@ottochain/sdk 2.3.0 → 2.5.0

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

@@ -1,140 +1,141 @@
-import { defineFiberApp } from "../../../schema/fiber-app.js";
+import { defineFiberApp } from '../../../schema/fiber-app.js';
+import { signerIsParty, signerIsNotParty } from '../../../schema/guards.js';
 /**
  * Auction market supporting English, Dutch, and sealed-bid variants.
  */
 export const marketAuctionDef = defineFiberApp({
     metadata: {
-        name: "MarketAuction",
-        app: "markets",
-        type: "auction",
-        version: "1.0.0",
-        description: "Auction market supporting English, Dutch, and sealed-bid variants",
+        name: 'MarketAuction',
+        app: 'markets',
+        type: 'auction',
+        version: '1.0.0',
+        description: 'Auction market supporting English, Dutch, and sealed-bid variants',
         crossReferences: {
             sellerIdentityId: "Links to seller's IdentityAgent",
-            escrowId: "Links to ContractEscrow for asset custody",
+            escrowId: 'Links to ContractEscrow for asset custody',
         },
     },
     createSchema: {
-        required: ["seller", "minBid"],
+        required: ['seller', 'minBid'],
         properties: {
             seller: {
-                type: "address",
-                description: "DAG address of the seller",
+                type: 'address',
+                description: 'DAG address of the seller',
                 immutable: true,
             },
             minBid: {
-                type: "number",
+                type: 'number',
                 minimum: 0,
-                description: "Minimum opening bid",
+                description: 'Minimum opening bid',
                 immutable: true,
             },
             bidIncrement: {
-                type: "number",
+                type: 'number',
                 minimum: 0,
-                description: "Minimum bid increment",
+                description: 'Minimum bid increment',
             },
             reservePrice: {
-                type: "number",
+                type: 'number',
                 minimum: 0,
-                description: "Reserve price (if any)",
+                description: 'Reserve price (if any)',
             },
-            deadline: { type: "timestamp", description: "Auction deadline" },
+            deadline: { type: 'timestamp', description: 'Auction deadline' },
         },
     },
     stateSchema: {
         properties: {
-            status: { type: "string", computed: true },
-            seller: { type: "address", immutable: true },
-            minBid: { type: "number", immutable: true },
-            bidIncrement: { type: "number" },
-            reservePrice: { type: "number" },
-            deadline: { type: "timestamp" },
-            bids: { type: "array", computed: true },
-            highBid: { type: "number", computed: true },
-            highBidder: { type: "address", computed: true },
+            status: { type: 'string', computed: true },
+            seller: { type: 'address', immutable: true },
+            minBid: { type: 'number', immutable: true },
+            bidIncrement: { type: 'number' },
+            reservePrice: { type: 'number' },
+            deadline: { type: 'timestamp' },
+            bids: { type: 'array', computed: true },
+            highBid: { type: 'number', computed: true },
+            highBidder: { type: 'address', computed: true },
         },
     },
     eventSchemas: {
-        open: { description: "Open the auction" },
-        cancel: { description: "Cancel the auction" },
+        open: { description: 'Open the auction' },
+        cancel: { description: 'Cancel the auction' },
         bid: {
-            description: "Place a bid",
-            required: ["amount"],
-            properties: { amount: { type: "number", minimum: 0 } },
+            description: 'Place a bid',
+            required: ['amount'],
+            properties: { amount: { type: 'number', minimum: 0 } },
         },
-        close: { description: "Close bidding" },
-        settle: { description: "Settle with winning bidder" },
-        no_sale: { description: "Declare no sale (reserve not met or no bids)" },
+        close: { description: 'Close bidding' },
+        settle: { description: 'Settle with winning bidder' },
+        no_sale: { description: 'Declare no sale (reserve not met or no bids)' },
     },
     states: {
         PROPOSED: {
-            id: "PROPOSED",
+            id: 'PROPOSED',
             isFinal: false,
             metadata: {
-                label: "Proposed",
-                description: "Auction created but not yet open",
-                category: "initial",
+                label: 'Proposed',
+                description: 'Auction created but not yet open',
+                category: 'initial',
             },
         },
         OPEN: {
-            id: "OPEN",
+            id: 'OPEN',
             isFinal: false,
             metadata: {
-                label: "Open",
-                description: "Accepting bids",
-                category: "active",
+                label: 'Open',
+                description: 'Accepting bids',
+                category: 'active',
             },
         },
         CLOSING: {
-            id: "CLOSING",
+            id: 'CLOSING',
             isFinal: false,
             metadata: {
-                label: "Closing",
-                description: "Bid period ended, determining winner",
-                category: "pending",
+                label: 'Closing',
+                description: 'Bid period ended, determining winner',
+                category: 'pending',
             },
         },
         SETTLED: {
-            id: "SETTLED",
+            id: 'SETTLED',
             isFinal: true,
             metadata: {
-                label: "Settled",
-                description: "Winner determined, transfer complete",
-                category: "terminal",
+                label: 'Settled',
+                description: 'Winner determined, transfer complete',
+                category: 'terminal',
             },
         },
         NO_SALE: {
-            id: "NO_SALE",
+            id: 'NO_SALE',
             isFinal: true,
             metadata: {
-                label: "No sale",
-                description: "Reserve not met or no valid bids",
-                category: "terminal",
+                label: 'No sale',
+                description: 'Reserve not met or no valid bids',
+                category: 'terminal',
             },
         },
         CANCELLED: {
-            id: "CANCELLED",
+            id: 'CANCELLED',
             isFinal: true,
             metadata: {
-                label: "Cancelled",
-                description: "Auction cancelled by seller",
-                category: "terminal",
+                label: 'Cancelled',
+                description: 'Auction cancelled by seller',
+                category: 'terminal',
             },
         },
     },
-    initialState: "PROPOSED",
+    initialState: 'PROPOSED',
     transitions: [
         {
-            from: "PROPOSED",
-            to: "OPEN",
-            eventName: "open",
-            guard: { "===": [{ var: "event.agent" }, { var: "state.seller" }] },
+            from: 'PROPOSED',
+            to: 'OPEN',
+            eventName: 'open',
+            guard: signerIsParty('state.seller'),
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "OPEN",
-                        openedAt: { var: "$timestamp" },
+                        status: 'OPEN',
+                        openedAt: { var: '$ordinal' },
                         bids: [],
                         highBid: null,
                         highBidder: null,
@@ -144,109 +145,94 @@ export const marketAuctionDef = defineFiberApp({
             dependencies: [],
         },
         {
-            from: "PROPOSED",
-            to: "CANCELLED",
-            eventName: "cancel",
-            guard: { "===": [{ var: "event.agent" }, { var: "state.seller" }] },
+            from: 'PROPOSED',
+            to: 'CANCELLED',
+            eventName: 'cancel',
+            guard: signerIsParty('state.seller'),
             effect: {
-                merge: [
-                    { var: "state" },
-                    { status: "CANCELLED", cancelledAt: { var: "$timestamp" } },
-                ],
+                merge: [{ var: 'state' }, { status: 'CANCELLED', cancelledAt: { var: '$ordinal' } }],
             },
             dependencies: [],
         },
         {
-            from: "OPEN",
-            to: "OPEN",
-            eventName: "bid",
+            from: 'OPEN',
+            to: 'OPEN',
+            eventName: 'bid',
             guard: {
                 and: [
-                    { "!==": [{ var: "event.agent" }, { var: "state.seller" }] },
-                    { ">=": [{ var: "event.amount" }, { var: "state.minBid" }] },
+                    signerIsNotParty('state.seller'),
+                    { '>=': [{ var: 'event.amount' }, { var: 'state.minBid' }] },
                     {
                         or: [
-                            { "!": [{ var: "state.highBid" }] },
+                            { '!': [{ var: 'state.highBid' }] },
                             {
-                                ">=": [
-                                    { var: "event.amount" },
+                                '>=': [
+                                    { var: 'event.amount' },
                                     {
-                                        "+": [
-                                            { var: "state.highBid" },
-                                            { var: "state.bidIncrement" },
-                                        ],
+                                        '+': [{ var: 'state.highBid' }, { var: 'state.bidIncrement' }],
                                     },
                                 ],
                             },
                         ],
                     },
                     {
-                        or: [
-                            { "!": [{ var: "state.deadline" }] },
-                            { "<=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
-                        ],
+                        or: [{ '!': [{ var: 'state.deadline' }] }, { '<=': [{ var: '$ordinal' }, { var: 'state.deadline' }] }],
                     },
                 ],
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
                         bids: {
                             cat: [
-                                { var: "state.bids" },
+                                { var: 'state.bids' },
                                 [
                                     {
-                                        bidder: { var: "event.agent" },
-                                        amount: { var: "event.amount" },
-                                        bidAt: { var: "$timestamp" },
+                                        bidder: { var: 'event.agent' },
+                                        amount: { var: 'event.amount' },
+                                        bidAt: { var: '$ordinal' },
                                     },
                                 ],
                             ],
                         },
-                        highBid: { var: "event.amount" },
-                        highBidder: { var: "event.agent" },
-                        lastBidAt: { var: "$timestamp" },
+                        highBid: { var: 'event.amount' },
+                        highBidder: { var: 'event.agent' },
+                        lastBidAt: { var: '$ordinal' },
                     },
                 ],
             },
             dependencies: [],
         },
         {
-            from: "OPEN",
-            to: "CLOSING",
-            eventName: "close",
+            from: 'OPEN',
+            to: 'CLOSING',
+            eventName: 'close',
             guard: {
                 or: [
-                    { "===": [{ var: "event.agent" }, { var: "state.seller" }] },
+                    signerIsParty('state.seller'),
                     {
-                        and: [
-                            { var: "state.deadline" },
-                            { ">=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
-                        ],
+                        and: [{ var: 'state.deadline' }, { '>=': [{ var: '$ordinal' }, { var: 'state.deadline' }] }],
                     },
                 ],
             },
             effect: {
-                merge: [
-                    { var: "state" },
-                    { status: "CLOSING", closedAt: { var: "$timestamp" } },
-                ],
+                merge: [{ var: 'state' }, { status: 'CLOSING', closedAt: { var: '$ordinal' } }],
             },
             dependencies: [],
         },
         {
-            from: "CLOSING",
-            to: "SETTLED",
-            eventName: "settle",
+            from: 'CLOSING',
+            to: 'SETTLED',
+            eventName: 'settle',
             guard: {
                 and: [
-                    { var: "state.highBidder" },
+                    { var: 'state.highBidder' },
                     {
                         or: [
-                            { "!": [{ var: "state.reservePrice" }] },
+                            { '!': [{ var: 'state.reservePrice' }] },
                             {
-                                ">=": [{ var: "state.highBid" }, { var: "state.reservePrice" }],
+                                '>=': [{ var: 'state.highBid' }, { var: 'state.reservePrice' }],
                             },
                         ],
                     },
@@ -254,29 +240,29 @@ export const marketAuctionDef = defineFiberApp({
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "SETTLED",
-                        settledAt: { var: "$timestamp" },
-                        winner: { var: "state.highBidder" },
-                        finalPrice: { var: "state.highBid" },
+                        status: 'SETTLED',
+                        settledAt: { var: '$ordinal' },
+                        winner: { var: 'state.highBidder' },
+                        finalPrice: { var: 'state.highBid' },
                     },
                 ],
             },
             dependencies: [],
         },
         {
-            from: "CLOSING",
-            to: "NO_SALE",
-            eventName: "no_sale",
+            from: 'CLOSING',
+            to: 'NO_SALE',
+            eventName: 'no_sale',
             guard: {
                 or: [
-                    { "!": [{ var: "state.highBidder" }] },
+                    { '!': [{ var: 'state.highBidder' }] },
                     {
                         and: [
-                            { var: "state.reservePrice" },
+                            { var: 'state.reservePrice' },
                             {
-                                "<": [{ var: "state.highBid" }, { var: "state.reservePrice" }],
+                                '<': [{ var: 'state.highBid' }, { var: 'state.reservePrice' }],
                             },
                         ],
                     },
@@ -284,16 +270,12 @@ export const marketAuctionDef = defineFiberApp({
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "NO_SALE",
-                        closedAt: { var: "$timestamp" },
+                        status: 'NO_SALE',
+                        closedAt: { var: '$ordinal' },
                         reason: {
-                            if: [
-                                { "!": [{ var: "state.highBidder" }] },
-                                "no_bids",
-                                "reserve_not_met",
-                            ],
+                            if: [{ '!': [{ var: 'state.highBidder' }] }, 'no_bids', 'reserve_not_met'],
                         },
                     },
                 ],