@paraspell/sdk 5.4.2 → 5.6.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 CHANGED
@@ -64,6 +64,8 @@ NOTES:
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.
68
+ - You can now customize XCM Version! Try using .xcmVersion parameter after address in builder.
67
69
  ```
68
70
 
69
71
  ### Builder pattern:
@@ -77,6 +79,7 @@ await Builder(/*node api - optional*/)
77
79
  /*.feeAsset(feeAsset) - Parameter required when using MultilocationArray*/
78
80
  .amount(amount) // Overriden when using MultilocationArray
79
81
  .address(address | Multilocation object /*If you are sending through xTokens, you need to pass the destination and address multilocation in one object (x2)*/)
82
+ /*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
80
83
  .build()
81
84
  /*
82
85
  EXAMPLE:
@@ -95,6 +98,7 @@ await Builder(/*node api - optional*/)
95
98
  .to(NODE/*,customParaId - optional*/ | Multilocation object)
96
99
  .amount(amount)
97
100
  .address(address | Multilocation object)
101
+ /*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
98
102
  .build()
99
103
  /*
100
104
  EXAMPLE:
@@ -111,6 +115,7 @@ await Builder(/*node api - optional*/)
111
115
  .from(NODE)
112
116
  .amount(amount)
113
117
  .address(address | Multilocation object)
118
+ /*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
114
119
  .build()
115
120
  /*
116
121
  EXAMPLE:
@@ -131,6 +136,7 @@ await Builder(/*node api - optional*/)
131
136
  .amount(amount)
132
137
  .address(address)
133
138
  .useKeepAlive(destinationParaAPI)
139
+ /*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
134
140
  .build()
135
141
  ```
136
142
  ##### Close HRMP channels