@juiceswapxyz/v4-sdk 3.0.0 → 3.0.2

package/dist/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./v4-sdk.cjs.production.min.js')
+} else {
+  module.exports = require('./v4-sdk.cjs.development.js')
+}

package/dist/internalConstants.d.ts

@@ -0,0 +1,46 @@
+import JSBI from 'jsbi';
+export declare const ADDRESS_ZERO = "0x0000000000000000000000000000000000000000";
+export declare const NEGATIVE_ONE: JSBI;
+export declare const ZERO: JSBI;
+export declare const ONE: JSBI;
+export declare const ONE_ETHER: JSBI;
+export declare const EMPTY_BYTES = "0x";
+export declare const Q96: JSBI;
+export declare const Q192: JSBI;
+export declare const FEE_AMOUNT_LOW = 100;
+export declare const FEE_AMOUNT_MEDIUM = 3000;
+export declare const FEE_AMOUNT_HIGHEST = 10000;
+export declare const TICK_SPACING_TEN = 10;
+export declare const TICK_SPACING_SIXTY = 60;
+export declare const MIN_SLIPPAGE_DECREASE = 0;
+export declare const OPEN_DELTA: import("ethers").BigNumber;
+export declare const SQRT_PRICE_1_1: JSBI;
+export declare const EMPTY_HOOK = "0x0000000000000000000000000000000000000000";
+export declare const NATIVE_NOT_SET = "NATIVE_NOT_SET";
+export declare const ZERO_LIQUIDITY = "ZERO_LIQUIDITY";
+export declare const NO_SQRT_PRICE = "NO_SQRT_PRICE";
+export declare const CANNOT_BURN = "CANNOT_BURN";
+/**
+ * Function fragments that exist on the PositionManager contract.
+ */
+export declare enum PositionFunctions {
+    INITIALIZE_POOL = "initializePool",
+    MODIFY_LIQUIDITIES = "modifyLiquidities",
+    PERMIT_BATCH = "0x002a3e3a",
+    ERC721PERMIT_PERMIT = "0x0f5730f1"
+}
+/**
+ * The default factory enabled fee amounts, denominated in hundredths of bips.
+ */
+export declare enum FeeAmount {
+    LOWEST = 100,
+    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/multicall.d.ts

@@ -0,0 +1,10 @@
+import { Interface } from '@ethersproject/abi';
+export declare abstract class Multicall {
+    static INTERFACE: Interface;
+    /**
+     * Cannot be constructed.
+     */
+    private constructor();
+    static encodeMulticall(calldataList: string | string[]): string;
+    static decodeMulticall(encodedCalldata: string): string[];
+}

package/dist/utils/calldata.d.ts

@@ -0,0 +1,20 @@
+import { BigintIsh } from '@juiceswapxyz/sdk-core';
+/**
+ * Generated method parameters for executing a call.
+ */
+export interface MethodParameters {
+    /**
+     * The hex encoded calldata to perform the given operation
+     */
+    calldata: string;
+    /**
+     * The amount of ether (wei) to send in hex.
+     */
+    value: string;
+}
+/**
+ * Converts a big int to a hex string
+ * @param bigintIsh
+ * @returns The hex encoded calldata
+ */
+export declare function toHex(bigintIsh: BigintIsh): string;

package/dist/utils/currencyMap.d.ts

@@ -0,0 +1,2 @@
+import { Currency } from '@juiceswapxyz/sdk-core';
+export declare function toAddress(currency: Currency): string;

package/dist/utils/encodeRouteToPath.d.ts

@@ -0,0 +1,10 @@
+import { Currency } from '@juiceswapxyz/sdk-core';
+import { Route } from '../entities/route';
+export declare type PathKey = {
+    intermediateCurrency: string;
+    fee: number;
+    tickSpacing: number;
+    hooks: string;
+    hookData: string;
+};
+export declare const encodeRouteToPath: (route: Route<Currency, Currency>, exactOutput?: boolean | undefined) => PathKey[];

package/dist/utils/hook.d.ts

@@ -0,0 +1,45 @@
+export declare type HookPermissions = {
+    [key in HookOptions]: boolean;
+};
+export declare enum HookOptions {
+    AfterRemoveLiquidityReturnsDelta = "afterRemoveLiquidityReturnsDelta",
+    AfterAddLiquidityReturnsDelta = "afterAddLiquidityReturnsDelta",
+    AfterSwapReturnsDelta = "afterSwapReturnsDelta",
+    BeforeSwapReturnsDelta = "beforeSwapReturnsDelta",
+    AfterDonate = "afterDonate",
+    BeforeDonate = "beforeDonate",
+    AfterSwap = "afterSwap",
+    BeforeSwap = "beforeSwap",
+    AfterRemoveLiquidity = "afterRemoveLiquidity",
+    BeforeRemoveLiquidity = "beforeRemoveLiquidity",
+    AfterAddLiquidity = "afterAddLiquidity",
+    BeforeAddLiquidity = "beforeAddLiquidity",
+    AfterInitialize = "afterInitialize",
+    BeforeInitialize = "beforeInitialize"
+}
+export declare const hookFlagIndex: {
+    afterRemoveLiquidityReturnsDelta: number;
+    afterAddLiquidityReturnsDelta: number;
+    afterSwapReturnsDelta: number;
+    beforeSwapReturnsDelta: number;
+    afterDonate: number;
+    beforeDonate: number;
+    afterSwap: number;
+    beforeSwap: number;
+    afterRemoveLiquidity: number;
+    beforeRemoveLiquidity: number;
+    afterAddLiquidity: number;
+    beforeAddLiquidity: number;
+    afterInitialize: number;
+    beforeInitialize: number;
+};
+export declare class Hook {
+    static permissions(address: string): HookPermissions;
+    static hasPermission(address: string, hookOption: HookOptions): boolean;
+    static hasInitializePermissions(address: string): boolean;
+    static hasLiquidityPermissions(address: string): boolean;
+    static hasSwapPermissions(address: string): boolean;
+    static hasDonatePermissions(address: string): boolean;
+    private static _hasPermission;
+    private static _checkAddress;
+}

package/dist/utils/index.d.ts

@@ -0,0 +1,11 @@
+export * from './encodeRouteToPath';
+export * from './v4Planner';
+export * from './v4PositionPlanner';
+export * from './calldata';
+export * from './v4BaseActionsParser';
+export * from './currencyMap';
+export * from './encodeRouteToPath';
+export * from './pathCurrency';
+export * from './priceTickConversions';
+export * from './sortsBefore';
+export * from './hook';

package/dist/utils/pathCurrency.d.ts

@@ -0,0 +1,4 @@
+import { Currency, CurrencyAmount } from '@juiceswapxyz/sdk-core';
+import { Pool } from '../entities/pool';
+export declare function amountWithPathCurrency(amount: CurrencyAmount<Currency>, pool: Pool): CurrencyAmount<Currency>;
+export declare function getPathCurrency(currency: Currency, pool: Pool): Currency;

package/dist/utils/positionManagerAbi.d.ts

@@ -0,0 +1,102 @@
+export declare const positionManagerAbi: ({
+    type: string;
+    inputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    stateMutability: string;
+    name?: undefined;
+    outputs?: undefined;
+    anonymous?: undefined;
+} | {
+    type: string;
+    stateMutability: string;
+    inputs?: undefined;
+    name?: undefined;
+    outputs?: undefined;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    outputs: ({
+        name: string;
+        type: string;
+        internalType: string;
+        components: {
+            name: string;
+            type: string;
+            internalType: string;
+        }[];
+    } | {
+        name: string;
+        type: string;
+        internalType: string;
+        components?: undefined;
+    })[];
+    stateMutability: string;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: ({
+        name: string;
+        type: string;
+        internalType: string;
+        components?: undefined;
+    } | {
+        name: string;
+        type: string;
+        internalType: string;
+        components: ({
+            name: string;
+            type: string;
+            internalType: string;
+            components: {
+                name: string;
+                type: string;
+                internalType: string;
+            }[];
+        } | {
+            name: string;
+            type: string;
+            internalType: string;
+            components?: undefined;
+        })[];
+    })[];
+    outputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    stateMutability: string;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        indexed: boolean;
+        internalType: string;
+    }[];
+    anonymous: boolean;
+    stateMutability?: undefined;
+    outputs?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    stateMutability?: undefined;
+    outputs?: undefined;
+    anonymous?: undefined;
+})[];

package/dist/utils/priceTickConversions.d.ts

@@ -0,0 +1,20 @@
+import { Price, Currency } from '@juiceswapxyz/sdk-core';
+/**
+ * This library is the almost the same as v3-sdk priceTickConversion except
+ * that it accepts a Currency type instead of a Token type,
+ * and thus uses some helper functions defined for the Currency type over the Token type.
+ */
+/**
+ * Returns a price object corresponding to the input tick and the base/quote token
+ * Inputs must be tokens because the address order is used to interpret the price represented by the tick
+ * @param baseToken the base token of the price
+ * @param quoteToken the quote token of the price
+ * @param tick the tick for which to return the price
+ */
+export declare function tickToPrice(baseCurrency: Currency, quoteCurrency: Currency, tick: number): Price<Currency, Currency>;
+/**
+ * Returns the first tick for which the given price is greater than or equal to the tick price
+ * @param price for which to return the closest tick that represents a price less than or equal to the input price,
+ * i.e. the price of the returned tick is less than or equal to the input price
+ */
+export declare function priceToClosestTick(price: Price<Currency, Currency>): number;

package/dist/utils/sortsBefore.d.ts

@@ -0,0 +1,2 @@
+import { Currency } from '@juiceswapxyz/sdk-core';
+export declare function sortsBefore(currencyA: Currency, currencyB: Currency): boolean;

package/dist/utils/v4BaseActionsParser.d.ts

@@ -0,0 +1,45 @@
+import { PoolKey } from '../entities/pool';
+import { PathKey } from './encodeRouteToPath';
+import { Actions } from './v4Planner';
+export declare type Param = {
+    readonly name: string;
+    readonly value: any;
+};
+export declare type V4RouterAction = {
+    readonly actionName: string;
+    readonly actionType: Actions;
+    readonly params: readonly Param[];
+};
+export declare type V4RouterCall = {
+    readonly actions: readonly V4RouterAction[];
+};
+export declare type SwapExactInSingle = {
+    readonly poolKey: PoolKey;
+    readonly zeroForOne: boolean;
+    readonly amountIn: string;
+    readonly amountOutMinimum: string;
+    readonly hookData: string;
+};
+export declare type SwapExactIn = {
+    readonly currencyIn: string;
+    readonly path: readonly PathKey[];
+    readonly amountIn: string;
+    readonly amountOutMinimum: string;
+};
+export declare type SwapExactOutSingle = {
+    readonly poolKey: PoolKey;
+    readonly zeroForOne: boolean;
+    readonly amountOut: string;
+    readonly amountInMaximum: string;
+    readonly hookData: string;
+};
+export declare type SwapExactOut = {
+    readonly currencyOut: string;
+    readonly path: readonly PathKey[];
+    readonly amountOut: string;
+    readonly amountInMaximum: string;
+};
+export declare abstract class V4BaseActionsParser {
+    static parseCalldata(calldata: string): V4RouterCall;
+    private static getActions;
+}

package/dist/utils/v4Planner.d.ts

@@ -0,0 +1,55 @@
+import { BigNumber } from 'ethers';
+import { Currency, Percent, TradeType } from '@juiceswapxyz/sdk-core';
+import { Trade } from '../entities/trade';
+/**
+ * Actions
+ * @description Constants that define what action to perform
+ * Not all actions are supported yet.
+ * @enum {number}
+ */
+export declare enum Actions {
+    INCREASE_LIQUIDITY = 0,
+    DECREASE_LIQUIDITY = 1,
+    MINT_POSITION = 2,
+    BURN_POSITION = 3,
+    SWAP_EXACT_IN_SINGLE = 6,
+    SWAP_EXACT_IN = 7,
+    SWAP_EXACT_OUT_SINGLE = 8,
+    SWAP_EXACT_OUT = 9,
+    SETTLE = 11,
+    SETTLE_ALL = 12,
+    SETTLE_PAIR = 13,
+    TAKE = 14,
+    TAKE_ALL = 15,
+    TAKE_PORTION = 16,
+    TAKE_PAIR = 17,
+    CLOSE_CURRENCY = 18,
+    SWEEP = 20,
+    UNWRAP = 22
+}
+export declare enum Subparser {
+    V4SwapExactInSingle = 0,
+    V4SwapExactIn = 1,
+    V4SwapExactOutSingle = 2,
+    V4SwapExactOut = 3,
+    PoolKey = 4
+}
+export declare type ParamType = {
+    readonly name: string;
+    readonly type: string;
+    readonly subparser?: Subparser;
+};
+export declare const V4_BASE_ACTIONS_ABI_DEFINITION: {
+    [key in Actions]: readonly ParamType[];
+};
+export declare class V4Planner {
+    actions: string;
+    params: string[];
+    constructor();
+    addAction(type: Actions, parameters: any[]): V4Planner;
+    addTrade(trade: Trade<Currency, Currency, TradeType>, slippageTolerance?: Percent): V4Planner;
+    addSettle(currency: Currency, payerIsUser: boolean, amount?: BigNumber): V4Planner;
+    addTake(currency: Currency, recipient: string, amount?: BigNumber): V4Planner;
+    addUnwrap(amount: BigNumber): V4Planner;
+    finalize(): string;
+}

package/dist/utils/v4PositionPlanner.d.ts

@@ -0,0 +1,12 @@
+import { V4Planner } from './v4Planner';
+import { Pool } from '../entities';
+import { BigintIsh, Currency } from '@juiceswapxyz/sdk-core';
+export declare class V4PositionPlanner extends V4Planner {
+    addMint(pool: Pool, tickLower: number, tickUpper: number, liquidity: BigintIsh, amount0Max: BigintIsh, amount1Max: BigintIsh, owner: string, hookData?: string): void;
+    addIncrease(tokenId: BigintIsh, liquidity: BigintIsh, amount0Max: BigintIsh, amount1Max: BigintIsh, hookData?: string): void;
+    addDecrease(tokenId: BigintIsh, liquidity: BigintIsh, amount0Min: BigintIsh, amount1Min: BigintIsh, hookData?: string): void;
+    addBurn(tokenId: BigintIsh, amount0Min: BigintIsh, amount1Min: BigintIsh, hookData?: string): void;
+    addSettlePair(currency0: Currency, currency1: Currency): void;
+    addTakePair(currency0: Currency, currency1: Currency, recipient: string): void;
+    addSweep(currency: Currency, to: string): void;
+}