DynamicProof
The DynamicProof class enables circuits to verify proofs using in-ciruit verfication keys.
This is opposed to the baked-in verification keys of the Proof class.
In order to use this, a subclass of DynamicProof that specifies the public input and output types along with the maxProofsVerified number has to be created.
export class SideloadedProgramProof extends DynamicProof<MyStruct, Field> {
static publicInputType = MyStruct;
static publicOutputType = Field;
static maxProofsVerified = 0 as const;
}
The maxProofsVerified constant is a product of the child circuit and indicates the maximum number that that circuit verifies itself.
If you are unsure about what that is for you, you should use 2.
Any DynamicProof subclass can be used as private input to ZkPrograms or SmartContracts along with a VerificationKey input.
proof.verify(verificationKey)
NOTE: In the case of DynamicProofs, the circuit makes no assertions about the verificationKey used on its own.
This is the responsibility of the application developer and should always implement appropriate checks.
This pattern differs a lot from the usage of normal Proof, where the verification key is baked into the compiled circuit.
See
src/examples/zkprogram/dynamic-keys-merkletree.ts for an example of how this can be done using merkle trees
Assertions generally only happen using the vk hash that is part of the VerificationKey struct along with the raw vk data as auxiliary data.
When using verify() on a DynamicProof, Pickles makes sure that the verification key data matches the hash.
Therefore all manual assertions have to be made on the vk's hash and it can be assumed that the vk's data is checked to match the hash if it is used with verify().
Extends
ProofBase\<Input,Output>
Type parameters
• Input
• Output
Constructors
new DynamicProof()
new DynamicProof<Input, Output>(__namedParameters: {
"maxProofsVerified": 0 | 1 | 2;
"proof": unknown;
"publicInput": Input;
"publicOutput": Output;
}): DynamicProof<Input, Output>
Parameters
• __namedParameters
• __namedParameters.maxProofsVerified: 0 | 1 | 2
• __namedParameters.proof: unknown
• __namedParameters.publicInput: Input
• __namedParameters.publicOutput: Output
Returns
DynamicProof\<Input, Output>
Inherited from
Source
Properties
maxProofsVerified
maxProofsVerified: 0 | 1 | 2;
Inherited from
Source
proof
proof: unknown;
Inherited from
Source
publicInput
publicInput: Input;
Inherited from
Source
publicOutput
publicOutput: Output;
Inherited from
Source
shouldVerify
shouldVerify: Bool;
Inherited from
Source
usedVerificationKey?
optional usedVerificationKey: VerificationKey;
Source
featureFlags
static featureFlags: FeatureFlags = FeatureFlags.allNone;
As the name indicates, feature flags are features of the proof system.
If we want to side load proofs and verification keys, we first have to tell Pickles what shape of proofs it should expect.
For example, if we want to side load proofs that use foreign field arithmetic custom gates, we have to make Pickles aware of that by defining these custom gates.
Note: Only proofs that use the exact same composition of custom gates which were expected by Pickles can be verified using side loading. If you want to verify any proof, no matter what custom gates it uses, you can use FeatureFlags.allMaybe. Please note that this might incur a significant overhead.
You can also toggle specific feature flags manually by specifying them here. Alternatively, you can use FeatureFlags.fromZkProgram to compute the set of feature flags that are compatible with a given program.
Source
maxProofsVerified
static maxProofsVerified: 0 | 1 | 2;
Source
publicInputType
static publicInputType: FlexibleProvablePure<any>;
Inherited from
Source
publicOutputType
static publicOutputType: FlexibleProvablePure<any>;
Inherited from
Source
Accessors
provable
get static provable(): ProvableProof<DynamicProof<any, any>, any, any>
Returns
ProvableProof\<DynamicProof\<any, any>, any, any>
Source
Methods
publicFields()
publicFields(): {
"input": Field[];
"output": Field[];
}
Returns
{
"input": Field[];
"output": Field[];
}
input
input: Field[];
output
output: Field[];
Inherited from
Source
toJSON()
toJSON(): JsonProof
Returns
Inherited from
Source
verify()
verify(vk: VerificationKey): void
Verifies this DynamicProof using a given verification key
Parameters
• vk: VerificationKey
The verification key this proof will be verified against
Returns
void
Source
verifyIf()
verifyIf(vk: VerificationKey, condition: Bool): void
Parameters
• vk: VerificationKey
• condition: Bool
Returns
void
Source
dummy()
static dummy<S>(
this: S,
publicInput: InferProvable<S["publicInputType"]>,
publicOutput: InferProvable<S["publicOutputType"]>,
maxProofsVerified: 0 | 1 | 2,
domainLog2: number): Promise<InstanceType<S>>
Type parameters
• S extends Subclass\<typeof DynamicProof>
Parameters
• this: S
• publicInput: InferProvable\<S["publicInputType"]>
• publicOutput: InferProvable\<S["publicOutputType"]>
• maxProofsVerified: 0 | 1 | 2
• domainLog2: number= 14
Returns
Promise\<InstanceType\<S>>
Source
fromJSON()
static fromJSON<S>(this: S, __namedParameters: JsonProof): Promise<DynamicProof<InferProvable<S["publicInputType"]>, InferProvable<S["publicOutputType"]>>>
Type parameters
• S extends Subclass\<typeof DynamicProof>
Parameters
• this: S
• __namedParameters: JsonProof
Returns
Promise\<DynamicProof\<InferProvable\<S["publicInputType"]>, InferProvable\<S["publicOutputType"]>>>
Source
fromProof()
static fromProof<S>(this: S, proof: Proof<InferProvable<S["publicInputType"]>, InferProvable<S["publicOutputType"]>>): InstanceType<S>
Converts a Proof into a DynamicProof carrying over all relevant data. This method can be used to convert a Proof computed by a ZkProgram into a DynamicProof that is accepted in a circuit that accepts DynamicProofs
Type parameters
• S extends Subclass\<typeof DynamicProof>
Parameters
• this: S
• proof: Proof\<InferProvable\<S["publicInputType"]>, InferProvable\<S["publicOutputType"]>>
Returns
InstanceType\<S>
Source
publicFields()
static publicFields(value: ProofBase<any, any>): {
"input": Field[];
"output": Field[];
}
Parameters
• value: ProofBase\<any, any>
Returns
{
"input": Field[];
"output": Field[];
}
input
input: Field[];
output
output: Field[];
Inherited from
Source
tag()
static tag(): {
"name": string;
}
Returns
{
"name": string;
}
name
name: string;
Overrides
ProofBase.tag