Class FederatedKeylessPublicKey

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.

Hierarchy (View Summary)

AccountPublicKey
- FederatedKeylessPublicKey

Index

Implementation - BCS

bcsToBytes

bcsToBytes(): Uint8Array
Serializes a Serializable value to its BCS representation. This function is the TypeScript SDK equivalent of bcs::to_bytes in Move.

Returns Uint8Array
the BCS representation of the Serializable instance as a byte buffer.
Inherited from AccountPublicKey.bcsToBytes
- Defined in src/bcs/serializer.ts:45

bcsToHex

bcsToHex(): Hex
Converts the BCS-serialized bytes of a value into a Hex instance. This function provides a Hex representation of the BCS-serialized data for easier handling and manipulation.

Returns Hex
A Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array.
Inherited from AccountPublicKey.bcsToHex
- Defined in src/bcs/serializer.ts:58

Implementation - Serialization

`Readonly`jwkAddress

jwkAddress: AccountAddress

The address that contains the JWK set to be used for verification.

`Readonly`keylessPublicKey

keylessPublicKey: KeylessPublicKey

The inner public key which contains the standard Keyless public key.

authKey

authKey(): AuthenticationKey
Get the authentication key for the federated keyless public key

Returns AuthenticationKey
AuthenticationKey
Overrides AccountPublicKey.authKey
- Defined in src/core/crypto/federatedKeyless.ts:57

toString

toString(): string
Get the public key as a hex string with a 0x prefix.

Returns string
The public key in hex format.
Inherited from AccountPublicKey.toString
- Defined in src/core/crypto/publicKey.ts:84

toUint8Array

toUint8Array(): Uint8Array
Get the raw public key bytes

Returns Uint8Array
Inherited from AccountPublicKey.toUint8Array
- Defined in src/core/crypto/publicKey.ts:73

verifySignature

verifySignature(
    args: {
        jwk: MoveJWK;
        keylessConfig: KeylessConfiguration;
        message: HexInput;
        signature: Signature;
    },
): boolean
Verifies a signed data with a public key
Parameters
- args: {
      jwk: MoveJWK;
      keylessConfig: KeylessConfiguration;
      message: HexInput;
      signature: Signature;
  }
  - jwk: MoveJWK
    The JWK to use for verification.
  - keylessConfig: KeylessConfiguration
    The keyless configuration to use for verification.
  - message: HexInput
    message
  - signature: Signature
    The signature
Returns boolean
true if the signature is valid
Overrides AccountPublicKey.verifySignature
- Defined in src/core/crypto/federatedKeyless.ts:78

`Static`create

create(
    args: {
        aud: string;
        iss: string;
        jwkAddress: AccountAddressInput;
        pepper: HexInput;
        uidKey: string;
        uidVal: string;
    },
): FederatedKeylessPublicKey
Creates a FederatedKeylessPublicKey from the JWT components plus pepper
Parameters
- args: {
      aud: string;
      iss: string;
      jwkAddress: AccountAddressInput;
      pepper: HexInput;
      uidKey: string;
      uidVal: string;
  }
  - aud: string
    the client ID of the application
  - iss: string
    the iss of the identity
  - jwkAddress: AccountAddressInput
  - pepper: HexInput
    The pepper used to maintain privacy of the account
  - uidKey: string
    the key to use to get the uidVal in the JWT token
  - uidVal: string
    the value of the uidKey in the JWT token
Returns FederatedKeylessPublicKey
FederatedKeylessPublicKey
- Defined in src/core/crypto/federatedKeyless.ts:141

Constructors

constructor

new FederatedKeylessPublicKey(
jwkAddress: AccountAddressInput,
keylessPublicKey: KeylessPublicKey,
): FederatedKeylessPublicKey
Parameters
- jwkAddress: AccountAddressInput
- keylessPublicKey: KeylessPublicKey
Returns FederatedKeylessPublicKey
Overrides AccountPublicKey.constructor
- Defined in src/core/crypto/federatedKeyless.ts:44

Methods

serialize

serialize(serializer: Serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides AccountPublicKey.serialize
- Defined in src/core/crypto/federatedKeyless.ts:92

toStringWithoutPrefix

toStringWithoutPrefix(): string
Returns the hex string representation of the Serializable value without the 0x prefix.

Returns string
the hex format as a string without 0x prefix.
Inherited from AccountPublicKey.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:67

verifySignatureAsync

verifySignatureAsync(
    args: {
        aptosConfig: AptosConfig;
        message: HexInput;
        options?: { throwErrorWithReason?: boolean };
        signature: KeylessSignature;
    },
): Promise<boolean>
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.
Parameters
- args: {
      aptosConfig: AptosConfig;
      message: HexInput;
      options?: { throwErrorWithReason?: boolean };
      signature: KeylessSignature;
  }
  - aptosConfig: AptosConfig
    The aptos config to use for fetching the keyless configuration.
  - message: HexInput
    The message to verify the signature against.
  - Optionaloptions?: { throwErrorWithReason?: boolean }
    OptionalthrowErrorWithReason?: boolean
    Whether to throw an error with the reason for the failure instead of returning false.
  - signature: KeylessSignature
    The signature to verify.
Returns Promise<boolean>
true if the signature is valid
Overrides AccountPublicKey.verifySignatureAsync
- Defined in src/core/crypto/federatedKeyless.ts:117

`Static`deserialize

deserialize(deserializer: Deserializer): FederatedKeylessPublicKey
Parameters
- deserializer: Deserializer
Returns FederatedKeylessPublicKey
- Defined in src/core/crypto/federatedKeyless.ts:97

`Static`fromJwtAndPepper

fromJwtAndPepper(
    args: {
        jwkAddress: AccountAddressInput;
        jwt: string;
        pepper: HexInput;
        uidKey?: string;
    },
): FederatedKeylessPublicKey
Parameters
- args: {
      jwkAddress: AccountAddressInput;
      jwt: string;
      pepper: HexInput;
      uidKey?: string;
  }
Returns FederatedKeylessPublicKey
- Defined in src/core/crypto/federatedKeyless.ts:152

`Static`isInstance

isInstance(publicKey: PublicKey): boolean
Parameters
- publicKey: PublicKey
Returns boolean
- Defined in src/core/crypto/federatedKeyless.ts:161

`Static`isPublicKey

isPublicKey(publicKey: PublicKey): publicKey is FederatedKeylessPublicKey
Parameters
- publicKey: PublicKey
Returns publicKey is FederatedKeylessPublicKey
- Defined in src/core/crypto/federatedKeyless.ts:103

Class FederatedKeylessPublicKey

Hierarchy (View Summary)

Index

Implementation - BCS

Implementation - Serialization

Constructors

Methods

Implementation - BCS

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

Implementation - Serialization

ReadonlyjwkAddress

ReadonlykeylessPublicKey

authKey

Returns AuthenticationKey

toString

Returns string

toUint8Array

Returns Uint8Array

verifySignature

Parameters

jwk: MoveJWK

keylessConfig: KeylessConfiguration

message: HexInput

signature: Signature

Returns boolean

Staticcreate

Parameters

aud: string

iss: string

jwkAddress: AccountAddressInput

pepper: HexInput

uidKey: string

uidVal: string

Returns FederatedKeylessPublicKey

Constructors

constructor

Parameters

Returns FederatedKeylessPublicKey

Methods

serialize

Parameters

Returns void

toStringWithoutPrefix

Returns string

verifySignatureAsync

Parameters

aptosConfig: AptosConfig

message: HexInput

Optionaloptions?: { throwErrorWithReason?: boolean }

OptionalthrowErrorWithReason?: boolean

signature: KeylessSignature

Returns Promise<boolean>

Staticdeserialize

Parameters

Returns FederatedKeylessPublicKey

StaticfromJwtAndPepper

Parameters

Returns FederatedKeylessPublicKey

StaticisInstance

Parameters

Returns boolean

StaticisPublicKey

Parameters

Returns publicKey is FederatedKeylessPublicKey

Settings

On This Page

`Readonly`jwkAddress

`Readonly`keylessPublicKey

`Static`create

`Optional`options?: { throwErrorWithReason?: boolean }

`Optional`throwErrorWithReason?: boolean

`Static`deserialize

`Static`fromJwtAndPepper

`Static`isInstance

`Static`isPublicKey