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 full)

AccountPublicKey
- FederatedKeylessPublicKey

Index

Constructors

constructor

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

Methods

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:40

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:29

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:40

serialize

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

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:44

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:49

toUint8Array

toUint8Array(): Uint8Array
Get the raw public key bytes

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

verifySignature

verifySignature(args): boolean
Verifies a signed data with a public key
Parameters
- args: {
  message: HexInput;
  signature: KeylessSignature;
  }
  - message: HexInput
    message
  - signature: KeylessSignature
    The signature
Returns boolean
true if the signature is valid
Overrides AccountPublicKey.verifySignature
- Defined in src/core/crypto/federatedKeyless.ts:58

`Static`create

create(args): 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:87

`Static`deserialize

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

`Static`fromJwtAndPepper

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

`Static`isInstance

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

`Static`isPublicKey

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

Properties

`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.

Class FederatedKeylessPublicKey

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns FederatedKeylessPublicKey

Methods

authKey

Returns AuthenticationKey

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

serialize

Parameters

Returns void

toString

Returns string

toStringWithoutPrefix

Returns string

toUint8Array

Returns Uint8Array

verifySignature

Parameters

message: HexInput

signature: KeylessSignature

Returns boolean

Staticcreate

Parameters

aud: string

iss: string

jwkAddress: AccountAddressInput

pepper: HexInput

uidKey: string

uidVal: string

Returns FederatedKeylessPublicKey

Staticdeserialize

Parameters

Returns FederatedKeylessPublicKey

StaticfromJwtAndPepper

Parameters

jwkAddress: AccountAddressInput

jwt: string

pepper: HexInput

OptionaluidKey?: string

Returns FederatedKeylessPublicKey

StaticisInstance

Parameters

Returns boolean

StaticisPublicKey

Parameters

Returns publicKey is FederatedKeylessPublicKey

Properties

ReadonlyjwkAddress

ReadonlykeylessPublicKey

Settings

On This Page

`Static`create

`Static`deserialize

`Static`fromJwtAndPepper

`Optional`uidKey?: string

`Static`isInstance

`Static`isPublicKey

`Readonly`jwkAddress

`Readonly`keylessPublicKey