refactor: remove config from manager

nicolasbrugneaux · nicolasbrugneaux · commit 3ce8752924f3 · 2024-09-16T16:49:25.000+02:00
diff --git a/packages/web3-core/src/web3_batch_request.ts b/packages/web3-core/src/web3_batch_request.ts
@@ -18,7 +18,6 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 import { JsonRpcBatchResponse, JsonRpcOptionalRequest, JsonRpcRequest } from 'web3-types';
 import { jsonRpc, Web3DeferredPromise } from 'web3-utils';
 import { OperationAbortError, OperationTimeoutError, ResponseError } from 'web3-errors';
-// eslint-disable-next-line import/no-cycle
 import { Web3RequestManager } from './web3_request_manager.js';
 
 export const DEFAULT_BATCH_REQUEST_TIMEOUT = 1000;
diff --git a/packages/web3-core/src/web3_config.ts b/packages/web3-core/src/web3_config.ts
@@ -25,7 +25,7 @@ import {
 } from 'web3-types';
 import { ConfigHardforkMismatchError, ConfigChainMismatchError } from 'web3-errors';
 import { isNullish, toHex } from 'web3-utils';
-import { ValidationSchemaInput } from 'web3-validator';
+import { Schema } from 'web3-validator';
 import { TransactionTypeParser } from './types.js';
 // eslint-disable-next-line import/no-cycle
 import { TransactionBuilder } from './web3_context.js';
@@ -60,7 +60,7 @@ export interface Web3ConfigOptions {
 	};
 	transactionBuilder?: TransactionBuilder;
 	transactionTypeParser?: TransactionTypeParser;
-	customTransactionSchema?: ValidationSchemaInput;
+	customTransactionSchema?: Record<string, Schema>;
 	defaultReturnFormat: DataFormat;
 }
 
@@ -523,11 +523,11 @@ export abstract class Web3Config
 		this.config.transactionTypeParser = val;
 	}
 
-	public get customTransactionSchema(): ValidationSchemaInput | undefined {
+	public get customTransactionSchema(): Record<string, Schema> | undefined {
 		return this.config.customTransactionSchema;
 	}
 
-	public set customTransactionSchema(schema: ValidationSchemaInput | undefined) {
+	public set customTransactionSchema(schema: Record<string, Schema> | undefined) {
 		this._triggerConfigChange('customTransactionSchema', schema);
 		this.config.customTransactionSchema = schema;
 	}
diff --git a/packages/web3-core/src/web3_context.ts b/packages/web3-core/src/web3_context.ts
@@ -36,7 +36,6 @@ import { ExtensionObject, RequestManagerMiddleware } from './types.js';
 import { Web3BatchRequest } from './web3_batch_request.js';
 // eslint-disable-next-line import/no-cycle
 import { Web3Config, Web3ConfigEvent, Web3ConfigOptions } from './web3_config.js';
-// eslint-disable-next-line import/no-cycle
 import { Web3RequestManager } from './web3_request_manager.js';
 import { Web3SubscriptionConstructor } from './web3_subscriptions.js';
 import { Web3SubscriptionManager } from './web3_subscription_manager.js';
diff --git a/packages/web3-core/src/web3_request_manager.ts b/packages/web3-core/src/web3_request_manager.ts
@@ -53,7 +53,6 @@ import {
 } from './utils.js';
 import { Web3EventEmitter } from './web3_event_emitter.js';
 import { RequestManagerMiddleware } from './types.js';
-import { type Web3ConfigOptions } from './web3_config.js';
 
 export enum Web3RequestManagerEvent {
 	PROVIDER_CHANGED = 'PROVIDER_CHANGED',
@@ -75,19 +74,15 @@ export class Web3RequestManager<
 }> {
 	private _provider?: SupportedProviders<API>;
 	private readonly useRpcCallSpecification?: boolean;
-	public config: Partial<Web3ConfigOptions>;
 	public middleware?: RequestManagerMiddleware<API>;
 
 	public constructor(
 		provider?: SupportedProviders<API> | string,
 		useRpcCallSpecification?: boolean,
 		requestManagerMiddleware?: RequestManagerMiddleware<API>,
-		config?: Partial<Web3ConfigOptions>,
 	) {
 		super();
 
-		this.config = config ?? {};
-
 		if (!isNullish(provider)) {
 			this.setProvider(provider);
 		}
@@ -153,10 +148,6 @@ export class Web3RequestManager<
 		return true;
 	}
 
-	public setConfig(options: Partial<Web3ConfigOptions>) {
-		Object.assign(this.config, options);
-	}
-
 	public setMiddleware(requestManagerMiddleware: RequestManagerMiddleware<API>) {
 		this.middleware = requestManagerMiddleware;
 	}
diff --git a/packages/web3-core/src/web3_subscription_manager.ts b/packages/web3-core/src/web3_subscription_manager.ts
@@ -29,7 +29,6 @@ import {
 import { ProviderError, SubscriptionError } from 'web3-errors';
 import { isNullish } from 'web3-utils';
 import { isSupportSubscriptions } from './utils.js';
-// eslint-disable-next-line import/no-cycle
 import { Web3RequestManager, Web3RequestManagerEvent } from './web3_request_manager.js';
 // eslint-disable-next-line import/no-cycle
 import { Web3SubscriptionConstructor } from './web3_subscriptions.js';
diff --git a/packages/web3-core/src/web3_subscriptions.ts b/packages/web3-core/src/web3_subscriptions.ts
@@ -34,7 +34,6 @@ import { jsonRpc } from 'web3-utils';
 // eslint-disable-next-line import/no-cycle
 import { Web3SubscriptionManager } from './web3_subscription_manager.js';
 import { Web3EventEmitter, Web3EventMap } from './web3_event_emitter.js';
-// eslint-disable-next-line import/no-cycle
 import { Web3RequestManager } from './web3_request_manager.js';
 
 type CommonSubscriptionEvents = {
diff --git a/packages/web3-eth-personal/src/personal.ts b/packages/web3-eth-personal/src/personal.ts
@@ -159,7 +159,7 @@ export class Personal extends Web3Context<EthPersonalAPI> {
 	 * ```
 	 */
 	public async sendTransaction(tx: Transaction, passphrase: string) {
-		return rpcWrappers.sendTransaction(this.requestManager, tx, passphrase);
+		return rpcWrappers.sendTransaction(this.requestManager, tx, passphrase, this.config);
 	}
 	/**
 	 * Signs a transaction. This account needs to be unlocked.
@@ -204,7 +204,7 @@ export class Personal extends Web3Context<EthPersonalAPI> {
 	 * ```
 	 */
 	public async signTransaction(tx: Transaction, passphrase: string) {
-		return rpcWrappers.signTransaction(this.requestManager, tx, passphrase);
+		return rpcWrappers.signTransaction(this.requestManager, tx, passphrase, this.config);
 	}
 	/**
 	 * Calculates an Ethereum specific signature with:
diff --git a/packages/web3-eth-personal/src/rpc_method_wrappers.ts b/packages/web3-eth-personal/src/rpc_method_wrappers.ts
@@ -14,9 +14,9 @@ GNU Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser General Public License
 along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
-import { Web3RequestManager } from 'web3-core';
+import { Web3RequestManager, Web3ConfigOptions } from 'web3-core';
 import { toChecksumAddress, utf8ToHex } from 'web3-utils';
-import { formatTransaction } from 'web3-eth';
+import { formatTransaction, type CustomTransactionSchema } from 'web3-eth';
 import { Address, EthPersonalAPI, ETH_DATA_FORMAT, HexString, Transaction } from 'web3-types';
 import { validator, isHexStrict } from 'web3-validator';
 import { personalRpcMethods } from 'web3-rpc-methods';
@@ -72,9 +72,10 @@ export const sendTransaction = async (
 	requestManager: Web3RequestManager<EthPersonalAPI>,
 	tx: Transaction,
 	passphrase: string,
+	config?: Web3ConfigOptions,
 ) => {
 	const formattedTx = formatTransaction(tx, ETH_DATA_FORMAT, {
-		transactionSchema: requestManager.config.customTransactionSchema,
+		transactionSchema: config?.customTransactionSchema as CustomTransactionSchema,
 	});
 
 	return personalRpcMethods.sendTransaction(requestManager, formattedTx, passphrase);
@@ -84,9 +85,10 @@ export const signTransaction = async (
 	requestManager: Web3RequestManager<EthPersonalAPI>,
 	tx: Transaction,
 	passphrase: string,
+	config?: Web3ConfigOptions,
 ) => {
 	const formattedTx = formatTransaction(tx, ETH_DATA_FORMAT, {
-		transactionSchema: requestManager.config.customTransactionSchema,
+		transactionSchema: config?.customTransactionSchema as CustomTransactionSchema,
 	});
 
 	return personalRpcMethods.signTransaction(requestManager, formattedTx, passphrase);
diff --git a/packages/web3-eth/src/rpc_method_wrappers.ts b/packages/web3-eth/src/rpc_method_wrappers.ts
@@ -66,6 +66,7 @@ import {
 	SignatureObjectSchema,
 } from './schemas.js';
 import {
+	type CustomTransactionSchema,
 	SendSignedTransactionEvents,
 	SendSignedTransactionOptions,
 	SendTransactionEvents,
@@ -429,7 +430,7 @@ export async function getTransaction<ReturnFormat extends DataFormat>(
 	return isNullish(response)
 		? response
 		: formatTransaction(response, returnFormat, {
-				transactionSchema: web3Context.config.customTransactionSchema,
+				transactionSchema: web3Context.config.customTransactionSchema as CustomTransactionSchema,
 				fillInputAndData: true,
 		  });
 }
@@ -449,7 +450,7 @@ export async function getPendingTransactions<ReturnFormat extends DataFormat>(
 			transaction as unknown as Transaction,
 			returnFormat ?? web3Context.defaultReturnFormat,
 			{
-				transactionSchema: web3Context.config.customTransactionSchema,
+				transactionSchema: web3Context.config.customTransactionSchema as CustomTransactionSchema,
 				fillInputAndData: true,
 			},
 		),
@@ -490,7 +491,7 @@ export async function getTransactionFromBlock<ReturnFormat extends DataFormat>(
 	return isNullish(response)
 		? response
 		: formatTransaction(response, returnFormat ?? web3Context.defaultReturnFormat, {
-				transactionSchema: web3Context.config.customTransactionSchema,
+				transactionSchema: web3Context.config.customTransactionSchema as CustomTransactionSchema,
 				fillInputAndData: true,
 		  });
 }
@@ -610,7 +611,7 @@ export function sendTransaction<
 						},
 						ETH_DATA_FORMAT,
 						{
-							transactionSchema: web3Context.config.customTransactionSchema,
+							transactionSchema: web3Context.config.customTransactionSchema as CustomTransactionSchema,
 						},
 					);
 
@@ -854,7 +855,7 @@ export async function signTransaction<ReturnFormat extends DataFormat>(
 	const response = await ethRpcMethods.signTransaction(
 		web3Context.requestManager,
 		formatTransaction(transaction, ETH_DATA_FORMAT, {
-			transactionSchema: web3Context.config.customTransactionSchema,
+			transactionSchema: web3Context.config.customTransactionSchema as CustomTransactionSchema,
 		}),
 	);
 	// Some clients only return the encoded signed transaction (e.g. Ganache)
@@ -870,7 +871,7 @@ export async function signTransaction<ReturnFormat extends DataFormat>(
 					returnFormat,
 				),
 				tx: formatTransaction((response as SignedTransactionInfoAPI).tx, returnFormat, {
-					transactionSchema: web3Context.config.customTransactionSchema,
+					transactionSchema: web3Context.config.customTransactionSchema as CustomTransactionSchema,
 					fillInputAndData: true,
 				}),
 		  };
diff --git a/packages/web3-eth/src/types.ts b/packages/web3-eth/src/types.ts
@@ -37,6 +37,8 @@ import {
 	TransactionWithFromLocalWalletIndex,
 	TransactionWithToLocalWalletIndex,
 } from 'web3-types';
+import { transactionSchema } from './schemas';
+import { Schema } from 'web3-validator';
 
 export type InternalTransaction = FormatType<Transaction, typeof ETH_DATA_FORMAT>;
 
@@ -105,3 +107,8 @@ export interface TransactionMiddleware {
 		options?: { [key: string]: unknown },
 	): Promise<TransactionMiddlewareData>;
 }
+
+export type CustomTransactionSchema = {
+	type: string;
+	properties: typeof transactionSchema['properties'] & Record<string, Schema>;
+};
diff --git a/packages/web3-eth/src/utils/decode_signed_transaction.ts b/packages/web3-eth/src/utils/decode_signed_transaction.ts
@@ -22,9 +22,9 @@ import {
 } from 'web3-types';
 import { bytesToHex, format, hexToBytes, keccak256 } from 'web3-utils';
 import { TransactionFactory } from 'web3-eth-accounts';
-import { ValidationSchemaInput } from 'web3-validator';
 import { detectRawTransactionType } from './detect_transaction_type.js';
 import { formatTransaction } from './format_transaction.js';
+import { type CustomTransactionSchema } from '../types.js';
 
 /**
  * Decodes an [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/#top) encoded transaction.
@@ -36,7 +36,7 @@ import { formatTransaction } from './format_transaction.js';
 export function decodeSignedTransaction<ReturnFormat extends DataFormat>(
 	encodedSignedTransaction: HexStringBytes,
 	returnFormat: ReturnFormat,
-	options: { fillInputAndData?: boolean; transactionSchema?: ValidationSchemaInput } = {
+	options: { fillInputAndData?: boolean; transactionSchema?: CustomTransactionSchema } = {
 		fillInputAndData: false,
 	},
 ): SignedTransactionInfoAPI {
diff --git a/packages/web3-eth/src/utils/format_transaction.ts b/packages/web3-eth/src/utils/format_transaction.ts
@@ -16,16 +16,12 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 import { Transaction, DataFormat, DEFAULT_RETURN_FORMAT, FormatType } from 'web3-types';
-import { isNullish, ValidationSchemaInput, Schema } from 'web3-validator';
+import { isNullish, ValidationSchemaInput } from 'web3-validator';
 import { mergeDeep, format, bytesToHex, toHex } from 'web3-utils';
 import { TransactionDataAndInputError } from 'web3-errors';
 
-import { transactionInfoSchema, transactionSchema } from '../schemas.js';
-
-type TransactionSchema = {
-	type: string;
-	properties: typeof transactionSchema['properties'] & Record<string, Schema>;
-};
+import { transactionInfoSchema } from '../schemas.js';
+import { type CustomTransactionSchema } from '../types.js';
 
 export function formatTransaction<
 	ReturnFormat extends DataFormat = typeof DEFAULT_RETURN_FORMAT,
@@ -34,7 +30,7 @@ export function formatTransaction<
 	transaction: TransactionType,
 	returnFormat: ReturnFormat = DEFAULT_RETURN_FORMAT as ReturnFormat,
 	options: {
-		transactionSchema?: ValidationSchemaInput | TransactionSchema | undefined;
+		transactionSchema?: ValidationSchemaInput | CustomTransactionSchema | undefined;
 		fillInputAndData?: boolean;
 	} = {
 		transactionSchema: transactionInfoSchema,
diff --git a/packages/web3-eth/src/utils/prepare_transaction_for_signing.ts b/packages/web3-eth/src/utils/prepare_transaction_for_signing.ts
@@ -33,6 +33,7 @@ import { isNullish } from 'web3-validator';
 import { validateTransactionForSigning } from '../validation.js';
 import { formatTransaction } from './format_transaction.js';
 import { transactionBuilder } from './transaction_builder.js';
+import { type CustomTransactionSchema } from '../types.js';
 
 const getEthereumjsTxDataFromTransaction = (
 	transaction: FormatType<PopulatedUnsignedTransaction, typeof ETH_DATA_FORMAT>,
@@ -135,14 +136,15 @@ export const prepareTransactionForSigning = async (
 		fillGasLimit,
 	})) as unknown as PopulatedUnsignedTransaction;
 	const formattedTransaction = formatTransaction(populatedTransaction, ETH_DATA_FORMAT, {
-		transactionSchema: web3Context.config.customTransactionSchema,
+		transactionSchema: web3Context.config.customTransactionSchema as CustomTransactionSchema,
 	}) as unknown as FormatType<PopulatedUnsignedTransaction, typeof ETH_DATA_FORMAT>;
 
 	validateTransactionForSigning(
 		formattedTransaction as unknown as FormatType<Transaction, typeof ETH_DATA_FORMAT>,
 		undefined,
 		{
-			transactionSchema: web3Context.config.customTransactionSchema,
+			transactionSchema: web3Context.config
+				.customTransactionSchema as CustomTransactionSchema,
 		},
 	);
 
diff --git a/packages/web3-eth/src/validation.ts b/packages/web3-eth/src/validation.ts
@@ -55,7 +55,7 @@ import {
 	UnsupportedFeeMarketError,
 } from 'web3-errors';
 import { formatTransaction } from './utils/format_transaction.js';
-import { InternalTransaction } from './types.js';
+import { CustomTransactionSchema, InternalTransaction } from './types.js';
 
 export function isBaseTransaction(value: BaseTransactionAPI): boolean {
 	if (!isNullish(value.to) && !isAddress(value.to)) return false;
@@ -290,7 +290,7 @@ export const validateTransactionForSigning = (
 	transaction: InternalTransaction,
 	overrideMethod?: (transaction: InternalTransaction) => void,
 	options: {
-		transactionSchema?: ValidationSchemaInput;
+		transactionSchema?: CustomTransactionSchema;
 	} = { transactionSchema: undefined },
 ) => {
 	if (!isNullish(overrideMethod)) {
diff --git a/packages/web3-eth/test/unit/rpc_method_wrappers/get_transaction.test.ts b/packages/web3-eth/test/unit/rpc_method_wrappers/get_transaction.test.ts
@@ -21,7 +21,11 @@ import { ethRpcMethods } from 'web3-rpc-methods';
 
 import { getTransaction } from '../../../src/rpc_method_wrappers';
 import { mockRpcResponse, testData } from './fixtures/get_transaction';
-import { formatTransaction, transactionInfoSchema } from '../../../src';
+import {
+	type CustomTransactionSchema,
+	formatTransaction,
+	transactionInfoSchema,
+} from '../../../src';
 
 jest.mock('web3-rpc-methods');
 
@@ -57,7 +61,7 @@ describe('getTransaction', () => {
 			const expectedFormattedResult = formatTransaction(
 				mockRpcResponse,
 				expectedReturnFormat,
-				{ transactionSchema: transactionInfoSchema },
+				{ transactionSchema: transactionInfoSchema as CustomTransactionSchema },
 			);
 			(ethRpcMethods.getTransactionByHash as jest.Mock).mockResolvedValueOnce(
 				mockRpcResponse,
