Class ProvenanceMarkGenerator

Generator for creating provenance mark chains.

Index

Methods

res seed chainId nextSeq rngState newWithSeed newWithPassphrase newUsing newRandom new next toString toJSON fromJSON intoEnvelope fromEnvelope

Methods

res

res(): ProvenanceMarkResolution
Returns ProvenanceMarkResolution
- Defined in generator.ts:44

seed

seed(): ProvenanceSeed
Returns ProvenanceSeed
- Defined in generator.ts:48

chainId

chainId(): Uint8Array
Returns Uint8Array
- Defined in generator.ts:52

nextSeq

nextSeq(): number
Returns number
- Defined in generator.ts:56

rngState

rngState(): RngState
Returns RngState
- Defined in generator.ts:60

`Static`newWithSeed

newWithSeed(
res: ProvenanceMarkResolution,
seed: ProvenanceSeed,
): ProvenanceMarkGenerator
Create a new generator with a seed.
Parameters
- res: ProvenanceMarkResolution
- seed: ProvenanceSeed
Returns ProvenanceMarkGenerator
- Defined in generator.ts:67

`Static`newWithPassphrase

newWithPassphrase(
res: ProvenanceMarkResolution,
passphrase: string,
): ProvenanceMarkGenerator
Create a new generator with a passphrase.
Parameters
- res: ProvenanceMarkResolution
- passphrase: string
Returns ProvenanceMarkGenerator
- Defined in generator.ts:78

`Static`newUsing

newUsing(
res: ProvenanceMarkResolution,
randomData: Uint8Array,
): ProvenanceMarkGenerator
Create a new generator with custom random data.
Parameters
- res: ProvenanceMarkResolution
- randomData: Uint8Array
Returns ProvenanceMarkGenerator
- Defined in generator.ts:89

`Static`newRandom

newRandom(res: ProvenanceMarkResolution): ProvenanceMarkGenerator
Create a new generator with random seed.
Parameters
- res: ProvenanceMarkResolution
Returns ProvenanceMarkGenerator
- Defined in generator.ts:97

`Static`new

new(
    res: ProvenanceMarkResolution,
    seed: ProvenanceSeed,
    chainId: Uint8Array,
    nextSeq: number,
    rngState: RngState,
): ProvenanceMarkGenerator
Create a new generator with all parameters.
Parameters
- res: ProvenanceMarkResolution
- seed: ProvenanceSeed
- chainId: Uint8Array
- nextSeq: number
- rngState: RngState
Returns ProvenanceMarkGenerator
- Defined in generator.ts:105

next

next(date: Date, info?: Cbor): ProvenanceMark
Generate the next provenance mark in the chain.
Parameters
- date: Date
- Optionalinfo: Cbor
Returns ProvenanceMark
- Defined in generator.ts:125

toString

toString(): string
String representation.

Returns string
- Defined in generator.ts:160

toJSON

toJSON(): Record<string, unknown>
JSON serialization.

Returns Record<string, unknown>
- Defined in generator.ts:167

`Static`fromJSON

fromJSON(json: Record<string, unknown>): ProvenanceMarkGenerator
Create from JSON object.
Parameters
- json: Record<string, unknown>
Returns ProvenanceMarkGenerator
- Defined in generator.ts:180

intoEnvelope

intoEnvelope(): Envelope$1
Convert this generator to a Gordian Envelope.

The envelope contains structured assertions for all generator fields:
- isA: "provenance-generator"
- res: The resolution
- seed: The seed
- next-seq: The next sequence number
- rng-state: The RNG state
Note: Use provenanceMarkGeneratorToEnvelope() for a standalone function alternative.
Returns Envelope$1
- Defined in generator.ts:205

`Static`fromEnvelope

fromEnvelope(envelope: Envelope$1): ProvenanceMarkGenerator
Extract a ProvenanceMarkGenerator from a Gordian Envelope.
Parameters
- envelope: Envelope$1
  The envelope to extract from
Returns ProvenanceMarkGenerator
The extracted generator

Throws
ProvenanceMarkError if extraction fails
- Defined in generator.ts:234