Class ProtoPODGPC

constructor

• new ProtoPODGPC(): ProtoPODGPC

• Returns ProtoPODGPC

Static ARTIFACTS_NPM_PACKAGE_NAME

Static ARTIFACTS_NPM_VERSION

Static CIRCUIT_FAMILY

Static CIRCUIT_PARAMETERS

Static circuitFamilyFromParams

• circuitFamilyFromParams(circuitParams): ProtoPODGPCCircuitDesc[]

• Derives circuit descriptions from circuit parameters.

  Parameters

  • circuitParams: [ProtoPODGPCCircuitParams, number][]

    an array of pairs of circuit parameters and circuit sizes (constraint counts).

  Returns ProtoPODGPCCircuitDesc[]

  an array of the corresponding circuit descriptions arranged in order of increasing circuit size.

Static circuitMeetsRequirements

• circuitMeetsRequirements(circuitDesc, requiredParams): boolean

• Checks whether a described circuit can meet a required set of parameters. This will be true if each of the circuit's parameters is greater than or equal to the required value.

  Parameters

  • circuitDesc: ProtoPODGPCCircuitDesc

    description of the circuit to check
  • requiredParams: ProtoPODGPCCircuitParams

    the min required value of each circuit parameter

  Returns boolean

  true if the circuit meets the requirements.

Static circuitNameForParams

• circuitNameForParams(params): string

• Generates a circuit name based on parameters.

  Parameters

  • params: ProtoPODGPCCircuitParams

  Returns string

Static filterPublicInputs

• filterPublicInputs(allInputs): ProtoPODGPCPublicInputs

• Extract the public inputs from the full set of proof inputs.

  Parameters

  • allInputs: ProtoPODGPCInputs

  Returns ProtoPODGPCPublicInputs

Static findCircuit

• findCircuit(familyName, circuitName, circuitFamily?): undefined | ProtoPODGPCCircuitDesc

• Finds the description of a circuit in this family by name.

  Parameters

  • familyName: string

    the circuit family name
  • circuitName: string

    the name of the circuit
  • Optional circuitFamily: ProtoPODGPCCircuitDesc[] = ProtoPODGPC.CIRCUIT_FAMILY

    the circuit family to search

  Returns undefined | ProtoPODGPCCircuitDesc

  the circuit description, or undefined if the name is unrecognized.

Static makePublicSignals

• makePublicSignals(inputs, outputs): bigint[]

• Creates a set of public signals for verification, given public inputs and outputs of a circuit.

  Some values are replaced with their 0-residues modulo BABY_JUB_PRIME to agree with the values returned by the Groth16 prover, which are always normalised this way.

  Parameters

  • inputs: ProtoPODGPCPublicInputs
  • outputs: ProtoPODGPCOutputs

  Returns bigint[]

Static mergeRequiredParams

• mergeRequiredParams(rp1, rp2): ProtoPODGPCCircuitParams

• Calculates the merged set of parameters which meets the unified (maximum) requirements of both inputs.

  Parameters

  • rp1: ProtoPODGPCCircuitParams

    first set of required parameters
  • rp2: ProtoPODGPCCircuitParams

    second set of required paremeters

  Returns ProtoPODGPCCircuitParams

  unified (maximum) parameters

Static outputsFromPublicSignals

• outputsFromPublicSignals(publicSignals, maxEntries, maxVirtualEntries, includeOwnerV3, includeOwnerV4): ProtoPODGPCOutputs

• Extract named outputs from the public circuit signals.

  Because of the flattened array representation of the public signals, the circuit's maxEntries and includeOwner parameters must be known to properly reconstruct output arrays.

  Parameters

  • publicSignals: bigint[]
  • maxEntries: number
  • maxVirtualEntries: number
  • includeOwnerV3: boolean
  • includeOwnerV4: boolean

  Returns ProtoPODGPCOutputs

Static pickCircuit

• pickCircuit(requiredParameters, circuitFamily?): undefined | ProtoPODGPCCircuitDesc

• Picks the smallest available circuit in this family which can handle the size parameters of a desired configuration.

  Parameters

  • requiredParameters: ProtoPODGPCCircuitParams

    a lower bound on the parameters required
  • Optional circuitFamily: ProtoPODGPCCircuitDesc[] = ProtoPODGPC.CIRCUIT_FAMILY

    the circuit family to pick the circuit from. This must be sorted in order of increasing circuit size (constraint count).

  Returns undefined | ProtoPODGPCCircuitDesc

  the circuit description, or undefined if no circuit can handle the required parameters.

Static prove

• prove(inputs, wasmPath, pkeyPath): Promise<{
      outputs: ProtoPODGPCOutputs;
      proof: Groth16Proof;
      publicSignals: bigint[];
  }>

• Generate a Groth16 proof for a circuit in this family.

  Parameters

  • inputs: ProtoPODGPCInputs

    full inputs (public and private)
  • wasmPath: string

    path to wasm file for witness generation. See CircuitArtifactPaths.
  • pkeyPath: string

    path to file containing proving key. See CircuitArtifactPaths.

  Returns Promise<{
      outputs: ProtoPODGPCOutputs;
      proof: Groth16Proof;
      publicSignals: bigint[];
  }>

  Groth16 proof, circuit outputs, and full set of public signals (primarily for verification in tests).

Static verify

• verify(vkeyPath, proof, publicInputs, outputs): Promise<boolean>

• Verify a proof for a circuit in this library.

  Parameters

  • vkeyPath: string

    path to verification key as a JSON file. See CircuitArtifactPaths.
  • proof: Groth16Proof

    Groth16 proof.
  • publicInputs: ProtoPODGPCPublicInputs

    claimed public inputs to the circuit. See filterPublicInputs
  • outputs: ProtoPODGPCOutputs

    claimed outputs from the circuit (generally derived from claims).

  Returns Promise<boolean>

  true if the proof is valid