@hyperscale0/hsx 2.1.0 → 2.2.0

package/examples/advance/advance.udl

@@ -9,8 +9,10 @@
       ],
       "actions": {
         "collect_repayment_1": {
+          "agentDescription": "Collect repayment 1 once on its stored due anchor, returning principal to the funder and any separately routed profit to its recipient.",
           "due": {
-            "field": "firstDueAt"
+            "field": "firstDueAt",
+            "offset": "P0D"
           },
           "effects": {
             "moves": [
@@ -73,6 +75,7 @@
           "summary": "Collect repayment 1 of 2"
         },
         "collect_repayment_2": {
+          "agentDescription": "Collect repayment 2 once on its stored due anchor, returning principal to the funder and any separately routed profit to its recipient.",
           "due": {
             "field": "firstDueAt",
             "offset": "P30D"
@@ -138,7 +141,7 @@
           "summary": "Collect repayment 2 of 2"
         },
         "create": {
-          "agentDescription": "Open the advance row before any money moves. The caller supplies the principal, the fee amount, the repayable total, and the first repayment date. The repayment fields must partition the repayable total exactly. Nothing is disbursed here.",
+          "agentDescription": "Open the advance row before any money moves. The caller supplies the principal, the repayable total, and repayment dates. A declared fee derives the fee amount from principal. The repayment fields must partition the repayable total exactly. Nothing is disbursed here.",
           "moves": [],
           "publicAction": "createAdvancePayment",
           "steps": [],
@@ -203,6 +206,17 @@
         }
       },
       "agentDescription": "Reach for advance when the funder pays the recipient up front and is repaid afterwards, either out of a carved hold release or over scheduled repayments. Pick deposit for a refundable reservation and instant transfer when nobody repays the payer.",
+      "derivedAmounts": [
+        {
+          "field": "feeAmount",
+          "rounding": "floor",
+          "rule": {
+            "bps": 250,
+            "kind": "percentage_of"
+          },
+          "sourceField": "principal"
+        }
+      ],
       "description": "Advance: the funder disburses principal to the recipient, repaid over 2 scheduled repayments plus the funder's discount",
       "fields": {
         "currency": {
@@ -214,7 +228,7 @@
         },
         "feeAmount": {
           "description": "2.5% of principal, the funder's discount repaid on top of the advance",
-          "pattern": "^[1-9][0-9]{0,17}$",
+          "pattern": "^(0|[1-9][0-9]{0,17})$",
           "type": "string",
           "x-hyperscale-currency": "SAR"
         },
@@ -258,13 +272,13 @@
           "x-hyperscale-currency": "SAR"
         },
         "repayment1Amount": {
-          "description": "Repayment 1 of 2 (carries the integer-division remainder): about 33.34% of repayableAmount, collected on its own stored-date anchor",
+          "description": "Stored total for repayment 1",
           "pattern": "^[1-9][0-9]{0,17}$",
           "type": "string",
           "x-hyperscale-currency": "SAR"
         },
         "repayment2Amount": {
-          "description": "Repayment 2 of 2: about 33.33% of repayableAmount, collected on its own stored-date anchor",
+          "description": "Stored total for repayment 2",
           "pattern": "^[1-9][0-9]{0,17}$",
           "type": "string",
           "x-hyperscale-currency": "SAR"
@@ -325,7 +339,6 @@
         "funderAccountId",
         "recipientAccountId",
         "principal",
-        "feeAmount",
         "repayableAmount",
         "firstDueAt",
         "repayment1Amount",
@@ -333,6 +346,16 @@
         "currency"
       ],
       "summary": "Advance to recipient repaid over 2 anchors",
+      "templateBinding": {
+        "id": "advance",
+        "parameters": {
+          "against": false,
+          "count": 2,
+          "dated": false,
+          "profitTo": false,
+          "repaymentSource": false
+        }
+      },
       "title": "Advance payment"
     }
   ],

package/examples/cancellable_booking/cancellable_booking.udl

@@ -382,6 +382,25 @@
         "startsAt"
       ],
       "summary": "Booking the guest can cancel at a price they see before they agree to it",
+      "templateBinding": {
+        "id": "cancellable_booking",
+        "parameters": {
+          "acceptance": false,
+          "authorityType": false,
+          "balanceBefore": false,
+          "cancelBands": false,
+          "confirmationWindow": false,
+          "departure": false,
+          "depositBps": false,
+          "earlyPenaltyBps": 1000,
+          "latePenaltyBps": 5000,
+          "priceValue": false,
+          "supplierCost": false,
+          "supplierRole": false,
+          "taxBps": false,
+          "unpaidBand": false
+        }
+      },
       "title": "Studio session"
     }
   ],

package/examples/captured_payment/captured_payment.hsx

@@ -9,10 +9,6 @@ settlement card_payment = captured_payment {
   reserve_until: reserveUntil
   correction: port correct_capture
   external_reversal: port reverse_capture within P14D
-  capture_mode: partial_then_full
-  correction_mode: full_only
-  negative_position: reject
-  timeout: reject
 }
 port correct_capture { allowed: [payee] }
 port reverse_capture {

package/examples/captured_payment/captured_payment.udl

@@ -669,6 +669,12 @@
         "currency"
       ],
       "summary": "Capture reservation from payer to payee",
+      "templateBinding": {
+        "id": "captured_payment",
+        "parameters": {
+          "derivedAmount": false
+        }
+      },
       "title": "Card payment"
     }
   ],

package/examples/conditional_disbursement/conditional_disbursement.hsx

@@ -8,8 +8,6 @@ settlement claim_payment = conditional_disbursement {
   cap: policyLimit: money(SAR)
   amount: approvedAmount: money(SAR)
   decision: port approve_claim
-  reopen_policy: refuse
-  recovery_policy: separate_transfer
 }
 port approve_claim {
   allowed: [source]

package/examples/conditional_disbursement/conditional_disbursement.udl

@@ -138,6 +138,10 @@
         "policyLimit"
       ],
       "summary": "Capped disbursement to claimant",
+      "templateBinding": {
+        "id": "conditional_disbursement",
+        "parameters": {}
+      },
       "title": "Claim payment"
     },
     {

package/examples/cost-table.json

@@ -21,7 +21,7 @@
       "verification.kyc.investment.count",
       "verification.kyc.standard.count"
     ],
-    "effectiveTableDigest": "5ad6cddeb7e9a8c69f94575c834cf494b07eac53a4c7d70d5aa16182e0fc9130",
+    "effectiveTableDigest": "4273afec16c56ae97282eda8a0a349b006b0e7f41a49d4dbebda3172e449cb58",
     "fixed": {
       "activationBaseMinor": "500000",
       "activationPerPointMinor": "100000",
@@ -29,7 +29,6 @@
       "monthlyPerPointMinor": "20000",
       "weights": {
         "aggregate_invariant": 2,
-        "blueprint": 5,
         "flow": 1,
         "gate": 1,
         "instrument": 3,
@@ -57,6 +56,14 @@
         "settlement": "invoice",
         "signature": "decides.air_carrier"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.allocation"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -185,6 +192,14 @@
         "settlement": "invoice",
         "signature": "decides.payouts"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.referenced_transition"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -201,6 +216,14 @@
         "settlement": "invoice",
         "signature": "decides.settlement_ingestion"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.subject_unique"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -282,6 +305,15 @@
         "settlement": "invoice",
         "signature": "meters.kyb.application.review"
       },
+      {
+        "bps": 6,
+        "meter": "transfer.internal.count",
+        "payer": "end_customer",
+        "perEventMinor": "75",
+        "settlement": "per_event",
+        "signature": "moves.allocation",
+        "volumeMeter": "transfer.internal.volume_sar"
+      },
       {
         "bps": 8,
         "meter": "collection.pay_in.count",
@@ -407,7 +439,7 @@
       "verification.kyc.investment.count",
       "verification.kyc.standard.count"
     ],
-    "effectiveTableDigest": "c0b6d44b312db8d0e78227a66893e0fae75bdbbc24d97d4c846dce2b5d31fa2b",
+    "effectiveTableDigest": "88c0a5ae2f12de977d156a04a32cdecbad107076bc74a1b8398239c590f3eb0a",
     "fixed": {
       "activationBaseMinor": "133300",
       "activationPerPointMinor": "26700",
@@ -415,7 +447,6 @@
       "monthlyPerPointMinor": "5300",
       "weights": {
         "aggregate_invariant": 2,
-        "blueprint": 5,
         "flow": 1,
         "gate": 1,
         "instrument": 3,
@@ -443,6 +474,14 @@
         "settlement": "invoice",
         "signature": "decides.air_carrier"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.allocation"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -571,6 +610,14 @@
         "settlement": "invoice",
         "signature": "decides.payouts"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.referenced_transition"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -587,6 +634,14 @@
         "settlement": "invoice",
         "signature": "decides.settlement_ingestion"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.subject_unique"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -668,6 +723,15 @@
         "settlement": "invoice",
         "signature": "meters.kyb.application.review"
       },
+      {
+        "bps": 6,
+        "meter": "transfer.internal.count",
+        "payer": "end_customer",
+        "perEventMinor": "20",
+        "settlement": "per_event",
+        "signature": "moves.allocation",
+        "volumeMeter": "transfer.internal.volume_usd"
+      },
       {
         "bps": 8,
         "meter": "collection.pay_in.count",
@@ -793,7 +857,7 @@
       "verification.kyc.investment.count",
       "verification.kyc.standard.count"
     ],
-    "effectiveTableDigest": "168bf0628428929b4a8600965440d83c159e290017ceeafae92f68ea746c266d",
+    "effectiveTableDigest": "004d1a8156aac9cd7cb789f36f6abef508ea304327703ba12844b65b66f03ab2",
     "fixed": {
       "activationBaseMinor": "125000",
       "activationPerPointMinor": "25000",
@@ -801,7 +865,6 @@
       "monthlyPerPointMinor": "5000",
       "weights": {
         "aggregate_invariant": 2,
-        "blueprint": 5,
         "flow": 1,
         "gate": 1,
         "instrument": 3,
@@ -829,6 +892,14 @@
         "settlement": "invoice",
         "signature": "decides.air_carrier"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.allocation"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -957,6 +1028,14 @@
         "settlement": "invoice",
         "signature": "decides.payouts"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.referenced_transition"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -973,6 +1052,14 @@
         "settlement": "invoice",
         "signature": "decides.settlement_ingestion"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.subject_unique"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -1054,6 +1141,15 @@
         "settlement": "invoice",
         "signature": "meters.kyb.application.review"
       },
+      {
+        "bps": 6,
+        "meter": "transfer.internal.count",
+        "payer": "end_customer",
+        "perEventMinor": "19",
+        "settlement": "per_event",
+        "signature": "moves.allocation",
+        "volumeMeter": "transfer.internal.volume_eur"
+      },
       {
         "bps": 8,
         "meter": "collection.pay_in.count",
@@ -1179,7 +1275,7 @@
       "verification.kyc.investment.count",
       "verification.kyc.standard.count"
     ],
-    "effectiveTableDigest": "872976014d670541f48e3ad66cbb2da0e6fcd160d34ee785b5a028c3a8a31219",
+    "effectiveTableDigest": "72155c0ce9eb3157f87b7f613bb3f05b3ab50a91248c9260e1b2ceae6b199286",
     "fixed": {
       "activationBaseMinor": "104200",
       "activationPerPointMinor": "20800",
@@ -1187,7 +1283,6 @@
       "monthlyPerPointMinor": "4200",
       "weights": {
         "aggregate_invariant": 2,
-        "blueprint": 5,
         "flow": 1,
         "gate": 1,
         "instrument": 3,
@@ -1215,6 +1310,14 @@
         "settlement": "invoice",
         "signature": "decides.air_carrier"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.allocation"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -1343,6 +1446,14 @@
         "settlement": "invoice",
         "signature": "decides.payouts"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.referenced_transition"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -1359,6 +1470,14 @@
         "settlement": "invoice",
         "signature": "decides.settlement_ingestion"
       },
+      {
+        "bps": 0,
+        "meter": "instrument.event.count",
+        "payer": "product",
+        "perEventMinor": "0",
+        "settlement": "invoice",
+        "signature": "decides.subject_unique"
+      },
       {
         "bps": 0,
         "meter": "instrument.event.count",
@@ -1440,6 +1559,15 @@
         "settlement": "invoice",
         "signature": "meters.kyb.application.review"
       },
+      {
+        "bps": 6,
+        "meter": "transfer.internal.count",
+        "payer": "end_customer",
+        "perEventMinor": "16",
+        "settlement": "per_event",
+        "signature": "moves.allocation",
+        "volumeMeter": "transfer.internal.volume_gbp"
+      },
       {
         "bps": 8,
         "meter": "collection.pay_in.count",

package/examples/credit_facility/credit_facility.hsx

@@ -21,7 +21,4 @@ settlement facility = credit_facility {
   limit: facilityLimit: money(SAR)
   expires_at: expiresAt
   obligation: repayment.obligation
-  availability_policy: revolving
-  expiry_policy: freeze_draws
-  close_policy: no_open_draws
 }

package/examples/credit_facility/credit_facility.udl

@@ -424,7 +424,6 @@
       "required": [
         "lenderAccountId",
         "repaymentSourceAccountId",
-        "borrowerAccountId",
         "currency",
         "principal",
         "firstDueAt",
@@ -432,6 +431,19 @@
         "installment2Amount"
       ],
       "summary": "2-anchor obligation for borrower",
+      "templateBinding": {
+        "id": "scheduled",
+        "parameters": {
+          "advanceTo": false,
+          "count": 2,
+          "derivedAmount": false,
+          "mandate": false,
+          "monthEnd": false,
+          "periodLiability": false,
+          "terminationDrain": false,
+          "until": false
+        }
+      },
       "title": "Repayment"
     },
     {
@@ -1162,6 +1174,10 @@
         "expiresAt"
       ],
       "summary": "Draw capacity for borrower",
+      "templateBinding": {
+        "id": "credit_facility",
+        "parameters": {}
+      },
       "title": "Facility"
     },
     {

package/examples/held_payment/held_payment.udl

@@ -542,6 +542,22 @@
         "currency"
       ],
       "summary": "Escrow-held payment from buyer to seller",
+      "templateBinding": {
+        "id": "held_payment",
+        "parameters": {
+          "cancelChargeBps": false,
+          "cancelOfferLife": false,
+          "derivedAmount": false,
+          "idPrefixOverride": false,
+          "privateActions": false,
+          "reference": false,
+          "releaseAction": false,
+          "releaseTo": false,
+          "upstream": false,
+          "wholeAmount": false,
+          "wholeFee": false
+        }
+      },
       "title": "Sale"
     }
   ],

package/examples/instant_transfer/instant_transfer.udl

@@ -359,6 +359,12 @@
         "currency"
       ],
       "summary": "Instant payment from customer to merchant",
+      "templateBinding": {
+        "id": "instant_transfer",
+        "parameters": {
+          "derivedAmount": false
+        }
+      },
       "title": "Transfer"
     }
   ],

package/examples/metered/metered.udl

@@ -146,7 +146,7 @@
           "summary": "Open a usage period with its committed rate card"
         }
       },
-      "agentDescription": "Reach for metered when the customer is billed per unit at a rate card fixed when the period opens, and the period closes on periodEnd. Every charge is its own transfer. Pick recurring collection for a flat repeating amount and instant transfer for a one-off payment.",
+      "agentDescription": "Reach for metered when the customer is billed per unit at a rate card fixed when the period opens, and the period closes on periodEnd. Every charge is its own transfer. Pick scheduled for a flat repeating amount and instant transfer for a one-off payment.",
       "description": "Metered usage: the customer is charged per unit at the committed rate card until the period closes on its stored end date",
       "fields": {
         "callRate": {
@@ -238,6 +238,10 @@
         "currency"
       ],
       "summary": "Metered charges from customer on a committed rate card",
+      "templateBinding": {
+        "id": "metered",
+        "parameters": {}
+      },
       "title": "Usage"
     }
   ],

package/examples/pooled_split/pooled_split.udl

@@ -417,6 +417,10 @@
         "currency"
       ],
       "summary": "Period pool from payer split 2 ways",
+      "templateBinding": {
+        "id": "pooled_split",
+        "parameters": {}
+      },
       "title": "Pool"
     }
   ],

package/examples/premium_forward/premium_forward.udl

@@ -589,6 +589,10 @@
         "currency"
       ],
       "summary": "Premium held for the carrier until the policy binds",
+      "templateBinding": {
+        "id": "premium_forward",
+        "parameters": {}
+      },
       "title": "Premium"
     }
   ],

package/examples/reconciled_payout/reconciled_payout.udl

@@ -181,6 +181,13 @@
         "settleBy"
       ],
       "summary": "Payout from treasury to supplier that is not done until the bank agrees",
+      "templateBinding": {
+        "id": "reconciled_payout",
+        "parameters": {
+          "matchedCeiling": 500,
+          "matchedWithin": 100
+        }
+      },
       "title": "Supplier payout"
     },
     {

package/examples/rotating_pool/rotating_pool.udl

@@ -541,6 +541,14 @@
         "one"
       ],
       "summary": "3-member rotating pool",
+      "templateBinding": {
+        "id": "rotating_pool",
+        "parameters": {
+          "count": 3,
+          "membership": false,
+          "memo": false
+        }
+      },
       "title": "Pool"
     },
     {

package/examples/scheduled/scheduled.udl

@@ -227,19 +227,19 @@
           "type": "string"
         },
         "installment1Amount": {
-          "description": "Installment 1 of 3 (carries the integer-division remainder): about 33.34% of totalAmount, collected on its own stored-date anchor",
+          "description": "Installment 1 of 3 (carries the integer-division remainder): a stored share of totalAmount, collected on its own stored-date anchor",
           "pattern": "^[1-9][0-9]{0,17}$",
           "type": "string",
           "x-hyperscale-currency": "SAR"
         },
         "installment2Amount": {
-          "description": "Installment 2 of 3: about 33.33% of totalAmount, collected on its own stored-date anchor",
+          "description": "Installment 2 of 3: a stored share of totalAmount, collected on its own stored-date anchor",
           "pattern": "^[1-9][0-9]{0,17}$",
           "type": "string",
           "x-hyperscale-currency": "SAR"
         },
         "installment3Amount": {
-          "description": "Installment 3 of 3: about 33.33% of totalAmount, collected on its own stored-date anchor",
+          "description": "Installment 3 of 3: a stored share of totalAmount, collected on its own stored-date anchor",
           "pattern": "^[1-9][0-9]{0,17}$",
           "type": "string",
           "x-hyperscale-currency": "SAR"
@@ -329,6 +329,21 @@
         "currency"
       ],
       "summary": "3-installment schedule from payer to payee",
+      "templateBinding": {
+        "id": "scheduled",
+        "parameters": {
+          "advanceTo": false,
+          "count": 3,
+          "debtor": false,
+          "derivedAmount": false,
+          "mandate": false,
+          "mode": false,
+          "monthEnd": false,
+          "periodLiability": false,
+          "terminationDrain": false,
+          "until": false
+        }
+      },
       "title": "Installments"
     }
   ],