Skip to content

Commit 0efe953

Browse files
update asset-transfer-api to latest version (#379)
* update asset-transfer-api to latest version * hard-code versions in sub-pages to allow local mkdocs builds * generate llms.txt * resolve conflicts * update reference to use version instead of commit hash
1 parent 75ce96e commit 0efe953

File tree

5 files changed

+37
-37
lines changed

5 files changed

+37
-37
lines changed

.snippets/code/develop/toolkit/interoperability/asset-transfer-api/reference/transfer-arg-opts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Options for customizing the claim assets transaction. These options allow you to
99
??? child "Type `Format`"
1010

1111
```ts
12-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:122:122'
12+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:132:132'
1313
```
1414

1515
---
@@ -60,7 +60,7 @@ Options for customizing the claim assets transaction. These options allow you to
6060
??? child "Type `AssetTransferType`"
6161

6262
```ts
63-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:480:480'
63+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:540:540'
6464
```
6565
6666
!!! note
@@ -82,7 +82,7 @@ Options for customizing the claim assets transaction. These options allow you to
8282
??? child "Type `AssetTransferType`"
8383

8484
```ts
85-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:480:480'
85+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:540:540'
8686
```
8787
8888
!!! note
@@ -102,4 +102,4 @@ Options for customizing the claim assets transaction. These options allow you to
102102

103103
```bash
104104
Xcm(vec![DepositAsset { assets: Wild(AllCounted(assets.len())), beneficiary }])
105-
```
105+
```

.snippets/code/develop/toolkit/interoperability/asset-transfer-api/reference/tx-result.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A promise containing the result of constructing the transaction.
2121
??? child "Type `Format`"
2222

2323
```ts
24-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:122:122'
24+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:132:132'
2525
```
2626

2727
---
@@ -109,14 +109,14 @@ A promise containing the result of constructing the transaction.
109109
??? child "Type `Methods`"
110110

111111
```ts
112-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:153:162'
112+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:170:179'
113113
```
114114

115115
??? child "Type `LocalTransferTypes`"
116116

117117

118118
```ts
119-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:138:148'
119+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:148:163'
120120
```
121121

122122
---
@@ -128,7 +128,7 @@ A promise containing the result of constructing the transaction.
128128
??? child "Type `ConstructedFormat<T>`"
129129

130130
```ts
131-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:127:133'
131+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:137:143'
132132
```
133133

134134
The `ConstructedFormat` type is a conditional type that returns a specific type based on the value of the TxResult `format` field.

develop/toolkit/interoperability/asset-transfer-api/reference.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ description: Explore the Asset Transfer API Reference for comprehensive details
3232

3333
Holds open an API connection to a specified chain within the `ApiPromise` to help construct transactions for assets and estimate fees.
3434

35-
For a more in-depth explanation of the Asset Transfer API class structure, check the [source code](https://github.com/paritytech/asset-transfer-api/blob/f2aa50db83882f23492f975221dd5501c35a26d5/src/AssetTransferApi.ts#L106){target=\_blank}.
35+
For a more in-depth explanation of the Asset Transfer API class structure, check the [source code](https://github.com/paritytech/asset-transfer-api/blob/{{dependencies.asset_transfer_api.version}}/src/AssetTransferApi.ts#L121){target=\_blank}.
3636

3737
### Methods
3838

@@ -43,7 +43,7 @@ Generates an XCM transaction for transferring assets between chains. It simplifi
4343
After obtaining the transaction, you must handle the signing and submission process separately.
4444

4545
```ts
46-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/{{dependencies.asset_transfer_api.version}}/src/AssetTransferApi.ts:169:175'
46+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/{{dependencies.asset_transfer_api.version}}/src/AssetTransferApi.ts:184:190'
4747
```
4848

4949
??? interface "Request parameters"
@@ -102,7 +102,7 @@ Creates a local XCM transaction to retrieve trapped assets. This function can be
102102

103103

104104
```ts
105-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/AssetTransferApi.ts:344:349'
105+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/{{dependencies.asset_transfer_api.version}}/src/AssetTransferApi.ts:368:373'
106106
```
107107

108108
??? interface "Request parameters"
@@ -153,7 +153,7 @@ Creates a local XCM transaction to retrieve trapped assets. This function can be
153153
Decodes the hex of an extrinsic into a string readable format.
154154

155155
```ts
156-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/AssetTransferApi.ts:466:466'
156+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/{{dependencies.asset_transfer_api.version}}/src/AssetTransferApi.ts:529:529'
157157
```
158158

159159
??? interface "Request parameters"
@@ -171,7 +171,7 @@ Decodes the hex of an extrinsic into a string readable format.
171171
??? child "Type `Format`"
172172

173173
```ts
174-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:122:122'
174+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/{{dependencies.asset_transfer_api.version}}/src/types.ts:132:132'
175175
```
176176

177177
??? interface "Response parameters"
@@ -197,7 +197,7 @@ Decodes the hex of an extrinsic into a string readable format.
197197
Fetch estimated fee information for an extrinsic.
198198

199199
```ts
200-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/AssetTransferApi.ts:420:423'
200+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/{{dependencies.asset_transfer_api.version}}/src/AssetTransferApi.ts:444:447'
201201
```
202202

203203
??? interface "Request parameters"
@@ -209,7 +209,7 @@ Fetch estimated fee information for an extrinsic.
209209
??? child "Type `ConstructedFormat<T>`"
210210

211211
```ts
212-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:127:133'
212+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/{{dependencies.asset_transfer_api.version}}/src/types.ts:137:143'
213213
```
214214

215215
The `ConstructedFormat` type is a conditional type that returns a specific type based on the value of the TxResult `format` field.
@@ -227,7 +227,7 @@ Fetch estimated fee information for an extrinsic.
227227
??? child "Type `Format`"
228228

229229
```ts
230-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:122:122'
230+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/{{dependencies.asset_transfer_api.version}}/src/types.ts:132:132'
231231
```
232232

233233
??? interface "Response parameters"
@@ -271,4 +271,4 @@ Fetch estimated fee information for an extrinsic.
271271

272272
***Response***
273273

274-
--8<-- 'code/develop/toolkit/interoperability/asset-transfer-api/reference/ffi-example-response.md'
274+
--8<-- 'code/develop/toolkit/interoperability/asset-transfer-api/reference/ffi-example-response.md'

llms.txt

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8452,7 +8452,7 @@ description: Explore the Asset Transfer API Reference for comprehensive details
84528452

84538453
Holds open an API connection to a specified chain within the `ApiPromise` to help construct transactions for assets and estimate fees.
84548454

8455-
For a more in-depth explanation of the Asset Transfer API class structure, check the [source code](https://github.com/paritytech/asset-transfer-api/blob/f2aa50db83882f23492f975221dd5501c35a26d5/src/AssetTransferApi.ts#L106){target=\_blank}.
8455+
For a more in-depth explanation of the Asset Transfer API class structure, check the [source code](https://github.com/paritytech/asset-transfer-api/blob/{{dependencies.asset_transfer_api.version}}/src/AssetTransferApi.ts#L121){target=\_blank}.
84568456

84578457
### Methods
84588458

@@ -8513,7 +8513,7 @@ public async createTransferTransaction<T extends Format>(
85138513
??? child "Type `Format`"
85148514

85158515
```ts
8516-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:122:122'
8516+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:132:132'
85178517
```
85188518

85198519
---
@@ -8564,7 +8564,7 @@ public async createTransferTransaction<T extends Format>(
85648564
??? child "Type `AssetTransferType`"
85658565

85668566
```ts
8567-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:480:480'
8567+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:540:540'
85688568
```
85698569

85708570
!!! note
@@ -8586,7 +8586,7 @@ public async createTransferTransaction<T extends Format>(
85868586
??? child "Type `AssetTransferType`"
85878587

85888588
```ts
8589-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:480:480'
8589+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:540:540'
85908590
```
85918591

85928592
!!! note
@@ -8635,7 +8635,7 @@ public async createTransferTransaction<T extends Format>(
86358635
??? child "Type `Format`"
86368636

86378637
```ts
8638-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:122:122'
8638+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:132:132'
86398639
```
86408640

86418641
---
@@ -8723,14 +8723,14 @@ public async createTransferTransaction<T extends Format>(
87238723
??? child "Type `Methods`"
87248724

87258725
```ts
8726-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:153:162'
8726+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:170:179'
87278727
```
87288728

87298729
??? child "Type `LocalTransferTypes`"
87308730

87318731

87328732
```ts
8733-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:138:148'
8733+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:148:163'
87348734
```
87358735

87368736
---
@@ -8742,7 +8742,7 @@ public async createTransferTransaction<T extends Format>(
87428742
??? child "Type `ConstructedFormat<T>`"
87438743

87448744
```ts
8745-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:127:133'
8745+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:137:143'
87468746
```
87478747

87488748
The `ConstructedFormat` type is a conditional type that returns a specific type based on the value of the TxResult `format` field.
@@ -8854,7 +8854,7 @@ public async claimAssets<T extends Format>(
88548854
??? child "Type `Format`"
88558855

88568856
```ts
8857-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:122:122'
8857+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:132:132'
88588858
```
88598859

88608860
---
@@ -8905,7 +8905,7 @@ public async claimAssets<T extends Format>(
89058905
??? child "Type `AssetTransferType`"
89068906

89078907
```ts
8908-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:480:480'
8908+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:540:540'
89098909
```
89108910

89118911
!!! note
@@ -8927,7 +8927,7 @@ public async claimAssets<T extends Format>(
89278927
??? child "Type `AssetTransferType`"
89288928

89298929
```ts
8930-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:480:480'
8930+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:540:540'
89318931
```
89328932

89338933
!!! note
@@ -8976,7 +8976,7 @@ public async claimAssets<T extends Format>(
89768976
??? child "Type `Format`"
89778977

89788978
```ts
8979-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:122:122'
8979+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:132:132'
89808980
```
89818981

89828982
---
@@ -9064,14 +9064,14 @@ public async claimAssets<T extends Format>(
90649064
??? child "Type `Methods`"
90659065

90669066
```ts
9067-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:153:162'
9067+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:170:179'
90689068
```
90699069

90709070
??? child "Type `LocalTransferTypes`"
90719071

90729072

90739073
```ts
9074-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:138:148'
9074+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:148:163'
90759075
```
90769076

90779077
---
@@ -9083,7 +9083,7 @@ public async claimAssets<T extends Format>(
90839083
??? child "Type `ConstructedFormat<T>`"
90849084

90859085
```ts
9086-
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.3.1/src/types.ts:127:133'
9086+
--8<-- 'https://raw.githubusercontent.com/paritytech/asset-transfer-api/refs/tags/v0.5.0/src/types.ts:137:143'
90879087
```
90889088

90899089
The `ConstructedFormat` type is a conditional type that returns a specific type based on the value of the TxResult `format` field.
@@ -9253,10 +9253,10 @@ public async fetchFeeInfo<T extends Format>(
92539253
export type ConstructedFormat<T> = T extends 'payload'
92549254
? GenericExtrinsicPayload
92559255
: T extends 'call'
9256-
? `0x${string}`
9257-
: T extends 'submittable'
9258-
? SubmittableExtrinsic<'promise', ISubmittableResult>
9259-
: never;
9256+
? `0x${string}`
9257+
: T extends 'submittable'
9258+
? SubmittableExtrinsic<'promise', ISubmittableResult>
9259+
: never;
92609260
```
92619261

92629262
The `ConstructedFormat` type is a conditional type that returns a specific type based on the value of the TxResult `format` field.

variables.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ dependencies:
1212
architecture: macos-arm64
1313
asset_transfer_api:
1414
repository_url: https://github.com/paritytech/asset-transfer-api
15-
version: v0.3.1
15+
version: v0.5.0
1616
polkadot_sdk_solochain_template:
1717
repository_url: https://github.com/paritytech/polkadot-sdk-solochain-template
1818
version: v0.0.2

0 commit comments

Comments
 (0)