quantumcoin 7.0.2 → 7.0.4

package/src/contract/index.d.ts

@@ -1,9 +1,9 @@
-declare const _exports: {
-    ContractFactory: typeof import("./contract-factory").ContractFactory;
-    BaseContract: typeof import("./contract").BaseContract;
-    Contract: typeof import("./contract").Contract;
-    ContractTransactionResponse: typeof import("./contract").ContractTransactionResponse;
-    ContractTransactionReceipt: typeof import("./contract").ContractTransactionReceipt;
-    EventLog: typeof import("./contract").EventLog;
-};
-export = _exports;
+declare const _exports: {
+    ContractFactory: typeof import("./contract-factory").ContractFactory;
+    BaseContract: typeof import("./contract").BaseContract;
+    Contract: typeof import("./contract").Contract;
+    ContractTransactionResponse: typeof import("./contract").ContractTransactionResponse;
+    ContractTransactionReceipt: typeof import("./contract").ContractTransactionReceipt;
+    EventLog: typeof import("./contract").EventLog;
+};
+export = _exports;

package/src/contract/index.js

@@ -1,9 +1,9 @@
-/**
- * @fileoverview Contract exports.
- */
-
-module.exports = {
-  ...require("./contract"),
-  ...require("./contract-factory"),
-};
-
+/**
+ * @fileoverview Contract exports.
+ */
+
+module.exports = {
+  ...require("./contract"),
+  ...require("./contract-factory"),
+};
+

package/src/errors/index.d.ts

@@ -1,92 +1,92 @@
-export type ErrorCode = "INVALID_ARGUMENT" | "NUMERIC_FAULT" | "BUFFER_OVERRUN" | "CALL_EXCEPTION" | "UNKNOWN_ERROR" | "NOT_IMPLEMENTED";
-/**
- * @fileoverview Error helpers and error classes.
- *
- * The QuantumCoin.js SDK follows ethers.js v6 error patterns:
- * - errors include a machine-readable `code`
- * - errors include `shortMessage`
- * - errors may include extra fields depending on the failure
- */
-/**
- * @typedef {"INVALID_ARGUMENT"|"NUMERIC_FAULT"|"BUFFER_OVERRUN"|"CALL_EXCEPTION"|"UNKNOWN_ERROR"|"NOT_IMPLEMENTED"} ErrorCode
- */
-/**
- * Returns true if the error matches the given code.
- * @param {any} error
- * @param {string} code
- * @returns {boolean}
- */
-export function isError(error: any, code: string): boolean;
-/**
- * Returns true if the error is a CALL_EXCEPTION.
- * @param {any} error
- * @returns {boolean}
- */
-export function isCallException(error: any): boolean;
-/**
- * Create an Error configured like ethers emits errors.
- *
- * @param {string} message
- * @param {ErrorCode} code
- * @param {Record<string, any>=} info
- * @returns {Error & { code: ErrorCode, shortMessage: string }}
- */
-export function makeError(message: string, code: ErrorCode, info?: Record<string, any> | undefined): Error & {
-    code: ErrorCode;
-    shortMessage: string;
-};
-/**
- * Assert a condition, throwing an ethers-style error otherwise.
- * @param {any} check
- * @param {string} message
- * @param {ErrorCode} code
- * @param {Record<string, any>=} info
- */
-export function assert(check: any, message: string, code: ErrorCode, info?: Record<string, any> | undefined): void;
-/**
- * Assert an argument constraint.
- * @param {any} check
- * @param {string} message
- * @param {string} name
- * @param {any} value
- */
-export function assertArgument(check: any, message: string, name: string, value: any): void;
-/**
- * Provider error.
- */
-export class ProviderError extends Error {
-    /**
-     * @param {string} message
-     * @param {Record<string, any>=} info
-     */
-    constructor(message: string, info?: Record<string, any> | undefined);
-    /** @type {ErrorCode} */
-    code: ErrorCode;
-    shortMessage: string;
-}
-/**
- * Transaction error.
- */
-export class TransactionError extends Error {
-    /**
-     * @param {string} message
-     * @param {Record<string, any>=} info
-     */
-    constructor(message: string, info?: Record<string, any> | undefined);
-    /** @type {ErrorCode} */
-    code: ErrorCode;
-    shortMessage: string;
-}
-/**
- * Contract error.
- */
-export class ContractError extends Error {
-    /**
-     * @param {string} message
-     * @param {Record<string, any>=} info
-     */
-    constructor(message: string, info?: Record<string, any> | undefined);
-    /** @type {ErrorCode} */
-    code: ErrorCode;
-    shortMessage: string;
-}
+export type ErrorCode = "INVALID_ARGUMENT" | "NUMERIC_FAULT" | "BUFFER_OVERRUN" | "CALL_EXCEPTION" | "UNKNOWN_ERROR" | "NOT_IMPLEMENTED";
+/**
+ * @fileoverview Error helpers and error classes.
+ *
+ * The QuantumCoin.js SDK follows ethers.js v6 error patterns:
+ * - errors include a machine-readable `code`
+ * - errors include `shortMessage`
+ * - errors may include extra fields depending on the failure
+ */
+/**
+ * @typedef {"INVALID_ARGUMENT"|"NUMERIC_FAULT"|"BUFFER_OVERRUN"|"CALL_EXCEPTION"|"UNKNOWN_ERROR"|"NOT_IMPLEMENTED"} ErrorCode
+ */
+/**
+ * Returns true if the error matches the given code.
+ * @param {any} error
+ * @param {string} code
+ * @returns {boolean}
+ */
+export function isError(error: any, code: string): boolean;
+/**
+ * Returns true if the error is a CALL_EXCEPTION.
+ * @param {any} error
+ * @returns {boolean}
+ */
+export function isCallException(error: any): boolean;
+/**
+ * Create an Error configured like ethers emits errors.
+ *
+ * @param {string} message
+ * @param {ErrorCode} code
+ * @param {Record<string, any>=} info
+ * @returns {Error & { code: ErrorCode, shortMessage: string }}
+ */
+export function makeError(message: string, code: ErrorCode, info?: Record<string, any> | undefined): Error & {
+    code: ErrorCode;
+    shortMessage: string;
+};
+/**
+ * Assert a condition, throwing an ethers-style error otherwise.
+ * @param {any} check
+ * @param {string} message
+ * @param {ErrorCode} code
+ * @param {Record<string, any>=} info
+ */
+export function assert(check: any, message: string, code: ErrorCode, info?: Record<string, any> | undefined): void;
+/**
+ * Assert an argument constraint.
+ * @param {any} check
+ * @param {string} message
+ * @param {string} name
+ * @param {any} value
+ */
+export function assertArgument(check: any, message: string, name: string, value: any): void;
+/**
+ * Provider error.
+ */
+export class ProviderError extends Error {
+    /**
+     * @param {string} message
+     * @param {Record<string, any>=} info
+     */
+    constructor(message: string, info?: Record<string, any> | undefined);
+    /** @type {ErrorCode} */
+    code: ErrorCode;
+    shortMessage: string;
+}
+/**
+ * Transaction error.
+ */
+export class TransactionError extends Error {
+    /**
+     * @param {string} message
+     * @param {Record<string, any>=} info
+     */
+    constructor(message: string, info?: Record<string, any> | undefined);
+    /** @type {ErrorCode} */
+    code: ErrorCode;
+    shortMessage: string;
+}
+/**
+ * Contract error.
+ */
+export class ContractError extends Error {
+    /**
+     * @param {string} message
+     * @param {Record<string, any>=} info
+     */
+    constructor(message: string, info?: Record<string, any> | undefined);
+    /** @type {ErrorCode} */
+    code: ErrorCode;
+    shortMessage: string;
+}

package/src/errors/index.js

@@ -1,188 +1,188 @@
-/**
- * @fileoverview Error helpers and error classes.
- *
- * The QuantumCoin.js SDK follows ethers.js v6 error patterns:
- * - errors include a machine-readable `code`
- * - errors include `shortMessage`
- * - errors may include extra fields depending on the failure
- */
-
-/**
- * @typedef {"INVALID_ARGUMENT"|"NUMERIC_FAULT"|"BUFFER_OVERRUN"|"CALL_EXCEPTION"|"UNKNOWN_ERROR"|"NOT_IMPLEMENTED"} ErrorCode
- */
-
-/**
- * Returns true if the error matches the given code.
- * @param {any} error
- * @param {string} code
- * @returns {boolean}
- */
-function isError(error, code) {
-  return Boolean(error && typeof error === "object" && error.code === code);
-}
-
-/**
- * Returns true if the error is a CALL_EXCEPTION.
- * @param {any} error
- * @returns {boolean}
- */
-function isCallException(error) {
-  return isError(error, "CALL_EXCEPTION");
-}
-
-function _stringify(value, seen) {
-  if (value == null) return "null";
-  if (seen == null) seen = new Set();
-  if (typeof value === "object") {
-    if (seen.has(value)) return "[Circular]";
-    seen.add(value);
-  }
-  if (Array.isArray(value)) return "[ " + value.map((v) => _stringify(v, seen)).join(", ") + " ]";
-  if (value instanceof Uint8Array) return `Uint8Array(${value.length})`;
-  if (typeof value === "object" && typeof value.toJSON === "function") return _stringify(value.toJSON(), seen);
-  switch (typeof value) {
-    case "boolean":
-    case "number":
-    case "symbol":
-      return value.toString();
-    case "bigint":
-      return BigInt(value).toString();
-    case "string":
-      return JSON.stringify(value);
-    case "object": {
-      const keys = Object.keys(value).sort();
-      return "{ " + keys.map((k) => `${_stringify(k, seen)}: ${_stringify(value[k], seen)}`).join(", ") + " }";
-    }
-    default:
-      return `[ COULD NOT SERIALIZE ]`;
-  }
-}
-
-/**
- * Create an Error configured like ethers emits errors.
- *
- * @param {string} message
- * @param {ErrorCode} code
- * @param {Record<string, any>=} info
- * @returns {Error & { code: ErrorCode, shortMessage: string }}
- */
-function makeError(message, code, info) {
-  let shortMessage = message;
-
-  const details = [];
-  if (info) {
-    if ("message" in info || "code" in info || "name" in info) {
-      throw new Error(`value will overwrite populated values: ${_stringify(info)}`);
-    }
-    for (const key in info) {
-      if (key === "shortMessage") continue;
-      details.push(key + "=" + _stringify(info[key]));
-    }
-  }
-  details.push(`code=${code}`);
-  if (details.length) message += " (" + details.join(", ") + ")";
-
-  /** @type {any} */
-  let err;
-  switch (code) {
-    case "INVALID_ARGUMENT":
-      err = new TypeError(message);
-      break;
-    case "NUMERIC_FAULT":
-    case "BUFFER_OVERRUN":
-      err = new RangeError(message);
-      break;
-    default:
-      err = new Error(message);
-  }
-
-  Object.defineProperty(err, "code", { enumerable: true, value: code, writable: false });
-  Object.defineProperty(err, "shortMessage", { enumerable: true, value: shortMessage, writable: false });
-  if (info) Object.assign(err, info);
-  return err;
-}
-
-/**
- * Assert a condition, throwing an ethers-style error otherwise.
- * @param {any} check
- * @param {string} message
- * @param {ErrorCode} code
- * @param {Record<string, any>=} info
- */
-function assert(check, message, code, info) {
-  if (!check) throw makeError(message, code, info);
-}
-
-/**
- * Assert an argument constraint.
- * @param {any} check
- * @param {string} message
- * @param {string} name
- * @param {any} value
- */
-function assertArgument(check, message, name, value) {
-  assert(check, message, "INVALID_ARGUMENT", { argument: name, value });
-}
-
-/**
- * Provider error.
- */
-class ProviderError extends Error {
-  /**
-   * @param {string} message
-   * @param {Record<string, any>=} info
-   */
-  constructor(message, info) {
-    super(message);
-    /** @type {ErrorCode} */
-    this.code = "UNKNOWN_ERROR";
-    this.shortMessage = message;
-    if (info) Object.assign(this, info);
-  }
-}
-
-/**
- * Transaction error.
- */
-class TransactionError extends Error {
-  /**
-   * @param {string} message
-   * @param {Record<string, any>=} info
-   */
-  constructor(message, info) {
-    super(message);
-    /** @type {ErrorCode} */
-    this.code = "UNKNOWN_ERROR";
-    this.shortMessage = message;
-    if (info) Object.assign(this, info);
-  }
-}
-
-/**
- * Contract error.
- */
-class ContractError extends Error {
-  /**
-   * @param {string} message
-   * @param {Record<string, any>=} info
-   */
-  constructor(message, info) {
-    super(message);
-    /** @type {ErrorCode} */
-    this.code = "UNKNOWN_ERROR";
-    this.shortMessage = message;
-    if (info) Object.assign(this, info);
-  }
-}
-
-module.exports = {
-  isError,
-  isCallException,
-  makeError,
-  assert,
-  assertArgument,
-  ProviderError,
-  TransactionError,
-  ContractError,
-};
-
+/**
+ * @fileoverview Error helpers and error classes.
+ *
+ * The QuantumCoin.js SDK follows ethers.js v6 error patterns:
+ * - errors include a machine-readable `code`
+ * - errors include `shortMessage`
+ * - errors may include extra fields depending on the failure
+ */
+
+/**
+ * @typedef {"INVALID_ARGUMENT"|"NUMERIC_FAULT"|"BUFFER_OVERRUN"|"CALL_EXCEPTION"|"UNKNOWN_ERROR"|"NOT_IMPLEMENTED"} ErrorCode
+ */
+
+/**
+ * Returns true if the error matches the given code.
+ * @param {any} error
+ * @param {string} code
+ * @returns {boolean}
+ */
+function isError(error, code) {
+  return Boolean(error && typeof error === "object" && error.code === code);
+}
+
+/**
+ * Returns true if the error is a CALL_EXCEPTION.
+ * @param {any} error
+ * @returns {boolean}
+ */
+function isCallException(error) {
+  return isError(error, "CALL_EXCEPTION");
+}
+
+function _stringify(value, seen) {
+  if (value == null) return "null";
+  if (seen == null) seen = new Set();
+  if (typeof value === "object") {
+    if (seen.has(value)) return "[Circular]";
+    seen.add(value);
+  }
+  if (Array.isArray(value)) return "[ " + value.map((v) => _stringify(v, seen)).join(", ") + " ]";
+  if (value instanceof Uint8Array) return `Uint8Array(${value.length})`;
+  if (typeof value === "object" && typeof value.toJSON === "function") return _stringify(value.toJSON(), seen);
+  switch (typeof value) {
+    case "boolean":
+    case "number":
+    case "symbol":
+      return value.toString();
+    case "bigint":
+      return BigInt(value).toString();
+    case "string":
+      return JSON.stringify(value);
+    case "object": {
+      const keys = Object.keys(value).sort();
+      return "{ " + keys.map((k) => `${_stringify(k, seen)}: ${_stringify(value[k], seen)}`).join(", ") + " }";
+    }
+    default:
+      return `[ COULD NOT SERIALIZE ]`;
+  }
+}
+
+/**
+ * Create an Error configured like ethers emits errors.
+ *
+ * @param {string} message
+ * @param {ErrorCode} code
+ * @param {Record<string, any>=} info
+ * @returns {Error & { code: ErrorCode, shortMessage: string }}
+ */
+function makeError(message, code, info) {
+  let shortMessage = message;
+
+  const details = [];
+  if (info) {
+    if ("message" in info || "code" in info || "name" in info) {
+      throw new Error(`value will overwrite populated values: ${_stringify(info)}`);
+    }
+    for (const key in info) {
+      if (key === "shortMessage") continue;
+      details.push(key + "=" + _stringify(info[key]));
+    }
+  }
+  details.push(`code=${code}`);
+  if (details.length) message += " (" + details.join(", ") + ")";
+
+  /** @type {any} */
+  let err;
+  switch (code) {
+    case "INVALID_ARGUMENT":
+      err = new TypeError(message);
+      break;
+    case "NUMERIC_FAULT":
+    case "BUFFER_OVERRUN":
+      err = new RangeError(message);
+      break;
+    default:
+      err = new Error(message);
+  }
+
+  Object.defineProperty(err, "code", { enumerable: true, value: code, writable: false });
+  Object.defineProperty(err, "shortMessage", { enumerable: true, value: shortMessage, writable: false });
+  if (info) Object.assign(err, info);
+  return err;
+}
+
+/**
+ * Assert a condition, throwing an ethers-style error otherwise.
+ * @param {any} check
+ * @param {string} message
+ * @param {ErrorCode} code
+ * @param {Record<string, any>=} info
+ */
+function assert(check, message, code, info) {
+  if (!check) throw makeError(message, code, info);
+}
+
+/**
+ * Assert an argument constraint.
+ * @param {any} check
+ * @param {string} message
+ * @param {string} name
+ * @param {any} value
+ */
+function assertArgument(check, message, name, value) {
+  assert(check, message, "INVALID_ARGUMENT", { argument: name, value });
+}
+
+/**
+ * Provider error.
+ */
+class ProviderError extends Error {
+  /**
+   * @param {string} message
+   * @param {Record<string, any>=} info
+   */
+  constructor(message, info) {
+    super(message);
+    /** @type {ErrorCode} */
+    this.code = "UNKNOWN_ERROR";
+    this.shortMessage = message;
+    if (info) Object.assign(this, info);
+  }
+}
+
+/**
+ * Transaction error.
+ */
+class TransactionError extends Error {
+  /**
+   * @param {string} message
+   * @param {Record<string, any>=} info
+   */
+  constructor(message, info) {
+    super(message);
+    /** @type {ErrorCode} */
+    this.code = "UNKNOWN_ERROR";
+    this.shortMessage = message;
+    if (info) Object.assign(this, info);
+  }
+}
+
+/**
+ * Contract error.
+ */
+class ContractError extends Error {
+  /**
+   * @param {string} message
+   * @param {Record<string, any>=} info
+   */
+  constructor(message, info) {
+    super(message);
+    /** @type {ErrorCode} */
+    this.code = "UNKNOWN_ERROR";
+    this.shortMessage = message;
+    if (info) Object.assign(this, info);
+  }
+}
+
+module.exports = {
+  isError,
+  isCallException,
+  makeError,
+  assert,
+  assertArgument,
+  ProviderError,
+  TransactionError,
+  ContractError,
+};
+

package/src/generator/index.d.ts

@@ -0,0 +1,74 @@
+export type GenerateOptions = {
+    abiPath: string;
+    binPath: string;
+    outDir: string;
+    contractName: string;
+    packageName?: string | undefined;
+    createPackage?: boolean | undefined;
+    dependencies?: Record<string, string> | undefined;
+};
+/**
+ * Generate typed contract files.
+ * @param {GenerateOptions} opts
+ * @returns {{ contractFile: string, factoryFile: string, typesFile: string, indexFile: string }}
+ */
+export function generate(opts: GenerateOptions): {
+    contractFile: string;
+    factoryFile: string;
+    typesFile: string;
+    indexFile: string;
+};
+/**
+ * @typedef {Object} GenerateOptions
+ * @property {string} abiPath
+ * @property {string} binPath
+ * @property {string} outDir
+ * @property {string} contractName
+ * @property {string=} packageName
+ * @property {boolean=} createPackage
+ * @property {Record<string,string>=} dependencies
+ */
+/**
+ * Generate multiple typed contract files.
+ * @param {{ outDir: string, artifacts: Array<{ contractName: string, abi: any[], bytecode: string }> }} opts
+ * @returns {{ contracts: Array<{ contractFile: string, factoryFile: string }>, typesFile: string, indexFile: string }}
+ */
+export function generateFromArtifacts(opts: {
+    outDir: string;
+    artifacts: Array<{
+        contractName: string;
+        abi: any[];
+        bytecode: string;
+    }>;
+}): {
+    contracts: Array<{
+        contractFile: string;
+        factoryFile: string;
+    }>;
+    typesFile: string;
+    indexFile: string;
+};
+/**
+ * Generate a transactional e2e test file (JavaScript) for the typed contract package.
+ * The test deploys the contract with constructor args (if any) and invokes one write method.
+ *
+ * @param {{ contractName: string, abi: any[] }} opts
+ * @returns {string}
+ */
+export function generateTransactionalTestJs(opts: {
+    contractName: string;
+    abi: any[];
+}): string;
+/**
+ * Generate a single transactional e2e test that deploys and invokes methods on ALL contracts.
+ * Used when the package has multiple contracts so one test exercises every contract.
+ *
+ * @param {{ artifacts: Array<{ contractName: string, abi: any[] }> }} opts
+ * @returns {string}
+ */
+export function generateAllContractsTransactionalTestJs(opts: {
+    artifacts: Array<{
+        contractName: string;
+        abi: any[];
+    }>;
+}): string;