Class FederatedKeylessPublicKey

constructor

• new FederatedKeylessPublicKey(jwkAddress, keylessPublicKey): FederatedKeylessPublicKey

• Parameters

  • jwkAddress: AccountAddressInput
  • keylessPublicKey: KeylessPublicKey

  Returns FederatedKeylessPublicKey

Readonly jwkAddress

Readonly keylessPublicKey

authKey

• authKey(): AuthenticationKey

• Get the authentication key for the federated keyless public key

  Returns AuthenticationKey

  AuthenticationKey

serialize

• serialize(serializer): void

• Parameters

  • serializer: Serializer

  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

  • args: {
        message: HexInput;
        signature: KeylessSignature;
    }

    • message: HexInput

      message

    • signature: KeylessSignature

      The signature

  Returns boolean

  true if the signature is valid

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

Static deserialize

• deserialize(deserializer): FederatedKeylessPublicKey

• Parameters

  • deserializer: Deserializer

  Returns FederatedKeylessPublicKey

Static fromJwtAndPepper

• fromJwtAndPepper(args): FederatedKeylessPublicKey

• Parameters

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

    • jwkAddress: AccountAddressInput

    • jwt: string

    • pepper: HexInput

    • Optional uidKey?: string

  Returns FederatedKeylessPublicKey

Static isInstance

• isInstance(publicKey): boolean

• Parameters

  • publicKey: PublicKey

  Returns boolean

Static isPublicKey

• isPublicKey(publicKey): publicKey is FederatedKeylessPublicKey

• Parameters

  • publicKey: PublicKey

  Returns publicKey is FederatedKeylessPublicKey