@hyperscale0/hsx 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (166) hide show
  1. package/CHANGELOG.md +15 -4
  2. package/README.md +58 -38
  3. package/dist/src/ast.d.ts +4 -2
  4. package/dist/src/ast.d.ts.map +1 -1
  5. package/dist/src/cli.d.ts +1 -1
  6. package/dist/src/cli.js.map +1 -1
  7. package/dist/src/compile.d.ts +8 -2
  8. package/dist/src/compile.d.ts.map +1 -1
  9. package/dist/src/compile.js +8 -1
  10. package/dist/src/compile.js.map +1 -1
  11. package/dist/src/cost.d.ts +3 -1
  12. package/dist/src/cost.d.ts.map +1 -1
  13. package/dist/src/cost.js +124 -94
  14. package/dist/src/cost.js.map +1 -1
  15. package/dist/src/diagnostics.d.ts.map +1 -1
  16. package/dist/src/diagnostics.js +89 -5
  17. package/dist/src/diagnostics.js.map +1 -1
  18. package/dist/src/emit.d.ts +3 -1
  19. package/dist/src/emit.d.ts.map +1 -1
  20. package/dist/src/emit.js +27 -10
  21. package/dist/src/emit.js.map +1 -1
  22. package/dist/src/format.js.map +1 -1
  23. package/dist/src/index.d.ts +2 -2
  24. package/dist/src/index.d.ts.map +1 -1
  25. package/dist/src/index.js +1 -1
  26. package/dist/src/index.js.map +1 -1
  27. package/dist/src/ir.d.ts.map +1 -1
  28. package/dist/src/lex.d.ts.map +1 -1
  29. package/dist/src/lsp/server.js.map +1 -1
  30. package/dist/src/modules.js +7 -3
  31. package/dist/src/modules.js.map +1 -1
  32. package/dist/src/parse.js +3 -3
  33. package/dist/src/parse.js.map +1 -1
  34. package/dist/src/std-bundle.js +41 -41
  35. package/dist/src/std-bundle.js.map +1 -1
  36. package/dist/src/std-library.js +2 -2
  37. package/dist/src/typecheck.d.ts.map +1 -1
  38. package/dist/src/typecheck.js +859 -156
  39. package/dist/src/typecheck.js.map +1 -1
  40. package/dist/src/version.d.ts +1 -1
  41. package/dist/src/version.js +1 -1
  42. package/docs/README.md +10 -1
  43. package/docs/assets/hsx.svg +18 -0
  44. package/docs/guide/01-first-program.md +1 -1
  45. package/docs/guide/02-money.md +1 -1
  46. package/docs/guide/03-instruments.md +44 -3
  47. package/docs/guide/04-lifecycles.md +18 -3
  48. package/docs/guide/05-fees-and-splits.md +2 -2
  49. package/docs/guide/06-schedules.md +1 -1
  50. package/docs/guide/07-composition.md +8 -2
  51. package/docs/guide/08-writing-a-module.md +13 -2
  52. package/docs/guide/09-cost.md +3 -3
  53. package/docs/guide/10-diagnostics.md +1 -1
  54. package/docs/llms-full.txt +453 -190
  55. package/docs/llms.txt +2 -2
  56. package/docs/playground.md +4 -3
  57. package/docs/reference/cli.md +2 -2
  58. package/docs/reference/diagnostics.md +223 -37
  59. package/docs/reference/grammar.md +2 -2
  60. package/docs/reference/std/advance.md +2 -2
  61. package/docs/reference/std/cancellable_booking.md +10 -10
  62. package/docs/reference/std/captured_payment.md +14 -14
  63. package/docs/reference/std/conditional_disbursement.md +3 -3
  64. package/docs/reference/std/credit_facility.md +2 -2
  65. package/docs/reference/std/held_payment.md +37 -33
  66. package/docs/reference/std/instant_transfer.md +8 -8
  67. package/docs/reference/std/metered.md +2 -2
  68. package/docs/reference/std/pooled_split.md +2 -2
  69. package/docs/reference/std/premium_forward.md +13 -13
  70. package/docs/reference/std/reconciled_payout.md +2 -2
  71. package/docs/reference/std/recurring_collection.md +2 -2
  72. package/docs/reference/std/rotating_pool.md +2 -2
  73. package/docs/reference/std/scheduled.md +18 -18
  74. package/docs/reference/std/security_deposit.md +14 -14
  75. package/docs/reference/std/settlement_batch.md +2 -2
  76. package/docs/reference/std/swap.md +18 -18
  77. package/docs/reference/std/threshold_pool.md +2 -2
  78. package/docs/reference/std/weighted_distribution.md +2 -2
  79. package/docs/reference/types.md +1 -1
  80. package/docs/reference/udl-output.md +1 -1
  81. package/examples/01-first-program/README.md +1 -1
  82. package/examples/01-first-program/tip-jar.hsx +1 -1
  83. package/examples/02-imports-and-archetypes/photo-booth.hsx +1 -1
  84. package/examples/03-diagnostics/corner-shop-fixed.hsx +1 -1
  85. package/examples/03-diagnostics/corner-shop.hsx +1 -1
  86. package/examples/04-complete-product/study-hall.hsx +1 -1
  87. package/examples/05-watch-club/README.md +0 -3
  88. package/examples/05-watch-club/watch-club.hsx +1 -1
  89. package/examples/README.md +35 -4
  90. package/examples/advance/advance.hsx +1 -1
  91. package/examples/advance/advance.udl +10 -5
  92. package/examples/cancellable_booking/cancellable_booking.hsx +1 -1
  93. package/examples/cancellable_booking/cancellable_booking.udl +3 -1
  94. package/examples/captured_payment/captured_payment.hsx +1 -1
  95. package/examples/captured_payment/captured_payment.udl +4 -1
  96. package/examples/conditional_disbursement/conditional_disbursement.hsx +1 -1
  97. package/examples/conditional_disbursement/conditional_disbursement.udl +5 -3
  98. package/examples/cost-table.json +1602 -382
  99. package/examples/credit_facility/credit_facility.hsx +1 -1
  100. package/examples/credit_facility/credit_facility.udl +16 -9
  101. package/examples/held_payment/held_payment.hsx +1 -1
  102. package/examples/held_payment/held_payment.udl +38 -3
  103. package/examples/instant_transfer/instant_transfer.hsx +1 -1
  104. package/examples/instant_transfer/instant_transfer.udl +11 -5
  105. package/examples/metered/metered.hsx +1 -1
  106. package/examples/metered/metered.udl +4 -2
  107. package/examples/pooled_split/pooled_split.hsx +1 -1
  108. package/examples/pooled_split/pooled_split.udl +6 -3
  109. package/examples/premium_forward/premium_forward.hsx +1 -1
  110. package/examples/premium_forward/premium_forward.udl +10 -4
  111. package/examples/reconciled_payout/reconciled_payout.hsx +1 -1
  112. package/examples/reconciled_payout/reconciled_payout.udl +4 -2
  113. package/examples/recurring_collection/recurring_collection.hsx +1 -1
  114. package/examples/recurring_collection/recurring_collection.udl +12 -7
  115. package/examples/rotating_pool/rotating_pool.hsx +1 -1
  116. package/examples/rotating_pool/rotating_pool.udl +14 -4
  117. package/examples/scheduled/scheduled.hsx +1 -1
  118. package/examples/scheduled/scheduled.udl +9 -4
  119. package/examples/security_deposit/security_deposit.hsx +1 -1
  120. package/examples/security_deposit/security_deposit.udl +17 -3
  121. package/examples/settlement_batch/settlement_batch.hsx +1 -1
  122. package/examples/swap/swap.hsx +1 -1
  123. package/examples/swap/swap.udl +12 -6
  124. package/examples/threshold_pool/threshold_pool.hsx +1 -1
  125. package/examples/threshold_pool/threshold_pool.udl +4 -2
  126. package/examples/weighted_distribution/weighted_distribution.hsx +1 -1
  127. package/examples/weighted_distribution/weighted_distribution.udl +4 -2
  128. package/package.json +6 -5
  129. package/skills/hsx/SKILL.md +26 -26
  130. package/src/ast.ts +4 -2
  131. package/src/cli.ts +4 -4
  132. package/src/compile.ts +14 -3
  133. package/src/cost.ts +176 -104
  134. package/src/diagnostics.ts +89 -4
  135. package/src/emit.ts +32 -18
  136. package/src/index.ts +2 -1
  137. package/src/modules.ts +9 -3
  138. package/src/parse.ts +3 -3
  139. package/src/std-bundle.ts +41 -41
  140. package/src/std-library.ts +2 -2
  141. package/src/typecheck.ts +1147 -235
  142. package/src/version.ts +1 -1
  143. package/std/SEMANTICS.md +12 -3
  144. package/std/{settlements → money_flows}/advance.hsx +1 -1
  145. package/std/{settlements → money_flows}/cancellable_booking.hsx +4 -3
  146. package/std/{settlements → money_flows}/captured_payment.hsx +35 -6
  147. package/std/{settlements → money_flows}/conditional_disbursement.hsx +17 -16
  148. package/std/{settlements → money_flows}/credit_facility.hsx +1 -2
  149. package/std/{settlements → money_flows}/held_payment.hsx +59 -25
  150. package/std/money_flows/index.hsx +3 -0
  151. package/std/{settlements → money_flows}/instant_transfer.hsx +2 -3
  152. package/std/{settlements → money_flows}/metered.hsx +1 -1
  153. package/std/{settlements → money_flows}/pooled_split.hsx +3 -3
  154. package/std/{settlements → money_flows}/premium_forward.hsx +22 -23
  155. package/std/{settlements → money_flows}/reconciled_payout.hsx +3 -3
  156. package/std/{settlements → money_flows}/recurring_collection.hsx +1 -1
  157. package/std/{settlements → money_flows}/rotating_pool.hsx +8 -6
  158. package/std/{settlements → money_flows}/scheduled.hsx +22 -27
  159. package/std/{settlements → money_flows}/security_deposit.hsx +38 -14
  160. package/std/{settlements → money_flows}/settlement_batch.hsx +3 -3
  161. package/std/{settlements → money_flows}/swap.hsx +41 -16
  162. package/std/{settlements → money_flows}/threshold_pool.hsx +5 -5
  163. package/std/{settlements → money_flows}/weighted_distribution.hsx +6 -6
  164. package/docs/sessions/2026-09-02-two-instruments.hsx +0 -21
  165. package/docs/sessions/2026-09-02-two-instruments.md +0 -41
  166. package/std/settlements/index.hsx +0 -3
package/docs/reference/std/held_payment.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # held_payment
4
4
 
5
- Source: [`std/settlements/held_payment.hsx`](../../../std/settlements/held_payment.hsx)
5
+ Source: [`std/money_flows/held_payment.hsx`](../../../std/money_flows/held_payment.hsx)
6
6
 
7
7
  ## Export
8
8
 
@@ -31,34 +31,38 @@ Source: [`std/settlements/held_payment.hsx`](../../../std/settlements/held_payme
31
31
 
32
32
  ## Actions and clauses
33
33
 
34
- | Action | Clauses lowered |
35
- | --------------------- | --------------------------------------------------------------------------------------------- |
36
- | `fund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
37
- | `fund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
38
- | `collect_service_fee` | `agent description`, `moves`, `steps`, `summary` |
39
- | `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
40
- | `release_piece_3` | `agent description`, `moves`, `steps`, `summary` |
41
- | `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
42
- | `refund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
43
- | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
44
- | `unfund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
45
- | `unfund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
46
- | `create` | `agent description`, `moves`, `steps`, `summary` |
47
- | `fund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
48
- | `release_name` | `agent description`, `deadline`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
49
- | `release_on_deadline` | `due`, `moves`, `steps`, `summary` |
50
- | `cancel` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
51
- | `fund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
52
- | `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
53
- | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
54
- | `fund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
55
- | `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
56
- | `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
57
- | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
58
- | `abandon` | `agent description`, `moves`, `steps`, `summary` |
59
- | `create` | `agent description`, `moves`, `steps`, `summary` |
60
- | `fund` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
61
- | `release_action` | `agent description`, `deadline`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
62
- | `release_on_deadline` | `due`, `event name`, `moves`, `steps`, `summary` |
63
- | `cancel` | `agent description`, `deadline`, `event name`, `moves`, `steps`, `summary` |
64
- | `abandon` | `agent description`, `moves`, `steps`, `summary` |
34
+ | Action | Clauses lowered |
35
+ | --------------------- | ------------------------------------------------------------------------------------------------------ |
36
+ | `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
37
+ | `fund_piece_3` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
38
+ | `collect_service_fee` | `agent description`, `moves`, `steps`, `summary` |
39
+ | `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
40
+ | `release_piece_3` | `agent description`, `moves`, `steps`, `summary` |
41
+ | `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
42
+ | `refund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
43
+ | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
44
+ | `unfund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
45
+ | `unfund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
46
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
47
+ | `fund_piece_1` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
48
+ | `release_name` | `agent description`, `deadline`, `input`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
49
+ | `release_on_deadline` | `due`, `moves`, `steps`, `summary` |
50
+ | `cancel` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
51
+ | `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
52
+ | `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
53
+ | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
54
+ | `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
55
+ | `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
56
+ | `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
57
+ | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
58
+ | `abandon` | `agent description`, `moves`, `steps`, `summary` |
59
+ | `dispute` | `agent description`, `description`, `moves`, `steps`, `summary` |
60
+ | `resume` | `agent description`, `description`, `moves`, `steps`, `summary` |
61
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
62
+ | `fund` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
63
+ | `release_action` | `agent description`, `deadline`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
64
+ | `release_on_deadline` | `due`, `event name`, `moves`, `steps`, `summary` |
65
+ | `cancel` | `agent description`, `deadline`, `event name`, `moves`, `steps`, `summary` |
66
+ | `abandon` | `agent description`, `moves`, `steps`, `summary` |
67
+ | `dispute` | `agent description`, `description`, `moves`, `steps`, `summary` |
68
+ | `resume` | `agent description`, `description`, `moves`, `steps`, `summary` |
package/docs/reference/std/instant_transfer.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # instant_transfer
4
4
 
5
- Source: [`std/settlements/instant_transfer.hsx`](../../../std/settlements/instant_transfer.hsx)
5
+ Source: [`std/money_flows/instant_transfer.hsx`](../../../std/money_flows/instant_transfer.hsx)
6
6
 
7
7
  ## Export
8
8
 
@@ -22,9 +22,9 @@ None.
22
22
 
23
23
  ## Actions and clauses
24
24
 
25
- | Action | Clauses lowered |
26
- | --------------------- | ------------------------------------------------ |
27
- | `create` | `agent description`, `moves`, `steps`, `summary` |
28
- | `pay_piece_1` | `agent description`, `moves`, `steps`, `summary` |
29
- | `pay_piece_2` | `agent description`, `moves`, `steps`, `summary` |
30
- | `collect_service_fee` | `agent description`, `moves`, `steps`, `summary` |
25
+ | Action | Clauses lowered |
26
+ | --------------------- | ------------------------------------------------------------------------- |
27
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
28
+ | `pay_piece_1` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
29
+ | `pay_piece_2` | `agent description`, `moves`, `steps`, `summary` |
30
+ | `collect_service_fee` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/metered.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # metered
4
4
 
5
- Source: [`std/settlements/metered.hsx`](../../../std/settlements/metered.hsx)
5
+ Source: [`std/money_flows/metered.hsx`](../../../std/money_flows/metered.hsx)
6
6
 
7
7
  ## Export
8
8
 
package/docs/reference/std/pooled_split.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # pooled_split
4
4
 
5
- Source: [`std/settlements/pooled_split.hsx`](../../../std/settlements/pooled_split.hsx)
5
+ Source: [`std/money_flows/pooled_split.hsx`](../../../std/money_flows/pooled_split.hsx)
6
6
 
7
7
  ## Export
8
8
 
package/docs/reference/std/premium_forward.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # premium_forward
4
4
 
5
- Source: [`std/settlements/premium_forward.hsx`](../../../std/settlements/premium_forward.hsx)
5
+ Source: [`std/money_flows/premium_forward.hsx`](../../../std/money_flows/premium_forward.hsx)
6
6
 
7
7
  ## Export
8
8
 
@@ -26,14 +26,14 @@ Source: [`std/settlements/premium_forward.hsx`](../../../std/settlements/premium
26
26
 
27
27
  ## Actions and clauses
28
28
 
29
- | Action | Clauses lowered |
30
- | ----------------- | ---------------------------------------------------------------------------------------- |
31
- | `create` | `agent description`, `steps`, `summary` |
32
- | `fund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
33
- | `fund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
34
- | `bind` | `agent description`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
35
- | `forward_piece_2` | `agent description`, `moves`, `steps`, `summary` |
36
- | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
37
- | `abandon` | `agent description`, `steps`, `summary` |
38
- | `endorsement` | `agent description`, `capture input`, `description`, `input`, `port`, `steps`, `summary` |
39
- | `lapse` | `due`, `steps`, `summary` |
29
+ | Action | Clauses lowered |
30
+ | ----------------- | ------------------------------------------------------------------------------------------ |
31
+ | `create` | `agent description`, `steps`, `summary` |
32
+ | `fund_piece_1` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
33
+ | `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
34
+ | `bind` | `agent description`, `input`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
35
+ | `forward_piece_2` | `agent description`, `moves`, `steps`, `summary` |
36
+ | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
37
+ | `abandon` | `agent description`, `steps`, `summary` |
38
+ | `endorsement` | `agent description`, `capture input`, `input`, `port`, `steps`, `summary` |
39
+ | `lapse` | `due`, `steps`, `summary` |
package/docs/reference/std/reconciled_payout.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # reconciled_payout
4
4
 
5
- Source: [`std/settlements/reconciled_payout.hsx`](../../../std/settlements/reconciled_payout.hsx)
5
+ Source: [`std/money_flows/reconciled_payout.hsx`](../../../std/money_flows/reconciled_payout.hsx)
6
6
 
7
7
  ## Export
8
8
 
package/docs/reference/std/recurring_collection.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # recurring_collection
4
4
 
5
- Source: [`std/settlements/recurring_collection.hsx`](../../../std/settlements/recurring_collection.hsx)
5
+ Source: [`std/money_flows/recurring_collection.hsx`](../../../std/money_flows/recurring_collection.hsx)
6
6
 
7
7
  ## Export
8
8
 
package/docs/reference/std/rotating_pool.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # rotating_pool
4
4
 
5
- Source: [`std/settlements/rotating_pool.hsx`](../../../std/settlements/rotating_pool.hsx)
5
+ Source: [`std/money_flows/rotating_pool.hsx`](../../../std/money_flows/rotating_pool.hsx)
6
6
 
7
7
  ## Export
8
8
 
package/docs/reference/std/scheduled.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # scheduled
4
4
 
5
- Source: [`std/settlements/scheduled.hsx`](../../../std/settlements/scheduled.hsx)
5
+ Source: [`std/money_flows/scheduled.hsx`](../../../std/money_flows/scheduled.hsx)
6
6
 
7
7
  ## Export
8
8
 
@@ -33,19 +33,19 @@ Source: [`std/settlements/scheduled.hsx`](../../../std/settlements/scheduled.hsx
33
33
 
34
34
  ## Actions and clauses
35
35
 
36
- | Action | Clauses lowered |
37
- | ------------------- | ------------------------------------------------------------------------------------------------- |
38
- | `create` | `agent description`, `steps`, `summary` |
39
- | `create` | `agent description`, `moves`, `steps`, `summary` |
40
- | `approve` | `agent description`, `steps`, `summary` |
41
- | `advance` | `agent description`, `moves`, `steps`, `summary` |
42
- | `delinquent_action` | `due`, `sets at`, `steps`, `summary` |
43
- | `complete` | `due`, `steps`, `summary` |
44
- | `write_off` | `agent description`, `steps`, `summary` |
45
- | `create` | `agent description`, `steps`, `summary` |
46
- | `repay` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
47
- | `refund` | `agent description`, `moves`, `steps`, `summary` |
48
- | `create` | `agent description`, `steps`, `summary` |
49
- | `open_period` | `due`, `steps`, `summary` |
50
- | `collect_period` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
51
- | `until` | `agent description`, `capture input`, `description`, `input`, `port`, `steps`, `summary` |
36
+ | Action | Clauses lowered |
37
+ | ------------------- | -------------------------------------------------------------------------------------------------------------------------- |
38
+ | `create` | `agent description`, `steps`, `summary` |
39
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
40
+ | `approve` | `agent description`, `steps`, `summary` |
41
+ | `advance` | `agent description`, `moves`, `steps`, `summary` |
42
+ | `delinquent_action` | `due`, `sets at`, `steps`, `summary` |
43
+ | `complete` | `due`, `steps`, `summary` |
44
+ | `write_off` | `agent description`, `steps`, `summary` |
45
+ | `create` | `agent description`, `steps`, `summary` |
46
+ | `repay` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
47
+ | `refund` | `agent description`, `moves`, `steps`, `summary` |
48
+ | `create` | `agent description`, `steps`, `summary` |
49
+ | `open_period` | `due`, `steps`, `summary` |
50
+ | `collect_period` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
51
+ | `until` | `agent description`, `capture input`, `input`, `port`, `steps`, `summary` |
package/docs/reference/std/security_deposit.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # security_deposit
4
4
 
5
- Source: [`std/settlements/security_deposit.hsx`](../../../std/settlements/security_deposit.hsx)
5
+ Source: [`std/money_flows/security_deposit.hsx`](../../../std/money_flows/security_deposit.hsx)
6
6
 
7
7
  ## Export
8
8
 
@@ -32,15 +32,15 @@ Source: [`std/settlements/security_deposit.hsx`](../../../std/settlements/securi
32
32
 
33
33
  ## Actions and clauses
34
34
 
35
- | Action | Clauses lowered |
36
- | --------------- | ---------------------------------------------------------------------------------------------------------------- |
37
- | `create` | `agent description`, `moves`, `steps`, `summary` |
38
- | `place_deposit` | `agent description`, `moves`, `steps`, `summary` |
39
- | `claim_name` | `agent description`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
40
- | `return_name` | `agent description`, `moves`, `steps`, `summary` |
41
- | `create` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
42
- | `fund` | `agent description`, `deadline`, `moves`, `sandbox failure point`, `steps`, `summary` |
43
- | `claim` | `agent description`, `capture input`, `deadline`, `decided amount`, `input`, `moves`, `port`, `steps`, `summary` |
44
- | `return` | `agent description`, `deadline`, `moves`, `port`, `steps`, `summary` |
45
- | `expire` | `due`, `moves`, `steps`, `summary` |
46
- | `cancel` | `agent description`, `moves`, `steps`, `summary` |
35
+ | Action | Clauses lowered |
36
+ | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
37
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
38
+ | `place_deposit` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
39
+ | `claim_name` | `agent description`, `input`, `moves`, `port`, `steps`, `summary` |
40
+ | `return_name` | `agent description`, `capture input`, `input`, `moves`, `port`, `steps`, `summary` |
41
+ | `create` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
42
+ | `fund` | `agent description`, `deadline`, `moves`, `sandbox failure point`, `steps`, `summary` |
43
+ | `claim` | `agent description`, `capture input`, `deadline`, `decided amount`, `input`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
44
+ | `return` | `agent description`, `deadline`, `moves`, `port`, `steps`, `summary` |
45
+ | `expire` | `due`, `moves`, `steps`, `summary` |
46
+ | `cancel` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/settlement_batch.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # settlement_batch
4
4
 
5
- Source: [`std/settlements/settlement_batch.hsx`](../../../std/settlements/settlement_batch.hsx)
5
+ Source: [`std/money_flows/settlement_batch.hsx`](../../../std/money_flows/settlement_batch.hsx)
6
6
 
7
7
  ## Export
8
8
 
package/docs/reference/std/swap.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # swap
4
4
 
5
- Source: [`std/settlements/swap.hsx`](../../../std/settlements/swap.hsx)
5
+ Source: [`std/money_flows/swap.hsx`](../../../std/money_flows/swap.hsx)
6
6
 
7
7
  ## Export
8
8
 
@@ -28,19 +28,19 @@ Source: [`std/settlements/swap.hsx`](../../../std/settlements/swap.hsx)
28
28
 
29
29
  ## Actions and clauses
30
30
 
31
- | Action | Clauses lowered |
32
- | --------- | --------------------------------------------------------------------------------------------------------------------------- |
33
- | `abandon` | `agent description`, `moves`, `public action`, `steps`, `summary` |
34
- | `cancel` | `agent description`, `moves`, `public action`, `steps`, `summary` |
35
- | `create` | `agent description`, `moves`, `public action`, `steps`, `summary` |
36
- | `dispute` | `agent description`, `deadline`, `moves`, `port`, `public action`, `steps`, `summary` |
37
- | `fund` | `agent description`, `moves`, `public action`, `steps`, `summary` |
38
- | `post` | `due`, `moves`, `steps`, `summary` |
39
- | `release` | `agent description`, `moves`, `port`, `public action`, `sets at`, `steps`, `summary` |
40
- | `create` | `agent description`, `moves`, `public action`, `steps`, `summary` |
41
- | `fund` | `agent description`, `event name`, `moves`, `public action`, `sandbox failure point`, `steps`, `summary` |
42
- | `release` | `agent description`, `event name`, `moves`, `port`, `public action`, `sandbox failure point`, `sets at`, `steps`, `summary` |
43
- | `post` | `due`, `event name`, `moves`, `steps`, `summary` |
44
- | `dispute` | `agent description`, `deadline`, `event name`, `moves`, `port`, `public action`, `steps`, `summary` |
45
- | `cancel` | `agent description`, `event name`, `moves`, `public action`, `steps`, `summary` |
46
- | `abandon` | `agent description`, `event name`, `moves`, `public action`, `steps`, `summary` |
31
+ | Action | Clauses lowered |
32
+ | --------- | ----------------------------------------------------------------------------------------------------------------------------- |
33
+ | `abandon` | `agent description`, `moves`, `public action`, `steps`, `summary` |
34
+ | `cancel` | `agent description`, `moves`, `public action`, `steps`, `summary` |
35
+ | `create` | `agent description`, `moves`, `public action`, `steps`, `summary` |
36
+ | `dispute` | `agent description`, `capture input`, `deadline`, `input`, `moves`, `port`, `public action`, `steps`, `summary` |
37
+ | `fund` | `agent description`, `moves`, `public action`, `sandbox failure point`, `steps`, `summary` |
38
+ | `post` | `due`, `moves`, `steps`, `summary` |
39
+ | `release` | `agent description`, `moves`, `port`, `public action`, `sandbox failure point`, `sets at`, `steps`, `summary` |
40
+ | `create` | `agent description`, `moves`, `public action`, `steps`, `summary` |
41
+ | `fund` | `agent description`, `event name`, `moves`, `public action`, `sandbox failure point`, `steps`, `summary` |
42
+ | `release` | `agent description`, `event name`, `moves`, `port`, `public action`, `sandbox failure point`, `sets at`, `steps`, `summary` |
43
+ | `post` | `due`, `event name`, `moves`, `steps`, `summary` |
44
+ | `dispute` | `agent description`, `capture input`, `deadline`, `event name`, `input`, `moves`, `port`, `public action`, `steps`, `summary` |
45
+ | `cancel` | `agent description`, `event name`, `moves`, `public action`, `steps`, `summary` |
46
+ | `abandon` | `agent description`, `event name`, `moves`, `public action`, `steps`, `summary` |
package/docs/reference/std/threshold_pool.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # threshold_pool
4
4
 
5
- Source: [`std/settlements/threshold_pool.hsx`](../../../std/settlements/threshold_pool.hsx)
5
+ Source: [`std/money_flows/threshold_pool.hsx`](../../../std/money_flows/threshold_pool.hsx)
6
6
 
7
7
  ## Export
8
8
 
package/docs/reference/std/weighted_distribution.md CHANGED
@@ -1,8 +1,8 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # weighted_distribution
4
4
 
5
- Source: [`std/settlements/weighted_distribution.hsx`](../../../std/settlements/weighted_distribution.hsx)
5
+ Source: [`std/money_flows/weighted_distribution.hsx`](../../../std/money_flows/weighted_distribution.hsx)
6
6
 
7
7
  ## Export
8
8
 
package/docs/reference/types.md CHANGED
@@ -1,4 +1,4 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # Types
4
4
 
package/docs/reference/udl-output.md CHANGED
@@ -1,4 +1,4 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
1
+ <!-- Generated by scripts/docs/build.ts for HSX 2.0.0. Do not edit. -->
2
2
 
3
3
  # UDL output
4
4
 
package/examples/01-first-program/README.md CHANGED
@@ -14,7 +14,7 @@ hsx build tip-jar.hsx # the compiled IR
14
14
  name is `snake_case` and becomes the IR document's `product`; the title is
15
15
  optional and is what people read.
16
16
 
17
- **`import { instant_transfer } from "std/settlements"`** brings in one settlement brick.
17
+ **`import { instant_transfer } from "std/money_flows"`** brings in one settlement brick.
18
18
  `"settlement"` is the only module there is, and it holds seventeen settlement
19
19
  bricks. A brick you have not imported cannot be instantiated, so the imports
20
20
  at the top tell you what shape of company this is before you read a line of it.
package/examples/01-first-program/tip-jar.hsx CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  program tip_jar "Tip jar"
7
7
 
8
- import { instant_transfer } from "std/settlements"
8
+ import { instant_transfer } from "std/money_flows"
9
9
 
10
10
  party listener: person
11
11
  party host: business
package/examples/02-imports-and-archetypes/photo-booth.hsx CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  program photo_booth "Photo booth rentals"
10
10
 
11
- import { held_payment } from "std/settlements"
11
+ import { held_payment } from "std/money_flows"
12
12
 
13
13
  party renter: person
14
14
  party company: business
package/examples/03-diagnostics/corner-shop-fixed.hsx CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  program corner_shop "Corner shop"
6
6
 
7
- import { held_payment } from "std/settlements"
7
+ import { held_payment } from "std/money_flows"
8
8
 
9
9
  party shopper: person
10
10
  party grocer: business
package/examples/03-diagnostics/corner-shop.hsx CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  program corner_shop "Corner shop"
8
8
 
9
- import { held_payment } from "std/settlements"
9
+ import { held_payment } from "std/money_flows"
10
10
 
11
11
  party shopper: person
12
12
 
package/examples/04-complete-product/study-hall.hsx CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  program study_hall "Study hall"
16
16
 
17
- import { held_payment, security_deposit, pooled_split } from "std/settlements"
17
+ import { held_payment, security_deposit, pooled_split } from "std/money_flows"
18
18
 
19
19
  party student: person
20
20
  party tutor: business
package/examples/05-watch-club/README.md CHANGED
@@ -4,6 +4,3 @@ This reference program joins the algebra needed for one club product. It keeps
4
4
  each watch attached to explicit sale, deposit, and trade rules. Membership due
5
5
  dates open periods, while callers still author every money action. Seller
6
6
  payouts close through stored provider evidence.
7
-
8
- The acceptance proof lives in
9
- `toolchain/system-tests/test/watch-club.acceptance.spec.ts`.
package/examples/05-watch-club/watch-club.hsx CHANGED
@@ -11,7 +11,7 @@ import {
11
11
  scheduled,
12
12
  settlement_batch,
13
13
  swap
14
- } from "std/settlements"
14
+ } from "std/money_flows"
15
15
 
16
16
  party member: person
17
17
  party seller: business
package/examples/README.md CHANGED
@@ -1,12 +1,43 @@
1
1
  # Examples
2
2
 
3
- Each standard-library module has its own directory with an HSX program, a
3
+ Each money flow has its own directory with an HSX program, a
4
4
  short lesson, and pinned canonical UDL bytes. The test suite reads the module
5
- list from `std/settlements`, compiles every program, and compares each emitted
5
+ list from `std/money_flows`, compiles every program, and compares each emitted
6
6
  document byte for byte.
7
7
 
8
- The numbered examples remain as longer lessons. They cover a first program,
9
- imports, diagnostic repair, a composed product, and a multi-instrument club.
8
+ The numbered examples provide end-to-end walkthroughs:
9
+
10
+ - [01 · Your first program](01-first-program/README.md)
11
+ - [02 · Imports and modules](02-imports-and-archetypes/README.md)
12
+ - [03 · Diagnostics](03-diagnostics/README.md)
13
+ - [04 · Complete product](04-complete-product/README.md)
14
+ - [05 · Watch club](05-watch-club/README.md)
15
+
16
+ ## Money flows
17
+
18
+ Each money flow has a runnable example directory:
19
+
20
+ - [advance](advance/README.md)
21
+ - [cancellable_booking](cancellable_booking/README.md)
22
+ - [captured_payment](captured_payment/README.md)
23
+ - [conditional_disbursement](conditional_disbursement/README.md)
24
+ - [credit_facility](credit_facility/README.md)
25
+ - [held_payment](held_payment/README.md)
26
+ - [instant_transfer](instant_transfer/README.md)
27
+ - [metered](metered/README.md)
28
+ - [pooled_split](pooled_split/README.md)
29
+ - [premium_forward](premium_forward/README.md)
30
+ - [reconciled_payout](reconciled_payout/README.md)
31
+ - [recurring_collection](recurring_collection/README.md)
32
+ - [rotating_pool](rotating_pool/README.md)
33
+ - [scheduled](scheduled/README.md)
34
+ - [security_deposit](security_deposit/README.md)
35
+ - [settlement_batch](settlement_batch/README.md)
36
+ - [swap](swap/README.md)
37
+ - [threshold_pool](threshold_pool/README.md)
38
+ - [weighted_distribution](weighted_distribution/README.md)
39
+
40
+ ## Running an example
10
41
 
11
42
  Run an example with the installed CLI:
12
43
 
package/examples/advance/advance.hsx CHANGED
@@ -1,5 +1,5 @@
1
1
  program advance_example "Advance example"
2
- import { advance } from "std/settlements"
2
+ import { advance } from "std/money_flows"
3
3
  party funder: business
4
4
  party recipient: business
5
5
  settlement advance_payment = advance {
package/examples/advance/advance.udl CHANGED
@@ -215,7 +215,8 @@
215
215
  "feeAmount": {
216
216
  "description": "2.5% of principal, the funder's discount repaid on top of the advance",
217
217
  "pattern": "^[1-9][0-9]{0,17}$",
218
- "type": "string"
218
+ "type": "string",
219
+ "x-hyperscale-currency": "SAR"
219
220
  },
220
221
  "firstDueAt": {
221
222
  "description": "Due date of the first repayment; repayment k falls P30D after its predecessor",
@@ -236,7 +237,8 @@
236
237
  "principal": {
237
238
  "description": "The advanced amount in SAR minor units, disbursed to the recipient up front",
238
239
  "pattern": "^[1-9][0-9]{0,17}$",
239
- "type": "string"
240
+ "type": "string",
241
+ "x-hyperscale-currency": "SAR"
240
242
  },
241
243
  "recipientAccountId": {
242
244
  "description": "The recipient account",
@@ -252,17 +254,20 @@
252
254
  "repayableAmount": {
253
255
  "description": "principal + feeAmount: the total the repayment fields below partition exactly",
254
256
  "pattern": "^[1-9][0-9]{0,17}$",
255
- "type": "string"
257
+ "type": "string",
258
+ "x-hyperscale-currency": "SAR"
256
259
  },
257
260
  "repayment1Amount": {
258
261
  "description": "Repayment 1 of 2 (carries the integer-division remainder): about 33.34% of repayableAmount, collected on its own stored-date anchor",
259
262
  "pattern": "^[1-9][0-9]{0,17}$",
260
- "type": "string"
263
+ "type": "string",
264
+ "x-hyperscale-currency": "SAR"
261
265
  },
262
266
  "repayment2Amount": {
263
267
  "description": "Repayment 2 of 2: about 33.33% of repayableAmount, collected on its own stored-date anchor",
264
268
  "pattern": "^[1-9][0-9]{0,17}$",
265
- "type": "string"
269
+ "type": "string",
270
+ "x-hyperscale-currency": "SAR"
266
271
  }
267
272
  },
268
273
  "id": "advance_payment",
package/examples/cancellable_booking/cancellable_booking.hsx CHANGED
@@ -1,5 +1,5 @@
1
1
  program cancellable_booking_example "Cancellable booking example"
2
- import { cancellable_booking } from "std/settlements"
2
+ import { cancellable_booking } from "std/money_flows"
3
3
  party guest: person
4
4
  party studio: business
5
5
  settlement studio_session = cancellable_booking {
package/examples/cancellable_booking/cancellable_booking.udl CHANGED
@@ -275,6 +275,7 @@
275
275
  }
276
276
  ],
277
277
  "publicAction": "takeStudioSession",
278
+ "sandboxFailurePoint": "funding",
278
279
  "steps": [],
279
280
  "summary": "Take the booking price from the guest into the holding account"
280
281
  }
@@ -303,7 +304,8 @@
303
304
  "sessionPrice": {
304
305
  "description": "Booking price in minor units, held away from both the guest and the studio until the booking ends",
305
306
  "pattern": "^[1-9][0-9]{0,17}$",
306
- "type": "string"
307
+ "type": "string",
308
+ "x-hyperscale-currency": "SAR"
307
309
  },
308
310
  "startsAt": {
309
311
  "description": "When the booking starts; the cancellation penalty is priced against the time left before it",