@tomo-inc/transaction-builder-sdk 0.0.1-alpha.2 → 0.0.1

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@tomo-inc/transaction-builder-sdk",
-  "version": "0.0.1-alpha.2",
+  "version": "0.0.1",
   "author": "tomo.inc",
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "private": false,
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -21,10 +26,10 @@
     "tronweb": "^6.0.3"
   },
   "devDependencies": {
-    "@tomo-inc/tomo-api": "workspace:*",
     "@types/node": "^20.11.19",
     "tsup": "^8.3.5",
     "typescript": "^5.3.3",
-    "vitest": "^3.0.8"
+    "vitest": "^3.0.8",
+    "@tomo-inc/tomo-api": "0.0.2"
   }
-}
+}

package/project.json

@@ -1,52 +0,0 @@
-{
-  "name": "transaction-builder-sdk",
-  "sourceRoot": "packages/transaction-builder-sdk/src",
-  "projectType": "library",
-  "targets": {
-    "build": {
-      "executor": "nx:run-commands",
-      "outputs": ["{projectRoot}/dist"],
-      "options": {
-        "command": "tsup",
-        "cwd": "packages/transaction-builder-sdk"
-      }
-    },
-    "dev": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "tsup --watch",
-        "cwd": "packages/transaction-builder-sdk"
-      }
-    },
-    "test": {
-      "executor": "nx:run-commands",
-      "outputs": ["{projectRoot}/coverage"],
-      "options": {
-        "command": "vitest run --typecheck=false src/__tests__/business.test.ts",
-        "cwd": "packages/transaction-builder-sdk"
-      }
-    },
-    "version:up": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "npm version patch --no-git-tag-version",
-        "cwd": "packages/transaction-builder-sdk"
-      }
-    },
-    "lint": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "eslint src/",
-        "cwd": "packages/transaction-builder-sdk"
-      }
-    },
-    "type-check": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "tsc --noEmit",
-        "cwd": "packages/transaction-builder-sdk"
-      }
-    }
-  },
-  "tags": ["scope:transaction-builder", "type:library"]
-}

package/src/__tests__/business.test.ts

@@ -1,315 +0,0 @@
-// __tests__/business.integration.test.ts
-import { beforeEach, describe, expect, it, vi } from "vitest";
-import { Business, Chain, TransactionQuoteParams, TransactionQuoteResult, TransactionToken } from "../";
-import { IPlatformType } from "../types/chain";
-
-describe("Business Integration", () => {
-  let business: Business;
-  let mockEthChain: Chain;
-  let mockBscChain: Chain;
-  let mockEthToken: TransactionToken;
-  let mockBnbToken: TransactionToken;
-  let mockDaiToken: TransactionToken;
-  let mockBridgeQuoteParams: TransactionQuoteParams;
-  let mockSwapQuoteParams: TransactionQuoteParams;
-
-  beforeEach(() => {
-    business = new Business({
-      config: {
-        API_KEY: "j7sjxxdv5iaqnq69ull0t1rbcc3y6yx5",
-        API_SECRET: "7bk63t810l3czi7b6vvd6gpxlqsq8ype",
-        SALT: "Tomo@2025!@#",
-        CLIENT_ID: "",
-      },
-      tomoStage: "dev",
-    });
-
-    // Setup mock chains
-    mockEthChain = {
-      chainName: "Ethereum",
-      chainId: 1,
-      chainIndex: 100,
-      orderStatusSupport: true,
-      support: true,
-      isListed: true,
-      type: 1,
-      name: "ETH",
-      nativeCurrencyName: "ETH",
-      nativeCurrencySymbol: "ETH",
-      nativeCurrencyDecimals: 18,
-      platformType: IPlatformType.EVM,
-      icon: "https://example.com/eth.png",
-      supportSwap: true,
-      isTestnet: false,
-    };
-
-    mockBscChain = {
-      chainName: "BNB Smart Chain",
-      chainId: 56,
-      chainIndex: 5600,
-      orderStatusSupport: true,
-      support: true,
-      isListed: true,
-      type: 1,
-      name: "BSC",
-      nativeCurrencyName: "BNB",
-      nativeCurrencySymbol: "BNB",
-      nativeCurrencyDecimals: 18,
-      platformType: IPlatformType.EVM,
-      icon: "https://example.com/bnb.png",
-      supportSwap: true,
-      isTestnet: false,
-    };
-
-    // Setup mock tokens
-    mockEthToken = {
-      address: "",
-      chain: mockEthChain,
-    };
-
-    mockBnbToken = {
-      address: "",
-      chain: mockBscChain,
-    };
-
-    mockDaiToken = {
-      address: "0x6B175474E89094C44Da98b954EedeAC495271d0F",
-      chain: mockEthChain,
-    };
-
-    // Setup mock quote parameters
-    mockBridgeQuoteParams = {
-      sender: "0x1234567890123456789012345678901234567890",
-      recipient: "0x1234567890123456789012345678901234567890",
-      fromToken: mockEthToken,
-      toToken: mockBnbToken,
-      slippage: 0.5,
-      amount: "1000000000000000000", // 1 ETH
-    };
-
-    mockSwapQuoteParams = {
-      sender: "0x1234567890123456789012345678901234567890",
-      recipient: "0x1234567890123456789012345678901234567890",
-      fromToken: mockEthToken,
-      toToken: mockDaiToken,
-      slippage: 0.5,
-      amount: "1000000000000000000", // 1 ETH
-    };
-  });
-
-  describe("Bridge Flow", () => {
-    it("should get bridge quotes and build bridge transaction", async () => {
-      // Mock the getBridgeQuotes implementation to return a quote result
-      const mockBridgeQuotes: TransactionQuoteResult[] = [
-        {
-          quoteID: "bridge-quote-123",
-          amountIn: "1000000000000000000",
-          amountOut: "995000000000000000",
-          contract: "0xBridgeContractAddress",
-          amountOutMin: "990000000000000000",
-          gasNetWorkFee: "21000",
-          approveGasFee: "50000",
-          crossNetworkFee: {
-            fromChainNetworkFee: "0",
-            toChainNetworkFee: "0",
-            providerServiceFee: "0",
-          },
-          dexInfo: {
-            name: "MockBridge",
-            displayName: "Mock Bridge",
-            logo: "https://example.com/bridge.png",
-          },
-          fromToken: {
-            chainID: "1",
-            address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-            symbol: "ETH",
-            decimals: 18,
-          },
-          toToken: {
-            chainID: "56",
-            address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-            symbol: "BNB",
-            decimals: 18,
-          },
-          extended: {
-            requestID: "bridge-request-123",
-          },
-          routes: [
-            {
-              amountIn: "1000000000000000000",
-              amountOut: "995000000000000000",
-              paths: [
-                {
-                  dexProvider: "MockBridge",
-                  fromToken: {
-                    chainID: "1",
-                    address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-                    symbol: "ETH",
-                    decimals: 18,
-                  },
-                  toToken: {
-                    chainID: "56",
-                    address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-                    symbol: "BNB",
-                    decimals: 18,
-                  },
-                  amountIn: "1000000000000000000",
-                  amountOut: "995000000000000000",
-                },
-              ],
-            },
-          ],
-          estimatedGas: {
-            feeUSD: "1.50",
-            gasLimit: "21000",
-            baseFee: "30",
-            priorityFee: {
-              low: "1",
-              medium: "2",
-              high: "3",
-            },
-          },
-        },
-      ];
-
-      // Mock the bridgeBuilder implementation to return a transaction
-      const mockBridgeTransaction = {
-        chainId: "0x1",
-        data: "0xBridgeTransactionData",
-        gasLimit: "21000",
-        to: "0xBridgeContractAddress",
-        from: "0xUserAddress",
-        value: "0x0",
-        nonce: "0x1",
-      };
-
-      // Mock the implementations
-      vi.spyOn(business, "getBridgeQuotes").mockResolvedValue(mockBridgeQuotes);
-      vi.spyOn(business, "bridgeBuilder").mockResolvedValue(mockBridgeTransaction);
-
-      // Execute the flow: get quotes then build transaction
-      const quotes = await business.getBridgeQuotes(mockBridgeQuoteParams);
-      const transaction = await business.bridgeBuilder(quotes[0], mockBridgeQuoteParams);
-
-      // Verify the flow
-      expect(quotes).toHaveLength(1);
-      expect(quotes[0]).toHaveProperty("quoteID", "bridge-quote-123");
-      expect(quotes[0]).toHaveProperty("amountIn", "1000000000000000000");
-
-      expect(transaction).toHaveProperty("data", "0xBridgeTransactionData");
-      expect(transaction).toHaveProperty("to", "0xBridgeContractAddress");
-
-      // Verify both methods were called
-      expect(business.getBridgeQuotes).toHaveBeenCalledWith(mockBridgeQuoteParams);
-      expect(business.bridgeBuilder).toHaveBeenCalledWith(quotes[0], mockBridgeQuoteParams);
-    });
-  });
-
-  describe("Swap Flow", () => {
-    it("should get swap quotes and build swap transaction", async () => {
-      // Mock the getSwapQuotes implementation to return a quote result
-      const mockSwapQuotes: TransactionQuoteResult[] = [
-        {
-          quoteID: "swap-quote-123",
-          amountIn: "1000000000000000000",
-          amountOut: "3000000000000000000000",
-          contract: "0xSwapContractAddress",
-          amountOutMin: "2985000000000000000000",
-          gasNetWorkFee: "150000",
-          approveGasFee: "50000",
-          crossNetworkFee: {
-            fromChainNetworkFee: "0",
-            toChainNetworkFee: "0",
-            providerServiceFee: "0",
-          },
-          dexInfo: {
-            name: "Uniswap",
-            displayName: "Uniswap V3",
-            logo: "https://example.com/uniswap.png",
-          },
-          fromToken: {
-            chainID: "1",
-            address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-            symbol: "ETH",
-            decimals: 18,
-          },
-          toToken: {
-            chainID: "1",
-            address: "0x6B175474E89094C44Da98b954EedeAC495271d0F",
-            symbol: "DAI",
-            decimals: 18,
-          },
-          extended: {
-            requestID: "swap-request-123",
-          },
-          routes: [
-            {
-              amountIn: "1000000000000000000",
-              amountOut: "3000000000000000000000",
-              paths: [
-                {
-                  dexProvider: "Uniswap",
-                  fromToken: {
-                    chainID: "1",
-                    address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-                    symbol: "ETH",
-                    decimals: 18,
-                  },
-                  toToken: {
-                    chainID: "1",
-                    address: "0x6B175474E89094C44Da98b954EedeAC495271d0F",
-                    symbol: "DAI",
-                    decimals: 18,
-                  },
-                  amountIn: "1000000000000000000",
-                  amountOut: "3000000000000000000000",
-                },
-              ],
-            },
-          ],
-          estimatedGas: {
-            feeUSD: "5.25",
-            gasLimit: "150000",
-            baseFee: "35",
-            priorityFee: {
-              low: "1",
-              medium: "2",
-              high: "3",
-            },
-          },
-        },
-      ];
-
-      // Mock the swapBuilder implementation to return a transaction
-      const mockSwapTransaction = {
-        chainId: "0x1",
-        data: "0xSwapTransactionData",
-        gasLimit: "150000",
-        to: "0xSwapContractAddress",
-        from: "0xUserAddress",
-        value: "0x0",
-        nonce: "0x2",
-      };
-
-      // Mock the implementations
-      vi.spyOn(business, "getSwapQuotes").mockResolvedValue(mockSwapQuotes);
-      vi.spyOn(business, "swapBuilder").mockResolvedValue(mockSwapTransaction);
-
-      // Execute the flow: get quotes then build transaction
-      const quotes = await business.getSwapQuotes(mockSwapQuoteParams);
-      const transaction = await business.swapBuilder(quotes[0], mockSwapQuoteParams);
-
-      // Verify the flow
-      expect(quotes).toHaveLength(1);
-      expect(quotes[0]).toHaveProperty("quoteID", "swap-quote-123");
-      expect(quotes[0]).toHaveProperty("amountOut", "3000000000000000000000");
-
-      expect(transaction).toHaveProperty("data", "0xSwapTransactionData");
-      expect(transaction).toHaveProperty("gasLimit", "150000");
-
-      // Verify both methods were called
-      expect(business.getSwapQuotes).toHaveBeenCalledWith(mockSwapQuoteParams);
-      expect(business.swapBuilder).toHaveBeenCalledWith(quotes[0], mockSwapQuoteParams);
-    });
-  });
-});

package/src/api/index.ts

@@ -1,115 +0,0 @@
-import { utils } from "@tomo-inc/tomo-api";
-import axios from "axios";
-import { ApiConfig, Config, TomoStage } from "../types";
-import { TransactionQuoteResult } from "../types/swap";
-import stageConfig from "./../constant/stage.json";
-import { IRawApiToken, SwapApiRouterTxRequestV2, SwapApiRouterTxResponseV2, SwapApiRoutesRequestV2 } from "./types";
-
-const QUOTE_API = "/api/v2/quote";
-const BUILD_TRANSACTION_API = "/api/v2/buildTransaction";
-
-const createApiConfig = (stage: TomoStage) => {
-  const routerApiUrl = stageConfig[stage].routerApiUrl;
-  const marketApiUrl = stageConfig[stage].marketApiUrl;
-
-  return {
-    routeApi: axios.create({
-      baseURL: routerApiUrl,
-      headers: {
-        "X-App-Version": "20250427",
-      },
-    }),
-    marketApi: axios.create({
-      baseURL: marketApiUrl,
-    }),
-  };
-};
-
-export const reinitializeApi = (stage: TomoStage, apiConfig: Config | null) => {
-  const { routeApi, marketApi } = createApiConfig(stage);
-
-  if (!apiConfig) {
-    throw new Error("Config was not provided");
-  }
-
-  [routeApi, marketApi].forEach((api) => {
-    api.interceptors.request.use(
-      (config) => {
-        const params = {
-          method: config.method?.toLocaleUpperCase() || "",
-          url: config.url || "",
-          data: config.data,
-          apiKey: apiConfig.API_KEY,
-          apiSecret: apiConfig.API_SECRET,
-          salt: apiConfig.SALT,
-          // debug: true,
-        };
-        const { signature, timestamp } = utils.signature.generateSignature(params);
-
-        Object.assign(config.headers ?? {}, {
-          "client-id": apiConfig.CLIENT_ID,
-          "X-APP-Key": apiConfig.API_KEY,
-          "X-Signature": signature,
-          "X-Timestamp": timestamp,
-        });
-        return config;
-      },
-      (error) => {
-        if (error?.response?.status === 401) {
-          return Promise.reject(error);
-        }
-      },
-    );
-  });
-
-  return {
-    routeApi,
-    marketApi,
-  };
-};
-
-export const reinitializeApiMethods = (apiConfig: ApiConfig) => {
-  const { routeApi, marketApi } = apiConfig;
-  if (!marketApi || !routeApi) {
-    throw new Error("API instances are not initialized");
-  }
-
-  const getTokenInfo = async (queryParameters: {
-    content: string;
-    chainIndex?: number;
-  }): Promise<{
-    data: IRawApiToken[];
-  }> => {
-    const res = await marketApi.get(`/v1/market/token/search`, {
-      params: queryParameters,
-    });
-    return res.data;
-  };
-
-  const getSwapRoutesV2 = async (params: SwapApiRoutesRequestV2): Promise<TransactionQuoteResult[]> => {
-    const res = await routeApi.post(QUOTE_API, params);
-    const data = res?.data?.result?.data;
-    if (!data) {
-      const e = new Error("No route found");
-      e.cause = res?.data;
-      throw e;
-    }
-    return data;
-  };
-
-  const getSwapRoutesTxV2 = async (params: SwapApiRouterTxRequestV2): Promise<SwapApiRouterTxResponseV2> => {
-    const res = await routeApi.post(BUILD_TRANSACTION_API, params);
-    const data = res?.data?.result;
-    if (data?.transactions[0]?.gasInfo) {
-      return res.data.result;
-    } else {
-      throw new Error("Transaction failed");
-    }
-  };
-
-  return {
-    getTokenInfo,
-    getSwapRoutesV2,
-    getSwapRoutesTxV2,
-  };
-};

package/src/api/types.ts

@@ -1,196 +0,0 @@
-import { reinitializeApiMethods } from ".";
-
-export enum SwapV2DexName {
-  OKX_SWAP = "OKXSwap",
-  OKX0 = "OKXCross0",
-  OKX1 = "OKXCross1",
-  OKX2 = "OKXCross2",
-  RANGO_BASIC = "RangoBasic",
-  RANGO_MAIN = "RangoMain",
-  JUPITER = "Jupiter",
-  ARRAKIS_BRIDGE = "ArrakisBridge",
-  SUN = "Sun",
-  TOMO = "Tomo",
-  KODIAK = "Kodiak",
-  STON = "Ston",
-  ONE_INCH = "1Inch",
-  NAVI = "Navi",
-  DOGE_OS = "DogeOS",
-}
-
-export interface SwapApiRoutesRequestV2 {
-  amount: string;
-  dexs: SwapV2DexName[]; //OKXSwap
-  dexsExclude: boolean;
-  fromToken: {
-    address: string;
-    chainID: string;
-    decimals: number;
-    symbol: string;
-  };
-  recipient: string;
-  sender: string;
-  slippage: number;
-  toToken: {
-    address: string;
-    chainID: string;
-    decimals: number;
-    symbol: string;
-  };
-  trade_id?: string;
-  quote_track_id?: string;
-  user_id?: number;
-}
-
-export type SwapApiRouterTxRequestV2 = {
-  extendedData:
-    | {
-        permit2: {
-          permit2InputEncode: string;
-          permitSingle: {
-            details: {
-              amount: string;
-              expiration: number;
-              nonce: number;
-              token: string;
-            };
-            sigDeadline: number;
-            spender: string;
-          };
-          signature: string;
-        };
-      }
-    | undefined
-    | null;
-  quoteID: string;
-  trade_id?: string;
-  user_id?: number;
-};
-
-export enum SwapRouterTxEVMType {
-  APPROVE = "approve",
-  SWAP = "swap",
-  EIP712 = "EIP712",
-}
-
-// export type CreateTxMethodParamsV2 = {
-//   fromToken: IToken;
-//   toToken: IToken;
-//   fromAmount: string;
-//   fromAddress: string;
-//   toAddress: string;
-//   slippage?: number;
-//   routeInfo: DexRouteInfoV2;
-//   feeMode: FeeMode;
-//   referrerInfo: {
-//     referrerFee: number;
-//     referrerAddress: string;
-//   }[];
-//   gasLimit?: string;
-//   gasPrice?: string;
-//   evmPermit: TypeEVMPermit | undefined;
-//   trackInfo?: TrackInfo;
-//   userInfo?: UserInfo;
-// };
-
-export type SwapRouterTxEVMResult = {
-  type: SwapRouterTxEVMType;
-  chainId: number;
-  data: string;
-  value: string;
-  from: string;
-  to: string;
-  nonce: number;
-  gasInfo: {
-    gasLimit: string;
-    baseFee: string;
-    priorityFee: {
-      low: string;
-      medium: string;
-      high: string;
-    };
-  };
-  extended: {
-    requestID: string;
-  };
-  //   params?: CreateTxMethodParamsV2;
-};
-
-export type SwapRouterTxSOLResult = {
-  type: SwapRouterTxEVMType.SWAP;
-  chainId: number;
-  data: string;
-  serializedData: string;
-  blockHash: string;
-  gasInfo: {
-    gasLimit: string;
-    baseFee: string;
-    priorityFee: {
-      low: string;
-      medium: string;
-      high: string;
-    };
-  };
-  //   params?: CreateTxMethodParamsV2;
-};
-
-export type SwapRouterTxTronResult = {
-  type: SwapRouterTxEVMType;
-  chainId: number;
-  data: string;
-  value: string;
-  from: string;
-  to: string;
-  rawData: {
-    visible: boolean;
-    txID: string;
-    raw_data: any;
-    raw_data_hex: string;
-  };
-  gasInfo: {
-    gasLimit: string;
-    baseFee: string;
-  };
-  //   params?: CreateTxMethodParamsV2;
-};
-
-export type SwapApiRouterTxResponseV2 = {
-  transactions: (SwapRouterTxEVMResult | SwapRouterTxSOLResult | SwapRouterTxTronResult)[];
-};
-
-export interface IRawApiToken {
-  createdTime: string;
-  updatedTime: string;
-  id: number;
-  name: string;
-  displayName: string;
-  symbol: string;
-  imageUrl?: string;
-  decimals: number;
-  chain: string;
-  isNative: boolean;
-  priceUsd: string;
-  realPrice?: string;
-  address: string;
-  marketCapUsd?: string;
-  risk: string;
-  riskLevel?: number;
-
-  isTomoji: boolean;
-  priceChangeH24: number;
-  change24h?: number;
-  volumeH24: string;
-  fdvUsd: string;
-  totalSupply: string;
-  websiteUrl?: string;
-  twitterUrl?: string;
-  isPoolBaseToken: boolean;
-  supportRango: boolean;
-  groupId: string;
-  liquidityUsd?: string;
-  poolAddress?: string;
-  coingeckoCoinId?: string;
-  forceSafe?: boolean;
-}
-
-export type ApiMethods = ReturnType<typeof reinitializeApiMethods>;