From 1c2993078fe1af136adc7e1226c0f7901f5b1390 Mon Sep 17 00:00:00 2001 From: Lukasz Zimnoch Date: Fri, 22 Mar 2024 16:30:38 +0100 Subject: [PATCH 1/2] Remove redundant wallet registry fetch There is no need to fetch `WalletRegistry` address from the `Bridge`. It is already loaded from the artifact. This allows saving a call to the Ethereum RPC server. --- typescript/src/lib/ethereum/index.ts | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/typescript/src/lib/ethereum/index.ts b/typescript/src/lib/ethereum/index.ts index c8573a305..8cf4b275d 100644 --- a/typescript/src/lib/ethereum/index.ts +++ b/typescript/src/lib/ethereum/index.ts @@ -96,17 +96,6 @@ export async function loadEthereumCoreContracts( chainId ) - const bridgeWalletRegistry = await bridge.walletRegistry() - if ( - !bridgeWalletRegistry - .getChainIdentifier() - .equals(walletRegistry.getChainIdentifier()) - ) { - throw new Error( - "Wallet registry used by Bridge is different than the one resolved from artifacts" - ) - } - return { bridge, tbtcToken, From f9e10d3f2a9bcd1b0cf4fbfc62b1870b684ef3d4 Mon Sep 17 00:00:00 2001 From: Lukasz Zimnoch Date: Fri, 22 Mar 2024 16:38:24 +0100 Subject: [PATCH 2/2] Regenerate API docs --- typescript/api-reference/README.md | 6 +-- .../api-reference/classes/ElectrumClient.md | 46 +++++++++---------- .../interfaces/ElectrumCredentials.md | 6 +-- 3 files changed, 29 insertions(+), 29 deletions(-) diff --git a/typescript/api-reference/README.md b/typescript/api-reference/README.md index 724fdbf21..84b059808 100644 --- a/typescript/api-reference/README.md +++ b/typescript/api-reference/README.md @@ -266,7 +266,7 @@ Additional options used by the Electrum server. #### Defined in -[src/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:49](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L49) ___ @@ -830,7 +830,7 @@ Electrum script hash as a hex string. #### Defined in -[src/lib/electrum/client.ts:667](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L667) +[src/lib/electrum/client.ts:668](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L668) ___ @@ -893,7 +893,7 @@ Throws an error if the signer's Ethereum chain ID is other than #### Defined in -[src/lib/ethereum/index.ts:129](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L129) +[src/lib/ethereum/index.ts:118](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/ethereum/index.ts#L118) ___ diff --git a/typescript/api-reference/classes/ElectrumClient.md b/typescript/api-reference/classes/ElectrumClient.md index 2b4bc55ba..9c0c9a378 100644 --- a/typescript/api-reference/classes/ElectrumClient.md +++ b/typescript/api-reference/classes/ElectrumClient.md @@ -62,7 +62,7 @@ Electrum-based implementation of the Bitcoin client. #### Defined in -[src/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:73](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L73) ## Properties @@ -72,7 +72,7 @@ Electrum-based implementation of the Bitcoin client. #### Defined in -[src/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:71](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L71) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[src/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:67](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L67) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[src/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:68](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L68) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[src/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:70](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L70) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[src/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:69](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L69) ## Methods @@ -138,7 +138,7 @@ ___ #### Defined in -[src/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:633](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L633) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[src/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:261](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L261) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[src/lib/electrum/client.ts:646](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L646) +[src/lib/electrum/client.ts:647](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L647) ___ @@ -217,7 +217,7 @@ ___ #### Defined in -[src/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:583](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L583) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[src/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:239](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L239) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[src/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:396](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L396) ___ @@ -289,7 +289,7 @@ ___ #### Defined in -[src/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:346](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L346) ___ @@ -315,7 +315,7 @@ ___ #### Defined in -[src/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:417](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L417) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[src/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:292](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L292) ___ @@ -369,7 +369,7 @@ ___ #### Defined in -[src/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:602](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L602) ___ @@ -395,7 +395,7 @@ ___ #### Defined in -[src/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:509](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L509) ___ @@ -415,7 +415,7 @@ ___ #### Defined in -[src/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:567](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L567) ___ @@ -439,7 +439,7 @@ A function that can retry any function. #### Defined in -[src/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:231](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L231) ___ @@ -470,7 +470,7 @@ Promise holding the outcome. #### Defined in -[src/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:169](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L169) ___ @@ -495,7 +495,7 @@ Electrum client instance. #### Defined in -[src/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:127](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L127) ___ @@ -523,7 +523,7 @@ Electrum client instance. #### Defined in -[src/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:98](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L98) ___ @@ -547,4 +547,4 @@ Electrum credentials object. #### Defined in -[src/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:148](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L148) diff --git a/typescript/api-reference/interfaces/ElectrumCredentials.md b/typescript/api-reference/interfaces/ElectrumCredentials.md index dce90cd8b..67665685d 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 -[src/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:35](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L35) ___ @@ -32,7 +32,7 @@ Port the Electrum server listens on. #### Defined in -[src/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:39](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L39) ___ @@ -44,4 +44,4 @@ Protocol used by the Electrum server. #### Defined in -[src/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:43](https://github.com/keep-network/tbtc-v2/blob/main/typescript/src/lib/electrum/client.ts#L43)