@octaflowlabs/onchain-sdk 1.1.1 → 1.1.3

package/dist/blockchain/broadcastTransaction.js

@@ -2,6 +2,7 @@
 import { Transaction } from 'ethers';
 /** local imports */
 import { getProvider } from './getProvider';
+import { errorMessagesForBroadcast, handleErrorMessages } from '../utils/handleErrorMessages';
 export const broadcastTransaction = async ({ signedTx, rpcUrl, chainId, waitConfirmations = 0, }) => {
     const provider = getProvider(rpcUrl, chainId);
     if (!provider)
@@ -10,7 +11,10 @@ export const broadcastTransaction = async ({ signedTx, rpcUrl, chainId, waitConf
         Transaction.from(signedTx);
     }
     catch (error) {
-        console.error('Invalid signed transaction format:', error);
+        handleErrorMessages({
+            e: error,
+            message: errorMessagesForBroadcast[error.code] || 'Invalid signed transaction format',
+        });
         throw new Error('Invalid signed transaction format' + (error?.message || error || ''));
     }
     try {
@@ -21,7 +25,10 @@ export const broadcastTransaction = async ({ signedTx, rpcUrl, chainId, waitConf
         return txHash;
     }
     catch (error) {
-        console.error('Error computing transaction hash:', error);
+        handleErrorMessages({
+            e: error,
+            message: errorMessagesForBroadcast[error.code] || 'Failed to broadcast transaction',
+        });
         throw new Error(error?.message || error || 'Failed to broadcast transaction');
     }
 };

package/dist/blockchain/estimateGasLimitFromProvider.js

@@ -1,3 +1,4 @@
+import { errorMessagesForGasLimitEstimation, handleErrorMessages, } from '../utils/handleErrorMessages';
 export const estimateGasLimitFromProvider = async ({ provider, unsignedTx, walletAddress, defaultGasLimit, }) => {
     let lastFeeData = null;
     let lastGasEstimated = null;
@@ -42,7 +43,10 @@ export const estimateGasLimitFromProvider = async ({ provider, unsignedTx, walle
         };
     }
     catch (error) {
-        console.error('Unable to estimate gas limit: ', error);
+        handleErrorMessages({
+            e: error,
+            message: errorMessagesForGasLimitEstimation[error.code] || 'Failed to estimate gas limit',
+        });
         console.log(`Setting default gas limit to: ${defaultGasLimit}`);
         const feeData = lastFeeData;
         const gasEstimated = lastGasEstimated ?? defaultGasLimit;

package/dist/blockchain/getProvider.js

@@ -2,13 +2,10 @@
 import { JsonRpcProvider, Network } from 'ethers';
 export const getProvider = (rpcUrl, chainId) => {
     try {
-        if (chainId) {
-            const network = Network.from(chainId);
-            return new JsonRpcProvider(rpcUrl, network, { staticNetwork: network });
-        }
-        else {
+        if (!chainId)
             return new JsonRpcProvider(rpcUrl);
-        }
+        const network = Network.from(chainId);
+        return new JsonRpcProvider(rpcUrl, network, { staticNetwork: network });
     }
     catch (error) {
         console.warn('Could not create provider with chainId, falling back to rpcUrl only:', error);

package/dist/cjs/blockchain/broadcastTransaction.js

@@ -5,6 +5,7 @@ exports.broadcastTransaction = void 0;
 const ethers_1 = require("ethers");
 /** local imports */
 const getProvider_1 = require("./getProvider");
+const handleErrorMessages_1 = require("../utils/handleErrorMessages");
 const broadcastTransaction = async ({ signedTx, rpcUrl, chainId, waitConfirmations = 0, }) => {
     const provider = (0, getProvider_1.getProvider)(rpcUrl, chainId);
     if (!provider)
@@ -13,7 +14,10 @@ const broadcastTransaction = async ({ signedTx, rpcUrl, chainId, waitConfirmatio
         ethers_1.Transaction.from(signedTx);
     }
     catch (error) {
-        console.error('Invalid signed transaction format:', error);
+        (0, handleErrorMessages_1.handleErrorMessages)({
+            e: error,
+            message: handleErrorMessages_1.errorMessagesForBroadcast[error.code] || 'Invalid signed transaction format',
+        });
         throw new Error('Invalid signed transaction format' + (error?.message || error || ''));
     }
     try {
@@ -24,7 +28,10 @@ const broadcastTransaction = async ({ signedTx, rpcUrl, chainId, waitConfirmatio
         return txHash;
     }
     catch (error) {
-        console.error('Error computing transaction hash:', error);
+        (0, handleErrorMessages_1.handleErrorMessages)({
+            e: error,
+            message: handleErrorMessages_1.errorMessagesForBroadcast[error.code] || 'Failed to broadcast transaction',
+        });
         throw new Error(error?.message || error || 'Failed to broadcast transaction');
     }
 };

package/dist/cjs/blockchain/estimateGasLimitFromProvider.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.estimateGasLimitFromProvider = void 0;
+const handleErrorMessages_1 = require("../utils/handleErrorMessages");
 const estimateGasLimitFromProvider = async ({ provider, unsignedTx, walletAddress, defaultGasLimit, }) => {
     let lastFeeData = null;
     let lastGasEstimated = null;
@@ -45,7 +46,10 @@ const estimateGasLimitFromProvider = async ({ provider, unsignedTx, walletAddres
         };
     }
     catch (error) {
-        console.error('Unable to estimate gas limit: ', error);
+        (0, handleErrorMessages_1.handleErrorMessages)({
+            e: error,
+            message: handleErrorMessages_1.errorMessagesForGasLimitEstimation[error.code] || 'Failed to estimate gas limit',
+        });
         console.log(`Setting default gas limit to: ${defaultGasLimit}`);
         const feeData = lastFeeData;
         const gasEstimated = lastGasEstimated ?? defaultGasLimit;

package/dist/cjs/blockchain/getProvider.js

@@ -5,13 +5,10 @@ exports.getProvider = void 0;
 const ethers_1 = require("ethers");
 const getProvider = (rpcUrl, chainId) => {
     try {
-        if (chainId) {
-            const network = ethers_1.Network.from(chainId);
-            return new ethers_1.JsonRpcProvider(rpcUrl, network, { staticNetwork: network });
-        }
-        else {
+        if (!chainId)
             return new ethers_1.JsonRpcProvider(rpcUrl);
-        }
+        const network = ethers_1.Network.from(chainId);
+        return new ethers_1.JsonRpcProvider(rpcUrl, network, { staticNetwork: network });
     }
     catch (error) {
         console.warn('Could not create provider with chainId, falling back to rpcUrl only:', error);

package/dist/cjs/index.d.ts

@@ -14,10 +14,11 @@ export { EvmWalletService, EvmGeneratedWallet, EvmDerivedWallet, } from './servi
 export { EntropySource } from './services/evm-wallet-core/entropy';
 export { createWallet, signMessage, signTransaction } from './services/evm-wallet-core/signer';
 /** utils exports */
-export { getShortenTransactionHash } from './utils/getShortenTxHash';
+export { getShortenTransactionHashOrAddress, getShortenData } from './utils/getShortenTxHash';
 export { transformBigInt } from './utils/transformBigInt';
 import NATIVE_TOKENS from './utils/tokens';
 export { NATIVE_TOKENS };
 export { formattedAmountForDisplay, parsedAmount } from './utils/formatAmount';
+export { handleErrorMessages, errorMessagesForBroadcast, errorMessagesForGasLimitEstimation, } from './utils/handleErrorMessages';
 /** types exports */
 export { BroadcastTransactionOptions, BuildMaxNativeTransferTxOptions, BuildMaxNativeTransferTxResponse, BuildUnsignedTransferTxOptions, EstimateGasLimitFromProviderProps, GasEstimateResult, TxStatusOptions, TxStatusResponse, UnsignedTransferTxResponse, FormatAmountOptions, TransactionRequest, } from './types/common';

package/dist/cjs/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parsedAmount = exports.formattedAmountForDisplay = exports.NATIVE_TOKENS = exports.transformBigInt = exports.getShortenTransactionHash = exports.signTransaction = exports.signMessage = exports.createWallet = exports.EvmWalletService = exports.txStatus = exports.getProvider = exports.estimateGasLimitFromProvider = exports.broadcastTransaction = exports.buildUnsignedTransferTx = exports.buildMaxNativeTransferTx = exports.GAS_LIMIT_PER_TX_TYPE = exports.ERC20_TOKEN_CONTRACT_ABI = void 0;
+exports.errorMessagesForGasLimitEstimation = exports.errorMessagesForBroadcast = exports.handleErrorMessages = exports.parsedAmount = exports.formattedAmountForDisplay = exports.NATIVE_TOKENS = exports.transformBigInt = exports.getShortenData = exports.getShortenTransactionHashOrAddress = exports.signTransaction = exports.signMessage = exports.createWallet = exports.EvmWalletService = exports.txStatus = exports.getProvider = exports.estimateGasLimitFromProvider = exports.broadcastTransaction = exports.buildUnsignedTransferTx = exports.buildMaxNativeTransferTx = exports.GAS_LIMIT_PER_TX_TYPE = exports.ERC20_TOKEN_CONTRACT_ABI = void 0;
 /** ABIs exports */
 const ERC20_TOKEN_CONTRACT_ABI_1 = __importDefault(require("./ABIs/ERC20_TOKEN_CONTRACT_ABI"));
 exports.ERC20_TOKEN_CONTRACT_ABI = ERC20_TOKEN_CONTRACT_ABI_1.default;
@@ -31,7 +31,8 @@ Object.defineProperty(exports, "signMessage", { enumerable: true, get: function
 Object.defineProperty(exports, "signTransaction", { enumerable: true, get: function () { return signer_1.signTransaction; } });
 /** utils exports */
 var getShortenTxHash_1 = require("./utils/getShortenTxHash");
-Object.defineProperty(exports, "getShortenTransactionHash", { enumerable: true, get: function () { return getShortenTxHash_1.getShortenTransactionHash; } });
+Object.defineProperty(exports, "getShortenTransactionHashOrAddress", { enumerable: true, get: function () { return getShortenTxHash_1.getShortenTransactionHashOrAddress; } });
+Object.defineProperty(exports, "getShortenData", { enumerable: true, get: function () { return getShortenTxHash_1.getShortenData; } });
 var transformBigInt_1 = require("./utils/transformBigInt");
 Object.defineProperty(exports, "transformBigInt", { enumerable: true, get: function () { return transformBigInt_1.transformBigInt; } });
 const tokens_1 = __importDefault(require("./utils/tokens"));
@@ -39,3 +40,7 @@ exports.NATIVE_TOKENS = tokens_1.default;
 var formatAmount_1 = require("./utils/formatAmount");
 Object.defineProperty(exports, "formattedAmountForDisplay", { enumerable: true, get: function () { return formatAmount_1.formattedAmountForDisplay; } });
 Object.defineProperty(exports, "parsedAmount", { enumerable: true, get: function () { return formatAmount_1.parsedAmount; } });
+var handleErrorMessages_1 = require("./utils/handleErrorMessages");
+Object.defineProperty(exports, "handleErrorMessages", { enumerable: true, get: function () { return handleErrorMessages_1.handleErrorMessages; } });
+Object.defineProperty(exports, "errorMessagesForBroadcast", { enumerable: true, get: function () { return handleErrorMessages_1.errorMessagesForBroadcast; } });
+Object.defineProperty(exports, "errorMessagesForGasLimitEstimation", { enumerable: true, get: function () { return handleErrorMessages_1.errorMessagesForGasLimitEstimation; } });

package/dist/cjs/utils/getShortenTxHash.d.ts

@@ -1 +1,2 @@
-export declare const getShortenTransactionHash: (txHash: string) => string;
+export declare const getShortenTransactionHashOrAddress: (txHashOrAddress: string) => string;
+export declare const getShortenData: (data: string) => string;

package/dist/cjs/utils/getShortenTxHash.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getShortenTransactionHash = void 0;
-const getShortenTransactionHash = (txHash) => {
-    const firstCharacters = txHash.substring(0, 6);
-    const lastCharacters = txHash.slice(-4);
+exports.getShortenData = exports.getShortenTransactionHashOrAddress = void 0;
+const getShortenTransactionHashOrAddress = (txHashOrAddress) => {
+    const firstCharacters = txHashOrAddress.substring(0, 6);
+    const lastCharacters = txHashOrAddress.slice(-4);
     return `${firstCharacters}...${lastCharacters}`;
 };
-exports.getShortenTransactionHash = getShortenTransactionHash;
+exports.getShortenTransactionHashOrAddress = getShortenTransactionHashOrAddress;
+const getShortenData = (data) => {
+    const firstCharacters = data.substring(0, 12);
+    const lastCharacters = data.slice(-12);
+    return `${firstCharacters}...${lastCharacters}`;
+};
+exports.getShortenData = getShortenData;

package/dist/cjs/utils/handleErrorMessages.d.ts

@@ -1,2 +1,9 @@
 export declare const errorMessagesForBroadcast: Record<string, string>;
 export declare const errorMessagesForGasLimitEstimation: Record<string, string>;
+type HandleErrorType = {
+    e: any;
+    message: string;
+};
+export declare const handleErrorMessages: ({ e, message }: HandleErrorType) => void;
+export declare const isEthersError: (error: any) => boolean;
+export {};

package/dist/cjs/utils/handleErrorMessages.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorMessagesForGasLimitEstimation = exports.errorMessagesForBroadcast = void 0;
+exports.isEthersError = exports.handleErrorMessages = exports.errorMessagesForGasLimitEstimation = exports.errorMessagesForBroadcast = void 0;
+/** local imports */
+const getShortenTxHash_1 = require("./getShortenTxHash");
 exports.errorMessagesForBroadcast = {
     INSUFFICIENT_FUNDS: 'Insufficient funds for gas.',
     NONCE_EXPIRED: 'Nonce expired.',
@@ -22,4 +24,55 @@ exports.errorMessagesForGasLimitEstimation = {
     GAS_LIMIT_REACHED: 'Error: Gas estimation exceeds block gas limit.',
     UNKNOWN_ERROR: 'Unknown error.',
 };
-//TODO: Make methofds to parse errors and return user friendly messages based on the above records
+const handleErrorMessages = ({ e, message }) => {
+    const timestamp = new Date().toISOString();
+    handleEthersError(e, timestamp);
+};
+exports.handleErrorMessages = handleErrorMessages;
+const handleEthersError = (error, timestamp) => {
+    if (!(0, exports.isEthersError)(error)) {
+        console.log(`Non-ethers error at ${timestamp}:`, error);
+        return;
+    }
+    const { code, reason, transaction, info } = error;
+    const { to, from, data } = transaction || {};
+    const payloadError = info?.error?.message || 'No additional error info';
+    const params = info?.payload?.params || [];
+    console.error(`🚨 ${timestamp}: Ethers Error: ${reason || 'Unknown reason, check transaction parameters!'} (Code: ${code || 'N/A'})`);
+    if (transaction) {
+        const functionSignature = data ? data.slice(0, 10) : undefined;
+        if (functionSignature)
+            console.log(`✏️  The function signature detected is: ${functionSignature}`);
+        console.log(`
+      📋 Transaction Details:
+      - From: ${from || 'N/A'}
+      - To: ${to || 'N/A'}
+      - Data: ${data ? `${(0, getShortenTxHash_1.getShortenData)(data)}` : 'N/A'}
+    `);
+    }
+    if (params.length > 0) {
+        console.log(`📊 Additional Parameters: ${params}`);
+        params.forEach((param, index) => {
+            const excludedFields = ['data', 'to', 'from'];
+            const processedParams = Object.fromEntries(Object.entries(param).map(([key, value]) => {
+                if (excludedFields.includes(key))
+                    return [key, value];
+                if (typeof value === 'string' && value.startsWith('0x'))
+                    return [key, parseInt(value, 16)];
+                return [key, value];
+            }));
+            console.log(`[${index}]: ${JSON.stringify(processedParams, null, 2)}`);
+        });
+    }
+    else
+        console.log('🔧 Params: No additional params provided.');
+    if (payloadError)
+        console.error(`🔍 Details: ${payloadError}`);
+    else
+        console.error('No further details available.');
+};
+const isEthersError = (error) => error &&
+    typeof error === 'object' &&
+    (error.code || error.action || error.transaction) &&
+    error.constructor?.name?.includes('Error');
+exports.isEthersError = isEthersError;

package/dist/index.d.ts

@@ -14,10 +14,11 @@ export { EvmWalletService, EvmGeneratedWallet, EvmDerivedWallet, } from './servi
 export { EntropySource } from './services/evm-wallet-core/entropy';
 export { createWallet, signMessage, signTransaction } from './services/evm-wallet-core/signer';
 /** utils exports */
-export { getShortenTransactionHash } from './utils/getShortenTxHash';
+export { getShortenTransactionHashOrAddress, getShortenData } from './utils/getShortenTxHash';
 export { transformBigInt } from './utils/transformBigInt';
 import NATIVE_TOKENS from './utils/tokens';
 export { NATIVE_TOKENS };
 export { formattedAmountForDisplay, parsedAmount } from './utils/formatAmount';
+export { handleErrorMessages, errorMessagesForBroadcast, errorMessagesForGasLimitEstimation, } from './utils/handleErrorMessages';
 /** types exports */
 export { BroadcastTransactionOptions, BuildMaxNativeTransferTxOptions, BuildMaxNativeTransferTxResponse, BuildUnsignedTransferTxOptions, EstimateGasLimitFromProviderProps, GasEstimateResult, TxStatusOptions, TxStatusResponse, UnsignedTransferTxResponse, FormatAmountOptions, TransactionRequest, } from './types/common';

package/dist/index.js

@@ -13,8 +13,9 @@ export { txStatus } from './blockchain/txStatus';
 export { EvmWalletService, } from './services/evm-wallet-core/evmWalletService';
 export { createWallet, signMessage, signTransaction } from './services/evm-wallet-core/signer';
 /** utils exports */
-export { getShortenTransactionHash } from './utils/getShortenTxHash';
+export { getShortenTransactionHashOrAddress, getShortenData } from './utils/getShortenTxHash';
 export { transformBigInt } from './utils/transformBigInt';
 import NATIVE_TOKENS from './utils/tokens';
 export { NATIVE_TOKENS };
 export { formattedAmountForDisplay, parsedAmount } from './utils/formatAmount';
+export { handleErrorMessages, errorMessagesForBroadcast, errorMessagesForGasLimitEstimation, } from './utils/handleErrorMessages';

package/dist/utils/getShortenTxHash.d.ts

@@ -1 +1,2 @@
-export declare const getShortenTransactionHash: (txHash: string) => string;
+export declare const getShortenTransactionHashOrAddress: (txHashOrAddress: string) => string;
+export declare const getShortenData: (data: string) => string;

package/dist/utils/getShortenTxHash.js

@@ -1,5 +1,10 @@
-export const getShortenTransactionHash = (txHash) => {
-    const firstCharacters = txHash.substring(0, 6);
-    const lastCharacters = txHash.slice(-4);
+export const getShortenTransactionHashOrAddress = (txHashOrAddress) => {
+    const firstCharacters = txHashOrAddress.substring(0, 6);
+    const lastCharacters = txHashOrAddress.slice(-4);
+    return `${firstCharacters}...${lastCharacters}`;
+};
+export const getShortenData = (data) => {
+    const firstCharacters = data.substring(0, 12);
+    const lastCharacters = data.slice(-12);
     return `${firstCharacters}...${lastCharacters}`;
 };

package/dist/utils/handleErrorMessages.d.ts

@@ -1,2 +1,9 @@
 export declare const errorMessagesForBroadcast: Record<string, string>;
 export declare const errorMessagesForGasLimitEstimation: Record<string, string>;
+type HandleErrorType = {
+    e: any;
+    message: string;
+};
+export declare const handleErrorMessages: ({ e, message }: HandleErrorType) => void;
+export declare const isEthersError: (error: any) => boolean;
+export {};

package/dist/utils/handleErrorMessages.js

@@ -1,3 +1,5 @@
+/** local imports */
+import { getShortenData } from './getShortenTxHash';
 export const errorMessagesForBroadcast = {
     INSUFFICIENT_FUNDS: 'Insufficient funds for gas.',
     NONCE_EXPIRED: 'Nonce expired.',
@@ -19,4 +21,53 @@ export const errorMessagesForGasLimitEstimation = {
     GAS_LIMIT_REACHED: 'Error: Gas estimation exceeds block gas limit.',
     UNKNOWN_ERROR: 'Unknown error.',
 };
-//TODO: Make methofds to parse errors and return user friendly messages based on the above records
+export const handleErrorMessages = ({ e, message }) => {
+    const timestamp = new Date().toISOString();
+    handleEthersError(e, timestamp);
+};
+const handleEthersError = (error, timestamp) => {
+    if (!isEthersError(error)) {
+        console.log(`Non-ethers error at ${timestamp}:`, error);
+        return;
+    }
+    const { code, reason, transaction, info } = error;
+    const { to, from, data } = transaction || {};
+    const payloadError = info?.error?.message || 'No additional error info';
+    const params = info?.payload?.params || [];
+    console.error(`🚨 ${timestamp}: Ethers Error: ${reason || 'Unknown reason, check transaction parameters!'} (Code: ${code || 'N/A'})`);
+    if (transaction) {
+        const functionSignature = data ? data.slice(0, 10) : undefined;
+        if (functionSignature)
+            console.log(`✏️  The function signature detected is: ${functionSignature}`);
+        console.log(`
+      📋 Transaction Details:
+      - From: ${from || 'N/A'}
+      - To: ${to || 'N/A'}
+      - Data: ${data ? `${getShortenData(data)}` : 'N/A'}
+    `);
+    }
+    if (params.length > 0) {
+        console.log(`📊 Additional Parameters: ${params}`);
+        params.forEach((param, index) => {
+            const excludedFields = ['data', 'to', 'from'];
+            const processedParams = Object.fromEntries(Object.entries(param).map(([key, value]) => {
+                if (excludedFields.includes(key))
+                    return [key, value];
+                if (typeof value === 'string' && value.startsWith('0x'))
+                    return [key, parseInt(value, 16)];
+                return [key, value];
+            }));
+            console.log(`[${index}]: ${JSON.stringify(processedParams, null, 2)}`);
+        });
+    }
+    else
+        console.log('🔧 Params: No additional params provided.');
+    if (payloadError)
+        console.error(`🔍 Details: ${payloadError}`);
+    else
+        console.error('No further details available.');
+};
+export const isEthersError = (error) => error &&
+    typeof error === 'object' &&
+    (error.code || error.action || error.transaction) &&
+    error.constructor?.name?.includes('Error');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octaflowlabs/onchain-sdk",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "onchain methods for web3",
   "repository": "https://github.com/crisramb665/onchain-sdk.git",
   "license": "MIT",