@aptos-labs/ts-sdk 6.3.1 → 7.0.0

package/dist/core/hex.d.ts

@@ -0,0 +1,154 @@
+import { ParsingResult } from "./common.js";
+import { HexInput } from "../types/index.js";
+/**
+ * Provides reasons for parsing failures related to hexadecimal values.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare enum HexInvalidReason {
+    TOO_SHORT = "too_short",
+    INVALID_LENGTH = "invalid_length",
+    INVALID_HEX_CHARS = "invalid_hex_chars"
+}
+/**
+ * NOTE: Do not use this class when working with account addresses; use AccountAddress instead.
+ * When accepting hex data as input to a function, prefer to accept HexInput and
+ *
+ * A helper class for working with hex data. Hex data, when represented as a string,
+ * generally looks like this, for example: 0xaabbcc, 45cd32, etc.
+ *
+ * then use the static helper methods of this class to convert it into the desired
+ * format. This enables the greatest flexibility for the developer.
+ *
+ * Example usage:
+ * ```typescript
+ * getTransactionByHash(txnHash: HexInput): Promise<Transaction> {
+ *   const txnHashString = Hex.fromHexInput(txnHash).toString();
+ *   return await getTransactionByHashInner(txnHashString);
+ * }
+ * ```
+ * This call to `Hex.fromHexInput().toString()` converts the HexInput to a hex string
+ * with a leading 0x prefix, regardless of what the input format was.
+ *
+ * Other ways to chain the functions together:
+ * - `Hex.fromHexString({ hexInput: "0x1f" }).toUint8Array()`
+ * - `new Hex([1, 3]).toStringWithoutPrefix()`
+ * @group Implementation
+ * @category Serialization
+ */
+export declare class Hex {
+    private readonly data;
+    /**
+     * Create a new Hex instance from a Uint8Array.
+     *
+     * @param data - The Uint8Array containing the data to initialize the Hex instance.
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(data: Uint8Array);
+    /**
+     * Get the inner hex 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(): Uint8Array;
+    /**
+     * Get the hex data as a string without the 0x prefix.
+     *
+     * @returns Hex string without 0x prefix
+     * @group Implementation
+     * @category Serialization
+     */
+    toStringWithoutPrefix(): string;
+    /**
+     * Get the hex data as a string with the 0x prefix.
+     *
+     * @returns Hex string with 0x prefix
+     * @group Implementation
+     * @category Serialization
+     */
+    toString(): string;
+    /**
+     * Converts a hex string into a Hex instance, allowing for both prefixed and non-prefixed formats.
+     *
+     * @param str - A hex string, with or without the 0x prefix.
+     *
+     * @throws ParsingError - If the hex string is too short, has an odd number of characters, or contains invalid hex characters.
+     *
+     * @returns Hex - The resulting Hex instance created from the provided string.
+     * @group Implementation
+     * @category Serialization
+     */
+    static fromHexString(str: string): Hex;
+    /**
+     * Converts an instance of HexInput, which can be a string or a Uint8Array, into a Hex instance.
+     * This function is useful for transforming hexadecimal representations into a structured Hex object for further manipulation.
+     *
+     * @param hexInput - A HexInput which can be a string or Uint8Array.
+     * @returns A Hex instance created from the provided hexInput.
+     * @group Implementation
+     * @category Serialization
+     */
+    static fromHexInput(hexInput: HexInput): Hex;
+    /**
+     * Converts an instance of HexInput, which can be a string or a Uint8Array, into a Uint8Array.
+     *
+     * @param hexInput - A HexInput which can be a string or Uint8Array.
+     * @returns A Uint8Array created from the provided hexInput.
+     */
+    static hexInputToUint8Array(hexInput: HexInput): Uint8Array;
+    /**
+     * Converts a HexInput (string or Uint8Array) to a hex string with '0x' prefix.
+     *
+     * @param hexInput - The input to convert, either a hex string (with/without '0x' prefix) or Uint8Array
+     * @returns A hex string with '0x' prefix (e.g., "0x1234")
+     *
+     * @example
+     * ```typescript
+     * Hex.hexInputToString("1234")        // returns "0x1234"
+     * Hex.hexInputToString("0x1234")      // returns "0x1234"
+     * Hex.hexInputToString(new Uint8Array([0x12, 0x34])) // returns "0x1234"
+     * ```
+     */
+    static hexInputToString(hexInput: HexInput): string;
+    /**
+     * Converts a HexInput (string or Uint8Array) to a hex string without '0x' prefix.
+     *
+     * @param hexInput - The input to convert, either a hex string (with/without '0x' prefix) or Uint8Array
+     * @returns A hex string without '0x' prefix (e.g., "1234")
+     *
+     * @example
+     * ```typescript
+     * Hex.hexInputToStringWithoutPrefix("1234")        // returns "1234"
+     * Hex.hexInputToStringWithoutPrefix("0x1234")      // returns "1234"
+     * Hex.hexInputToStringWithoutPrefix(new Uint8Array([0x12, 0x34])) // returns "1234"
+     * ```
+     */
+    static hexInputToStringWithoutPrefix(hexInput: HexInput): string;
+    /**
+     * Check if the provided string is a valid hexadecimal representation.
+     *
+     * @param str - A hex string representing byte data.
+     *
+     * @returns An object containing:
+     *  - valid: A boolean indicating whether the string is valid.
+     *  - invalidReason: The reason for invalidity if the string is not valid.
+     *  - invalidReasonMessage: A message explaining why the string is invalid.
+     * @group Implementation
+     * @category Serialization
+     */
+    static isValid(str: string): ParsingResult<HexInvalidReason>;
+    /**
+     * Determine if two Hex instances are equal by comparing their underlying byte data.
+     *
+     * @param other The Hex instance to compare to.
+     * @returns true if the Hex instances are equal, false if not.
+     * @group Implementation
+     * @category Serialization
+     */
+    equals(other: Hex): boolean;
+}
+export declare const hexToAsciiString: (hex: string) => string;
+//# sourceMappingURL=hex.d.ts.map

package/dist/core/hex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hex.d.ts","sourceRoot":"","sources":["../../src/core/hex.ts"],"names":[],"mappings":"AAIA,OAAO,EAAgB,aAAa,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;;;GAIG;AACH,oBAAY,gBAAgB;IAC1B,SAAS,cAAc;IACvB,cAAc,mBAAmB;IACjC,iBAAiB,sBAAsB;CACxC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,GAAG;IACd,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;IAElC;;;;;;OAMG;gBACS,IAAI,EAAE,UAAU;IAQ5B;;;;;;OAMG;IACH,YAAY,IAAI,UAAU;IAI1B;;;;;;OAMG;IACH,qBAAqB,IAAI,MAAM;IAI/B;;;;;;OAMG;IACH,QAAQ,IAAI,MAAM;IAQlB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG;IA4BtC;;;;;;;;OAQG;IACH,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,GAAG;IAK5C;;;;;OAKG;IACH,MAAM,CAAC,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,GAAG,UAAU;IAK3D;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM;IAInD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM;IAQhE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,gBAAgB,CAAC;IAa5D;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;CAI5B;AAED,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,WAAmE,CAAC"}

package/dist/core/hex.js

@@ -0,0 +1,219 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { bytesToHex, hexToBytes } from "@noble/hashes/utils.js";
+import { ParsingError } from "./common.js";
+/**
+ * Provides reasons for parsing failures related to hexadecimal values.
+ * @group Implementation
+ * @category Serialization
+ */
+export var HexInvalidReason;
+(function (HexInvalidReason) {
+    HexInvalidReason["TOO_SHORT"] = "too_short";
+    HexInvalidReason["INVALID_LENGTH"] = "invalid_length";
+    HexInvalidReason["INVALID_HEX_CHARS"] = "invalid_hex_chars";
+})(HexInvalidReason || (HexInvalidReason = {}));
+/**
+ * NOTE: Do not use this class when working with account addresses; use AccountAddress instead.
+ * When accepting hex data as input to a function, prefer to accept HexInput and
+ *
+ * A helper class for working with hex data. Hex data, when represented as a string,
+ * generally looks like this, for example: 0xaabbcc, 45cd32, etc.
+ *
+ * then use the static helper methods of this class to convert it into the desired
+ * format. This enables the greatest flexibility for the developer.
+ *
+ * Example usage:
+ * ```typescript
+ * getTransactionByHash(txnHash: HexInput): Promise<Transaction> {
+ *   const txnHashString = Hex.fromHexInput(txnHash).toString();
+ *   return await getTransactionByHashInner(txnHashString);
+ * }
+ * ```
+ * This call to `Hex.fromHexInput().toString()` converts the HexInput to a hex string
+ * with a leading 0x prefix, regardless of what the input format was.
+ *
+ * Other ways to chain the functions together:
+ * - `Hex.fromHexString({ hexInput: "0x1f" }).toUint8Array()`
+ * - `new Hex([1, 3]).toStringWithoutPrefix()`
+ * @group Implementation
+ * @category Serialization
+ */
+export class Hex {
+    data;
+    /**
+     * Create a new Hex instance from a Uint8Array.
+     *
+     * @param data - The Uint8Array containing the data to initialize the Hex instance.
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(data) {
+        this.data = data;
+    }
+    // ===
+    // Methods for representing an instance of Hex as other types.
+    // ===
+    /**
+     * Get the inner hex 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;
+    }
+    /**
+     * Get the hex data as a string without the 0x prefix.
+     *
+     * @returns Hex string without 0x prefix
+     * @group Implementation
+     * @category Serialization
+     */
+    toStringWithoutPrefix() {
+        return bytesToHex(this.data);
+    }
+    /**
+     * Get the hex data as a string with the 0x prefix.
+     *
+     * @returns Hex string with 0x prefix
+     * @group Implementation
+     * @category Serialization
+     */
+    toString() {
+        return `0x${this.toStringWithoutPrefix()}`;
+    }
+    // ===
+    // Methods for creating an instance of Hex from other types.
+    // ===
+    /**
+     * Converts a hex string into a Hex instance, allowing for both prefixed and non-prefixed formats.
+     *
+     * @param str - A hex string, with or without the 0x prefix.
+     *
+     * @throws ParsingError - If the hex string is too short, has an odd number of characters, or contains invalid hex characters.
+     *
+     * @returns Hex - The resulting Hex instance created from the provided string.
+     * @group Implementation
+     * @category Serialization
+     */
+    static fromHexString(str) {
+        let input = str;
+        if (input.startsWith("0x")) {
+            input = input.slice(2);
+        }
+        if (input.length === 0) {
+            throw new ParsingError("Hex string is too short, must be at least 1 char long, excluding the optional leading 0x.", HexInvalidReason.TOO_SHORT);
+        }
+        if (input.length % 2 !== 0) {
+            throw new ParsingError("Hex string must be an even number of hex characters.", HexInvalidReason.INVALID_LENGTH);
+        }
+        try {
+            return new Hex(hexToBytes(input));
+        }
+        catch (error) {
+            throw new ParsingError(`Hex string contains invalid hex characters: ${error?.message}`, HexInvalidReason.INVALID_HEX_CHARS);
+        }
+    }
+    /**
+     * Converts an instance of HexInput, which can be a string or a Uint8Array, into a Hex instance.
+     * This function is useful for transforming hexadecimal representations into a structured Hex object for further manipulation.
+     *
+     * @param hexInput - A HexInput which can be a string or Uint8Array.
+     * @returns A Hex instance created from the provided hexInput.
+     * @group Implementation
+     * @category Serialization
+     */
+    static fromHexInput(hexInput) {
+        if (hexInput instanceof Uint8Array)
+            return new Hex(hexInput);
+        return Hex.fromHexString(hexInput);
+    }
+    /**
+     * Converts an instance of HexInput, which can be a string or a Uint8Array, into a Uint8Array.
+     *
+     * @param hexInput - A HexInput which can be a string or Uint8Array.
+     * @returns A Uint8Array created from the provided hexInput.
+     */
+    static hexInputToUint8Array(hexInput) {
+        if (hexInput instanceof Uint8Array)
+            return hexInput;
+        return Hex.fromHexString(hexInput).toUint8Array();
+    }
+    /**
+     * Converts a HexInput (string or Uint8Array) to a hex string with '0x' prefix.
+     *
+     * @param hexInput - The input to convert, either a hex string (with/without '0x' prefix) or Uint8Array
+     * @returns A hex string with '0x' prefix (e.g., "0x1234")
+     *
+     * @example
+     * ```typescript
+     * Hex.hexInputToString("1234")        // returns "0x1234"
+     * Hex.hexInputToString("0x1234")      // returns "0x1234"
+     * Hex.hexInputToString(new Uint8Array([0x12, 0x34])) // returns "0x1234"
+     * ```
+     */
+    static hexInputToString(hexInput) {
+        return Hex.fromHexInput(hexInput).toString();
+    }
+    /**
+     * Converts a HexInput (string or Uint8Array) to a hex string without '0x' prefix.
+     *
+     * @param hexInput - The input to convert, either a hex string (with/without '0x' prefix) or Uint8Array
+     * @returns A hex string without '0x' prefix (e.g., "1234")
+     *
+     * @example
+     * ```typescript
+     * Hex.hexInputToStringWithoutPrefix("1234")        // returns "1234"
+     * Hex.hexInputToStringWithoutPrefix("0x1234")      // returns "1234"
+     * Hex.hexInputToStringWithoutPrefix(new Uint8Array([0x12, 0x34])) // returns "1234"
+     * ```
+     */
+    static hexInputToStringWithoutPrefix(hexInput) {
+        return Hex.fromHexInput(hexInput).toStringWithoutPrefix();
+    }
+    // ===
+    // Methods for checking validity.
+    // ===
+    /**
+     * Check if the provided string is a valid hexadecimal representation.
+     *
+     * @param str - A hex string representing byte data.
+     *
+     * @returns An object containing:
+     *  - valid: A boolean indicating whether the string is valid.
+     *  - invalidReason: The reason for invalidity if the string is not valid.
+     *  - invalidReasonMessage: A message explaining why the string is invalid.
+     * @group Implementation
+     * @category Serialization
+     */
+    static isValid(str) {
+        try {
+            Hex.fromHexString(str);
+            return { valid: true };
+        }
+        catch (error) {
+            return {
+                valid: false,
+                invalidReason: error?.invalidReason,
+                invalidReasonMessage: error?.message,
+            };
+        }
+    }
+    /**
+     * Determine if two Hex instances are equal by comparing their underlying byte data.
+     *
+     * @param other The Hex instance to compare to.
+     * @returns true if the Hex instances 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]);
+    }
+}
+export const hexToAsciiString = (hex) => new TextDecoder().decode(Hex.fromHexInput(hex).toUint8Array());
+//# sourceMappingURL=hex.js.map

package/dist/core/hex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hex.js","sourceRoot":"","sources":["../../src/core/hex.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,YAAY,EAAiB,MAAM,aAAa,CAAC;AAG1D;;;;GAIG;AACH,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,qDAAiC,CAAA;IACjC,2DAAuC,CAAA;AACzC,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,GAAG;IACG,IAAI,CAAa;IAElC;;;;;;OAMG;IACH,YAAY,IAAgB;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,MAAM;IACN,8DAA8D;IAC9D,MAAM;IAEN;;;;;;OAMG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACH,qBAAqB;QACnB,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACH,QAAQ;QACN,OAAO,KAAK,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;IAC7C,CAAC;IAED,MAAM;IACN,4DAA4D;IAC5D,MAAM;IAEN;;;;;;;;;;OAUG;IACH,MAAM,CAAC,aAAa,CAAC,GAAW;QAC9B,IAAI,KAAK,GAAG,GAAG,CAAC;QAEhB,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,YAAY,CACpB,2FAA2F,EAC3F,gBAAgB,CAAC,SAAS,CAC3B,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,YAAY,CAAC,sDAAsD,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;QAClH,CAAC;QAED,IAAI,CAAC;YACH,OAAO,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,YAAY,CACpB,+CAA+C,KAAK,EAAE,OAAO,EAAE,EAC/D,gBAAgB,CAAC,iBAAiB,CACnC,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,YAAY,CAAC,QAAkB;QACpC,IAAI,QAAQ,YAAY,UAAU;YAAE,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7D,OAAO,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,oBAAoB,CAAC,QAAkB;QAC5C,IAAI,QAAQ,YAAY,UAAU;YAAE,OAAO,QAAQ,CAAC;QACpD,OAAO,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,YAAY,EAAE,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,gBAAgB,CAAC,QAAkB;QACxC,OAAO,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,6BAA6B,CAAC,QAAkB;QACrD,OAAO,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,qBAAqB,EAAE,CAAC;IAC5D,CAAC;IAED,MAAM;IACN,iCAAiC;IACjC,MAAM;IAEN;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC;YACH,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YACvB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,aAAa,EAAE,KAAK,EAAE,aAAa;gBACnC,oBAAoB,EAAE,KAAK,EAAE,OAAO;aACrC,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAU;QACf,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QACzD,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC"}

package/dist/core/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./account/index.js";
+export * from "./accountAddress.js";
+export * from "./authenticationKey.js";
+export * from "./common.js";
+export * from "./crypto/index.js";
+export * from "./hex.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/core/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAGA,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC"}

package/dist/core/index.js

@@ -0,0 +1,9 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+export * from "./account/index.js";
+export * from "./accountAddress.js";
+export * from "./authenticationKey.js";
+export * from "./common.js";
+export * from "./crypto/index.js";
+export * from "./hex.js";
+//# sourceMappingURL=index.js.map

package/dist/core/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC"}

package/dist/errors/index.d.ts

@@ -0,0 +1,125 @@
+import { AptosApiType } from "../utils/const.js";
+import { AptosRequest, AptosResponse } from "../types/index.js";
+export declare enum KeylessErrorCategory {
+    API_ERROR = 0,
+    EXTERNAL_API_ERROR = 1,
+    SESSION_EXPIRED = 2,
+    INVALID_STATE = 3,
+    INVALID_SIGNATURE = 4,
+    UNKNOWN = 5
+}
+export declare enum KeylessErrorResolutionTip {
+    REAUTHENTICATE = "Re-authentiate to continue using your keyless account",
+    REAUTHENTICATE_UNSURE = "Try re-authentiating. If the error persists join the telegram group at https://t.me/+h5CN-W35yUFiYzkx for further support",
+    UPDATE_REQUEST_PARAMS = "Update the invalid request parameters and reauthenticate.",
+    RATE_LIMIT_EXCEEDED = "Cache the keyless account and reuse it to avoid making too many requests.  Keyless accounts are valid until either the EphemeralKeyPair expires, when the JWK is rotated, or when the proof verifying key is changed, whichever comes soonest.",
+    SERVER_ERROR = "Try again later.  See aptosApiError error for more context. For additional support join the telegram group at https://t.me/+h5CN-W35yUFiYzkx",
+    CALL_PRECHECK = "Call `await account.checkKeylessAccountValidity()` to wait for asyncronous changes and check for account validity before signing or serializing.",
+    REINSTANTIATE = "Try instantiating the account again.  Avoid manipulating the account object directly",
+    JOIN_SUPPORT_GROUP = "For support join the telegram group at https://t.me/+h5CN-W35yUFiYzkx",
+    UNKNOWN = "Error unknown. For support join the telegram group at https://t.me/+h5CN-W35yUFiYzkx"
+}
+export declare enum KeylessErrorType {
+    EPHEMERAL_KEY_PAIR_EXPIRED = 0,
+    PROOF_NOT_FOUND = 1,
+    ASYNC_PROOF_FETCH_FAILED = 2,
+    INVALID_PROOF_VERIFICATION_FAILED = 3,
+    INVALID_PROOF_VERIFICATION_KEY_NOT_FOUND = 4,
+    INVALID_JWT_SIG = 5,
+    INVALID_JWT_JWK_NOT_FOUND = 6,
+    INVALID_JWT_ISS_NOT_RECOGNIZED = 7,
+    INVALID_JWT_FEDERATED_ISS_NOT_SUPPORTED = 8,
+    INVALID_TW_SIG_VERIFICATION_FAILED = 9,
+    INVALID_TW_SIG_PUBLIC_KEY_NOT_FOUND = 10,
+    INVALID_EXPIRY_HORIZON = 11,
+    JWT_PARSING_ERROR = 12,
+    JWK_FETCH_FAILED = 13,
+    JWK_FETCH_FAILED_FEDERATED = 14,
+    RATE_LIMIT_EXCEEDED = 15,
+    PEPPER_SERVICE_INTERNAL_ERROR = 16,
+    PEPPER_SERVICE_BAD_REQUEST = 17,
+    PEPPER_SERVICE_OTHER = 18,
+    PROVER_SERVICE_INTERNAL_ERROR = 19,
+    PROVER_SERVICE_BAD_REQUEST = 20,
+    PROVER_SERVICE_OTHER = 21,
+    FULL_NODE_CONFIG_LOOKUP_ERROR = 22,
+    FULL_NODE_VERIFICATION_KEY_LOOKUP_ERROR = 23,
+    FULL_NODE_JWKS_LOOKUP_ERROR = 24,
+    FULL_NODE_OTHER = 25,
+    SIGNATURE_TYPE_INVALID = 26,
+    SIGNATURE_EXPIRED = 27,
+    MAX_EXPIRY_HORIZON_EXCEEDED = 28,
+    EPHEMERAL_SIGNATURE_VERIFICATION_FAILED = 29,
+    TRAINING_WHEELS_SIGNATURE_MISSING = 30,
+    TRAINING_WHEELS_SIGNATURE_VERIFICATION_FAILED = 31,
+    PROOF_VERIFICATION_FAILED = 32,
+    UNKNOWN = 33
+}
+export declare class KeylessError extends Error {
+    readonly innerError?: unknown;
+    readonly category: KeylessErrorCategory;
+    readonly resolutionTip: KeylessErrorResolutionTip;
+    readonly type: KeylessErrorType;
+    readonly details?: string;
+    /** @internal this constructor is for sdk internal use - do not instantiate outside of the SDK codebase */
+    constructor(args: {
+        innerError?: unknown;
+        category: KeylessErrorCategory;
+        resolutionTip: KeylessErrorResolutionTip;
+        type: KeylessErrorType;
+        message?: string;
+        details?: string;
+    });
+    static constructMessage(message: string, tip: KeylessErrorResolutionTip, innerError?: unknown, details?: string): string;
+    /**
+     * Static constructor that creates a KeylessError instance using the KeylessErrors constant
+     * @param args.type The type of KeylessError
+     * @param args.aptosApiError optional AptosApiError supplied for api errors
+     * @param args.details optional details to include in the error message
+     * @returns A new KeylessError instance
+     */
+    static fromErrorType(args: {
+        type: KeylessErrorType;
+        error?: unknown;
+        details?: string;
+    }): KeylessError;
+}
+/**
+ * Options for handling errors in the Aptos API.
+ */
+type AptosApiErrorOpts = {
+    apiType: AptosApiType;
+    aptosRequest: AptosRequest;
+    aptosResponse: AptosResponse<any, any>;
+};
+/**
+ * Represents an error returned from the Aptos API.
+ * This class encapsulates the details of the error, including the request URL, response status, and additional data.
+ *
+ * @param name - The name of the error, which is always "AptosApiError".
+ * @param url - The URL to which the request was made.
+ * @param status - The HTTP response status code (e.g., 400).
+ * @param statusText - The message associated with the response status.
+ * @param data - The response data returned from the API.
+ * @param request - The original AptosRequest that triggered the error.
+ */
+export declare class AptosApiError extends Error {
+    readonly url: string;
+    readonly status: number;
+    readonly statusText: string;
+    readonly data: any;
+    readonly request: AptosRequest;
+    /**
+     * Constructs an instance of AptosApiError with relevant error details.
+     *
+     * @param opts - The options for creating the AptosApiError.
+     * @param opts.apiType - The type of API that generated the error.
+     * @param opts.aptosRequest - The request object that caused the error.
+     * @param opts.aptosResponse - The response object containing error details.
+     *
+     * @internal This constructor is for SDK internal use - do not instantiate outside the SDK codebase.
+     */
+    constructor({ apiType, aptosRequest, aptosResponse }: AptosApiErrorOpts);
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/errors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEhE,oBAAY,oBAAoB;IAC9B,SAAS,IAAA;IACT,kBAAkB,IAAA;IAClB,eAAe,IAAA;IACf,aAAa,IAAA;IACb,iBAAiB,IAAA;IACjB,OAAO,IAAA;CACR;AAED,oBAAY,yBAAyB;IACnC,cAAc,0DAA0D;IAExE,qBAAqB,8HAA8H;IACnJ,qBAAqB,8DAA8D;IAEnF,mBAAmB,mPAAmP;IAEtQ,YAAY,iJAAiJ;IAE7J,aAAa,qJAAqJ;IAClK,aAAa,yFAAyF;IACtG,kBAAkB,0EAA0E;IAC5F,OAAO,yFAAyF;CACjG;AAED,oBAAY,gBAAgB;IAC1B,0BAA0B,IAAA;IAE1B,eAAe,IAAA;IAEf,wBAAwB,IAAA;IAExB,iCAAiC,IAAA;IAEjC,wCAAwC,IAAA;IAExC,eAAe,IAAA;IAEf,yBAAyB,IAAA;IAEzB,8BAA8B,IAAA;IAE9B,uCAAuC,IAAA;IAEvC,kCAAkC,IAAA;IAElC,mCAAmC,KAAA;IAEnC,sBAAsB,KAAA;IAEtB,iBAAiB,KAAA;IAEjB,gBAAgB,KAAA;IAEhB,0BAA0B,KAAA;IAE1B,mBAAmB,KAAA;IAEnB,6BAA6B,KAAA;IAE7B,0BAA0B,KAAA;IAE1B,oBAAoB,KAAA;IAEpB,6BAA6B,KAAA;IAE7B,0BAA0B,KAAA;IAE1B,oBAAoB,KAAA;IAEpB,6BAA6B,KAAA;IAE7B,uCAAuC,KAAA;IAEvC,2BAA2B,KAAA;IAE3B,eAAe,KAAA;IAEf,sBAAsB,KAAA;IAEtB,iBAAiB,KAAA;IAEjB,2BAA2B,KAAA;IAE3B,uCAAuC,KAAA;IAEvC,iCAAiC,KAAA;IAEjC,6CAA6C,KAAA;IAE7C,yBAAyB,KAAA;IAEzB,OAAO,KAAA;CACR;AA+KD,qBAAa,YAAa,SAAQ,KAAK;IACrC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAE9B,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAAC;IAExC,QAAQ,CAAC,aAAa,EAAE,yBAAyB,CAAC;IAElD,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAEhC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B,0GAA0G;gBAC9F,IAAI,EAAE;QAChB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,QAAQ,EAAE,oBAAoB,CAAC;QAC/B,aAAa,EAAE,yBAAyB,CAAC;QACzC,IAAI,EAAE,gBAAgB,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAYD,MAAM,CAAC,gBAAgB,CACrB,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,yBAAyB,EAC9B,UAAU,CAAC,EAAE,OAAO,EACpB,OAAO,CAAC,EAAE,MAAM,GACf,MAAM;IAcT;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,gBAAgB,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,YAAY;CAaxG;AAED;;GAEG;AACH,KAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,YAAY,CAAC;IACtB,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;CACxC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC;IAEnB,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC;IAE/B;;;;;;;;;OASG;gBACS,EAAE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,EAAE,iBAAiB;CAUxE"}