@deserialize/multi-vm-wallet 1.4.12 → 1.5.1

package/dist/evm/transaction.utils.js

@@ -15,34 +15,21 @@ exports.determineTransactionAssetType = determineTransactionAssetType;
 exports.parseTypedDataMessage = parseTypedDataMessage;
 exports.isEqualCaseInsensitive = isEqualCaseInsensitive;
 const viem_1 = require("viem");
-// ============================================================================
-// Types & Constants
-// ============================================================================
-/**
- * Enum representing different transaction types
- */
 var TransactionType;
 (function (TransactionType) {
-    // Token operations
     TransactionType["tokenMethodApprove"] = "approve";
     TransactionType["tokenMethodSetApprovalForAll"] = "setApprovalForAll";
     TransactionType["tokenMethodTransfer"] = "transfer";
     TransactionType["tokenMethodTransferFrom"] = "transferFrom";
     TransactionType["tokenMethodIncreaseAllowance"] = "increaseAllowance";
     TransactionType["tokenMethodSafeTransferFrom"] = "safeTransferFrom";
-    // Contract operations
     TransactionType["contractInteraction"] = "contractInteraction";
     TransactionType["deployContract"] = "deployContract";
-    // Simple transfers
     TransactionType["simpleSend"] = "simpleSend";
-    // Special operations
     TransactionType["cancel"] = "cancel";
     TransactionType["retry"] = "retry";
     TransactionType["swap"] = "swap";
 })(TransactionType || (exports.TransactionType = TransactionType = {}));
-/**
- * Enum representing asset types
- */
 var AssetType;
 (function (AssetType) {
     AssetType["native"] = "NATIVE";
@@ -50,9 +37,6 @@ var AssetType;
     AssetType["NFT"] = "NFT";
     AssetType["unknown"] = "UNKNOWN";
 })(AssetType || (exports.AssetType = AssetType = {}));
-/**
- * Enum representing token standards
- */
 var TokenStandard;
 (function (TokenStandard) {
     TokenStandard["ERC20"] = "ERC20";
@@ -60,12 +44,6 @@ var TokenStandard;
     TokenStandard["ERC1155"] = "ERC1155";
     TokenStandard["none"] = "none";
 })(TokenStandard || (exports.TokenStandard = TokenStandard = {}));
-// ============================================================================
-// ABIs
-// ============================================================================
-/**
- * ERC20 token ABI (essential methods only)
- */
 const ERC20_ABI = (0, viem_1.parseAbi)([
     'function approve(address spender, uint256 amount) returns (bool)',
     'function transfer(address to, uint256 amount) returns (bool)',
@@ -76,9 +54,6 @@ const ERC20_ABI = (0, viem_1.parseAbi)([
     'function symbol() view returns (string)',
     'function balanceOf(address account) view returns (uint256)',
 ]);
-/**
- * ERC721 token ABI (essential methods only)
- */
 const ERC721_ABI = (0, viem_1.parseAbi)([
     'function approve(address to, uint256 tokenId)',
     'function setApprovalForAll(address operator, bool approved)',
@@ -87,31 +62,19 @@ const ERC721_ABI = (0, viem_1.parseAbi)([
     'function safeTransferFrom(address from, address to, uint256 tokenId, bytes data)',
     'function supportsInterface(bytes4 interfaceId) view returns (bool)',
 ]);
-/**
- * ERC1155 token ABI (essential methods only)
- */
 const ERC1155_ABI = (0, viem_1.parseAbi)([
     'function setApprovalForAll(address operator, bool approved)',
     'function safeTransferFrom(address from, address to, uint256 id, uint256 amount, bytes data)',
     'function safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, bytes data)',
     'function supportsInterface(bytes4 interfaceId) view returns (bool)',
 ]);
-/**
- * USDC (Fiat Token V2) specific methods
- */
 const FIAT_TOKEN_V2_ABI = (0, viem_1.parseAbi)([
     'function increaseAllowance(address spender, uint256 increment) returns (bool)',
     'function decreaseAllowance(address spender, uint256 decrement) returns (bool)',
 ]);
-/**
- * Permit2 contract ABI
- */
 const PERMIT2_ABI = (0, viem_1.parseAbi)([
     'function approve(address token, address spender, uint160 amount, uint48 expiration)',
 ]);
-/**
- * List of transaction types that can be inferred from transaction data
- */
 const INFERRABLE_TRANSACTION_TYPES = [
     TransactionType.tokenMethodApprove,
     TransactionType.tokenMethodSetApprovalForAll,
@@ -121,88 +84,28 @@ const INFERRABLE_TRANSACTION_TYPES = [
     TransactionType.contractInteraction,
     TransactionType.simpleSend,
 ];
-/**
- * List of approval method names
- */
 const APPROVAL_METHOD_NAMES = [
     'approve',
     'setApprovalForAll',
     'increaseAllowance',
     'decreaseAllowance',
 ];
-/**
- * Interface IDs for token standards (EIP-165)
- */
 const INTERFACE_IDS = {
     ERC721: '0x80ac58cd',
     ERC1155: '0xd9b67a26',
     ERC165: '0x01ffc9a7',
 };
-// ============================================================================
-// Gas Fee Utilities
-// ============================================================================
-/**
- * Determines if a transaction uses EIP-1559 gas fields
- *
- * EIP-1559 transactions use maxFeePerGas and maxPriorityFeePerGas instead of gasPrice
- *
- * @param transactionMeta - Transaction metadata to check
- * @returns True if transaction uses valid EIP-1559 fields
- *
- * @example
- * ```typescript
- * const isEIP1559 = isEIP1559Transaction({
- *   txParams: {
- *     maxFeePerGas: '0x59682f00',
- *     maxPriorityFeePerGas: '0x3b9aca00'
- *   }
- * });
- * ```
- */
 function isEIP1559Transaction(transactionMeta) {
     const { maxFeePerGas, maxPriorityFeePerGas } = transactionMeta.txParams;
     return ((0, viem_1.isHex)(String(maxFeePerGas ?? '')) &&
         (0, viem_1.isHex)(String(maxPriorityFeePerGas ?? '')));
 }
-/**
- * Determines if a transaction uses legacy gas fields (gasPrice)
- *
- * Legacy transactions use gasPrice instead of EIP-1559 fields
- *
- * @param transactionMeta - Transaction metadata to check
- * @returns True if transaction uses valid legacy gas fields
- *
- * @example
- * ```typescript
- * const isLegacy = isLegacyTransaction({
- *   txParams: {
- *     gasPrice: '0x3b9aca00'
- *   }
- * });
- * ```
- */
 function isLegacyTransaction(transactionMeta) {
     const { maxFeePerGas, maxPriorityFeePerGas, gasPrice } = transactionMeta.txParams;
     return (typeof maxFeePerGas === 'undefined' &&
         typeof maxPriorityFeePerGas === 'undefined' &&
         (typeof gasPrice === 'undefined' || (0, viem_1.isHex)(String(gasPrice))));
 }
-/**
- * Checks if transaction gas fees match dApp suggested fees
- *
- * Useful for determining if the user has modified the dApp's suggested gas fees
- *
- * @param transactionMeta - Transaction metadata to check
- * @returns True if txParams match dappSuggestedGasFees
- *
- * @example
- * ```typescript
- * const isUnmodified = txParamsAreDappSuggested({
- *   txParams: { gasPrice: '0x3b9aca00' },
- *   dappSuggestedGasFees: { gasPrice: '0x3b9aca00' }
- * });
- * ```
- */
 function txParamsAreDappSuggested(transactionMeta) {
     const { gasPrice, maxPriorityFeePerGas, maxFeePerGas } = transactionMeta.txParams;
     const suggested = transactionMeta.dappSuggestedGasFees;
@@ -214,26 +117,6 @@ function txParamsAreDappSuggested(transactionMeta) {
             suggested.maxPriorityFeePerGas === maxPriorityFeePerGas &&
             suggested.maxFeePerGas === maxFeePerGas));
 }
-// ============================================================================
-// Transaction Data Parsing
-// ============================================================================
-/**
- * Attempts to decode transaction data using standard token ABIs
- *
- * Tries to decode the data against ERC20, ERC721, ERC1155, USDC, and Permit2 ABIs
- *
- * @param data - Encoded transaction data
- * @returns Decoded function data or undefined if decoding fails
- *
- * @example
- * ```typescript
- * const parsed = parseStandardTokenTransactionData('0xa9059cbb...');
- * if (parsed) {
- *   console.log('Function:', parsed.functionName);
- *   console.log('Args:', parsed.args);
- * }
- * ```
- */
 function parseStandardTokenTransactionData(data) {
     const abis = [
         ERC20_ABI,
@@ -247,48 +130,13 @@ function parseStandardTokenTransactionData(data) {
             return (0, viem_1.decodeFunctionData)({ abi, data });
         }
         catch {
-            // Continue to next ABI
         }
     }
     return undefined;
 }
-/**
- * Checks if transaction has meaningful data
- *
- * @param transactionData - Transaction data field
- * @returns True if data exists and is not empty
- *
- * @example
- * ```typescript
- * hasTransactionData('0x') // false
- * hasTransactionData('0xa9059cbb...') // true
- * ```
- */
 function hasTransactionData(transactionData) {
     return Boolean(transactionData?.length && transactionData.toLowerCase() !== '0x');
 }
-/**
- * Parses approval transaction data to extract relevant information
- *
- * Supports:
- * - ERC20: approve, increaseAllowance
- * - ERC721/ERC1155: setApprovalForAll
- * - Permit2: approve
- * - USDC: increaseAllowance
- *
- * @param data - Transaction data to parse
- * @returns Parsed approval data or undefined if not an approval transaction
- *
- * @example
- * ```typescript
- * const approval = parseApprovalTransactionData('0x095ea7b3...');
- * if (approval) {
- *   console.log('Spender:', approval.spender);
- *   console.log('Amount:', approval.amountOrTokenId);
- *   console.log('Is approval for all?', approval.isApproveAll);
- * }
- * ```
- */
 function parseApprovalTransactionData(data) {
     const decoded = parseStandardTokenTransactionData(data);
     if (!decoded)
@@ -297,22 +145,18 @@ function parseApprovalTransactionData(data) {
     if (!functionName || !APPROVAL_METHOD_NAMES.includes(functionName)) {
         return undefined;
     }
-    // Extract amount or token ID based on function
-    const rawAmountOrTokenId = args?._value ?? // ERC-20 approve
-        args?.increment ?? // Fiat Token V2 increaseAllowance
-        args?.amount ?? // Permit2 approve
-        args?.addedValue; // ERC-20 increaseAllowance
+    const rawAmountOrTokenId = args?._value ??
+        args?.increment ??
+        args?.amount ??
+        args?.addedValue;
     const amountOrTokenId = rawAmountOrTokenId
         ? BigInt(rawAmountOrTokenId.toString())
         : undefined;
-    // Extract spender address
     const spender = args?.spender ??
         args?._spender ??
         args?.[0];
-    // Check if it's an approval for all (ERC721/ERC1155)
     const isApproveAll = functionName === 'setApprovalForAll' && args?._approved === true;
     const isRevokeAll = functionName === 'setApprovalForAll' && args?._approved === false;
-    // Extract token address for Permit2
     const tokenAddress = functionName === 'approve' ? args?.token : undefined;
     return {
         amountOrTokenId,
@@ -323,24 +167,6 @@ function parseApprovalTransactionData(data) {
         spender,
     };
 }
-// ============================================================================
-// Contract Utilities
-// ============================================================================
-/**
- * Reads an address to determine if it's a contract
- *
- * @param client - Viem public client
- * @param address - Address to check
- * @returns Contract code and whether it's a contract address
- *
- * @example
- * ```typescript
- * const { isContractAddress, contractCode } = await readAddressAsContract(
- *   client,
- *   '0x...'
- * );
- * ```
- */
 async function readAddressAsContract(client, address) {
     try {
         const code = await client.getCode({ address });
@@ -358,23 +184,8 @@ async function readAddressAsContract(client, address) {
         };
     }
 }
-/**
- * Determines the token standard by checking EIP-165 interface support
- *
- * @param client - Viem public client
- * @param address - Token contract address
- * @returns Token standard (ERC721, ERC1155, ERC20, or none)
- *
- * @example
- * ```typescript
- * const standard = await getTokenStandard(client, '0x...');
- * console.log('Token standard:', standard); // 'ERC721'
- * ```
- */
 async function getTokenStandard(client, address) {
-    // Try ERC165 supportsInterface for ERC721/ERC1155
     try {
-        // Check ERC721
         const isERC721 = await client.readContract({
             address,
             abi: (0, viem_1.parseAbi)(['function supportsInterface(bytes4) view returns (bool)']),
@@ -383,7 +194,6 @@ async function getTokenStandard(client, address) {
         });
         if (isERC721)
             return TokenStandard.ERC721;
-        // Check ERC1155
         const isERC1155 = await client.readContract({
             address,
             abi: (0, viem_1.parseAbi)(['function supportsInterface(bytes4) view returns (bool)']),
@@ -394,9 +204,7 @@ async function getTokenStandard(client, address) {
             return TokenStandard.ERC1155;
     }
     catch {
-        // Not ERC721/ERC1155, try ERC20
     }
-    // Try ERC20 by checking for decimals function
     try {
         await client.readContract({
             address,
@@ -406,35 +214,15 @@ async function getTokenStandard(client, address) {
         return TokenStandard.ERC20;
     }
     catch {
-        // Not a recognized token standard
     }
     return TokenStandard.none;
 }
-/**
- * Gets token details including standard, decimals, symbol, and balance
- *
- * @param client - Viem public client
- * @param address - Token contract address
- * @param holderAddress - Optional address to check balance for
- * @returns Token details
- *
- * @example
- * ```typescript
- * const details = await getTokenStandardAndDetails(
- *   client,
- *   '0x...', // token address
- *   '0x...'  // holder address
- * );
- * console.log(details.symbol, details.decimals, details.balance);
- * ```
- */
 async function getTokenStandardAndDetails(client, address, holderAddress) {
     const standard = await getTokenStandard(client, address);
     if (standard === TokenStandard.none) {
         return { standard };
     }
     const details = { standard };
-    // Get ERC20 details
     if (standard === TokenStandard.ERC20) {
         try {
             const contract = (0, viem_1.getContract)({
@@ -459,50 +247,18 @@ async function getTokenStandardAndDetails(client, address, holderAddress) {
     }
     return details;
 }
-// ============================================================================
-// Transaction Type Determination
-// ============================================================================
-/**
- * Determines the type of transaction by analyzing its parameters
- *
- * This function analyzes the transaction to determine if it's:
- * - A contract deployment
- * - A token transfer/approval
- * - A contract interaction
- * - A simple ETH transfer
- *
- * @param txParams - Transaction parameters
- * @param client - Viem public client
- * @returns Transaction type and contract code
- *
- * @example
- * ```typescript
- * const result = await determineTransactionType(
- *   {
- *     from: '0x...',
- *     to: '0x...',
- *     data: '0xa9059cbb...'
- *   },
- *   client
- * );
- * console.log('Transaction type:', result.type);
- * ```
- */
 async function determineTransactionType(txParams, client) {
     const { data, to, value } = txParams;
-    // Contract deployment (no 'to' address)
     if (data && !to) {
         return {
             type: TransactionType.deployContract,
             contractCode: null,
         };
     }
-    // Check if 'to' is a contract
     if (to) {
         const { contractCode, isContractAddress } = await readAddressAsContract(client, to);
         if (isContractAddress) {
             const hasValue = value && BigInt(value) !== 0n;
-            // Try to parse the transaction data
             let functionName = '';
             try {
                 const parsed = data ? parseStandardTokenTransactionData(data) : undefined;
@@ -513,7 +269,6 @@ async function determineTransactionType(txParams, client) {
             catch (error) {
                 console.debug('Failed to parse transaction data:', error);
             }
-            // Check if it's a known token method
             const tokenMethodName = [
                 TransactionType.tokenMethodApprove,
                 TransactionType.tokenMethodSetApprovalForAll,
@@ -522,57 +277,29 @@ async function determineTransactionType(txParams, client) {
                 TransactionType.tokenMethodIncreaseAllowance,
                 TransactionType.tokenMethodSafeTransferFrom,
             ].find((methodName) => methodName.toLowerCase() === functionName.toLowerCase());
-            // Return token method if found and no ETH value
             if (data && tokenMethodName && !hasValue) {
                 return {
                     type: tokenMethodName,
                     contractCode,
                 };
             }
-            // Otherwise it's a general contract interaction
             return {
                 type: TransactionType.contractInteraction,
                 contractCode,
             };
         }
     }
-    // Simple ETH transfer
     return {
         type: TransactionType.simpleSend,
         contractCode: null,
     };
 }
-/**
- * Determines the asset type and token standard for a transaction
- *
- * This function analyzes the transaction to determine what type of asset
- * is being transferred and what standard it follows (if applicable)
- *
- * @param txMeta - Transaction metadata
- * @param client - Viem public client
- * @returns Asset type and token standard
- *
- * @example
- * ```typescript
- * const { assetType, tokenStandard } = await determineTransactionAssetType(
- *   txMeta,
- *   client
- * );
- *
- * if (assetType === AssetType.token) {
- *   console.log('ERC20 token transfer');
- * }
- * ```
- */
 async function determineTransactionAssetType(txMeta, client) {
-    // Use existing type if it's already inferrable
     let inferrableType = txMeta.type;
     if (txMeta.type && !INFERRABLE_TRANSACTION_TYPES.includes(txMeta.type)) {
-        // Get an inferrable type for special transactions (like swaps)
         const result = await determineTransactionType(txMeta.txParams, client);
         inferrableType = result.type;
     }
-    // Check if it's a token method
     const isTokenMethod = [
         TransactionType.tokenMethodApprove,
         TransactionType.tokenMethodSetApprovalForAll,
@@ -580,7 +307,6 @@ async function determineTransactionAssetType(txMeta, client) {
         TransactionType.tokenMethodTransferFrom,
         TransactionType.tokenMethodIncreaseAllowance,
     ].includes(inferrableType);
-    // Try to get token standard for token methods or contract interactions
     if (isTokenMethod || inferrableType === TransactionType.contractInteraction) {
         if (txMeta.txParams.to) {
             try {
@@ -595,58 +321,27 @@ async function determineTransactionAssetType(txMeta, client) {
                 }
             }
             catch {
-                // Failed to get token details, continue
             }
         }
     }
-    // Contract interaction with unknown asset type
     if (inferrableType === TransactionType.contractInteraction) {
         return {
             assetType: AssetType.unknown,
             tokenStandard: TokenStandard.none,
         };
     }
-    // Native ETH transfer
     return {
         assetType: AssetType.native,
         tokenStandard: TokenStandard.none,
     };
 }
-// ============================================================================
-// Typed Data Parsing
-// ============================================================================
-/**
- * Regex to extract large number values from typed data messages
- * Handles cases where JSON.parse would lose precision
- */
 const REGEX_MESSAGE_VALUE_LARGE = /"message"\s*:\s*\{[^}]*"value"\s*:\s*(\d{15,})/u;
-/**
- * Extracts large number value from a stringified message
- *
- * @param dataToParse - Stringified data to parse
- * @returns Extracted large number or undefined
- */
 function extractLargeMessageValue(dataToParse) {
     if (typeof dataToParse !== 'string') {
         return undefined;
     }
     return dataToParse.match(REGEX_MESSAGE_VALUE_LARGE)?.[1];
 }
-/**
- * Parses typed data message while preserving large number precision
- *
- * JSON.parse can lose precision for numbers > Number.MAX_SAFE_INTEGER
- * This function extracts large values and preserves them as strings
- *
- * @param dataToParse - Data to parse (object or string)
- * @returns Parsed data with preserved precision
- *
- * @example
- * ```typescript
- * const parsed = parseTypedDataMessage(signatureRequest.data);
- * console.log(parsed.message.value); // Preserved as string
- * ```
- */
 function parseTypedDataMessage(dataToParse) {
     const result = typeof dataToParse === 'object'
         ? dataToParse
@@ -657,17 +352,6 @@ function parseTypedDataMessage(dataToParse) {
     }
     return result;
 }
-// ============================================================================
-// Helper Utilities
-// ============================================================================
-/**
- * Case-insensitive string comparison
- *
- * @param str1 - First string
- * @param str2 - Second string
- * @returns True if strings are equal (case-insensitive)
- */
 function isEqualCaseInsensitive(str1, str2) {
     return str1.toLowerCase() === str2.toLowerCase();
 }
-//# sourceMappingURL=transaction.utils.js.map

package/dist/evm/transactionParsing.d.ts

@@ -40,16 +40,5 @@ export interface TransactionHistoryOptions {
     includeTokenTransfers?: boolean;
     includeNFTTransfers?: boolean;
 }
-/**
- * Fetches and parses transaction history for an EVM wallet address
- * @param client - Viem public client
- * @param walletAddress - Ethereum address
- * @param options - Optional parameters for filtering and features
- * @returns Array of parsed transaction history items
- */
 export declare function getEVMTransactionHistory(client: PublicClient, walletAddress: Address, options?: TransactionHistoryOptions): Promise<EVMTransactionHistoryItem[]>;
-/**
- * Alternative function that uses Etherscan-like API
- * This is the recommended approach for production use
- */
 export declare function getEVMTransactionHistoryWithAPI(client: PublicClient, walletAddress: Address, apiEndpoint: string, apiKey: string, options?: TransactionHistoryOptions): Promise<EVMTransactionHistoryItem[]>;