@galacticcouncil/sdk 0.0.1-beta.12 → 0.0.1-beta.14

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

@@ -27,13 +27,22 @@ export declare class TradeRouter extends Router {
      * @returns Best possible sell trade of given token pair
      */
     getBestSell(assetIn: string, assetOut: string, amountIn: BigNumber | string | number): Promise<Trade>;
+    /**
+     * Calculate the amount out for best possible trade if fees are zero
+     *
+     * @param amountIn - Amount of assetIn to sell for assetOut
+     * @param bestRoute - Best possible trade route (sell)
+     * @param poolsMap - Pools map
+     * @returns the amount out for best possible trade if fees are zero
+     */
+    private calculateDelta0Y;
     /**
      * Calculate and return sell swaps for given path
      * - final amount of previous swap is entry to next one
      *
      * @param amountIn - Amount of assetIn to sell for assetOut
-     * @param path - current path
-     * @param poolsMap - pools map
+     * @param path - Current path
+     * @param poolsMap - Pools map
      * @returns Sell swaps for given path with corresponding pool pairs
      */
     private toSellSwaps;
@@ -46,14 +55,23 @@ export declare class TradeRouter extends Router {
      * @returns Best possible buy trade of given token pair
      */
     getBestBuy(assetIn: string, assetOut: string, amountOut: BigNumber | string | number): Promise<Trade>;
+    /**
+     * Calculate the amount in for best possible trade if fees are zero
+     *
+     * @param amountOut - Amount of assetOut to buy for assetIn
+     * @param bestRoute - Best possible trade route (buy)
+     * @param poolsMap - Pools map
+     * @returns the amount in for best possible trade if fees are zero
+     */
+    private calculateDelta0X;
     /**
      * Calculate and return buy swaps for given path
      * - final amount of previous swap is entry to next one
      * - calculation is done backwards (swaps in reversed order)
      *
      * @param amountOut - Amount of assetOut to buy for assetIn
-     * @param path - current path
-     * @param poolsMap - pools map
+     * @param path - Current path
+     * @param poolsMap - Pools map
      * @returns Buy swaps for given path
      */
     private toBuySwaps;

package/dist/types/client/polkadotApi.d.ts

@@ -10,6 +10,7 @@ export declare class PolkadotApiClient {
     getStorageKey(asset: [StorageKey<AnyTuple>, Codec], index: number): string;
     getStorageEntryArray(asset: [StorageKey<AnyTuple>, Codec]): string[];
     getPoolTokens(poolAddress: string, assetKeys: string[]): Promise<PoolToken[]>;
+    syncPoolTokens(poolAddress: string, poolTokens: PoolToken[]): Promise<PoolToken[]>;
     getAssetMetadata(tokenKey: string): Promise<AssetMetadata>;
     getAccountBalance(accountId: string, tokenKey: string): Promise<string>;
     getSystemAccountBalance(accountId: string): Promise<string>;

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

@@ -12,7 +12,12 @@ interface LbpPoolData {
 }
 export declare class LbpPolkadotApiClient extends PolkadotApiClient {
     private readonly MAX_FINAL_WEIGHT;
+    private poolsData;
+    private pools;
+    private _poolsLoaded;
     getPools(): Promise<PoolBase[]>;
+    loadPools(): Promise<PoolBase[]>;
+    syncPools(): Promise<PoolBase[]>;
     getLinearWeight(poolEntry: LbpPoolData): Promise<string>;
     getRepayFee(): PoolFee;
     isRepayFeeApplied(assetKey: string, poolEntry: LbpPoolData): Promise<boolean>;

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

@@ -1,10 +1,14 @@
-import { Hop, PoolBase, PoolService, Transaction } from '../types';
-import { ApiPromise } from '@polkadot/api';
+import { Hop, PoolBase, PoolService, PoolType, Transaction } from '../types';
+import { XykPolkadotApiClient } from './xyk/xykPolkadotApiClient';
+import { LbpPolkadotApiClient } from './lbp/lbpPolkadotApiClient';
 import { BigNumber } from '../utils/bignumber';
+import { ApiPromise } from '@polkadot/api';
 export declare class PolkadotApiPoolService implements PoolService {
-    private readonly api;
+    protected readonly api: ApiPromise;
+    protected readonly xykClient: XykPolkadotApiClient;
+    protected readonly lbpClient: LbpPolkadotApiClient;
     constructor(api: ApiPromise);
-    getPools(): Promise<PoolBase[]>;
+    getPools(includeOnly: PoolType[]): Promise<PoolBase[]>;
     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/xyk/xykPolkadotApiClient.d.ts

@@ -1,6 +1,10 @@
 import { PolkadotApiClient } from '../../client';
 import { PoolBase, PoolFee } from '../../types';
 export declare class XykPolkadotApiClient extends PolkadotApiClient {
+    private pools;
+    private _poolsLoaded;
     getPools(): Promise<PoolBase[]>;
+    loadPools(): Promise<PoolBase[]>;
+    syncPools(): Promise<PoolBase[]>;
     getTradeFee(): PoolFee;
 }

package/dist/types/types.d.ts

@@ -64,7 +64,7 @@ export interface Pool extends PoolBase {
     calculateTradeFee(amount: BigNumber): BigNumber;
 }
 export interface PoolService {
-    getPools(): Promise<PoolBase[]>;
+    getPools(includeOnly?: PoolType[]): Promise<PoolBase[]>;
     buildBuyTx(assetIn: string, assetOut: string, amountOut: BigNumber, maxAmountIn: BigNumber, route: Hop[]): Transaction;
     buildSellTx(assetIn: string, assetOut: string, amountIn: BigNumber, minAmountOut: BigNumber, route: Hop[]): Transaction;
 }
@@ -99,6 +99,8 @@ export interface Trade extends Humanizer {
     amountIn: BigNumber;
     amountOut: BigNumber;
     spotPrice: BigNumber;
+    tradeFee: BigNumber;
+    tradeFeePct: number;
     priceImpactPct: number;
     swaps: Swap[];
     toTx(tradeLimit: BigNumber): Transaction;

package/dist/types/utils/math.d.ts

@@ -11,3 +11,23 @@ import { BigNumber } from './bignumber';
  * @returns Price impact percentage
  */
 export declare function calculatePriceImpact(amount: BigNumber, decimals: number, spotPrice: BigNumber, calculatedAmount: BigNumber): BigNumber;
+/**
+ * The total fee paid for a ‘sell’ transaction
+ * Suppose the trader is selling X for Y
+ *
+ * fee = 1 - (deltaY / delta0Y)
+ *
+ * @param delta0Y - the amount out if fees are zero
+ * @param deltaY - the amount out if the existing nonzero fees are included in the calculation
+ */
+export declare function calculateSellFee(delta0Y: BigNumber, deltaY: BigNumber): BigNumber;
+/**
+ * The total fee paid for a buy transaction
+ * Suppose the trader is buying Y using X
+ *
+ * fee = (deltaX / delta0X) - 1
+ *
+ * @param delta0X - the amount in if fees are zero
+ * @param deltaX - the amount in, inclusive of fees
+ */
+export declare function calculateBuyFee(delta0X: BigNumber, deltaX: BigNumber): BigNumber;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacticcouncil/sdk",
-  "version": "0.0.1-beta.12",
+  "version": "0.0.1-beta.14",
   "private": false,
   "description": "Galactic SDK",
   "author": "Pavol Noha <palo@hydradx.io>",

package/dist/types/client/polkadot.d.ts

@@ -1,14 +0,0 @@
-import { ApiPromise } from '@polkadot/api';
-import type { StorageKey } from '@polkadot/types';
-import type { AnyTuple, Codec } from '@polkadot/types/types';
-import type { AssetMetadata } from '@polkadot/types/interfaces';
-import '@polkadot/api-augment';
-export declare class PolkadotClient {
-    protected readonly api: ApiPromise;
-    constructor(api: ApiPromise);
-    getStorageKey(asset: [StorageKey<AnyTuple>, Codec], index: number): string;
-    getStorageEntryArray(asset: [StorageKey<AnyTuple>, Codec]): string[];
-    getAssetMetadata(tokenKey: string): Promise<AssetMetadata>;
-    getSystemAccountBalance(accountId: string): Promise<string>;
-    getTokenAccountBalance(accountId: string, tokenKey: string): Promise<string>;
-}

package/dist/types/client/types.d.ts

@@ -1,7 +0,0 @@
-import type { Struct } from '@polkadot/types-codec';
-import type { Balance } from '@polkadot/types/interfaces/runtime';
-export interface TokensAccountData extends Struct {
-    readonly free: Balance;
-    readonly reserved: Balance;
-    readonly frozen: Balance;
-}

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

@@ -1,7 +0,0 @@
-import { PoolBase, PoolService } from '../types';
-import { ApiPromise } from '@polkadot/api';
-export declare class PolkadotPoolService implements PoolService {
-    private readonly api;
-    constructor(api: ApiPromise);
-    getPools(): Promise<PoolBase[]>;
-}

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

@@ -1,8 +0,0 @@
-import { PolkadotClient } from '../../client';
-import { PoolBase, PoolToken } from '../../types';
-export declare class XykPolkadotClient extends PolkadotClient {
-    getPools(): Promise<PoolBase[]>;
-    getPoolTokens(poolAddress: string, assetKeys: string[]): Promise<PoolToken[]>;
-    getBalance(poolAddress: string, assetKey: string): Promise<string>;
-    getTradeFee(): string;
-}