@juiceswapxyz/sdk-core 3.0.0 → 3.0.2

package/dist/addresses.d.ts

@@ -0,0 +1,84 @@
+import { SupportedChainsType } from './chains';
+declare type AddressMap = {
+    [chainId: number]: string;
+};
+declare type ChainAddresses = {
+    v3CoreFactoryAddress: string;
+    multicallAddress: string;
+    quoterAddress: string;
+    v3MigratorAddress?: string;
+    nonfungiblePositionManagerAddress?: string;
+    tickLensAddress?: string;
+    swapRouter02Address?: string;
+    mixedRouteQuoterV1Address?: string;
+    mixedRouteQuoterV2Address?: string;
+    proxyAdminAddress?: string;
+    v4PoolManagerAddress?: string;
+    v4PositionManagerAddress?: string;
+    v4StateView?: string;
+    v4QuoterAddress?: string;
+    juiceSwapGatewayAddress?: string;
+    juiceSwapGovernorAddress?: string;
+    juiceSwapFeeCollectorAddress?: string;
+    l0UsdcAddress?: string;
+    l0UsdtAddress?: string;
+    l0WbtcAddress?: string;
+    l0UsdcOftAddress?: string;
+    l0UsdtOftAddress?: string;
+    l0WbtcOftAddress?: string;
+};
+export declare const UNI_ADDRESSES: AddressMap;
+export declare const UNISWAP_NFT_AIRDROP_CLAIM_ADDRESS = "0x8B799381ac40b838BBA4131ffB26197C432AFe78";
+/**
+ * @deprecated use V2_FACTORY_ADDRESSES instead
+ */
+export declare const V2_FACTORY_ADDRESS = "0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f";
+export declare const V2_FACTORY_ADDRESSES: AddressMap;
+/**
+ * @deprecated use V2_ROUTER_ADDRESSES instead
+ */
+export declare const V2_ROUTER_ADDRESS = "0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D";
+export declare const V2_ROUTER_ADDRESSES: AddressMap;
+/**
+ * V2 Pair init code hash for CREATE2 pair address computation.
+ * Computed from: keccak256(UniswapV2Pair.creationCode)
+ * Source: @juiceswapxyz/v2-core (branded LP tokens: "JuiceSwap V2" / "JUICE-V2")
+ * Must match: v2-periphery/contracts/libraries/UniswapV2Library.sol line 29
+ */
+export declare const V2_INIT_CODE_HASH = "0xdc3b9f52403077ec7261ad325e15f34e395cf7e2a5c3782098edb10a7599cc3e";
+export declare const CHAIN_TO_ADDRESSES_MAP: Record<SupportedChainsType, ChainAddresses>;
+export declare const V3_CORE_FACTORY_ADDRESSES: AddressMap;
+export declare const V3_MIGRATOR_ADDRESSES: AddressMap;
+export declare const MULTICALL_ADDRESSES: AddressMap;
+/**
+ * The oldest V0 governance address
+ */
+export declare const GOVERNANCE_ALPHA_V0_ADDRESSES: AddressMap;
+/**
+ * The older V1 governance address
+ */
+export declare const GOVERNANCE_ALPHA_V1_ADDRESSES: AddressMap;
+/**
+ * The latest governor bravo that is currently admin of timelock
+ */
+export declare const GOVERNANCE_BRAVO_ADDRESSES: AddressMap;
+export declare const TIMELOCK_ADDRESSES: AddressMap;
+export declare const MERKLE_DISTRIBUTOR_ADDRESS: AddressMap;
+export declare const ARGENT_WALLET_DETECTOR_ADDRESS: AddressMap;
+export declare const QUOTER_ADDRESSES: AddressMap;
+export declare const NONFUNGIBLE_POSITION_MANAGER_ADDRESSES: AddressMap;
+export declare const ENS_REGISTRAR_ADDRESSES: AddressMap;
+export declare const SOCKS_CONTROLLER_ADDRESSES: AddressMap;
+export declare const TICK_LENS_ADDRESSES: AddressMap;
+export declare const MIXED_ROUTE_QUOTER_V1_ADDRESSES: AddressMap;
+export declare const SWAP_ROUTER_02_ADDRESSES: (chainId: number) => string;
+export declare const JUICESWAP_GATEWAY_ADDRESSES: AddressMap;
+export declare const JUICESWAP_GOVERNOR_ADDRESSES: AddressMap;
+export declare const JUICESWAP_FEE_COLLECTOR_ADDRESSES: AddressMap;
+export declare const L0_USDC_ADDRESSES: AddressMap;
+export declare const L0_USDT_ADDRESSES: AddressMap;
+export declare const L0_WBTC_ADDRESSES: AddressMap;
+export declare const L0_USDC_OFT_ADDRESSES: AddressMap;
+export declare const L0_USDT_OFT_ADDRESSES: AddressMap;
+export declare const L0_WBTC_OFT_ADDRESSES: AddressMap;
+export {};

package/dist/chains.d.ts

@@ -0,0 +1,47 @@
+export declare enum ChainId {
+    MAINNET = 1,
+    GOERLI = 5,
+    SEPOLIA = 11155111,
+    OPTIMISM = 10,
+    OPTIMISM_GOERLI = 420,
+    OPTIMISM_SEPOLIA = 11155420,
+    ARBITRUM_ONE = 42161,
+    ARBITRUM_GOERLI = 421613,
+    ARBITRUM_SEPOLIA = 421614,
+    POLYGON = 137,
+    POLYGON_MUMBAI = 80001,
+    CELO = 42220,
+    CELO_ALFAJORES = 44787,
+    GNOSIS = 100,
+    MOONBEAM = 1284,
+    BNB = 56,
+    AVALANCHE = 43114,
+    BASE_GOERLI = 84531,
+    BASE_SEPOLIA = 84532,
+    BASE = 8453,
+    ZORA = 7777777,
+    ZORA_SEPOLIA = 999999999,
+    ROOTSTOCK = 30,
+    BLAST = 81457,
+    ZKSYNC = 324,
+    WORLDCHAIN = 480,
+    UNICHAIN_SEPOLIA = 1301,
+    UNICHAIN = 130,
+    MONAD_TESTNET = 10143,
+    SONEIUM = 1868,
+    CITREA_TESTNET = 5115,
+    CITREA_MAINNET = 4114
+}
+export declare const SUPPORTED_CHAINS: readonly [ChainId.MAINNET, ChainId.OPTIMISM, ChainId.OPTIMISM_GOERLI, ChainId.OPTIMISM_SEPOLIA, ChainId.ARBITRUM_ONE, ChainId.ARBITRUM_GOERLI, ChainId.ARBITRUM_SEPOLIA, ChainId.POLYGON, ChainId.POLYGON_MUMBAI, ChainId.GOERLI, ChainId.SEPOLIA, ChainId.CELO_ALFAJORES, ChainId.CELO, ChainId.BNB, ChainId.AVALANCHE, ChainId.BASE, ChainId.BASE_GOERLI, ChainId.BASE_SEPOLIA, ChainId.ZORA, ChainId.ZORA_SEPOLIA, ChainId.ROOTSTOCK, ChainId.BLAST, ChainId.ZKSYNC, ChainId.WORLDCHAIN, ChainId.UNICHAIN_SEPOLIA, ChainId.UNICHAIN, ChainId.MONAD_TESTNET, ChainId.SONEIUM, ChainId.CITREA_TESTNET, ChainId.CITREA_MAINNET];
+export declare type SupportedChainsType = (typeof SUPPORTED_CHAINS)[number];
+export declare enum NativeCurrencyName {
+    ETHER = "ETH",
+    MATIC = "MATIC",
+    CELO = "CELO",
+    GNOSIS = "XDAI",
+    MOONBEAM = "GLMR",
+    BNB = "BNB",
+    AVAX = "AVAX",
+    ROOTSTOCK = "RBTC",
+    CITREA_BTC = "cBTC"
+}

package/dist/constants.d.ts

@@ -0,0 +1,12 @@
+import JSBI from 'jsbi';
+export declare 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/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/entities/bridgedTokens.d.ts

@@ -0,0 +1,19 @@
+import { Token } from './token';
+/**
+ * Bridged USDC.e on Citrea Mainnet (via LayerZero)
+ */
+export declare const USDC_E: {
+    [chainId: number]: Token;
+};
+/**
+ * Bridged USDT.e on Citrea Mainnet (via LayerZero)
+ */
+export declare const USDT_E: {
+    [chainId: number]: Token;
+};
+/**
+ * Bridged WBTC.e on Citrea Mainnet (via LayerZero OFT)
+ */
+export declare const WBTC_E: {
+    [chainId: number]: Token;
+};

package/dist/entities/currency.d.ts

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

package/dist/entities/ether.d.ts

@@ -0,0 +1,13 @@
+import { Currency } from './currency';
+import { NativeCurrency } from './nativeCurrency';
+import { Token } from './token';
+/**
+ * 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;
+}

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

@@ -0,0 +1,31 @@
+import JSBI from 'jsbi';
+import { Currency } from '../currency';
+import { Token } from '../token';
+import { Fraction } from './fraction';
+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(format?: object): string;
+    get wrapped(): CurrencyAmount<Token>;
+}

package/dist/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/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/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/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/entities/index.d.ts

@@ -0,0 +1,7 @@
+export * from './fractions';
+export * from './currency';
+export * from './ether';
+export * from './nativeCurrency';
+export * from './token';
+export * from './weth9';
+export * from './bridgedTokens';

package/dist/entities/nativeCurrency.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 NativeCurrency extends BaseCurrency {
+    readonly isNative: true;
+    readonly isToken: false;
+}

package/dist/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/entities/weth9.d.ts

@@ -0,0 +1,7 @@
+import { Token } from './token';
+/**
+ * Known WETH9 implementation addresses, used in our implementation of Ether#wrapped
+ */
+export declare const WETH9: {
+    [chainId: number]: Token;
+};

package/dist/index.d.ts

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

package/dist/index.js

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