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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomo-inc/transaction-builder-sdk",
-  "version": "0.0.1-alpha.3",
+  "version": "0.0.2",
   "author": "tomo.inc",
   "files": [
     "dist/**/*",
@@ -26,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/dist/index.d.cts

@@ -1,584 +0,0 @@
-import { Hex } from 'viem';
-
-/**
- * Platform types supported by the wallet
- *
- * Represents different blockchain platforms and their specific characteristics
- */
-declare enum IPlatformType {
-    /** Ethereum Virtual Machine compatible chains */
-    EVM = "EVM",
-    /** TON (The Open Network) blockchain */
-    TON = "TON",
-    /** TRON blockchain */
-    TRON = "TRON",
-    /** Bitcoin blockchain */
-    BTC = "BTC",
-    /** Dogecoin blockchain */
-    DOGE = "DOGE",
-    /** Sui blockchain */
-    SUI = "SUI",
-    /** Cosmos ecosystem blockchains */
-    COSMOS = "COSMOS",
-    /** Aptos blockchain */
-    APTOS = "APTOS",
-    /** Solana blockchain */
-    SOLANA = "SOLANA"
-}
-/**
- * Chain information structure
- *
- * Represents detailed information about a blockchain network including
- * its properties, capabilities, and configuration details
- */
-type Chain = {
-    /** Full name of the blockchain network */
-    chainName: string;
-    /** Numeric chain identifier (e.g., 1 for Ethereum mainnet) */
-    chainId: number;
-    /** Internal index for ordering chains in UI */
-    chainIndex: number;
-    /** Whether order status tracking is supported on this chain */
-    orderStatusSupport: boolean;
-    /** Whether the chain is currently supported for operations */
-    support: boolean;
-    /** Chain type identifier */
-    type: number;
-    /** Short name or display name of the chain */
-    name: string;
-    /** Full name of the native currency (e.g., "Ethereum") */
-    nativeCurrencyName: string;
-    /** Symbol of the native currency (e.g., "ETH") */
-    nativeCurrencySymbol: string;
-    /** Decimal places for the native currency (e.g., 18 for ETH) */
-    nativeCurrencyDecimals: number;
-    /** Platform type this chain belongs to */
-    platformType: IPlatformType;
-    /** URL to the chain's icon/logo */
-    icon: string;
-    /** Whether swap operations are supported on this chain */
-    supportSwap: boolean;
-    /** Whether the chain is listed/publicly visible */
-    isListed: boolean;
-    /** Whether this is a testnet (optional) */
-    isTestnet?: boolean;
-    /** Array of RPC URLs for connecting to the chain (optional) */
-    rpcUrls?: string[];
-    /** URL to the chain's block explorer (optional) */
-    blockExplorerUrl?: string;
-};
-
-type TransactionToken = {
-    address: string;
-    chain: Chain;
-};
-type TransactionQuoteParams = {
-    sender: string | Hex;
-    recipient: string | Hex;
-    fromToken: TransactionToken;
-    toToken: TransactionToken;
-    slippage: number;
-    amount: string;
-};
-type TransactionQuoteResult = {
-    quoteID: string;
-    amountIn: string;
-    amountOut: string;
-    contract: string;
-    amountOutMin: string;
-    gasNetWorkFee: string;
-    approveGasFee: string;
-    crossNetworkFee: {
-        fromChainNetworkFee: string;
-        toChainNetworkFee: string;
-        providerServiceFee: string;
-    };
-    dexInfo: {
-        name: string;
-        displayName: string;
-        logo: string;
-    };
-    fromToken: {
-        chainID: string;
-        address: string;
-        symbol: string;
-        decimals: number;
-    };
-    toToken: {
-        chainID: string;
-        address: string;
-        symbol: string;
-        decimals: number;
-    };
-    extended: {
-        requestID: string;
-    };
-    routes: [
-        {
-            amountIn: string;
-            amountOut: string;
-            paths: [
-                {
-                    dexProvider: string;
-                    fromToken: {
-                        chainID: string;
-                        address: string;
-                        symbol: string;
-                        decimals: number;
-                    };
-                    toToken: {
-                        chainID: string;
-                        address: string;
-                        symbol: string;
-                        decimals: number;
-                    };
-                    amountIn: string;
-                    amountOut: string;
-                }
-            ];
-        }
-    ];
-    estimatedGas: {
-        feeUSD: string;
-        gasLimit: string;
-        baseFee: string;
-        priorityFee: {
-            low: string;
-            medium: string;
-            high: string;
-        };
-    };
-};
-type TransactionEVM = {
-    chainId: string;
-    data: string;
-    gasLimit: string;
-    gas?: string;
-    gasPrice: string | undefined;
-    maxFeePerGas: string | bigint | undefined;
-    maxPriorityFeePerGas: string | bigint | undefined;
-    nonce: string;
-    to: string;
-    from: string;
-    value: string;
-};
-type TransactionSOL = {
-    data: string;
-};
-type TransactionTRON = {
-    data: string;
-    value: string;
-    from: string;
-    to: string;
-    rawData: {
-        visible: boolean;
-        txID: string;
-        raw_data: any;
-        raw_data_hex: string;
-    };
-};
-type Transaction = TransactionEVM | TransactionSOL | TransactionTRON;
-type PermitSignParams = {
-    permit2InputEncode: string;
-    permitSingle: {
-        details: {
-            amount: string;
-            expiration: number;
-            nonce: number;
-            token: string;
-        };
-        sigDeadline: number;
-        spender: string;
-    };
-    signature: string;
-};
-
-type Config = {
-    API_KEY: string;
-    API_SECRET: string;
-    SALT: string;
-    CLIENT_ID: string;
-};
-type TomoStage = "dev" | "prod";
-
-declare enum SwapRouterTxEVMType {
-    APPROVE = "approve",
-    SWAP = "swap",
-    EIP712 = "EIP712"
-}
-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;
-    };
-};
-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;
-        };
-    };
-};
-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;
-    };
-};
-type SwapApiRouterTxResponseV2 = {
-    transactions: (SwapRouterTxEVMResult | SwapRouterTxSOLResult | SwapRouterTxTronResult)[];
-};
-
-declare const bridgeBuilder: (builder: (params: TransactionQuoteResult, permitSignParams?: PermitSignParams | undefined | null) => Promise<SwapApiRouterTxResponseV2>) => (params: TransactionQuoteResult, quoteParams: TransactionQuoteParams, permitParams?: {
-    signature: Hex;
-    permitTypeData: any;
-} | undefined | null) => Promise<Transaction>;
-
-declare const getApproveBuilder: (builder: (params: TransactionQuoteResult, permitSignParams?: PermitSignParams | undefined | null) => Promise<SwapApiRouterTxResponseV2>) => (params: TransactionQuoteResult, quoteParams: TransactionQuoteParams) => Promise<Transaction | undefined>;
-
-declare const getBridgeQuotes: (quote: (params: TransactionQuoteParams) => Promise<TransactionQuoteResult[]>) => (params: TransactionQuoteParams) => Promise<TransactionQuoteResult[]>;
-
-declare const getSwapQuotes: (quote: (params: TransactionQuoteParams) => Promise<TransactionQuoteResult[]>) => (params: TransactionQuoteParams) => Promise<TransactionQuoteResult[]>;
-
-declare const swapBuilder: (builder: (params: TransactionQuoteResult, permitSignParams?: PermitSignParams | undefined | null) => Promise<SwapApiRouterTxResponseV2>) => (params: TransactionQuoteResult, quoteParams: TransactionQuoteParams, permitParams?: {
-    signature: Hex;
-    permitTypeData: any;
-} | undefined | null) => Promise<Transaction>;
-
-declare class Business {
-    private apiConfig;
-    private apiMethods;
-    private _quoteMethod;
-    private _builderMethod;
-    private _bridgeBuilderMethod;
-    private _swapBuilderMethod;
-    private _getBridgeQuotesMethod;
-    private _getSwapQuotesMethod;
-    private _getApproveBuilderMethod;
-    /**
-     * Creates a new instance of the Business SDK
-     *
-     * @param options - Configuration options for the SDK
-     * @param options.routerApi - Custom router API URL for transaction routing
-     * @param options.marketApi - Custom market API URL for token information
-     */
-    constructor({ config, tomoStage }: {
-        config: Config;
-        tomoStage: TomoStage;
-    });
-    private getQuoteMethod;
-    private getBuilderMethod;
-    private getBridgeBuilderMethod;
-    private getSwapBuilderMethod;
-    private getGetBridgeQuotesMethod;
-    private getGetSwapQuotesMethod;
-    private getGetApproveBuilderMethod;
-    /**
-     * Build a cross-chain bridge transaction based on quote result
-     *
-     * This method constructs a complete transaction object for cross-chain bridge operations
-     * based on the provided quote and parameters. The resulting transaction can be directly
-     * sent to the network after signing.
-     *
-     * @param quote - The quote result from getBridgeQuotes containing route and pricing information
-     * @param quoteParams - The original quote parameters including sender, recipient, tokens and amount
-     * @param permitSignParams - Optional permit signature parameters for token approvals (required only when TomoDEX is selected in the quote)
-     * @returns Promise<Transaction> - The built transaction ready to be signed and submitted
-     *
-     * @throws Error - If fromToken and toToken are on the same chain (should use swapBuilder instead)
-     *
-     * @example
-     * ```typescript
-     * const quote = await business.getBridgeQuotes(quoteParams);
-     * const transaction = await business.bridgeBuilder(quote[0], quoteParams);
-     * ```
-     */
-    bridgeBuilder: (quote: TransactionQuoteResult, quoteParams: TransactionQuoteParams, permitSignParams?: {
-        signature: Hex;
-        permitTypeData: any;
-    } | null | undefined) => ReturnType<ReturnType<typeof bridgeBuilder>>;
-    /**
-     * Get cross-chain bridge quotes for token swaps between different chains
-     *
-     * This method fetches available routes and pricing information for cross-chain token swaps.
-     * It returns multiple quotes from different bridge providers, allowing users to choose
-     * the best option based on fees, speed, and other factors.
-     *
-     * @param params - Transaction quote parameters including sender, recipient, tokens and amount
-     * @returns Promise<TransactionQuoteResult[]> - Array of quote results containing routing information and transaction details
-     *
-     * @throws Error - If fromToken and toToken are on the same chain (should use getSwapQuotes instead)
-     *
-     * @example
-     * ```typescript
-     * const quoteParams = {
-     *   sender: "0x...",
-     *   recipient: "0x...",
-     *   fromToken: {
-     *     address: "", // Native token
-     *     chain: ethereumChain
-     *   },
-     *   toToken: {
-     *     address: "0x...", // ERC20 token on another chain
-     *     chain: bscChain
-     *   },
-     *   slippage: 0.5,
-     *   amount: "1000000000000000000" // 1 ETH in wei
-     * };
-     *
-     * const quotes = await business.getBridgeQuotes(quoteParams);
-     * ```
-     */
-    getBridgeQuotes: (params: TransactionQuoteParams) => ReturnType<ReturnType<typeof getBridgeQuotes>>;
-    /**
-     * Get same-chain swap quotes for token swaps on the same chain
-     *
-     * This method fetches available routes and pricing information for token swaps within
-     * the same blockchain network. It returns multiple quotes from different DEXes,
-     * allowing users to choose the best option based on price, fees, and liquidity.
-     *
-     * @param params - Transaction quote parameters including sender, recipient, tokens and amount
-     * @returns Promise<TransactionQuoteResult[]> - Array of quote results containing routing information and transaction details
-     *
-     * @throws Error - If fromToken and toToken are on different chains (should use getBridgeQuotes instead)
-     *
-     * @example
-     * ```typescript
-     * const quoteParams = {
-     *   sender: "0x...",
-     *   recipient: "0x...",
-     *   fromToken: {
-     *     address: "", // Native token (ETH)
-     *     chain: ethereumChain
-     *   },
-     *   toToken: {
-     *     address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
-     *     chain: ethereumChain
-     *   },
-     *   slippage: 0.5,
-     *   amount: "1000000000000000000" // 1 ETH in wei
-     * };
-     *
-     * const quotes = await business.getSwapQuotes(quoteParams);
-     * ```
-     */
-    getSwapQuotes: (params: TransactionQuoteParams) => ReturnType<ReturnType<typeof getSwapQuotes>>;
-    /**
-     * Build a same-chain swap transaction based on quote result
-     *
-     * This method constructs a complete transaction object for same-chain swap operations
-     * based on the provided quote and parameters. The resulting transaction can be directly
-     * sent to the network after signing.
-     *
-     * @param quote - The quote result from getSwapQuotes containing route and pricing information
-     * @param quoteParams - The original quote parameters including sender, recipient, tokens and amount
-     * @param permitSignParams - Optional permit signature parameters for token approvals (required only when TomoDEX is selected in the quote)
-     * @returns Promise<Transaction> - The built transaction ready to be signed and submitted
-     *
-     * @throws Error - If fromToken and toToken are on different chains (should use bridgeBuilder instead)
-     *
-     * @example
-     * ```typescript
-     * const quote = await business.getSwapQuotes(quoteParams);
-     * const transaction = await business.swapBuilder(quote[0], quoteParams);
-     * ```
-     */
-    swapBuilder: (quote: TransactionQuoteResult, quoteParams: TransactionQuoteParams, permitSignParams?: {
-        signature: Hex;
-        permitTypeData: any;
-    } | null | undefined) => ReturnType<ReturnType<typeof swapBuilder>>;
-    /**
-     * Get all supported chains for swap operations
-     *
-     * This method returns a list of all blockchain networks that are supported
-     * for swap operations. Each chain object contains information such as
-     * chain ID, name, native currency, and other relevant details needed
-     * for performing swaps on that network.
-     *
-     * @returns Chain[] - Array of supported chain objects
-     *
-     * @example
-     * ```typescript
-     * const business = new Business();
-     * const supportedChains = business.getSwapSupportChains();
-     * const ethereum = supportedChains.find(chain => chain.chainId === 1);
-     * ```
-     */
-    getSwapSupportChains: () => Chain[];
-    /**
-     * Get all supported chains for bridge operations
-     *
-     * This method returns a list of all blockchain networks that are supported
-     * for cross-chain bridge operations. Each chain object contains information such as
-     * chain ID, name, native currency, and other relevant details needed
-     * for performing cross-chain transfers on that network.
-     *
-     * @returns Chain[] - Array of supported chain objects for bridge operations
-     *
-     * @example
-     * ```typescript
-     * const business = new Business();
-     * const bridgeChains = business.getBridgeSupportChains();
-     * const bsc = bridgeChains.find(chain => chain.chainId === 56);
-     * ```
-     */
-    getBridgeSupportChains: () => Chain[];
-    /**
-     * Generate ERC20 token approval transaction for swap operations
-     *
-     * This method creates an approval transaction that allows a DEX contract to spend
-     * the user's ERC20 tokens. This is required before swapping ERC20 tokens for
-     * most DEXes (except those supporting permit signatures like TomoDEX).
-     *
-     * The method checks if an approval transaction is needed based on the quote result.
-     * If needed, it returns a transaction object that can be sent to the network.
-     *
-     * @param quote - The quote result from getSwapQuotes or getBridgeQuotes containing route information
-     * @param quoteParams - The original quote parameters including sender, recipient, tokens and amount
-     * @returns Promise<Transaction | undefined> - The approval transaction if needed, otherwise undefined
-     *
-     * @example
-     * ```typescript
-     * const quotes = await business.getSwapQuotes(quoteParams);
-     * const approveTx = await business.getApproveBuilder(quotes[0], quoteParams);
-     * if (approveTx) {
-     *   // Send approval transaction
-     *   await sendTransaction(approveTx);
-     * }
-     * ```
-     */
-    getApproveBuilder: (quote: TransactionQuoteResult, quoteParams: TransactionQuoteParams) => ReturnType<ReturnType<typeof getApproveBuilder>>;
-    /**
-     * EVM-specific permit signing utilities
-     *
-     * This namespace provides methods for handling ERC20 token approvals using
-     * EIP-712 permit signatures, which allows gasless approvals for compatible tokens.
-     */
-    evm: {
-        /**
-         * Generate EIP-712 typed data for ERC20 token permit signatures
-         *
-         * This method creates the structured data required for signing ERC20 permit
-         * transactions using EIP-712. The resulting data can be used with wallet
-         * signature methods to generate permit signatures without submitting a
-         * separate on-chain transaction.
-         *
-         * @param quoteParams - The original quote parameters including sender, recipient, tokens and amount
-         * @param quote - The quote result from getSwapQuotes or getBridgeQuotes
-         * @returns Promise<any> - EIP-712 typed data structure for signing
-         *
-         * @example
-         * ```typescript
-         * const permitTypeData = await business.evm.getPermitTypeData(quoteParams, quote);
-         * const signature = await signTypedData(permitTypeData);
-         * const unsignTx = await business.swapBuilder(quote, quoteParams, { signature, permitTypeData });
-         * ```
-         */
-        getPermitTypeData: (quoteParams: TransactionQuoteParams, quoteResult: TransactionQuoteResult) => Promise<{
-            types: {
-                PermitDetails: {
-                    name: string;
-                    type: string;
-                }[];
-                PermitSingle: {
-                    name: string;
-                    type: string;
-                }[];
-            };
-            message: {
-                details: {
-                    token: string;
-                    amount: string;
-                    expiration: number;
-                    nonce: number;
-                };
-                spender: string;
-                sigDeadline: number;
-            };
-            primaryType: string;
-            domain: {
-                name: string;
-                chainId: number;
-                verifyingContract: Hex;
-            };
-        }>;
-    };
-    tron: {
-        /**
-         * @example
-         * ```typescript
-         * const permitTypeData = await business.tron.getPermitTypeData(quoteParams, quote);
-         * const signature = await signTypedData(permitTypeData);
-         * const unsignTx = await business.swapBuilder(quote, quoteParams, { signature, permitTypeData });
-         * ```
-         */
-        getPermitTypeData: (quoteParams: TransactionQuoteParams, quoteResult: TransactionQuoteResult) => Promise<{
-            types: {
-                PermitDetails: {
-                    name: string;
-                    type: string;
-                }[];
-                PermitSingle: {
-                    name: string;
-                    type: string;
-                }[];
-            };
-            message: {
-                details: {
-                    token: `0x${string}`;
-                    amount: string;
-                    expiration: number;
-                    nonce: bigint;
-                };
-                spender: `0x${string}`;
-                sigDeadline: number;
-            };
-            primaryType: string;
-            domain: {
-                name: string;
-                chainId: number;
-                verifyingContract: string;
-            };
-            signatureHash: string;
-        }>;
-        rpc: string;
-    };
-}
-
-export { Business, type Chain, IPlatformType, type PermitSignParams, type Transaction, type TransactionEVM, type TransactionQuoteParams, type TransactionQuoteResult, type TransactionSOL, type TransactionTRON, type TransactionToken };