fix: add new Ethereum types namespace to fix types

package.json

@@ -48,7 +48,7 @@
  "semver": "7.3.5",
  "shx": "0.3.3",
  "ts-node": "10.4.0",
- "typescript": "4.5.4",
+ "typescript": "4.6.4",
  "validate-npm-package-name": "3.0.0",
  "yargs": "16.2.0"
  },

scripts/build-docs/index.ts

@@ -60,6 +60,7 @@ type Type = {
  elements: Type[];
  elementType: Type;
  value?: any;
+ declaration?: Child;
 };
 
 type Comment = {
@@ -271,7 +272,15 @@ function getTypeAsString(type: Type): string {
  case "array":
  return `${getTypeAsString(type.elementType)}[]`;
  case "reflection":
- return "object";
+ if (type.declaration) {
+ return `{ ${type.declaration.children
+ .map(child => {
+ return `${child.name}: ${getTypeAsString(child.type)}`;
+ })
+ .join(", ")} }`;
+ } else {
+ return "object";
+ }
  case "intrinsic":
  case "reference":
  return x(type.name);
@@ -283,6 +292,10 @@ function getTypeAsString(type: Type): string {
  // outputs a string literal like `He said, "hello, world"!` as
  // the string `"He said, \"hello, world\"!"`
  return `"${type.value.replace(/"/g, '\\"')}"`;
+ case "intersection":
+ return type.types.map(getTypeAsString).join(" & ");
+ case "conditional":
+ return getTypeAsString((type as any).checkType);
  default:
  console.error(type);
  throw new Error(`Unhandled type: ${type.type}`);
@@ -295,13 +308,7 @@ function renderReturnType(method: Method) {
  if (signature.type.typeArguments.length) {
  let typeArgs = signature.type.typeArguments.map(getTypeAsString);
  typeArgs = typeArgs.map((arg: string) => {
- if (arg.includes("Quantity")) {
- return arg.replace("Quantity", "QUANTITY");
- } else if (arg.includes("Data")) {
- return arg.replace("Data", "DATA");
- } else {
- return arg;
- }
+ return arg.replace(/Quantity/g, "QUANTITY").replace(/Data/g, "DATA");
  });
  returnType = `${returnType}<${typeArgs.join(", ")}>`;
  }

src/chains/ethereum/address/package.json

@@ -53,7 +53,7 @@
  "mocha": "9.1.3",
  "nyc": "15.1.0",
  "ts-node": "10.4.0",
- "typescript": "4.5.2"
+ "typescript": "4.6.4"
  },
  "dependencies": {
  "@ganache/utils": "0.3.0"

src/chains/ethereum/block/package.json

@@ -53,7 +53,7 @@
  "mocha": "9.1.3",
  "nyc": "15.1.0",
  "ts-node": "10.4.0",
- "typescript": "4.5.2"
+ "typescript": "4.6.4"
  },
  "dependencies": {
  "@ethereumjs/common": "2.6.4",

src/chains/ethereum/block/src/block.ts

@@ -4,7 +4,8 @@ import {
  GanacheRawExtraTx,
  TransactionFactory,
  TypedDatabaseTransaction,
- TypedTransaction
+ TypedTransaction,
+ TypedTransactionJSON
 } from "@ganache/ethereum-transaction";
 import type Common from "@ethereumjs/common";
 import { encode, decode } from "@ganache/rlp";
@@ -69,9 +70,11 @@ export class Block {
  });
  }
 
- toJSON(includeFullTransactions = false) {
+ toJSON<IncludeTransactions extends boolean>(
+ includeFullTransactions: IncludeTransactions
+ ) {
  const hash = this.hash();
- const txFn = this.getTxFn(includeFullTransactions);
+ const txFn = this.getTxFn<IncludeTransactions>(includeFullTransactions);
  const hashBuffer = hash.toBuffer();
  const header = this.header;
  const number = header.number.toBuffer();
@@ -92,19 +95,19 @@ export class Block {
  // leave it out of extra and update the effectiveGasPrice after like this
  tx.updateEffectiveGasPrice(header.baseFeePerGas);
  return txFn(tx);
- });
+ }) as IncludeTransactions extends true ? TypedTransactionJSON[] : Data[];
 
  return {
  hash,
  ...header,
  size: Quantity.from(this._size),
  transactions: jsonTxs,
- uncles: [] as string[] // this.value.uncleHeaders.map(function(uncleHash) {return to.hex(uncleHash)})
+ uncles: [] as Data[] // this.value.uncleHeaders.map(function(uncleHash) {return to.hex(uncleHash)})
  };
  }
 
- getTxFn(
- include = false
+ getTxFn<IncludeTransactions extends boolean>(
+ include: IncludeTransactions = <IncludeTransactions>false
  ): (tx: TypedTransaction) => ReturnType<TypedTransaction["toJSON"]> | Data {
  if (include) {
  return (tx: TypedTransaction) => tx.toJSON(this._common);

src/chains/ethereum/block/src/runtime-block.ts

@@ -51,7 +51,7 @@ export type BlockHeader = {
 
 /**
  * Returns the size of the serialized data as it would have been calculated had
- * we stored things geth does, i.e., `totalDfficulty` is not usually stored in
+ * we stored things geth does, i.e., `totalDifficulty` is not usually stored in
  * the block header.
  *
  * @param serialized -

src/chains/ethereum/block/tests/index.test.ts

@@ -3,10 +3,7 @@ import { Address } from "@ganache/ethereum-address";
 import { BUFFER_ZERO, Data, Quantity } from "@ganache/utils";
 import Common from "@ethereumjs/common";
 import Wallet from "../../ethereum/src/wallet";
-import {
- TypedRpcTransaction,
- TransactionFactory
-} from "@ganache/ethereum-transaction";
+import { Transaction, TransactionFactory } from "@ganache/ethereum-transaction";
 import Blockchain from "../../ethereum/src/blockchain";
 import { EthereumOptionsConfig } from "../../options/src/index";
 
@@ -36,7 +33,7 @@ describe("@ganache/ethereum-block", async () => {
  const wallet = new Wallet(options.wallet);
  const [from, to] = wallet.addresses;
  const fromAddress = new Address(from);
- const tx: TypedRpcTransaction = {
+ const tx: Transaction = {
  type: "0x2",
  from: from,
  to: to,

src/chains/ethereum/ethereum/RPC-METHODS.md

@@ -98,7 +98,7 @@ Attempts to replay the transaction as it was executed on the network and return
 
 ##### Returns
 
-`Promise<StorageRangeResult>` : Returns a storage object with the keys being keccak-256 hashes of the storage keys, and the values being the raw, unhashed key and value for that specific storage slot. Also returns a next key which is the keccak-256 hash of the next key in storage for continuous downloading.
+`Promise<Ethereum.StorageRangeResult>` : Returns a storage object with the keys being keccak-256 hashes of the storage keys, and the values being the raw, unhashed key and value for that specific storage slot. Also returns a next key which is the keccak-256 hash of the next key in storage for continuous downloading.
 
 ---
 
@@ -109,11 +109,11 @@ Attempt to run the transaction in the exact same manner as it was executed on th
 ##### Arguments
 
 - `transactionHash: DATA` : Hash of the transaction to trace.
-- `options?: TransactionTraceOptions` : See options in source.
+- `options?: Ethereum.TransactionTraceOptions` : See options in source.
 
 ##### Returns
 
-`Promise<TraceTransactionResult>` : Returns the `gas`, `structLogs`, and `returnValue` for the traced transaction. The `structLogs` are an array of logs, which contains the following fields:
+`Promise<Ethereum.TraceTransactionResult>` : Returns the `gas`, `structLogs`, and `returnValue` for the traced transaction. The `structLogs` are an array of logs, which contains the following fields:
 
 - `depth`: The execution depth.
 - `error`: Information about an error, if one occurred.
@@ -156,15 +156,11 @@ Executes a new message call immediately without creating a transaction on the bl
 - `transaction: any` : The transaction call object as seen in source.
 - `blockNumber: QUANTITY | TAG` : Integer block number, or the string "latest", "earliest" or "pending".
 - `overrides: CallOverrides`: State overrides to apply during the simulation.
+
  - `CallOverrides` - An address-to-state mapping, where each entry specifies some
-state to be ephemerally overridden prior to executing the call. Each address maps to an object containing:
- - `balance: QUANTITY` (optional) - The balance to set for the account before executing the call.
- - `nonce: QUANTITY` (optional) - The nonce to set for the account before executing the call.
- - `code: DATA` (optional) - The EVM bytecode to set for the account before executing the call.
- - `state: OBJECT` (optional\*) - Key-value mapping to override _all_ slots in the account storage before executing the call.
- - `stateDiff: OBJECT` (optional\*) - Key-value mapping to override _individual_ slots in the account storage before executing the call.
+ state to be ephemerally overridden prior to executing the call. Each address maps to an object containing: - `balance: QUANTITY` (optional) - The balance to set for the account before executing the call. - `nonce: QUANTITY` (optional) - The nonce to set for the account before executing the call. - `code: DATA` (optional) - The EVM bytecode to set for the account before executing the call. - `state: OBJECT` (optional\*) - Key-value mapping to override _all_ slots in the account storage before executing the call. - `stateDiff: OBJECT` (optional\*) - Key-value mapping to override _individual_ slots in the account storage before executing the call.
 
- _\*Note - `state` and `stateDiff` fields are mutually exclusive._
+  _\*Note - `state` and `stateDiff` fields are mutually exclusive._
 
 ##### Returns
 
@@ -198,7 +194,7 @@ Generates and returns an estimate of how much gas is necessary to allow the tran
 
 ##### Arguments
 
-- `transaction: TypedRpcTransaction` : The transaction call object as seen in source.
+- `transaction: Ethereum.Transaction` : The transaction call object as seen in source.
 - `blockNumber: QUANTITY | TAG` : Integer block number, or the string "latest", "earliest" or "pending".
 
 ##### Returns
@@ -243,7 +239,7 @@ Returns information about a block by block hash.
 
 ##### Returns
 
-`Promise<object>` : The block, `null` if the block doesn't exist.
+`Promise<Ethereum.Block<IncludeTransactions>>` : The block, `null` if the block doesn't exist.
 
 ---
 
@@ -258,7 +254,7 @@ Returns information about a block by block number.
 
 ##### Returns
 
-`Promise<object>` : The block, `null` if the block doesn't exist.
+`Promise<Ethereum.Block<IncludeTransactions>>` : The block, `null` if the block doesn't exist.
 
 ---
 
@@ -359,7 +355,7 @@ Returns an array of all logs matching a given filter object.
 
 ##### Arguments
 
-- `filter: FilterArgs` : The filter options as seen in source.
+- `filter: Ethereum.LogsFilter` : The filter options as seen in source.
 
 ##### Returns
 
@@ -452,7 +448,7 @@ Returns the receipt of a transaction by transaction hash.
 
 ##### Returns
 
-`Promise<TransactionReceiptJSON>` : Returns the receipt of a transaction by transaction hash.
+`Promise<Ethereum.TransactionReceipt>` : Returns the receipt of a transaction by transaction hash.
 
 ---
 
@@ -578,7 +574,7 @@ Creates a filter object, based on filter options, to notify when the state chang
 
 ##### Arguments
 
-- `filter?: RangeFilterArgs` : The filter options as seen in source.
+- `filter?: Ethereum.Filter` : The filter options as seen in source.
 
 ##### Returns
 
@@ -626,7 +622,7 @@ Creates new message call transaction or a contract creation, if the data field c
 
 ##### Arguments
 
-- `transaction: TypedRpcTransaction` : The transaction call object as seen in source.
+- `transaction: Ethereum.Transaction` : The transaction call object as seen in source.
 
 ##### Returns
 
@@ -655,7 +651,7 @@ Signs a transaction that can be submitted to the network at a later time using `
 
 ##### Arguments
 
-- `transaction: TypedRpcTransaction` : The transaction call object as seen in source.
+- `transaction: Ethereum.Transaction` : The transaction call object as seen in source.
 
 ##### Returns
 
@@ -670,7 +666,7 @@ Identical to eth_signTypedData_v4.
 ##### Arguments
 
 - `address: DATA` : Address of the account that will sign the messages.
-- `typedData: TypedData` : Typed structured data to be signed.
+- `typedData: Ethereum.TypedData` : Typed structured data to be signed.
 
 ##### Returns
 
@@ -683,7 +679,7 @@ Identical to eth_signTypedData_v4.
 ##### Arguments
 
 - `address: DATA` : Address of the account that will sign the messages.
-- `typedData: TypedData` : Typed structured data to be signed.
+- `typedData: Ethereum.TypedData` : Typed structured data to be signed.
 
 ##### Returns
 
@@ -728,7 +724,7 @@ Starts a subscription to a particular event. For every event that matches the su
 
 ##### Arguments
 
-- `subscriptionName: SubscriptionName` : Name for the subscription.
+- `subscriptionName: Ethereum.SubscriptionName` : Name for the subscription.
 
 ##### Returns
 
@@ -766,7 +762,7 @@ Cancel a subscription to a particular event. Returns a boolean indicating if the
 
 ##### Arguments
 
-- `subscriptionId: SubscriptionId` : The ID of the subscription to unsubscribe to.
+- `subscriptionId: Ethereum.SubscriptionId` : The ID of the subscription to unsubscribe to.
 
 ##### Returns
 
@@ -1086,8 +1082,8 @@ Validate the given passphrase and submit transaction.
 
 ##### Arguments
 
-- `transaction: TypedRpcTransaction`
-- `passphrase: string` : The passphrase to decrpyt the private key belonging to `tx.from`.
+- `transaction: Ethereum.Transaction`
+- `passphrase: string` : The passphrase to decrypt the private key belonging to `tx.from`.
 
 ##### Returns
 
@@ -1101,7 +1097,7 @@ Validates the given passphrase and signs a transaction that can be submitted to
 
 ##### Arguments
 
-- `transaction: TypedRpcTransaction` : The transaction call object as seen in source.
+- `transaction: Ethereum.Transaction` : The transaction call object as seen in source.
 - `passphrase: string`
 
 ##### Returns
@@ -1233,7 +1229,7 @@ Creates a whisper message and injects it into the network for distribution.
 
 ##### Arguments
 
-- `postData: WhisperPostObject`
+- `postData: Ethereum.WhisperPostObject`
 
 ##### Returns
 
@@ -1265,6 +1261,16 @@ Returns the current whisper protocol version.
 
 ---
 
+#### txpool_content()
+
+Returns the current content of the transaction pool.
+
+##### Returns
+
+`Promise<Ethereum.Pool.Content>` : The transactions currently pending or queued in the transaction pool.
+
+---
+
 #### web3_clientVersion
 
 Returns the current client version.

src/chains/ethereum/ethereum/index.ts

@@ -6,3 +6,4 @@
  */
 
 export * from "./src/connector";
+export * from "./src/api-types";