@aptos-labs/ts-sdk 1.27.0 → 1.27.1-zeta.0

package/src/api/keyless.ts

@@ -2,11 +2,17 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { EphemeralKeyPair, KeylessAccount, ProofFetchCallback } from "../account";
-import { ZeroKnowledgeSig } from "../core";
-import { deriveKeylessAccount, getPepper, getProof } from "../internal/keyless";
+import { FederatedKeylessAccount } from "../account/FederatedKeylessAccount";
+import { AccountAddressInput, ZeroKnowledgeSig } from "../core";
+import { deriveFederatedKeylessAccount, deriveKeylessAccount, getPepper, getProof } from "../internal/keyless";
 import { HexInput } from "../types";
 import { AptosConfig } from "./aptosConfig";
 
+
+interface InputGenerateMultiAgentRawTransactionData {
+  jwkAddress: AccountAddressInput;
+}
+
 /**
  * A class to query all `Keyless` related queries on Aptos.
  *
@@ -51,6 +57,27 @@ export class Keyless {
   }): Promise<ZeroKnowledgeSig> {
     return getProof({ aptosConfig: this.config, ...args });
   }
+  
+  async deriveKeylessAccount(
+    args: {
+      jwt: string;
+      ephemeralKeyPair: EphemeralKeyPair;
+      uidKey?: string;
+      pepper?: HexInput;
+      proofFetchCallback?: ProofFetchCallback;
+    },
+  ): Promise<KeylessAccount>;
+
+  async deriveKeylessAccount(
+    args: {
+      jwt: string;
+      ephemeralKeyPair: EphemeralKeyPair;
+      jwkAddress: AccountAddressInput;
+      uidKey?: string;
+      pepper?: HexInput;
+      proofFetchCallback?: ProofFetchCallback;
+    } & InputGenerateMultiAgentRawTransactionData,
+  ): Promise<FederatedKeylessAccount>;
 
   /**
    * Derives the Keyless Account from the JWT token and corresponding EphemeralKeyPair.  It will lookup the pepper from
@@ -69,10 +96,15 @@ export class Keyless {
   async deriveKeylessAccount(args: {
     jwt: string;
     ephemeralKeyPair: EphemeralKeyPair;
+    jwkAddress?: AccountAddressInput;
     uidKey?: string;
     pepper?: HexInput;
     proofFetchCallback?: ProofFetchCallback;
-  }): Promise<KeylessAccount> {
+  }): Promise<KeylessAccount | FederatedKeylessAccount> {
+    const { jwkAddress } = args;
+    if(jwkAddress !== undefined) {
+      return deriveFederatedKeylessAccount({ aptosConfig: this.config, jwkAddress, ...args });
+    }
     return deriveKeylessAccount({ aptosConfig: this.config, ...args });
   }
 }

package/src/bcs/deserializer.ts

@@ -37,6 +37,15 @@ export class Deserializer {
     return bytes;
   }
 
+  /**
+   * Returns the number of bytes remaining in the buffer.
+   *
+   * Useful to tell if there's more data to be read.
+   */
+  remaining(): number {
+    return this.buffer.byteLength - this.offset;
+  }
+
   /**
    * Deserializes a string. UTF8 string is supported. Reads the string's bytes length "l" first,
    * and then reads "l" bytes of content. Decodes the byte array into a string.

package/src/bcs/serializable/moveStructs.ts

@@ -244,7 +244,8 @@ export class MoveString extends Serializable implements TransactionArgument {
 
   serializeForScriptFunction(serializer: Serializer): void {
     // Serialize the string as a fixed byte string, i.e., without the length prefix
-    const fixedStringBytes = this.bcsToBytes().slice(1);
+    const textEncoder = new TextEncoder();
+    const fixedStringBytes = textEncoder.encode(this.value);
     // Put those bytes into a vector<u8> and serialize it as a script function argument
     const vectorU8 = MoveVector.U8(fixedStringBytes);
     vectorU8.serializeForScriptFunction(serializer);

package/src/core/crypto/federatedKeyless.ts

@@ -0,0 +1,134 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+import { AccountPublicKey, PublicKey } from "./publicKey";
+import { Deserializer, Serializer } from "../../bcs";
+import { Hex } from "../hex";
+import { HexInput, AnyPublicKeyVariant, SigningScheme } from "../../types";
+import { AuthenticationKey } from "../authenticationKey";
+import { AccountAddress, AccountAddressInput } from "../accountAddress";
+import { KeylessPublicKey, KeylessSignature } from "./keyless";
+
+/**
+ * Represents the FederatedKeylessPublicKey public key
+ *
+ * These keys use an onchain address as a source of truth for the JWK used to verify signatures.
+ *
+ * FederatedKeylessPublicKey authentication key is represented in the SDK as `AnyPublicKey`.
+ */
+export class FederatedKeylessPublicKey extends AccountPublicKey {
+  /**
+   * The address that contains the JWK set to be used for verification.
+   */
+  readonly jwkAddress: AccountAddress;
+
+  /**
+   * The inner public key which contains the standard Keyless public key.
+   */
+  readonly keylessPublicKey: KeylessPublicKey;
+
+  constructor(jwkAddress: AccountAddressInput, keylessPublicKey: KeylessPublicKey) {
+    super();
+    this.jwkAddress = AccountAddress.from(jwkAddress);
+    this.keylessPublicKey = keylessPublicKey;
+  }
+
+  /**
+   * Get the authentication key for the federated keyless public key
+   *
+   * @returns AuthenticationKey
+   */
+  authKey(): AuthenticationKey {
+    const serializer = new Serializer();
+    serializer.serializeU32AsUleb128(AnyPublicKeyVariant.FederatedKeyless);
+    serializer.serializeFixedBytes(this.bcsToBytes());
+    return AuthenticationKey.fromSchemeAndBytes({
+      scheme: SigningScheme.SingleKey,
+      input: serializer.toUint8Array(),
+    });
+  }
+
+  /**
+   * Get the public key in bytes (Uint8Array).
+   *
+   * @returns Uint8Array representation of the public key
+   */
+  toUint8Array(): Uint8Array {
+    return this.bcsToBytes();
+  }
+
+  /**
+   * Get the public key as a hex string with the 0x prefix.
+   *
+   * @returns string representation of the public key
+   */
+  toString(): string {
+    return Hex.fromHexInput(this.toUint8Array()).toString();
+  }
+
+  /**
+   * Verifies a signed data with a public key
+   *
+   * @param args.message message
+   * @param args.signature The signature
+   * @returns true if the signature is valid
+   */
+  // 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");
+  }
+
+  serialize(serializer: Serializer): void {
+    this.jwkAddress.serialize(serializer);
+    this.keylessPublicKey.serialize(serializer);
+  }
+
+  static deserialize(deserializer: Deserializer): FederatedKeylessPublicKey {
+    const jwkAddress = AccountAddress.deserialize(deserializer);
+    const keylessPublicKey = KeylessPublicKey.deserialize(deserializer);
+    return new FederatedKeylessPublicKey(jwkAddress, keylessPublicKey);
+  }
+
+  static isPublicKey(publicKey: PublicKey): publicKey is FederatedKeylessPublicKey {
+    return publicKey instanceof FederatedKeylessPublicKey;
+  }
+
+  /**
+   * 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
+   */
+  static create(args: {
+    iss: string;
+    uidKey: string;
+    uidVal: string;
+    aud: string;
+    pepper: HexInput;
+    jwkAddress: AccountAddressInput;
+  }): FederatedKeylessPublicKey {
+    return new FederatedKeylessPublicKey(args.jwkAddress, KeylessPublicKey.create(args));
+  }
+
+  static fromJwtAndPepper(args: {
+    jwt: string;
+    pepper: HexInput;
+    jwkAddress: AccountAddressInput;
+    uidKey?: string;
+  }): FederatedKeylessPublicKey {
+    return new FederatedKeylessPublicKey(args.jwkAddress, KeylessPublicKey.fromJwtAndPepper(args));
+  }
+
+  static isInstance(publicKey: PublicKey) {
+    return (
+      "jwkAddress" in publicKey &&
+      publicKey.jwkAddress instanceof AccountAddress &&
+      "keylessPublicKey" in publicKey &&
+      publicKey.keylessPublicKey instanceof KeylessPublicKey
+    );
+  }
+}

package/src/core/crypto/singleKey.ts

@@ -6,6 +6,7 @@ import { AccountPublicKey, PublicKey, VerifySignatureArgs } from "./publicKey";
 import { Secp256k1PublicKey, Secp256k1Signature } from "./secp256k1";
 import { KeylessPublicKey, KeylessSignature } from "./keyless";
 import { Signature } from "./signature";
+import { FederatedKeylessPublicKey } from "./federatedKeyless";
 
 /**
  * Represents any public key supported by Aptos.
@@ -37,6 +38,8 @@ export class AnyPublicKey extends AccountPublicKey {
       this.variant = AnyPublicKeyVariant.Secp256k1;
     } else if (publicKey instanceof KeylessPublicKey) {
       this.variant = AnyPublicKeyVariant.Keyless;
+    } else if (publicKey instanceof FederatedKeylessPublicKey) {
+      this.variant = AnyPublicKeyVariant.FederatedKeyless;
     } else {
       throw new Error("Unsupported public key type");
     }
@@ -91,6 +94,9 @@ export class AnyPublicKey extends AccountPublicKey {
       case AnyPublicKeyVariant.Keyless:
         publicKey = KeylessPublicKey.deserialize(deserializer);
         break;
+      case AnyPublicKeyVariant.FederatedKeyless:
+        publicKey = FederatedKeylessPublicKey.deserialize(deserializer);
+        break;
       default:
         throw new Error(`Unknown variant index for AnyPublicKey: ${variantIndex}`);
     }

package/src/internal/keyless.ts

@@ -10,6 +10,7 @@
 import { AptosConfig } from "../api/aptosConfig";
 import { postAptosPepperService, postAptosProvingService } from "../client";
 import {
+  AccountAddressInput,
   EphemeralSignature,
   Groth16Zkp,
   Hex,
@@ -23,6 +24,8 @@ import { EphemeralKeyPair, KeylessAccount, ProofFetchCallback } from "../account
 import { PepperFetchRequest, PepperFetchResponse, ProverRequest, ProverResponse } from "../types/keyless";
 import { nowInSeconds } from "../utils/helpers";
 import { lookupOriginalAccountAddress } from "./account";
+import { FederatedKeylessPublicKey } from "../core/crypto/federatedKeyless";
+import { FederatedKeylessAccount } from "../account/FederatedKeylessAccount";
 
 export async function getPepper(args: {
   aptosConfig: AptosConfig;
@@ -123,7 +126,33 @@ export async function deriveKeylessAccount(args: {
     authenticationKey: publicKey.authKey().derivedAddress(),
   });
 
-  const keylessAccount = KeylessAccount.create({ ...args, address, proof, pepper, proofFetchCallback });
+  return KeylessAccount.create({ ...args, address, proof, pepper, proofFetchCallback });
+}
+
+export async function deriveFederatedKeylessAccount(args: {
+  aptosConfig: AptosConfig;
+  jwt: string;
+  ephemeralKeyPair: EphemeralKeyPair;
+  jwkAddress: AccountAddressInput;
+  uidKey?: string;
+  pepper?: HexInput;
+  proofFetchCallback?: ProofFetchCallback;
+}): Promise<FederatedKeylessAccount> {
+  const { aptosConfig, jwt, jwkAddress, uidKey, proofFetchCallback, pepper = await getPepper(args) } = args;
+  const proofPromise = getProof({ ...args, pepper });
+  // If a callback is provided, pass in the proof as a promise to KeylessAccount.create.  This will make the proof be fetched in the
+  // background and the callback will handle the outcome of the fetch.  This allows the developer to not have to block on the proof fetch
+  // allowing for faster rendering of UX.
+  //
+  // If no callback is provided, the just await the proof fetch and continue syncronously.
+  const proof = proofFetchCallback ? proofPromise : await proofPromise;
+
+  // Look up the original address to handle key rotations
+  const publicKey = FederatedKeylessPublicKey.fromJwtAndPepper({ jwt, pepper, jwkAddress, uidKey });
+  const address = await lookupOriginalAccountAddress({
+    aptosConfig,
+    authenticationKey: publicKey.authKey().derivedAddress(),
+  });
 
-  return keylessAccount;
+  return FederatedKeylessAccount.create({ ...args, address, proof, pepper, proofFetchCallback });
 }

package/src/internal/move/jwks/build/jwk/BuildInfo.yaml

@@ -0,0 +1,56 @@
+---
+compiled_package_info:
+  package_name: jwk
+  address_alias_instantiation:
+    Extensions: "0000000000000000000000000000000000000000000000000000000000000001"
+    aptos_framework: "0000000000000000000000000000000000000000000000000000000000000001"
+    aptos_fungible_asset: 000000000000000000000000000000000000000000000000000000000000000a
+    aptos_std: "0000000000000000000000000000000000000000000000000000000000000001"
+    aptos_token: "0000000000000000000000000000000000000000000000000000000000000003"
+    core_resources: 000000000000000000000000000000000000000000000000000000000a550c18
+    std: "0000000000000000000000000000000000000000000000000000000000000001"
+    vm: "0000000000000000000000000000000000000000000000000000000000000000"
+    vm_reserved: "0000000000000000000000000000000000000000000000000000000000000000"
+  source_digest: 3437D4FB002907781F0FE5D46FC4E668C8B8F0420AA77751774AD63B0C2730BF
+  build_flags:
+    dev_mode: false
+    test_mode: false
+    override_std: ~
+    generate_docs: false
+    generate_abis: false
+    generate_move_model: true
+    full_model_generation: false
+    install_dir: ~
+    force_recompilation: false
+    additional_named_addresses: {}
+    architecture: ~
+    fetch_deps_only: false
+    skip_fetch_latest_git_deps: false
+    compiler_config:
+      bytecode_version: 6
+      known_attributes:
+        - bytecode_instruction
+        - deprecated
+        - event
+        - expected_failure
+        - "fmt::skip"
+        - legacy_entry_fun
+        - "lint::allow_unsafe_randomness"
+        - "lint::skip"
+        - native_interface
+        - randomness
+        - resource_group
+        - resource_group_member
+        - test
+        - test_only
+        - verify_only
+        - view
+      skip_attribute_checks: false
+      compiler_version: ~
+      language_version: ~
+      experiments:
+        - optimize=on
+dependencies:
+  - AptosFramework
+  - AptosStdlib
+  - MoveStdlib