@qidao/sdk 5.0.8 → 5.1.0

package/dist/src/src/vaultInfo.d.ts

@@ -0,0 +1,27 @@
+import { Provider } from "@ethersproject/providers";
+import { Signer } from 'ethers';
+import { CrosschainNativeQiStablecoin, CrosschainQiStablecoin, CrosschainQiStablecoinSlim, CrosschainQiStablecoinSlimV2, CrosschainQiStablecoinV2, CrosschainQiStablecoinwbtc, Erc20QiStablecoincamwbtc, Erc20QiStablecoinwbtc, Erc20Stablecoin, StableQiVault } from "./contracts";
+import { Token } from './entities';
+import ERC20_STABLECOIN from './abis/toGenerate/erc20Stablecoin.json';
+import STABLE_QI_VAULT from './abis/toGenerate/stableQiVault.json';
+import { ChainId } from "./constants";
+export declare type VaultContractAbi = typeof ERC20_STABLECOIN | typeof STABLE_QI_VAULT;
+export default interface COLLATERAL {
+    aaveId?: string;
+    connect(address: string, signerOrProvider: Signer | Provider): Erc20Stablecoin | Erc20QiStablecoinwbtc | Erc20QiStablecoincamwbtc | StableQiVault | CrosschainQiStablecoin | CrosschainNativeQiStablecoin | CrosschainQiStablecoinV2 | CrosschainQiStablecoinSlim | CrosschainQiStablecoinSlimV2 | CrosschainQiStablecoinwbtc;
+    chainId: ChainId;
+    depreciated?: boolean;
+    infoUrl?: string;
+    minimumCDR: number;
+    native?: boolean;
+    subgraph?: string;
+    token: Token;
+    vaultAddress: string;
+}
+export interface COLLATERAL_V2 extends COLLATERAL {
+    contractAbi: VaultContractAbi;
+}
+export declare function isV2QiVault(collateral: COLLATERAL | COLLATERAL_V2): collateral is COLLATERAL_V2;
+export declare const COLLATERALS: {
+    [chainId in ChainId]?: (COLLATERAL | COLLATERAL_V2)[];
+};

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,52 +1,60 @@
 {
   "name": "@qidao/sdk",
   "license": "MIT",
-  "version": "5.0.8",
+  "version": "5.1.0",
   "description": "🛠 An SDK for building applications on top of QiDao Protocol.",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "umd:main": "dist/index.umd.js",
+  "source": "./src/index.ts",
+  "exports": {
+    "require": "./dist/index.js",
+    "default": "./dist/index.modern.js"
+  },
+  "module": "./dist/index.module.js",
+  "unpkg": "./dist/index.umd.js",
+  "types": "./dist/src/index.d.ts",
   "files": [
     "dist"
   ],
   "repository": "https://github.com/royalaid/sushiswap-sdk",
   "keywords": [],
-  "module": "dist/sushiswap-sdk.esm.js",
   "scripts": {
-    "lint": "tsdx lint src test",
-    "build": "tsdx build",
-    "start": "tsdx watch",
-    "test": "tsdx test",
-    "prepublishOnly": "tsdx build"
+    "build": "microbundle",
+    "start": "microbundle watch",
+    "prepublishOnly": "microbundle",
+    "postinstall": "typechain  --discriminate-types --target ethers-v5 --out-dir src/contracts \"src/abis/toGenerate/**/*.json\""
   },
   "dependencies": {
-    "@uniswap/v2-core": "^1.0.0",
-    "big.js": "^5.2.2",
-    "decimal.js-light": "^2.5.0",
-    "jsbi": "^3.1.1",
-    "tiny-invariant": "^1.1.0",
-    "tiny-warning": "^1.0.3",
-    "toformat": "^2.0.0"
+    "big.js": "5.2.2",
+    "decimal.js-light": "2.5.1",
+    "ethers": "5.6.9",
+    "jsbi": "3.2.5",
+    "tiny-invariant": "1.2.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"
+    "@ethersproject/address": "5.6.1",
+    "@ethersproject/contracts": "5.6.2",
+    "@ethersproject/networks": "5.6.4",
+    "@ethersproject/providers": "5.6.8",
+    "@ethersproject/solidity": "5.6.1"
   },
   "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"
+    "@ethersproject/address": "5.6.1",
+    "@ethersproject/contracts": "5.6.2",
+    "@ethersproject/networks": "5.6.4",
+    "@ethersproject/providers": "5.6.8",
+    "@ethersproject/solidity": "5.6.1",
+    "@typechain/ethers-v5": "10.1.0",
+    "@types/big.js": "4.0.5",
+    "@types/jest": "28.1.6",
+    "microbundle": "0.15.1",
+    "typechain": "8.1.0",
+    "typescript": "4.7.4"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">= 16"
   },
   "prettier": {
     "printWidth": 120,

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>;
-}

package/dist/test/constants.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/data.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/entities.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/miscellaneous.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/pair.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/route.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/router.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/trade.test.d.ts

@@ -1 +0,0 @@
-export {};