Skip to content

A notification, pushed at least once, in no particular order (REQ-EV-2). Its id is stable across attempts (REQ-EV-3). It is signed: aledgent-signature is v1=HMAC-SHA256 over the id, aledgent-attempt-time and the body (REQ-EV-4). It names the latest anchor final when its transition was recorded, or null when none was (REQ-EV-1, AC-M2.4).

POST
aledgent-notification-id
required
string
aledgent-attempt-time
required
string
aledgent-signature
required
string
Media typeapplication/json

A notification (CTR-EVT, REQ-EV-1–REQ-EV-3). It stands on its own: it never needs an earlier notification to be understood, and its id is the same on every attempt, so a redelivery is recognisable.

object
anchor
Any of:

An anchor a notification names (REQ-EV-1, AC-M2.4): a final checkpoint of the book.

object
coordinate
required

Its Anchored record on the settlement layer.

object
digest
required

The entry’s digest, hex.

string
instance
required

The instance.

integer format: uint32
seq
required

The position in its inbox.

integer format: uint64
entry_sequence
required

The sequence of the last entry it commits to (REQ-PR-7).

integer format: uint64
height
required

The height of the block that wrote that record.

integer format: uint64
number
required

Its number: the settlement layer’s anchor number.

integer format: uint64
class
required
One of:

Terminal: the outcome is final.

string
Allowed value: terminal
error
Any of:
One of:
ERR-NotAuthorised
object
description
required
Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound
error
required
Allowed value: ERR-NotAuthorised
id
required

H(operation, transition), hex: stable across attempts (REQ-EV-3).

string
operation_reference
required

The operation.

string
outcome

The terminal state, where terminal.

string | null
reference
Any of:

Pass-through data (REQ-PO-5): any one JSON value, at most 1024 bytes of UTF-8 as sent. Kept and echoed exactly as sent; never read by aledgent. Over the bound, or not one JSON value, the command is refused with ERR-MalformedCommand.

state
required

The state it entered.

string
terminal
required

Whether it is terminal.

boolean

Received. Anything else is retried.