@galacticcouncil/sdk 0.7.7 → 0.8.0-beta.2

package/build/types/api/Router.d.ts

@@ -1,4 +1,4 @@
-import { IPoolService, PoolBase, Hop, Pool, PoolAsset, PoolType } from '../types';
+import { IPoolService, PoolBase, Hop, Pool, PoolToken, PoolType } from '../types';
 export type RouterOptions = {
     includeOnly?: PoolType[];
 };
@@ -21,16 +21,16 @@ export declare class Router {
     /**
      * Return list of all available assets from substrate based pools
      *
-     * @returns {PoolAsset[]} List of all available assets
+     * @returns {PoolToken[]} List of all available assets
      */
-    getAllAssets(): Promise<PoolAsset[]>;
+    getAllAssets(): Promise<PoolToken[]>;
     /**
      * Calculate and return list of all assets, given token can be trade with
      *
      * @param {string} asset - Storage key of asset
      * @returns {PoolAsset[]} List of all available assets, given token can be trade with
      */
-    getAssetPairs(asset: string): Promise<PoolAsset[]>;
+    getAssetPairs(asset: string): Promise<PoolToken[]>;
     /**
      * Calculate and return all possible paths for best swap assetIn>assetOut
      *
@@ -45,7 +45,7 @@ export declare class Router {
      * @param pools - pools
      * @returns Map of all available assets
      */
-    protected getAssets(pools: PoolBase[]): Promise<Map<string, PoolAsset>>;
+    protected getAssets(pools: PoolBase[]): Promise<Map<string, PoolToken>>;
     /**
      * Calculate and return all possible paths for best swap assetIn>assetOut
      *
@@ -64,7 +64,7 @@ export declare class Router {
      * @returns Pool assets & map
      */
     protected validateTokenPair(assetIn: string, assetOut: string, pools: PoolBase[]): Promise<{
-        assets: Map<string, PoolAsset>;
+        assets: Map<string, PoolToken>;
         poolsMap: Map<string, Pool>;
     }>;
     /**
@@ -74,7 +74,7 @@ export declare class Router {
      * @returns Pool assets & map
      */
     protected validateToken(token: string, pools: PoolBase[]): Promise<{
-        assets: Map<string, PoolAsset>;
+        assets: Map<string, PoolToken>;
         poolsMap: Map<string, Pool>;
     }>;
     /**

package/build/types/client/AssetClient.d.ts

@@ -1,16 +1,18 @@
+import type { PalletAssetRegistryAssetMetadata, PalletStableswapPoolInfo } from '@polkadot/types/lookup';
 import { ApiPromise } from '@polkadot/api';
-import { AssetDetail, AssetMetadata } from '../types';
+import { AssetMetadata } from '../types';
 import { PolkadotApiClient } from './PolkadotApi';
+import { ITuple } from '@polkadot/types-codec/types';
+import { u32, u64 } from '@polkadot/types-codec';
 export declare class AssetClient extends PolkadotApiClient {
+    private SUPPORTED_TYPES;
     constructor(api: ApiPromise);
-    private tryBonds;
-    private tryShares;
+    safeSharesQuery(): Promise<Map<string, PalletStableswapPoolInfo>>;
+    safeBondsQuery(): Promise<Map<string, ITuple<[u32, u64]>>>;
+    metadataQuery(): Promise<Map<string, PalletAssetRegistryAssetMetadata>>;
     private getTokenMetadata;
     private getBondMetadata;
     private getShareMetadata;
-    getAssetMetadata(tokenKey: string): Promise<AssetMetadata>;
-    private getTokenDetail;
-    private getBondDetail;
-    private getShareDetail;
-    getAssetDetail(tokenKey: string): Promise<AssetDetail>;
+    getOnChainMetadata(): Promise<AssetMetadata[]>;
+    private isSupportedType;
 }

package/build/types/client/BalanceClient.d.ts

@@ -1,11 +1,14 @@
 import { ApiPromise } from '@polkadot/api';
+import { UnsubscribePromise } from '@polkadot/api-base/types';
 import { BigNumber } from '../utils/bignumber';
-import { Amount } from '../types';
-import { AssetClient } from './AssetClient';
-export declare class BalanceClient extends AssetClient {
+import { PolkadotApiClient } from './PolkadotApi';
+export declare class BalanceClient extends PolkadotApiClient {
     constructor(api: ApiPromise);
-    getAccountBalance(accountId: string, tokenKey: string): Promise<Amount>;
-    getSystemAccountBalance(accountId: string): Promise<BigNumber>;
-    getTokenAccountBalance(accountId: string, tokenKey: string): Promise<BigNumber>;
+    getBalance(accountId: string, tokenKey: string): Promise<BigNumber>;
+    getSystemBalance(accountId: string): Promise<BigNumber>;
+    getTokenBalance(accountId: string, tokenKey: string): Promise<BigNumber>;
+    subscribeBalance(address: string, tokens: string[], onChange: (token: string, balance: BigNumber) => void): UnsubscribePromise;
+    subscribeTokenBalance(address: string, tokens: string[], onChange: (token: string, balance: BigNumber) => void): UnsubscribePromise;
+    subscribeSystemBalance(address: string, onChange: (token: string, balance: BigNumber) => void): UnsubscribePromise;
     private calculateFreeBalance;
 }

package/build/types/consts.d.ts

@@ -6,3 +6,4 @@ export declare const HYDRADX_PARACHAIN_ID = 2034;
 export declare const HYDRADX_SS58_PREFIX = 63;
 export declare const BASILISK_PARACHAIN_ID = 2090;
 export declare const DENOMINATOR = 1000;
+export declare const HYDRADX_OMNIPOOL_ADDRESS: string;

package/build/types/pool/PoolClient.d.ts

@@ -1,14 +1,23 @@
 import { ApiPromise } from '@polkadot/api';
-import type { StorageKey } from '@polkadot/types';
-import type { AnyTuple, Codec } from '@polkadot/types/types';
-import type { PoolBase, PoolFees, PoolToken } from '../types';
+import { UnsubscribePromise, VoidFn } from '@polkadot/api-base/types';
+import { PoolBase, PoolFees, PoolType } from '../types';
 import { BalanceClient } from '../client';
 export declare abstract class PoolClient extends BalanceClient {
+    protected pools: PoolBase[];
+    protected subs: VoidFn[];
+    private poolsLoaded;
     constructor(api: ApiPromise);
-    abstract getPools(): Promise<PoolBase[]>;
+    protected abstract loadPools(): Promise<PoolBase[]>;
+    abstract getPoolType(): PoolType;
     abstract getPoolFees(feeAsset: string, address: string): Promise<PoolFees>;
-    protected getStorageKey(asset: [StorageKey<AnyTuple>, Codec], index: number): string;
-    protected getStorageEntryArray(asset: [StorageKey<AnyTuple>, Codec]): string[];
-    protected getPoolTokens(poolAddress: string, assetKeys: string[]): Promise<PoolToken[]>;
-    protected syncPoolTokens(poolAddress: string, poolTokens: PoolToken[]): Promise<PoolToken[]>;
+    protected abstract subscribePoolChange(pool: PoolBase): UnsubscribePromise;
+    getPools(): Promise<PoolBase[]>;
+    subscribe(): Promise<VoidFn[]>;
+    unsubscribe(): void;
+    private hasShareAsset;
+    private tokenSubs;
+    private shareSubs;
+    private systemSubs;
+    private updateBalanceCallback;
+    private updateBalanceLog;
 }

package/build/types/pool/PoolService.d.ts

@@ -2,17 +2,23 @@ import { LbpPoolClient } from './lbp/LbpPoolClient';
 import { OmniPoolClient } from './omni/OmniPoolClient';
 import { XykPoolClient } from './xyk/XykPoolClient';
 import { StableSwapClient } from './stable/StableSwapClient';
-import { Hop, PoolBase, IPoolService, PoolType, Transaction, PoolFees, Pool } from '../types';
+import { AssetClient } from '../client';
+import { Hop, PoolBase, IPoolService, PoolType, Transaction, PoolFees, Pool, AssetMetadata } from '../types';
 import { BigNumber } from '../utils/bignumber';
 import { ApiPromise } from '@polkadot/api';
 export declare class PoolService implements IPoolService {
     protected readonly api: ApiPromise;
+    protected readonly assetClient: AssetClient;
     protected readonly xykClient: XykPoolClient;
     protected readonly omniClient: OmniPoolClient;
     protected readonly lbpClient: LbpPoolClient;
     protected readonly stableClient: StableSwapClient;
+    protected metadata: AssetMetadata[];
+    protected metadataLoaded: boolean;
     constructor(api: ApiPromise);
     getPools(includeOnly: PoolType[]): Promise<PoolBase[]>;
+    unsubscribe(): void;
+    private withMetadata;
     getPoolFees(feeAsset: string, pool: Pool): Promise<PoolFees>;
     private isDirectOmnipoolTrade;
     buildBuyTx(assetIn: string, assetOut: string, amountOut: BigNumber, maxAmountIn: BigNumber, route: Hop[]): Transaction;

package/build/types/pool/lbp/LbpPoolClient.d.ts

@@ -1,18 +1,16 @@
-import { PoolBase, PoolFees } from '../../types';
+import { UnsubscribePromise } from '@polkadot/api-base/types';
+import { PoolBase, PoolFees, PoolType } from '../../types';
 import { PoolClient } from '../PoolClient';
 export declare class LbpPoolClient extends PoolClient {
     private readonly MAX_FINAL_WEIGHT;
     private poolsData;
-    private pools;
-    private _poolsLoaded;
-    getPools(): Promise<PoolBase[]>;
-    private loadPools;
-    private syncPools;
-    getRelayChainBlock(): Promise<number>;
+    loadPools(): Promise<PoolBase[]>;
+    getPoolFees(_feeAsset: string, address: string): Promise<PoolFees>;
+    getPoolType(): PoolType;
+    subscribePoolChange(pool: PoolBase): UnsubscribePromise;
+    private getPoolDelta;
     private isActivePool;
-    private getLinearWeight;
     private isRepayFeeApplied;
-    getPoolFees(_feeAsset: string, address: string): Promise<PoolFees>;
     private getRepayFee;
     private getPoolLimits;
 }

package/build/types/pool/omni/OmniPool.d.ts

@@ -11,7 +11,6 @@ export type OmniPoolPair = PoolPair & {
 export type OmniPoolToken = PoolToken & {
     hubReserves: BigNumber;
     shares: BigNumber;
-    tradeable: number;
 };
 export type OmniPoolFees = PoolFees & {
     assetFee: PoolFee;

package/build/types/pool/omni/OmniPoolClient.d.ts

@@ -1,13 +1,12 @@
-import { PoolBase, PoolFees } from '../../types';
+import { UnsubscribePromise } from '@polkadot/api-base/types';
+import { PoolBase, PoolType, PoolFees } from '../../types';
 import { PoolClient } from '../PoolClient';
 export declare class OmniPoolClient extends PoolClient {
-    private pools;
-    private _poolLoaded;
-    getPools(): Promise<PoolBase[]>;
-    private loadPool;
-    private syncPool;
-    private getPoolTokenState;
+    loadPools(): Promise<PoolBase[]>;
     getPoolFees(feeAsset: string, _address: string): Promise<PoolFees>;
+    getPoolType(): PoolType;
+    subscribePoolChange(pool: PoolBase): UnsubscribePromise;
+    private updateTokenState;
     private getAssetFee;
     private getProtocolFee;
     private getPoolId;

package/build/types/pool/stable/StableSwap.d.ts

@@ -4,9 +4,6 @@ export type StableSwapPair = PoolPair & {
     tradeableIn: number;
     tradeableOut: number;
 };
-export type StableSwapToken = PoolToken & {
-    tradeable: number;
-};
 export type StableSwapFees = PoolFees & {
     fee: PoolFee;
 };
@@ -19,7 +16,7 @@ export type StableSwapBase = PoolBase & {
 export declare class StableSwap implements Pool {
     type: PoolType;
     address: string;
-    tokens: StableSwapToken[];
+    tokens: PoolToken[];
     maxInRatio: number;
     maxOutRatio: number;
     minTradingLimit: number;
@@ -28,7 +25,7 @@ export declare class StableSwap implements Pool {
     fee: PoolFee;
     totalIssuance: string;
     static fromPool(pool: StableSwapBase): StableSwap;
-    constructor(address: string, tokens: StableSwapToken[], maxInRation: number, maxOutRatio: number, minTradeLimit: number, amplification: string, id: string, fee: PoolFee, totalIssuance: string);
+    constructor(address: string, tokens: PoolToken[], maxInRation: number, maxOutRatio: number, minTradeLimit: number, amplification: string, id: string, fee: PoolFee, totalIssuance: string);
     validatePair(_tokenIn: string, _tokenOut: string): boolean;
     parsePair(tokenIn: string, tokenOut: string): StableSwapPair;
     validateAndBuy(poolPair: StableSwapPair, amountOut: BigNumber, fees: StableSwapFees): BuyTransfer;

package/build/types/pool/stable/StableSwapClient.d.ts

@@ -1,19 +1,14 @@
-import { PoolBase, PoolFees } from '../../types';
+import { UnsubscribePromise } from '@polkadot/api-base/types';
+import { PoolBase, PoolType, PoolFees } from '../../types';
 import { PoolClient } from '../PoolClient';
 export declare class StableSwapClient extends PoolClient {
-    private poolsData;
-    private pools;
-    private _poolsLoaded;
-    getPools(): Promise<PoolBase[]>;
-    private loadPools;
-    private syncPools;
-    private syncTokens;
-    private getPoolTokenState;
-    getParaChainBlock(): Promise<number>;
-    private getTotalIssueance;
-    private getAmplification;
-    private getPoolAddress;
-    private getOmniPoolAddress;
+    private stablePools;
+    loadPools(): Promise<PoolBase[]>;
     getPoolFees(_feeAsset: string, address: string): Promise<PoolFees>;
+    getPoolType(): PoolType;
+    subscribePoolChange(pool: PoolBase): UnsubscribePromise;
+    private getPoolDelta;
+    private getPoolTokens;
+    private getPoolAddress;
     private getPoolLimits;
 }

package/build/types/pool/xyk/XykPoolClient.d.ts

@@ -1,12 +1,11 @@
-import { PoolBase, PoolFees } from '../../types';
+import { UnsubscribePromise } from '@polkadot/api-base/types';
+import { PoolBase, PoolType, PoolFees } from '../../types';
 import { PoolClient } from '../PoolClient';
 export declare class XykPoolClient extends PoolClient {
-    private pools;
-    private _poolsLoaded;
-    getPools(): Promise<PoolBase[]>;
-    private loadPools;
-    private syncPools;
+    loadPools(): Promise<PoolBase[]>;
     getPoolFees(_feeAsset: string, _address: string): Promise<PoolFees>;
+    getPoolType(): PoolType;
+    protected subscribePoolChange(pool: PoolBase): UnsubscribePromise;
     private getExchangeFee;
     private getPoolLimits;
 }

package/build/types/types.d.ts

@@ -1,10 +1,4 @@
 import { BigNumber } from './utils/bignumber';
-export type PoolAsset = {
-    id: string;
-    symbol: string;
-    icon: string;
-    meta?: Record<string, string>;
-};
 export declare enum PoolType {
     XYK = "Xyk",
     LBP = "Lbp",
@@ -35,16 +29,17 @@ export type PoolBase = {
     maxOutRatio: number;
     minTradingLimit: number;
 };
+export interface PoolToken extends AssetMetadata {
+    id: string;
+    balance: string;
+    tradeable?: number;
+}
 export type PoolLimits = Pick<PoolBase, 'maxInRatio' | 'maxOutRatio' | 'minTradingLimit'>;
 export type PoolFee = [numerator: number, denominator: number];
 export type PoolFees = {
     min?: PoolFee;
     max?: PoolFee;
 };
-export type PoolToken = PoolAsset & {
-    balance: string;
-    decimals: number;
-};
 export type PoolSell = {
     calculatedOut: BigNumber;
 };
@@ -129,13 +124,12 @@ export interface AssetBalance {
     available: BigNumber;
 }
 export interface AssetMetadata {
-    symbol: string;
+    id: string;
     decimals: number;
-    icon: string;
-    meta?: Record<string, string>;
-}
-export interface AssetDetail {
     name: string;
+    symbol: string;
+    icon: string;
     assetType: string;
     existentialDeposit: string;
+    meta?: Record<string, string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacticcouncil/sdk",
-  "version": "0.7.7",
+  "version": "0.8.0-beta.2",
   "description": "Galactic off-chain routing & optimization of orders across pools for best price execution",
   "author": "GalacticCouncil",
   "repository": {