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 7 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
119 changes: 78 additions & 41 deletions typescript/api-reference/README.md
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions typescript/api-reference/classes/BitcoinTxHash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

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

___

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

___

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

___

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

___

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

___

Expand All @@ -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)
20 changes: 10 additions & 10 deletions typescript/api-reference/classes/Deposit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

___

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

___

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

___

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

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

___

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

___

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

___

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

___

Expand All @@ -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)
10 changes: 5 additions & 5 deletions typescript/api-reference/classes/DepositFunding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

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

___

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

___

Expand All @@ -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)
16 changes: 8 additions & 8 deletions typescript/api-reference/classes/DepositRefund.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

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

___

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

___

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

___

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

___

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

___

Expand All @@ -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)
14 changes: 7 additions & 7 deletions typescript/api-reference/classes/DepositScript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

___

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

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

___

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

___

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

___

Expand All @@ -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)
16 changes: 8 additions & 8 deletions typescript/api-reference/classes/DepositsService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

___

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

___

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

___

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

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

___

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

___

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