@galacticcouncil/sdk 0.5.0-beta.0 → 0.5.0

package/dist/types/api/TradeRouter.d.ts

@@ -16,6 +16,20 @@ export declare class TradeRouter extends Router {
      * @returns best sell swap if exist, otherwise first one found
      */
     private findBestSellRoute;
+    /**
+     * Return route fee range [min,max] in case pool is using dynamic fees
+     *
+     * @param swaps - Trade routes
+     * @returns min & max fee range if swap through the pool with dynamic fees support
+     */
+    private getRouteFeeRange;
+    /**
+     * Return pool fee range [min,max] in case pool is using dynamic fees
+     *
+     * @param fees - Pool fees
+     * @returns min & max fee range if swap through the pool with dynamic fees support
+     */
+    private getPoolFeeRange;
     /**
      * Calculate and return best possible sell trade for assetIn>assetOut
      *

package/dist/types/errors.d.ts

@@ -1,4 +1,7 @@
 import { PoolType } from './types';
+export declare class PoolNotFound extends Error {
+    constructor(poolType: PoolType);
+}
 export declare class PoolConfigNotFound extends Error {
     constructor(poolType: PoolType, param: string);
 }

package/dist/types/pool/CachingPoolService.d.ts

@@ -0,0 +1,10 @@
+import { PoolService } from './PoolService';
+import { PoolFees, Pool } from '../types';
+import { ApiPromise } from '@polkadot/api';
+export declare class CachingPoolService extends PoolService {
+    private feeCache;
+    private disconnectSubscribeNewHeads;
+    constructor(api: ApiPromise);
+    getPoolFees(feeAsset: string, pool: Pool): Promise<PoolFees>;
+    destroy(): Promise<void>;
+}

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

@@ -1,10 +1,12 @@
 import { ApiPromise } from '@polkadot/api';
 import type { StorageKey } from '@polkadot/types';
 import type { AnyTuple, Codec } from '@polkadot/types/types';
-import type { PoolToken } from '../types';
+import type { PoolBase, PoolFees, PoolToken } from '../types';
 import { BalanceClient } from '../client';
 export declare abstract class PoolClient extends BalanceClient {
     constructor(api: ApiPromise);
+    abstract getPools(): Promise<PoolBase[]>;
+    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[]>;

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

@@ -1,7 +1,7 @@
 import { LbpPoolClient } from './lbp/LbpPoolClient';
 import { OmniPoolClient } from './omni/OmniPoolClient';
 import { XykPoolClient } from './xyk/XykPoolClient';
-import { Hop, PoolBase, IPoolService, PoolType, Transaction, PoolFees } from '../types';
+import { Hop, PoolBase, IPoolService, PoolType, Transaction, PoolFees, Pool } from '../types';
 import { BigNumber } from '../utils/bignumber';
 import { ApiPromise } from '@polkadot/api';
 export declare class PoolService implements IPoolService {
@@ -11,7 +11,7 @@ export declare class PoolService implements IPoolService {
     protected readonly lbpClient: LbpPoolClient;
     constructor(api: ApiPromise);
     getPools(includeOnly: PoolType[]): Promise<PoolBase[]>;
-    getDynamicFees(asset: string, poolType: PoolType): Promise<PoolFees | null>;
+    getPoolFees(feeAsset: string, pool: Pool): Promise<PoolFees>;
     private isDirectOmnipoolTrade;
     buildBuyTx(assetIn: string, assetOut: string, amountOut: BigNumber, maxAmountIn: BigNumber, route: Hop[]): Transaction;
     buildSellTx(assetIn: string, assetOut: string, amountIn: BigNumber, minAmountOut: BigNumber, route: Hop[]): Transaction;

package/dist/types/pool/index.d.ts

@@ -1,3 +1,4 @@
+export { CachingPoolService } from './CachingPoolService';
 export { PoolService } from './PoolService';
 export { PoolFactory } from './PoolFactory';
 export { XykPool } from './xyk/XykPool';

package/dist/types/pool/lbp/LbpPool.d.ts

@@ -12,6 +12,7 @@ export type LbpPoolFees = PoolFees & {
     repayFee: PoolFee;
 };
 export type LbpPoolBase = PoolBase & {
+    fee: PoolFee;
     repayFeeApply: boolean;
 };
 export declare class LbpPool implements Pool {
@@ -21,10 +22,10 @@ export declare class LbpPool implements Pool {
     maxInRatio: number;
     maxOutRatio: number;
     minTradingLimit: number;
-    fees: LbpPoolFees;
+    fee: PoolFee;
     repayFeeApply: boolean;
     static fromPool(pool: LbpPoolBase): LbpPool;
-    constructor(address: string, tokens: WeightedPoolToken[], maxInRation: number, maxOutRatio: number, minTradeLimit: number, fees: LbpPoolFees, repayFeeApply: boolean);
+    constructor(address: string, tokens: WeightedPoolToken[], maxInRation: number, maxOutRatio: number, minTradeLimit: number, fee: PoolFee, repayFeeApply: boolean);
     validatePair(_tokenIn: string, _tokenOut: string): boolean;
     parsePair(tokenIn: string, tokenOut: string): WeightedPoolPair;
     /**
@@ -33,14 +34,14 @@ export declare class LbpPool implements Pool {
      * a) Accumulated asset is bought (out) from the pool for distributed asset (in) - User(Buyer) bears the fee
      * b) Distributed asset is bought (out) from the pool for accumualted asset (in) - Pool bears the fee
      */
-    validateAndBuy(poolPair: WeightedPoolPair, amountOut: BigNumber, dynamicFees: LbpPoolFees): BuyTransfer;
+    validateAndBuy(poolPair: WeightedPoolPair, amountOut: BigNumber, fees: LbpPoolFees): BuyTransfer;
     /**
      * Validate sell transfer
      *
      * a) Accumulated asset is sold (in) to the pool for distributed asset (out) - Pool bears the fee
      * b) Distributed asset is sold (in) to the pool for accumualted asset (out) - User(Seller) bears the fee
      */
-    validateAndSell(poolPair: WeightedPoolPair, amountIn: BigNumber, dynamicFees: LbpPoolFees): SellTransfer;
+    validateAndSell(poolPair: WeightedPoolPair, amountIn: BigNumber, fees: LbpPoolFees): SellTransfer;
     calculateInGivenOut(poolPair: WeightedPoolPair, amountOut: BigNumber): BigNumber;
     calculateOutGivenIn(poolPair: WeightedPoolPair, amountIn: BigNumber): BigNumber;
     spotPriceInGivenOut(poolPair: WeightedPoolPair): BigNumber;

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

@@ -1,15 +1,5 @@
-import { PoolBase, PoolFee, PoolFees, PoolLimits } from '../../types';
+import { PoolBase, PoolFees } from '../../types';
 import { PoolClient } from '../PoolClient';
-interface LbpPoolData {
-    readonly assets: string[];
-    readonly feeCollector: string;
-    readonly fee: number[];
-    readonly repayTarget: string;
-    readonly initialWeight: number;
-    readonly finalWeight: number;
-    readonly start: number;
-    readonly end: number;
-}
 export declare class LbpPoolClient extends PoolClient {
     private readonly MAX_FINAL_WEIGHT;
     private poolsData;
@@ -18,10 +8,9 @@ export declare class LbpPoolClient extends PoolClient {
     getPools(): Promise<PoolBase[]>;
     private loadPools;
     private syncPools;
-    getLinearWeight(poolEntry: LbpPoolData): Promise<string>;
-    isRepayFeeApplied(assetKey: string, poolEntry: LbpPoolData): Promise<boolean>;
-    getPoolFees(poolEntry: LbpPoolData): PoolFees;
-    getRepayFee(): PoolFee;
-    getPoolLimits(): PoolLimits;
+    private getLinearWeight;
+    private isRepayFeeApplied;
+    getPoolFees(_feeAsset: string, address: string): Promise<PoolFees>;
+    private getRepayFee;
+    private getPoolLimits;
 }
-export {};

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

@@ -24,14 +24,13 @@ export declare class OmniPool implements Pool {
     maxInRatio: number;
     maxOutRatio: number;
     minTradingLimit: number;
-    fees: OmniPoolFees;
     hubAssetId: string;
     static fromPool(pool: OmniPoolBase): OmniPool;
-    constructor(address: string, tokens: OmniPoolToken[], maxInRation: number, maxOutRatio: number, minTradeLimit: number, fees: OmniPoolFees, hubAssetId: string);
+    constructor(address: string, tokens: OmniPoolToken[], maxInRation: number, maxOutRatio: number, minTradeLimit: number, hubAssetId: string);
     validatePair(_tokenIn: string, tokenOut: string): boolean;
     parsePair(tokenIn: string, tokenOut: string): OmniPoolPair;
-    validateAndBuy(poolPair: OmniPoolPair, amountOut: BigNumber, dynamicFees: OmniPoolFees): BuyTransfer;
-    validateAndSell(poolPair: OmniPoolPair, amountIn: BigNumber, dynamicFees: OmniPoolFees): SellTransfer;
+    validateAndBuy(poolPair: OmniPoolPair, amountOut: BigNumber, fees: OmniPoolFees): BuyTransfer;
+    validateAndSell(poolPair: OmniPoolPair, amountIn: BigNumber, fees: OmniPoolFees): SellTransfer;
     calculateInGivenOut(poolPair: OmniPoolPair, amountOut: BigNumber, fees?: OmniPoolFees): BigNumber;
     calculateLrnaInGivenOut(poolPair: OmniPoolPair, amountOut: BigNumber, fees?: OmniPoolFees): BigNumber;
     calculateOutGivenIn(poolPair: OmniPoolPair, amountIn: BigNumber, fees?: OmniPoolFees): BigNumber;

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

@@ -1,5 +1,4 @@
-import { PoolBase, PoolFee, PoolLimits, PoolFees } from '../../types';
-import { OmniPoolFees } from './OmniPool';
+import { PoolBase, PoolFees } from '../../types';
 import { PoolClient } from '../PoolClient';
 export declare class OmniPoolClient extends PoolClient {
     private pools;
@@ -8,10 +7,9 @@ export declare class OmniPoolClient extends PoolClient {
     private loadPool;
     private syncPool;
     private getPoolTokenState;
-    getPoolFees(): PoolFees;
-    getAssetFee(): PoolFee;
-    getProtocolFee(): PoolFee;
-    getDynamicFees(asset: string): Promise<OmniPoolFees | null>;
-    getPoolId(): string;
-    getPoolLimits(): PoolLimits;
+    getPoolFees(feeAsset: string, _address: string): Promise<PoolFees>;
+    private getAssetFee;
+    private getProtocolFee;
+    private getPoolId;
+    private getPoolLimits;
 }

package/dist/types/pool/xyk/XykPool.d.ts

@@ -10,13 +10,12 @@ export declare class XykPool implements Pool {
     maxInRatio: number;
     maxOutRatio: number;
     minTradingLimit: number;
-    fees: XykPoolFees;
     static fromPool(pool: PoolBase): XykPool;
-    constructor(address: string, tokens: PoolToken[], maxInRation: number, maxOutRatio: number, minTradeLimit: number, fees: XykPoolFees);
+    constructor(address: string, tokens: PoolToken[], maxInRation: number, maxOutRatio: number, minTradeLimit: number);
     validatePair(_tokenIn: string, _tokenOut: string): boolean;
     parsePair(tokenIn: string, tokenOut: string): PoolPair;
-    validateAndBuy(poolPair: PoolPair, amountOut: BigNumber, dynamicFees: XykPoolFees): BuyTransfer;
-    validateAndSell(poolPair: PoolPair, amountIn: BigNumber, dynamicFees: XykPoolFees): SellTransfer;
+    validateAndBuy(poolPair: PoolPair, amountOut: BigNumber, fees: XykPoolFees): BuyTransfer;
+    validateAndSell(poolPair: PoolPair, amountIn: BigNumber, fees: XykPoolFees): SellTransfer;
     calculateInGivenOut(poolPair: PoolPair, amountOut: BigNumber): BigNumber;
     calculateOutGivenIn(poolPair: PoolPair, amountIn: BigNumber): BigNumber;
     spotPriceInGivenOut(poolPair: PoolPair): BigNumber;

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

@@ -1,4 +1,4 @@
-import { PoolBase, PoolFee, PoolLimits, PoolFees } from '../../types';
+import { PoolBase, PoolFees } from '../../types';
 import { PoolClient } from '../PoolClient';
 export declare class XykPoolClient extends PoolClient {
     private pools;
@@ -6,7 +6,7 @@ export declare class XykPoolClient extends PoolClient {
     getPools(): Promise<PoolBase[]>;
     private loadPools;
     private syncPools;
-    getPoolFees(): PoolFees;
-    getExchangeFee(): PoolFee;
-    getPoolLimits(): PoolLimits;
+    getPoolFees(_feeAsset: string, _address: string): Promise<PoolFees>;
+    private getExchangeFee;
+    private getPoolLimits;
 }

package/dist/types/types.d.ts

@@ -26,14 +26,16 @@ export type PoolBase = {
     address: string;
     type: PoolType;
     tokens: PoolToken[];
-    fees: PoolFees;
     maxInRatio: number;
     maxOutRatio: number;
     minTradingLimit: number;
 };
 export type PoolLimits = Pick<PoolBase, 'maxInRatio' | 'maxOutRatio' | 'minTradingLimit'>;
 export type PoolFee = [numerator: number, denominator: number];
-export type PoolFees = {};
+export type PoolFees = {
+    min?: PoolFee;
+    max?: PoolFee;
+};
 export type PoolToken = PoolAsset & {
     balance: string;
     decimals: number;
@@ -64,7 +66,7 @@ export interface Pool extends PoolBase {
 }
 export interface IPoolService {
     getPools(includeOnly?: PoolType[]): Promise<PoolBase[]>;
-    getDynamicFees(asset: string, poolType: PoolType): Promise<PoolFees | null>;
+    getPoolFees(feeAsset: string, pool: Pool): Promise<PoolFees>;
     buildBuyTx(assetIn: string, assetOut: string, amountOut: BigNumber, maxAmountIn: BigNumber, route: Hop[]): Transaction;
     buildSellTx(assetIn: string, assetOut: string, amountIn: BigNumber, minAmountOut: BigNumber, route: Hop[]): Transaction;
 }
@@ -86,6 +88,7 @@ export type Swap = Hop & Humanizer & {
     amountOut: BigNumber;
     spotPrice: BigNumber;
     tradeFeePct: number;
+    tradeFeeRange?: [number, number];
     priceImpactPct: number;
     errors: PoolError[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacticcouncil/sdk",
-  "version": "0.5.0-beta.0",
+  "version": "0.5.0",
   "private": false,
   "description": "Galactic SDK",
   "author": "Pavol Noha <palo@hydradx.io>",
@@ -10,10 +10,12 @@
   "scripts": {
     "build": "node ./esbuild.mjs && tsc --emitDeclarationOnly --outDir dist/types/",
     "cleanup": "rimraf out && rimraf dist",
+    "release": "standard-version --tag-prefix=''",
     "test": "jest",
     "test:coverage": "jest --coverage",
     "pckg:build": "npm run cleanup && npm run build",
-    "pckg:release": "npm run pckg:build && standard-version --tag-prefix=''",
+    "pckg:beta": "npm run pckg:build && npm publish --tag beta",
+    "pckg:release": "npm run pckg:build && npm release",
     "pckg:publish": "git push --follow-tags origin master && npm publish",
     "xcmgr:sync": "node ./xcmgr.sync.mjs"
   },
@@ -41,6 +43,7 @@
     "@galacticcouncil/math-lbp": "^0.1.3",
     "@galacticcouncil/math-omnipool": "^0.1.3",
     "@galacticcouncil/math-xyk": "^0.1.3",
+    "@thi.ng/cache": "^2.1.35",
     "bignumber.js": "^9.1.0",
     "lodash.clonedeep": "^4.5.0"
   },