wb3cor 0.0.1-security → 4.7.0

package/lib/commonjs/web3_config.js

@@ -0,0 +1,436 @@
+"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/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Web3Config = exports.Web3ConfigEvent = void 0;
+const web3_types_1 = require("web3-types");
+const web3_errors_1 = require("web3-errors");
+const web3_utils_1 = require("web3-utils");
+const web3_event_emitter_js_1 = require("./web3_event_emitter.js");
+var Web3ConfigEvent;
+(function (Web3ConfigEvent) {
+    Web3ConfigEvent["CONFIG_CHANGE"] = "CONFIG_CHANGE";
+})(Web3ConfigEvent = exports.Web3ConfigEvent || (exports.Web3ConfigEvent = {}));
+class Web3Config extends web3_event_emitter_js_1.Web3EventEmitter {
+    constructor(options) {
+        super();
+        this.config = {
+            handleRevert: false,
+            defaultAccount: undefined,
+            defaultBlock: 'latest',
+            transactionBlockTimeout: 50,
+            transactionConfirmationBlocks: 24,
+            transactionPollingInterval: 1000,
+            transactionPollingTimeout: 750 * 1000,
+            transactionReceiptPollingInterval: undefined,
+            transactionSendTimeout: 750 * 1000,
+            transactionConfirmationPollingInterval: undefined,
+            blockHeaderTimeout: 10,
+            maxListenersWarningThreshold: 100,
+            contractDataInputFill: 'data',
+            defaultNetworkId: undefined,
+            defaultChain: 'mainnet',
+            defaultHardfork: 'london',
+            // TODO - Check if there is a default Common
+            defaultCommon: undefined,
+            defaultTransactionType: '0x2',
+            defaultMaxPriorityFeePerGas: (0, web3_utils_1.toHex)(2500000000),
+            enableExperimentalFeatures: {
+                useSubscriptionWhenCheckingBlockTimeout: false,
+                useRpcCallSpecification: false,
+            },
+            transactionBuilder: undefined,
+            transactionTypeParser: undefined,
+            customTransactionSchema: undefined,
+            defaultReturnFormat: web3_types_1.DEFAULT_RETURN_FORMAT,
+            ignoreGasPricing: false,
+        };
+        this.setConfig(options !== null && options !== void 0 ? options : {});
+    }
+    setConfig(options) {
+        // TODO: Improve and add key check
+        const keys = Object.keys(options);
+        for (const key of keys) {
+            this._triggerConfigChange(key, options[key]);
+            if (!(0, web3_utils_1.isNullish)(options[key]) &&
+                typeof options[key] === 'number' &&
+                key === 'maxListenersWarningThreshold') {
+                // additionally set in event emitter
+                this.setMaxListenerWarningThreshold(Number(options[key]));
+            }
+        }
+        Object.assign(this.config, options);
+    }
+    /**
+     * The `handleRevert` options property returns the revert reason string if enabled for the following methods:
+     * - web3.eth.sendTransaction()
+     * - web3.eth.call()
+     * - myContract.methods.myMethod().call()
+     * - myContract.methods.myMethod().send()
+     * Default is `false`.
+     *
+     * `Note`: At the moment `handleRevert` is only supported for `sendTransaction` and not for `sendSignedTransaction`
+     */
+    get handleRevert() {
+        return this.config.handleRevert;
+    }
+    /**
+     * Will set the handleRevert
+     */
+    set handleRevert(val) {
+        this._triggerConfigChange('handleRevert', val);
+        this.config.handleRevert = val;
+    }
+    /**
+     * The `contractDataInputFill` options property will allow you to set the hash of the method signature and encoded parameters to the property
+     * either `data`, `input` or both within your contract.
+     * This will affect the contracts send, call and estimateGas methods
+     * Default is `data`.
+     */
+    get contractDataInputFill() {
+        return this.config.contractDataInputFill;
+    }
+    /**
+     * Will set the contractDataInputFill
+     */
+    set contractDataInputFill(val) {
+        this._triggerConfigChange('contractDataInputFill', val);
+        this.config.contractDataInputFill = val;
+    }
+    /**
+     * This default address is used as the default `from` property, if no `from` property is specified in for the following methods:
+     * - web3.eth.sendTransaction()
+     * - web3.eth.call()
+     * - myContract.methods.myMethod().call()
+     * - myContract.methods.myMethod().send()
+     */
+    get defaultAccount() {
+        return this.config.defaultAccount;
+    }
+    /**
+     * Will set the default account.
+     */
+    set defaultAccount(val) {
+        this._triggerConfigChange('defaultAccount', val);
+        this.config.defaultAccount = val;
+    }
+    /**
+     * The default block is used for certain methods. You can override it by passing in the defaultBlock as last parameter. The default value is `"latest"`.
+     * - web3.eth.getBalance()
+     * - web3.eth.getCode()
+     * - web3.eth.getTransactionCount()
+     * - web3.eth.getStorageAt()
+     * - web3.eth.call()
+     * - myContract.methods.myMethod().call()
+     */
+    get defaultBlock() {
+        return this.config.defaultBlock;
+    }
+    /**
+     * Will set the default block.
+     *
+     * - A block number
+     * - `"earliest"` - String: The genesis block
+     * - `"latest"` - String: The latest block (current head of the blockchain)
+     * - `"pending"` - String: The currently mined block (including pending transactions)
+     * - `"finalized"` - String: (For POS networks) The finalized block is one which has been accepted as canonical by greater than 2/3 of validators
+     * - `"safe"` - String: (For POS networks) The safe head block is one which under normal network conditions, is expected to be included in the canonical chain. Under normal network conditions the safe head and the actual tip of the chain will be equivalent (with safe head trailing only by a few seconds). Safe heads will be less likely to be reorged than the proof of work network's latest blocks.
+     */
+    set defaultBlock(val) {
+        this._triggerConfigChange('defaultBlock', val);
+        this.config.defaultBlock = val;
+    }
+    /**
+     * The time used to wait for Ethereum Node to return the sent transaction result.
+     * Note: If the RPC call stuck at the Node and therefor timed-out, the transaction may still be pending or even mined by the Network. We recommend checking the pending transactions in such a case.
+     * Default is `750` seconds (12.5 minutes).
+     */
+    get transactionSendTimeout() {
+        return this.config.transactionSendTimeout;
+    }
+    /**
+     * Will set the transactionSendTimeout.
+     */
+    set transactionSendTimeout(val) {
+        this._triggerConfigChange('transactionSendTimeout', val);
+        this.config.transactionSendTimeout = val;
+    }
+    /**
+     * The `transactionBlockTimeout` is used over socket-based connections. This option defines the amount of new blocks it should wait until the first confirmation happens, otherwise the PromiEvent rejects with a timeout error.
+     * Default is `50`.
+     */
+    get transactionBlockTimeout() {
+        return this.config.transactionBlockTimeout;
+    }
+    /**
+     * Will set the transactionBlockTimeout.
+     */
+    set transactionBlockTimeout(val) {
+        this._triggerConfigChange('transactionBlockTimeout', val);
+        this.config.transactionBlockTimeout = val;
+    }
+    /**
+     * This defines the number of blocks it requires until a transaction is considered confirmed.
+     * Default is `24`.
+     */
+    get transactionConfirmationBlocks() {
+        return this.config.transactionConfirmationBlocks;
+    }
+    /**
+     * Will set the transactionConfirmationBlocks.
+     */
+    set transactionConfirmationBlocks(val) {
+        this._triggerConfigChange('transactionConfirmationBlocks', val);
+        this.config.transactionConfirmationBlocks = val;
+    }
+    /**
+     * Used over HTTP connections. This option defines the number of seconds between Web3 calls for a receipt which confirms that a transaction was mined by the network.
+     * Default is `1000` ms.
+     */
+    get transactionPollingInterval() {
+        return this.config.transactionPollingInterval;
+    }
+    /**
+     * Will set the transactionPollingInterval.
+     */
+    set transactionPollingInterval(val) {
+        this._triggerConfigChange('transactionPollingInterval', val);
+        this.config.transactionPollingInterval = val;
+        this.transactionReceiptPollingInterval = val;
+        this.transactionConfirmationPollingInterval = val;
+    }
+    /**
+     * Used over HTTP connections. This option defines the number of seconds Web3 will wait for a receipt which confirms that a transaction was mined by the network. Note: If this method times out, the transaction may still be pending.
+     * Default is `750` seconds (12.5 minutes).
+     */
+    get transactionPollingTimeout() {
+        return this.config.transactionPollingTimeout;
+    }
+    /**
+     * Will set the transactionPollingTimeout.
+     */
+    set transactionPollingTimeout(val) {
+        this._triggerConfigChange('transactionPollingTimeout', val);
+        this.config.transactionPollingTimeout = val;
+    }
+    /**
+     * The `transactionPollingInterval` is used over HTTP connections. This option defines the number of seconds between Web3 calls for a receipt which confirms that a transaction was mined by the network.
+     * Default is `undefined`
+     */
+    get transactionReceiptPollingInterval() {
+        return this.config.transactionReceiptPollingInterval;
+    }
+    /**
+     * Will set the transactionReceiptPollingInterval
+     */
+    set transactionReceiptPollingInterval(val) {
+        this._triggerConfigChange('transactionReceiptPollingInterval', val);
+        this.config.transactionReceiptPollingInterval = val;
+    }
+    get transactionConfirmationPollingInterval() {
+        return this.config.transactionConfirmationPollingInterval;
+    }
+    set transactionConfirmationPollingInterval(val) {
+        this._triggerConfigChange('transactionConfirmationPollingInterval', val);
+        this.config.transactionConfirmationPollingInterval = val;
+    }
+    /**
+     * The blockHeaderTimeout is used over socket-based connections. This option defines the amount seconds it should wait for `'newBlockHeaders'` event before falling back to polling to fetch transaction receipt.
+     * Default is `10` seconds.
+     */
+    get blockHeaderTimeout() {
+        return this.config.blockHeaderTimeout;
+    }
+    /**
+     * Will set the blockHeaderTimeout
+     */
+    set blockHeaderTimeout(val) {
+        this._triggerConfigChange('blockHeaderTimeout', val);
+        this.config.blockHeaderTimeout = val;
+    }
+    /**
+     * The enableExperimentalFeatures is used to enable trying new experimental features that are still not fully implemented or not fully tested or still have some related issues.
+     * Default is `false` for every feature.
+     */
+    get enableExperimentalFeatures() {
+        return this.config.enableExperimentalFeatures;
+    }
+    /**
+     * Will set the enableExperimentalFeatures
+     */
+    set enableExperimentalFeatures(val) {
+        this._triggerConfigChange('enableExperimentalFeatures', val);
+        this.config.enableExperimentalFeatures = val;
+    }
+    get maxListenersWarningThreshold() {
+        return this.config.maxListenersWarningThreshold;
+    }
+    set maxListenersWarningThreshold(val) {
+        this._triggerConfigChange('maxListenersWarningThreshold', val);
+        this.setMaxListenerWarningThreshold(val);
+        this.config.maxListenersWarningThreshold = val;
+    }
+    get defaultReturnFormat() {
+        return this.config.defaultReturnFormat;
+    }
+    set defaultReturnFormat(val) {
+        this._triggerConfigChange('defaultReturnFormat', val);
+        this.config.defaultReturnFormat = val;
+    }
+    get defaultNetworkId() {
+        return this.config.defaultNetworkId;
+    }
+    set defaultNetworkId(val) {
+        this._triggerConfigChange('defaultNetworkId', val);
+        this.config.defaultNetworkId = val;
+    }
+    get defaultChain() {
+        return this.config.defaultChain;
+    }
+    set defaultChain(val) {
+        if (!(0, web3_utils_1.isNullish)(this.config.defaultCommon) &&
+            !(0, web3_utils_1.isNullish)(this.config.defaultCommon.baseChain) &&
+            val !== this.config.defaultCommon.baseChain)
+            throw new web3_errors_1.ConfigChainMismatchError(this.config.defaultChain, val);
+        this._triggerConfigChange('defaultChain', val);
+        this.config.defaultChain = val;
+    }
+    /**
+     * Will return the default hardfork. Default is `london`
+     * The default hardfork property can be one of the following:
+     * - `chainstart`
+     * - `homestead`
+     * - `dao`
+     * - `tangerineWhistle`
+     * - `spuriousDragon`
+     * - `byzantium`
+     * - `constantinople`
+     * - `petersburg`
+     * - `istanbul`
+     * - `berlin`
+     * - `london`
+     * - 'arrowGlacier',
+     * - 'tangerineWhistle',
+     * - 'muirGlacier'
+     *
+     */
+    get defaultHardfork() {
+        return this.config.defaultHardfork;
+    }
+    /**
+     * Will set the default hardfork.
+     *
+     */
+    set defaultHardfork(val) {
+        if (!(0, web3_utils_1.isNullish)(this.config.defaultCommon) &&
+            !(0, web3_utils_1.isNullish)(this.config.defaultCommon.hardfork) &&
+            val !== this.config.defaultCommon.hardfork)
+            throw new web3_errors_1.ConfigHardforkMismatchError(this.config.defaultCommon.hardfork, val);
+        this._triggerConfigChange('defaultHardfork', val);
+        this.config.defaultHardfork = val;
+    }
+    /**
+     *
+     * Will get the default common property
+     * The default common property does contain the following Common object:
+     * - `customChain` - `Object`: The custom chain properties
+     * 	- `name` - `string`: (optional) The name of the chain
+     * 	- `networkId` - `number`: Network ID of the custom chain
+     * 	- `chainId` - `number`: Chain ID of the custom chain
+     * - `baseChain` - `string`: (optional) mainnet, goerli, kovan, rinkeby, or ropsten
+     * - `hardfork` - `string`: (optional) chainstart, homestead, dao, tangerineWhistle, spuriousDragon, byzantium, constantinople, petersburg, istanbul, berlin, or london
+     * Default is `undefined`.
+     *
+     */
+    get defaultCommon() {
+        return this.config.defaultCommon;
+    }
+    /**
+     * Will set the default common property
+     *
+     */
+    set defaultCommon(val) {
+        // validation check if default hardfork is set and matches defaultCommon hardfork
+        if (!(0, web3_utils_1.isNullish)(this.config.defaultHardfork) &&
+            !(0, web3_utils_1.isNullish)(val) &&
+            !(0, web3_utils_1.isNullish)(val.hardfork) &&
+            this.config.defaultHardfork !== val.hardfork)
+            throw new web3_errors_1.ConfigHardforkMismatchError(this.config.defaultHardfork, val.hardfork);
+        if (!(0, web3_utils_1.isNullish)(this.config.defaultChain) &&
+            !(0, web3_utils_1.isNullish)(val) &&
+            !(0, web3_utils_1.isNullish)(val.baseChain) &&
+            this.config.defaultChain !== val.baseChain)
+            throw new web3_errors_1.ConfigChainMismatchError(this.config.defaultChain, val.baseChain);
+        this._triggerConfigChange('defaultCommon', val);
+        this.config.defaultCommon = val;
+    }
+    /**
+     *  Will get the ignoreGasPricing property. When true, the gasPrice, maxPriorityFeePerGas, and maxFeePerGas will not be autofilled in the transaction object.
+     *  Useful when you want wallets to handle gas pricing.
+     */
+    get ignoreGasPricing() {
+        return this.config.ignoreGasPricing;
+    }
+    set ignoreGasPricing(val) {
+        this._triggerConfigChange('ignoreGasPricing', val);
+        this.config.ignoreGasPricing = val;
+    }
+    get defaultTransactionType() {
+        return this.config.defaultTransactionType;
+    }
+    set defaultTransactionType(val) {
+        this._triggerConfigChange('defaultTransactionType', val);
+        this.config.defaultTransactionType = val;
+    }
+    get defaultMaxPriorityFeePerGas() {
+        return this.config.defaultMaxPriorityFeePerGas;
+    }
+    set defaultMaxPriorityFeePerGas(val) {
+        this._triggerConfigChange('defaultMaxPriorityFeePerGas', val);
+        this.config.defaultMaxPriorityFeePerGas = val;
+    }
+    get transactionBuilder() {
+        return this.config.transactionBuilder;
+    }
+    set transactionBuilder(val) {
+        this._triggerConfigChange('transactionBuilder', val);
+        this.config.transactionBuilder = val;
+    }
+    get transactionTypeParser() {
+        return this.config.transactionTypeParser;
+    }
+    set transactionTypeParser(val) {
+        this._triggerConfigChange('transactionTypeParser', val);
+        this.config.transactionTypeParser = val;
+    }
+    get customTransactionSchema() {
+        return this.config.customTransactionSchema;
+    }
+    set customTransactionSchema(schema) {
+        this._triggerConfigChange('customTransactionSchema', schema);
+        this.config.customTransactionSchema = schema;
+    }
+    _triggerConfigChange(config, newValue) {
+        this.emit(Web3ConfigEvent.CONFIG_CHANGE, {
+            name: config,
+            oldValue: this.config[config],
+            newValue,
+        });
+    }
+}
+exports.Web3Config = Web3Config;
+//# sourceMappingURL=web3_config.js.map

package/lib/commonjs/web3_config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web3_config.js","sourceRoot":"","sources":["../../src/web3_config.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;EAeE;;;AAEF,2CAOoB;AACpB,6CAAoF;AACpF,2CAA8C;AAI9C,mEAA2D;AAwC3D,IAAY,eAEX;AAFD,WAAY,eAAe;IAC1B,kDAA+B,CAAA;AAChC,CAAC,EAFW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAE1B;AAED,MAAsB,UACrB,SAAQ,wCAAqF;IAmC7F,YAAmB,OAAoC;QACtD,KAAK,EAAE,CAAC;QAjCF,WAAM,GAAsB;YAClC,YAAY,EAAE,KAAK;YACnB,cAAc,EAAE,SAAS;YACzB,YAAY,EAAE,QAAQ;YACtB,uBAAuB,EAAE,EAAE;YAC3B,6BAA6B,EAAE,EAAE;YACjC,0BAA0B,EAAE,IAAI;YAChC,yBAAyB,EAAE,GAAG,GAAG,IAAI;YACrC,iCAAiC,EAAE,SAAS;YAC5C,sBAAsB,EAAE,GAAG,GAAG,IAAI;YAClC,sCAAsC,EAAE,SAAS;YACjD,kBAAkB,EAAE,EAAE;YACtB,4BAA4B,EAAE,GAAG;YACjC,qBAAqB,EAAE,MAAM;YAC7B,gBAAgB,EAAE,SAAS;YAC3B,YAAY,EAAE,SAAS;YACvB,eAAe,EAAE,QAAQ;YACzB,4CAA4C;YAC5C,aAAa,EAAE,SAAS;YACxB,sBAAsB,EAAE,KAAK;YAC7B,2BAA2B,EAAE,IAAA,kBAAK,EAAC,UAAU,CAAC;YAC9C,0BAA0B,EAAE;gBAC3B,uCAAuC,EAAE,KAAK;gBAC9C,uBAAuB,EAAE,KAAK;aAC9B;YACD,kBAAkB,EAAE,SAAS;YAC7B,qBAAqB,EAAE,SAAS;YAChC,uBAAuB,EAAE,SAAS;YAClC,mBAAmB,EAAE,kCAAqB;YAC1C,gBAAgB,EAAE,KAAK;SACvB,CAAC;QAID,IAAI,CAAC,SAAS,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC;IAC/B,CAAC;IAEM,SAAS,CAAC,OAAmC;QACnD,kCAAkC;QAClC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAgC,CAAC;QACjE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACvB,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;YAE7C,IACC,CAAC,IAAA,sBAAS,EAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACxB,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ;gBAChC,GAAG,KAAK,8BAA8B,EACrC;gBACD,oCAAoC;gBACpC,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aAC1D;SACD;QACD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;OASG;IACH,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAW,YAAY,CAAC,GAAG;QAC1B,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,GAAG,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,IAAW,qBAAqB;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAW,qBAAqB,CAAC,GAAG;QACnC,IAAI,CAAC,oBAAoB,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,qBAAqB,GAAG,GAAG,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACH,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;IACnC,CAAC;IACD;;OAEG;IACH,IAAW,cAAc,CAAC,GAAG;QAC5B,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,GAAG,CAAC;IAClC,CAAC;IAED;;;;;;;;OAQG;IACH,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IACjC,CAAC;IAED;;;;;;;;;OASG;IACH,IAAW,YAAY,CAAC,GAAG;QAC1B,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,GAAG,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,IAAW,sBAAsB;QAChC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,IAAW,sBAAsB,CAAC,GAAG;QACpC,IAAI,CAAC,oBAAoB,CAAC,wBAAwB,EAAE,GAAG,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,sBAAsB,GAAG,GAAG,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,IAAW,uBAAuB,CAAC,GAAG;QACrC,IAAI,CAAC,oBAAoB,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,CAAC,uBAAuB,GAAG,GAAG,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,IAAW,6BAA6B;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,IAAW,6BAA6B,CAAC,GAAG;QAC3C,IAAI,CAAC,oBAAoB,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,6BAA6B,GAAG,GAAG,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,IAAW,0BAA0B;QACpC,OAAO,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,IAAW,0BAA0B,CAAC,GAAG;QACxC,IAAI,CAAC,oBAAoB,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,CAAC,0BAA0B,GAAG,GAAG,CAAC;QAE7C,IAAI,CAAC,iCAAiC,GAAG,GAAG,CAAC;QAC7C,IAAI,CAAC,sCAAsC,GAAG,GAAG,CAAC;IACnD,CAAC;IACD;;;OAGG;IACH,IAAW,yBAAyB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,IAAW,yBAAyB,CAAC,GAAG;QACvC,IAAI,CAAC,oBAAoB,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QAE5D,IAAI,CAAC,MAAM,CAAC,yBAAyB,GAAG,GAAG,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,IAAW,iCAAiC;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,iCAAiC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,IAAW,iCAAiC,CAAC,GAAG;QAC/C,IAAI,CAAC,oBAAoB,CAAC,mCAAmC,EAAE,GAAG,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,CAAC,iCAAiC,GAAG,GAAG,CAAC;IACrD,CAAC;IAED,IAAW,sCAAsC;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,sCAAsC,CAAC;IAC3D,CAAC;IAED,IAAW,sCAAsC,CAAC,GAAG;QACpD,IAAI,CAAC,oBAAoB,CAAC,wCAAwC,EAAE,GAAG,CAAC,CAAC;QACzE,IAAI,CAAC,MAAM,CAAC,sCAAsC,GAAG,GAAG,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,IAAW,kBAAkB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,IAAW,kBAAkB,CAAC,GAAG;QAChC,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;QAErD,IAAI,CAAC,MAAM,CAAC,kBAAkB,GAAG,GAAG,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,IAAW,0BAA0B;QACpC,OAAO,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,IAAW,0BAA0B,CAAC,GAAG;QACxC,IAAI,CAAC,oBAAoB,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC;QAE7D,IAAI,CAAC,MAAM,CAAC,0BAA0B,GAAG,GAAG,CAAC;IAC9C,CAAC;IAED,IAAW,4BAA4B;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,4BAA4B,CAAC;IACjD,CAAC;IAED,IAAW,4BAA4B,CAAC,GAAG;QAC1C,IAAI,CAAC,oBAAoB,CAAC,8BAA8B,EAAE,GAAG,CAAC,CAAC;QAC/D,IAAI,CAAC,8BAA8B,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,4BAA4B,GAAG,GAAG,CAAC;IAChD,CAAC;IAED,IAAW,mBAAmB;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC;IACxC,CAAC;IACD,IAAW,mBAAmB,CAAC,GAAG;QACjC,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;QAEtD,IAAI,CAAC,MAAM,CAAC,mBAAmB,GAAG,GAAG,CAAC;IACvC,CAAC;IAED,IAAW,gBAAgB;QAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACrC,CAAC;IAED,IAAW,gBAAgB,CAAC,GAAG;QAC9B,IAAI,CAAC,oBAAoB,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;QAEnD,IAAI,CAAC,MAAM,CAAC,gBAAgB,GAAG,GAAG,CAAC;IACpC,CAAC;IAED,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IACjC,CAAC;IAED,IAAW,YAAY,CAAC,GAAG;QAC1B,IACC,CAAC,IAAA,sBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;YACrC,CAAC,IAAA,sBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC;YAC/C,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS;YAE3C,MAAM,IAAI,sCAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QAEnE,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;QAE/C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,GAAG,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAW,eAAe;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAW,eAAe,CAAC,GAAG;QAC7B,IACC,CAAC,IAAA,sBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;YACrC,CAAC,IAAA,sBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC;YAC9C,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ;YAE1C,MAAM,IAAI,yCAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAChF,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;QAElD,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,GAAG,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAW,aAAa;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,IAAW,aAAa,CAAC,GAAuB;QAC/C,iFAAiF;QACjF,IACC,CAAC,IAAA,sBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YACvC,CAAC,IAAA,sBAAS,EAAC,GAAG,CAAC;YACf,CAAC,IAAA,sBAAS,EAAC,GAAG,CAAC,QAAQ,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,eAAe,KAAK,GAAG,CAAC,QAAQ;YAE5C,MAAM,IAAI,yCAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClF,IACC,CAAC,IAAA,sBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YACpC,CAAC,IAAA,sBAAS,EAAC,GAAG,CAAC;YACf,CAAC,IAAA,sBAAS,EAAC,GAAG,CAAC,SAAS,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,GAAG,CAAC,SAAS;YAE1C,MAAM,IAAI,sCAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,CAAC,oBAAoB,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;QAEhD,IAAI,CAAC,MAAM,CAAC,aAAa,GAAG,GAAG,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,IAAW,gBAAgB;QAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACrC,CAAC;IACD,IAAW,gBAAgB,CAAC,GAAG;QAC9B,IAAI,CAAC,oBAAoB,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,CAAC,gBAAgB,GAAG,GAAG,CAAC;IACpC,CAAC;IACD,IAAW,sBAAsB;QAChC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAC3C,CAAC;IAED,IAAW,sBAAsB,CAAC,GAAG;QACpC,IAAI,CAAC,oBAAoB,CAAC,wBAAwB,EAAE,GAAG,CAAC,CAAC;QAEzD,IAAI,CAAC,MAAM,CAAC,sBAAsB,GAAG,GAAG,CAAC;IAC1C,CAAC;IAED,IAAW,2BAA2B;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC;IAChD,CAAC;IAED,IAAW,2BAA2B,CAAC,GAAG;QACzC,IAAI,CAAC,oBAAoB,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,CAAC,2BAA2B,GAAG,GAAG,CAAC;IAC/C,CAAC;IAED,IAAW,kBAAkB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;IACvC,CAAC;IAED,IAAW,kBAAkB,CAAC,GAAG;QAChC,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,kBAAkB,GAAG,GAAG,CAAC;IACtC,CAAC;IAED,IAAW,qBAAqB;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAC1C,CAAC;IAED,IAAW,qBAAqB,CAAC,GAAG;QACnC,IAAI,CAAC,oBAAoB,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,qBAAqB,GAAG,GAAG,CAAC;IACzC,CAAC;IAED,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAC5C,CAAC;IAED,IAAW,uBAAuB,CAAC,MAA2C;QAC7E,IAAI,CAAC,oBAAoB,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,CAAC,uBAAuB,GAAG,MAAM,CAAC;IAC9C,CAAC;IAEO,oBAAoB,CAC3B,MAAS,EACT,QAA8B;QAE9B,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE;YACxC,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YAC7B,QAAQ;SAC0B,CAAC,CAAC;IACtC,CAAC;CACD;AAleD,gCAkeC"}

package/lib/commonjs/web3_context.d.ts

@@ -0,0 +1,212 @@
+import { EthExecutionAPI, HexString, Numbers, SupportedProviders, Transaction, Web3AccountProvider, Web3APISpec, Web3BaseProvider, Web3BaseWallet, Web3BaseWalletAccount } from 'web3-types';
+import { BaseTransaction } from 'web3-eth-accounts';
+import { ExtensionObject, RequestManagerMiddleware } from './types.js';
+import { Web3BatchRequest } from './web3_batch_request.js';
+import { Web3Config, Web3ConfigOptions } from './web3_config.js';
+import { Web3RequestManager } from './web3_request_manager.js';
+import { Web3SubscriptionConstructor } from './web3_subscriptions.js';
+import { Web3SubscriptionManager } from './web3_subscription_manager.js';
+export declare type Web3ContextObject<API extends Web3APISpec = unknown, RegisteredSubs extends {
+    [key: string]: Web3SubscriptionConstructor<API>;
+} = any> = {
+    config: Web3ConfigOptions;
+    provider?: SupportedProviders<API> | string;
+    requestManager: Web3RequestManager<API>;
+    subscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs> | undefined;
+    registeredSubscriptions?: RegisteredSubs;
+    providers: typeof Web3RequestManager.providers;
+    accountProvider?: Web3AccountProvider<Web3BaseWalletAccount>;
+    wallet?: Web3BaseWallet<Web3BaseWalletAccount>;
+};
+export declare type Web3ContextInitOptions<API extends Web3APISpec = unknown, RegisteredSubs extends {
+    [key: string]: Web3SubscriptionConstructor<API>;
+} = any> = {
+    config?: Partial<Web3ConfigOptions>;
+    provider?: SupportedProviders<API> | string;
+    requestManager?: Web3RequestManager<API>;
+    subscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs> | undefined;
+    registeredSubscriptions?: RegisteredSubs;
+    accountProvider?: Web3AccountProvider<Web3BaseWalletAccount>;
+    wallet?: Web3BaseWallet<Web3BaseWalletAccount>;
+    requestManagerMiddleware?: RequestManagerMiddleware<API>;
+};
+export declare type Web3ContextConstructor<T extends Web3Context, T2 extends unknown[]> = new (...args: [...extras: T2, context: Web3ContextObject]) => T;
+export declare type Web3ContextFactory<T extends Web3Context, T2 extends unknown[]> = Web3ContextConstructor<T, T2> & {
+    fromContextObject(this: Web3ContextConstructor<T, T2>, contextObject: Web3ContextObject): T;
+};
+export declare class Web3Context<API extends Web3APISpec = unknown, RegisteredSubs extends {
+    [key: string]: Web3SubscriptionConstructor<API>;
+} = any> extends Web3Config {
+    static readonly providers: {
+        HttpProvider: import("web3-types").Web3BaseProviderConstructor;
+        WebsocketProvider: import("web3-types").Web3BaseProviderConstructor;
+    };
+    static givenProvider?: SupportedProviders<never>;
+    readonly providers: {
+        HttpProvider: import("web3-types").Web3BaseProviderConstructor;
+        WebsocketProvider: import("web3-types").Web3BaseProviderConstructor;
+    };
+    protected _requestManager: Web3RequestManager<API>;
+    protected _subscriptionManager: Web3SubscriptionManager<API, RegisteredSubs>;
+    protected _accountProvider?: Web3AccountProvider<Web3BaseWalletAccount>;
+    protected _wallet?: Web3BaseWallet<Web3BaseWalletAccount>;
+    constructor(providerOrContext?: string | SupportedProviders<API> | Web3ContextInitOptions<API, RegisteredSubs>);
+    get requestManager(): Web3RequestManager<API>;
+    /**
+     * Will return the current subscriptionManager ({@link Web3SubscriptionManager})
+     */
+    get subscriptionManager(): Web3SubscriptionManager<API, RegisteredSubs>;
+    get wallet(): Web3BaseWallet<Web3BaseWalletAccount> | undefined;
+    get accountProvider(): Web3AccountProvider<Web3BaseWalletAccount> | undefined;
+    static fromContextObject<T extends Web3Context, T3 extends unknown[]>(this: Web3ContextConstructor<T, T3>, ...args: [Web3ContextObject, ...T3]): T;
+    getContextObject(): Web3ContextObject<API, RegisteredSubs>;
+    /**
+     * Use to create new object of any type extended by `Web3Context`
+     * and link it to current context. This can be used to initiate a global context object
+     * and then use it to create new objects of any type extended by `Web3Context`.
+     */
+    use<T extends Web3Context, T2 extends unknown[]>(ContextRef: Web3ContextConstructor<T, T2>, ...args: [...T2]): T;
+    /**
+     * Link current context to another context.
+     */
+    link<T extends Web3Context>(parentContext: T): void;
+    registerPlugin(plugin: Web3PluginBase): void;
+    /**
+     * Will return the current provider.
+     *
+     * @returns Returns the current provider
+     * @example
+     * ```ts
+     * const web3 = new Web3Context("http://localhost:8545");
+     * console.log(web3.provider);
+     * > HttpProvider {
+     * 	clientUrl: 'http://localhost:8545',
+     * 	httpProviderOptions: undefined
+     *  }
+     * ```
+     */
+    get provider(): Web3BaseProvider<API> | undefined;
+    /**
+     * Will set the current provider.
+     *
+     * @param provider - The provider to set
+     *
+     * Accepted providers are of type {@link SupportedProviders}
+     * @example
+     * ```ts
+     *  const web3Context = new web3ContextContext("http://localhost:8545");
+     * web3Context.provider = "ws://localhost:8545";
+     * console.log(web3Context.provider);
+     * > WebSocketProvider {
+     * _eventEmitter: EventEmitter {
+     * _events: [Object: null prototype] {},
+     * _eventsCount: 0,
+     * ...
+     * }
+     * ```
+     */
+    set provider(provider: SupportedProviders<API> | string | undefined);
+    /**
+     * Will return the current provider. (The same as `provider`)
+     *
+     * @returns Returns the current provider
+     * @example
+     * ```ts
+     * const web3Context = new Web3Context("http://localhost:8545");
+     * console.log(web3Context.provider);
+     * > HttpProvider {
+     * 	clientUrl: 'http://localhost:8545',
+     * 	httpProviderOptions: undefined
+     *  }
+     * ```
+     */
+    get currentProvider(): Web3BaseProvider<API> | undefined;
+    /**
+     * Will set the current provider. (The same as `provider`)
+     *
+     * @param provider - {@link SupportedProviders} The provider to set
+     *
+     * @example
+     * ```ts
+     *  const web3Context = new Web3Context("http://localhost:8545");
+     * web3Context.currentProvider = "ws://localhost:8545";
+     * console.log(web3Context.provider);
+     * > WebSocketProvider {
+     * _eventEmitter: EventEmitter {
+     * _events: [Object: null prototype] {},
+     * _eventsCount: 0,
+     * ...
+     * }
+     * ```
+     */
+    set currentProvider(provider: SupportedProviders<API> | string | undefined);
+    /**
+     * Will return the givenProvider if available.
+     *
+     * When using web3.js in an Ethereum compatible browser, it will set with the current native provider by that browser. Will return the given provider by the (browser) environment, otherwise `undefined`.
+     */
+    get givenProvider(): SupportedProviders<never> | undefined;
+    /**
+     * Will set the provider.
+     *
+     * @param provider - {@link SupportedProviders} The provider to set
+     * @returns Returns true if the provider was set
+     */
+    setProvider(provider?: SupportedProviders<API> | string): boolean;
+    setRequestManagerMiddleware(requestManagerMiddleware: RequestManagerMiddleware<API>): void;
+    /**
+     * Will return the {@link Web3BatchRequest} constructor.
+     */
+    get BatchRequest(): new () => Web3BatchRequest;
+    /**
+     * This method allows extending the web3 modules.
+     * Note: This method is only for backward compatibility, and It is recommended to use Web3 v4 Plugin feature for extending web3.js functionality if you are developing something new.
+     */
+    extend(extendObj: ExtensionObject): this;
+}
+/**
+ * Extend this class when creating a plugin that either doesn't require {@link EthExecutionAPI},
+ * or interacts with a RPC node that doesn't fully implement {@link EthExecutionAPI}.
+ *
+ * To add type support for RPC methods to the {@link Web3RequestManager},
+ * define a {@link Web3APISpec} and pass it as a generic to Web3PluginBase like so:
+ *
+ * @example
+ * ```ts
+ * type CustomRpcApi = {
+ *	custom_rpc_method: () => string;
+ *	custom_rpc_method_with_parameters: (parameter1: string, parameter2: number) => string;
+ * };
+ *
+ * class CustomPlugin extends Web3PluginBase<CustomRpcApi> {...}
+ * ```
+ */
+export declare abstract class Web3PluginBase<API extends Web3APISpec = Web3APISpec> extends Web3Context<API> {
+    abstract pluginNamespace: string;
+    protected registerNewTransactionType<NewTxTypeClass extends typeof BaseTransaction<unknown>>(type: Numbers, txClass: NewTxTypeClass): void;
+}
+/**
+ * Extend this class when creating a plugin that makes use of {@link EthExecutionAPI},
+ * or depends on other Web3 packages (such as `web3-eth-contract`) that depend on {@link EthExecutionAPI}.
+ *
+ * To add type support for RPC methods to the {@link Web3RequestManager} (in addition to {@link EthExecutionAPI}),
+ * define a {@link Web3APISpec} and pass it as a generic to Web3PluginBase like so:
+ *
+ * @example
+ * ```ts
+ * type CustomRpcApi = {
+ *	custom_rpc_method: () => string;
+ *	custom_rpc_method_with_parameters: (parameter1: string, parameter2: number) => string;
+ * };
+ *
+ * class CustomPlugin extends Web3PluginBase<CustomRpcApi> {...}
+ * ```
+ */
+export declare abstract class Web3EthPluginBase<API extends Web3APISpec = unknown> extends Web3PluginBase<API & EthExecutionAPI> {
+}
+export declare type TransactionBuilder<API extends Web3APISpec = unknown> = <ReturnType = Transaction>(options: {
+    transaction: Transaction;
+    web3Context: Web3Context<API>;
+    privateKey?: HexString | Uint8Array;
+    fillGasPrice?: boolean;
+}) => Promise<ReturnType>;