defaultTransactionBuilder (chainId and networkId) - #4800 (#4842)

* Move Web3Net to web3_net.ts

* Refactor index.ts exports

* Add web3-net dependency to web3-eth

* Add chainId and networkId to defaultTransactionBuilder

* yarn format

* Add rpcMethods export to web3-net

* Add tests for populating chainId and networkId

* Update prepareTransactionForSigning tests to account for added networkId population

Author: spacesailor24

packages/web3-eth/package.json

@@ -46,6 +46,7 @@
 		"web3-core": "4.0.0-alpha.0",
 		"web3-eth-accounts": "4.0.0-alpha.0",
 		"web3-utils": "4.0.0-alpha.1",
-		"web3-validator": "^0.1.0-alpha.0"
+		"web3-validator": "^0.1.0-alpha.0",
+		"web3-net": "4.0.0-alpha.0"
 	}
 }

packages/web3-eth/src/utils/transaction_builder.ts

@@ -2,9 +2,11 @@ import { EthExecutionAPI } from 'web3-common';
 import { Web3Context } from 'web3-core';
 import { privateKeyToAddress } from 'web3-eth-accounts';
 import { Address, convertToValidType, HexString, ValidTypes } from 'web3-utils';
+import { getId, Web3NetAPI } from 'web3-net';
+
 import { TransactionDataAndInputError, UnableToPopulateNonceError } from '../errors';
 // eslint-disable-next-line import/no-cycle
-import { getTransactionCount } from '../rpc_method_wrappers';
+import { getChainId, getTransactionCount } from '../rpc_method_wrappers';
 import { chain, hardfork, Transaction } from '../types';
 import { detectTransactionType } from './detect_transaction_type';
 // eslint-disable-next-line import/no-cycle
@@ -55,7 +57,7 @@ export const getTransactionType = (
 // as some of the properties are dependent on others
 export async function defaultTransactionBuilder<ReturnType = Record<string, unknown>>(options: {
 	transaction: Record<string, unknown>;
-	web3Context: Web3Context<EthExecutionAPI>;
+	web3Context: Web3Context<EthExecutionAPI & Web3NetAPI>;
 	privateKey?: HexString | Buffer;
 }): Promise<ReturnType> {
 	let populatedTransaction = { ...options.transaction } as unknown as Transaction;
@@ -97,15 +99,19 @@ export async function defaultTransactionBuilder<ReturnType = Record<string, unkn
 			populatedTransaction.hardfork = options.web3Context.defaultHardfork as hardfork;
 	}
 
-	// if (populatedTransaction.chainId === undefined && populatedTransaction.common?.customChain.chainId === undefined)
-	// TODO - web3Eth.getChainId not implemented
-	// populatedTransaction.chainId = await web3Eth.getChainId();
+	if (
+		populatedTransaction.chainId === undefined &&
+		populatedTransaction.common?.customChain.chainId === undefined
+	)
+		populatedTransaction.chainId = await getChainId(
+			options.web3Context,
+			options.web3Context.defaultReturnType,
+		);
 
-	// if (populatedTransaction.networkId === undefined) {
-	// 	populatedTransaction.networkId = web3Context.defaultNetworkId ?? undefined;
-	//  TODO - getNetworkId (net_version) not implemented
-	// 	populatedTransaction.networkId = await getNetworkId();
-	// }
+	if (populatedTransaction.networkId === undefined)
+		populatedTransaction.networkId =
+			options.web3Context.defaultNetworkId ??
+			(await getId(options.web3Context, options.web3Context.defaultReturnType));
 
 	if (populatedTransaction.gasLimit === undefined && populatedTransaction.gas !== undefined)
 		populatedTransaction.gasLimit = populatedTransaction.gas;

packages/web3-eth/test/unit/default_transaction_builder.test.ts

@@ -16,6 +16,11 @@ import {
 
 jest.mock('../../src/rpc_methods');
 
+const expectedNetworkId = '0x4';
+jest.mock('web3-net', () => ({
+	getId: jest.fn().mockImplementation(() => expectedNetworkId),
+}));
+
 describe('defaultTransactionBuilder', () => {
 	const expectedFrom = '0xb8CE9ab6943e0eCED004cDe8e3bBed6568B2Fa01';
 	const expectedNonce = '0x42';
@@ -25,6 +30,7 @@ describe('defaultTransactionBuilder', () => {
 	const expectedBaseFeePerGas = '0x13afe8b904';
 	const expectedMaxPriorityFeePerGas = '0x9502f900';
 	const expectedMaxFeePerGas = '0x27f4d46b08';
+	const expectedChainId = '0x1';
 	const defaultTransactionType = '0x0';
 	const transaction: Transaction = {
 		from: expectedFrom,
@@ -40,12 +46,13 @@ describe('defaultTransactionBuilder', () => {
 		nonce: expectedNonce,
 		chain: 'mainnet',
 		hardfork: 'berlin',
-		chainId: '0x1',
+		chainId: expectedChainId,
+		networkId: expectedNetworkId,
 		common: {
 			customChain: {
 				name: 'foo',
-				networkId: '0x4',
-				chainId: '0x42',
+				networkId: expectedNetworkId,
+				chainId: expectedChainId,
 			},
 			baseChain: 'mainnet',
 			hardfork: 'berlin',
@@ -98,6 +105,9 @@ describe('defaultTransactionBuilder', () => {
 		// @ts-expect-error - Mocked implementation doesn't have correct method signature
 		// (i.e. requestManager, blockNumber, hydrated params), but that doesn't matter for the test
 		jest.spyOn(rpcMethods, 'getGasPrice').mockImplementation(() => expectedGasPrice);
+		// @ts-expect-error - Mocked implementation doesn't have correct method signature
+		// (i.e. requestManager, blockNumber, hydrated params), but that doesn't matter for the test
+		jest.spyOn(rpcMethods, 'getChainId').mockImplementation(() => expectedChainId);
 
 		web3Context = new Web3Context<EthExecutionAPI>(new HttpProvider('http://127.0.0.1'));
 	});
@@ -258,16 +268,29 @@ describe('defaultTransactionBuilder', () => {
 	});
 
 	describe('should populate chainId', () => {
-		// TODO - web3Eth.getChainId not implemented
-		it.skip('should populate with web3Eth.getChainId', async () => {
+		it('should populate with web3Eth.getChainId', async () => {
 			const input = { ...transaction };
 			delete input.chainId;
+			delete input.common;
+
+			const result = await defaultTransactionBuilder({
+				transaction: input,
+				web3Context,
+			});
+			expect(result.chainId).toBe(expectedChainId);
+		});
+	});
+
+	describe('should populate networkId', () => {
+		it('should populate with web3Net.getId', async () => {
+			const input = { ...transaction };
+			delete input.networkId;
 
 			const result = await defaultTransactionBuilder({
 				transaction: input,
 				web3Context,
 			});
-			expect(result.chainId).toBe('0x1');
+			expect(result.networkId).toBe(expectedNetworkId);
 		});
 	});
 

packages/web3-eth/test/unit/prepare_transaction_for_signing.test.ts

@@ -12,7 +12,10 @@ import { prepareTransactionForSigning } from '../../src/utils/prepare_transactio
 import { validTransactions } from '../fixtures/prepare_transaction_for_signing';
 
 describe('prepareTransactionForSigning', () => {
-	const web3Context = new Web3Context<EthExecutionAPI>(new HttpProvider('http://127.0.0.1'));
+	const web3Context = new Web3Context<EthExecutionAPI>({
+		provider: new HttpProvider('http://127.0.0.1'),
+		config: { defaultNetworkId: '0x1' },
+	});
 
 	describe('should return an @ethereumjs/tx instance with expected properties', () => {
 		it.each(validTransactions)(

packages/web3-net/src/index.ts

@@ -1,24 +1,8 @@
-import { Web3Context } from 'web3-core';
-import { ValidTypes } from 'web3-utils';
-import * as rpcMethodsWrappers from './rpc_method_wrappers';
-import { Web3NetAPI } from './web3_net_api';
+import { Web3Net } from './web3_net';
 
-export class Web3Net extends Web3Context<Web3NetAPI> {
-	public async getId<ReturnType extends ValidTypes = ValidTypes.HexString>(
-		returnType?: ReturnType,
-	) {
-		return rpcMethodsWrappers.getId(this, returnType);
-	}
-
-	public async getPeerCount<ReturnType extends ValidTypes = ValidTypes.HexString>(
-		returnType?: ReturnType,
-	) {
-		return rpcMethodsWrappers.getPeerCount(this, returnType);
-	}
-
-	public async isListening() {
-		return rpcMethodsWrappers.isListening(this);
-	}
-}
-export { Web3NetAPI };
+export * from './web3_net';
+export * as rpcMethods from './rpc_methods';
 export * from './rpc_method_wrappers';
+export * from './web3_net_api';
+
+export default Web3Net;

packages/web3-net/src/web3_net.ts

@@ -0,0 +1,23 @@
+import { Web3Context } from 'web3-core';
+
+import { ValidTypes } from 'web3-utils';
+import * as rpcMethodsWrappers from './rpc_method_wrappers';
+import { Web3NetAPI } from './web3_net_api';
+
+export class Web3Net extends Web3Context<Web3NetAPI> {
+	public async getId<ReturnType extends ValidTypes = ValidTypes.HexString>(
+		returnType?: ReturnType,
+	) {
+		return rpcMethodsWrappers.getId(this, returnType);
+	}
+
+	public async getPeerCount<ReturnType extends ValidTypes = ValidTypes.HexString>(
+		returnType?: ReturnType,
+	) {
+		return rpcMethodsWrappers.getPeerCount(this, returnType);
+	}
+
+	public async isListening() {
+		return rpcMethodsWrappers.isListening(this);
+	}
+}

packages/web3-utils/src/types.ts

@@ -125,4 +125,3 @@ export interface Filter {
 	readonly address?: Address | Address[];
 	readonly topics?: (Topic | Topic[] | null)[];
 }
-