@aptos-labs/ts-sdk 6.3.0 → 7.0.0

package/dist/core/authenticationKey.js

@@ -0,0 +1,155 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { sha3_256 as sha3Hash } from "@noble/hashes/sha3.js";
+import { AccountAddress } from "./accountAddress.js";
+import { Hex } from "./hex.js";
+import { Serializable } from "../bcs/serializer.js";
+/**
+ * Represents an authentication key used for account management. Each account stores an authentication key that enables account
+ * owners to rotate their private key(s) without changing the address that hosts their account. The authentication key is a
+ * SHA3-256 hash of data and is always 32 bytes in length.
+ *
+ * @see {@link https://aptos.dev/concepts/accounts | Account Basics}
+ *
+ * Account addresses can be derived from the AuthenticationKey.
+ * @group Implementation
+ * @category Serialization
+ */
+export class AuthenticationKey extends Serializable {
+    /**
+     * An authentication key is always a SHA3-256 hash of data, and is always 32 bytes.
+     *
+     * The data to hash depends on the underlying public key type and the derivation scheme.
+     * @group Implementation
+     * @category Serialization
+     */
+    static LENGTH = 32;
+    /**
+     * The raw bytes of the authentication key.
+     * @group Implementation
+     * @category Serialization
+     */
+    data;
+    /**
+     * Creates an instance of the AuthenticationKey using the provided hex input.
+     * This ensures that the hex input is valid and conforms to the required length for an Authentication Key.
+     *
+     * @param args - The arguments for constructing the AuthenticationKey.
+     * @param args.data - The hex input data to be used for the Authentication Key.
+     * @throws {Error} Throws an error if the length of the provided hex input is not equal to the required Authentication Key
+     * length.
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(args) {
+        super();
+        const { data } = args;
+        const hex = Hex.fromHexInput(data);
+        if (hex.toUint8Array().length !== AuthenticationKey.LENGTH) {
+            throw new Error(`Authentication Key length should be ${AuthenticationKey.LENGTH}`);
+        }
+        this.data = hex;
+    }
+    /**
+     * Serializes the authentication key as length-prefixed bytes (BCS `serde_bytes` encoding).
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     * @group Implementation
+     * @category Serialization
+     */
+    serialize(serializer) {
+        serializer.serializeBytes(this.data.toUint8Array());
+    }
+    /**
+     * Deserialize an AuthenticationKey from the byte buffer in a Deserializer instance.
+     * @param deserializer - The deserializer to deserialize the AuthenticationKey from.
+     * @returns An instance of AuthenticationKey.
+     * @group Implementation
+     * @category Serialization
+     */
+    static deserialize(deserializer) {
+        const bytes = deserializer.deserializeBytes();
+        if (bytes.length !== AuthenticationKey.LENGTH) {
+            throw new Error(`AuthenticationKey BCS must be ${AuthenticationKey.LENGTH} bytes, got ${bytes.length}`);
+        }
+        return new AuthenticationKey({ data: bytes });
+    }
+    /**
+     * Override `Serializable.toString` (which would return the length-prefixed BCS hex) so the public
+     * representation stays the underlying 32-byte hex address — what callers compare against
+     * (REST `authentication_key`, indexer GraphQL filters, on-chain account address derivation).
+     */
+    toString() {
+        return this.data.toString();
+    }
+    /**
+     * Convert the internal data representation to a Uint8Array.
+     *
+     * This function is useful for obtaining a byte representation of the data, which can be utilized for serialization or transmission.
+     *
+     * @returns Uint8Array representation of the internal data.
+     * @group Implementation
+     * @category Serialization
+     */
+    toUint8Array() {
+        return this.data.toUint8Array();
+    }
+    /**
+     * Generates an AuthenticationKey from the specified scheme and input bytes.
+     * This function is essential for creating a valid authentication key based on a given scheme.
+     *
+     * @param args - The arguments for generating the AuthenticationKey.
+     * @param args.scheme - The authentication key scheme to use.
+     * @param args.input - The input data in hexadecimal format to derive the key.
+     * @returns An instance of AuthenticationKey containing the generated key data.
+     * @group Implementation
+     * @category Serialization
+     */
+    static fromSchemeAndBytes(args) {
+        const { scheme, input } = args;
+        const inputBytes = Hex.fromHexInput(input).toUint8Array();
+        const hashInput = new Uint8Array([...inputBytes, scheme]);
+        const hash = sha3Hash.create();
+        hash.update(hashInput);
+        const hashDigest = hash.digest();
+        return new AuthenticationKey({ data: hashDigest });
+    }
+    /**
+     * Derives an AuthenticationKey from the provided public key using a specified derivation scheme.
+     *
+     * @deprecated Use `fromPublicKey` instead.
+     * @param args - The arguments for deriving the authentication key.
+     * @param args.publicKey - The public key used for the derivation.
+     * @param args.scheme - The scheme to use for deriving the authentication key.
+     * @group Implementation
+     * @category Serialization
+     */
+    static fromPublicKeyAndScheme(args) {
+        const { publicKey } = args;
+        return publicKey.authKey();
+    }
+    /**
+     * Converts a PublicKey to an AuthenticationKey using the derivation scheme inferred from the provided PublicKey instance.
+     *
+     * @param args - The arguments for the function.
+     * @param args.publicKey - The PublicKey to be converted.
+     * @returns AuthenticationKey - The derived AuthenticationKey.
+     * @group Implementation
+     * @category Serialization
+     */
+    static fromPublicKey(args) {
+        const { publicKey } = args;
+        return publicKey.authKey();
+    }
+    /**
+     * Derives an account address from an AuthenticationKey by translating the AuthenticationKey bytes directly to an AccountAddress.
+     *
+     * @returns AccountAddress - The derived account address.
+     * @group Implementation
+     * @category Serialization
+     */
+    derivedAddress() {
+        return new AccountAddress(this.data.toUint8Array());
+    }
+}
+//# sourceMappingURL=authenticationKey.js.map

package/dist/core/authenticationKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticationKey.js","sourceRoot":"","sources":["../../src/core/authenticationKey.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAc,MAAM,sBAAsB,CAAC;AAGhE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACjD;;;;;;OAMG;IACH,MAAM,CAAU,MAAM,GAAW,EAAE,CAAC;IAEpC;;;;OAIG;IACa,IAAI,CAAM;IAE1B;;;;;;;;;;OAUG;IACH,YAAY,IAAwB;QAClC,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,MAAM,GAAG,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,MAAM,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,uCAAuC,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,UAAsB;QAC9B,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,YAA0B;QAC3C,MAAM,KAAK,GAAG,YAAY,CAAC,gBAAgB,EAAE,CAAC;QAC9C,IAAI,KAAK,CAAC,MAAM,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,iCAAiC,iBAAiB,CAAC,MAAM,eAAe,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1G,CAAC;QACD,OAAO,IAAI,iBAAiB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAA0D;QAClF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAC/B,MAAM,UAAU,GAAG,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,CAAC;QAC1D,MAAM,SAAS,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACvB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACjC,OAAO,IAAI,iBAAiB,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAsE;QACzG,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAC3B,OAAO,SAAS,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,aAAa,CAAC,IAAqC;QACxD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAC3B,OAAO,SAAS,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,cAAc;QACZ,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACtD,CAAC"}

package/dist/core/common.d.ts

@@ -0,0 +1,51 @@
+/**
+ * This error is used to explain why parsing failed.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare class ParsingError<T> extends Error {
+    /**
+     * This provides a programmatic way to access why parsing failed. Downstream devs
+     * might want to use this to build their own error messages if the default error
+     * messages are not suitable for their use case. This should be an enum.
+     * @group Implementation
+     * @category Serialization
+     */
+    invalidReason: T;
+    /**
+     * Creates an instance of the error with a specified message and invalid reason.
+     *
+     * @param message The error message that describes the issue.
+     * @param invalidReason The reason why the input is considered invalid.
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(message: string, invalidReason: T);
+}
+/**
+ * Whereas ParsingError is thrown when parsing fails, e.g. in a fromString function,
+ * this type is returned from "defensive" functions like isValid.
+ * @group Implementation
+ * @category Serialization
+ */
+export type ParsingResult<T> = {
+    /**
+     * True if valid, false otherwise.
+     * @group Implementation
+     * @category Serialization
+     */
+    valid: boolean;
+    /**
+     * If valid is false, this will be a code explaining why parsing failed.
+     * @group Implementation
+     * @category Serialization
+     */
+    invalidReason?: T;
+    /**
+     * If valid is false, this will be a string explaining why parsing failed.
+     * @group Implementation
+     * @category Serialization
+     */
+    invalidReasonMessage?: string;
+};
+//# sourceMappingURL=common.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/core/common.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,qBAAa,YAAY,CAAC,CAAC,CAAE,SAAQ,KAAK;IACxC;;;;;;OAMG;IACI,aAAa,EAAE,CAAC,CAAC;IAExB;;;;;;;OAOG;gBACS,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;CAI9C;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAC7B;;;;OAIG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,CAAC;IAElB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC"}

package/dist/core/common.js

@@ -0,0 +1,30 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * This error is used to explain why parsing failed.
+ * @group Implementation
+ * @category Serialization
+ */
+export class ParsingError extends Error {
+    /**
+     * This provides a programmatic way to access why parsing failed. Downstream devs
+     * might want to use this to build their own error messages if the default error
+     * messages are not suitable for their use case. This should be an enum.
+     * @group Implementation
+     * @category Serialization
+     */
+    invalidReason;
+    /**
+     * Creates an instance of the error with a specified message and invalid reason.
+     *
+     * @param message The error message that describes the issue.
+     * @param invalidReason The reason why the input is considered invalid.
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(message, invalidReason) {
+        super(message);
+        this.invalidReason = invalidReason;
+    }
+}
+//# sourceMappingURL=common.js.map

package/dist/core/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/core/common.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC;;;;GAIG;AACH,MAAM,OAAO,YAAgB,SAAQ,KAAK;IACxC;;;;;;OAMG;IACI,aAAa,CAAI;IAExB;;;;;;;OAOG;IACH,YAAY,OAAe,EAAE,aAAgB;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;CACF"}

package/dist/core/crypto/abstraction.d.ts

@@ -0,0 +1,21 @@
+import { Deserializer, Serializer } from "../../bcs/index.js";
+import { HexInput } from "../../types/index.js";
+import { AccountAddress } from "../accountAddress.js";
+import { AuthenticationKey } from "../authenticationKey.js";
+import { AccountPublicKey, VerifySignatureArgs, VerifySignatureAsyncArgs } from "./publicKey.js";
+import { Signature } from "./signature.js";
+export declare class AbstractSignature extends Signature {
+    readonly value: Uint8Array;
+    constructor(value: HexInput);
+    serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): AbstractSignature;
+}
+export declare class AbstractPublicKey extends AccountPublicKey {
+    readonly accountAddress: AccountAddress;
+    constructor(accountAddress: AccountAddress);
+    authKey(): AuthenticationKey;
+    verifySignature(args: VerifySignatureArgs): boolean;
+    verifySignatureAsync(args: VerifySignatureAsyncArgs): Promise<boolean>;
+    serialize(serializer: Serializer): void;
+}
+//# sourceMappingURL=abstraction.d.ts.map

package/dist/core/crypto/abstraction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstraction.d.ts","sourceRoot":"","sources":["../../../src/core/crypto/abstraction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;gBAEf,KAAK,EAAE,QAAQ;IAK3B,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAIvC,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,iBAAiB;CAGlE;AAED,qBAAa,iBAAkB,SAAQ,gBAAgB;IACrD,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;gBAE5B,cAAc,EAAE,cAAc;IAK1C,OAAO,IAAI,iBAAiB;IAI5B,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO;IAI7C,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5E,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;CAGxC"}

package/dist/core/crypto/abstraction.js

@@ -0,0 +1,37 @@
+import { AuthenticationKey } from "../authenticationKey.js";
+import { Hex } from "../hex.js";
+import { AccountPublicKey } from "./publicKey.js";
+import { Signature } from "./signature.js";
+export class AbstractSignature extends Signature {
+    value;
+    constructor(value) {
+        super();
+        this.value = Hex.fromHexInput(value).toUint8Array();
+    }
+    serialize(serializer) {
+        serializer.serializeBytes(this.value);
+    }
+    static deserialize(deserializer) {
+        return new AbstractSignature(deserializer.deserializeBytes());
+    }
+}
+export class AbstractPublicKey extends AccountPublicKey {
+    accountAddress;
+    constructor(accountAddress) {
+        super();
+        this.accountAddress = accountAddress;
+    }
+    authKey() {
+        return new AuthenticationKey({ data: this.accountAddress.toUint8Array() });
+    }
+    verifySignature(args) {
+        throw new Error("This function is not implemented for AbstractPublicKey.");
+    }
+    async verifySignatureAsync(args) {
+        throw new Error("This function is not implemented for AbstractPublicKey.");
+    }
+    serialize(serializer) {
+        throw new Error("This function is not implemented for AbstractPublicKey.");
+    }
+}
+//# sourceMappingURL=abstraction.js.map

package/dist/core/crypto/abstraction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstraction.js","sourceRoot":"","sources":["../../../src/core/crypto/abstraction.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAiD,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IACrC,KAAK,CAAa;IAE3B,YAAY,KAAe;QACzB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,CAAC;IACtD,CAAC;IAED,SAAS,CAAC,UAAsB;QAC9B,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,YAA0B;QAC3C,OAAO,IAAI,iBAAiB,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,gBAAgB;IAC5C,cAAc,CAAiB;IAExC,YAAY,cAA8B;QACxC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;IAED,OAAO;QACL,OAAO,IAAI,iBAAiB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,eAAe,CAAC,IAAyB;QACvC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,IAA8B;QACvD,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAC7E,CAAC;IAED,SAAS,CAAC,UAAsB;QAC9B,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAC7E,CAAC;CACF"}

package/dist/core/crypto/anyKeyRegistry.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Registry for AnyPublicKey and AnySignature variant handlers.
+ *
+ * This allows keyless (and future) variants to register themselves at runtime,
+ * so that singleKey.ts does not need a compile-time dependency on keyless/poseidon.
+ * When the keyless module is imported, it registers its deserializers and instanceof
+ * checkers here. If keyless is never imported, these variants remain unregistered
+ * and deserialization will throw a clear error.
+ */
+import type { Deserializer } from "../../bcs/deserializer.js";
+import type { PublicKey } from "./publicKey.js";
+import type { Signature } from "./signature.js";
+export type PublicKeyDeserializer = (deserializer: Deserializer) => PublicKey;
+export type SignatureDeserializer = (deserializer: Deserializer) => Signature;
+export type VariantDetector = (key: PublicKey) => number | undefined;
+export type SignatureVariantDetector = (sig: Signature) => number | undefined;
+/**
+ * Register a deserializer for a public key variant.
+ * Called by modules that define new AnyPublicKey variants (e.g., keyless).
+ */
+export declare function registerPublicKeyVariant(variant: number, deserializer: PublicKeyDeserializer, detector: VariantDetector): void;
+/**
+ * Register a deserializer for a signature variant.
+ * Called by modules that define new AnySignature variants (e.g., keyless).
+ */
+export declare function registerSignatureVariant(variant: number, deserializer: SignatureDeserializer, detector: SignatureVariantDetector): void;
+/**
+ * Look up a registered public key deserializer by variant index.
+ */
+export declare function getPublicKeyDeserializer(variant: number): PublicKeyDeserializer | undefined;
+/**
+ * Look up a registered signature deserializer by variant index.
+ */
+export declare function getSignatureDeserializer(variant: number): SignatureDeserializer | undefined;
+/**
+ * Detect the variant for a public key using registered detectors.
+ * Returns the variant number, or undefined if no detector matches.
+ */
+export declare function detectPublicKeyVariant(key: PublicKey): number | undefined;
+/**
+ * Detect the variant for a signature using registered detectors.
+ * Returns the variant number, or undefined if no detector matches.
+ */
+export declare function detectSignatureVariant(sig: Signature): number | undefined;
+//# sourceMappingURL=anyKeyRegistry.d.ts.map

package/dist/core/crypto/anyKeyRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"anyKeyRegistry.d.ts","sourceRoot":"","sources":["../../../src/core/crypto/anyKeyRegistry.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,MAAM,MAAM,qBAAqB,GAAG,CAAC,YAAY,EAAE,YAAY,KAAK,SAAS,CAAC;AAC9E,MAAM,MAAM,qBAAqB,GAAG,CAAC,YAAY,EAAE,YAAY,KAAK,SAAS,CAAC;AAC9E,MAAM,MAAM,eAAe,GAAG,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,GAAG,SAAS,CAAC;AACrE,MAAM,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,GAAG,SAAS,CAAC;AAO9E;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,qBAAqB,EACnC,QAAQ,EAAE,eAAe,GACxB,IAAI,CAGN;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,qBAAqB,EACnC,QAAQ,EAAE,wBAAwB,GACjC,IAAI,CAGN;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAE3F;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAE3F;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAMzE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAMzE"}

package/dist/core/crypto/anyKeyRegistry.js

@@ -0,0 +1,59 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+const publicKeyDeserializers = new Map();
+const signatureDeserializers = new Map();
+const publicKeyVariantDetectors = [];
+const signatureVariantDetectors = [];
+/**
+ * Register a deserializer for a public key variant.
+ * Called by modules that define new AnyPublicKey variants (e.g., keyless).
+ */
+export function registerPublicKeyVariant(variant, deserializer, detector) {
+    publicKeyDeserializers.set(variant, deserializer);
+    publicKeyVariantDetectors.push(detector);
+}
+/**
+ * Register a deserializer for a signature variant.
+ * Called by modules that define new AnySignature variants (e.g., keyless).
+ */
+export function registerSignatureVariant(variant, deserializer, detector) {
+    signatureDeserializers.set(variant, deserializer);
+    signatureVariantDetectors.push(detector);
+}
+/**
+ * Look up a registered public key deserializer by variant index.
+ */
+export function getPublicKeyDeserializer(variant) {
+    return publicKeyDeserializers.get(variant);
+}
+/**
+ * Look up a registered signature deserializer by variant index.
+ */
+export function getSignatureDeserializer(variant) {
+    return signatureDeserializers.get(variant);
+}
+/**
+ * Detect the variant for a public key using registered detectors.
+ * Returns the variant number, or undefined if no detector matches.
+ */
+export function detectPublicKeyVariant(key) {
+    for (const detector of publicKeyVariantDetectors) {
+        const variant = detector(key);
+        if (variant !== undefined)
+            return variant;
+    }
+    return undefined;
+}
+/**
+ * Detect the variant for a signature using registered detectors.
+ * Returns the variant number, or undefined if no detector matches.
+ */
+export function detectSignatureVariant(sig) {
+    for (const detector of signatureVariantDetectors) {
+        const variant = detector(sig);
+        if (variant !== undefined)
+            return variant;
+    }
+    return undefined;
+}
+//# sourceMappingURL=anyKeyRegistry.js.map

package/dist/core/crypto/anyKeyRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"anyKeyRegistry.js","sourceRoot":"","sources":["../../../src/core/crypto/anyKeyRegistry.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAqBtC,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAiC,CAAC;AACxE,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAiC,CAAC;AACxE,MAAM,yBAAyB,GAAsB,EAAE,CAAC;AACxD,MAAM,yBAAyB,GAA+B,EAAE,CAAC;AAEjE;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAe,EACf,YAAmC,EACnC,QAAyB;IAEzB,sBAAsB,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAClD,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC3C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAe,EACf,YAAmC,EACnC,QAAkC;IAElC,sBAAsB,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAClD,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAe;IACtD,OAAO,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAe;IACtD,OAAO,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,GAAc;IACnD,KAAK,MAAM,QAAQ,IAAI,yBAAyB,EAAE,CAAC;QACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,OAAO,CAAC;IAC5C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,GAAc;IACnD,KAAK,MAAM,QAAQ,IAAI,yBAAyB,EAAE,CAAC;QACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,OAAO,CAAC;IAC5C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/core/crypto/deserializationUtils.d.ts

@@ -0,0 +1,22 @@
+import { PublicKey } from "./publicKey.js";
+import { Signature } from "./signature.js";
+import { HexInput } from "../../types/index.js";
+/**
+ * Deserializes a public key from a hex string.
+ * Attempts to deserialize using various public key types in sequence until one succeeds.
+ *
+ * @param publicKey - The hex string representation of the public key to deserialize
+ * @returns The deserialized public key
+ * @throws Error if deserialization fails for all supported key types or if multiple deserializations are found
+ */
+export declare function deserializePublicKey(publicKey: HexInput): PublicKey;
+/**
+ * Deserializes a signature from a hex string.
+ * Attempts to deserialize using various signature types in sequence until one succeeds.
+ *
+ * @param signature - The hex string representation of the signature to deserialize
+ * @returns The deserialized signature
+ * @throws Error if deserialization fails for all supported signature types or if multiple deserializations are found
+ */
+export declare function deserializeSignature(signature: HexInput): Signature;
+//# sourceMappingURL=deserializationUtils.d.ts.map

package/dist/core/crypto/deserializationUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deserializationUtils.d.ts","sourceRoot":"","sources":["../../../src/core/crypto/deserializationUtils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAIhD;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,QAAQ,GAAG,SAAS,CAiCnE;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,QAAQ,GAAG,SAAS,CAgCnE"}

package/dist/core/crypto/deserializationUtils.js

@@ -0,0 +1,89 @@
+import { AnyPublicKey, AnySignature } from "./singleKey.js";
+import { Ed25519PublicKey, Ed25519Signature } from "./ed25519.js";
+import { MultiKey, MultiKeySignature } from "./multiKey.js";
+import { KeylessPublicKey, KeylessSignature } from "./keyless.js";
+import { MultiEd25519PublicKey, MultiEd25519Signature } from "./multiEd25519.js";
+import { FederatedKeylessPublicKey } from "./federatedKeyless.js";
+import { Secp256k1PublicKey, Secp256k1Signature } from "./secp256k1.js";
+import { Deserializer } from "../../bcs/deserializer.js";
+const MULTIPLE_DESERIALIZATIONS_ERROR_MSG = "Multiple possible deserializations found";
+/**
+ * Deserializes a public key from a hex string.
+ * Attempts to deserialize using various public key types in sequence until one succeeds.
+ *
+ * @param publicKey - The hex string representation of the public key to deserialize
+ * @returns The deserialized public key
+ * @throws Error if deserialization fails for all supported key types or if multiple deserializations are found
+ */
+export function deserializePublicKey(publicKey) {
+    const publicKeyTypes = [
+        Ed25519PublicKey,
+        AnyPublicKey,
+        MultiEd25519PublicKey,
+        MultiKey,
+        KeylessPublicKey,
+        FederatedKeylessPublicKey,
+        Secp256k1PublicKey,
+    ];
+    let result;
+    for (const KeyType of publicKeyTypes) {
+        try {
+            const deserializer = Deserializer.fromHex(publicKey);
+            const key = KeyType.deserialize(deserializer);
+            deserializer.assertFinished();
+            if (result) {
+                throw new Error(`${MULTIPLE_DESERIALIZATIONS_ERROR_MSG}: ${publicKey}`);
+            }
+            result = key;
+        }
+        catch (error) {
+            if (error instanceof Error && error.message.includes(MULTIPLE_DESERIALIZATIONS_ERROR_MSG)) {
+                throw error;
+            }
+        }
+    }
+    if (!result) {
+        throw new Error(`Failed to deserialize public key: ${publicKey}`);
+    }
+    return result;
+}
+/**
+ * Deserializes a signature from a hex string.
+ * Attempts to deserialize using various signature types in sequence until one succeeds.
+ *
+ * @param signature - The hex string representation of the signature to deserialize
+ * @returns The deserialized signature
+ * @throws Error if deserialization fails for all supported signature types or if multiple deserializations are found
+ */
+export function deserializeSignature(signature) {
+    const signatureTypes = [
+        Ed25519Signature,
+        AnySignature,
+        MultiEd25519Signature,
+        MultiKeySignature,
+        KeylessSignature,
+        Secp256k1Signature,
+    ];
+    let result;
+    for (const SignatureType of signatureTypes) {
+        try {
+            const deserializer = Deserializer.fromHex(signature);
+            const sig = SignatureType.deserialize(deserializer);
+            deserializer.assertFinished();
+            if (result) {
+                throw new Error(`${MULTIPLE_DESERIALIZATIONS_ERROR_MSG}: ${signature}`);
+            }
+            result = sig;
+        }
+        catch (error) {
+            if (error instanceof Error && error.message.includes(MULTIPLE_DESERIALIZATIONS_ERROR_MSG)) {
+                throw error;
+            }
+        }
+    }
+    if (!result) {
+        throw new Error(`Failed to deserialize signature: ${signature}`);
+    }
+    return result;
+}
+//# sourceMappingURL=deserializationUtils.js.map

package/dist/core/crypto/deserializationUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deserializationUtils.js","sourceRoot":"","sources":["../../../src/core/crypto/deserializationUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGxE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,MAAM,mCAAmC,GAAG,0CAA0C,CAAC;AAEvF;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,SAAmB;IACtD,MAAM,cAAc,GAAG;QACrB,gBAAgB;QAChB,YAAY;QACZ,qBAAqB;QACrB,QAAQ;QACR,gBAAgB;QAChB,yBAAyB;QACzB,kBAAkB;KACnB,CAAC;IAEF,IAAI,MAA6B,CAAC;IAClC,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;QACrC,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACrD,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAC9C,YAAY,CAAC,cAAc,EAAE,CAAC;YAC9B,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,GAAG,mCAAmC,KAAK,SAAS,EAAE,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,GAAG,GAAG,CAAC;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,mCAAmC,CAAC,EAAE,CAAC;gBAC1F,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,qCAAqC,SAAS,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,SAAmB;IACtD,MAAM,cAAc,GAAG;QACrB,gBAAgB;QAChB,YAAY;QACZ,qBAAqB;QACrB,iBAAiB;QACjB,gBAAgB;QAChB,kBAAkB;KACnB,CAAC;IAEF,IAAI,MAA6B,CAAC;IAClC,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACrD,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACpD,YAAY,CAAC,cAAc,EAAE,CAAC;YAC9B,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,GAAG,mCAAmC,KAAK,SAAS,EAAE,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,GAAG,GAAG,CAAC;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,mCAAmC,CAAC,EAAE,CAAC;gBAC1F,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,oCAAoC,SAAS,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}