@aptos-labs/ts-sdk 1.36.0 → 1.37.1

package/src/core/crypto/ed25519.ts

@@ -9,7 +9,7 @@ import { Hex } from "../hex";
 import { HexInput, SigningScheme as AuthenticationKeyScheme, PrivateKeyVariants } from "../../types";
 import { CKDPriv, deriveKey, HARDENED_OFFSET, isValidHardenedPath, mnemonicToSeed, splitPath } from "./hdKey";
 import { PrivateKey } from "./privateKey";
-import { AccountPublicKey, PublicKey, VerifySignatureArgs } from "./publicKey";
+import { AccountPublicKey, PublicKey, VerifySignatureArgs, VerifySignatureAsyncArgs } from "./publicKey";
 import { Signature } from "./signature";
 import { convertSigningMessage } from "./utils";
 
@@ -120,6 +120,24 @@ export class Ed25519PublicKey extends AccountPublicKey {
     return ed25519.verify(signatureBytes, messageBytes, publicKeyBytes);
   }
 
+  /**
+   * Note: Ed25519Signatures can be verified syncronously.
+   *
+   * Verifies the provided signature against the given message.
+   * This function helps ensure the integrity and authenticity of the message by confirming that the signature is valid.
+   *
+   * @param args - The arguments for signature verification.
+   * @param args.aptosConfig - The configuration object for connecting to the Aptos network
+   * @param args.message - The message that was signed.
+   * @param args.signature - The signature to verify, which must be an instance of Secp256k1Signature.
+   * @returns A boolean indicating whether the signature is valid for the given message.
+   * @group Implementation
+   * @category Serialization
+   */
+  async verifySignatureAsync(args: VerifySignatureAsyncArgs): Promise<boolean> {
+    return this.verifySignature(args);
+  }
+
   /**
    * Generates an authentication key from the public key using the Ed25519 scheme.
    * This function is essential for creating a secure authentication key that can be used for further cryptographic operations.

package/src/core/crypto/ephemeral.ts

@@ -4,6 +4,7 @@ import { PublicKey } from "./publicKey";
 import { Signature } from "./signature";
 import { Ed25519PublicKey, Ed25519Signature } from "./ed25519";
 import { Hex } from "../hex";
+import { AptosConfig } from "../../api";
 
 /**
  * Represents ephemeral public keys for Aptos Keyless accounts.
@@ -64,6 +65,14 @@ export class EphemeralPublicKey extends PublicKey {
     return this.publicKey.verifySignature({ message, signature: signature.signature });
   }
 
+  async verifySignatureAsync(args: {
+    aptosConfig: AptosConfig;
+    message: HexInput;
+    signature: EphemeralSignature;
+  }): Promise<boolean> {
+    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.

package/src/core/crypto/federatedKeyless.ts

@@ -6,7 +6,16 @@ import { Deserializer, Serializer } from "../../bcs";
 import { HexInput, AnyPublicKeyVariant, SigningScheme } from "../../types";
 import { AuthenticationKey } from "../authenticationKey";
 import { AccountAddress, AccountAddressInput } from "../accountAddress";
-import { KeylessPublicKey, KeylessSignature } from "./keyless";
+import {
+  KeylessConfiguration,
+  KeylessPublicKey,
+  KeylessSignature,
+  MoveJWK,
+  verifyKeylessSignature,
+  verifyKeylessSignatureWithJwkAndConfig,
+} from "./keyless";
+import { AptosConfig } from "../../api";
+import { Signature } from "..";
 
 /**
  * Represents the FederatedKeylessPublicKey public key
@@ -60,13 +69,24 @@ export class FederatedKeylessPublicKey extends AccountPublicKey {
    *
    * @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
    */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars, class-methods-use-this
-  verifySignature(args: { message: HexInput; signature: KeylessSignature }): boolean {
-    throw new Error("Not yet implemented");
+  verifySignature(args: {
+    message: HexInput;
+    signature: Signature;
+    jwk: MoveJWK;
+    keylessConfig: KeylessConfiguration;
+  }): boolean {
+    try {
+      verifyKeylessSignatureWithJwkAndConfig({ ...args, publicKey: this });
+      return true;
+    } catch (error) {
+      return false;
+    }
   }
 
   serialize(serializer: Serializer): void {
@@ -84,6 +104,28 @@ export class FederatedKeylessPublicKey extends AccountPublicKey {
     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: {
+    aptosConfig: AptosConfig;
+    message: HexInput;
+    signature: KeylessSignature;
+    options?: { throwErrorWithReason?: boolean };
+  }): Promise<boolean> {
+    return verifyKeylessSignature({
+      ...args,
+      publicKey: this,
+    });
+  }
+
   /**
    * Creates a FederatedKeylessPublicKey from the JWT components plus pepper
    *

package/src/core/crypto/index.ts

@@ -1,13 +1,14 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
+export * from "./abstraction";
 export * from "./ed25519";
-export * from "./hdKey";
-export * from "./multiEd25519";
-export * from "./multiKey";
 export * from "./ephemeral";
 export * from "./federatedKeyless";
+export * from "./hdKey";
 export * from "./keyless";
+export * from "./multiEd25519";
+export * from "./multiKey";
 export * from "./poseidon";
 export * from "./privateKey";
 export * from "./publicKey";