@aptos-labs/ts-sdk 1.35.0-zeta.2 → 1.36.0

package/dist/esm/chunk-NUT2VOX2.mjs

@@ -1,317 +0,0 @@
-import {
-  Hex
-} from "./chunk-BDM6FBUO.mjs";
-import {
-  MAX_U32_NUMBER
-} from "./chunk-SBB4YEPT.mjs";
-
-// src/bcs/deserializer.ts
-var Deserializer = class _Deserializer {
-  /**
-   * Creates a new instance of the class with a copy of the provided data buffer.
-   * This prevents outside mutation of the buffer.
-   *
-   * @param data - The data to be copied into the internal buffer as a Uint8Array.
-   * @group Implementation
-   * @category BCS
-   */
-  constructor(data) {
-    this.buffer = new ArrayBuffer(data.length);
-    new Uint8Array(this.buffer).set(data, 0);
-    this.offset = 0;
-  }
-  static fromHex(hex) {
-    const data = Hex.hexInputToUint8Array(hex);
-    return new _Deserializer(data);
-  }
-  /**
-   * Reads a specified number of bytes from the buffer and advances the offset.
-   *
-   * @param length - The number of bytes to read from the buffer.
-   * @throws Throws an error if the read operation exceeds the buffer's length.
-   * @group Implementation
-   * @category BCS
-   */
-  read(length) {
-    if (this.offset + length > this.buffer.byteLength) {
-      throw new Error("Reached to the end of buffer");
-    }
-    const bytes = this.buffer.slice(this.offset, this.offset + length);
-    this.offset += length;
-    return bytes;
-  }
-  /**
-   * Returns the number of bytes remaining in the buffer.
-   *
-   * This information is useful to determine if there's more data to be read.
-   *
-   * @returns The number of bytes remaining in the buffer.
-   * @group Implementation
-   * @category BCS
-   */
-  remaining() {
-    return this.buffer.byteLength - this.offset;
-  }
-  /**
-   * Deserializes a UTF-8 encoded string from a byte array. It first reads the length of the string in bytes,
-   * followed by the actual byte content, and decodes it into a string.
-   *
-   * BCS layout for "string": string_length | string_content
-   * where string_length is a u32 integer encoded as a uleb128 integer, equal to the number of bytes in string_content.
-   *
-   * @example
-   * ```typescript
-   * const deserializer = new Deserializer(new Uint8Array([8, 49, 50, 51, 52, 97, 98, 99, 100]));
-   * assert(deserializer.deserializeStr() === "1234abcd");
-   * ```
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeStr() {
-    const value = this.deserializeBytes();
-    const textDecoder = new TextDecoder();
-    return textDecoder.decode(value);
-  }
-  /**
-   * @deprecated use `deserializeOption("string")` instead.
-   *
-   * The BCS layout for Optional<String> is 0 if none, else 1 followed by the string length and string content.
-   * @returns The deserialized string if it exists, otherwise undefined.
-   * @example
-   * ```typescript
-   * const deserializer = new Deserializer(new Uint8Array([0x00]));
-   * assert(deserializer.deserializeOptionStr() === undefined);
-   * const deserializer = new Deserializer(new Uint8Array([1, 8, 49, 50, 51, 52, 97, 98, 99, 100]));
-   * assert(deserializer.deserializeOptionStr() === "1234abcd");
-   * ```
-   */
-  deserializeOptionStr() {
-    return this.deserializeOption("string");
-  }
-  deserializeOption(type, len) {
-    const exists = this.deserializeBool();
-    if (!exists) return void 0;
-    if (type === "string") {
-      return this.deserializeStr();
-    }
-    if (type === "bytes") {
-      return this.deserializeBytes();
-    }
-    if (type === "fixedBytes") {
-      if (len === void 0) {
-        throw new Error("Fixed bytes length not provided");
-      }
-      return this.deserializeFixedBytes(len);
-    }
-    return this.deserialize(type);
-  }
-  /**
-   * Deserializes an array of bytes.
-   *
-   * The BCS layout for "bytes" consists of a bytes_length followed by the bytes themselves, where bytes_length is a u32 integer
-   * encoded as a uleb128 integer, indicating the length of the bytes array.
-   *
-   * @returns {Uint8Array} The deserialized array of bytes.
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeBytes() {
-    const len = this.deserializeUleb128AsU32();
-    return new Uint8Array(this.read(len));
-  }
-  /**
-   * Deserializes an array of bytes of a specified length.
-   *
-   * @param len - The number of bytes to read from the source.
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeFixedBytes(len) {
-    return new Uint8Array(this.read(len));
-  }
-  /**
-   * Deserializes a boolean value from a byte stream.
-   *
-   * The BCS layout for a boolean uses one byte, where "0x01" represents true and "0x00" represents false.
-   * An error is thrown if the byte value is not valid.
-   *
-   * @returns The deserialized boolean value.
-   * @throws Throws an error if the boolean value is invalid.
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeBool() {
-    const bool = new Uint8Array(this.read(1))[0];
-    if (bool !== 1 && bool !== 0) {
-      throw new Error("Invalid boolean value");
-    }
-    return bool === 1;
-  }
-  /**
-   * Deserializes a uint8 number from the binary data.
-   *
-   * BCS layout for "uint8": One byte. Binary format in little-endian representation.
-   *
-   * @returns {number} The deserialized uint8 number.
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeU8() {
-    return new DataView(this.read(1)).getUint8(0);
-  }
-  /**
-   * Deserializes a uint16 number from a binary format in little-endian representation.
-   *
-   * BCS layout for "uint16": Two bytes.
-   * @example
-   * ```typescript
-   * const deserializer = new Deserializer(new Uint8Array([0x34, 0x12]));
-   * assert(deserializer.deserializeU16() === 4660);
-   * ```
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeU16() {
-    return new DataView(this.read(2)).getUint16(0, true);
-  }
-  /**
-   * Deserializes a uint32 number from a binary format in little-endian representation.
-   *
-   * BCS layout for "uint32": Four bytes.
-   * @example
-   * ```typescript
-   * const deserializer = new Deserializer(new Uint8Array([0x78, 0x56, 0x34, 0x12]));
-   * assert(deserializer.deserializeU32() === 305419896);
-   * ```
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeU32() {
-    return new DataView(this.read(4)).getUint32(0, true);
-  }
-  /**
-   * Deserializes a uint64 number.
-   *
-   * This function combines two 32-bit values to return a 64-bit unsigned integer in little-endian representation.
-   * @example
-   * ```typescript
-   * const deserializer = new Deserializer(new Uint8Array([0x00, 0xEF, 0xCD, 0xAB, 0x78, 0x56, 0x34, 0x12]));
-   * assert(deserializer.deserializeU64() === 1311768467750121216);
-   * ```
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeU64() {
-    const low = this.deserializeU32();
-    const high = this.deserializeU32();
-    return BigInt(BigInt(high) << BigInt(32) | BigInt(low));
-  }
-  /**
-   * Deserializes a uint128 number from its binary representation.
-   * This function combines two 64-bit values to return a single uint128 value in little-endian format.
-   *
-   * @returns {BigInt} The deserialized uint128 number.
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeU128() {
-    const low = this.deserializeU64();
-    const high = this.deserializeU64();
-    return BigInt(high << BigInt(64) | low);
-  }
-  /**
-   * Deserializes a uint256 number from its binary representation.
-   *
-   * The BCS layout for "uint256" consists of thirty-two bytes in little-endian format.
-   *
-   * @returns {BigInt} The deserialized uint256 number.
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeU256() {
-    const low = this.deserializeU128();
-    const high = this.deserializeU128();
-    return BigInt(high << BigInt(128) | low);
-  }
-  /**
-   * Deserializes a uleb128 encoded uint32 number.
-   *
-   * This function is used for interpreting lengths of variable-length sequences and tags of enum values in BCS encoding.
-   *
-   * @throws {Error} Throws an error if the parsed value exceeds the maximum uint32 number.
-   * @returns {number} The deserialized uint32 value.
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeUleb128AsU32() {
-    let value = BigInt(0);
-    let shift = 0;
-    while (value < MAX_U32_NUMBER) {
-      const byte = this.deserializeU8();
-      value |= BigInt(byte & 127) << BigInt(shift);
-      if ((byte & 128) === 0) {
-        break;
-      }
-      shift += 7;
-    }
-    if (value > MAX_U32_NUMBER) {
-      throw new Error("Overflow while parsing uleb128-encoded uint32 value");
-    }
-    return Number(value);
-  }
-  /**
-   * Helper function that primarily exists to support alternative syntax for deserialization.
-   * That is, if we have a `const deserializer: new Deserializer(...)`, instead of having to use
-   * `MyClass.deserialize(deserializer)`, we can call `deserializer.deserialize(MyClass)`.
-   *
-   * @example const deserializer = new Deserializer(new Uint8Array([1, 2, 3]));
-   * const value = deserializer.deserialize(MyClass); // where MyClass has a `deserialize` function
-   * // value is now an instance of MyClass
-   * // equivalent to `const value = MyClass.deserialize(deserializer)`
-   * @param cls The BCS-deserializable class to deserialize the buffered bytes into.
-   *
-   * @returns the deserialized value of class type T
-   * @group Implementation
-   * @category BCS
-   */
-  deserialize(cls) {
-    return cls.deserialize(this);
-  }
-  /**
-   * Deserializes an array of BCS Deserializable values given an existing Deserializer instance with a loaded byte buffer.
-   *
-   * @param cls The BCS-deserializable class to deserialize the buffered bytes into.
-   * @returns An array of deserialized values of type T.
-   * @example
-   * // serialize a vector of addresses
-   * const addresses = new Array<AccountAddress>(
-   *   AccountAddress.from("0x1"),
-   *   AccountAddress.from("0x2"),
-   *   AccountAddress.from("0xa"),
-   *   AccountAddress.from("0xb"),
-   * );
-   * const serializer = new Serializer();
-   * serializer.serializeVector(addresses);
-   * const serializedBytes = serializer.toUint8Array();
-   *
-   * // deserialize the bytes into an array of addresses
-   * const deserializer = new Deserializer(serializedBytes);
-   * const deserializedAddresses = deserializer.deserializeVector(AccountAddress);
-   * // deserializedAddresses is now an array of AccountAddress instances
-   * @group Implementation
-   * @category BCS
-   */
-  deserializeVector(cls) {
-    const length = this.deserializeUleb128AsU32();
-    const vector = new Array();
-    for (let i = 0; i < length; i += 1) {
-      vector.push(this.deserialize(cls));
-    }
-    return vector;
-  }
-};
-
-export {
-  Deserializer
-};
-//# sourceMappingURL=chunk-NUT2VOX2.mjs.map

package/dist/esm/chunk-OFUNBTK4.mjs

@@ -1,169 +0,0 @@
-import {
-  NetworkToFaucetAPI,
-  NetworkToIndexerAPI,
-  NetworkToNodeAPI,
-  NetworkToPepperAPI,
-  NetworkToProverAPI
-} from "./chunk-SFLQPB72.mjs";
-
-// src/api/aptosConfig.ts
-import aptosClient, { bcsRequest } from "@aptos-labs/aptos-client";
-var AptosConfig = class {
-  /**
-   * Initializes an instance of the Aptos client with the specified settings.
-   * This allows users to configure various aspects of the client, such as network and endpoints.
-   *
-   * @param settings - Optional configuration settings for the Aptos client.
-   * @param settings.network - The network to connect to, defaults to `Network.DEVNET`.
-   * @param settings.fullnode - The fullnode endpoint to use for requests.
-   * @param settings.faucet - The faucet endpoint for obtaining test tokens.
-   * @param settings.pepper - The pepper used for transaction signing.
-   * @param settings.prover - The prover endpoint for transaction verification.
-   * @param settings.indexer - The indexer endpoint for querying blockchain data.
-   * @param settings.client - Custom client settings, defaults to a standard Aptos client.
-   * @param settings.clientConfig - Additional configuration for the client.
-   * @param settings.fullnodeConfig - Additional configuration for the fullnode.
-   * @param settings.indexerConfig - Additional configuration for the indexer.
-   * @param settings.faucetConfig - Additional configuration for the faucet.
-   *
-   * @example
-   * ```typescript
-   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
-   *
-   * async function runExample() {
-   *     // Create a new Aptos client with default settings
-   *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify the network
-   *     const aptos = new Aptos(config);
-   *
-   *     console.log("Aptos client initialized:", aptos);
-   * }
-   * runExample().catch(console.error);
-   * ```
-   * @group Client
-   */
-  constructor(settings) {
-    this.network = settings?.network ?? "devnet" /* DEVNET */;
-    this.fullnode = settings?.fullnode;
-    this.faucet = settings?.faucet;
-    this.pepper = settings?.pepper;
-    this.prover = settings?.prover;
-    this.indexer = settings?.indexer;
-    this.client = settings?.client ?? { provider: aptosClient, binaryProvider: bcsRequest };
-    this.clientConfig = settings?.clientConfig ?? {};
-    this.fullnodeConfig = settings?.fullnodeConfig ?? {};
-    this.indexerConfig = settings?.indexerConfig ?? {};
-    this.faucetConfig = settings?.faucetConfig ?? {};
-  }
-  /**
-   * Returns the URL endpoint to send the request to based on the specified API type.
-   * If a custom URL was provided in the configuration, that URL is returned. Otherwise, the URL endpoint is derived from the network.
-   *
-   * @param apiType - The type of Aptos API to get the URL for. This can be one of the following: FULLNODE, FAUCET, INDEXER, PEPPER, PROVER.
-   *
-   * @example
-   * ```typescript
-   * import { Aptos, AptosConfig, Network, AptosApiType } from "@aptos-labs/ts-sdk";
-   *
-   * const config = new AptosConfig({ network: Network.TESTNET });
-   * const aptos = new Aptos(config);
-   *
-   * async function runExample() {
-   *   // Getting the request URL for the FULLNODE API
-   *   const url = config.getRequestUrl(AptosApiType.FULLNODE);
-   *   console.log("Request URL for FULLNODE:", url);
-   * }
-   * runExample().catch(console.error);
-   * ```
-   * @group Client
-   */
-  getRequestUrl(apiType) {
-    switch (apiType) {
-      case "Fullnode" /* FULLNODE */:
-        if (this.fullnode !== void 0) return this.fullnode;
-        if (this.network === "custom" /* CUSTOM */) throw new Error("Please provide a custom full node url");
-        return NetworkToNodeAPI[this.network];
-      case "Faucet" /* FAUCET */:
-        if (this.faucet !== void 0) return this.faucet;
-        if (this.network === "testnet" /* TESTNET */) {
-          throw new Error(
-            "There is no way to programmatically mint testnet APT, you must use the minting site at https://aptos.dev/network/faucet"
-          );
-        }
-        if (this.network === "mainnet" /* MAINNET */) {
-          throw new Error("There is no mainnet faucet");
-        }
-        if (this.network === "custom" /* CUSTOM */) throw new Error("Please provide a custom faucet url");
-        return NetworkToFaucetAPI[this.network];
-      case "Indexer" /* INDEXER */:
-        if (this.indexer !== void 0) return this.indexer;
-        if (this.network === "custom" /* CUSTOM */) throw new Error("Please provide a custom indexer url");
-        return NetworkToIndexerAPI[this.network];
-      case "Pepper" /* PEPPER */:
-        if (this.pepper !== void 0) return this.pepper;
-        if (this.network === "custom" /* CUSTOM */) throw new Error("Please provide a custom pepper service url");
-        return NetworkToPepperAPI[this.network];
-      case "Prover" /* PROVER */:
-        if (this.prover !== void 0) return this.prover;
-        if (this.network === "custom" /* CUSTOM */) throw new Error("Please provide a custom prover service url");
-        return NetworkToProverAPI[this.network];
-      default:
-        throw Error(`apiType ${apiType} is not supported`);
-    }
-  }
-  /**
-   * Checks if the provided URL is a known pepper service endpoint.
-   *
-   * @param url - The URL to check against the known pepper service endpoints.
-   *
-   * @example
-   * ```typescript
-   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
-   *
-   * const config = new AptosConfig({ network: Network.TESTNET });
-   * const aptos = new Aptos(config);
-   *
-   * async function runExample() {
-   *     const url = "https://example.pepper.service"; // replace with a real pepper service URL
-   *
-   *     // Check if the URL is a known pepper service endpoint
-   *     const isPepperService = config.isPepperServiceRequest(url);
-   *
-   *     console.log(`Is the URL a known pepper service? ${isPepperService}`);
-   * }
-   * runExample().catch(console.error);
-   * ```
-   * @group Client
-   */
-  isPepperServiceRequest(url) {
-    return NetworkToPepperAPI[this.network] === url;
-  }
-  /**
-   * Checks if the provided URL is a known prover service endpoint.
-   *
-   * @param url - The URL to check against known prover service endpoints.
-   * @returns A boolean indicating whether the URL is a known prover service endpoint.
-   *
-   * @example
-   * ```typescript
-   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
-   *
-   * const config = new AptosConfig({ network: Network.TESTNET });
-   * const aptos = new Aptos(config);
-   *
-   * // Check if the URL is a known prover service endpoint
-   * const url = "https://prover.testnet.aptos.dev"; // replace with a real URL if needed
-   * const isProver = config.isProverServiceRequest(url);
-   *
-   * console.log(`Is the URL a known prover service? ${isProver}`);
-   * ```
-   * @group Client
-   */
-  isProverServiceRequest(url) {
-    return NetworkToProverAPI[this.network] === url;
-  }
-};
-
-export {
-  AptosConfig
-};
-//# sourceMappingURL=chunk-OFUNBTK4.mjs.map

package/dist/esm/chunk-ORCQEMJL.mjs

@@ -1,51 +0,0 @@
-import {
-  generateViewFunctionPayload
-} from "./chunk-IJ7XCPP3.mjs";
-import {
-  postAptosFullNode
-} from "./chunk-6T3V5LXK.mjs";
-import {
-  Serializer
-} from "./chunk-C7T6GW5P.mjs";
-
-// src/internal/view.ts
-async function view(args) {
-  const { aptosConfig, payload, options } = args;
-  const viewFunctionPayload = await generateViewFunctionPayload({
-    ...payload,
-    aptosConfig
-  });
-  const serializer = new Serializer();
-  viewFunctionPayload.serialize(serializer);
-  const bytes = serializer.toUint8Array();
-  const { data } = await postAptosFullNode({
-    aptosConfig,
-    path: "view",
-    originMethod: "view",
-    contentType: "application/x.aptos.view_function+bcs" /* BCS_VIEW_FUNCTION */,
-    params: { ledger_version: options?.ledgerVersion },
-    body: bytes
-  });
-  return data;
-}
-async function viewJson(args) {
-  const { aptosConfig, payload, options } = args;
-  const { data } = await postAptosFullNode({
-    aptosConfig,
-    originMethod: "viewJson",
-    path: "view",
-    params: { ledger_version: options?.ledgerVersion },
-    body: {
-      function: payload.function,
-      type_arguments: payload.typeArguments ?? [],
-      arguments: payload.functionArguments ?? []
-    }
-  });
-  return data;
-}
-
-export {
-  view,
-  viewJson
-};
-//# sourceMappingURL=chunk-ORCQEMJL.mjs.map

package/dist/esm/chunk-PGFEUN7K.mjs

@@ -1,129 +0,0 @@
-import {
-  sleep
-} from "./chunk-RQS33JAS.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();
-    let childProcess;
-    if (currentPlatform === "win32") {
-      childProcess = spawn(cliCommand, cliArgs, { shell: true });
-    } else {
-      childProcess = spawn(cliCommand, cliArgs);
-    }
-    this.process = childProcess;
-    childProcess.stderr?.on("data", (data) => {
-      const str = data.toString();
-      console.log(str);
-    });
-    childProcess.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-PGFEUN7K.mjs.map