@paraspell/sdk 12.9.7 → 12.10.0-rc.0

package/README.md

@@ -47,7 +47,7 @@ npm install | pnpm add | yarn add @paraspell/sdk
 
 ### Install Swap extension
 
-If you plan to [do Swap XCMs](https://paraspell.github.io/docs/sdk/xcmPallet.html#swap) you can install Swap package which allows you to do cross-chain swaps on popular Polkadot, Kusama, Paseo, Westend exchanges. Only available in PAPI version of SDK.
+If you plan to [do Swap XCMs](https://paraspell.github.io/docs/sdk/xcmPallet.html#swap) you can install Swap package which allows you to do cross-chain swaps on popular Polkadot, Kusama, Paseo, Westend exchanges. Now available in all JS client versions of SDK.
 
 > [!IMPORTANT]
 > - ⚠️  **WebAssembly (Wasm) must be enabled in your project** because of the Hydration SDK (One of the exchanges implemented in XCM Router). Wasm can be enabled either through the web application configuration or through the appropriate plugin. 
@@ -87,11 +87,14 @@ import * as paraspell from '@paraspell/sdk'
 ## Implementation
 
 > [!NOTE]
+> - You can now pass signer directly into sender parameter
 > - The local transfers now have additional builder parameter called keepAlive
 > - Transact is here! Find out more: https://paraspell.github.io/docs/sdk/xcmPallet.html#transact
 > 
 > **Latest news:**
-> - Swap is here! Find out more: https://paraspell.github.io/docs/sdk/getting-started.html#install-swap-extension
+> - V12 > V13 Migration guide: https://paraspell.github.io/docs/migration/v12-to-v13.html
+> - Swap package is now available on every XCM SDK version: https://paraspell.github.io/docs/sdk/getting-started.html#install-swap-extension
+> - abstractDecimals is now turned on by default!
 
 ### Sending XCM
 For full documentation on XCM Transfers head over to [official documentation](https://paraspell.github.io/docs/sdk/xcmPallet.html).
@@ -103,15 +106,15 @@ const builder = Builder(/*chain api/builder_config/ws_url_string/ws_url_array -
       .from(TSubstrateChain)
       .to(TChain /*,customParaId - optional*/ | Location object /*Only works for PolkadotXCM pallet*/) 
       .currency({id: currencyID, amount: amount} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | {location: Override('Custom Location'), amount: amount /*Use "ALL" to transfer everything*/} | [{currencySelection /*for example symbol: symbol or id: id, or location: location*/, amount: amount /*Use "ALL" to transfer everything*/}, {currencySelection}, ..]) 
-      .address(address | Location object /*If you are sending through xTokens, you need to pass the destination and address Location in one object (x2)*/)
-      .senderAddress(address | PAPI_SIGNER) // - OPTIONAL but strongly recommended as it is automatically ignored when not needed - Used when origin is AssetHub with feeAsset or when sending to AssetHub to prevent asset traps by auto-swapping to DOT to have DOT ED.
+      .recipient(address | Location object /*If you are sending through xTokens, you need to pass the destination and address Location in one object (x2)*/)
+      .sender(address | PAPI_SIGNER) // - OPTIONAL but strongly recommended as it is automatically ignored when not needed - Used when origin is AssetHub with feeAsset or when sending to AssetHub to prevent asset traps by auto-swapping to DOT to have DOT ED.
       /*.ahAddress(ahAddress) - OPTIONAL - used when origin is EVM chain and XCM goes through AssetHub (Multihop transfer where we are unable to convert Key20 to ID32 address eg. origin: Moonbeam & destination: Ethereum (Multihop goes from Moonbeam > AssetHub > BridgeHub > Ethereum)
         .feeAsset({symbol: 'symbol'} || {id: 'id'} || {location: 'location'}) // Optional parameter used when multiasset is provided or when origin is AssetHub - so user can pay in fees different than DOT
         .xcmVersion(Version.V3/V4/V5)  //Optional parameter for manual override of XCM Version used in call
         .customPallet('Pallet','pallet_function') //Optional parameter for manual override of XCM Pallet and function used in call (If they are named differently on some chain but syntax stays the same). Both pallet name and function required. Pallet name must be CamelCase, function name snake_case.*/
 
 const tx = await builder.build()
-// Or if you use signers in senderAddress:
+// Or if you use signers in sender:
 // await builder.signAndSubmit() - Signs and submits the transaction; returns TX hash for tracking
 
 //Make sure to disconnect the API after it is no longer used (eg, after a transaction)
@@ -124,9 +127,9 @@ const builder = Builder()
   .to('Polkadot')
   .currency({
     symbol: 'DOT',
-    amount: '1000000000'
+    amount: '1'
   })
-  .address(address)
+  .recipient(address)
 
 const tx = await builder.build()
 
@@ -142,7 +145,7 @@ const builder = Builder(/*chain api/builder_config/ws_url_string/ws_url_array -
       .from(TSubstrateChain)
       .to(TChain) //Has to be the same as the origin (from)
       .currency({id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | {location: Override('Custom Location'), amount: amount /*Use "ALL" to transfer everything*/} | [{currencySelection /*for example symbol: symbol or id: id, or location: location*/, amount: amount /*Use "ALL" to transfer everything*/}, {currencySelection}, ..])
-      .address(address)
+      .recipient(address)
    /* .keepAlive(bool) - Optional: Allows draining the account below the existential deposit. */
 
 const tx = await builder.build()
@@ -157,9 +160,9 @@ const builder = Builder()
   .to('Hydration')
   .currency({
     symbol: 'DOT',
-    amount: '1000000000'
+    amount: '1'
   })
-  .address(address)
+  .recipient(address)
 
 const tx = await builder.build()
 
@@ -175,12 +178,12 @@ const builder = Builder(/*client | builder_config | ws_url | [ws_url, ws_url,..]
       .from(TSubstrateChain) // 'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/sdk/AssetPallet.html#import-chains-as-types
       .to(TChain) // Has to be same as origin (from)
       .currency({id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | {location: Override('Custom Location'), amount: amount /*Use "ALL" to transfer everything*/})
-      .senderAddress(senderAddress | PAPI SIGNER)
-      .address(address)
+      .sender(sender | PAPI SIGNER)
+      .recipient(address)
       .transact(hex, /* originType, TWeight - Optional */)
 
 const tx = await builder.build()
-// Or if you use signers in senderAddress:
+// Or if you use signers in sender:
 // await builder.signAndSubmit() - Signs and submits the transaction; returns TX hash for tracking
 
 //Disconnect API after TX
@@ -194,20 +197,21 @@ const builder = Builder(/*client | builder_config |ws_url | [ws_url, ws_url,..]
       .from(TSubstrateChain) // 'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/sdk/AssetPallet.html#import-chains-as-types
       .to(TChain /*,customParaId - optional*/ | Location object /*Only works for PolkadotXCM pallet*/) //'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/sdk/AssetPallet.html#import-chains-as-types
       .currency({id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | {location: Override('Custom Location'), amount: amount /*Use "ALL" to transfer everything*/})
-      .address(address | Location object /*If you are sending through xTokens, you need to pass the destination and address location in one object (x2)*/)
-      .senderAddress(address | PAPI_SIGNER /*Only in PAPI SDK*/ | {address, PJS_SIGNER} /*Only in PJS SDK*/) // - OPTIONAL but strongly recommended as it is automatically ignored when not needed - Used when origin is AssetHub/Hydration with feeAsset or when sending to AssetHub to prevent asset traps by auto-swapping to DOT to have DOT ED.
+      .recipient(address | Location object /*If you are sending through xTokens, you need to pass the destination and address location in one object (x2)*/)
+      .sender(address | PAPI_SIGNER /*Only in PAPI SDK*/ | {address, PJS_SIGNER} /*Only in PJS SDK*/) // - OPTIONAL but strongly recommended as it is automatically ignored when not needed - Used when origin is AssetHub/Hydration with feeAsset or when sending to AssetHub to prevent asset traps by auto-swapping to DOT to have DOT ED.
       .swap({
           currencyTo: {id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | {location: Override('Custom Location'), amount: amount /*Use "ALL" to transfer everything*/}
           // exchange: ['AssetHubPolkadotDex'], - Optional parameter - 'HydrationDex' | 'AcalaDex' | 'AssetHubPolkadotDex' | ...
           // slippage: 1, - Optional - 1 by default
-          // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+          // evmsender: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
           // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
           // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
       })
 
 const tx = await builder.buildAll()
-// Or if you use signers in senderAddress:
-// await builder.signAndSubmit() - Signs and submits the transaction; returns TX hash for tracking
+// Or if you use signers in sender:
+// await builder.signAndSubmit() - Signs and submits the transaction (only working in 1click scenarios); returns TX hash for tracking
+// await builder.signAndSubmitAll() - Signs and submits transactions (required in 2click scenarios); returns array of TX hashes for tracking
 
 // Make sure to disconnect API after it is no longer used (eg. after transaction)
 await builder.disconnect()
@@ -226,12 +230,12 @@ const result = await Builder(/*chain api/builder_config/ws_url_string/ws_url_arr
               currencyTo: CURRENCY_SPEC, //Reffer to currency spec options above
               // exchange: ['AssetHubPolkadotDex'], - Optional parameter - 'HydrationDex' | 'AcalaDex' | 'AssetHubPolkadotDex' | ...
               // slippage: 1, - Optional - 1 by default
-              // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+              // evmsender: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
               // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
               // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
           })*/
-        .address(ADDRESS)
-        .senderAddress(address | PAPI_SIGNER)
+        .recipient(ADDRESS)
+        .sender(address | PAPI_SIGNER)
         .dryRun()
 
 //Check Parachain for DryRun support - returns true/false
@@ -249,8 +253,8 @@ const result = await Builder(/*chain api/builder_config/ws_url_string/ws_url_arr
         .to(TChain)
         .currency({id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | {location: Override('Custom Location'), amount: amount /*Use "ALL" to transfer everything*/} | {[{currencySelection, isFeeAsset?: true /* for example symbol: symbol or id: id, or Location: Location*/, amount: amount /*Use "ALL" to transfer everything*/}]})
         /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in same fee asset as selected currency.*/
-        .address(ADDRESS)
-        .senderAddress(address | PAPI_SIGNER)
+        .recipient(ADDRESS)
+        .sender(address | PAPI_SIGNER)
         .dryRunPreview(/*{ mintFeeAssets: true } - false by default - Mints fee assets also, if user does not have enough to cover fees on origin.*/)
 ```
 
@@ -261,13 +265,13 @@ const builder = Builder(/*chain api/builder_config/ws_url_string/ws_url_array -
       .from(TSubstrateChain) //Ensure, that origin chain is the same in all batched XCM Calls.
       .to(TChain2) //Any compatible Parachain
       .currency({currencySelection, amount}) //Currency to transfer - options as in scenarios above
-      .address(address | Location object)
+      .recipient(address | Location object)
       .addToBatch()
 
       .from(TSubstrateChain) //Ensure, that origin chain is the same in all batched XCM Calls.
       .to(TChain3) //Any compatible Parachain
       .currency({currencySelection, amount}) //Currency to transfer - options as in scenarios above
-      .address(address | Location object)
+      .recipient(address | Location object)
       .addToBatch()
       
 const tx = await builder.buildBatch({ 
@@ -287,7 +291,7 @@ const builder = Builder(/*chain api/builder_config/ws_url_string/ws_url_array -
       .claimfrom(TSubstrateChain)
       .currency({id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | [{currencySelection /*for example symbol: symbol or id: id, or location: location*/, amount: amount /*Use "ALL" to transfer everything*/}, {currencySelection}, ..]
 )
-      .address(address | Location object)
+      .recipient(address | Location object)
       /*.xcmVersion(Version.V3) Optional parameter, by default chain specific version. XCM Version ENUM if a different XCM version is needed (Supported V3 & V4 & V5). Requires importing Version enum.*/
 
 const tx = await builder.build()
@@ -312,11 +316,11 @@ const builder = await Builder({
   .from(TSubstrateChain)
   .to(TChain)
   .currency({id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | {location: Override('Custom Location'), amount: amount /*Use "ALL" to transfer everything*/} | [{currencySelection, isFeeAsset?: true /* for example symbol: symbol or id: id, or Location: Location*/, amount: amount /*Use "ALL" to transfer everything*/}])
-  .address(address) //You can also use prederived accounts - //Alice, //Bob... //Alith, //Balthathar...
-  .senderAddress(address | PAPI_SIGNER) //You can also use prederived accounts //Alice, //Bob... //Alith, //Balthathar...
+  .recipient(address) //You can also use prederived accounts - //Alice, //Bob... //Alith, //Balthathar...
+  .sender(address | PAPI_SIGNER) //You can also use prederived accounts //Alice, //Bob... //Alith, //Balthathar...
 
 const tx = await builder.build()
-//Or if you use prederived account as senderAddress:
+//Or if you use prederived account as sender:
 //await builder.signAndSubmit()
 
 //Disconnect API after TX
@@ -338,12 +342,12 @@ const fee = await Builder(/*chain api/builder_config/ws_url_string/ws_url_array
                 currencyTo: CURRENCY_SPEC, //Reffer to currency spec options above
                 // exchange: ['AssetHubPolkadotDex'], - Optional parameter - 'HydrationDex' | 'AcalaDex' | 'AssetHubPolkadotDex' | ...
                 // slippage: 1, - Optional - 1 by default
-                // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+                // evmsender: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
                 // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
                 // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
             })*/
-          .address(RECIPIENT_ADDRESS)
-          .senderAddress(address | PAPI_SIGNER)
+          .recipient(RECIPIENT_ADDRESS)
+          .sender(address | PAPI_SIGNER)
           .getXcmFee(/*{disableFallback: true / false}*/)  //Fallback is optional. When fallback is disabled, you only get notified of a DryRun error, but no Payment info query fallback is performed. Payment info is still performed if Origin or Destination chain do not support DryRun out of the box.
 ```
 
@@ -355,8 +359,8 @@ const fee = await Builder(/*chain api/builder_config/ws_url_string/ws_url_array
           .to(TChain)
           .currency(CURRENCY_SPEC)
           /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.*/
-          .address(RECIPIENT_ADDRESS)
-          .senderAddress(address | PAPI_SIGNER)
+          .recipient(RECIPIENT_ADDRESS)
+          .sender(address | PAPI_SIGNER)
           .getOriginXcmFee(/*{disableFallback: true / false}*/)  //Fallback is optional. When fallback is disabled, you only get notified of a DryRun error, but no Payment info query fallback is performed. Payment info is still performed if Origin do not support DryRun out of the box.
 ```
 
@@ -367,8 +371,8 @@ const info = await Builder(/*chain api/builder_config/ws_url_string/ws_url_array
           .to(TChain)
           .currency(CURRENCY_SPEC)
           /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.*/
-          .address(RECIPIENT_ADDRESS)
-          .senderAddress(address | PAPI_SIGNER)
+          .recipient(RECIPIENT_ADDRESS)
+          .sender(address | PAPI_SIGNER)
           .getTransferInfo()
 ```
 
@@ -383,12 +387,12 @@ const transferable = await Builder(/*chain api/builder_config/ws_url_string/ws_u
                 currencyTo: CURRENCY_SPEC, //Reffer to currency spec options above
                 // exchange: ['AssetHubPolkadotDex'], - Optional parameter - 'HydrationDex' | 'AcalaDex' | 'AssetHubPolkadotDex' | ...
                 // slippage: 1, - Optional - 1 by default
-                // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+                // evmsender: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
                 // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
                 // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
             })*/
-          .address(RECIPIENT_ADDRESS)
-          .senderAddress(address | PAPI_SIGNER)
+          .recipient(RECIPIENT_ADDRESS)
+          .sender(address | PAPI_SIGNER)
           .getTransferableAmount()
 ```
 
@@ -403,12 +407,12 @@ const transferable = await Builder(/*chain api/builder_config/ws_url_string/ws_u
                 currencyTo: CURRENCY_SPEC, //Reffer to currency spec options above
                 // exchange: ['AssetHubPolkadotDex'], - Optional parameter - 'HydrationDex' | 'AcalaDex' | 'AssetHubPolkadotDex' | ...
                 // slippage: 1, - Optional - 1 by default
-                // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+                // evmsender: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
                 // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
                 // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
             })*/
-          .address(RECIPIENT_ADDRESS)
-          .senderAddress(address | PAPI_SIGNER)
+          .recipient(RECIPIENT_ADDRESS)
+          .sender(address | PAPI_SIGNER)
           .getMinTransferableAmount()
 ```
 
@@ -419,8 +423,8 @@ const receivable = await Builder(/*chain api/builder_config/ws_url_string/ws_url
           .to(TChain)
           .currency(CURRENCY_SPEC)
           /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.*/
-          .address(RECIPIENT_ADDRESS)
-          .senderAddress(address | PAPI_SIGNER)
+          .recipient(RECIPIENT_ADDRESS)
+          .sender(address | PAPI_SIGNER)
           .getReceivableAmount()
 ```
 
@@ -431,8 +435,8 @@ const ed = await Builder(/*chain api/builder_config/ws_url_string/ws_url_array -
           .to(TChain)
           .currency(CURRENCY_SPEC)
           /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.*/
-          .address(RECIPIENT_ADDRESS)
-          .senderAddress(address | PAPI_SIGNER)
+          .recipient(RECIPIENT_ADDRESS)
+          .sender(address | PAPI_SIGNER)
           .verifyEdOnDestination()
 ```
 
@@ -443,13 +447,13 @@ const result = await Builder(/*chain api/builder_config/ws_url_string/ws_url_arr
       .from(TSubstrateChain) //'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/sdk/AssetPallet.html#import-chains-as-types
       .to(TChain) //'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/sdk/AssetPallet.html#import-chains-as-types
       .currency(CURRENCY_SPEC) 
-      .address(RECIPIENT_ADDRESS)
-      .senderAddress(SENDER_ADDRESS)
+      .recipient(RECIPIENT_ADDRESS)
+      .sender(SENDER_ADDRESS)
       .swap({
           currencyTo: CURRENCY_SPEC, 
           // exchange: ['AssetHubPolkadotDex'], - Optional parameter - 'HydrationDex' | 'AcalaDex' | 'AssetHubPolkadotDex' | ...
           // slippage: 1, - Optional - 1 by default
-          // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+          // evmsender: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
           // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
           // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
       })
@@ -487,11 +491,12 @@ import { convertSs58 } from "@paraspell/sdk";
 let result = convertSs58(ADDRESS, TChain) // returns converted address in string
 ```
 
-### Asset queries
+### Asset queries:
+
 For full documentation with output examples of asset queries, head over to [official documentation](https://paraspell.github.io/docs/sdk/AssetPallet.html).
 
 ```ts
-import { getSupportedDestinations, getFeeAssets, getAssetsObject, getAssetId, getRelayChainSymbol, getNativeAssets, getNativeAssets, getOtherAssets, getAllAssetsSymbols, hasSupportForAsset, getAssetDecimals, getParaId, getTChain, getAssetLocation, CHAINS, findAssetInfo, findAssetInfoOrThrow } from  '@paraspell/sdk'
+import { getSupportedDestinations, getFeeAssets, getAssetsObject, getRelayChainSymbol, getNativeAssets, getNativeAssets, getOtherAssets, getAllAssetsSymbols, getParaId, getTChain, getAssetLocation, CHAINS, findAssetInfo, findAssetInfoOrThrow } from  '@paraspell/sdk'
 
 //Get chains that support the specific asset related to origin
 getSupportedDestinations(TChain, CURRENCY)
@@ -514,9 +519,6 @@ getAssetLocation(TChain, { symbol: symbol } | { id: assetId })
 // Retrieve assets object from assets.json for a particular chain, including information about native and foreign assets
 getAssetsObject(TChain)
 
-// Retrieve foreign assetId for a particular chain and asset symbol
-getAssetId(TChain, ASSET_SYMBOL)
-
 // Retrieve the symbol of the relay chain for a particular chain. Either "DOT" or "KSM"
 getRelayChainSymbol(TChain)
 
@@ -529,12 +531,6 @@ getOtherAssets(TChain)
 // Retrieve string array of all asset symbols. (native and foreign assets are merged into a single array)
 getAllAssetsSymbols(TChain)
 
-// Check if a chain supports a particular asset. (Both native and foreign assets are searched). Returns boolean
-hasSupportForAsset(TChain, ASSET_SYMBOL)
-
-// Get decimals for specific asset
-getAssetDecimals(TChain, ASSET_SYMBOL)
-
 // Get specific chain id
 getParaId(TChain)
 
@@ -579,6 +575,8 @@ console.log(SUPPORTED_PALLETS)
 
 - Run end-to-end tests using `pnpm test:e2e`
 
+- Run swap end-to-end tests using `pnpm test:e2e:swap`
+
 - Run full end-to-end tests using `pnpm test:e2e:chopsticks`
 
 - Run all core tests and checks using `pnpm runAll`

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _paraspell_sdk_core from '@paraspell/sdk-core';
-import { TApiOrUrl, TEvmChainFrom, TSwapEvent as TSwapEvent$1, Foreign, ForeignAbstract, Native, Override, findAssetInfo, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getAssetsObject, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTChain, hasSupportForAsset, isChainEvm, TSubstrateChain, TEvmBuilderOptions, TChain, TCurrencyInputWithAmount, TBuilderOptions, GeneralBuilder as GeneralBuilder$1, TSendBaseOptions, TGetXcmFeeBaseOptions, TCreateBaseSwapXcmOptions } from '@paraspell/sdk-core';
+import { TApiOrUrl, TEvmChainFrom, TSwapEvent as TSwapEvent$1, Foreign, ForeignAbstract, Native, Override, findAssetInfo, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getAssetsObject, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTChain, hasSupportForAsset, isChainEvm, TSubstrateChain, TEvmBuilderOptions, TChain, TCurrencyInputWithAmount, TBuilderOptions, GeneralBuilder as GeneralBuilder$1, TTransferBaseOptions, TGetXcmFeeBaseOptions, TCreateBaseSwapXcmOptions } from '@paraspell/sdk-core';
 export * from '@paraspell/sdk-core';
 import * as polkadot_api from 'polkadot-api';
 import { PolkadotClient, UnsafeTransaction, PolkadotSigner } from 'polkadot-api';
@@ -22,20 +22,11 @@ declare const getBalance: (options: _paraspell_sdk_core.TGetBalanceCommonOptions
 } & {
     api?: TPapiApiOrUrl;
 }) => Promise<bigint>;
-/**
- * Claims assets from a parachain.
- *
- * @returns An extrinsic representing the claim transaction.
- */
-declare const claimAssets: (options: _paraspell_sdk_core.TAssetClaimOptionsBase & {
-    api?: TPapiApiOrUrl;
-}) => Promise<TPapiTransaction>;
 
 declare const assets_Foreign: typeof Foreign;
 declare const assets_ForeignAbstract: typeof ForeignAbstract;
 declare const assets_Native: typeof Native;
 declare const assets_Override: typeof Override;
-declare const assets_claimAssets: typeof claimAssets;
 declare const assets_findAssetInfo: typeof findAssetInfo;
 declare const assets_getAllAssetsSymbols: typeof getAllAssetsSymbols;
 declare const assets_getAssetDecimals: typeof getAssetDecimals;
@@ -58,7 +49,6 @@ declare namespace assets {
     assets_ForeignAbstract as ForeignAbstract,
     assets_Native as Native,
     assets_Override as Override,
-    assets_claimAssets as claimAssets,
     assets_findAssetInfo as findAssetInfo,
     assets_getAllAssetsSymbols as getAllAssetsSymbols,
     assets_getAssetDecimals as getAssetDecimals,
@@ -113,8 +103,8 @@ declare class EvmBuilderCore<TApi, TRes, TSigner, T extends Partial<TEvmBuilderO
      * @param address - The Polkadot address to receive the transfer.
      * @returns An instance of EvmBuilder
      */
-    address(address: string): EvmBuilderCore<TApi, TRes, TSigner, T & {
-        address: string;
+    recipient(address: string): EvmBuilderCore<TApi, TRes, TSigner, T & {
+        recipient: string;
     }>;
     /**
      * Sets the asset hub address. This is used for transfers that go through the Asset Hub.
@@ -149,7 +139,7 @@ declare class EvmBuilderCore<TApi, TRes, TSigner, T extends Partial<TEvmBuilderO
  * @returns A new Builder instance.
  */
 declare const Builder: (api?: TBuilderOptions<TPapiApiOrUrl>) => GeneralBuilder$1<PolkadotClient, TPapiTransaction, PolkadotSigner, object>;
-type GeneralBuilder<T extends Partial<TSendBaseOptions<TPapiApi, TPapiTransaction, TPapiSigner>> = object> = GeneralBuilder$1<PolkadotClient, TPapiTransaction, PolkadotSigner, T>;
+type GeneralBuilder<T extends Partial<TTransferBaseOptions<TPapiApi, TPapiTransaction, TPapiSigner>> = object> = GeneralBuilder$1<PolkadotClient, TPapiTransaction, PolkadotSigner, T>;
 declare const EvmBuilder: (api?: TBuilderOptions<TPapiApiOrUrl>) => EvmBuilderCore<unknown, unknown, unknown, {
     api: _paraspell_sdk_core.IPolkadotApi<PolkadotClient, TPapiTransaction, PolkadotSigner>;
 }>;
@@ -198,5 +188,5 @@ declare const createChainClient: (chain: TSubstrateChain, api?: TBuilderOptions<
 declare const checkAndConvertToNumberOrBigInt: (input: string) => number | bigint;
 declare const transform: (obj: any) => any;
 
-export { Builder, EvmBuilder, assets, checkAndConvertToNumberOrBigInt, claimAssets, convertSs58, createChainClient, dryRun, dryRunOrigin, getBalance, getBridgeStatus, getOriginXcmFee, getParaEthTransferFees, getXcmFee, handleSwapExecuteTransfer, transform, transfer as xcmPallet };
+export { Builder, EvmBuilder, assets, checkAndConvertToNumberOrBigInt, convertSs58, createChainClient, dryRun, dryRunOrigin, getBalance, getBridgeStatus, getOriginXcmFee, getParaEthTransferFees, getXcmFee, handleSwapExecuteTransfer, transform, transfer as xcmPallet };
 export type { GeneralBuilder, TEvmChainFromPapi, TPapiApi, TPapiApiOrUrl, TPapiSigner, TPapiTransaction, TSwapEvent };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { getNativeAssetSymbol, getOtherAssets, isSenderSigner, getEvmPrivateKeyHex, NumberFormatError, createClientCache, MAX_CLIENTS, EXTENSION_MS, createClientPoolHelpers, InvalidAddressError, BatchMode, isConfig, findNativeAssetInfoOrThrow, getChainProviders, DEFAULT_TTL_MS, resolveChainApi, isExternalChain, Parents, findAssetInfoOrThrow, hasXcmPaymentApiSupport, replaceBigInt, getAssetsObject, RuntimeApiUnavailableError, wrapTxBypass, localizeLocation, isAssetXcEqual, addXcmVersionHeader, RELAY_LOCATION, getRelayChainOf, isRelayChain, padValueBy, isAssetEqual, createChainClient as createChainClient$1, getBalance as getBalance$1, claimAssets as claimAssets$1, Foreign, ForeignAbstract, Native, Override, findAssetInfo, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getExistentialDeposit, getNativeAssets, getRelayChainSymbol, getSupportedAssets, getTChain, hasSupportForAsset, isChainEvm, convertSs58 as convertSs58$1, transferMoonbeamEvm, validateAddress, transferMoonbeamToEth, Builder as Builder$1, handleSwapExecuteTransfer as handleSwapExecuteTransfer$1, getBridgeStatus as getBridgeStatus$1, getParaEthTransferFees as getParaEthTransferFees$1, getXcmFee as getXcmFee$1, dryRun as dryRun$1, dryRunOrigin as dryRunOrigin$1, getOriginXcmFee as getOriginXcmFee$1 } from '@paraspell/sdk-core';
+import { getNativeAssetSymbol, getOtherAssets, isSenderSigner, getEvmPrivateKeyHex, NumberFormatError, createClientCache, MAX_CLIENTS, EXTENSION_MS, createClientPoolHelpers, InvalidAddressError, BatchMode, isConfig, findNativeAssetInfoOrThrow, getChainProviders, DEFAULT_TTL_MS, resolveChainApi, isExternalChain, Parents, findAssetInfoOrThrow, hasXcmPaymentApiSupport, replaceBigInt, getAssetsObject, RuntimeApiUnavailableError, wrapTxBypass, localizeLocation, isAssetXcEqual, addXcmVersionHeader, RELAY_LOCATION, getRelayChainOf, isRelayChain, padValueBy, isAssetEqual, SubmitTransactionError, createChainClient as createChainClient$1, getBalance as getBalance$1, Foreign, ForeignAbstract, Native, Override, findAssetInfo, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getExistentialDeposit, getNativeAssets, getRelayChainSymbol, getSupportedAssets, getTChain, hasSupportForAsset, isChainEvm, convertSs58 as convertSs58$1, transferMoonbeamEvm, validateAddress, transferMoonbeamToEth, Builder as Builder$1, handleSwapExecuteTransfer as handleSwapExecuteTransfer$1, getBridgeStatus as getBridgeStatus$1, getParaEthTransferFees as getParaEthTransferFees$1, getXcmFee as getXcmFee$1, dryRun as dryRun$1, dryRunOrigin as dryRunOrigin$1, getOriginXcmFee as getOriginXcmFee$1 } from '@paraspell/sdk-core';
 export * from '@paraspell/sdk-core';
 import { secp256k1 } from '@noble/curves/secp256k1.js';
 import { keccak_256 } from '@noble/hashes/sha3.js';
@@ -1044,13 +1044,13 @@ var PapiApi = /*#__PURE__*/function () {
         return _regenerator().w(function (_context9) {
           while (1) switch (_context9.n) {
             case 0:
-              api = new PapiApi();
+              api = new PapiApi(isConfig(this._config) ? this._config : undefined);
               _context9.n = 1;
               return api.init(chain);
             case 1:
               return _context9.a(2, api);
           }
-        }, _callee9);
+        }, _callee9, this);
       }));
       function createApiForChain(_x15) {
         return _createApiForChain.apply(this, arguments);
@@ -1099,7 +1099,7 @@ var PapiApi = /*#__PURE__*/function () {
                 isCustomAsset: true,
                 asset: findAssetInfoOrThrow(chain, {
                   id: assetId
-                }, null)
+                })
               });
           }
         }, _callee0, this);
@@ -1785,6 +1785,39 @@ var PapiApi = /*#__PURE__*/function () {
       }
       return signAndSubmit;
     }()
+  }, {
+    key: "signAndSubmitFinalized",
+    value: function () {
+      var _signAndSubmitFinalized = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee19(tx, sender) {
+        var signer;
+        return _regenerator().w(function (_context19) {
+          while (1) switch (_context19.n) {
+            case 0:
+              signer = isSenderSigner(sender) ? sender : createDevSigner(sender);
+              return _context19.a(2, new Promise(function (resolve, reject) {
+                tx.signSubmitAndWatch(signer).subscribe({
+                  next: function next(event) {
+                    if (event.type === 'finalized' || event.type === 'txBestBlocksState' && event.found) {
+                      if (!event.ok) {
+                        reject(new SubmitTransactionError(JSON.stringify(event.dispatchError.value)));
+                      } else {
+                        resolve(event.txHash);
+                      }
+                    }
+                  },
+                  error: function error(_error) {
+                    reject(_error instanceof Error ? _error : new SubmitTransactionError(String(_error)));
+                  }
+                });
+              }));
+          }
+        }, _callee19);
+      }));
+      function signAndSubmitFinalized(_x37, _x38) {
+        return _signAndSubmitFinalized.apply(this, arguments);
+      }
+      return signAndSubmitFinalized;
+    }()
   }]);
 }();
 
@@ -1825,12 +1858,6 @@ var findFailingEvent = function findFailingEvent(result) {
  * @returns The asset balance as a bigint.
  */
 var getBalance = createPapiApiCall(getBalance$1);
-/**
- * Claims assets from a parachain.
- *
- * @returns An extrinsic representing the claim transaction.
- */
-var claimAssets = createPapiApiCall(claimAssets$1);
 
 var assets = /*#__PURE__*/Object.freeze({
   __proto__: null,
@@ -1838,7 +1865,6 @@ var assets = /*#__PURE__*/Object.freeze({
   ForeignAbstract: ForeignAbstract,
   Native: Native,
   Override: Override,
-  claimAssets: claimAssets,
   findAssetInfo: findAssetInfo,
   getAllAssetsSymbols: getAllAssetsSymbols,
   getAssetDecimals: getAssetDecimals,
@@ -1910,10 +1936,10 @@ var EvmBuilderCore = /*#__PURE__*/function () {
      * @returns An instance of EvmBuilder
      */
   }, {
-    key: "address",
-    value: function address(_address) {
+    key: "recipient",
+    value: function recipient(address) {
       return new EvmBuilderCore(_objectSpread2(_objectSpread2({}, this._options), {}, {
-        address: _address
+        recipient: address
       }));
     }
     /**
@@ -1951,12 +1977,12 @@ var EvmBuilderCore = /*#__PURE__*/function () {
     key: "build",
     value: (function () {
       var _build = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
-        var _this$_options, from, to, address, api;
+        var _this$_options, from, to, recipient, api;
         return _regenerator().w(function (_context) {
           while (1) switch (_context.n) {
             case 0:
-              _this$_options = this._options, from = _this$_options.from, to = _this$_options.to, address = _this$_options.address, api = _this$_options.api;
-              validateAddress(api, address, to);
+              _this$_options = this._options, from = _this$_options.from, to = _this$_options.to, recipient = _this$_options.recipient, api = _this$_options.api;
+              validateAddress(api, recipient, to);
               if (!(from === 'Moonbeam' && to === 'Ethereum')) {
                 _context.n = 1;
                 break;
@@ -2075,4 +2101,4 @@ var transfer = /*#__PURE__*/Object.freeze({
   handleSwapExecuteTransfer: handleSwapExecuteTransfer
 });
 
-export { Builder, EvmBuilder, assets, checkAndConvertToNumberOrBigInt, claimAssets, convertSs58, createChainClient, dryRun, dryRunOrigin, getBalance, getBridgeStatus, getOriginXcmFee, getParaEthTransferFees, getXcmFee, handleSwapExecuteTransfer, _transform as transform, transfer as xcmPallet };
+export { Builder, EvmBuilder, assets, checkAndConvertToNumberOrBigInt, convertSs58, createChainClient, dryRun, dryRunOrigin, getBalance, getBridgeStatus, getOriginXcmFee, getParaEthTransferFees, getXcmFee, handleSwapExecuteTransfer, _transform as transform, transfer as xcmPallet };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paraspell/sdk",
-  "version": "12.9.7",
+  "version": "12.10.0-rc.0",
   "description": "SDK for ParaSpell XCM/XCMP tool for developers",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "@polkadot-labs/hdkd": "^0.0.27",
     "@polkadot-labs/hdkd-helpers": "^0.0.28",
     "viem": "2.47.1",
-    "@paraspell/sdk-core": "12.9.7"
+    "@paraspell/sdk-core": "12.10.0-rc.0"
   },
   "peerDependencies": {
     "polkadot-api": ">= 1.23.3 < 2"
@@ -63,6 +63,7 @@
     "test:watch": "vitest",
     "runAll": "pnpm compile && pnpm format:write && pnpm lint && pnpm test",
     "test:e2e": "vitest run --config ./vitest.config.e2e.ts --sequence.concurrent",
-    "test:e2e:chopsticks": "vitest run --config ./vitest.config.chopsticks.e2e.ts"
+    "test:e2e:chopsticks": "vitest run --config ./vitest.config.chopsticks.e2e.ts",
+    "test:e2e:swap": "vitest run --config ./vitest.config.swap.e2e.ts --sequence.concurrent"
   }
 }