@hyperscale0/udl 2.6.1 → 3.0.0

package/conformance/invalid/not-an-object.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL1003",
-      "path": "$"
-    }
-  ],
-  "summary": "Valid JSON that is not a UDL document.",
-  "verdict": "invalid"
-}

package/conformance/invalid/not-an-object.udl

@@ -1 +0,0 @@
-"a string"

package/conformance/invalid/payout-reconcile-not-a-bank-debit.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL5005",
-      "path": "$.instruments[0].actions.settle.reconcile[0].evidence"
-    }
-  ],
-  "summary": "Bank evidence for payouts: an instrument that owns a payout closes it against a debit statement line, never against the provider confirmation of our own instruction.",
-  "verdict": "invalid"
-}

package/conformance/invalid/payout-reconcile-not-a-bank-debit.udl

@@ -1,259 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "create",
-        "instruct",
-        "settle"
-      ],
-      "actions": {
-        "create": {
-          "moves": [],
-          "publicAction": "createSupplierPayout",
-          "steps": [],
-          "summary": "Create a supplier payout"
-        },
-        "instruct": {
-          "moves": [],
-          "payout": {
-            "amount": "fields.netPayable",
-            "beneficiaryField": "supplierBeneficiaryId",
-            "beneficiaryPartyField": "supplierAccountId",
-            "capture": "payoutId",
-            "currencyField": "currency",
-            "sourceAccountField": "treasuryAccountId",
-            "speed": "standard"
-          },
-          "publicAction": "instructSupplierPayout",
-          "steps": [],
-          "summary": "Instruct the payout to the supplier"
-        },
-        "settle": {
-          "due": {
-            "field": "settleBy"
-          },
-          "moves": [],
-          "reconcile": [
-            {
-              "amount": "fields.netPayable",
-              "capture": "settlementEvidenceId",
-              "counterpartyRef": "payoutId",
-              "currencyField": "currency",
-              "direction": "debit",
-              "evidence": "provider_confirmation",
-              "exception": {
-                "amountField": "unmatchedAmount",
-                "childInstrumentId": "supplier_payout_break",
-                "maxOpen": 1,
-                "reasonField": "breakReason",
-                "refField": "supplierPayoutId"
-              },
-              "match": {
-                "dial": "settlement_tolerance",
-                "law": "tolerance",
-                "minorUnits": 100
-              },
-              "within": {
-                "field": "settleBy"
-              }
-            }
-          ],
-          "steps": [],
-          "summary": "Match the bank's debit against what the instruction promised"
-        }
-      },
-      "description": "A payout the instrument owns end to end: one instruction, one expectation about the debit it will produce, and one break when the debit never matches",
-      "dials": [
-        {
-          "key": "settlement_tolerance",
-          "kind": "reconcile_tolerance",
-          "maxMinorUnits": 500,
-          "summary": "Largest difference between the instructed amount and the settled debit that still counts as matched.",
-          "title": "Settlement tolerance"
-        }
-      ],
-      "fields": {
-        "currency": {
-          "description": "ISO 4217 currency code",
-          "maxLength": 3,
-          "minLength": 3,
-          "pattern": "^[A-Z]{3}$",
-          "type": "string"
-        },
-        "netPayable": {
-          "description": "Amount instructed to the supplier in minor units",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
-        },
-        "settleBy": {
-          "description": "Instant the expectation stops waiting and the unmatched amount becomes a break",
-          "format": "hyperscale-date-time",
-          "type": "string"
-        },
-        "supplierAccountId": {
-          "description": "The supplier account",
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string",
-          "x-hyperscale-reference-filter": {
-            "column": "role",
-            "values": [
-              "customer_balance"
-            ]
-          }
-        },
-        "supplierBeneficiaryId": {
-          "description": "Beneficiary ID for the payout instruction",
-          "pattern": "^ben_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string"
-        },
-        "treasuryAccountId": {
-          "description": "The treasury account the payout leaves",
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string",
-          "x-hyperscale-reference-filter": {
-            "column": "role",
-            "values": [
-              "customer_balance"
-            ]
-          }
-        }
-      },
-      "id": "supplier_payout",
-      "idPrefix": "sp",
-      "lifecycle": {
-        "initial": "created",
-        "states": [
-          "created",
-          "instructed",
-          "settled"
-        ],
-        "transitions": {
-          "instruct": {
-            "from": [
-              "created"
-            ],
-            "to": "instructed"
-          },
-          "settle": {
-            "from": [
-              "instructed"
-            ],
-            "to": "settled"
-          }
-        }
-      },
-      "parties": {
-        "beneficiary": "supplierAccountId",
-        "payer": "treasuryAccountId"
-      },
-      "required": [
-        "netPayable",
-        "supplierAccountId",
-        "supplierBeneficiaryId",
-        "currency",
-        "treasuryAccountId",
-        "settleBy"
-      ],
-      "summary": "Payout from treasury to supplier that is not done until the bank agrees",
-      "title": "Supplier payout"
-    },
-    {
-      "actionOrder": [
-        "create",
-        "carry"
-      ],
-      "actions": {
-        "carry": {
-          "moves": [],
-          "publicAction": "carrySupplierPayoutBreak",
-          "requiresRefs": [
-            {
-              "field": "supplierPayoutId",
-              "match": {
-                "fields.currency": "fields.currency"
-              },
-              "statuses": [
-                "instructed"
-              ]
-            }
-          ],
-          "steps": [],
-          "summary": "Carry the break to whoever owns it"
-        },
-        "create": {
-          "moves": [],
-          "publicAction": "createSupplierPayoutBreak",
-          "requiresRefs": [
-            {
-              "field": "supplierPayoutId",
-              "match": {
-                "fields.currency": "fields.currency"
-              },
-              "statuses": [
-                "instructed"
-              ]
-            }
-          ],
-          "steps": [],
-          "summary": "Raise a break against an instructed payout"
-        }
-      },
-      "description": "One break raised when a payout expectation reached its window with no matching debit; it is carried, never silently dropped",
-      "fields": {
-        "breakReason": {
-          "description": "Why the expectation went unmatched",
-          "maxLength": 180,
-          "minLength": 1,
-          "type": "string"
-        },
-        "currency": {
-          "description": "ISO 4217 currency code",
-          "maxLength": 3,
-          "minLength": 3,
-          "pattern": "^[A-Z]{3}$",
-          "type": "string"
-        },
-        "supplierPayoutId": {
-          "description": "Payout whose expectation broke",
-          "pattern": "^sp_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string"
-        },
-        "unmatchedAmount": {
-          "description": "Difference between the instructed amount and the evidence, in minor units",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
-        }
-      },
-      "id": "supplier_payout_break",
-      "idPrefix": "spbk",
-      "lifecycle": {
-        "initial": "created",
-        "states": [
-          "created",
-          "carried"
-        ],
-        "transitions": {
-          "carry": {
-            "from": [
-              "created"
-            ],
-            "to": "carried"
-          }
-        }
-      },
-      "required": [
-        "breakReason",
-        "currency",
-        "unmatchedAmount",
-        "supplierPayoutId"
-      ],
-      "summary": "Unmatched settlement expectation carried as its own row",
-      "title": "Supplier payout Break"
-    }
-  ],
-  "product": "supplier_settlement",
-  "subjects": [],
-  "title": "Supplier settlement",
-  "udl": 1,
-  "version": 1
-}

package/conformance/invalid/piece-plan-without-partition.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL4002",
-      "path": "$.instruments[0].piecePlan"
-    }
-  ],
-  "summary": "A multi-piece plan must match a declared partition of its total.",
-  "verdict": "invalid"
-}

package/conformance/invalid/piece-plan-without-partition.udl

@@ -1,305 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "create",
-        "fund_piece",
-        "payout_piece"
-      ],
-      "actions": {
-        "create": {
-          "moves": [],
-          "steps": [],
-          "summary": "Create watch instrument"
-        },
-        "fund_piece": {
-          "calls": [
-            {
-              "action": "transfers.execute_fund",
-              "bind": {
-                "inst": "$instance",
-                "p": "$piece"
-              },
-              "id": "call_fund"
-            }
-          ],
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "fund_piece.call_fund.leaf_fund"
-              }
-            ]
-          },
-          "input": {
-            "additionalProperties": false,
-            "properties": {
-              "pieceId": {
-                "enum": [
-                  "p1",
-                  "p2"
-                ],
-                "type": "string"
-              }
-            },
-            "required": [
-              "pieceId"
-            ],
-            "type": "object"
-          },
-          "moves": [],
-          "pieceStage": {
-            "plan": "split_plan",
-            "stage": "fund"
-          },
-          "steps": [],
-          "summary": "Fund one piece in stage"
-        },
-        "payout_piece": {
-          "calls": [
-            {
-              "action": "transfers.execute_release",
-              "bind": {
-                "inst": "$instance",
-                "p": "$piece"
-              },
-              "id": "call_rel"
-            }
-          ],
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "payout_piece.call_rel.leaf_rel"
-              }
-            ]
-          },
-          "input": {
-            "additionalProperties": false,
-            "properties": {
-              "pieceId": {
-                "enum": [
-                  "p1",
-                  "p2"
-                ],
-                "type": "string"
-              }
-            },
-            "required": [
-              "pieceId"
-            ],
-            "type": "object"
-          },
-          "moves": [],
-          "pieceStage": {
-            "plan": "split_plan",
-            "stage": "release"
-          },
-          "steps": [],
-          "summary": "Release piece"
-        }
-      },
-      "actionLibrary": {
-        "transfers": {
-          "actionOrder": [
-            "execute_fund",
-            "execute_release"
-          ],
-          "actions": {
-            "execute_fund": {
-              "approval": "inherit",
-              "calls": [],
-              "leaves": [
-                {
-                  "bind": {
-                    "amount": "$p.amount",
-                    "destinationAccountId": "$p.release_to",
-                    "sourceAccountId": "$inst.fields.buyerAccount"
-                  },
-                  "effects": [
-                    {
-                      "kind": "moves",
-                      "signature": "moves.transfer.internal"
-                    }
-                  ],
-                  "evidence": "bank transfer confirmation receipt",
-                  "id": "leaf_fund",
-                  "operation": "internal_transfer.create"
-                }
-              ],
-              "order": [
-                "leaf_fund"
-              ],
-              "parameters": {
-                "inst": {
-                  "kind": "instance"
-                },
-                "p": {
-                  "kind": "piece"
-                }
-              },
-              "principal": "api_key",
-              "recovery": "local"
-            },
-            "execute_release": {
-              "approval": "inherit",
-              "calls": [],
-              "leaves": [
-                {
-                  "bind": {
-                    "amount": "$p.amount",
-                    "destinationAccountId": "$p.release_to",
-                    "sourceAccountId": "$inst.fields.escrowAccount"
-                  },
-                  "effects": [
-                    {
-                      "kind": "moves",
-                      "signature": "moves.transfer.internal"
-                    }
-                  ],
-                  "evidence": "release to payee confirmation",
-                  "id": "leaf_rel",
-                  "operation": "internal_transfer.create"
-                }
-              ],
-              "order": [
-                "leaf_rel"
-              ],
-              "parameters": {
-                "inst": {
-                  "kind": "instance"
-                },
-                "p": {
-                  "kind": "piece"
-                }
-              },
-              "principal": "api_key",
-              "recovery": "local"
-            }
-          }
-        }
-      },
-      "fields": {
-        "buyerAccount": {
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string"
-        },
-        "currency": {
-          "const": "USD",
-          "pattern": "^[A-Z]{3}$",
-          "type": "string"
-        },
-        "escrowAccount": {
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string"
-        },
-        "p1Amount": {
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "USD"
-        },
-        "p1Refund": {
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string"
-        },
-        "p1Release": {
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string"
-        },
-        "p2Amount": {
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "USD"
-        },
-        "p2Refund": {
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string"
-        },
-        "p2Release": {
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string"
-        },
-        "totalAmount": {
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "USD"
-        }
-      },
-      "id": "escrow_watch",
-      "idPrefix": "ew",
-      "lifecycle": {
-        "initial": "draft",
-        "states": [
-          "draft",
-          "funded",
-          "released"
-        ],
-        "transitions": {
-          "fund_piece": {
-            "from": [
-              "draft"
-            ],
-            "to": "funded"
-          },
-          "payout_piece": {
-            "from": [
-              "funded"
-            ],
-            "to": "released"
-          }
-        }
-      },
-      "piecePlan": {
-        "fund_order": [
-          "p1",
-          "p2"
-        ],
-        "id": "split_plan",
-        "pieces": [
-          {
-            "amount": "p1Amount",
-            "id": "p1",
-            "refund_to": "p1Refund",
-            "release_to": "p1Release"
-          },
-          {
-            "amount": "p2Amount",
-            "id": "p2",
-            "refund_to": "p2Refund",
-            "release_to": "p2Release"
-          }
-        ],
-        "refund_order": [
-          "p1"
-        ],
-        "release_order": [
-          "p1",
-          "p2"
-        ],
-        "total": "totalAmount",
-        "unfund_order": [
-          "p2",
-          "p1"
-        ]
-      },
-      "required": [
-        "totalAmount",
-        "p1Amount",
-        "p2Amount",
-        "p1Release",
-        "p1Refund",
-        "p2Release",
-        "p2Refund",
-        "buyerAccount",
-        "escrowAccount"
-      ],
-      "summary": "Escrow watch contract with piece plan",
-      "title": "Escrow Watch"
-    }
-  ],
-  "product": "escrow_watch",
-  "subjects": [],
-  "title": "Escrow Watch Document",
-  "udl": 1,
-  "version": 1
-}

package/conformance/invalid/private-action-independent-approval.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL2012",
-      "path": "$.instruments[0].actionLibrary.transfers.actions.execute_fund.approval"
-    }
-  ],
-  "summary": "A private action inherits the public action's approval; it cannot declare its own.",
-  "verdict": "invalid"
-}