@paraspell/assets 13.4.1 → 13.6.0

package/dist/index.d.ts

@@ -79,6 +79,16 @@ type WithAmount<TBase, T = bigint> = TBase & {
 };
 type WithComplexAmount<TBase> = WithAmount<TBase, TAmount>;
 
+type TCustomAssetInfo = TAssetInfo & {
+    forceOverride?: boolean;
+};
+type TCustomAssetsMap = Partial<Record<TChain, TCustomAssetInfo[]>>;
+type TCustomAssetsMapNormalized = Partial<Record<TChain, TAssetInfo[]>>;
+type TCustomCtx = {
+    customAssets?: TCustomAssetsMapNormalized;
+    customChainAssets?: Record<string, TChainAssetsInfo>;
+};
+
 /**
  * Retrieves the existential deposit value for a given chain.
  *
@@ -92,6 +102,7 @@ declare const getEdFromAssetOrThrow: (asset: TAssetInfo) => bigint;
 
 declare const getFeeAssets: (chain: TChain) => Omit<TAssetInfo, "isFeeAsset">[];
 
+declare const getAssetsObjectImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => TChainAssetsInfo;
 /**
  * Retrieves the assets object for a given chain containing the native and foreign assets.
  *
@@ -99,7 +110,8 @@ declare const getFeeAssets: (chain: TChain) => Omit<TAssetInfo, "isFeeAsset">[];
  * @returns The assets object associated with the given chain.
  */
 declare const getAssetsObject: (chain: TChain) => TChainAssetsInfo;
-declare const isChainEvm: (chain: TChain) => boolean;
+declare const isChainEvmImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => boolean;
+declare const isChainEvm: <TCustomChain extends string = never>(chain: TChain | TCustomChain) => boolean;
 /**
  * Retrieves the asset ID for a given symbol on a specified chain.
  *
@@ -110,6 +122,7 @@ declare const isChainEvm: (chain: TChain) => boolean;
  * @returns The asset ID if found; otherwise, null.
  */
 declare const getAssetId: (chain: TChain, symbol: string) => string | null;
+declare const getRelayChainSymbolImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => string;
 /**
  * Retrieves the relay chain asset symbol for a specified chain.
  *
@@ -117,6 +130,7 @@ declare const getAssetId: (chain: TChain, symbol: string) => string | null;
  * @returns The relay chain asset symbol.
  */
 declare const getRelayChainSymbol: (chain: TChain) => string;
+declare const getNativeAssetsImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => TAssetInfo[];
 /**
  * Retrieves the list of native assets for a specified chain.
  *
@@ -124,13 +138,15 @@ declare const getRelayChainSymbol: (chain: TChain) => string;
  * @returns An array of native asset details.
  */
 declare const getNativeAssets: (chain: TChain) => TAssetInfo[];
+declare const getOtherAssetsImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => TAssetInfo[];
 /**
  * Retrieves the list of other (non-native) assets for a specified chain.
  *
  * @param chain - The chain for which to get other assets.
  * @returns An array of other asset details.
  */
-declare const getOtherAssets: (chain: TChain) => TAssetInfo[];
+declare const getOtherAssets: <TCustomChain extends string = never>(chain: TChain | TCustomChain) => TAssetInfo[];
+declare const getAssetsImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => TAssetInfo[];
 /**
  * Retrieves the complete list of assets for a specified chain, including relay chain asset, native, and other assets.
  *
@@ -145,13 +161,14 @@ declare const getAssets: (chain: TChain) => TAssetInfo[];
  * @returns An array of asset symbols.
  */
 declare const getAllAssetsSymbols: (chain: TChain) => string[];
+declare const getNativeAssetSymbolImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => string;
 /**
  * Retrieves the symbol of the native asset for a specified chain.
  *
  * @param chain - The chain for which to get the native asset symbol.
  * @returns The symbol of the native asset.
  */
-declare const getNativeAssetSymbol: (chain: TChain) => string;
+declare const getNativeAssetSymbol: <TCustomChain extends string = never>(chain: TChain | TCustomChain) => string;
 /**
  * Determines whether a specified chain supports an asset with the given symbol.
  *
@@ -172,14 +189,23 @@ declare const hasSupportForAsset: (chain: TChain, symbol: string) => boolean;
  * @returns The number of decimals if the asset is found; otherwise, null.
  */
 declare const getAssetDecimals: (chain: TChain, symbol: string) => number | null;
+declare const hasDryRunSupportImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => boolean;
 declare const hasDryRunSupport: (chain: TChain) => boolean;
+declare const hasXcmPaymentApiSupportImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => boolean;
 declare const hasXcmPaymentApiSupport: (chain: TChain) => boolean;
 
 declare const Native: (symbol: string) => TSymbolSpecifier;
 declare const Foreign: (symbol: string) => TSymbolSpecifier;
 declare const ForeignAbstract: (symbol: string) => TSymbolSpecifier;
+/**
+ * @deprecated Use the `customAssets` Builder option to register the asset instead. Will be removed in v14.
+ */
 declare const Override: (location: TLocation) => TOverrideLocationSpecifier;
 
+declare const normalizeCustomAssets: (map: TCustomAssetsMap | undefined) => TCustomAssetsMapNormalized;
+declare const isCustomAsset: (chain: TChain, asset: TAssetInfo, ctx?: Pick<TCustomCtx, "customAssets">) => boolean;
+
+declare const getSupportedAssetsImpl: <TCustomChain extends string = never>(origin: TChain | TCustomChain, destination: TChain | TCustomChain, ctx?: TCustomCtx) => TAssetInfo[];
 /**
  * Retrieves the list of assets that are supported for transfers between two specified chains.
  *
@@ -212,6 +238,7 @@ declare const isBridgedSystemAsset: (asset: TAssetInfo, relayChains: readonly TR
  * @returns A new transformed `TLocation`
  */
 declare const normalizeLocation: (location: TLocation, version?: Version) => TLocation;
+declare const canonicalizeLocation: (location: TLocation) => TLocation;
 
 /**
  * Normalizes an asset symbol by stripping the 'xc' prefix (if present) and converting it to lowercase.
@@ -221,24 +248,38 @@ declare const normalizeLocation: (location: TLocation, version?: Version) => TLo
  */
 declare const normalizeSymbol: (symbol?: string) => string;
 
+declare const findAssetInfoImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, currency: TCurrencyInput, destination?: TChain | TCustomChain | null, ctx?: TCustomCtx) => TAssetInfo | null;
 declare const findAssetInfo: (chain: TChain, currency: TCurrencyInput, destination?: TChain | null) => TAssetInfo | null;
 
 declare const findAssetInfoById: (assets: TAssetInfo[], assetId: TCurrency) => TAssetInfo;
 
 declare const findAssetInfoByLoc: (foreignAssets: TAssetInfo[], location: string | TLocation) => TAssetInfo | undefined;
 
-declare const findAssetInfoBySymbol: (otherAssets: TAssetInfo[], nativeAssets: TAssetInfo[], symbol: TCurrencySymbolValue, destination?: TChain) => TAssetInfo | undefined;
+declare const findAssetInfoBySymbol: <TCustomChain extends string = never>(otherAssets: TAssetInfo[], nativeAssets: TAssetInfo[], symbol: TCurrencySymbolValue, destination?: TChain | TCustomChain) => TAssetInfo | undefined;
 
+declare const findAssetInfoOnDestImpl: <TCustomChain extends string = never>(origin: TChain | TCustomChain, destination: TChain | TCustomChain, currency: TCurrencyInput, originAsset?: TAssetInfo | null, ctx?: TCustomCtx) => TAssetInfo | null;
 declare const findAssetInfoOnDest: (origin: TChain, destination: TChain, currency: TCurrencyInput, originAsset?: TAssetInfo | null) => TAssetInfo | null;
+declare const findAssetOnDestOrThrowImpl: <TCustomChain extends string = never>(origin: TChain | TCustomChain, destination: TChain | TCustomChain, currency: TCurrencyInput, ctx?: TCustomCtx) => TAssetInfo;
 declare const findAssetOnDestOrThrow: (origin: TChain, destination: TChain, currency: TCurrencyInput) => TAssetInfo;
 
+declare const findAssetInfoOrThrowImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, currency: TCurrencyInput, destination?: TChain | TCustomChain | null, ctx?: TCustomCtx) => TAssetInfo;
 declare const findAssetInfoOrThrow: (chain: TChain, currency: TCurrencyInput, destination?: TChain | null) => TAssetInfo;
 
 declare const findBestMatches: (assets: TAssetInfo[], value: string, property?: "symbol" | "alias") => TAssetInfo[];
 
+declare const findNativeAssetInfoImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => TAssetInfo | null;
 declare const findNativeAssetInfo: (chain: TChain) => TAssetInfo | null;
+declare const findNativeAssetInfoOrThrowImpl: <TCustomChain extends string = never>(chain: TChain | TCustomChain, ctx?: TCustomCtx) => TAssetInfo;
 declare const findNativeAssetInfoOrThrow: (chain: TChain) => TAssetInfo;
 
+/**
+ * Error thrown when a custom asset's location collides with an existing
+ * registry asset and `forceOverride` was not set.
+ */
+declare class CustomAssetConflictError extends Error {
+    constructor(msg: string);
+}
+
 /**
  * Error thrown when multiple assets with the same symbol are found.
  */
@@ -287,5 +328,5 @@ declare const extractAssetLocation: <T = bigint>(asset: TAsset<T>) => TLocation;
 
 declare const getAssetLocation: (chain: TChain, currency: TCurrencyInput) => TLocation | null;
 
-export { DuplicateAssetError, DuplicateAssetIdError, Foreign, ForeignAbstract, InvalidCurrencyError, Native, Override, assertEdDefined, compareLocations, extractAssetLocation, findAssetInfo, findAssetInfoById, findAssetInfoByLoc, findAssetInfoBySymbol, findAssetInfoOnDest, findAssetInfoOrThrow, findAssetOnDestOrThrow, findBestMatches, findNativeAssetInfo, findNativeAssetInfoOrThrow, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssetLocation, getAssets, getAssetsObject, getEdFromAssetOrThrow, getExistentialDeposit, getExistentialDepositOrThrow, getFeeAssets, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getSupportedDestinations, hasDryRunSupport, hasSupportForAsset, hasXcmPaymentApiSupport, isAssetEqual, isAssetXcEqual, isBridgedSystemAsset, isChainEvm, isOverrideLocationSpecifier, isStableCoinAsset, isSymbolMatch, isSymbolSpecifier, isSystemAsset, isTAsset, normalizeLocation, normalizeSymbol };
-export type { TAmount, TAsset, TAssetInfo, TAssetInfoWithId, TAssetJsonMap, TAssetV3, TAssetV4, TAssetWithFee, TChainAssetsInfo, TCurrency, TCurrencyCore, TCurrencyInput, TCurrencyInputWithAmount, TCurrencySymbol, TCurrencySymbolValue, TLocationValue, TLocationValueWithOverride, TOverrideLocationSpecifier, TSymbolSpecifier, WithAmount, WithComplexAmount };
+export { CustomAssetConflictError, DuplicateAssetError, DuplicateAssetIdError, Foreign, ForeignAbstract, InvalidCurrencyError, Native, Override, assertEdDefined, canonicalizeLocation, compareLocations, extractAssetLocation, findAssetInfo, findAssetInfoById, findAssetInfoByLoc, findAssetInfoBySymbol, findAssetInfoImpl, findAssetInfoOnDest, findAssetInfoOnDestImpl, findAssetInfoOrThrow, findAssetInfoOrThrowImpl, findAssetOnDestOrThrow, findAssetOnDestOrThrowImpl, findBestMatches, findNativeAssetInfo, findNativeAssetInfoImpl, findNativeAssetInfoOrThrow, findNativeAssetInfoOrThrowImpl, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssetLocation, getAssets, getAssetsImpl, getAssetsObject, getAssetsObjectImpl, getEdFromAssetOrThrow, getExistentialDeposit, getExistentialDepositOrThrow, getFeeAssets, getNativeAssetSymbol, getNativeAssetSymbolImpl, getNativeAssets, getNativeAssetsImpl, getOtherAssets, getOtherAssetsImpl, getRelayChainSymbol, getRelayChainSymbolImpl, getSupportedAssets, getSupportedAssetsImpl, getSupportedDestinations, hasDryRunSupport, hasDryRunSupportImpl, hasSupportForAsset, hasXcmPaymentApiSupport, hasXcmPaymentApiSupportImpl, isAssetEqual, isAssetXcEqual, isBridgedSystemAsset, isChainEvm, isChainEvmImpl, isCustomAsset, isOverrideLocationSpecifier, isStableCoinAsset, isSymbolMatch, isSymbolSpecifier, isSystemAsset, isTAsset, normalizeCustomAssets, normalizeLocation, normalizeSymbol };
+export type { TAmount, TAsset, TAssetInfo, TAssetInfoWithId, TAssetJsonMap, TAssetV3, TAssetV4, TAssetWithFee, TChainAssetsInfo, TCurrency, TCurrencyCore, TCurrencyInput, TCurrencyInputWithAmount, TCurrencySymbol, TCurrencySymbolValue, TCustomAssetInfo, TCustomAssetsMap, TCustomAssetsMapNormalized, TCustomCtx, TLocationValue, TLocationValueWithOverride, TOverrideLocationSpecifier, TSymbolSpecifier, WithAmount, WithComplexAmount };