@aptos-labs/ts-sdk 4.0.0-zeta.0 → 5.0.0

package/dist/esm/chunk-P6RWWRGG.mjs

@@ -1,440 +0,0 @@
-import {
-  Serializable
-} from "./chunk-FJJ3KCPC.mjs";
-import {
-  ParsingError
-} from "./chunk-QPT4BSAB.mjs";
-
-// src/core/accountAddress.ts
-import { bytesToHex, hexToBytes } from "@noble/hashes/utils";
-var AddressInvalidReason = /* @__PURE__ */ ((AddressInvalidReason2) => {
-  AddressInvalidReason2["INCORRECT_NUMBER_OF_BYTES"] = "incorrect_number_of_bytes";
-  AddressInvalidReason2["INVALID_HEX_CHARS"] = "invalid_hex_chars";
-  AddressInvalidReason2["TOO_SHORT"] = "too_short";
-  AddressInvalidReason2["TOO_LONG"] = "too_long";
-  AddressInvalidReason2["LEADING_ZERO_X_REQUIRED"] = "leading_zero_x_required";
-  AddressInvalidReason2["LONG_FORM_REQUIRED_UNLESS_SPECIAL"] = "long_form_required_unless_special";
-  AddressInvalidReason2["INVALID_PADDING_ZEROES"] = "INVALID_PADDING_ZEROES";
-  AddressInvalidReason2["INVALID_PADDING_STRICTNESS"] = "INVALID_PADDING_STRICTNESS";
-  return AddressInvalidReason2;
-})(AddressInvalidReason || {});
-var _AccountAddress = class _AccountAddress extends Serializable {
-  /**
-   * Creates an instance of AccountAddress from a Uint8Array.
-   *
-   * This function ensures that the input data is exactly 32 bytes long, which is required for a valid account address.
-   *
-   * @param input A Uint8Array representing an account address.
-   * @throws ParsingError if the input length is not equal to 32 bytes.
-   * @group Implementation
-   * @category Serialization
-   */
-  constructor(input) {
-    super();
-    if (input.length !== _AccountAddress.LENGTH) {
-      throw new ParsingError(
-        "AccountAddress data should be exactly 32 bytes long",
-        "incorrect_number_of_bytes" /* INCORRECT_NUMBER_OF_BYTES */
-      );
-    }
-    this.data = input;
-  }
-  /**
-   * Determines if the address is classified as special, which is defined as 0x0 to 0xf inclusive.
-   * In other words, the last byte of the address must be < 0b10000 (16)
-   * and every other byte must be zero.
-   *
-   * For more information on how special addresses are defined, see AIP-40:
-   * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
-   *
-   * @returns true if the address is special, false otherwise.
-   * @group Implementation
-   * @category Serialization
-   */
-  isSpecial() {
-    return this.data.slice(0, this.data.length - 1).every((byte) => byte === 0) && this.data[this.data.length - 1] < 16;
-  }
-  // ===
-  // Methods for representing an instance of AccountAddress as other types.
-  // ===
-  /**
-   * Return the AccountAddress as a string as per AIP-40.
-   * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
-   * This representation returns special addresses in SHORT form (0xf)
-   * and other addresses in LONG form (0x + 64 characters).
-   *
-   * @returns AccountAddress as a string conforming to AIP-40.
-   * @group Implementation
-   * @category Serialization
-   */
-  toString() {
-    return `0x${this.toStringWithoutPrefix()}`;
-  }
-  /**
-   * Return the AccountAddress as a string conforming to AIP-40 but without the leading 0x.
-   *
-   * NOTE: Prefer to use `toString` where possible.
-   *
-   * @returns AccountAddress as a string without the leading 0x.
-   * @group Implementation
-   * @category Serialization
-   */
-  toStringWithoutPrefix() {
-    let hex = bytesToHex(this.data);
-    if (this.isSpecial()) {
-      hex = hex[hex.length - 1];
-    }
-    return hex;
-  }
-  /**
-   * Convert the account address to a string in LONG format, which is always 0x followed by 64 hex characters.
-   *
-   * NOTE: Prefer to use `toString` where possible, as it formats special addresses using the SHORT form (no leading 0s).
-   *
-   * @returns AccountAddress as a string in LONG form.
-   * @group Implementation
-   * @category Serialization
-   */
-  toStringLong() {
-    return `0x${this.toStringLongWithoutPrefix()}`;
-  }
-  /**
-   * Returns the account address as a string in LONG form without a leading 0x.
-   * This function will include leading zeroes and will produce a string of 64 hex characters.
-   *
-   * NOTE: Prefer to use `toString` where possible, as it formats special addresses using the SHORT form (no leading 0s).
-   *
-   * @returns {string} The account address in LONG form.
-   * @group Implementation
-   * @category Serialization
-   */
-  toStringLongWithoutPrefix() {
-    return bytesToHex(this.data);
-  }
-  /**
-   * Convert the account address to a string in SHORT format, which is 0x followed by the shortest
-   * possible representation (no leading zeros).
-   *
-   * @returns AccountAddress as a string in SHORT form.
-   * @group Implementation
-   * @category Serialization
-   */
-  toStringShort() {
-    return `0x${this.toStringShortWithoutPrefix()}`;
-  }
-  /**
-   * Returns a lossless short string representation of the address by trimming leading zeros.
-   * If the address consists of all zeros, returns "0".
-   *
-   * @returns A string representation of the address without leading zeros
-   * @group Implementation
-   * @category Serialization
-   */
-  toStringShortWithoutPrefix() {
-    const hex = bytesToHex(this.data).replace(/^0+/, "");
-    return hex === "" ? "0" : hex;
-  }
-  /**
-   * Get the inner data as a Uint8Array.
-   * The inner data is already a Uint8Array, so no conversion takes place.
-   *
-   * @returns Hex data as Uint8Array
-   * @group Implementation
-   * @category Serialization
-   */
-  toUint8Array() {
-    return this.data;
-  }
-  /**
-   * Serialize the AccountAddress to a Serializer instance's data buffer.
-   * @param serializer The serializer to serialize the AccountAddress to.
-   * @returns void
-   * @example
-   * const serializer = new Serializer();
-   * const address = AccountAddress.fromString("0x1");
-   * address.serialize(serializer);
-   * const bytes = serializer.toUint8Array();
-   * // `bytes` is now the BCS-serialized address.
-   * @group Implementation
-   * @category Serialization
-   */
-  serialize(serializer) {
-    serializer.serializeFixedBytes(this.data);
-  }
-  /**
-   * Serializes the current instance into a byte sequence suitable for entry functions.
-   * This allows for the proper encoding of data when interacting with entry functions in the blockchain.
-   *
-   * @param serializer - The serializer instance used to convert the data into bytes.
-   * @group Implementation
-   * @category Serialization
-   */
-  serializeForEntryFunction(serializer) {
-    const bcsBytes = this.bcsToBytes();
-    serializer.serializeBytes(bcsBytes);
-  }
-  /**
-   * Serializes the current instance for use in a script function by encoding it into a byte sequence.
-   * This process involves serializing the variant index and the instance data, making it suitable for transmission.
-   *
-   * @param serializer - The serializer instance used to perform the serialization.
-   * @group Implementation
-   * @category Serialization
-   */
-  serializeForScriptFunction(serializer) {
-    serializer.serializeU32AsUleb128(3 /* Address */);
-    serializer.serialize(this);
-  }
-  /**
-   * Deserialize an AccountAddress from the byte buffer in a Deserializer instance.
-   * This function allows you to convert a byte representation of an AccountAddress into an instance of AccountAddress.
-   * @param deserializer The deserializer to deserialize the AccountAddress from.
-   * @returns An instance of AccountAddress.
-   * @example
-   * const bytes = hexToBytes("0x0102030405060708091011121314151617181920212223242526272829303132");
-   * const deserializer = new Deserializer(bytes);
-   * const address = AccountAddress.deserialize(deserializer);
-   * // `address` is now an instance of AccountAddress.
-   * @group Implementation
-   * @category Serialization
-   */
-  static deserialize(deserializer) {
-    const bytes = deserializer.deserializeFixedBytes(_AccountAddress.LENGTH);
-    return new _AccountAddress(bytes);
-  }
-  // ===
-  // Methods for creating an instance of AccountAddress from other types.
-  // ===
-  /**
-   * NOTE: This function has strict parsing behavior. For relaxed behavior, please use
-   * the `fromString` function.
-   *
-   * Creates an instance of AccountAddress from a hex string.
-   *
-   * This function allows only the strictest formats defined by AIP-40. In short this
-   * means only the following formats are accepted:
-   *
-   * - LONG
-   * - SHORT for special addresses
-   *
-   * Where:
-   * - LONG is defined as 0x + 64 hex characters.
-   * - SHORT for special addresses is 0x0 to 0xf inclusive without padding zeroes.
-   *
-   * This means the following are not accepted:
-   * - SHORT for non-special addresses.
-   * - Any address without a leading 0x.
-   *
-   * @param input - A hex string representing an account address.
-   *
-   * @throws {ParsingError} If the hex string does not start with 0x or is not in a valid format.
-   *
-   * @remarks
-   *
-   * This function has strict parsing behavior. For relaxed behavior, please use the `fromString` function.
-   *
-   * @see AIP-40 documentation for more details on address formats:
-   * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
-   *
-   * @returns An instance of AccountAddress.
-   * @group Implementation
-   * @category Serialization
-   */
-  static fromStringStrict(input) {
-    if (!input.startsWith("0x")) {
-      throw new ParsingError("Hex string must start with a leading 0x.", "leading_zero_x_required" /* LEADING_ZERO_X_REQUIRED */);
-    }
-    const address = _AccountAddress.fromString(input);
-    if (input.length !== _AccountAddress.LONG_STRING_LENGTH + 2) {
-      if (!address.isSpecial()) {
-        throw new ParsingError(
-          `The given hex string ${input} is not a special address, it must be represented as 0x + 64 chars.`,
-          "long_form_required_unless_special" /* LONG_FORM_REQUIRED_UNLESS_SPECIAL */
-        );
-      } else if (input.length !== 3) {
-        throw new ParsingError(
-          // eslint-disable-next-line max-len
-          `The given hex string ${input} is a special address not in LONG form, it must be 0x0 to 0xf without padding zeroes.`,
-          "INVALID_PADDING_ZEROES" /* INVALID_PADDING_ZEROES */
-        );
-      }
-    }
-    return address;
-  }
-  /**
-   * NOTE: This function has relaxed parsing behavior. For strict behavior, please use
-   * the `fromStringStrict` function. Where possible use `fromStringStrict` rather than this
-   * function, `fromString`.
-   *
-   * Creates an instance of AccountAddress from a hex string.
-   *
-   * This function allows all formats defined by AIP-40. In short this means the
-   * following formats are accepted:
-   *
-   * - LONG, with or without leading 0x
-   * - SHORT*, with or without leading 0x
-   *
-   * Where:
-   * - LONG is 64 hex characters.
-   * - SHORT* is 1 to 63 hex characters inclusive. The address can have missing values up to `maxMissingChars` before it is padded.
-   * - Padding zeroes are allowed, e.g. 0x0123 is valid.
-   *
-   * Learn more about the different address formats by reading AIP-40:
-   * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
-   *
-   * @param input A hex string representing an account address.
-   * @param args.maxMissingChars The number of characters that can be missing in a padded address before it is invalid.
-   *
-   * @returns An instance of AccountAddress.
-   *
-   * @throws ParsingError if the hex string is too short, too long, or contains invalid characters.
-   * @group Implementation
-   * @category Serialization
-   */
-  static fromString(input, { maxMissingChars = 4 } = {}) {
-    let parsedInput = input;
-    if (input.startsWith("0x")) {
-      parsedInput = input.slice(2);
-    }
-    if (parsedInput.length === 0) {
-      throw new ParsingError(
-        "Hex string is too short, must be 1 to 64 chars long, excluding the leading 0x.",
-        "too_short" /* TOO_SHORT */
-      );
-    }
-    if (parsedInput.length > 64) {
-      throw new ParsingError(
-        "Hex string is too long, must be 1 to 64 chars long, excluding the leading 0x.",
-        "too_long" /* TOO_LONG */
-      );
-    }
-    if (maxMissingChars > 63 || maxMissingChars < 0) {
-      throw new ParsingError(
-        `maxMissingChars must be between or equal to 0 and 63. Received ${maxMissingChars}`,
-        "INVALID_PADDING_STRICTNESS" /* INVALID_PADDING_STRICTNESS */
-      );
-    }
-    let addressBytes;
-    try {
-      addressBytes = hexToBytes(parsedInput.padStart(64, "0"));
-    } catch (error) {
-      throw new ParsingError(`Hex characters are invalid: ${error?.message}`, "invalid_hex_chars" /* INVALID_HEX_CHARS */);
-    }
-    const address = new _AccountAddress(addressBytes);
-    if (parsedInput.length < 64 - maxMissingChars) {
-      if (!address.isSpecial()) {
-        throw new ParsingError(
-          `Hex string is too short, must be ${64 - maxMissingChars} to 64 chars long, excluding the leading 0x. You may need to fix 
-the addresss by padding it with 0s before passing it to \`fromString\` (e.g. <addressString>.padStart(64, '0')). 
-Received ${input}`,
-          "too_short" /* TOO_SHORT */
-        );
-      }
-    }
-    return address;
-  }
-  /**
-   * Convenience method for creating an AccountAddress from various input types.
-   * This function accepts a string, Uint8Array, or an existing AccountAddress instance and returns the corresponding
-   * AccountAddress.
-   *
-   * @param input - The input to convert into an AccountAddress. This can be a string representation of an address, a Uint8Array,
-   * or an existing AccountAddress.
-   * @param args.maxMissingChars The number of characters that can be missing in a padded address before it is invalid.
-   * @group Implementation
-   * @category Serialization
-   */
-  static from(input, { maxMissingChars = 4 } = {}) {
-    if (typeof input === "string") {
-      return _AccountAddress.fromString(input, { maxMissingChars });
-    }
-    if (input instanceof Uint8Array) {
-      return new _AccountAddress(input);
-    }
-    return input;
-  }
-  /**
-   * Create an AccountAddress from various input types, including strings, Uint8Array, and AccountAddress instances.
-   *
-   * @param input - The input to convert into an AccountAddress, which can be a string, a Uint8Array, or an AccountAddress.
-   * @group Implementation
-   * @category Serialization
-   */
-  static fromStrict(input) {
-    if (typeof input === "string") {
-      return _AccountAddress.fromStringStrict(input);
-    }
-    if (input instanceof Uint8Array) {
-      return new _AccountAddress(input);
-    }
-    return input;
-  }
-  // ===
-  // Methods for checking validity.
-  // ===
-  /**
-   * Check if the provided input is a valid AccountAddress.
-   *
-   * @param args - The arguments for validation.
-   * @param args.input - A hex string representing an account address.
-   * @param args.strict - If true, use strict parsing behavior; if false, use relaxed parsing behavior.
-   *
-   * @returns An object indicating whether the address is valid. If valid, valid = true; if not, valid = false with additional details.
-   * If the address is invalid, invalidReason will explain why it is invalid, and invalidReasonMessage will provide the error message.
-   * @group Implementation
-   * @category Serialization
-   */
-  static isValid(args) {
-    try {
-      if (args.strict) {
-        _AccountAddress.fromStrict(args.input);
-      } else {
-        _AccountAddress.from(args.input);
-      }
-      return { valid: true };
-    } catch (error) {
-      return {
-        valid: false,
-        invalidReason: error?.invalidReason,
-        invalidReasonMessage: error?.message
-      };
-    }
-  }
-  /**
-   * Determine if two AccountAddresses are equal based on their underlying byte data.
-   *
-   * @param other - The AccountAddress to compare to.
-   * @returns true if the AccountAddresses are equal, false if not.
-   * @group Implementation
-   * @category Serialization
-   */
-  equals(other) {
-    if (this.data.length !== other.data.length) return false;
-    return this.data.every((value, index) => value === other.data[index]);
-  }
-};
-/**
- * The number of bytes that make up an account address.
- * @group Implementation
- * @category Serialization
- */
-_AccountAddress.LENGTH = 32;
-/**
- * The length of an address string in LONG form without a leading 0x.
- * @group Implementation
- * @category Serialization
- */
-_AccountAddress.LONG_STRING_LENGTH = 64;
-_AccountAddress.ZERO = _AccountAddress.from("0x0");
-_AccountAddress.ONE = _AccountAddress.from("0x1");
-_AccountAddress.TWO = _AccountAddress.from("0x2");
-_AccountAddress.THREE = _AccountAddress.from("0x3");
-_AccountAddress.FOUR = _AccountAddress.from("0x4");
-_AccountAddress.A = _AccountAddress.from("0xA");
-var AccountAddress = _AccountAddress;
-
-export {
-  AddressInvalidReason,
-  AccountAddress
-};
-//# sourceMappingURL=chunk-P6RWWRGG.mjs.map

package/dist/esm/chunk-PT2QHUB6.mjs

@@ -1,96 +0,0 @@
-// src/transactions/management/asyncQueue.ts
-var AsyncQueue = class {
-  constructor() {
-    this.queue = [];
-    // The pendingDequeue is used to handle the resolution of promises when items are enqueued and dequeued.
-    this.pendingDequeue = [];
-    this.cancelled = false;
-  }
-  /**
-   * Adds an item to the queue. If there are pending dequeued promises, it resolves the oldest promise with the enqueued item
-   * immediately; otherwise, it adds the item to the queue.
-   *
-   * @param item - The item to be added to the queue.
-   * @group Implementation
-   * @category Transactions
-   */
-  enqueue(item) {
-    this.cancelled = false;
-    if (this.pendingDequeue.length > 0) {
-      const promise = this.pendingDequeue.shift();
-      promise?.resolve(item);
-      return;
-    }
-    this.queue.push(item);
-  }
-  /**
-   * Dequeues the next item from the queue and returns a promise that resolves to it.
-   * If the queue is empty, it creates a new promise that will be resolved when an item is enqueued.
-   *
-   * @returns Promise<T>
-   * @group Implementation
-   * @category Transactions
-   */
-  async dequeue() {
-    if (this.queue.length > 0) {
-      return Promise.resolve(this.queue.shift());
-    }
-    return new Promise((resolve, reject) => {
-      this.pendingDequeue.push({ resolve, reject });
-    });
-  }
-  /**
-   * Determine whether the queue is empty.
-   *
-   * @returns boolean - Returns true if the queue has no elements, otherwise false.
-   * @group Implementation
-   * @category Transactions
-   */
-  isEmpty() {
-    return this.queue.length === 0;
-  }
-  /**
-   * Cancels all pending promises in the queue and rejects them with an AsyncQueueCancelledError.
-   * This ensures that any awaiting code can handle the cancellation appropriately.
-   *
-   * @returns {void}
-   * @group Implementation
-   * @category Transactions
-   */
-  cancel() {
-    this.cancelled = true;
-    this.pendingDequeue.forEach(async ({ reject }) => {
-      reject(new AsyncQueueCancelledError("Task cancelled"));
-    });
-    this.pendingDequeue = [];
-    this.queue.length = 0;
-  }
-  /**
-   * Determine whether the queue has been cancelled.
-   *
-   * @returns boolean - Returns true if the queue is cancelled, otherwise false.
-   * @group Implementation
-   * @category Transactions
-   */
-  isCancelled() {
-    return this.cancelled;
-  }
-  /**
-   * Retrieve the length of the pending dequeue.
-   *
-   * @returns number - The number of items currently in the pending dequeue.
-   * @group Implementation
-   * @category Transactions
-   */
-  pendingDequeueLength() {
-    return this.pendingDequeue.length;
-  }
-};
-var AsyncQueueCancelledError = class extends Error {
-};
-
-export {
-  AsyncQueue,
-  AsyncQueueCancelledError
-};
-//# sourceMappingURL=chunk-PT2QHUB6.mjs.map

package/dist/esm/chunk-Q5W46UAQ.mjs

@@ -1,123 +0,0 @@
-import {
-  sleep
-} from "./chunk-SCWOUBOV.mjs";
-
-// src/cli/localNode.ts
-import { spawn } from "child_process";
-import kill from "tree-kill";
-import { platform } from "os";
-var LocalNode = class {
-  constructor(args) {
-    this.MAXIMUM_WAIT_TIME_SEC = 75;
-    this.READINESS_ENDPOINT = "http://127.0.0.1:8070/";
-    this.showStdout = true;
-    this.process = null;
-    this.showStdout = args?.showStdout ?? true;
-  }
-  /**
-   * Kills the current process and all its descendant processes.
-   *
-   * @returns {Promise<void>} A promise that resolves to true if the process was successfully killed.
-   * @throws {Error} If there is an error while attempting to kill the process.
-   * @group Implementation
-   * @category CLI
-   */
-  async stop() {
-    await new Promise((resolve, reject) => {
-      if (!this.process?.pid) return;
-      kill(this.process.pid, (err) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve(true);
-        }
-      });
-    });
-  }
-  /**
-   * Runs a localnet and waits for the process to be up.
-   * If the local node process is already running, it returns without starting the process.
-   *
-   * @returns {Promise<void>} A promise that resolves when the process is up.
-   * @group Implementation
-   * @category CLI
-   */
-  async run() {
-    const nodeIsUp = await this.checkIfProcessIsUp();
-    if (nodeIsUp) {
-      return;
-    }
-    this.start();
-    await this.waitUntilProcessIsUp();
-  }
-  /**
-   * Starts the localnet by running the Aptos node with the specified command-line arguments.
-   *
-   * @returns {void}
-   *
-   * @throws {Error} If there is an issue starting the localnet.
-   * @group Implementation
-   * @category CLI
-   */
-  start() {
-    const cliCommand = "npx";
-    const cliArgs = ["aptos", "node", "run-localnet", "--force-restart", "--assume-yes", "--with-indexer-api"];
-    const currentPlatform = platform();
-    const spawnConfig = {
-      env: { ...process.env, ENABLE_KEYLESS_DEFAULT: "1" },
-      ...currentPlatform === "win32" && { shell: true }
-    };
-    this.process = spawn(cliCommand, cliArgs, spawnConfig);
-    this.process.stdout?.on("data", (data) => {
-      const str = data.toString();
-      if (this.showStdout) {
-        console.log(str);
-      }
-    });
-  }
-  /**
-   * Waits for the localnet process to be operational within a specified maximum wait time.
-   * This function continuously checks if the process is up and will throw an error if it fails to start.
-   *
-   * @returns Promise<boolean> - Resolves to true if the process is up, otherwise throws an error.
-   * @group Implementation
-   * @category CLI
-   */
-  async waitUntilProcessIsUp() {
-    let operational = await this.checkIfProcessIsUp();
-    const start = Date.now() / 1e3;
-    let last = start;
-    while (!operational && start + this.MAXIMUM_WAIT_TIME_SEC > last) {
-      await sleep(1e3);
-      operational = await this.checkIfProcessIsUp();
-      last = Date.now() / 1e3;
-    }
-    if (!operational) {
-      throw new Error("Process failed to start");
-    }
-    return true;
-  }
-  /**
-   * Checks if the localnet is up by querying the readiness endpoint.
-   *
-   * @returns Promise<boolean> - A promise that resolves to true if the localnet is up, otherwise false.
-   * @group Implementation
-   * @category CLI
-   */
-  async checkIfProcessIsUp() {
-    try {
-      const data = await fetch(this.READINESS_ENDPOINT);
-      if (data.status === 200) {
-        return true;
-      }
-      return false;
-    } catch (err) {
-      return false;
-    }
-  }
-};
-
-export {
-  LocalNode
-};
-//# sourceMappingURL=chunk-Q5W46UAQ.mjs.map