@paraspell/sdk 5.5.0 → 5.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -7
- package/dist/index.cjs +1559 -916
- package/dist/index.d.ts +85 -27
- package/dist/index.mjs +1551 -914
- package/package.json +18 -29
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
<img alt="snyk" src="https://snyk.io/test/github/paraspell/sdk/badge.svg" />
|
|
18
18
|
</a>
|
|
19
19
|
</p>
|
|
20
|
-
<p>Currently supporting
|
|
20
|
+
<p>Currently supporting 55 Polkadot & Kusama nodes list <a href = "https://github.com/paraspell/xcm-tools/blob/main/packages/sdk/docs/supportedNodes.md"\>[here]</p>
|
|
21
21
|
<p>SDK documentation <a href = "https://paraspell.github.io/docs/" \>[here]</p>
|
|
22
22
|
</div>
|
|
23
23
|
|
|
@@ -58,13 +58,15 @@ const paraspell = require('@paraspell/sdk')
|
|
|
58
58
|
```
|
|
59
59
|
NOTES:
|
|
60
60
|
- If you wish to transfer from Parachain that uses long IDs for example Moonbeam you have to add the character 'n' to the end of currencyID. Eg: .currency(42259045809535163221576417993425387648n) will mean you transfer xcDOT.
|
|
61
|
-
- You can now use custom ParachainIDs if you wish to test in TestNet. Just add parachainID as an additional parameter eg: .to('Basilisk', 2948)
|
|
61
|
+
- You can now use custom ParachainIDs if you wish to test in TestNet. Just add parachainID as an additional parameter eg: .to('Basilisk', 2948).
|
|
62
62
|
- You can now add an optional parameter useKeepAlive which will ensure, that you send more than the existential deposit.
|
|
63
63
|
- Since v5 you can fully customize all multilocations (address, currency and destination). Instead of a string parameter simply pass an object with multilocation instead for more information refer to the following PR https://github.com/paraspell/xcm-tools/pull/199.
|
|
64
64
|
- Fee asset is now a required builder parameter when you enter a multilocation array.
|
|
65
65
|
- When using a multilocation array the amount parameter is overridden.
|
|
66
66
|
- Multilocation arrays are now available. Customize your asset multilocations by .currency([{multilocation1},{multilocation2}..{multilocationN}]) For more information refer to the official documentation or following PR https://github.com/paraspell/xcm-tools/pull/224.
|
|
67
|
-
- POLKADOT <> KUSAMA Bridge is now available! Try sending DOT or KSM between AssetHubs.
|
|
67
|
+
- POLKADOT <> KUSAMA Bridge is now available! Try sending DOT or KSM between AssetHubs - More information here: https://paraspell.github.io/docs/sdk/xcmPallet.html#ecosystem-bridges.
|
|
68
|
+
- You can now customize XCM Version! Try using .xcmVersion parameter after address in builder.
|
|
69
|
+
- POLKADOT <> ETHEREUM Bridge is now available! Try sending WETH between the ecosystems - More information here: https://paraspell.github.io/docs/sdk/xcmPallet.html#ecosystem-bridges.
|
|
68
70
|
```
|
|
69
71
|
|
|
70
72
|
### Builder pattern:
|
|
@@ -78,6 +80,7 @@ await Builder(/*node api - optional*/)
|
|
|
78
80
|
/*.feeAsset(feeAsset) - Parameter required when using MultilocationArray*/
|
|
79
81
|
.amount(amount) // Overriden when using MultilocationArray
|
|
80
82
|
.address(address | Multilocation object /*If you are sending through xTokens, you need to pass the destination and address multilocation in one object (x2)*/)
|
|
83
|
+
/*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
|
|
81
84
|
.build()
|
|
82
85
|
/*
|
|
83
86
|
EXAMPLE:
|
|
@@ -96,6 +99,7 @@ await Builder(/*node api - optional*/)
|
|
|
96
99
|
.to(NODE/*,customParaId - optional*/ | Multilocation object)
|
|
97
100
|
.amount(amount)
|
|
98
101
|
.address(address | Multilocation object)
|
|
102
|
+
/*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
|
|
99
103
|
.build()
|
|
100
104
|
/*
|
|
101
105
|
EXAMPLE:
|
|
@@ -112,6 +116,7 @@ await Builder(/*node api - optional*/)
|
|
|
112
116
|
.from(NODE)
|
|
113
117
|
.amount(amount)
|
|
114
118
|
.address(address | Multilocation object)
|
|
119
|
+
/*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
|
|
115
120
|
.build()
|
|
116
121
|
/*
|
|
117
122
|
EXAMPLE:
|
|
@@ -132,6 +137,7 @@ await Builder(/*node api - optional*/)
|
|
|
132
137
|
.amount(amount)
|
|
133
138
|
.address(address)
|
|
134
139
|
.useKeepAlive(destinationParaAPI)
|
|
140
|
+
/*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
|
|
135
141
|
.build()
|
|
136
142
|
```
|
|
137
143
|
##### Close HRMP channels
|
|
@@ -342,11 +348,8 @@ Published under [MIT License](https://github.com/paraspell/xcm-tools/blob/main/p
|
|
|
342
348
|
<a href="https://github.com/w3f/Grants-Program/pull/1245">
|
|
343
349
|
<img width="200" alt="version" src="https://user-images.githubusercontent.com/55763425/211145923-f7ee2a57-3e63-4b7d-9674-2da9db46b2ee.png" />
|
|
344
350
|
</a>
|
|
345
|
-
<a href="https://kusama.subsquare.io/referenda/
|
|
351
|
+
<a href="https://kusama.subsquare.io/referenda/417">
|
|
346
352
|
<img width="200" alt="version" src="https://github.com/paraspell/xcm-sdk/assets/55763425/9ed74ebe-9b29-4efd-8e3e-7467ac4caed6" />
|
|
347
353
|
</a>
|
|
348
|
-
<a href="https://bsx.fi/">
|
|
349
|
-
<img width="200" alt="version" src="https://user-images.githubusercontent.com/55763425/204865221-90d2b3cd-f2ac-48a2-a367-08722aa8e923.svg" />
|
|
350
|
-
</a>
|
|
351
354
|
</p>
|
|
352
355
|
</div>
|