PeerSettlementPosition

Experimental

A settlement’s position in the receiving session’s log: the settlement record’s id and its stream sequence. Clients treat it as an opaque cursor that orders by sequence.

Fields and variants

• id — Experimental
• sequence — Experimental

Source

schema/msp/experimental/msp.schema.json#/types/PeerSettlementPosition

{
  "description": "A settlement's position in the receiving session's log: the settlement\nrecord's id and its stream sequence. Clients treat it as an opaque cursor\nthat orders by `sequence`.",
  "properties": {
    "id": {
      "description": "The settlement record id (required).",
      "type": "string"
    },
    "sequence": {
      "description": "The record's stream sequence, at least 1 (required).",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "sequence"
  ],
  "type": "object",
  "x-msp-descriptor": "peer/settlements",
  "x-msp-stability": "experimental"
}