stableflow-ai-sdk 1.0.0 → 2.0.0

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+import * as _solana_web3_js from '@solana/web3.js';
+import { Connection, PublicKey } from '@solana/web3.js';
+import { ethers } from 'ethers';
+
 type ApiRequestOptions = {
     readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
     readonly url: string;
@@ -495,6 +499,101 @@ declare namespace TokenResponse {
     }
 }
 
+type ServiceType = "oneclick" | "usdt0" | "cctp";
+declare const Service: {
+    readonly OneClick: "oneclick";
+    readonly Usdt0: "usdt0";
+    readonly CCTP: "cctp";
+};
+
+type ChainType = "near" | "sol" | "evm" | "tron" | "aptos";
+
+interface ChainConfig {
+    chainName: string;
+    chainIcon: string;
+    chainIconGray: string;
+    chainType: ChainType;
+    chainId?: number;
+    blockExplorerUrl: string;
+    primaryColor: string;
+    nativeToken: {
+        symbol: string;
+        decimals: number;
+    };
+    rpcUrl: string;
+}
+
+interface TokenConfig extends ChainConfig {
+    symbol: string;
+    decimals: number;
+    icon: string;
+    assetId: string;
+    contractAddress: string;
+    services: ServiceType[];
+}
+
+declare enum SendType {
+    SEND = "SEND",
+    TRANSFER = "TRANSFER"
+}
+
+interface WalletConfig {
+    transfer(params: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<string>;
+    getBalance(token: TokenConfig, account: string): Promise<string>;
+    balanceOf(token: TokenConfig, account: string): Promise<string>;
+    allowance?(params: {
+        contractAddress: string;
+        spender: string;
+        address: string;
+        amountWei: string | number | BigInt;
+    }): Promise<{
+        allowance: string;
+        needApprove: boolean;
+    }>;
+    approve?(params: {
+        contractAddress: string;
+        spender: string;
+        amountWei: string | number | BigInt;
+        isApproveMax?: boolean;
+    }): Promise<boolean>;
+    quote(type: ServiceType, params: {}): Promise<{
+        needApprove?: boolean;
+        approveSpender?: string;
+        sendParam?: any;
+        quoteParam: any;
+        fees?: Record<string, string>;
+        totalFeesUsd?: string;
+        estimateSourceGas?: BigInt;
+        estimateSourceGasUsd?: string;
+        estimateTime?: number;
+        outputAmount?: string;
+    }>;
+    send(type: SendType, params: any): Promise<string>;
+}
+
+declare enum TransactionStatus {
+    Pending = "pending",
+    Success = "success",
+    Failed = "failed"
+}
+
+interface GetAllQuoteParams {
+    singleService?: ServiceType;
+    dry?: boolean;
+    prices: Record<string, string>;
+    fromToken: TokenConfig;
+    toToken: TokenConfig;
+    wallet: WalletConfig;
+    recipient: string;
+    refundTo: string;
+    amountWei: string;
+    slippageTolerance: number;
+    minInputAmount?: string;
+}
 /**
  * StableFlow AI Service
  * Main service class for interacting with the StableFlow AI API
@@ -507,6 +606,7 @@ declare class SFA {
      * Each token entry includes its blockchain, contract address (if available), price in USD, and other metadata such as symbol and decimals.
      * @returns TokenResponse
      * @throws ApiError
+     * @deprecated Please use the import { tokens } from 'stableflow-ai-sdk';
      */
     static getTokens(): CancelablePromise<Array<TokenResponse>>;
     /**
@@ -521,6 +621,7 @@ declare class SFA {
      * @param requestBody
      * @returns QuoteResponse
      * @throws ApiError
+     * @deprecated Please use the getAllQuote
      */
     static getQuote(requestBody: QuoteRequest): CancelablePromise<QuoteResponse>;
     /**
@@ -532,18 +633,340 @@ declare class SFA {
      * @param depositMemo
      * @returns GetExecutionStatusResponse
      * @throws ApiError
+     * @deprecated Please use the getStatus
      */
     static getExecutionStatus(depositAddress: string, depositMemo?: string): CancelablePromise<GetExecutionStatusResponse>;
     /**
      * Submit deposit transaction hash
      * Optionally notifies the StableFlow AI service that a deposit has been sent to the specified address, using the blockchain transaction hash.
+     * Only for Oneclick project
      *
      * This step can speed up swap processing by allowing the system to preemptively verify the deposit.
      * @param requestBody
      * @returns SubmitDepositTxResponse
      * @throws ApiError
+     * @deprecated the send method will submit the tx hash automatically
      */
-    static submitDepositTx(requestBody: SubmitDepositTxRequest): CancelablePromise<SubmitDepositTxResponse>;
+    static submitDepositTx: (requestBody: SubmitDepositTxRequest) => CancelablePromise<SubmitDepositTxResponse>;
+    /**
+     * Get quotes from all available bridge services
+     * Retrieves quotes from all supported bridge services (OneClick, CCTP, USDT0) in parallel.
+     * Returns an array of quotes with their corresponding service types, allowing users to compare and select the best route.
+     *
+     * @param params Parameters for quote request including wallet, tokens, amount, etc.
+     * @returns Promise resolving to an array of quote results with service type information
+     * @throws Error if all bridge services fail or if required parameters are missing
+     */
+    static getAllQuote(params: GetAllQuoteParams): Promise<Array<{
+        serviceType: ServiceType;
+        quote?: any;
+        error?: string;
+    }>>;
+    /**
+     * Send transaction for the selected bridge route
+     * Executes the transaction using the specified bridge service based on the service type.
+     *
+     * @param serviceType The type of bridge service to use (oneclick, cctp, or usdt0)
+     * @param params Parameters for sending the transaction including wallet, tokens, deposit address, etc.
+     * @returns Promise resolving to the transaction hash or signature
+     * @throws Error if the service type is invalid or if the transaction fails
+     */
+    static send(serviceType: ServiceType, params: {
+        wallet: any;
+        quote: any;
+    }): Promise<string>;
+    /**
+     * Get transaction status for the selected bridge route
+     * Queries the transaction status from the specified bridge service.
+     *
+     * @param serviceType The type of bridge service used (oneclick, cctp, or usdt0)
+     * @param params Parameters for querying status including deposit address, transaction hash, etc.
+     * @returns Promise resolving to the transaction status response
+     * @throws Error if the service type is invalid or if the status query fails
+     */
+    static getStatus(serviceType: ServiceType, params: {
+        depositAddress?: string;
+        hash?: string;
+    }): Promise<{
+        status: TransactionStatus;
+        toChainTxHash?: string;
+    }>;
+}
+
+declare const tokens: TokenConfig[];
+declare const usdtTokens: TokenConfig[];
+declare const usdcTokens: TokenConfig[];
+
+declare const usdtChains: Record<string, TokenConfig>;
+
+declare const usdcChains: Record<string, TokenConfig>;
+
+declare class NearWallet {
+    private selector;
+    private rpcUrl;
+    constructor(_selector: any);
+    private query;
+    transfer(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<any>;
+    getBalance(token: any, _account: string): Promise<any>;
+    balanceOf(token: any, account: string): Promise<any>;
+    /**
+     * Get native NEAR balance
+     * @param account Account ID
+     * @returns NEAR balance in yoctoNEAR (smallest unit)
+     */
+    getNearBalance(account: string): Promise<string>;
+    /**
+     * Estimate gas limit for transfer transaction
+     * @param data Transfer data
+     * @returns Gas limit estimate, gas price, and estimated gas cost
+     */
+    estimateTransferGas(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<{
+        gasLimit: bigint;
+        gasPrice: bigint;
+        estimateGas: bigint;
+    }>;
+    checkTransactionStatus(txHash: string): Promise<void>;
+    quoteOneClickProxy(params: any): Promise<any>;
+    sendTransaction(params: any): Promise<any>;
+    /**
+     * Unified quote method that routes to specific quote methods based on type
+     * @param type Service type from ServiceType
+     * @param params Parameters for the quote
+     */
+    quote(type: ServiceType, params: any): Promise<any>;
+    /**
+     * Unified send method that routes to specific send methods based on type
+     * @param type Send type from SendType enum
+     * @param params Parameters for the send transaction
+     */
+    send(type: SendType, params: any): Promise<any>;
 }
 
-export { ApiError, type AppFee, type BadRequestResponse, CancelError, CancelablePromise, GetExecutionStatusResponse, OpenAPI, type OpenAPIConfig, type Quote, QuoteRequest, type QuoteResponse, SFA, type SubmitDepositTxRequest, SubmitDepositTxResponse, type SwapDetails, TokenResponse, type TransactionDetails };
+declare class SolanaWallet {
+    connection: Connection;
+    private publicKey;
+    private signTransaction;
+    private signer;
+    constructor(options: {
+        publicKey: PublicKey | null;
+        signer: any;
+    });
+    transferSOL(to: string, amount: string): Promise<string>;
+    transferToken(tokenMint: string, to: string, amount: string): Promise<string>;
+    transfer(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<string>;
+    getSOLBalance(account: string): Promise<number>;
+    getTokenBalance(tokenMint: string, account: string): Promise<bigint | 0>;
+    getBalance(token: any, account: string): Promise<number | bigint>;
+    balanceOf(token: any, account: string): Promise<number | bigint>;
+    /**
+     * Estimate gas limit for transfer transaction
+     * @param data Transfer data
+     * @returns Gas limit estimate, gas price, and estimated gas cost
+     */
+    estimateTransferGas(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<{
+        gasLimit: bigint;
+        gasPrice: bigint;
+        estimateGas: bigint;
+    }>;
+    checkTransactionStatus(signature: string): Promise<boolean>;
+    simulateIx(ix: any): Promise<_solana_web3_js.SimulatedTransactionResponse>;
+    sendTransaction(params: any): Promise<string>;
+    /**
+     * Unified quote method that routes to specific quote methods based on type
+     * @param type Service type from ServiceType
+     * @param params Parameters for the quote
+     */
+    quote(type: ServiceType, params: any): Promise<any>;
+    /**
+     * Unified send method that routes to specific send methods based on type
+     * @param type Send type from SendType enum
+     * @param params Parameters for the send transaction
+     */
+    send(type: SendType, params: any): Promise<string>;
+    quoteOneClickProxy(params: any): Promise<any>;
+    quoteCCTP(params: any): Promise<any>;
+    createAssociatedTokenAddress(params: any): Promise<PublicKey>;
+}
+
+declare class EVMWallet {
+    provider: any;
+    signer: any;
+    constructor(_provider: any, _signer?: any);
+    transfer(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<any>;
+    getBalance(token: any, account: string): Promise<any>;
+    balanceOf(token: any, account: string): Promise<any>;
+    /**
+     * Estimate gas limit for transfer transaction
+     * @param data Transfer data
+     * @returns Gas limit estimate, gas price, and estimated gas cost
+     */
+    estimateTransferGas(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<{
+        gasLimit: bigint;
+        gasPrice: bigint;
+        estimateGas: bigint;
+    }>;
+    getContract(params: any): ethers.Contract;
+    allowance(params: any): Promise<{
+        contract: ethers.Contract;
+        allowance: string;
+        needApprove: boolean;
+    }>;
+    approve(params: any): Promise<boolean>;
+    getEstimateGas(params: any): Promise<{
+        gasPrice: any;
+        usd: string;
+        wei: bigint;
+        amount: string;
+    }>;
+    quoteOFT(params: any): Promise<any>;
+    sendTransaction(params: any): Promise<any>;
+    /**
+     * Unified quote method that routes to specific quote methods based on type
+     * @param type Service type from ServiceType
+     * @param params Parameters for the quote
+     */
+    quote(type: ServiceType, params: any): Promise<any>;
+    /**
+     * Unified send method that routes to specific send methods based on type
+     * @param type Send type from SendType enum
+     * @param params Parameters for the send transaction
+     */
+    send(type: SendType, params: any): Promise<any>;
+    quoteCCTP(params: any): Promise<any>;
+    quoteOneClickProxy(params: any): Promise<any>;
+}
+
+declare class TronWallet {
+    private signAndSendTransaction;
+    private tronWeb;
+    constructor(options: any);
+    waitForTronWeb(): Promise<unknown>;
+    transfer(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<any>;
+    transferTRX(to: string, amount: string): Promise<any>;
+    transferToken(contractAddress: string, to: string, amount: string): Promise<any>;
+    getBalance(token: any, account: string): Promise<any>;
+    getTRXBalance(account: string): Promise<any>;
+    getTokenBalance(contractAddress: string, account: string): Promise<any>;
+    balanceOf(token: any, account: string): Promise<any>;
+    /**
+     * Estimate gas limit for transfer transaction
+     * @param data Transfer data
+     * @returns Gas limit estimate (bandwidth or energy), gas price, and estimated gas cost
+     */
+    estimateTransferGas(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<{
+        gasLimit: bigint;
+        gasPrice: bigint;
+        estimateGas: bigint;
+    }>;
+    checkTransactionStatus(txHash: string): Promise<boolean>;
+    allowance(params: any): Promise<{
+        contract: any;
+        allowance: string;
+        needApprove: boolean;
+    }>;
+    approve(params: any): Promise<any>;
+    getEnergyPrice(): Promise<any>;
+    toBytes32(addr: string): string;
+    quoteOFT(params: any): Promise<any>;
+    sendTransaction(params: any): Promise<any>;
+    /**
+     * Unified quote method that routes to specific quote methods based on type
+     * @param type Service type from ServiceType
+     * @param params Parameters for the quote
+     */
+    quote(type: ServiceType, params: any): Promise<any>;
+    /**
+     * Unified send method that routes to specific send methods based on type
+     * @param type Send type from SendType enum
+     * @param params Parameters for the send transaction
+     */
+    send(type: SendType, params: any): Promise<any>;
+    quoteOneClickProxy(params: any): Promise<any>;
+}
+
+declare class AptosWallet {
+    connection: any;
+    private account;
+    private aptos;
+    private signAndSubmitTransaction;
+    constructor(options: {
+        account: any | null;
+        signAndSubmitTransaction: any;
+    });
+    transferAPT(to: string, amount: string): Promise<string>;
+    transferToken(contractAddress: string, to: string, amount: string): Promise<string>;
+    transfer(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<string>;
+    getAPTBalance(account: string): Promise<string>;
+    getTokenBalance(contractAddress: string, account: string): Promise<string>;
+    getBalance(token: any, account: string): Promise<string>;
+    balanceOf(token: any, account: string): Promise<string>;
+    /**
+     * Estimate gas limit for transfer transaction
+     * @param data Transfer data
+     * @returns Gas limit estimate, gas price, and estimated gas cost
+     */
+    estimateTransferGas(data: {
+        originAsset: string;
+        depositAddress: string;
+        amount: string;
+    }): Promise<{
+        gasLimit: bigint;
+        gasPrice: bigint;
+        estimateGas: bigint;
+    }>;
+    checkTransactionStatus(signature: string): Promise<boolean>;
+    quoteOneClickProxy(params: any): Promise<any>;
+    sendTransaction(params: any): Promise<any>;
+    /**
+    * Unified quote method that routes to specific quote methods based on type
+    * @param type Service type from ServiceType
+    * @param params Parameters for the quote
+    */
+    quote(type: ServiceType, params: any): Promise<any>;
+    /**
+     * Unified send method that routes to specific send methods based on type
+     * @param type Send type from SendTypeSENDm
+     * @param params Parameters for the send transaction
+     */
+    send(type: SendType, params: any): Promise<any>;
+}
+
+declare const chainsRpcUrls: Record<string, string>;
+
+export { ApiError, type AppFee, AptosWallet, type BadRequestResponse, CancelError, CancelablePromise, EVMWallet, type GetAllQuoteParams, GetExecutionStatusResponse, NearWallet, OpenAPI, type OpenAPIConfig, type Quote, QuoteRequest, type QuoteResponse, SFA, Service, type ServiceType, SolanaWallet, type SubmitDepositTxRequest, SubmitDepositTxResponse, type SwapDetails, type TokenConfig, TokenResponse, type TransactionDetails, TransactionStatus, TronWallet, chainsRpcUrls, tokens, usdcChains, usdcTokens, usdtChains, usdtTokens };