SelfProof

o1js / Modules / SelfProof

Class: SelfProof<PublicInput, PublicOutput>

Type parameters

Name
PublicInput
PublicOutput

Hierarchy

• Proof<PublicInput, PublicOutput>

  ↳ SelfProof

Table of contents

Constructors

• constructor

Properties

• maxProofsVerified
• proof
• publicInput
• publicOutput
• shouldVerify
• publicInputType
• publicOutputType
• tag

Methods

• toJSON
• verify
• verifyIf
• dummy
• fromJSON

Constructors

constructor

• new SelfProof<PublicInput, PublicOutput>(«destructured»)

Type parameters

Name
PublicInput
PublicOutput

Parameters

Name	Type
«destructured»	Object
› maxProofsVerified	0 | 2 | 1
› proof	unknown
› publicInput	PublicInput
› publicOutput	PublicOutput

Inherited from

Proof.constructor

Defined in

lib/proof_system.ts:134

Properties

maxProofsVerified

• maxProofsVerified: 0 | 2 | 1

Inherited from

Proof.maxProofsVerified

Defined in

lib/proof_system.ts:92

---

proof

• proof: unknown

Inherited from

Proof.proof

Defined in

lib/proof_system.ts:91

---

publicInput

• publicInput: PublicInput

Inherited from

Proof.publicInput

Defined in

lib/proof_system.ts:89

---

publicOutput

• publicOutput: PublicOutput

Inherited from

Proof.publicOutput

Defined in

lib/proof_system.ts:90

---

shouldVerify

• shouldVerify: Bool

Inherited from

Proof.shouldVerify

Defined in

lib/proof_system.ts:93

---

publicInputType

▪ Static publicInputType: FlexibleProvablePure<any>

Inherited from

Proof.publicInputType

Defined in

lib/proof_system.ts:81

---

publicOutputType

▪ Static publicOutputType: FlexibleProvablePure<any>

Inherited from

Proof.publicOutputType

Defined in

lib/proof_system.ts:82

---

tag

▪ Static tag: () => { name: string }

Type declaration

▸ (): Object

Returns

Object

Name	Type
name	string

Inherited from

Proof.tag

Defined in

lib/proof_system.ts:83

Methods

toJSON

▸ toJSON(): JsonProof

Returns

JsonProof

Inherited from

Proof.toJSON

Defined in

lib/proof_system.ts:101

---

verify

▸ verify(): void

Returns

void

Inherited from

Proof.verify

Defined in

lib/proof_system.ts:95

---

verifyIf

▸ verifyIf(condition): void

Parameters

Name	Type
condition	Bool

Returns

void

Inherited from

Proof.verifyIf

Defined in

lib/proof_system.ts:98

---

dummy

▸ Static dummy<Input, OutPut>(publicInput, publicOutput, maxProofsVerified, domainLog2?): Promise<Proof<Input, OutPut>>

Dummy proof. This can be useful for ZkPrograms that handle the base case in the same method as the inductive case, using a pattern like this:

method(proof: SelfProof<I, O>, isRecursive: Bool) {
  proof.verifyIf(isRecursive);
  // ...
}

To use such a method in the base case, you need a dummy proof:

let dummy = await MyProof.dummy(publicInput, publicOutput, 1);
await myProgram.myMethod(dummy, Bool(false));

Note: The types of publicInput and publicOutput, as well as the maxProofsVerified parameter, must match your ZkProgram. maxProofsVerified is the maximum number of proofs that any of your methods take as arguments.

Type parameters

Name
Input
OutPut

Parameters

Name	Type	Default value
publicInput	Input	undefined
publicOutput	OutPut	undefined
maxProofsVerified	0 | 2 | 1	undefined
domainLog2	number	14

Returns

Promise<Proof<Input, OutPut>>

Inherited from

Proof.dummy

Defined in

lib/proof_system.ts:172

---

fromJSON

▸ Static fromJSON<S>(this, «destructured»): Proof<InferProvable<S["publicInputType"]>, InferProvable<S["publicOutputType"]>>

Type parameters

Name	Type
S	extends Subclass<typeof Proof>

Parameters

Name	Type
this	S
«destructured»	JsonProof

Returns

Proof<InferProvable<S["publicInputType"]>, InferProvable<S["publicOutputType"]>>

Inherited from

Proof.fromJSON

Defined in

lib/proof_system.ts:110