@paraspell/assets 8.9.0

package/dist/index.d.ts

@@ -0,0 +1,262 @@
+import { TRelayChainSymbol, TMultiLocation, TNodeWithRelayChains } from '@paraspell/sdk-common';
+
+type AtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];
+type TBaseAsset = {
+    symbol: string;
+    decimals?: number;
+    manuallyAdded?: boolean;
+    alias?: string;
+    existentialDeposit?: string;
+};
+type TNativeAsset = TBaseAsset & {
+    isNative: true;
+    multiLocation?: TMultiLocation;
+};
+type TForeignAsset = TBaseAsset & AtLeastOne<{
+    assetId?: string;
+    multiLocation?: TMultiLocation;
+}>;
+type TAsset = TNativeAsset | TForeignAsset;
+type TNodeAssets = {
+    relayChainAssetSymbol: TRelayChainSymbol;
+    nativeAssetSymbol: string;
+    isEVM: boolean;
+    supportsDryRunApi: boolean;
+    nativeAssets: TNativeAsset[];
+    otherAssets: TForeignAsset[];
+};
+type TAssetJsonMap = Record<TNodeWithRelayChains, TNodeAssets>;
+
+type TMultiAsset = TMultiAssetV3 | TMultiAssetV4;
+interface TMultiAssetV3 {
+    id: {
+        Concrete: TMultiLocation;
+    };
+    fun: {
+        Fungible: TAmount;
+    };
+}
+interface TMultiAssetV4 {
+    id: TMultiLocation;
+    fun: {
+        Fungible: TAmount;
+    };
+}
+
+type TAmount = string | number | bigint;
+type TCurrency = string | number | bigint;
+type TSymbolSpecifier = {
+    type: 'Native' | 'Foreign' | 'ForeignAbstract';
+    value: string;
+};
+type TOverrideMultiLocationSpecifier = {
+    type: 'Override';
+    value: TMultiLocation;
+};
+type TCurrencySymbolValue = string | TSymbolSpecifier;
+type TCurrencySymbol = {
+    symbol: TCurrencySymbolValue;
+};
+type TCurrencyCore = TCurrencySymbol | {
+    id: TCurrency;
+} | {
+    multilocation: TMultiLocationValue;
+};
+type TMultiAssetWithFee = TMultiAsset & {
+    isFeeAsset?: boolean;
+};
+type TMultiLocationValue = string | TMultiLocation;
+type TMultiLocationValueWithOverride = TMultiLocationValue | TOverrideMultiLocationSpecifier;
+type TCurrencyInputWithAmount = WithAmount<TCurrencySymbol | {
+    id: TCurrency;
+} | {
+    multilocation: TMultiLocationValueWithOverride;
+}> | {
+    multiasset: TMultiAsset[] | WithAmount<TCurrencyCore>[];
+};
+type TCurrencyInput = TCurrencySymbol | {
+    id: TCurrency;
+} | {
+    multilocation: TMultiLocationValueWithOverride;
+} | {
+    multiasset: TMultiAsset[] | WithAmount<TCurrencyCore>[];
+};
+type WithAmount<TBase> = TBase & {
+    amount: TAmount;
+};
+
+/**
+ * Retrieves the existential deposit value for a given node.
+ *
+ * @param node - The node for which to get the existential deposit.
+ * @returns The existential deposit as a string if available; otherwise, null.
+ */
+declare const getExistentialDeposit: (node: TNodeWithRelayChains, currency?: TCurrencyCore) => string | null;
+
+/**
+ * Retrieves the assets object for a given node containing the native and foreign assets.
+ *
+ * @param node - The node for which to retrieve the assets object.
+ * @returns The assets object associated with the given node.
+ */
+declare const getAssetsObject: (node: TNodeWithRelayChains) => TNodeAssets;
+declare const isNodeEvm: (node: TNodeWithRelayChains) => boolean;
+/**
+ * Retrieves the asset ID for a given symbol on a specified node.
+ *
+ * @param node - The node to search for the asset.
+ * @param symbol - The symbol of the asset.
+ * @returns The asset ID if found; otherwise, null.
+ */
+declare const getAssetId: (node: TNodeWithRelayChains, symbol: string) => string | null;
+/**
+ * Retrieves the relay chain asset symbol for a specified node.
+ *
+ * @param node - The node for which to get the relay chain symbol.
+ * @returns The relay chain asset symbol.
+ */
+declare const getRelayChainSymbol: (node: TNodeWithRelayChains) => TRelayChainSymbol;
+/**
+ * Retrieves the list of native assets for a specified node.
+ *
+ * @param node - The node for which to get native assets.
+ * @returns An array of native asset details.
+ */
+declare const getNativeAssets: (node: TNodeWithRelayChains) => TNativeAsset[];
+/**
+ * Retrieves the list of other (non-native) assets for a specified node.
+ *
+ * @param node - The node for which to get other assets.
+ * @returns An array of other asset details.
+ */
+declare const getOtherAssets: (node: TNodeWithRelayChains) => TForeignAsset[];
+/**
+ * Retrieves the complete list of assets for a specified node, including relay chain asset, native, and other assets.
+ *
+ * @param node - The node for which to get the assets.
+ * @returns An array of objects of all assets associated with the node.
+ */
+declare const getAssets: (node: TNodeWithRelayChains) => TAsset[];
+/**
+ * Retrieves the symbols of all assets (relay chain, native, and other assets) for a specified node.
+ *
+ * @param node - The node for which to get asset symbols.
+ * @returns An array of asset symbols.
+ */
+declare const getAllAssetsSymbols: (node: TNodeWithRelayChains) => string[];
+/**
+ * Retrieves the symbol of the native asset for a specified node.
+ *
+ * @param node - The node for which to get the native asset symbol.
+ * @returns The symbol of the native asset.
+ */
+declare const getNativeAssetSymbol: (node: TNodeWithRelayChains) => string;
+/**
+ * Determines whether a specified node supports an asset with the given symbol.
+ *
+ * @param node - The node to check for asset support.
+ * @param symbol - The symbol of the asset to check.
+ * @returns True if the asset is supported; otherwise, false.
+ */
+declare const hasSupportForAsset: (node: TNodeWithRelayChains, symbol: string) => boolean;
+/**
+ * Retrieves the number of decimals for an asset with the given symbol on a specified node.
+ *
+ * @param node - The node where the asset is located.
+ * @param symbol - The symbol of the asset.
+ * @returns The number of decimals if the asset is found; otherwise, null.
+ */
+declare const getAssetDecimals: (node: TNodeWithRelayChains, symbol: string) => number | null;
+declare const hasDryRunSupport: (node: TNodeWithRelayChains) => boolean;
+
+declare const Native: (symbol: string) => TSymbolSpecifier;
+declare const Foreign: (symbol: string) => TSymbolSpecifier;
+declare const ForeignAbstract: (symbol: string) => TSymbolSpecifier;
+declare const Override: (multiLocation: TMultiLocation) => TOverrideMultiLocationSpecifier;
+
+declare const filterEthCompatibleAssets: (assets: TForeignAsset[]) => TForeignAsset[];
+
+/**
+ * Normalizes an asset symbol by stripping the 'xc' prefix (if present) and converting it to lowercase.
+ *
+ * @param symbol - The symbol to normalize.
+ * @returns The normalized symbol.
+ */
+declare const normalizeSymbol: (symbol: string | undefined) => string;
+/**
+ * Retrieves the list of assets that are supported for transfers between two specified nodes.
+ *
+ * @param origin - The origin node.
+ * @param destination - The destination node.
+ * @returns An array of assets supported between the origin and destination nodes.
+ */
+declare const getSupportedAssets: (origin: TNodeWithRelayChains, destination: TNodeWithRelayChains) => TAsset[];
+
+declare const isAssetEqual: (asset1: TAsset, asset2: TAsset) => boolean;
+
+declare const findAsset: (node: TNodeWithRelayChains, currency: TCurrencyInput, destination: TNodeWithRelayChains | null) => TAsset | null;
+
+declare const findAssetById: (assets: TForeignAsset[], assetId: TCurrency) => TForeignAsset | undefined;
+
+declare const findAssetByMultiLocation: (foreignAssets: TForeignAsset[], multiLocation: string | TMultiLocation) => TForeignAsset | undefined;
+
+declare const findAssetBySymbol: (node: TNodeWithRelayChains, destination: TNodeWithRelayChains | null, otherAssets: TForeignAsset[], nativeAssets: TNativeAsset[], symbol: TCurrencySymbolValue) => TAsset | undefined;
+
+declare const findBestMatches: <T extends {
+    symbol: string;
+    alias?: string;
+}>(assets: T[], value: string, property?: "symbol" | "alias") => T[];
+
+/**
+ * Error thrown when multiple assets with the same symbol are found.
+ */
+declare class DuplicateAssetError extends Error {
+    /**
+     * Constructs a new DuplicateAssetError.
+     *
+     * @param symbol - The symbol of the asset causing the duplication error.
+     */
+    constructor(msg: string);
+}
+
+/**
+ * Error thrown when multiple assets with the same symbol are found.
+ */
+declare class DuplicateAssetIdError extends Error {
+    /**
+     * Constructs a new DuplicateAssetError.
+     *
+     * @param symbol - The symbol of the asset causing the duplication error.
+     */
+    constructor(id: string);
+}
+
+/**
+ * Used to inform user, that currency they wish to use is not registered on either origin or destination Parachain
+ */
+declare class InvalidCurrencyError extends Error {
+    /**
+     * Constructs a new InvalidCurrencyError.
+     *
+     * @param message - The error message.
+     */
+    constructor(message: string);
+}
+
+declare const isForeignAsset: (asset: TAsset) => asset is TForeignAsset;
+
+declare const isOverrideMultiLocationSpecifier: (multiLocationSpecifier: TMultiLocationValueWithOverride) => multiLocationSpecifier is TOverrideMultiLocationSpecifier;
+
+declare const isSymbolSpecifier: (currencySymbolValue: TCurrencySymbolValue) => currencySymbolValue is TSymbolSpecifier;
+
+declare const isTMultiAsset: (value: unknown) => value is TMultiAsset;
+
+declare const compareMultiLocations: (input: string, asset: TForeignAsset) => boolean;
+
+declare const extractMultiAssetLoc: (multiAsset: TMultiAsset) => TMultiLocation;
+
+declare const getAssetMultiLocation: (node: TNodeWithRelayChains, currency: TCurrencyInput) => TMultiLocation | null;
+
+export { DuplicateAssetError, DuplicateAssetIdError, Foreign, ForeignAbstract, InvalidCurrencyError, Native, Override, type TAmount, type TAsset, type TAssetJsonMap, type TCurrency, type TCurrencyCore, type TCurrencyInput, type TCurrencyInputWithAmount, type TCurrencySymbol, type TCurrencySymbolValue, type TForeignAsset, type TMultiAsset, type TMultiAssetV3, type TMultiAssetV4, type TMultiAssetWithFee, type TMultiLocationValue, type TMultiLocationValueWithOverride, type TNativeAsset, type TNodeAssets, type TOverrideMultiLocationSpecifier, type TSymbolSpecifier, type WithAmount, compareMultiLocations, extractMultiAssetLoc, filterEthCompatibleAssets, findAsset, findAssetById, findAssetByMultiLocation, findAssetBySymbol, findBestMatches, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssetMultiLocation, getAssets, getAssetsObject, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, hasDryRunSupport, hasSupportForAsset, isAssetEqual, isForeignAsset, isNodeEvm, isOverrideMultiLocationSpecifier, isSymbolSpecifier, isTMultiAsset, normalizeSymbol };