Type alias PODPCDArgValidatorParams

PODPCDArgValidatorParams: {
    membershipLists?: string;
    notFoundMessage?: string;
    prescribedEntries?: string;
    prescribedSignerPublicKeys?: PODSignerPublicKeys;
    proofConfig?: string;
}

Validator parameters for POD PCD arguments. These will play a role in filtering the selection of PODs available for a user to choose for their proof.

Type declaration

  • Optional membershipLists?: string

    JSON-serialised membership lists to narrow down the selection of POD PCDs to those satisfying the list membership check specified in the proof config. This should coincide with the membership list string supplied in the GPCPCDArgs (if any). May be deserialised using podMembershipListsFromSimplifiedJSON.

  • Optional notFoundMessage?: string

    Message to display if the POD specified in the config does not match any of the available POD PCDs.

  • Optional prescribedEntries?: string

    JSON-serialised PODEntries.This is used to narrow down the selection of POD PCDs to those with entries matching these prescribed values. May be deserialised using podEntryRecordFromSimplifiedJSON.

  • Optional prescribedSignerPublicKeys?: PODSignerPublicKeys

    Record of prescribed signers' public keys. This is used to narrow down the selection of POD PCDs to those with signers' public keys matching these prescribed values. May be serialised and deserialised using JSON.stringify and JSON.parse.

  • Optional proofConfig?: string

    JSON-serialised proof configuration used to narrow down the selection of POD PCDs. This should coincide with the proof config string supplied in the GPCPCDArgs. May be deserialised using deserializeGPCProofConfig.

Generated using TypeDoc