Specify SignTransaction's argument types

docs/docs/guides/web3_plugin_guide/plugin_authors.md

@@ -156,8 +156,8 @@ A workaround for this issue is available, below is an example of it:
 import { Web3Context, Web3PluginBase } from 'web3-core';
 import { ContractAbi } from 'web3-eth-abi';
 import Contract from 'web3-eth-contract';
-import { Address } from 'web3-types';
-import { DataFormat, DEFAULT_RETURN_FORMAT, format } from 'web3-utils';
+import { Address, DataFormat, DEFAULT_RETURN_FORMAT } from 'web3-types';
+import { format } from 'web3-utils';
 
 import { ERC20TokenAbi } from './ERC20Token';
 

packages/web3-core/CHANGELOG.md

@@ -93,6 +93,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 -   If a transaction object with a `data` property is passed to `txInputOptionsFormatter`, it will now be replaced with `input` (#5915)
+-   The types `TransactionTypeParser` and `TransactionBuilder` are now utilizing the type `Transaction` for the transaction object. (#5993)
 
 ### Removed
 

packages/web3-core/src/types.ts

@@ -15,7 +15,6 @@ 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 { HexString } from 'web3-types';
+import { HexString, Transaction } from 'web3-types';
 
-// TODO: When we have `web3-types` package we can share TransactionType
-export type TransactionTypeParser = (transaction: Record<string, unknown>) => HexString | undefined;
+export type TransactionTypeParser = (transaction: Transaction) => HexString | undefined;

packages/web3-core/src/web3_context.ts

@@ -24,6 +24,7 @@ import {
 	HexString,
 	EthExecutionAPI,
 	Web3BaseProvider,
+	Transaction,
 } from 'web3-types';
 import { isNullish } from 'web3-utils';
 import { ExistingPluginNamespaceError } from 'web3-errors';
@@ -368,11 +369,10 @@ export class Web3Context<
 }
 
 // To avoid cycle dependency declare this type in this file
-// TODO: When we have `web3-types` package we can share TransactionType
 export type TransactionBuilder<API extends Web3APISpec = unknown> = <
-	ReturnType = Record<string, unknown>,
+	ReturnType = Transaction,
 >(options: {
-	transaction: Record<string, unknown>;
+	transaction: Transaction;
 	web3Context: Web3Context<API>;
 	privateKey?: HexString | Buffer;
 }) => Promise<ReturnType>;

packages/web3-core/src/web3_subscription_manager.ts

@@ -15,9 +15,9 @@ 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 { Web3APISpec } from 'web3-types';
+import { DataFormat, DEFAULT_RETURN_FORMAT, Web3APISpec } from 'web3-types';
 import { ProviderError, SubscriptionError } from 'web3-errors';
-import { isNullish, DataFormat, DEFAULT_RETURN_FORMAT } from 'web3-utils';
+import { isNullish } from 'web3-utils';
 import { isSupportSubscriptions } from './utils';
 import { Web3RequestManager, Web3RequestManagerEvent } from './web3_request_manager';
 import { Web3SubscriptionConstructor } from './web3_subscriptions';

packages/web3-core/src/web3_subscriptions.ts

@@ -16,7 +16,6 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 // eslint-disable-next-line max-classes-per-file
-import { DataFormat, DEFAULT_RETURN_FORMAT } from 'web3-utils';
 import {
 	HexString,
 	BlockOutput,
@@ -27,6 +26,8 @@ import {
 	Log,
 	JsonRpcNotification,
 	JsonRpcSubscriptionResult,
+	DataFormat,
+	DEFAULT_RETURN_FORMAT,
 } from 'web3-types';
 import { jsonRpc } from 'web3-utils';
 import { Web3EventEmitter, Web3EventMap } from './web3_event_emitter';

packages/web3-core/test/unit/web3_subscription_manager.test.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 { DEFAULT_RETURN_FORMAT } from 'web3-utils';
+import { DEFAULT_RETURN_FORMAT } from 'web3-types';
 import { Web3RequestManagerEvent } from '../../src/web3_request_manager';
 import { Web3SubscriptionManager } from '../../src/web3_subscription_manager';
 import { ExampleSubscription } from './fixtures/example_subscription';

packages/web3-eth-accounts/CHANGELOG.md

@@ -81,3 +81,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 -   Moved @ethereumjs/tx, @ethereumjs/common code to our source code (#5963)
+-   The method `signTransaction` returned by `privateKeyToAccount` is now accepting the type `Transaction` for its argument. (#5993)

packages/web3-eth-accounts/src/account.ts

@@ -40,6 +40,7 @@ import {
 	PBKDF2SHA256Params,
 	ScryptParams,
 	KeyStore,
+	Transaction,
 } from 'web3-types';
 import {
 	bytesToBuffer,
@@ -594,7 +595,7 @@ export const privateKeyToAccount = (privateKey: Bytes, ignoreLength?: boolean):
 		address: privateKeyToAddress(privateKeyBuffer),
 		privateKey: bytesToHex(privateKeyBuffer),
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		signTransaction: (_tx: Record<string, unknown>) => {
+		signTransaction: (_tx: Transaction) => {
 			throw new TransactionSigningError('Do not have network access to sign the transaction');
 		},
 		sign: (data: Record<string, unknown> | string) =>

packages/web3-eth-contract/CHANGELOG.md

@@ -247,6 +247,7 @@ const transactionHash = receipt.transactionHash;
 
 -   `getSendTxParams` will now return `input` instead of `data` in returned transaction parameters object (#5915)
 -   `Contract` constructor will now thrown new `ContractTransactionDataAndInputError` if both `data` and `input` are passed in `ContractInitOptions` for `Contract` constructor (#5915)
+-   The types `ContractAbiWithSignature`, `EventLog`, `ContractEventOptions`, `ContractOptions`, `ContractInitOptions` and `PayableCallOptions` moved to `web3-types`. (#5993)
 
 ### Removed
 

packages/web3-eth-contract/src/contract.ts

@@ -63,14 +63,17 @@ import {
 	HexString,
 	LogsInput,
 	Mutable,
-} from 'web3-types';
-import {
+	ContractAbiWithSignature,
+	ContractEventOptions,
+	ContractInitOptions,
+	ContractOptions,
+	EventLog,
+	NonPayableCallOptions,
+	PayableCallOptions,
 	DataFormat,
 	DEFAULT_RETURN_FORMAT,
-	format,
-	isDataFormat,
-	toChecksumAddress,
-} from 'web3-utils';
+} from 'web3-types';
+import { format, isDataFormat, toChecksumAddress } from 'web3-utils';
 import {
 	isNullish,
 	validator,
@@ -83,15 +86,8 @@ import { ALL_EVENTS_ABI } from './constants';
 import { decodeEventABI, decodeMethodReturn, encodeEventABI, encodeMethodABI } from './encoding';
 import { LogsSubscription } from './log_subscription';
 import {
-	ContractAbiWithSignature,
-	ContractEventOptions,
-	ContractInitOptions,
-	ContractOptions,
-	EventLog,
-	NonPayableCallOptions,
 	NonPayableMethodObject,
 	NonPayableTxOptions,
-	PayableCallOptions,
 	PayableMethodObject,
 	PayableTxOptions,
 	Web3ContractContext,

packages/web3-eth-contract/src/encoding.ts

@@ -15,25 +15,25 @@ 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 {
-	DataFormat,
-	DEFAULT_RETURN_FORMAT,
-	FMT_BYTES,
-	FMT_NUMBER,
-	format,
-	isNullish,
-} from 'web3-utils';
+import { format, isNullish } from 'web3-utils';
 
 import {
 	AbiConstructorFragment,
 	AbiEventFragment,
 	AbiFunctionFragment,
+	ContractAbiWithSignature,
+	ContractOptions,
+	EventLog,
 	LogsInput,
 	BlockNumberOrTag,
 	Filter,
 	HexString,
 	Topic,
 	Numbers,
+	FMT_NUMBER,
+	FMT_BYTES,
+	DataFormat,
+	DEFAULT_RETURN_FORMAT,
 } from 'web3-types';
 
 import {
@@ -50,8 +50,6 @@ import {
 import { blockSchema, logSchema } from 'web3-eth';
 
 import { Web3ContractError } from 'web3-errors';
-// eslint-disable-next-line import/no-cycle
-import { ContractAbiWithSignature, ContractOptions, EventLog } from './types';
 
 export const encodeEventABI = (
 	{ address }: ContractOptions,

packages/web3-eth-contract/src/log_subscription.ts

@@ -15,14 +15,12 @@ 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 { AbiEventFragment, LogsInput, HexString, Topic } from 'web3-types';
+import { AbiEventFragment, LogsInput, HexString, Topic, DataFormat } from 'web3-types';
 import { Web3RequestManager, Web3Subscription } from 'web3-core';
 // eslint-disable-next-line import/no-cycle
-import { DataFormat } from 'web3-utils';
-// eslint-disable-next-line import/no-cycle
+import { ContractAbiWithSignature, EventLog } from 'web3-types';
 import { decodeEventABI } from './encoding';
 // eslint-disable-next-line import/no-cycle
-import { ContractAbiWithSignature, EventLog } from './types';
 
 /**
  * LogSubscription to be used to subscribe to events logs.