Skip to content

Commit 10b49fb

Browse files
gsteenkamp89gsteenkamp89
authored
generate typedoc (#168)
1 parent d027d7c commit 10b49fb

File tree

113 files changed

+1569
-768
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+1569
-768
lines changed

‎packages/sdk/docs/README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,20 @@
2121
- [AcrossErrorCodeType](type-aliases/AcrossErrorCodeType.md)
2222
- [Amount](type-aliases/Amount.md)
2323
- [BuildMessageParams](type-aliases/BuildMessageParams.md)
24+
- [ChainInfoMap](type-aliases/ChainInfoMap.md)
2425
- [ChainsQueryParams](type-aliases/ChainsQueryParams.md)
2526
- [ChainsQueryResponse](type-aliases/ChainsQueryResponse.md)
2627
- [ConfiguredPublicClient](type-aliases/ConfiguredPublicClient.md)
2728
- [ConfiguredPublicClientMap](type-aliases/ConfiguredPublicClientMap.md)
2829
- [ConfiguredWalletClient](type-aliases/ConfiguredWalletClient.md)
2930
- [CrossChainAction](type-aliases/CrossChainAction.md)
3031
- [Deposit](type-aliases/Deposit.md)
32+
- [DepositLog](type-aliases/DepositLog.md)
3133
- [DepositStatus](type-aliases/DepositStatus.md)
3234
- [ExecuteQuoteParams](type-aliases/ExecuteQuoteParams.md)
3335
- [ExecutionProgress](type-aliases/ExecutionProgress.md)
36+
- [FilledV3RelayEvent](type-aliases/FilledV3RelayEvent.md)
37+
- [FillEventLog](type-aliases/FillEventLog.md)
3438
- [FillStatus](type-aliases/FillStatus.md)
3539
- [GetAvailableRoutesParams](type-aliases/GetAvailableRoutesParams.md)
3640
- [GetAvailableRoutesReturnType](type-aliases/GetAvailableRoutesReturnType.md)
@@ -48,29 +52,41 @@
4852
- [IndexerStatusResponse](type-aliases/IndexerStatusResponse.md)
4953
- [LoggerT](type-aliases/LoggerT.md)
5054
- [LogLevel](type-aliases/LogLevel.md)
55+
- [MakeOptional](type-aliases/MakeOptional.md)
56+
- [NoNullValuesOfObject](type-aliases/NoNullValuesOfObject.md)
5157
- [Quote](type-aliases/Quote.md)
5258
- [Route](type-aliases/Route.md)
5359
- [RoutesQueryParams](type-aliases/RoutesQueryParams.md)
60+
- [SignUpdateDepositTypedDataParams](type-aliases/SignUpdateDepositTypedDataParams.md)
5461
- [SimulateApproveTxParams](type-aliases/SimulateApproveTxParams.md)
5562
- [SimulateDepositTxParams](type-aliases/SimulateDepositTxParams.md)
63+
- [SimulateUpdateDepositTxParams](type-aliases/SimulateUpdateDepositTxParams.md)
5664
- [Status](type-aliases/Status.md)
5765
- [SuggestedFeesQueryParams](type-aliases/SuggestedFeesQueryParams.md)
5866
- [SuggestedFeesResponse](type-aliases/SuggestedFeesResponse.md)
5967
- [TenderlySimulateTxParams](type-aliases/TenderlySimulateTxParams.md)
6068
- [TokenInfo](type-aliases/TokenInfo.md)
6169
- [TransactionProgress](type-aliases/TransactionProgress.md)
70+
- [V3\_5FilledRelayEvent](type-aliases/V3_5FilledRelayEvent.md)
71+
- [V3\_5FundsDepositedEvent](type-aliases/V3_5FundsDepositedEvent.md)
72+
- [V3FundsDepositedEvent](type-aliases/V3FundsDepositedEvent.md)
6273
- [WaitForDepositTxParams](type-aliases/WaitForDepositTxParams.md)
6374
- [WaitForFillTxParams](type-aliases/WaitForFillTxParams.md)
6475

6576
## Variables
6677

67-
- [DOMAIN_CALLDATA_DELIMITER](variables/DOMAIN_CALLDATA_DELIMITER.md)
78+
- [DOMAIN\_CALLDATA\_DELIMITER](variables/DOMAIN_CALLDATA_DELIMITER.md)
79+
- [FillType](variables/FillType.md)
6880
- [LogLevels](variables/LogLevels.md)
81+
- [MulticallHandlerAbi](variables/MulticallHandlerAbi.md)
6982

7083
## Functions
7184

85+
- [addressToBytes32](functions/addressToBytes32.md)
86+
- [assertValidIntegratorId](functions/assertValidIntegratorId.md)
7287
- [buildMulticallHandlerMessage](functions/buildMulticallHandlerMessage.md)
7388
- [buildSearchParams](functions/buildSearchParams.md)
89+
- [bytes32ToAddress](functions/bytes32ToAddress.md)
7490
- [configurePublicClients](functions/configurePublicClients.md)
7591
- [createAcrossClient](functions/createAcrossClient.md)
7692
- [executeQuote](functions/executeQuote.md)
@@ -82,16 +98,28 @@
8298
- [getDeposit](functions/getDeposit.md)
8399
- [getDepositFromLogs](functions/getDepositFromLogs.md)
84100
- [getFillByDepositTx](functions/getFillByDepositTx.md)
101+
- [getFillLogs](functions/getFillLogs.md)
85102
- [getIntegratorDataSuffix](functions/getIntegratorDataSuffix.md)
86103
- [getLimits](functions/getLimits.md)
87104
- [getMultiCallHandlerAddress](functions/getMultiCallHandlerAddress.md)
88105
- [getQuote](functions/getQuote.md)
89106
- [getSuggestedFees](functions/getSuggestedFees.md)
90107
- [getSupportedChains](functions/getSupportedChains.md)
108+
- [getUpdateDepositTypedData](functions/getUpdateDepositTypedData.md)
109+
- [getUpdateDepositTypedDataV3\_5](functions/getUpdateDepositTypedDataV3_5.md)
91110
- [isOk](functions/isOk.md)
111+
- [isValidIntegratorId](functions/isValidIntegratorId.md)
112+
- [parseDepositLogs](functions/parseDepositLogs.md)
113+
- [parseFillLogs](functions/parseFillLogs.md)
114+
- [signUpdateDepositTypedData](functions/signUpdateDepositTypedData.md)
92115
- [simulateApproveTx](functions/simulateApproveTx.md)
93116
- [simulateDepositTx](functions/simulateDepositTx.md)
94117
- [simulateTxOnTenderly](functions/simulateTxOnTenderly.md)
118+
- [simulateUpdateDepositTx](functions/simulateUpdateDepositTx.md)
95119
- [tagIntegratorId](functions/tagIntegratorId.md)
96120
- [waitForDepositTx](functions/waitForDepositTx.md)
121+
- [waitForFillByDepositTx](functions/waitForFillByDepositTx.md)
97122
- [waitForFillTx](functions/waitForFillTx.md)
123+
- [waitForFillTxEvent](functions/waitForFillTxEvent.md)
124+
- [waitForV3\_5FillEvent](functions/waitForV3_5FillEvent.md)
125+
- [waitForV3FillEvent](functions/waitForV3FillEvent.md)

‎packages/sdk/docs/classes/AcrossApiError.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
#### Defined in
4444

45-
[packages/sdk/src/errors/index.ts:33](https://github.com/across-protocol/toolkit/blob/fa61c35c7597804e093096de254dbc326f096003/packages/sdk/src/errors/index.ts#L33)
45+
[packages/sdk/src/errors/index.ts:33](https://github.com/across-protocol/toolkit/blob/d027d7c23e7230b7b5f439570f9efd60c1d715ce/packages/sdk/src/errors/index.ts#L33)
4646

4747
## Properties
4848

@@ -56,9 +56,9 @@
5656

5757
#### Defined in
5858

59-
node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:24
59+
node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
6060

61-
---
61+
***
6262

6363
### message
6464

@@ -70,9 +70,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error
7070

7171
#### Defined in
7272

73-
node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076
73+
node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es5.d.ts:1076
7474

75-
---
75+
***
7676

7777
### name
7878

@@ -84,9 +84,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:107
8484

8585
#### Defined in
8686

87-
node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1075
87+
node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es5.d.ts:1075
8888

89-
---
89+
***
9090

9191
### stack?
9292

@@ -98,9 +98,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:107
9898

9999
#### Defined in
100100

101-
node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077
101+
node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es5.d.ts:1077
102102

103-
---
103+
***
104104

105105
### status
106106

@@ -112,9 +112,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:107
112112

113113
#### Defined in
114114

115-
[packages/sdk/src/errors/index.ts:15](https://github.com/across-protocol/toolkit/blob/fa61c35c7597804e093096de254dbc326f096003/packages/sdk/src/errors/index.ts#L15)
115+
[packages/sdk/src/errors/index.ts:15](https://github.com/across-protocol/toolkit/blob/d027d7c23e7230b7b5f439570f9efd60c1d715ce/packages/sdk/src/errors/index.ts#L15)
116116

117-
---
117+
***
118118

119119
### url
120120

@@ -126,9 +126,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:107
126126

127127
#### Defined in
128128

129-
[packages/sdk/src/errors/index.ts:14](https://github.com/across-protocol/toolkit/blob/fa61c35c7597804e093096de254dbc326f096003/packages/sdk/src/errors/index.ts#L14)
129+
[packages/sdk/src/errors/index.ts:14](https://github.com/across-protocol/toolkit/blob/d027d7c23e7230b7b5f439570f9efd60c1d715ce/packages/sdk/src/errors/index.ts#L14)
130130

131-
---
131+
***
132132

133133
### prepareStackTrace()?
134134

@@ -156,9 +156,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
156156

157157
#### Defined in
158158

159-
node_modules/.pnpm/@types[email protected]/node_modules/@types/node/globals.d.ts:28
159+
node\_modules/.pnpm/@types[email protected]/node\_modules/@types/node/globals.d.ts:28
160160

161-
---
161+
***
162162

163163
### stackTraceLimit
164164

@@ -170,7 +170,7 @@ node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:28
170170

171171
#### Defined in
172172

173-
node_modules/.pnpm/@types[email protected]/node_modules/@types/node/globals.d.ts:30
173+
node\_modules/.pnpm/@types[email protected]/node\_modules/@types/node/globals.d.ts:30
174174

175175
## Methods
176176

@@ -196,4 +196,4 @@ Create .stack property on a target object
196196

197197
#### Defined in
198198

199-
node_modules/.pnpm/@types[email protected]/node_modules/@types/node/globals.d.ts:21
199+
node\_modules/.pnpm/@types[email protected]/node\_modules/@types/node/globals.d.ts:21

‎packages/sdk/docs/classes/AcrossApiSimulationError.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
#### Defined in
4444

45-
[packages/sdk/src/errors/index.ts:61](https://github.com/across-protocol/toolkit/blob/fa61c35c7597804e093096de254dbc326f096003/packages/sdk/src/errors/index.ts#L61)
45+
[packages/sdk/src/errors/index.ts:61](https://github.com/across-protocol/toolkit/blob/d027d7c23e7230b7b5f439570f9efd60c1d715ce/packages/sdk/src/errors/index.ts#L61)
4646

4747
## Properties
4848

@@ -56,9 +56,9 @@
5656

5757
#### Defined in
5858

59-
node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:24
59+
node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
6060

61-
---
61+
***
6262

6363
### message
6464

@@ -70,9 +70,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error
7070

7171
#### Defined in
7272

73-
node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076
73+
node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es5.d.ts:1076
7474

75-
---
75+
***
7676

7777
### name
7878

@@ -84,9 +84,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:107
8484

8585
#### Defined in
8686

87-
node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1075
87+
node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es5.d.ts:1075
8888

89-
---
89+
***
9090

9191
### stack?
9292

@@ -98,9 +98,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:107
9898

9999
#### Defined in
100100

101-
node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077
101+
node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es5.d.ts:1077
102102

103-
---
103+
***
104104

105105
### status
106106

@@ -112,9 +112,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:107
112112

113113
#### Defined in
114114

115-
[packages/sdk/src/errors/index.ts:15](https://github.com/across-protocol/toolkit/blob/fa61c35c7597804e093096de254dbc326f096003/packages/sdk/src/errors/index.ts#L15)
115+
[packages/sdk/src/errors/index.ts:15](https://github.com/across-protocol/toolkit/blob/d027d7c23e7230b7b5f439570f9efd60c1d715ce/packages/sdk/src/errors/index.ts#L15)
116116

117-
---
117+
***
118118

119119
### transaction
120120

@@ -138,9 +138,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:107
138138
139139
#### Defined in
140140

141-
[packages/sdk/src/errors/index.ts:54](https://github.com/across-protocol/toolkit/blob/fa61c35c7597804e093096de254dbc326f096003/packages/sdk/src/errors/index.ts#L54)
141+
[packages/sdk/src/errors/index.ts:54](https://github.com/across-protocol/toolkit/blob/d027d7c23e7230b7b5f439570f9efd60c1d715ce/packages/sdk/src/errors/index.ts#L54)
142142

143-
---
143+
***
144144

145145
### url
146146

@@ -152,9 +152,9 @@ node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:107
152152

153153
#### Defined in
154154

155-
[packages/sdk/src/errors/index.ts:14](https://github.com/across-protocol/toolkit/blob/fa61c35c7597804e093096de254dbc326f096003/packages/sdk/src/errors/index.ts#L14)
155+
[packages/sdk/src/errors/index.ts:14](https://github.com/across-protocol/toolkit/blob/d027d7c23e7230b7b5f439570f9efd60c1d715ce/packages/sdk/src/errors/index.ts#L14)
156156

157-
---
157+
***
158158

159159
### prepareStackTrace()?
160160

@@ -182,9 +182,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
182182

183183
#### Defined in
184184

185-
node_modules/.pnpm/@types[email protected]/node_modules/@types/node/globals.d.ts:28
185+
node\_modules/.pnpm/@types[email protected]/node\_modules/@types/node/globals.d.ts:28
186186

187-
---
187+
***
188188

189189
### stackTraceLimit
190190

@@ -196,7 +196,7 @@ node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:28
196196

197197
#### Defined in
198198

199-
node_modules/.pnpm/@types[email protected]/node_modules/@types/node/globals.d.ts:30
199+
node\_modules/.pnpm/@types[email protected]/node\_modules/@types/node/globals.d.ts:30
200200

201201
## Methods
202202

@@ -222,4 +222,4 @@ Create .stack property on a target object
222222

223223
#### Defined in
224224

225-
node_modules/.pnpm/@types[email protected]/node_modules/@types/node/globals.d.ts:21
225+
node\_modules/.pnpm/@types[email protected]/node\_modules/@types/node/globals.d.ts:21

0 commit comments

Comments
 (0)