PeerSettlementsResult

Experimental

peer/settlements result: one page, ascending by position.

Fields and variants

• requestedAfter — Experimental
• sessionId — Experimental
• settlements — Experimental
• through — Experimental

Source

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

{
  "description": "`peer/settlements` result: one page, ascending by position.",
  "properties": {
    "requestedAfter": {
      "anyOf": [
        {
          "$ref": "#/$defs/PeerSettlementPosition"
        },
        {
          "type": "null"
        }
      ],
      "description": "The request's `after`, echoed (required, nullable)."
    },
    "sessionId": {
      "description": "The receiving session (required).",
      "type": "string"
    },
    "settlements": {
      "description": "At most `limit` settlements, strictly ascending (required).",
      "items": {
        "$ref": "#/$defs/PeerSettlement"
      },
      "type": "array"
    },
    "through": {
      "anyOf": [
        {
          "$ref": "#/$defs/PeerSettlementPosition"
        },
        {
          "type": "null"
        }
      ],
      "description": "The last settlement in this page, or `requestedAfter` when the page\nis empty (required, nullable). The next read passes it as `after`."
    }
  },
  "required": [
    "requestedAfter",
    "sessionId",
    "settlements",
    "through"
  ],
  "type": "object",
  "x-msp-descriptor": "peer/settlements",
  "x-msp-stability": "experimental"
}