@dodoex/widgets 3.2.2 → 3.2.3

package/dist/types/widgets/PoolWidget/AMMV3/hooks/useV3DerivedMintInfo.d.ts

@@ -0,0 +1,46 @@
+import { ReactNode } from 'react';
+import { StateProps } from '../reducer';
+import { Currency, CurrencyAmount, Price, Token } from '../sdks/sdk-core';
+import { Pool, Position } from '../sdks/v3-sdk';
+import { Bound, Field } from '../types';
+import { PoolState } from './usePools';
+export declare function useV3DerivedMintInfo({ state, existingPosition, }: {
+    state: StateProps;
+    existingPosition?: Position;
+}): {
+    pool?: Pool | null;
+    poolState: PoolState;
+    ticks: {
+        [bound in Bound]?: number | undefined;
+    };
+    price?: Price<Token, Token>;
+    pricesAtTicks: {
+        [bound in Bound]?: Price<Token, Token> | undefined;
+    };
+    pricesAtLimit: {
+        [bound in Bound]?: Price<Token, Token> | undefined;
+    };
+    currencies: {
+        [field in Field]?: Currency;
+    };
+    currencyBalances: {
+        [field in Field]?: CurrencyAmount<Currency>;
+    };
+    dependentField: Field;
+    parsedAmounts: {
+        [field in Field]?: CurrencyAmount<Currency>;
+    };
+    position?: Position;
+    noLiquidity?: boolean;
+    errorMessage?: ReactNode;
+    invalidPool: boolean;
+    outOfRange: boolean;
+    invalidRange: boolean;
+    depositADisabled: boolean;
+    depositBDisabled: boolean;
+    invertPrice: boolean;
+    ticksAtLimit: {
+        [bound in Bound]?: boolean | undefined;
+    };
+    isTaxed: boolean;
+};

package/dist/types/widgets/PoolWidget/AMMV3/hooks/useV3MintActionHandlers.d.ts

@@ -0,0 +1,11 @@
+import { Actions } from '../reducer';
+export declare function useV3MintActionHandlers({ noLiquidity, dispatch, }: {
+    noLiquidity: boolean | undefined;
+    dispatch: React.Dispatch<Actions>;
+}): {
+    onFieldAInput: (typedValue: string) => void;
+    onFieldBInput: (typedValue: string) => void;
+    onLeftRangeInput: (typedValue: string) => void;
+    onRightRangeInput: (typedValue: string) => void;
+    onStartPriceInput: (typedValue: string) => void;
+};

package/dist/types/widgets/PoolWidget/AMMV3/hooks/useV3PositionFees.d.ts

@@ -0,0 +1,8 @@
+import { ChainId, Currency, CurrencyAmount } from '../sdks/sdk-core';
+import { Pool } from '../sdks/v3-sdk';
+export declare function useV3PositionFees({ chainId, pool, tokenId, asWETH, }: {
+    chainId: ChainId;
+    pool?: Pool;
+    tokenId: string;
+    asWETH: boolean;
+}): [CurrencyAmount<Currency>, CurrencyAmount<Currency>] | [undefined, undefined];

package/dist/types/widgets/PoolWidget/AMMV3/hooks/useV3Positions.d.ts

@@ -0,0 +1,13 @@
+import { ChainId } from '@dodoex/api';
+import { PositionDetails } from '../types/position';
+interface UseV3PositionsResults {
+    loading: boolean;
+    positions?: PositionDetails[];
+}
+interface UseV3PositionResults {
+    loading: boolean;
+    position?: PositionDetails;
+}
+export declare function useV3PositionFromTokenId(tokenId: string | undefined, chainId: ChainId): UseV3PositionResults;
+export declare function useV3Positions(account: string | null | undefined, chainId: ChainId): UseV3PositionsResults;
+export {};

package/dist/types/widgets/PoolWidget/AMMV3/reducer.d.ts

@@ -0,0 +1,55 @@
+import { TokenInfo } from '../../../hooks/Token/type';
+import { Currency } from './sdks/sdk-core';
+import { FeeAmount } from './sdks/v3-sdk';
+import { Field, FullRange } from './types';
+export interface StateProps {
+    baseToken: Maybe<Currency>;
+    quoteToken: Maybe<Currency>;
+    feeAmount: FeeAmount | undefined;
+    readonly independentField: Field;
+    readonly typedValue: string;
+    readonly startPriceTypedValue: string;
+    readonly leftRangeTypedValue: string | FullRange;
+    readonly rightRangeTypedValue: string | FullRange;
+}
+export declare enum Types {
+    UpdateBaseToken = 0,
+    UpdateDefaultBaseToken = 1,
+    UpdateQuoteToken = 2,
+    UpdateDefaultQuoteToken = 3,
+    UpdateBaseTokenAndClearQuoteToken = 4,
+    UpdateFeeAmount = 5,
+    ToggleRate = 6,
+    setFullRange = 7,
+    typeStartPriceInput = 8,
+    typeLeftRangeInput = 9,
+    typeRightRangeInput = 10,
+    typeInput = 11
+}
+type Payload = {
+    [Types.UpdateBaseToken]: TokenInfo;
+    [Types.UpdateDefaultBaseToken]: TokenInfo;
+    [Types.UpdateQuoteToken]: TokenInfo;
+    [Types.UpdateDefaultQuoteToken]: TokenInfo;
+    [Types.UpdateBaseTokenAndClearQuoteToken]: TokenInfo;
+    [Types.UpdateFeeAmount]: FeeAmount;
+    [Types.ToggleRate]: void;
+    [Types.setFullRange]: void;
+    [Types.typeStartPriceInput]: {
+        typedValue: string;
+    };
+    [Types.typeLeftRangeInput]: {
+        typedValue: string;
+    };
+    [Types.typeRightRangeInput]: {
+        typedValue: string;
+    };
+    [Types.typeInput]: {
+        field: Field;
+        typedValue: string;
+        noLiquidity: boolean;
+    };
+};
+export type Actions = ActionMap<Payload>[keyof ActionMap<Payload>];
+export declare function reducer(state: StateProps, action: Actions): StateProps;
+export {};

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/addresses.d.ts

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

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/chains.d.ts

@@ -0,0 +1,10 @@
+import { ChainId } from '@dodoex/api';
+export { ChainId } from '@dodoex/api';
+/**
+ * @deprecated
+ */
+export declare const SUPPORTED_CHAINS: readonly [ChainId.MAINNET, ChainId.ARBITRUM_ONE, ChainId.SEPOLIA, ChainId.TAIKO];
+/**
+ * @deprecated
+ */
+export type SupportedChainsType = (typeof SUPPORTED_CHAINS)[number];

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/constants.d.ts

@@ -0,0 +1,12 @@
+import JSBI from 'jsbi';
+export type BigintIsh = JSBI | string | number;
+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 MaxUint256: JSBI;

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/baseCurrency.d.ts

@@ -0,0 +1,49 @@
+import { Currency } from './currency';
+import { Token } from './token';
+/**
+ * A currency is any fungible financial instrument, including Ether, all ERC20 tokens, and other chain-native currencies
+ */
+export declare abstract class BaseCurrency {
+    /**
+     * Returns whether the currency is native to the chain and must be wrapped (e.g. Ether)
+     */
+    abstract readonly isNative: boolean;
+    /**
+     * Returns whether the currency is a token that is usable in Uniswap without wrapping
+     */
+    abstract readonly isToken: boolean;
+    /**
+     * The chain ID on which this currency resides
+     */
+    readonly chainId: number;
+    /**
+     * The decimals used in representing currency amounts
+     */
+    readonly decimals: number;
+    /**
+     * The symbol of the currency, i.e. a short textual non-unique identifier
+     */
+    readonly symbol?: string;
+    /**
+     * The name of the currency, i.e. a descriptive textual non-unique identifier
+     */
+    readonly name?: string;
+    /**
+     * Constructs an instance of the base class `BaseCurrency`.
+     * @param chainId the chain ID on which this currency resides
+     * @param decimals decimals of the currency
+     * @param symbol symbol of the currency
+     * @param name of the currency
+     */
+    protected constructor(chainId: number, decimals: number, symbol?: string, name?: string);
+    /**
+     * Returns whether this currency is functionally equivalent to the other currency
+     * @param other the other currency
+     */
+    abstract equals(other: Currency): boolean;
+    /**
+     * Return the wrapped version of this currency that can be used with the Uniswap contracts. Currencies must
+     * implement this to be used in Uniswap
+     */
+    abstract get wrapped(): Token;
+}

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/currency.d.ts

@@ -0,0 +1,3 @@
+import { NativeCurrency } from './nativeCurrency';
+import { Token } from './token';
+export type Currency = NativeCurrency | Token;

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/fractions/currencyAmount.d.ts

@@ -0,0 +1,32 @@
+import JSBI from 'jsbi';
+import { Currency } from '../currency';
+import { Token } from '../token';
+import { Fraction } from './fraction';
+import BigNumber from 'bignumber.js';
+import { BigintIsh, Rounding } from '../../constants';
+export declare class CurrencyAmount<T extends Currency> extends Fraction {
+    readonly currency: T;
+    readonly decimalScale: JSBI;
+    /**
+     * Returns a new currency amount instance from the unitless amount of token, i.e. the raw amount
+     * @param currency the currency in the amount
+     * @param rawAmount the raw token or ether amount
+     */
+    static fromRawAmount<T extends Currency>(currency: T, rawAmount: BigintIsh): CurrencyAmount<T>;
+    /**
+     * Construct a currency amount with a denominator that is not equal to 1
+     * @param currency the currency
+     * @param numerator the numerator of the fractional token amount
+     * @param denominator the denominator of the fractional token amount
+     */
+    static fromFractionalAmount<T extends Currency>(currency: T, numerator: BigintIsh, denominator: BigintIsh): CurrencyAmount<T>;
+    protected constructor(currency: T, numerator: BigintIsh, denominator?: BigintIsh);
+    add(other: CurrencyAmount<T>): CurrencyAmount<T>;
+    subtract(other: CurrencyAmount<T>): CurrencyAmount<T>;
+    multiply(other: Fraction | BigintIsh): CurrencyAmount<T>;
+    divide(other: Fraction | BigintIsh): CurrencyAmount<T>;
+    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
+    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
+    toExact(): BigNumber;
+    get wrapped(): CurrencyAmount<Token>;
+}

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/fractions/fraction.d.ts

@@ -0,0 +1,24 @@
+import JSBI from 'jsbi';
+import { BigintIsh, Rounding } from '../../constants';
+export declare class Fraction {
+    readonly numerator: JSBI;
+    readonly denominator: JSBI;
+    constructor(numerator: BigintIsh, denominator?: BigintIsh);
+    private static tryParseFraction;
+    get quotient(): JSBI;
+    get remainder(): Fraction;
+    invert(): Fraction;
+    add(other: Fraction | BigintIsh): Fraction;
+    subtract(other: Fraction | BigintIsh): Fraction;
+    lessThan(other: Fraction | BigintIsh): boolean;
+    equalTo(other: Fraction | BigintIsh): boolean;
+    greaterThan(other: Fraction | BigintIsh): boolean;
+    multiply(other: Fraction | BigintIsh): Fraction;
+    divide(other: Fraction | BigintIsh): Fraction;
+    toSignificant(significantDigits: number, format?: object, rounding?: Rounding): string;
+    toFixed(decimalPlaces: number, format?: object, rounding?: Rounding): string;
+    /**
+     * Helper method for converting any super class back to a fraction
+     */
+    get asFraction(): Fraction;
+}

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/fractions/index.d.ts

@@ -0,0 +1,4 @@
+export { CurrencyAmount } from './currencyAmount';
+export { Fraction } from './fraction';
+export { Percent } from './percent';
+export { Price } from './price';

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/fractions/percent.d.ts

@@ -0,0 +1,14 @@
+import { BigintIsh, Rounding } from '../../constants';
+import { Fraction } from './fraction';
+export declare class Percent extends Fraction {
+    /**
+     * This boolean prevents a fraction from being interpreted as a Percent
+     */
+    readonly isPercent: true;
+    add(other: Fraction | BigintIsh): Percent;
+    subtract(other: Fraction | BigintIsh): Percent;
+    multiply(other: Fraction | BigintIsh): Percent;
+    divide(other: Fraction | BigintIsh): Percent;
+    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
+    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
+}

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/fractions/price.d.ts

@@ -0,0 +1,38 @@
+import { BigintIsh, Rounding } from '../../constants';
+import { Currency } from '../currency';
+import { Fraction } from './fraction';
+import { CurrencyAmount } from './currencyAmount';
+export declare class Price<TBase extends Currency, TQuote extends Currency> extends Fraction {
+    readonly baseCurrency: TBase;
+    readonly quoteCurrency: TQuote;
+    readonly scalar: Fraction;
+    /**
+     * Construct a price, either with the base and quote currency amount, or the
+     * @param args
+     */
+    constructor(...args: [TBase, TQuote, BigintIsh, BigintIsh] | [{
+        baseAmount: CurrencyAmount<TBase>;
+        quoteAmount: CurrencyAmount<TQuote>;
+    }]);
+    /**
+     * Flip the price, switching the base and quote currency
+     */
+    invert(): Price<TQuote, TBase>;
+    /**
+     * Multiply the price by another price, returning a new price. The other price must have the same base currency as this price's quote currency
+     * @param other the other price
+     */
+    multiply<TOtherQuote extends Currency>(other: Price<TQuote, TOtherQuote>): Price<TBase, TOtherQuote>;
+    /**
+     * Return the amount of quote currency corresponding to a given amount of the base currency
+     * @param currencyAmount the amount of base currency to quote against the price
+     */
+    quote(currencyAmount: CurrencyAmount<TBase>): CurrencyAmount<TQuote>;
+    /**
+     * Get the value scaled by decimals for formatting
+     * @private
+     */
+    private get adjustedForDecimals();
+    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
+    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
+}

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/index.d.ts

@@ -0,0 +1,4 @@
+export * from './fractions';
+export * from './currency';
+export * from './nativeCurrencyClass';
+export * from './token';

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/nativeCurrency.d.ts

@@ -0,0 +1,16 @@
+import { ChainId } from '@dodoex/api';
+import { Currency, NativeCurrencyClass, Token } from '..';
+export declare class NativeCurrency implements NativeCurrencyClass {
+    constructor(chainId: number);
+    chainId: ChainId;
+    decimals: number;
+    name: string;
+    symbol: string;
+    isNative: true;
+    isToken: false;
+    address: string;
+    equals(currency: Currency): boolean;
+    get wrapped(): Token;
+    private static _cachedNativeCurrency;
+    static onChain(chainId: number): NativeCurrency;
+}

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/nativeCurrencyClass.d.ts

@@ -0,0 +1,8 @@
+import { BaseCurrency } from './baseCurrency';
+/**
+ * Represents the native currency of the chain on which it resides, e.g.
+ */
+export declare abstract class NativeCurrencyClass extends BaseCurrency {
+    readonly isNative: true;
+    readonly isToken: false;
+}

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/entities/token.d.ts

@@ -0,0 +1,48 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { BaseCurrency } from './baseCurrency';
+import { Currency } from './currency';
+/**
+ * Represents an ERC20 token with a unique address and some metadata.
+ */
+export declare class Token extends BaseCurrency {
+    readonly isNative: false;
+    readonly isToken: true;
+    /**
+     * The contract address on the chain on which this token lives
+     */
+    readonly address: string;
+    /**
+     * Relevant for fee-on-transfer (FOT) token taxes,
+     * Not every ERC20 token is FOT token, so this field is optional
+     */
+    readonly buyFeeBps?: BigNumber;
+    readonly sellFeeBps?: BigNumber;
+    /**
+     *
+     * @param chainId {@link BaseCurrency#chainId}
+     * @param address The contract address on the chain on which this token lives
+     * @param decimals {@link BaseCurrency#decimals}
+     * @param symbol {@link BaseCurrency#symbol}
+     * @param name {@link BaseCurrency#name}
+     * @param bypassChecksum If true it only checks for length === 42, startsWith 0x and contains only hex characters
+     * @param buyFeeBps Buy fee tax for FOT tokens, in basis points
+     * @param sellFeeBps Sell fee tax for FOT tokens, in basis points
+     */
+    constructor(chainId: number, address: string, decimals: number, symbol?: string, name?: string, bypassChecksum?: boolean, buyFeeBps?: BigNumber, sellFeeBps?: BigNumber);
+    /**
+     * Returns true if the two tokens are equivalent, i.e. have the same chainId and address.
+     * @param other other token to compare
+     */
+    equals(other: Currency): boolean;
+    /**
+     * Returns true if the address of this token sorts before the address of the other token
+     * @param other other token to compare
+     * @throws if the tokens have the same address
+     * @throws if the tokens are on different chains
+     */
+    sortsBefore(other: Token): boolean;
+    /**
+     * Return this token, which does not need to be wrapped
+     */
+    get wrapped(): Token;
+}

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/index.d.ts

@@ -0,0 +1,5 @@
+export * from './addresses';
+export * from './chains';
+export * from './constants';
+export * from './entities';
+export * from './utils';

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/utils/computePriceImpact.d.ts

@@ -0,0 +1,8 @@
+import { Currency, CurrencyAmount, Percent, Price } from '../entities';
+/**
+ * Returns the percent difference between the mid price and the execution price, i.e. price impact.
+ * @param midPrice mid price before the trade
+ * @param inputAmount the input amount of the trade
+ * @param outputAmount the output amount of the trade
+ */
+export declare function computePriceImpact<TBase extends Currency, TQuote extends Currency>(midPrice: Price<TBase, TQuote>, inputAmount: CurrencyAmount<TBase>, outputAmount: CurrencyAmount<TQuote>): Percent;

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/utils/index.d.ts

@@ -0,0 +1,4 @@
+export { computePriceImpact } from './computePriceImpact';
+export { sortedInsert } from './sortedInsert';
+export { sqrt } from './sqrt';
+export { validateAndParseAddress } from './validateAndParseAddress';

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/utils/sortedInsert.d.ts

@@ -0,0 +1 @@
+export declare function sortedInsert<T>(items: T[], add: T, maxSize: number, comparator: (a: T, b: T) => number): T | null;

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/utils/sqrt.d.ts

@@ -0,0 +1,7 @@
+import JSBI from 'jsbi';
+export declare const MAX_SAFE_INTEGER: JSBI;
+/**
+ * Computes floor(sqrt(value))
+ * @param value the value for which to compute the square root, rounded down
+ */
+export declare function sqrt(value: JSBI): JSBI;

package/dist/types/widgets/PoolWidget/AMMV3/sdks/sdk-core/utils/validateAndParseAddress.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Validates an address and returns the parsed (checksummed) version of that address
+ * @param address the unchecksummed hex address
+ */
+export declare function validateAndParseAddress(address: string): string;
+/**
+ * Checks if an address is valid by checking 0x prefix, length === 42 and hex encoding.
+ * @param address the unchecksummed hex address
+ */
+export declare function checkValidAddress(address: string): string;

package/dist/types/widgets/PoolWidget/AMMV3/sdks/v3-sdk/constants.d.ts

@@ -0,0 +1,32 @@
+import { ChainId } from '../sdk-core';
+/**
+ * Taiko UniswapV3Factory
+ * @see https://taikoscan.io/address/0x78172691DD3B8ADa7aEbd9bFfB487FB11D735DB2?tab=contract#code
+ */
+export declare const FACTORY_ADDRESS = "0x78172691DD3B8ADa7aEbd9bFfB487FB11D735DB2";
+export declare const ADDRESS_ZERO = "0x0000000000000000000000000000000000000000";
+export declare const POOL_INIT_CODE_HASH = "0x5ccd5621c1bb9e44ce98cef8b90d31eb2423dec3793b6239232cefae976936ea";
+/**
+ * Taiko  POOL_INIT_CODE_HASH
+ * @see PoolAddress.sol
+ * @see https://taikoscan.io/address/0x202bEE65B164aEcBb6A2318438bf46bEF14E1072?tab=contract#code#F12#L6
+ */
+export declare function poolInitCodeHash(chainId?: ChainId): string;
+/**
+ * The default factory enabled fee amounts, denominated in hundredths of bips.
+ */
+export declare enum FeeAmount {
+    LOWEST = 100,
+    LOW_200 = 200,
+    LOW_300 = 300,
+    LOW_400 = 400,
+    LOW = 500,
+    MEDIUM = 3000,
+    HIGH = 10000
+}
+/**
+ * The default factory tick spacings by fee amount.
+ */
+export declare const TICK_SPACINGS: {
+    [amount in FeeAmount]: number;
+};

package/dist/types/widgets/PoolWidget/AMMV3/sdks/v3-sdk/entities/index.d.ts

@@ -0,0 +1,7 @@
+export * from './pool';
+export * from './position';
+export * from './route';
+export * from './tick';
+export * from './trade';
+export * from './tickDataProvider';
+export * from './tickListDataProvider';

package/dist/types/widgets/PoolWidget/AMMV3/sdks/v3-sdk/entities/pool.d.ts

@@ -0,0 +1,81 @@
+import JSBI from 'jsbi';
+import { BigintIsh, CurrencyAmount, Price, Token } from '../../sdk-core';
+import { FeeAmount } from '../constants';
+import { Tick, TickConstructorArgs } from './tick';
+import { TickDataProvider } from './tickDataProvider';
+/**
+ * Represents a V3 pool
+ */
+export declare class Pool {
+    readonly token0: Token;
+    readonly token1: Token;
+    readonly fee: FeeAmount;
+    readonly sqrtRatioX96: JSBI;
+    readonly liquidity: JSBI;
+    readonly tickCurrent: number;
+    readonly tickDataProvider: TickDataProvider;
+    private _token0Price?;
+    private _token1Price?;
+    static getAddress(tokenA: Token, tokenB: Token, fee: FeeAmount, initCodeHashManualOverride?: string, factoryAddressOverride?: string): string;
+    /**
+     * Construct a pool
+     * @param tokenA One of the tokens in the pool
+     * @param tokenB The other token in the pool
+     * @param fee The fee in hundredths of a bips of the input amount of every swap that is collected by the pool
+     * @param sqrtRatioX96 The sqrt of the current ratio of amounts of token1 to token0
+     * @param liquidity The current value of in range liquidity
+     * @param tickCurrent The current tick of the pool
+     * @param ticks The current state of the pool ticks or a data provider that can return tick data
+     */
+    constructor(tokenA: Token, tokenB: Token, fee: FeeAmount, sqrtRatioX96: BigintIsh, liquidity: BigintIsh, tickCurrent: number, ticks?: TickDataProvider | (Tick | TickConstructorArgs)[]);
+    /**
+     * Returns true if the token is either token0 or token1
+     * @param token The token to check
+     * @returns True if token is either token0 or token
+     */
+    involvesToken(token: Token): boolean;
+    /**
+     * Returns the current mid price of the pool in terms of token0, i.e. the ratio of token1 over token0
+     */
+    get token0Price(): Price<Token, Token>;
+    /**
+     * Returns the current mid price of the pool in terms of token1, i.e. the ratio of token0 over token1
+     */
+    get token1Price(): Price<Token, Token>;
+    /**
+     * Return the price of the given token in terms of the other token in the pool.
+     * @param token The token to return price of
+     * @returns The price of the given token, in terms of the other.
+     */
+    priceOf(token: Token): Price<Token, Token>;
+    /**
+     * Returns the chain ID of the tokens in the pool.
+     */
+    get chainId(): number;
+    /**
+     * Given an input amount of a token, return the computed output amount, and a pool with state updated after the trade
+     * @param inputAmount The input amount for which to quote the output amount
+     * @param sqrtPriceLimitX96 The Q64.96 sqrt price limit
+     * @returns The output amount and the pool with updated state
+     */
+    getOutputAmount(inputAmount: CurrencyAmount<Token>, sqrtPriceLimitX96?: JSBI): Promise<[CurrencyAmount<Token>, Pool]>;
+    /**
+     * Given a desired output amount of a token, return the computed input amount and a pool with state updated after the trade
+     * @param outputAmount the output amount for which to quote the input amount
+     * @param sqrtPriceLimitX96 The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this value after the swap. If one for zero, the price cannot be greater than this value after the swap
+     * @returns The input amount and the pool with updated state
+     */
+    getInputAmount(outputAmount: CurrencyAmount<Token>, sqrtPriceLimitX96?: JSBI): Promise<[CurrencyAmount<Token>, Pool]>;
+    /**
+     * Executes a swap
+     * @param zeroForOne Whether the amount in is token0 or token1
+     * @param amountSpecified The amount of the swap, which implicitly configures the swap as exact input (positive), or exact output (negative)
+     * @param sqrtPriceLimitX96 The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this value after the swap. If one for zero, the price cannot be greater than this value after the swap
+     * @returns amountCalculated
+     * @returns sqrtRatioX96
+     * @returns liquidity
+     * @returns tickCurrent
+     */
+    private swap;
+    get tickSpacing(): number;
+}