PeerSettlementsParams

Experimental

peer/settlements params. Unknown fields are invalidParams.

Fields and variants

• after — Experimental
• limit — Experimental
• sessionId — Experimental

Source

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

{
  "description": "`peer/settlements` params. Unknown fields are\n`invalidParams`.",
  "properties": {
    "after": {
      "$ref": "#/$defs/PeerSettlementPosition",
      "description": "The position of the last settlement the client folded; absent reads\nfrom the first settlement."
    },
    "limit": {
      "description": "Page size, 1 to [`PEER_SETTLEMENTS_PAGE_MAX`]; absent means the\nmaximum.",
      "type": "integer"
    },
    "sessionId": {
      "description": "The receiving session (required; loaded on this host).",
      "type": "string"
    }
  },
  "required": [
    "sessionId"
  ],
  "type": "object",
  "x-msp-descriptor": "peer/settlements",
  "x-msp-stability": "experimental"
}