@pancakeswap/sdk 3.2.0 → 4.0.0

package/README.md

@@ -6,7 +6,7 @@ You can refer to the Uniswap SDK documentation [uniswap.org](https://docs.uniswa
 
 ## Running tests
 
-To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.
+To run the tests, follow these steps. You must have at least node v10 and [pnpm](https://pnpm.io) installed.
 
 First clone the repository:
 
@@ -23,19 +23,19 @@ cd pancakeswap-sdk/
 Install dependencies
 
 ```sh
-yarn install
+pnpm install
 ```
 
 Run tests
 
 ```sh
-yarn test
+pnpm test
 ```
 
 You should see output like the following:
 
 ```sh
-yarn run v1.22.4
+pnpm run v1.22.4
 $ tsdx test
  PASS  test/constants.test.ts
  PASS  test/pair.test.ts

package/dist/constants.d.ts

@@ -0,0 +1,32 @@
+import { Percent } from '@pancakeswap/swap-sdk-core';
+import { ERC20Token } from './entities/token';
+export declare enum ChainId {
+    ETHEREUM = 1,
+    GOERLI = 5,
+    BSC = 56,
+    BSC_TESTNET = 97
+}
+export declare const ZERO_PERCENT: Percent;
+export declare const ONE_HUNDRED_PERCENT: Percent;
+export declare const FACTORY_ADDRESS = "0xcA143Ce32Fe78f1f7019d7d551a6402fC5350c73";
+export declare const FACTORY_ADDRESS_MAP: Record<number, string>;
+export declare const INIT_CODE_HASH = "0x00fb7f630766e6a796048ea87d01acd3068e8ff67d078148a3fa3f4a84f69bd5";
+export declare const INIT_CODE_HASH_MAP: Record<number, string>;
+export declare const WETH9: {
+    1: ERC20Token;
+    5: ERC20Token;
+    56: ERC20Token;
+    97: ERC20Token;
+};
+export declare const WBNB: {
+    1: ERC20Token;
+    56: ERC20Token;
+    97: ERC20Token;
+};
+export declare const WNATIVE: Record<number, ERC20Token>;
+export declare const NATIVE: Record<number, {
+    name: string;
+    symbol: string;
+    decimals: number;
+}>;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C,oBAAY,OAAO;IACjB,QAAQ,IAAI;IACZ,MAAM,IAAI;IACV,GAAG,KAAK;IACR,WAAW,KAAK;CACjB;AAED,eAAO,MAAM,YAAY,SAAmB,CAAA;AAC5C,eAAO,MAAM,mBAAmB,SAAmB,CAAA;AAEnD,eAAO,MAAM,eAAe,+CAA+C,CAAA;AAI3E,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAKtD,CAAA;AACD,eAAO,MAAM,cAAc,uEAAuE,CAAA;AAGlG,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAKrD,CAAA;AAED,eAAO,MAAM,KAAK;;;;;CAiCjB,CAAA;AAED,eAAO,MAAM,IAAI;;;;CAyBhB,CAAA;AAED,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAK9C,CAAA;AAED,eAAO,MAAM,MAAM,EAAE,MAAM,CACzB,MAAM,EACN;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAcF,CAAA"}

package/dist/entities/index.d.ts

@@ -0,0 +1,6 @@
+export { ERC20Token } from './token';
+export * from './pair';
+export * from './route';
+export * from './trade';
+export * from './native';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/entities/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA"}

package/dist/entities/native.d.ts

@@ -0,0 +1,18 @@
+import { Currency, Token, NativeCurrency } from '@pancakeswap/swap-sdk-core';
+/**
+ *
+ * Native is the main usage of a 'native' currency, i.e. for BSC mainnet and all testnets
+ */
+export declare class Native extends NativeCurrency {
+    protected constructor({ chainId, decimals, name, symbol, }: {
+        chainId: number;
+        decimals: number;
+        symbol: string;
+        name: string;
+    });
+    get wrapped(): Token;
+    private static cache;
+    static onChain(chainId: number): Native;
+    equals(other: Currency): boolean;
+}
+//# sourceMappingURL=native.d.ts.map

package/dist/entities/native.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"native.d.ts","sourceRoot":"","sources":["../../src/entities/native.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAG5E;;;GAGG;AACH,qBAAa,MAAO,SAAQ,cAAc;IACxC,SAAS,aAAa,EACpB,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,MAAM,GACP,EAAE;QACD,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,EAAE,MAAM,CAAA;KACb;IAID,IAAW,OAAO,IAAI,KAAK,CAI1B;IAED,OAAO,CAAC,MAAM,CAAC,KAAK,CAAoC;WAE1C,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IASvC,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;CAGxC"}

package/dist/entities/pair.d.ts

@@ -0,0 +1,45 @@
+import { CurrencyAmount, Price, BigintIsh } from '@pancakeswap/swap-sdk-core';
+import { ERC20Token } from './token';
+export declare const computePairAddress: ({ factoryAddress, tokenA, tokenB, }: {
+    factoryAddress: string;
+    tokenA: ERC20Token;
+    tokenB: ERC20Token;
+}) => string;
+export declare class Pair {
+    readonly liquidityToken: ERC20Token;
+    private readonly tokenAmounts;
+    static getAddress(tokenA: ERC20Token, tokenB: ERC20Token): string;
+    constructor(currencyAmountA: CurrencyAmount<ERC20Token>, tokenAmountB: CurrencyAmount<ERC20Token>);
+    /**
+     * Returns true if the token is either token0 or token1
+     * @param token to check
+     */
+    involvesToken(token: ERC20Token): boolean;
+    /**
+     * Returns the current mid price of the pair in terms of token0, i.e. the ratio of reserve1 to reserve0
+     */
+    get token0Price(): Price<ERC20Token, ERC20Token>;
+    /**
+     * Returns the current mid price of the pair in terms of token1, i.e. the ratio of reserve0 to reserve1
+     */
+    get token1Price(): Price<ERC20Token, ERC20Token>;
+    /**
+     * 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: ERC20Token): Price<ERC20Token, ERC20Token>;
+    /**
+     * Returns the chain ID of the tokens in the pair.
+     */
+    get chainId(): number;
+    get token0(): ERC20Token;
+    get token1(): ERC20Token;
+    get reserve0(): CurrencyAmount<ERC20Token>;
+    get reserve1(): CurrencyAmount<ERC20Token>;
+    reserveOf(token: ERC20Token): CurrencyAmount<ERC20Token>;
+    getOutputAmount(inputAmount: CurrencyAmount<ERC20Token>): [CurrencyAmount<ERC20Token>, Pair];
+    getInputAmount(outputAmount: CurrencyAmount<ERC20Token>): [CurrencyAmount<ERC20Token>, Pair];
+    getLiquidityMinted(totalSupply: CurrencyAmount<ERC20Token>, tokenAmountA: CurrencyAmount<ERC20Token>, tokenAmountB: CurrencyAmount<ERC20Token>): CurrencyAmount<ERC20Token>;
+    getLiquidityValue(token: ERC20Token, totalSupply: CurrencyAmount<ERC20Token>, liquidity: CurrencyAmount<ERC20Token>, feeOn?: boolean, kLast?: BigintIsh): CurrencyAmount<ERC20Token>;
+}
+//# sourceMappingURL=pair.d.ts.map

package/dist/entities/pair.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pair.d.ts","sourceRoot":"","sources":["../../src/entities/pair.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,cAAc,EACd,KAAK,EAML,SAAS,EAEV,MAAM,4BAA4B,CAAA;AAMnC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAMpC,eAAO,MAAM,kBAAkB;oBAKb,MAAM;YACd,UAAU;YACV,UAAU;MAChB,MAgBH,CAAA;AAED,qBAAa,IAAI;IACf,SAAgB,cAAc,EAAE,UAAU,CAAA;IAE1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA0D;WAEzE,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,GAAG,MAAM;gBAIrD,eAAe,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,YAAY,EAAE,cAAc,CAAC,UAAU,CAAC;IAcxG;;;OAGG;IACI,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO;IAIhD;;OAEG;IACH,IAAW,WAAW,IAAI,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC,CAGtD;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC,CAGtD;IAED;;;OAGG;IACI,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC;IAKhE;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED,IAAW,MAAM,IAAI,UAAU,CAE9B;IAED,IAAW,MAAM,IAAI,UAAU,CAE9B;IAED,IAAW,QAAQ,IAAI,cAAc,CAAC,UAAU,CAAC,CAEhD;IAED,IAAW,QAAQ,IAAI,cAAc,CAAC,UAAU,CAAC,CAEhD;IAEM,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;IAKxD,eAAe,CAAC,WAAW,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC;IAoB5F,cAAc,CAAC,YAAY,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC;IAqB5F,kBAAkB,CACvB,WAAW,EAAE,cAAc,CAAC,UAAU,CAAC,EACvC,YAAY,EAAE,cAAc,CAAC,UAAU,CAAC,EACxC,YAAY,EAAE,cAAc,CAAC,UAAU,CAAC,GACvC,cAAc,CAAC,UAAU,CAAC;IAqBtB,iBAAiB,CACtB,KAAK,EAAE,UAAU,EACjB,WAAW,EAAE,cAAc,CAAC,UAAU,CAAC,EACvC,SAAS,EAAE,cAAc,CAAC,UAAU,CAAC,EACrC,KAAK,UAAQ,EACb,KAAK,CAAC,EAAE,SAAS,GAChB,cAAc,CAAC,UAAU,CAAC;CAiC9B"}

package/dist/entities/route.d.ts

@@ -0,0 +1,13 @@
+import { Token, Currency, Price } from '@pancakeswap/swap-sdk-core';
+import { Pair } from './pair';
+export declare class Route<TInput extends Currency, TOutput extends Currency> {
+    readonly pairs: Pair[];
+    readonly path: Token[];
+    readonly input: TInput;
+    readonly output: TOutput;
+    constructor(pairs: Pair[], input: TInput, output: TOutput);
+    private _midPrice;
+    get midPrice(): Price<TInput, TOutput>;
+    get chainId(): number;
+}
+//# sourceMappingURL=route.d.ts.map

package/dist/entities/route.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.d.ts","sourceRoot":"","sources":["../../src/entities/route.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAEnE,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7B,qBAAa,KAAK,CAAC,MAAM,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ;IAClE,SAAgB,KAAK,EAAE,IAAI,EAAE,CAAA;IAE7B,SAAgB,IAAI,EAAE,KAAK,EAAE,CAAA;IAE7B,SAAgB,KAAK,EAAE,MAAM,CAAA;IAE7B,SAAgB,MAAM,EAAE,OAAO,CAAA;gBAEZ,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO;IA2BhE,OAAO,CAAC,SAAS,CAAsC;IAEvD,IAAW,QAAQ,IAAI,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAa5C;IAED,IAAW,OAAO,IAAI,MAAM,CAE3B;CACF"}

package/dist/entities/token.d.ts

@@ -0,0 +1,13 @@
+import { Token } from '@pancakeswap/swap-sdk-core';
+export interface SerializedToken {
+    chainId: number;
+    address: string;
+    decimals: number;
+    symbol: string;
+    name?: string;
+    projectLink?: string;
+}
+export declare class ERC20Token extends Token {
+    constructor(chainId: number, address: string, decimals: number, symbol: string, name?: string, projectLink?: string);
+}
+//# sourceMappingURL=token.d.ts.map

package/dist/entities/token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../src/entities/token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAGlD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAKD,qBAAa,UAAW,SAAQ,KAAK;gBAEjC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,EACb,WAAW,CAAC,EAAE,MAAM;CAIvB"}

package/dist/entities/trade.d.ts

@@ -0,0 +1,104 @@
+import { TradeType, CurrencyAmount, Currency, Percent, Price } from '@pancakeswap/swap-sdk-core';
+import { Pair } from './pair';
+import { Route } from './route';
+interface InputOutput<TInput extends Currency, TOutput extends Currency> {
+    readonly inputAmount: CurrencyAmount<TInput>;
+    readonly outputAmount: CurrencyAmount<TOutput>;
+}
+export declare function inputOutputComparator<TInput extends Currency, TOutput extends Currency>(a: InputOutput<TInput, TOutput>, b: InputOutput<TInput, TOutput>): number;
+export declare function tradeComparator<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(a: Trade<TInput, TOutput, TTradeType>, b: Trade<TInput, TOutput, TTradeType>): number;
+export interface BestTradeOptions {
+    maxNumResults?: number;
+    maxHops?: number;
+}
+/**
+ * Represents a trade executed against a list of pairs.
+ * Does not account for slippage, i.e. trades that front run this trade and move the price.
+ */
+export declare class Trade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> {
+    /**
+     * The route of the trade, i.e. which pairs the trade goes through and the input/output currencies.
+     */
+    readonly route: Route<TInput, TOutput>;
+    /**
+     * The type of the trade, either exact in or exact out.
+     */
+    readonly tradeType: TTradeType;
+    /**
+     * The input amount for the trade assuming no slippage.
+     */
+    readonly inputAmount: CurrencyAmount<TInput>;
+    /**
+     * The output amount for the trade assuming no slippage.
+     */
+    readonly outputAmount: CurrencyAmount<TOutput>;
+    /**
+     * The price expressed in terms of output amount/input amount.
+     */
+    readonly executionPrice: Price<TInput, TOutput>;
+    /**
+     * The percent difference between the mid price before the trade and the trade execution price.
+     */
+    readonly priceImpact: Percent;
+    /**
+     * Constructs an exact in trade with the given amount in and route
+     * @param route route of the exact in trade
+     * @param amountIn the amount being passed in
+     */
+    static exactIn<TInput extends Currency, TOutput extends Currency>(route: Route<TInput, TOutput>, amountIn: CurrencyAmount<TInput>): Trade<TInput, TOutput, TradeType.EXACT_INPUT>;
+    /**
+     * Constructs an exact out trade with the given amount out and route
+     * @param route route of the exact out trade
+     * @param amountOut the amount returned by the trade
+     */
+    static exactOut<TInput extends Currency, TOutput extends Currency>(route: Route<TInput, TOutput>, amountOut: CurrencyAmount<TOutput>): Trade<TInput, TOutput, TradeType.EXACT_OUTPUT>;
+    constructor(route: Route<TInput, TOutput>, amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>, tradeType: TTradeType);
+    /**
+     * Get the minimum amount that must be received from this trade for the given slippage tolerance
+     * @param slippageTolerance tolerance of unfavorable slippage from the execution price of this trade
+     */
+    minimumAmountOut(slippageTolerance: Percent): CurrencyAmount<TOutput>;
+    /**
+     * Get the maximum amount in that can be spent via this trade for the given slippage tolerance
+     * @param slippageTolerance tolerance of unfavorable slippage from the execution price of this trade
+     */
+    maximumAmountIn(slippageTolerance: Percent): CurrencyAmount<TInput>;
+    /**
+     * Given a list of pairs, and a fixed amount in, returns the top `maxNumResults` trades that go from an input token
+     * amount to an output token, making at most `maxHops` hops.
+     * Note this does not consider aggregation, as routes are linear. It's possible a better route exists by splitting
+     * the amount in among multiple routes.
+     * @param pairs the pairs to consider in finding the best trade
+     * @param nextAmountIn exact amount of input currency to spend
+     * @param currencyOut the desired currency out
+     * @param maxNumResults maximum number of results to return
+     * @param maxHops maximum number of hops a returned trade can make, e.g. 1 hop goes through a single pair
+     * @param currentPairs used in recursion; the current list of pairs
+     * @param currencyAmountIn used in recursion; the original value of the currencyAmountIn parameter
+     * @param bestTrades used in recursion; the current list of best trades
+     */
+    static bestTradeExactIn<TInput extends Currency, TOutput extends Currency>(pairs: Pair[], currencyAmountIn: CurrencyAmount<TInput>, currencyOut: TOutput, { maxNumResults, maxHops }?: BestTradeOptions, currentPairs?: Pair[], nextAmountIn?: CurrencyAmount<Currency>, bestTrades?: Trade<TInput, TOutput, TradeType.EXACT_INPUT>[]): Trade<TInput, TOutput, TradeType.EXACT_INPUT>[];
+    /**
+     * Return the execution price after accounting for slippage tolerance
+     * @param slippageTolerance the allowed tolerated slippage
+     */
+    worstExecutionPrice(slippageTolerance: Percent): Price<TInput, TOutput>;
+    /**
+     * similar to the above method but instead targets a fixed output amount
+     * given a list of pairs, and a fixed amount out, returns the top `maxNumResults` trades that go from an input token
+     * to an output token amount, making at most `maxHops` hops
+     * note this does not consider aggregation, as routes are linear. it's possible a better route exists by splitting
+     * the amount in among multiple routes.
+     * @param pairs the pairs to consider in finding the best trade
+     * @param currencyIn the currency to spend
+     * @param nextAmountOut the exact amount of currency out
+     * @param maxNumResults maximum number of results to return
+     * @param maxHops maximum number of hops a returned trade can make, e.g. 1 hop goes through a single pair
+     * @param currentPairs used in recursion; the current list of pairs
+     * @param currencyAmountOut used in recursion; the original value of the currencyAmountOut parameter
+     * @param bestTrades used in recursion; the current list of best trades
+     */
+    static bestTradeExactOut<TInput extends Currency, TOutput extends Currency>(pairs: Pair[], currencyIn: TInput, currencyAmountOut: CurrencyAmount<TOutput>, { maxNumResults, maxHops }?: BestTradeOptions, currentPairs?: Pair[], nextAmountOut?: CurrencyAmount<Currency>, bestTrades?: Trade<TInput, TOutput, TradeType.EXACT_OUTPUT>[]): Trade<TInput, TOutput, TradeType.EXACT_OUTPUT>[];
+}
+export {};
+//# sourceMappingURL=trade.d.ts.map

package/dist/entities/trade.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trade.d.ts","sourceRoot":"","sources":["../../src/entities/trade.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,SAAS,EAET,cAAc,EACd,QAAQ,EAER,OAAO,EACP,KAAK,EAIN,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAG/B,UAAU,WAAW,CAAC,MAAM,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ;IACrE,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;IAC5C,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAC,OAAO,CAAC,CAAA;CAC/C;AAID,wBAAgB,qBAAqB,CAAC,MAAM,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ,EACrF,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,MAAM,CAmBR;AAGD,wBAAgB,eAAe,CAAC,MAAM,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ,EAAE,UAAU,SAAS,SAAS,EAC7G,CAAC,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,EACrC,CAAC,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,UAiBtC;AAED,MAAM,WAAW,gBAAgB;IAE/B,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;GAGG;AACH,qBAAa,KAAK,CAAC,MAAM,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ,EAAE,UAAU,SAAS,SAAS;IAChG;;OAEG;IACH,SAAgB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7C;;OAEG;IACH,SAAgB,SAAS,EAAE,UAAU,CAAA;IAErC;;OAEG;IACH,SAAgB,WAAW,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;IAEnD;;OAEG;IACH,SAAgB,YAAY,EAAE,cAAc,CAAC,OAAO,CAAC,CAAA;IAErD;;OAEG;IACH,SAAgB,cAAc,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEtD;;OAEG;IACH,SAAgB,WAAW,EAAE,OAAO,CAAA;IAEpC;;;;OAIG;WACW,OAAO,CAAC,MAAM,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ,EACrE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC,GAC/B,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC;IAIhD;;;;OAIG;WACW,QAAQ,CAAC,MAAM,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ,EACtE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,SAAS,EAAE,cAAc,CAAC,OAAO,CAAC,GACjC,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,YAAY,CAAC;gBAK/C,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,MAAM,EAAE,UAAU,SAAS,SAAS,CAAC,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,EACnG,SAAS,EAAE,UAAU;IA4CvB;;;OAGG;IACI,gBAAgB,CAAC,iBAAiB,EAAE,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;IAY5E;;;OAGG;IACI,eAAe,CAAC,iBAAiB,EAAE,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC;IAW1E;;;;;;;;;;;;;OAaG;WACW,gBAAgB,CAAC,MAAM,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ,EAC9E,KAAK,EAAE,IAAI,EAAE,EACb,gBAAgB,EAAE,cAAc,CAAC,MAAM,CAAC,EACxC,WAAW,EAAE,OAAO,EACpB,EAAE,aAAiB,EAAE,OAAW,EAAE,GAAE,gBAAqB,EAEzD,YAAY,GAAE,IAAI,EAAO,EACzB,YAAY,GAAE,cAAc,CAAC,QAAQ,CAAoB,EACzD,UAAU,GAAE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC,EAAO,GAC/D,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC,EAAE;IA6DlD;;;OAGG;IACI,mBAAmB,CAAC,iBAAiB,EAAE,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC;IAS9E;;;;;;;;;;;;;;OAcG;WACW,iBAAiB,CAAC,MAAM,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ,EAC/E,KAAK,EAAE,IAAI,EAAE,EACb,UAAU,EAAE,MAAM,EAClB,iBAAiB,EAAE,cAAc,CAAC,OAAO,CAAC,EAC1C,EAAE,aAAiB,EAAE,OAAW,EAAE,GAAE,gBAAqB,EAEzD,YAAY,GAAE,IAAI,EAAO,EACzB,aAAa,GAAE,cAAc,CAAC,QAAQ,CAAqB,EAC3D,UAAU,GAAE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,YAAY,CAAC,EAAO,GAChE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,YAAY,CAAC,EAAE;CA4DpD"}

package/dist/ether.d.ts

@@ -0,0 +1,12 @@
+import { Currency, NativeCurrency, Token } from '@pancakeswap/swap-sdk-core';
+/**
+ * Ether is the main usage of a 'native' currency, i.e. for Ethereum mainnet and all testnets
+ */
+export declare class Ether extends NativeCurrency {
+    protected constructor(chainId: number);
+    get wrapped(): Token;
+    private static _etherCache;
+    static onChain(chainId: number): Ether;
+    equals(other: Currency): boolean;
+}
+//# sourceMappingURL=ether.d.ts.map

package/dist/ether.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ether.d.ts","sourceRoot":"","sources":["../src/ether.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAG5E;;GAEG;AACH,qBAAa,KAAM,SAAQ,cAAc;IACvC,SAAS,aAAa,OAAO,EAAE,MAAM;IAIrC,IAAW,OAAO,IAAI,KAAK,CAM1B;IAED,OAAO,CAAC,MAAM,CAAC,WAAW,CAAmC;WAE/C,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK;IAQtC,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;CAGxC"}

package/dist/fetcher.d.ts

@@ -0,0 +1,29 @@
+import { Token } from '@pancakeswap/swap-sdk-core';
+import { Pair } from './entities/pair';
+import { ChainId } from './constants';
+/**
+ * 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 symbol of the token
+     * @param name optional name of the token
+     */
+    static fetchTokenData(chainId: ChainId, address: string, provider: import("@ethersproject/providers").BaseProvider | undefined, 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>;
+}
+//# sourceMappingURL=fetcher.d.ts.map

package/dist/fetcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetcher.d.ts","sourceRoot":"","sources":["../src/fetcher.ts"],"names":[],"mappings":"AAGA,OAAO,EAAkB,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElE,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAQrC;;GAEG;AACH,8BAAsB,OAAO;IAC3B;;OAEG;IAEH,OAAO;IAEP;;;;;;;OAOG;WACiB,cAAc,CAChC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,QAAQ,6DAA0C,EAClD,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,KAAK,CAAC;IAiBjB;;;;;OAKG;WACiB,aAAa,CAC/B,MAAM,EAAE,KAAK,EACb,MAAM,EAAE,KAAK,EACb,QAAQ,kDAAiD,GACxD,OAAO,CAAC,IAAI,CAAC;CAUjB"}

package/dist/index.d.ts

@@ -1,282 +1,9 @@
-export { default as JSBI } from 'jsbi';
-import { Token, Percent, CurrencyAmount, Price, BigintIsh, Currency, TradeType, NativeCurrency } from '@pancakeswap/swap-sdk-core';
+export * from './constants';
+export * from './trade';
+export * from './entities';
+export * from './router';
+export * from './utils';
+export * from './ether';
+export * from './fetcher';
 export * from '@pancakeswap/swap-sdk-core';
-
-declare class ERC20Token extends Token {
-    constructor(chainId: number, address: string, decimals: number, symbol: string, name?: string, projectLink?: string);
-}
-
-declare enum ChainId {
-    ETHEREUM = 1,
-    GOERLI = 5,
-    BSC = 56,
-    BSC_TESTNET = 97
-}
-declare const ZERO_PERCENT: Percent;
-declare const ONE_HUNDRED_PERCENT: Percent;
-declare const FACTORY_ADDRESS = "0xcA143Ce32Fe78f1f7019d7d551a6402fC5350c73";
-declare const FACTORY_ADDRESS_MAP: Record<number, string>;
-declare const INIT_CODE_HASH = "0x00fb7f630766e6a796048ea87d01acd3068e8ff67d078148a3fa3f4a84f69bd5";
-declare const INIT_CODE_HASH_MAP: Record<number, string>;
-declare const WETH9: {
-    1: ERC20Token;
-    5: ERC20Token;
-};
-declare const WBNB: {
-    1: ERC20Token;
-    56: ERC20Token;
-    97: ERC20Token;
-};
-declare const WNATIVE: Record<number, ERC20Token>;
-declare const NATIVE: Record<number, {
-    name: string;
-    symbol: string;
-    decimals: number;
-}>;
-
-declare const computePairAddress: ({ factoryAddress, tokenA, tokenB, }: {
-    factoryAddress: string;
-    tokenA: ERC20Token;
-    tokenB: ERC20Token;
-}) => string;
-declare class Pair {
-    readonly liquidityToken: ERC20Token;
-    private readonly tokenAmounts;
-    static getAddress(tokenA: ERC20Token, tokenB: ERC20Token): string;
-    constructor(currencyAmountA: CurrencyAmount<ERC20Token>, tokenAmountB: CurrencyAmount<ERC20Token>);
-    /**
-     * Returns true if the token is either token0 or token1
-     * @param token to check
-     */
-    involvesToken(token: ERC20Token): boolean;
-    /**
-     * Returns the current mid price of the pair in terms of token0, i.e. the ratio of reserve1 to reserve0
-     */
-    get token0Price(): Price<ERC20Token, ERC20Token>;
-    /**
-     * Returns the current mid price of the pair in terms of token1, i.e. the ratio of reserve0 to reserve1
-     */
-    get token1Price(): Price<ERC20Token, ERC20Token>;
-    /**
-     * 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: ERC20Token): Price<ERC20Token, ERC20Token>;
-    /**
-     * Returns the chain ID of the tokens in the pair.
-     */
-    get chainId(): number;
-    get token0(): ERC20Token;
-    get token1(): ERC20Token;
-    get reserve0(): CurrencyAmount<ERC20Token>;
-    get reserve1(): CurrencyAmount<ERC20Token>;
-    reserveOf(token: ERC20Token): CurrencyAmount<ERC20Token>;
-    getOutputAmount(inputAmount: CurrencyAmount<ERC20Token>): [CurrencyAmount<ERC20Token>, Pair];
-    getInputAmount(outputAmount: CurrencyAmount<ERC20Token>): [CurrencyAmount<ERC20Token>, Pair];
-    getLiquidityMinted(totalSupply: CurrencyAmount<ERC20Token>, tokenAmountA: CurrencyAmount<ERC20Token>, tokenAmountB: CurrencyAmount<ERC20Token>): CurrencyAmount<ERC20Token>;
-    getLiquidityValue(token: ERC20Token, totalSupply: CurrencyAmount<ERC20Token>, liquidity: CurrencyAmount<ERC20Token>, feeOn?: boolean, kLast?: BigintIsh): CurrencyAmount<ERC20Token>;
-}
-
-declare class Route<TInput extends Currency, TOutput extends Currency> {
-    readonly pairs: Pair[];
-    readonly path: Token[];
-    readonly input: TInput;
-    readonly output: TOutput;
-    constructor(pairs: Pair[], input: TInput, output: TOutput);
-    private _midPrice;
-    get midPrice(): Price<TInput, TOutput>;
-    get chainId(): number;
-}
-
-interface InputOutput<TInput extends Currency, TOutput extends Currency> {
-    readonly inputAmount: CurrencyAmount<TInput>;
-    readonly outputAmount: CurrencyAmount<TOutput>;
-}
-declare function inputOutputComparator<TInput extends Currency, TOutput extends Currency>(a: InputOutput<TInput, TOutput>, b: InputOutput<TInput, TOutput>): number;
-declare function tradeComparator<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(a: Trade<TInput, TOutput, TTradeType>, b: Trade<TInput, TOutput, TTradeType>): number;
-interface BestTradeOptions {
-    maxNumResults?: number;
-    maxHops?: number;
-}
-/**
- * Represents a trade executed against a list of pairs.
- * Does not account for slippage, i.e. trades that front run this trade and move the price.
- */
-declare class Trade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> {
-    /**
-     * The route of the trade, i.e. which pairs the trade goes through and the input/output currencies.
-     */
-    readonly route: Route<TInput, TOutput>;
-    /**
-     * The type of the trade, either exact in or exact out.
-     */
-    readonly tradeType: TTradeType;
-    /**
-     * The input amount for the trade assuming no slippage.
-     */
-    readonly inputAmount: CurrencyAmount<TInput>;
-    /**
-     * The output amount for the trade assuming no slippage.
-     */
-    readonly outputAmount: CurrencyAmount<TOutput>;
-    /**
-     * The price expressed in terms of output amount/input amount.
-     */
-    readonly executionPrice: Price<TInput, TOutput>;
-    /**
-     * The percent difference between the mid price before the trade and the trade execution price.
-     */
-    readonly priceImpact: Percent;
-    /**
-     * Constructs an exact in trade with the given amount in and route
-     * @param route route of the exact in trade
-     * @param amountIn the amount being passed in
-     */
-    static exactIn<TInput extends Currency, TOutput extends Currency>(route: Route<TInput, TOutput>, amountIn: CurrencyAmount<TInput>): Trade<TInput, TOutput, TradeType.EXACT_INPUT>;
-    /**
-     * Constructs an exact out trade with the given amount out and route
-     * @param route route of the exact out trade
-     * @param amountOut the amount returned by the trade
-     */
-    static exactOut<TInput extends Currency, TOutput extends Currency>(route: Route<TInput, TOutput>, amountOut: CurrencyAmount<TOutput>): Trade<TInput, TOutput, TradeType.EXACT_OUTPUT>;
-    constructor(route: Route<TInput, TOutput>, amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>, tradeType: TTradeType);
-    /**
-     * Get the minimum amount that must be received from this trade for the given slippage tolerance
-     * @param slippageTolerance tolerance of unfavorable slippage from the execution price of this trade
-     */
-    minimumAmountOut(slippageTolerance: Percent): CurrencyAmount<TOutput>;
-    /**
-     * Get the maximum amount in that can be spent via this trade for the given slippage tolerance
-     * @param slippageTolerance tolerance of unfavorable slippage from the execution price of this trade
-     */
-    maximumAmountIn(slippageTolerance: Percent): CurrencyAmount<TInput>;
-    /**
-     * Given a list of pairs, and a fixed amount in, returns the top `maxNumResults` trades that go from an input token
-     * amount to an output token, making at most `maxHops` hops.
-     * Note this does not consider aggregation, as routes are linear. It's possible a better route exists by splitting
-     * the amount in among multiple routes.
-     * @param pairs the pairs to consider in finding the best trade
-     * @param nextAmountIn exact amount of input currency to spend
-     * @param currencyOut the desired currency out
-     * @param maxNumResults maximum number of results to return
-     * @param maxHops maximum number of hops a returned trade can make, e.g. 1 hop goes through a single pair
-     * @param currentPairs used in recursion; the current list of pairs
-     * @param currencyAmountIn used in recursion; the original value of the currencyAmountIn parameter
-     * @param bestTrades used in recursion; the current list of best trades
-     */
-    static bestTradeExactIn<TInput extends Currency, TOutput extends Currency>(pairs: Pair[], currencyAmountIn: CurrencyAmount<TInput>, currencyOut: TOutput, { maxNumResults, maxHops }?: BestTradeOptions, currentPairs?: Pair[], nextAmountIn?: CurrencyAmount<Currency>, bestTrades?: Trade<TInput, TOutput, TradeType.EXACT_INPUT>[]): Trade<TInput, TOutput, TradeType.EXACT_INPUT>[];
-    /**
-     * Return the execution price after accounting for slippage tolerance
-     * @param slippageTolerance the allowed tolerated slippage
-     */
-    worstExecutionPrice(slippageTolerance: Percent): Price<TInput, TOutput>;
-    /**
-     * similar to the above method but instead targets a fixed output amount
-     * given a list of pairs, and a fixed amount out, returns the top `maxNumResults` trades that go from an input token
-     * to an output token amount, making at most `maxHops` hops
-     * note this does not consider aggregation, as routes are linear. it's possible a better route exists by splitting
-     * the amount in among multiple routes.
-     * @param pairs the pairs to consider in finding the best trade
-     * @param currencyIn the currency to spend
-     * @param nextAmountOut the exact amount of currency out
-     * @param maxNumResults maximum number of results to return
-     * @param maxHops maximum number of hops a returned trade can make, e.g. 1 hop goes through a single pair
-     * @param currentPairs used in recursion; the current list of pairs
-     * @param currencyAmountOut used in recursion; the original value of the currencyAmountOut parameter
-     * @param bestTrades used in recursion; the current list of best trades
-     */
-    static bestTradeExactOut<TInput extends Currency, TOutput extends Currency>(pairs: Pair[], currencyIn: TInput, currencyAmountOut: CurrencyAmount<TOutput>, { maxNumResults, maxHops }?: BestTradeOptions, currentPairs?: Pair[], nextAmountOut?: CurrencyAmount<Currency>, bestTrades?: Trade<TInput, TOutput, TradeType.EXACT_OUTPUT>[]): Trade<TInput, TOutput, TradeType.EXACT_OUTPUT>[];
-}
-
-/**
- *
- * Native is the main usage of a 'native' currency, i.e. for BSC mainnet and all testnets
- */
-declare class Native extends NativeCurrency {
-    protected constructor({ chainId, decimals, name, symbol, }: {
-        chainId: number;
-        decimals: number;
-        symbol: string;
-        name: string;
-    });
-    get wrapped(): Token;
-    private static cache;
-    static onChain(chainId: number): Native;
-    equals(other: Currency): boolean;
-}
-
-declare function isTradeBetter(tradeA: Trade<Currency, Currency, TradeType> | undefined | null, tradeB: Trade<Currency, Currency, TradeType> | undefined | null, minimumDelta?: Percent): boolean | undefined;
-
-/**
- * Options for producing the arguments to send call to the router.
- */
-interface TradeOptions {
-    /**
-     * How much the execution price is allowed to move unfavorably from the trade execution price.
-     */
-    allowedSlippage: Percent;
-    /**
-     * How long the swap is valid until it expires, in seconds.
-     * This will be used to produce a `deadline` parameter which is computed from when the swap call parameters
-     * are generated.
-     */
-    ttl: number;
-    /**
-     * The account that should receive the output of the swap.
-     */
-    recipient: string;
-    /**
-     * Whether any of the tokens in the path are fee on transfer tokens, which should be handled with special methods
-     */
-    feeOnTransfer?: boolean;
-}
-interface TradeOptionsDeadline extends Omit<TradeOptions, 'ttl'> {
-    /**
-     * When the transaction expires.
-     * This is an atlernate to specifying the ttl, for when you do not want to use local time.
-     */
-    deadline: number;
-}
-/**
- * The parameters to use in the call to the Pancake Router to execute a trade.
- */
-interface SwapParameters {
-    /**
-     * The method to call on the Pancake Router.
-     */
-    methodName: string;
-    /**
-     * The arguments to pass to the method, all hex encoded.
-     */
-    args: (string | string[])[];
-    /**
-     * The amount of wei to send in hex.
-     */
-    value: string;
-}
-/**
- * Represents the Pancake Router, and has static methods for helping execute trades.
- */
-declare abstract class Router {
-    /**
-     * Produces the on-chain method name to call and the hex encoded parameters to pass as arguments for a given trade.
-     * @param trade to produce call parameters for
-     * @param options options for the call parameters
-     */
-    static swapCallParameters(trade: Trade<Currency, Currency, TradeType>, options: TradeOptions | TradeOptionsDeadline): SwapParameters;
-}
-
-declare function validateAndParseAddress(address: string): string;
-
-/**
- * Ether is the main usage of a 'native' currency, i.e. for Ethereum mainnet and all testnets
- */
-declare class Ether extends NativeCurrency {
-    protected constructor(chainId: number);
-    get wrapped(): Token;
-    private static _etherCache;
-    static onChain(chainId: number): Ether;
-    equals(other: Currency): boolean;
-}
-
-export { BestTradeOptions, ChainId, ERC20Token, Ether, FACTORY_ADDRESS, FACTORY_ADDRESS_MAP, INIT_CODE_HASH, INIT_CODE_HASH_MAP, NATIVE, Native, ONE_HUNDRED_PERCENT, Pair, Route, Router, SwapParameters, Trade, TradeOptions, TradeOptionsDeadline, WBNB, WETH9, WNATIVE, ZERO_PERCENT, computePairAddress, inputOutputComparator, isTradeBetter, tradeComparator, validateAndParseAddress };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AAEvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AAExB,cAAc,SAAS,CAAA;AAEvB,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AAEzB,cAAc,4BAA4B,CAAA"}