@decentro-dev/polkadot-sufficient-assets 0.0.1

package/packages/core/.papi/descriptors/dist/polkadot_metadata.d.ts

@@ -0,0 +1,2 @@
+declare const binMeta: string;
+export default binMeta;

package/packages/core/.papi/descriptors/dist/rah.d.ts

@@ -0,0 +1,434 @@
+import { StorageDescriptor, PlainDescriptor, TxDescriptor, RuntimeDescriptor, Enum, QueryFromPalletsDef, TxFromPalletsDef, EventsFromPalletsDef, ErrorsFromPalletsDef, ConstFromPalletsDef, SS58String, Binary, FixedSizeBinary, FixedSizeArray } from "polkadot-api";
+import { I5sesotjlssv2d, I1q8tnt1cluu5j, I3qklfjubrljqh, Iag3f1hum3p4c8, I7svnfko10tq2e, I78s05f59eoi8b, I4c0s5cioidn76, I7rv8d2nr55kkq, Id0as9l3s817qs, I4ktuaksf5i1gk, Iakevv83i18n4r, I5gi8h3e5lkbeq, I6mahckc73q3cs, I72tqocvdoqfff, Ikm68gg7akl51, I35p85j063s0il, I5vv5n03oo8gas, I8g3e3pmb9v816 } from "./common-types";
+type AnonymousEnum<T extends {}> = T & {
+    __anonymous: true;
+};
+type MyTuple<T> = [T, ...T[]];
+type SeparateUndefined<T> = undefined extends T ? undefined | Exclude<T, undefined> : T;
+type Anonymize<T> = SeparateUndefined<T extends FixedSizeBinary<infer L> ? number extends L ? Binary : FixedSizeBinary<L> : T extends string | number | bigint | boolean | void | undefined | null | symbol | Uint8Array | Enum<any> ? T : T extends AnonymousEnum<infer V> ? Enum<V> : T extends MyTuple<any> ? {
+    [K in keyof T]: T[K];
+} : T extends [] ? [] : T extends FixedSizeArray<infer L, infer T> ? number extends L ? Array<T> : FixedSizeArray<L, T> : {
+    [K in keyof T & string]: T[K];
+}>;
+type IStorage = {
+    System: {
+        /**
+         * The full account information for a particular account ID.
+         */
+        Account: StorageDescriptor<[Key: SS58String], Anonymize<I5sesotjlssv2d>, false, never>;
+    };
+    Balances: {
+        /**
+         * The total units issued in the system.
+         */
+        TotalIssuance: StorageDescriptor<[], bigint, false, never>;
+        /**
+         * The Balances pallet example of storing the balance of an account.
+         *
+         * # Example
+         *
+         * ```nocompile
+         *  impl pallet_balances::Config for Runtime {
+         *    type AccountStore = StorageMapShim<Self::Account<Runtime>, frame_system::Provider<Runtime>, AccountId, Self::AccountData<Balance>>
+         *  }
+         * ```
+         *
+         * You can also store the balance of an account in the `System` pallet.
+         *
+         * # Example
+         *
+         * ```nocompile
+         *  impl pallet_balances::Config for Runtime {
+         *   type AccountStore = System
+         *  }
+         * ```
+         *
+         * But this comes with tradeoffs, storing account balances in the system pallet stores
+         * `frame_system` data alongside the account data contrary to storing account balances in the
+         * `Balances` pallet, which uses a `StorageMap` to store balances data only.
+         * NOTE: This is only used in the case that this pallet is used to store balances.
+         */
+        Account: StorageDescriptor<[Key: SS58String], Anonymize<I1q8tnt1cluu5j>, false, never>;
+    };
+    Assets: {
+        /**
+         * Details of an asset.
+         */
+        Asset: StorageDescriptor<[Key: number], Anonymize<I3qklfjubrljqh>, true, never>;
+        /**
+         * The holdings of a specific account for a specific asset.
+         */
+        Account: StorageDescriptor<Anonymize<I7svnfko10tq2e>, Anonymize<Iag3f1hum3p4c8>, true, never>;
+        /**
+         * Metadata of an asset.
+         */
+        Metadata: StorageDescriptor<[Key: number], Anonymize<I78s05f59eoi8b>, false, never>;
+    };
+    ForeignAssets: {
+        /**
+         * Details of an asset.
+         */
+        Asset: StorageDescriptor<[Key: Anonymize<I4c0s5cioidn76>], Anonymize<I3qklfjubrljqh>, true, never>;
+        /**
+         * The holdings of a specific account for a specific asset.
+         */
+        Account: StorageDescriptor<Anonymize<I7rv8d2nr55kkq>, Anonymize<Iag3f1hum3p4c8>, true, never>;
+        /**
+         * Metadata of an asset.
+         */
+        Metadata: StorageDescriptor<[Key: Anonymize<I4c0s5cioidn76>], Anonymize<I78s05f59eoi8b>, false, never>;
+    };
+    PoolAssets: {
+        /**
+         * Details of an asset.
+         */
+        Asset: StorageDescriptor<[Key: number], Anonymize<I3qklfjubrljqh>, true, never>;
+        /**
+         * The holdings of a specific account for a specific asset.
+         */
+        Account: StorageDescriptor<Anonymize<I7svnfko10tq2e>, Anonymize<Iag3f1hum3p4c8>, true, never>;
+    };
+    AssetConversion: {
+        /**
+         * Map from `PoolAssetId` to `PoolInfo`. This establishes whether a pool has been officially
+         * created rather than people sending tokens directly to a pool's public account.
+         */
+        Pools: StorageDescriptor<[Key: Anonymize<Id0as9l3s817qs>], number, true, never>;
+    };
+};
+type ICalls = {
+    Balances: {
+        /**
+         *Same as the [`transfer_allow_death`] call, but with a check that the transfer will not
+         *kill the origin account.
+         *
+         *99% of the time you want [`transfer_allow_death`] instead.
+         *
+         *[`transfer_allow_death`]: struct.Pallet.html#method.transfer
+         */
+        transfer_keep_alive: TxDescriptor<Anonymize<I4ktuaksf5i1gk>>;
+    };
+    PolkadotXcm: {
+        /**
+         *Teleport some assets from the local chain to some destination chain.
+         *
+         ***This function is deprecated: Use `limited_teleport_assets` instead.**
+         *
+         *Fee payment on the destination side is made from the asset in the `assets` vector of
+         *index `fee_asset_item`. The weight limit for fees is not provided and thus is unlimited,
+         *with all fees taken as needed from the asset.
+         *
+         *- `origin`: Must be capable of withdrawing the `assets` and executing XCM.
+         *- `dest`: Destination context for the assets. Will typically be `[Parent,
+         *  Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
+         *  relay to parachain.
+         *- `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
+         *  generally be an `AccountId32` value.
+         *- `assets`: The assets to be withdrawn. This should include the assets used to pay the
+         *  fee on the `dest` chain.
+         *- `fee_asset_item`: The index into `assets` of the item which should be used to pay
+         *  fees.
+         */
+        teleport_assets: TxDescriptor<Anonymize<Iakevv83i18n4r>>;
+        /**
+         *Transfer some assets from the local chain to the destination chain through their local,
+         *destination or remote reserve.
+         *
+         *`assets` must have same reserve location and may not be teleportable to `dest`.
+         * - `assets` have local reserve: transfer assets to sovereign account of destination
+         *   chain and forward a notification XCM to `dest` to mint and deposit reserve-based
+         *   assets to `beneficiary`.
+         * - `assets` have destination reserve: burn local assets and forward a notification to
+         *   `dest` chain to withdraw the reserve assets from this chain's sovereign account and
+         *   deposit them to `beneficiary`.
+         * - `assets` have remote reserve: burn local assets, forward XCM to reserve chain to move
+         *   reserves from this chain's SA to `dest` chain's SA, and forward another XCM to `dest`
+         *   to mint and deposit reserve-based assets to `beneficiary`.
+         *
+         ***This function is deprecated: Use `limited_reserve_transfer_assets` instead.**
+         *
+         *Fee payment on the destination side is made from the asset in the `assets` vector of
+         *index `fee_asset_item`. The weight limit for fees is not provided and thus is unlimited,
+         *with all fees taken as needed from the asset.
+         *
+         *- `origin`: Must be capable of withdrawing the `assets` and executing XCM.
+         *- `dest`: Destination context for the assets. Will typically be `[Parent,
+         *  Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
+         *  relay to parachain.
+         *- `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
+         *  generally be an `AccountId32` value.
+         *- `assets`: The assets to be withdrawn. This should include the assets used to pay the
+         *  fee on the `dest` (and possibly reserve) chains.
+         *- `fee_asset_item`: The index into `assets` of the item which should be used to pay
+         *  fees.
+         */
+        reserve_transfer_assets: TxDescriptor<Anonymize<Iakevv83i18n4r>>;
+        /**
+         *Transfer some assets from the local chain to the destination chain through their local,
+         *destination or remote reserve.
+         *
+         *`assets` must have same reserve location and may not be teleportable to `dest`.
+         * - `assets` have local reserve: transfer assets to sovereign account of destination
+         *   chain and forward a notification XCM to `dest` to mint and deposit reserve-based
+         *   assets to `beneficiary`.
+         * - `assets` have destination reserve: burn local assets and forward a notification to
+         *   `dest` chain to withdraw the reserve assets from this chain's sovereign account and
+         *   deposit them to `beneficiary`.
+         * - `assets` have remote reserve: burn local assets, forward XCM to reserve chain to move
+         *   reserves from this chain's SA to `dest` chain's SA, and forward another XCM to `dest`
+         *   to mint and deposit reserve-based assets to `beneficiary`.
+         *
+         *Fee payment on the destination side is made from the asset in the `assets` vector of
+         *index `fee_asset_item`, up to enough to pay for `weight_limit` of weight. If more weight
+         *is needed than `weight_limit`, then the operation will fail and the sent assets may be
+         *at risk.
+         *
+         *- `origin`: Must be capable of withdrawing the `assets` and executing XCM.
+         *- `dest`: Destination context for the assets. Will typically be `[Parent,
+         *  Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
+         *  relay to parachain.
+         *- `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
+         *  generally be an `AccountId32` value.
+         *- `assets`: The assets to be withdrawn. This should include the assets used to pay the
+         *  fee on the `dest` (and possibly reserve) chains.
+         *- `fee_asset_item`: The index into `assets` of the item which should be used to pay
+         *  fees.
+         *- `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
+         */
+        limited_reserve_transfer_assets: TxDescriptor<Anonymize<I5gi8h3e5lkbeq>>;
+        /**
+         *Teleport some assets from the local chain to some destination chain.
+         *
+         *Fee payment on the destination side is made from the asset in the `assets` vector of
+         *index `fee_asset_item`, up to enough to pay for `weight_limit` of weight. If more weight
+         *is needed than `weight_limit`, then the operation will fail and the sent assets may be
+         *at risk.
+         *
+         *- `origin`: Must be capable of withdrawing the `assets` and executing XCM.
+         *- `dest`: Destination context for the assets. Will typically be `[Parent,
+         *  Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
+         *  relay to parachain.
+         *- `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
+         *  generally be an `AccountId32` value.
+         *- `assets`: The assets to be withdrawn. This should include the assets used to pay the
+         *  fee on the `dest` chain.
+         *- `fee_asset_item`: The index into `assets` of the item which should be used to pay
+         *  fees.
+         *- `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
+         */
+        limited_teleport_assets: TxDescriptor<Anonymize<I5gi8h3e5lkbeq>>;
+        /**
+         *Transfer some assets from the local chain to the destination chain through their local,
+         *destination or remote reserve, or through teleports.
+         *
+         *Fee payment on the destination side is made from the asset in the `assets` vector of
+         *index `fee_asset_item` (hence referred to as `fees`), up to enough to pay for
+         *`weight_limit` of weight. If more weight is needed than `weight_limit`, then the
+         *operation will fail and the sent assets may be at risk.
+         *
+         *`assets` (excluding `fees`) must have same reserve location or otherwise be teleportable
+         *to `dest`, no limitations imposed on `fees`.
+         * - for local reserve: transfer assets to sovereign account of destination chain and
+         *   forward a notification XCM to `dest` to mint and deposit reserve-based assets to
+         *   `beneficiary`.
+         * - for destination reserve: burn local assets and forward a notification to `dest` chain
+         *   to withdraw the reserve assets from this chain's sovereign account and deposit them
+         *   to `beneficiary`.
+         * - for remote reserve: burn local assets, forward XCM to reserve chain to move reserves
+         *   from this chain's SA to `dest` chain's SA, and forward another XCM to `dest` to mint
+         *   and deposit reserve-based assets to `beneficiary`.
+         * - for teleports: burn local assets and forward XCM to `dest` chain to mint/teleport
+         *   assets and deposit them to `beneficiary`.
+         *
+         *- `origin`: Must be capable of withdrawing the `assets` and executing XCM.
+         *- `dest`: Destination context for the assets. Will typically be `X2(Parent,
+         *  Parachain(..))` to send from parachain to parachain, or `X1(Parachain(..))` to send
+         *  from relay to parachain.
+         *- `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
+         *  generally be an `AccountId32` value.
+         *- `assets`: The assets to be withdrawn. This should include the assets used to pay the
+         *  fee on the `dest` (and possibly reserve) chains.
+         *- `fee_asset_item`: The index into `assets` of the item which should be used to pay
+         *  fees.
+         *- `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
+         */
+        transfer_assets: TxDescriptor<Anonymize<I5gi8h3e5lkbeq>>;
+    };
+    Utility: {
+        /**
+         *Send a batch of dispatch calls and atomically execute them.
+         *The whole transaction will rollback and fail if any of the calls failed.
+         *
+         *May be called from any origin except `None`.
+         *
+         *- `calls`: The calls to be dispatched from the same origin. The number of call must not
+         *  exceed the constant: `batched_calls_limit` (available in constant metadata).
+         *
+         *If origin is root then the calls are dispatched without checking origin filter. (This
+         *includes bypassing `frame_system::Config::BaseCallFilter`).
+         *
+         *## Complexity
+         *- O(C) where C is the number of calls to be batched.
+         */
+        batch_all: TxDescriptor<Anonymize<I6mahckc73q3cs>>;
+    };
+    Assets: {
+        /**
+         *Move some assets from the sender account to another.
+         *
+         *Origin must be Signed.
+         *
+         *- `id`: The identifier of the asset to have some amount transferred.
+         *- `target`: The account to be credited.
+         *- `amount`: The amount by which the sender's balance of assets should be reduced and
+         *`target`'s balance increased. The amount actually transferred may be slightly greater in
+         *the case that the transfer would otherwise take the sender balance above zero but below
+         *the minimum balance. Must be greater than zero.
+         *
+         *Emits `Transferred` with the actual amount transferred. If this takes the source balance
+         *to below the minimum for the asset, then the amount transferred is increased to take it
+         *to zero.
+         *
+         *Weight: `O(1)`
+         *Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
+         *`target`.
+         */
+        transfer: TxDescriptor<Anonymize<I72tqocvdoqfff>>;
+        /**
+         *Move some assets from the sender account to another, keeping the sender account alive.
+         *
+         *Origin must be Signed.
+         *
+         *- `id`: The identifier of the asset to have some amount transferred.
+         *- `target`: The account to be credited.
+         *- `amount`: The amount by which the sender's balance of assets should be reduced and
+         *`target`'s balance increased. The amount actually transferred may be slightly greater in
+         *the case that the transfer would otherwise take the sender balance above zero but below
+         *the minimum balance. Must be greater than zero.
+         *
+         *Emits `Transferred` with the actual amount transferred. If this takes the source balance
+         *to below the minimum for the asset, then the amount transferred is increased to take it
+         *to zero.
+         *
+         *Weight: `O(1)`
+         *Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
+         *`target`.
+         */
+        transfer_keep_alive: TxDescriptor<Anonymize<I72tqocvdoqfff>>;
+    };
+    ForeignAssets: {
+        /**
+         *Move some assets from the sender account to another.
+         *
+         *Origin must be Signed.
+         *
+         *- `id`: The identifier of the asset to have some amount transferred.
+         *- `target`: The account to be credited.
+         *- `amount`: The amount by which the sender's balance of assets should be reduced and
+         *`target`'s balance increased. The amount actually transferred may be slightly greater in
+         *the case that the transfer would otherwise take the sender balance above zero but below
+         *the minimum balance. Must be greater than zero.
+         *
+         *Emits `Transferred` with the actual amount transferred. If this takes the source balance
+         *to below the minimum for the asset, then the amount transferred is increased to take it
+         *to zero.
+         *
+         *Weight: `O(1)`
+         *Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
+         *`target`.
+         */
+        transfer: TxDescriptor<Anonymize<Ikm68gg7akl51>>;
+    };
+};
+type IEvent = {};
+type IError = {};
+type IConstants = {
+    Balances: {
+        /**
+         * The minimum amount required to keep an account open. MUST BE GREATER THAN ZERO!
+         *
+         * If you *really* need it to be zero, you can enable the feature `insecure_zero_ed` for
+         * this pallet. However, you do so at your own risk: this will open up a major DoS vector.
+         * In case you have multiple sources of provider references, you may also get unexpected
+         * behaviour if you set this to zero.
+         *
+         * Bottom line: Do yourself a favour and make it at least one!
+         */
+        ExistentialDeposit: PlainDescriptor<bigint>;
+    };
+    AssetConversion: {
+        /**
+         * A % the liquidity providers will take of every swap. Represents 10ths of a percent.
+         */
+        LPFee: PlainDescriptor<number>;
+    };
+};
+type IRuntimeCalls = {
+    /**
+     * This runtime api allows people to query the size of the liquidity pools
+     * and quote prices for swaps.
+     */
+    AssetConversionApi: {
+        /**
+         * Provides a quote for [`Pallet::swap_tokens_for_exact_tokens`].
+         *
+         * Note that the price may have changed by the time the transaction is executed.
+         * (Use `amount_in_max` to control slippage.)
+         */
+        quote_price_tokens_for_exact_tokens: RuntimeDescriptor<[asset1: Anonymize<I4c0s5cioidn76>, asset2: Anonymize<I4c0s5cioidn76>, amount: bigint, include_fee: boolean], Anonymize<I35p85j063s0il>>;
+        /**
+         * Provides a quote for [`Pallet::swap_exact_tokens_for_tokens`].
+         *
+         * Note that the price may have changed by the time the transaction is executed.
+         * (Use `amount_out_min` to control slippage.)
+         */
+        quote_price_exact_tokens_for_tokens: RuntimeDescriptor<[asset1: Anonymize<I4c0s5cioidn76>, asset2: Anonymize<I4c0s5cioidn76>, amount: bigint, include_fee: boolean], Anonymize<I35p85j063s0il>>;
+        /**
+         * Returns the size of the liquidity pool for the given asset pair.
+         */
+        get_reserves: RuntimeDescriptor<[asset1: Anonymize<I4c0s5cioidn76>, asset2: Anonymize<I4c0s5cioidn76>], Anonymize<I5vv5n03oo8gas>>;
+    };
+};
+type IAsset = PlainDescriptor<Anonymize<I4c0s5cioidn76>>;
+export type RahDispatchError = unknown;
+type PalletsTypedef = {
+    __storage: IStorage;
+    __tx: ICalls;
+    __event: IEvent;
+    __error: IError;
+    __const: IConstants;
+};
+type IDescriptors = {
+    descriptors: {
+        pallets: PalletsTypedef;
+        apis: IRuntimeCalls;
+    } & Promise<any>;
+    metadataTypes: Promise<Uint8Array>;
+    asset: IAsset;
+    getMetadata: () => Promise<Uint8Array>;
+    genesis: string | undefined;
+};
+declare const _allDescriptors: IDescriptors;
+export default _allDescriptors;
+export type RahQueries = QueryFromPalletsDef<PalletsTypedef>;
+export type RahCalls = TxFromPalletsDef<PalletsTypedef>;
+export type RahEvents = EventsFromPalletsDef<PalletsTypedef>;
+export type RahErrors = ErrorsFromPalletsDef<PalletsTypedef>;
+export type RahConstants = ConstFromPalletsDef<PalletsTypedef>;
+export type RahCallData = Anonymize<I8g3e3pmb9v816> & {
+    value: {
+        type: string;
+    };
+};
+export type RahWhitelistEntry = PalletKey | ApiKey<IRuntimeCalls> | `query.${NestedKey<PalletsTypedef['__storage']>}` | `tx.${NestedKey<PalletsTypedef['__tx']>}` | `event.${NestedKey<PalletsTypedef['__event']>}` | `error.${NestedKey<PalletsTypedef['__error']>}` | `const.${NestedKey<PalletsTypedef['__const']>}`;
+type PalletKey = `*.${keyof (IStorage & ICalls & IEvent & IError & IConstants & IRuntimeCalls)}`;
+type NestedKey<D extends Record<string, Record<string, any>>> = "*" | {
+    [P in keyof D & string]: `${P}.*` | {
+        [N in keyof D[P] & string]: `${P}.${N}`;
+    }[keyof D[P] & string];
+}[keyof D & string];
+type ApiKey<D extends Record<string, Record<string, any>>> = "api.*" | {
+    [P in keyof D & string]: `api.${P}.*` | {
+        [N in keyof D[P] & string]: `api.${P}.${N}`;
+    }[keyof D[P] & string];
+}[keyof D & string];