wb3-eth 0.0.1-security → 4.10.0

package/lib/esm/utils/prepare_transaction_for_signing.js

@@ -0,0 +1,99 @@
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { ETH_DATA_FORMAT, } from 'web3-types';
+import { toNumber } from 'web3-utils';
+import { TransactionFactory, Common } from 'web3-eth-accounts';
+import { isNullish } from 'web3-validator';
+import { validateTransactionForSigning } from '../validation.js';
+import { formatTransaction } from './format_transaction.js';
+import { transactionBuilder } from './transaction_builder.js';
+const getEthereumjsTxDataFromTransaction = (transaction) => {
+    var _a, _b;
+    return (Object.assign(Object.assign({}, transaction), { nonce: transaction.nonce, gasPrice: transaction.gasPrice, gasLimit: (_a = transaction.gasLimit) !== null && _a !== void 0 ? _a : transaction.gas, to: transaction.to, value: transaction.value, data: (_b = transaction.data) !== null && _b !== void 0 ? _b : transaction.input, type: transaction.type, chainId: transaction.chainId, accessList: transaction.accessList, maxPriorityFeePerGas: transaction.maxPriorityFeePerGas, maxFeePerGas: transaction.maxFeePerGas }));
+};
+const getEthereumjsTransactionOptions = (transaction, web3Context) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+    const hasTransactionSigningOptions = (!isNullish(transaction.chain) && !isNullish(transaction.hardfork)) ||
+        !isNullish(transaction.common);
+    let common;
+    if (!hasTransactionSigningOptions) {
+        // if defaultcommon is specified, use that.
+        if (web3Context.defaultCommon) {
+            common = Object.assign({}, web3Context.defaultCommon);
+            if (isNullish(common.hardfork))
+                common.hardfork = (_a = transaction.hardfork) !== null && _a !== void 0 ? _a : web3Context.defaultHardfork;
+            if (isNullish(common.baseChain))
+                common.baseChain = web3Context.defaultChain;
+        }
+        else {
+            common = Common.custom({
+                name: 'custom-network',
+                chainId: toNumber(transaction.chainId),
+                networkId: !isNullish(transaction.networkId)
+                    ? toNumber(transaction.networkId)
+                    : undefined,
+                defaultHardfork: (_b = transaction.hardfork) !== null && _b !== void 0 ? _b : web3Context.defaultHardfork,
+            }, {
+                baseChain: web3Context.defaultChain,
+            });
+        }
+    }
+    else {
+        const name = (_f = (_e = (_d = (_c = transaction === null || transaction === void 0 ? void 0 : transaction.common) === null || _c === void 0 ? void 0 : _c.customChain) === null || _d === void 0 ? void 0 : _d.name) !== null && _e !== void 0 ? _e : transaction.chain) !== null && _f !== void 0 ? _f : 'custom-network';
+        const chainId = toNumber((_j = (_h = (_g = transaction === null || transaction === void 0 ? void 0 : transaction.common) === null || _g === void 0 ? void 0 : _g.customChain) === null || _h === void 0 ? void 0 : _h.chainId) !== null && _j !== void 0 ? _j : transaction === null || transaction === void 0 ? void 0 : transaction.chainId);
+        const networkId = toNumber((_m = (_l = (_k = transaction === null || transaction === void 0 ? void 0 : transaction.common) === null || _k === void 0 ? void 0 : _k.customChain) === null || _l === void 0 ? void 0 : _l.networkId) !== null && _m !== void 0 ? _m : transaction === null || transaction === void 0 ? void 0 : transaction.networkId);
+        const defaultHardfork = (_q = (_p = (_o = transaction === null || transaction === void 0 ? void 0 : transaction.common) === null || _o === void 0 ? void 0 : _o.hardfork) !== null && _p !== void 0 ? _p : transaction === null || transaction === void 0 ? void 0 : transaction.hardfork) !== null && _q !== void 0 ? _q : web3Context.defaultHardfork;
+        const baseChain = (_t = (_s = (_r = transaction.common) === null || _r === void 0 ? void 0 : _r.baseChain) !== null && _s !== void 0 ? _s : transaction.chain) !== null && _t !== void 0 ? _t : web3Context.defaultChain;
+        if (chainId && networkId && name) {
+            common = Common.custom({
+                name,
+                chainId,
+                networkId,
+                defaultHardfork,
+            }, {
+                baseChain,
+            });
+        }
+    }
+    return { common };
+};
+export const prepareTransactionForSigning = (transaction, web3Context, privateKey, fillGasPrice = false, fillGasLimit = true) => __awaiter(void 0, void 0, void 0, function* () {
+    const populatedTransaction = (yield transactionBuilder({
+        transaction,
+        web3Context,
+        privateKey,
+        fillGasPrice,
+        fillGasLimit,
+    }));
+    const formattedTransaction = formatTransaction(populatedTransaction, ETH_DATA_FORMAT, {
+        transactionSchema: web3Context.config.customTransactionSchema,
+    });
+    validateTransactionForSigning(formattedTransaction, undefined, {
+        transactionSchema: web3Context.config.customTransactionSchema,
+    });
+    return TransactionFactory.fromTxData(getEthereumjsTxDataFromTransaction(formattedTransaction), getEthereumjsTransactionOptions(formattedTransaction, web3Context));
+});
+//# sourceMappingURL=prepare_transaction_for_signing.js.map

package/lib/esm/utils/prepare_transaction_for_signing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepare_transaction_for_signing.js","sourceRoot":"","sources":["../../../src/utils/prepare_transaction_for_signing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;EAeE;;;;;;;;;;AAEF,OAAO,EASN,eAAe,GACf,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAa,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,MAAM,kCAAkC,GAAG,CAC1C,WAA6E,EAC5E,EAAE;;IAAC,OAAA,iCACD,WAAW,KACd,KAAK,EAAE,WAAW,CAAC,KAAK,EACxB,QAAQ,EAAE,WAAW,CAAC,QAAQ,EAC9B,QAAQ,EAAE,MAAA,WAAW,CAAC,QAAQ,mCAAI,WAAW,CAAC,GAAG,EACjD,EAAE,EAAE,WAAW,CAAC,EAAE,EAClB,KAAK,EAAE,WAAW,CAAC,KAAK,EACxB,IAAI,EAAE,MAAA,WAAW,CAAC,IAAI,mCAAI,WAAW,CAAC,KAAK,EAC3C,IAAI,EAAE,WAAW,CAAC,IAAI,EACtB,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,UAAU,EACT,WACA,CAAC,UAAU,EACZ,oBAAoB,EACnB,WACA,CAAC,oBAAoB,EACtB,YAAY,EACX,WACA,CAAC,YAAY,IACb,CAAA;CAAA,CAAC;AAEH,MAAM,+BAA+B,GAAG,CACvC,WAA6E,EAC7E,WAAyC,EACxC,EAAE;;IACH,MAAM,4BAA4B,GACjC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACnE,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAEhC,IAAI,MAAM,CAAC;IACX,IAAI,CAAC,4BAA4B,EAAE;QAClC,2CAA2C;QAC3C,IAAI,WAAW,CAAC,aAAa,EAAE;YAC9B,MAAM,qBAAQ,WAAW,CAAC,aAAa,CAAE,CAAC;YAE1C,IAAI,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC;gBAC7B,MAAM,CAAC,QAAQ,GAAG,MAAA,WAAW,CAAC,QAAQ,mCAAI,WAAW,CAAC,eAAe,CAAC;YACvE,IAAI,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC;gBAC9B,MAAM,CAAC,SAAS,GAAG,WAAW,CAAC,YAA2B,CAAC;SAC5D;aAAM;YACN,MAAM,GAAG,MAAM,CAAC,MAAM,CACrB;gBACC,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAW;gBAChD,SAAS,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC;oBAC3C,CAAC,CAAE,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAY;oBAC7C,CAAC,CAAC,SAAS;gBACZ,eAAe,EAAE,MAAA,WAAW,CAAC,QAAQ,mCAAI,WAAW,CAAC,eAAe;aACpE,EACD;gBACC,SAAS,EAAE,WAAW,CAAC,YAAY;aACnC,CACD,CAAC;SACF;KACD;SAAM;QACN,MAAM,IAAI,GACT,MAAA,MAAA,MAAA,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,0CAAE,WAAW,0CAAE,IAAI,mCAAI,WAAW,CAAC,KAAK,mCAAI,gBAAgB,CAAC;QACjF,MAAM,OAAO,GAAG,QAAQ,CACvB,MAAA,MAAA,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,0CAAE,WAAW,0CAAE,OAAO,mCAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CACvD,CAAC;QACZ,MAAM,SAAS,GAAG,QAAQ,CACzB,MAAA,MAAA,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,0CAAE,WAAW,0CAAE,SAAS,mCAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,CAC3D,CAAC;QACZ,MAAM,eAAe,GACpB,MAAA,MAAA,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,0CAAE,QAAQ,mCAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,mCAAI,WAAW,CAAC,eAAe,CAAC;QACvF,MAAM,SAAS,GACd,MAAA,MAAA,MAAA,WAAW,CAAC,MAAM,0CAAE,SAAS,mCAAI,WAAW,CAAC,KAAK,mCAAI,WAAW,CAAC,YAAY,CAAC;QAEhF,IAAI,OAAO,IAAI,SAAS,IAAI,IAAI,EAAE;YACjC,MAAM,GAAG,MAAM,CAAC,MAAM,CACrB;gBACC,IAAI;gBACJ,OAAO;gBACP,SAAS;gBACT,eAAe;aACf,EACD;gBACC,SAAS;aACT,CACD,CAAC;SACF;KACD;IACD,OAAO,EAAE,MAAM,EAAe,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC3C,WAAwB,EACxB,WAAyC,EACzC,UAAmC,EACnC,YAAY,GAAG,KAAK,EACpB,YAAY,GAAG,IAAI,EAClB,EAAE;IACH,MAAM,oBAAoB,GAAG,CAAC,MAAM,kBAAkB,CAAC;QACtD,WAAW;QACX,WAAW;QACX,UAAU;QACV,YAAY;QACZ,YAAY;KACZ,CAAC,CAA4C,CAAC;IAC/C,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,oBAAoB,EAAE,eAAe,EAAE;QACrF,iBAAiB,EAAE,WAAW,CAAC,MAAM,CAAC,uBAAuB;KAC7D,CAAgF,CAAC;IAElF,6BAA6B,CAC5B,oBAAkF,EAClF,SAAS,EACT;QACC,iBAAiB,EAAE,WAAW,CAAC,MAAM,CAAC,uBAAuB;KAC7D,CACD,CAAC;IAEF,OAAO,kBAAkB,CAAC,UAAU,CACnC,kCAAkC,CAAC,oBAAoB,CAAC,EACxD,+BAA+B,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAClE,CAAC;AACH,CAAC,CAAA,CAAC"}

package/lib/esm/utils/reject_if_block_timeout.js

@@ -0,0 +1,134 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { rejectIfConditionAtInterval } from 'web3-utils';
+import { TransactionBlockTimeoutError } from 'web3-errors';
+import { NUMBER_DATA_FORMAT } from '../constants.js';
+// eslint-disable-next-line import/no-cycle
+import { getBlockNumber } from '../rpc_method_wrappers.js';
+function resolveByPolling(web3Context, starterBlockNumber, transactionHash) {
+    const pollingInterval = web3Context.transactionPollingInterval;
+    const [intervalId, promiseToError] = rejectIfConditionAtInterval(() => __awaiter(this, void 0, void 0, function* () {
+        let lastBlockNumber;
+        try {
+            lastBlockNumber = yield getBlockNumber(web3Context, NUMBER_DATA_FORMAT);
+        }
+        catch (error) {
+            console.warn('An error happen while trying to get the block number', error);
+            return undefined;
+        }
+        const numberOfBlocks = lastBlockNumber - starterBlockNumber;
+        if (numberOfBlocks >= web3Context.transactionBlockTimeout) {
+            return new TransactionBlockTimeoutError({
+                starterBlockNumber,
+                numberOfBlocks,
+                transactionHash,
+            });
+        }
+        return undefined;
+    }), pollingInterval);
+    const clean = () => {
+        clearInterval(intervalId);
+    };
+    return [promiseToError, { clean }];
+}
+function resolveBySubscription(web3Context, starterBlockNumber, transactionHash) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        // The following variable will stay true except if the data arrived,
+        //	or if watching started after an error had occurred.
+        let needToWatchLater = true;
+        let subscription;
+        let resourceCleaner;
+        // internal helper function
+        function revertToPolling(reject, previousError) {
+            if (previousError) {
+                console.warn('error happened at subscription. So revert to polling...', previousError);
+            }
+            resourceCleaner.clean();
+            needToWatchLater = false;
+            const [promiseToError, newResourceCleaner] = resolveByPolling(web3Context, starterBlockNumber, transactionHash);
+            resourceCleaner.clean = newResourceCleaner.clean;
+            promiseToError.catch(error => reject(error));
+        }
+        try {
+            subscription = (yield ((_a = web3Context.subscriptionManager) === null || _a === void 0 ? void 0 : _a.subscribe('newHeads')));
+            resourceCleaner = {
+                clean: () => {
+                    var _a;
+                    // Remove the subscription, if it was not removed somewhere
+                    // 	else by calling, for example, subscriptionManager.clear()
+                    if (subscription.id) {
+                        (_a = web3Context.subscriptionManager) === null || _a === void 0 ? void 0 : _a.removeSubscription(subscription).then(() => {
+                            // Subscription ended successfully
+                        }).catch(() => {
+                            // An error happened while ending subscription. But no need to take any action.
+                        });
+                    }
+                },
+            };
+        }
+        catch (error) {
+            return resolveByPolling(web3Context, starterBlockNumber, transactionHash);
+        }
+        const promiseToError = new Promise((_, reject) => {
+            try {
+                subscription.on('data', (lastBlockHeader) => {
+                    needToWatchLater = false;
+                    if (!(lastBlockHeader === null || lastBlockHeader === void 0 ? void 0 : lastBlockHeader.number)) {
+                        return;
+                    }
+                    const numberOfBlocks = Number(BigInt(lastBlockHeader.number) - BigInt(starterBlockNumber));
+                    if (numberOfBlocks >= web3Context.transactionBlockTimeout) {
+                        // Transaction Block Timeout is known to be reached by subscribing to new heads
+                        reject(new TransactionBlockTimeoutError({
+                            starterBlockNumber,
+                            numberOfBlocks,
+                            transactionHash,
+                        }));
+                    }
+                });
+                subscription.on('error', error => {
+                    revertToPolling(reject, error);
+                });
+            }
+            catch (error) {
+                revertToPolling(reject, error);
+            }
+            // Fallback to polling if tx receipt didn't arrived in "blockHeaderTimeout" [10 seconds]
+            setTimeout(() => {
+                if (needToWatchLater) {
+                    revertToPolling(reject);
+                }
+            }, web3Context.blockHeaderTimeout * 1000);
+        });
+        return [promiseToError, resourceCleaner];
+    });
+}
+/* TODO: After merge, there will be constant block mining time (exactly 12 second each block, except slot missed that currently happens in <1% of slots. ) so we can optimize following function
+for POS NWs, we can skip checking getBlockNumber(); after interval and calculate only based on time  that certain num of blocked are mined after that for internal double check, can do one getBlockNumber() call and timeout.
+*/
+export function rejectIfBlockTimeout(web3Context, transactionHash) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const { provider } = web3Context.requestManager;
+        let callingRes;
+        const starterBlockNumber = yield getBlockNumber(web3Context, NUMBER_DATA_FORMAT);
+        // TODO: once https://github.com/web3/web3.js/issues/5521 is implemented, remove checking for `enableExperimentalFeatures.useSubscriptionWhenCheckingBlockTimeout`
+        if (((_b = (_a = provider).supportsSubscriptions) === null || _b === void 0 ? void 0 : _b.call(_a)) &&
+            web3Context.enableExperimentalFeatures.useSubscriptionWhenCheckingBlockTimeout) {
+            callingRes = yield resolveBySubscription(web3Context, starterBlockNumber, transactionHash);
+        }
+        else {
+            callingRes = resolveByPolling(web3Context, starterBlockNumber, transactionHash);
+        }
+        return callingRes;
+    });
+}
+//# sourceMappingURL=reject_if_block_timeout.js.map

package/lib/esm/utils/reject_if_block_timeout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reject_if_block_timeout.js","sourceRoot":"","sources":["../../../src/utils/reject_if_block_timeout.ts"],"names":[],"mappings":";;;;;;;;;AAkBA,OAAO,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAEzD,OAAO,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,2CAA2C;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAO3D,SAAS,gBAAgB,CACxB,WAAyC,EACzC,kBAA0B,EAC1B,eAAuB;IAEvB,MAAM,eAAe,GAAG,WAAW,CAAC,0BAA0B,CAAC;IAC/D,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,2BAA2B,CAAC,GAAS,EAAE;QAC3E,IAAI,eAAe,CAAC;QACpB,IAAI;YACH,eAAe,GAAG,MAAM,cAAc,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;SACxE;QAAC,OAAO,KAAK,EAAE;YACf,OAAO,CAAC,IAAI,CAAC,sDAAsD,EAAE,KAAK,CAAC,CAAC;YAC5E,OAAO,SAAS,CAAC;SACjB;QACD,MAAM,cAAc,GAAG,eAAe,GAAG,kBAAkB,CAAC;QAC5D,IAAI,cAAc,IAAI,WAAW,CAAC,uBAAuB,EAAE;YAC1D,OAAO,IAAI,4BAA4B,CAAC;gBACvC,kBAAkB;gBAClB,cAAc;gBACd,eAAe;aACf,CAAC,CAAC;SACH;QACD,OAAO,SAAS,CAAC;IAClB,CAAC,CAAA,EAAE,eAAe,CAAC,CAAC;IAEpB,MAAM,KAAK,GAAG,GAAG,EAAE;QAClB,aAAa,CAAC,UAAU,CAAC,CAAC;IAC3B,CAAC,CAAC;IAEF,OAAO,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;AACpC,CAAC;AAED,SAAe,qBAAqB,CACnC,WAAyC,EACzC,kBAA0B,EAC1B,eAAuB;;;QAEvB,oEAAoE;QACpE,sDAAsD;QACtD,IAAI,gBAAgB,GAAG,IAAI,CAAC;QAE5B,IAAI,YAAkC,CAAC;QACvC,IAAI,eAAgC,CAAC;QACrC,2BAA2B;QAC3B,SAAS,eAAe,CACvB,MAAmD,EACnD,aAAqB;YAErB,IAAI,aAAa,EAAE;gBAClB,OAAO,CAAC,IAAI,CAAC,yDAAyD,EAAE,aAAa,CAAC,CAAC;aACvF;YACD,eAAe,CAAC,KAAK,EAAE,CAAC;YAExB,gBAAgB,GAAG,KAAK,CAAC;YACzB,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,GAAG,gBAAgB,CAC5D,WAAW,EACX,kBAAkB,EAClB,eAAe,CACf,CAAC;YACF,eAAe,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC;YACjD,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAc,CAAC,CAAC,CAAC;QACvD,CAAC;QACD,IAAI;YACH,YAAY,GAAG,CAAC,MAAM,CAAA,MAAA,WAAW,CAAC,mBAAmB,0CAAE,SAAS,CAC/D,UAAU,CACV,CAAA,CAAoC,CAAC;YACtC,eAAe,GAAG;gBACjB,KAAK,EAAE,GAAG,EAAE;;oBACX,2DAA2D;oBAC3D,6DAA6D;oBAC7D,IAAI,YAAY,CAAC,EAAE,EAAE;wBACpB,MAAA,WAAW,CAAC,mBAAmB,0CAC5B,kBAAkB,CAAC,YAAY,EAChC,IAAI,CAAC,GAAG,EAAE;4BACV,kCAAkC;wBACnC,CAAC,EACA,KAAK,CAAC,GAAG,EAAE;4BACX,+EAA+E;wBAChF,CAAC,CAAC,CAAC;qBACJ;gBACF,CAAC;aACD,CAAC;SACF;QAAC,OAAO,KAAK,EAAE;YACf,OAAO,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,EAAE,eAAe,CAAC,CAAC;SAC1E;QACD,MAAM,cAAc,GAAmB,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YAChE,IAAI;gBACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,eAAkC,EAAE,EAAE;oBAC9D,gBAAgB,GAAG,KAAK,CAAC;oBACzB,IAAI,CAAC,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,MAAM,CAAA,EAAE;wBAC7B,OAAO;qBACP;oBACD,MAAM,cAAc,GAAG,MAAM,CAC5B,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAC3D,CAAC;oBAEF,IAAI,cAAc,IAAI,WAAW,CAAC,uBAAuB,EAAE;wBAC1D,+EAA+E;wBAC/E,MAAM,CACL,IAAI,4BAA4B,CAAC;4BAChC,kBAAkB;4BAClB,cAAc;4BACd,eAAe;yBACf,CAAC,CACF,CAAC;qBACF;gBACF,CAAC,CAAC,CAAC;gBACH,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;oBAChC,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;aACH;YAAC,OAAO,KAAK,EAAE;gBACf,eAAe,CAAC,MAAM,EAAE,KAAc,CAAC,CAAC;aACxC;YAED,wFAAwF;YACxF,UAAU,CAAC,GAAG,EAAE;gBACf,IAAI,gBAAgB,EAAE;oBACrB,eAAe,CAAC,MAAM,CAAC,CAAC;iBACxB;YACF,CAAC,EAAE,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;;CACzC;AAED;;EAEE;AACF,MAAM,UAAgB,oBAAoB,CACzC,WAAyC,EACzC,eAAuB;;;QAEvB,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,cAAc,CAAC;QAChD,IAAI,UAA6C,CAAC;QAClD,MAAM,kBAAkB,GAAG,MAAM,cAAc,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;QACjF,kKAAkK;QAClK,IACC,CAAA,MAAA,MAAC,QAA6B,EAAC,qBAAqB,kDAAI;YACxD,WAAW,CAAC,0BAA0B,CAAC,uCAAuC,EAC7E;YACD,UAAU,GAAG,MAAM,qBAAqB,CAAC,WAAW,EAAE,kBAAkB,EAAE,eAAe,CAAC,CAAC;SAC3F;aAAM;YACN,UAAU,GAAG,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,EAAE,eAAe,CAAC,CAAC;SAChF;QACD,OAAO,UAAU,CAAC;;CAClB"}

package/lib/esm/utils/send_tx_helper.js

@@ -0,0 +1,175 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+import { ETH_DATA_FORMAT, } from 'web3-types';
+import { isNullish } from 'web3-validator';
+import { ContractExecutionError, InvalidResponseError, TransactionPollingTimeoutError, TransactionRevertedWithoutReasonError, TransactionRevertInstructionError, TransactionRevertWithCustomError, } from 'web3-errors';
+import { ethRpcMethods } from 'web3-rpc-methods';
+// eslint-disable-next-line import/no-cycle
+import { getTransactionGasPricing } from './get_transaction_gas_pricing.js';
+// eslint-disable-next-line import/no-cycle
+import { trySendTransaction } from './try_send_transaction.js';
+// eslint-disable-next-line import/no-cycle
+import { watchTransactionForConfirmations } from './watch_transaction_for_confirmations.js';
+import { ALL_EVENTS_ABI } from '../constants.js';
+// eslint-disable-next-line import/no-cycle
+import { getTransactionError } from './get_transaction_error.js';
+// eslint-disable-next-line import/no-cycle
+import { getRevertReason } from './get_revert_reason.js';
+import { decodeEventABI } from './decoding.js';
+export class SendTxHelper {
+    constructor({ options, web3Context, promiEvent, returnFormat, }) {
+        this.options = {
+            checkRevertBeforeSending: true,
+        };
+        this.options = options;
+        this.web3Context = web3Context;
+        this.promiEvent = promiEvent;
+        this.returnFormat = returnFormat;
+    }
+    getReceiptWithEvents(data) {
+        var _a, _b;
+        const result = Object.assign({}, (data !== null && data !== void 0 ? data : {}));
+        if (((_a = this.options) === null || _a === void 0 ? void 0 : _a.contractAbi) && result.logs && result.logs.length > 0) {
+            result.events = {};
+            for (const log of result.logs) {
+                const event = decodeEventABI(ALL_EVENTS_ABI, log, (_b = this.options) === null || _b === void 0 ? void 0 : _b.contractAbi, this.returnFormat);
+                if (event.event) {
+                    result.events[event.event] = event;
+                }
+            }
+        }
+        return result;
+    }
+    checkRevertBeforeSending(tx) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.options.checkRevertBeforeSending !== false) {
+                let formatTx = tx;
+                if (isNullish(tx.data) && isNullish(tx.input) && isNullish(tx.gas)) {
+                    // eth.call runs into error if data isnt filled and gas is not defined, its a simple transaction so we fill it with 21000
+                    formatTx = Object.assign(Object.assign({}, tx), { gas: 21000 });
+                }
+                const reason = yield getRevertReason(this.web3Context, formatTx, this.options.contractAbi);
+                if (reason !== undefined) {
+                    throw yield getTransactionError(this.web3Context, tx, undefined, undefined, this.options.contractAbi, reason);
+                }
+            }
+        });
+    }
+    emitSending(tx) {
+        if (this.promiEvent.listenerCount('sending') > 0) {
+            this.promiEvent.emit('sending', tx);
+        }
+    }
+    populateGasPrice({ transactionFormatted, transaction, }) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let result = transactionFormatted;
+            if (!this.web3Context.config.ignoreGasPricing &&
+                !((_a = this.options) === null || _a === void 0 ? void 0 : _a.ignoreGasPricing) &&
+                isNullish(transactionFormatted.gasPrice) &&
+                (isNullish(transaction.maxPriorityFeePerGas) ||
+                    isNullish(transaction.maxFeePerGas))) {
+                result = Object.assign(Object.assign({}, transactionFormatted), (yield getTransactionGasPricing(transactionFormatted, this.web3Context, ETH_DATA_FORMAT)));
+            }
+            return result;
+        });
+    }
+    signAndSend({ wallet, tx, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (wallet) {
+                const signedTransaction = yield wallet.signTransaction(tx);
+                return trySendTransaction(this.web3Context, () => __awaiter(this, void 0, void 0, function* () {
+                    return ethRpcMethods.sendRawTransaction(this.web3Context.requestManager, signedTransaction.rawTransaction);
+                }), signedTransaction.transactionHash);
+            }
+            return trySendTransaction(this.web3Context, () => __awaiter(this, void 0, void 0, function* () {
+                return ethRpcMethods.sendTransaction(this.web3Context.requestManager, tx);
+            }));
+        });
+    }
+    emitSent(tx) {
+        if (this.promiEvent.listenerCount('sent') > 0) {
+            this.promiEvent.emit('sent', tx);
+        }
+    }
+    emitTransactionHash(hash) {
+        if (this.promiEvent.listenerCount('transactionHash') > 0) {
+            this.promiEvent.emit('transactionHash', hash);
+        }
+    }
+    emitReceipt(receipt) {
+        if (this.promiEvent.listenerCount('receipt') > 0) {
+            this.promiEvent.emit('receipt', 
+            // @ts-expect-error unknown type fix
+            receipt);
+        }
+    }
+    handleError({ error, tx }) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let _error = error;
+            if (_error instanceof ContractExecutionError && this.web3Context.handleRevert) {
+                _error = yield getTransactionError(this.web3Context, tx, undefined, undefined, (_a = this.options) === null || _a === void 0 ? void 0 : _a.contractAbi);
+            }
+            if ((_error instanceof InvalidResponseError ||
+                _error instanceof ContractExecutionError ||
+                _error instanceof TransactionRevertWithCustomError ||
+                _error instanceof TransactionRevertedWithoutReasonError ||
+                _error instanceof TransactionRevertInstructionError ||
+                _error instanceof TransactionPollingTimeoutError) &&
+                this.promiEvent.listenerCount('error') > 0) {
+                this.promiEvent.emit('error', _error);
+            }
+            return _error;
+        });
+    }
+    emitConfirmation({ receipt, transactionHash, customTransactionReceiptSchema, }) {
+        if (this.promiEvent.listenerCount('confirmation') > 0) {
+            watchTransactionForConfirmations(this.web3Context, this.promiEvent, receipt, transactionHash, this.returnFormat, customTransactionReceiptSchema);
+        }
+    }
+    handleResolve({ receipt, tx }) {
+        var _a, _b, _c;
+        return __awaiter(this, void 0, void 0, function* () {
+            if ((_a = this.options) === null || _a === void 0 ? void 0 : _a.transactionResolver) {
+                return (_b = this.options) === null || _b === void 0 ? void 0 : _b.transactionResolver(receipt);
+            }
+            if (receipt.status === BigInt(0)) {
+                const error = yield getTransactionError(this.web3Context, tx, 
+                // @ts-expect-error unknown type fix
+                receipt, undefined, (_c = this.options) === null || _c === void 0 ? void 0 : _c.contractAbi);
+                if (this.promiEvent.listenerCount('error') > 0) {
+                    this.promiEvent.emit('error', error);
+                }
+                throw error;
+            }
+            else {
+                return receipt;
+            }
+        });
+    }
+}
+//# sourceMappingURL=send_tx_helper.js.map

package/lib/esm/utils/send_tx_helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send_tx_helper.js","sourceRoot":"","sources":["../../../src/utils/send_tx_helper.ts"],"names":[],"mappings":";;;;;;;;;AAAA;;;;;;;;;;;;;;;EAeE;AACF,OAAO,EACN,eAAe,GAgBf,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,SAAS,EAAc,MAAM,gBAAgB,CAAC;AACvD,OAAO,EACN,sBAAsB,EACtB,oBAAoB,EACpB,8BAA8B,EAC9B,qCAAqC,EACrC,iCAAiC,EACjC,gCAAgC,GAChC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAOjD,2CAA2C;AAC3C,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,2CAA2C;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,2CAA2C;AAC3C,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,2CAA2C;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,2CAA2C;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C,MAAM,OAAO,YAAY;IAkBxB,YAAmB,EAClB,OAAO,EACP,WAAW,EACX,UAAU,EACV,YAAY,GASZ;QAjBgB,YAAO,GAAwC;YAC/D,wBAAwB,EAAE,IAAI;SAC9B,CAAC;QAgBD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IAClC,CAAC;IAEM,oBAAoB,CAAC,IAAwB;;QACnD,MAAM,MAAM,qBAAQ,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAE,CAAC;QACnC,IAAI,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,WAAW,KAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACvE,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC;YACnB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE;gBAC9B,MAAM,KAAK,GAAG,cAAc,CAC3B,cAAc,EACd,GAAgB,EAChB,MAAA,IAAI,CAAC,OAAO,0CAAE,WAAuC,EACrD,IAAI,CAAC,YAAY,CACjB,CAAC;gBACF,IAAI,KAAK,CAAC,KAAK,EAAE;oBAChB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;iBACnC;aACD;SACD;QAED,OAAO,MAAgC,CAAC;IACzC,CAAC;IAEY,wBAAwB,CAAC,EAAmB;;YACxD,IAAI,IAAI,CAAC,OAAO,CAAC,wBAAwB,KAAK,KAAK,EAAE;gBACpD,IAAI,QAAQ,GAAG,EAAE,CAAC;gBAClB,IAAI,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE;oBACnE,yHAAyH;oBACzH,QAAQ,mCACJ,EAAE,KACL,GAAG,EAAE,KAAK,GACV,CAAC;iBACF;gBACD,MAAM,MAAM,GAAG,MAAM,eAAe,CACnC,IAAI,CAAC,WAAW,EAChB,QAAQ,EACR,IAAI,CAAC,OAAO,CAAC,WAAW,CACxB,CAAC;gBACF,IAAI,MAAM,KAAK,SAAS,EAAE;oBACzB,MAAM,MAAM,mBAAmB,CAC9B,IAAI,CAAC,WAAW,EAChB,EAAE,EACF,SAAS,EACT,SAAS,EACT,IAAI,CAAC,OAAO,CAAC,WAAW,EACxB,MAAM,CACN,CAAC;iBACF;aACD;QACF,CAAC;KAAA;IAEM,WAAW,CAAC,EAAsB;QACxC,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;YACjD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;SACpC;IACF,CAAC;IAEY,gBAAgB,CAAC,EAC7B,oBAAoB,EACpB,WAAW,GAIX;;;YACA,IAAI,MAAM,GAAG,oBAAoB,CAAC;YAClC,IACC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,gBAAgB;gBACzC,CAAC,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,gBAAgB,CAAA;gBAC/B,SAAS,CAAE,oBAAoC,CAAC,QAAQ,CAAC;gBACzD,CAAC,SAAS,CAAE,WAA2B,CAAC,oBAAoB,CAAC;oBAC5D,SAAS,CAAE,WAA2B,CAAC,YAAY,CAAC,CAAC,EACrD;gBACD,MAAM,mCACF,oBAAoB,GAGpB,CAAC,MAAM,wBAAwB,CACjC,oBAAoB,EACpB,IAAI,CAAC,WAAW,EAChB,eAAe,CACf,CAAC,CACF,CAAC;aACF;YAED,OAAO,MAAM,CAAC;;KACd;IAEY,WAAW,CAAC,EACxB,MAAM,EACN,EAAE,GAIF;;YACA,IAAI,MAAM,EAAE;gBACX,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;gBAE3D,OAAO,kBAAkB,CACxB,IAAI,CAAC,WAAW,EAChB,GAA0B,EAAE;oBAC3B,OAAA,aAAa,CAAC,kBAAkB,CAC/B,IAAI,CAAC,WAAW,CAAC,cAAc,EAC/B,iBAAiB,CAAC,cAAc,CAChC,CAAA;kBAAA,EACF,iBAAiB,CAAC,eAAe,CACjC,CAAC;aACF;YACD,OAAO,kBAAkB,CACxB,IAAI,CAAC,WAAW,EAChB,GAA0B,EAAE;gBAC3B,OAAA,aAAa,CAAC,eAAe,CAC5B,IAAI,CAAC,WAAW,CAAC,cAAc,EAC/B,EAAuC,CACvC,CAAA;cAAA,CACF,CAAC;QACH,CAAC;KAAA;IAEM,QAAQ,CAAC,EAAsB;QACrC,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;YAC9C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;SACjC;IACF,CAAC;IACM,mBAAmB,CAAC,IAAyB;QACnD,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE;YACzD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;SAC9C;IACF,CAAC;IAEM,WAAW,CAAC,OAAoB;QACtC,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;YAEhD,IAAI,CAAC,UAGL,CAAC,IAAI,CACL,SAAS;YACT,oCAAoC;YACpC,OAAO,CACP,CAAC;SACF;IACF,CAAC;IAEY,WAAW,CAAC,EAAE,KAAK,EAAE,EAAE,EAA2C;;;YAC9E,IAAI,MAAM,GAAG,KAAK,CAAC;YAEnB,IAAI,MAAM,YAAY,sBAAsB,IAAI,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE;gBAC9E,MAAM,GAAG,MAAM,mBAAmB,CACjC,IAAI,CAAC,WAAW,EAChB,EAAE,EACF,SAAS,EACT,SAAS,EACT,MAAA,IAAI,CAAC,OAAO,0CAAE,WAAW,CACzB,CAAC;aACF;YAED,IACC,CAAC,MAAM,YAAY,oBAAoB;gBACtC,MAAM,YAAY,sBAAsB;gBACxC,MAAM,YAAY,gCAAgC;gBAClD,MAAM,YAAY,qCAAqC;gBACvD,MAAM,YAAY,iCAAiC;gBACnD,MAAM,YAAY,8BAA8B,CAAC;gBAClD,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,EACzC;gBACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;aACtC;YAED,OAAO,MAAM,CAAC;;KACd;IAEM,gBAAgB,CAAC,EACvB,OAAO,EACP,eAAe,EACf,8BAA8B,GAK9B;QACA,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACtD,gCAAgC,CAK/B,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,UAAU,EACf,OAAwC,EACxC,eAAe,EACf,IAAI,CAAC,YAAY,EACjB,8BAA8B,CAC9B,CAAC;SACF;IACF,CAAC;IAEY,aAAa,CAAC,EAAE,OAAO,EAAE,EAAE,EAAiD;;;YACxF,IAAI,MAAA,IAAI,CAAC,OAAO,0CAAE,mBAAmB,EAAE;gBACtC,OAAO,MAAA,IAAI,CAAC,OAAO,0CAAE,mBAAmB,CAAC,OAAwC,CAAC,CAAC;aACnF;YACD,IAAK,OAAyC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE;gBACpE,MAAM,KAAK,GAAG,MAAM,mBAAmB,CACtC,IAAI,CAAC,WAAW,EAChB,EAAE;gBACF,oCAAoC;gBACpC,OAAO,EACP,SAAS,EACT,MAAA,IAAI,CAAC,OAAO,0CAAE,WAAW,CACzB,CAAC;gBACF,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;oBAC/C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;iBACrC;gBAED,MAAM,KAAK,CAAC;aACZ;iBAAM;gBACN,OAAO,OAAO,CAAC;aACf;;KACD;CACD"}

package/lib/esm/utils/transaction_builder.js

@@ -0,0 +1,163 @@
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { ETH_DATA_FORMAT, } from 'web3-types';
+import { privateKeyToAddress } from 'web3-eth-accounts';
+import { getId } from 'web3-net';
+import { isNullish, isNumber, isHexStrict, isAddress } from 'web3-validator';
+import { InvalidTransactionWithSender, InvalidTransactionWithReceiver, LocalWalletNotAvailableError, TransactionDataAndInputError, UnableToPopulateNonceError, } from 'web3-errors';
+import { bytesToHex, format } from 'web3-utils';
+import { NUMBER_DATA_FORMAT } from '../constants.js';
+// eslint-disable-next-line import/no-cycle
+import { getChainId, getTransactionCount, estimateGas } from '../rpc_method_wrappers.js';
+import { detectTransactionType } from './detect_transaction_type.js';
+import { transactionSchema } from '../schemas.js';
+// eslint-disable-next-line import/no-cycle
+import { getTransactionGasPricing } from './get_transaction_gas_pricing.js';
+export const getTransactionFromOrToAttr = (attr, web3Context, transaction, privateKey) => {
+    if (transaction !== undefined && attr in transaction && transaction[attr] !== undefined) {
+        if (typeof transaction[attr] === 'string' && isAddress(transaction[attr])) {
+            return transaction[attr];
+        }
+        if (!isHexStrict(transaction[attr]) && isNumber(transaction[attr])) {
+            if (web3Context.wallet) {
+                const account = web3Context.wallet.get(format({ format: 'uint' }, transaction[attr], NUMBER_DATA_FORMAT));
+                if (!isNullish(account)) {
+                    return account.address;
+                }
+                throw new LocalWalletNotAvailableError();
+            }
+            throw new LocalWalletNotAvailableError();
+        }
+        else {
+            throw attr === 'from'
+                ? new InvalidTransactionWithSender(transaction.from)
+                : // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+                    new InvalidTransactionWithReceiver(transaction.to);
+        }
+    }
+    if (attr === 'from') {
+        if (!isNullish(privateKey))
+            return privateKeyToAddress(privateKey);
+        if (!isNullish(web3Context.defaultAccount))
+            return web3Context.defaultAccount;
+    }
+    return undefined;
+};
+export const getTransactionNonce = (web3Context, address, returnFormat = web3Context.defaultReturnFormat) => __awaiter(void 0, void 0, void 0, function* () {
+    if (isNullish(address)) {
+        // TODO if (web3.eth.accounts.wallet) use address from local wallet
+        throw new UnableToPopulateNonceError();
+    }
+    return getTransactionCount(web3Context, address, web3Context.defaultBlock, returnFormat);
+});
+export const getTransactionType = (transaction, web3Context) => {
+    const inferredType = detectTransactionType(transaction, web3Context);
+    if (!isNullish(inferredType))
+        return inferredType;
+    if (!isNullish(web3Context.defaultTransactionType))
+        return format({ format: 'uint' }, web3Context.defaultTransactionType, ETH_DATA_FORMAT);
+    return undefined;
+};
+// Keep in mind that the order the properties of populateTransaction get populated matters
+// as some of the properties are dependent on others
+export function defaultTransactionBuilder(options) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        let populatedTransaction = format(transactionSchema, options.transaction, options.web3Context.defaultReturnFormat);
+        if (isNullish(populatedTransaction.from)) {
+            populatedTransaction.from = getTransactionFromOrToAttr('from', options.web3Context, undefined, options.privateKey);
+        }
+        // TODO: Debug why need to typecase getTransactionNonce
+        if (isNullish(populatedTransaction.nonce)) {
+            populatedTransaction.nonce = yield getTransactionNonce(options.web3Context, populatedTransaction.from, ETH_DATA_FORMAT);
+        }
+        if (isNullish(populatedTransaction.value)) {
+            populatedTransaction.value = '0x0';
+        }
+        if (!isNullish(populatedTransaction.data)) {
+            if (!isNullish(populatedTransaction.input) &&
+                populatedTransaction.data !== populatedTransaction.input)
+                throw new TransactionDataAndInputError({
+                    data: bytesToHex(populatedTransaction.data),
+                    input: bytesToHex(populatedTransaction.input),
+                });
+            if (!populatedTransaction.data.startsWith('0x'))
+                populatedTransaction.data = `0x${populatedTransaction.data}`;
+        }
+        else if (!isNullish(populatedTransaction.input)) {
+            if (!populatedTransaction.input.startsWith('0x'))
+                populatedTransaction.input = `0x${populatedTransaction.input}`;
+        }
+        else {
+            populatedTransaction.input = '0x';
+        }
+        if (isNullish(populatedTransaction.common)) {
+            if (options.web3Context.defaultCommon) {
+                const common = options.web3Context.defaultCommon;
+                const chainId = common.customChain.chainId;
+                const networkId = common.customChain.networkId;
+                const name = common.customChain.name;
+                populatedTransaction.common = Object.assign(Object.assign({}, common), { customChain: { chainId, networkId, name } });
+            }
+            if (isNullish(populatedTransaction.chain)) {
+                populatedTransaction.chain = options.web3Context.defaultChain;
+            }
+            if (isNullish(populatedTransaction.hardfork)) {
+                populatedTransaction.hardfork = options.web3Context.defaultHardfork;
+            }
+        }
+        if (isNullish(populatedTransaction.chainId) &&
+            isNullish((_a = populatedTransaction.common) === null || _a === void 0 ? void 0 : _a.customChain.chainId)) {
+            populatedTransaction.chainId = yield getChainId(options.web3Context, ETH_DATA_FORMAT);
+        }
+        if (isNullish(populatedTransaction.networkId)) {
+            populatedTransaction.networkId =
+                (_b = options.web3Context.defaultNetworkId) !== null && _b !== void 0 ? _b : (yield getId(options.web3Context, ETH_DATA_FORMAT));
+        }
+        if (isNullish(populatedTransaction.gasLimit) && !isNullish(populatedTransaction.gas)) {
+            populatedTransaction.gasLimit = populatedTransaction.gas;
+        }
+        populatedTransaction.type = getTransactionType(populatedTransaction, options.web3Context);
+        if (isNullish(populatedTransaction.accessList) &&
+            (populatedTransaction.type === '0x1' || populatedTransaction.type === '0x2')) {
+            populatedTransaction.accessList = [];
+        }
+        if (options.fillGasPrice)
+            populatedTransaction = Object.assign(Object.assign({}, populatedTransaction), (yield getTransactionGasPricing(populatedTransaction, options.web3Context, ETH_DATA_FORMAT)));
+        if (isNullish(populatedTransaction.gas) &&
+            isNullish(populatedTransaction.gasLimit) &&
+            options.fillGasLimit) {
+            const fillGasLimit = yield estimateGas(options.web3Context, populatedTransaction, 'latest', ETH_DATA_FORMAT);
+            populatedTransaction = Object.assign(Object.assign({}, populatedTransaction), { gas: format({ format: 'uint' }, fillGasLimit, ETH_DATA_FORMAT) });
+        }
+        return populatedTransaction;
+    });
+}
+export const transactionBuilder = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    return ((_a = options.web3Context.transactionBuilder) !== null && _a !== void 0 ? _a : defaultTransactionBuilder)(Object.assign(Object.assign({}, options), { transaction: options.transaction }));
+});
+//# sourceMappingURL=transaction_builder.js.map

package/lib/esm/utils/transaction_builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction_builder.js","sourceRoot":"","sources":["../../../src/utils/transaction_builder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;EAeE;;;;;;;;;;AAEF,OAAO,EAeN,eAAe,GACf,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC7E,OAAO,EACN,4BAA4B,EAC5B,8BAA8B,EAC9B,4BAA4B,EAC5B,4BAA4B,EAC5B,0BAA0B,GAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,2CAA2C;AAC3C,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAElD,2CAA2C;AAC3C,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAE5E,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACzC,IAAmB,EACnB,WAAyC,EACzC,WAI2C,EAC3C,UAAmC,EACb,EAAE;IACxB,IAAI,WAAW,KAAK,SAAS,IAAI,IAAI,IAAI,WAAW,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE;QACxF,IAAI,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,QAAQ,IAAI,SAAS,CAAC,WAAW,CAAC,IAAI,CAAW,CAAC,EAAE;YACpF,OAAO,WAAW,CAAC,IAAI,CAAY,CAAC;SACpC;QACD,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAW,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAY,CAAC,EAAE;YACxF,IAAI,WAAW,CAAC,MAAM,EAAE;gBACvB,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,CACrC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,IAAI,CAAY,EAAE,kBAAkB,CAAC,CAC5E,CAAC;gBAEF,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;oBACxB,OAAO,OAAO,CAAC,OAAO,CAAC;iBACvB;gBAED,MAAM,IAAI,4BAA4B,EAAE,CAAC;aACzC;YACD,MAAM,IAAI,4BAA4B,EAAE,CAAC;SACzC;aAAM;YACN,MAAM,IAAI,KAAK,MAAM;gBACpB,CAAC,CAAC,IAAI,4BAA4B,CAAC,WAAW,CAAC,IAAI,CAAC;gBACpD,CAAC,CAAC,6DAA6D;oBAC7D,IAAI,8BAA8B,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;SACtD;KACD;IACD,IAAI,IAAI,KAAK,MAAM,EAAE;QACpB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;YAAE,OAAO,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC;YAAE,OAAO,WAAW,CAAC,cAAc,CAAC;KAC9E;IAED,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAClC,WAAyC,EACzC,OAAiB,EACjB,eAA6B,WAAW,CAAC,mBAAmC,EAC3E,EAAE;IACH,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE;QACvB,mEAAmE;QACnE,MAAM,IAAI,0BAA0B,EAAE,CAAC;KACvC;IAED,OAAO,mBAAmB,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;AAC1F,CAAC,CAAA,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CACjC,WAA4D,EAC5D,WAAyC,EACxC,EAAE;IACH,MAAM,YAAY,GAAG,qBAAqB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACrE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;QAAE,OAAO,YAAY,CAAC;IAClD,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,sBAAsB,CAAC;QACjD,OAAO,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,sBAAsB,EAAE,eAAe,CAAC,CAAC;IAExF,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAEF,0FAA0F;AAC1F,oDAAoD;AACpD,MAAM,UAAgB,yBAAyB,CAA2B,OAMzE;;;QACA,IAAI,oBAAoB,GAAG,MAAM,CAChC,iBAAiB,EACjB,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAChB,CAAC;QAEzB,IAAI,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE;YACzC,oBAAoB,CAAC,IAAI,GAAG,0BAA0B,CACrD,MAAM,EACN,OAAO,CAAC,WAAW,EACnB,SAAS,EACT,OAAO,CAAC,UAAU,CAClB,CAAC;SACF;QAED,uDAAuD;QACvD,IAAI,SAAS,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE;YAC1C,oBAAoB,CAAC,KAAK,GAAG,MAAM,mBAAmB,CACrD,OAAO,CAAC,WAAW,EACnB,oBAAoB,CAAC,IAAI,EACzB,eAAe,CACf,CAAC;SACF;QAED,IAAI,SAAS,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE;YAC1C,oBAAoB,CAAC,KAAK,GAAG,KAAK,CAAC;SACnC;QAED,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE;YAC1C,IACC,CAAC,SAAS,CAAC,oBAAoB,CAAC,KAAK,CAAC;gBACtC,oBAAoB,CAAC,IAAI,KAAK,oBAAoB,CAAC,KAAK;gBAExD,MAAM,IAAI,4BAA4B,CAAC;oBACtC,IAAI,EAAE,UAAU,CAAC,oBAAoB,CAAC,IAAI,CAAC;oBAC3C,KAAK,EAAE,UAAU,CAAC,oBAAoB,CAAC,KAAK,CAAC;iBAC7C,CAAC,CAAC;YAEJ,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC9C,oBAAoB,CAAC,IAAI,GAAG,KAAK,oBAAoB,CAAC,IAAI,EAAE,CAAC;SAC9D;aAAM,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE;YAClD,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC/C,oBAAoB,CAAC,KAAK,GAAG,KAAK,oBAAoB,CAAC,KAAK,EAAE,CAAC;SAChE;aAAM;YACN,oBAAoB,CAAC,KAAK,GAAG,IAAI,CAAC;SAClC;QAED,IAAI,SAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE;YAC3C,IAAI,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE;gBACtC,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,aAAkC,CAAC;gBACtE,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,OAAiB,CAAC;gBACrD,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,SAAmB,CAAC;gBACzD,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,IAAc,CAAC;gBAC/C,oBAAoB,CAAC,MAAM,mCACvB,MAAM,KACT,WAAW,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GACzC,CAAC;aACF;YAED,IAAI,SAAS,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE;gBAC1C,oBAAoB,CAAC,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,YAA2B,CAAC;aAC7E;YACD,IAAI,SAAS,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE;gBAC7C,oBAAoB,CAAC,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,eAA2B,CAAC;aAChF;SACD;QAED,IACC,SAAS,CAAC,oBAAoB,CAAC,OAAO,CAAC;YACvC,SAAS,CAAC,MAAA,oBAAoB,CAAC,MAAM,0CAAE,WAAW,CAAC,OAAO,CAAC,EAC1D;YACD,oBAAoB,CAAC,OAAO,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;SACtF;QAED,IAAI,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE;YAC9C,oBAAoB,CAAC,SAAS;gBAC7B,MAAC,OAAO,CAAC,WAAW,CAAC,gBAA2B,mCAChD,CAAC,MAAM,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;SACrD;QAED,IAAI,SAAS,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE;YACrF,oBAAoB,CAAC,QAAQ,GAAG,oBAAoB,CAAC,GAAG,CAAC;SACzD;QAED,oBAAoB,CAAC,IAAI,GAAG,kBAAkB,CAAC,oBAAoB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1F,IACC,SAAS,CAAC,oBAAoB,CAAC,UAAU,CAAC;YAC1C,CAAC,oBAAoB,CAAC,IAAI,KAAK,KAAK,IAAI,oBAAoB,CAAC,IAAI,KAAK,KAAK,CAAC,EAC3E;YACD,oBAAoB,CAAC,UAAU,GAAG,EAAE,CAAC;SACrC;QACD,IAAI,OAAO,CAAC,YAAY;YACvB,oBAAoB,mCAChB,oBAAoB,GACpB,CAAC,MAAM,wBAAwB,CACjC,oBAAoB,EACpB,OAAO,CAAC,WAAW,EACnB,eAAe,CACf,CAAC,CACF,CAAC;QACH,IACC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC;YACnC,SAAS,CAAC,oBAAoB,CAAC,QAAQ,CAAC;YACxC,OAAO,CAAC,YAAY,EACnB;YACD,MAAM,YAAY,GAAG,MAAM,WAAW,CACrC,OAAO,CAAC,WAAW,EACnB,oBAAoB,EACpB,QAAQ,EACR,eAAe,CACf,CAAC;YACF,oBAAoB,mCAChB,oBAAoB,KACvB,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,YAAuB,EAAE,eAAe,CAAC,GACzE,CAAC;SACF;QACD,OAAO,oBAAkC,CAAC;;CAC1C;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CACjC,OAMC,EAEA,EAAE;;IACH,OAAA,CAAC,MAAA,OAAO,CAAC,WAAW,CAAC,kBAAkB,mCAAI,yBAAyB,CAAC,iCACjE,OAAO,KACV,WAAW,EAAE,OAAO,CAAC,WAAW,IACN,CAAA;EAAA,CAAC"}