@galacticcouncil/sdk 0.0.8 → 0.2.0

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

@@ -1,17 +1,17 @@
-import { PoolService, PoolBase, Hop, Pool, PoolAsset, PoolType } from '../types';
+import { IPoolService, PoolBase, Hop, Pool, PoolAsset, PoolType } from '../types';
 export type RouterOptions = {
     includeOnly?: PoolType[];
 };
 export declare class Router {
     private readonly routeSuggester;
     private readonly routerOptions;
-    protected readonly poolService: PoolService;
+    protected readonly poolService: IPoolService;
     private readonly defaultRouterOptions;
     /**
      * @param poolService - Fetch pool data from substrate based pools
      * @param routerOptions - Optional router options
      */
-    constructor(poolService: PoolService, routerOptions?: RouterOptions);
+    constructor(poolService: IPoolService, routerOptions?: RouterOptions);
     /**
      * Return all pools
      *

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

@@ -49,9 +49,9 @@ export declare class TradeRouter extends Router {
      *
      * @param {string} assetIn - Storage key of tokenIn
      * @param {string} assetOut - Storage key of tokenOut
-     * @return Best possible spot price of given token pair
+     * @return Best possible spot price of given token pair, or undefined if given pair trade not supported
      */
-    getBestSpotPrice(assetIn: string, assetOut: string): Promise<Amount>;
+    getBestSpotPrice(assetIn: string, assetOut: string): Promise<Amount | undefined>;
     /**
      * Find best buy swap without errors, if there is none return first one found
      *

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

@@ -0,0 +1,8 @@
+import { ApiPromise } from '@polkadot/api';
+import { AssetDetail, AssetMetadata } from '../types';
+import { PolkadotApiClient } from './PolkadotApi';
+export declare class AssetApiClient extends PolkadotApiClient {
+    constructor(api: ApiPromise);
+    getAssetMetadata(tokenKey: string): Promise<AssetMetadata>;
+    getAssetDetail(tokenKey: string): Promise<AssetDetail>;
+}

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

@@ -0,0 +1,11 @@
+import { ApiPromise } from '@polkadot/api';
+import { BigNumber } from '../utils/bignumber';
+import { Amount } from '../types';
+import { AssetApiClient } from './AssetApiClient';
+export declare class BalanceApiClient extends AssetApiClient {
+    constructor(api: ApiPromise);
+    getAccountBalance(accountId: string, tokenKey: string): Promise<Amount>;
+    getSystemAccountBalance(accountId: string): Promise<BigNumber>;
+    getTokenAccountBalance(accountId: string, tokenKey: string): Promise<BigNumber>;
+    private calculateFreeBalance;
+}

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

@@ -1,18 +1,8 @@
 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 type { PoolToken } from '../types';
 import '@polkadot/api-augment';
-export declare class PolkadotApiClient {
+export declare abstract class PolkadotApiClient {
     protected readonly api: ApiPromise;
     constructor(api: ApiPromise);
-    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>;
-    getTokenAccountBalance(accountId: string, tokenKey: string): Promise<string>;
+    get chainDecimals(): number;
+    get chainToken(): string;
 }

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

@@ -1 +1,3 @@
 export { PolkadotApiClient } from './PolkadotApi';
+export { AssetApiClient } from './AssetApiClient';
+export { BalanceApiClient } from './BalanceApiClient';

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

@@ -0,0 +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 { BalanceApiClient } from '../client';
+export declare abstract class PoolApiClient extends BalanceApiClient {
+    constructor(api: ApiPromise);
+    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[]>;
+}

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

@@ -0,0 +1,17 @@
+import { LbpPoolApiClient } from './lbp/LbpPoolApiClient';
+import { OmniPoolApiClient } from './omni/OmniPoolApiClient';
+import { XykPoolApiClient } from './xyk/XykPoolApiClient';
+import { Hop, PoolBase, IPoolService, PoolType, Transaction } from '../types';
+import { BigNumber } from '../utils/bignumber';
+import { ApiPromise } from '@polkadot/api';
+export declare class PoolService implements IPoolService {
+    protected readonly api: ApiPromise;
+    protected readonly xykClient: XykPoolApiClient;
+    protected readonly omniClient: OmniPoolApiClient;
+    protected readonly lbpClient: LbpPoolApiClient;
+    constructor(api: ApiPromise);
+    getPools(includeOnly: PoolType[]): Promise<PoolBase[]>;
+    private isOmnipoolTx;
+    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,4 +1,4 @@
-export { PolkadotApiPoolService } from './PolkadotApiPoolService';
+export { PoolService } from './PoolService';
 export { PoolFactory } from './PoolFactory';
 export { XykPool } from './xyk/XykPool';
 export { XykMath } from './xyk/XykMath';

package/dist/types/pool/lbp/{LbpPolkadotApiClient.d.ts → LbpPoolApiClient.d.ts}

@@ -1,5 +1,5 @@
-import { PolkadotApiClient } from '../../client';
 import { PoolBase, PoolFee, PoolLimits } from '../../types';
+import { PoolApiClient } from '../PoolApiClient';
 interface LbpPoolData {
     readonly assets: string[];
     readonly feeCollector: string;
@@ -10,14 +10,14 @@ interface LbpPoolData {
     readonly start: number;
     readonly end: number;
 }
-export declare class LbpPolkadotApiClient extends PolkadotApiClient {
+export declare class LbpPoolApiClient extends PoolApiClient {
     private readonly MAX_FINAL_WEIGHT;
     private poolsData;
     private pools;
     private _poolsLoaded;
     getPools(): Promise<PoolBase[]>;
-    loadPools(): Promise<PoolBase[]>;
-    syncPools(): Promise<PoolBase[]>;
+    private loadPools;
+    private syncPools;
     getLinearWeight(poolEntry: LbpPoolData): Promise<string>;
     isRepayFeeApplied(assetKey: string, poolEntry: LbpPoolData): Promise<boolean>;
     getRepayFee(): PoolFee;

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

@@ -7,8 +7,8 @@ export declare class OmniMath {
     static calculateOutGivenLrnaIn(assetOutBalance: string, assetOutHubReserve: string, assetOutShares: string, amountOut: string, assetFee: string): string;
     static calculatePoolTradeFee(amount: string, feeNumerator: number, feeDenominator: number): string;
     static calculateShares(assetReserve: string, assetHubReserve: string, assetShares: string, amountIn: string): string;
-    static calculateLiquidityOut(assetReserve: string, assetHubReserve: string, assetShares: string, positionAmount: string, positionShares: string, positionPrice: string, sharesToRemove: string): string;
-    static calculateLiquidityLRNAOut(assetReserve: string, assetHubReserve: string, assetShares: string, positionAmount: string, positionShares: string, positionPrice: string, sharesToRemove: string): string;
+    static calculateLiquidityOut(assetReserve: string, assetHubReserve: string, assetShares: string, positionAmount: string, positionShares: string, positionPrice: string, sharesToRemove: string, withdrawalFee: string): string;
+    static calculateLiquidityLRNAOut(assetReserve: string, assetHubReserve: string, assetShares: string, positionAmount: string, positionShares: string, positionPrice: string, sharesToRemove: string, withdrawalFee: string): string;
     static calculateCapDifference(assetReserve: string, assetHubReserve: string, assetCap: string, totalHubReserve: string): string;
     static verifyAssetCap(assetReserve: string, assetCap: string, hubAdded: string, totalHubReserve: string): boolean;
     static calculateLimitHubIn(assetReserve: string, assetHubReserve: string, assetShares: string, amountIn: string): string;

package/dist/types/pool/omni/{OmniPolkadotApiClient.d.ts → OmniPoolApiClient.d.ts}

@@ -1,13 +1,11 @@
-import { ApiPromise } from '@polkadot/api';
-import { PolkadotApiClient } from '../../client';
 import { PoolBase, PoolFee, PoolLimits } from '../../types';
-export declare class OmniPolkadotApiClient extends PolkadotApiClient {
+import { PoolApiClient } from '../PoolApiClient';
+export declare class OmniPoolApiClient extends PoolApiClient {
     private pools;
     private _poolLoaded;
-    constructor(api: ApiPromise);
     getPools(): Promise<PoolBase[]>;
-    loadPool(): Promise<PoolBase>;
-    syncPool(): Promise<PoolBase>;
+    private loadPool;
+    private syncPool;
     private getPoolTokenState;
     getTradeFee(): PoolFee;
     getAssetFee(): PoolFee;

package/dist/types/pool/xyk/{XykPolkadotApiClient.d.ts → XykPoolApiClient.d.ts}

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

package/dist/types/types.d.ts

@@ -62,7 +62,7 @@ export interface Pool extends PoolBase {
     spotPriceOutGivenIn(poolPair: PoolPair): BigNumber;
     calculateTradeFee(amount: BigNumber): BigNumber;
 }
-export interface PoolService {
+export interface IPoolService {
     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;
@@ -118,3 +118,12 @@ export interface AssetBalance {
     reserved: BigNumber;
     available: BigNumber;
 }
+export interface AssetMetadata {
+    symbol: string;
+    decimals: number;
+}
+export interface AssetDetail {
+    name: string;
+    existentialDeposit: string;
+    locked: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacticcouncil/sdk",
-  "version": "0.0.8",
+  "version": "0.2.0",
   "private": false,
   "description": "Galactic SDK",
   "author": "Pavol Noha <palo@hydradx.io>",
@@ -36,14 +36,14 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@galacticcouncil/math-lbp": "^0.0.7",
-    "@galacticcouncil/math-omnipool": "^0.0.7",
-    "@galacticcouncil/math-xyk": "^0.0.7",
+    "@galacticcouncil/math-lbp": "^0.1.3",
+    "@galacticcouncil/math-omnipool": "^0.1.3",
+    "@galacticcouncil/math-xyk": "^0.1.3",
     "bignumber.js": "^9.1.0",
     "lodash.clonedeep": "^4.5.0"
   },
   "peerDependencies": {
-    "@polkadot/api": "^9.9.1",
+    "@polkadot/api": "^9.14.2",
     "capi": "^0.1.0-beta.12",
     "ethers": "^6.0.5"
   }

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

@@ -1,17 +0,0 @@
-import { Hop, PoolBase, PoolService, PoolType, Transaction } from '../types';
-import { XykPolkadotApiClient } from './xyk/XykPolkadotApiClient';
-import { LbpPolkadotApiClient } from './lbp/LbpPolkadotApiClient';
-import { OmniPolkadotApiClient } from './omni/OmniPolkadotApiClient';
-import { BigNumber } from '../utils/bignumber';
-import { ApiPromise } from '@polkadot/api';
-export declare class PolkadotApiPoolService implements PoolService {
-    protected readonly api: ApiPromise;
-    protected readonly xykClient: XykPolkadotApiClient;
-    protected readonly omniClient: OmniPolkadotApiClient;
-    protected readonly lbpClient: LbpPolkadotApiClient;
-    constructor(api: ApiPromise);
-    getPools(includeOnly: PoolType[]): Promise<PoolBase[]>;
-    isOmnipoolTx(route: Hop[]): boolean;
-    buildBuyTx(assetIn: string, assetOut: string, amountOut: BigNumber, maxAmountIn: BigNumber, route: Hop[]): Transaction;
-    buildSellTx(assetIn: string, assetOut: string, amountIn: BigNumber, minAmountOut: BigNumber, route: Hop[]): Transaction;
-}