Class Sigchain

Hierarchy

CreateDestroyStartStop
- Sigchain

Constructors

constructor

new Sigchain(__namedParameters): Sigchain
Parameters
- __namedParameters: {
      db: DB;
      keyRing: KeyRing;
      logger: Logger;
  }
  - db: DB
  - keyRing: KeyRing
  - logger: Logger
Returns Sigchain
Inherited from createDestroyStartStop.CreateDestroyStartStop.constructor
- Defined in src/sigchain/Sigchain.ts:86

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` db

db: DB

`Protected` dbClaimsPath

dbClaimsPath: readonly (string | Buffer)[] = ...

`Protected` dbLastClaimIdPath

dbLastClaimIdPath: readonly (string | Buffer)[] = ...

Maintain last ClaimId to preserve monotonicity across process restarts. The ClaimId provides a globally unique ID that is time-sortable. Sigchain/lastClaimId -> {raw(ClaimId)}

`Protected` dbLastSequenceNumberPath

dbLastSequenceNumberPath: readonly (string | Buffer)[] = ...

Maintain last sequence number to preserve monotonicity across process restarts. The sequence number provides cardinal and ordinal information regarding a claim. Sigchain/lastSequenceNumber -> {SequenceNumber}}

`Protected` dbPath

dbPath: readonly (string | Buffer)[] = ...

`Protected` dbSignaturesPath

dbSignaturesPath: readonly (string | Buffer)[] = ...

`Protected` generateClaimId

generateClaimId: (() => ClaimId)

Type declaration

- (): ClaimId
- Returns ClaimId

`Protected` generateSequenceNumber

generateSequenceNumber: (() => number)

Type declaration

- (): number
- Returns number

`Protected` keyRing

keyRing: KeyRing

`Protected` logger

logger: Logger

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from createDestroyStartStop.CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

addClaim

addClaim(data, date?, signingHook?, tran?): Promise<[ClaimId, SignedClaim]>
Appends a claim (of any type) to the sigchain. For ClaimInput, it will be JSON encoded. Remember that undefined properties are deleted. While undefined values in arrays are converted to null.
Parameters
- data: ClaimInput
- date: Date = ...
- Optional signingHook: ((token) => Promise<Token<Claim>>)
  - - (token): Promise<Token<Claim>>
    - Parameters
      
      token: Token<Claim>
      
      Returns Promise<Token<Claim>>
- Optional tran: DBTransaction
Returns Promise<[ClaimId, SignedClaim]>
- Defined in src/sigchain/Sigchain.ts:395

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.destroy
- Defined in src/sigchain/Sigchain.ts:127

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

getClaim

getClaim(claimId, tran?): Promise<undefined | Claim>
Get a claim according to the ClaimId
Parameters
- claimId: ClaimId
- Optional tran: DBTransaction
Returns Promise<undefined | Claim>
- Defined in src/sigchain/Sigchain.ts:214

getClaims

getClaims(__namedParameters?, tran?): AsyncGenerator<[ClaimId, Claim], any, unknown>
Get claims
Parameters
- __namedParameters: {
      limit?: number;
      order?: "asc" | "desc";
      seek?: ClaimId;
  } = {}
  - Optional limit?: number
  - Optional order?: "asc" | "desc"
  - Optional seek?: ClaimId
- Optional tran: DBTransaction
Returns AsyncGenerator<[ClaimId, Claim], any, unknown>
- Defined in src/sigchain/Sigchain.ts:289

getLastClaim

getLastClaim(tran?): Promise<undefined | [ClaimId, Claim]>
Parameters
- Optional tran: DBTransaction
Returns Promise<undefined | [ClaimId, Claim]>
- Defined in src/sigchain/Sigchain.ts:182

getLastClaimId

getLastClaimId(tran?): Promise<undefined | ClaimId>
Gets the last claim ID for preserving monotonicity over restarts
Parameters
- Optional tran: DBTransaction
Returns Promise<undefined | ClaimId>
- Defined in src/sigchain/Sigchain.ts:136

getLastSequenceNumber

getLastSequenceNumber(tran?): Promise<undefined | number>
Gets the last sequence number for preserving monotonicity over restarts
Parameters
- Optional tran: DBTransaction
Returns Promise<undefined | number>
- Defined in src/sigchain/Sigchain.ts:155

getLastSignedClaim

getLastSignedClaim(tran?): Promise<undefined | [ClaimId, SignedClaim]>
Parameters
- Optional tran: DBTransaction
Returns Promise<undefined | [ClaimId, SignedClaim]>
- Defined in src/sigchain/Sigchain.ts:195

getSignatures

getSignatures(claimId, tran?): Promise<TokenHeaderSignature[]>
Get a claim signatures according to the ClaimId
Parameters
- claimId: ClaimId
- Optional tran: DBTransaction
Returns Promise<TokenHeaderSignature[]>
- Defined in src/sigchain/Sigchain.ts:255

getSignedClaim

getSignedClaim(claimId, tran?): Promise<undefined | SignedClaim>
Get a signed claim according to the ClaimId
Parameters
- claimId: ClaimId
- Optional tran: DBTransaction
Returns Promise<undefined | SignedClaim>
- Defined in src/sigchain/Sigchain.ts:228

getSignedClaims

getSignedClaims(__namedParameters?, tran?): AsyncGenerator<[ClaimId, SignedClaim], any, unknown>
Get signed claims
Parameters
- __namedParameters: {
      limit?: number;
      order?: "asc" | "desc";
      seek?: ClaimId;
  } = {}
  - Optional limit?: number
  - Optional order?: "asc" | "desc"
  - Optional seek?: ClaimId
- Optional tran: DBTransaction
Returns AsyncGenerator<[ClaimId, SignedClaim], any, unknown>
- Defined in src/sigchain/Sigchain.ts:337

`Protected` lockLastClaimId

lockLastClaimId(tran): Promise<void>
Mutually exclude the last claim ID. Use this to ensure claim appending is serialised.
Parameters
- tran: DBTransaction
Returns Promise<void>
- Defined in src/sigchain/Sigchain.ts:479

onKeyRingChange

onKeyRingChange(): Promise<void>
Call this method when the KeyRing changes This should be replaced with rxjs later

Returns Promise<void>
- Defined in src/sigchain/Sigchain.ts:173

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  } = {}
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.start
- Defined in src/sigchain/Sigchain.ts:100

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.stop
- Defined in src/sigchain/Sigchain.ts:122

`Static` createSigchain

createSigchain(__namedParameters): Promise<Sigchain>
Parameters
- __namedParameters: {
      db: DB;
      fresh?: boolean;
      keyRing: KeyRing;
      logger?: Logger;
  }
  - db: DB
  - Optional fresh?: boolean
  - keyRing: KeyRing
  - Optional logger?: Logger
Returns Promise<Sigchain>
- Defined in src/sigchain/Sigchain.ts:37

Class Sigchain

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { db: DB; keyRing: KeyRing; logger: Logger; }

db: DB

keyRing: KeyRing

logger: Logger

Returns Sigchain

Properties

Readonly [initLock]

Protected db

Protected dbClaimsPath

Protected dbLastClaimIdPath

Protected dbLastSequenceNumberPath

Protected dbPath

Protected dbSignaturesPath

Protected generateClaimId

Type declaration

Returns ClaimId

Protected generateSequenceNumber

Type declaration

Returns number

Protected keyRing

Protected logger

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addClaim

Parameters

data: ClaimInput

date: Date = ...

Optional signingHook: ((token) => Promise<Token<Claim>>)

Parameters

token: Token<Claim>

Returns Promise<Token<Claim>>

Optional tran: DBTransaction

Returns Promise<[ClaimId, SignedClaim]>

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

destroy

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

getClaim

Parameters

claimId: ClaimId

Optional tran: DBTransaction

Returns Promise<undefined | Claim>

getClaims

__namedParameters: {
db: DB;
keyRing: KeyRing;
logger: Logger;
}

`Readonly` [initLock]

`Protected` db

`Protected` dbClaimsPath

`Protected` dbLastClaimIdPath

`Protected` dbLastSequenceNumberPath

`Protected` dbPath

`Protected` dbSignaturesPath

`Protected` generateClaimId

`Protected` generateSequenceNumber

`Protected` keyRing

`Protected` logger

`Optional` signingHook: ((token) => Promise<Token<Claim>>)

`Optional` tran: DBTransaction

`Optional` options: boolean | AddEventListenerOptions

`Optional` tran: DBTransaction

__namedParameters: {
limit?: number;
order?: "asc" | "desc";
seek?: ClaimId;
} = {}

`Optional` limit?: number

`Optional` order?: "asc" | "desc"

`Optional` seek?: ClaimId

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

__namedParameters: {
limit?: number;
order?: "asc" | "desc";
seek?: ClaimId;
} = {}

`Optional` limit?: number

`Optional` order?: "asc" | "desc"

`Optional` seek?: ClaimId

`Optional` tran: DBTransaction

`Protected` lockLastClaimId

`Optional` options: boolean | EventListenerOptions

__namedParameters: {
fresh?: boolean;
} = {}

`Optional` fresh?: boolean

`Static` createSigchain

__namedParameters: {
db: DB;
fresh?: boolean;
keyRing: KeyRing;
logger?: Logger;
}

`Optional` fresh?: boolean

`Optional` logger?: Logger