fix web3config setconfig (web3#6555)

Alex · dkurukula · commit 5417f71b8771 · 2023-11-08T00:53:28.000-05:00
* add web3config

* fix config to emit properly

* fix lint

* fix testcases and change emit for contracts

* fix lint

* remove unneccesary code

* update tests

* remove test

* update changelog and format

* update changelog

* fix contracts creation in web3 package

* fix linter

* format

* format

* add validation

* add test and address feedback

* update changelog

* update tests

* update

* fix tests

* update test

* update time

* add promises to fix parallel tests

* revert
diff --git a/packages/web3-core/CHANGELOG.md b/packages/web3-core/CHANGELOG.md
@@ -193,8 +193,12 @@ Documentation:
 
 ## [4.3.1]
 
+### Fixed
+
+-   Fix `Web3Config` to properly update within other web3 packages when `setConfig` is used  (#6555)
+
 ### Added
 
 -   Added `isMetaMaskProvider` function to check if provider is metamask (#6534)
 
-## [Unreleased]
+## [Unreleased]
diff --git a/packages/web3-core/src/web3_config.ts b/packages/web3-core/src/web3_config.ts
@@ -97,12 +97,15 @@ export abstract class Web3Config
 
 	public constructor(options?: Partial<Web3ConfigOptions>) {
 		super();
-
 		this.setConfig(options ?? {});
 	}
 
 	public setConfig(options: Partial<Web3ConfigOptions>) {
 		// TODO: Improve and add key check
+		const keys = Object.keys(options) as (keyof Web3ConfigOptions)[];
+		for (const key of keys) {
+			this._triggerConfigChange(key, options[key])
+		}
 		Object.assign(this.config, options);
 	}
 
diff --git a/packages/web3-core/src/web3_context.ts b/packages/web3-core/src/web3_context.ts
@@ -108,7 +108,7 @@ export class Web3Context<
 			| Web3ContextInitOptions<API, RegisteredSubs>,
 	) {
 		super();
-
+		
 		// If "providerOrContext" is provided as "string" or an objects matching "SupportedProviders" interface
 		if (
 			isNullish(providerOrContext) ||
diff --git a/packages/web3-eth-contract/src/contract.ts b/packages/web3-eth-contract/src/contract.ts
@@ -241,7 +241,6 @@ export class Contract<Abi extends ContractAbi>
 	 * RPC provider when using contract methods.
 	 * Default is `input`
 	 */
-	private readonly _dataInputFill?: 'data' | 'input' | 'both';
 
 	private context?: Web3Context;
 	/**
@@ -369,17 +368,11 @@ export class Contract<Abi extends ContractAbi>
 			: isDataFormat(optionsOrContextOrReturnFormat)
 			? optionsOrContextOrReturnFormat
 			: returnFormat ?? DEFAULT_RETURN_FORMAT;
-
 		const address =
 			typeof addressOrOptionsOrContext === 'string' ? addressOrOptionsOrContext : undefined;
-
-		if (this.config.contractDataInputFill === 'both') {
-			this._dataInputFill = this.config.contractDataInputFill;
-		} else {
-			this._dataInputFill =
+			this.config.contractDataInputFill =
 				(options as ContractInitOptions)?.dataInputFill ??
 				this.config.contractDataInputFill;
-		}
 		this._parseAndSetJsonInterface(jsonInterface, returnDataFormat);
 
 		if (!isNullish(address)) {
@@ -409,6 +402,13 @@ export class Contract<Abi extends ContractAbi>
 			set: (value: ContractAbi) => this._parseAndSetJsonInterface(value, returnDataFormat),
 			get: () => this._jsonInterface,
 		});
+
+		if (contractContext instanceof Web3Context) {
+			contractContext.on(Web3ConfigEvent.CONFIG_CHANGE, event => {
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+				this.setConfig({ [event.name]: event.newValue });
+			});
+		}
 	}
 
 	/**
@@ -501,7 +501,7 @@ export class Contract<Abi extends ContractAbi>
 					data: this.options.data,
 					provider: this.currentProvider,
 					syncWithContext: this.syncWithContext,
-					dataInputFill: this._dataInputFill,
+					dataInputFill: this.config.contractDataInputFill,
 				},
 				this.getContextObject(),
 			);
@@ -516,7 +516,7 @@ export class Contract<Abi extends ContractAbi>
 					data: this.options.data,
 					provider: this.currentProvider,
 					syncWithContext: this.syncWithContext,
-					dataInputFill: this._dataInputFill,
+					dataInputFill: this.config.contractDataInputFill,
 				},
 				this.getContextObject(),
 			);
@@ -1014,7 +1014,7 @@ export class Contract<Abi extends ContractAbi>
 			params,
 			options: {
 				...options,
-				dataInputFill: this._dataInputFill,
+				dataInputFill: this.config.contractDataInputFill,
 			},
 			contractOptions: {
 				...this.options,
@@ -1088,7 +1088,7 @@ export class Contract<Abi extends ContractAbi>
 			checkRevertBeforeSending: false,
 			contractAbi: this._jsonInterface,
 		});
-
+		
 		// eslint-disable-next-line no-void
 		void transactionToSend.on('error', (error: unknown) => {
 			if (error instanceof ContractExecutionError) {
diff --git a/packages/web3-eth-contract/src/utils.ts b/packages/web3-eth-contract/src/utils.ts
@@ -25,10 +25,9 @@ import {
 	Address,
 	NonPayableCallOptions,
 	PayableCallOptions,
-	ContractInitOptions,
 	ContractOptions,
 } from 'web3-types';
-import { isNullish, mergeDeep } from 'web3-utils';
+import { isNullish, mergeDeep, isContractInitOptions } from 'web3-utils';
 import { encodeMethodABI } from './encoding.js';
 import { Web3ContractContext } from './types.js';
 
@@ -165,24 +164,11 @@ export const getEstimateGasParams = ({
 	return txParams as TransactionWithSenderAPI;
 };
 
-export const isContractInitOptions = (options: unknown): options is ContractInitOptions =>
-	typeof options === 'object' &&
-	!isNullish(options) &&
-	[
-		'input',
-		'data',
-		'from',
-		'gas',
-		'gasPrice',
-		'gasLimit',
-		'address',
-		'jsonInterface',
-		'syncWithContext',
-		'dataInputFill',
-	].some(key => key in options);
+export { isContractInitOptions } from 'web3-utils';
 
 export const isWeb3ContractContext = (options: unknown): options is Web3ContractContext =>
-	typeof options === 'object' && !isNullish(options) && !isContractInitOptions(options);
+	typeof options === 'object' && !isNullish(options) && 
+	Object.keys(options).length !== 0 && !isContractInitOptions(options);
 
 export const getCreateAccessListParams = ({
 	abi,
diff --git a/packages/web3-eth/src/rpc_method_wrappers.ts b/packages/web3-eth/src/rpc_method_wrappers.ts
@@ -507,7 +507,7 @@ export function sendTransaction<
 						},
 						ETH_DATA_FORMAT,
 					);
-
+					
 					try {
 						transactionFormatted = await sendTxHelper.populateGasPrice({
 							transaction,
diff --git a/packages/web3-eth/src/utils/prepare_transaction_for_signing.ts b/packages/web3-eth/src/utils/prepare_transaction_for_signing.ts
@@ -141,7 +141,7 @@ export const prepareTransactionForSigning = async (
 	validateTransactionForSigning(
 		formattedTransaction as unknown as FormatType<Transaction, typeof ETH_DATA_FORMAT>,
 	);
-
+	
 	return TransactionFactory.fromTxData(
 		getEthereumjsTxDataFromTransaction(formattedTransaction),
 		getEthereumjsTransactionOptions(formattedTransaction, web3Context),
diff --git a/packages/web3-eth/src/web3_eth.ts b/packages/web3-eth/src/web3_eth.ts
@@ -95,7 +95,7 @@ export class Web3Eth extends Web3Context<Web3EthExecutionAPI, RegisteredSubscrip
 		super({
 			...(providerOrContext as Web3ContextInitOptions),
 			registeredSubscriptions,
-		});
+		});		
 	}
 
 	/**
diff --git a/packages/web3-utils/CHANGELOG.md b/packages/web3-utils/CHANGELOG.md
@@ -169,4 +169,8 @@ Documentation:
 -   Fix issue with default config with babel (and React): "TypeError: Cannot convert a BigInt value to a number #6187" (#6506)
 -   Fixed bug in chunks processing logic (#6496)
 
-## [Unreleased]
+## [Unreleased]
+
+### Added
+
+-   Add `isContractInitOptions` method (#6455)
diff --git a/packages/web3-utils/src/validation.ts b/packages/web3-utils/src/validation.ts
@@ -30,7 +30,7 @@ import {
 	isTopicInBloom as isTopicInBloomValidator,
 	isUserEthereumAddressInBloom as isUserEthereumAddressInBloomValidator,
 } from 'web3-validator';
-import { BlockNumberOrTag, BlockTags } from 'web3-types';
+import { BlockNumberOrTag, BlockTags, ContractInitOptions } from 'web3-types';
 
 /**
  * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
@@ -169,4 +169,22 @@ export const compareBlockNumbers = (blockA: BlockNumberOrTag, blockB: BlockNumbe
 	return 1;
 };
 
+
+export const isContractInitOptions = (options: unknown): options is ContractInitOptions =>
+	typeof options === 'object' &&
+	!isNullishValidator(options) &&
+	Object.keys(options).length !== 0 &&
+	[
+		'input',
+		'data',
+		'from',
+		'gas',
+		'gasPrice',
+		'gasLimit',
+		'address',
+		'jsonInterface',
+		'syncWithContext',
+		'dataInputFill',
+	].some(key => key in options);
+
 export const isNullish = isNullishValidator;
diff --git a/packages/web3-utils/test/fixtures/validation.ts b/packages/web3-utils/test/fixtures/validation.ts
@@ -15,7 +15,7 @@ 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 { Numbers } from 'web3-types';
+import { Numbers, ContractInitOptions } from 'web3-types';
 import { InvalidBlockError } from 'web3-errors';
 
 export const compareBlockNumbersValidData: [[Numbers, Numbers], number][] = [
@@ -77,3 +77,18 @@ export const isBloomValidData: [any, true][] = [
 		true,
 	],
 ];
+
+export const isContractInitValidData: ContractInitOptions[] = [
+	{dataInputFill: "data"},
+	{syncWithContext: true},
+	{gas: "100000",
+	syncWithContext: true,
+	dataInputFill: "data",
+	},
+];
+
+export const isContractInitInvalidData: unknown[] = [
+	"",
+	12,
+	{}
+];
diff --git a/packages/web3-utils/test/unit/validation.test.ts b/packages/web3-utils/test/unit/validation.test.ts
@@ -18,10 +18,12 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 /* eslint-disable jest/no-conditional-expect */
 
 import { InvalidBlockError } from 'web3-errors';
-import { compareBlockNumbers } from '../../src/validation';
+import { compareBlockNumbers, isContractInitOptions } from '../../src/validation';
 import {
 	compareBlockNumbersInvalidData,
 	compareBlockNumbersValidData,
+	isContractInitValidData,
+	isContractInitInvalidData
 } from '../fixtures/validation';
 
 describe('validation', () => {
@@ -37,4 +39,20 @@ describe('validation', () => {
 			},
 		);
 	});
+	describe('isContractInit', () => {
+		describe('should return true', () => { 
+			it.each([...isContractInitValidData])(
+				'%s', (input) => {
+					expect(isContractInitOptions(input)).toBe(true);
+				}
+			)
+		});
+		describe('should return false', () => { 
+			it.each([...isContractInitInvalidData])(
+				'%s', (input) => {
+					expect(isContractInitOptions(input)).toBe(false);
+				}
+			)
+		});
+	});
 });
diff --git a/packages/web3/src/web3.ts b/packages/web3/src/web3.ts
diff --git a/packages/web3/test/integration/web3.config.test.ts b/packages/web3/test/integration/web3.config.test.ts
diff --git a/packages/web3/test/unit/web3.config.test.ts b/packages/web3/test/unit/web3.config.test.ts

Original file line number	Diff line number	Diff line change
`@@ -97,12 +97,15 @@ export abstract class Web3Config`
`97`	`97`
`98`	`98`	`public constructor(options?: Partial<Web3ConfigOptions>) {`
`99`	`99`	`super();`
`100`		`-`
`101`	`100`	`this.setConfig(options ?? {});`
`102`	`101`	`}`
`103`	`102`
`104`	`103`	`public setConfig(options: Partial<Web3ConfigOptions>) {`
`105`	`104`	`// TODO: Improve and add key check`
	`105`	`+ const keys = Object.keys(options) as (keyof Web3ConfigOptions)[];`
	`106`	`+ for (const key of keys) {`
	`107`	`+ this._triggerConfigChange(key, options[key])`
	`108`	`+ }`
`106`	`109`	`Object.assign(this.config, options);`
`107`	`110`	`}`
`108`	`111`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ export class Web3Eth extends Web3Context<Web3EthExecutionAPI, RegisteredSubscrip`
`95`	`95`	`super({`
`96`	`96`	`...(providerOrContext as Web3ContextInitOptions),`
`97`	`97`	`registeredSubscriptions,`
`98`		`- });`
	`98`	`+ });`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`/**`