@aptos-labs/ts-sdk 6.3.1 → 7.0.1

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

@@ -0,0 +1,112 @@
+import { Serializer, Deserializer } from "../../bcs/index.js";
+import { EphemeralPublicKeyVariant, HexInput } from "../../types/index.js";
+import { PublicKey } from "./publicKey.js";
+import { Signature } from "./signature.js";
+import { AptosConfig } from "../../api/aptosConfig.js";
+/**
+ * Represents ephemeral public keys for Aptos Keyless accounts.
+ *
+ * These keys are used only temporarily within Keyless accounts and are not utilized as public keys for account identification.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare class EphemeralPublicKey extends PublicKey {
+    /**
+     * The public key itself
+     * @group Implementation
+     * @category Serialization
+     */
+    readonly publicKey: PublicKey;
+    /**
+     * An enum indicating the scheme of the ephemeral public key
+     * @group Implementation
+     * @category Serialization
+     */
+    readonly variant: EphemeralPublicKeyVariant;
+    /**
+     * Creates an instance of EphemeralPublicKey using the provided public key.
+     * This constructor ensures that only supported signature types are accepted.
+     *
+     * @param publicKey - The public key to be used for the ephemeral public key.
+     * @throws Error if the signature type is unsupported.
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(publicKey: PublicKey);
+    /**
+     * Verifies a signed message using the ephemeral public key.
+     *
+     * @param args - The arguments for the verification.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature that was signed by the private key of the ephemeral public key.
+     * @returns true if the signature is valid, otherwise false.
+     * @group Implementation
+     * @category Serialization
+     */
+    verifySignature(args: {
+        message: HexInput;
+        signature: EphemeralSignature;
+    }): boolean;
+    verifySignatureAsync(args: {
+        aptosConfig: AptosConfig;
+        message: HexInput;
+        signature: EphemeralSignature;
+    }): Promise<boolean>;
+    /**
+     * Serializes the current instance, specifically handling the Ed25519 signature type.
+     * This function ensures that the signature is properly serialized using the provided serializer.
+     *
+     * @param serializer - The serializer instance used to serialize the signature.
+     * @throws Error if the signature type is unknown.
+     * @group Implementation
+     * @category Serialization
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Deserializes an EphemeralSignature from the provided deserializer.
+     * This function allows you to retrieve an EphemeralSignature based on the deserialized data.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Serialization
+     */
+    static deserialize(deserializer: Deserializer): EphemeralPublicKey;
+    /**
+     * Determines if the provided public key is an instance of `EphemeralPublicKey`.
+     *
+     * @param publicKey - The public key to check.
+     * @returns A boolean indicating whether the public key is an ephemeral type.
+     * @group Implementation
+     * @category Serialization
+     */
+    static isPublicKey(publicKey: PublicKey): publicKey is EphemeralPublicKey;
+}
+/**
+ * Represents ephemeral signatures used in Aptos Keyless accounts.
+ *
+ * These signatures are utilized within the KeylessSignature framework.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare class EphemeralSignature extends Signature {
+    /**
+     * The signature signed by the private key of an EphemeralKeyPair
+     * @group Implementation
+     * @category Serialization
+     */
+    readonly signature: Signature;
+    constructor(signature: Signature);
+    /**
+     * Deserializes an ephemeral signature from a hexadecimal input.
+     * This function allows you to convert a hexadecimal representation of an ephemeral signature into its deserialized form for
+     * further processing.
+     *
+     * @param hexInput - The hexadecimal input representing the ephemeral signature.
+     * @group Implementation
+     * @category Serialization
+     */
+    static fromHex(hexInput: HexInput): EphemeralSignature;
+    serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): EphemeralSignature;
+}
+//# sourceMappingURL=ephemeral.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ephemeral.d.ts","sourceRoot":"","sources":["../../../src/core/crypto/ephemeral.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAA6B,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACtG,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;GAMG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;IAC/C;;;;OAIG;IACH,SAAgB,SAAS,EAAE,SAAS,CAAC;IAErC;;;;OAIG;IACH,SAAgB,OAAO,EAAE,yBAAyB,CAAC;IAEnD;;;;;;;;OAQG;gBACS,SAAS,EAAE,SAAS;IAahC;;;;;;;;;OASG;IACH,eAAe,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,QAAQ,CAAC;QAAC,SAAS,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO;IAK9E,oBAAoB,CAAC,IAAI,EAAE;QAC/B,WAAW,EAAE,WAAW,CAAC;QACzB,OAAO,EAAE,QAAQ,CAAC;QAClB,SAAS,EAAE,kBAAkB,CAAC;KAC/B,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpB;;;;;;;;OAQG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IASvC;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,kBAAkB;IAUlE;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,IAAI,kBAAkB;CAG1E;AAED;;;;;;GAMG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;IAC/C;;;;OAIG;IACH,SAAgB,SAAS,EAAE,SAAS,CAAC;gBAEzB,SAAS,EAAE,SAAS;IAYhC;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,kBAAkB;IAMtD,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IASvC,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,kBAAkB;CASnE"}

package/dist/core/crypto/ephemeral.js

@@ -0,0 +1,170 @@
+import { Deserializer } from "../../bcs/index.js";
+import { EphemeralPublicKeyVariant, EphemeralSignatureVariant } from "../../types/index.js";
+import { PublicKey } from "./publicKey.js";
+import { Signature } from "./signature.js";
+import { Ed25519PublicKey, Ed25519Signature } from "./ed25519.js";
+import { Hex } from "../hex.js";
+/**
+ * Represents ephemeral public keys for Aptos Keyless accounts.
+ *
+ * These keys are used only temporarily within Keyless accounts and are not utilized as public keys for account identification.
+ * @group Implementation
+ * @category Serialization
+ */
+export class EphemeralPublicKey extends PublicKey {
+    /**
+     * The public key itself
+     * @group Implementation
+     * @category Serialization
+     */
+    publicKey;
+    /**
+     * An enum indicating the scheme of the ephemeral public key
+     * @group Implementation
+     * @category Serialization
+     */
+    variant;
+    /**
+     * Creates an instance of EphemeralPublicKey using the provided public key.
+     * This constructor ensures that only supported signature types are accepted.
+     *
+     * @param publicKey - The public key to be used for the ephemeral public key.
+     * @throws Error if the signature type is unsupported.
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(publicKey) {
+        super();
+        const publicKeyType = publicKey.constructor.name;
+        switch (publicKeyType) {
+            case Ed25519PublicKey.name:
+                this.publicKey = publicKey;
+                this.variant = EphemeralPublicKeyVariant.Ed25519;
+                break;
+            default:
+                throw new Error(`Unsupported key for EphemeralPublicKey - ${publicKeyType}`);
+        }
+    }
+    /**
+     * Verifies a signed message using the ephemeral public key.
+     *
+     * @param args - The arguments for the verification.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature that was signed by the private key of the ephemeral public key.
+     * @returns true if the signature is valid, otherwise false.
+     * @group Implementation
+     * @category Serialization
+     */
+    verifySignature(args) {
+        const { message, signature } = args;
+        return this.publicKey.verifySignature({ message, signature: signature.signature });
+    }
+    async verifySignatureAsync(args) {
+        return this.verifySignature(args);
+    }
+    /**
+     * Serializes the current instance, specifically handling the Ed25519 signature type.
+     * This function ensures that the signature is properly serialized using the provided serializer.
+     *
+     * @param serializer - The serializer instance used to serialize the signature.
+     * @throws Error if the signature type is unknown.
+     * @group Implementation
+     * @category Serialization
+     */
+    serialize(serializer) {
+        if (this.publicKey instanceof Ed25519PublicKey) {
+            serializer.serializeU32AsUleb128(EphemeralPublicKeyVariant.Ed25519);
+            this.publicKey.serialize(serializer);
+        }
+        else {
+            throw new Error("Unknown public key type");
+        }
+    }
+    /**
+     * Deserializes an EphemeralSignature from the provided deserializer.
+     * This function allows you to retrieve an EphemeralSignature based on the deserialized data.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Serialization
+     */
+    static deserialize(deserializer) {
+        const index = deserializer.deserializeUleb128AsU32();
+        switch (index) {
+            case EphemeralPublicKeyVariant.Ed25519:
+                return new EphemeralPublicKey(Ed25519PublicKey.deserialize(deserializer));
+            default:
+                throw new Error(`Unknown variant index for EphemeralPublicKey: ${index}`);
+        }
+    }
+    /**
+     * Determines if the provided public key is an instance of `EphemeralPublicKey`.
+     *
+     * @param publicKey - The public key to check.
+     * @returns A boolean indicating whether the public key is an ephemeral type.
+     * @group Implementation
+     * @category Serialization
+     */
+    static isPublicKey(publicKey) {
+        return publicKey instanceof EphemeralPublicKey;
+    }
+}
+/**
+ * Represents ephemeral signatures used in Aptos Keyless accounts.
+ *
+ * These signatures are utilized within the KeylessSignature framework.
+ * @group Implementation
+ * @category Serialization
+ */
+export class EphemeralSignature extends Signature {
+    /**
+     * The signature signed by the private key of an EphemeralKeyPair
+     * @group Implementation
+     * @category Serialization
+     */
+    signature;
+    constructor(signature) {
+        super();
+        const signatureType = signature.constructor.name;
+        switch (signatureType) {
+            case Ed25519Signature.name:
+                this.signature = signature;
+                break;
+            default:
+                throw new Error(`Unsupported signature for EphemeralSignature - ${signatureType}`);
+        }
+    }
+    /**
+     * Deserializes an ephemeral signature from a hexadecimal input.
+     * This function allows you to convert a hexadecimal representation of an ephemeral signature into its deserialized form for
+     * further processing.
+     *
+     * @param hexInput - The hexadecimal input representing the ephemeral signature.
+     * @group Implementation
+     * @category Serialization
+     */
+    static fromHex(hexInput) {
+        const data = Hex.fromHexInput(hexInput);
+        const deserializer = new Deserializer(data.toUint8Array());
+        return EphemeralSignature.deserialize(deserializer);
+    }
+    serialize(serializer) {
+        if (this.signature instanceof Ed25519Signature) {
+            serializer.serializeU32AsUleb128(EphemeralSignatureVariant.Ed25519);
+            this.signature.serialize(serializer);
+        }
+        else {
+            throw new Error("Unknown signature type");
+        }
+    }
+    static deserialize(deserializer) {
+        const index = deserializer.deserializeUleb128AsU32();
+        switch (index) {
+            case EphemeralSignatureVariant.Ed25519:
+                return new EphemeralSignature(Ed25519Signature.deserialize(deserializer));
+            default:
+                throw new Error(`Unknown variant index for EphemeralSignature: ${index}`);
+        }
+    }
+}
+//# sourceMappingURL=ephemeral.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ephemeral.js","sourceRoot":"","sources":["../../../src/core/crypto/ephemeral.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAY,MAAM,sBAAsB,CAAC;AACtG,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAGhC;;;;;;GAMG;AACH,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C;;;;OAIG;IACa,SAAS,CAAY;IAErC;;;;OAIG;IACa,OAAO,CAA4B;IAEnD;;;;;;;;OAQG;IACH,YAAY,SAAoB;QAC9B,KAAK,EAAE,CAAC;QACR,MAAM,aAAa,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC;QACjD,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,gBAAgB,CAAC,IAAI;gBACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;gBAC3B,IAAI,CAAC,OAAO,GAAG,yBAAyB,CAAC,OAAO,CAAC;gBACjD,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,4CAA4C,aAAa,EAAE,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CAAC,IAA0D;QACxE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,IAI1B;QACC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,UAAsB;QAC9B,IAAI,IAAI,CAAC,SAAS,YAAY,gBAAgB,EAAE,CAAC;YAC/C,UAAU,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;YACpE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,YAA0B;QAC3C,MAAM,KAAK,GAAG,YAAY,CAAC,uBAAuB,EAAE,CAAC;QACrD,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,yBAAyB,CAAC,OAAO;gBACpC,OAAO,IAAI,kBAAkB,CAAC,gBAAgB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;YAC5E;gBACE,MAAM,IAAI,KAAK,CAAC,iDAAiD,KAAK,EAAE,CAAC,CAAC;QAC9E,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,SAAoB;QACrC,OAAO,SAAS,YAAY,kBAAkB,CAAC;IACjD,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C;;;;OAIG;IACa,SAAS,CAAY;IAErC,YAAY,SAAoB;QAC9B,KAAK,EAAE,CAAC;QACR,MAAM,aAAa,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC;QACjD,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,gBAAgB,CAAC,IAAI;gBACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;gBAC3B,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,kDAAkD,aAAa,EAAE,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,CAAC,QAAkB;QAC/B,MAAM,IAAI,GAAG,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC3D,OAAO,kBAAkB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACtD,CAAC;IAED,SAAS,CAAC,UAAsB;QAC9B,IAAI,IAAI,CAAC,SAAS,YAAY,gBAAgB,EAAE,CAAC;YAC/C,UAAU,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;YACpE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,YAA0B;QAC3C,MAAM,KAAK,GAAG,YAAY,CAAC,uBAAuB,EAAE,CAAC;QACrD,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,yBAAyB,CAAC,OAAO;gBACpC,OAAO,IAAI,kBAAkB,CAAC,gBAAgB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;YAC5E;gBACE,MAAM,IAAI,KAAK,CAAC,iDAAiD,KAAK,EAAE,CAAC,CAAC;QAC9E,CAAC;IACH,CAAC;CACF"}

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

@@ -0,0 +1,106 @@
+import { AccountPublicKey, PublicKey } from "./publicKey.js";
+import { Deserializer, Serializer } from "../../bcs/index.js";
+import { HexInput } from "../../types/index.js";
+import { AuthenticationKey } from "../authenticationKey.js";
+import { AccountAddress, AccountAddressInput } from "../accountAddress.js";
+import { KeylessConfiguration, KeylessPublicKey, KeylessSignature, MoveJWK } from "./keyless.js";
+import { AptosConfig } from "../../api/aptosConfig.js";
+import { Signature } from "../index.js";
+/**
+ * Represents the FederatedKeylessPublicKey public key
+ *
+ * These keys use an on-chain address as a source of truth for the JWK used to verify signatures.
+ *
+ * FederatedKeylessPublicKey authentication key is represented in the SDK as `AnyPublicKey`.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare class FederatedKeylessPublicKey extends AccountPublicKey {
+    /**
+     * The address that contains the JWK set to be used for verification.
+     * @group Implementation
+     * @category Serialization
+     */
+    readonly jwkAddress: AccountAddress;
+    /**
+     * The inner public key which contains the standard Keyless public key.
+     * @group Implementation
+     * @category Serialization
+     */
+    readonly keylessPublicKey: KeylessPublicKey;
+    constructor(jwkAddress: AccountAddressInput, keylessPublicKey: KeylessPublicKey);
+    /**
+     * Get the authentication key for the federated keyless public key
+     *
+     * @returns AuthenticationKey
+     * @group Implementation
+     * @category Serialization
+     */
+    authKey(): AuthenticationKey;
+    /**
+     * Verifies a signed data with a public key
+     *
+     * @param args.message message
+     * @param args.signature The signature
+     * @param args.jwk - The JWK to use for verification.
+     * @param args.keylessConfig - The keyless configuration to use for verification.
+     * @returns true if the signature is valid
+     * @group Implementation
+     * @category Serialization
+     */
+    verifySignature(args: {
+        message: HexInput;
+        signature: Signature;
+        jwk: MoveJWK;
+        keylessConfig: KeylessConfiguration;
+    }): boolean;
+    serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): FederatedKeylessPublicKey;
+    static isPublicKey(publicKey: PublicKey): publicKey is FederatedKeylessPublicKey;
+    /**
+     * Verifies a keyless signature for a given message.  It will fetch the keyless configuration and the JWK to
+     * use for verification from the appropriate network as defined by the aptosConfig.
+     *
+     * @param args.aptosConfig The aptos config to use for fetching the keyless configuration.
+     * @param args.message The message to verify the signature against.
+     * @param args.signature The signature to verify.
+     * @param args.options.throwErrorWithReason Whether to throw an error with the reason for the failure instead of returning false.
+     * @returns true if the signature is valid
+     */
+    verifySignatureAsync(args: {
+        aptosConfig: AptosConfig;
+        message: HexInput;
+        signature: KeylessSignature;
+        options?: {
+            throwErrorWithReason?: boolean;
+        };
+    }): Promise<boolean>;
+    /**
+     * Creates a FederatedKeylessPublicKey from the JWT components plus pepper
+     *
+     * @param args.iss the iss of the identity
+     * @param args.uidKey the key to use to get the uidVal in the JWT token
+     * @param args.uidVal the value of the uidKey in the JWT token
+     * @param args.aud the client ID of the application
+     * @param args.pepper The pepper used to maintain privacy of the account
+     * @returns FederatedKeylessPublicKey
+     * @group Implementation
+     * @category Serialization
+     */
+    static create(args: {
+        iss: string;
+        uidKey: string;
+        uidVal: string;
+        aud: string;
+        pepper: HexInput;
+        jwkAddress: AccountAddressInput;
+    }): FederatedKeylessPublicKey;
+    static fromJwtAndPepper(args: {
+        jwt: string;
+        pepper: HexInput;
+        jwkAddress: AccountAddressInput;
+        uidKey?: string;
+    }): FederatedKeylessPublicKey;
+    static isInstance(publicKey: PublicKey): boolean;
+}
+//# sourceMappingURL=federatedKeyless.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"federatedKeyless.d.ts","sourceRoot":"","sources":["../../../src/core/crypto/federatedKeyless.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAsC,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,OAAO,EAGR,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;GAQG;AACH,qBAAa,yBAA0B,SAAQ,gBAAgB;IAC7D;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;gBAEhC,UAAU,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,gBAAgB;IAM/E;;;;;;OAMG;IACH,OAAO,IAAI,iBAAiB;IAU5B;;;;;;;;;;OAUG;IACH,eAAe,CAAC,IAAI,EAAE;QACpB,OAAO,EAAE,QAAQ,CAAC;QAClB,SAAS,EAAE,SAAS,CAAC;QACrB,GAAG,EAAE,OAAO,CAAC;QACb,aAAa,EAAE,oBAAoB,CAAC;KACrC,GAAG,OAAO;IASX,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAKvC,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,yBAAyB;IAMzE,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,IAAI,yBAAyB;IAIhF;;;;;;;;;OASG;IACG,oBAAoB,CAAC,IAAI,EAAE;QAC/B,WAAW,EAAE,WAAW,CAAC;QACzB,OAAO,EAAE,QAAQ,CAAC;QAClB,SAAS,EAAE,gBAAgB,CAAC;QAC5B,OAAO,CAAC,EAAE;YAAE,oBAAoB,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC;KAC9C,GAAG,OAAO,CAAC,OAAO,CAAC;IAOpB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;QAClB,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,QAAQ,CAAC;QACjB,UAAU,EAAE,mBAAmB,CAAC;KACjC,GAAG,yBAAyB;IAI7B,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE;QAC5B,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,QAAQ,CAAC;QACjB,UAAU,EAAE,mBAAmB,CAAC;QAChC,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,yBAAyB;IAI7B,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS;CAQvC"}

package/dist/core/crypto/federatedKeyless.js

@@ -0,0 +1,125 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { AccountPublicKey } from "./publicKey.js";
+import { Serializer } from "../../bcs/index.js";
+import { AnyPublicKeyVariant, SigningScheme } from "../../types/index.js";
+import { AuthenticationKey } from "../authenticationKey.js";
+import { AccountAddress } from "../accountAddress.js";
+import { KeylessPublicKey, verifyKeylessSignature, verifyKeylessSignatureWithJwkAndConfig, } from "./keyless.js";
+/**
+ * Represents the FederatedKeylessPublicKey public key
+ *
+ * These keys use an on-chain address as a source of truth for the JWK used to verify signatures.
+ *
+ * FederatedKeylessPublicKey authentication key is represented in the SDK as `AnyPublicKey`.
+ * @group Implementation
+ * @category Serialization
+ */
+export class FederatedKeylessPublicKey extends AccountPublicKey {
+    /**
+     * The address that contains the JWK set to be used for verification.
+     * @group Implementation
+     * @category Serialization
+     */
+    jwkAddress;
+    /**
+     * The inner public key which contains the standard Keyless public key.
+     * @group Implementation
+     * @category Serialization
+     */
+    keylessPublicKey;
+    constructor(jwkAddress, keylessPublicKey) {
+        super();
+        this.jwkAddress = AccountAddress.from(jwkAddress);
+        this.keylessPublicKey = keylessPublicKey;
+    }
+    /**
+     * Get the authentication key for the federated keyless public key
+     *
+     * @returns AuthenticationKey
+     * @group Implementation
+     * @category Serialization
+     */
+    authKey() {
+        const serializer = new Serializer();
+        serializer.serializeU32AsUleb128(AnyPublicKeyVariant.FederatedKeyless);
+        serializer.serializeFixedBytes(this.bcsToBytes());
+        return AuthenticationKey.fromSchemeAndBytes({
+            scheme: SigningScheme.SingleKey,
+            input: serializer.toUint8Array(),
+        });
+    }
+    /**
+     * Verifies a signed data with a public key
+     *
+     * @param args.message message
+     * @param args.signature The signature
+     * @param args.jwk - The JWK to use for verification.
+     * @param args.keylessConfig - The keyless configuration to use for verification.
+     * @returns true if the signature is valid
+     * @group Implementation
+     * @category Serialization
+     */
+    verifySignature(args) {
+        try {
+            verifyKeylessSignatureWithJwkAndConfig({ ...args, publicKey: this });
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    serialize(serializer) {
+        this.jwkAddress.serialize(serializer);
+        this.keylessPublicKey.serialize(serializer);
+    }
+    static deserialize(deserializer) {
+        const jwkAddress = AccountAddress.deserialize(deserializer);
+        const keylessPublicKey = KeylessPublicKey.deserialize(deserializer);
+        return new FederatedKeylessPublicKey(jwkAddress, keylessPublicKey);
+    }
+    static isPublicKey(publicKey) {
+        return publicKey instanceof FederatedKeylessPublicKey;
+    }
+    /**
+     * Verifies a keyless signature for a given message.  It will fetch the keyless configuration and the JWK to
+     * use for verification from the appropriate network as defined by the aptosConfig.
+     *
+     * @param args.aptosConfig The aptos config to use for fetching the keyless configuration.
+     * @param args.message The message to verify the signature against.
+     * @param args.signature The signature to verify.
+     * @param args.options.throwErrorWithReason Whether to throw an error with the reason for the failure instead of returning false.
+     * @returns true if the signature is valid
+     */
+    async verifySignatureAsync(args) {
+        return verifyKeylessSignature({
+            ...args,
+            publicKey: this,
+        });
+    }
+    /**
+     * Creates a FederatedKeylessPublicKey from the JWT components plus pepper
+     *
+     * @param args.iss the iss of the identity
+     * @param args.uidKey the key to use to get the uidVal in the JWT token
+     * @param args.uidVal the value of the uidKey in the JWT token
+     * @param args.aud the client ID of the application
+     * @param args.pepper The pepper used to maintain privacy of the account
+     * @returns FederatedKeylessPublicKey
+     * @group Implementation
+     * @category Serialization
+     */
+    static create(args) {
+        return new FederatedKeylessPublicKey(args.jwkAddress, KeylessPublicKey.create(args));
+    }
+    static fromJwtAndPepper(args) {
+        return new FederatedKeylessPublicKey(args.jwkAddress, KeylessPublicKey.fromJwtAndPepper(args));
+    }
+    static isInstance(publicKey) {
+        return ("jwkAddress" in publicKey &&
+            publicKey.jwkAddress instanceof AccountAddress &&
+            "keylessPublicKey" in publicKey &&
+            publicKey.keylessPublicKey instanceof KeylessPublicKey);
+    }
+}
+//# sourceMappingURL=federatedKeyless.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"federatedKeyless.js","sourceRoot":"","sources":["../../../src/core/crypto/federatedKeyless.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,OAAO,EAAE,gBAAgB,EAAa,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAgB,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAY,mBAAmB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAuB,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAEL,gBAAgB,EAGhB,sBAAsB,EACtB,sCAAsC,GACvC,MAAM,cAAc,CAAC;AAItB;;;;;;;;GAQG;AACH,MAAM,OAAO,yBAA0B,SAAQ,gBAAgB;IAC7D;;;;OAIG;IACM,UAAU,CAAiB;IAEpC;;;;OAIG;IACM,gBAAgB,CAAmB;IAE5C,YAAY,UAA+B,EAAE,gBAAkC;QAC7E,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClD,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,OAAO;QACL,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QACpC,UAAU,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;QACvE,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAClD,OAAO,iBAAiB,CAAC,kBAAkB,CAAC;YAC1C,MAAM,EAAE,aAAa,CAAC,SAAS;YAC/B,KAAK,EAAE,UAAU,CAAC,YAAY,EAAE;SACjC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CAAC,IAKf;QACC,IAAI,CAAC;YACH,sCAAsC,CAAC,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACrE,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,SAAS,CAAC,UAAsB;QAC9B,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACtC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,YAA0B;QAC3C,MAAM,UAAU,GAAG,cAAc,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC5D,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACpE,OAAO,IAAI,yBAAyB,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,SAAoB;QACrC,OAAO,SAAS,YAAY,yBAAyB,CAAC;IACxD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAK1B;QACC,OAAO,sBAAsB,CAAC;YAC5B,GAAG,IAAI;YACP,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,CAAC,IAOb;QACC,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,IAKvB;QACC,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IACjG,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,SAAoB;QACpC,OAAO,CACL,YAAY,IAAI,SAAS;YACzB,SAAS,CAAC,UAAU,YAAY,cAAc;YAC9C,kBAAkB,IAAI,SAAS;YAC/B,SAAS,CAAC,gBAAgB,YAAY,gBAAgB,CACvD,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,90 @@
+/**
+ * Contains the derived cryptographic key as a Uint8Array.
+ * @group Implementation
+ * @category Serialization
+ */
+export type DerivedKeys = {
+    key: Uint8Array;
+    chainCode: Uint8Array;
+};
+/**
+ * Aptos derive path is 637
+ * @group Implementation
+ * @category Serialization
+ */
+export declare const APTOS_HARDENED_REGEX: RegExp;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
+export declare const APTOS_BIP44_REGEX: RegExp;
+/**
+ * Supported key types and their associated seeds.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare enum KeyType {
+    ED25519 = "ed25519 seed"
+}
+/**
+ * @group Implementation
+ * @category Serialization
+ */
+export declare const HARDENED_OFFSET = 2147483648;
+/**
+ * Validate a BIP-44 derivation path string to ensure it meets the required format.
+ * This function checks if the provided path adheres to the BIP-44 standard for Secp256k1.
+ * Parse and validate a path that is compliant to BIP-44 in form m/44'/637'/{account_index}'/{change_index}/{address_index}
+ * for Secp256k1
+ *
+ * Note that for Secp256k1, the last two components must be non-hardened.
+ *
+ * @param path - The path string to validate (e.g. `m/44'/637'/0'/0/0`).
+ * @group Implementation
+ * @category Serialization
+ */
+export declare function isValidBIP44Path(path: string): boolean;
+/**
+ * Aptos derive path is 637
+ *
+ * Parse and validate a path that is compliant to SLIP-0010 and BIP-44
+ * in form m/44'/637'/{account_index}'/{change_index}'/{address_index}'.
+ * See SLIP-0010 {@link https://github.com/satoshilabs/slips/blob/master/slip-0044.md}
+ * See BIP-44 {@link https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki}
+ *
+ * Note that for Ed25519, all components must be hardened.
+ * This is because non-hardened [PK] derivation would not work due to Ed25519's lack of a key homomorphism.
+ * Specifically, you cannot derive the PK associated with derivation path a/b/c given the PK of a/b.
+ * This is because the PK in Ed25519 is, more or less, computed as 𝑔𝐻(𝑠𝑘),
+ * with the hash function breaking the homomorphism.
+ *
+ * @param path - The derivation path string to validate (e.g. `m/44'/637'/0'/0'/0'`).
+ * @group Implementation
+ * @category Serialization
+ */
+export declare function isValidHardenedPath(path: string): boolean;
+export declare const deriveKey: (hashSeed: Uint8Array | string, data: Uint8Array | string) => DerivedKeys;
+/**
+ * Derive a child key from the private key
+ * @param key
+ * @param chainCode
+ * @param index
+ * @group Implementation
+ * @category Serialization
+ */
+export declare const CKDPriv: ({ key, chainCode }: DerivedKeys, index: number) => DerivedKeys;
+/**
+ * Splits derive path into segments
+ * @param path
+ * @group Implementation
+ * @category Serialization
+ */
+export declare const splitPath: (path: string) => Array<string>;
+/**
+ * Normalizes the mnemonic by removing extra whitespace and making it lowercase
+ * @param mnemonic the mnemonic seed phrase
+ * @group Implementation
+ * @category Serialization
+ */
+export declare const mnemonicToSeed: (mnemonic: string) => Uint8Array;
+//# sourceMappingURL=hdKey.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hdKey.d.ts","sourceRoot":"","sources":["../../../src/core/crypto/hdKey.ts"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,EAAE,UAAU,CAAC;IAChB,SAAS,EAAE,UAAU,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,QAA+C,CAAC;AAEjF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAA4C,CAAC;AAE3E;;;;GAIG;AACH,oBAAY,OAAO;IACjB,OAAO,iBAAiB;CACzB;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,aAAa,CAAC;AAE1C;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEzD;AASD,eAAO,MAAM,SAAS,GAAI,UAAU,UAAU,GAAG,MAAM,EAAE,MAAM,UAAU,GAAG,MAAM,KAAG,WAMpF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,GAAI,oBAAoB,WAAW,EAAE,OAAO,MAAM,KAAG,WAOxE,CAAC;AAIF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,MAAM,KAAG,KAAK,CAAC,MAAM,CAAoD,CAAC;AAE1G;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,MAAM,KAAG,UAOjD,CAAC"}