@hyperscale0/hsx 1.0.0-rc.1 → 1.0.123

package/docs/reference/grammar.md

@@ -1,39 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# Grammar vocabulary
-
-The parser is hand-written. This page records the exported lexer vocabulary, the UDL clause vocabulary it binds, and the current standard-library module names.
-
-## Keywords
-
-`action`, `as`, `asset`, `commit`, `const`, `expect`, `expose`, `expires`, `export`, `from`, `import`, `instrument`, `module`, `party`, `port`, `program`, `quote`, `rate`, `reconcile`, `settlement`, `subject`, `type`, `use`
-
-## Punctuation
-
-`{`, `}`, `(`, `)`, `[`, `]`, `:`, `,`, `;`, `=`, `|`, `.`, `<`, `>`, `?` and `->`
-
-## Typed clause spellings
-
-`agent description`, `capture input`, `commit`, `quote`, `decided amount`, `deadline`, `decision`, `computes distribute`, `description`, `due`, `earnable`, `event name`, `examples`, `input`, `moves`, `payout`, `port`, `principal`, `public action`, `reconcile`, `computes remainder`, `requires aggregate`, `requires checks`, `requires drained`, `requires exposure`, `requires refs`, `sandbox failure point`, `sets at`, `computes signed_sum`, `steps`, `summary`, `updates`, `notify`, `agent description`, `aggregate invariants`, `caller parked states`, `description`, `dials`, `distinct parties`, `computes derived`, `computes fees`, `id prefix`, `nav`, `partitions`, `subject`, `summary`, `surface visibility`, `template id`, `title`, `update`
-
-## Standard-library modules
-
-- `advance`
-- `cancellable_booking`
-- `captured_payment`
-- `conditional_disbursement`
-- `credit_facility`
-- `held_payment`
-- `instant_transfer`
-- `metered`
-- `pooled_split`
-- `premium_forward`
-- `reconciled_payout`
-- `recurring_collection`
-- `rotating_pool`
-- `scheduled`
-- `security_deposit`
-- `settlement_batch`
-- `swap`
-- `threshold_pool`
-- `weighted_distribution`

package/docs/reference/std/advance.md

@@ -1,35 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# advance
-
-Source: [`std/settlements/advance.hsx`](../../../std/settlements/advance.hsx)
-
-## Export
-
-`advance<C>`
-
-## Parameters
-
-- `funder: party`
-- `to: party`
-- `amount: money<C>`
-- `fee: optional<percent>`
-- `count: optional<integer>`
-- `every: optional<text>`
-- `first_due: optional<date>`
-- `against: optional<ref>`
-
-## Decision ports
-
-None.
-
-## Actions and clauses
-
-| Action                | Clauses lowered                                  |
-| --------------------- | ------------------------------------------------ |
-| `create`              | `agent description`, `moves`, `steps`, `summary` |
-| `disburse`            | `agent description`, `moves`, `steps`, `summary` |
-| `settle`              | `agent description`, `moves`, `steps`, `summary` |
-| `create`              | `agent description`, `moves`, `steps`, `summary` |
-| `disburse`            | `agent description`, `moves`, `steps`, `summary` |
-| `collect_repayment_1` | `due`, `moves`, `steps`, `summary`               |

package/docs/reference/std/cancellable_booking.md

@@ -1,35 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# cancellable_booking
-
-Source: [`std/settlements/cancellable_booking.hsx`](../../../std/settlements/cancellable_booking.hsx)
-
-## Export
-
-`cancellable_booking<C>`
-
-## Parameters
-
-- `guest: party`
-- `host: party`
-- `amount: money<C>`
-- `starts_at: date`
-- `late_penalty_bps: integer`
-- `late_within: text`
-- `early_penalty_bps: integer`
-- `offer_life: text`
-
-## Decision ports
-
-None.
-
-## Actions and clauses
-
-| Action     | Clauses lowered                                            |
-| ---------- | ---------------------------------------------------------- |
-| `create`   | `agent description`, `moves`, `steps`, `summary`           |
-| `take`     | `agent description`, `moves`, `steps`, `summary`           |
-| `complete` | `due`, `moves`, `steps`, `summary`                         |
-| `cancel`   | `agent description`, `moves`, `quote`, `steps`, `summary`  |
-| `confirm`  | `agent description`, `commit`, `moves`, `steps`, `summary` |
-| `retain`   | `agent description`, `moves`, `steps`, `summary`           |

package/docs/reference/std/captured_payment.md

@@ -1,43 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# captured_payment
-
-Source: [`std/settlements/captured_payment.hsx`](../../../std/settlements/captured_payment.hsx)
-
-## Export
-
-`captured_payment<C>`
-
-## Parameters
-
-- `payer: party`
-- `payee: party`
-- `amount: money<C>`
-- `reserve_until: date`
-- `correction: condition`
-- `external_reversal: condition`
-- `capture_mode: text`
-- `correction_mode: text`
-- `negative_position: text`
-- `timeout: text`
-- `derived_amount: optional<block>`
-
-## Decision ports
-
-- `correction`
-- `external_reversal`
-
-## Actions and clauses
-
-| Action             | Clauses lowered                                                                              |
-| ------------------ | -------------------------------------------------------------------------------------------- |
-| `create`           | `agent description`, `moves`, `steps`, `summary`                                             |
-| `authorize`        | `agent description`, `moves`, `steps`, `summary`                                             |
-| `capture`          | `agent description`, `deadline`, `description`, `input`, `moves`, `steps`, `summary`         |
-| `capture_more`     | `agent description`, `deadline`, `description`, `input`, `moves`, `steps`, `summary`         |
-| `settle`           | `agent description`, `deadline`, `moves`, `steps`, `summary`                                 |
-| `void`             | `agent description`, `moves`, `steps`, `summary`                                             |
-| `expire`           | `due`, `moves`, `steps`, `summary`                                                           |
-| `settle_on_expiry` | `due`, `moves`, `steps`, `summary`                                                           |
-| `correction_name`  | `agent description`, `moves`, `port`, `steps`, `summary`                                     |
-| `reversal_name`    | `agent description`, `deadline`, `description`, `input`, `moves`, `port`, `steps`, `summary` |

package/docs/reference/std/conditional_disbursement.md

@@ -1,33 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# conditional_disbursement
-
-Source: [`std/settlements/conditional_disbursement.hsx`](../../../std/settlements/conditional_disbursement.hsx)
-
-## Export
-
-`conditional_disbursement<C>`
-
-## Parameters
-
-- `source: party`
-- `destination: party`
-- `cap: money<C>`
-- `amount: money<C>`
-- `decision: condition`
-- `reopen_policy: text`
-- `recovery_policy: text`
-
-## Decision ports
-
-- `decision`
-
-## Actions and clauses
-
-| Action    | Clauses lowered                                                                                   |
-| --------- | ------------------------------------------------------------------------------------------------- |
-| `create`  | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `deny`    | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
-| `create`  | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `approve` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
-| `pay`     | `agent description`, `moves`, `steps`, `summary`                                                  |

package/docs/reference/std/credit_facility.md

@@ -1,35 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# credit_facility
-
-Source: [`std/settlements/credit_facility.hsx`](../../../std/settlements/credit_facility.hsx)
-
-## Export
-
-`credit_facility<C>`
-
-## Parameters
-
-- `lender: party`
-- `borrower: party`
-- `draw_destination: party`
-- `limit: money<C>`
-- `expires_at: date`
-- `obligation: ref`
-- `availability_policy: text`
-- `expiry_policy: text`
-- `close_policy: text`
-
-## Decision ports
-
-None.
-
-## Actions and clauses
-
-| Action    | Clauses lowered                                  |
-| --------- | ------------------------------------------------ |
-| `create`  | `agent description`, `moves`, `steps`, `summary` |
-| `freeze`  | `due`, `moves`, `steps`, `summary`               |
-| `close`   | `agent description`, `moves`, `steps`, `summary` |
-| `create`  | `agent description`, `moves`, `steps`, `summary` |
-| `resolve` | `agent description`, `moves`, `steps`, `summary` |

package/docs/reference/std/held_payment.md

@@ -1,64 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# held_payment
-
-Source: [`std/settlements/held_payment.hsx`](../../../std/settlements/held_payment.hsx)
-
-## Export
-
-`held_payment<C>`
-
-## Parameters
-
-- `payer: party`
-- `payee: party`
-- `amount: money<C>`
-- `release: condition`
-- `fees: optional<block>`
-- `on_cancel: optional<block>`
-- `derived_amount: optional<block>`
-- `release_to: optional<party>`
-- `whole_amount: optional<block>`
-- `release_action: optional<text>`
-- `whole_fee: optional<money<C>>`
-- `reference: optional<text>`
-- `upstream: optional<ref>`
-- `id_prefix_override: optional<text>`
-
-## Decision ports
-
-- `release`
-
-## Actions and clauses
-
-| Action                | Clauses lowered                                                                               |
-| --------------------- | --------------------------------------------------------------------------------------------- |
-| `fund_piece_2`        | `agent description`, `moves`, `steps`, `summary`                                              |
-| `fund_piece_3`        | `agent description`, `moves`, `steps`, `summary`                                              |
-| `collect_service_fee` | `agent description`, `moves`, `steps`, `summary`                                              |
-| `release_piece_2`     | `agent description`, `moves`, `steps`, `summary`                                              |
-| `release_piece_3`     | `agent description`, `moves`, `steps`, `summary`                                              |
-| `refund_piece_2`      | `agent description`, `moves`, `steps`, `summary`                                              |
-| `refund_piece_3`      | `agent description`, `moves`, `steps`, `summary`                                              |
-| `unfund_piece_1`      | `agent description`, `moves`, `steps`, `summary`                                              |
-| `unfund_piece_2`      | `agent description`, `moves`, `steps`, `summary`                                              |
-| `unfund_piece_3`      | `agent description`, `moves`, `steps`, `summary`                                              |
-| `create`              | `agent description`, `moves`, `steps`, `summary`                                              |
-| `fund_piece_1`        | `agent description`, `moves`, `steps`, `summary`                                              |
-| `release_name`        | `agent description`, `deadline`, `description`, `input`, `moves`, `port`, `steps`, `summary`  |
-| `release_on_deadline` | `due`, `moves`, `steps`, `summary`                                                            |
-| `cancel`              | `agent description`, `deadline`, `moves`, `steps`, `summary`                                  |
-| `fund_piece_2`        | `agent description`, `moves`, `steps`, `summary`                                              |
-| `release_piece_2`     | `agent description`, `moves`, `steps`, `summary`                                              |
-| `unfund_piece_1`      | `agent description`, `moves`, `steps`, `summary`                                              |
-| `fund_piece_2`        | `agent description`, `moves`, `steps`, `summary`                                              |
-| `release_piece_2`     | `agent description`, `moves`, `steps`, `summary`                                              |
-| `refund_piece_2`      | `agent description`, `moves`, `steps`, `summary`                                              |
-| `unfund_piece_1`      | `agent description`, `moves`, `steps`, `summary`                                              |
-| `abandon`             | `agent description`, `moves`, `steps`, `summary`                                              |
-| `create`              | `agent description`, `moves`, `steps`, `summary`                                              |
-| `fund`                | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary`                     |
-| `release_action`      | `agent description`, `deadline`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
-| `release_on_deadline` | `due`, `event name`, `moves`, `steps`, `summary`                                              |
-| `cancel`              | `agent description`, `deadline`, `event name`, `moves`, `steps`, `summary`                    |
-| `abandon`             | `agent description`, `moves`, `steps`, `summary`                                              |

package/docs/reference/std/instant_transfer.md

@@ -1,30 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# instant_transfer
-
-Source: [`std/settlements/instant_transfer.hsx`](../../../std/settlements/instant_transfer.hsx)
-
-## Export
-
-`instant_transfer<C>`
-
-## Parameters
-
-- `payer: party`
-- `payee: party`
-- `amount: money<C>`
-- `fees: optional<block>`
-- `derived_amount: optional<block>`
-
-## Decision ports
-
-None.
-
-## Actions and clauses
-
-| Action                | Clauses lowered                                  |
-| --------------------- | ------------------------------------------------ |
-| `create`              | `agent description`, `moves`, `steps`, `summary` |
-| `pay_piece_1`         | `agent description`, `moves`, `steps`, `summary` |
-| `pay_piece_2`         | `agent description`, `moves`, `steps`, `summary` |
-| `collect_service_fee` | `agent description`, `moves`, `steps`, `summary` |

package/docs/reference/std/metered.md

@@ -1,27 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# metered
-
-Source: [`std/settlements/metered.hsx`](../../../std/settlements/metered.hsx)
-
-## Export
-
-`metered`
-
-## Parameters
-
-- `payer: party`
-- `payee: party`
-- `close_by: date`
-- `rates: unknown`
-
-## Decision ports
-
-None.
-
-## Actions and clauses
-
-| Action         | Clauses lowered                         |
-| -------------- | --------------------------------------- |
-| `create`       | `agent description`, `steps`, `summary` |
-| `close_period` | `due`, `steps`, `summary`               |

package/docs/reference/std/pooled_split.md

@@ -1,26 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# pooled_split
-
-Source: [`std/settlements/pooled_split.hsx`](../../../std/settlements/pooled_split.hsx)
-
-## Export
-
-`pooled_split<C>`
-
-## Parameters
-
-- `payer: party`
-- `amount: money<C>`
-- `payout_due: date`
-- `split: block`
-
-## Decision ports
-
-None.
-
-## Actions and clauses
-
-| Action   | Clauses lowered                                  |
-| -------- | ------------------------------------------------ |
-| `create` | `agent description`, `moves`, `steps`, `summary` |

package/docs/reference/std/premium_forward.md

@@ -1,39 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# premium_forward
-
-Source: [`std/settlements/premium_forward.hsx`](../../../std/settlements/premium_forward.hsx)
-
-## Export
-
-`premium_forward<C>`
-
-## Parameters
-
-- `payer: party`
-- `carrier: party`
-- `amount: money<C>`
-- `bind: condition`
-- `commission: percent`
-- `policy_ref: optional<text>`
-- `renewal_due: optional<date>`
-- `endorsement: optional<condition>`
-
-## Decision ports
-
-- `bind`
-- `endorsement`
-
-## Actions and clauses
-
-| Action            | Clauses lowered                                                                          |
-| ----------------- | ---------------------------------------------------------------------------------------- |
-| `create`          | `agent description`, `steps`, `summary`                                                  |
-| `fund_piece_1`    | `agent description`, `moves`, `steps`, `summary`                                         |
-| `fund_piece_2`    | `agent description`, `moves`, `steps`, `summary`                                         |
-| `bind`            | `agent description`, `description`, `input`, `moves`, `port`, `steps`, `summary`         |
-| `forward_piece_2` | `agent description`, `moves`, `steps`, `summary`                                         |
-| `unfund_piece_1`  | `agent description`, `moves`, `steps`, `summary`                                         |
-| `abandon`         | `agent description`, `steps`, `summary`                                                  |
-| `endorsement`     | `agent description`, `capture input`, `description`, `input`, `port`, `steps`, `summary` |
-| `lapse`           | `due`, `steps`, `summary`                                                                |

package/docs/reference/std/reconciled_payout.md

@@ -1,33 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# reconciled_payout
-
-Source: [`std/settlements/reconciled_payout.hsx`](../../../std/settlements/reconciled_payout.hsx)
-
-## Export
-
-`reconciled_payout<C>`
-
-## Parameters
-
-- `payer: party`
-- `beneficiary: party`
-- `amount: money<C>`
-- `beneficiary_ref: text`
-- `settle_by: date`
-- `matched_within: integer`
-- `matched_ceiling: integer`
-
-## Decision ports
-
-None.
-
-## Actions and clauses
-
-| Action     | Clauses lowered                                            |
-| ---------- | ---------------------------------------------------------- |
-| `create`   | `agent description`, `moves`, `steps`, `summary`           |
-| `instruct` | `agent description`, `moves`, `payout`, `steps`, `summary` |
-| `settle`   | `due`, `moves`, `reconcile`, `steps`, `summary`            |
-| `create`   | `agent description`, `moves`, `steps`, `summary`           |
-| `carry`    | `agent description`, `moves`, `steps`, `summary`           |

package/docs/reference/std/recurring_collection.md

@@ -1,25 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# recurring_collection
-
-Source: [`std/settlements/recurring_collection.hsx`](../../../std/settlements/recurring_collection.hsx)
-
-## Export
-
-`recurring_collection`
-
-## Parameters
-
-- `marker: optional<text>`
-
-## Decision ports
-
-None.
-
-## Actions and clauses
-
-| Action    | Clauses lowered                         |
-| --------- | --------------------------------------- |
-| `create`  | `agent description`, `steps`, `summary` |
-| `collect` | `agent description`, `steps`, `summary` |
-| `end`     | `agent description`, `steps`, `summary` |

package/docs/reference/std/rotating_pool.md

@@ -1,42 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# rotating_pool
-
-Source: [`std/settlements/rotating_pool.hsx`](../../../std/settlements/rotating_pool.hsx)
-
-## Export
-
-`rotating_pool<C>`
-
-## Parameters
-
-- `members: optional<list<party>>`
-- `contribution: money<C>`
-- `count: integer`
-- `every: optional<text>`
-- `first_due: date`
-- `payout_order: optional<list<party>>`
-- `default_policy: optional<text>`
-- `guarantee_policy: optional<text>`
-- `guarantor: optional<party>`
-- `exit_policy: optional<text>`
-- `memo: optional<text>`
-- `membership: optional<block>`
-
-## Decision ports
-
-None.
-
-## Actions and clauses
-
-| Action     | Clauses lowered                                   |
-| ---------- | ------------------------------------------------- |
-| `create`   | `agent description`, `moves`, `steps`, `summary`  |
-| `cancel`   | `agent description`, `moves`, `steps`, `summary`  |
-| `activate` | `agent description`, `moves`, `steps`, `summary`  |
-| `create`   | `agent description`, `moves`, `steps`, `summary`  |
-| `close`    | `agent description`, `moves`, `steps`, `summary`  |
-| `create`   | `agent description`, `examples`, `moves`, `steps` |
-| `activate` | `due`, `examples`, `moves`, `steps`               |
-| `disband`  | `agent description`, `examples`, `moves`, `steps` |
-| `close`    | `agent description`, `examples`, `moves`, `steps` |

package/docs/reference/std/scheduled.md

@@ -1,51 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# scheduled
-
-Source: [`std/settlements/scheduled.hsx`](../../../std/settlements/scheduled.hsx)
-
-## Export
-
-`scheduled<C>`
-
-## Parameters
-
-- `payer: party`
-- `payee: party`
-- `amount: money<C>`
-- `count: optional<integer>`
-- `every: text`
-- `first_due: date`
-- `mode: optional<text>`
-- `debtor: optional<party>`
-- `advance_to: optional<party>`
-- `until: optional<condition>`
-- `month_end: optional<text>`
-- `period_liability: optional<text>`
-- `termination_drain: optional<text>`
-- `mandate: optional<condition>`
-- `derived_amount: optional<unknown>`
-
-## Decision ports
-
-- `until`
-- `mandate`
-
-## Actions and clauses
-
-| Action              | Clauses lowered                                                                                   |
-| ------------------- | ------------------------------------------------------------------------------------------------- |
-| `create`            | `agent description`, `steps`, `summary`                                                           |
-| `create`            | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `approve`           | `agent description`, `steps`, `summary`                                                           |
-| `advance`           | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `delinquent_action` | `due`, `sets at`, `steps`, `summary`                                                              |
-| `complete`          | `due`, `steps`, `summary`                                                                         |
-| `write_off`         | `agent description`, `steps`, `summary`                                                           |
-| `create`            | `agent description`, `steps`, `summary`                                                           |
-| `repay`             | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
-| `refund`            | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `create`            | `agent description`, `steps`, `summary`                                                           |
-| `open_period`       | `due`, `steps`, `summary`                                                                         |
-| `collect_period`    | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
-| `until`             | `agent description`, `capture input`, `description`, `input`, `port`, `steps`, `summary`          |

package/docs/reference/std/security_deposit.md

@@ -1,46 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# security_deposit
-
-Source: [`std/settlements/security_deposit.hsx`](../../../std/settlements/security_deposit.hsx)
-
-## Export
-
-`security_deposit<C>`
-
-## Parameters
-
-- `payer: party`
-- `holder: party`
-- `amount: money<C>`
-- `claim: optional<condition>`
-- `return: optional<condition>`
-- `claim_amount: optional<block>`
-- `deadline: optional<date>`
-- `claim_to: optional<party>`
-- `return_to: optional<party>`
-- `memo: optional<text>`
-- `claim_input: optional<block>`
-- `claim_capture: optional<block>`
-- `fund_failure_point: optional<text>`
-- `id_prefix_override: optional<text>`
-
-## Decision ports
-
-- `claim`
-- `return`
-
-## Actions and clauses
-
-| Action          | Clauses lowered                                                                                                  |
-| --------------- | ---------------------------------------------------------------------------------------------------------------- |
-| `create`        | `agent description`, `moves`, `steps`, `summary`                                                                 |
-| `place_deposit` | `agent description`, `moves`, `steps`, `summary`                                                                 |
-| `claim_name`    | `agent description`, `description`, `input`, `moves`, `port`, `steps`, `summary`                                 |
-| `return_name`   | `agent description`, `moves`, `steps`, `summary`                                                                 |
-| `create`        | `agent description`, `deadline`, `moves`, `steps`, `summary`                                                     |
-| `fund`          | `agent description`, `deadline`, `moves`, `sandbox failure point`, `steps`, `summary`                            |
-| `claim`         | `agent description`, `capture input`, `deadline`, `decided amount`, `input`, `moves`, `port`, `steps`, `summary` |
-| `return`        | `agent description`, `deadline`, `moves`, `port`, `steps`, `summary`                                             |
-| `expire`        | `due`, `moves`, `steps`, `summary`                                                                               |
-| `cancel`        | `agent description`, `moves`, `steps`, `summary`                                                                 |

package/docs/reference/std/settlement_batch.md

@@ -1,42 +0,0 @@
-<!-- Generated by scripts/docs/build.ts for HSX 1.0.0-rc.1. Do not edit. -->
-
-# settlement_batch
-
-Source: [`std/settlements/settlement_batch.hsx`](../../../std/settlements/settlement_batch.hsx)
-
-## Export
-
-`settlement_batch<C>`
-
-## Parameters
-
-- `settlement_account: party`
-- `source_capture_refs: text`
-- `fee_entries: text`
-- `external_reversal_offsets: text`
-- `close_trigger: date`
-- `payout_destination: party`
-- `negative_position: text`
-- `payout_acknowledgement: condition`
-- `payout_beneficiary_ref: text`
-
-## Decision ports
-
-- `payout_acknowledgement`
-
-## Actions and clauses
-
-| Action                   | Clauses lowered                                                                                   |
-| ------------------------ | ------------------------------------------------------------------------------------------------- |
-| `create`                 | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `close`                  | `due`, `moves`, `steps`, `summary`                                                                |
-| `calculate`              | `agent description`, `computes signed_sum`, `moves`, `steps`, `summary`                           |
-| `approve`                | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `instruct`               | `agent description`, `moves`, `payout`, `steps`, `summary`                                        |
-| `payout_acknowledgement` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
-| `reconcile`              | `due`, `moves`, `reconcile`, `steps`, `summary`                                                   |
-| `create`                 | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `accrue`                 | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `create`                 | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `adjust`                 | `agent description`, `moves`, `steps`, `summary`                                                  |
-| `correct`                | `agent description`, `moves`, `steps`, `summary`                                                  |