web3-eth sendTransaction and sendSignedTransaction PromiEvent…

… tests #4810 (#4875)

* WIP Web3Eth.sendTransaction tests

* Update use of ReceiptInfo and TransactionReceipt to ReceiptInfoFormatted

* Add optional data field to BaseTransaction

* Init sendTransaction test and fixture

* Remove old sendTransactionValidData

* Remove no longer needed imports

* Remove errornous sendTransaction test

* Init getGasPricing tests for sendTransaction

* Init wait_for_transaction_receipt.ts

* Init watch_transaction_for_confirmations.ts

* Import waitForTransactionReceipt and watchTransactionForConfirmations from utils/

* Init waitForTransactionReceipt and watchTransactionForConfirmations tests

* Fix promiEvent bug with sendSignedTransaction

* Use HexString for expectedTransactionHash instead of string

* Remove jest.useRealTimers

* Init sendSignedTransaction tests

* Update use of ReceiptInfo to ReceiptInfoFormatted for sendSignedTransaction

* Remove unused import ReceiptInfo

* Update SendSignedTransactionEvents to include only unique properties

* Add transactionHash to TransactionMissingReceiptOrBlockHashError

* Update packages/web3-eth/src/errors.ts

* Add effectiveGasPrice to sendSignedTransaction and sendTransaction fixtures

* Add expectedTransactionHash to watchTransactionForConfirmationsSpy tests

* Update names of files to match existing casings

* Merge with #4859

* Update import for ReceiptInfo

* Add effectiveGasPrice to transactionSchema

* Update SendTransactionEvents and SendSignedTransactionEvents types

* Add transaction receipt formatting

Co-authored-by: Alex <alex.luu@mail.utoronto.ca>

packages/web3-common/src/eth_execution_api.ts

@@ -43,8 +43,9 @@ export interface BaseTransaction {
  readonly nonce: Uint;
  readonly gas: Uint;
  readonly value: Uint;
- // TODO - Investigate if this should actually be data instead of input
+ // TODO - https://github.com/ethereum/execution-apis/pull/201
  readonly input: HexStringBytes;
+ readonly data?: HexStringBytes;
  readonly chainId?: Uint;
 }
 

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

@@ -396,7 +396,7 @@ export class Contract<Abi extends ContractAbi>
  contractOptions: contractOptions ?? this.options,
  });
 
- return sendTransaction(this, tx);
+ return sendTransaction(this, tx, DEFAULT_RETURN_FORMAT);
  }
 
  private async _contractMethodEstimateGas<

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

@@ -1,4 +1,4 @@
-import { getBlock } from 'web3-eth';
+import { getBlock, ReceiptInfo } from 'web3-eth';
 import { Web3Context, SupportedProviders, Web3ContextObject } from 'web3-core';
 import { getId, Web3NetAPI } from 'web3-net';
 import { Address } from 'web3-utils';
@@ -9,7 +9,7 @@ import {
  ENSNetworkNotSyncedError,
  DEFAULT_RETURN_FORMAT,
 } from 'web3-common';
-import { NonPayableCallOptions, TransactionReceipt, Contract } from 'web3-eth-contract';
+import { NonPayableCallOptions, Contract } from 'web3-eth-contract';
 import { RESOLVER } from './abi/resolver';
 import { Registry } from './registry';
 import { registryAddresses } from './config';
@@ -50,7 +50,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  name: string,
  address: Address,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._registry.setResolver(name, address, txConfig);
  }
 
@@ -64,7 +64,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  resolver: Address,
  ttl: number,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._registry.setSubnodeRecord(name, label, owner, resolver, ttl, txConfig);
  }
 
@@ -75,7 +75,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  operator: Address,
  approved: boolean,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._registry.setApprovalForAll(operator, approved, txConfig);
  }
 
@@ -101,7 +101,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  label: string,
  address: Address,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._registry.setSubnodeOwner(name, label, address, txConfig);
  }
 
@@ -119,7 +119,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  name: string,
  ttl: number,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._registry.setTTL(name, ttl, txConfig);
  }
 
@@ -137,7 +137,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  name: string,
  address: Address,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._registry.setOwner(name, address, txConfig);
  }
 
@@ -150,7 +150,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  resolver: Address,
  ttl: number,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._registry.setRecord(name, owner, resolver, ttl, txConfig);
  }
 
@@ -161,7 +161,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  name: string,
  address: Address,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._resolver.setAddress(name, address, txConfig);
  }
 
@@ -173,7 +173,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  x: string,
  y: string,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._resolver.setPubkey(name, x, y, txConfig);
  }
 
@@ -184,7 +184,7 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
  name: string,
  hash: string,
  txConfig: NonPayableCallOptions,
- ): Promise<TransactionReceipt | RevertInstructionError> {
+ ): Promise<ReceiptInfo | RevertInstructionError> {
  return this._resolver.setContenthash(name, hash, txConfig);
  }
 

packages/web3-eth/src/errors.ts

@@ -21,9 +21,10 @@ import {
  ERR_TX_POLLING_TIMEOUT,
  ERR_TX_RECEIPT_MISSING_OR_BLOCKHASH_NULL,
  ERR_TX_RECEIPT_MISSING_BLOCK_NUMBER,
- ReceiptInfo,
 } from 'web3-common';
-import { HexString, HexString32Bytes, Numbers, Web3Error } from 'web3-utils';
+import { Bytes, HexString, Numbers, Web3Error } from 'web3-utils';
+
+import { ReceiptInfo } from './types';
 
 export class InvalidTransactionWithSender extends Web3Error {
  public code = ERR_TX_INVALID_SENDER;
@@ -249,9 +250,9 @@ export class TransactionDataAndInputError extends Web3Error {
 export class TransactionPollingTimeoutError extends Web3Error {
  public code = ERR_TX_POLLING_TIMEOUT;
 
- public constructor(value: { numberOfSeconds: number; transactionHash: HexString32Bytes }) {
+ public constructor(value: { numberOfSeconds: number; transactionHash: Bytes }) {
  super(
- `transactionHash: ${value.transactionHash}`,
+ `transactionHash: ${value.transactionHash.toString()}`,
  `Transaction was not mined within ${value.numberOfSeconds} seconds, please make sure your transaction was properly sent. Be aware that it might still be mined!`,
  );
  }
@@ -260,9 +261,11 @@ export class TransactionPollingTimeoutError extends Web3Error {
 export class TransactionMissingReceiptOrBlockHashError extends Web3Error {
  public code = ERR_TX_RECEIPT_MISSING_OR_BLOCKHASH_NULL;
 
- public constructor(value: { receipt: ReceiptInfo; blockHash: HexString32Bytes }) {
+ public constructor(value: { receipt: ReceiptInfo; blockHash: Bytes; transactionHash: Bytes }) {
  super(
- `receipt: ${JSON.stringify(value.receipt)}, blockHash: ${value.blockHash}`,
+ `receipt: ${JSON.stringify(
+ value.receipt,
+ )}, blockHash: ${value.blockHash.toString()}, transactionHash: ${value.transactionHash.toString()}`,
  `Receipt missing or blockHash null`,
  );
  }