Type alias GPCPCDArgs

Type declaration

• externalNullifier: ObjectArgument<JSONPODValue>

  Optional external nullifier can be any type of POD value. It will be used (by hash) to generate a nullifier hash which is unique to the combination of this value and owner identity. This can be used to avoid duplicate actions by the same user, without revealing the user's identity.

  You can use @pcd/pod!podValueToJSON to produce this format.

• Optional id?: StringArgument

  A string that uniquely identifies a GPCPCD. If this argument is not specified a random id will be generated.

  This ID is not cryptographically verified. An issuer can choose to include the ID in the watermark or external nullifier if desired, but this PCD type doesn't enforce that.

• identity: PCDArgument<SemaphoreIdentityPCD>

  Optional secret info identifying the owner of PODs, if needed by the proof configuration. This is never revealed.

• membershipLists: ObjectArgument<JSONPODMembershipLists>

  Optional membership lists, if needed by the proof configuration. This is always revealed.

  You can use @pcd/gpc!podMembershipListsToJSON to produce this format.

• pods: PODPCDRecordArg

  POD objects to prove about. Each object is identified by name in the value underlying this record container argument. These are not revealed by default, but a redacted version of their entries will become part of the claims of the resulting proof PCD, as specified by the proof config.

  See GPCProofConfig and GPCRevealedClaims for more information.

• proofConfig: ObjectArgument<JSONProofConfig>

  A configuration object specifying the constraints to be proven. This will be part of the claims of the resulting proof PCD. See GPCProofConfig for more information.

  This is formatted in a JSON-compatible format which can be parsed using @pcd/gpc!proofConfigFromJSON.

• watermark: ObjectArgument<JSONPODValue>

  Optional watermark can be any POD value. It will be included (by hash) in the proof and cryptographically verified. This can be used to avoid reuse of the same proof.

  You can use @pcd/pod!podValueToJSON to produce this format.