@aptos-labs/ts-sdk 6.3.0 → 7.0.0

package/dist/account/KeylessAccount.js

@@ -0,0 +1,133 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { getIssAudAndUidVal, KeylessPublicKey, } from "../core/crypto/keyless.js";
+import { Deserializer } from "../bcs/index.js";
+import { AbstractKeylessAccount } from "./AbstractKeylessAccount.js";
+import { Hex } from "../core/hex.js";
+/**
+ * Account implementation for the Keyless authentication scheme.
+ *
+ * Used to represent a Keyless based account and sign transactions with it.
+ *
+ * Use `KeylessAccount.create()` to instantiate a KeylessAccount with a JWT, proof and EphemeralKeyPair.
+ *
+ * When the proof expires or the JWT becomes invalid, the KeylessAccount must be instantiated again with a new JWT,
+ * EphemeralKeyPair, and corresponding proof.
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export class KeylessAccount extends AbstractKeylessAccount {
+    /**
+     * The KeylessPublicKey associated with the account
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    publicKey;
+    // Use the static constructor 'create' instead.
+    /**
+     * Use the static generator `create(...)` instead.
+     * Creates an instance of the KeylessAccount with an optional proof.
+     *
+     * @param args - The parameters for creating a KeylessAccount.
+     * @param args.address - Optional account address associated with the KeylessAccount.
+     * @param args.ephemeralKeyPair - The ephemeral key pair used in the account creation.
+     * @param args.iss - A JWT issuer.
+     * @param args.uidKey - The claim on the JWT to identify a user.  This is typically 'sub' or 'email'.
+     * @param args.uidVal - The unique id for this user, intended to be a stable user identifier.
+     * @param args.aud - The value of the 'aud' claim on the JWT, also known as client ID.  This is the identifier for the dApp's
+     * OIDC registration with the identity provider.
+     * @param args.pepper - A hexadecimal input used for additional security.
+     * @param args.proof - A Zero Knowledge Signature or a promise that resolves to one.
+     * @param args.proofFetchCallback - Optional callback function for fetching proof.
+     * @param args.jwt - A JSON Web Token used for authentication.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    constructor(args) {
+        const publicKey = KeylessPublicKey.create(args);
+        super({ publicKey, ...args });
+        this.publicKey = publicKey;
+    }
+    /**
+     * Serializes the transaction data into a format suitable for transmission or storage.
+     * This function ensures that both the transaction bytes and the proof are properly serialized.
+     *
+     * @param serializer - The serializer instance used to convert the transaction data into bytes.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    serialize(serializer) {
+        super.serialize(serializer);
+    }
+    /**
+     * Deserializes the provided deserializer to create a KeylessAccount instance.
+     * This function extracts necessary components such as the JWT, UID key, pepper, ephemeral key pair, and proof from the deserializer.
+     *
+     * @param deserializer - The deserializer instance used to retrieve the serialized data.
+     * @returns A KeylessAccount instance created from the deserialized data.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    static deserialize(deserializer) {
+        const { address, proof, ephemeralKeyPair, jwt, uidKey, pepper, verificationKeyHash } = AbstractKeylessAccount.partialDeserialize(deserializer);
+        const { iss, aud, uidVal } = getIssAudAndUidVal({ jwt, uidKey });
+        return new KeylessAccount({
+            address,
+            proof,
+            ephemeralKeyPair,
+            iss,
+            uidKey,
+            uidVal,
+            aud,
+            pepper,
+            jwt,
+            verificationKeyHash,
+        });
+    }
+    /**
+     * Deserialize bytes using this account's information.
+     *
+     * @param bytes The bytes being interpreted.
+     * @returns
+     */
+    static fromBytes(bytes) {
+        return KeylessAccount.deserialize(new Deserializer(Hex.hexInputToUint8Array(bytes)));
+    }
+    /**
+     * Creates a KeylessAccount instance using the provided parameters.
+     * This function allows you to set up a KeylessAccount with specific attributes such as address, proof, and JWT.
+     * This is used instead of the KeylessAccount constructor.
+     *
+     * @param args - The parameters for creating a KeylessAccount.
+     * @param args.address - Optional account address associated with the KeylessAccount.
+     * @param args.proof - A Zero Knowledge Signature or a promise that resolves to one.
+     * @param args.jwt - A JSON Web Token used for authentication.
+     * @param args.ephemeralKeyPair - The ephemeral key pair used in the account creation.
+     * @param args.pepper - A hexadecimal input used for additional security.
+     * @param args.uidKey - Optional key for user identification, defaults to "sub".
+     * @param args.proofFetchCallback - Optional callback function for fetching proof.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    static create(args) {
+        const { address, proof, jwt, ephemeralKeyPair, pepper, uidKey = "sub", proofFetchCallback, verificationKey, verificationKeyHash, } = args;
+        if (verificationKeyHash && verificationKey) {
+            throw new Error("Cannot provide both verificationKey and verificationKeyHash");
+        }
+        const { iss, aud, uidVal } = getIssAudAndUidVal({ jwt, uidKey });
+        return new KeylessAccount({
+            address,
+            proof,
+            ephemeralKeyPair,
+            iss,
+            uidKey,
+            uidVal,
+            aud,
+            pepper,
+            jwt,
+            proofFetchCallback,
+            verificationKeyHash: verificationKeyHash ?? (verificationKey ? verificationKey.hash() : undefined),
+        });
+    }
+}
+//# sourceMappingURL=KeylessAccount.js.map

package/dist/account/KeylessAccount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeylessAccount.js","sourceRoot":"","sources":["../../src/account/KeylessAccount.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAItC,OAAO,EACL,kBAAkB,EAElB,gBAAgB,GAEjB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,YAAY,EAAc,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAsB,MAAM,6BAA6B,CAAC;AACzF,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,cAAe,SAAQ,sBAAsB;IACxD;;;;OAIG;IACM,SAAS,CAAmB;IAErC,+CAA+C;IAE/C;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,IAYX;QACC,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAChD,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,UAAsB;QAC9B,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,WAAW,CAAC,YAA0B;QAC3C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,GAClF,sBAAsB,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAC1D,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,kBAAkB,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,cAAc,CAAC;YACxB,OAAO;YACP,KAAK;YACL,gBAAgB;YAChB,GAAG;YACH,MAAM;YACN,MAAM;YACN,GAAG;YACH,MAAM;YACN,GAAG;YACH,mBAAmB;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,KAAe;QAC9B,OAAO,cAAc,CAAC,WAAW,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CAAC,IAUb;QACC,MAAM,EACJ,OAAO,EACP,KAAK,EACL,GAAG,EACH,gBAAgB,EAChB,MAAM,EACN,MAAM,GAAG,KAAK,EACd,kBAAkB,EAClB,eAAe,EACf,mBAAmB,GACpB,GAAG,IAAI,CAAC;QAET,IAAI,mBAAmB,IAAI,eAAe,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,kBAAkB,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,cAAc,CAAC;YACxB,OAAO;YACP,KAAK;YACL,gBAAgB;YAChB,GAAG;YACH,MAAM;YACN,MAAM;YACN,GAAG;YACH,MAAM;YACN,GAAG;YACH,kBAAkB;YAClB,mBAAmB,EAAE,mBAAmB,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SACnG,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/account/MultiEd25519Account.d.ts

@@ -0,0 +1,100 @@
+import { AptosConfig } from "../api/aptosConfig.js";
+import { AccountAddress, AccountAddressInput } from "../core/accountAddress.js";
+import { Ed25519PrivateKey, Signature } from "../core/crypto/index.js";
+import { MultiEd25519PublicKey, MultiEd25519Signature } from "../core/crypto/multiEd25519.js";
+import { AccountAuthenticatorMultiEd25519 } from "../transactions/authenticator/account.js";
+import { AnyRawTransaction } from "../transactions/types.js";
+import { HexInput, SigningScheme } from "../types/index.js";
+import type { Account } from "./Account.js";
+export interface MultiEd25519SignerConstructorArgs {
+    publicKey: MultiEd25519PublicKey;
+    signers: Ed25519PrivateKey[];
+    address?: AccountAddressInput;
+}
+export interface VerifyMultiEd25519SignatureArgs {
+    message: HexInput;
+    signature: MultiEd25519Signature;
+}
+/**
+ * Signer implementation for the Multi-Ed25519 authentication scheme.
+ *
+ * Note: This authentication scheme is a legacy authentication scheme.  Prefer using MultiKeyAccounts as a
+ * MultiKeyAccount can support any type of signer, not just Ed25519.  Generating a signer instance does not
+ * create the account on-chain.
+ */
+export declare class MultiEd25519Account implements Account {
+    readonly publicKey: MultiEd25519PublicKey;
+    readonly accountAddress: AccountAddress;
+    readonly signingScheme = SigningScheme.MultiEd25519;
+    /**
+     * The signers used to sign messages.  These signers should correspond to public keys in the
+     * MultiEd25519Account.  The number of signers should be equal to this.publicKey.threshold.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    readonly signers: Ed25519PrivateKey[];
+    /**
+     * An array of indices where for signer[i], signerIndicies[i] is the index of the corresponding public key in
+     * publicKey.publicKeys.  Used to derive the right public key to use for verification.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    readonly signerIndices: number[];
+    readonly signaturesBitmap: Uint8Array;
+    constructor(args: MultiEd25519SignerConstructorArgs);
+    /**
+     * Verify the given message and signature with the public key.
+     *
+     * @param args.message raw message data in HexInput format
+     * @param args.signature signed message Signature
+     * @returns
+     */
+    verifySignature(args: VerifyMultiEd25519SignatureArgs): boolean;
+    /**
+     * Verify the given message and signature with the public key.
+     *
+     * MultiEd25519 signatures do not depend on chain state, so this function is
+     * equivalent to the synchronous verifySignature method.
+     *
+     * @param args - The arguments for verifying the signature.
+     * @param args.aptosConfig - The configuration object for connecting to the Aptos network
+     * @param args.message - Raw message data in HexInput format.
+     * @param args.signature - Signed message signature.
+     * @returns A boolean indicating whether the signature is valid.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    verifySignatureAsync(args: {
+        aptosConfig: AptosConfig;
+        message: HexInput;
+        signature: Signature;
+        options?: {
+            throwErrorWithReason?: boolean;
+        };
+    }): Promise<boolean>;
+    /**
+     * Sign a message using the account's Ed25519 private key.
+     * @param message the signing message, as binary input
+     * @return the AccountAuthenticator containing the signature, together with the account's public key
+     */
+    signWithAuthenticator(message: HexInput): AccountAuthenticatorMultiEd25519;
+    /**
+     * Sign a transaction using the account's Ed25519 private keys.
+     * @param transaction the raw transaction
+     * @return the AccountAuthenticator containing the signature of the transaction, together with the account's public key
+     */
+    signTransactionWithAuthenticator(transaction: AnyRawTransaction): AccountAuthenticatorMultiEd25519;
+    /**
+     * Sign the given message using the account's Ed25519 private keys.
+     * @param message in HexInput format
+     * @returns MultiEd25519Signature
+     */
+    sign(message: HexInput): MultiEd25519Signature;
+    /**
+     * Sign the given transaction using the available signing capabilities.
+     * @param transaction the transaction to be signed
+     * @returns Signature
+     */
+    signTransaction(transaction: AnyRawTransaction): MultiEd25519Signature;
+}
+//# sourceMappingURL=MultiEd25519Account.d.ts.map

package/dist/account/MultiEd25519Account.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiEd25519Account.d.ts","sourceRoot":"","sources":["../../src/account/MultiEd25519Account.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChF,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC9F,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,WAAW,iCAAiC;IAChD,SAAS,EAAE,qBAAqB,CAAC;IACjC,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC7B,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B;AAED,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,QAAQ,CAAC;IAClB,SAAS,EAAE,qBAAqB,CAAC;CAClC;AAED;;;;;;GAMG;AACH,qBAAa,mBAAoB,YAAW,OAAO;IACjD,QAAQ,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAE1C,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAExC,QAAQ,CAAC,aAAa,8BAA8B;IAEpD;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAEtC;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,CAAC;IAEjC,QAAQ,CAAC,gBAAgB,EAAE,UAAU,CAAC;gBAI1B,IAAI,EAAE,iCAAiC;IA6CnD;;;;;;OAMG;IACH,eAAe,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO;IAI/D;;;;;;;;;;;;;OAaG;IACG,oBAAoB,CAAC,IAAI,EAAE;QAC/B,WAAW,EAAE,WAAW,CAAC;QACzB,OAAO,EAAE,QAAQ,CAAC;QAClB,SAAS,EAAE,SAAS,CAAC;QACrB,OAAO,CAAC,EAAE;YAAE,oBAAoB,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC;KAC9C,GAAG,OAAO,CAAC,OAAO,CAAC;IAOpB;;;;OAIG;IACH,qBAAqB,CAAC,OAAO,EAAE,QAAQ,GAAG,gCAAgC;IAI1E;;;;OAIG;IACH,gCAAgC,CAAC,WAAW,EAAE,iBAAiB,GAAG,gCAAgC;IAIlG;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,qBAAqB;IAQ9C;;;;OAIG;IACH,eAAe,CAAC,WAAW,EAAE,iBAAiB,GAAG,qBAAqB;CAKvE"}

package/dist/account/MultiEd25519Account.js

@@ -0,0 +1,134 @@
+import { AccountAddress } from "../core/accountAddress.js";
+import { MultiEd25519Signature } from "../core/crypto/multiEd25519.js";
+import { AccountAuthenticatorMultiEd25519 } from "../transactions/authenticator/account.js";
+import { generateSigningMessageForTransaction } from "../transactions/transactionBuilder/signingMessage.js";
+import { SigningScheme } from "../types/index.js";
+/**
+ * Signer implementation for the Multi-Ed25519 authentication scheme.
+ *
+ * Note: This authentication scheme is a legacy authentication scheme.  Prefer using MultiKeyAccounts as a
+ * MultiKeyAccount can support any type of signer, not just Ed25519.  Generating a signer instance does not
+ * create the account on-chain.
+ */
+export class MultiEd25519Account {
+    publicKey;
+    accountAddress;
+    signingScheme = SigningScheme.MultiEd25519;
+    /**
+     * The signers used to sign messages.  These signers should correspond to public keys in the
+     * MultiEd25519Account.  The number of signers should be equal to this.publicKey.threshold.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    signers;
+    /**
+     * An array of indices where for signer[i], signerIndicies[i] is the index of the corresponding public key in
+     * publicKey.publicKeys.  Used to derive the right public key to use for verification.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    signerIndices;
+    signaturesBitmap;
+    // region Constructors
+    constructor(args) {
+        const { signers, publicKey, address } = args;
+        this.publicKey = publicKey;
+        this.accountAddress = address ? AccountAddress.from(address) : this.publicKey.authKey().derivedAddress();
+        if (publicKey.threshold > signers.length) {
+            throw new Error(`Not enough signers provided to satisfy the required signatures. Need ${publicKey.threshold} signers, but only ${signers.length} provided`);
+        }
+        else if (publicKey.threshold < signers.length) {
+            throw new Error(`More signers provided than required. Need ${publicKey.threshold} signers, but ${signers.length} provided`);
+        }
+        // For each signer, find its corresponding position in the public keys array
+        const bitPositions = [];
+        for (const signer of signers) {
+            bitPositions.push(this.publicKey.getIndex(signer.publicKey()));
+        }
+        // Create pairs of [signer, position] and sort them by position
+        // This sorting is critical because:
+        // 1. The on-chain verification expects signatures to be in ascending order by bit position
+        // 2. The bitmap must match the order of signatures when verifying
+        const signersAndBitPosition = signers.map((signer, index) => [
+            signer,
+            bitPositions[index],
+        ]);
+        signersAndBitPosition.sort((a, b) => a[1] - b[1]);
+        // Extract the sorted signers and their positions into separate arrays
+        this.signers = signersAndBitPosition.map((value) => value[0]);
+        this.signerIndices = signersAndBitPosition.map((value) => value[1]);
+        // Create a bitmap representing which public keys from the MultiEd25519PublicKey are being used
+        // This bitmap is used during signature verification to identify which public keys
+        // should be used to verify each signature
+        this.signaturesBitmap = this.publicKey.createBitmap({ bits: bitPositions });
+    }
+    // endregion
+    // region Account
+    /**
+     * Verify the given message and signature with the public key.
+     *
+     * @param args.message raw message data in HexInput format
+     * @param args.signature signed message Signature
+     * @returns
+     */
+    verifySignature(args) {
+        return this.publicKey.verifySignature(args);
+    }
+    /**
+     * Verify the given message and signature with the public key.
+     *
+     * MultiEd25519 signatures do not depend on chain state, so this function is
+     * equivalent to the synchronous verifySignature method.
+     *
+     * @param args - The arguments for verifying the signature.
+     * @param args.aptosConfig - The configuration object for connecting to the Aptos network
+     * @param args.message - Raw message data in HexInput format.
+     * @param args.signature - Signed message signature.
+     * @returns A boolean indicating whether the signature is valid.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    async verifySignatureAsync(args) {
+        return this.publicKey.verifySignatureAsync({
+            ...args,
+            signature: args.signature,
+        });
+    }
+    /**
+     * Sign a message using the account's Ed25519 private key.
+     * @param message the signing message, as binary input
+     * @return the AccountAuthenticator containing the signature, together with the account's public key
+     */
+    signWithAuthenticator(message) {
+        return new AccountAuthenticatorMultiEd25519(this.publicKey, this.sign(message));
+    }
+    /**
+     * Sign a transaction using the account's Ed25519 private keys.
+     * @param transaction the raw transaction
+     * @return the AccountAuthenticator containing the signature of the transaction, together with the account's public key
+     */
+    signTransactionWithAuthenticator(transaction) {
+        return new AccountAuthenticatorMultiEd25519(this.publicKey, this.signTransaction(transaction));
+    }
+    /**
+     * Sign the given message using the account's Ed25519 private keys.
+     * @param message in HexInput format
+     * @returns MultiEd25519Signature
+     */
+    sign(message) {
+        const signatures = [];
+        for (const signer of this.signers) {
+            signatures.push(signer.sign(message));
+        }
+        return new MultiEd25519Signature({ signatures, bitmap: this.signaturesBitmap });
+    }
+    /**
+     * Sign the given transaction using the available signing capabilities.
+     * @param transaction the transaction to be signed
+     * @returns Signature
+     */
+    signTransaction(transaction) {
+        return this.sign(generateSigningMessageForTransaction(transaction));
+    }
+}
+//# sourceMappingURL=MultiEd25519Account.js.map

package/dist/account/MultiEd25519Account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiEd25519Account.js","sourceRoot":"","sources":["../../src/account/MultiEd25519Account.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAuB,MAAM,2BAA2B,CAAC;AAEhF,OAAO,EAAyB,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC9F,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,EAAE,oCAAoC,EAAE,MAAM,sDAAsD,CAAC;AAE5G,OAAO,EAAY,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAc5D;;;;;;GAMG;AACH,MAAM,OAAO,mBAAmB;IACrB,SAAS,CAAwB;IAEjC,cAAc,CAAiB;IAE/B,aAAa,GAAG,aAAa,CAAC,YAAY,CAAC;IAEpD;;;;;OAKG;IACM,OAAO,CAAsB;IAEtC;;;;;OAKG;IACM,aAAa,CAAW;IAExB,gBAAgB,CAAa;IAEtC,sBAAsB;IAEtB,YAAY,IAAuC;QACjD,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,cAAc,EAAE,CAAC;QAEzG,IAAI,SAAS,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACb,wEAAwE,SAAS,CAAC,SAAS,sBAAsB,OAAO,CAAC,MAAM,WAAW,CAC3I,CAAC;QACJ,CAAC;aAAM,IAAI,SAAS,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CACb,6CAA6C,SAAS,CAAC,SAAS,iBAAiB,OAAO,CAAC,MAAM,WAAW,CAC3G,CAAC;QACJ,CAAC;QAED,4EAA4E;QAC5E,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACjE,CAAC;QAED,+DAA+D;QAC/D,oCAAoC;QACpC,2FAA2F;QAC3F,kEAAkE;QAClE,MAAM,qBAAqB,GAAkC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;YAC1F,MAAM;YACN,YAAY,CAAC,KAAK,CAAC;SACpB,CAAC,CAAC;QACH,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,sEAAsE;QACtE,IAAI,CAAC,OAAO,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,aAAa,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAEpE,+FAA+F;QAC/F,kFAAkF;QAClF,0CAA0C;QAC1C,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,YAAY;IAEZ,iBAAiB;IAEjB;;;;;;OAMG;IACH,eAAe,CAAC,IAAqC;QACnD,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAK1B;QACC,OAAO,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;YACzC,GAAG,IAAI;YACP,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CAAC,OAAiB;QACrC,OAAO,IAAI,gCAAgC,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAClF,CAAC;IAED;;;;OAIG;IACH,gCAAgC,CAAC,WAA8B;QAC7D,OAAO,IAAI,gCAAgC,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC;IACjG,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,OAAiB;QACpB,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,IAAI,qBAAqB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,WAA8B;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,oCAAoC,CAAC,WAAW,CAAC,CAAC,CAAC;IACtE,CAAC;CAGF"}

package/dist/account/MultiKeyAccount.d.ts

@@ -0,0 +1,197 @@
+import type { Account } from "./Account.js";
+import { MultiKey, MultiKeySignature, PublicKey } from "../core/crypto/index.js";
+import { AccountAddress, AccountAddressInput } from "../core/accountAddress.js";
+import { HexInput, SigningScheme } from "../types/index.js";
+import { AccountAuthenticatorMultiKey } from "../transactions/authenticator/account.js";
+import { AnyRawTransaction } from "../transactions/types.js";
+import { type KeylessSigner } from "./keylessSigner.js";
+import { AptosConfig } from "../api/aptosConfig.js";
+import { SingleKeySignerOrLegacyEd25519Account } from "./SingleKeyAccount.js";
+/**
+ * Arguments required to verify a multi-key signature against a given message.
+ *
+ * @param message - The original message that was signed.
+ * @param signature - The multi-key signature to be verified.
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export interface VerifyMultiKeySignatureArgs {
+    message: HexInput;
+    signature: MultiKeySignature;
+}
+/**
+ * Signer implementation for the MultiKey authentication scheme.
+ *
+ * This account utilizes an M of N signing scheme, where M and N are specified in the {@link MultiKey}.
+ * It signs messages using an array of M accounts, each corresponding to a public key in the {@link MultiKey}.
+ *
+ * Note: Generating a signer instance does not create the account on-chain.
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export declare class MultiKeyAccount implements Account, KeylessSigner {
+    /**
+     * Public key associated with the account
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    readonly publicKey: MultiKey;
+    /**
+     * Account address associated with the account
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    readonly accountAddress: AccountAddress;
+    /**
+     * Signing scheme used to sign transactions
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    readonly signingScheme: SigningScheme;
+    /**
+     * The signers used to sign messages.  These signers should correspond to public keys in the
+     * MultiKeyAccount's public key.  The number of signers should be equal to this.publicKey.signaturesRequired.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    readonly signers: Account[];
+    /**
+     * An array of indices where for signer[i], signerIndicies[i] is the index of the corresponding public key in
+     * publicKey.publicKeys.  Used to derive the right public key to use for verification.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    readonly signerIndicies: number[];
+    readonly signaturesBitmap: Uint8Array;
+    /**
+     * Constructs a MultiKeyAccount instance, which requires multiple signatures for transactions.
+     *
+     * @param args - The arguments for creating a MultiKeyAccount.
+     * @param args.multiKey - The multikey of the account consisting of N public keys and a number M representing the required signatures.
+     * @param args.signers - An array of M signers that will be used to sign the transaction.
+     * @param args.address - An optional account address input. If not provided, the derived address from the public key will be used.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    constructor(args: {
+        multiKey: MultiKey;
+        signers: SingleKeySignerOrLegacyEd25519Account[];
+        address?: AccountAddressInput;
+    });
+    /**
+     * Static constructor to create a MultiKeyAccount using the provided public keys and signers.
+     *
+     * @param args - The arguments for creating a MultiKeyAccount.
+     * @param args.publicKeys - The N public keys of the MultiKeyAccount.
+     * @param args.signaturesRequired - The number of signatures required to authorize a transaction.
+     * @param args.signers - An array of M signers that will be used to sign the transaction.
+     * @returns MultiKeyAccount - The newly created MultiKeyAccount.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    static fromPublicKeysAndSigners(args: {
+        address?: AccountAddressInput;
+        publicKeys: PublicKey[];
+        signaturesRequired: number;
+        signers: SingleKeySignerOrLegacyEd25519Account[];
+    }): MultiKeyAccount;
+    /**
+     * Determines if the provided account is a multi-key account.
+     *
+     * @param account - The account to check.
+     * @returns A boolean indicating whether the account is a multi-key account.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    static isMultiKeySigner(account: Account): account is MultiKeyAccount;
+    /**
+     * Sign a message using the account's signers and return an AccountAuthenticator containing the signature along with the
+     * account's public key.
+     * @param message - The signing message, represented as binary input in hexadecimal format.
+     * @returns An instance of AccountAuthenticatorMultiKey that includes the signature and the public key.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    signWithAuthenticator(message: HexInput): AccountAuthenticatorMultiKey;
+    /**
+     * Sign a transaction using the account's signers, returning an AccountAuthenticator that contains the signature and the
+     * account's public key.
+     * @param transaction - The raw transaction to be signed.
+     * @returns An AccountAuthenticatorMultiKey containing the signature of the transaction along with the account's public key.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    signTransactionWithAuthenticator(transaction: AnyRawTransaction): AccountAuthenticatorMultiKey;
+    /**
+     * Waits for any proofs on KeylessAccount signers to be fetched. This ensures that signing with the KeylessAccount does not
+     * fail due to missing proofs.
+     * @return {Promise<void>} A promise that resolves when all proofs have been fetched.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    waitForProofFetch(): Promise<void>;
+    /**
+     * Validates that the Keyless Account can be used to sign transactions.
+     * @return
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    checkKeylessAccountValidity(aptosConfig: AptosConfig): Promise<void>;
+    /**
+     * Sign the given message using the MultiKeyAccount's signers
+     * @param data - The data to be signed in HexInput format.
+     * @returns MultiKeySignature
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    sign(data: HexInput): MultiKeySignature;
+    /**
+     * Sign the given transaction using the MultiKeyAccount's signers.
+     * This function aggregates signatures from all signers associated with the MultiKeyAccount.
+     *
+     * @param transaction - The transaction to be signed.
+     * @returns MultiKeySignature - An object containing the aggregated signatures and a bitmap of the signatures.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    signTransaction(transaction: AnyRawTransaction): MultiKeySignature;
+    /**
+     * Verify the given message and signature with the public keys.
+     *
+     * This function checks if the provided signatures are valid for the given message using the corresponding public keys.
+     * Note: If you are using KeylessAccounts, you must use `verifySignatureAsync` instead.
+     *
+     * @param args - The arguments for verifying the signature.
+     * @param args.message - The raw message data in HexInput format.
+     * @param args.signature - The signed message MultiKeySignature containing multiple signatures.
+     * @returns A boolean indicating whether the signatures are valid for the message.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    verifySignature(args: {
+        message: HexInput;
+        signature: MultiKeySignature;
+    }): boolean;
+    /**
+     * Verify the given message and signature with the public keys.
+     *
+     * This function checks if the provided signatures are valid for the given message using the corresponding public keys.
+     *
+     * @param args - The arguments for verifying the signature.
+     * @param args.message - The raw message data in HexInput format.
+     * @param args.signature - The signed message MultiKeySignature containing multiple signatures.
+     * @param args.options.throwErrorWithReason - Whether to throw an error with the reason for the verification failure.
+     * @returns A boolean indicating whether the signatures are valid for the message.
+     * @group Implementation
+     * @category Account (On-Chain Model)
+     */
+    verifySignatureAsync(args: {
+        aptosConfig: AptosConfig;
+        message: HexInput;
+        signature: MultiKeySignature;
+        options?: {
+            throwErrorWithReason?: boolean;
+        };
+    }): Promise<boolean>;
+}
+//# sourceMappingURL=MultiKeyAccount.d.ts.map

package/dist/account/MultiKeyAccount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiKeyAccount.d.ts","sourceRoot":"","sources":["../../src/account/MultiKeyAccount.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAI7D,OAAO,EAAmB,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAqC,qCAAqC,EAAE,MAAM,uBAAuB,CAAC;AAGjH;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,QAAQ,CAAC;IAClB,SAAS,EAAE,iBAAiB,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,qBAAa,eAAgB,YAAW,OAAO,EAAE,aAAa;IAC5D;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAExC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,aAAa,CAA0B;IAE/D;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC;IAE5B;;;;;OAKG;IAEH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;IAElC,QAAQ,CAAC,gBAAgB,EAAE,UAAU,CAAC;IAEtC;;;;;;;;;OASG;gBACS,IAAI,EAAE;QAChB,QAAQ,EAAE,QAAQ,CAAC;QACnB,OAAO,EAAE,qCAAqC,EAAE,CAAC;QACjD,OAAO,CAAC,EAAE,mBAAmB,CAAC;KAC/B;IA4CD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE;QACpC,OAAO,CAAC,EAAE,mBAAmB,CAAC;QAC9B,UAAU,EAAE,SAAS,EAAE,CAAC;QACxB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,OAAO,EAAE,qCAAqC,EAAE,CAAC;KAClD,GAAG,eAAe;IAMnB;;;;;;;OAOG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,eAAe;IAIrE;;;;;;;OAOG;IACH,qBAAqB,CAAC,OAAO,EAAE,QAAQ,GAAG,4BAA4B;IAItE;;;;;;;OAOG;IACH,gCAAgC,CAAC,WAAW,EAAE,iBAAiB,GAAG,4BAA4B;IAI9F;;;;;;OAMG;IACG,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAMxC;;;;;OAKG;IACG,2BAA2B,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1E;;;;;;OAMG;IACH,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,iBAAiB;IAQvC;;;;;;;;OAQG;IACH,eAAe,CAAC,WAAW,EAAE,iBAAiB,GAAG,iBAAiB;IAQlE;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,QAAQ,CAAC;QAAC,SAAS,EAAE,iBAAiB,CAAA;KAAE,GAAG,OAAO;IAInF;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,IAAI,EAAE;QAC/B,WAAW,EAAE,WAAW,CAAC;QACzB,OAAO,EAAE,QAAQ,CAAC;QAClB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,OAAO,CAAC,EAAE;YAAE,oBAAoB,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC;KAC9C,GAAG,OAAO,CAAC,OAAO,CAAC;CAGrB"}