Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add signer for ledger live app #743

Merged
merged 19 commits into from
Nov 14, 2023
Merged

Add signer for ledger live app #743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
f7fb03c
Move LedgerLiveAppEthereumSigner from T dashboard
michalsmiarowski Nov 9, 2023
c73d926
Import Signer from `ethers` lib
michalsmiarowski Nov 9, 2023
1f8ca9e
Add additional arguments to the constructor
michalsmiarowski Nov 9, 2023
802d52e
Move everything ledger related to ledger.ts file
michalsmiarowski Nov 9, 2023
7df49c7
Fix import
michalsmiarowski Nov 9, 2023
9cca82e
Extract error to a separate class
michalsmiarowski Nov 9, 2023
f7de5dd
Update docs
michalsmiarowski Nov 9, 2023
8244f9f
Simplify the LedgerLiveAppEthereumSigner name
michalsmiarowski Nov 14, 2023
98df68f
Add whitespace below imports
michalsmiarowski Nov 14, 2023
37e3675
Remove exports from util functions
michalsmiarowski Nov 14, 2023
59e142d
Remove unnecessery arguments from contructor
michalsmiarowski Nov 14, 2023
848142f
Set account in the new instance from `connect`
michalsmiarowski Nov 14, 2023
4366767
Create new `_checkProviderAndAccount` method
michalsmiarowski Nov 14, 2023
ddbb7e0
Make `provider` argument optional
michalsmiarowski Nov 14, 2023
54be6d7
Populate transaction in `sendTransaction`
michalsmiarowski Nov 14, 2023
4fc86ee
Wrap wallet-api calls with try-catch block
michalsmiarowski Nov 14, 2023
4003943
Specify `account` type
michalsmiarowski Nov 14, 2023
b30a8f0
Update dosc
michalsmiarowski Nov 14, 2023
3c874c4
Merge branch 'main' into add-signer-for-ledger-live-app
lukasz-zimnoch Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 42 additions & 41 deletions typescript/api-reference/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand All @@ -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

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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

Expand All @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand All @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand All @@ -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)
Loading