Skip to content

Commit

Permalink
Set typedoc revision as main and disable breadcrumbs
Browse files Browse the repository at this point in the history
  • Loading branch information
@lukasz-zimnoch
lukasz-zimnoch committed Nov 3, 2023
1 parent 8cf610b commit 2cf0c94
Show file tree
Hide file tree
Showing 49 changed files with 351 additions and 445 deletions.
84 changes: 41 additions & 43 deletions typescript/api-reference/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
@keep-network/tbtc-v2.ts

# @keep-network/tbtc-v2.ts

## Table of contents
Expand Down Expand Up @@ -121,7 +119,7 @@ Data about a Bitcoin transaction input.

#### Defined in

[lib/bitcoin/tx.ts:63](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/tx.ts#L63)
[lib/bitcoin/tx.ts:63](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L63)

___

Expand All @@ -133,7 +131,7 @@ Data about a Bitcoin unspent transaction output.

#### Defined in

[lib/bitcoin/tx.ts:93](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/tx.ts#L93)
[lib/bitcoin/tx.ts:93](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L93)

___

Expand All @@ -145,7 +143,7 @@ Represents an event emitted on deposit reveal to the on-chain bridge.

#### Defined in

[lib/contracts/bridge.ts:283](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/bridge.ts#L283)
[lib/contracts/bridge.ts:283](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L283)

___

Expand All @@ -158,7 +156,7 @@ wallet registry.

#### Defined in

[lib/contracts/wallet-registry.ts:64](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/wallet-registry.ts#L64)
[lib/contracts/wallet-registry.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L64)

___

Expand All @@ -171,7 +169,7 @@ wallet registry.

#### Defined in

[lib/contracts/wallet-registry.ts:79](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/wallet-registry.ts#L79)
[lib/contracts/wallet-registry.ts:79](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L79)

___

Expand All @@ -184,7 +182,7 @@ wallet registry.

#### Defined in

[lib/contracts/wallet-registry.ts:45](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/wallet-registry.ts#L45)
[lib/contracts/wallet-registry.ts:45](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L45)

___

Expand All @@ -196,7 +194,7 @@ Additional options used by the Electrum server.

#### Defined in

[lib/electrum/client.ts:48](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/electrum/client.ts#L48)
[lib/electrum/client.ts:48](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L48)

___

Expand All @@ -222,7 +220,7 @@ True if the error matches, false otherwise.

#### Defined in

[lib/utils/backoff.ts:42](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/utils/backoff.ts#L42)
[lib/utils/backoff.ts:42](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L42)

___

Expand All @@ -234,7 +232,7 @@ Supported Ethereum networks.

#### Defined in

[lib/ethereum/index.ts:74](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/ethereum/index.ts#L74)
[lib/ethereum/index.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L74)

___

Expand All @@ -248,7 +246,7 @@ or a Provider that works only in the read-only mode.

#### Defined in

[lib/ethereum/index.ts:25](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/ethereum/index.ts#L25)
[lib/ethereum/index.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L25)

___

Expand All @@ -274,7 +272,7 @@ A function that is called with execution status messages.

#### Defined in

[lib/utils/backoff.ts:56](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/utils/backoff.ts#L56)
[lib/utils/backoff.ts:56](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L56)

___

Expand All @@ -286,7 +284,7 @@ Represents an event emitted when new wallet is registered on the on-chain bridge

#### Defined in

[lib/contracts/bridge.ts:445](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/bridge.ts#L445)
[lib/contracts/bridge.ts:445](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L445)

___

Expand All @@ -299,7 +297,7 @@ is cancelled on chain.

#### Defined in

[lib/contracts/tbtc-vault.ts:170](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/tbtc-vault.ts#L170)
[lib/contracts/tbtc-vault.ts:170](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L170)

___

Expand All @@ -312,7 +310,7 @@ is finalized on chain.

#### Defined in

[lib/contracts/tbtc-vault.ts:186](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/tbtc-vault.ts#L186)
[lib/contracts/tbtc-vault.ts:186](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L186)

___

Expand All @@ -332,7 +330,7 @@ Bridge.

#### Defined in

[lib/contracts/tbtc-vault.ts:120](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/tbtc-vault.ts#L120)
[lib/contracts/tbtc-vault.ts:120](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L120)

___

Expand All @@ -345,7 +343,7 @@ on chain.

#### Defined in

[lib/contracts/tbtc-vault.ts:136](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/tbtc-vault.ts#L136)
[lib/contracts/tbtc-vault.ts:136](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L136)

___

Expand All @@ -357,7 +355,7 @@ Represents an event emitted on redemption request.

#### Defined in

[lib/contracts/bridge.ts:334](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/bridge.ts#L334)
[lib/contracts/bridge.ts:334](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L334)

___

Expand Down Expand Up @@ -387,7 +385,7 @@ ___

#### Defined in

[lib/utils/backoff.ts:51](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/utils/backoff.ts#L51)
[lib/utils/backoff.ts:51](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L51)

___

Expand All @@ -408,7 +406,7 @@ Convenience type aggregating all TBTC contracts handles.

#### Defined in

[lib/contracts/index.ts:16](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/index.ts#L16)
[lib/contracts/index.ts:16](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/index.ts#L16)

## Variables

Expand All @@ -430,7 +428,7 @@ Utility functions allowing to perform Bitcoin address conversions.

#### Defined in

[lib/bitcoin/address.ts:112](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/address.ts#L112)
[lib/bitcoin/address.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/address.ts#L112)

___

Expand All @@ -448,7 +446,7 @@ Utility functions allowing to deal with Bitcoin compact size uints.

#### Defined in

[lib/bitcoin/csuint.ts:50](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/csuint.ts#L50)
[lib/bitcoin/csuint.ts:50](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/csuint.ts#L50)

___

Expand All @@ -469,7 +467,7 @@ Utility functions allowing to deal with Bitcoin hashes.

#### Defined in

[lib/bitcoin/hash.ts:52](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/hash.ts#L52)
[lib/bitcoin/hash.ts:52](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/hash.ts#L52)

___

Expand All @@ -489,7 +487,7 @@ Utility functions allowing to serialize and deserialize Bitcoin block headers.

#### Defined in

[lib/bitcoin/header.ts:109](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/header.ts#L109)
[lib/bitcoin/header.ts:109](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L109)

___

Expand All @@ -508,7 +506,7 @@ Utility functions allowing to deal with Bitcoin locktime.

#### Defined in

[lib/bitcoin/tx.ts:234](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/tx.ts#L234)
[lib/bitcoin/tx.ts:234](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L234)

___

Expand All @@ -526,7 +524,7 @@ Utility functions allowing to perform operations on Bitcoin ECDSA private keys.

#### Defined in

[lib/bitcoin/ecdsa-key.ts:77](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/ecdsa-key.ts#L77)
[lib/bitcoin/ecdsa-key.ts:77](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/ecdsa-key.ts#L77)

___

Expand All @@ -545,7 +543,7 @@ Utility functions allowing to perform operations on Bitcoin ECDSA public keys.

#### Defined in

[lib/bitcoin/ecdsa-key.ts:51](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/ecdsa-key.ts#L51)
[lib/bitcoin/ecdsa-key.ts:51](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/ecdsa-key.ts#L51)

___

Expand All @@ -566,7 +564,7 @@ Utility functions allowing to deal with Bitcoin scripts.

#### Defined in

[lib/bitcoin/script.ts:63](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/script.ts#L63)
[lib/bitcoin/script.ts:63](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/script.ts#L63)

___

Expand All @@ -585,7 +583,7 @@ Utility functions allowing to perform Bitcoin target conversions.

#### Defined in

[lib/bitcoin/header.ts:268](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/header.ts#L268)
[lib/bitcoin/header.ts:268](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L268)

## Functions

Expand All @@ -612,7 +610,7 @@ Bitcoin transaction along with the inclusion proof.

#### Defined in

[lib/bitcoin/spv.ts:64](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/spv.ts#L64)
[lib/bitcoin/spv.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L64)

___

Expand Down Expand Up @@ -662,7 +660,7 @@ A function that can retry any function.

#### Defined in

[lib/utils/backoff.ts:89](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/utils/backoff.ts#L89)
[lib/utils/backoff.ts:89](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L89)

___

Expand All @@ -687,7 +685,7 @@ Electrum script hash as a hex string.

#### Defined in

[lib/electrum/client.ts:591](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/electrum/client.ts#L591)
[lib/electrum/client.ts:591](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L591)

___

Expand Down Expand Up @@ -717,7 +715,7 @@ Throws an error if the address of the signer is not a proper

#### Defined in

[lib/ethereum/index.ts:61](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/ethereum/index.ts#L61)
[lib/ethereum/index.ts:61](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L61)

___

Expand All @@ -741,7 +739,7 @@ Ethereum network.

#### Defined in

[lib/ethereum/index.ts:32](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/ethereum/index.ts#L32)
[lib/ethereum/index.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L32)

___

Expand All @@ -766,7 +764,7 @@ Transaction data with fields represented as un-prefixed hex strings.

#### Defined in

[lib/bitcoin/tx.ts:133](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/tx.ts#L133)
[lib/bitcoin/tx.ts:133](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L133)

___

Expand Down Expand Up @@ -797,7 +795,7 @@ Throws an error if the signer's Ethereum network is other than

#### Defined in

[lib/ethereum/index.ts:85](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/ethereum/index.ts#L85)
[lib/ethereum/index.ts:85](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L85)

___

Expand All @@ -822,7 +820,7 @@ Always returns true.

#### Defined in

[lib/utils/backoff.ts:9](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/utils/backoff.ts#L9)
[lib/utils/backoff.ts:9](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L9)

___

Expand All @@ -848,7 +846,7 @@ Matcher function that returns false if error matches one of the patterns.

#### Defined in

[lib/utils/backoff.ts:20](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/utils/backoff.ts#L20)
[lib/utils/backoff.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L20)

___

Expand Down Expand Up @@ -877,7 +875,7 @@ An error if the network is not supported by `bitcoinjs-lib`.

#### Defined in

[lib/bitcoin/network.ts:55](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/network.ts#L55)
[lib/bitcoin/network.ts:55](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L55)

___

Expand Down Expand Up @@ -918,7 +916,7 @@ If any of the block headers are invalid, or if the block

#### Defined in

[lib/bitcoin/header.ts:132](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/header.ts#L132)
[lib/bitcoin/header.ts:132](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L132)

___

Expand Down Expand Up @@ -958,7 +956,7 @@ The function should be used within a try-catch block.

#### Defined in

[lib/bitcoin/spv.ts:145](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/bitcoin/spv.ts#L145)
[lib/bitcoin/spv.ts:145](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L145)

___

Expand All @@ -985,4 +983,4 @@ This function does not validate the depositor's identifier as its

#### Defined in

[lib/contracts/bridge.ts:228](https://github.com/keep-network/tbtc-v2/blob/807249d0/typescript/src/lib/contracts/bridge.ts#L228)
[lib/contracts/bridge.ts:228](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L228)
Loading

0 comments on commit 2cf0c94

Please sign in to comment.