Skip to content

Commit

Permalink
Regenerated typescript docs
Browse files Browse the repository at this point in the history
Removed Unknown-Gravity external contributor part from the links and
replaced it back with keep-network. This change sneaked in when merging
changes from a fork.
  • Loading branch information
pdyraga committed Sep 5, 2024
1 parent 0c16aa3 commit 6c529b9
Show file tree
Hide file tree
Showing 66 changed files with 475 additions and 475 deletions.
102 changes: 51 additions & 51 deletions typescript/api-reference/README.md

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions typescript/api-reference/classes/ArbitrumL2BitcoinDepositor.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ EthersContractHandle\<L2BitcoinDepositorTypechain\>.constructor

#### Defined in

[lib/arbitrum/l2-bitcoin-depositor.ts:36](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L36)
[lib/arbitrum/l2-bitcoin-depositor.ts:36](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L36)

## Properties

Expand All @@ -73,7 +73,7 @@ EthersContractHandle\<L2BitcoinDepositorTypechain\>.constructor

#### Defined in

[lib/arbitrum/l2-bitcoin-depositor.ts:34](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L34)
[lib/arbitrum/l2-bitcoin-depositor.ts:34](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L34)

___

Expand All @@ -83,7 +83,7 @@ ___

#### Defined in

[lib/arbitrum/l2-bitcoin-depositor.ts:33](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L33)
[lib/arbitrum/l2-bitcoin-depositor.ts:33](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L33)

___

Expand All @@ -101,7 +101,7 @@ EthersContractHandle.\_deployedAtBlockNumber

#### Defined in

[lib/ethereum/adapter.ts:80](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L80)
[lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L80)

___

Expand All @@ -117,7 +117,7 @@ EthersContractHandle.\_instance

#### Defined in

[lib/ethereum/adapter.ts:74](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L74)
[lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L74)

___

Expand All @@ -133,7 +133,7 @@ EthersContractHandle.\_totalRetryAttempts

#### Defined in

[lib/ethereum/adapter.ts:84](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L84)
[lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L84)

## Methods

Expand All @@ -153,7 +153,7 @@ EthersContractHandle.\_totalRetryAttempts

#### Defined in

[lib/arbitrum/l2-bitcoin-depositor.ts:83](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L83)
[lib/arbitrum/l2-bitcoin-depositor.ts:83](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L83)

___

Expand All @@ -175,7 +175,7 @@ EthersContractHandle.getAddress

#### Defined in

[lib/ethereum/adapter.ts:112](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L112)
[lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L112)

___

Expand All @@ -195,7 +195,7 @@ ___

#### Defined in

[lib/arbitrum/l2-bitcoin-depositor.ts:59](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L59)
[lib/arbitrum/l2-bitcoin-depositor.ts:59](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L59)

___

Expand All @@ -215,7 +215,7 @@ ___

#### Defined in

[lib/arbitrum/l2-bitcoin-depositor.ts:67](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L67)
[lib/arbitrum/l2-bitcoin-depositor.ts:67](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L67)

___

Expand Down Expand Up @@ -249,7 +249,7 @@ EthersContractHandle.getEvents

#### Defined in

[lib/ethereum/adapter.ts:127](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L127)
[lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L127)

___

Expand Down Expand Up @@ -278,7 +278,7 @@ ___

#### Defined in

[lib/arbitrum/l2-bitcoin-depositor.ts:91](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L91)
[lib/arbitrum/l2-bitcoin-depositor.ts:91](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L91)

___

Expand All @@ -304,4 +304,4 @@ ___

#### Defined in

[lib/arbitrum/l2-bitcoin-depositor.ts:75](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L75)
[lib/arbitrum/l2-bitcoin-depositor.ts:75](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-bitcoin-depositor.ts#L75)
16 changes: 8 additions & 8 deletions typescript/api-reference/classes/ArbitrumL2TBTCToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ EthersContractHandle\<L2TBTCTypechain\>.constructor

#### Defined in

[lib/arbitrum/l2-tbtc-token.ts:22](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-tbtc-token.ts#L22)
[lib/arbitrum/l2-tbtc-token.ts:22](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-tbtc-token.ts#L22)

## Properties

Expand All @@ -76,7 +76,7 @@ EthersContractHandle.\_deployedAtBlockNumber

#### Defined in

[lib/ethereum/adapter.ts:80](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L80)
[lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L80)

___

Expand All @@ -92,7 +92,7 @@ EthersContractHandle.\_instance

#### Defined in

[lib/ethereum/adapter.ts:74](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L74)
[lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L74)

___

Expand All @@ -108,7 +108,7 @@ EthersContractHandle.\_totalRetryAttempts

#### Defined in

[lib/ethereum/adapter.ts:84](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L84)
[lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L84)

## Methods

Expand All @@ -134,7 +134,7 @@ EthersContractHandle.\_totalRetryAttempts

#### Defined in

[lib/arbitrum/l2-tbtc-token.ts:51](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-tbtc-token.ts#L51)
[lib/arbitrum/l2-tbtc-token.ts:51](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-tbtc-token.ts#L51)

___

Expand All @@ -156,7 +156,7 @@ EthersContractHandle.getAddress

#### Defined in

[lib/ethereum/adapter.ts:112](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L112)
[lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L112)

___

Expand All @@ -176,7 +176,7 @@ ___

#### Defined in

[lib/arbitrum/l2-tbtc-token.ts:43](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-tbtc-token.ts#L43)
[lib/arbitrum/l2-tbtc-token.ts:43](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/arbitrum/l2-tbtc-token.ts#L43)

___

Expand Down Expand Up @@ -210,4 +210,4 @@ EthersContractHandle.getEvents

#### Defined in

[lib/ethereum/adapter.ts:127](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L127)
[lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L127)
26 changes: 13 additions & 13 deletions typescript/api-reference/classes/BaseL2BitcoinDepositor.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ EthersContractHandle\<L2BitcoinDepositorTypechain\>.constructor

#### Defined in

[lib/base/l2-bitcoin-depositor.ts:37](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L37)
[lib/base/l2-bitcoin-depositor.ts:37](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L37)

## Properties

Expand All @@ -73,7 +73,7 @@ EthersContractHandle\<L2BitcoinDepositorTypechain\>.constructor

#### Defined in

[lib/base/l2-bitcoin-depositor.ts:35](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L35)
[lib/base/l2-bitcoin-depositor.ts:35](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L35)

___

Expand All @@ -83,7 +83,7 @@ ___

#### Defined in

[lib/base/l2-bitcoin-depositor.ts:34](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L34)
[lib/base/l2-bitcoin-depositor.ts:34](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L34)

___

Expand All @@ -101,7 +101,7 @@ EthersContractHandle.\_deployedAtBlockNumber

#### Defined in

[lib/ethereum/adapter.ts:80](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L80)
[lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L80)

___

Expand All @@ -117,7 +117,7 @@ EthersContractHandle.\_instance

#### Defined in

[lib/ethereum/adapter.ts:74](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L74)
[lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L74)

___

Expand All @@ -133,7 +133,7 @@ EthersContractHandle.\_totalRetryAttempts

#### Defined in

[lib/ethereum/adapter.ts:84](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L84)
[lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L84)

## Methods

Expand All @@ -153,7 +153,7 @@ EthersContractHandle.\_totalRetryAttempts

#### Defined in

[lib/base/l2-bitcoin-depositor.ts:85](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L85)
[lib/base/l2-bitcoin-depositor.ts:85](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L85)

___

Expand All @@ -175,7 +175,7 @@ EthersContractHandle.getAddress

#### Defined in

[lib/ethereum/adapter.ts:112](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L112)
[lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L112)

___

Expand All @@ -195,7 +195,7 @@ ___

#### Defined in

[lib/base/l2-bitcoin-depositor.ts:61](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L61)
[lib/base/l2-bitcoin-depositor.ts:61](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L61)

___

Expand All @@ -215,7 +215,7 @@ ___

#### Defined in

[lib/base/l2-bitcoin-depositor.ts:69](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L69)
[lib/base/l2-bitcoin-depositor.ts:69](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L69)

___

Expand Down Expand Up @@ -249,7 +249,7 @@ EthersContractHandle.getEvents

#### Defined in

[lib/ethereum/adapter.ts:127](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L127)
[lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L127)

___

Expand Down Expand Up @@ -278,7 +278,7 @@ ___

#### Defined in

[lib/base/l2-bitcoin-depositor.ts:93](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L93)
[lib/base/l2-bitcoin-depositor.ts:93](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L93)

___

Expand All @@ -304,4 +304,4 @@ ___

#### Defined in

[lib/base/l2-bitcoin-depositor.ts:77](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L77)
[lib/base/l2-bitcoin-depositor.ts:77](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-bitcoin-depositor.ts#L77)
16 changes: 8 additions & 8 deletions typescript/api-reference/classes/BaseL2TBTCToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ EthersContractHandle\<L2TBTCTypechain\>.constructor

#### Defined in

[lib/base/l2-tbtc-token.ts:23](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-tbtc-token.ts#L23)
[lib/base/l2-tbtc-token.ts:23](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-tbtc-token.ts#L23)

## Properties

Expand All @@ -76,7 +76,7 @@ EthersContractHandle.\_deployedAtBlockNumber

#### Defined in

[lib/ethereum/adapter.ts:80](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L80)
[lib/ethereum/adapter.ts:80](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L80)

___

Expand All @@ -92,7 +92,7 @@ EthersContractHandle.\_instance

#### Defined in

[lib/ethereum/adapter.ts:74](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L74)
[lib/ethereum/adapter.ts:74](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L74)

___

Expand All @@ -108,7 +108,7 @@ EthersContractHandle.\_totalRetryAttempts

#### Defined in

[lib/ethereum/adapter.ts:84](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L84)
[lib/ethereum/adapter.ts:84](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L84)

## Methods

Expand All @@ -134,7 +134,7 @@ EthersContractHandle.\_totalRetryAttempts

#### Defined in

[lib/base/l2-tbtc-token.ts:53](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-tbtc-token.ts#L53)
[lib/base/l2-tbtc-token.ts:53](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-tbtc-token.ts#L53)

___

Expand All @@ -156,7 +156,7 @@ EthersContractHandle.getAddress

#### Defined in

[lib/ethereum/adapter.ts:112](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L112)
[lib/ethereum/adapter.ts:112](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L112)

___

Expand All @@ -176,7 +176,7 @@ ___

#### Defined in

[lib/base/l2-tbtc-token.ts:45](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-tbtc-token.ts#L45)
[lib/base/l2-tbtc-token.ts:45](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/base/l2-tbtc-token.ts#L45)

___

Expand Down Expand Up @@ -210,4 +210,4 @@ EthersContractHandle.getEvents

#### Defined in

[lib/ethereum/adapter.ts:127](https://github.com/Unknown-Gravity/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L127)
[lib/ethereum/adapter.ts:127](https://github.com/keep-network/tbtc-v2-sdk/blob/main/typescript/src/lib/ethereum/adapter.ts#L127)
Loading

0 comments on commit 6c529b9

Please sign in to comment.