Class ZeroKnowledgeSig

The signature representation of a proof

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
  - Optional extraField?: string
  - Optional overrideAudVal?: string
  - proof: ZkProof
  - Optional trainingWheelsSignature?: EphemeralSignature
Returns ZeroKnowledgeSig
Overrides Signature.constructor
- Defined in src/core/crypto/keyless.ts:473

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

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:27

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

serialize

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

toString

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

Returns string
Inherited from Signature.toString
- Defined in src/core/crypto/signature.ts:20

toUint8Array

toUint8Array(): Uint8Array
Get the signature in bytes (Uint8Array).

Returns Uint8Array
Uint8Array representation of the signature
Overrides Signature.toUint8Array
- Defined in src/core/crypto/keyless.ts:494

`Static` deserialize

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

`Static` fromBytes

fromBytes(bytes): ZeroKnowledgeSig
Return a ZeroKnowledgeSig object from its bcs serialization in bytes.
Parameters
- bytes: Uint8Array
Returns ZeroKnowledgeSig
ZeroKnowledgeSig
- Defined in src/core/crypto/keyless.ts:503

Class ZeroKnowledgeSig

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

expHorizonSecs: number

Optional extraField?: string

Optional overrideAudVal?: string

proof: ZkProof

Optional trainingWheelsSignature?: EphemeralSignature

Returns ZeroKnowledgeSig

Properties

Readonly expHorizonSecs

Optional Readonly extraField

Optional Readonly overrideAudVal

Readonly proof

Optional Readonly trainingWheelsSignature

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

serialize

Parameters

Returns void

toString

Returns string

toUint8Array

Returns Uint8Array

Static deserialize

Parameters

Returns ZeroKnowledgeSig

Static fromBytes

Parameters

Returns ZeroKnowledgeSig

Settings

Member Visibility

Theme

On This Page

`Optional` extraField?: string

`Optional` overrideAudVal?: string

`Optional` trainingWheelsSignature?: EphemeralSignature

`Readonly` expHorizonSecs

`Optional` `Readonly` extraField

`Optional` `Readonly` overrideAudVal

`Readonly` proof

`Optional` `Readonly` trainingWheelsSignature

`Static` deserialize

`Static` fromBytes