@paraspell/sdk 5.0.0 → 5.1.0

package/dist/index.d.ts

@@ -1,6 +1,85 @@
 import { ApiPromise } from '@polkadot/api';
 import { SubmittableExtrinsic } from '@polkadot/api/types';
 
+type NetworkId = string | null;
+type BodyId = string | null;
+type BodyPart = string | null;
+type StringOrNumber = string | number;
+type HexString = string;
+interface JunctionParachain {
+    Parachain: StringOrNumber;
+}
+interface JunctionAccountId32 {
+    AccountId32: {
+        network: NetworkId;
+        id: HexString;
+    };
+}
+interface JunctionAccountIndex64 {
+    AccountIndex64: {
+        network: NetworkId;
+        index: StringOrNumber;
+    };
+}
+interface JunctionAccountKey20 {
+    AccountKey20: {
+        network: NetworkId;
+        key: HexString;
+    };
+}
+interface JunctionPalletInstance {
+    PalletInstance: StringOrNumber;
+}
+interface JunctionGeneralIndex {
+    GeneralIndex: StringOrNumber;
+}
+interface JunctionGeneralKey {
+    GeneralKey: {
+        length: StringOrNumber;
+        data: HexString;
+    };
+}
+interface JunctionOnlyChild {
+    OnlyChild: string;
+}
+interface JunctionPlurality {
+    Plurality: {
+        id: BodyId;
+        part: BodyPart;
+    };
+}
+interface JunctionGlobalConsensus {
+    GlobalConsensus: NetworkId;
+}
+type Junction = JunctionParachain | JunctionAccountId32 | JunctionAccountIndex64 | JunctionAccountKey20 | JunctionPalletInstance | JunctionGeneralIndex | JunctionGeneralKey | JunctionOnlyChild | JunctionPlurality | JunctionGlobalConsensus;
+interface Junctions {
+    X1?: Junction;
+    X2?: [Junction, Junction];
+    X3?: [Junction, Junction, Junction];
+    X4?: [Junction, Junction, Junction, Junction];
+    X5?: [Junction, Junction, Junction, Junction, Junction];
+    X6?: [Junction, Junction, Junction, Junction, Junction, Junction];
+    X7?: [Junction, Junction, Junction, Junction, Junction, Junction, Junction];
+    X8?: [Junction, Junction, Junction, Junction, Junction, Junction, Junction, Junction];
+    X9?: [Junction, Junction, Junction, Junction, Junction, Junction, Junction, Junction, Junction];
+    X10?: [
+        Junction,
+        Junction,
+        Junction,
+        Junction,
+        Junction,
+        Junction,
+        Junction,
+        Junction,
+        Junction,
+        Junction
+    ];
+}
+interface TMultiLocation {
+    parents: StringOrNumber;
+    interior: Junctions;
+}
+
 declare abstract class ParachainNode {
     private readonly _node;
     private readonly _name;
@@ -17,8 +96,8 @@ declare abstract class ParachainNode {
     transferRelayToPara(options: TRelayToParaInternalOptions): TSerializedApiCall;
     getProvider(): string;
     createApiInstance(): Promise<ApiPromise>;
-    createCurrencySpec(amount: string, scenario: TScenario, version: Version, currencyId?: string): any;
-    createPolkadotXcmHeader(scenario: TScenario, paraId?: number): any;
+    createCurrencySpec(amount: string, scenario: TScenario, version: Version, currencyId?: string, overridedMultiLocation?: TMultiLocation): any;
+    createPolkadotXcmHeader(scenario: TScenario, destination?: TDestination, paraId?: number): any;
 }
 
 declare const NODE_NAMES: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "Centrifuge", "ComposableFinance", "Darwinia", "HydraDX", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Mangata", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Unique", "Crust", "Manta", "Nodle", "NeuroWeb", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Subsocial"];
@@ -72,8 +151,9 @@ interface XTokensTransferInput {
     fees: number;
     scenario: TScenario;
     origin: TNode;
-    destination?: TNode;
+    destination?: TDestination;
     paraIdTo?: number;
+    overridedCurrencyMultiLocation?: TMultiLocation;
     serializedApiCallEnabled?: boolean;
 }
 interface XTransferTransferInput {
@@ -81,10 +161,11 @@ interface XTransferTransferInput {
     currency: string | undefined;
     currencyID: string | undefined;
     amount: string;
-    recipientAddress: string;
+    recipientAddress: TAddress;
     origin: TNode;
     paraId?: number;
-    destination?: TNode;
+    destination?: TDestination;
+    overridedCurrencyMultiLocation?: TMultiLocation;
     serializedApiCallEnabled?: boolean;
 }
 interface IXTokensTransfer {
@@ -103,16 +184,19 @@ interface PolkadotXCMTransferInput {
     serializedApiCallEnabled?: boolean;
 }
 type TAmount = string | number | bigint;
+type TCurrency = string | number | bigint | TMultiLocation;
+type TAddress = string | TMultiLocation;
+type TDestination = TNode | TMultiLocation;
 interface TSendBaseOptions {
-    address: string;
-    destination?: TNode;
+    address: TAddress;
+    destination?: TDestination;
     paraIdTo?: number;
     destApiForKeepAlive?: ApiPromise;
 }
 interface TSendOptions extends TSendBaseOptions {
     api?: ApiPromise;
     origin: TNode;
-    currency: string | number | bigint;
+    currency: TCurrency;
     amount: TAmount;
 }
 interface TSendOptionsCommon extends TSendOptions {
@@ -123,11 +207,12 @@ interface TSendInternalOptions extends TSendBaseOptions {
     currencySymbol: string | undefined;
     currencyId: string | undefined;
     amount: string;
+    overridedCurrencyMultiLocation?: TMultiLocation;
     serializedApiCallEnabled?: boolean;
 }
 interface TRelayToParaBaseOptions {
-    destination: TNode;
-    address: string;
+    destination: TDestination;
+    address: TAddress;
     paraIdTo?: number;
     destApiForKeepAlive?: ApiPromise;
 }
@@ -268,23 +353,23 @@ declare class ToGeneralBuilder {
     private readonly from;
     private readonly to;
     private readonly paraIdTo?;
-    constructor(api: ApiPromise | undefined, from: TNode, to: TNode, paraIdTo?: number);
-    currency(currency: string | number | bigint): AmountBuilder;
+    constructor(api: ApiPromise | undefined, from: TNode, to: TDestination, paraIdTo?: number);
+    currency(currency: TCurrency): AmountBuilder;
     openChannel(): MaxSizeOpenChannelBuilder;
 }
 declare class FromGeneralBuilder {
     private readonly api?;
     private readonly from;
     constructor(api: ApiPromise | undefined, from: TNode);
-    to(node: TNode, paraIdTo?: number): ToGeneralBuilder;
-    amount(amount: string | number | bigint): AddressBuilder;
+    to(node: TDestination, paraIdTo?: number): ToGeneralBuilder;
+    amount(amount: TAmount): AddressBuilder;
     closeChannel(): InboundCloseChannelBuilder;
 }
 declare class GeneralBuilder {
     private readonly api?;
     constructor(api?: ApiPromise);
     from(node: TNode): FromGeneralBuilder;
-    to(node: TNode, paraIdTo?: number): AmountBuilder;
+    to(node: TDestination, paraIdTo?: number): AmountBuilder;
 }
 declare const Builder: (api?: ApiPromise) => GeneralBuilder;
 interface FinalBuilder {
@@ -297,10 +382,10 @@ interface UseKeepAliveFinalBuilder {
     buildSerializedApiCall: () => Promise<TSerializedApiCall>;
 }
 interface AddressBuilder {
-    address: (address: string) => UseKeepAliveFinalBuilder;
+    address: (address: TAddress) => UseKeepAliveFinalBuilder;
 }
 interface AmountBuilder {
-    amount: (amount: string | number | bigint) => AddressBuilder;
+    amount: (amount: TAmount) => AddressBuilder;
 }
 
 declare const getNode: (node: TNode) => ParachainNode;
@@ -331,4 +416,4 @@ declare class IncompatibleNodesError extends Error {
 
 declare const getExistentialDeposit: (node: TNodeWithRelayChains) => string | null;
 
-export { Builder, type CheckKeepAliveOptions, type Extrinsic, type ExtrinsicFunction, type IPolkadotXCMTransfer, type IXTokensTransfer, type IXTransferTransfer, IncompatibleNodesError, InvalidCurrencyError, NODES_WITH_RELAY_CHAINS, NODE_NAMES, NoXCMSupportImplementedError, NodeNotSupportedError, Parents, type PolkadotXCMHeader, type PolkadotXCMTransferInput, SUPPORTED_PALLETS, ScenarioNotSupportedError, type TAmount, type TAssetDetails, type TAssetJsonMap, type TCloseChannelInternalOptions, type TCloseChannelOptions, type TEdJsonMap, type TNativeAssetDetails, type TNode, type TNodeAssets, type TNodeWithRelayChains, type TOpenChannelInternalOptions, type TOpenChannelOptions, type TPallet, type TPalletJsonMap, type TPalletMap, type TRelayChainSymbol, type TRelayChainType, type TRelayToParaCommonOptions, type TRelayToParaInternalOptions, type TRelayToParaOptions, type TScenario, type TSendBaseOptions, type TSendInternalOptions, type TSendOptions, type TSendOptionsCommon, type TSerializedApiCall, type UpdateFunction, Version, type XTokensTransferInput, type XTransferTransferInput, index as assets, index$1 as closeChannels, createApiInstanceForNode, getAllAssetsSymbols, getAllNodeProviders, getAssetDecimals, getAssetId, getAssetsObject, getDefaultPallet, getExistentialDeposit, getNativeAssets, getNode, getNodeEndpointOption, getNodeProvider, getOtherAssets, getParaId, getRelayChainSymbol, getSupportedPallets, getTNode, hasSupportForAsset, index$2 as openChannels, index$3 as xcmPallet };
+export { Builder, type CheckKeepAliveOptions, type Extrinsic, type ExtrinsicFunction, type IPolkadotXCMTransfer, type IXTokensTransfer, type IXTransferTransfer, IncompatibleNodesError, InvalidCurrencyError, NODES_WITH_RELAY_CHAINS, NODE_NAMES, NoXCMSupportImplementedError, NodeNotSupportedError, Parents, type PolkadotXCMHeader, type PolkadotXCMTransferInput, SUPPORTED_PALLETS, ScenarioNotSupportedError, type TAddress, type TAmount, type TAssetDetails, type TAssetJsonMap, type TCloseChannelInternalOptions, type TCloseChannelOptions, type TCurrency, type TDestination, type TEdJsonMap, type TNativeAssetDetails, type TNode, type TNodeAssets, type TNodeWithRelayChains, type TOpenChannelInternalOptions, type TOpenChannelOptions, type TPallet, type TPalletJsonMap, type TPalletMap, type TRelayChainSymbol, type TRelayChainType, type TRelayToParaCommonOptions, type TRelayToParaInternalOptions, type TRelayToParaOptions, type TScenario, type TSendBaseOptions, type TSendInternalOptions, type TSendOptions, type TSendOptionsCommon, type TSerializedApiCall, type UpdateFunction, Version, type XTokensTransferInput, type XTransferTransferInput, index as assets, index$1 as closeChannels, createApiInstanceForNode, getAllAssetsSymbols, getAllNodeProviders, getAssetDecimals, getAssetId, getAssetsObject, getDefaultPallet, getExistentialDeposit, getNativeAssets, getNode, getNodeEndpointOption, getNodeProvider, getOtherAssets, getParaId, getRelayChainSymbol, getSupportedPallets, getTNode, hasSupportForAsset, index$2 as openChannels, index$3 as xcmPallet };