peer/settlements

Experimental

Reads one page of the receiving session’s peer-admission settlements after a cursor, ascending, in the shape the receiver timeline folds.

Parameters

Type: PeerSettlementsParams

peer/settlements params. Unknown fields are invalidParams.

Field	Type	Stability	Presence	Description
after	PeerSettlementPosition	Experimental	optional	The position of the last settlement the client folded; absent reads from the first settlement.
limit	integer	Experimental	optional	Page size, 1 to [PEER_SETTLEMENTS_PAGE_MAX]; absent means the maximum.
sessionId	string	Experimental	required	The receiving session (required; loaded on this host).

Source

schema/msp/experimental/msp.schema.json#/methods/peer~2Fsettlements

{
  "description": "Reads one page of the receiving session's peer-admission settlements after a cursor, ascending, in the shape the receiver timeline folds.",
  "params": {
    "$ref": "#/$defs/PeerSettlementsParams"
  },
  "result": {
    "$ref": "#/$defs/PeerSettlementsResult"
  },
  "x-msp-descriptor": "peer/settlements",
  "x-msp-stability": "experimental"
}