PeerSettlement

Experimental

One settlement: an optional admission decision plus the outcome of each message the settlement released, in order.

Fields and variants

• decision — Experimental
• outcomes — Experimental
• position — Experimental

Source

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

{
  "description": "One settlement: an optional admission decision plus the outcome of each\nmessage the settlement released, in order.",
  "properties": {
    "decision": {
      "$ref": "#/$defs/PeerSettlementDecision",
      "description": "The admission decision this settlement records, when it records one."
    },
    "outcomes": {
      "description": "One entry per released message, in release order (required); a\n`null` entry keeps the ordinal of a message with nothing to show.",
      "items": {
        "anyOf": [
          {
            "$ref": "#/$defs/PeerSettlementOutcome"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    },
    "position": {
      "$ref": "#/$defs/PeerSettlementPosition",
      "description": "The settlement's position (required)."
    }
  },
  "required": [
    "outcomes",
    "position"
  ],
  "type": "object",
  "x-msp-descriptor": "peer/settlements",
  "x-msp-stability": "experimental"
}