@ottochain/sdk 2.0.0 → 2.2.0

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

@@ -0,0 +1,651 @@
+/**
+ * Binary or multi-outcome prediction market with oracle resolution and position staking.
+ */
+export declare const marketPredictionDef: {
+    readonly metadata: {
+        readonly name: "MarketPrediction";
+        readonly app: "markets";
+        readonly type: "prediction";
+        readonly version: "1.0.0";
+        readonly description: "Binary or multi-outcome prediction market with oracle resolution and position staking";
+        readonly crossReferences: {
+            readonly oracleId: "Links to IdentityOracle that resolves the outcome";
+            readonly creatorIdentityId: "Links to creator's IdentityAgent";
+        };
+    };
+    readonly createSchema: {
+        readonly required: readonly ["creator", "outcomes", "oracles", "quorum"];
+        readonly properties: {
+            readonly creator: {
+                readonly type: "address";
+                readonly description: "DAG address of the market creator";
+                readonly immutable: true;
+            };
+            readonly outcomes: {
+                readonly type: "array";
+                readonly description: "Valid outcome identifiers";
+                readonly immutable: true;
+            };
+            readonly oracles: {
+                readonly type: "array";
+                readonly description: "Authorized oracle addresses";
+                readonly immutable: true;
+            };
+            readonly quorum: {
+                readonly type: "number";
+                readonly description: "Minimum oracle submissions needed to resolve";
+                readonly immutable: true;
+            };
+            readonly deadline: {
+                readonly type: "timestamp";
+                readonly description: "Optional trading deadline";
+            };
+        };
+    };
+    readonly stateSchema: {
+        readonly properties: {
+            readonly status: {
+                readonly type: "string";
+                readonly computed: true;
+            };
+            readonly creator: {
+                readonly type: "address";
+                readonly immutable: true;
+            };
+            readonly outcomes: {
+                readonly type: "array";
+                readonly immutable: true;
+            };
+            readonly oracles: {
+                readonly type: "array";
+                readonly immutable: true;
+            };
+            readonly quorum: {
+                readonly type: "number";
+                readonly immutable: true;
+            };
+            readonly deadline: {
+                readonly type: "timestamp";
+            };
+            readonly positions: {
+                readonly type: "object";
+                readonly computed: true;
+            };
+            readonly totalPool: {
+                readonly type: "number";
+                readonly computed: true;
+            };
+            readonly resolutions: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+            readonly finalOutcome: {
+                readonly type: "string";
+                readonly computed: true;
+            };
+            readonly claims: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+        };
+    };
+    readonly eventSchemas: {
+        readonly open: {
+            readonly description: "Open the market for trading";
+        };
+        readonly cancel: {
+            readonly description: "Cancel the market before opening";
+            readonly properties: {
+                readonly reason: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly take_position: {
+            readonly description: "Take a position on an outcome";
+            readonly required: readonly ["outcome", "amount"];
+            readonly properties: {
+                readonly outcome: {
+                    readonly type: "string";
+                };
+                readonly amount: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                };
+            };
+        };
+        readonly close: {
+            readonly description: "Close trading";
+        };
+        readonly submit_resolution: {
+            readonly description: "Submit oracle resolution";
+            readonly required: readonly ["outcome", "proof"];
+            readonly properties: {
+                readonly outcome: {
+                    readonly type: "string";
+                };
+                readonly proof: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly finalize: {
+            readonly description: "Finalize market after quorum reached";
+            readonly properties: {
+                readonly outcome: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly dispute: {
+            readonly description: "Dispute the resolution";
+            readonly required: readonly ["stake"];
+            readonly properties: {
+                readonly stake: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                };
+                readonly reason: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly ruling: {
+            readonly description: "Judicial ruling on dispute";
+            readonly properties: {
+                readonly judicialRuling: {
+                    readonly type: "boolean";
+                };
+                readonly outcome: {
+                    readonly type: "string";
+                };
+                readonly rulingId: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly invalidate: {
+            readonly description: "Invalidate market by oracle consensus";
+        };
+        readonly claim: {
+            readonly description: "Claim payout after settlement";
+            readonly properties: {
+                readonly amount: {
+                    readonly type: "number";
+                };
+            };
+        };
+    };
+    readonly states: {
+        readonly PROPOSED: {
+            readonly id: "PROPOSED";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Market created but not yet open for trading";
+            };
+        };
+        readonly OPEN: {
+            readonly id: "OPEN";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Accepting positions on outcomes";
+            };
+        };
+        readonly CLOSED: {
+            readonly id: "CLOSED";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "No more positions, awaiting resolution";
+            };
+        };
+        readonly RESOLVING: {
+            readonly id: "RESOLVING";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Oracle(s) submitting resolution";
+            };
+        };
+        readonly DISPUTED: {
+            readonly id: "DISPUTED";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Resolution challenged, awaiting arbitration";
+            };
+        };
+        readonly SETTLED: {
+            readonly id: "SETTLED";
+            readonly isFinal: true;
+            readonly metadata: {
+                readonly description: "Outcome finalized, payouts available";
+            };
+        };
+        readonly REFUNDED: {
+            readonly id: "REFUNDED";
+            readonly isFinal: true;
+            readonly metadata: {
+                readonly description: "Market invalidated, all positions refunded";
+            };
+        };
+        readonly CANCELLED: {
+            readonly id: "CANCELLED";
+            readonly isFinal: true;
+            readonly metadata: {
+                readonly description: "Market cancelled before opening";
+            };
+        };
+    };
+    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.creator";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "OPEN";
+                readonly openedAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly positions: {};
+                readonly totalPool: 0;
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "PROPOSED";
+        readonly to: "CANCELLED";
+        readonly eventName: "cancel";
+        readonly guard: {
+            readonly "===": readonly [{
+                readonly var: "event.agent";
+            }, {
+                readonly var: "state.creator";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "CANCELLED";
+                readonly cancelledAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly reason: {
+                    readonly var: "event.reason";
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "OPEN";
+        readonly to: "OPEN";
+        readonly eventName: "take_position";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly var: "event.amount";
+                }, 0];
+            }, {
+                readonly in: readonly [{
+                    readonly var: "event.outcome";
+                }, {
+                    readonly var: "state.outcomes";
+                }];
+            }, {
+                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 positions: {
+                    readonly merge: readonly [{
+                        readonly var: "state.positions";
+                    }, {
+                        readonly __computed: {
+                            readonly cat: readonly [{
+                                readonly var: "event.agent";
+                            }, "_", {
+                                readonly var: "event.outcome";
+                            }];
+                        };
+                    }];
+                };
+                readonly totalPool: {
+                    readonly "+": readonly [{
+                        readonly var: "state.totalPool";
+                    }, {
+                        readonly var: "event.amount";
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "OPEN";
+        readonly to: "CLOSED";
+        readonly eventName: "close";
+        readonly guard: {
+            readonly or: readonly [{
+                readonly "===": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.creator";
+                }];
+            }, {
+                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: "CLOSED";
+                readonly closedAt: {
+                    readonly var: "$timestamp";
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "CLOSED";
+        readonly to: "RESOLVING";
+        readonly eventName: "submit_resolution";
+        readonly guard: {
+            readonly in: readonly [{
+                readonly var: "event.agent";
+            }, {
+                readonly var: "state.oracles";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "RESOLVING";
+                readonly resolutions: readonly [{
+                    readonly oracle: {
+                        readonly var: "event.agent";
+                    };
+                    readonly outcome: {
+                        readonly var: "event.outcome";
+                    };
+                    readonly proof: {
+                        readonly var: "event.proof";
+                    };
+                    readonly submittedAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "RESOLVING";
+        readonly to: "RESOLVING";
+        readonly eventName: "submit_resolution";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly in: readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.oracles";
+                }];
+            }, {
+                readonly "!": readonly [{
+                    readonly in: readonly [{
+                        readonly var: "event.agent";
+                    }, {
+                        readonly map: readonly [{
+                            readonly var: "state.resolutions";
+                        }, {
+                            readonly var: "oracle";
+                        }];
+                    }];
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly resolutions: {
+                    readonly cat: readonly [{
+                        readonly var: "state.resolutions";
+                    }, readonly [{
+                        readonly oracle: {
+                            readonly var: "event.agent";
+                        };
+                        readonly outcome: {
+                            readonly var: "event.outcome";
+                        };
+                        readonly proof: {
+                            readonly var: "event.proof";
+                        };
+                        readonly submittedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }]];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "RESOLVING";
+        readonly to: "SETTLED";
+        readonly eventName: "finalize";
+        readonly guard: {
+            readonly ">=": readonly [{
+                readonly size: {
+                    readonly var: "state.resolutions";
+                };
+            }, {
+                readonly var: "state.quorum";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "SETTLED";
+                readonly settledAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly finalOutcome: {
+                    readonly var: "event.outcome";
+                };
+                readonly claims: readonly [];
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "RESOLVING";
+        readonly to: "DISPUTED";
+        readonly eventName: "dispute";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly size: {
+                        readonly filter: readonly [{
+                            readonly var: "state.positions";
+                        }, {
+                            readonly "===": readonly [{
+                                readonly var: "agent";
+                            }, {
+                                readonly var: "event.agent";
+                            }];
+                        }];
+                    };
+                }, 0];
+            }, {
+                readonly var: "event.stake";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "DISPUTED";
+                readonly disputedAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly disputedBy: {
+                    readonly var: "event.agent";
+                };
+                readonly disputeStake: {
+                    readonly var: "event.stake";
+                };
+                readonly disputeReason: {
+                    readonly var: "event.reason";
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "DISPUTED";
+        readonly to: "SETTLED";
+        readonly eventName: "ruling";
+        readonly guard: {
+            readonly var: "event.judicialRuling";
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "SETTLED";
+                readonly settledAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly finalOutcome: {
+                    readonly var: "event.outcome";
+                };
+                readonly rulingId: {
+                    readonly var: "event.rulingId";
+                };
+                readonly claims: readonly [];
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "RESOLVING";
+        readonly to: "REFUNDED";
+        readonly eventName: "invalidate";
+        readonly guard: {
+            readonly ">=": readonly [{
+                readonly size: {
+                    readonly filter: readonly [{
+                        readonly var: "state.resolutions";
+                    }, {
+                        readonly "===": readonly [{
+                            readonly var: "outcome";
+                        }, "INVALID"];
+                    }];
+                };
+            }, {
+                readonly var: "state.quorum";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "REFUNDED";
+                readonly refundedAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly reason: "oracle_invalidation";
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "SETTLED";
+        readonly to: "SETTLED";
+        readonly eventName: "claim";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly size: {
+                        readonly filter: readonly [{
+                            readonly var: "state.positions";
+                        }, {
+                            readonly and: readonly [{
+                                readonly "===": readonly [{
+                                    readonly var: "agent";
+                                }, {
+                                    readonly var: "event.agent";
+                                }];
+                            }, {
+                                readonly "===": readonly [{
+                                    readonly var: "outcome";
+                                }, {
+                                    readonly var: "state.finalOutcome";
+                                }];
+                            }];
+                        }];
+                    };
+                }, 0];
+            }, {
+                readonly "!": readonly [{
+                    readonly in: readonly [{
+                        readonly var: "event.agent";
+                    }, {
+                        readonly map: readonly [{
+                            readonly var: "state.claims";
+                        }, {
+                            readonly var: "agent";
+                        }];
+                    }];
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly claims: {
+                    readonly cat: readonly [{
+                        readonly var: "state.claims";
+                    }, readonly [{
+                        readonly agent: {
+                            readonly var: "event.agent";
+                        };
+                        readonly amount: {
+                            readonly var: "event.amount";
+                        };
+                        readonly claimedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }]];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }];
+};