fix: add an upper limit to # of accounts that can be generated by ganache (#3361)

Co-authored-by: David Murdoch <[email protected]>

Author: tenthirtyone

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

@@ -30,7 +30,7 @@ describe("@ganache/ethereum-block", async () => {
         chain: { chainId: 1337 },
         logging: { logger: { log: (_message: string) => {} } } // ignore logging
       });
-      const wallet = new Wallet(options.wallet);
+      const wallet = new Wallet(options.wallet, options.logging);
       const [from, to] = wallet.addresses;
       const fromAddress = new Address(from);
       const tx: Transaction = {

src/chains/ethereum/ethereum/src/provider.ts

@@ -155,7 +155,10 @@ export class EthereumProvider
       options as EthereumProviderOptions
     ));
 
-    const wallet = (this.#wallet = new Wallet(providerOptions.wallet));
+    const wallet = (this.#wallet = new Wallet(
+      providerOptions.wallet,
+      providerOptions.logging
+    ));
     const accounts = wallet.initialAccounts;
     const fork =
       providerOptions.fork.url ||

src/chains/ethereum/ethereum/src/wallet.ts

@@ -32,6 +32,7 @@ const SCRYPT_PARAMS = {
   r: 1
 } as const;
 const CIPHER = "aes-128-ctr";
+const MAX_ACCOUNTS = 100000;
 //#endregion
 
 type OmitLastType<T extends [unknown, ...Array<unknown>]> = T extends [
@@ -119,7 +120,15 @@ export default class Wallet {
   readonly unlockedAccounts = new Map<string, Data>();
   readonly lockTimers = new Map<string, NodeJS.Timeout>();
 
-  constructor(opts: EthereumInternalOptions["wallet"]) {
+  constructor(
+    opts: EthereumInternalOptions["wallet"],
+    logging: EthereumInternalOptions["logging"]
+  ) {
+    if (opts.totalAccounts > MAX_ACCOUNTS) {
+      logging.logger.log(
+        `wallet.totalAccounts exceeds MAX_ACCOUNTS (${MAX_ACCOUNTS}) and may affect performance.`
+      );
+    }
     // create a RNG from our initial starting conditions (opts.mnemonic)
     this.#randomRng = alea("ganache " + opts.mnemonic);
 
@@ -271,6 +280,7 @@ export default class Wallet {
       }
     } else {
       const numberOfAccounts = options.totalAccounts;
+
       if (numberOfAccounts != null) {
         for (let i = 0; i < numberOfAccounts; i++) {
           const acct = makeAccountAtIndex(i);

src/chains/ethereum/ethereum/tests/api/eth/call.test.ts

@@ -862,7 +862,7 @@ describe("api", () => {
           const options = EthereumOptionsConfig.normalize({
             logging: { quiet: true }
           });
-          wallet = new Wallet(options.wallet);
+          wallet = new Wallet(options.wallet, options.logging);
           [from, to] = wallet.addresses;
           blockchain = new Blockchain(
             options,

src/chains/ethereum/ethereum/tests/api/eth/sendTransaction.test.ts

@@ -329,7 +329,7 @@ describe("api", () => {
           // https://eips.ethereum.org/EIPS/eip-2
 
           const options = EthereumOptionsConfig.normalize({});
-          const wallet = new Wallet(options.wallet);
+          const wallet = new Wallet(options.wallet, options.logging);
 
           function makeKeys(address: string) {
             const addressBuf = Data.toBuffer(address);

src/chains/ethereum/ethereum/tests/blockchain.test.ts

@@ -27,7 +27,7 @@ describe("blockchain", async () => {
       const options = EthereumOptionsConfig.normalize(optionsJson);
 
       // set up wallet/blockchain
-      const wallet = new Wallet(options.wallet);
+      const wallet = new Wallet(options.wallet, options.logging);
       const initialAccounts = wallet.initialAccounts;
       const blockchain = new Blockchain(options, initialAccounts[0].address);
       await blockchain.initialize(wallet.initialAccounts);

src/chains/ethereum/ethereum/tests/miner/miner.test.ts

@@ -41,7 +41,7 @@ describe("miner", async () => {
         chain: { chainId: 1337 }
       };
       const options = EthereumOptionsConfig.normalize(optionsJson);
-      const wallet = new Wallet(options.wallet);
+      const wallet = new Wallet(options.wallet, options.logging);
       [from1, from2, from3, to] = wallet.addresses;
       const fromAddress = new Address(from1);
 

src/chains/ethereum/ethereum/tests/transaction-pool.test.ts

@@ -42,7 +42,7 @@ describe("transaction pool", async () => {
   const options = EthereumOptionsConfig.normalize(optionsJson);
   let futureNonceRpc, executableRpc: Transaction;
   before(function () {
-    const wallet = new Wallet(options.wallet);
+    const wallet = new Wallet(options.wallet, options.logging);
     [from] = wallet.addresses;
     secretKey = wallet.unlockedAccounts.get(from);
     rpcTx = {

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

@@ -41,9 +41,12 @@ describe("@ganache/ethereum-transaction", async () => {
         { secretKey: `0x${"46".repeat(31)}47`, balance: 100n },
         { secretKey: `0x${"46".repeat(31)}48`, balance: 100n }
       ]
+    },
+    logging: {
+      logger: console
     }
   });
-  const wallet = new Wallet(options.wallet);
+  const wallet = new Wallet(options.wallet, options.logging);
   const [from, to, accessListAcc] = wallet.addresses;
 
   // #endregion configure accounts and private keys in wallet