Attester | @kiltprotocol/portablegabi

The Attester can be used to create and revoke Attestations of Credentials.

Hierarchy

Attester
- AttesterChain

Implements

IAttester

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Attester(publicKey: AttesterPublicKey, privateKey: AttesterPrivateKey): Attester

- Defined in src/attestation/Attester.ts:89
Constructs a new Attester using an existing private and public key pair.

Parameters
- publicKey: AttesterPublicKey
  
  The public key for the Attester.
- privateKey: AttesterPrivateKey
  
  The private key for the Attester.
Returns Attester

Properties

Readonly privateKey

privateKey: AttesterPrivateKey

Readonly publicKey

publicKey: AttesterPublicKey

Methods

createAccumulator

createAccumulator(): ReturnType<IAttester["createAccumulator"]>

- Defined in src/attestation/Attester.ts:126
Creates a new accumulator.

Returns ReturnType<IAttester["createAccumulator"]>

A new Accumulator.

issueAttestation

issueAttestation(__namedParameters: { accumulator: Accumulator; attestationRequest: AttestationRequest; attestationSession: AttesterAttestationSession }): ReturnType<IAttester["issueAttestation"]>

- Defined in src/attestation/Attester.ts:144
Creates an Attestation for the claim inside the AttestationRequest.

Parameters
- __namedParameters: { accumulator: Accumulator; attestationRequest: AttestationRequest; attestationSession: AttesterAttestationSession }
  - accumulator: Accumulator
  - attestationRequest: AttestationRequest
  - attestationSession: AttesterAttestationSession
Returns ReturnType<IAttester["issueAttestation"]>

The Attestation object which should be sent to the Claimer and a Witness which can be used to revoke the attestation.

revokeAttestation

revokeAttestation(__namedParameters: { accumulator: Accumulator; witnesses: Witness[] }): ReturnType<IAttester["revokeAttestation"]>

- Defined in src/attestation/Attester.ts:177
Revokes an Attestation which corresponds to the provided Witness.

Parameters
- __namedParameters: { accumulator: Accumulator; witnesses: Witness[] }
  - accumulator: Accumulator
  - witnesses: Witness[]
Returns ReturnType<IAttester["revokeAttestation"]>

An updated version of the Accumulator.

startAttestation

startAttestation(): ReturnType<IAttester["startAttestation"]>

- Defined in src/attestation/Attester.ts:110
Initiates the attestation session.

Returns ReturnType<IAttester["startAttestation"]>

A session and a message object. The message should be sent over to the Claimer.

Static create

create(options?: KeyGenOptions): Promise<Attester>

- Defined in src/attestation/Attester.ts:86
Generates a new key pair and returns a new Attester.

Parameters
- Default value options: KeyGenOptions = {}
  
  An optional object containing options for the key generation.
Returns Promise<Attester>

A new Attester.

Static genKeyPair

genKeyPair(__namedParameters?: { keyLength: undefined | 1024 | 2048 | 4096; maxAttributes: undefined | number; validityDuration: undefined | number }): Promise<{ privateKey: AttesterPrivateKey; publicKey: AttesterPublicKey }>

- Defined in src/attestation/Attester.ts:52
Generates a new key pair.

Parameters
- Default value __namedParameters: { keyLength: undefined | 1024 | 2048 | 4096; maxAttributes: undefined | number; validityDuration: undefined | number } = {}
  - keyLength: undefined | 1024 | 2048 | 4096
  - maxAttributes: undefined | number
  - validityDuration: undefined | number
Returns Promise<{ privateKey: AttesterPrivateKey; publicKey: AttesterPublicKey }>

A newly generated key pair.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

publicKey: AttesterPublicKey

privateKey: AttesterPrivateKey

Returns Attester

Properties

Readonly privateKey

Readonly publicKey

Methods

createAccumulator

Returns ReturnType<IAttester["createAccumulator"]>

issueAttestation

Parameters

__namedParameters: { accumulator: Accumulator; attestationRequest: AttestationRequest; attestationSession: AttesterAttestationSession }

accumulator: Accumulator

attestationRequest: AttestationRequest

attestationSession: AttesterAttestationSession

Returns ReturnType<IAttester["issueAttestation"]>

revokeAttestation

Parameters

__namedParameters: { accumulator: Accumulator; witnesses: Witness[] }

accumulator: Accumulator

witnesses: Witness[]

Returns ReturnType<IAttester["revokeAttestation"]>

startAttestation

Returns ReturnType<IAttester["startAttestation"]>

Static create

Parameters

Default value options: KeyGenOptions = {}

Returns Promise<Attester>

Static genKeyPair

Parameters

Default value __namedParameters: { keyLength: undefined | 1024 | 2048 | 4096; maxAttributes: undefined | number; validityDuration: undefined | number } = {}

keyLength: undefined | 1024 | 2048 | 4096

maxAttributes: undefined | number

validityDuration: undefined | number

Returns Promise<{ privateKey: AttesterPrivateKey; publicKey: AttesterPublicKey }>