@fenine/universal-router-sdk 1.0.0

package/dist/types/src/utils/numbers.d.ts

@@ -0,0 +1,7 @@
+import { BigNumber } from 'ethers';
+import JSBI from 'jsbi';
+import { Percent } from '@fenine/sdk-core';
+export declare function expandTo18DecimalsBN(n: number): BigNumber;
+export declare function expandTo18Decimals(n: number): JSBI;
+export declare function encodeFeeBips(fee: Percent): string;
+export declare function encodeFee1e18(fee: Percent): string;

package/dist/types/src/utils/pathCurrency.d.ts

@@ -0,0 +1,3 @@
+import { Currency } from '@fenine/sdk-core';
+import { TPool } from '@uniswap/router-sdk';
+export declare function getPathCurrency(currency: Currency, pool: TPool): Currency;

package/dist/types/src/utils/routerCommands.d.ts

@@ -0,0 +1,77 @@
+import { UniversalRouterVersion } from './constants';
+import { AcrossV4DepositV3Params } from '../entities/actions/across';
+/**
+ * CommandTypes
+ * @description Flags that modify a command's execution
+ * @enum {number}
+ */
+export declare enum CommandType {
+    V3_SWAP_EXACT_IN = 0,
+    V3_SWAP_EXACT_OUT = 1,
+    PERMIT2_TRANSFER_FROM = 2,
+    PERMIT2_PERMIT_BATCH = 3,
+    SWEEP = 4,
+    TRANSFER = 5,
+    PAY_PORTION = 6,
+    PAY_PORTION_FULL_PRECISION = 7,
+    V2_SWAP_EXACT_IN = 8,
+    V2_SWAP_EXACT_OUT = 9,
+    PERMIT2_PERMIT = 10,
+    WRAP_ETH = 11,
+    UNWRAP_WETH = 12,
+    PERMIT2_TRANSFER_FROM_BATCH = 13,
+    BALANCE_CHECK_ERC20 = 14,
+    V4_SWAP = 16,
+    V3_POSITION_MANAGER_PERMIT = 17,
+    V3_POSITION_MANAGER_CALL = 18,
+    V4_INITIALIZE_POOL = 19,
+    V4_POSITION_MANAGER_CALL = 20,
+    EXECUTE_SUB_PLAN = 33,
+    ACROSS_V4_DEPOSIT_V3 = 64
+}
+export declare enum Subparser {
+    V3PathExactIn = 0,
+    V3PathExactOut = 1
+}
+export declare enum Parser {
+    Abi = 0,
+    V4Actions = 1,
+    V3Actions = 2
+}
+export type ParamType = {
+    readonly name: string;
+    readonly type: string;
+    readonly subparser?: Subparser;
+};
+export type CommandDefinition = {
+    parser: Parser.Abi;
+    params: ParamType[];
+} | {
+    parser: Parser.V4Actions;
+} | {
+    parser: Parser.V3Actions;
+};
+export declare const COMMAND_DEFINITION: {
+    [key in CommandType]: CommandDefinition;
+};
+export declare const V2V3_SWAP_COMMANDS_V2_1_1: {
+    [key: number]: CommandDefinition;
+};
+export declare class RoutePlanner {
+    commands: string;
+    inputs: string[];
+    constructor();
+    addSubPlan(subplan: RoutePlanner): RoutePlanner;
+    addCommand(type: CommandType, parameters: any[], allowRevert?: boolean, urVersion?: UniversalRouterVersion): RoutePlanner;
+    /**
+     * Add Across bridge deposit command for cross-chain bridging
+     * @param params AcrossV4DepositV3Params containing bridge parameters
+     * @returns RoutePlanner instance for chaining
+     */
+    addAcrossBridge(params: AcrossV4DepositV3Params): RoutePlanner;
+}
+export type RouterCommand = {
+    type: CommandType;
+    encodedInput: string;
+};
+export declare function createCommand(type: CommandType, parameters: any[], urVersion?: UniversalRouterVersion): RouterCommand;

package/dist/types/src/utils/routerTradeAdapter.d.ts

@@ -0,0 +1,73 @@
+import { Trade as RouterTrade } from '@uniswap/router-sdk';
+import { Currency, TradeType } from '@fenine/sdk-core';
+export type TokenInRoute = {
+    address: string;
+    chainId: number;
+    symbol: string;
+    decimals: string;
+    name?: string;
+    buyFeeBps?: string;
+    sellFeeBps?: string;
+};
+export declare enum PoolType {
+    V2Pool = "v2-pool",
+    V3Pool = "v3-pool",
+    V4Pool = "v4-pool"
+}
+export type V2Reserve = {
+    token: TokenInRoute;
+    quotient: string;
+};
+export type V2PoolInRoute = {
+    type: PoolType.V2Pool;
+    address?: string;
+    tokenIn: TokenInRoute;
+    tokenOut: TokenInRoute;
+    reserve0: V2Reserve;
+    reserve1: V2Reserve;
+    amountIn?: string;
+    amountOut?: string;
+};
+export type V3PoolInRoute = {
+    type: PoolType.V3Pool;
+    address?: string;
+    tokenIn: TokenInRoute;
+    tokenOut: TokenInRoute;
+    sqrtRatioX96: string;
+    liquidity: string;
+    tickCurrent: string;
+    fee: string;
+    amountIn?: string;
+    amountOut?: string;
+};
+export type V4PoolInRoute = {
+    type: PoolType.V4Pool;
+    address?: string;
+    tokenIn: TokenInRoute;
+    tokenOut: TokenInRoute;
+    fee: string;
+    tickSpacing: string;
+    hooks: string;
+    liquidity: string;
+    sqrtRatioX96: string;
+    tickCurrent: string;
+    amountIn?: string;
+    amountOut?: string;
+};
+export type PartialClassicQuote = {
+    tokenIn: string;
+    tokenOut: string;
+    tradeType: TradeType;
+    route: Array<(V4PoolInRoute | V3PoolInRoute | V2PoolInRoute)[]>;
+};
+export declare const isNativeCurrency: (address: string) => boolean;
+export declare class RouterTradeAdapter {
+    static fromClassicQuote(quote: PartialClassicQuote): RouterTrade<Currency, Currency, TradeType>;
+    private static toCurrency;
+    private static toPoolOrPair;
+    private static toToken;
+    private static toV3Pool;
+    private static toV4Pool;
+    private static toPair;
+    private static isVersionedRoute;
+}

package/dist/types/src/utils/validateEncodeSwaps.d.ts

@@ -0,0 +1,2 @@
+import { NormalizedSwapSpecification, SwapStep } from '../types/encodeSwaps';
+export declare function validateEncodeSwaps(spec: NormalizedSwapSpecification, swapSteps: SwapStep[]): void;

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@fenine/universal-router-sdk",
+  "version": "1.0.0",
+  "description": "SDK for integrating with the Universal Router contracts on Fenine Network",
+  "repository": "https://github.com/AvenBreaks/fenine-sdks.git",
+  "keywords": [
+    "fenine",
+    "uniswap",
+    "universal-router",
+    "ethereum"
+  ],
+  "license": "MIT",
+  "main": "./dist/cjs/src/index.js",
+  "typings": "./dist/types/src/index.d.ts",
+  "module": "./dist/esm/src/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/types/src/index.d.ts",
+      "import": "./dist/esm/src/index.js",
+      "require": "./dist/cjs/src/index.js"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "yarn clean && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && tsc -p tsconfig.types.json",
+    "clean": "rm -rf dist",
+    "release": "npm publish --access public",
+    "test": "bun test test/unit/"
+  },
+  "dependencies": {
+    "@ethersproject/abi": "^5.5.0",
+    "@ethersproject/abstract-signer": "^5.7.0",
+    "@fenine/permit2-sdk": "^1.0.0",
+    "@fenine/sdk-core": "^1.0.0",
+    "@fenine/v3-sdk": "^1.0.0",
+    "@openzeppelin/contracts": "4.7.0",
+    "@uniswap/router-sdk": "^2.10.0",
+    "@uniswap/universal-router": "2.1.0",
+    "@uniswap/v2-core": "^1.0.1",
+    "@uniswap/v2-sdk": "^4.20.0",
+    "@uniswap/v3-core": "1.0.0",
+    "@uniswap/v4-sdk": "^2.1.0",
+    "bignumber.js": "^9.0.2",
+    "ethers": "^5.7.0",
+    "jsbi": "^3.1.4",
+    "tiny-invariant": "^1.1.0",
+    "tslib": "^2.3.0"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.3",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.7.16",
+    "@types/node-fetch": "^2.6.2",
+    "chai": "^4.3.6",
+    "dotenv": "^16.0.3",
+    "eslint-plugin-prettier": "^3.4.1",
+    "hardhat": "^2.25.0",
+    "prettier": "^2.4.1",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.21.2",
+    "typescript": "^4.3.3"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}