@degenerate/generic 0.4.0 → 0.7.0

package/dist/models/functions/share-data-function-models.js

@@ -1,9 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IShareDataRuleSchema = exports.IShareDataNetworkRuleSchema = exports.IShareDataRuleBasicSchema = exports.IShareDataNetworkFunctionDescriptorSchema = exports.IShareDataNetworkFunctionSchema = exports.IShareDataFunctionSchema = exports.IShareDataFunctionBasicSchema = exports.INetworkProofSchema = exports.ICryptographicSignatureProofSchema = exports.ITargetObjectSchema = exports.INetworkProofTypeSchema = exports.INetworkProofType = void 0;
+exports.IShareDataFunctionSchema = exports.IShareDataFunctionBasicSchema = exports.INetworkProofSchema = exports.ICryptographicSignatureProofSchema = exports.ITargetObjectSchema = exports.INetworkProofTypeSchema = exports.INetworkProofType = void 0;
 const zod_1 = require("zod");
 /**
- * This contains the data for the share functions
+ * Function record + proof types still referenced by the runtime (the rules
+ * engine's `ITargetObject` and the `IShareDataFunction` shape used by
+ * `share-data-errors`). The earlier network-function/rule "logic library"
+ * sketches (`IShareDataNetworkFunction` / `IShareDataNetworkRule` / …) were
+ * removed — the live, signed, versioned library entities in
+ * `@degenerate/generic`'s `library/` module supersede them.
  */
 //#region enum
 /**
@@ -41,19 +46,6 @@ exports.IShareDataFunctionBasicSchema = zod_1.z.object({
     stringifiedFunction: zod_1.z.string(), // the stringified function
     currentHash: zod_1.z.string(), // the hash of the stringified function + previous hash
 });
-// const shareDataFunction: IShareDataFunction = {
-// createdAt: 1234567890,
-// previousHash: 'example-previous-hash',
-// stringifiedFunction: 'example-stringified-function',
-// currentHash: 'example-current-hash',
-//     // Properties specific to IShareDataFunction
-//     proof: {
-//         signature: 'example-signature',
-//         publicKey: 'example-public-key',
-//         // Add other properties of ICryptographicSignatureProof as needed
-//     },
-//     proofType: INetworkProofType.CRYPTOGRAPHIC_SIGNATURE,
-// };
 /**
  * This contains a share data function
  */
@@ -62,53 +54,3 @@ exports.IShareDataFunctionSchema = zod_1.z.object({
     proof: exports.INetworkProofSchema, // the proof that the function is valid
     proofType: exports.INetworkProofTypeSchema, // the type of proof
 });
-/**
- * This contains a share data network function
- */
-exports.IShareDataNetworkFunctionSchema = zod_1.z.object({
-    id: zod_1.z.string(), // the id of the function (this will be the original hex representation of the following fields)
-    name: zod_1.z.string(), // the name of the function
-    description: zod_1.z.string(), // the description of the function
-    shareDataFunctions: zod_1.z.array(exports.IShareDataFunctionSchema), // the stringified function
-    proof: exports.INetworkProofSchema, // the proof that the function is valid
-    proofType: exports.INetworkProofTypeSchema, // the type of proof
-});
-/**
- * This contains the data for a share data network function descriptor.
- */
-exports.IShareDataNetworkFunctionDescriptorSchema = zod_1.z.object({
-    functionNumber: zod_1.z.number(), // the number of the function in the list
-    name: zod_1.z.string(), // the name of the function
-    description: zod_1.z.string(), // the description of the function
-});
-/**
- * This contains the data for a share data network rule that is the basic shape.
- */
-exports.IShareDataRuleBasicSchema = zod_1.z.object({
-    createdAt: zod_1.z.number(), // the time the rule was created (in milliseconds)
-    previousHash: zod_1.z.string(), // the previous hash of the rule
-    stringifiedRule: zod_1.z.string(), // the stringified rule
-    currentHash: zod_1.z.string(), // the hash of the stringified rule + previous hash
-});
-/**
- * This contains the interface for a share function record in the share data object
- */
-exports.IShareDataNetworkRuleSchema = zod_1.z.object({
-    id: zod_1.z.string(), // the id of the rule (this will be the original hex representation of the following fields)
-    shareDataRules: zod_1.z.array(exports.IShareDataRuleBasicSchema), // the stringified rule
-    applicationId: zod_1.z.string(), // the application id that owns the rule
-    applicationIdProof: zod_1.z.string(), // the proof that the application id owns the rule
-});
-/**
- * This contains the data for a share data network rule.
- */
-exports.IShareDataRuleSchema = zod_1.z.object({
-    createdAt: zod_1.z.number(), // the time the rule was created (in milliseconds)
-    previousHash: zod_1.z.string(), // the previous hash of the rule
-    stringifiedRule: zod_1.z.string(), // the stringified rule
-    currentHash: zod_1.z.string(), // the hash of the stringified rule + previous hash
-});
-/// Use of user defined function in the share data
-/// Storage / Retrieval of the user defined functions in the network. (logic library)
-// Use of user defined rules in the share data (product)
-// Storage / Retrieval of the user defined rules in the network. (logic library)

package/dist/models/index.d.ts

@@ -17,5 +17,6 @@ export * from './safe/safe-transaction-models';
 export * from './share-data/share-data-crypto-models';
 export * from './share-data/share-data-models';
 export * from './share-data/share-data-persistence-models';
+export * from './settlement/settlement-models';
 export * from './shareblock/shareblock-models';
 //# sourceMappingURL=index.d.ts.map

package/dist/models/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAEA,cAAc,sDAAsD,CAAC;AACrE,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8CAA8C,CAAC;AAC7D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAElD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,qDAAqD,CAAC;AACpE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,mDAAmD,CAAC;AAClE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,mDAAmD,CAAC;AAClE,cAAc,gCAAgC,CAAC;AAG/C,cAAc,uCAAuC,CAAC;AACtD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAEA,cAAc,sDAAsD,CAAC;AACrE,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8CAA8C,CAAC;AAC7D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAElD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,qDAAqD,CAAC;AACpE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,mDAAmD,CAAC;AAClE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,mDAAmD,CAAC;AAClE,cAAc,gCAAgC,CAAC;AAG/C,cAAc,uCAAuC,CAAC;AACtD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC"}

package/dist/models/index.js

@@ -38,4 +38,5 @@ __exportStar(require("./safe/safe-transaction-models"), exports);
 __exportStar(require("./share-data/share-data-crypto-models"), exports);
 __exportStar(require("./share-data/share-data-models"), exports);
 __exportStar(require("./share-data/share-data-persistence-models"), exports);
+__exportStar(require("./settlement/settlement-models"), exports);
 __exportStar(require("./shareblock/shareblock-models"), exports);

package/dist/models/safe/transactions/sharedata-transactions-models.d.ts

@@ -34,6 +34,7 @@ export declare const ISAFETransactionShareDataDataSchema: z.ZodObject<{
             Funding: "Funding";
             Distribution: "Distribution";
             GraceRepayment: "GraceRepayment";
+            Settlement: "Settlement";
         }>;
         relatedLoanApplicationId: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
@@ -93,6 +94,7 @@ export declare const ISAFETransactionShareDataSchema: z.ZodObject<{
                     Funding: "Funding";
                     Distribution: "Distribution";
                     GraceRepayment: "GraceRepayment";
+                    Settlement: "Settlement";
                 }>;
                 relatedLoanApplicationId: z.ZodOptional<z.ZodString>;
                 description: z.ZodOptional<z.ZodString>;
@@ -151,6 +153,7 @@ export declare const ISAFETransactionShareDataAddSchema: z.ZodObject<{
                     Funding: "Funding";
                     Distribution: "Distribution";
                     GraceRepayment: "GraceRepayment";
+                    Settlement: "Settlement";
                 }>;
                 relatedLoanApplicationId: z.ZodOptional<z.ZodString>;
                 description: z.ZodOptional<z.ZodString>;
@@ -208,6 +211,7 @@ export declare const ISAFETransactionShareDataUpdateSchema: z.ZodObject<{
                     Funding: "Funding";
                     Distribution: "Distribution";
                     GraceRepayment: "GraceRepayment";
+                    Settlement: "Settlement";
                 }>;
                 relatedLoanApplicationId: z.ZodOptional<z.ZodString>;
                 description: z.ZodOptional<z.ZodString>;
@@ -265,6 +269,7 @@ export declare const ISAFETransactionShareDataDeleteSchema: z.ZodObject<{
                     Funding: "Funding";
                     Distribution: "Distribution";
                     GraceRepayment: "GraceRepayment";
+                    Settlement: "Settlement";
                 }>;
                 relatedLoanApplicationId: z.ZodOptional<z.ZodString>;
                 description: z.ZodOptional<z.ZodString>;

package/dist/models/safe/transactions/sharedata-transactions-models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedata-transactions-models.d.ts","sourceRoot":"","sources":["../../../../src/models/safe/transactions/sharedata-transactions-models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACH,mBAAmB,EACnB,yBAAyB,EAG5B,MAAM,4BAA4B,CAAC;AASpC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK9C,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAEhG;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAO1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAIxF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE9F;;GAEG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKhD,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AAEpG;;GAEG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKhD,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC"}
+{"version":3,"file":"sharedata-transactions-models.d.ts","sourceRoot":"","sources":["../../../../src/models/safe/transactions/sharedata-transactions-models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACH,mBAAmB,EACnB,yBAAyB,EAG5B,MAAM,4BAA4B,CAAC;AASpC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK9C,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAEhG;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAO1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAIxF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE9F;;GAEG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKhD,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AAEpG;;GAEG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKhD,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC"}

package/dist/models/settlement/settlement-models.d.ts

@@ -0,0 +1,221 @@
+import z from 'zod';
+/**
+ * Two-phase-commit phase of a settlement, journaled on the coordinator's
+ * state. The legal transition graph (enforced by `buildSettlementPhaseRule`):
+ *
+ *   PREPARING ──▶ COMMITTING ──▶ COMMITTED   (terminal)
+ *      │
+ *      └────────▶ ABORTING  ──▶ ABORTED      (terminal)
+ *
+ * `COMMITTING` is the point of no return: once reached, every leg was already
+ * reserved, so the settlement can only roll forward. Failures before that
+ * point route to `ABORTING`. Terminals are sinks.
+ */
+export declare const SettlementPhaseSchema: z.ZodEnum<{
+    PREPARING: "PREPARING";
+    COMMITTING: "COMMITTING";
+    ABORTING: "ABORTING";
+    COMMITTED: "COMMITTED";
+    ABORTED: "ABORTED";
+}>;
+export type SettlementPhase = z.infer<typeof SettlementPhaseSchema>;
+/**
+ * Per-leg status as tracked by the coordinator (a superset of the member
+ * block's `ReservationStatus`):
+ *
+ *   - `planned`   — in the plan, not yet reserved on its block.
+ *   - `reserved`  — successfully held on its block (PREPARE done for this leg).
+ *   - `committed` — finalized on its block.
+ *   - `released`  — unwound on its block (abort path).
+ *   - `failed`    — its reserve threw (drift/overdraw); triggers settlement
+ *                   abort.
+ */
+export declare const SettlementLegStatusSchema: z.ZodEnum<{
+    reserved: "reserved";
+    committed: "committed";
+    released: "released";
+    planned: "planned";
+    failed: "failed";
+}>;
+export type SettlementLegStatus = z.infer<typeof SettlementLegStatusSchema>;
+/**
+ * One leg of a settlement plan as recorded on the coordinator. A transfer is a
+ * `debit` leg (source) + a `credit` leg (destination) of equal `amountCents`.
+ * `againstHash` pins the leg to the target block's current-state hash at plan
+ * time (D5): if the block advanced, the reserve fails and the settlement
+ * aborts. `currency` is not carried per-leg — a settlement is single-currency
+ * (see the coordinator's `currency`).
+ */
+export declare const ISettlementLegSchema: z.ZodObject<{
+    blockId: z.ZodString;
+    direction: z.ZodEnum<{
+        debit: "debit";
+        credit: "credit";
+    }>;
+    amountCents: z.ZodNumber;
+    againstHash: z.ZodString;
+    status: z.ZodEnum<{
+        reserved: "reserved";
+        committed: "committed";
+        released: "released";
+        planned: "planned";
+        failed: "failed";
+    }>;
+}, z.core.$strip>;
+export type ISettlementLeg = z.infer<typeof ISettlementLegSchema>;
+/**
+ * The coordinator ShareBlock's state. A Settlement block is not a money-
+ * holding block — its inherited `balance` stays at zero and `participants` is
+ * empty; its real payload is the plan (`legs`), the 2PC `phase`, and the
+ * timestamps. The block's append-only transaction history is the durable
+ * journal that crash-recovery re-drives.
+ */
+export declare const ISettlementShareBlockStateSchema: z.ZodObject<{
+    balance: z.ZodNumber;
+    isOpen: z.ZodBoolean;
+    participants: z.ZodRecord<z.ZodString, z.ZodObject<{
+        userId: z.ZodString;
+        role: z.ZodEnum<{
+            Borrower: "Borrower";
+            Lender: "Lender";
+            Platform: "Platform";
+            Recipient: "Recipient";
+        }>;
+        committedAmount: z.ZodNumber;
+        settledAmount: z.ZodNumber;
+    }, z.core.$strip>>;
+    reservations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        settlementId: z.ZodString;
+        direction: z.ZodEnum<{
+            debit: "debit";
+            credit: "credit";
+        }>;
+        amountCents: z.ZodNumber;
+        currency: z.ZodString;
+        againstHash: z.ZodString;
+        status: z.ZodEnum<{
+            reserved: "reserved";
+            committed: "committed";
+            released: "released";
+        }>;
+    }, z.core.$strip>>>;
+    blockType: z.ZodLiteral<"Settlement">;
+    settlementId: z.ZodString;
+    currency: z.ZodString;
+    phase: z.ZodEnum<{
+        PREPARING: "PREPARING";
+        COMMITTING: "COMMITTING";
+        ABORTING: "ABORTING";
+        COMMITTED: "COMMITTED";
+        ABORTED: "ABORTED";
+    }>;
+    legs: z.ZodArray<z.ZodObject<{
+        blockId: z.ZodString;
+        direction: z.ZodEnum<{
+            debit: "debit";
+            credit: "credit";
+        }>;
+        amountCents: z.ZodNumber;
+        againstHash: z.ZodString;
+        status: z.ZodEnum<{
+            reserved: "reserved";
+            committed: "committed";
+            released: "released";
+            planned: "planned";
+            failed: "failed";
+        }>;
+    }, z.core.$strip>>;
+    openedAtMs: z.ZodNumber;
+    terminalAtMs: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type ISettlementShareBlockState = z.infer<typeof ISettlementShareBlockStateSchema>;
+/**
+ * Input for the coordinator `openSettlement` function — establishes the plan
+ * as the first journaled transaction (phase `PREPARING`, every leg `planned`).
+ */
+export declare const ISettlementOpenInputSchema: z.ZodObject<{
+    userId: z.ZodString;
+    settlementId: z.ZodString;
+    currency: z.ZodString;
+    legs: z.ZodArray<z.ZodObject<{
+        blockId: z.ZodString;
+        direction: z.ZodEnum<{
+            debit: "debit";
+            credit: "credit";
+        }>;
+        amountCents: z.ZodNumber;
+        againstHash: z.ZodString;
+        status: z.ZodEnum<{
+            reserved: "reserved";
+            committed: "committed";
+            released: "released";
+            planned: "planned";
+            failed: "failed";
+        }>;
+    }, z.core.$strip>>;
+    openedAtMs: z.ZodNumber;
+}, z.core.$strip>;
+export type ISettlementOpenInput = z.infer<typeof ISettlementOpenInputSchema>;
+/**
+ * Input for `markLegReserved` — advances one leg `planned → reserved` once its
+ * block-side reserve succeeds. Legs are addressed by `blockId`.
+ */
+export declare const ISettlementMarkLegReservedInputSchema: z.ZodObject<{
+    userId: z.ZodString;
+    blockId: z.ZodString;
+}, z.core.$strip>;
+export type ISettlementMarkLegReservedInput = z.infer<typeof ISettlementMarkLegReservedInputSchema>;
+/**
+ * Input for `beginCommit` — the commit point: phase `PREPARING → COMMITTING`.
+ * Valid only when every leg is `reserved`.
+ */
+export declare const ISettlementBeginCommitInputSchema: z.ZodObject<{
+    userId: z.ZodString;
+}, z.core.$strip>;
+export type ISettlementBeginCommitInput = z.infer<typeof ISettlementBeginCommitInputSchema>;
+/**
+ * Input for `markLegCommitted` — advances one leg `reserved → committed` after
+ * its block-side commit lands.
+ */
+export declare const ISettlementMarkLegCommittedInputSchema: z.ZodObject<{
+    userId: z.ZodString;
+    blockId: z.ZodString;
+}, z.core.$strip>;
+export type ISettlementMarkLegCommittedInput = z.infer<typeof ISettlementMarkLegCommittedInputSchema>;
+/**
+ * Input for `finishCommit` — phase `COMMITTING → COMMITTED` (terminal) once
+ * every leg is committed. Stamps `terminalAtMs`.
+ */
+export declare const ISettlementFinishCommitInputSchema: z.ZodObject<{
+    userId: z.ZodString;
+    terminalAtMs: z.ZodNumber;
+}, z.core.$strip>;
+export type ISettlementFinishCommitInput = z.infer<typeof ISettlementFinishCommitInputSchema>;
+/**
+ * Input for `beginAbort` — phase `PREPARING → ABORTING` when a leg fails to
+ * reserve before the commit point. `reason` is optional audit context.
+ */
+export declare const ISettlementBeginAbortInputSchema: z.ZodObject<{
+    userId: z.ZodString;
+    reason: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ISettlementBeginAbortInput = z.infer<typeof ISettlementBeginAbortInputSchema>;
+/**
+ * Input for `markLegReleased` — advances a `reserved` leg to `released` after
+ * its block-side release unwinds the hold (abort path).
+ */
+export declare const ISettlementMarkLegReleasedInputSchema: z.ZodObject<{
+    userId: z.ZodString;
+    blockId: z.ZodString;
+}, z.core.$strip>;
+export type ISettlementMarkLegReleasedInput = z.infer<typeof ISettlementMarkLegReleasedInputSchema>;
+/**
+ * Input for `finishAbort` — phase `ABORTING → ABORTED` (terminal) once every
+ * reserved leg is released. Stamps `terminalAtMs`.
+ */
+export declare const ISettlementFinishAbortInputSchema: z.ZodObject<{
+    userId: z.ZodString;
+    terminalAtMs: z.ZodNumber;
+}, z.core.$strip>;
+export type ISettlementFinishAbortInput = z.infer<typeof ISettlementFinishAbortInputSchema>;
+//# sourceMappingURL=settlement-models.d.ts.map

package/dist/models/settlement/settlement-models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settlement-models.d.ts","sourceRoot":"","sources":["../../../src/models/settlement/settlement-models.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AASpB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB;;;;;;EAMhC,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB;;;;;;EAMpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAM5E;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;iBAM/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAY3C,CAAC;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAM1F;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;iBAMrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;;GAGG;AACH,eAAO,MAAM,qCAAqC;;;iBAGhD,CAAC;AACH,MAAM,MAAM,+BAA+B,GACvC,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,iCAAiC;;iBAE5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GACnC,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,sCAAsC;;;iBAGjD,CAAC;AACH,MAAM,MAAM,gCAAgC,GACxC,CAAC,CAAC,KAAK,CAAC,OAAO,sCAAsC,CAAC,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAC;AACH,MAAM,MAAM,4BAA4B,GACpC,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAEvD;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;iBAG3C,CAAC;AACH,MAAM,MAAM,0BAA0B,GAClC,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAErD;;;GAGG;AACH,eAAO,MAAM,qCAAqC;;;iBAGhD,CAAC;AACH,MAAM,MAAM,+BAA+B,GACvC,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,iCAAiC;;;iBAG5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GACnC,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC"}

package/dist/models/settlement/settlement-models.js

@@ -0,0 +1,152 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ISettlementFinishAbortInputSchema = exports.ISettlementMarkLegReleasedInputSchema = exports.ISettlementBeginAbortInputSchema = exports.ISettlementFinishCommitInputSchema = exports.ISettlementMarkLegCommittedInputSchema = exports.ISettlementBeginCommitInputSchema = exports.ISettlementMarkLegReservedInputSchema = exports.ISettlementOpenInputSchema = exports.ISettlementShareBlockStateSchema = exports.ISettlementLegSchema = exports.SettlementLegStatusSchema = exports.SettlementPhaseSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const shareblock_models_1 = require("../shareblock/shareblock-models");
+//#region Phase + leg status
+/**
+ * Two-phase-commit phase of a settlement, journaled on the coordinator's
+ * state. The legal transition graph (enforced by `buildSettlementPhaseRule`):
+ *
+ *   PREPARING ──▶ COMMITTING ──▶ COMMITTED   (terminal)
+ *      │
+ *      └────────▶ ABORTING  ──▶ ABORTED      (terminal)
+ *
+ * `COMMITTING` is the point of no return: once reached, every leg was already
+ * reserved, so the settlement can only roll forward. Failures before that
+ * point route to `ABORTING`. Terminals are sinks.
+ */
+exports.SettlementPhaseSchema = zod_1.default.enum([
+    'PREPARING',
+    'COMMITTING',
+    'ABORTING',
+    'COMMITTED',
+    'ABORTED',
+]);
+/**
+ * Per-leg status as tracked by the coordinator (a superset of the member
+ * block's `ReservationStatus`):
+ *
+ *   - `planned`   — in the plan, not yet reserved on its block.
+ *   - `reserved`  — successfully held on its block (PREPARE done for this leg).
+ *   - `committed` — finalized on its block.
+ *   - `released`  — unwound on its block (abort path).
+ *   - `failed`    — its reserve threw (drift/overdraw); triggers settlement
+ *                   abort.
+ */
+exports.SettlementLegStatusSchema = zod_1.default.enum([
+    'planned',
+    'reserved',
+    'committed',
+    'released',
+    'failed',
+]);
+//#endregion Phase + leg status
+//#region Leg + coordinator state
+/**
+ * One leg of a settlement plan as recorded on the coordinator. A transfer is a
+ * `debit` leg (source) + a `credit` leg (destination) of equal `amountCents`.
+ * `againstHash` pins the leg to the target block's current-state hash at plan
+ * time (D5): if the block advanced, the reserve fails and the settlement
+ * aborts. `currency` is not carried per-leg — a settlement is single-currency
+ * (see the coordinator's `currency`).
+ */
+exports.ISettlementLegSchema = zod_1.default.object({
+    blockId: zod_1.default.string(),
+    direction: shareblock_models_1.SettlementLegDirectionSchema,
+    amountCents: zod_1.default.number().int().positive(),
+    againstHash: zod_1.default.string(),
+    status: exports.SettlementLegStatusSchema,
+});
+/**
+ * The coordinator ShareBlock's state. A Settlement block is not a money-
+ * holding block — its inherited `balance` stays at zero and `participants` is
+ * empty; its real payload is the plan (`legs`), the 2PC `phase`, and the
+ * timestamps. The block's append-only transaction history is the durable
+ * journal that crash-recovery re-drives.
+ */
+exports.ISettlementShareBlockStateSchema = shareblock_models_1.IShareBlockStateSchema.extend({
+    blockType: zod_1.default.literal(shareblock_models_1.ShareBlockTypeSchema.enum.Settlement),
+    settlementId: zod_1.default.string(),
+    // Opaque currency code; equality-checked against member legs, never
+    // converted. Loosened from the base `min(3).max(3)` per the settlement
+    // design (one settlement = one currency).
+    currency: zod_1.default.string(),
+    phase: exports.SettlementPhaseSchema,
+    legs: zod_1.default.array(exports.ISettlementLegSchema),
+    openedAtMs: zod_1.default.number().int().nonnegative(),
+    /** Stamped when the block reaches a terminal phase (COMMITTED/ABORTED). */
+    terminalAtMs: zod_1.default.number().int().nonnegative().optional(),
+});
+//#endregion Leg + coordinator state
+//#region Coordinator function inputs
+/**
+ * Input for the coordinator `openSettlement` function — establishes the plan
+ * as the first journaled transaction (phase `PREPARING`, every leg `planned`).
+ */
+exports.ISettlementOpenInputSchema = zod_1.default.object({
+    userId: zod_1.default.string(),
+    settlementId: zod_1.default.string(),
+    currency: zod_1.default.string(),
+    legs: zod_1.default.array(exports.ISettlementLegSchema),
+    openedAtMs: zod_1.default.number().int().nonnegative(),
+});
+/**
+ * Input for `markLegReserved` — advances one leg `planned → reserved` once its
+ * block-side reserve succeeds. Legs are addressed by `blockId`.
+ */
+exports.ISettlementMarkLegReservedInputSchema = zod_1.default.object({
+    userId: zod_1.default.string(),
+    blockId: zod_1.default.string(),
+});
+/**
+ * Input for `beginCommit` — the commit point: phase `PREPARING → COMMITTING`.
+ * Valid only when every leg is `reserved`.
+ */
+exports.ISettlementBeginCommitInputSchema = zod_1.default.object({
+    userId: zod_1.default.string(),
+});
+/**
+ * Input for `markLegCommitted` — advances one leg `reserved → committed` after
+ * its block-side commit lands.
+ */
+exports.ISettlementMarkLegCommittedInputSchema = zod_1.default.object({
+    userId: zod_1.default.string(),
+    blockId: zod_1.default.string(),
+});
+/**
+ * Input for `finishCommit` — phase `COMMITTING → COMMITTED` (terminal) once
+ * every leg is committed. Stamps `terminalAtMs`.
+ */
+exports.ISettlementFinishCommitInputSchema = zod_1.default.object({
+    userId: zod_1.default.string(),
+    terminalAtMs: zod_1.default.number().int().nonnegative(),
+});
+/**
+ * Input for `beginAbort` — phase `PREPARING → ABORTING` when a leg fails to
+ * reserve before the commit point. `reason` is optional audit context.
+ */
+exports.ISettlementBeginAbortInputSchema = zod_1.default.object({
+    userId: zod_1.default.string(),
+    reason: zod_1.default.string().optional(),
+});
+/**
+ * Input for `markLegReleased` — advances a `reserved` leg to `released` after
+ * its block-side release unwinds the hold (abort path).
+ */
+exports.ISettlementMarkLegReleasedInputSchema = zod_1.default.object({
+    userId: zod_1.default.string(),
+    blockId: zod_1.default.string(),
+});
+/**
+ * Input for `finishAbort` — phase `ABORTING → ABORTED` (terminal) once every
+ * reserved leg is released. Stamps `terminalAtMs`.
+ */
+exports.ISettlementFinishAbortInputSchema = zod_1.default.object({
+    userId: zod_1.default.string(),
+    terminalAtMs: zod_1.default.number().int().nonnegative(),
+});
+//#endregion Coordinator function inputs

package/dist/models/share-data/share-data-models.d.ts

@@ -60,6 +60,18 @@ export interface IShareFunction<TInput, TFunction extends (...args: any[]) => an
     input: TInput;
     func: TFunction;
     output: TOutput;
+    /**
+     * Optional Zod schema for the runtime input (the `input` arm of the
+     * `func` argument). When present, the input is validated against it at
+     * application time, BEFORE `func` runs; a failure throws
+     * {@link ShareFunctionInputInvalidError}. When absent, behavior is
+     * unchanged (opt-in, additive).
+     *
+     * Governs input WELL-FORMEDNESS only (types, ranges, required fields).
+     * Stateful legality (membership, role, balance, phase) depends on
+     * `current` and stays in `func` / the rule engine.
+     */
+    inputSchema?: z.ZodType<unknown>;
 }
 /**
  * This contains the interface for the rule failures in the share data object

package/dist/models/share-data/share-data-models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"share-data-models.d.ts","sourceRoot":"","sources":["../../../src/models/share-data/share-data-models.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAOpB,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGxE;;GAEG;AACH,oBAAY,cAAc;IACtB,aAAa,kBAAkB;IAC/B,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,mBAAmB,wBAAwB;IAC3C,IAAI,SAAS;CAChB;AAED,eAAO,MAAM,oBAAoB;;;;;;EAM/B,CAAC;AAMH;;GAEG;AACH,eAAO,MAAM,gBAAgB,oCAAgC,CAAC;AAC9D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;iBAQrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;iBAI/B,CAAC;AAGH,MAAM,WAAW,cAAc,CAAC,MAAM,EAAE,SAAS,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,OAAO;IACtF;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;CACnB;AAGD;;GAEG;AACH,eAAO,MAAM,4BAA4B;;iBAEvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;iBAI1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF;;;GAGG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;iBAG7C,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,GAAG;IAC5F,KAAK,CAAC,EAAE,qBAAqB,CAAC;CACjC,CAAC"}
+{"version":3,"file":"share-data-models.d.ts","sourceRoot":"","sources":["../../../src/models/share-data/share-data-models.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAOpB,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGxE;;GAEG;AACH,oBAAY,cAAc;IACtB,aAAa,kBAAkB;IAC/B,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,mBAAmB,wBAAwB;IAC3C,IAAI,SAAS;CAChB;AAED,eAAO,MAAM,oBAAoB;;;;;;EAM/B,CAAC;AAMH;;GAEG;AACH,eAAO,MAAM,gBAAgB,oCAAgC,CAAC;AAC9D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;iBAQrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;iBAI/B,CAAC;AAGH,MAAM,WAAW,cAAc,CAAC,MAAM,EAAE,SAAS,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,OAAO;IACtF;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;CACpC;AAGD;;GAEG;AACH,eAAO,MAAM,4BAA4B;;iBAEvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;iBAI1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF;;;GAGG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;iBAG7C,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,GAAG;IAC5F,KAAK,CAAC,EAAE,qBAAqB,CAAC;CACjC,CAAC"}

package/dist/models/share-data/share-data-persistence-models.d.ts

@@ -26,6 +26,7 @@ export declare const PersistedCreationConfigSchema: z.ZodObject<{
             Funding: "Funding";
             Distribution: "Distribution";
             GraceRepayment: "GraceRepayment";
+            Settlement: "Settlement";
         }>;
         relatedLoanApplicationId: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
@@ -98,6 +99,7 @@ export declare const PersistedShareDataSchema: z.ZodObject<{
         Funding: "Funding";
         Distribution: "Distribution";
         GraceRepayment: "GraceRepayment";
+        Settlement: "Settlement";
     }>;
     signingCurve: z.ZodEnum<{
         ed25519: EllipticalCurvesSigning.Curve25519;
@@ -117,6 +119,7 @@ export declare const PersistedShareDataSchema: z.ZodObject<{
                 Funding: "Funding";
                 Distribution: "Distribution";
                 GraceRepayment: "GraceRepayment";
+                Settlement: "Settlement";
             }>;
             relatedLoanApplicationId: z.ZodOptional<z.ZodString>;
             description: z.ZodOptional<z.ZodString>;

package/dist/models/share-data/share-data-persistence-models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"share-data-persistence-models.d.ts","sourceRoot":"","sources":["../../../src/models/share-data/share-data-persistence-models.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAEH,cAAc,EAEjB,MAAM,iCAAiC,CAAC;AAmBzC;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;EAGtC,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;iBAIxC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACpC,SAAS,EAAE,cAAc,CAAC;IAC1B,cAAc,EAAE,uBAAuB,CAAC;CAC3C;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;iBAOrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuBnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,sDAAsD;AACtD,eAAO,MAAM,mCAAmC,EAAG,CAAU,CAAC"}
+{"version":3,"file":"share-data-persistence-models.d.ts","sourceRoot":"","sources":["../../../src/models/share-data/share-data-persistence-models.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAEH,cAAc,EAEjB,MAAM,iCAAiC,CAAC;AAmBzC;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;EAGtC,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;iBAIxC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACpC,SAAS,EAAE,cAAc,CAAC;IAC1B,cAAc,EAAE,uBAAuB,CAAC;CAC3C;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;iBAOrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuBnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,sDAAsD;AACtD,eAAO,MAAM,mCAAmC,EAAG,CAAU,CAAC"}