@qidao/sdk 5.0.6 → 5.0.9

package/dist/router.d.ts

@@ -1,4 +1,8 @@
-import { Percent, Trade } from './entities';
+import { Currency } from './entities/Currency';
+import { CurrencyAmount } from './entities/CurrencyAmount';
+import { Percent } from './entities/Percent';
+import { Trade } from './entities/Trade';
+import { TradeType } from './enums/TradeType';
 /**
  * Options for producing the arguments to send call to the router.
  */
@@ -46,6 +50,7 @@ export interface SwapParameters {
      */
     value: string;
 }
+export declare function toHex(currencyAmount: CurrencyAmount<Currency>): string;
 /**
  * Represents the Uniswap V2 Router, and has static methods for helping execute trades.
  */
@@ -59,5 +64,5 @@ export declare abstract class Router {
      * @param trade to produce call parameters for
      * @param options options for the call parameters
      */
-    static swapCallParameters(trade: Trade, options: TradeOptions | TradeOptionsDeadline): SwapParameters;
+    static swapCallParameters(trade: Trade<Currency, Currency, TradeType>, options: TradeOptions | TradeOptionsDeadline): SwapParameters;
 }

package/dist/types/AddressMap.d.ts

@@ -0,0 +1,3 @@
+export declare type AddressMap = {
+    [chainId: number]: string;
+};

package/dist/types/BigIntIsh.d.ts

@@ -0,0 +1,2 @@
+import JSBI from 'jsbi';
+export declare type BigintIsh = JSBI | number | string;

package/dist/types/ChainTokenMap.d.ts

@@ -0,0 +1,5 @@
+import { ChainId } from 'enums';
+import { Token } from 'entities';
+export declare type ChainTokenMap = {
+    readonly [chainId in ChainId]?: Token;
+};

package/dist/types/LimitOrderTypes.d.ts

@@ -0,0 +1,21 @@
+export declare const types: {
+    EIP712Domain: {
+        name: string;
+        type: string;
+    }[];
+    LimitOrder: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const bentoTypes: {
+    EIP712Domain: {
+        name: string;
+        type: string;
+    }[];
+    SetMasterContractApproval: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const name = "LimitOrder";

package/dist/types/MultiRouterTypes.d.ts

@@ -0,0 +1,97 @@
+import { BigNumber } from '@ethersproject/bignumber';
+export interface RToken {
+    name: string;
+    address: string;
+}
+export declare enum PoolType {
+    ConstantProduct = "ConstantProduct",
+    Weighted = "Weighted",
+    Hybrid = "Hybrid",
+    ConcentratedLiquidity = "ConcentratedLiquidity"
+}
+export interface PoolInfo {
+    address: string;
+    token0: RToken;
+    token1: RToken;
+    type: PoolType;
+    reserve0: BigNumber;
+    reserve1: BigNumber;
+    fee: number;
+    minLiquidity: number;
+    swapGasCost: number;
+}
+declare type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+declare type PoolInfoWithDefaults = PartialBy<PoolInfo, 'minLiquidity' | 'swapGasCost'>;
+export declare class Pool {
+    address: string;
+    token0: RToken;
+    token1: RToken;
+    type: PoolType;
+    reserve0: BigNumber;
+    reserve1: BigNumber;
+    fee: number;
+    minLiquidity: number;
+    swapGasCost: number;
+    constructor(_info: PoolInfoWithDefaults);
+}
+declare type PoolInfoNoType = Omit<PoolInfoWithDefaults, 'type'>;
+export declare class RConstantProductPool extends Pool {
+    constructor(info: PoolInfoNoType);
+}
+declare type HybridPoolInfo = PoolInfoNoType & {
+    A: number;
+};
+export declare class RHybridPool extends Pool {
+    A: number;
+    constructor(info: HybridPoolInfo);
+}
+declare type WeightedPoolInfo = PoolInfoNoType & {
+    weight0: number;
+    weight1: number;
+};
+export declare class RWeightedPool extends Pool {
+    weight0: number;
+    weight1: number;
+    constructor(info: WeightedPoolInfo);
+}
+export declare const CL_MIN_TICK = -887272;
+export declare const CL_MAX_TICK: number;
+interface CLTick {
+    index: number;
+    DLiquidity: number;
+}
+interface CLSpecific {
+    liquidity: number;
+    sqrtPrice: number;
+    nearestTick: number;
+    ticks: CLTick[];
+}
+declare type CLPoolInfo = Omit<PoolInfoNoType, 'reserve0' | 'reserve1'> & CLSpecific;
+export declare class RConcentratedLiquidityPool extends Pool {
+    liquidity: number;
+    sqrtPrice: number;
+    nearestTick: number;
+    ticks: CLTick[];
+    constructor(info: CLPoolInfo);
+}
+export interface RouteLeg {
+    address: string;
+    token: RToken;
+    swapPortion: number;
+    absolutePortion: number;
+}
+export declare enum RouteStatus {
+    Success = "Success",
+    NoWay = "NoWay",
+    Partial = "Partial"
+}
+export interface MultiRoute {
+    status: RouteStatus;
+    amountIn: number;
+    amountOut: number;
+    legs: RouteLeg[];
+    gasSpent: number;
+    totalAmountOut: number;
+}
+export {};

package/dist/types/TokenMap.d.ts

@@ -0,0 +1,4 @@
+import { Token } from '../entities';
+export declare type TokenMap = {
+    [chainId: number]: Token;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './BigIntIsh';
+export * from './MultiRouterTypes';
+export * from './LimitOrderTypes';
+export * from './AddressMap';

package/dist/utils/MultiRouterMath.d.ts

@@ -0,0 +1,15 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { Pool, RHybridPool } from '../types/MultiRouterTypes';
+export declare function HybridComputeLiquidity(pool: RHybridPool): BigNumber;
+export declare function HybridgetY(pool: RHybridPool, x: BigNumber): BigNumber;
+export declare function calcOutByIn(pool: Pool, amountIn: number, direction?: boolean): number;
+export declare class OutOfLiquidity extends Error {
+}
+export declare function calcInByOut(pool: Pool, amountOut: number, direction: boolean): number;
+export declare function calcPrice(pool: Pool, amountIn: number, takeFeeIntoAccount?: boolean): number;
+export declare function calcInputByPrice(pool: Pool, priceEffective: number, hint?: number): number;
+export declare function ASSERT(f: () => boolean, t?: string): void;
+export declare function closeValues(a: number, b: number, accuracy: number): boolean;
+export declare function calcSquareEquation(a: number, b: number, c: number): [number, number];
+export declare function revertPositive(f: (x: number) => number, out: number, hint?: number): number;
+export declare function getBigNumber(valueBN: BigNumber | undefined, value: number): BigNumber;

package/package.json

@@ -1,56 +1,82 @@
 {
   "name": "@qidao/sdk",
   "license": "MIT",
-  "version": "5.0.6",
+  "version": "5.0.9",
   "description": "🛠 An SDK for building applications on top of QiDao Protocol.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
     "dist"
   ],
-  "repository": "https://github.com/royalaid/sushiswap-sdk",
-  "keywords": [],
-  "module": "dist/sushiswap-sdk.esm.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/publu/qidao-sdk.git"
+  },
+  "keywords": [
+    "qidao",
+    "mai",
+    "polygon",
+    "sdk"
+  ],
+  "module": "dist/sdk.esm.js",
   "scripts": {
     "lint": "tsdx lint src test",
     "build": "tsdx build",
-    "start": "tsdx watch",
+    "watch": "tsdx watch",
     "test": "tsdx test",
-    "prepublishOnly": "tsdx build"
+    "prepublish": "tsdx build",
+    "prepare": "husky install",
+    "prettier": "prettier --write 'src/**/*.ts' 'test/**/*.ts'"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": [
+      "yarn lint",
+      "yarn test --bail --passWithNoTests --findRelatedTests",
+      "prettier --write"
+    ],
+    "*.md": "prettier --write"
   },
   "dependencies": {
-    "@uniswap/v2-core": "^1.0.0",
-    "big.js": "^5.2.2",
+    "@ethersproject/abi": "^5.4.0",
+    "@ethersproject/abstract-signer": "^5.4.0",
+    "@ethersproject/address": "^5.4.0",
+    "@ethersproject/bignumber": "^5.4.0",
+    "@ethersproject/bytes": "^5.4.0",
+    "@ethersproject/contracts": "^5.4.0",
+    "@ethersproject/experimental": "^5.4.0",
+    "@ethersproject/networks": "^5.4.0",
+    "@ethersproject/providers": "^5.4.0",
+    "@ethersproject/signing-key": "^5.4.0",
+    "@ethersproject/solidity": "^5.4.0",
+    "@ethersproject/transactions": "^5.4.0",
+    "@sushiswap/core": "^2.0.0-canary.1",
+    "big.js": "^6.1.0",
     "decimal.js-light": "^2.5.0",
-    "jsbi": "^3.1.1",
+    "eip-712": "^0.4.3",
+    "isomorphic-unfetch": "^3.1.0",
+    "jsbi": "^4.1.0",
     "tiny-invariant": "^1.1.0",
     "tiny-warning": "^1.0.3",
     "toformat": "^2.0.0"
   },
-  "peerDependencies": {
-    "@ethersproject/address": "^5.0.0-beta",
-    "@ethersproject/contracts": "^5.0.0-beta",
-    "@ethersproject/networks": "^5.0.0-beta",
-    "@ethersproject/providers": "^5.0.0-beta",
-    "@ethersproject/solidity": "^5.0.0-beta"
-  },
   "devDependencies": {
-    "@ethersproject/address": "^5.0.2",
-    "@ethersproject/contracts": "^5.0.2",
-    "@ethersproject/networks": "^5.0.2",
-    "@ethersproject/providers": "^5.0.5",
-    "@ethersproject/solidity": "^5.0.2",
-    "@types/big.js": "^4.0.5",
-    "@types/jest": "^24.0.25",
-    "babel-plugin-transform-jsbi-to-bigint": "^1.3.1",
-    "tsdx": "^0.12.3"
+    "@sushiswap/prettier-config": "^0.1.0",
+    "@types/big.js": "^6.1.0",
+    "babel-plugin-transform-jsbi-to-bigint": "^1.4.0",
+    "husky": "^7.0.0",
+    "lint-staged": "^11.1.2",
+    "prettier": "^2.4.1",
+    "tsdx": "^0.14.1"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=14"
+  },
+  "bugs": {
+    "url": "https://github.com/publu/qidao-sdk/issues"
+  },
+  "homepage": "https://github.com/publu/qidao-sdk#readme",
+  "directories": {
+    "test": "test"
   },
-  "prettier": {
-    "printWidth": 120,
-    "semi": false,
-    "singleQuote": true
-  }
+  "author": "Pablo"
 }

package/dist/constants.d.ts

@@ -1,86 +0,0 @@
-import JSBI from 'jsbi';
-export declare type BigintIsh = JSBI | bigint | string;
-export declare enum ChainId {
-    MAINNET = 1,
-    ROPSTEN = 3,
-    RINKEBY = 4,
-    GÖRLI = 5,
-    KOVAN = 42,
-    MATIC = 137,
-    MATIC_TESTNET = 80001,
-    FANTOM = 250,
-    FANTOM_TESTNET = 4002,
-    XDAI = 100,
-    BSC = 56,
-    BSC_TESTNET = 97,
-    ARBITRUM = 42161,
-    MOONBASE = 1287,
-    AVALANCHE = 43114,
-    FUJI = 43113,
-    HECO = 128,
-    HECO_TESTNET = 256,
-    HARMONY = 1666600000,
-    HARMONY_TESTNET = 1666700000,
-    MOONRIVER = 1285,
-    CRONOS = 25,
-    OPTIMISM = 10,
-    SYSCOIN = 57,
-    METIS = 1088,
-    MOONBEAM = 1284,
-    MILKOMEDA = 2001,
-    KAVA = 2222,
-    IOTEX = 4689,
-    KLAYTN = 8217,
-    CELO = 42220,
-    AURORA = 1313161554,
-    BOBA = 288
-}
-export declare enum TradeType {
-    EXACT_INPUT = 0,
-    EXACT_OUTPUT = 1
-}
-export declare enum Rounding {
-    ROUND_DOWN = 0,
-    ROUND_HALF_UP = 1,
-    ROUND_UP = 2
-}
-export declare const INIT_CODE_HASH: string;
-export declare const FACTORY_ADDRESS: {
-    [chainId in ChainId]: string;
-};
-export declare const ROUTER_ADDRESS: {
-    [chainId in ChainId]: string;
-};
-export declare const SUSHI_ADDRESS: {
-    [chainId in ChainId]: string;
-};
-export declare const MASTERCHEF_ADDRESS: {
-    [chainId in ChainId]: string;
-};
-export declare const BAR_ADDRESS: {
-    [chainId in ChainId]: string;
-};
-export declare const MAKER_ADDRESS: {
-    [chainId in ChainId]: string;
-};
-export declare const TIMELOCK_ADDRESS: {
-    [chainId in ChainId]: string;
-};
-export declare const MINIMUM_LIQUIDITY: JSBI;
-export declare const ZERO: JSBI;
-export declare const ONE: JSBI;
-export declare const TWO: JSBI;
-export declare const THREE: JSBI;
-export declare const FIVE: JSBI;
-export declare const TEN: JSBI;
-export declare const _100: JSBI;
-export declare const _997: JSBI;
-export declare const _1000: JSBI;
-export declare enum SolidityType {
-    uint8 = "uint8",
-    uint256 = "uint256"
-}
-export declare const SOLIDITY_TYPE_MAXIMA: {
-    uint8: JSBI;
-    uint256: JSBI;
-};

package/dist/entities/currency.d.ts

@@ -1,81 +0,0 @@
-import { ChainId } from '../constants';
-/**
- * A currency is any fungible financial instrument on Ethereum, including Ether and all ERC20 tokens.
- *
- * The only instance of the base class `Currency` is Ether.
- */
-export declare class Currency {
-    readonly decimals: number;
-    readonly symbol?: string;
-    readonly name?: string;
-    static readonly ETHER: Currency;
-    static readonly BNB: Currency;
-    static readonly FTM: Currency;
-    static readonly MATIC: Currency;
-    static readonly XDAI: Currency;
-    static readonly GLMR: Currency;
-    static readonly AVAX: Currency;
-    static readonly HT: Currency;
-    static readonly ONE: Currency;
-    static readonly MOVR: Currency;
-    static readonly CRO: Currency;
-    static readonly SYSCOIN: Currency;
-    static readonly METIS: Currency;
-    static readonly MOONBEAM: Currency;
-    static readonly MILKOMEDA: Currency;
-    static readonly KAVA: Currency;
-    static readonly IOTEX: Currency;
-    static readonly KLAYTN: Currency;
-    static readonly CELO: Currency;
-    static readonly AURORA: Currency;
-    static readonly BOBA: Currency;
-    static readonly NATIVE: {
-        1: Currency;
-        3: Currency;
-        4: Currency;
-        5: Currency;
-        42: Currency;
-        250: Currency;
-        4002: Currency;
-        137: Currency;
-        80001: Currency;
-        100: Currency;
-        56: Currency;
-        97: Currency;
-        42161: Currency;
-        1287: Currency;
-        43114: Currency;
-        43113: Currency;
-        128: Currency;
-        256: Currency;
-        1666600000: Currency;
-        1666700000: Currency;
-        25: Currency;
-        1285: Currency;
-        10: Currency;
-        57: Currency;
-        1088: Currency;
-        1284: Currency;
-        2001: Currency;
-        2222: Currency;
-        4689: Currency;
-        8217: Currency;
-        42220: Currency;
-        1313161554: Currency;
-        288: Currency;
-    };
-    /**
-     * Constructs an instance of the base class `Currency`. The only instance of the base class `Currency` is `Currency.ETHER`.
-     * @param decimals decimals of the currency
-     * @param symbol symbol of the currency
-     * @param name of the currency
-     */
-    protected constructor(decimals: number, symbol?: string, name?: string);
-    static getNativeCurrency(chainId?: ChainId): Currency;
-    static getNativeCurrencySymbol(chainId?: ChainId): string | undefined;
-    static getNativeCurrencyName(chainId?: ChainId): string | undefined;
-    getSymbol(chainId?: ChainId): string | undefined;
-    getName(chainId?: ChainId): string | undefined;
-}
-declare const ETHER: Currency;
-export { ETHER };

package/dist/entities/fractions/currencyAmount.d.ts

@@ -1,19 +0,0 @@
-import { Currency } from '../currency';
-import JSBI from 'jsbi';
-import { BigintIsh, Rounding } from '../../constants';
-import { Fraction } from './fraction';
-export declare class CurrencyAmount extends Fraction {
-    readonly currency: Currency;
-    /**
-     * Helper that calls the constructor with the ETHER currency
-     * @param amount ether amount in wei
-     */
-    static ether(amount: BigintIsh): CurrencyAmount;
-    protected constructor(currency: Currency, amount: BigintIsh);
-    get raw(): JSBI;
-    add(other: CurrencyAmount): CurrencyAmount;
-    subtract(other: CurrencyAmount): CurrencyAmount;
-    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
-    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
-    toExact(format?: object): string;
-}

package/dist/entities/fractions/index.d.ts

@@ -1,5 +0,0 @@
-export * from './fraction';
-export * from './percent';
-export * from './tokenAmount';
-export * from './currencyAmount';
-export * from './price';

package/dist/entities/fractions/percent.d.ts

@@ -1,6 +0,0 @@
-import { Rounding } from '../../constants';
-import { Fraction } from './fraction';
-export declare class Percent extends Fraction {
-    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
-    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
-}

package/dist/entities/fractions/price.d.ts

@@ -1,19 +0,0 @@
-import { BigintIsh, Rounding } from '../../constants';
-import { Currency } from '../currency';
-import { Route } from '../route';
-import { Fraction } from './fraction';
-import { CurrencyAmount } from './currencyAmount';
-export declare class Price extends Fraction {
-    readonly baseCurrency: Currency;
-    readonly quoteCurrency: Currency;
-    readonly scalar: Fraction;
-    static fromRoute(route: Route): Price;
-    constructor(baseCurrency: Currency, quoteCurrency: Currency, denominator: BigintIsh, numerator: BigintIsh);
-    get raw(): Fraction;
-    get adjusted(): Fraction;
-    invert(): Price;
-    multiply(other: Price): Price;
-    quote(currencyAmount: CurrencyAmount): CurrencyAmount;
-    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
-    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
-}

package/dist/entities/fractions/tokenAmount.d.ts

@@ -1,9 +0,0 @@
-import { CurrencyAmount } from './currencyAmount';
-import { Token } from '../token';
-import { BigintIsh } from '../../constants';
-export declare class TokenAmount extends CurrencyAmount {
-    readonly token: Token;
-    constructor(token: Token, amount: BigintIsh);
-    add(other: TokenAmount): TokenAmount;
-    subtract(other: TokenAmount): TokenAmount;
-}

package/dist/entities/pair.d.ts

@@ -1,41 +0,0 @@
-import { Price } from './fractions/price';
-import { TokenAmount } from './fractions/tokenAmount';
-import { BigintIsh, ChainId } from '../constants';
-import { Token } from './token';
-export declare class Pair {
-    readonly liquidityToken: Token;
-    private readonly tokenAmounts;
-    static getAddress(tokenA: Token, tokenB: Token): string;
-    constructor(tokenAmountA: TokenAmount, tokenAmountB: TokenAmount);
-    /**
-     * Returns true if the token is either token0 or token1
-     * @param token to check
-     */
-    involvesToken(token: Token): boolean;
-    /**
-     * Returns the current mid price of the pair in terms of token0, i.e. the ratio of reserve1 to reserve0
-     */
-    get token0Price(): Price;
-    /**
-     * Returns the current mid price of the pair in terms of token1, i.e. the ratio of reserve0 to reserve1
-     */
-    get token1Price(): Price;
-    /**
-     * Return the price of the given token in terms of the other token in the pair.
-     * @param token token to return price of
-     */
-    priceOf(token: Token): Price;
-    /**
-     * Returns the chain ID of the tokens in the pair.
-     */
-    get chainId(): ChainId;
-    get token0(): Token;
-    get token1(): Token;
-    get reserve0(): TokenAmount;
-    get reserve1(): TokenAmount;
-    reserveOf(token: Token): TokenAmount;
-    getOutputAmount(inputAmount: TokenAmount): [TokenAmount, Pair];
-    getInputAmount(outputAmount: TokenAmount): [TokenAmount, Pair];
-    getLiquidityMinted(totalSupply: TokenAmount, tokenAmountA: TokenAmount, tokenAmountB: TokenAmount): TokenAmount;
-    getLiquidityValue(token: Token, totalSupply: TokenAmount, liquidity: TokenAmount, feeOn?: boolean, kLast?: BigintIsh): TokenAmount;
-}

package/dist/entities/route.d.ts

@@ -1,14 +0,0 @@
-import { ChainId } from '../constants';
-import { Currency } from './currency';
-import { Token } from './token';
-import { Pair } from './pair';
-import { Price } from './fractions/price';
-export declare class Route {
-    readonly pairs: Pair[];
-    readonly path: Token[];
-    readonly input: Currency;
-    readonly output: Currency;
-    readonly midPrice: Price;
-    constructor(pairs: Pair[], input: Currency, output?: Currency);
-    get chainId(): ChainId;
-}

package/dist/fetcher.d.ts

@@ -1,28 +0,0 @@
-import { Pair } from './entities/pair';
-import { ChainId } from './constants';
-import { Token } from './entities/token';
-/**
- * Contains methods for constructing instances of pairs and tokens from on-chain data.
- */
-export declare abstract class Fetcher {
-    /**
-     * Cannot be constructed.
-     */
-    private constructor();
-    /**
-     * Fetch information for a given token on the given chain, using the given ethers provider.
-     * @param chainId chain of the token
-     * @param address address of the token on the chain
-     * @param provider provider used to fetch the token
-     * @param symbol optional symbol of the token
-     * @param name optional name of the token
-     */
-    static fetchTokenData(chainId: ChainId, address: string, provider?: import("@ethersproject/providers").BaseProvider, symbol?: string, name?: string): Promise<Token>;
-    /**
-     * Fetches information about a pair and constructs a pair from the given two tokens.
-     * @param tokenA first token
-     * @param tokenB second token
-     * @param provider the provider to use to fetch the data
-     */
-    static fetchPairData(tokenA: Token, tokenB: Token, provider?: import("@ethersproject/providers").BaseProvider): Promise<Pair>;
-}