@hyperscale0/hsx 1.0.0-beta.1 → 1.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 (255) hide show
  1. package/CHANGELOG.md +58 -9
  2. package/LICENSING.md +3 -3
  3. package/README.md +39 -149
  4. package/TRADEMARKS.md +4 -4
  5. package/bin/hsx.ts +2 -0
  6. package/dist/bin/hsx.js +2 -0
  7. package/dist/bin/hsx.js.map +1 -1
  8. package/dist/src/ast.d.ts +135 -10
  9. package/dist/src/ast.d.ts.map +1 -1
  10. package/dist/src/ast.js +24 -0
  11. package/dist/src/ast.js.map +1 -1
  12. package/dist/src/cli.d.ts +4 -1
  13. package/dist/src/cli.d.ts.map +1 -1
  14. package/dist/src/cli.js +172 -16
  15. package/dist/src/cli.js.map +1 -1
  16. package/dist/src/compile.d.ts +42 -7
  17. package/dist/src/compile.d.ts.map +1 -1
  18. package/dist/src/compile.js +82 -16
  19. package/dist/src/compile.js.map +1 -1
  20. package/dist/src/cost.d.ts +78 -0
  21. package/dist/src/cost.d.ts.map +1 -0
  22. package/dist/src/cost.js +369 -0
  23. package/dist/src/cost.js.map +1 -0
  24. package/dist/src/diagnostics.d.ts +11 -0
  25. package/dist/src/diagnostics.d.ts.map +1 -0
  26. package/dist/src/diagnostics.js +420 -0
  27. package/dist/src/diagnostics.js.map +1 -0
  28. package/dist/src/emit.d.ts +34 -0
  29. package/dist/src/emit.d.ts.map +1 -0
  30. package/dist/src/emit.js +137 -0
  31. package/dist/src/emit.js.map +1 -0
  32. package/dist/src/entry-overrides.d.ts +17 -3
  33. package/dist/src/entry-overrides.d.ts.map +1 -1
  34. package/dist/src/entry-overrides.js +180 -35
  35. package/dist/src/entry-overrides.js.map +1 -1
  36. package/dist/src/format.d.ts +10 -0
  37. package/dist/src/format.d.ts.map +1 -0
  38. package/dist/src/format.js +183 -0
  39. package/dist/src/format.js.map +1 -0
  40. package/dist/src/index.d.ts +11 -4
  41. package/dist/src/index.d.ts.map +1 -1
  42. package/dist/src/index.js +10 -3
  43. package/dist/src/index.js.map +1 -1
  44. package/dist/src/ir.d.ts +66 -0
  45. package/dist/src/ir.d.ts.map +1 -0
  46. package/dist/src/ir.js +15 -0
  47. package/dist/src/ir.js.map +1 -0
  48. package/dist/src/lex.d.ts +9 -1
  49. package/dist/src/lex.d.ts.map +1 -1
  50. package/dist/src/lex.js +50 -4
  51. package/dist/src/lex.js.map +1 -1
  52. package/dist/src/limits.d.ts +2 -3
  53. package/dist/src/limits.d.ts.map +1 -1
  54. package/dist/src/limits.js +2 -3
  55. package/dist/src/limits.js.map +1 -1
  56. package/dist/src/lsp/server.d.ts +32 -0
  57. package/dist/src/lsp/server.d.ts.map +1 -0
  58. package/dist/src/lsp/server.js +391 -0
  59. package/dist/src/lsp/server.js.map +1 -0
  60. package/dist/src/modules.d.ts +38 -0
  61. package/dist/src/modules.d.ts.map +1 -0
  62. package/dist/src/modules.js +368 -0
  63. package/dist/src/modules.js.map +1 -0
  64. package/dist/src/parse.d.ts.map +1 -1
  65. package/dist/src/parse.js +590 -17
  66. package/dist/src/parse.js.map +1 -1
  67. package/dist/src/std-bundle.d.ts +2 -0
  68. package/dist/src/std-bundle.d.ts.map +1 -0
  69. package/dist/src/std-bundle.js +88 -0
  70. package/dist/src/std-bundle.js.map +1 -0
  71. package/dist/src/std-library.d.ts +5 -0
  72. package/dist/src/std-library.d.ts.map +1 -0
  73. package/dist/src/std-library.js +9 -0
  74. package/dist/src/std-library.js.map +1 -0
  75. package/dist/src/typecheck.d.ts +8 -0
  76. package/dist/src/typecheck.d.ts.map +1 -0
  77. package/dist/src/typecheck.js +2958 -0
  78. package/dist/src/typecheck.js.map +1 -0
  79. package/dist/src/version.d.ts +4 -15
  80. package/dist/src/version.d.ts.map +1 -1
  81. package/dist/src/version.js +4 -15
  82. package/dist/src/version.js.map +1 -1
  83. package/docs/README.md +26 -0
  84. package/docs/guide/01-first-program.md +24 -0
  85. package/docs/guide/02-money.md +25 -0
  86. package/docs/guide/03-instruments.md +22 -0
  87. package/docs/guide/04-lifecycles.md +25 -0
  88. package/docs/guide/05-fees-and-splits.md +45 -0
  89. package/docs/guide/06-schedules.md +22 -0
  90. package/docs/guide/07-composition.md +46 -0
  91. package/docs/guide/08-writing-a-module.md +26 -0
  92. package/docs/guide/09-cost.md +24 -0
  93. package/docs/guide/10-diagnostics.md +27 -0
  94. package/docs/llms-full.txt +1739 -0
  95. package/docs/llms.txt +45 -0
  96. package/docs/playground.md +54 -0
  97. package/docs/reference/cli.md +35 -0
  98. package/docs/reference/diagnostics.md +619 -0
  99. package/docs/reference/grammar.md +39 -0
  100. package/docs/reference/std/advance.md +35 -0
  101. package/docs/reference/std/cancellable_booking.md +35 -0
  102. package/docs/reference/std/captured_payment.md +43 -0
  103. package/docs/reference/std/conditional_disbursement.md +33 -0
  104. package/docs/reference/std/credit_facility.md +35 -0
  105. package/docs/reference/std/held_payment.md +64 -0
  106. package/docs/reference/std/instant_transfer.md +30 -0
  107. package/docs/reference/std/metered.md +27 -0
  108. package/docs/reference/std/pooled_split.md +26 -0
  109. package/docs/reference/std/premium_forward.md +39 -0
  110. package/docs/reference/std/reconciled_payout.md +33 -0
  111. package/docs/reference/std/recurring_collection.md +25 -0
  112. package/docs/reference/std/rotating_pool.md +42 -0
  113. package/docs/reference/std/scheduled.md +51 -0
  114. package/docs/reference/std/security_deposit.md +46 -0
  115. package/docs/reference/std/settlement_batch.md +42 -0
  116. package/docs/reference/std/swap.md +46 -0
  117. package/docs/reference/std/threshold_pool.md +47 -0
  118. package/docs/reference/std/weighted_distribution.md +39 -0
  119. package/docs/reference/types.md +20 -0
  120. package/docs/reference/udl-output.md +13 -0
  121. package/docs/sessions/2026-09-02-two-instruments.hsx +21 -0
  122. package/docs/sessions/2026-09-02-two-instruments.md +41 -0
  123. package/examples/01-first-program/README.md +45 -0
  124. package/examples/01-first-program/tip-jar.hsx +17 -0
  125. package/examples/02-imports-and-archetypes/README.md +96 -0
  126. package/examples/02-imports-and-archetypes/photo-booth.hsx +37 -0
  127. package/examples/03-diagnostics/README.md +68 -0
  128. package/examples/03-diagnostics/corner-shop-fixed.hsx +22 -0
  129. package/examples/03-diagnostics/corner-shop.hsx +19 -0
  130. package/examples/04-complete-product/README.md +84 -0
  131. package/examples/04-complete-product/study-hall.hsx +67 -0
  132. package/examples/05-watch-club/README.md +9 -0
  133. package/examples/05-watch-club/watch-club.hsx +124 -0
  134. package/examples/README.md +18 -0
  135. package/examples/advance/README.md +3 -0
  136. package/examples/advance/advance.hsx +13 -0
  137. package/examples/advance/advance.udl +339 -0
  138. package/examples/cancellable_booking/README.md +3 -0
  139. package/examples/cancellable_booking/cancellable_booking.hsx +14 -0
  140. package/examples/cancellable_booking/cancellable_booking.udl +391 -0
  141. package/examples/captured_payment/README.md +3 -0
  142. package/examples/captured_payment/captured_payment.hsx +21 -0
  143. package/examples/captured_payment/captured_payment.udl +677 -0
  144. package/examples/conditional_disbursement/README.md +3 -0
  145. package/examples/conditional_disbursement/conditional_disbursement.hsx +17 -0
  146. package/examples/conditional_disbursement/conditional_disbursement.udl +412 -0
  147. package/examples/cost-table.json +386 -0
  148. package/examples/credit_facility/README.md +3 -0
  149. package/examples/credit_facility/credit_facility.hsx +27 -0
  150. package/examples/credit_facility/credit_facility.udl +1373 -0
  151. package/examples/held_payment/README.md +3 -0
  152. package/examples/held_payment/held_payment.hsx +13 -0
  153. package/examples/held_payment/held_payment.udl +507 -0
  154. package/examples/instant_transfer/README.md +3 -0
  155. package/examples/instant_transfer/instant_transfer.hsx +16 -0
  156. package/examples/instant_transfer/instant_transfer.udl +364 -0
  157. package/examples/metered/README.md +3 -0
  158. package/examples/metered/metered.hsx +13 -0
  159. package/examples/metered/metered.udl +247 -0
  160. package/examples/pooled_split/README.md +3 -0
  161. package/examples/pooled_split/pooled_split.hsx +15 -0
  162. package/examples/pooled_split/pooled_split.udl +425 -0
  163. package/examples/premium_forward/README.md +3 -0
  164. package/examples/premium_forward/premium_forward.hsx +19 -0
  165. package/examples/premium_forward/premium_forward.udl +594 -0
  166. package/examples/reconciled_payout/README.md +3 -0
  167. package/examples/reconciled_payout/reconciled_payout.hsx +13 -0
  168. package/examples/reconciled_payout/reconciled_payout.udl +303 -0
  169. package/examples/recurring_collection/README.md +3 -0
  170. package/examples/recurring_collection/recurring_collection.hsx +21 -0
  171. package/examples/recurring_collection/recurring_collection.udl +1130 -0
  172. package/examples/rotating_pool/README.md +3 -0
  173. package/examples/rotating_pool/rotating_pool.hsx +18 -0
  174. package/examples/rotating_pool/rotating_pool.udl +4352 -0
  175. package/examples/scheduled/README.md +3 -0
  176. package/examples/scheduled/scheduled.hsx +12 -0
  177. package/examples/scheduled/scheduled.udl +335 -0
  178. package/examples/security_deposit/README.md +3 -0
  179. package/examples/security_deposit/security_deposit.hsx +21 -0
  180. package/examples/security_deposit/security_deposit.udl +293 -0
  181. package/examples/settlement_batch/README.md +3 -0
  182. package/examples/settlement_batch/settlement_batch.hsx +19 -0
  183. package/examples/settlement_batch/settlement_batch.udl +753 -0
  184. package/examples/swap/README.md +3 -0
  185. package/examples/swap/swap.hsx +19 -0
  186. package/examples/swap/swap.udl +876 -0
  187. package/examples/threshold_pool/README.md +3 -0
  188. package/examples/threshold_pool/threshold_pool.hsx +16 -0
  189. package/examples/threshold_pool/threshold_pool.udl +667 -0
  190. package/examples/weighted_distribution/README.md +3 -0
  191. package/examples/weighted_distribution/weighted_distribution.hsx +20 -0
  192. package/examples/weighted_distribution/weighted_distribution.udl +337 -0
  193. package/package.json +27 -6
  194. package/skills/hsx/SKILL.md +483 -0
  195. package/src/ast.ts +193 -9
  196. package/src/cli.ts +191 -20
  197. package/src/compile.ts +160 -23
  198. package/src/cost.ts +579 -0
  199. package/src/diagnostics.ts +442 -0
  200. package/src/emit.ts +201 -0
  201. package/src/entry-overrides.ts +263 -48
  202. package/src/format.ts +261 -0
  203. package/src/index.ts +34 -4
  204. package/src/ir.ts +99 -0
  205. package/src/lex.ts +59 -4
  206. package/src/limits.ts +2 -3
  207. package/src/lsp/server.ts +460 -0
  208. package/src/modules.ts +446 -0
  209. package/src/parse.ts +655 -21
  210. package/src/std-bundle.ts +91 -0
  211. package/src/std-library.ts +12 -0
  212. package/src/typecheck.ts +3876 -0
  213. package/src/version.ts +4 -16
  214. package/std/SEMANTICS.md +130 -0
  215. package/std/settlements/advance.hsx +177 -0
  216. package/std/settlements/cancellable_booking.hsx +87 -0
  217. package/std/settlements/captured_payment.hsx +144 -0
  218. package/std/settlements/conditional_disbursement.hsx +185 -0
  219. package/std/settlements/credit_facility.hsx +167 -0
  220. package/std/settlements/held_payment.hsx +578 -0
  221. package/std/settlements/index.hsx +3 -0
  222. package/std/settlements/instant_transfer.hsx +190 -0
  223. package/std/settlements/metered.hsx +67 -0
  224. package/std/settlements/pooled_split.hsx +68 -0
  225. package/std/settlements/premium_forward.hsx +257 -0
  226. package/std/settlements/reconciled_payout.hsx +77 -0
  227. package/std/settlements/recurring_collection.hsx +27 -0
  228. package/std/settlements/rotating_pool.hsx +252 -0
  229. package/std/settlements/scheduled.hsx +641 -0
  230. package/std/settlements/security_deposit.hsx +166 -0
  231. package/std/settlements/settlement_batch.hsx +122 -0
  232. package/std/settlements/swap.hsx +1114 -0
  233. package/std/settlements/threshold_pool.hsx +221 -0
  234. package/std/settlements/weighted_distribution.hsx +141 -0
  235. package/dist/src/archetypes.d.ts +0 -17
  236. package/dist/src/archetypes.d.ts.map +0 -1
  237. package/dist/src/archetypes.js +0 -327
  238. package/dist/src/archetypes.js.map +0 -1
  239. package/dist/src/check.d.ts +0 -12
  240. package/dist/src/check.d.ts.map +0 -1
  241. package/dist/src/check.js +0 -1910
  242. package/dist/src/check.js.map +0 -1
  243. package/dist/src/lower.d.ts +0 -146
  244. package/dist/src/lower.d.ts.map +0 -1
  245. package/dist/src/lower.js +0 -4570
  246. package/dist/src/lower.js.map +0 -1
  247. package/dist/src/model.d.ts +0 -467
  248. package/dist/src/model.d.ts.map +0 -1
  249. package/dist/src/model.js +0 -15
  250. package/dist/src/model.js.map +0 -1
  251. package/spec/hsx-ir.schema.json +0 -920
  252. package/src/archetypes.ts +0 -340
  253. package/src/check.ts +0 -2938
  254. package/src/lower.ts +0 -5416
  255. package/src/model.ts +0 -519
@@ -0,0 +1,35 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # cancellable_booking
4
+
5
+ Source: [`std/settlements/cancellable_booking.hsx`](../../../std/settlements/cancellable_booking.hsx)
6
+
7
+ ## Export
8
+
9
+ `cancellable_booking<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `guest: party`
14
+ - `host: party`
15
+ - `amount: money<C>`
16
+ - `starts_at: date`
17
+ - `late_penalty_bps: integer`
18
+ - `late_within: text`
19
+ - `early_penalty_bps: integer`
20
+ - `offer_life: text`
21
+
22
+ ## Decision ports
23
+
24
+ None.
25
+
26
+ ## Actions and clauses
27
+
28
+ | Action | Clauses lowered |
29
+ | ---------- | ---------------------------------------------------------- |
30
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
31
+ | `take` | `agent description`, `moves`, `steps`, `summary` |
32
+ | `complete` | `due`, `moves`, `steps`, `summary` |
33
+ | `cancel` | `agent description`, `moves`, `quote`, `steps`, `summary` |
34
+ | `confirm` | `agent description`, `commit`, `moves`, `steps`, `summary` |
35
+ | `retain` | `agent description`, `moves`, `steps`, `summary` |
@@ -0,0 +1,43 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # captured_payment
4
+
5
+ Source: [`std/settlements/captured_payment.hsx`](../../../std/settlements/captured_payment.hsx)
6
+
7
+ ## Export
8
+
9
+ `captured_payment<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `payer: party`
14
+ - `payee: party`
15
+ - `amount: money<C>`
16
+ - `reserve_until: date`
17
+ - `correction: condition`
18
+ - `external_reversal: condition`
19
+ - `capture_mode: text`
20
+ - `correction_mode: text`
21
+ - `negative_position: text`
22
+ - `timeout: text`
23
+ - `derived_amount: optional<block>`
24
+
25
+ ## Decision ports
26
+
27
+ - `correction`
28
+ - `external_reversal`
29
+
30
+ ## Actions and clauses
31
+
32
+ | Action | Clauses lowered |
33
+ | ------------------ | -------------------------------------------------------------------------------------------- |
34
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
35
+ | `authorize` | `agent description`, `moves`, `steps`, `summary` |
36
+ | `capture` | `agent description`, `deadline`, `description`, `input`, `moves`, `steps`, `summary` |
37
+ | `capture_more` | `agent description`, `deadline`, `description`, `input`, `moves`, `steps`, `summary` |
38
+ | `settle` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
39
+ | `void` | `agent description`, `moves`, `steps`, `summary` |
40
+ | `expire` | `due`, `moves`, `steps`, `summary` |
41
+ | `settle_on_expiry` | `due`, `moves`, `steps`, `summary` |
42
+ | `correction_name` | `agent description`, `moves`, `port`, `steps`, `summary` |
43
+ | `reversal_name` | `agent description`, `deadline`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
@@ -0,0 +1,33 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # conditional_disbursement
4
+
5
+ Source: [`std/settlements/conditional_disbursement.hsx`](../../../std/settlements/conditional_disbursement.hsx)
6
+
7
+ ## Export
8
+
9
+ `conditional_disbursement<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `source: party`
14
+ - `destination: party`
15
+ - `cap: money<C>`
16
+ - `amount: money<C>`
17
+ - `decision: condition`
18
+ - `reopen_policy: text`
19
+ - `recovery_policy: text`
20
+
21
+ ## Decision ports
22
+
23
+ - `decision`
24
+
25
+ ## Actions and clauses
26
+
27
+ | Action | Clauses lowered |
28
+ | --------- | ------------------------------------------------------------------------------------------------- |
29
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
30
+ | `deny` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
31
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
32
+ | `approve` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
33
+ | `pay` | `agent description`, `moves`, `steps`, `summary` |
@@ -0,0 +1,35 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # credit_facility
4
+
5
+ Source: [`std/settlements/credit_facility.hsx`](../../../std/settlements/credit_facility.hsx)
6
+
7
+ ## Export
8
+
9
+ `credit_facility<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `lender: party`
14
+ - `borrower: party`
15
+ - `draw_destination: party`
16
+ - `limit: money<C>`
17
+ - `expires_at: date`
18
+ - `obligation: ref`
19
+ - `availability_policy: text`
20
+ - `expiry_policy: text`
21
+ - `close_policy: text`
22
+
23
+ ## Decision ports
24
+
25
+ None.
26
+
27
+ ## Actions and clauses
28
+
29
+ | Action | Clauses lowered |
30
+ | --------- | ------------------------------------------------ |
31
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
32
+ | `freeze` | `due`, `moves`, `steps`, `summary` |
33
+ | `close` | `agent description`, `moves`, `steps`, `summary` |
34
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
35
+ | `resolve` | `agent description`, `moves`, `steps`, `summary` |
@@ -0,0 +1,64 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # held_payment
4
+
5
+ Source: [`std/settlements/held_payment.hsx`](../../../std/settlements/held_payment.hsx)
6
+
7
+ ## Export
8
+
9
+ `held_payment<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `payer: party`
14
+ - `payee: party`
15
+ - `amount: money<C>`
16
+ - `release: condition`
17
+ - `fees: optional<block>`
18
+ - `on_cancel: optional<block>`
19
+ - `derived_amount: optional<block>`
20
+ - `release_to: optional<party>`
21
+ - `whole_amount: optional<block>`
22
+ - `release_action: optional<text>`
23
+ - `whole_fee: optional<money<C>>`
24
+ - `reference: optional<text>`
25
+ - `upstream: optional<ref>`
26
+ - `id_prefix_override: optional<text>`
27
+
28
+ ## Decision ports
29
+
30
+ - `release`
31
+
32
+ ## Actions and clauses
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` |
@@ -0,0 +1,30 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # instant_transfer
4
+
5
+ Source: [`std/settlements/instant_transfer.hsx`](../../../std/settlements/instant_transfer.hsx)
6
+
7
+ ## Export
8
+
9
+ `instant_transfer<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `payer: party`
14
+ - `payee: party`
15
+ - `amount: money<C>`
16
+ - `fees: optional<block>`
17
+ - `derived_amount: optional<block>`
18
+
19
+ ## Decision ports
20
+
21
+ None.
22
+
23
+ ## Actions and clauses
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` |
@@ -0,0 +1,27 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # metered
4
+
5
+ Source: [`std/settlements/metered.hsx`](../../../std/settlements/metered.hsx)
6
+
7
+ ## Export
8
+
9
+ `metered`
10
+
11
+ ## Parameters
12
+
13
+ - `payer: party`
14
+ - `payee: party`
15
+ - `close_by: date`
16
+ - `rates: unknown`
17
+
18
+ ## Decision ports
19
+
20
+ None.
21
+
22
+ ## Actions and clauses
23
+
24
+ | Action | Clauses lowered |
25
+ | -------------- | --------------------------------------- |
26
+ | `create` | `agent description`, `steps`, `summary` |
27
+ | `close_period` | `due`, `steps`, `summary` |
@@ -0,0 +1,26 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # pooled_split
4
+
5
+ Source: [`std/settlements/pooled_split.hsx`](../../../std/settlements/pooled_split.hsx)
6
+
7
+ ## Export
8
+
9
+ `pooled_split<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `payer: party`
14
+ - `amount: money<C>`
15
+ - `payout_due: date`
16
+ - `split: block`
17
+
18
+ ## Decision ports
19
+
20
+ None.
21
+
22
+ ## Actions and clauses
23
+
24
+ | Action | Clauses lowered |
25
+ | -------- | ------------------------------------------------ |
26
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
@@ -0,0 +1,39 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # premium_forward
4
+
5
+ Source: [`std/settlements/premium_forward.hsx`](../../../std/settlements/premium_forward.hsx)
6
+
7
+ ## Export
8
+
9
+ `premium_forward<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `payer: party`
14
+ - `carrier: party`
15
+ - `amount: money<C>`
16
+ - `bind: condition`
17
+ - `commission: percent`
18
+ - `policy_ref: optional<text>`
19
+ - `renewal_due: optional<date>`
20
+ - `endorsement: optional<condition>`
21
+
22
+ ## Decision ports
23
+
24
+ - `bind`
25
+ - `endorsement`
26
+
27
+ ## Actions and clauses
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` |
@@ -0,0 +1,33 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # reconciled_payout
4
+
5
+ Source: [`std/settlements/reconciled_payout.hsx`](../../../std/settlements/reconciled_payout.hsx)
6
+
7
+ ## Export
8
+
9
+ `reconciled_payout<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `payer: party`
14
+ - `beneficiary: party`
15
+ - `amount: money<C>`
16
+ - `beneficiary_ref: text`
17
+ - `settle_by: date`
18
+ - `matched_within: integer`
19
+ - `matched_ceiling: integer`
20
+
21
+ ## Decision ports
22
+
23
+ None.
24
+
25
+ ## Actions and clauses
26
+
27
+ | Action | Clauses lowered |
28
+ | ---------- | ---------------------------------------------------------- |
29
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
30
+ | `instruct` | `agent description`, `moves`, `payout`, `steps`, `summary` |
31
+ | `settle` | `due`, `moves`, `reconcile`, `steps`, `summary` |
32
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
33
+ | `carry` | `agent description`, `moves`, `steps`, `summary` |
@@ -0,0 +1,25 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # recurring_collection
4
+
5
+ Source: [`std/settlements/recurring_collection.hsx`](../../../std/settlements/recurring_collection.hsx)
6
+
7
+ ## Export
8
+
9
+ `recurring_collection`
10
+
11
+ ## Parameters
12
+
13
+ - `marker: optional<text>`
14
+
15
+ ## Decision ports
16
+
17
+ None.
18
+
19
+ ## Actions and clauses
20
+
21
+ | Action | Clauses lowered |
22
+ | --------- | --------------------------------------- |
23
+ | `create` | `agent description`, `steps`, `summary` |
24
+ | `collect` | `agent description`, `steps`, `summary` |
25
+ | `end` | `agent description`, `steps`, `summary` |
@@ -0,0 +1,42 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # rotating_pool
4
+
5
+ Source: [`std/settlements/rotating_pool.hsx`](../../../std/settlements/rotating_pool.hsx)
6
+
7
+ ## Export
8
+
9
+ `rotating_pool<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `members: optional<list<party>>`
14
+ - `contribution: money<C>`
15
+ - `count: integer`
16
+ - `every: optional<text>`
17
+ - `first_due: date`
18
+ - `payout_order: optional<list<party>>`
19
+ - `default_policy: optional<text>`
20
+ - `guarantee_policy: optional<text>`
21
+ - `guarantor: optional<party>`
22
+ - `exit_policy: optional<text>`
23
+ - `memo: optional<text>`
24
+ - `membership: optional<block>`
25
+
26
+ ## Decision ports
27
+
28
+ None.
29
+
30
+ ## Actions and clauses
31
+
32
+ | Action | Clauses lowered |
33
+ | ---------- | ------------------------------------------------- |
34
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
35
+ | `cancel` | `agent description`, `moves`, `steps`, `summary` |
36
+ | `activate` | `agent description`, `moves`, `steps`, `summary` |
37
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
38
+ | `close` | `agent description`, `moves`, `steps`, `summary` |
39
+ | `create` | `agent description`, `examples`, `moves`, `steps` |
40
+ | `activate` | `due`, `examples`, `moves`, `steps` |
41
+ | `disband` | `agent description`, `examples`, `moves`, `steps` |
42
+ | `close` | `agent description`, `examples`, `moves`, `steps` |
@@ -0,0 +1,51 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # scheduled
4
+
5
+ Source: [`std/settlements/scheduled.hsx`](../../../std/settlements/scheduled.hsx)
6
+
7
+ ## Export
8
+
9
+ `scheduled<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `payer: party`
14
+ - `payee: party`
15
+ - `amount: money<C>`
16
+ - `count: optional<integer>`
17
+ - `every: text`
18
+ - `first_due: date`
19
+ - `mode: optional<text>`
20
+ - `debtor: optional<party>`
21
+ - `advance_to: optional<party>`
22
+ - `until: optional<condition>`
23
+ - `month_end: optional<text>`
24
+ - `period_liability: optional<text>`
25
+ - `termination_drain: optional<text>`
26
+ - `mandate: optional<condition>`
27
+ - `derived_amount: optional<unknown>`
28
+
29
+ ## Decision ports
30
+
31
+ - `until`
32
+ - `mandate`
33
+
34
+ ## Actions and clauses
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` |
@@ -0,0 +1,46 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # security_deposit
4
+
5
+ Source: [`std/settlements/security_deposit.hsx`](../../../std/settlements/security_deposit.hsx)
6
+
7
+ ## Export
8
+
9
+ `security_deposit<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `payer: party`
14
+ - `holder: party`
15
+ - `amount: money<C>`
16
+ - `claim: optional<condition>`
17
+ - `return: optional<condition>`
18
+ - `claim_amount: optional<block>`
19
+ - `deadline: optional<date>`
20
+ - `claim_to: optional<party>`
21
+ - `return_to: optional<party>`
22
+ - `memo: optional<text>`
23
+ - `claim_input: optional<block>`
24
+ - `claim_capture: optional<block>`
25
+ - `fund_failure_point: optional<text>`
26
+ - `id_prefix_override: optional<text>`
27
+
28
+ ## Decision ports
29
+
30
+ - `claim`
31
+ - `return`
32
+
33
+ ## Actions and clauses
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` |
@@ -0,0 +1,42 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # settlement_batch
4
+
5
+ Source: [`std/settlements/settlement_batch.hsx`](../../../std/settlements/settlement_batch.hsx)
6
+
7
+ ## Export
8
+
9
+ `settlement_batch<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `settlement_account: party`
14
+ - `source_capture_refs: text`
15
+ - `fee_entries: text`
16
+ - `external_reversal_offsets: text`
17
+ - `close_trigger: date`
18
+ - `payout_destination: party`
19
+ - `negative_position: text`
20
+ - `payout_acknowledgement: condition`
21
+ - `payout_beneficiary_ref: text`
22
+
23
+ ## Decision ports
24
+
25
+ - `payout_acknowledgement`
26
+
27
+ ## Actions and clauses
28
+
29
+ | Action | Clauses lowered |
30
+ | ------------------------ | ------------------------------------------------------------------------------------------------- |
31
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
32
+ | `close` | `due`, `moves`, `steps`, `summary` |
33
+ | `calculate` | `agent description`, `computes signed_sum`, `moves`, `steps`, `summary` |
34
+ | `approve` | `agent description`, `moves`, `steps`, `summary` |
35
+ | `instruct` | `agent description`, `moves`, `payout`, `steps`, `summary` |
36
+ | `payout_acknowledgement` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
37
+ | `reconcile` | `due`, `moves`, `reconcile`, `steps`, `summary` |
38
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
39
+ | `accrue` | `agent description`, `moves`, `steps`, `summary` |
40
+ | `create` | `agent description`, `moves`, `steps`, `summary` |
41
+ | `adjust` | `agent description`, `moves`, `steps`, `summary` |
42
+ | `correct` | `agent description`, `moves`, `steps`, `summary` |
@@ -0,0 +1,46 @@
1
+ <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
+
3
+ # swap
4
+
5
+ Source: [`std/settlements/swap.hsx`](../../../std/settlements/swap.hsx)
6
+
7
+ ## Export
8
+
9
+ `swap<C>`
10
+
11
+ ## Parameters
12
+
13
+ - `between: list<party>`
14
+ - `amounts: block`
15
+ - `fees: block`
16
+ - `release: condition`
17
+ - `dispute: condition`
18
+ - `side_names: optional<block>`
19
+ - `lifecycle_state_order: optional<list<text>>`
20
+ - `action_bindings: optional<block>`
21
+ - `parked_states: optional<block>`
22
+ - `fixed_prefix: optional<text>`
23
+
24
+ ## Decision ports
25
+
26
+ - `release`
27
+ - `dispute`
28
+
29
+ ## Actions and clauses
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` |