TypeScript: @dnsid-ai/log-c2sp-tlog — classes
Part of Transparency log (@dnsid-ai/log-c2sp-tlog).
Classes
Section titled “Classes”C2spTlogBinding
Section titled “C2spTlogBinding”Defined in: packages/log-c2sp-tlog/src/reader.ts:497
Read/write binding for a c2sp-tlog stream: extends C2spTlogReader
with the prepared-event workflow (prepare, sign per role, finalize, append).
The generic writeEvent is intentionally unimplemented; appends go through
C2spTlogBinding.writePreparedEvent with a deployment-specific submitter.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new C2spTlogBinding(lr, options): C2spTlogBinding;Defined in: packages/log-c2sp-tlog/src/reader.ts:109
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”readonly lr: string;Defined in: packages/log-c2sp-tlog/src/reader.ts:109
Inherited from
Section titled “Inherited from”parsed
Section titled “parsed”readonly parsed: ParsedC2spTlogLr;Defined in: packages/log-c2sp-tlog/src/reader.ts:101
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”additionalSignerRoles()
Section titled “additionalSignerRoles()”additionalSignerRoles(event): LogSignerRole[];Defined in: packages/log-c2sp-tlog/src/reader.ts:134
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”C2spTlogReader.additionalSignerRoles
canonical()
Section titled “canonical()”canonical(event): Promise<Uint8Array<ArrayBufferLike>>;Defined in: packages/log-c2sp-tlog/src/reader.ts:129
Returns the canonical byte representation of the event for this log method. Used to verify the signatures required by the log method on events read from the log. MUST produce identical output to Log.canonical for the same supported event.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”entryBytes()
Section titled “entryBytes()”entryBytes(prepared, context?): Promise<Uint8Array<ArrayBufferLike>>;Defined in: packages/log-c2sp-tlog/src/reader.ts:510
Parameters
Section titled “Parameters”prepared
Section titled “prepared”context?
Section titled “context?”PreparedC2spVerificationContext
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
keyTimestamp()
Section titled “keyTimestamp()”keyTimestamp(domain, keyThumbprint): Promise<Date>;Defined in: packages/log-c2sp-tlog/src/reader.ts:138
Returns the timestamp at which the given key thumbprint was bound to the domain (ISSUANCE or KEY_ROTATION event). Used for ka validation.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
keyThumbprint
Section titled “keyThumbprint”string
Returns
Section titled “Returns”Promise<Date>
Inherited from
Section titled “Inherited from”parsePreparedEvent()
Section titled “parsePreparedEvent()”parsePreparedEvent(bytes, context?): Promise<PreparedC2spTlogEvent>;Defined in: packages/log-c2sp-tlog/src/reader.ts:502
Parameters
Section titled “Parameters”Uint8Array
context?
Section titled “context?”PreparedC2spVerificationContext
Returns
Section titled “Returns”Promise<PreparedC2spTlogEvent>
prepareEvent()
Section titled “prepareEvent()”prepareEvent(event, chain?): PreparedC2spTlogEvent;Defined in: packages/log-c2sp-tlog/src/reader.ts:498
Parameters
Section titled “Parameters”chain?
Section titled “chain?”Returns
Section titled “Returns”readEvent()
Section titled “readEvent()”readEvent(ref): Promise<LogEvent>;Defined in: packages/log-c2sp-tlog/src/reader.ts:209
Reads a single event by its log reference. MUST verify inclusion proof and timestamp proof before returning.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<LogEvent>
Inherited from
Section titled “Inherited from”rebuildHistory()
Section titled “rebuildHistory()”rebuildHistory(domain): Promise<LogEvent[]>;Defined in: packages/log-c2sp-tlog/src/reader.ts:263
Rebuilds the full event history for the domain in authoritative log order. MUST verify inclusion proofs, timestamp proofs, append-only consistency, and required lifecycle signatures on every returned event. Event signature verification MUST use the public keys valid for that event in the reconstructed lifecycle history. Events with invalid signatures MUST NOT be returned.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
Returns
Section titled “Returns”Promise<LogEvent[]>
Inherited from
Section titled “Inherited from”signPreparedEvent()
Section titled “signPreparedEvent()”signPreparedEvent( prepared, role, keyProvider, options?): Promise<PreparedC2spTlogEvent>;Defined in: packages/log-c2sp-tlog/src/reader.ts:506
Parameters
Section titled “Parameters”prepared
Section titled “prepared”keyProvider
Section titled “keyProvider”options?
Section titled “options?”Returns
Section titled “Returns”Promise<PreparedC2spTlogEvent>
verifyBilateralBinding()
Section titled “verifyBilateralBinding()”verifyBilateralBinding( record, entityKey, operationalKey): Promise<{ initialEntityThumbprint: string; initialOperationalThumbprint: string; timestamp: Date;}>;Defined in: packages/log-c2sp-tlog/src/reader.ts:146
Verifies draft-01 bilateral ISSUANCE binding for the current TXT record.
Parameters
Section titled “Parameters”record
Section titled “record”unknown
entityKey
Section titled “entityKey”unknown
operationalKey
Section titled “operationalKey”unknown
Returns
Section titled “Returns”Promise<{
initialEntityThumbprint: string;
initialOperationalThumbprint: string;
timestamp: Date;
}>
Inherited from
Section titled “Inherited from”C2spTlogReader.verifyBilateralBinding
verifyNonRevocation()
Section titled “verifyNonRevocation()”verifyNonRevocation(domain, at): Promise<LoggedStateEvidence>;Defined in: packages/log-c2sp-tlog/src/reader.ts:183
Verifies that the domain is neither REVOKED nor RETIRED at the given timestamp. Raises on a terminal state or if complete, fresh evidence cannot be established. Returns the accepted proof boundary.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
Date
Returns
Section titled “Returns”Promise<LoggedStateEvidence>
Inherited from
Section titled “Inherited from”C2spTlogReader.verifyNonRevocation
verifyOperationalContinuity()
Section titled “verifyOperationalContinuity()”verifyOperationalContinuity( domain, initialOperationalThumbprint, currentOperationalThumbprint): Promise<void>;Defined in: packages/log-c2sp-tlog/src/reader.ts:172
Verifies KEY_ROTATION continuity from ISSUANCE to the current operational key.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
initialOperationalThumbprint
Section titled “initialOperationalThumbprint”string
currentOperationalThumbprint
Section titled “currentOperationalThumbprint”string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”C2spTlogReader.verifyOperationalContinuity
writeEvent()
Section titled “writeEvent()”writeEvent(_event): Promise<string>;Defined in: packages/log-c2sp-tlog/src/reader.ts:518
Appends a signed event to the log. The event MUST already carry the signatures required by its log method before writeEvent is called. Returns a LogRef identifying the recorded entry.
Parameters
Section titled “Parameters”_event
Section titled “_event”Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”writePreparedEvent()
Section titled “writePreparedEvent()”writePreparedEvent(prepared, options): Promise<string>;Defined in: packages/log-c2sp-tlog/src/reader.ts:514
Parameters
Section titled “Parameters”prepared
Section titled “prepared”options
Section titled “options”Returns
Section titled “Returns”Promise<string>
C2spTlogClient
Section titled “C2spTlogClient”Defined in: packages/log-c2sp-tlog/src/reader.ts:524
Deprecated
Section titled “Deprecated”Use C2spTlogBinding.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new C2spTlogClient(lr, options): C2spTlogClient;Defined in: packages/log-c2sp-tlog/src/reader.ts:109
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”readonly lr: string;Defined in: packages/log-c2sp-tlog/src/reader.ts:109
Inherited from
Section titled “Inherited from”parsed
Section titled “parsed”readonly parsed: ParsedC2spTlogLr;Defined in: packages/log-c2sp-tlog/src/reader.ts:101
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”additionalSignerRoles()
Section titled “additionalSignerRoles()”additionalSignerRoles(event): LogSignerRole[];Defined in: packages/log-c2sp-tlog/src/reader.ts:134
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”C2spTlogBinding.additionalSignerRoles
canonical()
Section titled “canonical()”canonical(event): Promise<Uint8Array<ArrayBufferLike>>;Defined in: packages/log-c2sp-tlog/src/reader.ts:129
Returns the canonical byte representation of the event for this log method. Used to verify the signatures required by the log method on events read from the log. MUST produce identical output to Log.canonical for the same supported event.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
Inherited from
Section titled “Inherited from”entryBytes()
Section titled “entryBytes()”entryBytes(prepared, context?): Promise<Uint8Array<ArrayBufferLike>>;Defined in: packages/log-c2sp-tlog/src/reader.ts:510
Parameters
Section titled “Parameters”prepared
Section titled “prepared”context?
Section titled “context?”PreparedC2spVerificationContext
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
Inherited from
Section titled “Inherited from”keyTimestamp()
Section titled “keyTimestamp()”keyTimestamp(domain, keyThumbprint): Promise<Date>;Defined in: packages/log-c2sp-tlog/src/reader.ts:138
Returns the timestamp at which the given key thumbprint was bound to the domain (ISSUANCE or KEY_ROTATION event). Used for ka validation.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
keyThumbprint
Section titled “keyThumbprint”string
Returns
Section titled “Returns”Promise<Date>
Inherited from
Section titled “Inherited from”parsePreparedEvent()
Section titled “parsePreparedEvent()”parsePreparedEvent(bytes, context?): Promise<PreparedC2spTlogEvent>;Defined in: packages/log-c2sp-tlog/src/reader.ts:502
Parameters
Section titled “Parameters”Uint8Array
context?
Section titled “context?”PreparedC2spVerificationContext
Returns
Section titled “Returns”Promise<PreparedC2spTlogEvent>
Inherited from
Section titled “Inherited from”C2spTlogBinding.parsePreparedEvent
prepareEvent()
Section titled “prepareEvent()”prepareEvent(event, chain?): PreparedC2spTlogEvent;Defined in: packages/log-c2sp-tlog/src/reader.ts:498
Parameters
Section titled “Parameters”chain?
Section titled “chain?”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”readEvent()
Section titled “readEvent()”readEvent(ref): Promise<LogEvent>;Defined in: packages/log-c2sp-tlog/src/reader.ts:209
Reads a single event by its log reference. MUST verify inclusion proof and timestamp proof before returning.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<LogEvent>
Inherited from
Section titled “Inherited from”rebuildHistory()
Section titled “rebuildHistory()”rebuildHistory(domain): Promise<LogEvent[]>;Defined in: packages/log-c2sp-tlog/src/reader.ts:263
Rebuilds the full event history for the domain in authoritative log order. MUST verify inclusion proofs, timestamp proofs, append-only consistency, and required lifecycle signatures on every returned event. Event signature verification MUST use the public keys valid for that event in the reconstructed lifecycle history. Events with invalid signatures MUST NOT be returned.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
Returns
Section titled “Returns”Promise<LogEvent[]>
Inherited from
Section titled “Inherited from”C2spTlogBinding.rebuildHistory
signPreparedEvent()
Section titled “signPreparedEvent()”signPreparedEvent( prepared, role, keyProvider, options?): Promise<PreparedC2spTlogEvent>;Defined in: packages/log-c2sp-tlog/src/reader.ts:506
Parameters
Section titled “Parameters”prepared
Section titled “prepared”keyProvider
Section titled “keyProvider”options?
Section titled “options?”Returns
Section titled “Returns”Promise<PreparedC2spTlogEvent>
Inherited from
Section titled “Inherited from”C2spTlogBinding.signPreparedEvent
verifyBilateralBinding()
Section titled “verifyBilateralBinding()”verifyBilateralBinding( record, entityKey, operationalKey): Promise<{ initialEntityThumbprint: string; initialOperationalThumbprint: string; timestamp: Date;}>;Defined in: packages/log-c2sp-tlog/src/reader.ts:146
Verifies draft-01 bilateral ISSUANCE binding for the current TXT record.
Parameters
Section titled “Parameters”record
Section titled “record”unknown
entityKey
Section titled “entityKey”unknown
operationalKey
Section titled “operationalKey”unknown
Returns
Section titled “Returns”Promise<{
initialEntityThumbprint: string;
initialOperationalThumbprint: string;
timestamp: Date;
}>
Inherited from
Section titled “Inherited from”C2spTlogBinding.verifyBilateralBinding
verifyNonRevocation()
Section titled “verifyNonRevocation()”verifyNonRevocation(domain, at): Promise<LoggedStateEvidence>;Defined in: packages/log-c2sp-tlog/src/reader.ts:183
Verifies that the domain is neither REVOKED nor RETIRED at the given timestamp. Raises on a terminal state or if complete, fresh evidence cannot be established. Returns the accepted proof boundary.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
Date
Returns
Section titled “Returns”Promise<LoggedStateEvidence>
Inherited from
Section titled “Inherited from”C2spTlogBinding.verifyNonRevocation
verifyOperationalContinuity()
Section titled “verifyOperationalContinuity()”verifyOperationalContinuity( domain, initialOperationalThumbprint, currentOperationalThumbprint): Promise<void>;Defined in: packages/log-c2sp-tlog/src/reader.ts:172
Verifies KEY_ROTATION continuity from ISSUANCE to the current operational key.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
initialOperationalThumbprint
Section titled “initialOperationalThumbprint”string
currentOperationalThumbprint
Section titled “currentOperationalThumbprint”string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”C2spTlogBinding.verifyOperationalContinuity
writeEvent()
Section titled “writeEvent()”writeEvent(_event): Promise<string>;Defined in: packages/log-c2sp-tlog/src/reader.ts:518
Appends a signed event to the log. The event MUST already carry the signatures required by its log method before writeEvent is called. Returns a LogRef identifying the recorded entry.
Parameters
Section titled “Parameters”_event
Section titled “_event”Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”writePreparedEvent()
Section titled “writePreparedEvent()”writePreparedEvent(prepared, options): Promise<string>;Defined in: packages/log-c2sp-tlog/src/reader.ts:514
Parameters
Section titled “Parameters”prepared
Section titled “prepared”options
Section titled “options”Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”C2spTlogBinding.writePreparedEvent
C2spTlogError
Section titled “C2spTlogError”Defined in: packages/log-c2sp-tlog/src/errors.ts:8
Base error for all c2sp-tlog failures.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new C2spTlogError(message, options?): C2spTlogError;Defined in: packages/log-c2sp-tlog/src/errors.ts:11
Parameters
Section titled “Parameters”message
Section titled “message”string
options?
Section titled “options?”cause?
Section titled “cause?”unknown
errorCategory?
Section titled “errorCategory?”status?
Section titled “status?”number
transient?
Section titled “transient?”boolean
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Properties
Section titled “Properties”agentState?
Section titled “agentState?”readonly optional agentState?: string;Defined in: packages/protocol/src/errors.ts:88
Agent state reported by the status document, when the failure is state-related.
Inherited from
Section titled “Inherited from”cause?
Section titled “cause?”optional cause?: unknown;Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24
Inherited from
Section titled “Inherited from”readonly code: VerificationCode;Defined in: packages/protocol/src/errors.ts:84
Classification of the failure.
Inherited from
Section titled “Inherited from”errorCategory?
Section titled “errorCategory?”readonly optional errorCategory?: LifecycleErrorCategory;Defined in: packages/protocol/src/errors.ts:90
Lifecycle conformance category, when the failure maps to a lifecycle state-machine rule.
Inherited from
Section titled “Inherited from”VerificationError.errorCategory
message
Section titled “message”message: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1075
Inherited from
Section titled “Inherited from”name: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1074
Inherited from
Section titled “Inherited from”stack?
Section titled “stack?”optional stack?: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”status?
Section titled “status?”readonly optional status?: number;Defined in: packages/log-c2sp-tlog/src/errors.ts:9
transient
Section titled “transient”readonly transient: boolean;Defined in: packages/protocol/src/errors.ts:86
True when retrying the verification may succeed.
Inherited from
Section titled “Inherited from”verifiedEntityKeyThumbprint?
Section titled “verifiedEntityKeyThumbprint?”readonly optional verifiedEntityKeyThumbprint?: string;Defined in: packages/protocol/src/errors.ts:94
Observed verified record-signing key thumbprint (CounterpartyNotAccepted only). Never echoes configured pins.
Inherited from
Section titled “Inherited from”VerificationError.verifiedEntityKeyThumbprint
verifiedGovernanceId?
Section titled “verifiedGovernanceId?”readonly optional verifiedGovernanceId?: string;Defined in: packages/protocol/src/errors.ts:92
Observed verified governance ID (CounterpartyNotAccepted only). Never echoes configured policy.
Inherited from
Section titled “Inherited from”VerificationError.verifiedGovernanceId
stackTraceLimit
Section titled “stackTraceLimit”static stackTraceLimit: number;Defined in: node_modules/@types/node/globals.d.ts:67
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Section titled “Inherited from”VerificationError.stackTraceLimit
Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”static captureStackTrace(targetObject, constructorOpt?): void;Defined in: node_modules/@types/node/globals.d.ts:51
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};Error.captureStackTrace(myObject);myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() { b();}
function b() { c();}
function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error;}
a();Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”VerificationError.captureStackTrace
prepareStackTrace()
Section titled “prepareStackTrace()”static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/@types/node/globals.d.ts:55
Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Section titled “Inherited from”VerificationError.prepareStackTrace
C2spTlogParseError
Section titled “C2spTlogParseError”Defined in: packages/log-c2sp-tlog/src/errors.ts:29
Thrown when c2sp-tlog input (checkpoint, entry, reference, bundle, …) is malformed or non-canonical.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new C2spTlogParseError(message, cause?): C2spTlogParseError;Defined in: packages/log-c2sp-tlog/src/errors.ts:30
Parameters
Section titled “Parameters”message
Section titled “message”string
cause?
Section titled “cause?”unknown
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Properties
Section titled “Properties”agentState?
Section titled “agentState?”readonly optional agentState?: string;Defined in: packages/protocol/src/errors.ts:88
Agent state reported by the status document, when the failure is state-related.
Inherited from
Section titled “Inherited from”cause?
Section titled “cause?”optional cause?: unknown;Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24
Inherited from
Section titled “Inherited from”readonly code: VerificationCode;Defined in: packages/protocol/src/errors.ts:84
Classification of the failure.
Inherited from
Section titled “Inherited from”errorCategory?
Section titled “errorCategory?”readonly optional errorCategory?: LifecycleErrorCategory;Defined in: packages/protocol/src/errors.ts:90
Lifecycle conformance category, when the failure maps to a lifecycle state-machine rule.
Inherited from
Section titled “Inherited from”message
Section titled “message”message: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1075
Inherited from
Section titled “Inherited from”name: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1074
Inherited from
Section titled “Inherited from”stack?
Section titled “stack?”optional stack?: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”status?
Section titled “status?”readonly optional status?: number;Defined in: packages/log-c2sp-tlog/src/errors.ts:9
Inherited from
Section titled “Inherited from”transient
Section titled “transient”readonly transient: boolean;Defined in: packages/protocol/src/errors.ts:86
True when retrying the verification may succeed.
Inherited from
Section titled “Inherited from”verifiedEntityKeyThumbprint?
Section titled “verifiedEntityKeyThumbprint?”readonly optional verifiedEntityKeyThumbprint?: string;Defined in: packages/protocol/src/errors.ts:94
Observed verified record-signing key thumbprint (CounterpartyNotAccepted only). Never echoes configured pins.
Inherited from
Section titled “Inherited from”C2spTlogError.verifiedEntityKeyThumbprint
verifiedGovernanceId?
Section titled “verifiedGovernanceId?”readonly optional verifiedGovernanceId?: string;Defined in: packages/protocol/src/errors.ts:92
Observed verified governance ID (CounterpartyNotAccepted only). Never echoes configured policy.
Inherited from
Section titled “Inherited from”C2spTlogError.verifiedGovernanceId
stackTraceLimit
Section titled “stackTraceLimit”static stackTraceLimit: number;Defined in: node_modules/@types/node/globals.d.ts:67
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”static captureStackTrace(targetObject, constructorOpt?): void;Defined in: node_modules/@types/node/globals.d.ts:51
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};Error.captureStackTrace(myObject);myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() { b();}
function b() { c();}
function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error;}
a();Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”C2spTlogError.captureStackTrace
prepareStackTrace()
Section titled “prepareStackTrace()”static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/@types/node/globals.d.ts:55
Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Section titled “Inherited from”C2spTlogError.prepareStackTrace
C2spTlogReader
Section titled “C2spTlogReader”Defined in: packages/log-c2sp-tlog/src/reader.ts:100
LogReader for the c2sp-tlog method: verifies an agent’s identity-record
lifecycle against a C2SP tlog-tiles log. Evidence is loaded from a verified
stream bundle when configured, otherwise through the stream source; checkpoints
are policy-enforced and advanced in a trusted checkpoint store. One verified
lifecycle snapshot is shared by the
binding, continuity, and key-age checks performed by one reader.
Throws
Section titled “Throws”VerificationError (LogError) from every LogReader boundary.
Extended by
Section titled “Extended by”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new C2spTlogReader(lr, options): C2spTlogReader;Defined in: packages/log-c2sp-tlog/src/reader.ts:109
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Properties
Section titled “Properties”readonly lr: string;Defined in: packages/log-c2sp-tlog/src/reader.ts:109
parsed
Section titled “parsed”readonly parsed: ParsedC2spTlogLr;Defined in: packages/log-c2sp-tlog/src/reader.ts:101
Methods
Section titled “Methods”additionalSignerRoles()
Section titled “additionalSignerRoles()”additionalSignerRoles(event): LogSignerRole[];Defined in: packages/log-c2sp-tlog/src/reader.ts:134
Parameters
Section titled “Parameters”Returns
Section titled “Returns”canonical()
Section titled “canonical()”canonical(event): Promise<Uint8Array<ArrayBufferLike>>;Defined in: packages/log-c2sp-tlog/src/reader.ts:129
Returns the canonical byte representation of the event for this log method. Used to verify the signatures required by the log method on events read from the log. MUST produce identical output to Log.canonical for the same supported event.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
Implementation of
Section titled “Implementation of”keyTimestamp()
Section titled “keyTimestamp()”keyTimestamp(domain, keyThumbprint): Promise<Date>;Defined in: packages/log-c2sp-tlog/src/reader.ts:138
Returns the timestamp at which the given key thumbprint was bound to the domain (ISSUANCE or KEY_ROTATION event). Used for ka validation.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
keyThumbprint
Section titled “keyThumbprint”string
Returns
Section titled “Returns”Promise<Date>
Implementation of
Section titled “Implementation of”readEvent()
Section titled “readEvent()”readEvent(ref): Promise<LogEvent>;Defined in: packages/log-c2sp-tlog/src/reader.ts:209
Reads a single event by its log reference. MUST verify inclusion proof and timestamp proof before returning.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<LogEvent>
Implementation of
Section titled “Implementation of”rebuildHistory()
Section titled “rebuildHistory()”rebuildHistory(domain): Promise<LogEvent[]>;Defined in: packages/log-c2sp-tlog/src/reader.ts:263
Rebuilds the full event history for the domain in authoritative log order. MUST verify inclusion proofs, timestamp proofs, append-only consistency, and required lifecycle signatures on every returned event. Event signature verification MUST use the public keys valid for that event in the reconstructed lifecycle history. Events with invalid signatures MUST NOT be returned.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
Returns
Section titled “Returns”Promise<LogEvent[]>
Implementation of
Section titled “Implementation of”verifyBilateralBinding()
Section titled “verifyBilateralBinding()”verifyBilateralBinding( record, entityKey, operationalKey): Promise<{ initialEntityThumbprint: string; initialOperationalThumbprint: string; timestamp: Date;}>;Defined in: packages/log-c2sp-tlog/src/reader.ts:146
Verifies draft-01 bilateral ISSUANCE binding for the current TXT record.
Parameters
Section titled “Parameters”record
Section titled “record”unknown
entityKey
Section titled “entityKey”unknown
operationalKey
Section titled “operationalKey”unknown
Returns
Section titled “Returns”Promise<{
initialEntityThumbprint: string;
initialOperationalThumbprint: string;
timestamp: Date;
}>
Implementation of
Section titled “Implementation of”LogReader.verifyBilateralBinding
verifyNonRevocation()
Section titled “verifyNonRevocation()”verifyNonRevocation(domain, at): Promise<LoggedStateEvidence>;Defined in: packages/log-c2sp-tlog/src/reader.ts:183
Verifies that the domain is neither REVOKED nor RETIRED at the given timestamp. Raises on a terminal state or if complete, fresh evidence cannot be established. Returns the accepted proof boundary.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
Date
Returns
Section titled “Returns”Promise<LoggedStateEvidence>
Implementation of
Section titled “Implementation of”verifyOperationalContinuity()
Section titled “verifyOperationalContinuity()”verifyOperationalContinuity( domain, initialOperationalThumbprint, currentOperationalThumbprint): Promise<void>;Defined in: packages/log-c2sp-tlog/src/reader.ts:172
Verifies KEY_ROTATION continuity from ISSUANCE to the current operational key.
Parameters
Section titled “Parameters”domain
Section titled “domain”string
initialOperationalThumbprint
Section titled “initialOperationalThumbprint”string
currentOperationalThumbprint
Section titled “currentOperationalThumbprint”string
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”LogReader.verifyOperationalContinuity
C2spTlogVerificationError
Section titled “C2spTlogVerificationError”Defined in: packages/log-c2sp-tlog/src/errors.ts:37
Thrown when well-formed c2sp-tlog evidence fails cryptographic or policy verification.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new C2spTlogVerificationError(message, errorCategory?): C2spTlogVerificationError;Defined in: packages/log-c2sp-tlog/src/errors.ts:41
Parameters
Section titled “Parameters”message
Section titled “message”string
errorCategory?
Section titled “errorCategory?”LifecycleErrorCategory = 'INVALID_EVIDENCE'
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Properties
Section titled “Properties”agentState?
Section titled “agentState?”readonly optional agentState?: string;Defined in: packages/protocol/src/errors.ts:88
Agent state reported by the status document, when the failure is state-related.
Inherited from
Section titled “Inherited from”cause?
Section titled “cause?”optional cause?: unknown;Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24
Inherited from
Section titled “Inherited from”readonly code: VerificationCode;Defined in: packages/protocol/src/errors.ts:84
Classification of the failure.
Inherited from
Section titled “Inherited from”errorCategory
Section titled “errorCategory”readonly errorCategory: LifecycleErrorCategory;Defined in: packages/log-c2sp-tlog/src/errors.ts:39
Lifecycle conformance category for this failure; defaults to INVALID_EVIDENCE.
Overrides
Section titled “Overrides”message
Section titled “message”message: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1075
Inherited from
Section titled “Inherited from”name: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1074
Inherited from
Section titled “Inherited from”stack?
Section titled “stack?”optional stack?: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”status?
Section titled “status?”readonly optional status?: number;Defined in: packages/log-c2sp-tlog/src/errors.ts:9
Inherited from
Section titled “Inherited from”transient
Section titled “transient”readonly transient: boolean;Defined in: packages/protocol/src/errors.ts:86
True when retrying the verification may succeed.
Inherited from
Section titled “Inherited from”verifiedEntityKeyThumbprint?
Section titled “verifiedEntityKeyThumbprint?”readonly optional verifiedEntityKeyThumbprint?: string;Defined in: packages/protocol/src/errors.ts:94
Observed verified record-signing key thumbprint (CounterpartyNotAccepted only). Never echoes configured pins.
Inherited from
Section titled “Inherited from”C2spTlogError.verifiedEntityKeyThumbprint
verifiedGovernanceId?
Section titled “verifiedGovernanceId?”readonly optional verifiedGovernanceId?: string;Defined in: packages/protocol/src/errors.ts:92
Observed verified governance ID (CounterpartyNotAccepted only). Never echoes configured policy.
Inherited from
Section titled “Inherited from”C2spTlogError.verifiedGovernanceId
stackTraceLimit
Section titled “stackTraceLimit”static stackTraceLimit: number;Defined in: node_modules/@types/node/globals.d.ts:67
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”static captureStackTrace(targetObject, constructorOpt?): void;Defined in: node_modules/@types/node/globals.d.ts:51
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};Error.captureStackTrace(myObject);myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() { b();}
function b() { c();}
function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error;}
a();Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”C2spTlogError.captureStackTrace
prepareStackTrace()
Section titled “prepareStackTrace()”static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/@types/node/globals.d.ts:55
Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Section titled “Inherited from”C2spTlogError.prepareStackTrace
InMemoryTrustedC2spCheckpointStore
Section titled “InMemoryTrustedC2spCheckpointStore”Defined in: packages/log-c2sp-tlog/src/checkpoint-trust.ts:42
Non-persistent, per-process trusted checkpoint store.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new InMemoryTrustedC2spCheckpointStore(): InMemoryTrustedC2spCheckpointStore;Returns
Section titled “Returns”InMemoryTrustedC2spCheckpointStore
Methods
Section titled “Methods”compareAndSwap()
Section titled “compareAndSwap()”compareAndSwap( origin, expected, candidate, signal?): Promise<boolean>;Defined in: packages/log-c2sp-tlog/src/checkpoint-trust.ts:50
Atomically replaces expected with candidate; returns false on a lost race.
Implementations must honor cancellation at the commit boundary: an aborted
signal must prevent a pending write, not merely reject its returned promise.
Parameters
Section titled “Parameters”origin
Section titled “origin”string
expected
Section titled “expected”TrustedC2spCheckpoint | undefined
candidate
Section titled “candidate”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”TrustedC2spCheckpointStore.compareAndSwap
load()
Section titled “load()”load(origin, signal?): Promise<TrustedC2spCheckpoint | undefined>;Defined in: packages/log-c2sp-tlog/src/checkpoint-trust.ts:45
Returns the currently trusted checkpoint for origin, if any.
Parameters
Section titled “Parameters”origin
Section titled “origin”string
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<TrustedC2spCheckpoint | undefined>
Implementation of
Section titled “Implementation of”TrustedC2spCheckpointStore.load
ScanStreamSource
Section titled “ScanStreamSource”Defined in: packages/log-c2sp-tlog/src/stream-source.ts:130
StreamSource that performs a complete scan of a C2SP tlog-tiles log: it fetches the checkpoint, authenticates it via the configured callback, then downloads every fixed-geometry entry bundle up to the checkpoint tree size.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ScanStreamSource(options, resourceFetcher?): ScanStreamSource;Defined in: packages/log-c2sp-tlog/src/stream-source.ts:137
Parameters
Section titled “Parameters”options
Section titled “options”resourceFetcher?
Section titled “resourceFetcher?”C2spBoundedResourceFetcher = ...
Returns
Section titled “Returns”Methods
Section titled “Methods”load()
Section titled “load()”load(prefix, options?): Promise<StreamEvidence>;Defined in: packages/log-c2sp-tlog/src/stream-source.ts:150
Loads and authenticates the checkpoint, then every entry of the log at prefix (complete is always true).
Parameters
Section titled “Parameters”prefix
Section titled “prefix”string
options?
Section titled “options?”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<StreamEvidence>