@galacticcouncil/descriptors 1.0.0

package/build/descriptors-4VWMSC3A.mjs

@@ -0,0 +1,27 @@
+// .papi/descriptors/src/descriptors.ts
+var [minified, commonTrees, tokens] = JSON.parse(`[{"hydration":{"storage":{"0":{"Account":0,"Number":1},"2":{"1":6,"AssetLocations":7},"3":{"1":8,"HubAssetTradability":1},"4":0,"5":{"AssetFee":14},"6":{"Pools":16,"AssetTradability":17},"7":{"7":19},"8":{"PoolData":20},"9":{"PoolAssets":22},"10":{"TotalIssuance":24,"Accounts":25},"11":0,"12":{"ValidationData":27}},"tx":{"0":0,"2":0,"3":{"13":10,"14":11},"4":{"13":12,"14":13},"5":0,"6":0,"7":0,"8":0,"9":0,"10":0,"11":0,"12":0},"events":{"0":0,"2":0,"3":0,"4":0,"5":0,"6":0,"7":0,"8":0,"9":0,"10":0,"11":{"Log":26},"12":0},"constants":{"0":{"BlockWeights":2,"BlockLength":3,"BlockHashCount":1,"DbWeight":4,"Version":5,"SS58Prefix":1},"2":0,"3":{"15":9,"16":9,"HdxAssetId":1,"HubAssetId":1,"MinWithdrawalFee":1,"MinimumTradingLimit":9,"MinimumPoolLiquidity":9,"NFTCollectionId":9,"BurnProtocolFee":1},"4":0,"5":{"AssetFeeParameters":15,"ProtocolFeeParameters":15},"6":{"17":9,"18":9,"AmplificationRange":18},"7":0,"8":{"15":9,"16":9,"17":9,"18":9,"repay_fee":21},"9":{"15":9,"16":9,"17":9,"18":9,"NativeAssetId":1,"GetExchangeFee":21,"OracleSource":23},"10":0,"11":0,"12":0},"apis":{"CurrenciesApi":{"account":28,"accounts":29,"free_balance":30}}}},[{}],["System","Assets","AssetRegistry","Omnipool","Router","DynamicFees","Stableswap","Bonds","LBP","XYK","Tokens","EVM","ParachainSystem","sell","buy","MaxInRatio","MaxOutRatio","MinPoolLiquidity","MinTradingLimit"]]`);
+var replaceTokens = (obj) => Object.fromEntries(
+  Object.entries(obj).map(([key, value]) => {
+    const unwrappedValue = typeof value === "object" ? replaceTokens(value) : value;
+    const numericKey = Number(key);
+    if (Number.isNaN(numericKey)) {
+      return [key, unwrappedValue];
+    }
+    return [tokens[numericKey], unwrappedValue];
+  })
+);
+var tokenizedCommonTrees = commonTrees.map(replaceTokens);
+var unwrap = (obj, depth) => depth === 0 ? obj : Object.fromEntries(
+  Object.entries(obj).map(([key, value]) => [
+    key,
+    unwrap(
+      typeof value === "object" ? value : tokenizedCommonTrees[value],
+      depth - 1
+    )
+  ])
+);
+var getChainDescriptors = (key) => unwrap(replaceTokens(minified[key]), 2);
+var Hydration = getChainDescriptors("hydration");
+export {
+  Hydration
+};

package/build/descriptors.d.ts

@@ -0,0 +1 @@
+export declare const Hydration: Record<string, object>;

package/build/hydration.d.ts

@@ -0,0 +1,398 @@
+import { StorageDescriptor, PlainDescriptor, TxDescriptor, RuntimeDescriptor, Enum, QueryFromPalletsDef, TxFromPalletsDef, EventsFromPalletsDef, ErrorsFromPalletsDef, ConstFromPalletsDef, SS58String, FixedSizeBinary, Binary, FixedSizeArray } from "polkadot-api";
+import { I5sesotjlssv2d, Ifj0li5nn5unet, I4c0s5cioidn76, I8ikpj86u2na1q, Ibn3i0ad6beo5l, I1p5pqg6bllgtl, I9jd27rnpm8ttv, I4ojmnsk1dchql, Iesq88051ch8ht, Ic02kut0350gb0, I6ouflveob4eli, Ifn6q3equiq9qi, In7a38730s6qs, If15el53dd76v9, I9s0ave7t0vnrk, Ic6nglu2db2c36, Ie5fbn0f5capo3, Ia9ai1mp1viqjd, Ievca65alkkho9, I2qkf9i0e8mf1f, Iet9su1uri0qgo, I242odhgbhik24, Ifmc9boeeia623, I4g15ko4u63fja, I426moodfs3rr2 } 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>;
+        /**
+         * The current block number being processed. Set by `execute_block`.
+         */
+        Number: StorageDescriptor<[], number, false, never>;
+    };
+    AssetRegistry: {
+        /**
+         * Details of an asset.
+         */
+        Assets: StorageDescriptor<[Key: number], Anonymize<Ifj0li5nn5unet>, true, never>;
+        /**
+         * Native location of an asset.
+         */
+        AssetLocations: StorageDescriptor<[Key: number], Anonymize<I4c0s5cioidn76>, true, never>;
+    };
+    Omnipool: {
+        /**
+         * State of an asset in the omnipool
+         */
+        Assets: StorageDescriptor<[Key: number], Anonymize<I8ikpj86u2na1q>, true, never>;
+        /**
+         * Tradable state of hub asset.
+         */
+        HubAssetTradability: StorageDescriptor<[], number, false, never>;
+    };
+    DynamicFees: {
+        /**
+         * Stores last calculated fee of an asset and block number in which it was changed..
+         * Stored as (Asset fee, Protocol fee, Block number)
+         */
+        AssetFee: StorageDescriptor<[Key: number], Anonymize<Ibn3i0ad6beo5l>, true, never>;
+    };
+    Stableswap: {
+        /**
+         * Existing pools
+         */
+        Pools: StorageDescriptor<[Key: number], Anonymize<I1p5pqg6bllgtl>, true, never>;
+        /**
+         * Tradability state of pool assets.
+         */
+        AssetTradability: StorageDescriptor<Anonymize<I9jd27rnpm8ttv>, number, false, never>;
+    };
+    Bonds: {
+        /**
+         * Registered bonds.
+         * Maps bond ID -> (underlying asset ID, maturity)
+         */
+        Bonds: StorageDescriptor<[Key: number], Anonymize<I4ojmnsk1dchql>, true, never>;
+    };
+    LBP: {
+        /**
+         * Details of a pool.
+         */
+        PoolData: StorageDescriptor<[Key: SS58String], Anonymize<Iesq88051ch8ht>, true, never>;
+    };
+    XYK: {
+        /**
+         * Asset pair in a pool.
+         */
+        PoolAssets: StorageDescriptor<[Key: SS58String], Anonymize<I9jd27rnpm8ttv>, true, never>;
+    };
+    Tokens: {
+        /**
+         * The total issuance of a token type.
+         */
+        TotalIssuance: StorageDescriptor<[Key: number], bigint, false, never>;
+        /**
+         * The balance of a token type under an account.
+         *
+         * NOTE: If the total is ever zero, decrease account ref account.
+         *
+         * NOTE: This is only used in the case that this module is used to store
+         * balances.
+         */
+        Accounts: StorageDescriptor<Anonymize<I6ouflveob4eli>, Anonymize<Ic02kut0350gb0>, false, never>;
+    };
+    ParachainSystem: {
+        /**
+         * The [`PersistedValidationData`] set for this block.
+         * This value is expected to be set only once per block and it's never stored
+         * in the trie.
+         */
+        ValidationData: StorageDescriptor<[], Anonymize<Ifn6q3equiq9qi>, true, never>;
+    };
+};
+type ICalls = {
+    Omnipool: {
+        /**
+         *Execute a swap of `asset_in` for `asset_out`.
+         *
+         *Price is determined by the Omnipool.
+         *
+         *Hub asset is traded separately.
+         *
+         *Asset's tradable states must contain SELL flag for asset_in and BUY flag for asset_out, otherwise `NotAllowed` error is returned.
+         *
+         *Parameters:
+         *- `asset_in`: ID of asset sold to the pool
+         *- `asset_out`: ID of asset bought from the pool
+         *- `amount`: Amount of asset sold
+         *- `min_buy_amount`: Minimum amount required to receive
+         *
+         *Emits `SellExecuted` event when successful. Deprecated.
+         *Emits `pallet_broadcast::Swapped` event when successful.
+         *
+         */
+        sell: TxDescriptor<Anonymize<Ievca65alkkho9>>;
+        /**
+         *Execute a swap of `asset_out` for `asset_in`.
+         *
+         *Price is determined by the Omnipool.
+         *
+         *Hub asset is traded separately.
+         *
+         *Asset's tradable states must contain SELL flag for asset_in and BUY flag for asset_out, otherwise `NotAllowed` error is returned.
+         *
+         *Parameters:
+         *- `asset_in`: ID of asset sold to the pool
+         *- `asset_out`: ID of asset bought from the pool
+         *- `amount`: Amount of asset sold
+         *- `max_sell_amount`: Maximum amount to be sold.
+         *
+         *Emits `BuyExecuted` event when successful. Deprecated.
+         *Emits `pallet_broadcast::Swapped` event when successful.
+         *
+         */
+        buy: TxDescriptor<Anonymize<I2qkf9i0e8mf1f>>;
+    };
+    Router: {
+        /**
+         *Executes a sell with a series of trades specified in the route.
+         *The price for each trade is determined by the corresponding AMM.
+         *
+         *- `origin`: The executor of the trade
+         *- `asset_in`: The identifier of the asset to sell
+         *- `asset_out`: The identifier of the asset to receive
+         *- `amount_in`: The amount of `asset_in` to sell
+         *- `min_amount_out`: The minimum amount of `asset_out` to receive.
+         *- `route`: Series of [`Trade<AssetId>`] to be executed. A [`Trade<AssetId>`] specifies the asset pair (`asset_in`, `asset_out`) and the AMM (`pool`) in which the trade is executed.
+         *		   If not specified, than the on-chain route is used.
+         *		   If no on-chain is present, then omnipool route is used as default
+         *
+         *Emits `RouteExecuted` when successful.
+         */
+        sell: TxDescriptor<Anonymize<Iet9su1uri0qgo>>;
+        /**
+         *Executes a buy with a series of trades specified in the route.
+         *The price for each trade is determined by the corresponding AMM.
+         *
+         *- `origin`: The executor of the trade
+         *- `asset_in`: The identifier of the asset to be swapped to buy `asset_out`
+         *- `asset_out`: The identifier of the asset to buy
+         *- `amount_out`: The amount of `asset_out` to buy
+         *- `max_amount_in`: The max amount of `asset_in` to spend on the buy.
+         *- `route`: Series of [`Trade<AssetId>`] to be executed. A [`Trade<AssetId>`] specifies the asset pair (`asset_in`, `asset_out`) and the AMM (`pool`) in which the trade is executed.
+         *		   If not specified, than the on-chain route is used.
+         *		   If no on-chain is present, then omnipool route is used as default
+         *
+         *Emits `RouteExecuted` when successful.
+         */
+        buy: TxDescriptor<Anonymize<I242odhgbhik24>>;
+    };
+};
+type IEvent = {
+    EVM: {
+        /**
+         *Ethereum events from contracts.
+         */
+        Log: PlainDescriptor<Anonymize<Ifmc9boeeia623>>;
+    };
+};
+type IError = {};
+type IConstants = {
+    System: {
+        /**
+         * Block & extrinsics weights: base values and limits.
+         */
+        BlockWeights: PlainDescriptor<Anonymize<In7a38730s6qs>>;
+        /**
+         * The maximum length of a block (in bytes).
+         */
+        BlockLength: PlainDescriptor<Anonymize<If15el53dd76v9>>;
+        /**
+         * Maximum number of block number to block hash mappings to keep (oldest pruned first).
+         */
+        BlockHashCount: PlainDescriptor<number>;
+        /**
+         * The weight of runtime database operations the runtime can invoke.
+         */
+        DbWeight: PlainDescriptor<Anonymize<I9s0ave7t0vnrk>>;
+        /**
+         * Get the chain's in-code version.
+         */
+        Version: PlainDescriptor<Anonymize<Ic6nglu2db2c36>>;
+        /**
+         * The designated SS58 prefix of this chain.
+         *
+         * This replaces the "ss58Format" property declared in the chain spec. Reason is
+         * that the runtime should know about the prefix in order to make use of it as
+         * an identifier of the chain.
+         */
+        SS58Prefix: PlainDescriptor<number>;
+    };
+    Omnipool: {
+        /**
+         * Native Asset ID
+         */
+        HdxAssetId: PlainDescriptor<number>;
+        /**
+         * Hub Asset ID
+         */
+        HubAssetId: PlainDescriptor<number>;
+        /**
+         * Minimum withdrawal fee
+         */
+        MinWithdrawalFee: PlainDescriptor<number>;
+        /**
+         * Minimum trading limit
+         */
+        MinimumTradingLimit: PlainDescriptor<bigint>;
+        /**
+         * Minimum pool liquidity which can be added
+         */
+        MinimumPoolLiquidity: PlainDescriptor<bigint>;
+        /**
+         * Max fraction of asset reserve to sell in single transaction
+         */
+        MaxInRatio: PlainDescriptor<bigint>;
+        /**
+         * Max fraction of asset reserve to buy in single transaction
+         */
+        MaxOutRatio: PlainDescriptor<bigint>;
+        /**
+         * Non fungible class id
+         */
+        NFTCollectionId: PlainDescriptor<bigint>;
+        /**
+        
+         */
+        BurnProtocolFee: PlainDescriptor<number>;
+    };
+    DynamicFees: {
+        /**
+        
+         */
+        AssetFeeParameters: PlainDescriptor<Anonymize<Ie5fbn0f5capo3>>;
+        /**
+        
+         */
+        ProtocolFeeParameters: PlainDescriptor<Anonymize<Ie5fbn0f5capo3>>;
+    };
+    Stableswap: {
+        /**
+         * Minimum pool liquidity
+         */
+        MinPoolLiquidity: PlainDescriptor<bigint>;
+        /**
+         * Minimum trading amount
+         */
+        MinTradingLimit: PlainDescriptor<bigint>;
+        /**
+         * Amplification inclusive range. Pool's amp can be selected from the range only.
+         */
+        AmplificationRange: PlainDescriptor<Anonymize<Ia9ai1mp1viqjd>>;
+    };
+    LBP: {
+        /**
+         * Minimum trading limit, sole purpose of this is to keep the math working
+         */
+        MinTradingLimit: PlainDescriptor<bigint>;
+        /**
+         * Minimum pool liquidity, sole purpose of this is to keep the math working
+         */
+        MinPoolLiquidity: PlainDescriptor<bigint>;
+        /**
+         * Max fraction of pool to sell in single transaction
+         */
+        MaxInRatio: PlainDescriptor<bigint>;
+        /**
+         * Max fraction of pool to buy in single transaction
+         */
+        MaxOutRatio: PlainDescriptor<bigint>;
+        /**
+        
+         */
+        repay_fee: PlainDescriptor<Anonymize<I9jd27rnpm8ttv>>;
+    };
+    XYK: {
+        /**
+         * Native Asset Id
+         */
+        NativeAssetId: PlainDescriptor<number>;
+        /**
+         * Trading fee rate
+         */
+        GetExchangeFee: PlainDescriptor<Anonymize<I9jd27rnpm8ttv>>;
+        /**
+         * Minimum trading limit
+         */
+        MinTradingLimit: PlainDescriptor<bigint>;
+        /**
+         * Minimum pool liquidity
+         */
+        MinPoolLiquidity: PlainDescriptor<bigint>;
+        /**
+         * Max fraction of pool to sell in single transaction
+         */
+        MaxInRatio: PlainDescriptor<bigint>;
+        /**
+         * Max fraction of pool to buy in single transaction
+         */
+        MaxOutRatio: PlainDescriptor<bigint>;
+        /**
+         * Oracle source identifier for this pallet.
+         */
+        OracleSource: PlainDescriptor<FixedSizeBinary<8>>;
+    };
+};
+type IRuntimeCalls = {
+    /**
+    
+     */
+    CurrenciesApi: {
+        /**
+        
+         */
+        account: RuntimeDescriptor<[asset_id: number, who: SS58String], Anonymize<Ic02kut0350gb0>>;
+        /**
+        
+         */
+        accounts: RuntimeDescriptor<[who: SS58String], Anonymize<I4g15ko4u63fja>>;
+        /**
+        
+         */
+        free_balance: RuntimeDescriptor<[asset_id: number, who: SS58String], bigint>;
+    };
+};
+type IAsset = PlainDescriptor<void>;
+export type HydrationDispatchError = 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 HydrationQueries = QueryFromPalletsDef<PalletsTypedef>;
+export type HydrationCalls = TxFromPalletsDef<PalletsTypedef>;
+export type HydrationEvents = EventsFromPalletsDef<PalletsTypedef>;
+export type HydrationErrors = ErrorsFromPalletsDef<PalletsTypedef>;
+export type HydrationConstants = ConstFromPalletsDef<PalletsTypedef>;
+export type HydrationCallData = Anonymize<I426moodfs3rr2> & {
+    value: {
+        type: string;
+    };
+};
+export type HydrationWhitelistEntry = 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];