@hyperscale0/udl 2.3.0 → 2.4.0

package/conformance/valid/vocabulary.udl

@@ -0,0 +1,1999 @@
+{
+  "instruments": [
+    {
+      "actionOrder": [
+        "payoff",
+        "write_off",
+        "create",
+        "close"
+      ],
+      "actions": {
+        "close": {
+          "agentDescription": "Close when the declared count and schedule hold.",
+          "effects": {
+            "reads": [
+              {
+                "signature": "reads.requires_aggregate",
+                "source": "requiresAggregate"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "closeCover",
+          "requiresAggregate": [
+            {
+              "check": {
+                "kind": "count_at_least",
+                "targetField": "minimumMissed"
+              },
+              "instrumentId": "slice",
+              "over": "children",
+              "refField": "coverId",
+              "statuses": [
+                "closed"
+              ]
+            },
+            {
+              "check": {
+                "field": "dueAt",
+                "kind": "ordered",
+                "positionField": "position"
+              },
+              "instrumentId": "slice",
+              "over": "children",
+              "refField": "coverId",
+              "statuses": [
+                "open"
+              ]
+            },
+            {
+              "check": {
+                "amounts": [
+                  {
+                    "amountField": "principal",
+                    "totalField": "principal"
+                  },
+                  {
+                    "amountField": "profit",
+                    "totalField": "profit"
+                  }
+                ],
+                "dateField": "dueAt",
+                "datesField": "dates",
+                "kind": "schedule",
+                "positionField": "position",
+                "remainder": "first"
+              },
+              "instrumentId": "slice",
+              "over": "children",
+              "refField": "coverId",
+              "statuses": [
+                "open"
+              ]
+            }
+          ],
+          "steps": [],
+          "summary": "Close instrument"
+        },
+        "create": {
+          "agentDescription": "Record the signed cover terms.",
+          "moves": [],
+          "publicAction": "createCover",
+          "requiresExposure": [
+            {
+              "amountField": "principal",
+              "anchorField": "limitId",
+              "capField": "cap",
+              "capOnAnchor": true,
+              "childInstrumentId": "cover",
+              "measure": {
+                "allocation": "principal"
+              },
+              "statuses": [
+                "open"
+              ]
+            }
+          ],
+          "steps": [],
+          "summary": "Create instrument"
+        },
+        "payoff": {
+          "agentDescription": "Compute this obligation's payoff from its remaining balances.",
+          "allocate": {
+            "capture": "payoffReceipt",
+            "mode": "payoff",
+            "paymentIdentityField": "paymentIdentity",
+            "sourceAccountField": "payerAccount"
+          },
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.allocation",
+                "source": "allocate"
+              }
+            ],
+            "moves": [
+              {
+                "signature": "moves.allocation",
+                "source": "allocate"
+              }
+            ]
+          },
+          "input": {
+            "additionalProperties": false,
+            "properties": {
+              "payerAccount": {
+                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+                "type": "string"
+              },
+              "paymentIdentity": {
+                "minLength": 1,
+                "type": "string"
+              }
+            },
+            "required": [
+              "payerAccount",
+              "paymentIdentity"
+            ],
+            "type": "object"
+          },
+          "moves": [],
+          "publicAction": "payoffCover",
+          "steps": [],
+          "summary": "Payoff instrument"
+        },
+        "write_off": {
+          "agentDescription": "Cancel this obligation without cash.",
+          "allocate": {
+            "capture": "loss",
+            "mode": "write_off"
+          },
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.allocation",
+                "source": "allocate"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "writeOffCover",
+          "steps": [],
+          "summary": "Write Off instrument"
+        }
+      },
+      "agentDescription": "Freeze the signed dates and amounts before admitting slices.",
+      "allocation": {
+        "buckets": [
+          {
+            "key": "principal",
+            "source": {
+              "amountField": "principal",
+              "destinationField": "receiver",
+              "from": "slice"
+            }
+          },
+          {
+            "key": "profit",
+            "source": {
+              "amountField": "profit",
+              "destinationField": "receiver",
+              "from": "slice"
+            }
+          },
+          {
+            "key": "cost",
+            "source": {
+              "amountField": "amount",
+              "destinationField": "receiver",
+              "from": "children",
+              "parameters": {
+                "cost": true
+              },
+              "refField": "sliceId",
+              "statuses": [
+                "open"
+              ],
+              "template": "assessment"
+            }
+          }
+        ],
+        "dueField": "dueAt",
+        "earningRuleField": "earningRule",
+        "positionField": "position",
+        "sliceInstrumentId": "slice",
+        "sliceRefField": "coverId",
+        "sliceStatuses": [
+          "open"
+        ]
+      },
+      "dateOrder": [
+        {
+          "afterField": "end",
+          "beforeField": "start",
+          "operator": "<"
+        }
+      ],
+      "fields": {
+        "currency": {
+          "description": "ISO 4217 currency code",
+          "maxLength": 3,
+          "minLength": 3,
+          "pattern": "^[A-Z]{3}$",
+          "type": "string"
+        },
+        "dates": {
+          "items": {
+            "format": "hyperscale-date-time",
+            "type": "string"
+          },
+          "maxItems": 366,
+          "minItems": 1,
+          "type": "array"
+        },
+        "earningRule": {
+          "enum": [
+            "per_slice_on_due",
+            "on_disbursement"
+          ],
+          "type": "string"
+        },
+        "end": {
+          "format": "hyperscale-date-time",
+          "type": "string"
+        },
+        "limitId": {
+          "pattern": "^lim_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "minimumMissed": {
+          "maximum": 1,
+          "minimum": 1,
+          "type": "integer"
+        },
+        "principal": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "profit": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "start": {
+          "format": "hyperscale-date-time",
+          "type": "string"
+        }
+      },
+      "id": "cover",
+      "idPrefix": "cvr",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "close": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          },
+          "payoff": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          },
+          "write_off": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "required": [
+        "limitId",
+        "start",
+        "end",
+        "minimumMissed",
+        "principal",
+        "profit",
+        "dates",
+        "earningRule",
+        "currency"
+      ],
+      "summary": "Cover instrument",
+      "title": "Cover"
+    },
+    {
+      "actionOrder": [
+        "create",
+        "close"
+      ],
+      "actions": {
+        "close": {
+          "due": {
+            "field": "dueAt",
+            "offset": {
+              "field": "grace"
+            }
+          },
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.allocation",
+                "source": "requiresAllocation"
+              },
+              {
+                "signature": "decides.referenced_transition",
+                "source": "transitionsRefs[0]"
+              }
+            ],
+            "schedules": [
+              {
+                "signature": "schedules.due",
+                "source": "due"
+              }
+            ]
+          },
+          "moves": [],
+          "requiresAllocation": {
+            "buckets": [
+              "principal",
+              "profit"
+            ],
+            "check": "settled",
+            "refField": "coverId",
+            "slice": "self"
+          },
+          "steps": [],
+          "summary": "Close instrument",
+          "transitionsRefs": [
+            {
+              "action": "close",
+              "field": "coverId"
+            }
+          ]
+        },
+        "create": {
+          "agentDescription": "Check both signed bounds and the assessment kind.",
+          "effects": {
+            "reads": [
+              {
+                "signature": "reads.requires_refs",
+                "source": "requiresRefs"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "createSlice",
+          "requiresRefs": [
+            {
+              "dateComparison": {
+                "localPath": "fields.start",
+                "operator": ">=",
+                "referencedPath": "fields.start"
+              },
+              "field": "coverId",
+              "statuses": [
+                "open"
+              ],
+              "unique": {
+                "byFields": [
+                  "kind"
+                ],
+                "namespace": "assessment"
+              }
+            },
+            {
+              "dateComparison": {
+                "localPath": "fields.end",
+                "operator": "<=",
+                "referencedPath": "fields.end"
+              },
+              "field": "coverId",
+              "statuses": [
+                "open"
+              ]
+            }
+          ],
+          "steps": [],
+          "summary": "Create instrument"
+        }
+      },
+      "agentDescription": "Keep one premium and its signed interval.",
+      "derivedAmounts": [
+        {
+          "field": "commission",
+          "rounding": "floor",
+          "rule": {
+            "bps": {
+              "field": "rate"
+            },
+            "kind": "percentage_of"
+          },
+          "sourceField": "premium"
+        },
+        {
+          "field": "charge",
+          "rounding": "floor",
+          "rule": {
+            "capField": "cap",
+            "kind": "minimum"
+          },
+          "sourceField": "cost"
+        }
+      ],
+      "fields": {
+        "cap": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "charge": {
+          "pattern": "^(0|[1-9][0-9]{0,17})$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "commission": {
+          "pattern": "^(0|[1-9][0-9]{0,17})$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "cost": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "coverId": {
+          "pattern": "^cvr_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "currency": {
+          "description": "ISO 4217 currency code",
+          "maxLength": 3,
+          "minLength": 3,
+          "pattern": "^[A-Z]{3}$",
+          "type": "string"
+        },
+        "dueAt": {
+          "format": "hyperscale-date-time",
+          "type": "string"
+        },
+        "end": {
+          "format": "hyperscale-date-time",
+          "type": "string"
+        },
+        "grace": {
+          "enum": [
+            "P3D",
+            "P7D"
+          ],
+          "type": "string"
+        },
+        "kind": {
+          "enum": [
+            "fine",
+            "cost"
+          ],
+          "type": "string"
+        },
+        "position": {
+          "maximum": 366,
+          "minimum": 1,
+          "type": "integer"
+        },
+        "premium": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "principal": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "profit": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "rate": {
+          "maximum": 1000,
+          "minimum": 500,
+          "type": "integer"
+        },
+        "receiver": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "start": {
+          "format": "hyperscale-date-time",
+          "type": "string"
+        }
+      },
+      "id": "slice",
+      "idPrefix": "slc",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "close": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "required": [
+        "coverId",
+        "start",
+        "end",
+        "dueAt",
+        "position",
+        "principal",
+        "profit",
+        "premium",
+        "cost",
+        "cap",
+        "rate",
+        "grace",
+        "kind",
+        "receiver",
+        "currency"
+      ],
+      "summary": "Slice instrument",
+      "title": "Slice"
+    },
+    {
+      "actionOrder": [
+        "create",
+        "close"
+      ],
+      "actions": {
+        "close": {
+          "agentDescription": "Close this claim.",
+          "moves": [],
+          "publicAction": "closeClaim",
+          "steps": [],
+          "summary": "Close coverId"
+        },
+        "create": {
+          "agentDescription": "Read the cover's due premiums under the admission clock.",
+          "effects": {
+            "reads": [
+              {
+                "signature": "reads.requires_aggregate",
+                "source": "requiresAggregate"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "createClaim",
+          "requiresAggregate": [
+            {
+              "anchorField": "coverId",
+              "check": {
+                "kind": "count_exactly",
+                "value": 0
+              },
+              "dueBefore": {
+                "field": "dueAt"
+              },
+              "instrumentId": "slice",
+              "over": "siblings",
+              "refField": "coverId",
+              "statuses": [
+                "open"
+              ]
+            }
+          ],
+          "steps": [],
+          "summary": "Create coverId"
+        }
+      },
+      "agentDescription": "Refuse a claim while a sibling premium is unpaid past due.",
+      "fields": {
+        "coverId": {
+          "pattern": "^cvr_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        }
+      },
+      "id": "claim",
+      "idPrefix": "clm",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "close": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "required": [
+        "coverId"
+      ],
+      "summary": "Claim instrument",
+      "title": "Claim"
+    },
+    {
+      "actionOrder": [
+        "create",
+        "close"
+      ],
+      "actions": {
+        "close": {
+          "agentDescription": "Allocate this payment to outstanding debt once.",
+          "allocate": {
+            "amountField": "amount",
+            "capture": "allocationReceipt",
+            "mode": "payment",
+            "paymentIdentityField": "paymentIdentity",
+            "refField": "coverId",
+            "sourceAccountField": "payer"
+          },
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.allocation",
+                "source": "allocate"
+              }
+            ],
+            "moves": [
+              {
+                "signature": "moves.allocation",
+                "source": "allocate"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "closePayment",
+          "steps": [],
+          "summary": "Close instrument"
+        },
+        "create": {
+          "agentDescription": "Record one payment identity.",
+          "moves": [],
+          "publicAction": "createPayment",
+          "steps": [],
+          "summary": "Create instrument"
+        }
+      },
+      "agentDescription": "Allocate one identified payment through the obligation's bucket rules.",
+      "fields": {
+        "amount": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "coverId": {
+          "pattern": "^cvr_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "currency": {
+          "description": "ISO 4217 currency code",
+          "maxLength": 3,
+          "minLength": 3,
+          "pattern": "^[A-Z]{3}$",
+          "type": "string"
+        },
+        "payer": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "paymentIdentity": {
+          "maxLength": 128,
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "id": "payment",
+      "idPrefix": "pmt",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "close": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "required": [
+        "coverId",
+        "amount",
+        "payer",
+        "paymentIdentity",
+        "currency"
+      ],
+      "summary": "Payment instrument",
+      "title": "Payment"
+    },
+    {
+      "actionOrder": [
+        "create",
+        "fund",
+        "refund",
+        "release"
+      ],
+      "actions": {
+        "create": {
+          "agentDescription": "Open the held account for these contributions.",
+          "moves": [],
+          "publicAction": "createJoinedSettlement",
+          "steps": [
+            {
+              "bind": {
+                "currency": {
+                  "from": "const",
+                  "value": "SAR"
+                },
+                "productId": {
+                  "from": "instance",
+                  "path": "productId"
+                }
+              },
+              "capture": {
+                "hold": "accountId"
+              },
+              "operation": "account.escrow.provision"
+            }
+          ],
+          "summary": "Create instrument"
+        },
+        "fund": {
+          "agentDescription": "Fund all contributions together.",
+          "contributionStage": {
+            "accountPath": "refs.hold",
+            "stage": "fund"
+          },
+          "effects": {
+            "moves": [
+              {
+                "signature": "moves.transfer.internal",
+                "source": "contributionStage"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "fundJoinedSettlement",
+          "steps": [],
+          "summary": "Fund instrument"
+        },
+        "refund": {
+          "agentDescription": "Refund all contributions to their original accounts.",
+          "contributionStage": {
+            "accountPath": "refs.hold",
+            "stage": "refund"
+          },
+          "effects": {
+            "moves": [
+              {
+                "signature": "moves.transfer.internal",
+                "source": "contributionStage"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "refundJoinedSettlement",
+          "steps": [],
+          "summary": "Refund instrument"
+        },
+        "release": {
+          "agentDescription": "Release the complete seller, fee and tax partition.",
+          "effects": {
+            "moves": [
+              {
+                "signature": "moves.transfer.internal",
+                "source": "moves[0]"
+              },
+              {
+                "signature": "moves.transfer.internal",
+                "source": "moves[1]"
+              },
+              {
+                "signature": "moves.transfer.internal",
+                "source": "moves[2]"
+              }
+            ]
+          },
+          "moves": [
+            {
+              "bind": {
+                "amount": {
+                  "from": "instance",
+                  "path": "fields.sellerNet"
+                },
+                "currency": {
+                  "from": "const",
+                  "value": "SAR"
+                },
+                "destinationAccountId": {
+                  "from": "instance",
+                  "path": "fields.seller"
+                },
+                "productId": {
+                  "from": "instance",
+                  "path": "productId"
+                },
+                "sourceAccountId": {
+                  "from": "instance",
+                  "path": "refs.hold"
+                }
+              },
+              "key": "net",
+              "operation": "internal_transfer.create"
+            },
+            {
+              "bind": {
+                "amount": {
+                  "from": "instance",
+                  "path": "fields.sellerFee"
+                },
+                "currency": {
+                  "from": "const",
+                  "value": "SAR"
+                },
+                "destinationAccountId": {
+                  "from": "instance",
+                  "path": "fields.feeAccount"
+                },
+                "productId": {
+                  "from": "instance",
+                  "path": "productId"
+                },
+                "sourceAccountId": {
+                  "from": "instance",
+                  "path": "refs.hold"
+                }
+              },
+              "key": "fee",
+              "operation": "internal_transfer.create"
+            },
+            {
+              "bind": {
+                "amount": {
+                  "from": "instance",
+                  "path": "fields.tax"
+                },
+                "currency": {
+                  "from": "const",
+                  "value": "SAR"
+                },
+                "destinationAccountId": {
+                  "from": "instance",
+                  "path": "fields.taxAccount"
+                },
+                "productId": {
+                  "from": "instance",
+                  "path": "productId"
+                },
+                "sourceAccountId": {
+                  "from": "instance",
+                  "path": "refs.hold"
+                }
+              },
+              "key": "tax",
+              "operation": "internal_transfer.create"
+            }
+          ],
+          "publicAction": "releaseJoinedSettlement",
+          "steps": [],
+          "summary": "Release instrument"
+        }
+      },
+      "agentDescription": "Fund one held balance from an immutable list and refund each origin.",
+      "contributions": {
+        "accountKey": "origin",
+        "amountKey": "amount",
+        "field": "contributions",
+        "totalField": "price"
+      },
+      "fields": {
+        "buyerPart": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "contributions": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "amount": {
+                "pattern": "^[1-9][0-9]{0,17}$",
+                "type": "string",
+                "x-hyperscale-currency": "SAR"
+              },
+              "origin": {
+                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+                "type": "string"
+              }
+            },
+            "required": [
+              "amount",
+              "origin"
+            ],
+            "type": "object"
+          },
+          "maxItems": 256,
+          "minItems": 1,
+          "type": "array"
+        },
+        "currency": {
+          "const": "SAR",
+          "type": "string"
+        },
+        "feeAccount": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "funderPart": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "price": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "seller": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "sellerFee": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "sellerNet": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "tax": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "taxAccount": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        }
+      },
+      "id": "joined_settlement",
+      "idPrefix": "stlm",
+      "lifecycle": {
+        "initial": "created",
+        "states": [
+          "created",
+          "funded",
+          "refunded",
+          "released"
+        ],
+        "transitions": {
+          "fund": {
+            "from": [
+              "created"
+            ],
+            "to": "funded"
+          },
+          "refund": {
+            "from": [
+              "funded"
+            ],
+            "to": "refunded"
+          },
+          "release": {
+            "from": [
+              "funded"
+            ],
+            "to": "released"
+          }
+        }
+      },
+      "partitions": [
+        {
+          "pieceFields": [
+            "buyerPart",
+            "funderPart"
+          ],
+          "totalField": "price"
+        },
+        {
+          "pieceFields": [
+            "sellerNet",
+            "sellerFee",
+            "tax"
+          ],
+          "totalField": "price"
+        }
+      ],
+      "required": [
+        "price",
+        "buyerPart",
+        "funderPart",
+        "sellerNet",
+        "sellerFee",
+        "tax",
+        "seller",
+        "feeAccount",
+        "taxAccount",
+        "currency",
+        "contributions"
+      ],
+      "summary": "Joined Settlement instrument",
+      "title": "Joined Settlement"
+    },
+    {
+      "actionOrder": [
+        "create",
+        "close"
+      ],
+      "actions": {
+        "close": {
+          "agentDescription": "Pay the positive remaining balance.",
+          "effects": {
+            "moves": [
+              {
+                "signature": "moves.transfer.internal",
+                "source": "moves[0]"
+              }
+            ]
+          },
+          "moves": [
+            {
+              "bind": {
+                "amount": {
+                  "from": "instance",
+                  "path": "refs.remaining"
+                },
+                "currency": {
+                  "from": "const",
+                  "value": "SAR"
+                },
+                "destinationAccountId": {
+                  "from": "instance",
+                  "path": "fields.receiver"
+                },
+                "productId": {
+                  "from": "instance",
+                  "path": "productId"
+                },
+                "sourceAccountId": {
+                  "from": "instance",
+                  "path": "fields.payer"
+                }
+              },
+              "key": "pay",
+              "operation": "internal_transfer.create"
+            }
+          ],
+          "publicAction": "closePayoffRemainder",
+          "remainder": {
+            "amountRef": "remaining",
+            "onZero": "refuse",
+            "subtractPaths": [
+              "fields.paid",
+              "fields.rebate"
+            ],
+            "totalPath": "fields.total"
+          },
+          "steps": [],
+          "summary": "Close instrument"
+        },
+        "create": {
+          "agentDescription": "Record immutable balances.",
+          "moves": [],
+          "publicAction": "createPayoffRemainder",
+          "steps": [],
+          "summary": "Create instrument"
+        }
+      },
+      "agentDescription": "Subtract paid principal and cancelled profit from a fixed total.",
+      "fields": {
+        "currency": {
+          "const": "SAR",
+          "type": "string"
+        },
+        "paid": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "payer": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "rebate": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "receiver": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "total": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        }
+      },
+      "id": "payoff_remainder",
+      "idPrefix": "rem",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "close": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "parties": {
+        "payer": "payer",
+        "receiver": "receiver"
+      },
+      "required": [
+        "payer",
+        "receiver",
+        "total",
+        "paid",
+        "rebate",
+        "currency"
+      ],
+      "summary": "Payoff Remainder instrument",
+      "title": "Payoff Remainder"
+    },
+    {
+      "actionOrder": [
+        "create",
+        "close"
+      ],
+      "actions": {
+        "close": {
+          "agentDescription": "Refund the recorded assessment allocation once.",
+          "allocate": {
+            "action": "close",
+            "assessmentField": "assessment",
+            "capture": "refundReceipt",
+            "mode": "refund",
+            "refField": "paymentId"
+          },
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.allocation",
+                "source": "allocate"
+              }
+            ],
+            "moves": [
+              {
+                "signature": "moves.allocation",
+                "source": "allocate"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "closeAllocationRefund",
+          "steps": [],
+          "summary": "Close instrument"
+        },
+        "create": {
+          "agentDescription": "Identify the original payment receipt.",
+          "moves": [],
+          "publicAction": "createAllocationRefund",
+          "steps": [],
+          "summary": "Create instrument"
+        }
+      },
+      "agentDescription": "Refund one previously recorded allocation to its original payer.",
+      "fields": {
+        "assessment": {
+          "maxLength": 128,
+          "minLength": 1,
+          "type": "string"
+        },
+        "paymentId": {
+          "pattern": "^pmt_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        }
+      },
+      "id": "allocation_refund",
+      "idPrefix": "arfn",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "close": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "required": [
+        "paymentId",
+        "assessment"
+      ],
+      "summary": "Allocation Refund instrument",
+      "title": "Allocation Refund"
+    },
+    {
+      "actionOrder": [
+        "create",
+        "close"
+      ],
+      "actions": {
+        "close": {
+          "agentDescription": "Close the limit without releasing its subject claim.",
+          "moves": [],
+          "publicAction": "closeLimit",
+          "steps": [],
+          "summary": "Close instrument"
+        },
+        "create": {
+          "agentDescription": "Claim this borrower and currency once.",
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.subject_unique",
+                "source": "unique"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "createLimit",
+          "steps": [],
+          "summary": "Create instrument",
+          "unique": {
+            "byFields": [
+              "borrower",
+              "currency"
+            ],
+            "namespace": "borrower_limit"
+          }
+        }
+      },
+      "agentDescription": "Keep one permanent cap per borrower and currency.",
+      "fields": {
+        "borrower": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "cap": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "currency": {
+          "const": "SAR",
+          "type": "string"
+        }
+      },
+      "id": "limit",
+      "idPrefix": "lim",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "close": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "required": [
+        "borrower",
+        "currency",
+        "cap"
+      ],
+      "summary": "Limit instrument",
+      "title": "Limit"
+    },
+    {
+      "actionOrder": [
+        "collect",
+        "refund",
+        "create"
+      ],
+      "actions": {
+        "collect": {
+          "agentDescription": "Collect this assessment's remaining balance.",
+          "allocate": {
+            "amountField": "amount",
+            "assessment": "self",
+            "capture": "collectionReceipt",
+            "mode": "payment",
+            "paymentIdentityField": "paymentIdentity",
+            "refField": "coverId",
+            "sourceAccountField": "receiver"
+          },
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.allocation",
+                "source": "allocate"
+              }
+            ],
+            "moves": [
+              {
+                "signature": "moves.allocation",
+                "source": "allocate"
+              }
+            ]
+          },
+          "input": {
+            "additionalProperties": false,
+            "properties": {
+              "paymentIdentity": {
+                "minLength": 1,
+                "type": "string"
+              }
+            },
+            "required": [
+              "paymentIdentity"
+            ],
+            "type": "object"
+          },
+          "moves": [],
+          "publicAction": "collectFirstCost",
+          "steps": [],
+          "summary": "Collect instrument"
+        },
+        "create": {
+          "agentDescription": "Record the assessment.",
+          "moves": [],
+          "publicAction": "createFirstCost",
+          "steps": [],
+          "summary": "Create instrument"
+        },
+        "refund": {
+          "agentDescription": "Reverse this record's prior collection.",
+          "allocate": {
+            "action": "collect",
+            "capture": "refundReceipt",
+            "mode": "refund"
+          },
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.allocation",
+                "source": "allocate"
+              }
+            ],
+            "moves": [
+              {
+                "signature": "moves.allocation",
+                "source": "allocate"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "refundFirstCost",
+          "steps": [],
+          "summary": "Refund instrument"
+        }
+      },
+      "agentDescription": "One assessment selected by template and bound kind.",
+      "fields": {
+        "amount": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "coverId": {
+          "pattern": "^cvr_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "currency": {
+          "description": "ISO 4217 currency code",
+          "maxLength": 3,
+          "minLength": 3,
+          "pattern": "^[A-Z]{3}$",
+          "type": "string"
+        },
+        "receiver": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "sliceId": {
+          "pattern": "^slc_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        }
+      },
+      "id": "first_cost",
+      "idPrefix": "fc",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "paid",
+          "refunded"
+        ],
+        "transitions": {
+          "collect": {
+            "from": [
+              "open"
+            ],
+            "to": "paid"
+          },
+          "refund": {
+            "from": [
+              "paid"
+            ],
+            "to": "refunded"
+          }
+        }
+      },
+      "required": [
+        "sliceId",
+        "coverId",
+        "amount",
+        "receiver",
+        "currency"
+      ],
+      "summary": "First Cost instrument",
+      "templateBinding": {
+        "id": "assessment",
+        "parameters": {
+          "cost": true
+        }
+      },
+      "title": "First Cost"
+    },
+    {
+      "actionOrder": [
+        "collect",
+        "refund",
+        "create"
+      ],
+      "actions": {
+        "collect": {
+          "agentDescription": "Collect this assessment's remaining balance.",
+          "allocate": {
+            "amountField": "amount",
+            "assessment": "self",
+            "capture": "collectionReceipt",
+            "mode": "payment",
+            "paymentIdentityField": "paymentIdentity",
+            "refField": "coverId",
+            "sourceAccountField": "receiver"
+          },
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.allocation",
+                "source": "allocate"
+              }
+            ],
+            "moves": [
+              {
+                "signature": "moves.allocation",
+                "source": "allocate"
+              }
+            ]
+          },
+          "input": {
+            "additionalProperties": false,
+            "properties": {
+              "paymentIdentity": {
+                "minLength": 1,
+                "type": "string"
+              }
+            },
+            "required": [
+              "paymentIdentity"
+            ],
+            "type": "object"
+          },
+          "moves": [],
+          "publicAction": "collectSecondCost",
+          "steps": [],
+          "summary": "Collect instrument"
+        },
+        "create": {
+          "agentDescription": "Record the assessment.",
+          "moves": [],
+          "publicAction": "createSecondCost",
+          "steps": [],
+          "summary": "Create instrument"
+        },
+        "refund": {
+          "agentDescription": "Reverse this record's prior collection.",
+          "allocate": {
+            "action": "collect",
+            "capture": "refundReceipt",
+            "mode": "refund"
+          },
+          "effects": {
+            "decides": [
+              {
+                "signature": "decides.allocation",
+                "source": "allocate"
+              }
+            ],
+            "moves": [
+              {
+                "signature": "moves.allocation",
+                "source": "allocate"
+              }
+            ]
+          },
+          "moves": [],
+          "publicAction": "refundSecondCost",
+          "steps": [],
+          "summary": "Refund instrument"
+        }
+      },
+      "agentDescription": "One assessment selected by template and bound kind.",
+      "fields": {
+        "amount": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "coverId": {
+          "pattern": "^cvr_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "currency": {
+          "description": "ISO 4217 currency code",
+          "maxLength": 3,
+          "minLength": 3,
+          "pattern": "^[A-Z]{3}$",
+          "type": "string"
+        },
+        "receiver": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "sliceId": {
+          "pattern": "^slc_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        }
+      },
+      "id": "second_cost",
+      "idPrefix": "sc",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "paid",
+          "refunded"
+        ],
+        "transitions": {
+          "collect": {
+            "from": [
+              "open"
+            ],
+            "to": "paid"
+          },
+          "refund": {
+            "from": [
+              "paid"
+            ],
+            "to": "refunded"
+          }
+        }
+      },
+      "required": [
+        "sliceId",
+        "coverId",
+        "amount",
+        "receiver",
+        "currency"
+      ],
+      "summary": "Second Cost instrument",
+      "templateBinding": {
+        "id": "assessment",
+        "parameters": {
+          "cost": true
+        }
+      },
+      "title": "Second Cost"
+    },
+    {
+      "actionOrder": [
+        "close",
+        "create"
+      ],
+      "actions": {
+        "close": {
+          "agentDescription": "Close the assessment.",
+          "moves": [],
+          "publicAction": "closeFineOnly",
+          "steps": [],
+          "summary": "Close instrument"
+        },
+        "create": {
+          "agentDescription": "Record the assessment.",
+          "moves": [],
+          "publicAction": "createFineOnly",
+          "steps": [],
+          "summary": "Create instrument"
+        }
+      },
+      "agentDescription": "One assessment selected by template and bound kind.",
+      "fields": {
+        "amount": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "coverId": {
+          "pattern": "^cvr_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "currency": {
+          "description": "ISO 4217 currency code",
+          "maxLength": 3,
+          "minLength": 3,
+          "pattern": "^[A-Z]{3}$",
+          "type": "string"
+        },
+        "receiver": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "sliceId": {
+          "pattern": "^slc_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        }
+      },
+      "id": "fine_only",
+      "idPrefix": "fo",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "close": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "required": [
+        "sliceId",
+        "coverId",
+        "amount",
+        "receiver",
+        "currency"
+      ],
+      "summary": "Fine Only instrument",
+      "templateBinding": {
+        "id": "assessment",
+        "parameters": {
+          "cost": false
+        }
+      },
+      "title": "Fine Only"
+    },
+    {
+      "actionOrder": [
+        "create",
+        "close"
+      ],
+      "actions": {
+        "close": {
+          "agentDescription": "Record the custody transition.",
+          "funding": {
+            "capture": "snapshot",
+            "collectAction": "collect",
+            "destinationAccountField": "fundingAccount",
+            "obligationField": "obligationId",
+            "principalField": "principal",
+            "sourceAccountPath": "refs.escrow",
+            "terms": {
+              "currency": "currency",
+              "principal": "principal"
+            },
+            "ticketAccountField": "wallet",
+            "ticketAmountField": "amount",
+            "ticketInstrumentId": "ticket",
+            "ticketInvestorField": "investor",
+            "ticketRefField": "roundId",
+            "ticketStatus": "open"
+          },
+          "moves": [],
+          "steps": [],
+          "summary": "Record custody"
+        },
+        "create": {
+          "agentDescription": "Record the custody transition.",
+          "moves": [],
+          "steps": [
+            {
+              "bind": {
+                "currency": {
+                  "from": "instance",
+                  "path": "fields.currency"
+                },
+                "owner.id": {
+                  "from": "instance",
+                  "path": "productId"
+                },
+                "owner.type": {
+                  "from": "const",
+                  "value": "product"
+                },
+                "productId": {
+                  "from": "instance",
+                  "path": "productId"
+                },
+                "role": {
+                  "from": "const",
+                  "value": "product_escrow"
+                }
+              },
+              "capture": {
+                "escrow": "accountId"
+              },
+              "operation": "account.escrow.provision"
+            }
+          ],
+          "summary": "Record custody"
+        }
+      },
+      "agentDescription": "Bind frozen tickets to one obligation and its receipts.",
+      "fields": {
+        "currency": {
+          "const": "SAR",
+          "type": "string"
+        },
+        "fundingAccount": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "maximumTicket": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "minimumTicket": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "obligationId": {
+          "pattern": "^cvr_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "principal": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        }
+      },
+      "id": "round",
+      "idPrefix": "rnd",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "close": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "required": [
+        "obligationId",
+        "principal",
+        "minimumTicket",
+        "maximumTicket",
+        "fundingAccount",
+        "currency"
+      ],
+      "summary": "Frozen investor custody",
+      "title": "round"
+    },
+    {
+      "actionOrder": [
+        "create",
+        "collect"
+      ],
+      "actions": {
+        "collect": {
+          "agentDescription": "Record the custody transition.",
+          "engineOwned": true,
+          "moves": [],
+          "steps": [],
+          "summary": "Record custody"
+        },
+        "create": {
+          "agentDescription": "Record the custody transition.",
+          "moves": [],
+          "requiresExposure": [
+            {
+              "amountField": "amount",
+              "anchorField": "roundId",
+              "capField": "maximumTicket",
+              "capOnAnchor": true,
+              "childInstrumentId": "ticket",
+              "groupField": "investor",
+              "minimumField": "minimumTicket",
+              "statuses": [
+                "open"
+              ]
+            }
+          ],
+          "steps": [],
+          "summary": "Record custody"
+        }
+      },
+      "agentDescription": "Bind frozen tickets to one obligation and its receipts.",
+      "fields": {
+        "amount": {
+          "pattern": "^[1-9][0-9]{0,17}$",
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
+        },
+        "currency": {
+          "const": "SAR",
+          "type": "string"
+        },
+        "investor": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "roundId": {
+          "pattern": "^rnd_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "wallet": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        }
+      },
+      "id": "ticket",
+      "idPrefix": "tkt",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open",
+          "closed"
+        ],
+        "transitions": {
+          "collect": {
+            "from": [
+              "open"
+            ],
+            "to": "closed"
+          }
+        }
+      },
+      "required": [
+        "roundId",
+        "amount",
+        "investor",
+        "wallet",
+        "currency"
+      ],
+      "summary": "Frozen investor custody",
+      "title": "ticket"
+    },
+    {
+      "actionOrder": [
+        "create"
+      ],
+      "actions": {
+        "create": {
+          "agentDescription": "Record the custody transition.",
+          "moves": [],
+          "receiptDistribution": {
+            "capture": "receipt",
+            "feeAccountField": "fee",
+            "feeBps": 100,
+            "mode": "cash",
+            "receiptField": "receiptId",
+            "receiptPath": "refs.allocationReceipt",
+            "residualAccountField": "residual",
+            "roundField": "roundId",
+            "snapshotRef": "snapshot",
+            "taxAccountField": "tax",
+            "vatBps": 1500
+          },
+          "steps": [],
+          "summary": "Record custody"
+        }
+      },
+      "agentDescription": "Bind frozen tickets to one obligation and its receipts.",
+      "fields": {
+        "currency": {
+          "const": "SAR",
+          "type": "string"
+        },
+        "fee": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "receiptId": {
+          "pattern": "^pmt_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "residual": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "roundId": {
+          "pattern": "^rnd_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        },
+        "tax": {
+          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
+          "type": "string"
+        }
+      },
+      "id": "distribution",
+      "idPrefix": "dst",
+      "lifecycle": {
+        "initial": "open",
+        "states": [
+          "open"
+        ],
+        "transitions": {}
+      },
+      "required": [
+        "roundId",
+        "receiptId",
+        "fee",
+        "tax",
+        "residual",
+        "currency"
+      ],
+      "summary": "Frozen investor custody",
+      "title": "distribution"
+    }
+  ],
+  "product": "vocabulary",
+  "subjects": [],
+  "title": "Vocabulary witnesses",
+  "udl": 1,
+  "version": 1
+}