Class KeylessPublicKey

Represents the KeylessPublicKey public key

KeylessPublicKey authentication key is represented in the SDK as AnyPublicKey.

Hierarchy (view full)

Constructors

constructor

Properties

idCommitment iss ID_COMMITMENT_LENGTH

Methods

authKey bcsToBytes bcsToHex serialize toString toUint8Array verifySignature create deserialize fromJwtAndPepper isInstance isPublicKey load

Constructors

constructor

Properties

ReadonlyidCommitment

idCommitment: Uint8Array

A value representing a cryptographic commitment to a user identity.

It is calculated from the aud, uidKey, uidVal, pepper.

Readonlyiss

iss: string

The value of the 'iss' claim on the JWT which identifies the OIDC provider.

Static ReadonlyID_COMMITMENT_LENGTH

ID_COMMITMENT_LENGTH: number

The number of bytes that idCommitment should be

Methods

authKey

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

bcsToHex

  • bcsToHex(): Hex

  • Helper function to get a value's BCS-serialized bytes as a Hex instance.

    Returns Hex

    a Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array

serialize

  • serialize(serializer): void

  • Parameters

    Returns void

toString

  • toString(): string

  • Get the public key as a hex string with the 0x prefix.

    Returns string

    string representation of the public key

toUint8Array

  • toUint8Array(): Uint8Array

  • Get the public key in bytes (Uint8Array).

    Returns Uint8Array

    Uint8Array representation of the public key

verifySignature

  • verifySignature(args): boolean

  • Verifies a signed data with a public key

    Parameters

    Returns boolean

    true if the signature is valid

Staticcreate

  • create(args): KeylessPublicKey

  • Creates a KeylessPublicKey from the JWT components plus pepper

    Parameters

    • args: {
          aud: string;
          iss: string;
          pepper: HexInput;
          uidKey: string;
          uidVal: string;
      }
      • aud: string

        the client ID of the application

      • iss: string

        the iss of the identity

      • 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 KeylessPublicKey

    KeylessPublicKey

Staticdeserialize

StaticfromJwtAndPepper

  • fromJwtAndPepper(args): KeylessPublicKey

  • Parameters

    • args: {
          jwt: string;
          pepper: HexInput;
          uidKey?: string;
      }
      • jwt: string
      • pepper: HexInput
      • OptionaluidKey?: string

    Returns KeylessPublicKey

StaticisInstance

  • isInstance(publicKey): boolean

  • Parameters

    Returns boolean

StaticisPublicKey

  • isPublicKey(publicKey): publicKey is KeylessPublicKey

  • Parameters

    Returns publicKey is KeylessPublicKey

Staticload

Settings

Member Visibility

On This Page

Constructors
Properties
Methods