Skip to content
Developer Preview

peer/settlementsChanged

Experimental

A peer-admission settlement committed in the receiving session; read peer/settlements from your cursor.

Type: PeerSettlementsChangedParams

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.

Field Type Stability Presence Description
revision integer Experimental required The settlement revision after the change (required).
sessionId string Experimental required The receiving session (required).
Source

schema/msp/experimental/msp.schema.json#/notifications/peer~2FsettlementsChanged

{
"description": "A peer-admission settlement committed in the receiving session; read `peer/settlements` from your cursor.",
"params": {
"$ref": "#/$defs/PeerSettlementsChangedParams"
},
"x-msp-descriptor": "peer/settlementsChanged",
"x-msp-stability": "experimental"
}