@imtbl/dex-sdk 2.0.0-alpha.0

package/dist/types/lib/utils.d.ts

@@ -0,0 +1,60 @@
+import { Pool } from '@uniswap/v3-sdk';
+import * as Uniswap from '@uniswap/sdk-core';
+import { JsonRpcProvider } from 'ethers';
+import { Amount, Coin, CoinAmount, ERC20, Native, Token } from '../types';
+export declare const quoteReturnMapping: {
+    [signature: string]: string[];
+};
+/**
+ * Returns true if poolA is equivalent to poolB
+ * @param poolA one of the two pools
+ * @param poolB the other pool
+ */
+export declare function poolEquals(poolA: Pool, poolB: Pool): boolean;
+export declare const decimalsFunctionSig: string;
+export declare function getTokenDecimals(tokenAddress: string, provider: JsonRpcProvider, nativeToken: Coin): Promise<number>;
+/**
+ * Based on https://github.com/ethers-io/ethers.js/blob/main/src.ts/address/checks.ts#L51
+ */
+export declare function isValidNonZeroAddress(address: string): boolean;
+export declare const isValidTokenLiteral: (address: string) => boolean;
+export declare const erc20ToUniswapToken: (token: ERC20) => Uniswap.Token;
+export declare const uniswapTokenToERC20: (token: Uniswap.Token) => ERC20;
+export declare const toBigNumber: (amount: Uniswap.CurrencyAmount<Uniswap.Token>) => bigint;
+export declare const toAmount: (amount: Uniswap.CurrencyAmount<Uniswap.Token>) => CoinAmount<ERC20>;
+export declare const toCurrencyAmount: (amount: CoinAmount<ERC20>) => Uniswap.CurrencyAmount<Uniswap.Token>;
+export declare const newAmount: <T extends Coin>(amount: bigint, token: T) => CoinAmount<T>;
+export declare const isERC20Amount: (amount: CoinAmount<Coin>) => amount is CoinAmount<ERC20>;
+export declare const isNativeAmount: (amount: CoinAmount<Coin>) => amount is CoinAmount<Native>;
+export declare const isNative: (token: Coin) => token is Native;
+export declare const addERC20Amount: (a: CoinAmount<ERC20>, b: CoinAmount<ERC20>) => {
+    value: bigint;
+    token: ERC20;
+};
+export declare const addAmount: <T extends Coin>(a: CoinAmount<T>, b: CoinAmount<T>) => {
+    value: bigint;
+    token: ERC20;
+} | {
+    value: bigint;
+    token: Native;
+};
+export declare const subtractERC20Amount: (a: CoinAmount<ERC20>, b: CoinAmount<ERC20>) => {
+    value: bigint;
+    token: ERC20;
+};
+export declare const subtractAmount: <T extends Coin>(a: CoinAmount<T>, b: CoinAmount<T>) => {
+    value: bigint;
+    token: ERC20;
+} | {
+    value: bigint;
+    token: Native;
+};
+/**
+ * Converts our internal token type which could be ERC20 or Native
+ * into a format consumable by Checkout. They require an address to be
+ * present. We populate the address with the string 'native' if it's Native.
+ * If it's ERC20, we don't need to change it.
+ */
+export declare const toPublicTokenType: (token: Coin) => Token;
+export declare const toPublicAmount: (amount: CoinAmount<Coin>) => Amount;
+export declare const getDefaultDeadlineSeconds: () => number;

package/dist/types/lib/utils.test.d.ts

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

package/dist/types/test/utils.d.ts

@@ -0,0 +1,134 @@
+import { TradeType } from '@uniswap/sdk-core';
+import { Pool } from '@uniswap/v3-sdk';
+import { ImmutableConfiguration } from '@imtbl/config';
+import { BigNumberish, BytesLike, Result } from 'ethers';
+import { QuoteResult } from '../lib/getQuotesForRoutes';
+import { NativeTokenService } from '../lib/nativeTokenService';
+import { ExchangeModuleConfiguration, SecondaryFee, CoinAmount, Coin, ERC20, Native, Amount } from '../types';
+import { IV3SwapRouter } from '../contracts/types/ImmutableSwapProxy';
+import { RoutingContracts } from '../lib';
+export declare const TEST_BASE_FEE: bigint;
+export declare const TEST_MAX_PRIORITY_FEE_PER_GAS: bigint;
+export declare const TEST_GAS_PRICE: bigint;
+export declare const TEST_TRANSACTION_GAS_USAGE: bigint;
+export declare const TEST_CHAIN_ID = 999;
+export declare const TEST_RPC_URL = "https://0.net";
+export declare const TEST_FROM_ADDRESS = "0x94fC2BcA2E71e26D874d7E937d89ce2c9113af6e";
+export declare const TEST_FEE_RECIPIENT = "0xe3ece548F1DD4B1536Eb6eE188fE35350bc1dd16";
+export declare const TEST_MAX_FEE_BASIS_POINTS = 1000;
+export declare const TEST_MULTICALL_ADDRESS = "0x66d0aB680ACEe44308edA2062b910405CC51A190";
+export declare const TEST_V3_CORE_FACTORY_ADDRESS = "0x23490b262829ACDAD3EF40e555F23d77D1B69e4e";
+export declare const TEST_QUOTER_ADDRESS = "0x9B323E56215aAdcD4f45a6Be660f287DE154AFC5";
+export declare const TEST_ROUTER_ADDRESS = "0x615FFbea2af24C55d737dD4264895A56624Da072";
+export declare const TEST_V3_MIGRATOR_ADDRESSES = "0x0Df0d2d5Cf4739C0b579C33Fdb3d8B04Bee85729";
+export declare const TEST_NONFUNGIBLE_POSITION_MANAGER_ADDRESSES = "0x446c78D97b1E78bC35864FC49AcE1f7404F163F6";
+export declare const TEST_TICK_LENS_ADDRESSES = "0x3aC4F8094b21A6c5945453007d9c52B7e15340c0";
+export declare const TEST_SWAP_PROXY_ADDRESS = "0x8dBE1f0900C5e92ad87A54521902a33ba1598C51";
+export declare const TEST_ROUTING_CONTRACTS: RoutingContracts;
+export declare const IMX_TEST_TOKEN: ERC20;
+export declare const WIMX_TEST_TOKEN: ERC20;
+export declare const WETH_TEST_TOKEN: ERC20;
+export declare const USDC_TEST_TOKEN: ERC20;
+export declare const FUN_TEST_TOKEN: ERC20;
+export declare const NATIVE_TEST_TOKEN: Native;
+export declare const nativeTokenService: NativeTokenService;
+export declare const TEST_IMMUTABLE_CONFIGURATION: ImmutableConfiguration;
+export declare const TEST_DEX_CONFIGURATION: ExchangeModuleConfiguration;
+export declare const refundETHFunctionSignature = "0x12210e8a";
+export type PromiseOrValue<T> = T | Promise<T>;
+export type SwapTest = {
+    fromAddress: string;
+    pools: Pool[];
+    inputToken: string;
+    outputToken: string;
+    intermediaryToken: string | undefined;
+};
+export declare function uniqBy<K, T extends string | number>(array: K[], comparator: (arg: K) => T): K[];
+export declare function decodePathForExactInput(path: string): {
+    inputToken: string;
+    firstPoolFee: bigint;
+    intermediaryToken: string;
+    secondPoolFee: bigint;
+    outputToken: string;
+};
+export declare function decodePathForExactOutput(path: string): {
+    outputToken: string;
+    firstPoolFee: bigint;
+    intermediaryToken: string;
+    secondPoolFee: bigint;
+    inputToken: string;
+};
+export declare function decodeMulticallExactInputWithFees(data: BytesLike): {
+    secondaryFeeParams: SecondaryFee[];
+    swapParams: IV3SwapRouter.ExactInputParamsStruct;
+    unwrapTokenParams: Result;
+    deadline: bigint;
+};
+export declare function decodeMulticallExactInputWithoutFees(data: BytesLike): {
+    swapParams: IV3SwapRouter.ExactInputParamsStruct;
+};
+export declare function decodeMulticallExactOutputWithFees(data: BytesLike): {
+    secondaryFeeParams: SecondaryFee[];
+    swapParams: IV3SwapRouter.ExactOutputParamsStruct;
+    unwrapTokenParams: Result;
+    deadline: bigint;
+};
+export declare function decodeMulticallExactInputSingleWithFees(data: BytesLike): {
+    secondaryFeeParams: SecondaryFee[];
+    swapParams: IV3SwapRouter.ExactInputSingleParamsStruct;
+    unwrapTokenParams: Result;
+    deadline: bigint;
+};
+export declare function decodeMulticallExactOutputSingleWithFees(data: BytesLike): {
+    secondaryFeeParams: SecondaryFee[];
+    swapParams: IV3SwapRouter.ExactOutputSingleParamsStruct;
+    unwrapTokenParams: Result;
+    deadline: bigint;
+};
+export declare function decodeMulticallExactInputSingleWithoutFees(data: BytesLike): {
+    swapParams: IV3SwapRouter.ExactInputSingleParamsStruct;
+};
+export declare function decodeMulticallExactOutputSingleWithoutFees(data: BytesLike): {
+    swapParams: IV3SwapRouter.ExactOutputSingleParamsStruct;
+};
+export declare function createPool(tokenIn: ERC20, tokenOut: ERC20): Pool;
+export declare function setupSwapTxTest(params?: {
+    multiPoolSwap?: boolean;
+}): SwapTest;
+type MockParams = {
+    pools: Pool[];
+    exchangeRate?: number;
+};
+export declare const amountOutFromAmountIn: (amountIn: CoinAmount<ERC20>, tokenOut: ERC20, exchangeRate: number) => CoinAmount<ERC20>;
+export declare const amountInFromAmountOut: (amountOut: CoinAmount<ERC20>, tokenIn: ERC20, exchangeRate: number) => CoinAmount<ERC20>;
+export declare function mockRouterImplementation(params: MockParams): jest.Mock<QuoteResult, [amountSpecified: CoinAmount<ERC20>, otherToken: ERC20, tradeType: TradeType, secondaryFees: SecondaryFee[], maxHops: number], any>;
+export declare function expectToBeDefined<T>(x: T): asserts x is NonNullable<T>;
+export declare function expectToBeString(x: unknown): asserts x is string;
+export declare function expectERC20(token: Coin, expectedAddress?: string): asserts token is ERC20;
+export declare function expectNative(token: Coin): asserts token is Native;
+/**
+ * Takes an arbitrary string and turns it into a valid ethereum address
+ * @param str Arbitrary string to create the address from
+ */
+export declare function makeAddr(str: string): string;
+export declare function formatAmount(amount: CoinAmount<Coin> | Amount): string;
+export declare function formatTokenAmount(amount: BigNumberish, token: ERC20): string;
+export declare function formatEther(bn: PromiseOrValue<BigNumberish>): string;
+export declare function newAmountFromString<T extends Coin>(amount: string, token: T): CoinAmount<T>;
+export declare const buildBlock: ({ baseFeePerGas }: {
+    baseFeePerGas: bigint | null;
+}) => {
+    baseFeePerGas: bigint | null;
+    difficulty: bigint;
+    extraData: string;
+    gasLimit: bigint;
+    gasUsed: bigint;
+    hash: string;
+    miner: string;
+    nonce: string;
+    number: number;
+    parentHash: string;
+    timestamp: number;
+    transactions: never[];
+};
+export {};

package/dist/types/test/utils.test.d.ts

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

package/dist/types/types/index.d.ts

@@ -0,0 +1,174 @@
+import { TransactionRequest } from 'ethers';
+import { ModuleConfiguration } from '@imtbl/config';
+export type ExchangeContracts = {
+    multicall: string;
+    coreFactory: string;
+    quoter: string;
+    swapRouter: string;
+    immutableSwapProxy: string;
+};
+/**
+ * Type representing a Chain
+ * @property {number} chainId - The chain ID
+ * @property {string} rpcUrl - The RPC URL for the chain
+ * @property {@link ExchangeContracts} contracts - The DEX contract addresses
+ * @property {@link ERC20[]} commonRoutingTokens - The tokens used to find available pools for a swap
+ * @property {@link Native} nativeToken - The native token of the chain
+ * @property {@link ERC20} wrappedNativeToken - The wrapped native token of the chain
+ */
+export type Chain = {
+    chainId: number;
+    rpcUrl: string;
+    contracts: ExchangeContracts;
+    commonRoutingTokens: ERC20[];
+    nativeToken: Native;
+    wrappedNativeToken: ERC20;
+};
+/**
+ * Type representing the secondary fees for a swap
+ * @property {string} recipient - The fee recipient address
+ * @property {number} basisPoints - The fee percentage in basis points
+ * @example 100 basis points = 1%
+ */
+export type SecondaryFee = {
+    recipient: string;
+    basisPoints: number;
+};
+/**
+ * Type representing the fees returned in the quote
+ * @property {string} recipient - The fee recipient address
+ * @property {number} basisPoints - The fee percentage in basis points
+ * @property {@link Amount} amount - The amount of the fee
+ * @example 100 basis points = 1% = 1 IMX
+ */
+export type Fee = {
+    recipient: string;
+    basisPoints: number;
+    amount: Amount;
+};
+/**
+ * Type representing an amount with the token information
+ * @property {@link Coin} token - The coin for the amount, either a {@link Native} or {@link ERC20}
+ * @property {BigInt} value - The value of the amount in the token's smallest unit
+ */
+export type CoinAmount<T extends Coin> = {
+    token: T;
+    value: bigint;
+};
+/**
+ * Type representing a quote for a swap
+ * @property {@link Amount} amount - The quoted amount with fees applied
+ * @property {@link Amount} amountWithMaxSlippage - The quoted amount with the max slippage and fees applied
+ * @property {number} slippage - The slippage percentage used to calculate the quote
+ * @property {@link Fee[]} fees - The secondary fees applied to the swap
+ */
+export type Quote = {
+    amount: Amount;
+    amountWithMaxSlippage: Amount;
+    slippage: number;
+    fees: Fee[];
+};
+/**
+ * Type representing the details of a transaction
+ * @property {@link TransactionRequest} transaction - The unsigned transaction
+ * @property {@link Amount | null} gasFeeEstimate - The gas fee estimate or null if it is not available
+ */
+export type TransactionDetails = {
+    transaction: TransactionRequest;
+    gasFeeEstimate: Amount | null;
+};
+/**
+ * Type representing the results of {@link Exchange.getUnsignedSwapTxFromAmountIn} {@link Exchange.getUnsignedSwapTxFromAmountOut}
+ * @property {@link TransactionDetails | null} approval - The approval transaction or null if it is not required
+ * @property {@link TransactionDetails} swap - The swap transaction
+ * @property {@link Quote} quote - The quote details for the swap
+ */
+export type TransactionResponse = {
+    approval: TransactionDetails | null;
+    swap: TransactionDetails;
+    quote: Quote;
+};
+/**
+ * Type representing an ERC20 token
+ * @property {string} type - The token type, used to discriminate between {@link ERC20} and {@link Native}
+ * @property {number} chainId - The chain ID
+ * @property {string} address - The token address
+ * @property {number} decimals - The token decimals
+ * @property {string | undefined} symbol - The token symbol or undefined if it is not available
+ * @property {string | undefined} name - The token name or undefined if it is not available
+ */
+export type ERC20 = {
+    type: 'erc20';
+    chainId: number;
+    address: string;
+    decimals: number;
+    symbol?: string;
+    name?: string;
+};
+/**
+ * Type representing a native token
+ * @property {string} type - The token type, used to discriminate between {@link ERC20} and {@link Native}
+ * @property {number} chainId - The chain ID
+ * @property {number} decimals - The token decimals
+ * @property {string | undefined} symbol - The token symbol or undefined if it is not available
+ * @property {string | undefined} name - The token name or undefined if it is not available
+ */
+export type Native = {
+    type: 'native';
+    chainId: number;
+    decimals: number;
+    symbol?: string;
+    name?: string;
+};
+/**
+ * Type representing a token, either an {@link ERC20} or {@link Native}
+ */
+export type Coin = ERC20 | Native;
+/**
+ * Type representing a token
+ * @property {number} chainId - The chain ID
+ * @property {string} address - The token address, or the empty string for the native token
+ * @property {number} decimals - The token decimals
+ * @property {string | undefined} symbol - The token symbol or undefined if it is not available
+ * @property {string | undefined} name - The token name or undefined if it is not available
+ */
+export type Token = {
+    chainId: number;
+    address: string;
+    decimals: number;
+    symbol?: string;
+    name?: string;
+};
+/**
+ * Interface representing a token amount
+ * @property {@link Token} token - The token
+ * @property {@link BigInt} value - The amount
+ */
+export type Amount = {
+    token: Token;
+    value: bigint;
+};
+/**
+ * Type representing the overrides for the {@link Exchange} module
+ * @property {string} rpcURL - The RPC URL for the chain
+ * @property {ExchangeContracts} exchangeContracts - The DEX contract addresses
+ * @property {ERC20[]} commonRoutingTokens - The tokens used to find available pools for a swap
+ * @property {Native} nativeToken - The native token of the chain
+ * @property {ERC20} wrappedNativeToken - The wrapped native token of the chain
+ */
+export type ExchangeOverrides = {
+    rpcURL: string;
+    exchangeContracts: ExchangeContracts;
+    commonRoutingTokens: ERC20[];
+    nativeToken: Native;
+    wrappedNativeToken: ERC20;
+};
+/**
+ * Interface representing the configuration for the {@link Exchange} module
+ * @property {number} chainId - The chain ID
+ * @property {@link SecondaryFee[]} secondaryFees - The secondary fees for a swap
+ */
+export interface ExchangeModuleConfiguration extends ModuleConfiguration<ExchangeOverrides> {
+    chainId: number;
+    secondaryFees?: SecondaryFee[];
+}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@imtbl/dex-sdk",
+  "description": "DEX Provider package for the Immutable SDK",
+  "version": "2.0.0-alpha.0",
+  "author": "Immutable",
+  "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
+  "dependencies": {
+    "@imtbl/config": "2.0.0-alpha.0",
+    "@uniswap/sdk-core": "^3.0.1",
+    "@uniswap/swap-router-contracts": "^1.3.1",
+    "@uniswap/v3-sdk": "^3.9.0",
+    "ethers": "^6.13.4"
+  },
+  "devDependencies": {
+    "@swc/core": "^1.3.36",
+    "@swc/jest": "^0.2.24",
+    "@typechain/ethers-v6": "^0.5.1",
+    "@types/jest": "^29.4.3",
+    "@types/node": "^18.14.2",
+    "eslint": "^8.40.0",
+    "jest": "^29.4.3",
+    "jest-environment-jsdom": "^29.4.3",
+    "ts-node": "^10.9.1",
+    "tsup": "^8.3.5",
+    "typechain": "^8.1.1",
+    "typescript": "^5.6.2"
+  },
+  "engines": {
+    "node": ">=20.11.0"
+  },
+  "exports": {
+    "development": {
+      "types": "./src/index.ts",
+      "browser": "./dist/browser/index.js",
+      "require": "./dist/node/index.cjs",
+      "default": "./dist/node/index.js"
+    },
+    "default": {
+      "types": "./dist/types/index.d.ts",
+      "browser": "./dist/browser/index.js",
+      "require": "./dist/node/index.cjs",
+      "default": "./dist/node/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/immutable/ts-immutable-sdk#readme",
+  "keywords": [
+    "immutablex"
+  ],
+  "license": "Apache-2.0",
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "browser": "dist/browser/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "immutable/ts-immutable-sdk.git",
+  "source": "src/index.ts",
+  "type": "module",
+  "types": "./dist/types/index.d.ts",
+  "scripts": {
+    "build": "pnpm transpile && pnpm typegen",
+    "transpile": "tsup src/index.ts --config ../../../../tsup.config.js",
+    "typegen": "tsc --customConditions default --emitDeclarationOnly --outDir dist/types",
+    "generate-types": "typechain --target ethers-v6 --out-dir ./src/contracts/types ./src/contracts/ABIs/*.json",
+    "lint": "eslint ./src --ext .ts --max-warnings=0",
+    "lint:fix": "cd ../../../.. && pnpm wsrun -p @imtbl/dex-sdk -c lint --fix",
+    "test": "jest test",
+    "test:watch": "jest --watch",
+    "typecheck": "tsc --customConditions default --noEmit"
+  }
+}