@sovereign-sdk/test 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/soak/index.d.mts

@@ -0,0 +1,188 @@
+import { BaseTypeSpec, Rollup } from '@sovereign-sdk/web3';
+import SovereignSDK from '@sovereign-sdk/client';
+import { Signer } from '@sovereign-sdk/signers';
+
+/** Response data type from a transaction submission */
+type TxResult = SovereignSDK.Sequencer.TxCreateResponse.Data;
+/**
+ * Possible outcomes for a generated transaction.
+ * Used to control whether the transaction should succeed or fail.
+ */
+declare enum Outcome {
+    /** Transaction should be generated to succeed */
+    Success = 0,
+    /** Transaction should be generated to fail */
+    Failure = 1
+}
+/**
+ * Represents a generated transaction input with its associated metadata.
+ * @template S - The type specification for the rollup being tested
+ */
+type GeneratedInput<S extends BaseTypeSpec> = {
+    /** The unsigned transaction to be submitted */
+    unsignedTransaction: S["UnsignedTransaction"];
+    /** The signer to use for signing the transaction */
+    signer: Signer;
+    /**
+     * Optional callback to be executed after the transaction is onSubmitted
+     * This function is passed the transaction receipt along with events and
+     * other result related data - it can be used to assert the output of the provided
+     * input.
+     */
+    onSubmitted?: (result: TxResult) => Promise<void>;
+};
+/**
+ * Represents a generated transaction with its expected outcome.
+ * This is returned by generator strategies to indicate both the transaction
+ * and whether it should succeed or fail.
+ */
+type InputWithExpectation<S extends BaseTypeSpec> = {
+    /** The generated transaction input */
+    input: GeneratedInput<S>;
+    /** The expected outcome of the transaction */
+    expectedOutcome: Outcome;
+};
+/**
+ * Interface for generating individual test transactions.
+ * Implementations should create transactions that can either succeed or fail
+ * based on the provided outcome.
+ *
+ * @template S - The type specification for the rollup being tested
+ *
+ * @example
+ * ```typescript
+ * class CustomGenerator implements TransactionGenerator<YourTypeSpec> {
+ *   async successful(): Promise<GeneratedInput<YourTypeSpec>> {
+ *     // Generate transaction based on outcome
+ *     return {
+ *       unsignedTransaction: {},
+ *       signer: {},
+ *       onSubmitted: async (result) => {
+ *         // Handle submission result
+ *       }
+ *     };
+ *   }
+ * }
+ * ```
+ */
+declare abstract class TransactionGenerator<S extends BaseTypeSpec> {
+    /**
+     * Generate a single test transaction that should succeed.
+     * @returns A promise that resolves to the generated transaction input
+     */
+    successful(): Promise<GeneratedInput<S>>;
+    /**
+     * Generate a single test transaction that should fail.
+     * @returns A promise that resolves to the generated transaction input
+     */
+    failure(): Promise<GeneratedInput<S>>;
+}
+/**
+ * Interface for generating batches of test transactions.
+ * Implementations should create multiple transactions according to the specified amount.
+ *
+ * @template S - The type specification for the rollup being tested
+ */
+interface GeneratorStrategy<S extends BaseTypeSpec> {
+    /**
+     * Generates a batch of test transactions.
+     * @param amount - The number of transactions to generate
+     * @returns A promise that resolves to an array of generated transactions with their expected outcomes
+     */
+    generate(amount: number): Promise<InputWithExpectation<S>[]>;
+}
+/**
+ * A basic implementation of GeneratorStrategy that generates a fixed number of
+ * transactions that always succeed using a singular TransactionGenerator.
+ *
+ * @template S - The type specification for the rollup being tested
+ *
+ * @example
+ * ```typescript
+ * const generator = new YourTransactionGenerator();
+ * const strategy = new BasicGeneratorStrategy(generator);
+ * const transactions = await strategy.generate(100);
+ * ```
+ */
+declare class BasicGeneratorStrategy<S extends BaseTypeSpec> implements GeneratorStrategy<S> {
+    private readonly generator;
+    /**
+     * Creates a new BasicGeneratorStrategy instance.
+     * @param generator - The transaction generator to use for creating individual transactions
+     */
+    constructor(generator: TransactionGenerator<S>);
+    /**
+     * Generates a batch of test transactions using the configured generator.
+     * All transactions are generated with Outcome.Success.
+     *
+     * @param amount - The number of transactions to generate
+     * @returns A promise that resolves to an array of generated transactions with their expected outcomes
+     */
+    generate(amount: number): Promise<InputWithExpectation<S>[]>;
+}
+
+/**
+ * Configuration options for creating a new TestRunner instance.
+ * @template S - The type specification for the rollup being tested
+ */
+interface TestOptions<S extends BaseTypeSpec> {
+    /** Maximum number of concurrent transactions to run (default: 30) */
+    concurrency?: number;
+    /** Strategy for generating test transactions */
+    generator: GeneratorStrategy<S>;
+    /** The rollup instance to test against */
+    rollup: Rollup<S, any>;
+}
+/**
+ * A class for running soak tests against a Sovereign rollup.
+ * Manages concurrent transaction execution and provides control over test execution.
+ *
+ * @template S - The type specification for the rollup being tested
+ *
+ * @example
+ * ```typescript
+ * const runner = new TestRunner({
+ *   rollup: new YourRollup(),
+ *   generator: new YourGeneratorStrategy(),
+ *   concurrency: 30
+ * });
+ *
+ * // Start the test
+ * await runner.run();
+ *
+ * // Stop the test when needed
+ * await runner.stop();
+ * ```
+ */
+declare class TestRunner<S extends BaseTypeSpec> {
+    private controller;
+    private readonly concurrency;
+    private readonly queue;
+    private readonly rollup;
+    private readonly generator;
+    /**
+     * Creates a new TestRunner instance.
+     * @param options - Configuration options for the test runner
+     */
+    constructor({ rollup, generator, concurrency }: TestOptions<S>);
+    /**
+     * Starts the soak test. This will begin generating and submitting transactions
+     * according to the configured generator strategy and concurrency settings.
+     *
+     * The test will continue running until explicitly stopped using the stop() method.
+     */
+    run(): Promise<void>;
+    /**
+     * Stops the soak test. This will abort any pending transactions and prevent
+     * new transactions from being generated.
+     */
+    stop(): Promise<void>;
+    private doExecution;
+    private silenceNodeWarning;
+}
+
+declare class NotImplementedError extends Error {
+    constructor(symbol: string);
+}
+
+export { BasicGeneratorStrategy, type GeneratedInput, type GeneratorStrategy, type InputWithExpectation, NotImplementedError, Outcome, type TestOptions, TestRunner, TransactionGenerator, type TxResult };

package/dist/soak/index.d.ts

@@ -0,0 +1,188 @@
+import { BaseTypeSpec, Rollup } from '@sovereign-sdk/web3';
+import SovereignSDK from '@sovereign-sdk/client';
+import { Signer } from '@sovereign-sdk/signers';
+
+/** Response data type from a transaction submission */
+type TxResult = SovereignSDK.Sequencer.TxCreateResponse.Data;
+/**
+ * Possible outcomes for a generated transaction.
+ * Used to control whether the transaction should succeed or fail.
+ */
+declare enum Outcome {
+    /** Transaction should be generated to succeed */
+    Success = 0,
+    /** Transaction should be generated to fail */
+    Failure = 1
+}
+/**
+ * Represents a generated transaction input with its associated metadata.
+ * @template S - The type specification for the rollup being tested
+ */
+type GeneratedInput<S extends BaseTypeSpec> = {
+    /** The unsigned transaction to be submitted */
+    unsignedTransaction: S["UnsignedTransaction"];
+    /** The signer to use for signing the transaction */
+    signer: Signer;
+    /**
+     * Optional callback to be executed after the transaction is onSubmitted
+     * This function is passed the transaction receipt along with events and
+     * other result related data - it can be used to assert the output of the provided
+     * input.
+     */
+    onSubmitted?: (result: TxResult) => Promise<void>;
+};
+/**
+ * Represents a generated transaction with its expected outcome.
+ * This is returned by generator strategies to indicate both the transaction
+ * and whether it should succeed or fail.
+ */
+type InputWithExpectation<S extends BaseTypeSpec> = {
+    /** The generated transaction input */
+    input: GeneratedInput<S>;
+    /** The expected outcome of the transaction */
+    expectedOutcome: Outcome;
+};
+/**
+ * Interface for generating individual test transactions.
+ * Implementations should create transactions that can either succeed or fail
+ * based on the provided outcome.
+ *
+ * @template S - The type specification for the rollup being tested
+ *
+ * @example
+ * ```typescript
+ * class CustomGenerator implements TransactionGenerator<YourTypeSpec> {
+ *   async successful(): Promise<GeneratedInput<YourTypeSpec>> {
+ *     // Generate transaction based on outcome
+ *     return {
+ *       unsignedTransaction: {},
+ *       signer: {},
+ *       onSubmitted: async (result) => {
+ *         // Handle submission result
+ *       }
+ *     };
+ *   }
+ * }
+ * ```
+ */
+declare abstract class TransactionGenerator<S extends BaseTypeSpec> {
+    /**
+     * Generate a single test transaction that should succeed.
+     * @returns A promise that resolves to the generated transaction input
+     */
+    successful(): Promise<GeneratedInput<S>>;
+    /**
+     * Generate a single test transaction that should fail.
+     * @returns A promise that resolves to the generated transaction input
+     */
+    failure(): Promise<GeneratedInput<S>>;
+}
+/**
+ * Interface for generating batches of test transactions.
+ * Implementations should create multiple transactions according to the specified amount.
+ *
+ * @template S - The type specification for the rollup being tested
+ */
+interface GeneratorStrategy<S extends BaseTypeSpec> {
+    /**
+     * Generates a batch of test transactions.
+     * @param amount - The number of transactions to generate
+     * @returns A promise that resolves to an array of generated transactions with their expected outcomes
+     */
+    generate(amount: number): Promise<InputWithExpectation<S>[]>;
+}
+/**
+ * A basic implementation of GeneratorStrategy that generates a fixed number of
+ * transactions that always succeed using a singular TransactionGenerator.
+ *
+ * @template S - The type specification for the rollup being tested
+ *
+ * @example
+ * ```typescript
+ * const generator = new YourTransactionGenerator();
+ * const strategy = new BasicGeneratorStrategy(generator);
+ * const transactions = await strategy.generate(100);
+ * ```
+ */
+declare class BasicGeneratorStrategy<S extends BaseTypeSpec> implements GeneratorStrategy<S> {
+    private readonly generator;
+    /**
+     * Creates a new BasicGeneratorStrategy instance.
+     * @param generator - The transaction generator to use for creating individual transactions
+     */
+    constructor(generator: TransactionGenerator<S>);
+    /**
+     * Generates a batch of test transactions using the configured generator.
+     * All transactions are generated with Outcome.Success.
+     *
+     * @param amount - The number of transactions to generate
+     * @returns A promise that resolves to an array of generated transactions with their expected outcomes
+     */
+    generate(amount: number): Promise<InputWithExpectation<S>[]>;
+}
+
+/**
+ * Configuration options for creating a new TestRunner instance.
+ * @template S - The type specification for the rollup being tested
+ */
+interface TestOptions<S extends BaseTypeSpec> {
+    /** Maximum number of concurrent transactions to run (default: 30) */
+    concurrency?: number;
+    /** Strategy for generating test transactions */
+    generator: GeneratorStrategy<S>;
+    /** The rollup instance to test against */
+    rollup: Rollup<S, any>;
+}
+/**
+ * A class for running soak tests against a Sovereign rollup.
+ * Manages concurrent transaction execution and provides control over test execution.
+ *
+ * @template S - The type specification for the rollup being tested
+ *
+ * @example
+ * ```typescript
+ * const runner = new TestRunner({
+ *   rollup: new YourRollup(),
+ *   generator: new YourGeneratorStrategy(),
+ *   concurrency: 30
+ * });
+ *
+ * // Start the test
+ * await runner.run();
+ *
+ * // Stop the test when needed
+ * await runner.stop();
+ * ```
+ */
+declare class TestRunner<S extends BaseTypeSpec> {
+    private controller;
+    private readonly concurrency;
+    private readonly queue;
+    private readonly rollup;
+    private readonly generator;
+    /**
+     * Creates a new TestRunner instance.
+     * @param options - Configuration options for the test runner
+     */
+    constructor({ rollup, generator, concurrency }: TestOptions<S>);
+    /**
+     * Starts the soak test. This will begin generating and submitting transactions
+     * according to the configured generator strategy and concurrency settings.
+     *
+     * The test will continue running until explicitly stopped using the stop() method.
+     */
+    run(): Promise<void>;
+    /**
+     * Stops the soak test. This will abort any pending transactions and prevent
+     * new transactions from being generated.
+     */
+    stop(): Promise<void>;
+    private doExecution;
+    private silenceNodeWarning;
+}
+
+declare class NotImplementedError extends Error {
+    constructor(symbol: string);
+}
+
+export { BasicGeneratorStrategy, type GeneratedInput, type GeneratorStrategy, type InputWithExpectation, NotImplementedError, Outcome, type TestOptions, TestRunner, TransactionGenerator, type TxResult };

package/dist/soak/index.js

@@ -0,0 +1,205 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/soak/index.ts
+var soak_exports = {};
+__export(soak_exports, {
+  BasicGeneratorStrategy: () => BasicGeneratorStrategy,
+  NotImplementedError: () => NotImplementedError,
+  Outcome: () => Outcome,
+  TestRunner: () => TestRunner,
+  TransactionGenerator: () => TransactionGenerator
+});
+module.exports = __toCommonJS(soak_exports);
+
+// src/soak/runner.ts
+var import_p_queue = __toESM(require("p-queue"));
+var TestRunner = class {
+  /**
+   * Creates a new TestRunner instance.
+   * @param options - Configuration options for the test runner
+   */
+  constructor({ rollup, generator, concurrency }) {
+    this.controller = new AbortController();
+    this.concurrency = concurrency != null ? concurrency : 30;
+    this.queue = new import_p_queue.default({ concurrency: this.concurrency });
+    this.rollup = rollup;
+    this.generator = generator;
+  }
+  /**
+   * Starts the soak test. This will begin generating and submitting transactions
+   * according to the configured generator strategy and concurrency settings.
+   *
+   * The test will continue running until explicitly stopped using the stop() method.
+   */
+  run() {
+    return __async(this, null, function* () {
+      yield this.silenceNodeWarning();
+      this.doExecution();
+    });
+  }
+  /**
+   * Stops the soak test. This will abort any pending transactions and prevent
+   * new transactions from being generated.
+   */
+  stop() {
+    return __async(this, null, function* () {
+      this.controller.abort();
+    });
+  }
+  doExecution() {
+    return __async(this, null, function* () {
+      if (this.controller.signal.aborted) return;
+      const controller = new AbortController();
+      const signal = controller.signal;
+      this.controller.signal.addEventListener("abort", controller.abort, {
+        once: true
+      });
+      const inputs = yield this.generator.generate(100);
+      const execution = inputs.map(({ input }) => {
+        return () => __async(this, null, function* () {
+          if (signal.aborted) return;
+          const { signer, unsignedTransaction, onSubmitted } = input;
+          const { response } = yield this.rollup.signAndSubmitTransaction(
+            unsignedTransaction,
+            { signer },
+            { signal }
+          );
+          if (onSubmitted) {
+            yield onSubmitted(response.data);
+          }
+        });
+      });
+      this.queue.addAll(execution);
+      yield this.queue.onSizeLessThan(this.concurrency);
+      this.controller.signal.removeEventListener("abort", controller.abort);
+      setTimeout(() => this.doExecution(), 100);
+    });
+  }
+  // Node emits a warning if there's more than 10 listeners by default
+  // to try detect listener leaks. This is nodejs specific, we're OK to ignore it.
+  silenceNodeWarning() {
+    return __async(this, null, function* () {
+      var _a;
+      if ((_a = process == null ? void 0 : process.versions) == null ? void 0 : _a.node) {
+        const events = yield import("events");
+        events.setMaxListeners(200);
+      }
+    });
+  }
+};
+
+// src/soak/errors.ts
+var NotImplementedError = class extends Error {
+  constructor(symbol) {
+    super(`Not implemented: ${symbol}`);
+    this.name = "NotImplementedError";
+  }
+};
+
+// src/soak/generation.ts
+var Outcome = /* @__PURE__ */ ((Outcome2) => {
+  Outcome2[Outcome2["Success"] = 0] = "Success";
+  Outcome2[Outcome2["Failure"] = 1] = "Failure";
+  return Outcome2;
+})(Outcome || {});
+var TransactionGenerator = class {
+  /**
+   * Generate a single test transaction that should succeed.
+   * @returns A promise that resolves to the generated transaction input
+   */
+  successful() {
+    throw new NotImplementedError("TransactionGenerator.successful");
+  }
+  /**
+   * Generate a single test transaction that should fail.
+   * @returns A promise that resolves to the generated transaction input
+   */
+  failure() {
+    throw new NotImplementedError("TransactionGenerator.failure");
+  }
+};
+var BasicGeneratorStrategy = class {
+  /**
+   * Creates a new BasicGeneratorStrategy instance.
+   * @param generator - The transaction generator to use for creating individual transactions
+   */
+  constructor(generator) {
+    this.generator = generator;
+  }
+  /**
+   * Generates a batch of test transactions using the configured generator.
+   * All transactions are generated with Outcome.Success.
+   *
+   * @param amount - The number of transactions to generate
+   * @returns A promise that resolves to an array of generated transactions with their expected outcomes
+   */
+  generate(amount) {
+    return __async(this, null, function* () {
+      const promises = [];
+      for (let i = 0; i <= amount; i += 1) {
+        promises.push(this.generator.successful());
+      }
+      const inputs = yield Promise.all(promises);
+      return inputs.map((input) => ({
+        input,
+        expectedOutcome: 0 /* Success */
+      }));
+    });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BasicGeneratorStrategy,
+  NotImplementedError,
+  Outcome,
+  TestRunner,
+  TransactionGenerator
+});
+//# sourceMappingURL=index.js.map

package/dist/soak/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/soak/index.ts","../../src/soak/runner.ts","../../src/soak/errors.ts","../../src/soak/generation.ts"],"sourcesContent":["export * from \"./runner\";\nexport * from \"./generation\";\nexport * from \"./errors\";\n","import type { BaseTypeSpec, Rollup } from \"@sovereign-sdk/web3\";\nimport PQueue from \"p-queue\";\nimport type { GeneratorStrategy } from \"./generation\";\n\n/**\n * Configuration options for creating a new TestRunner instance.\n * @template S - The type specification for the rollup being tested\n */\nexport interface TestOptions<S extends BaseTypeSpec> {\n  /** Maximum number of concurrent transactions to run (default: 30) */\n  concurrency?: number;\n  /** Strategy for generating test transactions */\n  generator: GeneratorStrategy<S>;\n  /** The rollup instance to test against */\n  // biome-ignore lint/suspicious/noExplicitAny: generic not need\n  rollup: Rollup<S, any>;\n}\n\n/**\n * A class for running soak tests against a Sovereign rollup.\n * Manages concurrent transaction execution and provides control over test execution.\n *\n * @template S - The type specification for the rollup being tested\n *\n * @example\n * ```typescript\n * const runner = new TestRunner({\n *   rollup: new YourRollup(),\n *   generator: new YourGeneratorStrategy(),\n *   concurrency: 30\n * });\n *\n * // Start the test\n * await runner.run();\n *\n * // Stop the test when needed\n * await runner.stop();\n * ```\n */\nexport class TestRunner<S extends BaseTypeSpec> {\n  private controller: AbortController;\n  private readonly concurrency: number;\n  private readonly queue: PQueue;\n  // biome-ignore lint/suspicious/noExplicitAny: generic not need\n  private readonly rollup: Rollup<S, any>;\n  private readonly generator: GeneratorStrategy<S>;\n\n  /**\n   * Creates a new TestRunner instance.\n   * @param options - Configuration options for the test runner\n   */\n  constructor({ rollup, generator, concurrency }: TestOptions<S>) {\n    this.controller = new AbortController();\n    this.concurrency = concurrency ?? 30;\n    this.queue = new PQueue({ concurrency: this.concurrency });\n    this.rollup = rollup;\n    this.generator = generator;\n  }\n\n  /**\n   * Starts the soak test. This will begin generating and submitting transactions\n   * according to the configured generator strategy and concurrency settings.\n   *\n   * The test will continue running until explicitly stopped using the stop() method.\n   */\n  async run(): Promise<void> {\n    await this.silenceNodeWarning();\n    this.doExecution();\n  }\n\n  /**\n   * Stops the soak test. This will abort any pending transactions and prevent\n   * new transactions from being generated.\n   */\n  async stop(): Promise<void> {\n    this.controller.abort();\n  }\n\n  private async doExecution(): Promise<void> {\n    if (this.controller.signal.aborted) return;\n\n    // create a child abort signal per batch because there's no way\n    // to clean up abort listeners, this prevents them building up and leaking\n    const controller = new AbortController();\n    const signal = controller.signal;\n    this.controller.signal.addEventListener(\"abort\", controller.abort, {\n      once: true,\n    });\n\n    const inputs = await this.generator.generate(100);\n    // TODO: check expectedOutcome with what the rollup actually returns\n    const execution = inputs.map(({ input }) => {\n      return async () => {\n        if (signal.aborted) return;\n\n        const { signer, unsignedTransaction, onSubmitted } = input;\n        // TODO: handle abort error\n        const { response } = await this.rollup.signAndSubmitTransaction(\n          unsignedTransaction,\n          { signer },\n          { signal },\n        );\n\n        if (onSubmitted) {\n          // TODO: handle errors\n          await onSubmitted(response.data);\n        }\n      };\n    });\n\n    this.queue.addAll(execution);\n    await this.queue.onSizeLessThan(this.concurrency);\n\n    // clean-up listener to prevent listener leak on top-level abort controller\n    this.controller.signal.removeEventListener(\"abort\", controller.abort);\n\n    setTimeout(() => this.doExecution(), 100);\n  }\n\n  // Node emits a warning if there's more than 10 listeners by default\n  // to try detect listener leaks. This is nodejs specific, we're OK to ignore it.\n  private async silenceNodeWarning(): Promise<void> {\n    if (process?.versions?.node) {\n      const events = await import(\"node:events\");\n      // biome-ignore lint/suspicious/noExplicitAny: node specific\n      (events as any).setMaxListeners(200);\n    }\n  }\n}\n","export class NotImplementedError extends Error {\n  constructor(symbol: string) {\n    super(`Not implemented: ${symbol}`);\n    this.name = \"NotImplementedError\";\n  }\n}\n","import type SovereignSDK from \"@sovereign-sdk/client\";\nimport type { Signer } from \"@sovereign-sdk/signers\";\nimport type { BaseTypeSpec } from \"@sovereign-sdk/web3\";\nimport { NotImplementedError } from \"./errors\";\n\n/** Response data type from a transaction submission */\nexport type TxResult = SovereignSDK.Sequencer.TxCreateResponse.Data;\n\n/**\n * Possible outcomes for a generated transaction.\n * Used to control whether the transaction should succeed or fail.\n */\nexport enum Outcome {\n  /** Transaction should be generated to succeed */\n  Success = 0,\n  /** Transaction should be generated to fail */\n  Failure = 1,\n}\n\n/**\n * Represents a generated transaction input with its associated metadata.\n * @template S - The type specification for the rollup being tested\n */\nexport type GeneratedInput<S extends BaseTypeSpec> = {\n  /** The unsigned transaction to be submitted */\n  unsignedTransaction: S[\"UnsignedTransaction\"];\n  /** The signer to use for signing the transaction */\n  signer: Signer;\n  /**\n   * Optional callback to be executed after the transaction is onSubmitted\n   * This function is passed the transaction receipt along with events and\n   * other result related data - it can be used to assert the output of the provided\n   * input.\n   */\n  onSubmitted?: (result: TxResult) => Promise<void>;\n};\n\n/**\n * Represents a generated transaction with its expected outcome.\n * This is returned by generator strategies to indicate both the transaction\n * and whether it should succeed or fail.\n */\nexport type InputWithExpectation<S extends BaseTypeSpec> = {\n  /** The generated transaction input */\n  input: GeneratedInput<S>;\n  /** The expected outcome of the transaction */\n  expectedOutcome: Outcome;\n};\n\n/**\n * Interface for generating individual test transactions.\n * Implementations should create transactions that can either succeed or fail\n * based on the provided outcome.\n *\n * @template S - The type specification for the rollup being tested\n *\n * @example\n * ```typescript\n * class CustomGenerator implements TransactionGenerator<YourTypeSpec> {\n *   async successful(): Promise<GeneratedInput<YourTypeSpec>> {\n *     // Generate transaction based on outcome\n *     return {\n *       unsignedTransaction: {},\n *       signer: {},\n *       onSubmitted: async (result) => {\n *         // Handle submission result\n *       }\n *     };\n *   }\n * }\n * ```\n */\nexport abstract class TransactionGenerator<S extends BaseTypeSpec> {\n  /**\n   * Generate a single test transaction that should succeed.\n   * @returns A promise that resolves to the generated transaction input\n   */\n  successful(): Promise<GeneratedInput<S>> {\n    throw new NotImplementedError(\"TransactionGenerator.successful\");\n  }\n\n  /**\n   * Generate a single test transaction that should fail.\n   * @returns A promise that resolves to the generated transaction input\n   */\n  failure(): Promise<GeneratedInput<S>> {\n    throw new NotImplementedError(\"TransactionGenerator.failure\");\n  }\n}\n\n/**\n * Interface for generating batches of test transactions.\n * Implementations should create multiple transactions according to the specified amount.\n *\n * @template S - The type specification for the rollup being tested\n */\nexport interface GeneratorStrategy<S extends BaseTypeSpec> {\n  /**\n   * Generates a batch of test transactions.\n   * @param amount - The number of transactions to generate\n   * @returns A promise that resolves to an array of generated transactions with their expected outcomes\n   */\n  generate(amount: number): Promise<InputWithExpectation<S>[]>;\n}\n\n/**\n * A basic implementation of GeneratorStrategy that generates a fixed number of\n * transactions that always succeed using a singular TransactionGenerator.\n *\n * @template S - The type specification for the rollup being tested\n *\n * @example\n * ```typescript\n * const generator = new YourTransactionGenerator();\n * const strategy = new BasicGeneratorStrategy(generator);\n * const transactions = await strategy.generate(100);\n * ```\n */\nexport class BasicGeneratorStrategy<S extends BaseTypeSpec>\n  implements GeneratorStrategy<S>\n{\n  private readonly generator: TransactionGenerator<S>;\n\n  /**\n   * Creates a new BasicGeneratorStrategy instance.\n   * @param generator - The transaction generator to use for creating individual transactions\n   */\n  constructor(generator: TransactionGenerator<S>) {\n    this.generator = generator;\n  }\n\n  /**\n   * Generates a batch of test transactions using the configured generator.\n   * All transactions are generated with Outcome.Success.\n   *\n   * @param amount - The number of transactions to generate\n   * @returns A promise that resolves to an array of generated transactions with their expected outcomes\n   */\n  async generate(amount: number): Promise<InputWithExpectation<S>[]> {\n    const promises = [];\n\n    for (let i = 0; i <= amount; i += 1) {\n      promises.push(this.generator.successful());\n    }\n\n    const inputs = await Promise.all(promises);\n    return inputs.map((input) => ({\n      input,\n      expectedOutcome: Outcome.Success,\n    }));\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,qBAAmB;AAsCZ,IAAM,aAAN,MAAyC;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9C,YAAY,EAAE,QAAQ,WAAW,YAAY,GAAmB;AAC9D,SAAK,aAAa,IAAI,gBAAgB;AACtC,SAAK,cAAc,oCAAe;AAClC,SAAK,QAAQ,IAAI,eAAAA,QAAO,EAAE,aAAa,KAAK,YAAY,CAAC;AACzD,SAAK,SAAS;AACd,SAAK,YAAY;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQM,MAAqB;AAAA;AACzB,YAAM,KAAK,mBAAmB;AAC9B,WAAK,YAAY;AAAA,IACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMM,OAAsB;AAAA;AAC1B,WAAK,WAAW,MAAM;AAAA,IACxB;AAAA;AAAA,EAEc,cAA6B;AAAA;AACzC,UAAI,KAAK,WAAW,OAAO,QAAS;AAIpC,YAAM,aAAa,IAAI,gBAAgB;AACvC,YAAM,SAAS,WAAW;AAC1B,WAAK,WAAW,OAAO,iBAAiB,SAAS,WAAW,OAAO;AAAA,QACjE,MAAM;AAAA,MACR,CAAC;AAED,YAAM,SAAS,MAAM,KAAK,UAAU,SAAS,GAAG;AAEhD,YAAM,YAAY,OAAO,IAAI,CAAC,EAAE,MAAM,MAAM;AAC1C,eAAO,MAAY;AACjB,cAAI,OAAO,QAAS;AAEpB,gBAAM,EAAE,QAAQ,qBAAqB,YAAY,IAAI;AAErD,gBAAM,EAAE,SAAS,IAAI,MAAM,KAAK,OAAO;AAAA,YACrC;AAAA,YACA,EAAE,OAAO;AAAA,YACT,EAAE,OAAO;AAAA,UACX;AAEA,cAAI,aAAa;AAEf,kBAAM,YAAY,SAAS,IAAI;AAAA,UACjC;AAAA,QACF;AAAA,MACF,CAAC;AAED,WAAK,MAAM,OAAO,SAAS;AAC3B,YAAM,KAAK,MAAM,eAAe,KAAK,WAAW;AAGhD,WAAK,WAAW,OAAO,oBAAoB,SAAS,WAAW,KAAK;AAEpE,iBAAW,MAAM,KAAK,YAAY,GAAG,GAAG;AAAA,IAC1C;AAAA;AAAA;AAAA;AAAA,EAIc,qBAAoC;AAAA;AAzHpD;AA0HI,WAAI,wCAAS,aAAT,mBAAmB,MAAM;AAC3B,cAAM,SAAS,MAAM,OAAO,QAAa;AAEzC,QAAC,OAAe,gBAAgB,GAAG;AAAA,MACrC;AAAA,IACF;AAAA;AACF;;;AChIO,IAAM,sBAAN,cAAkC,MAAM;AAAA,EAC7C,YAAY,QAAgB;AAC1B,UAAM,oBAAoB,MAAM,EAAE;AAClC,SAAK,OAAO;AAAA,EACd;AACF;;;ACOO,IAAK,UAAL,kBAAKC,aAAL;AAEL,EAAAA,kBAAA,aAAU,KAAV;AAEA,EAAAA,kBAAA,aAAU,KAAV;AAJU,SAAAA;AAAA,GAAA;AA4DL,IAAe,uBAAf,MAA4D;AAAA;AAAA;AAAA;AAAA;AAAA,EAKjE,aAAyC;AACvC,UAAM,IAAI,oBAAoB,iCAAiC;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAsC;AACpC,UAAM,IAAI,oBAAoB,8BAA8B;AAAA,EAC9D;AACF;AA8BO,IAAM,yBAAN,MAEP;AAAA;AAAA;AAAA;AAAA;AAAA,EAOE,YAAY,WAAoC;AAC9C,SAAK,YAAY;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASM,SAAS,QAAoD;AAAA;AACjE,YAAM,WAAW,CAAC;AAElB,eAAS,IAAI,GAAG,KAAK,QAAQ,KAAK,GAAG;AACnC,iBAAS,KAAK,KAAK,UAAU,WAAW,CAAC;AAAA,MAC3C;AAEA,YAAM,SAAS,MAAM,QAAQ,IAAI,QAAQ;AACzC,aAAO,OAAO,IAAI,CAAC,WAAW;AAAA,QAC5B;AAAA,QACA,iBAAiB;AAAA,MACnB,EAAE;AAAA,IACJ;AAAA;AACF;","names":["PQueue","Outcome"]}

package/dist/soak/index.mjs

@@ -0,0 +1,165 @@
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/soak/runner.ts
+import PQueue from "p-queue";
+var TestRunner = class {
+  /**
+   * Creates a new TestRunner instance.
+   * @param options - Configuration options for the test runner
+   */
+  constructor({ rollup, generator, concurrency }) {
+    this.controller = new AbortController();
+    this.concurrency = concurrency != null ? concurrency : 30;
+    this.queue = new PQueue({ concurrency: this.concurrency });
+    this.rollup = rollup;
+    this.generator = generator;
+  }
+  /**
+   * Starts the soak test. This will begin generating and submitting transactions
+   * according to the configured generator strategy and concurrency settings.
+   *
+   * The test will continue running until explicitly stopped using the stop() method.
+   */
+  run() {
+    return __async(this, null, function* () {
+      yield this.silenceNodeWarning();
+      this.doExecution();
+    });
+  }
+  /**
+   * Stops the soak test. This will abort any pending transactions and prevent
+   * new transactions from being generated.
+   */
+  stop() {
+    return __async(this, null, function* () {
+      this.controller.abort();
+    });
+  }
+  doExecution() {
+    return __async(this, null, function* () {
+      if (this.controller.signal.aborted) return;
+      const controller = new AbortController();
+      const signal = controller.signal;
+      this.controller.signal.addEventListener("abort", controller.abort, {
+        once: true
+      });
+      const inputs = yield this.generator.generate(100);
+      const execution = inputs.map(({ input }) => {
+        return () => __async(this, null, function* () {
+          if (signal.aborted) return;
+          const { signer, unsignedTransaction, onSubmitted } = input;
+          const { response } = yield this.rollup.signAndSubmitTransaction(
+            unsignedTransaction,
+            { signer },
+            { signal }
+          );
+          if (onSubmitted) {
+            yield onSubmitted(response.data);
+          }
+        });
+      });
+      this.queue.addAll(execution);
+      yield this.queue.onSizeLessThan(this.concurrency);
+      this.controller.signal.removeEventListener("abort", controller.abort);
+      setTimeout(() => this.doExecution(), 100);
+    });
+  }
+  // Node emits a warning if there's more than 10 listeners by default
+  // to try detect listener leaks. This is nodejs specific, we're OK to ignore it.
+  silenceNodeWarning() {
+    return __async(this, null, function* () {
+      var _a;
+      if ((_a = process == null ? void 0 : process.versions) == null ? void 0 : _a.node) {
+        const events = yield import("node:events");
+        events.setMaxListeners(200);
+      }
+    });
+  }
+};
+
+// src/soak/errors.ts
+var NotImplementedError = class extends Error {
+  constructor(symbol) {
+    super(`Not implemented: ${symbol}`);
+    this.name = "NotImplementedError";
+  }
+};
+
+// src/soak/generation.ts
+var Outcome = /* @__PURE__ */ ((Outcome2) => {
+  Outcome2[Outcome2["Success"] = 0] = "Success";
+  Outcome2[Outcome2["Failure"] = 1] = "Failure";
+  return Outcome2;
+})(Outcome || {});
+var TransactionGenerator = class {
+  /**
+   * Generate a single test transaction that should succeed.
+   * @returns A promise that resolves to the generated transaction input
+   */
+  successful() {
+    throw new NotImplementedError("TransactionGenerator.successful");
+  }
+  /**
+   * Generate a single test transaction that should fail.
+   * @returns A promise that resolves to the generated transaction input
+   */
+  failure() {
+    throw new NotImplementedError("TransactionGenerator.failure");
+  }
+};
+var BasicGeneratorStrategy = class {
+  /**
+   * Creates a new BasicGeneratorStrategy instance.
+   * @param generator - The transaction generator to use for creating individual transactions
+   */
+  constructor(generator) {
+    this.generator = generator;
+  }
+  /**
+   * Generates a batch of test transactions using the configured generator.
+   * All transactions are generated with Outcome.Success.
+   *
+   * @param amount - The number of transactions to generate
+   * @returns A promise that resolves to an array of generated transactions with their expected outcomes
+   */
+  generate(amount) {
+    return __async(this, null, function* () {
+      const promises = [];
+      for (let i = 0; i <= amount; i += 1) {
+        promises.push(this.generator.successful());
+      }
+      const inputs = yield Promise.all(promises);
+      return inputs.map((input) => ({
+        input,
+        expectedOutcome: 0 /* Success */
+      }));
+    });
+  }
+};
+export {
+  BasicGeneratorStrategy,
+  NotImplementedError,
+  Outcome,
+  TestRunner,
+  TransactionGenerator
+};
+//# sourceMappingURL=index.mjs.map

package/dist/soak/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/soak/runner.ts","../../src/soak/errors.ts","../../src/soak/generation.ts"],"sourcesContent":["import type { BaseTypeSpec, Rollup } from \"@sovereign-sdk/web3\";\nimport PQueue from \"p-queue\";\nimport type { GeneratorStrategy } from \"./generation\";\n\n/**\n * Configuration options for creating a new TestRunner instance.\n * @template S - The type specification for the rollup being tested\n */\nexport interface TestOptions<S extends BaseTypeSpec> {\n  /** Maximum number of concurrent transactions to run (default: 30) */\n  concurrency?: number;\n  /** Strategy for generating test transactions */\n  generator: GeneratorStrategy<S>;\n  /** The rollup instance to test against */\n  // biome-ignore lint/suspicious/noExplicitAny: generic not need\n  rollup: Rollup<S, any>;\n}\n\n/**\n * A class for running soak tests against a Sovereign rollup.\n * Manages concurrent transaction execution and provides control over test execution.\n *\n * @template S - The type specification for the rollup being tested\n *\n * @example\n * ```typescript\n * const runner = new TestRunner({\n *   rollup: new YourRollup(),\n *   generator: new YourGeneratorStrategy(),\n *   concurrency: 30\n * });\n *\n * // Start the test\n * await runner.run();\n *\n * // Stop the test when needed\n * await runner.stop();\n * ```\n */\nexport class TestRunner<S extends BaseTypeSpec> {\n  private controller: AbortController;\n  private readonly concurrency: number;\n  private readonly queue: PQueue;\n  // biome-ignore lint/suspicious/noExplicitAny: generic not need\n  private readonly rollup: Rollup<S, any>;\n  private readonly generator: GeneratorStrategy<S>;\n\n  /**\n   * Creates a new TestRunner instance.\n   * @param options - Configuration options for the test runner\n   */\n  constructor({ rollup, generator, concurrency }: TestOptions<S>) {\n    this.controller = new AbortController();\n    this.concurrency = concurrency ?? 30;\n    this.queue = new PQueue({ concurrency: this.concurrency });\n    this.rollup = rollup;\n    this.generator = generator;\n  }\n\n  /**\n   * Starts the soak test. This will begin generating and submitting transactions\n   * according to the configured generator strategy and concurrency settings.\n   *\n   * The test will continue running until explicitly stopped using the stop() method.\n   */\n  async run(): Promise<void> {\n    await this.silenceNodeWarning();\n    this.doExecution();\n  }\n\n  /**\n   * Stops the soak test. This will abort any pending transactions and prevent\n   * new transactions from being generated.\n   */\n  async stop(): Promise<void> {\n    this.controller.abort();\n  }\n\n  private async doExecution(): Promise<void> {\n    if (this.controller.signal.aborted) return;\n\n    // create a child abort signal per batch because there's no way\n    // to clean up abort listeners, this prevents them building up and leaking\n    const controller = new AbortController();\n    const signal = controller.signal;\n    this.controller.signal.addEventListener(\"abort\", controller.abort, {\n      once: true,\n    });\n\n    const inputs = await this.generator.generate(100);\n    // TODO: check expectedOutcome with what the rollup actually returns\n    const execution = inputs.map(({ input }) => {\n      return async () => {\n        if (signal.aborted) return;\n\n        const { signer, unsignedTransaction, onSubmitted } = input;\n        // TODO: handle abort error\n        const { response } = await this.rollup.signAndSubmitTransaction(\n          unsignedTransaction,\n          { signer },\n          { signal },\n        );\n\n        if (onSubmitted) {\n          // TODO: handle errors\n          await onSubmitted(response.data);\n        }\n      };\n    });\n\n    this.queue.addAll(execution);\n    await this.queue.onSizeLessThan(this.concurrency);\n\n    // clean-up listener to prevent listener leak on top-level abort controller\n    this.controller.signal.removeEventListener(\"abort\", controller.abort);\n\n    setTimeout(() => this.doExecution(), 100);\n  }\n\n  // Node emits a warning if there's more than 10 listeners by default\n  // to try detect listener leaks. This is nodejs specific, we're OK to ignore it.\n  private async silenceNodeWarning(): Promise<void> {\n    if (process?.versions?.node) {\n      const events = await import(\"node:events\");\n      // biome-ignore lint/suspicious/noExplicitAny: node specific\n      (events as any).setMaxListeners(200);\n    }\n  }\n}\n","export class NotImplementedError extends Error {\n  constructor(symbol: string) {\n    super(`Not implemented: ${symbol}`);\n    this.name = \"NotImplementedError\";\n  }\n}\n","import type SovereignSDK from \"@sovereign-sdk/client\";\nimport type { Signer } from \"@sovereign-sdk/signers\";\nimport type { BaseTypeSpec } from \"@sovereign-sdk/web3\";\nimport { NotImplementedError } from \"./errors\";\n\n/** Response data type from a transaction submission */\nexport type TxResult = SovereignSDK.Sequencer.TxCreateResponse.Data;\n\n/**\n * Possible outcomes for a generated transaction.\n * Used to control whether the transaction should succeed or fail.\n */\nexport enum Outcome {\n  /** Transaction should be generated to succeed */\n  Success = 0,\n  /** Transaction should be generated to fail */\n  Failure = 1,\n}\n\n/**\n * Represents a generated transaction input with its associated metadata.\n * @template S - The type specification for the rollup being tested\n */\nexport type GeneratedInput<S extends BaseTypeSpec> = {\n  /** The unsigned transaction to be submitted */\n  unsignedTransaction: S[\"UnsignedTransaction\"];\n  /** The signer to use for signing the transaction */\n  signer: Signer;\n  /**\n   * Optional callback to be executed after the transaction is onSubmitted\n   * This function is passed the transaction receipt along with events and\n   * other result related data - it can be used to assert the output of the provided\n   * input.\n   */\n  onSubmitted?: (result: TxResult) => Promise<void>;\n};\n\n/**\n * Represents a generated transaction with its expected outcome.\n * This is returned by generator strategies to indicate both the transaction\n * and whether it should succeed or fail.\n */\nexport type InputWithExpectation<S extends BaseTypeSpec> = {\n  /** The generated transaction input */\n  input: GeneratedInput<S>;\n  /** The expected outcome of the transaction */\n  expectedOutcome: Outcome;\n};\n\n/**\n * Interface for generating individual test transactions.\n * Implementations should create transactions that can either succeed or fail\n * based on the provided outcome.\n *\n * @template S - The type specification for the rollup being tested\n *\n * @example\n * ```typescript\n * class CustomGenerator implements TransactionGenerator<YourTypeSpec> {\n *   async successful(): Promise<GeneratedInput<YourTypeSpec>> {\n *     // Generate transaction based on outcome\n *     return {\n *       unsignedTransaction: {},\n *       signer: {},\n *       onSubmitted: async (result) => {\n *         // Handle submission result\n *       }\n *     };\n *   }\n * }\n * ```\n */\nexport abstract class TransactionGenerator<S extends BaseTypeSpec> {\n  /**\n   * Generate a single test transaction that should succeed.\n   * @returns A promise that resolves to the generated transaction input\n   */\n  successful(): Promise<GeneratedInput<S>> {\n    throw new NotImplementedError(\"TransactionGenerator.successful\");\n  }\n\n  /**\n   * Generate a single test transaction that should fail.\n   * @returns A promise that resolves to the generated transaction input\n   */\n  failure(): Promise<GeneratedInput<S>> {\n    throw new NotImplementedError(\"TransactionGenerator.failure\");\n  }\n}\n\n/**\n * Interface for generating batches of test transactions.\n * Implementations should create multiple transactions according to the specified amount.\n *\n * @template S - The type specification for the rollup being tested\n */\nexport interface GeneratorStrategy<S extends BaseTypeSpec> {\n  /**\n   * Generates a batch of test transactions.\n   * @param amount - The number of transactions to generate\n   * @returns A promise that resolves to an array of generated transactions with their expected outcomes\n   */\n  generate(amount: number): Promise<InputWithExpectation<S>[]>;\n}\n\n/**\n * A basic implementation of GeneratorStrategy that generates a fixed number of\n * transactions that always succeed using a singular TransactionGenerator.\n *\n * @template S - The type specification for the rollup being tested\n *\n * @example\n * ```typescript\n * const generator = new YourTransactionGenerator();\n * const strategy = new BasicGeneratorStrategy(generator);\n * const transactions = await strategy.generate(100);\n * ```\n */\nexport class BasicGeneratorStrategy<S extends BaseTypeSpec>\n  implements GeneratorStrategy<S>\n{\n  private readonly generator: TransactionGenerator<S>;\n\n  /**\n   * Creates a new BasicGeneratorStrategy instance.\n   * @param generator - The transaction generator to use for creating individual transactions\n   */\n  constructor(generator: TransactionGenerator<S>) {\n    this.generator = generator;\n  }\n\n  /**\n   * Generates a batch of test transactions using the configured generator.\n   * All transactions are generated with Outcome.Success.\n   *\n   * @param amount - The number of transactions to generate\n   * @returns A promise that resolves to an array of generated transactions with their expected outcomes\n   */\n  async generate(amount: number): Promise<InputWithExpectation<S>[]> {\n    const promises = [];\n\n    for (let i = 0; i <= amount; i += 1) {\n      promises.push(this.generator.successful());\n    }\n\n    const inputs = await Promise.all(promises);\n    return inputs.map((input) => ({\n      input,\n      expectedOutcome: Outcome.Success,\n    }));\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,YAAY;AAsCZ,IAAM,aAAN,MAAyC;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9C,YAAY,EAAE,QAAQ,WAAW,YAAY,GAAmB;AAC9D,SAAK,aAAa,IAAI,gBAAgB;AACtC,SAAK,cAAc,oCAAe;AAClC,SAAK,QAAQ,IAAI,OAAO,EAAE,aAAa,KAAK,YAAY,CAAC;AACzD,SAAK,SAAS;AACd,SAAK,YAAY;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQM,MAAqB;AAAA;AACzB,YAAM,KAAK,mBAAmB;AAC9B,WAAK,YAAY;AAAA,IACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMM,OAAsB;AAAA;AAC1B,WAAK,WAAW,MAAM;AAAA,IACxB;AAAA;AAAA,EAEc,cAA6B;AAAA;AACzC,UAAI,KAAK,WAAW,OAAO,QAAS;AAIpC,YAAM,aAAa,IAAI,gBAAgB;AACvC,YAAM,SAAS,WAAW;AAC1B,WAAK,WAAW,OAAO,iBAAiB,SAAS,WAAW,OAAO;AAAA,QACjE,MAAM;AAAA,MACR,CAAC;AAED,YAAM,SAAS,MAAM,KAAK,UAAU,SAAS,GAAG;AAEhD,YAAM,YAAY,OAAO,IAAI,CAAC,EAAE,MAAM,MAAM;AAC1C,eAAO,MAAY;AACjB,cAAI,OAAO,QAAS;AAEpB,gBAAM,EAAE,QAAQ,qBAAqB,YAAY,IAAI;AAErD,gBAAM,EAAE,SAAS,IAAI,MAAM,KAAK,OAAO;AAAA,YACrC;AAAA,YACA,EAAE,OAAO;AAAA,YACT,EAAE,OAAO;AAAA,UACX;AAEA,cAAI,aAAa;AAEf,kBAAM,YAAY,SAAS,IAAI;AAAA,UACjC;AAAA,QACF;AAAA,MACF,CAAC;AAED,WAAK,MAAM,OAAO,SAAS;AAC3B,YAAM,KAAK,MAAM,eAAe,KAAK,WAAW;AAGhD,WAAK,WAAW,OAAO,oBAAoB,SAAS,WAAW,KAAK;AAEpE,iBAAW,MAAM,KAAK,YAAY,GAAG,GAAG;AAAA,IAC1C;AAAA;AAAA;AAAA;AAAA,EAIc,qBAAoC;AAAA;AAzHpD;AA0HI,WAAI,wCAAS,aAAT,mBAAmB,MAAM;AAC3B,cAAM,SAAS,MAAM,OAAO,aAAa;AAEzC,QAAC,OAAe,gBAAgB,GAAG;AAAA,MACrC;AAAA,IACF;AAAA;AACF;;;AChIO,IAAM,sBAAN,cAAkC,MAAM;AAAA,EAC7C,YAAY,QAAgB;AAC1B,UAAM,oBAAoB,MAAM,EAAE;AAClC,SAAK,OAAO;AAAA,EACd;AACF;;;ACOO,IAAK,UAAL,kBAAKA,aAAL;AAEL,EAAAA,kBAAA,aAAU,KAAV;AAEA,EAAAA,kBAAA,aAAU,KAAV;AAJU,SAAAA;AAAA,GAAA;AA4DL,IAAe,uBAAf,MAA4D;AAAA;AAAA;AAAA;AAAA;AAAA,EAKjE,aAAyC;AACvC,UAAM,IAAI,oBAAoB,iCAAiC;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAsC;AACpC,UAAM,IAAI,oBAAoB,8BAA8B;AAAA,EAC9D;AACF;AA8BO,IAAM,yBAAN,MAEP;AAAA;AAAA;AAAA;AAAA;AAAA,EAOE,YAAY,WAAoC;AAC9C,SAAK,YAAY;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASM,SAAS,QAAoD;AAAA;AACjE,YAAM,WAAW,CAAC;AAElB,eAAS,IAAI,GAAG,KAAK,QAAQ,KAAK,GAAG;AACnC,iBAAS,KAAK,KAAK,UAAU,WAAW,CAAC;AAAA,MAC3C;AAEA,YAAM,SAAS,MAAM,QAAQ,IAAI,QAAQ;AACzC,aAAO,OAAO,IAAI,CAAC,WAAW;AAAA,QAC5B;AAAA,QACA,iBAAiB;AAAA,MACnB,EAAE;AAAA,IACJ;AAAA;AACF;","names":["Outcome"]}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@sovereign-sdk/test",
+  "version": "0.1.1",
+  "description": "",
+  "repository": "github:Sovereign-Labs/sovereign-sdk-web3-js",
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "exports": {
+    "./soak": {
+      "types": "./dist/soak/index.d.ts",
+      "require": "./dist/soak/index.js",
+      "import": "./dist/soak/index.mjs"
+    }
+  },
+  "dependencies": {
+    "@sovereign-sdk/client": "0.1.0-alpha.32",
+    "p-queue": "^8.1.0",
+    "@sovereign-sdk/signers": "^0.0.4",
+    "@sovereign-sdk/web3": "^0.4.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "vitest": "^3.0.5"
+  },
+  "scripts": {
+    "build": "pnpm typecheck && tsup",
+    "ci": "biome ci",
+    "fix": "biome check --write",
+    "lint": "biome lint",
+    "typecheck": "tsc --noEmit"
+  }
+}