Class BBSCredentialBuilder

Optional_credStatus

Optional_encodedAttributes

Optional_schema

Optional_sig

Optional_subject

_topLevelFields

_version

StaticVERSION

credStatus

• get credStatus(): undefined | object

• Returns undefined | object

• set credStatus(subject): void

• Parameters

  • subject: undefined | object

  Returns void

schema

• get schema(): undefined | CredentialSchema

• Returns undefined | CredentialSchema

• set schema(schema): void

• Parameters

  • schema: CredentialSchema

  Returns void

signature

• get signature(): undefined | Signature

• Returns undefined | Signature

subject

• get subject(): undefined | object | object[]

• Returns undefined | object | object[]

• set subject(subject): void

• Add single or an array of subjects.

  Parameters

  • subject: object | object[]

  Returns void

version

• get version(): string

• Returns string

• set version(version): void

• Parameters

  • version: string

  Returns void

getTopLevelField

• getTopLevelField(name): unknown

• Parameters

  • name: string

  Returns unknown

serializeForSigning

• serializeForSigning(): object

• Serialize the credential making it ready for signing

  Returns object

setCredentialStatus

• setCredentialStatus(registryId, revCheck, memberValue, revType?): void

• Set the credentialStatus property of the credential

  Parameters

  • registryId: string

    This is id of the revocation registry, like the unique id of the accumulator
  • revCheck: string

    whether its a membership or non-membership check. this depends on how revocation is implemented, i.e. if
  • memberValue: unknown

    Value present/absent in the revocation registry (accumulator for now) which corresponds to a credential. This should be unique per credential per registry.
  • OptionalrevType: RevocationStatusProtocol

    revocation protocol being used like if accumulator, which accumulator

  Returns void

setTopLevelField

• setTopLevelField(name, value): void

• Parameters

  • name: string
  • value: unknown

  Returns void

sign

• sign(secretKey, signatureParams?, signingOpts?): Credential<BBSPublicKey, BBSSignature, BBSSignatureParams>

• Serializes and signs creating a credential. Expects the credential to have the same fields as schema. This is intentional to always communicate to the verifier the full structure of the credential.

  Parameters

  • secretKey: BBSSecretKey
  • OptionalsignatureParams: BBSSignatureParams

    This makes bulk issuance of credentials with same number of attributes faster because the signature params don't have to be generated.
  • OptionalsigningOpts: Partial<ISigningOpts>

  Returns Credential<BBSPublicKey, BBSSignature, BBSSignatureParams>

updateSchemaIfNeeded

• updateSchemaIfNeeded(signingOpts?): object

• When schema doesn't match the credential, create a new appropriate schema and update the credential. Returns the serialized credential

  Parameters

  • OptionalsigningOpts: Partial<ISigningOpts>

  Returns object

updateSchemaIfNeededLegacy

• updateSchemaIfNeededLegacy(signingOpts?): object

• When schema doesn't match the credential, create a new appropriate schema and update the credential. Returns the serialized credential. Legacy version. Used by SDK for some older credential versions

  Parameters

  • OptionalsigningOpts: Partial<ISigningOpts>

  Returns object

StatichasSameFieldsAsSchema

• hasSameFieldsAsSchema(cred, schema): boolean

• Parameters

  • cred: object
  • schema: CredentialSchema

  Returns boolean