@hyperscale0/hsx 2.4.1 → 3.0.0

package/examples/instant_transfer/instant_transfer.udl

@@ -1,376 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "create",
-        "pay_piece_1",
-        "pay_piece_2",
-        "collect_service_fee"
-      ],
-      "actions": {
-        "collect_service_fee": {
-          "agentDescription": "Finish the payment and collect the service fee the customer owes on top of the amount. Both pieces must already be paid. When the product charges no payer fee this only closes the payment out.",
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "moves[0]"
-              }
-            ]
-          },
-          "moves": [
-            {
-              "bind": {
-                "amount": {
-                  "from": "instance",
-                  "path": "fields.checkoutFee"
-                },
-                "currency": {
-                  "from": "const",
-                  "value": "SAR"
-                },
-                "destinationAccountId": {
-                  "from": "instance",
-                  "path": "fields.platformAccountId"
-                },
-                "metadata.instrumentId": {
-                  "from": "const",
-                  "value": "transfer"
-                },
-                "metadata.instrumentInstanceId": {
-                  "from": "instance",
-                  "path": "instrumentInstanceId"
-                },
-                "metadata.phase": {
-                  "from": "const",
-                  "value": "collect_service_fee"
-                },
-                "productId": {
-                  "from": "instance",
-                  "path": "productId"
-                },
-                "sourceAccountId": {
-                  "from": "instance",
-                  "path": "fields.customerAccountId"
-                }
-              },
-              "capture": {
-                "collectServiceFeeTransferTransferId": "transferId"
-              },
-              "key": "transfer",
-              "operation": "internal_transfer.create"
-            }
-          ],
-          "publicAction": "collectServiceFeeTransfer",
-          "steps": [],
-          "summary": "Collect the payer-side service fee"
-        },
-        "create": {
-          "agentDescription": "Open the payment row before anything moves. The caller supplies the transferAmount, the currency, and both party accounts. Fee and derived pieces are computed from the transferAmount, callers never supply them. Call pay piece 1 to move the money.",
-          "moves": [],
-          "publicAction": "createTransfer",
-          "steps": [],
-          "summary": "Create a transfer payment"
-        },
-        "pay_piece_1": {
-          "agentDescription": "Move the first piece from the customer to the merchant. The payment must be created. This moves the whole amount unless the product carves a payee fee, in which case it moves the net share and pay piece 2 takes the fee.",
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "moves[0]"
-              }
-            ]
-          },
-          "moves": [
-            {
-              "bind": {
-                "amount": {
-                  "from": "instance",
-                  "path": "fields.netOfCarvedFeeAmount"
-                },
-                "currency": {
-                  "from": "const",
-                  "value": "SAR"
-                },
-                "destinationAccountId": {
-                  "from": "instance",
-                  "path": "fields.merchantAccountId"
-                },
-                "metadata.instrumentId": {
-                  "from": "const",
-                  "value": "transfer"
-                },
-                "metadata.instrumentInstanceId": {
-                  "from": "instance",
-                  "path": "instrumentInstanceId"
-                },
-                "metadata.phase": {
-                  "from": "const",
-                  "value": "pay_piece_1"
-                },
-                "productId": {
-                  "from": "instance",
-                  "path": "productId"
-                },
-                "sourceAccountId": {
-                  "from": "instance",
-                  "path": "fields.customerAccountId"
-                }
-              },
-              "capture": {
-                "payPiece1TransferTransferId": "transferId"
-              },
-              "key": "transfer",
-              "operation": "internal_transfer.create"
-            }
-          ],
-          "publicAction": "payPiece1Transfer",
-          "sandboxFailurePoint": "funding",
-          "steps": [],
-          "summary": "Pay piece 1 of the amount through"
-        },
-        "pay_piece_2": {
-          "agentDescription": "Move the carved platform fee out of the amount. Call this after pay piece 1. When the product carves no merchant fee this only steps the payment forward and moves nothing.",
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "moves[0]"
-              }
-            ]
-          },
-          "moves": [
-            {
-              "bind": {
-                "amount": {
-                  "from": "instance",
-                  "path": "fields.carvedFeeAmount"
-                },
-                "currency": {
-                  "from": "const",
-                  "value": "SAR"
-                },
-                "destinationAccountId": {
-                  "from": "instance",
-                  "path": "fields.platformAccountId"
-                },
-                "metadata.instrumentId": {
-                  "from": "const",
-                  "value": "transfer"
-                },
-                "metadata.instrumentInstanceId": {
-                  "from": "instance",
-                  "path": "instrumentInstanceId"
-                },
-                "metadata.phase": {
-                  "from": "const",
-                  "value": "pay_piece_2"
-                },
-                "productId": {
-                  "from": "instance",
-                  "path": "productId"
-                },
-                "sourceAccountId": {
-                  "from": "instance",
-                  "path": "fields.customerAccountId"
-                }
-              },
-              "capture": {
-                "payPiece2TransferTransferId": "transferId"
-              },
-              "key": "transfer",
-              "operation": "internal_transfer.create"
-            }
-          ],
-          "publicAction": "payPiece2Transfer",
-          "steps": [],
-          "summary": "Pay piece 2 of the amount through"
-        }
-      },
-      "agentDescription": "Reach for instant transfer when the customer pays the merchant straight through with no custody step. The money leaves and lands in one call. Pick deposit when the money must be held first, and captured payment when the payee takes it in slices.",
-      "description": "Instant transfer: the customer pays transferAmount straight through to the merchant, no custody",
-      "feeRules": [
-        {
-          "amountField": "checkoutFee",
-          "baseField": "transferAmount",
-          "bearerField": "customerAccountId",
-          "position": "on_top",
-          "rule": {
-            "currencyField": "currency",
-            "field": "checkoutFee",
-            "kind": "exact"
-          }
-        },
-        {
-          "amountField": "carvedFeeAmount",
-          "baseField": "transferAmount",
-          "bearerField": "merchantAccountId",
-          "position": "carved",
-          "rule": {
-            "kind": "tiered",
-            "tiers": [
-              {
-                "fromInclusive": "0",
-                "rule": {
-                  "bps": 100,
-                  "kind": "bps"
-                },
-                "toExclusive": "10000"
-              },
-              {
-                "fromInclusive": "10000",
-                "rule": {
-                  "currencyField": "currency",
-                  "field": "highValueFee",
-                  "kind": "exact"
-                }
-              }
-            ]
-          }
-        }
-      ],
-      "fields": {
-        "carvedFeeAmount": {
-          "description": "The carved platform fee selected from transferAmount",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        },
-        "checkoutFee": {
-          "description": "Immutable exact customer fee in SAR minor units",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        },
-        "currency": {
-          "description": "ISO 4217 currency code",
-          "maxLength": 3,
-          "minLength": 3,
-          "pattern": "^[A-Z]{3}$",
-          "type": "string"
-        },
-        "customerAccountId": {
-          "description": "The customer account",
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string",
-          "x-hyperscale-reference-filter": {
-            "column": "role",
-            "values": [
-              "customer_balance"
-            ]
-          }
-        },
-        "highValueFee": {
-          "description": "Immutable exact merchant fee in SAR minor units",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        },
-        "merchantAccountId": {
-          "description": "The merchant account",
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string",
-          "x-hyperscale-reference-filter": {
-            "column": "role",
-            "values": [
-              "customer_balance"
-            ]
-          }
-        },
-        "netOfCarvedFeeAmount": {
-          "description": "The remainder of transferAmount after the carved platform fee",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        },
-        "platformAccountId": {
-          "description": "The product fee collection account",
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string",
-          "x-hyperscale-fee-collection-port": true,
-          "x-hyperscale-reference-filter": {
-            "column": "role",
-            "values": [
-              "customer_balance",
-              "product_revenue"
-            ]
-          }
-        },
-        "transferAmount": {
-          "description": "The gross amount in SAR minor units; the piece fields below partition it exactly",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        }
-      },
-      "id": "transfer",
-      "idPrefix": "tran",
-      "lifecycle": {
-        "initial": "created",
-        "states": [
-          "created",
-          "paying_1",
-          "paying_2",
-          "paid"
-        ],
-        "transitions": {
-          "collect_service_fee": {
-            "from": [
-              "paying_2"
-            ],
-            "to": "paid"
-          },
-          "pay_piece_1": {
-            "from": [
-              "created"
-            ],
-            "to": "paying_1"
-          },
-          "pay_piece_2": {
-            "from": [
-              "paying_1"
-            ],
-            "to": "paying_2"
-          }
-        }
-      },
-      "parties": {
-        "beneficiary": "merchantAccountId",
-        "payer": "customerAccountId"
-      },
-      "partitions": [
-        {
-          "pieceFields": [
-            "netOfCarvedFeeAmount",
-            "carvedFeeAmount"
-          ],
-          "totalField": "transferAmount"
-        }
-      ],
-      "required": [
-        "customerAccountId",
-        "merchantAccountId",
-        "platformAccountId",
-        "transferAmount",
-        "netOfCarvedFeeAmount",
-        "checkoutFee",
-        "highValueFee",
-        "currency"
-      ],
-      "summary": "Instant payment from customer to merchant",
-      "templateBinding": {
-        "id": "instant_transfer",
-        "parameters": {
-          "derivedAmount": false
-        }
-      },
-      "title": "Transfer"
-    }
-  ],
-  "product": "instant_transfer_example",
-  "subjects": [],
-  "title": "Instant transfer example",
-  "udl": 1,
-  "version": 1
-}

package/examples/metered/README.md

@@ -1,3 +0,0 @@
-# metered
-
-This example applies the `metered` standard-library module. Its sibling UDL file pins the canonical compiler output byte for byte. The company and parties are invented.

package/examples/metered/metered.hsx

@@ -1,13 +0,0 @@
-program metered_example "Metered example"
-import { metered } from "std/money_flows"
-party customer: business
-party provider: business
-settlement usage = metered {
-  payer: customer
-  payee: provider
-  close_by: periodEnd
-  rates {
-    api_call: callRate: money(SAR)
-    storage_gib: storageRate: money(SAR)
-  }
-}

package/examples/metered/metered.udl

@@ -1,253 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "create",
-        "charge_api_call",
-        "charge_storage_gib",
-        "close_period"
-      ],
-      "actions": {
-        "charge_api_call": {
-          "agentDescription": "Charge one metered api call at the committed price. The period must still be open, so charge before periodEnd. The transfer posts from the customer to the provider at once and there is no reversal action.",
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "moves[0]"
-              }
-            ]
-          },
-          "moves": [
-            {
-              "bind": {
-                "amount": {
-                  "from": "instance",
-                  "path": "fields.callRate"
-                },
-                "currency": {
-                  "from": "const",
-                  "value": "SAR"
-                },
-                "destinationAccountId": {
-                  "from": "instance",
-                  "path": "fields.providerAccountId"
-                },
-                "metadata.instrumentId": {
-                  "from": "const",
-                  "value": "usage"
-                },
-                "metadata.instrumentInstanceId": {
-                  "from": "instance",
-                  "path": "instrumentInstanceId"
-                },
-                "metadata.phase": {
-                  "from": "const",
-                  "value": "charge_api_call"
-                },
-                "productId": {
-                  "from": "instance",
-                  "path": "productId"
-                },
-                "sourceAccountId": {
-                  "from": "instance",
-                  "path": "fields.customerAccountId"
-                }
-              },
-              "capture": {
-                "chargeApiCallTransferTransferId": "transferId"
-              },
-              "key": "transfer",
-              "operation": "internal_transfer.create"
-            }
-          ],
-          "publicAction": "chargeApiCallUsage",
-          "steps": [],
-          "summary": "Charge one metered api call; the emission is the transfer itself"
-        },
-        "charge_storage_gib": {
-          "agentDescription": "Charge one metered storage gib at the committed price. The period must still be open, so charge before periodEnd. The transfer posts from the customer to the provider at once and there is no reversal action.",
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "moves[0]"
-              }
-            ]
-          },
-          "moves": [
-            {
-              "bind": {
-                "amount": {
-                  "from": "instance",
-                  "path": "fields.storageRate"
-                },
-                "currency": {
-                  "from": "const",
-                  "value": "SAR"
-                },
-                "destinationAccountId": {
-                  "from": "instance",
-                  "path": "fields.providerAccountId"
-                },
-                "metadata.instrumentId": {
-                  "from": "const",
-                  "value": "usage"
-                },
-                "metadata.instrumentInstanceId": {
-                  "from": "instance",
-                  "path": "instrumentInstanceId"
-                },
-                "metadata.phase": {
-                  "from": "const",
-                  "value": "charge_storage_gib"
-                },
-                "productId": {
-                  "from": "instance",
-                  "path": "productId"
-                },
-                "sourceAccountId": {
-                  "from": "instance",
-                  "path": "fields.customerAccountId"
-                }
-              },
-              "capture": {
-                "chargeStorageGibTransferTransferId": "transferId"
-              },
-              "key": "transfer",
-              "operation": "internal_transfer.create"
-            }
-          ],
-          "publicAction": "chargeStorageGibUsage",
-          "steps": [],
-          "summary": "Charge one metered storage gib; the emission is the transfer itself"
-        },
-        "close_period": {
-          "due": {
-            "field": "periodEnd"
-          },
-          "effects": {
-            "schedules": [
-              {
-                "signature": "schedules.due",
-                "source": "due"
-              }
-            ]
-          },
-          "moves": [],
-          "steps": [],
-          "summary": "Close the metering period; no further usage can be charged"
-        },
-        "create": {
-          "agentDescription": "Open the metering period with its committed rate card. The caller supplies the periodEnd anchor and every per-unit price. The prices are fixed here and no later charge can change them. No money moves.",
-          "moves": [],
-          "publicAction": "createUsage",
-          "steps": [],
-          "summary": "Open a usage period with its committed rate card"
-        }
-      },
-      "agentDescription": "Reach for metered when the customer is billed per unit at a rate card fixed when the period opens, and the period closes on periodEnd. Every charge is its own transfer. Pick scheduled for a flat repeating amount and instant transfer for a one-off payment.",
-      "description": "Metered usage: the customer is charged per unit at the committed rate card until the period closes on its stored end date",
-      "fields": {
-        "callRate": {
-          "description": "Per-unit price of api call in SAR minor units, committed at period open",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        },
-        "currency": {
-          "description": "ISO 4217 currency code",
-          "maxLength": 3,
-          "minLength": 3,
-          "pattern": "^[A-Z]{3}$",
-          "type": "string"
-        },
-        "customerAccountId": {
-          "description": "The customer account",
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string",
-          "x-hyperscale-reference-filter": {
-            "column": "role",
-            "values": [
-              "customer_balance"
-            ]
-          }
-        },
-        "periodEnd": {
-          "description": "End of this metering period; the close makes further charges unreachable",
-          "format": "hyperscale-date-time",
-          "type": "string"
-        },
-        "providerAccountId": {
-          "description": "The provider account",
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string",
-          "x-hyperscale-reference-filter": {
-            "column": "role",
-            "values": [
-              "customer_balance"
-            ]
-          }
-        },
-        "storageRate": {
-          "description": "Per-unit price of storage gib in SAR minor units, committed at period open",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        }
-      },
-      "id": "usage",
-      "idPrefix": "usag",
-      "lifecycle": {
-        "initial": "open",
-        "states": [
-          "open",
-          "closed"
-        ],
-        "transitions": {
-          "charge_api_call": {
-            "from": [
-              "open"
-            ],
-            "to": "open"
-          },
-          "charge_storage_gib": {
-            "from": [
-              "open"
-            ],
-            "to": "open"
-          },
-          "close_period": {
-            "from": [
-              "open"
-            ],
-            "to": "closed"
-          }
-        }
-      },
-      "parties": {
-        "beneficiary": "providerAccountId",
-        "payer": "customerAccountId"
-      },
-      "required": [
-        "customerAccountId",
-        "providerAccountId",
-        "periodEnd",
-        "callRate",
-        "storageRate",
-        "currency"
-      ],
-      "summary": "Metered charges from customer on a committed rate card",
-      "templateBinding": {
-        "id": "metered",
-        "parameters": {}
-      },
-      "title": "Usage"
-    }
-  ],
-  "product": "metered_example",
-  "subjects": [],
-  "title": "Metered example",
-  "udl": 1,
-  "version": 1
-}

package/examples/pooled_split/README.md

@@ -1,3 +0,0 @@
-# pooled_split
-
-This example applies the `pooled_split` standard-library module. Its sibling UDL file pins the canonical compiler output byte for byte. The company and parties are invented.

package/examples/pooled_split/pooled_split.hsx

@@ -1,15 +0,0 @@
-program pooled_split_example "Pooled split example"
-import { pooled_split } from "std/money_flows"
-party payer: business
-party first_recipient: business
-party second_recipient: business
-settlement pool = pooled_split {
-  payer: payer
-  amount: poolAmount: money(SAR)
-  payout_due: payoutDueAt
-  split {
-    first_recipient: 60%
-    second_recipient: 40%
-    remainder_to: first_recipient
-  }
-}