@ottochain/sdk 1.7.0-beta.2 → 2.1.0

package/dist/types/apps/markets/state-machines/market-auction.d.ts

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