@aptos-labs/ts-sdk - v5.1.4
    Preparing search index...

    Class ZeroKnowledgeSig

    Represents a zero-knowledge signature, encapsulating the proof and its associated metadata.

    Hierarchy (View Summary)

    Index

    Implementation - BCS

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

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

    Implementation - Serialization

    expHorizonSecs: number

    The max lifespan of the proof

    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.

    overrideAudVal?: string

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

    proof: ZkProof

    The proof

    trainingWheelsSignature?: EphemeralSignature

    The training wheels signature

    • Deserialize a ZeroKnowledgeSig object from its BCS serialization in bytes.

      Parameters

      • bytes: Uint8Array

        The bytes representing the serialized ZeroKnowledgeSig.

      Returns ZeroKnowledgeSig

      ZeroKnowledgeSig - The deserialized ZeroKnowledgeSig object.

    Constructors

    Methods