Class ZeroKnowledgeSig

The signature representation of a proof

Hierarchy (view full)

Constructors

constructor

Properties

expHorizonSecs extraField? overrideAudVal? proof trainingWheelsSignature?

Methods

bcsToBytes bcsToHex serialize toString toUint8Array deserialize fromBytes

Constructors

constructor

  • new ZeroKnowledgeSig(args): ZeroKnowledgeSig

  • Parameters

    • args: {
          expHorizonSecs: number;
          extraField?: string;
          overrideAudVal?: string;
          proof: ZkProof;
          trainingWheelsSignature?: EphemeralSignature;
      }
      • expHorizonSecs: number
      • OptionalextraField?: string
      • OptionaloverrideAudVal?: string
      • proof: ZkProof
      • OptionaltrainingWheelsSignature?: EphemeralSignature

    Returns ZeroKnowledgeSig

Properties

ReadonlyexpHorizonSecs

expHorizonSecs: number

The max lifespan of the proof

Optional ReadonlyextraField

extraField?: string

A key value pair on the JWT token that can be specified on the signature which would reveal the value on chain. Can be used to assert identity or other attributes.

Optional ReadonlyoverrideAudVal

overrideAudVal?: string

The 'aud' value of the recovery service which is set when recovering an account.

Readonlyproof

proof: ZkProof

The proof

Optional ReadonlytrainingWheelsSignature

trainingWheelsSignature?: EphemeralSignature

The training wheels signature

Methods

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 signature as a hex string with a 0x prefix e.g. 0x123456...

    Returns string

toUint8Array

  • toUint8Array(): Uint8Array

  • Get the signature in bytes (Uint8Array).

    Returns Uint8Array

    Uint8Array representation of the signature

Staticdeserialize

StaticfromBytes

  • fromBytes(bytes): ZeroKnowledgeSig

  • Return a ZeroKnowledgeSig object from its bcs serialization in bytes.

    Parameters

    • bytes: Uint8Array

    Returns ZeroKnowledgeSig

    ZeroKnowledgeSig

Settings

Member Visibility

On This Page

Constructors
Properties
Methods