PeerSettlementsChangedParams

Experimental

peer/settlementsChanged params: a non-view notification to the receiving session’s connections. revision grows by at least one per committed settlement batch; it is a wake hint, not a cursor, and the client reads peer/settlements from its own cursor.

Fields and variants

• revision — Experimental
• sessionId — Experimental

Source

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

{
  "description": "`peer/settlementsChanged` params: a non-view notification\nto the receiving session's connections. `revision` grows by at least one\nper committed settlement batch; it is a wake hint, not a cursor, and the\nclient reads `peer/settlements` from its own cursor.",
  "properties": {
    "revision": {
      "description": "The settlement revision after the change (required).",
      "type": "integer"
    },
    "sessionId": {
      "description": "The receiving session (required).",
      "type": "string"
    }
  },
  "required": [
    "revision",
    "sessionId"
  ],
  "type": "object",
  "x-msp-descriptor": "peer/settlementsChanged",
  "x-msp-stability": "experimental"
}