Class ZeroKnowledgeSig

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

Hierarchy (view full)

Signature
- ZeroKnowledgeSig

Index

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
Overrides Signature.constructor
- Defined in src/core/crypto/keyless.ts:542

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.
Inherited from Signature.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 Signature.bcsToHex
- Defined in src/bcs/serializer.ts:40

serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides Signature.serialize
- Defined in src/core/crypto/keyless.ts:568

toString

toString(): string
Get the signature as a hex string with a 0x prefix e.g. 0x123456...

Returns string
The hex string representation of the signature.
Inherited from Signature.toString
- Defined in src/core/crypto/signature.ts:23

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 Signature.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:49

toUint8Array

toUint8Array(): Uint8Array
Get the raw signature bytes

Returns Uint8Array
Inherited from Signature.toUint8Array
- Defined in src/core/crypto/signature.ts:15

`Static`deserialize

deserialize(deserializer): ZeroKnowledgeSig
Parameters
- deserializer: Deserializer
Returns ZeroKnowledgeSig
- Defined in src/core/crypto/keyless.ts:576

`Static`fromBytes

fromBytes(bytes): ZeroKnowledgeSig
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.
- Defined in src/core/crypto/keyless.ts:564

Properties

`Readonly`expHorizonSecs

expHorizonSecs: number

The max lifespan of the proof

`Optional` `Readonly`extraField

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` `Readonly`overrideAudVal

overrideAudVal?: string

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

`Readonly`proof

proof: ZkProof

The proof

`Optional` `Readonly`trainingWheelsSignature

trainingWheelsSignature?: EphemeralSignature

The training wheels signature

Class ZeroKnowledgeSig

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

expHorizonSecs: number

OptionalextraField?: string

OptionaloverrideAudVal?: string

proof: ZkProof

OptionaltrainingWheelsSignature?: EphemeralSignature

Returns ZeroKnowledgeSig

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

serialize

Parameters

Returns void

toString

Returns string

toStringWithoutPrefix

Returns string

toUint8Array

Returns Uint8Array

Staticdeserialize

Parameters

Returns ZeroKnowledgeSig

StaticfromBytes

Parameters

Returns ZeroKnowledgeSig

Properties

ReadonlyexpHorizonSecs

Optional ReadonlyextraField

Optional ReadonlyoverrideAudVal

Readonlyproof

Optional ReadonlytrainingWheelsSignature

Settings

On This Page

`Optional`extraField?: string

`Optional`overrideAudVal?: string

`Optional`trainingWheelsSignature?: EphemeralSignature

`Static`deserialize

`Static`fromBytes

`Readonly`expHorizonSecs

`Optional` `Readonly`extraField

`Optional` `Readonly`overrideAudVal

`Readonly`proof

`Optional` `Readonly`trainingWheelsSignature