@paraspell/sdk 7.0.1 → 7.1.0

package/README.md

@@ -100,7 +100,7 @@ NOTES:
 
 ##### Transfer assets from Parachain to Parachain
 ```ts
-await Builder(/*node api - optional*/)
+await Builder(/*node api/ws_url_string - optional*/)
       .from(NODE)
       .to(NODE /*,customParaId - optional*/ | Multilocation object /*Only works for PolkadotXCM pallet*/) 
       .currency({id: currencyID} | {symbol: currencySymbol}, | {multilocation: multilocationJson} | {multiasset: multilocationJsonArray})
@@ -122,7 +122,7 @@ await Builder()
 ```
 ##### Transfer assets from the Relay chain to Parachain
 ```ts
-await Builder(/*node api - optional*/)
+await Builder(/*node api/ws_url_string - optional*/)
       .to(NODE/*,customParaId - optional*/ | Multilocation object)
       .amount(amount)
       .address(address | Multilocation object)
@@ -139,7 +139,7 @@ await Builder()
 ```
 ##### Transfer assets from Parachain to Relay chain
 ```ts
-await Builder(/*node api - optional*/)
+await Builder(/*node api/ws_url_string - optional*/)
       .from(NODE)
       .amount(amount)
       .address(address | Multilocation object)
@@ -159,7 +159,7 @@ await Builder()
 NOTE: Custom multilocations are not available when keepALive check is used
 ```
 ```ts
-await Builder(/*node api - optional*/)
+await Builder(/*node api/ws_url_string - optional*/)
       .from(NODE)
       .amount(amount)
       .address(address)
@@ -171,7 +171,7 @@ await Builder(/*node api - optional*/)
 ##### 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*/)
+await Builder(/*node api/ws_url_string - 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()
@@ -202,7 +202,7 @@ NOTES:
 // Transfer assets from Parachain to Parachain
 await paraspell.xcmPallet.send(
     {
-      api?: ApiPromise,
+      api?: ApiPromise/Ws_url_string,
       origin: origin  Parachain  name  string,
       currency: {id: currencyID} | {symbol: currencySymbol}, | {multilocation: multilocationJson} | {multiasset: multilocationJsonArray},
       feeAsset? - Fee asset select id
@@ -217,7 +217,7 @@ await paraspell.xcmPallet.send(
 // Transfer assets from Parachain to Relay chain
 await paraspell.xcmPallet.send(
   {
-    api?: ApiPromise,
+    api?: ApiPromise/Ws_url_string,
     origin: origin  Parachain  name  string,
     amount: any,
     to: destination  address  string | Multilocation object,
@@ -229,7 +229,7 @@ await paraspell.xcmPallet.send(
 // Transfer assets from Relay chain to Parachain
 await paraspell.xcmPallet.transferRelayToPara(
   {
-    api?: ApiPromise,
+    api?: ApiPromise/Ws_url_string,
     destination: destination  Parachain  ID | Multilocation object,
     amount: any,
     to: destination  address  string | Multilocation object,
@@ -242,7 +242,7 @@ await paraspell.xcmPallet.transferRelayToPara(
 ### Asset claim:
 ```ts
 //Claim XCM trapped assets from the selected chain
-await Builder(api)
+await Builder(api/ws_url_string)
       .claimFrom(NODE)
       .fungible(MultilocationArray (Only one multilocation allowed) [{Multilocation}])
       .account(address | Multilocation object)
@@ -322,16 +322,19 @@ import { getTransferInfo, getBalanceForeign, getBalanceNative, getOriginFeeDetai
 import { getTransferInfo, getBalanceForeign, getBalanceNative, getOriginFeeDetails } from "@paraspell/sdk/papi"; 
 
 //Get balance of foreign currency
-await getBalanceForeign(address, Parachain name, currency /*- {id: currencyID} | {symbol: currencySymbol}*/)
+await getBalanceForeign({address, node, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, api /* api/ws_url_string optional */})
 
 //Get balance of native currency
-await getBalanceNative(address, Parachain name)
+await getBalanceNative({address, node, api /* api/ws_url_string optional */})
 
 //Get fee information regarding XCM call
-await getOriginFeeDetails(from, to, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, amount, originAddress, api /* optional */, feeMargin /* 10% by default */)
+await getOriginFeeDetails({from, to, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, amount, originAddress, api /* api/ws_url_string optional */, feeMargin /* 10% by default */})
+
+//Retrieves the asset balance for a given account on a specified node.
+await getAssetBalance({address, node, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, api /* api/ws_url_string optional */});
 
 //Get all the information about XCM transfer
-await getTransferInfo(from, to, address, destinationAddress, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, amount)
+await getTransferInfo({from, to, address, destinationAddress, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, amount, api /* api/ws_url_string optional */})
 ```
 
 ## 💻 Tests