feat: add custom transaction schema to formatTransaction

CHANGELOG.md

@@ -2702,3 +2702,24 @@ If there are any bugs, improvements, optimizations or any new feature proposal f
 -   The callback function provided to the static `Web3.onNewProviderDiscovered` function expects a parameter of type `EIP6963ProvidersMapUpdateEvent` as opposed to `EIP6963AnnounceProviderEvent`. (#7242)
 
 ## [Unreleased]
+
+### Added
+
+#### web3-core
+
+-   Adds a new property (`customTransactionSchema`) to `Web3ConfigOptions`
+-   Adds a new property (`config`) to `Web3RequestManager`
+
+#### web3-eth
+
+-   Adds the same `{transactionSchema?: ValidationSchemaInput}` that exists in `formatTransaction` to `validateTransactionForSigning`
+
+### Changed
+
+#### web3-eth
+
+-   Forwards the new `web3Context.config.customTransactionSchema` to `formatTransaction`
+
+#### web3-eth-personal
+
+-   Forwards the new `web3Context.config.customTransactionSchema` to `formatTransaction`

docs/docs/guides/web3_config/index.md

@@ -28,6 +28,7 @@ There is list of configuration params that can be set for modifying behavior of
 - [defaultCommon](/guides/web3_config/#defaultcommon)  
 - [defaultTransactionType](/guides/web3_config/#defaulttransactiontype)
 - [defaultMaxPriorityFeePerGas](/guides/web3_config/#defaultmaxpriorityfeepergas)
+- [customTransactionSchema](/guides/web3_config/#customTransactionSchema)
 - [defaultReturnFormat](/guides/web3_config/#defaultreturnformat)  
 
 ## Global level Config
@@ -411,6 +412,9 @@ The `defaultMaxPriorityFeePerGas` option is used to set the [`defaultMaxPriority
 
 The default value of `defaultMaxPriorityFeePerGas` is 2500000000 (2.5gwei) in hexstring format.
 
+### [customTransactionSchema](/api/web3-core/class/Web3Config#customTransactionSchema)
+The `customTransactionSchema` option is used to allow [`formatTransaction`](/api/web3-eth/function/formatTransaction) to accept a custom schema to validate transactions. A use-case could be: your chain has an extra field in its transactions and you want to write a plugin that makes sending these transactions easier.
+
 ### [defaultReturnFormat](/api/web3-core/class/Web3Config#defaultReturnFormat)
 The `defaultReturnFormat` option allows users to specify the format in which certain types of data should be returned by default. It is a configuration parameter that can be set at the global level and affects how data is returned across the entire library.
 ```ts

packages/web3-core/CHANGELOG.md

@@ -234,3 +234,8 @@ Documentation:
 -   `setConfig()` fix for `setMaxListenerWarningThreshold` fix (#5079)
 
 ## [Unreleased]
+
+### Added
+
+-   Adds a new property (`customTransactionSchema`) to `Web3ConfigOptions`
+-   Adds a new property (`config`) to `Web3RequestManager`

packages/web3-core/src/web3_batch_request.ts

@@ -18,6 +18,7 @@ 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;

packages/web3-core/src/web3_config.ts

@@ -25,6 +25,7 @@ import {
 } from 'web3-types';
 import { ConfigHardforkMismatchError, ConfigChainMismatchError } from 'web3-errors';
 import { isNullish, toHex } from 'web3-utils';
+import { ValidationSchemaInput } from 'web3-validator';
 import { TransactionTypeParser } from './types.js';
 // eslint-disable-next-line import/no-cycle
 import { TransactionBuilder } from './web3_context.js';
@@ -59,6 +60,7 @@ export interface Web3ConfigOptions {
 	};
 	transactionBuilder?: TransactionBuilder;
 	transactionTypeParser?: TransactionTypeParser;
+	customTransactionSchema?: ValidationSchemaInput;
 	defaultReturnFormat: DataFormat;
 }
 
@@ -101,6 +103,7 @@ export abstract class Web3Config
 		},
 		transactionBuilder: undefined,
 		transactionTypeParser: undefined,
+		customTransactionSchema: undefined,
 		defaultReturnFormat: DEFAULT_RETURN_FORMAT,
 	};
 
@@ -520,6 +523,15 @@ export abstract class Web3Config
 		this.config.transactionTypeParser = val;
 	}
 
+	public get customTransactionSchema(): ValidationSchemaInput | undefined {
+		return this.config.customTransactionSchema;
+	}
+
+	public set customTransactionSchema(schema: ValidationSchemaInput | undefined) {
+		this._triggerConfigChange('customTransactionSchema', schema);
+		this.config.customTransactionSchema = schema;
+	}
+
 	private _triggerConfigChange<K extends keyof Web3ConfigOptions>(
 		config: K,
 		newValue: Web3ConfigOptions[K],

packages/web3-core/src/web3_context.ts

@@ -36,6 +36,7 @@ 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';
@@ -148,6 +149,7 @@ export class Web3Context<
 				provider,
 				config?.enableExperimentalFeatures?.useSubscriptionWhenCheckingBlockTimeout,
 				requestManagerMiddleware,
+				config,
 			);
 
 		if (subscriptionManager) {
@@ -224,6 +226,8 @@ export class Web3Context<
 		this.on(Web3ConfigEvent.CONFIG_CHANGE, event => {
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 			newContextChild.setConfig({ [event.name]: event.newValue });
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+			this._requestManager.setConfig({ [event.name]: event.newValue });
 		});
 
 		// @ts-expect-error No index signature with a parameter of type 'string' was found on type 'Web3Context<API, RegisteredSubs>'
@@ -247,6 +251,8 @@ export class Web3Context<
 		parentContext.on(Web3ConfigEvent.CONFIG_CHANGE, event => {
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 			this.setConfig({ [event.name]: event.newValue });
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+			this._requestManager.setConfig({ [event.name]: event.newValue });
 		});
 	}
 

packages/web3-core/src/web3_request_manager.ts

@@ -53,6 +53,7 @@ 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',
@@ -74,15 +75,19 @@ 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);
 		}
@@ -148,6 +153,10 @@ export class Web3RequestManager<
 		return true;
 	}
 
+	public setConfig(options: Partial<Web3ConfigOptions>) {
+		Object.assign(this.config, options);
+	}
+
 	public setMiddleware(requestManagerMiddleware: RequestManagerMiddleware<API>) {
 		this.middleware = requestManagerMiddleware;
 	}

packages/web3-core/src/web3_subscription_manager.ts

@@ -29,6 +29,7 @@ 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';

packages/web3-core/src/web3_subscriptions.ts

@@ -34,6 +34,7 @@ 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 = {

packages/web3-core/test/unit/__snapshots__/web3_context.test.ts.snap

@@ -6,6 +6,7 @@ exports[`Web3Context getContextObject should return correct context object 1`] =
   "config": {
     "blockHeaderTimeout": 10,
     "contractDataInputFill": "data",
+    "customTransactionSchema": undefined,
     "defaultAccount": undefined,
     "defaultBlock": "latest",
     "defaultChain": "mainnet",
@@ -73,6 +74,7 @@ exports[`Web3Context getContextObject should return correct context object 1`] =
       "clientUrl": "http://test/abc",
       "httpProviderOptions": undefined,
     },
+    "config": {},
     "useRpcCallSpecification": undefined,
   },
   "subscriptionManager": Web3SubscriptionManager {
@@ -108,6 +110,7 @@ exports[`Web3Context getContextObject should return correct context object 1`] =
         "clientUrl": "http://test/abc",
         "httpProviderOptions": undefined,
       },
+      "config": {},
       "useRpcCallSpecification": undefined,
     },
     "tolerateUnlinkedSubscription": false,

packages/web3-core/test/unit/web3_config.test.ts

@@ -49,6 +49,7 @@ const defaultConfig = {
 	defaultReturnFormat: DEFAULT_RETURN_FORMAT,
 	transactionBuilder: undefined,
 	transactionTypeParser: undefined,
+	customTransactionSchema: undefined,
 };
 const setValue = {
 	string: 'newValue',

packages/web3-core/test/unit/web3_context.test.ts

@@ -124,6 +124,9 @@ describe('Web3Context', () => {
 			expect(newContext.requestManager).toBeInstanceOf(Web3RequestManager);
 			expect(newContext.config.defaultHardfork).toEqual(config.defaultHardfork);
 			expect(newContext.config.defaultNetworkId).toEqual(config.defaultNetworkId);
+			expect(newContext.requestManager.config.defaultHardfork).toEqual(
+				config.defaultHardfork,
+			);
 		});
 
 		describe('accountsProvider', () => {

packages/web3-eth-personal/CHANGELOG.md

@@ -148,3 +148,7 @@ Documentation:
 -   Dependencies updated
 
 ## [Unreleased]
+
+### Changed
+
+-   Forwards the new `web3Context.config.customTransactionSchema` to `formatTransaction`

packages/web3-eth-personal/src/rpc_method_wrappers.ts

@@ -73,7 +73,9 @@ export const sendTransaction = async (
 	tx: Transaction,
 	passphrase: string,
 ) => {
-	const formattedTx = formatTransaction(tx, ETH_DATA_FORMAT);
+	const formattedTx = formatTransaction(tx, ETH_DATA_FORMAT, {
+		transactionSchema: requestManager.config.customTransactionSchema,
+	});
 
 	return personalRpcMethods.sendTransaction(requestManager, formattedTx, passphrase);
 };
@@ -83,7 +85,9 @@ export const signTransaction = async (
 	tx: Transaction,
 	passphrase: string,
 ) => {
-	const formattedTx = formatTransaction(tx, ETH_DATA_FORMAT);
+	const formattedTx = formatTransaction(tx, ETH_DATA_FORMAT, {
+		transactionSchema: requestManager.config.customTransactionSchema,
+	});
 
 	return personalRpcMethods.signTransaction(requestManager, formattedTx, passphrase);
 };

packages/web3-eth-personal/test/unit/eth_personal.test.ts

@@ -185,7 +185,11 @@ describe('Personal', () => {
 			await personal.sendTransaction(tx, 'password');
 
 			expect(eth.formatTransaction).toHaveBeenCalledTimes(1);
-			expect(eth.formatTransaction).toHaveBeenCalledWith(tx, ETH_DATA_FORMAT);
+			expect(eth.formatTransaction).toHaveBeenCalledWith(
+				tx,
+				ETH_DATA_FORMAT,
+				expect.anything(),
+			);
 		});
 	});
 
@@ -215,7 +219,11 @@ describe('Personal', () => {
 			await personal.signTransaction(tx, 'password');
 
 			expect(eth.formatTransaction).toHaveBeenCalledTimes(1);
-			expect(eth.formatTransaction).toHaveBeenCalledWith(tx, ETH_DATA_FORMAT);
+			expect(eth.formatTransaction).toHaveBeenCalledWith(
+				tx,
+				ETH_DATA_FORMAT,
+				expect.anything(),
+			);
 		});
 	});
 

packages/web3-eth/CHANGELOG.md

@@ -270,3 +270,11 @@ Documentation:
 -   Change method `getTransactionReceipt` to not be casted as `TransactionReceipt` to give proper return type (#7159)
 
 ## [Unreleased]
+
+### Changed
+
+-   Forwards the new `web3Context.config.customTransactionSchema` to `formatTransaction`
+
+### Added
+
+-   Adds the same `{transactionSchema?: ValidationSchemaInput}` that exists in `formatTransaction` to `validateTransactionForSigning`

packages/web3-eth/src/rpc_method_wrappers.ts

@@ -429,6 +429,7 @@ export async function getTransaction<ReturnFormat extends DataFormat>(
 	return isNullish(response)
 		? response
 		: formatTransaction(response, returnFormat, {
+				transactionSchema: web3Context.config.customTransactionSchema,
 				fillInputAndData: true,
 		  });
 }
@@ -448,6 +449,7 @@ export async function getPendingTransactions<ReturnFormat extends DataFormat>(
 			transaction as unknown as Transaction,
 			returnFormat ?? web3Context.defaultReturnFormat,
 			{
+				transactionSchema: web3Context.config.customTransactionSchema,
 				fillInputAndData: true,
 			},
 		),
@@ -488,6 +490,7 @@ export async function getTransactionFromBlock<ReturnFormat extends DataFormat>(
 	return isNullish(response)
 		? response
 		: formatTransaction(response, returnFormat ?? web3Context.defaultReturnFormat, {
+				transactionSchema: web3Context.config.customTransactionSchema,
 				fillInputAndData: true,
 		  });
 }
@@ -606,6 +609,9 @@ export function sendTransaction<
 							to: getTransactionFromOrToAttr('to', web3Context, transaction),
 						},
 						ETH_DATA_FORMAT,
+						{
+							transactionSchema: web3Context.config.customTransactionSchema,
+						},
 					);
 
 					try {
@@ -847,7 +853,9 @@ export async function signTransaction<ReturnFormat extends DataFormat>(
 ) {
 	const response = await ethRpcMethods.signTransaction(
 		web3Context.requestManager,
-		formatTransaction(transaction, ETH_DATA_FORMAT),
+		formatTransaction(transaction, ETH_DATA_FORMAT, {
+			transactionSchema: web3Context.config.customTransactionSchema,
+		}),
 	);
 	// Some clients only return the encoded signed transaction (e.g. Ganache)
 	// while clients such as Geth return the desired SignedTransactionInfoAPI object
@@ -862,6 +870,7 @@ export async function signTransaction<ReturnFormat extends DataFormat>(
 					returnFormat,
 				),
 				tx: formatTransaction((response as SignedTransactionInfoAPI).tx, returnFormat, {
+					transactionSchema: web3Context.config.customTransactionSchema,
 					fillInputAndData: true,
 				}),
 		  };
@@ -885,7 +894,9 @@ export async function call<ReturnFormat extends DataFormat>(
 
 	const response = await ethRpcMethods.call(
 		web3Context.requestManager,
-		formatTransaction(transaction, ETH_DATA_FORMAT),
+		formatTransaction(transaction, ETH_DATA_FORMAT, {
+			transactionSchema: web3Context.config.customTransactionSchema,
+		}),
 		blockNumberFormatted,
 	);
 
@@ -903,7 +914,9 @@ export async function estimateGas<ReturnFormat extends DataFormat>(
 	blockNumber: BlockNumberOrTag = web3Context.defaultBlock,
 	returnFormat: ReturnFormat,
 ) {
-	const transactionFormatted = formatTransaction(transaction, ETH_DATA_FORMAT);
+	const transactionFormatted = formatTransaction(transaction, ETH_DATA_FORMAT, {
+		transactionSchema: web3Context.config.customTransactionSchema,
+	});
 	const blockNumberFormatted = isBlockTag(blockNumber as string)
 		? (blockNumber as BlockTag)
 		: format({ format: 'uint' }, blockNumber as Numbers, ETH_DATA_FORMAT);
@@ -1074,7 +1087,9 @@ export async function createAccessList<ReturnFormat extends DataFormat>(
 
 	const response = (await ethRpcMethods.createAccessList(
 		web3Context.requestManager,
-		formatTransaction(transaction, ETH_DATA_FORMAT),
+		formatTransaction(transaction, ETH_DATA_FORMAT, {
+			transactionSchema: web3Context.config.customTransactionSchema,
+		}),
 		blockNumberFormatted,
 	)) as unknown as AccessListResult;