@ottochain/sdk 2.3.0 → 2.5.0

package/dist/esm/apps/markets/state-machines/market-group-buy.js

@@ -1,159 +1,160 @@
-import { defineFiberApp } from "../../../schema/fiber-app.js";
+import { defineFiberApp } from '../../../schema/fiber-app.js';
+import { signerIsParty, signerIsAnyParty } from '../../../schema/guards.js';
 /**
  * Collective purchasing with quantity thresholds and tiered pricing.
  */
 export const marketGroupBuyDef = defineFiberApp({
     metadata: {
-        name: "MarketGroupBuy",
-        app: "markets",
-        type: "groupBuy",
-        version: "1.0.0",
-        description: "Collective purchasing with quantity thresholds and tiered pricing",
+        name: 'MarketGroupBuy',
+        app: 'markets',
+        type: 'groupBuy',
+        version: '1.0.0',
+        description: 'Collective purchasing with quantity thresholds and tiered pricing',
         crossReferences: {
             vendorIdentityId: "Links to vendor's IdentityAgent",
-            escrowId: "Links to ContractEscrow for payment custody",
+            escrowId: 'Links to ContractEscrow for payment custody',
         },
     },
     createSchema: {
-        required: ["organizer", "minQuantity", "deadline"],
+        required: ['organizer', 'minQuantity', 'deadline'],
         properties: {
             organizer: {
-                type: "address",
-                description: "DAG address of group buy organizer",
+                type: 'address',
+                description: 'DAG address of group buy organizer',
                 immutable: true,
             },
             minQuantity: {
-                type: "number",
+                type: 'number',
                 minimum: 1,
-                description: "Minimum quantity to proceed",
+                description: 'Minimum quantity to proceed',
                 immutable: true,
             },
             deadline: {
-                type: "timestamp",
-                description: "Order deadline",
+                type: 'timestamp',
+                description: 'Order deadline',
                 immutable: true,
             },
-            vendor: { type: "address", description: "DAG address of the vendor" },
+            vendor: { type: 'address', description: 'DAG address of the vendor' },
             maxPerBuyer: {
-                type: "number",
+                type: 'number',
                 minimum: 1,
-                description: "Max quantity per buyer",
+                description: 'Max quantity per buyer',
             },
             priceTiers: {
-                type: "array",
-                description: "Quantity-based pricing tiers",
+                type: 'array',
+                description: 'Quantity-based pricing tiers',
             },
         },
     },
     stateSchema: {
         properties: {
-            status: { type: "string", computed: true },
-            organizer: { type: "address", immutable: true },
-            vendor: { type: "address" },
-            minQuantity: { type: "number", immutable: true },
-            maxPerBuyer: { type: "number" },
-            deadline: { type: "timestamp", immutable: true },
-            priceTiers: { type: "array" },
-            orders: { type: "array", computed: true },
-            totalQuantity: { type: "number", computed: true },
-            currentTier: { type: "number", computed: true },
-            refundsClaimed: { type: "array", computed: true },
+            status: { type: 'string', computed: true },
+            organizer: { type: 'address', immutable: true },
+            vendor: { type: 'address' },
+            minQuantity: { type: 'number', immutable: true },
+            maxPerBuyer: { type: 'number' },
+            deadline: { type: 'timestamp', immutable: true },
+            priceTiers: { type: 'array' },
+            orders: { type: 'array', computed: true },
+            totalQuantity: { type: 'number', computed: true },
+            currentTier: { type: 'number', computed: true },
+            refundsClaimed: { type: 'array', computed: true },
         },
     },
     eventSchemas: {
-        open: { description: "Open the group buy for orders" },
-        cancel: { description: "Cancel the group buy" },
+        open: { description: 'Open the group buy for orders' },
+        cancel: { description: 'Cancel the group buy' },
         order: {
-            description: "Place an order",
-            required: ["quantity"],
+            description: 'Place an order',
+            required: ['quantity'],
             properties: {
-                quantity: { type: "number", minimum: 1 },
-                shippingInfo: { type: "object" },
+                quantity: { type: 'number', minimum: 1 },
+                shippingInfo: { type: 'object' },
             },
         },
-        check_threshold: { description: "Check if minimum threshold reached" },
-        finalize: { description: "Finalize after deadline" },
-        fulfill: { description: "Mark group buy as fulfilled by vendor/organizer" },
-        claim_refund: { description: "Claim refund if threshold not met" },
+        check_threshold: { description: 'Check if minimum threshold reached' },
+        finalize: { description: 'Finalize after deadline' },
+        fulfill: { description: 'Mark group buy as fulfilled by vendor/organizer' },
+        claim_refund: { description: 'Claim refund if threshold not met' },
     },
     states: {
         PROPOSED: {
-            id: "PROPOSED",
+            id: 'PROPOSED',
             isFinal: false,
             metadata: {
-                label: "Proposed",
-                description: "Group buy created but not yet open",
-                category: "initial",
+                label: 'Proposed',
+                description: 'Group buy created but not yet open',
+                category: 'initial',
             },
         },
         OPEN: {
-            id: "OPEN",
+            id: 'OPEN',
             isFinal: false,
             metadata: {
-                label: "Open",
-                description: "Accepting orders",
-                category: "active",
+                label: 'Open',
+                description: 'Accepting orders',
+                category: 'active',
             },
         },
         THRESHOLD_MET: {
-            id: "THRESHOLD_MET",
+            id: 'THRESHOLD_MET',
             isFinal: false,
             metadata: {
-                label: "Threshold met",
-                description: "Minimum quantity reached, continuing for better tier",
-                category: "active",
+                label: 'Threshold met',
+                description: 'Minimum quantity reached, continuing for better tier',
+                category: 'active',
             },
         },
         PROCESSING: {
-            id: "PROCESSING",
+            id: 'PROCESSING',
             isFinal: false,
             metadata: {
-                label: "Processing",
-                description: "Order placed with vendor, awaiting fulfillment",
-                category: "pending",
+                label: 'Processing',
+                description: 'Order placed with vendor, awaiting fulfillment',
+                category: 'pending',
             },
         },
         FULFILLED: {
-            id: "FULFILLED",
+            id: 'FULFILLED',
             isFinal: true,
             metadata: {
-                label: "Fulfilled",
-                description: "All items delivered to buyers",
-                category: "terminal",
+                label: 'Fulfilled',
+                description: 'All items delivered to buyers',
+                category: 'terminal',
             },
         },
         REFUNDED: {
-            id: "REFUNDED",
+            id: 'REFUNDED',
             isFinal: true,
             metadata: {
-                label: "Refunded",
-                description: "Threshold not met, all orders refunded",
-                category: "terminal",
+                label: 'Refunded',
+                description: 'Threshold not met, all orders refunded',
+                category: 'terminal',
             },
         },
         CANCELLED: {
-            id: "CANCELLED",
+            id: 'CANCELLED',
             isFinal: true,
             metadata: {
-                label: "Cancelled",
-                description: "Group buy cancelled",
-                category: "terminal",
+                label: 'Cancelled',
+                description: 'Group buy cancelled',
+                category: 'terminal',
             },
         },
     },
-    initialState: "PROPOSED",
+    initialState: 'PROPOSED',
     transitions: [
         {
-            from: "PROPOSED",
-            to: "OPEN",
-            eventName: "open",
-            guard: { "===": [{ var: "event.agent" }, { var: "state.organizer" }] },
+            from: 'PROPOSED',
+            to: 'OPEN',
+            eventName: 'open',
+            guard: signerIsParty('state.organizer'),
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "OPEN",
-                        openedAt: { var: "$timestamp" },
+                        status: 'OPEN',
+                        openedAt: { var: '$ordinal' },
                         orders: [],
                         totalQuantity: 0,
                         currentTier: 0,
@@ -163,55 +164,52 @@ export const marketGroupBuyDef = defineFiberApp({
             dependencies: [],
         },
         {
-            from: "PROPOSED",
-            to: "CANCELLED",
-            eventName: "cancel",
-            guard: { "===": [{ var: "event.agent" }, { var: "state.organizer" }] },
+            from: 'PROPOSED',
+            to: 'CANCELLED',
+            eventName: 'cancel',
+            guard: signerIsParty('state.organizer'),
             effect: {
-                merge: [
-                    { var: "state" },
-                    { status: "CANCELLED", cancelledAt: { var: "$timestamp" } },
-                ],
+                merge: [{ var: 'state' }, { status: 'CANCELLED', cancelledAt: { var: '$ordinal' } }],
             },
             dependencies: [],
         },
         {
-            from: "OPEN",
-            to: "OPEN",
-            eventName: "order",
+            from: 'OPEN',
+            to: 'OPEN',
+            eventName: 'order',
             guard: {
                 and: [
-                    { ">": [{ var: "event.quantity" }, 0] },
+                    { '>': [{ var: 'event.quantity' }, 0] },
                     {
                         or: [
-                            { "!": [{ var: "state.maxPerBuyer" }] },
+                            { '!': [{ var: 'state.maxPerBuyer' }] },
                             {
-                                "<=": [{ var: "event.quantity" }, { var: "state.maxPerBuyer" }],
+                                '<=': [{ var: 'event.quantity' }, { var: 'state.maxPerBuyer' }],
                             },
                         ],
                     },
-                    { "<=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
+                    { '<=': [{ var: '$ordinal' }, { var: 'state.deadline' }] },
                 ],
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
                         orders: {
                             cat: [
-                                { var: "state.orders" },
+                                { var: 'state.orders' },
                                 [
                                     {
-                                        buyer: { var: "event.agent" },
-                                        quantity: { var: "event.quantity" },
-                                        shippingInfo: { var: "event.shippingInfo" },
-                                        orderedAt: { var: "$timestamp" },
+                                        buyer: { var: 'event.agent' },
+                                        quantity: { var: 'event.quantity' },
+                                        shippingInfo: { var: 'event.shippingInfo' },
+                                        orderedAt: { var: '$ordinal' },
                                     },
                                 ],
                             ],
                         },
                         totalQuantity: {
-                            "+": [{ var: "state.totalQuantity" }, { var: "event.quantity" }],
+                            '+': [{ var: 'state.totalQuantity' }, { var: 'event.quantity' }],
                         },
                     },
                 ],
@@ -219,31 +217,28 @@ export const marketGroupBuyDef = defineFiberApp({
             dependencies: [],
         },
         {
-            from: "OPEN",
-            to: "THRESHOLD_MET",
-            eventName: "check_threshold",
+            from: 'OPEN',
+            to: 'THRESHOLD_MET',
+            eventName: 'check_threshold',
             guard: {
-                ">=": [{ var: "state.totalQuantity" }, { var: "state.minQuantity" }],
+                '>=': [{ var: 'state.totalQuantity' }, { var: 'state.minQuantity' }],
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "THRESHOLD_MET",
-                        thresholdMetAt: { var: "$timestamp" },
+                        status: 'THRESHOLD_MET',
+                        thresholdMetAt: { var: '$ordinal' },
                         currentTier: {
                             reduce: [
-                                { var: "state.priceTiers" },
+                                { var: 'state.priceTiers' },
                                 {
                                     if: [
                                         {
-                                            "<=": [
-                                                { var: "current.minQuantity" },
-                                                { var: "state.totalQuantity" },
-                                            ],
+                                            '<=': [{ var: 'current.minQuantity' }, { var: 'state.totalQuantity' }],
                                         },
-                                        { var: "current.tier" },
-                                        { var: "accumulator" },
+                                        { var: 'current.tier' },
+                                        { var: 'accumulator' },
                                     ],
                                 },
                                 0,
@@ -255,56 +250,50 @@ export const marketGroupBuyDef = defineFiberApp({
             dependencies: [],
         },
         {
-            from: "THRESHOLD_MET",
-            to: "THRESHOLD_MET",
-            eventName: "order",
+            from: 'THRESHOLD_MET',
+            to: 'THRESHOLD_MET',
+            eventName: 'order',
             guard: {
-                and: [
-                    { ">": [{ var: "event.quantity" }, 0] },
-                    { "<=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
-                ],
+                and: [{ '>': [{ var: 'event.quantity' }, 0] }, { '<=': [{ var: '$ordinal' }, { var: 'state.deadline' }] }],
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
                         orders: {
                             cat: [
-                                { var: "state.orders" },
+                                { var: 'state.orders' },
                                 [
                                     {
-                                        buyer: { var: "event.agent" },
-                                        quantity: { var: "event.quantity" },
-                                        shippingInfo: { var: "event.shippingInfo" },
-                                        orderedAt: { var: "$timestamp" },
+                                        buyer: { var: 'event.agent' },
+                                        quantity: { var: 'event.quantity' },
+                                        shippingInfo: { var: 'event.shippingInfo' },
+                                        orderedAt: { var: '$ordinal' },
                                     },
                                 ],
                             ],
                         },
                         totalQuantity: {
-                            "+": [{ var: "state.totalQuantity" }, { var: "event.quantity" }],
+                            '+': [{ var: 'state.totalQuantity' }, { var: 'event.quantity' }],
                         },
                         currentTier: {
                             reduce: [
-                                { var: "state.priceTiers" },
+                                { var: 'state.priceTiers' },
                                 {
                                     if: [
                                         {
-                                            "<=": [
-                                                { var: "current.minQuantity" },
+                                            '<=': [
+                                                { var: 'current.minQuantity' },
                                                 {
-                                                    "+": [
-                                                        { var: "state.totalQuantity" },
-                                                        { var: "event.quantity" },
-                                                    ],
+                                                    '+': [{ var: 'state.totalQuantity' }, { var: 'event.quantity' }],
                                                 },
                                             ],
                                         },
-                                        { var: "current.tier" },
-                                        { var: "accumulator" },
+                                        { var: 'current.tier' },
+                                        { var: 'accumulator' },
                                     ],
                                 },
-                                { var: "state.currentTier" },
+                                { var: 'state.currentTier' },
                             ],
                         },
                     },
@@ -313,24 +302,20 @@ export const marketGroupBuyDef = defineFiberApp({
             dependencies: [],
         },
         {
-            from: "THRESHOLD_MET",
-            to: "PROCESSING",
-            eventName: "finalize",
-            guard: { ">=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
+            from: 'THRESHOLD_MET',
+            to: 'PROCESSING',
+            eventName: 'finalize',
+            guard: { '>=': [{ var: '$ordinal' }, { var: 'state.deadline' }] },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "PROCESSING",
-                        finalizedAt: { var: "$timestamp" },
-                        finalTier: { var: "state.currentTier" },
+                        status: 'PROCESSING',
+                        finalizedAt: { var: '$ordinal' },
+                        finalTier: { var: 'state.currentTier' },
                         finalPricePerUnit: {
                             var: {
-                                cat: [
-                                    "state.priceTiers.",
-                                    { var: "state.currentTier" },
-                                    ".pricePerUnit",
-                                ],
+                                cat: ['state.priceTiers.', { var: 'state.currentTier' }, '.pricePerUnit'],
                             },
                         },
                     },
@@ -339,74 +324,68 @@ export const marketGroupBuyDef = defineFiberApp({
             dependencies: [],
         },
         {
-            from: "PROCESSING",
-            to: "FULFILLED",
-            eventName: "fulfill",
-            guard: {
-                or: [
-                    { "===": [{ var: "event.agent" }, { var: "state.vendor" }] },
-                    { "===": [{ var: "event.agent" }, { var: "state.organizer" }] },
-                ],
-            },
+            from: 'PROCESSING',
+            to: 'FULFILLED',
+            eventName: 'fulfill',
+            guard: signerIsAnyParty(['state.vendor', 'state.organizer']),
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "FULFILLED",
-                        fulfilledAt: { var: "$timestamp" },
-                        trackingInfo: { var: "event.trackingInfo" },
+                        status: 'FULFILLED',
+                        fulfilledAt: { var: '$ordinal' },
+                        trackingInfo: { var: 'event.trackingInfo' },
                     },
                 ],
             },
             dependencies: [],
         },
         {
-            from: "OPEN",
-            to: "REFUNDED",
-            eventName: "finalize",
+            from: 'OPEN',
+            to: 'REFUNDED',
+            eventName: 'finalize',
             guard: {
                 and: [
                     {
-                        "<": [{ var: "state.totalQuantity" }, { var: "state.minQuantity" }],
+                        '<': [{ var: 'state.totalQuantity' }, { var: 'state.minQuantity' }],
                     },
-                    { ">=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
+                    { '>=': [{ var: '$ordinal' }, { var: 'state.deadline' }] },
                 ],
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "REFUNDED",
-                        refundedAt: { var: "$timestamp" },
-                        reason: "threshold_not_met",
+                        status: 'REFUNDED',
+                        refundedAt: { var: '$ordinal' },
+                        reason: 'threshold_not_met',
                     },
                 ],
             },
             dependencies: [],
         },
         {
-            from: "REFUNDED",
-            to: "REFUNDED",
-            eventName: "claim_refund",
+            from: 'REFUNDED',
+            to: 'REFUNDED',
+            eventName: 'claim_refund',
             guard: {
                 and: [
                     {
-                        ">": [
+                        '>': [
                             {
-                                size: {
-                                    filter: [
-                                        { var: "state.orders" },
-                                        { "===": [{ var: "buyer" }, { var: "event.agent" }] },
-                                    ],
-                                },
+                                length: [
+                                    {
+                                        filter: [{ var: 'state.orders' }, { '===': [{ var: 'buyer' }, { var: 'event.agent' }] }],
+                                    },
+                                ],
                             },
                             0,
                         ],
                     },
                     {
-                        "!": [
+                        '!': [
                             {
-                                in: [{ var: "event.agent" }, { var: "state.refundsClaimed" }],
+                                in: [{ var: 'event.agent' }, { var: 'state.refundsClaimed' }],
                             },
                         ],
                     },
@@ -414,10 +393,10 @@ export const marketGroupBuyDef = defineFiberApp({
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
                         refundsClaimed: {
-                            cat: [{ var: "state.refundsClaimed" }, [{ var: "event.agent" }]],
+                            cat: [{ var: 'state.refundsClaimed' }, [{ var: 'event.agent' }]],
                         },
                     },
                 ],