@paraspell/sdk 5.9.0 → 6.0.0

package/README.md

@@ -57,13 +57,13 @@ const paraspell = require('@paraspell/sdk')
 
 ```
 NOTES:
-- 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.
+- 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({id: 42259045809535163221576417993425387648n}) will mean you transfer xcDOT.
 - You can now use custom ParachainIDs if you wish to test in TestNet. Just add parachainID as an additional parameter eg: .to('Basilisk', 2948).
 - You can now add an optional parameter useKeepAlive which will ensure, that you send more than the existential deposit.
 - 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.
 - Fee asset is now a required builder parameter when you enter a multilocation array.
 - When using a multilocation array the amount parameter is overridden.
-- 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.
+- Multilocation arrays are now available. Customize your asset multilocations by .currency({multiasset: [{multilocation1},{multilocation2}..{multilocationN}]}) For more information refer to the official documentation or following PR https://github.com/paraspell/xcm-tools/pull/224.
 - 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.
 - You can now customize XCM Version! Try using .xcmVersion parameter after address in builder.
 - 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.
@@ -76,7 +76,7 @@ NOTES:
 await Builder(/*node api - optional*/)
       .from(NODE)
       .to(NODE /*,customParaId - optional*/ | Multilocation object /*Only works for PolkadotXCM pallet*/) 
-      .currency(CurrencyString| CurrencyID | Multilocation object | MultilocationArray)
+      .currency({id: currencyID} | {symbol: currencySymbol}, | {multilocation: multilocationJson} | {multiasset: multilocationJsonArray})
       /*.feeAsset(feeAsset) - Parameter required when using MultilocationArray*/
       .amount(amount) // Overriden when using MultilocationArray
       .address(address | Multilocation object /*If you are sending through xTokens, you need to pass the destination and address multilocation in one object (x2)*/)
@@ -87,7 +87,7 @@ EXAMPLE:
 await Builder()
       .from('Basilisk')
       .to('Robonomics')
-      .currency('XRT')
+      .currency({symbol:'XRT'})
       .amount(1000000000000)
       .address('4FCUYBMe2sbq5KosN22emsPUydS8XUwZhJ6VUZesmouGu6qd')
       .build()
@@ -140,25 +140,28 @@ await Builder(/*node api - optional*/)
       /*.xcmVersion(Version.V1/V2/V3/V4)  //Optional parameter for manual override of XCM Version used in call*/
       .build()
 ```
-##### Close HRMP channels
-```ts
-Builder(api)
-.from(NODE)
-.closeChannel()
-.inbound(inbound)
-.outbound(outbound)
-.build()
-```
 
-##### Open HRMP channels
-```ts
-Builder()
-.from(NODE)
-.to(NODE)
-.openChannel()
-.maxSize(maxSize)
-.maxMessageSize(maxMsgSize)
-.build()'
+##### Batch calls
+You can batch XCM calls and execute multiple XCM calls within one call. All three scenarios (Para->Para, Para->Relay, Relay->Para) can be used and combined.
+```js
+await Builder(/*node api - optional*/)
+      .from(NODE) //Ensure, that origin node is the same in all batched XCM Calls.
+      .to(NODE_2) //Any compatible Parachain
+      .currency(currency) //Currency to transfer (If Para->Para), otherwise you do not need to specify .currency()
+      .amount(amount) 
+      .address(address | Multilocation object)
+      .addToBatch()
+
+      .from(NODE) //Ensure, that origin node is the same in all batched XCM Calls.
+      .to(NODE_3) //Any compatible Parachain
+      .currency(currency) //Currency to transfer (If Para->Para), otherwise you do not need to specify .currency()
+      .amount(amount)
+      .address(address | Multilocation object)
+      .addToBatch()
+      .buildBatch({ 
+          // This settings object is optional and batch all is the default option
+          mode: BatchMode.BATCH_ALL //or BatchMode.BATCH
+      })
 ```
 
 ### Function pattern:
@@ -174,7 +177,7 @@ await paraspell.xcmPallet.send(
     {
       api?: ApiPromise,
       origin: origin  Parachain  name  string,
-      currency: CurrencyString | CurrencyID | Multilocation object /*Only works for PolkadotXCM pallet*/,
+      currency: {id: currencyID} | {symbol: currencySymbol}, | {multilocation: multilocationJson} | {multiasset: multilocationJsonArray},
       feeAsset? - Fee asset select id
       amount: any,
       to: destination  address  string | Multilocation object,
@@ -207,27 +210,6 @@ await paraspell.xcmPallet.transferRelayToPara(
     destApiForKeepAlive?: ApiPromise
   }
 )
-
-// Close HRMP channels
-paraspell.closeChannels.closeChannel(
-  {
-    api: ApiPromise,
-    origin: origin  Parachain  ID, 
-    inbound: number,
-    outbound: number
-  }
-)
-
-// Open HRMP channels
-paraspell.openChannels.openChannel(
-  {
-    api: ApiPromise,
-    origin: origin  Parachain  ID,
-    destination: destination  Parachain  ID,
-    maxSize: number,
-    maxMessageSize: number
-  }
-)
 ```
 
 ### Asset claim:
@@ -304,16 +286,16 @@ const ed = getExistentialDeposit('Acala')
 import { getTransferInfo, getBalanceForeign, getBalanceNative, getOriginFeeDetails } from "@paraspell/sdk"; 
 
 //Get balance of foreign currency
-await getBalanceForeign(address, Parachain name, currency)
+await getBalanceForeign(address, Parachain name, currency /*- {id: currencyID} | {symbol: currencySymbol}*/)
 
 //Get balance of native currency
 await getBalanceNative(address, Parachain name)
 
 //Get fee information regarding XCM call
-await getOriginFeeDetails(from, to, currency, amount, originAddress)
+await getOriginFeeDetails(from, to, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, amount, originAddress)
 
 //Get all the information about XCM transfer
-await getTransferInfo(from, to, address, destinationAddress, currency, amount)
+await getTransferInfo(from, to, address, destinationAddress, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, amount)
 ```
 
 ## 💻 Tests