@hyperscale0/hsx 1.0.0 → 2.0.1

package/examples/rotating_pool/rotating_pool.udl

@@ -396,7 +396,8 @@
         "contributionAmount": {
           "description": "Exact contribution in SAR minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -605,8 +606,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -648,6 +649,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Fund member a's cycle 1 contribution"
         },
@@ -684,8 +686,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -763,8 +765,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -843,8 +845,8 @@
             {
               "bind": {
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "owner.id": {
                   "from": "instance",
@@ -895,8 +897,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -966,8 +968,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -1037,8 +1039,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -1200,8 +1202,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -1244,6 +1246,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "release",
           "steps": [],
           "summary": "Pay this member's stored contribution into cycle 1's shared pot recipient"
         },
@@ -1271,8 +1274,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -1342,8 +1345,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -1413,8 +1416,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -1484,8 +1487,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -1555,8 +1558,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -1609,7 +1612,8 @@
         "contributionAmount": {
           "description": "Exact contribution amount shared by every cycle",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -1872,8 +1876,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -1915,6 +1919,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Fund member b's cycle 1 contribution"
         },
@@ -1951,8 +1956,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2030,8 +2035,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2110,8 +2115,8 @@
             {
               "bind": {
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "owner.id": {
                   "from": "instance",
@@ -2162,8 +2167,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2233,8 +2238,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2304,8 +2309,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2467,8 +2472,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2511,6 +2516,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "release",
           "steps": [],
           "summary": "Pay this member's stored contribution into cycle 1's shared pot recipient"
         },
@@ -2538,8 +2544,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2609,8 +2615,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2680,8 +2686,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2751,8 +2757,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2822,8 +2828,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -2876,7 +2882,8 @@
         "contributionAmount": {
           "description": "Exact contribution amount shared by every cycle",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -3139,8 +3146,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -3182,6 +3189,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Fund member c's cycle 1 contribution"
         },
@@ -3218,8 +3226,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -3297,8 +3305,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -3377,8 +3385,8 @@
             {
               "bind": {
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "owner.id": {
                   "from": "instance",
@@ -3429,8 +3437,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -3500,8 +3508,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -3571,8 +3579,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -3734,8 +3742,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -3778,6 +3786,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "release",
           "steps": [],
           "summary": "Pay this member's stored contribution into cycle 1's shared pot recipient"
         },
@@ -3805,8 +3814,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -3876,8 +3885,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -3947,8 +3956,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -4018,8 +4027,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -4089,8 +4098,8 @@
                   "path": "fields.contributionAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -4143,7 +4152,8 @@
         "contributionAmount": {
           "description": "Exact contribution amount shared by every cycle",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",

package/examples/scheduled/scheduled.hsx

@@ -1,5 +1,5 @@
 program scheduled_example "Scheduled example"
-import { scheduled } from "std/settlements"
+import { scheduled } from "std/money_flows"
 party payer: business
 party payee: business
 settlement installments = scheduled {

package/examples/scheduled/scheduled.udl

@@ -41,8 +41,8 @@
                   "path": "fields.installment1Amount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -76,6 +76,7 @@
               "operation": "internal_transfer.create"
             }
           ],
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Collect installment 1 of 3"
         },
@@ -106,8 +107,8 @@
                   "path": "fields.installment2Amount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -171,8 +172,8 @@
                   "path": "fields.installment3Amount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -228,17 +229,20 @@
         "installment1Amount": {
           "description": "Installment 1 of 3 (carries the integer-division remainder): about 33.34% of totalAmount, collected on its own stored-date anchor",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "installment2Amount": {
           "description": "Installment 2 of 3: about 33.33% of totalAmount, collected on its own stored-date anchor",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "installment3Amount": {
           "description": "Installment 3 of 3: about 33.33% of totalAmount, collected on its own stored-date anchor",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "payeeAccountId": {
           "description": "The payee account",
@@ -265,7 +269,8 @@
         "totalAmount": {
           "description": "The total scheduled amount in SAR minor units; the installment fields below partition it exactly",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         }
       },
       "id": "installments",

package/examples/security_deposit/security_deposit.hsx

@@ -1,5 +1,5 @@
 program deposit_example "Deposit example"
-import { security_deposit } from "std/settlements"
+import { security_deposit } from "std/money_flows"
 party renter: person
 party owner: business
 settlement security_deposit = security_deposit {

package/examples/security_deposit/security_deposit.udl

@@ -37,9 +37,10 @@
             "additionalProperties": false,
             "properties": {
               "damageAmount": {
-                "description": "Caller-decided amount in minor units",
+                "description": "Decided amount in SAR minor units",
                 "pattern": "^(0|[1-9][0-9]{0,17})$",
-                "type": "string"
+                "type": "string",
+                "x-hyperscale-currency": "SAR"
               },
               "evidence": {
                 "description": "Required decision reference retained in the operation receipt",
@@ -132,8 +133,8 @@
                   "path": "fields.depositAmount"
                 },
                 "currency": {
-                  "from": "instance",
-                  "path": "fields.currency"
+                  "from": "const",
+                  "value": "SAR"
                 },
                 "destinationAccountId": {
                   "from": "instance",
@@ -168,12 +169,19 @@
             }
           ],
           "publicAction": "placeDepositSecurityDeposit",
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Reserve the depositAmount against the renter's account"
         },
         "return_deposit": {
           "agentDescription": "Return the held deposit to the renter. The deposit must be in held and unclaimed. This releases the reservation whole and the owner receives nothing.",
           "effects": {
+            "decides": [
+              {
+                "signature": "decides.tenant_port",
+                "source": "port"
+              }
+            ],
             "moves": [
               {
                 "signature": "moves.transfer.internal",
@@ -197,6 +205,11 @@
               "operation": "internal_transfer.void"
             }
           ],
+          "port": {
+            "allowedParties": [
+              "beneficiary"
+            ]
+          },
           "publicAction": "returnDepositSecurityDeposit",
           "steps": [],
           "summary": "Return the deposit to the renter through return_deposit"
@@ -215,7 +228,8 @@
         "depositAmount": {
           "description": "The deposit amount in SAR minor units, reserved in full and fully accounted on claim or return",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "ownerAccountId": {
           "description": "The owner account",

package/examples/settlement_batch/settlement_batch.hsx

@@ -1,5 +1,5 @@
 program settlement_batch_example "Settlement batch example"
-import { settlement_batch } from "std/settlements"
+import { settlement_batch } from "std/money_flows"
 party settlement_account: business
 party payout_destination: business
 settlement batch = settlement_batch {