@paraspell/sdk-pjs 13.2.2 → 13.4.0

package/README.md

@@ -14,7 +14,7 @@
       <img alt="build" src="https://github.com/paraspell/xcm-tools/actions/workflows/ci.yml/badge.svg" />
     </a>
   </p>
-  <p>Supporting every XCM Active Parachain <a href = "https://paraspell.github.io/docs/supported.html"\>[list]</p>
+  <p>Supporting every XCM Active Parachain <a href = "https://paraspell.github.io/docs/supported-chains.html"\>[list]</p>
   <p>SDK documentation <a href = "https://paraspell.github.io/docs/" \>[here]</p>
 </div>
 
@@ -41,9 +41,9 @@ npm install | pnpm add | yarn add @polkadot/api @polkadot/types @polkadot/api-ba
 npm install | pnpm add | yarn add @paraspell/sdk-pjs
 ```
 
-### Install Swap extension
+### (OPTIONAL) 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. Now available in all JS client versions of SDK.
+If you plan to [do Swap XCMs](https://paraspell.github.io/docs/xcm-sdk/send-xcm.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. 
@@ -54,7 +54,7 @@ If you plan to [do Swap XCMs](https://paraspell.github.io/docs/sdk/xcmPallet.htm
 npm install | pnpm add | yarn add @paraspell/swap @galacticcouncil/api-augment
 ```
 
-### Setup Swap extension
+#### Setup Swap extension
 
 Add the `@paraspell/swap` import to your application's root component (Usually `App.tsx`). This ensures the extension is registered before using Builder.
 
@@ -67,6 +67,46 @@ export default function App() {
 }
 ```
 
+### (OPTIONAL) Install EVM extension
+If you plan to [do EVM contract transfers](https://paraspell.github.io/docs/xcm-sdk/send-xcm.html#moonbeam-xtokens-smart-contract) you can install EVM package which allows you to interact with EVM contract based XCMs on Moonbeam, Moonriver and Darwinia. Available in **ALL** versions of SDK.
+
+```bash
+npm install | pnpm add | yarn add @paraspell/evm
+```
+
+#### Setup EVM extension
+
+Add the `@paraspell/evm` import to your application's root component (Usually `App.tsx`). This ensures the extension is registered before using Builder.
+
+```ts
+// Import EVM extension here
+import '@paraspell/evm';
+
+export default function App() {
+  return {/* Your app here */};
+}
+```
+
+### (OPTIONAL) Install Snowbridge extension
+If you plan to [do Snowbridge transfers from Ethereum](https://paraspell.github.io/docs/xcm-sdk/send-xcm.html#ethereum-polkadot-transfer) you can install Snowbridge package which allows you to input "Ethereum" as from chain parameter. Available in **ALL** versions of SDK.
+
+```bash
+npm install | pnpm add | yarn add @paraspell/evm-snowbridge
+```
+
+#### Setup Snowbridge extension
+
+Add the `@paraspell/evm-snowbridge` import to your application's root component (Usually `App.tsx`). This ensures the extension is registered before using Builder.
+
+```ts
+// Import Snowbridge extension here
+import '@paraspell/evm-snowbridge';
+
+export default function App() {
+  return {/* Your app here */};
+}
+```
+
 ### Importing SDK functionality
 
 Named import:
@@ -84,18 +124,15 @@ import * as paraspell from '@paraspell/sdk-pjs'
 ## 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:**
 > - 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!
+> - Swap extension is now available on every XCM SDK version: https://paraspell.github.io/docs/xcm-sdk/getting-started.html#install-swap-extension
+> - EVM extension is now available: https://paraspell.github.io/docs/xcm-sdk/getting-started.html#install-evm-extension
+> - Snowbridge extension is now available: https://paraspell.github.io/docs/xcm-sdk/getting-started.html#install-snowbridge-extension
 
 
 ### Sending XCM
-For full documentation on XCM Transfers head over to [official documentation](https://paraspell.github.io/docs/sdk/xcmPallet.html).
+For full documentation on XCM Transfers head over to [official documentation](https://paraspell.github.io/docs/xcm-sdk/send-xcm.html).
 
 #### Transfer assets from Substrate to Substrate
 
@@ -174,7 +211,7 @@ await builder.disconnect()
 
 ```ts
 const builder = Builder(/*client | builder_config | ws_url | [ws_url, ws_url,..] - Optional*/)
-      .from(TSubstrateChain) // 'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/sdk/AssetPallet.html#import-chains-as-types
+      .from(TSubstrateChain) // 'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types
       .to(TChain) // Has to be same as origin (from)
       .currency(CURRENCY_SPEC) // Refer to currency spec options below
       .sender(sender | PAPI SIGNER)
@@ -193,8 +230,8 @@ await builder.disconnect()
 
 ```ts
 const builder = Builder(/*client | builder_config |ws_url | [ws_url, ws_url,..] - Optional*/)
-      .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
+      .from(TSubstrateChain) // 'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/xcm-sdk/asset-package.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/xcm-sdk/asset-package.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*/})
       .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.
@@ -308,7 +345,7 @@ await builder.disconnect()
 
 ### XCM Fee queries
 
-For full documentation with output examples of XCM Fee queries, head to [official documentation](https://paraspell.github.io/docs/sdk/xcmUtils.html).
+For full documentation with output examples of XCM Fee queries, head to [official documentation](https://paraspell.github.io/docs/xcm-sdk/xcm-utils.html).
 
 #### XCM Fee (Origin and Dest.)
 
@@ -424,8 +461,8 @@ const ed = await Builder(/*chain api/builder_config/ws_url_string/ws_url_array -
 
 ```ts
 const result = await Builder(/*chain api/builder_config/ws_url_string/ws_url_array - optional*/)
-      .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
+      .from(TSubstrateChain) //'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types
+      .to(TChain) //'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types
       .currency(CURRENCY_SPEC) 
       .recipient(RECIPIENT_ADDRESS)
       .sender(SENDER_ADDRESS)
@@ -473,7 +510,7 @@ let result = convertSs58(ADDRESS, TChain) // returns converted address in string
 
 ### Asset queries:
 
-For full documentation with output examples of asset queries, head over to [official documentation](https://paraspell.github.io/docs/sdk/AssetPallet.html).
+For full documentation with output examples of asset queries, head over to [official documentation](https://paraspell.github.io/docs/xcm-sdk/asset-package.html).
 
 ```ts
 import { getSupportedDestinations, getFeeAssets, getAssetsObject, getRelayChainSymbol, getNativeAssets, getNativeAssets, getOtherAssets, getAllAssetsSymbols, getParaId, getTChain, getAssetLocation, CHAINS, findAssetInfo, findAssetInfoOrThrow } from  '@paraspell/sdk-pjs'
@@ -523,7 +560,7 @@ CHAINS
 
 ### Parachain XCM Pallet queries
 
-For full documentation with output examples of pallet queries, head over to [official documentation](https://paraspell.github.io/docs/sdk/NodePallets.html).
+For full documentation with output examples of pallet queries, head over to [official documentation](https://paraspell.github.io/docs/xcm-sdk/pallet-package.html).
 
 ```ts
 import { getDefaultPallet, getSupportedPallets, getPalletIndex, getNativeAssetsPallet, getOtherAssetsPallets, SUPPORTED_PALLETS } from  '@paraspell/sdk-pjs';
@@ -609,7 +646,7 @@ console.log(CHAINS)
 
 ## Contribute to XCM Tools and earn rewards 💰
 
-We run an open Bug Bounty Program that rewards contributors for reporting and fixing bugs in the project. More information on bug bounty can be found in the [official documentation](https://paraspell.github.io/docs/contribution.html).
+We run an open Bug Bounty Program that rewards contributors for reporting and fixing bugs in the project. More information on bug bounty can be found in the [official documentation](https://paraspell.github.io/docs/contribution-guidelines.html).
 
 ## Get Support 🚑
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _paraspell_sdk_core from '@paraspell/sdk-core';
-import { WithApi, TEvmChainFrom, TChain, TCurrencyInputWithAmount, Foreign, ForeignAbstract, Native, Override, findAssetInfo, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getAssetsObject, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTChain, hasSupportForAsset, isChainEvm, TSubstrateChain, TBuilderOptions, TApiOrUrl, GeneralBuilder as GeneralBuilder$1, TTransferBaseOptions } from '@paraspell/sdk-core';
+import { WithApi, TChain, TCurrencyInputWithAmount, Foreign, ForeignAbstract, Native, Override, findAssetInfo, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getAssetsObject, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTChain, hasSupportForAsset, isChainEvm, TSubstrateChain, TBuilderOptions, TApiOrUrl, GeneralBuilder as GeneralBuilder$1, TTransferBaseOptions } from '@paraspell/sdk-core';
 export * from '@paraspell/sdk-core';
 import * as _polkadot_api from '@polkadot/api';
 import { ApiPromise } from '@polkadot/api';
@@ -7,7 +7,7 @@ import { SubmittableExtrinsic, Signer } from '@polkadot/api/types';
 import * as ethers from 'ethers';
 import { Signer as Signer$1, AbstractProvider } from 'ethers';
 import { WalletClient } from 'viem';
-import { toPolkadotV2 } from '@snowbridge/api';
+import * as _snowbridge_api_dist_transfers_toPolkadot_transferInterface from '@snowbridge/api/dist/transfers/toPolkadot/transferInterface';
 
 type TPjsApi = ApiPromise;
 type Extrinsic = SubmittableExtrinsic<'promise'>;
@@ -15,6 +15,7 @@ type TPjsSigner = {
     signer: Signer;
     address: string;
 };
+type TEvmChainFrom = Extract<TChain, 'Ethereum' | 'Moonbeam' | 'Moonriver' | 'Darwinia'>;
 type TEvmBuilderOptionsBase = {
     /**
      * The source chain. Can be either 'Ethereum', 'Moonbeam', 'Moonriver', or 'Darwinia'.
@@ -105,6 +106,8 @@ declare const convertSs58: (address: string, chain: TSubstrateChain) => string;
 
 /**
  * Builder class for constructing transfers from Ethereum to Polkadot.
+ *
+ * @deprecated EvmBuilder is deprecated. Please use the Builder class instead.
  */
 declare class EvmBuilderCore<TApi, TRes, TSigner, T extends Partial<TPjsEvmBuilderOptions<TApi, TRes, TSigner>> = object> {
     protected readonly _options: T;
@@ -173,6 +176,7 @@ declare class EvmBuilderCore<TApi, TRes, TSigner, T extends Partial<TPjsEvmBuild
  */
 declare const Builder: (api?: TBuilderOptions<TApiOrUrl<TPjsApi>>) => GeneralBuilder$1<_polkadot_api.ApiPromise, Extrinsic, TPjsSigner, object>;
 type GeneralBuilder<T extends Partial<TTransferBaseOptions<TPjsApi, Extrinsic, TPjsSigner>> = object> = GeneralBuilder$1<TPjsApi, Extrinsic, TPjsSigner, T>;
+/** @deprecated EvmBuilder is deprecated. Please use the Builder class instead. */
 declare const EvmBuilder: (provider?: AbstractProvider, api?: TBuilderOptions<TApiOrUrl<TPjsApi>>) => EvmBuilderCore<unknown, unknown, unknown, {
     api: _paraspell_sdk_core.PolkadotApi<_polkadot_api.ApiPromise, Extrinsic, TPjsSigner>;
     provider: AbstractProvider | undefined;
@@ -200,7 +204,7 @@ declare const depositToken: (signer: Signer$1, amount: bigint, symbol: string) =
  */
 declare const transferEthToPolkadot$1: <TApi, TRes, TSigner>({ api, provider, signer, recipient, to, currency }: TPjsEvmBuilderOptions<TApi, TRes, TSigner>) => Promise<{
     response: ethers.TransactionResponse;
-    messageReceipt: toPolkadotV2.MessageReceipt;
+    messageReceipt: _snowbridge_api_dist_transfers_toPolkadot_transferInterface.MessageReceipt;
 }>;
 
 declare const getTokenBalance: (signer: Signer$1, symbol: string) => Promise<bigint>;
@@ -242,4 +246,4 @@ declare namespace transfer {
 declare const createChainClient: (chain: TSubstrateChain, builderOptions?: TBuilderOptions<TApiOrUrl<TPjsApi>>) => Promise<_polkadot_api.ApiPromise>;
 
 export { Builder, EvmBuilder, approveToken, assets, convertSs58, createChainClient, depositToken, dryRun, dryRunOrigin, getBalance, getBridgeStatus, getParaEthTransferFees, getTokenBalance, transferEthToPolkadot, transfer as xcmPallet };
-export type { Extrinsic, GeneralBuilder, TPjsApi, TPjsEvmBuilderOptions, TPjsSigner };
+export type { Extrinsic, GeneralBuilder, TEvmChainFrom, TPjsApi, TPjsEvmBuilderOptions, TPjsSigner };