@deserialize/multi-vm-wallet 1.0.2 → 1.0.4

package/dist/evm/utils.d.ts

@@ -0,0 +1,214 @@
+import { Balance } from '../types';
+import { JsonRpcProvider, Wallet, TransactionReceipt } from 'ethers';
+export interface TransactionParams {
+    to: string;
+    value?: string | bigint;
+    data?: string;
+    gasLimit?: string | bigint;
+    gasPrice?: string | bigint;
+    maxFeePerGas?: string | bigint;
+    maxPriorityFeePerGas?: string | bigint;
+    nonce?: number;
+}
+interface TransactionResult {
+    hash: string;
+    receipt: TransactionReceipt | null;
+    success: boolean;
+    gasUsed?: bigint;
+    effectiveGasPrice?: bigint;
+    blockNumber?: number;
+    confirmations: number;
+}
+export interface SwapParams {
+    tokenIn: string;
+    tokenOut: string;
+    amountIn: string;
+    slippageTolerance?: number;
+    recipient?: string;
+    deadline?: number;
+    feeAmount?: string;
+    feeReceiver?: string;
+    isInBps?: boolean;
+    chargeFeeBy?: 'currency_in' | 'currency_out';
+}
+export interface KyberRoute {
+    tokenIn: string;
+    amountIn: string;
+    tokenOut: string;
+    amountOut: string;
+    gas: string;
+    gasPrice: string;
+    gasUsd: number;
+    amountOutUsd: string;
+    receivedUsd: string;
+    swaps: Array<{
+        pool: string;
+        tokenIn: string;
+        tokenOut: string;
+        swapAmount: string;
+        amountOut: string;
+        limitReturnAmount: string;
+        maxPrice: string;
+        exchange: string;
+        poolLength: number;
+        poolType: string;
+    }>;
+    tokens: {
+        [address: string]: {
+            address: string;
+            symbol: string;
+            name: string;
+            decimals: number;
+            price: number;
+        };
+    };
+}
+export interface KyberSwapResponse {
+    code: number;
+    message: string;
+    data: {
+        routeSummary: KyberRoute;
+        routerAddress: string;
+    };
+}
+export interface KyberBuildResponse {
+    code: number;
+    message: string;
+    data: {
+        amountIn: string;
+        amountInUsd: string;
+        amountOut: string;
+        amountOutUsd: string;
+        gas: string;
+        gasUsd: string;
+        outputChange: {
+            amount: string;
+            percent: number;
+            level: number;
+        };
+        data: string;
+        routerAddress: string;
+    };
+}
+interface KyberSwapParams {
+    chainId: string;
+    tokenIn: string;
+    tokenOut: string;
+    amountIn: string;
+    slippageTolerance?: number;
+    recipient?: string;
+    sender?: string;
+    deadline?: number;
+    feeAmount?: string;
+    feeReceiver?: string;
+    isInBps?: boolean;
+    chargeFeeBy?: 'currency_in' | 'currency_out';
+    clientId?: string;
+}
+export declare const getNativeBalance: (address: string, provider: JsonRpcProvider) => Promise<Balance>;
+export declare const getTokenBalance: (tokenAddress: string, walletAddress: string, provider: JsonRpcProvider) => Promise<Balance>;
+/**
+ * Sign, send, and confirm any EVM transaction
+ */
+export declare const signSendAndConfirm: (wallet: Wallet, // Connected wallet (private key + provider)
+transactionParams: TransactionParams, confirmations?: number, // Number of confirmations to wait for
+timeout?: number) => Promise<TransactionResult>;
+/**
+ * Send native token (ETH, BNB, MATIC, etc.)
+ */
+export declare const sendNativeToken: (wallet: Wallet, to: string, amount: string | bigint, // Amount in wei
+gasLimit?: string | bigint, confirmations?: number) => Promise<TransactionResult>;
+/**
+ * Send ERC-20 token
+ */
+export declare const sendERC20Token: (wallet: Wallet, tokenAddress: string, to: string, amount: string | bigint, // Amount in token's smallest unit
+gasLimit?: string | bigint, confirmations?: number) => Promise<TransactionResult>;
+/**
+ * Execute any contract method
+ */
+export declare const executeContractMethod: (wallet: Wallet, contractAddress: string, abi: any[], methodName: string, methodParams?: any[], value?: string | bigint, // For payable methods
+gasLimit?: string | bigint, confirmations?: number) => Promise<TransactionResult>;
+/**
+ * Get current gas prices (both legacy and EIP-1559)
+ */
+export declare const getGasPrices: (provider: JsonRpcProvider) => Promise<{
+    gasPrice: bigint | null;
+    maxFeePerGas: bigint | null;
+    maxPriorityFeePerGas: bigint | null;
+}>;
+/**
+ * Estimate gas for a transaction
+ */
+export declare const estimateGas: (provider: JsonRpcProvider, transactionParams: TransactionParams) => Promise<bigint>;
+/**
+ * Check ERC-20 token allowance
+ */
+export declare const checkAllowance: (tokenAddress: string, owner: string, spender: string, provider: JsonRpcProvider) => Promise<{
+    allowance: bigint;
+    formatted: string;
+    decimals: number;
+}>;
+/**
+ * Check if allowance is sufficient for a transaction
+ */
+export declare const isAllowanceSufficient: (tokenAddress: string, owner: string, spender: string, requiredAmount: string | bigint, provider: JsonRpcProvider) => Promise<boolean>;
+/**
+ * Approve ERC-20 token spending
+ */
+export declare const approveToken: (wallet: Wallet, tokenAddress: string, spender: string, amount: string | bigint, // Amount to approve, use MaxUint256 for unlimited
+gasLimit?: string | bigint, confirmations?: number) => Promise<TransactionResult>;
+/**
+ * Approve unlimited token spending (MaxUint256)
+ */
+export declare const approveTokenUnlimited: (wallet: Wallet, tokenAddress: string, spender: string, gasLimit?: string | bigint, confirmations?: number) => Promise<TransactionResult>;
+/**
+ * Check allowance and approve if necessary
+ */
+export declare const checkAndApprove: (wallet: Wallet, tokenAddress: string, spender: string, requiredAmount: string | bigint, approvalAmount?: string | bigint, // If not provided, will approve exactly the required amount
+gasLimit?: string | bigint, confirmations?: number) => Promise<{
+    approvalNeeded: boolean;
+    currentAllowance: bigint;
+    approvalResult?: TransactionResult;
+}>;
+/**
+ * Reset token allowance to zero (security best practice before setting new allowance)
+ */
+export declare const resetAllowance: (wallet: Wallet, tokenAddress: string, spender: string, gasLimit?: string | bigint, confirmations?: number) => Promise<TransactionResult>;
+/**
+ * Safe approve: Reset to zero first, then approve the desired amount
+ * (Some tokens like USDT require this)
+ */
+export declare const safeApprove: (wallet: Wallet, tokenAddress: string, spender: string, amount: string | bigint, gasLimit?: string | bigint, confirmations?: number) => Promise<{
+    resetResult: TransactionResult;
+    approveResult: TransactionResult;
+}>;
+export declare function getKyberSwapRoute(params: KyberSwapParams): Promise<KyberSwapResponse>;
+export declare function buildKyberSwapTransaction(chainId: string, routeSummary: KyberRoute, sender: string, recipient: string, slippageTolerance?: number, deadline?: number, clientId?: string): Promise<KyberBuildResponse>;
+export declare function performSwap(params: {
+    chainId: string;
+    tokenIn: string;
+    tokenOut: string;
+    amountIn: string;
+    sender: string;
+    recipient?: string;
+    slippageTolerance?: number;
+    deadline?: number;
+    feeAmount?: string;
+    feeReceiver?: string;
+    isInBps?: boolean;
+    chargeFeeBy?: 'currency_in' | 'currency_out';
+    clientId?: string;
+}): Promise<TransactionParams>;
+export declare function getKyberSupportedChains(): {
+    [key: string]: string;
+};
+export declare function isChainSupportedByKyber(chainId: string): boolean;
+export declare function getNativeTokenAddress(): string;
+export declare function formatAmountToWei(amount: string, decimals: number): string;
+export declare function formatAmountFromWei(amountWei: string, decimals: number): string;
+export declare function prepareSwapParams(tokenIn: string, tokenOut: string, amountIn: string, tokenInDecimals: number, isNativeIn?: boolean, isNativeOut?: boolean): {
+    tokenInAddress: string;
+    tokenOutAddress: string;
+    formattedAmountIn: string;
+};
+export {};