wb3-eth 0.0.1-security → 4.10.0

package/lib/commonjs/utils/send_tx_helper.js

@@ -0,0 +1,179 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SendTxHelper = void 0;
+/*
+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/>.
+*/
+const web3_types_1 = require("web3-types");
+const web3_validator_1 = require("web3-validator");
+const web3_errors_1 = require("web3-errors");
+const web3_rpc_methods_1 = require("web3-rpc-methods");
+// eslint-disable-next-line import/no-cycle
+const get_transaction_gas_pricing_js_1 = require("./get_transaction_gas_pricing.js");
+// eslint-disable-next-line import/no-cycle
+const try_send_transaction_js_1 = require("./try_send_transaction.js");
+// eslint-disable-next-line import/no-cycle
+const watch_transaction_for_confirmations_js_1 = require("./watch_transaction_for_confirmations.js");
+const constants_js_1 = require("../constants.js");
+// eslint-disable-next-line import/no-cycle
+const get_transaction_error_js_1 = require("./get_transaction_error.js");
+// eslint-disable-next-line import/no-cycle
+const get_revert_reason_js_1 = require("./get_revert_reason.js");
+const decoding_js_1 = require("./decoding.js");
+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 = (0, decoding_js_1.decodeEventABI)(constants_js_1.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 ((0, web3_validator_1.isNullish)(tx.data) && (0, web3_validator_1.isNullish)(tx.input) && (0, web3_validator_1.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 (0, get_revert_reason_js_1.getRevertReason)(this.web3Context, formatTx, this.options.contractAbi);
+                if (reason !== undefined) {
+                    throw yield (0, get_transaction_error_js_1.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) &&
+                (0, web3_validator_1.isNullish)(transactionFormatted.gasPrice) &&
+                ((0, web3_validator_1.isNullish)(transaction.maxPriorityFeePerGas) ||
+                    (0, web3_validator_1.isNullish)(transaction.maxFeePerGas))) {
+                result = Object.assign(Object.assign({}, transactionFormatted), (yield (0, get_transaction_gas_pricing_js_1.getTransactionGasPricing)(transactionFormatted, this.web3Context, web3_types_1.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 (0, try_send_transaction_js_1.trySendTransaction)(this.web3Context, () => __awaiter(this, void 0, void 0, function* () {
+                    return web3_rpc_methods_1.ethRpcMethods.sendRawTransaction(this.web3Context.requestManager, signedTransaction.rawTransaction);
+                }), signedTransaction.transactionHash);
+            }
+            return (0, try_send_transaction_js_1.trySendTransaction)(this.web3Context, () => __awaiter(this, void 0, void 0, function* () {
+                return web3_rpc_methods_1.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 web3_errors_1.ContractExecutionError && this.web3Context.handleRevert) {
+                _error = yield (0, get_transaction_error_js_1.getTransactionError)(this.web3Context, tx, undefined, undefined, (_a = this.options) === null || _a === void 0 ? void 0 : _a.contractAbi);
+            }
+            if ((_error instanceof web3_errors_1.InvalidResponseError ||
+                _error instanceof web3_errors_1.ContractExecutionError ||
+                _error instanceof web3_errors_1.TransactionRevertWithCustomError ||
+                _error instanceof web3_errors_1.TransactionRevertedWithoutReasonError ||
+                _error instanceof web3_errors_1.TransactionRevertInstructionError ||
+                _error instanceof web3_errors_1.TransactionPollingTimeoutError) &&
+                this.promiEvent.listenerCount('error') > 0) {
+                this.promiEvent.emit('error', _error);
+            }
+            return _error;
+        });
+    }
+    emitConfirmation({ receipt, transactionHash, customTransactionReceiptSchema, }) {
+        if (this.promiEvent.listenerCount('confirmation') > 0) {
+            (0, watch_transaction_for_confirmations_js_1.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 (0, get_transaction_error_js_1.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;
+            }
+        });
+    }
+}
+exports.SendTxHelper = SendTxHelper;
+//# sourceMappingURL=send_tx_helper.js.map

package/lib/commonjs/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,2CAiBoB;AAEpB,mDAAuD;AACvD,6CAOqB;AACrB,uDAAiD;AAOjD,2CAA2C;AAC3C,qFAA4E;AAC5E,2CAA2C;AAC3C,uEAA+D;AAC/D,2CAA2C;AAC3C,qGAA4F;AAC5F,kDAAiD;AACjD,2CAA2C;AAC3C,yEAAiE;AACjE,2CAA2C;AAC3C,iEAAyD;AACzD,+CAA+C;AAE/C,MAAa,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,IAAA,4BAAc,EAC3B,6BAAc,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,IAAA,0BAAS,EAAC,EAAE,CAAC,IAAI,CAAC,IAAI,IAAA,0BAAS,EAAC,EAAE,CAAC,KAAK,CAAC,IAAI,IAAA,0BAAS,EAAC,EAAE,CAAC,GAAG,CAAC,EAAE;oBACnE,yHAAyH;oBACzH,QAAQ,mCACJ,EAAE,KACL,GAAG,EAAE,KAAK,GACV,CAAC;iBACF;gBACD,MAAM,MAAM,GAAG,MAAM,IAAA,sCAAe,EACnC,IAAI,CAAC,WAAW,EAChB,QAAQ,EACR,IAAI,CAAC,OAAO,CAAC,WAAW,CACxB,CAAC;gBACF,IAAI,MAAM,KAAK,SAAS,EAAE;oBACzB,MAAM,MAAM,IAAA,8CAAmB,EAC9B,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,IAAA,0BAAS,EAAE,oBAAoC,CAAC,QAAQ,CAAC;gBACzD,CAAC,IAAA,0BAAS,EAAE,WAA2B,CAAC,oBAAoB,CAAC;oBAC5D,IAAA,0BAAS,EAAE,WAA2B,CAAC,YAAY,CAAC,CAAC,EACrD;gBACD,MAAM,mCACF,oBAAoB,GAGpB,CAAC,MAAM,IAAA,yDAAwB,EACjC,oBAAoB,EACpB,IAAI,CAAC,WAAW,EAChB,4BAAe,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,IAAA,4CAAkB,EACxB,IAAI,CAAC,WAAW,EAChB,GAA0B,EAAE;oBAC3B,OAAA,gCAAa,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,IAAA,4CAAkB,EACxB,IAAI,CAAC,WAAW,EAChB,GAA0B,EAAE;gBAC3B,OAAA,gCAAa,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,oCAAsB,IAAI,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE;gBAC9E,MAAM,GAAG,MAAM,IAAA,8CAAmB,EACjC,IAAI,CAAC,WAAW,EAChB,EAAE,EACF,SAAS,EACT,SAAS,EACT,MAAA,IAAI,CAAC,OAAO,0CAAE,WAAW,CACzB,CAAC;aACF;YAED,IACC,CAAC,MAAM,YAAY,kCAAoB;gBACtC,MAAM,YAAY,oCAAsB;gBACxC,MAAM,YAAY,8CAAgC;gBAClD,MAAM,YAAY,mDAAqC;gBACvD,MAAM,YAAY,+CAAiC;gBACnD,MAAM,YAAY,4CAA8B,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,IAAA,yEAAgC,EAK/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,IAAA,8CAAmB,EACtC,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;AA5PD,oCA4PC"}

package/lib/commonjs/utils/transaction_builder.d.ts

@@ -0,0 +1,19 @@
+import { EthExecutionAPI, Address, HexString, Transaction, TransactionWithFromLocalWalletIndex, TransactionWithToLocalWalletIndex, TransactionWithFromAndToLocalWalletIndex, Web3NetAPI, DataFormat, FormatType, ETH_DATA_FORMAT } from 'web3-types';
+import { Web3Context } from 'web3-core';
+export declare const getTransactionFromOrToAttr: (attr: 'from' | 'to', web3Context: Web3Context<EthExecutionAPI>, transaction?: Transaction | TransactionWithFromLocalWalletIndex | TransactionWithToLocalWalletIndex | TransactionWithFromAndToLocalWalletIndex, privateKey?: HexString | Uint8Array) => Address | undefined;
+export declare const getTransactionNonce: <ReturnFormat extends DataFormat>(web3Context: Web3Context<EthExecutionAPI>, address?: Address, returnFormat?: ReturnFormat) => Promise<import("web3-types").NumberTypes[ReturnFormat["number"]]>;
+export declare const getTransactionType: (transaction: FormatType<Transaction, typeof ETH_DATA_FORMAT>, web3Context: Web3Context<EthExecutionAPI>) => string | undefined;
+export declare function defaultTransactionBuilder<ReturnType = Transaction>(options: {
+    transaction: Transaction;
+    web3Context: Web3Context<EthExecutionAPI & Web3NetAPI>;
+    privateKey?: HexString | Uint8Array;
+    fillGasPrice?: boolean;
+    fillGasLimit?: boolean;
+}): Promise<ReturnType>;
+export declare const transactionBuilder: <ReturnType_1 = Transaction>(options: {
+    transaction: Transaction;
+    web3Context: Web3Context<EthExecutionAPI>;
+    privateKey?: HexString | Uint8Array;
+    fillGasPrice?: boolean;
+    fillGasLimit?: boolean;
+}) => Promise<ReturnType_1>;

package/lib/commonjs/utils/transaction_builder.js

@@ -0,0 +1,171 @@
+"use strict";
+/*
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transactionBuilder = exports.defaultTransactionBuilder = exports.getTransactionType = exports.getTransactionNonce = exports.getTransactionFromOrToAttr = void 0;
+const web3_types_1 = require("web3-types");
+const web3_eth_accounts_1 = require("web3-eth-accounts");
+const web3_net_1 = require("web3-net");
+const web3_validator_1 = require("web3-validator");
+const web3_errors_1 = require("web3-errors");
+const web3_utils_1 = require("web3-utils");
+const constants_js_1 = require("../constants.js");
+// eslint-disable-next-line import/no-cycle
+const rpc_method_wrappers_js_1 = require("../rpc_method_wrappers.js");
+const detect_transaction_type_js_1 = require("./detect_transaction_type.js");
+const schemas_js_1 = require("../schemas.js");
+// eslint-disable-next-line import/no-cycle
+const get_transaction_gas_pricing_js_1 = require("./get_transaction_gas_pricing.js");
+const getTransactionFromOrToAttr = (attr, web3Context, transaction, privateKey) => {
+    if (transaction !== undefined && attr in transaction && transaction[attr] !== undefined) {
+        if (typeof transaction[attr] === 'string' && (0, web3_validator_1.isAddress)(transaction[attr])) {
+            return transaction[attr];
+        }
+        if (!(0, web3_validator_1.isHexStrict)(transaction[attr]) && (0, web3_validator_1.isNumber)(transaction[attr])) {
+            if (web3Context.wallet) {
+                const account = web3Context.wallet.get((0, web3_utils_1.format)({ format: 'uint' }, transaction[attr], constants_js_1.NUMBER_DATA_FORMAT));
+                if (!(0, web3_validator_1.isNullish)(account)) {
+                    return account.address;
+                }
+                throw new web3_errors_1.LocalWalletNotAvailableError();
+            }
+            throw new web3_errors_1.LocalWalletNotAvailableError();
+        }
+        else {
+            throw attr === 'from'
+                ? new web3_errors_1.InvalidTransactionWithSender(transaction.from)
+                : // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+                    new web3_errors_1.InvalidTransactionWithReceiver(transaction.to);
+        }
+    }
+    if (attr === 'from') {
+        if (!(0, web3_validator_1.isNullish)(privateKey))
+            return (0, web3_eth_accounts_1.privateKeyToAddress)(privateKey);
+        if (!(0, web3_validator_1.isNullish)(web3Context.defaultAccount))
+            return web3Context.defaultAccount;
+    }
+    return undefined;
+};
+exports.getTransactionFromOrToAttr = getTransactionFromOrToAttr;
+const getTransactionNonce = (web3Context, address, returnFormat = web3Context.defaultReturnFormat) => __awaiter(void 0, void 0, void 0, function* () {
+    if ((0, web3_validator_1.isNullish)(address)) {
+        // TODO if (web3.eth.accounts.wallet) use address from local wallet
+        throw new web3_errors_1.UnableToPopulateNonceError();
+    }
+    return (0, rpc_method_wrappers_js_1.getTransactionCount)(web3Context, address, web3Context.defaultBlock, returnFormat);
+});
+exports.getTransactionNonce = getTransactionNonce;
+const getTransactionType = (transaction, web3Context) => {
+    const inferredType = (0, detect_transaction_type_js_1.detectTransactionType)(transaction, web3Context);
+    if (!(0, web3_validator_1.isNullish)(inferredType))
+        return inferredType;
+    if (!(0, web3_validator_1.isNullish)(web3Context.defaultTransactionType))
+        return (0, web3_utils_1.format)({ format: 'uint' }, web3Context.defaultTransactionType, web3_types_1.ETH_DATA_FORMAT);
+    return undefined;
+};
+exports.getTransactionType = getTransactionType;
+// Keep in mind that the order the properties of populateTransaction get populated matters
+// as some of the properties are dependent on others
+function defaultTransactionBuilder(options) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        let populatedTransaction = (0, web3_utils_1.format)(schemas_js_1.transactionSchema, options.transaction, options.web3Context.defaultReturnFormat);
+        if ((0, web3_validator_1.isNullish)(populatedTransaction.from)) {
+            populatedTransaction.from = (0, exports.getTransactionFromOrToAttr)('from', options.web3Context, undefined, options.privateKey);
+        }
+        // TODO: Debug why need to typecase getTransactionNonce
+        if ((0, web3_validator_1.isNullish)(populatedTransaction.nonce)) {
+            populatedTransaction.nonce = yield (0, exports.getTransactionNonce)(options.web3Context, populatedTransaction.from, web3_types_1.ETH_DATA_FORMAT);
+        }
+        if ((0, web3_validator_1.isNullish)(populatedTransaction.value)) {
+            populatedTransaction.value = '0x0';
+        }
+        if (!(0, web3_validator_1.isNullish)(populatedTransaction.data)) {
+            if (!(0, web3_validator_1.isNullish)(populatedTransaction.input) &&
+                populatedTransaction.data !== populatedTransaction.input)
+                throw new web3_errors_1.TransactionDataAndInputError({
+                    data: (0, web3_utils_1.bytesToHex)(populatedTransaction.data),
+                    input: (0, web3_utils_1.bytesToHex)(populatedTransaction.input),
+                });
+            if (!populatedTransaction.data.startsWith('0x'))
+                populatedTransaction.data = `0x${populatedTransaction.data}`;
+        }
+        else if (!(0, web3_validator_1.isNullish)(populatedTransaction.input)) {
+            if (!populatedTransaction.input.startsWith('0x'))
+                populatedTransaction.input = `0x${populatedTransaction.input}`;
+        }
+        else {
+            populatedTransaction.input = '0x';
+        }
+        if ((0, web3_validator_1.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 ((0, web3_validator_1.isNullish)(populatedTransaction.chain)) {
+                populatedTransaction.chain = options.web3Context.defaultChain;
+            }
+            if ((0, web3_validator_1.isNullish)(populatedTransaction.hardfork)) {
+                populatedTransaction.hardfork = options.web3Context.defaultHardfork;
+            }
+        }
+        if ((0, web3_validator_1.isNullish)(populatedTransaction.chainId) &&
+            (0, web3_validator_1.isNullish)((_a = populatedTransaction.common) === null || _a === void 0 ? void 0 : _a.customChain.chainId)) {
+            populatedTransaction.chainId = yield (0, rpc_method_wrappers_js_1.getChainId)(options.web3Context, web3_types_1.ETH_DATA_FORMAT);
+        }
+        if ((0, web3_validator_1.isNullish)(populatedTransaction.networkId)) {
+            populatedTransaction.networkId =
+                (_b = options.web3Context.defaultNetworkId) !== null && _b !== void 0 ? _b : (yield (0, web3_net_1.getId)(options.web3Context, web3_types_1.ETH_DATA_FORMAT));
+        }
+        if ((0, web3_validator_1.isNullish)(populatedTransaction.gasLimit) && !(0, web3_validator_1.isNullish)(populatedTransaction.gas)) {
+            populatedTransaction.gasLimit = populatedTransaction.gas;
+        }
+        populatedTransaction.type = (0, exports.getTransactionType)(populatedTransaction, options.web3Context);
+        if ((0, web3_validator_1.isNullish)(populatedTransaction.accessList) &&
+            (populatedTransaction.type === '0x1' || populatedTransaction.type === '0x2')) {
+            populatedTransaction.accessList = [];
+        }
+        if (options.fillGasPrice)
+            populatedTransaction = Object.assign(Object.assign({}, populatedTransaction), (yield (0, get_transaction_gas_pricing_js_1.getTransactionGasPricing)(populatedTransaction, options.web3Context, web3_types_1.ETH_DATA_FORMAT)));
+        if ((0, web3_validator_1.isNullish)(populatedTransaction.gas) &&
+            (0, web3_validator_1.isNullish)(populatedTransaction.gasLimit) &&
+            options.fillGasLimit) {
+            const fillGasLimit = yield (0, rpc_method_wrappers_js_1.estimateGas)(options.web3Context, populatedTransaction, 'latest', web3_types_1.ETH_DATA_FORMAT);
+            populatedTransaction = Object.assign(Object.assign({}, populatedTransaction), { gas: (0, web3_utils_1.format)({ format: 'uint' }, fillGasLimit, web3_types_1.ETH_DATA_FORMAT) });
+        }
+        return populatedTransaction;
+    });
+}
+exports.defaultTransactionBuilder = defaultTransactionBuilder;
+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 }));
+});
+exports.transactionBuilder = transactionBuilder;
+//# sourceMappingURL=transaction_builder.js.map

package/lib/commonjs/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,2CAgBoB;AAEpB,yDAAwD;AACxD,uCAAiC;AACjC,mDAA6E;AAC7E,6CAMqB;AACrB,2CAAgD;AAChD,kDAAqD;AACrD,2CAA2C;AAC3C,sEAAyF;AACzF,6EAAqE;AACrE,8CAAkD;AAElD,2CAA2C;AAC3C,qFAA4E;AAErE,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,IAAA,0BAAS,EAAC,WAAW,CAAC,IAAI,CAAW,CAAC,EAAE;YACpF,OAAO,WAAW,CAAC,IAAI,CAAY,CAAC;SACpC;QACD,IAAI,CAAC,IAAA,4BAAW,EAAC,WAAW,CAAC,IAAI,CAAW,CAAC,IAAI,IAAA,yBAAQ,EAAC,WAAW,CAAC,IAAI,CAAY,CAAC,EAAE;YACxF,IAAI,WAAW,CAAC,MAAM,EAAE;gBACvB,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,CACrC,IAAA,mBAAM,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,IAAI,CAAY,EAAE,iCAAkB,CAAC,CAC5E,CAAC;gBAEF,IAAI,CAAC,IAAA,0BAAS,EAAC,OAAO,CAAC,EAAE;oBACxB,OAAO,OAAO,CAAC,OAAO,CAAC;iBACvB;gBAED,MAAM,IAAI,0CAA4B,EAAE,CAAC;aACzC;YACD,MAAM,IAAI,0CAA4B,EAAE,CAAC;SACzC;aAAM;YACN,MAAM,IAAI,KAAK,MAAM;gBACpB,CAAC,CAAC,IAAI,0CAA4B,CAAC,WAAW,CAAC,IAAI,CAAC;gBACpD,CAAC,CAAC,6DAA6D;oBAC7D,IAAI,4CAA8B,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;SACtD;KACD;IACD,IAAI,IAAI,KAAK,MAAM,EAAE;QACpB,IAAI,CAAC,IAAA,0BAAS,EAAC,UAAU,CAAC;YAAE,OAAO,IAAA,uCAAmB,EAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,IAAA,0BAAS,EAAC,WAAW,CAAC,cAAc,CAAC;YAAE,OAAO,WAAW,CAAC,cAAc,CAAC;KAC9E;IAED,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAxCW,QAAA,0BAA0B,8BAwCrC;AAEK,MAAM,mBAAmB,GAAG,CAClC,WAAyC,EACzC,OAAiB,EACjB,eAA6B,WAAW,CAAC,mBAAmC,EAC3E,EAAE;IACH,IAAI,IAAA,0BAAS,EAAC,OAAO,CAAC,EAAE;QACvB,mEAAmE;QACnE,MAAM,IAAI,wCAA0B,EAAE,CAAC;KACvC;IAED,OAAO,IAAA,4CAAmB,EAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;AAC1F,CAAC,CAAA,CAAC;AAXW,QAAA,mBAAmB,uBAW9B;AAEK,MAAM,kBAAkB,GAAG,CACjC,WAA4D,EAC5D,WAAyC,EACxC,EAAE;IACH,MAAM,YAAY,GAAG,IAAA,kDAAqB,EAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACrE,IAAI,CAAC,IAAA,0BAAS,EAAC,YAAY,CAAC;QAAE,OAAO,YAAY,CAAC;IAClD,IAAI,CAAC,IAAA,0BAAS,EAAC,WAAW,CAAC,sBAAsB,CAAC;QACjD,OAAO,IAAA,mBAAM,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,sBAAsB,EAAE,4BAAe,CAAC,CAAC;IAExF,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAVW,QAAA,kBAAkB,sBAU7B;AAEF,0FAA0F;AAC1F,oDAAoD;AACpD,SAAsB,yBAAyB,CAA2B,OAMzE;;;QACA,IAAI,oBAAoB,GAAG,IAAA,mBAAM,EAChC,8BAAiB,EACjB,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAChB,CAAC;QAEzB,IAAI,IAAA,0BAAS,EAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE;YACzC,oBAAoB,CAAC,IAAI,GAAG,IAAA,kCAA0B,EACrD,MAAM,EACN,OAAO,CAAC,WAAW,EACnB,SAAS,EACT,OAAO,CAAC,UAAU,CAClB,CAAC;SACF;QAED,uDAAuD;QACvD,IAAI,IAAA,0BAAS,EAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE;YAC1C,oBAAoB,CAAC,KAAK,GAAG,MAAM,IAAA,2BAAmB,EACrD,OAAO,CAAC,WAAW,EACnB,oBAAoB,CAAC,IAAI,EACzB,4BAAe,CACf,CAAC;SACF;QAED,IAAI,IAAA,0BAAS,EAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE;YAC1C,oBAAoB,CAAC,KAAK,GAAG,KAAK,CAAC;SACnC;QAED,IAAI,CAAC,IAAA,0BAAS,EAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE;YAC1C,IACC,CAAC,IAAA,0BAAS,EAAC,oBAAoB,CAAC,KAAK,CAAC;gBACtC,oBAAoB,CAAC,IAAI,KAAK,oBAAoB,CAAC,KAAK;gBAExD,MAAM,IAAI,0CAA4B,CAAC;oBACtC,IAAI,EAAE,IAAA,uBAAU,EAAC,oBAAoB,CAAC,IAAI,CAAC;oBAC3C,KAAK,EAAE,IAAA,uBAAU,EAAC,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,IAAA,0BAAS,EAAC,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,IAAA,0BAAS,EAAC,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,IAAA,0BAAS,EAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE;gBAC1C,oBAAoB,CAAC,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,YAA2B,CAAC;aAC7E;YACD,IAAI,IAAA,0BAAS,EAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE;gBAC7C,oBAAoB,CAAC,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,eAA2B,CAAC;aAChF;SACD;QAED,IACC,IAAA,0BAAS,EAAC,oBAAoB,CAAC,OAAO,CAAC;YACvC,IAAA,0BAAS,EAAC,MAAA,oBAAoB,CAAC,MAAM,0CAAE,WAAW,CAAC,OAAO,CAAC,EAC1D;YACD,oBAAoB,CAAC,OAAO,GAAG,MAAM,IAAA,mCAAU,EAAC,OAAO,CAAC,WAAW,EAAE,4BAAe,CAAC,CAAC;SACtF;QAED,IAAI,IAAA,0BAAS,EAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE;YAC9C,oBAAoB,CAAC,SAAS;gBAC7B,MAAC,OAAO,CAAC,WAAW,CAAC,gBAA2B,mCAChD,CAAC,MAAM,IAAA,gBAAK,EAAC,OAAO,CAAC,WAAW,EAAE,4BAAe,CAAC,CAAC,CAAC;SACrD;QAED,IAAI,IAAA,0BAAS,EAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAA,0BAAS,EAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE;YACrF,oBAAoB,CAAC,QAAQ,GAAG,oBAAoB,CAAC,GAAG,CAAC;SACzD;QAED,oBAAoB,CAAC,IAAI,GAAG,IAAA,0BAAkB,EAAC,oBAAoB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1F,IACC,IAAA,0BAAS,EAAC,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,IAAA,yDAAwB,EACjC,oBAAoB,EACpB,OAAO,CAAC,WAAW,EACnB,4BAAe,CACf,CAAC,CACF,CAAC;QACH,IACC,IAAA,0BAAS,EAAC,oBAAoB,CAAC,GAAG,CAAC;YACnC,IAAA,0BAAS,EAAC,oBAAoB,CAAC,QAAQ,CAAC;YACxC,OAAO,CAAC,YAAY,EACnB;YACD,MAAM,YAAY,GAAG,MAAM,IAAA,oCAAW,EACrC,OAAO,CAAC,WAAW,EACnB,oBAAoB,EACpB,QAAQ,EACR,4BAAe,CACf,CAAC;YACF,oBAAoB,mCAChB,oBAAoB,KACvB,GAAG,EAAE,IAAA,mBAAM,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,YAAuB,EAAE,4BAAe,CAAC,GACzE,CAAC;SACF;QACD,OAAO,oBAAkC,CAAC;;CAC1C;AA5HD,8DA4HC;AAEM,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;AAbhB,QAAA,kBAAkB,sBAaF"}

package/lib/commonjs/utils/try_send_transaction.d.ts

@@ -0,0 +1,11 @@
+import { Web3Context } from 'web3-core';
+import { EthExecutionAPI, Bytes } from 'web3-types';
+import { AsyncFunction } from 'web3-utils';
+/**
+ * An internal function to send a transaction or throws if sending did not finish during the timeout during the blocks-timeout.
+ * @param web3Context - the context to read the configurations from
+ * @param sendTransactionFunc - the function that will send the transaction (could be sendTransaction or sendRawTransaction)
+ * @param transactionHash - to be used inside the exception message if there will be any exceptions.
+ * @returns the Promise<string> returned by the `sendTransactionFunc`.
+ */
+export declare function trySendTransaction(web3Context: Web3Context<EthExecutionAPI>, sendTransactionFunc: AsyncFunction<string>, transactionHash?: Bytes): Promise<string>;

package/lib/commonjs/utils/try_send_transaction.js

@@ -0,0 +1,46 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trySendTransaction = void 0;
+const web3_utils_1 = require("web3-utils");
+const web3_errors_1 = require("web3-errors");
+// eslint-disable-next-line import/no-cycle
+const reject_if_block_timeout_js_1 = require("./reject_if_block_timeout.js");
+/**
+ * An internal function to send a transaction or throws if sending did not finish during the timeout during the blocks-timeout.
+ * @param web3Context - the context to read the configurations from
+ * @param sendTransactionFunc - the function that will send the transaction (could be sendTransaction or sendRawTransaction)
+ * @param transactionHash - to be used inside the exception message if there will be any exceptions.
+ * @returns the Promise<string> returned by the `sendTransactionFunc`.
+ */
+function trySendTransaction(web3Context, sendTransactionFunc, transactionHash) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const [timeoutId, rejectOnTimeout] = (0, web3_utils_1.rejectIfTimeout)(web3Context.transactionSendTimeout, new web3_errors_1.TransactionSendTimeoutError({
+            numberOfSeconds: web3Context.transactionSendTimeout / 1000,
+            transactionHash,
+        }));
+        const [rejectOnBlockTimeout, blockTimeoutResourceCleaner] = yield (0, reject_if_block_timeout_js_1.rejectIfBlockTimeout)(web3Context, transactionHash);
+        try {
+            // If an error happened here, do not catch it, just clear the resources before raising it to the caller function.
+            return yield Promise.race([
+                sendTransactionFunc(),
+                rejectOnTimeout,
+                rejectOnBlockTimeout, // this will throw an error on Transaction Block Timeout
+            ]);
+        }
+        finally {
+            clearTimeout(timeoutId);
+            blockTimeoutResourceCleaner.clean();
+        }
+    });
+}
+exports.trySendTransaction = trySendTransaction;
+//# sourceMappingURL=try_send_transaction.js.map

package/lib/commonjs/utils/try_send_transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"try_send_transaction.js","sourceRoot":"","sources":["../../../src/utils/try_send_transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;AAkBA,2CAA4D;AAC5D,6CAA0D;AAE1D,2CAA2C;AAC3C,6EAAoE;AAEpE;;;;;;GAMG;AACH,SAAsB,kBAAkB,CACvC,WAAyC,EACzC,mBAA0C,EAC1C,eAAuB;;QAEvB,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,GAAG,IAAA,4BAAe,EACnD,WAAW,CAAC,sBAAsB,EAClC,IAAI,yCAA2B,CAAC;YAC/B,eAAe,EAAE,WAAW,CAAC,sBAAsB,GAAG,IAAI;YAC1D,eAAe;SACf,CAAC,CACF,CAAC;QAEF,MAAM,CAAC,oBAAoB,EAAE,2BAA2B,CAAC,GAAG,MAAM,IAAA,iDAAoB,EACrF,WAAW,EACX,eAAe,CACf,CAAC;QAEF,IAAI;YACH,iHAAiH;YACjH,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC;gBACzB,mBAAmB,EAAE;gBACrB,eAAe;gBACf,oBAAoB,EAAE,wDAAwD;aAC9E,CAAC,CAAC;SACH;gBAAS;YACT,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,2BAA2B,CAAC,KAAK,EAAE,CAAC;SACpC;IACF,CAAC;CAAA;AA7BD,gDA6BC"}

package/lib/commonjs/utils/wait_for_transaction_receipt.d.ts

@@ -0,0 +1,3 @@
+import { Web3Context } from 'web3-core';
+import { EthExecutionAPI, Bytes, TransactionReceipt, DataFormat } from 'web3-types';
+export declare function waitForTransactionReceipt<ReturnFormat extends DataFormat>(web3Context: Web3Context<EthExecutionAPI>, transactionHash: Bytes, returnFormat: ReturnFormat, customGetTransactionReceipt?: (web3Context: Web3Context<EthExecutionAPI>, transactionHash: Bytes, returnFormat: ReturnFormat) => Promise<TransactionReceipt>): Promise<TransactionReceipt>;

package/lib/commonjs/utils/wait_for_transaction_receipt.js

@@ -0,0 +1,72 @@
+"use strict";
+/*
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForTransactionReceipt = void 0;
+const web3_errors_1 = require("web3-errors");
+// eslint-disable-next-line import/no-cycle
+const web3_utils_1 = require("web3-utils");
+// eslint-disable-next-line import/no-cycle
+const reject_if_block_timeout_js_1 = require("./reject_if_block_timeout.js");
+// eslint-disable-next-line import/no-cycle
+const rpc_method_wrappers_js_1 = require("../rpc_method_wrappers.js");
+function waitForTransactionReceipt(web3Context, transactionHash, returnFormat, customGetTransactionReceipt) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const pollingInterval = (_a = web3Context.transactionReceiptPollingInterval) !== null && _a !== void 0 ? _a : web3Context.transactionPollingInterval;
+        const [awaitableTransactionReceipt, IntervalId] = (0, web3_utils_1.pollTillDefinedAndReturnIntervalId)(() => __awaiter(this, void 0, void 0, function* () {
+            try {
+                return (customGetTransactionReceipt !== null && customGetTransactionReceipt !== void 0 ? customGetTransactionReceipt : rpc_method_wrappers_js_1.getTransactionReceipt)(web3Context, transactionHash, returnFormat);
+            }
+            catch (error) {
+                console.warn('An error happen while trying to get the transaction receipt', error);
+                return undefined;
+            }
+        }), pollingInterval);
+        const [timeoutId, rejectOnTimeout] = (0, web3_utils_1.rejectIfTimeout)(web3Context.transactionPollingTimeout, new web3_errors_1.TransactionPollingTimeoutError({
+            numberOfSeconds: web3Context.transactionPollingTimeout / 1000,
+            transactionHash,
+        }));
+        const [rejectOnBlockTimeout, blockTimeoutResourceCleaner] = yield (0, reject_if_block_timeout_js_1.rejectIfBlockTimeout)(web3Context, transactionHash);
+        try {
+            // If an error happened here, do not catch it, just clear the resources before raising it to the caller function.
+            return yield Promise.race([
+                awaitableTransactionReceipt,
+                rejectOnTimeout,
+                rejectOnBlockTimeout, // this will throw an error on Transaction Block Timeout
+            ]);
+        }
+        finally {
+            if (timeoutId)
+                clearTimeout(timeoutId);
+            if (IntervalId)
+                clearInterval(IntervalId);
+            blockTimeoutResourceCleaner.clean();
+        }
+    });
+}
+exports.waitForTransactionReceipt = waitForTransactionReceipt;
+//# sourceMappingURL=wait_for_transaction_receipt.js.map

package/lib/commonjs/utils/wait_for_transaction_receipt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait_for_transaction_receipt.js","sourceRoot":"","sources":["../../../src/utils/wait_for_transaction_receipt.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;EAeE;;;;;;;;;;;;AAGF,6CAA6D;AAG7D,2CAA2C;AAC3C,2CAAiF;AACjF,2CAA2C;AAC3C,6EAAoE;AACpE,2CAA2C;AAC3C,sEAAkE;AAElE,SAAsB,yBAAyB,CAC9C,WAAyC,EACzC,eAAsB,EACtB,YAA0B,EAC1B,2BAIgC;;;QAEhC,MAAM,eAAe,GACpB,MAAA,WAAW,CAAC,iCAAiC,mCAAI,WAAW,CAAC,0BAA0B,CAAC;QAEzF,MAAM,CAAC,2BAA2B,EAAE,UAAU,CAAC,GAAG,IAAA,+CAAkC,EACnF,GAAS,EAAE;YACV,IAAI;gBACH,OAAO,CAAC,2BAA2B,aAA3B,2BAA2B,cAA3B,2BAA2B,GAAI,8CAAqB,CAAC,CAC5D,WAAW,EACX,eAAe,EACf,YAAY,CACZ,CAAC;aACF;YAAC,OAAO,KAAK,EAAE;gBACf,OAAO,CAAC,IAAI,CAAC,6DAA6D,EAAE,KAAK,CAAC,CAAC;gBACnF,OAAO,SAAS,CAAC;aACjB;QACF,CAAC,CAAA,EACD,eAAe,CACf,CAAC;QAEF,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,GAAG,IAAA,4BAAe,EACnD,WAAW,CAAC,yBAAyB,EACrC,IAAI,4CAA8B,CAAC;YAClC,eAAe,EAAE,WAAW,CAAC,yBAAyB,GAAG,IAAI;YAC7D,eAAe;SACf,CAAC,CACF,CAAC;QAEF,MAAM,CAAC,oBAAoB,EAAE,2BAA2B,CAAC,GAAG,MAAM,IAAA,iDAAoB,EACrF,WAAW,EACX,eAAe,CACf,CAAC;QAEF,IAAI;YACH,iHAAiH;YACjH,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC;gBACzB,2BAA2B;gBAC3B,eAAe;gBACf,oBAAoB,EAAE,wDAAwD;aAC9E,CAAC,CAAC;SACH;gBAAS;YACT,IAAI,SAAS;gBAAE,YAAY,CAAC,SAAS,CAAC,CAAC;YACvC,IAAI,UAAU;gBAAE,aAAa,CAAC,UAAU,CAAC,CAAC;YAC1C,2BAA2B,CAAC,KAAK,EAAE,CAAC;SACpC;;CACD;AAtDD,8DAsDC"}

package/lib/commonjs/utils/watch_transaction_by_polling.d.ts

@@ -0,0 +1,19 @@
+import { EthExecutionAPI, TransactionReceipt } from 'web3-types';
+import { Web3Context, Web3PromiEvent } from 'web3-core';
+import { DataFormat } from 'web3-types';
+import { JsonSchema } from 'web3-validator';
+import { SendSignedTransactionEvents, SendTransactionEvents } from '../types.js';
+export declare type Web3PromiEventEventTypeBase<ReturnFormat extends DataFormat> = SendTransactionEvents<ReturnFormat> | SendSignedTransactionEvents<ReturnFormat>;
+export declare type WaitProps<ReturnFormat extends DataFormat, ResolveType = TransactionReceipt> = {
+    web3Context: Web3Context<EthExecutionAPI>;
+    transactionReceipt: TransactionReceipt;
+    customTransactionReceiptSchema?: JsonSchema;
+    transactionPromiEvent: Web3PromiEvent<ResolveType, Web3PromiEventEventTypeBase<ReturnFormat>>;
+    returnFormat: ReturnFormat;
+};
+/**
+ * This function watches a Transaction by subscribing to new heads.
+ * It is used by `watchTransactionForConfirmations`, in case the provider does not support subscription.
+ * And it is also used by `watchTransactionBySubscription`, as a fallback, if the subscription failed for any reason.
+ */
+export declare const watchTransactionByPolling: <ReturnFormat extends DataFormat, ResolveType = TransactionReceipt>({ web3Context, transactionReceipt, transactionPromiEvent, customTransactionReceiptSchema, returnFormat, }: WaitProps<ReturnFormat, ResolveType>) => void;

package/lib/commonjs/utils/watch_transaction_by_polling.js

@@ -0,0 +1,45 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.watchTransactionByPolling = void 0;
+const web3_utils_1 = require("web3-utils");
+const web3_rpc_methods_1 = require("web3-rpc-methods");
+const schemas_js_1 = require("../schemas.js");
+/**
+ * This function watches a Transaction by subscribing to new heads.
+ * It is used by `watchTransactionForConfirmations`, in case the provider does not support subscription.
+ * And it is also used by `watchTransactionBySubscription`, as a fallback, if the subscription failed for any reason.
+ */
+const watchTransactionByPolling = ({ web3Context, transactionReceipt, transactionPromiEvent, customTransactionReceiptSchema, returnFormat, }) => {
+    var _a;
+    // Having a transactionReceipt means that the transaction has already been included
+    // in at least one block, so we start with 1
+    let confirmations = 1;
+    const intervalId = setInterval(() => {
+        (() => __awaiter(void 0, void 0, void 0, function* () {
+            if (confirmations >= web3Context.transactionConfirmationBlocks) {
+                clearInterval(intervalId);
+                return;
+            }
+            const nextBlock = yield web3_rpc_methods_1.ethRpcMethods.getBlockByNumber(web3Context.requestManager, (0, web3_utils_1.numberToHex)(BigInt(transactionReceipt.blockNumber) + BigInt(confirmations)), false);
+            if (nextBlock === null || nextBlock === void 0 ? void 0 : nextBlock.hash) {
+                confirmations += 1;
+                transactionPromiEvent.emit('confirmation', {
+                    confirmations: (0, web3_utils_1.format)({ format: 'uint' }, confirmations, returnFormat),
+                    receipt: (0, web3_utils_1.format)(customTransactionReceiptSchema !== null && customTransactionReceiptSchema !== void 0 ? customTransactionReceiptSchema : schemas_js_1.transactionReceiptSchema, transactionReceipt, returnFormat),
+                    latestBlockHash: (0, web3_utils_1.format)({ format: 'bytes32' }, nextBlock.hash, returnFormat),
+                });
+            }
+        }))();
+    }, (_a = web3Context.transactionReceiptPollingInterval) !== null && _a !== void 0 ? _a : web3Context.transactionPollingInterval);
+};
+exports.watchTransactionByPolling = watchTransactionByPolling;
+//# sourceMappingURL=watch_transaction_by_polling.js.map

package/lib/commonjs/utils/watch_transaction_by_polling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch_transaction_by_polling.js","sourceRoot":"","sources":["../../../src/utils/watch_transaction_by_polling.ts"],"names":[],"mappings":";;;;;;;;;;;;AAkBA,2CAAiD;AACjD,uDAAiD;AAKjD,8CAAyD;AAczD;;;;GAIG;AACI,MAAM,yBAAyB,GAAG,CAGvC,EACD,WAAW,EACX,kBAAkB,EAClB,qBAAqB,EACrB,8BAA8B,EAC9B,YAAY,GAC0B,EAAE,EAAE;;IAC1C,mFAAmF;IACnF,4CAA4C;IAC5C,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE;QACnC,CAAC,GAAS,EAAE;YACX,IAAI,aAAa,IAAI,WAAW,CAAC,6BAA6B,EAAE;gBAC/D,aAAa,CAAC,UAAU,CAAC,CAAC;gBAC1B,OAAO;aACP;YAED,MAAM,SAAS,GAAG,MAAM,gCAAa,CAAC,gBAAgB,CACrD,WAAW,CAAC,cAAc,EAC1B,IAAA,wBAAW,EAAC,MAAM,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,EAC3E,KAAK,CACL,CAAC;YAEF,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI,EAAE;gBACpB,aAAa,IAAI,CAAC,CAAC;gBAEnB,qBAAqB,CAAC,IAAI,CAAC,cAAc,EAAE;oBAC1C,aAAa,EAAE,IAAA,mBAAM,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,YAAY,CAAC;oBACtE,OAAO,EAAE,IAAA,mBAAM,EACd,8BAA8B,aAA9B,8BAA8B,cAA9B,8BAA8B,GAAI,qCAAwB,EAC1D,kBAAkB,EAClB,YAAY,CACZ;oBACD,eAAe,EAAE,IAAA,mBAAM,EACtB,EAAE,MAAM,EAAE,SAAS,EAAE,EACrB,SAAS,CAAC,IAAa,EACvB,YAAY,CACZ;iBACD,CAAC,CAAC;aACH;QACF,CAAC,CAAA,CAAC,EAAa,CAAC;IACjB,CAAC,EAAE,MAAA,WAAW,CAAC,iCAAiC,mCAAI,WAAW,CAAC,0BAA0B,CAAC,CAAC;AAC7F,CAAC,CAAC;AA7CW,QAAA,yBAAyB,6BA6CpC"}

package/lib/commonjs/utils/watch_transaction_by_subscription.d.ts

@@ -0,0 +1,8 @@
+import { TransactionReceipt } from 'web3-types';
+import { DataFormat } from 'web3-types';
+import { WaitProps } from './watch_transaction_by_polling.js';
+/**
+ * This function watches a Transaction by subscribing to new heads.
+ * It is used by `watchTransactionForConfirmations`, in case the provider supports subscription.
+ */
+export declare const watchTransactionBySubscription: <ReturnFormat extends DataFormat, ResolveType = TransactionReceipt>({ web3Context, transactionReceipt, transactionPromiEvent, customTransactionReceiptSchema, returnFormat, }: WaitProps<ReturnFormat, ResolveType>) => void;