diff --git a/typescript/api-reference/README.md b/typescript/api-reference/README.md index b5e639aa6..55d6dc399 100644 --- a/typescript/api-reference/README.md +++ b/typescript/api-reference/README.md @@ -28,6 +28,7 @@ - [EthereumTBTCVault](classes/EthereumTBTCVault.md) - [EthereumWalletRegistry](classes/EthereumWalletRegistry.md) - [Hex](classes/Hex.md) +- [LedgerLiveEthereumSigner](classes/LedgerLiveEthereumSigner.md) - [MaintenanceService](classes/MaintenanceService.md) - [OptimisticMinting](classes/OptimisticMinting.md) - [RedemptionsService](classes/RedemptionsService.md) @@ -119,7 +120,7 @@ Data about a Bitcoin transaction input. #### Defined in -[lib/bitcoin/tx.ts:63](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L63) +[src/lib/bitcoin/tx.ts:63](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L63) ___ @@ -131,7 +132,7 @@ Data about a Bitcoin unspent transaction output. #### Defined in -[lib/bitcoin/tx.ts:93](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L93) +[src/lib/bitcoin/tx.ts:93](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L93) ___ @@ -143,7 +144,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/main/typescript/src/lib/contracts/bridge.ts#L283) +[src/lib/contracts/bridge.ts:283](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L283) ___ @@ -156,7 +157,7 @@ wallet registry. #### Defined in -[lib/contracts/wallet-registry.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L64) +[src/lib/contracts/wallet-registry.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L64) ___ @@ -169,7 +170,7 @@ wallet registry. #### Defined in -[lib/contracts/wallet-registry.ts:79](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L79) +[src/lib/contracts/wallet-registry.ts:79](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L79) ___ @@ -182,7 +183,7 @@ wallet registry. #### Defined in -[lib/contracts/wallet-registry.ts:45](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L45) +[src/lib/contracts/wallet-registry.ts:45](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L45) ___ @@ -194,7 +195,7 @@ Additional options used by the Electrum server. #### Defined in -[lib/electrum/client.ts:48](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L48) +[src/lib/electrum/client.ts:48](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L48) ___ @@ -220,7 +221,7 @@ True if the error matches, false otherwise. #### Defined in -[lib/utils/backoff.ts:42](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L42) +[src/lib/utils/backoff.ts:42](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L42) ___ @@ -232,7 +233,7 @@ Supported Ethereum networks. #### Defined in -[lib/ethereum/index.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L74) +[src/lib/ethereum/index.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L74) ___ @@ -246,7 +247,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/main/typescript/src/lib/ethereum/index.ts#L25) +[src/lib/ethereum/index.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L25) ___ @@ -272,7 +273,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/main/typescript/src/lib/utils/backoff.ts#L56) +[src/lib/utils/backoff.ts:56](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L56) ___ @@ -284,7 +285,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/main/typescript/src/lib/contracts/bridge.ts#L445) +[src/lib/contracts/bridge.ts:445](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L445) ___ @@ -297,7 +298,7 @@ is cancelled on chain. #### Defined in -[lib/contracts/tbtc-vault.ts:170](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L170) +[src/lib/contracts/tbtc-vault.ts:170](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L170) ___ @@ -310,7 +311,7 @@ is finalized on chain. #### Defined in -[lib/contracts/tbtc-vault.ts:186](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L186) +[src/lib/contracts/tbtc-vault.ts:186](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L186) ___ @@ -330,7 +331,7 @@ Bridge. #### Defined in -[lib/contracts/tbtc-vault.ts:120](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L120) +[src/lib/contracts/tbtc-vault.ts:120](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L120) ___ @@ -343,7 +344,7 @@ on chain. #### Defined in -[lib/contracts/tbtc-vault.ts:136](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L136) +[src/lib/contracts/tbtc-vault.ts:136](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L136) ___ @@ -355,7 +356,7 @@ Represents an event emitted on redemption request. #### Defined in -[lib/contracts/bridge.ts:334](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L334) +[src/lib/contracts/bridge.ts:334](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L334) ___ @@ -385,7 +386,7 @@ ___ #### Defined in -[lib/utils/backoff.ts:51](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L51) +[src/lib/utils/backoff.ts:51](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L51) ___ @@ -406,7 +407,7 @@ Convenience type aggregating all TBTC contracts handles. #### Defined in -[lib/contracts/index.ts:16](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/index.ts#L16) +[src/lib/contracts/index.ts:16](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/index.ts#L16) ## Variables @@ -428,7 +429,7 @@ Utility functions allowing to perform Bitcoin address conversions. #### Defined in -[lib/bitcoin/address.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/address.ts#L112) +[src/lib/bitcoin/address.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/address.ts#L112) ___ @@ -446,7 +447,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/main/typescript/src/lib/bitcoin/csuint.ts#L50) +[src/lib/bitcoin/csuint.ts:50](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/csuint.ts#L50) ___ @@ -467,7 +468,7 @@ Utility functions allowing to deal with Bitcoin hashes. #### Defined in -[lib/bitcoin/hash.ts:52](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/hash.ts#L52) +[src/lib/bitcoin/hash.ts:52](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/hash.ts#L52) ___ @@ -487,7 +488,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/main/typescript/src/lib/bitcoin/header.ts#L109) +[src/lib/bitcoin/header.ts:109](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L109) ___ @@ -506,7 +507,7 @@ Utility functions allowing to deal with Bitcoin locktime. #### Defined in -[lib/bitcoin/tx.ts:234](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L234) +[src/lib/bitcoin/tx.ts:234](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L234) ___ @@ -524,7 +525,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/main/typescript/src/lib/bitcoin/ecdsa-key.ts#L77) +[src/lib/bitcoin/ecdsa-key.ts:77](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/ecdsa-key.ts#L77) ___ @@ -543,7 +544,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/main/typescript/src/lib/bitcoin/ecdsa-key.ts#L51) +[src/lib/bitcoin/ecdsa-key.ts:51](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/ecdsa-key.ts#L51) ___ @@ -564,7 +565,7 @@ Utility functions allowing to deal with Bitcoin scripts. #### Defined in -[lib/bitcoin/script.ts:63](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/script.ts#L63) +[src/lib/bitcoin/script.ts:63](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/script.ts#L63) ___ @@ -583,7 +584,7 @@ Utility functions allowing to perform Bitcoin target conversions. #### Defined in -[lib/bitcoin/header.ts:268](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L268) +[src/lib/bitcoin/header.ts:268](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L268) ## Functions @@ -610,7 +611,7 @@ Bitcoin transaction along with the inclusion proof. #### Defined in -[lib/bitcoin/spv.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L64) +[src/lib/bitcoin/spv.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L64) ___ @@ -660,7 +661,7 @@ A function that can retry any function. #### Defined in -[lib/utils/backoff.ts:89](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L89) +[src/lib/utils/backoff.ts:89](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L89) ___ @@ -685,7 +686,7 @@ Electrum script hash as a hex string. #### Defined in -[lib/electrum/client.ts:649](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L649) +[src/lib/electrum/client.ts:649](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L649) ___ @@ -715,7 +716,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/main/typescript/src/lib/ethereum/index.ts#L61) +[src/lib/ethereum/index.ts:61](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L61) ___ @@ -739,7 +740,7 @@ Ethereum network. #### Defined in -[lib/ethereum/index.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L32) +[src/lib/ethereum/index.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L32) ___ @@ -764,7 +765,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/main/typescript/src/lib/bitcoin/tx.ts#L133) +[src/lib/bitcoin/tx.ts:133](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L133) ___ @@ -795,7 +796,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/main/typescript/src/lib/ethereum/index.ts#L85) +[src/lib/ethereum/index.ts:85](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L85) ___ @@ -820,7 +821,7 @@ Always returns true. #### Defined in -[lib/utils/backoff.ts:9](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L9) +[src/lib/utils/backoff.ts:9](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L9) ___ @@ -846,7 +847,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/main/typescript/src/lib/utils/backoff.ts#L20) +[src/lib/utils/backoff.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/backoff.ts#L20) ___ @@ -875,7 +876,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/main/typescript/src/lib/bitcoin/network.ts#L55) +[src/lib/bitcoin/network.ts:55](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L55) ___ @@ -916,7 +917,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/main/typescript/src/lib/bitcoin/header.ts#L132) +[src/lib/bitcoin/header.ts:132](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L132) ___ @@ -956,7 +957,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/main/typescript/src/lib/bitcoin/spv.ts#L145) +[src/lib/bitcoin/spv.ts:145](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L145) ___ @@ -983,4 +984,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/main/typescript/src/lib/contracts/bridge.ts#L228) +[src/lib/contracts/bridge.ts:228](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L228) diff --git a/typescript/api-reference/classes/BitcoinTxHash.md b/typescript/api-reference/classes/BitcoinTxHash.md index 47deeb331..04b246409 100644 --- a/typescript/api-reference/classes/BitcoinTxHash.md +++ b/typescript/api-reference/classes/BitcoinTxHash.md @@ -53,7 +53,7 @@ the use cases that expect the Bitcoin internal byte order. #### Defined in -[lib/utils/hex.ts:7](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L7) +[src/lib/utils/hex.ts:7](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L7) ## Properties @@ -67,7 +67,7 @@ the use cases that expect the Bitcoin internal byte order. #### Defined in -[lib/utils/hex.ts:5](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L5) +[src/lib/utils/hex.ts:5](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L5) ## Methods @@ -95,7 +95,7 @@ True if both values are equal, false otherwise. #### Defined in -[lib/utils/hex.ts:57](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L57) +[src/lib/utils/hex.ts:57](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L57) ___ @@ -115,7 +115,7 @@ Reversed hexadecimal value. #### Defined in -[lib/utils/hex.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L64) +[src/lib/utils/hex.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L64) ___ @@ -135,7 +135,7 @@ Hexadecimal value as a Buffer. #### Defined in -[lib/utils/hex.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L32) +[src/lib/utils/hex.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L32) ___ @@ -155,7 +155,7 @@ Hexadecimal string prefixed with '0x'. #### Defined in -[lib/utils/hex.ts:46](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L46) +[src/lib/utils/hex.ts:46](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L46) ___ @@ -175,7 +175,7 @@ Unprefixed hexadecimal string. #### Defined in -[lib/utils/hex.ts:39](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L39) +[src/lib/utils/hex.ts:39](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L39) ___ @@ -199,4 +199,4 @@ ___ #### Defined in -[lib/utils/hex.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L25) +[src/lib/utils/hex.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L25) diff --git a/typescript/api-reference/classes/Deposit.md b/typescript/api-reference/classes/Deposit.md index 522fa783b..e6a52812e 100644 --- a/typescript/api-reference/classes/Deposit.md +++ b/typescript/api-reference/classes/Deposit.md @@ -46,7 +46,7 @@ This component tries to abstract away that complexity. #### Defined in -[services/deposits/deposit.ts:42](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L42) +[src/services/deposits/deposit.ts:42](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L42) ## Properties @@ -58,7 +58,7 @@ Bitcoin client handle. #### Defined in -[services/deposits/deposit.ts:35](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L35) +[src/services/deposits/deposit.ts:35](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L35) ___ @@ -71,7 +71,7 @@ generated deposit address. #### Defined in -[services/deposits/deposit.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L40) +[src/services/deposits/deposit.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L40) ___ @@ -83,7 +83,7 @@ Bitcoin script corresponding to this deposit. #### Defined in -[services/deposits/deposit.ts:27](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L27) +[src/services/deposits/deposit.ts:27](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L27) ___ @@ -95,7 +95,7 @@ Handle to tBTC contracts. #### Defined in -[services/deposits/deposit.ts:31](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L31) +[src/services/deposits/deposit.ts:31](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L31) ## Methods @@ -114,7 +114,7 @@ Specific UTXOs targeting this deposit. Empty array in case #### Defined in -[services/deposits/deposit.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L84) +[src/services/deposits/deposit.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L84) ___ @@ -130,7 +130,7 @@ Bitcoin address corresponding to this deposit. #### Defined in -[services/deposits/deposit.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L74) +[src/services/deposits/deposit.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L74) ___ @@ -146,7 +146,7 @@ Receipt corresponding to this deposit. #### Defined in -[services/deposits/deposit.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L67) +[src/services/deposits/deposit.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L67) ___ @@ -190,7 +190,7 @@ Throws an error if the funding outpoint was already used to #### Defined in -[services/deposits/deposit.ts:114](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L114) +[src/services/deposits/deposit.ts:114](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L114) ___ @@ -212,4 +212,4 @@ ___ #### Defined in -[services/deposits/deposit.ts:54](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L54) +[src/services/deposits/deposit.ts:54](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L54) diff --git a/typescript/api-reference/classes/DepositFunding.md b/typescript/api-reference/classes/DepositFunding.md index 7bf298e41..5fef70a82 100644 --- a/typescript/api-reference/classes/DepositFunding.md +++ b/typescript/api-reference/classes/DepositFunding.md @@ -41,7 +41,7 @@ the given tBTC v2 deposit script. #### Defined in -[services/deposits/funding.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L30) +[src/services/deposits/funding.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L30) ## Properties @@ -51,7 +51,7 @@ the given tBTC v2 deposit script. #### Defined in -[services/deposits/funding.ts:28](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L28) +[src/services/deposits/funding.ts:28](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L28) ## Methods @@ -101,7 +101,7 @@ When the sum of the selected UTXOs is insufficient to cover #### Defined in -[services/deposits/funding.ts:62](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L62) +[src/services/deposits/funding.ts:62](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L62) ___ @@ -151,7 +151,7 @@ When the sum of the selected UTXOs is insufficient to cover #### Defined in -[services/deposits/funding.ts:181](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L181) +[src/services/deposits/funding.ts:181](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L181) ___ @@ -171,4 +171,4 @@ ___ #### Defined in -[services/deposits/funding.ts:34](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L34) +[src/services/deposits/funding.ts:34](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/funding.ts#L34) diff --git a/typescript/api-reference/classes/DepositRefund.md b/typescript/api-reference/classes/DepositRefund.md index 1bc726de0..0cce0d135 100644 --- a/typescript/api-reference/classes/DepositRefund.md +++ b/typescript/api-reference/classes/DepositRefund.md @@ -44,7 +44,7 @@ the given tBTC v2 deposit script. #### Defined in -[services/deposits/refund.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L37) +[src/services/deposits/refund.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L37) ## Properties @@ -54,7 +54,7 @@ the given tBTC v2 deposit script. #### Defined in -[services/deposits/refund.ts:35](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L35) +[src/services/deposits/refund.ts:35](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L35) ## Methods @@ -84,7 +84,7 @@ The outcome consisting of: #### Defined in -[services/deposits/refund.ts:111](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L111) +[src/services/deposits/refund.ts:111](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L111) ___ @@ -113,7 +113,7 @@ Error if there are discrepancies in values or key formats. #### Defined in -[services/deposits/refund.ts:191](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L191) +[src/services/deposits/refund.ts:191](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L191) ___ @@ -139,7 +139,7 @@ An empty promise upon successful signing. #### Defined in -[services/deposits/refund.ts:219](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L219) +[src/services/deposits/refund.ts:219](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L219) ___ @@ -166,7 +166,7 @@ An empty promise upon successful signing. #### Defined in -[services/deposits/refund.ts:256](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L256) +[src/services/deposits/refund.ts:256](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L256) ___ @@ -203,7 +203,7 @@ This function should be called by the refunder after `refundLocktime` #### Defined in -[services/deposits/refund.ts:63](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L63) +[src/services/deposits/refund.ts:63](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L63) ___ @@ -223,4 +223,4 @@ ___ #### Defined in -[services/deposits/refund.ts:41](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L41) +[src/services/deposits/refund.ts:41](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/refund.ts#L41) diff --git a/typescript/api-reference/classes/DepositScript.md b/typescript/api-reference/classes/DepositScript.md index 3e70aa76d..43fd05256 100644 --- a/typescript/api-reference/classes/DepositScript.md +++ b/typescript/api-reference/classes/DepositScript.md @@ -43,7 +43,7 @@ by the target wallet during the deposit sweep process. #### Defined in -[services/deposits/deposit.ts:166](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L166) +[src/services/deposits/deposit.ts:166](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L166) ## Properties @@ -56,7 +56,7 @@ and allowing to build a unique deposit script (and address) on Bitcoin chain. #### Defined in -[services/deposits/deposit.ts:159](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L159) +[src/services/deposits/deposit.ts:159](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L159) ___ @@ -69,7 +69,7 @@ should be a witness P2WSH one. If false, legacy P2SH will be used instead. #### Defined in -[services/deposits/deposit.ts:164](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L164) +[src/services/deposits/deposit.ts:164](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L164) ## Methods @@ -93,7 +93,7 @@ Bitcoin address corresponding to this deposit script. #### Defined in -[services/deposits/deposit.ts:228](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L228) +[src/services/deposits/deposit.ts:228](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L228) ___ @@ -109,7 +109,7 @@ Hashed deposit script as Buffer. #### Defined in -[services/deposits/deposit.ts:183](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L183) +[src/services/deposits/deposit.ts:183](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L183) ___ @@ -125,7 +125,7 @@ Plain-text deposit script as a hex string. #### Defined in -[services/deposits/deposit.ts:195](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L195) +[src/services/deposits/deposit.ts:195](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L195) ___ @@ -146,4 +146,4 @@ ___ #### Defined in -[services/deposits/deposit.ts:173](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L173) +[src/services/deposits/deposit.ts:173](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposit.ts#L173) diff --git a/typescript/api-reference/classes/DepositsService.md b/typescript/api-reference/classes/DepositsService.md index cd237c9ab..e7db0b486 100644 --- a/typescript/api-reference/classes/DepositsService.md +++ b/typescript/api-reference/classes/DepositsService.md @@ -40,7 +40,7 @@ Service exposing features related to tBTC v2 deposits. #### Defined in -[services/deposits/deposits-service.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L40) +[src/services/deposits/deposits-service.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L40) ## Properties @@ -52,7 +52,7 @@ Bitcoin client handle. #### Defined in -[services/deposits/deposits-service.ts:33](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L33) +[src/services/deposits/deposits-service.ts:33](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L33) ___ @@ -65,7 +65,7 @@ initiated by this service. #### Defined in -[services/deposits/deposits-service.ts:38](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L38) +[src/services/deposits/deposits-service.ts:38](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L38) ___ @@ -78,7 +78,7 @@ This is 9 month in seconds assuming 1 month = 30 days #### Defined in -[services/deposits/deposits-service.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L25) +[src/services/deposits/deposits-service.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L25) ___ @@ -90,7 +90,7 @@ Handle to tBTC contracts. #### Defined in -[services/deposits/deposits-service.ts:29](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L29) +[src/services/deposits/deposits-service.ts:29](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L29) ## Methods @@ -110,7 +110,7 @@ Handle to tBTC contracts. #### Defined in -[services/deposits/deposits-service.ts:62](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L62) +[src/services/deposits/deposits-service.ts:62](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L62) ___ @@ -141,7 +141,7 @@ Throws an error if one of the following occurs: #### Defined in -[services/deposits/deposits-service.ts:57](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L57) +[src/services/deposits/deposits-service.ts:57](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L57) ___ @@ -170,4 +170,4 @@ Typically, there is no need to use this method when DepositsService #### Defined in -[services/deposits/deposits-service.ts:125](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L125) +[src/services/deposits/deposits-service.ts:125](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/deposits/deposits-service.ts#L125) diff --git a/typescript/api-reference/classes/ElectrumClient.md b/typescript/api-reference/classes/ElectrumClient.md index bef3ba335..ca7c460ce 100644 --- a/typescript/api-reference/classes/ElectrumClient.md +++ b/typescript/api-reference/classes/ElectrumClient.md @@ -61,7 +61,7 @@ Electrum-based implementation of the Bitcoin client. #### Defined in -[lib/electrum/client.ts:72](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L72) +[src/lib/electrum/client.ts:72](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L72) ## Properties @@ -71,7 +71,7 @@ Electrum-based implementation of the Bitcoin client. #### Defined in -[lib/electrum/client.ts:70](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L70) +[src/lib/electrum/client.ts:70](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L70) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[lib/electrum/client.ts:66](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L66) +[src/lib/electrum/client.ts:66](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L66) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[lib/electrum/client.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L67) +[src/lib/electrum/client.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L67) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[lib/electrum/client.ts:69](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L69) +[src/lib/electrum/client.ts:69](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L69) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -[lib/electrum/client.ts:68](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L68) +[src/lib/electrum/client.ts:68](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L68) ## Methods @@ -137,7 +137,7 @@ ___ #### Defined in -[lib/electrum/client.ts:632](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L632) +[src/lib/electrum/client.ts:632](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L632) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[lib/electrum/client.ts:260](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L260) +[src/lib/electrum/client.ts:260](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L260) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[lib/electrum/client.ts:582](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L582) +[src/lib/electrum/client.ts:582](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L582) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[lib/electrum/client.ts:238](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L238) +[src/lib/electrum/client.ts:238](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L238) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[lib/electrum/client.ts:395](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L395) +[src/lib/electrum/client.ts:395](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L395) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[lib/electrum/client.ts:345](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L345) +[src/lib/electrum/client.ts:345](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L345) ___ @@ -288,7 +288,7 @@ ___ #### Defined in -[lib/electrum/client.ts:416](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L416) +[src/lib/electrum/client.ts:416](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L416) ___ @@ -315,7 +315,7 @@ ___ #### Defined in -[lib/electrum/client.ts:291](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L291) +[src/lib/electrum/client.ts:291](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L291) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[lib/electrum/client.ts:601](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L601) +[src/lib/electrum/client.ts:601](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L601) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[lib/electrum/client.ts:508](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L508) +[src/lib/electrum/client.ts:508](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L508) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[lib/electrum/client.ts:566](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L566) +[src/lib/electrum/client.ts:566](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L566) ___ @@ -412,7 +412,7 @@ A function that can retry any function. #### Defined in -[lib/electrum/client.ts:230](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L230) +[src/lib/electrum/client.ts:230](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L230) ___ @@ -443,7 +443,7 @@ Promise holding the outcome. #### Defined in -[lib/electrum/client.ts:168](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L168) +[src/lib/electrum/client.ts:168](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L168) ___ @@ -468,7 +468,7 @@ Electrum client instance. #### Defined in -[lib/electrum/client.ts:126](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L126) +[src/lib/electrum/client.ts:126](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L126) ___ @@ -496,7 +496,7 @@ Electrum client instance. #### Defined in -[lib/electrum/client.ts:97](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L97) +[src/lib/electrum/client.ts:97](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L97) ___ @@ -520,4 +520,4 @@ Electrum credentials object. #### Defined in -[lib/electrum/client.ts:147](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L147) +[src/lib/electrum/client.ts:147](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L147) diff --git a/typescript/api-reference/classes/EthereumAddress.md b/typescript/api-reference/classes/EthereumAddress.md index 7998fc4a6..08b14f897 100644 --- a/typescript/api-reference/classes/EthereumAddress.md +++ b/typescript/api-reference/classes/EthereumAddress.md @@ -39,7 +39,7 @@ Represents an Ethereum address. #### Defined in -[lib/ethereum/address.ts:12](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/address.ts#L12) +[src/lib/ethereum/address.ts:12](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/address.ts#L12) ## Properties @@ -55,7 +55,7 @@ Identifier as an un-prefixed hex string. #### Defined in -[lib/ethereum/address.ts:10](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/address.ts#L10) +[src/lib/ethereum/address.ts:10](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/address.ts#L10) ## Methods @@ -81,7 +81,7 @@ Checks if two identifiers are equal. #### Defined in -[lib/ethereum/address.ts:28](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/address.ts#L28) +[src/lib/ethereum/address.ts:28](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/address.ts#L28) ___ @@ -101,4 +101,4 @@ ___ #### Defined in -[lib/ethereum/address.ts:24](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/address.ts#L24) +[src/lib/ethereum/address.ts:24](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/address.ts#L24) diff --git a/typescript/api-reference/classes/EthereumBridge.md b/typescript/api-reference/classes/EthereumBridge.md index dc55ab59e..191323f1a 100644 --- a/typescript/api-reference/classes/EthereumBridge.md +++ b/typescript/api-reference/classes/EthereumBridge.md @@ -78,7 +78,7 @@ EthersContractHandle\<BridgeTypechain\>.constructor #### Defined in -[lib/ethereum/bridge.ts:59](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L59) +[src/lib/ethereum/bridge.ts:59](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L59) ## Properties @@ -96,7 +96,7 @@ EthersContractHandle.\_deployedAtBlockNumber #### Defined in -[lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L80) +[src/lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L80) ___ @@ -112,7 +112,7 @@ EthersContractHandle.\_instance #### Defined in -[lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L74) +[src/lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L74) ___ @@ -128,7 +128,7 @@ EthersContractHandle.\_totalRetryAttempts #### Defined in -[lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L84) +[src/lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L84) ## Methods @@ -148,7 +148,7 @@ EthersContractHandle.\_totalRetryAttempts #### Defined in -[lib/ethereum/bridge.ts:490](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L490) +[src/lib/ethereum/bridge.ts:490](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L490) ___ @@ -177,7 +177,7 @@ Builds the UTXO hash based on the UTXO components. UTXO hash is computed as #### Defined in -[lib/ethereum/bridge.ts:614](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L614) +[src/lib/ethereum/bridge.ts:614](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L614) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:425](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L425) +[src/lib/ethereum/bridge.ts:425](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L425) ___ @@ -226,7 +226,7 @@ EthersContractHandle.getAddress #### Defined in -[lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L112) +[src/lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L112) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:86](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L86) +[src/lib/ethereum/bridge.ts:86](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L86) ___ @@ -273,7 +273,7 @@ Bridge.getDepositRevealedEvents #### Defined in -[lib/ethereum/bridge.ts:94](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L94) +[src/lib/ethereum/bridge.ts:94](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L94) ___ @@ -307,7 +307,7 @@ EthersContractHandle.getEvents #### Defined in -[lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L127) +[src/lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L127) ___ @@ -334,7 +334,7 @@ Bridge.getNewWalletRegisteredEvents #### Defined in -[lib/ethereum/bridge.ts:526](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L526) +[src/lib/ethereum/bridge.ts:526](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L526) ___ @@ -361,7 +361,7 @@ Bridge.getRedemptionRequestedEvents #### Defined in -[lib/ethereum/bridge.ts:631](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L631) +[src/lib/ethereum/bridge.ts:631](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L631) ___ @@ -381,7 +381,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:511](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L511) +[src/lib/ethereum/bridge.ts:511](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L511) ___ @@ -405,7 +405,7 @@ Parsed deposit request. #### Defined in -[lib/ethereum/bridge.ts:470](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L470) +[src/lib/ethereum/bridge.ts:470](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L470) ___ @@ -430,7 +430,7 @@ Parsed redemption request. #### Defined in -[lib/ethereum/bridge.ts:212](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L212) +[src/lib/ethereum/bridge.ts:212](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L212) ___ @@ -454,7 +454,7 @@ Parsed wallet data. #### Defined in -[lib/ethereum/bridge.ts:585](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L585) +[src/lib/ethereum/bridge.ts:585](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L585) ___ @@ -481,7 +481,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:131](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L131) +[src/lib/ethereum/bridge.ts:131](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L131) ___ @@ -510,7 +510,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:332](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L332) +[src/lib/ethereum/bridge.ts:332](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L332) ___ @@ -539,7 +539,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:230](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L230) +[src/lib/ethereum/bridge.ts:230](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L230) ___ @@ -568,7 +568,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:268](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L268) +[src/lib/ethereum/bridge.ts:268](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L268) ___ @@ -597,7 +597,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:376](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L376) +[src/lib/ethereum/bridge.ts:376](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L376) ___ @@ -624,7 +624,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:154](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L154) +[src/lib/ethereum/bridge.ts:154](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L154) ___ @@ -644,7 +644,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:318](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L318) +[src/lib/ethereum/bridge.ts:318](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L318) ___ @@ -664,7 +664,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:551](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L551) +[src/lib/ethereum/bridge.ts:551](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L551) ___ @@ -690,7 +690,7 @@ ___ #### Defined in -[lib/ethereum/bridge.ts:568](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L568) +[src/lib/ethereum/bridge.ts:568](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L568) ___ @@ -715,7 +715,7 @@ Deposit key. #### Defined in -[lib/ethereum/bridge.ts:451](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L451) +[src/lib/ethereum/bridge.ts:451](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L451) ___ @@ -740,4 +740,4 @@ The redemption key. #### Defined in -[lib/ethereum/bridge.ts:182](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L182) +[src/lib/ethereum/bridge.ts:182](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/bridge.ts#L182) diff --git a/typescript/api-reference/classes/EthereumTBTCToken.md b/typescript/api-reference/classes/EthereumTBTCToken.md index 1c5657ef8..91c22bc39 100644 --- a/typescript/api-reference/classes/EthereumTBTCToken.md +++ b/typescript/api-reference/classes/EthereumTBTCToken.md @@ -61,7 +61,7 @@ EthersContractHandle\<TBTCTypechain\>.constructor #### Defined in -[lib/ethereum/tbtc-token.ts:26](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L26) +[src/lib/ethereum/tbtc-token.ts:26](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L26) ## Properties @@ -79,7 +79,7 @@ EthersContractHandle.\_deployedAtBlockNumber #### Defined in -[lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L80) +[src/lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L80) ___ @@ -95,7 +95,7 @@ EthersContractHandle.\_instance #### Defined in -[lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L74) +[src/lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L74) ___ @@ -111,7 +111,7 @@ EthersContractHandle.\_totalRetryAttempts #### Defined in -[lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L84) +[src/lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L84) ## Methods @@ -142,7 +142,7 @@ EthersContractHandle.\_totalRetryAttempts #### Defined in -[lib/ethereum/tbtc-token.ts:135](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L135) +[src/lib/ethereum/tbtc-token.ts:135](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L135) ___ @@ -165,7 +165,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-token.ts:104](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L104) +[src/lib/ethereum/tbtc-token.ts:104](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L104) ___ @@ -187,7 +187,7 @@ EthersContractHandle.getAddress #### Defined in -[lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L112) +[src/lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L112) ___ @@ -207,7 +207,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-token.ts:53](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L53) +[src/lib/ethereum/tbtc-token.ts:53](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L53) ___ @@ -241,7 +241,7 @@ EthersContractHandle.getEvents #### Defined in -[lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L127) +[src/lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L127) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-token.ts:71](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L71) +[src/lib/ethereum/tbtc-token.ts:71](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L71) ___ @@ -296,4 +296,4 @@ ___ #### Defined in -[lib/ethereum/tbtc-token.ts:61](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L61) +[src/lib/ethereum/tbtc-token.ts:61](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-token.ts#L61) diff --git a/typescript/api-reference/classes/EthereumTBTCVault.md b/typescript/api-reference/classes/EthereumTBTCVault.md index 4e3bd636f..99a4a537c 100644 --- a/typescript/api-reference/classes/EthereumTBTCVault.md +++ b/typescript/api-reference/classes/EthereumTBTCVault.md @@ -69,7 +69,7 @@ EthersContractHandle\<TBTCVaultTypechain\>.constructor #### Defined in -[lib/ethereum/tbtc-vault.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L40) +[src/lib/ethereum/tbtc-vault.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L40) ## Properties @@ -87,7 +87,7 @@ EthersContractHandle.\_deployedAtBlockNumber #### Defined in -[lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L80) +[src/lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L80) ___ @@ -103,7 +103,7 @@ EthersContractHandle.\_instance #### Defined in -[lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L74) +[src/lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L74) ___ @@ -119,7 +119,7 @@ EthersContractHandle.\_totalRetryAttempts #### Defined in -[lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L84) +[src/lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L84) ## Methods @@ -146,7 +146,7 @@ EthersContractHandle.\_totalRetryAttempts #### Defined in -[lib/ethereum/tbtc-vault.ts:149](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L149) +[src/lib/ethereum/tbtc-vault.ts:149](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L149) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-vault.ts:172](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L172) +[src/lib/ethereum/tbtc-vault.ts:172](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L172) ___ @@ -195,7 +195,7 @@ EthersContractHandle.getAddress #### Defined in -[lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L112) +[src/lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L112) ___ @@ -215,7 +215,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-vault.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L67) +[src/lib/ethereum/tbtc-vault.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L67) ___ @@ -249,7 +249,7 @@ EthersContractHandle.getEvents #### Defined in -[lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L127) +[src/lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L127) ___ @@ -269,7 +269,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-vault.ts:89](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L89) +[src/lib/ethereum/tbtc-vault.ts:89](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L89) ___ @@ -296,7 +296,7 @@ TBTCVault.getOptimisticMintingCancelledEvents #### Defined in -[lib/ethereum/tbtc-vault.ts:267](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L267) +[src/lib/ethereum/tbtc-vault.ts:267](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L267) ___ @@ -323,7 +323,7 @@ TBTCVault.getOptimisticMintingFinalizedEvents #### Defined in -[lib/ethereum/tbtc-vault.ts:294](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L294) +[src/lib/ethereum/tbtc-vault.ts:294](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L294) ___ @@ -350,7 +350,7 @@ TBTCVault.getOptimisticMintingRequestedEvents #### Defined in -[lib/ethereum/tbtc-vault.ts:234](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L234) +[src/lib/ethereum/tbtc-vault.ts:234](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L234) ___ @@ -376,7 +376,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-vault.ts:113](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L113) +[src/lib/ethereum/tbtc-vault.ts:113](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L113) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-vault.ts:103](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L103) +[src/lib/ethereum/tbtc-vault.ts:103](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L103) ___ @@ -422,7 +422,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-vault.ts:75](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L75) +[src/lib/ethereum/tbtc-vault.ts:75](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L75) ___ @@ -449,7 +449,7 @@ ___ #### Defined in -[lib/ethereum/tbtc-vault.ts:198](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L198) +[src/lib/ethereum/tbtc-vault.ts:198](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L198) ___ @@ -473,7 +473,7 @@ Parsed optimistic minting request. #### Defined in -[lib/ethereum/tbtc-vault.ts:221](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L221) +[src/lib/ethereum/tbtc-vault.ts:221](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L221) ___ @@ -500,4 +500,4 @@ ___ #### Defined in -[lib/ethereum/tbtc-vault.ts:123](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L123) +[src/lib/ethereum/tbtc-vault.ts:123](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/tbtc-vault.ts#L123) diff --git a/typescript/api-reference/classes/EthereumWalletRegistry.md b/typescript/api-reference/classes/EthereumWalletRegistry.md index 7cab2bd60..07199894b 100644 --- a/typescript/api-reference/classes/EthereumWalletRegistry.md +++ b/typescript/api-reference/classes/EthereumWalletRegistry.md @@ -61,7 +61,7 @@ EthersContractHandle\<WalletRegistryTypechain\>.constructor #### Defined in -[lib/ethereum/wallet-registry.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L32) +[src/lib/ethereum/wallet-registry.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L32) ## Properties @@ -79,7 +79,7 @@ EthersContractHandle.\_deployedAtBlockNumber #### Defined in -[lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L80) +[src/lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L80) ___ @@ -95,7 +95,7 @@ EthersContractHandle.\_instance #### Defined in -[lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L74) +[src/lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L74) ___ @@ -111,7 +111,7 @@ EthersContractHandle.\_totalRetryAttempts #### Defined in -[lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L84) +[src/lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L84) ## Methods @@ -133,7 +133,7 @@ EthersContractHandle.getAddress #### Defined in -[lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L112) +[src/lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L112) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -[lib/ethereum/wallet-registry.ts:59](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L59) +[src/lib/ethereum/wallet-registry.ts:59](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L59) ___ @@ -180,7 +180,7 @@ WalletRegistry.getDkgResultApprovedEvents #### Defined in -[lib/ethereum/wallet-registry.ts:125](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L125) +[src/lib/ethereum/wallet-registry.ts:125](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L125) ___ @@ -207,7 +207,7 @@ WalletRegistry.getDkgResultChallengedEvents #### Defined in -[lib/ethereum/wallet-registry.ts:150](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L150) +[src/lib/ethereum/wallet-registry.ts:150](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L150) ___ @@ -234,7 +234,7 @@ WalletRegistry.getDkgResultSubmittedEvents #### Defined in -[lib/ethereum/wallet-registry.ts:82](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L82) +[src/lib/ethereum/wallet-registry.ts:82](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L82) ___ @@ -268,7 +268,7 @@ EthersContractHandle.getEvents #### Defined in -[lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L127) +[src/lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L127) ___ @@ -294,4 +294,4 @@ ___ #### Defined in -[lib/ethereum/wallet-registry.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L67) +[src/lib/ethereum/wallet-registry.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/wallet-registry.ts#L67) diff --git a/typescript/api-reference/classes/Hex.md b/typescript/api-reference/classes/Hex.md index 9975b5248..49646c295 100644 --- a/typescript/api-reference/classes/Hex.md +++ b/typescript/api-reference/classes/Hex.md @@ -45,7 +45,7 @@ Represents a hexadecimal value. #### Defined in -[lib/utils/hex.ts:7](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L7) +[src/lib/utils/hex.ts:7](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L7) ## Properties @@ -55,7 +55,7 @@ Represents a hexadecimal value. #### Defined in -[lib/utils/hex.ts:5](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L5) +[src/lib/utils/hex.ts:5](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L5) ## Methods @@ -79,7 +79,7 @@ True if both values are equal, false otherwise. #### Defined in -[lib/utils/hex.ts:57](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L57) +[src/lib/utils/hex.ts:57](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L57) ___ @@ -95,7 +95,7 @@ Reversed hexadecimal value. #### Defined in -[lib/utils/hex.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L64) +[src/lib/utils/hex.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L64) ___ @@ -111,7 +111,7 @@ Hexadecimal value as a Buffer. #### Defined in -[lib/utils/hex.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L32) +[src/lib/utils/hex.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L32) ___ @@ -127,7 +127,7 @@ Hexadecimal string prefixed with '0x'. #### Defined in -[lib/utils/hex.ts:46](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L46) +[src/lib/utils/hex.ts:46](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L46) ___ @@ -143,7 +143,7 @@ Unprefixed hexadecimal string. #### Defined in -[lib/utils/hex.ts:39](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L39) +[src/lib/utils/hex.ts:39](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L39) ___ @@ -163,4 +163,4 @@ ___ #### Defined in -[lib/utils/hex.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L25) +[src/lib/utils/hex.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/hex.ts#L25) diff --git a/typescript/api-reference/classes/LedgerLiveEthereumSigner.md b/typescript/api-reference/classes/LedgerLiveEthereumSigner.md new file mode 100644 index 000000000..f079f00a1 --- /dev/null +++ b/typescript/api-reference/classes/LedgerLiveEthereumSigner.md @@ -0,0 +1,660 @@ +# Class: LedgerLiveEthereumSigner + +Ethereum signer extended from `ethers` Signer class. The main purpose of it +is to allow the user to communicate with eth contracts through our tBTC SDK +inside Ledger Live application, when the app is used there as a Live App. + +## Hierarchy + +- `Signer` + + ↳ **`LedgerLiveEthereumSigner`** + +## Table of contents + +### Constructors + +- [constructor](LedgerLiveEthereumSigner.md#constructor) + +### Properties + +- [\_account](LedgerLiveEthereumSigner.md#_account) +- [\_isSigner](LedgerLiveEthereumSigner.md#_issigner) +- [\_walletApiClient](LedgerLiveEthereumSigner.md#_walletapiclient) +- [\_windowMessageTransport](LedgerLiveEthereumSigner.md#_windowmessagetransport) +- [provider](LedgerLiveEthereumSigner.md#provider) + +### Accessors + +- [account](LedgerLiveEthereumSigner.md#account) + +### Methods + +- [\_catchWalletApiError](LedgerLiveEthereumSigner.md#_catchwalletapierror) +- [\_checkAccount](LedgerLiveEthereumSigner.md#_checkaccount) +- [\_checkProvider](LedgerLiveEthereumSigner.md#_checkprovider) +- [\_checkProviderAndAccount](LedgerLiveEthereumSigner.md#_checkproviderandaccount) +- [\_getWalletApiEthereumTransaction](LedgerLiveEthereumSigner.md#_getwalletapiethereumtransaction) +- [call](LedgerLiveEthereumSigner.md#call) +- [checkTransaction](LedgerLiveEthereumSigner.md#checktransaction) +- [connect](LedgerLiveEthereumSigner.md#connect) +- [estimateGas](LedgerLiveEthereumSigner.md#estimategas) +- [getAccountId](LedgerLiveEthereumSigner.md#getaccountid) +- [getAddress](LedgerLiveEthereumSigner.md#getaddress) +- [getBalance](LedgerLiveEthereumSigner.md#getbalance) +- [getChainId](LedgerLiveEthereumSigner.md#getchainid) +- [getFeeData](LedgerLiveEthereumSigner.md#getfeedata) +- [getGasPrice](LedgerLiveEthereumSigner.md#getgasprice) +- [getTransactionCount](LedgerLiveEthereumSigner.md#gettransactioncount) +- [populateTransaction](LedgerLiveEthereumSigner.md#populatetransaction) +- [requestAccount](LedgerLiveEthereumSigner.md#requestaccount) +- [resolveName](LedgerLiveEthereumSigner.md#resolvename) +- [sendTransaction](LedgerLiveEthereumSigner.md#sendtransaction) +- [setAccount](LedgerLiveEthereumSigner.md#setaccount) +- [signMessage](LedgerLiveEthereumSigner.md#signmessage) +- [signTransaction](LedgerLiveEthereumSigner.md#signtransaction) +- [isSigner](LedgerLiveEthereumSigner.md#issigner) + +## Constructors + +### constructor + +• **new LedgerLiveEthereumSigner**(`provider?`): [`LedgerLiveEthereumSigner`](LedgerLiveEthereumSigner.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `provider?` | `Provider` | + +#### Returns + +[`LedgerLiveEthereumSigner`](LedgerLiveEthereumSigner.md) + +#### Overrides + +Signer.constructor + +#### Defined in + +[src/lib/utils/ledger.ts:31](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L31) + +## Properties + +### \_account + +• `Private` **\_account**: `undefined` \| `Account` + +#### Defined in + +[src/lib/utils/ledger.ts:29](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L29) + +___ + +### \_isSigner + +• `Readonly` **\_isSigner**: `boolean` + +#### Inherited from + +Signer.\_isSigner + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 + +___ + +### \_walletApiClient + +• `Private` **\_walletApiClient**: `WalletAPIClient`\<`CustomModule`, (`client`: `WalletAPIClient`\<`CustomModule`, (client: WalletAPIClient\) =\> CustomModule \| Record\\>) => `CustomModule` \| `Record`\<`string`, `CustomModule`\>\> + +#### Defined in + +[src/lib/utils/ledger.ts:27](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L27) + +___ + +### \_windowMessageTransport + +• `Private` **\_windowMessageTransport**: `default` + +#### Defined in + +[src/lib/utils/ledger.ts:28](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L28) + +___ + +### provider + +• `Optional` `Readonly` **provider**: `Provider` + +#### Inherited from + +Signer.provider + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 + +## Accessors + +### account + +• `get` **account**(): `undefined` \| `Account` + +#### Returns + +`undefined` \| `Account` + +#### Defined in + +[src/lib/utils/ledger.ts:61](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L61) + +## Methods + +### \_catchWalletApiError + +▸ **_catchWalletApiError**(`error?`, `defaultErrorMessage?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error?` | `any` | +| `defaultErrorMessage?` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/lib/utils/ledger.ts:49](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L49) + +___ + +### \_checkAccount + +▸ **_checkAccount**(): `void` + +#### Returns + +`void` + +#### Defined in + +[src/lib/utils/ledger.ts:38](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L38) + +___ + +### \_checkProvider + +▸ **_checkProvider**(`operation?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operation?` | `string` | + +#### Returns + +`void` + +#### Inherited from + +Signer.\_checkProvider + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 + +___ + +### \_checkProviderAndAccount + +▸ **_checkProviderAndAccount**(): `void` + +#### Returns + +`void` + +#### Defined in + +[src/lib/utils/ledger.ts:44](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L44) + +___ + +### \_getWalletApiEthereumTransaction + +▸ **_getWalletApiEthereumTransaction**(`transaction`): `EthereumTransaction` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `TransactionRequest` | + +#### Returns + +`EthereumTransaction` + +#### Defined in + +[src/lib/utils/ledger.ts:98](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L98) + +___ + +### call + +▸ **call**(`transaction`, `blockTag?`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +Signer.call + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 + +___ + +### checkTransaction + +▸ **checkTransaction**(`transaction`): `Deferrable`\<`TransactionRequest`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | + +#### Returns + +`Deferrable`\<`TransactionRequest`\> + +#### Inherited from + +Signer.checkTransaction + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 + +___ + +### connect + +▸ **connect**(`provider`): `Signer` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `provider` | `Provider` | + +#### Returns + +`Signer` + +#### Overrides + +Signer.connect + +#### Defined in + +[src/lib/utils/ledger.ts:221](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L221) + +___ + +### estimateGas + +▸ **estimateGas**(`transaction`): `Promise`\<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | + +#### Returns + +`Promise`\<`BigNumber`\> + +#### Inherited from + +Signer.estimateGas + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 + +___ + +### getAccountId + +▸ **getAccountId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/lib/utils/ledger.ts:88](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L88) + +___ + +### getAddress + +▸ **getAddress**(): `Promise`\<`string`\> + +#### Returns + +`Promise`\<`string`\> + +#### Overrides + +Signer.getAddress + +#### Defined in + +[src/lib/utils/ledger.ts:93](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L93) + +___ + +### getBalance + +▸ **getBalance**(`blockTag?`): `Promise`\<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`\<`BigNumber`\> + +#### Inherited from + +Signer.getBalance + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 + +___ + +### getChainId + +▸ **getChainId**(): `Promise`\<`number`\> + +#### Returns + +`Promise`\<`number`\> + +#### Inherited from + +Signer.getChainId + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 + +___ + +### getFeeData + +▸ **getFeeData**(): `Promise`\<`FeeData`\> + +#### Returns + +`Promise`\<`FeeData`\> + +#### Inherited from + +Signer.getFeeData + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 + +___ + +### getGasPrice + +▸ **getGasPrice**(): `Promise`\<`BigNumber`\> + +#### Returns + +`Promise`\<`BigNumber`\> + +#### Inherited from + +Signer.getGasPrice + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 + +___ + +### getTransactionCount + +▸ **getTransactionCount**(`blockTag?`): `Promise`\<`number`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`\<`number`\> + +#### Inherited from + +Signer.getTransactionCount + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 + +___ + +### populateTransaction + +▸ **populateTransaction**(`transaction`): `Promise`\<`TransactionRequest`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | + +#### Returns + +`Promise`\<`TransactionRequest`\> + +#### Inherited from + +Signer.populateTransaction + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 + +___ + +### requestAccount + +▸ **requestAccount**(`params`): `Promise`\<`Account`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `undefined` \| \{ `currencyIds?`: `string`[] } | + +#### Returns + +`Promise`\<`Account`\> + +#### Defined in + +[src/lib/utils/ledger.ts:69](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L69) + +___ + +### resolveName + +▸ **resolveName**(`name`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +Signer.resolveName + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 + +___ + +### sendTransaction + +▸ **sendTransaction**(`transaction`): `Promise`\<`TransactionResponse`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | + +#### Returns + +`Promise`\<`TransactionResponse`\> + +#### Overrides + +Signer.sendTransaction + +#### Defined in + +[src/lib/utils/ledger.ts:185](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L185) + +___ + +### setAccount + +▸ **setAccount**(`account`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `account` | `undefined` \| `Account` | + +#### Returns + +`void` + +#### Defined in + +[src/lib/utils/ledger.ts:65](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L65) + +___ + +### signMessage + +▸ **signMessage**(`message`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Overrides + +Signer.signMessage + +#### Defined in + +[src/lib/utils/ledger.ts:138](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L138) + +___ + +### signTransaction + +▸ **signTransaction**(`transaction`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `TransactionRequest` | + +#### Returns + +`Promise`\<`string`\> + +#### Overrides + +Signer.signTransaction + +#### Defined in + +[src/lib/utils/ledger.ts:159](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/utils/ledger.ts#L159) + +___ + +### isSigner + +▸ **isSigner**(`value`): value is Signer + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +value is Signer + +#### Inherited from + +Signer.isSigner + +#### Defined in + +node_modules/@ethersproject/contracts/node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/typescript/api-reference/classes/MaintenanceService.md b/typescript/api-reference/classes/MaintenanceService.md index 22efdffb5..f565a1cd9 100644 --- a/typescript/api-reference/classes/MaintenanceService.md +++ b/typescript/api-reference/classes/MaintenanceService.md @@ -33,7 +33,7 @@ operators of the tBTC v2 system. #### Defined in -[services/maintenance/maintenance-service.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/maintenance-service.ts#L20) +[src/services/maintenance/maintenance-service.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/maintenance-service.ts#L20) ## Properties @@ -45,7 +45,7 @@ Features for optimistic minting maintainers. #### Defined in -[services/maintenance/maintenance-service.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/maintenance-service.ts#L14) +[src/services/maintenance/maintenance-service.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/maintenance-service.ts#L14) ___ @@ -57,4 +57,4 @@ Features for SPV proof maintainers. #### Defined in -[services/maintenance/maintenance-service.ts:18](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/maintenance-service.ts#L18) +[src/services/maintenance/maintenance-service.ts:18](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/maintenance-service.ts#L18) diff --git a/typescript/api-reference/classes/OptimisticMinting.md b/typescript/api-reference/classes/OptimisticMinting.md index 4c5fe6b04..21883c613 100644 --- a/typescript/api-reference/classes/OptimisticMinting.md +++ b/typescript/api-reference/classes/OptimisticMinting.md @@ -35,7 +35,7 @@ #### Defined in -[services/maintenance/optimistic-minting.ts:9](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L9) +[src/services/maintenance/optimistic-minting.ts:9](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L9) ## Properties @@ -45,7 +45,7 @@ #### Defined in -[services/maintenance/optimistic-minting.ts:7](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L7) +[src/services/maintenance/optimistic-minting.ts:7](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L7) ## Methods @@ -70,7 +70,7 @@ Transaction hash of the optimistic mint cancel transaction. #### Defined in -[services/maintenance/optimistic-minting.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L37) +[src/services/maintenance/optimistic-minting.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L37) ___ @@ -95,7 +95,7 @@ Transaction hash of the optimistic mint finalize transaction. #### Defined in -[services/maintenance/optimistic-minting.ts:54](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L54) +[src/services/maintenance/optimistic-minting.ts:54](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L54) ___ @@ -120,7 +120,7 @@ Optimistic minting request. #### Defined in -[services/maintenance/optimistic-minting.ts:71](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L71) +[src/services/maintenance/optimistic-minting.ts:71](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L71) ___ @@ -145,4 +145,4 @@ Transaction hash of the optimistic mint request transaction. #### Defined in -[services/maintenance/optimistic-minting.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L20) +[src/services/maintenance/optimistic-minting.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/optimistic-minting.ts#L20) diff --git a/typescript/api-reference/classes/RedemptionsService.md b/typescript/api-reference/classes/RedemptionsService.md index be69d387b..d83ad0514 100644 --- a/typescript/api-reference/classes/RedemptionsService.md +++ b/typescript/api-reference/classes/RedemptionsService.md @@ -39,7 +39,7 @@ Service exposing features related to tBTC v2 redemptions. #### Defined in -[services/redemptions/redemptions-service.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L30) +[src/services/redemptions/redemptions-service.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L30) ## Properties @@ -51,7 +51,7 @@ Bitcoin client handle. #### Defined in -[services/redemptions/redemptions-service.ts:28](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L28) +[src/services/redemptions/redemptions-service.ts:28](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L28) ___ @@ -63,7 +63,7 @@ Handle to tBTC contracts. #### Defined in -[services/redemptions/redemptions-service.ts:24](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L24) +[src/services/redemptions/redemptions-service.ts:24](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L24) ## Methods @@ -90,7 +90,7 @@ Promise holding the wallet main UTXO or undefined value. #### Defined in -[services/redemptions/redemptions-service.ts:225](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L225) +[src/services/redemptions/redemptions-service.ts:225](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L225) ___ @@ -116,7 +116,7 @@ Promise with the wallet details needed to request a redemption. #### Defined in -[services/redemptions/redemptions-service.ts:106](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L106) +[src/services/redemptions/redemptions-service.ts:106](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L106) ___ @@ -147,7 +147,7 @@ Throws an error if no redemption request exists for the given #### Defined in -[services/redemptions/redemptions-service.ts:337](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L337) +[src/services/redemptions/redemptions-service.ts:337](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L337) ___ @@ -176,4 +176,4 @@ Object containing: #### Defined in -[services/redemptions/redemptions-service.ts:48](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L48) +[src/services/redemptions/redemptions-service.ts:48](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/redemptions/redemptions-service.ts#L48) diff --git a/typescript/api-reference/classes/Spv.md b/typescript/api-reference/classes/Spv.md index 2fdf8ae10..e48f8da79 100644 --- a/typescript/api-reference/classes/Spv.md +++ b/typescript/api-reference/classes/Spv.md @@ -35,7 +35,7 @@ #### Defined in -[services/maintenance/spv.ts:21](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L21) +[src/services/maintenance/spv.ts:21](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L21) ## Properties @@ -47,7 +47,7 @@ Bitcoin client handle. #### Defined in -[services/maintenance/spv.ts:19](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L19) +[src/services/maintenance/spv.ts:19](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L19) ___ @@ -59,7 +59,7 @@ Handle to tBTC contracts. #### Defined in -[services/maintenance/spv.ts:15](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L15) +[src/services/maintenance/spv.ts:15](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L15) ## Methods @@ -86,7 +86,7 @@ Empty promise. #### Defined in -[services/maintenance/spv.ts:34](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L34) +[src/services/maintenance/spv.ts:34](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L34) ___ @@ -113,4 +113,4 @@ Empty promise. #### Defined in -[services/maintenance/spv.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L67) +[src/services/maintenance/spv.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/spv.ts#L67) diff --git a/typescript/api-reference/classes/TBTC.md b/typescript/api-reference/classes/TBTC.md index 3317f5fde..c4aa77cce 100644 --- a/typescript/api-reference/classes/TBTC.md +++ b/typescript/api-reference/classes/TBTC.md @@ -42,7 +42,7 @@ Entrypoint component of the tBTC v2 SDK. #### Defined in -[services/tbtc.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L40) +[src/services/tbtc.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L40) ## Properties @@ -54,7 +54,7 @@ Bitcoin client handle for low-level access. #### Defined in -[services/tbtc.ts:38](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L38) +[src/services/tbtc.ts:38](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L38) ___ @@ -66,7 +66,7 @@ Service supporting the tBTC v2 deposit flow. #### Defined in -[services/tbtc.ts:21](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L21) +[src/services/tbtc.ts:21](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L21) ___ @@ -79,7 +79,7 @@ and operators. #### Defined in -[services/tbtc.ts:26](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L26) +[src/services/tbtc.ts:26](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L26) ___ @@ -91,7 +91,7 @@ Service supporting the tBTC v2 redemption flow. #### Defined in -[services/tbtc.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L30) +[src/services/tbtc.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L30) ___ @@ -103,7 +103,7 @@ Handle to tBTC contracts for low-level access. #### Defined in -[services/tbtc.ts:34](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L34) +[src/services/tbtc.ts:34](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L34) ## Methods @@ -135,7 +135,7 @@ This function is especially useful for local development as it gives #### Defined in -[services/tbtc.ts:117](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L117) +[src/services/tbtc.ts:117](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L117) ___ @@ -168,7 +168,7 @@ Throws an error if the underlying signer's Ethereum network is #### Defined in -[services/tbtc.ts:88](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L88) +[src/services/tbtc.ts:88](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L88) ___ @@ -199,7 +199,7 @@ Throws an error if the signer's Ethereum network is other than #### Defined in -[services/tbtc.ts:73](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L73) +[src/services/tbtc.ts:73](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L73) ___ @@ -230,4 +230,4 @@ Throws an error if the signer's Ethereum network is other than #### Defined in -[services/tbtc.ts:60](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L60) +[src/services/tbtc.ts:60](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/tbtc.ts#L60) diff --git a/typescript/api-reference/classes/WalletTx.md b/typescript/api-reference/classes/WalletTx.md index f3371bf4f..93b406471 100644 --- a/typescript/api-reference/classes/WalletTx.md +++ b/typescript/api-reference/classes/WalletTx.md @@ -40,7 +40,7 @@ using threshold signature schemes. #### Defined in -[services/maintenance/wallet-tx.ts:48](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/wallet-tx.ts#L48) +[src/services/maintenance/wallet-tx.ts:48](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/wallet-tx.ts#L48) ## Properties @@ -50,7 +50,7 @@ using threshold signature schemes. #### Defined in -[services/maintenance/wallet-tx.ts:45](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/wallet-tx.ts#L45) +[src/services/maintenance/wallet-tx.ts:45](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/wallet-tx.ts#L45) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[services/maintenance/wallet-tx.ts:46](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/wallet-tx.ts#L46) +[src/services/maintenance/wallet-tx.ts:46](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/services/maintenance/wallet-tx.ts#L46) diff --git a/typescript/api-reference/enums/BitcoinNetwork-1.md b/typescript/api-reference/enums/BitcoinNetwork-1.md index 0b7b11044..4045a9027 100644 --- a/typescript/api-reference/enums/BitcoinNetwork-1.md +++ b/typescript/api-reference/enums/BitcoinNetwork-1.md @@ -20,7 +20,7 @@ Bitcoin Mainnet. #### Defined in -[lib/bitcoin/network.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L20) +[src/lib/bitcoin/network.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L20) ___ @@ -32,7 +32,7 @@ Bitcoin Testnet. #### Defined in -[lib/bitcoin/network.ts:16](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L16) +[src/lib/bitcoin/network.ts:16](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L16) ___ @@ -44,4 +44,4 @@ Unknown network. #### Defined in -[lib/bitcoin/network.ts:12](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L12) +[src/lib/bitcoin/network.ts:12](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L12) diff --git a/typescript/api-reference/enums/WalletState-1.md b/typescript/api-reference/enums/WalletState-1.md index f31266409..c48e3da3f 100644 --- a/typescript/api-reference/enums/WalletState-1.md +++ b/typescript/api-reference/enums/WalletState-1.md @@ -22,7 +22,7 @@ any action in the Bridge. #### Defined in -[lib/contracts/bridge.ts:371](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L371) +[src/lib/contracts/bridge.ts:371](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L371) ___ @@ -36,7 +36,7 @@ and must defend against them. #### Defined in -[lib/contracts/bridge.ts:366](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L366) +[src/lib/contracts/bridge.ts:366](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L366) ___ @@ -48,7 +48,7 @@ The wallet can sweep deposits and accept redemption requests. #### Defined in -[lib/contracts/bridge.ts:353](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L353) +[src/lib/contracts/bridge.ts:353](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L353) ___ @@ -63,7 +63,7 @@ accepted. #### Defined in -[lib/contracts/bridge.ts:360](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L360) +[src/lib/contracts/bridge.ts:360](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L360) ___ @@ -78,7 +78,7 @@ any actions in the Bridge. #### Defined in -[lib/contracts/bridge.ts:378](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L378) +[src/lib/contracts/bridge.ts:378](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L378) ___ @@ -90,4 +90,4 @@ The wallet is unknown to the Bridge. #### Defined in -[lib/contracts/bridge.ts:349](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L349) +[src/lib/contracts/bridge.ts:349](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L349) diff --git a/typescript/api-reference/interfaces/BitcoinClient.md b/typescript/api-reference/interfaces/BitcoinClient.md index 3afac0bdd..49b8c4a10 100644 --- a/typescript/api-reference/interfaces/BitcoinClient.md +++ b/typescript/api-reference/interfaces/BitcoinClient.md @@ -42,7 +42,7 @@ Broadcasts the given transaction over the network. #### Defined in -[lib/bitcoin/client.ts:101](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L101) +[src/lib/bitcoin/client.ts:101](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L101) ___ @@ -66,7 +66,7 @@ List of UTXOs. #### Defined in -[lib/bitcoin/client.ts:21](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L21) +[src/lib/bitcoin/client.ts:21](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L21) ___ @@ -91,7 +91,7 @@ Concatenation of block headers in a hexadecimal format. #### Defined in -[lib/bitcoin/client.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L84) +[src/lib/bitcoin/client.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L84) ___ @@ -109,7 +109,7 @@ Bitcoin network. #### Defined in -[lib/bitcoin/client.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L14) +[src/lib/bitcoin/client.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L14) ___ @@ -133,7 +133,7 @@ Raw transaction. #### Defined in -[lib/bitcoin/client.ts:47](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L47) +[src/lib/bitcoin/client.ts:47](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L47) ___ @@ -157,7 +157,7 @@ Transaction object. #### Defined in -[lib/bitcoin/client.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L40) +[src/lib/bitcoin/client.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L40) ___ @@ -182,7 +182,7 @@ The number of confirmations. #### Defined in -[lib/bitcoin/client.ts:55](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L55) +[src/lib/bitcoin/client.ts:55](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L55) ___ @@ -208,7 +208,7 @@ at the moment of request. #### Defined in -[lib/bitcoin/client.ts:33](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L33) +[src/lib/bitcoin/client.ts:33](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L33) ___ @@ -233,7 +233,7 @@ Merkle branch. #### Defined in -[lib/bitcoin/client.ts:92](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L92) +[src/lib/bitcoin/client.ts:92](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L92) ___ @@ -263,7 +263,7 @@ Array of confirmed transaction hashes related to the provided #### Defined in -[lib/bitcoin/client.ts:69](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L69) +[src/lib/bitcoin/client.ts:69](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L69) ___ @@ -281,4 +281,4 @@ Height of the last mined block. #### Defined in -[lib/bitcoin/client.ts:75](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L75) +[src/lib/bitcoin/client.ts:75](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/client.ts#L75) diff --git a/typescript/api-reference/interfaces/BitcoinHeader.md b/typescript/api-reference/interfaces/BitcoinHeader.md index 731675c74..b66bf7c90 100644 --- a/typescript/api-reference/interfaces/BitcoinHeader.md +++ b/typescript/api-reference/interfaces/BitcoinHeader.md @@ -25,7 +25,7 @@ less than or equal to. The field is 4-byte long. #### Defined in -[lib/bitcoin/header.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L37) +[src/lib/bitcoin/header.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L37) ___ @@ -38,7 +38,7 @@ The field is 32-byte long. #### Defined in -[lib/bitcoin/header.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L25) +[src/lib/bitcoin/header.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L25) ___ @@ -52,7 +52,7 @@ produce a hash less than or equal to the target threshold. The field is #### Defined in -[lib/bitcoin/header.ts:44](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L44) +[src/lib/bitcoin/header.ts:44](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L44) ___ @@ -64,7 +64,7 @@ The hash of the previous block's header. The field is 32-byte long. #### Defined in -[lib/bitcoin/header.ts:19](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L19) +[src/lib/bitcoin/header.ts:19](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L19) ___ @@ -77,7 +77,7 @@ The Unix epoch time when the miner started hashing the header. The field is #### Defined in -[lib/bitcoin/header.ts:31](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L31) +[src/lib/bitcoin/header.ts:31](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L31) ___ @@ -90,4 +90,4 @@ to follow. The field is 4-byte long. #### Defined in -[lib/bitcoin/header.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L14) +[src/lib/bitcoin/header.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/header.ts#L14) diff --git a/typescript/api-reference/interfaces/BitcoinRawTx.md b/typescript/api-reference/interfaces/BitcoinRawTx.md index f1b4f45b1..248c75209 100644 --- a/typescript/api-reference/interfaces/BitcoinRawTx.md +++ b/typescript/api-reference/interfaces/BitcoinRawTx.md @@ -18,4 +18,4 @@ The full transaction payload as an un-prefixed hex string. #### Defined in -[lib/bitcoin/tx.ts:22](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L22) +[src/lib/bitcoin/tx.ts:22](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L22) diff --git a/typescript/api-reference/interfaces/BitcoinRawTxVectors.md b/typescript/api-reference/interfaces/BitcoinRawTxVectors.md index a541515d1..ace8204a6 100644 --- a/typescript/api-reference/interfaces/BitcoinRawTxVectors.md +++ b/typescript/api-reference/interfaces/BitcoinRawTxVectors.md @@ -22,7 +22,7 @@ as a hex string. #### Defined in -[lib/bitcoin/tx.ts:113](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L113) +[src/lib/bitcoin/tx.ts:113](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L113) ___ @@ -34,7 +34,7 @@ Transaction locktime as a hex string. #### Defined in -[lib/bitcoin/tx.ts:124](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L124) +[src/lib/bitcoin/tx.ts:124](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L124) ___ @@ -47,7 +47,7 @@ as a hex string. #### Defined in -[lib/bitcoin/tx.ts:119](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L119) +[src/lib/bitcoin/tx.ts:119](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L119) ___ @@ -59,4 +59,4 @@ Transaction version as a hex string. #### Defined in -[lib/bitcoin/tx.ts:107](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L107) +[src/lib/bitcoin/tx.ts:107](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L107) diff --git a/typescript/api-reference/interfaces/BitcoinSpvProof.md b/typescript/api-reference/interfaces/BitcoinSpvProof.md index 7c06b4549..81058b45f 100644 --- a/typescript/api-reference/interfaces/BitcoinSpvProof.md +++ b/typescript/api-reference/interfaces/BitcoinSpvProof.md @@ -22,7 +22,7 @@ Concatenated block headers in hexadecimal format. Each block header is #### Defined in -[lib/bitcoin/spv.ts:31](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L31) +[src/lib/bitcoin/spv.ts:31](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L31) ___ @@ -34,7 +34,7 @@ The merkle proof of transaction inclusion in a block. #### Defined in -[lib/bitcoin/spv.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L20) +[src/lib/bitcoin/spv.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L20) ___ @@ -46,4 +46,4 @@ Transaction index in the block (0-indexed). #### Defined in -[lib/bitcoin/spv.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L25) +[src/lib/bitcoin/spv.ts:25](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L25) diff --git a/typescript/api-reference/interfaces/BitcoinTx.md b/typescript/api-reference/interfaces/BitcoinTx.md index aad847f53..982a28136 100644 --- a/typescript/api-reference/interfaces/BitcoinTx.md +++ b/typescript/api-reference/interfaces/BitcoinTx.md @@ -20,7 +20,7 @@ The vector of transaction inputs. #### Defined in -[lib/bitcoin/tx.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L37) +[src/lib/bitcoin/tx.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L37) ___ @@ -32,7 +32,7 @@ The vector of transaction outputs. #### Defined in -[lib/bitcoin/tx.ts:42](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L42) +[src/lib/bitcoin/tx.ts:42](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L42) ___ @@ -44,4 +44,4 @@ The transaction hash (or transaction ID) as an un-prefixed hex string. #### Defined in -[lib/bitcoin/tx.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L32) +[src/lib/bitcoin/tx.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L32) diff --git a/typescript/api-reference/interfaces/BitcoinTxMerkleBranch.md b/typescript/api-reference/interfaces/BitcoinTxMerkleBranch.md index df3aac29e..94c74a9c9 100644 --- a/typescript/api-reference/interfaces/BitcoinTxMerkleBranch.md +++ b/typescript/api-reference/interfaces/BitcoinTxMerkleBranch.md @@ -20,7 +20,7 @@ The height of the block the transaction was confirmed in. #### Defined in -[lib/bitcoin/spv.ts:41](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L41) +[src/lib/bitcoin/spv.ts:41](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L41) ___ @@ -34,7 +34,7 @@ the deepest pairing first. Each hash is an unprefixed hex string. #### Defined in -[lib/bitcoin/spv.ts:48](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L48) +[src/lib/bitcoin/spv.ts:48](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L48) ___ @@ -46,4 +46,4 @@ The 0-based index of the transaction's position in the block. #### Defined in -[lib/bitcoin/spv.ts:53](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L53) +[src/lib/bitcoin/spv.ts:53](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/spv.ts#L53) diff --git a/typescript/api-reference/interfaces/BitcoinTxOutpoint.md b/typescript/api-reference/interfaces/BitcoinTxOutpoint.md index e6bff27c7..fa9aa37b3 100644 --- a/typescript/api-reference/interfaces/BitcoinTxOutpoint.md +++ b/typescript/api-reference/interfaces/BitcoinTxOutpoint.md @@ -19,7 +19,7 @@ The zero-based index of the output from the specified transaction. #### Defined in -[lib/bitcoin/tx.ts:57](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L57) +[src/lib/bitcoin/tx.ts:57](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L57) ___ @@ -31,4 +31,4 @@ The hash of the transaction the outpoint belongs to. #### Defined in -[lib/bitcoin/tx.ts:52](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L52) +[src/lib/bitcoin/tx.ts:52](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L52) diff --git a/typescript/api-reference/interfaces/BitcoinTxOutput.md b/typescript/api-reference/interfaces/BitcoinTxOutput.md index d364b1206..6defd54fb 100644 --- a/typescript/api-reference/interfaces/BitcoinTxOutput.md +++ b/typescript/api-reference/interfaces/BitcoinTxOutput.md @@ -20,7 +20,7 @@ The 0-based index of the output. #### Defined in -[lib/bitcoin/tx.ts:77](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L77) +[src/lib/bitcoin/tx.ts:77](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L77) ___ @@ -32,7 +32,7 @@ The receiving scriptPubKey. #### Defined in -[lib/bitcoin/tx.ts:87](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L87) +[src/lib/bitcoin/tx.ts:87](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L87) ___ @@ -44,4 +44,4 @@ The value of the output in satoshis. #### Defined in -[lib/bitcoin/tx.ts:82](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L82) +[src/lib/bitcoin/tx.ts:82](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/tx.ts#L82) diff --git a/typescript/api-reference/interfaces/Bridge.md b/typescript/api-reference/interfaces/Bridge.md index 1282c848f..d97ba6b0e 100644 --- a/typescript/api-reference/interfaces/Bridge.md +++ b/typescript/api-reference/interfaces/Bridge.md @@ -44,7 +44,7 @@ GetEventsFunction #### Defined in -[lib/contracts/bridge.ts:26](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L26) +[src/lib/contracts/bridge.ts:26](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L26) ___ @@ -60,7 +60,7 @@ GetEventsFunction #### Defined in -[lib/contracts/bridge.ts:155](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L155) +[src/lib/contracts/bridge.ts:155](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L155) ___ @@ -76,7 +76,7 @@ GetEventsFunction #### Defined in -[lib/contracts/bridge.ts:181](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L181) +[src/lib/contracts/bridge.ts:181](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L181) ## Methods @@ -96,7 +96,7 @@ Compressed (33 bytes long with 02 or 03 prefix) active wallet's #### Defined in -[lib/contracts/bridge.ts:149](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L149) +[src/lib/contracts/bridge.ts:149](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L149) ___ @@ -120,7 +120,7 @@ The hash of the UTXO. #### Defined in -[lib/contracts/bridge.ts:175](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L175) +[src/lib/contracts/bridge.ts:175](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L175) ___ @@ -145,7 +145,7 @@ Revealed deposit data. #### Defined in -[lib/contracts/bridge.ts:68](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L68) +[src/lib/contracts/bridge.ts:68](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L68) ___ @@ -161,7 +161,7 @@ Gets the chain-specific identifier of this contract. #### Defined in -[lib/contracts/bridge.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L20) +[src/lib/contracts/bridge.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L20) ___ @@ -186,7 +186,7 @@ Promise with the pending redemption. #### Defined in -[lib/contracts/bridge.ts:124](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L124) +[src/lib/contracts/bridge.ts:124](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L124) ___ @@ -213,7 +213,7 @@ Transaction hash of the request redemption transaction. #### Defined in -[lib/contracts/bridge.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L84) +[src/lib/contracts/bridge.ts:84](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L84) ___ @@ -240,7 +240,7 @@ Transaction hash of the reveal deposit transaction. #### Defined in -[lib/contracts/bridge.ts:54](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L54) +[src/lib/contracts/bridge.ts:54](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L54) ___ @@ -267,7 +267,7 @@ Transaction hash of the submit deposit sweep proof transaction. #### Defined in -[lib/contracts/bridge.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L37) +[src/lib/contracts/bridge.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L37) ___ @@ -294,7 +294,7 @@ Transaction hash of the submit redemption proof transaction. #### Defined in -[lib/contracts/bridge.ts:100](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L100) +[src/lib/contracts/bridge.ts:100](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L100) ___ @@ -319,7 +319,7 @@ Promise with the pending redemption. #### Defined in -[lib/contracts/bridge.ts:138](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L138) +[src/lib/contracts/bridge.ts:138](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L138) ___ @@ -342,7 +342,7 @@ This number signifies how many confirmations a transaction has to #### Defined in -[lib/contracts/bridge.ts:113](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L113) +[src/lib/contracts/bridge.ts:113](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L113) ___ @@ -358,7 +358,7 @@ Returns the attached WalletRegistry instance. #### Defined in -[lib/contracts/bridge.ts:160](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L160) +[src/lib/contracts/bridge.ts:160](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L160) ___ @@ -382,4 +382,4 @@ Promise with the wallet details. #### Defined in -[lib/contracts/bridge.ts:168](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L168) +[src/lib/contracts/bridge.ts:168](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L168) diff --git a/typescript/api-reference/interfaces/ChainEvent.md b/typescript/api-reference/interfaces/ChainEvent.md index afc8f0b7a..380791ade 100644 --- a/typescript/api-reference/interfaces/ChainEvent.md +++ b/typescript/api-reference/interfaces/ChainEvent.md @@ -20,7 +20,7 @@ Block hash of the event emission. #### Defined in -[lib/contracts/chain-event.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L14) +[src/lib/contracts/chain-event.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L14) ___ @@ -32,7 +32,7 @@ Block number of the event emission. #### Defined in -[lib/contracts/chain-event.ts:10](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L10) +[src/lib/contracts/chain-event.ts:10](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L10) ___ @@ -44,4 +44,4 @@ Transaction hash within which the event was emitted. #### Defined in -[lib/contracts/chain-event.ts:18](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L18) +[src/lib/contracts/chain-event.ts:18](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L18) diff --git a/typescript/api-reference/interfaces/ChainIdentifier.md b/typescript/api-reference/interfaces/ChainIdentifier.md index a5a08597a..fb3275ee6 100644 --- a/typescript/api-reference/interfaces/ChainIdentifier.md +++ b/typescript/api-reference/interfaces/ChainIdentifier.md @@ -26,7 +26,7 @@ Identifier as an un-prefixed hex string. #### Defined in -[lib/contracts/chain-identifier.ts:8](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-identifier.ts#L8) +[src/lib/contracts/chain-identifier.ts:8](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-identifier.ts#L8) ## Methods @@ -48,4 +48,4 @@ Checks if two identifiers are equal. #### Defined in -[lib/contracts/chain-identifier.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-identifier.ts#L14) +[src/lib/contracts/chain-identifier.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-identifier.ts#L14) diff --git a/typescript/api-reference/interfaces/DepositReceipt.md b/typescript/api-reference/interfaces/DepositReceipt.md index 85f12c732..ecd74a655 100644 --- a/typescript/api-reference/interfaces/DepositReceipt.md +++ b/typescript/api-reference/interfaces/DepositReceipt.md @@ -24,7 +24,7 @@ public key and refund public key. #### Defined in -[lib/contracts/bridge.ts:198](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L198) +[src/lib/contracts/bridge.ts:198](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L198) ___ @@ -36,7 +36,7 @@ Depositor's chain identifier. #### Defined in -[lib/contracts/bridge.ts:192](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L192) +[src/lib/contracts/bridge.ts:192](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L192) ___ @@ -48,7 +48,7 @@ A 4-byte little-endian refund locktime. #### Defined in -[lib/contracts/bridge.ts:218](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L218) +[src/lib/contracts/bridge.ts:218](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L218) ___ @@ -63,7 +63,7 @@ You can use `computeHash160` function to get the hash from a public key. #### Defined in -[lib/contracts/bridge.ts:213](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L213) +[src/lib/contracts/bridge.ts:213](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L213) ___ @@ -77,4 +77,4 @@ You can use `computeHash160` function to get the hash from a public key. #### Defined in -[lib/contracts/bridge.ts:205](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L205) +[src/lib/contracts/bridge.ts:205](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L205) diff --git a/typescript/api-reference/interfaces/DepositRequest.md b/typescript/api-reference/interfaces/DepositRequest.md index 89b9d6ea2..c9cda320b 100644 --- a/typescript/api-reference/interfaces/DepositRequest.md +++ b/typescript/api-reference/interfaces/DepositRequest.md @@ -23,7 +23,7 @@ Deposit amount in satoshis. #### Defined in -[lib/contracts/bridge.ts:257](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L257) +[src/lib/contracts/bridge.ts:257](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L257) ___ @@ -35,7 +35,7 @@ Depositor's chain identifier. #### Defined in -[lib/contracts/bridge.ts:252](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L252) +[src/lib/contracts/bridge.ts:252](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L252) ___ @@ -47,7 +47,7 @@ UNIX timestamp the deposit was revealed at. #### Defined in -[lib/contracts/bridge.ts:267](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L267) +[src/lib/contracts/bridge.ts:267](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L267) ___ @@ -60,7 +60,7 @@ should have zero as value. #### Defined in -[lib/contracts/bridge.ts:272](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L272) +[src/lib/contracts/bridge.ts:272](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L272) ___ @@ -73,7 +73,7 @@ Denominated in satoshi. #### Defined in -[lib/contracts/bridge.ts:277](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L277) +[src/lib/contracts/bridge.ts:277](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L277) ___ @@ -85,4 +85,4 @@ Optional identifier of the vault the deposit should be routed in. #### Defined in -[lib/contracts/bridge.ts:262](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L262) +[src/lib/contracts/bridge.ts:262](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L262) diff --git a/typescript/api-reference/interfaces/ElectrumCredentials.md b/typescript/api-reference/interfaces/ElectrumCredentials.md index d72c5c2d4..dce90cd8b 100644 --- a/typescript/api-reference/interfaces/ElectrumCredentials.md +++ b/typescript/api-reference/interfaces/ElectrumCredentials.md @@ -20,7 +20,7 @@ Host pointing to the Electrum server. #### Defined in -[lib/electrum/client.ts:34](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L34) +[src/lib/electrum/client.ts:34](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L34) ___ @@ -32,7 +32,7 @@ Port the Electrum server listens on. #### Defined in -[lib/electrum/client.ts:38](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L38) +[src/lib/electrum/client.ts:38](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L38) ___ @@ -44,4 +44,4 @@ Protocol used by the Electrum server. #### Defined in -[lib/electrum/client.ts:42](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L42) +[src/lib/electrum/client.ts:42](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L42) diff --git a/typescript/api-reference/interfaces/EthereumContractConfig.md b/typescript/api-reference/interfaces/EthereumContractConfig.md index 49b8d1b50..abed960bc 100644 --- a/typescript/api-reference/interfaces/EthereumContractConfig.md +++ b/typescript/api-reference/interfaces/EthereumContractConfig.md @@ -22,7 +22,7 @@ contract artifact. #### Defined in -[lib/ethereum/adapter.ts:53](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L53) +[src/lib/ethereum/adapter.ts:53](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L53) ___ @@ -36,7 +36,7 @@ contract artifact. #### Defined in -[lib/ethereum/adapter.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L64) +[src/lib/ethereum/adapter.ts:64](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L64) ___ @@ -49,4 +49,4 @@ Provider - will return a downgraded Contract which only has read-only access (i. #### Defined in -[lib/ethereum/adapter.ts:58](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L58) +[src/lib/ethereum/adapter.ts:58](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/adapter.ts#L58) diff --git a/typescript/api-reference/interfaces/GetChainEvents.Function.md b/typescript/api-reference/interfaces/GetChainEvents.Function.md index 10c90d30d..80a5ee695 100644 --- a/typescript/api-reference/interfaces/GetChainEvents.Function.md +++ b/typescript/api-reference/interfaces/GetChainEvents.Function.md @@ -33,4 +33,4 @@ Array of found events. #### Defined in -[lib/contracts/chain-event.ts:60](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L60) +[src/lib/contracts/chain-event.ts:60](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L60) diff --git a/typescript/api-reference/interfaces/GetChainEvents.Options.md b/typescript/api-reference/interfaces/GetChainEvents.Options.md index eb17d6ac7..c2cde770a 100644 --- a/typescript/api-reference/interfaces/GetChainEvents.Options.md +++ b/typescript/api-reference/interfaces/GetChainEvents.Options.md @@ -24,7 +24,7 @@ Number of blocks for interval length in partial events pulls. #### Defined in -[lib/contracts/chain-event.ts:43](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L43) +[src/lib/contracts/chain-event.ts:43](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L43) ___ @@ -37,7 +37,7 @@ If not defined a block number of a contract deployment is used. #### Defined in -[lib/contracts/chain-event.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L30) +[src/lib/contracts/chain-event.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L30) ___ @@ -49,7 +49,7 @@ A logger function to pass execution messages. #### Defined in -[lib/contracts/chain-event.ts:47](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L47) +[src/lib/contracts/chain-event.ts:47](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L47) ___ @@ -61,7 +61,7 @@ Number of retries in case of an error getting the events. #### Defined in -[lib/contracts/chain-event.ts:39](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L39) +[src/lib/contracts/chain-event.ts:39](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L39) ___ @@ -74,4 +74,4 @@ If not defined the latest block number will be used. #### Defined in -[lib/contracts/chain-event.ts:35](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L35) +[src/lib/contracts/chain-event.ts:35](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/chain-event.ts#L35) diff --git a/typescript/api-reference/interfaces/RedemptionRequest.md b/typescript/api-reference/interfaces/RedemptionRequest.md index 5202c498e..864b07f4c 100644 --- a/typescript/api-reference/interfaces/RedemptionRequest.md +++ b/typescript/api-reference/interfaces/RedemptionRequest.md @@ -23,7 +23,7 @@ On-chain identifier of the redeemer. #### Defined in -[lib/contracts/bridge.ts:296](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L296) +[src/lib/contracts/bridge.ts:296](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L296) ___ @@ -36,7 +36,7 @@ prepended with length. #### Defined in -[lib/contracts/bridge.ts:302](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L302) +[src/lib/contracts/bridge.ts:302](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L302) ___ @@ -50,7 +50,7 @@ by the sum of the fee share and the treasury fee for this particular output. #### Defined in -[lib/contracts/bridge.ts:309](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L309) +[src/lib/contracts/bridge.ts:309](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L309) ___ @@ -62,7 +62,7 @@ UNIX timestamp the request was created at. #### Defined in -[lib/contracts/bridge.ts:328](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L328) +[src/lib/contracts/bridge.ts:328](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L328) ___ @@ -77,7 +77,7 @@ on-chain contract at the time the redemption request was made. #### Defined in -[lib/contracts/bridge.ts:317](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L317) +[src/lib/contracts/bridge.ts:317](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L317) ___ @@ -90,4 +90,4 @@ redemption's `requestedAmount` to pay the transaction network fee. #### Defined in -[lib/contracts/bridge.ts:323](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L323) +[src/lib/contracts/bridge.ts:323](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L323) diff --git a/typescript/api-reference/interfaces/TBTCToken.md b/typescript/api-reference/interfaces/TBTCToken.md index 3c8e0a182..e3e3347f4 100644 --- a/typescript/api-reference/interfaces/TBTCToken.md +++ b/typescript/api-reference/interfaces/TBTCToken.md @@ -28,7 +28,7 @@ Gets the chain-specific identifier of this contract. #### Defined in -[lib/contracts/tbtc-token.ts:13](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-token.ts#L13) +[src/lib/contracts/tbtc-token.ts:13](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-token.ts#L13) ___ @@ -58,7 +58,7 @@ Transaction hash of the approve and call transaction. #### Defined in -[lib/contracts/tbtc-token.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-token.ts#L40) +[src/lib/contracts/tbtc-token.ts:40](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-token.ts#L40) ___ @@ -82,4 +82,4 @@ with 1e8 precision in satoshi. #### Defined in -[lib/contracts/tbtc-token.ts:23](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-token.ts#L23) +[src/lib/contracts/tbtc-token.ts:23](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-token.ts#L23) diff --git a/typescript/api-reference/interfaces/TBTCVault.md b/typescript/api-reference/interfaces/TBTCVault.md index c7bead2a0..cd8177284 100644 --- a/typescript/api-reference/interfaces/TBTCVault.md +++ b/typescript/api-reference/interfaces/TBTCVault.md @@ -40,7 +40,7 @@ GetEventsFunction #### Defined in -[lib/contracts/tbtc-vault.ts:107](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L107) +[src/lib/contracts/tbtc-vault.ts:107](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L107) ___ @@ -56,7 +56,7 @@ GetEventsFunction #### Defined in -[lib/contracts/tbtc-vault.ts:113](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L113) +[src/lib/contracts/tbtc-vault.ts:113](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L113) ___ @@ -72,7 +72,7 @@ GetEventsFunction #### Defined in -[lib/contracts/tbtc-vault.ts:101](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L101) +[src/lib/contracts/tbtc-vault.ts:101](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L101) ## Methods @@ -97,7 +97,7 @@ Transaction hash of the optimistic mint cancel transaction. #### Defined in -[lib/contracts/tbtc-vault.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L67) +[src/lib/contracts/tbtc-vault.ts:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L67) ___ @@ -122,7 +122,7 @@ Transaction hash of the optimistic mint finalize transaction. #### Defined in -[lib/contracts/tbtc-vault.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L80) +[src/lib/contracts/tbtc-vault.ts:80](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L80) ___ @@ -138,7 +138,7 @@ Gets the chain-specific identifier of this contract. #### Defined in -[lib/contracts/tbtc-vault.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L14) +[src/lib/contracts/tbtc-vault.ts:14](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L14) ___ @@ -156,7 +156,7 @@ Array containing identifiers of all currently registered minters. #### Defined in -[lib/contracts/tbtc-vault.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L30) +[src/lib/contracts/tbtc-vault.ts:30](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L30) ___ @@ -178,7 +178,7 @@ Checks if given identifier is registered as guardian. #### Defined in -[lib/contracts/tbtc-vault.ts:44](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L44) +[src/lib/contracts/tbtc-vault.ts:44](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L44) ___ @@ -200,7 +200,7 @@ Checks if given identifier is registered as minter. #### Defined in -[lib/contracts/tbtc-vault.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L37) +[src/lib/contracts/tbtc-vault.ts:37](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L37) ___ @@ -221,7 +221,7 @@ Optimistic Minting Delay in seconds. #### Defined in -[lib/contracts/tbtc-vault.ts:23](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L23) +[src/lib/contracts/tbtc-vault.ts:23](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L23) ___ @@ -246,7 +246,7 @@ Optimistic minting request. #### Defined in -[lib/contracts/tbtc-vault.ts:92](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L92) +[src/lib/contracts/tbtc-vault.ts:92](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L92) ___ @@ -271,4 +271,4 @@ Transaction hash of the optimistic mint request transaction. #### Defined in -[lib/contracts/tbtc-vault.ts:54](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L54) +[src/lib/contracts/tbtc-vault.ts:54](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/tbtc-vault.ts#L54) diff --git a/typescript/api-reference/interfaces/Wallet.md b/typescript/api-reference/interfaces/Wallet.md index 38cb250d1..6387c08e3 100644 --- a/typescript/api-reference/interfaces/Wallet.md +++ b/typescript/api-reference/interfaces/Wallet.md @@ -27,7 +27,7 @@ UNIX timestamp indicating the moment the wallet's closing period started. #### Defined in -[lib/contracts/bridge.ts:427](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L427) +[src/lib/contracts/bridge.ts:427](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L427) ___ @@ -39,7 +39,7 @@ UNIX timestamp the wallet was created at. #### Defined in -[lib/contracts/bridge.ts:418](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L418) +[src/lib/contracts/bridge.ts:418](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L418) ___ @@ -51,7 +51,7 @@ Identifier of a ECDSA Wallet registered in the ECDSA Wallet Registry. #### Defined in -[lib/contracts/bridge.ts:402](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L402) +[src/lib/contracts/bridge.ts:402](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L402) ___ @@ -63,7 +63,7 @@ Latest wallet's main UTXO hash. #### Defined in -[lib/contracts/bridge.ts:410](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L410) +[src/lib/contracts/bridge.ts:410](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L410) ___ @@ -76,7 +76,7 @@ funds. #### Defined in -[lib/contracts/bridge.ts:423](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L423) +[src/lib/contracts/bridge.ts:423](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L423) ___ @@ -88,7 +88,7 @@ Moving funds target wallet commitment submitted by the wallet. #### Defined in -[lib/contracts/bridge.ts:439](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L439) +[src/lib/contracts/bridge.ts:439](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L439) ___ @@ -100,7 +100,7 @@ Total count of pending moved funds sweep requests targeting this wallet. #### Defined in -[lib/contracts/bridge.ts:431](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L431) +[src/lib/contracts/bridge.ts:431](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L431) ___ @@ -112,7 +112,7 @@ The total redeemable value of pending redemption requests targeting that wallet. #### Defined in -[lib/contracts/bridge.ts:414](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L414) +[src/lib/contracts/bridge.ts:414](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L414) ___ @@ -124,7 +124,7 @@ Current state of the wallet. #### Defined in -[lib/contracts/bridge.ts:435](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L435) +[src/lib/contracts/bridge.ts:435](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L435) ___ @@ -136,4 +136,4 @@ Compressed public key of the ECDSA Wallet. #### Defined in -[lib/contracts/bridge.ts:406](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L406) +[src/lib/contracts/bridge.ts:406](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L406) diff --git a/typescript/api-reference/interfaces/WalletRegistry.md b/typescript/api-reference/interfaces/WalletRegistry.md index 2fb0500fc..b56bbdfde 100644 --- a/typescript/api-reference/interfaces/WalletRegistry.md +++ b/typescript/api-reference/interfaces/WalletRegistry.md @@ -33,7 +33,7 @@ GetEventsFunction #### Defined in -[lib/contracts/wallet-registry.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L32) +[src/lib/contracts/wallet-registry.ts:32](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L32) ___ @@ -49,7 +49,7 @@ GetEventsFunction #### Defined in -[lib/contracts/wallet-registry.ts:38](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L38) +[src/lib/contracts/wallet-registry.ts:38](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L38) ___ @@ -65,7 +65,7 @@ GetEventsFunction #### Defined in -[lib/contracts/wallet-registry.ts:26](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L26) +[src/lib/contracts/wallet-registry.ts:26](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L26) ## Methods @@ -81,7 +81,7 @@ Gets the chain-specific identifier of this contract. #### Defined in -[lib/contracts/wallet-registry.ts:13](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L13) +[src/lib/contracts/wallet-registry.ts:13](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L13) ___ @@ -105,4 +105,4 @@ Uncompressed public key without the 04 prefix. #### Defined in -[lib/contracts/wallet-registry.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L20) +[src/lib/contracts/wallet-registry.ts:20](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/wallet-registry.ts#L20) diff --git a/typescript/api-reference/modules/BitcoinNetwork.md b/typescript/api-reference/modules/BitcoinNetwork.md index 369c84e00..31437a832 100644 --- a/typescript/api-reference/modules/BitcoinNetwork.md +++ b/typescript/api-reference/modules/BitcoinNetwork.md @@ -30,4 +30,4 @@ Bitcoin Network. #### Defined in -[lib/bitcoin/network.ts:33](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L33) +[src/lib/bitcoin/network.ts:33](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/bitcoin/network.ts#L33) diff --git a/typescript/api-reference/modules/WalletState.md b/typescript/api-reference/modules/WalletState.md index 9a940a1b9..3d2991d40 100644 --- a/typescript/api-reference/modules/WalletState.md +++ b/typescript/api-reference/modules/WalletState.md @@ -24,4 +24,4 @@ #### Defined in -[lib/contracts/bridge.ts:384](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L384) +[src/lib/contracts/bridge.ts:384](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/contracts/bridge.ts#L384) diff --git a/typescript/package.json b/typescript/package.json index d0d068e1b..14393de28 100644 --- a/typescript/package.json +++ b/typescript/package.json @@ -28,6 +28,8 @@ "@bitcoinerlab/secp256k1": "^1.0.5", "@keep-network/ecdsa": "development", "@keep-network/tbtc-v2": "development", + "@ledgerhq/wallet-api-client": "^1.2.1", + "bignumber.js": "^9.1.2", "bitcoinjs-lib": "^6.1.5", "bufio": "^1.0.6", "ecpair": "^2.1.0", diff --git a/typescript/src/lib/utils/index.ts b/typescript/src/lib/utils/index.ts index d3e639c60..b51ccf033 100644 --- a/typescript/src/lib/utils/index.ts +++ b/typescript/src/lib/utils/index.ts @@ -1,2 +1,3 @@ export * from "./backoff" export * from "./hex" +export * from "./ledger" diff --git a/typescript/src/lib/utils/ledger.ts b/typescript/src/lib/utils/ledger.ts new file mode 100644 index 000000000..cde84b059 --- /dev/null +++ b/typescript/src/lib/utils/ledger.ts @@ -0,0 +1,239 @@ +import { ethers, Signer } from "ethers" +import { + Account, + EthereumTransaction, + WalletAPIClient, + WindowMessageTransport, +} from "@ledgerhq/wallet-api-client" +import { AddressZero } from "@ethersproject/constants" +import { Deferrable } from "@ethersproject/properties" +import { Hex } from "./hex" +import BigNumber from "bignumber.js" + +class AccountNotFoundError extends Error { + constructor() { + super( + "Account not found. Please use `requestAccount` method or set the signer account with `setAccount` method." + ) + } +} + +/** + * Ethereum signer extended from `ethers` Signer class. The main purpose of it + * is to allow the user to communicate with eth contracts through our tBTC SDK + * inside Ledger Live application, when the app is used there as a Live App. + */ +export class LedgerLiveEthereumSigner extends Signer { + private _walletApiClient: WalletAPIClient + private _windowMessageTransport: WindowMessageTransport + private _account: Account | undefined + + constructor(provider?: ethers.providers.Provider) { + super() + ethers.utils.defineReadOnly(this, "provider", provider) + this._windowMessageTransport = getWindowMessageTransport() + this._walletApiClient = getWalletAPIClient(this._windowMessageTransport) + } + + private _checkAccount(): void { + if (!this._account || !this._account.id) { + throw new AccountNotFoundError() + } + } + + private _checkProviderAndAccount(): void { + this._checkProvider() + this._checkAccount() + } + + private _catchWalletApiError(error?: any, defaultErrorMessage?: string) { + this._windowMessageTransport.disconnect() + + if (typeof error === "string" || error instanceof Error) { + throw new Error(error.toString()) + } + throw new Error( + defaultErrorMessage || + "Something went wrong when using ledger live singer to interact with out wallet." + ) + } + + get account() { + return this._account + } + + setAccount(account: Account | undefined): void { + this._account = account + } + + async requestAccount( + params: { currencyIds?: string[] | undefined } | undefined + ): Promise { + let account: Account + try { + this._windowMessageTransport.connect() + account = await this._walletApiClient.account.request(params) + this._windowMessageTransport.disconnect() + } catch (err) { + this._catchWalletApiError( + err, + "Something went wrong when requesting an account with ledger live signer!" + ) + } + + this._account = account! + return this._account + } + + getAccountId(): string { + this._checkAccount() + return this._account!.id + } + + async getAddress(): Promise { + this._checkAccount() + return this._account!.address + } + + private _getWalletApiEthereumTransaction( + transaction: ethers.providers.TransactionRequest + ): EthereumTransaction { + const { + value, + to, + nonce, + data, + gasPrice, + gasLimit, + maxFeePerGas, + maxPriorityFeePerGas, + } = transaction + + const ethereumTransaction: EthereumTransaction = { + family: "ethereum" as const, + amount: value ? new BigNumber(value.toString()) : new BigNumber(0), + recipient: to ? to : AddressZero, + } + + if (nonce) ethereumTransaction.nonce = Number(nonce) + if (data) + ethereumTransaction.data = Buffer.from( + Hex.from(data.toString()).toString(), + "hex" + ) + if (gasPrice) + ethereumTransaction.gasPrice = new BigNumber(gasPrice.toString()) + if (gasLimit) + ethereumTransaction.gasLimit = new BigNumber(gasLimit.toString()) + if (maxFeePerGas) + ethereumTransaction.maxFeePerGas = new BigNumber(maxFeePerGas.toString()) + if (maxPriorityFeePerGas) + ethereumTransaction.maxPriorityFeePerGas = new BigNumber( + maxPriorityFeePerGas.toString() + ) + + return ethereumTransaction + } + + async signMessage(message: string): Promise { + this._checkAccount() + + let buffer: Buffer + try { + this._windowMessageTransport.connect() + buffer = await this._walletApiClient.message.sign( + this._account!.id, + Buffer.from(message) + ) + this._windowMessageTransport.disconnect() + } catch (err) { + this._catchWalletApiError( + err, + "Something went wrong when signing a message with ledger live signer!" + ) + } + + return buffer!.toString() + } + + async signTransaction( + transaction: ethers.providers.TransactionRequest + ): Promise { + this._checkAccount() + + const ethereumTransaction = + this._getWalletApiEthereumTransaction(transaction) + + let buffer: Buffer + try { + this._windowMessageTransport.connect() + buffer = await this._walletApiClient.transaction.sign( + this._account!.id, + ethereumTransaction + ) + this._windowMessageTransport.disconnect() + } catch (err) { + this._catchWalletApiError( + err, + "Something went wrong when signing a transaction with ledger live signer!" + ) + } + + return buffer!.toString() + } + + async sendTransaction( + transaction: Deferrable + ): Promise { + this._checkProviderAndAccount() + + const pupulatedTransaction = await this.populateTransaction(transaction) + const ethereumTransaction = + this._getWalletApiEthereumTransaction(pupulatedTransaction) + + let transactionHash: string + try { + this._windowMessageTransport.connect() + transactionHash = + await this._walletApiClient.transaction.signAndBroadcast( + this._account!.id, + ethereumTransaction + ) + this._windowMessageTransport.disconnect() + } catch (err) { + this._catchWalletApiError( + err, + "Something went wrong when sending a transaction with ledger live signer!" + ) + } + + const transactionResponse = await this.provider?.getTransaction( + transactionHash! + ) + + if (!transactionResponse) { + throw new Error("Transaction response not found!") + } + + return transactionResponse + } + + connect(provider: ethers.providers.Provider): Signer { + const account = this._account + const newLedgerLiveEthereumSignerInstance = new LedgerLiveEthereumSigner( + provider + ) + newLedgerLiveEthereumSignerInstance.setAccount(account) + return newLedgerLiveEthereumSignerInstance + } +} + +const getWindowMessageTransport = () => { + return new WindowMessageTransport() +} + +const getWalletAPIClient = (windowMessageTransport: WindowMessageTransport) => { + const walletApiClient = new WalletAPIClient(windowMessageTransport) + + return walletApiClient +} diff --git a/typescript/yarn.lock b/typescript/yarn.lock index 584329aed..bf93f537f 100644 --- a/typescript/yarn.lock +++ b/typescript/yarn.lock @@ -1633,11 +1633,26 @@ rxjs "6" semver "^7.3.5" +"@ledgerhq/devices@^8.0.7": + version "8.0.7" + resolved "https://registry.yarnpkg.com/@ledgerhq/devices/-/devices-8.0.7.tgz#206434dbd8a097529bbfc95f5eef94c2923c7578" + integrity sha512-BbPyET52lXnVs7CxJWrGYqmtGdbGzj+XnfCqLsDnA7QYr1CZREysxmie+Rr6BKpNDBRVesAovXjtaVaZOn+upw== + dependencies: + "@ledgerhq/errors" "^6.14.0" + "@ledgerhq/logs" "^6.10.1" + rxjs "6" + semver "^7.3.5" + "@ledgerhq/errors@^5.50.0": version "5.50.0" resolved "https://registry.yarnpkg.com/@ledgerhq/errors/-/errors-5.50.0.tgz#e3a6834cb8c19346efca214c1af84ed28e69dad9" integrity sha512-gu6aJ/BHuRlpU7kgVpy2vcYk6atjB4iauP2ymF7Gk0ez0Y/6VSMVSJvubeEQN+IV60+OBK0JgeIZG7OiHaw8ow== +"@ledgerhq/errors@^6.14.0": + version "6.14.0" + resolved "https://registry.yarnpkg.com/@ledgerhq/errors/-/errors-6.14.0.tgz#0bf253983773ef12eebce2091f463bc719223b37" + integrity sha512-ZWJw2Ti6Dq1Ott/+qYqJdDWeZm16qI3VNG5rFlb0TQ3UcAyLIQZbnnzzdcVVwVeZiEp66WIpINd/pBdqsHVyOA== + "@ledgerhq/hw-app-eth@^5.11.0": version "5.53.0" resolved "https://registry.yarnpkg.com/@ledgerhq/hw-app-eth/-/hw-app-eth-5.53.0.tgz#5df2d7427db9f387099d0cc437e9730101d7c404" @@ -1659,11 +1674,44 @@ "@ledgerhq/errors" "^5.50.0" events "^3.3.0" +"@ledgerhq/hw-transport@^6.28.8": + version "6.28.8" + resolved "https://registry.yarnpkg.com/@ledgerhq/hw-transport/-/hw-transport-6.28.8.tgz#f99a5c71c5c09591e9bfb1b970c42aafbe81351f" + integrity sha512-XxQVl4htd018u/M66r0iu5nlHi+J6QfdPsORzDF6N39jaz+tMqItb7tUlXM/isggcuS5lc7GJo7NOuJ8rvHZaQ== + dependencies: + "@ledgerhq/devices" "^8.0.7" + "@ledgerhq/errors" "^6.14.0" + events "^3.3.0" + "@ledgerhq/logs@^5.50.0": version "5.50.0" resolved "https://registry.yarnpkg.com/@ledgerhq/logs/-/logs-5.50.0.tgz#29c6419e8379d496ab6d0426eadf3c4d100cd186" integrity sha512-swKHYCOZUGyVt4ge0u8a7AwNcA//h4nx5wIi0sruGye1IJ5Cva0GyK9L2/WdX+kWVTKp92ZiEo1df31lrWGPgA== +"@ledgerhq/logs@^6.10.1": + version "6.10.1" + resolved "https://registry.yarnpkg.com/@ledgerhq/logs/-/logs-6.10.1.tgz#5bd16082261d7364eabb511c788f00937dac588d" + integrity sha512-z+ILK8Q3y+nfUl43ctCPuR4Y2bIxk/ooCQFwZxhtci1EhAtMDzMAx2W25qx8G1PPL9UUOdnUax19+F0OjXoj4w== + +"@ledgerhq/wallet-api-client@^1.2.1": + version "1.2.1" + resolved "https://registry.yarnpkg.com/@ledgerhq/wallet-api-client/-/wallet-api-client-1.2.1.tgz#b47fe5b4f431282f50ddb64c8abb911545593eba" + integrity sha512-uTBTZCpbLTM5y5Cd7ioQB0lcq0b3cbrU2bGzCiKuY1IEd0NUyFhr2dKliRrcLoMPDRtQRmRnSxeX0BFKinoo8Q== + dependencies: + "@ledgerhq/hw-transport" "^6.28.8" + "@ledgerhq/wallet-api-core" "1.3.1" + bignumber.js "^9.1.2" + +"@ledgerhq/wallet-api-core@1.3.1": + version "1.3.1" + resolved "https://registry.yarnpkg.com/@ledgerhq/wallet-api-core/-/wallet-api-core-1.3.1.tgz#092d027a6d9ce7139a2d4c157480e2feb7c88489" + integrity sha512-yOeb1tfdwF6NdxVEIVr8SVz5iOyh6asWa0bbuCyMpiLrfuVS/Wkr6OeDMBYSxWxXxRFmQDJ9XQxdtSS+MGNk1Q== + dependencies: + "@ledgerhq/errors" "^6.14.0" + bignumber.js "^9.1.2" + uuid "^9.0.0" + zod "^3.22.2" + "@noble/hashes@^1.1.5", "@noble/hashes@^1.2.0": version "1.3.2" resolved "https://registry.yarnpkg.com/@noble/hashes/-/hashes-1.3.2.tgz#6f26dbc8fbc7205873ce3cee2f690eba0d421b39" @@ -2574,6 +2622,11 @@ bignumber.js@^7.2.0: resolved "https://registry.yarnpkg.com/bignumber.js/-/bignumber.js-7.2.1.tgz#80c048759d826800807c4bfd521e50edbba57a5f" integrity sha512-S4XzBk5sMB+Rcb/LNcpzXr57VRTxgAvaAEDAl1AwRx27j00hT84O6OkteE7u8UB3NuaaygCRrEpqox4uDOrbdQ== +bignumber.js@^9.1.2: + version "9.1.2" + resolved "https://registry.yarnpkg.com/bignumber.js/-/bignumber.js-9.1.2.tgz#b7c4242259c008903b13707983b5f4bbd31eda0c" + integrity sha512-2/mKyZH9K85bzOEfhXDBFZTGd1CTs+5IHpeFQo9luiBG7hghdC851Pj2WAhb6E3R6b9tZj/XKhbg4fum+Kepug== + binary-extensions@^2.0.0: version "2.2.0" resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-2.2.0.tgz#75f502eeaf9ffde42fc98829645be4ea76bd9e2d" @@ -7887,6 +7940,11 @@ uuid@^3.3.2: resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.4.0.tgz#b23e4358afa8a202fe7a100af1f5f883f02007ee" integrity sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A== +uuid@^9.0.0: + version "9.0.1" + resolved "https://registry.yarnpkg.com/uuid/-/uuid-9.0.1.tgz#e188d4c8853cc722220392c424cd637f32293f30" + integrity sha512-b+1eJOlsR9K8HJpow9Ok3fiWOWSIcIzXodvv0rQjVoOVNpWMpxf1wZNpt4y9h10odCNrqnYp1OBzRktckBe3sA== + v8-compile-cache-lib@^3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz#6336e8d71965cb3d35a1bbb7868445a7c05264bf" @@ -9033,3 +9091,8 @@ yocto-queue@^0.1.0: version "0.1.0" resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b" integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q== + +zod@^3.22.2: + version "3.22.4" + resolved "https://registry.yarnpkg.com/zod/-/zod-3.22.4.tgz#f31c3a9386f61b1f228af56faa9255e845cf3fff" + integrity sha512-iC+8Io04lddc+mVqQ9AZ7OQ2MrUKGN+oIQyq1vemgt46jwCwLfhq7/pwnBnNXXXZb8VTVLKwp9EDkx+ryxIWmg==