@hyperscale0/hsx 1.0.0-rc.1 → 1.0.123

package/std/escrow.hsx

@@ -0,0 +1,73 @@
+header escrow
+
+// Economics: Funding and unspent returns are principal. Acceptance realizes earnings for
+// the company or a payout to a bound outside seller; tax is pass-through.
+
+// Expose create, fund, deliver and accept for the purchase path. Create captures
+// subject.price; acceptance pays payee less the configured fee, not payer.
+// Expose dispute, verify_return and refund separately for the return path.
+// Payer disputes delivered goods; payee verifies return evidence from disputed;
+// payee refunds the entire held price from return_verified by default.
+// Acceptance expiry enters disputed, never released. Neither verify_return nor
+// refund becomes public merely because dispute is exposed. Clock actions remain
+// internal. Expose cancel for a pending hold, including a checkout-funded hold;
+// it returns its credited balance to payer before cancelling. Confirm requires
+// the whole captured price in held. This flow has no partial release or refund.
+
+// Cost: create declares one owned account. Fund and refund each declare one
+// transfer; accept expands the configured fee and tax into moves. Run hsx cost
+// on the composed program for instruction counts. The executor supplies prices.
+
+instrument hold(payer: party = party(person), payee: party = programOperator, accept_within: duration = 48h, fee: fee = { seller: 0%, tax: 0% }, dispute: policy = { refund_after: return_verified }) {
+  revisioned: true
+  summary: "Hold the subject price through delivery, acceptance and verified return."
+  fields {
+    payer: account of payer, payee: account of payee
+    held: account of self, deliveredAt: date?
+    price: money = subject.price
+  }
+  lifecycle { states: [pending, funded, delivered, disputed, return_verified, released, refunded, cancelled], initial: pending }
+  action create {
+    subject { price: money }
+    actor: { party: payer }
+  }
+  action fund {
+    from: pending, to: funded, actor: { party: payer }
+    subject { price: money }
+    moves self.price from payer to self.held economics { purpose: principal, sourceParty: payer }
+  }
+  action confirm {
+    from: pending, to: funded
+    requires self.held.balance == self.price
+  }
+  action deliver {
+    from: funded, to: delivered, actor: { party: payee }
+    set: { deliveredAt: { field: self.now } }
+  }
+  action accept { allowZero: true, requires self.price > "0";
+    from: delivered, to: released, actor: { party: payer }
+    input { acceptanceReference: text }
+    deadline: { at: self.deliveredAt, offset: accept_within }
+    moves self.price from self.held to payee fee fee economics { payee: { recipient: payee, company: { purpose: earning, sourceParty: payer }, participant: { purpose: participant_payout, sourceParty: programOperator } }, fee: { purpose: earning, sourceParty: payer }, tax: { purpose: pass_through, sourceParty: programOperator } }
+  }
+  action expire_acceptance {
+    from: delivered, to: disputed, actor: clock
+    due: { at: self.deliveredAt, offset: accept_within }
+  }
+  action dispute {
+    from: delivered, to: disputed, actor: { party: payer }
+    deadline: { at: self.deliveredAt, offset: accept_within }
+  }
+  action verify_return {
+    from: disputed, to: return_verified, actor: { party: payee }
+    input { returnEvidence: text }
+  }
+  action refund {
+    from: dispute.refund_after, to: refunded, actor: { party: payee }
+    moves self.price from self.held to payer economics { purpose: principal, sourceParty: programOperator }
+  }
+  action cancel { allowZero: true,
+    from: pending, to: cancelled, actor: { party: payer }
+    moves self.held.balance from self.held to payer economics { purpose: principal, sourceParty: programOperator }
+  }
+}