@ottochain/sdk 2.0.0 → 2.2.0

package/dist/types/apps/governance/state-machines/governance-universal.d.ts

@@ -0,0 +1,181 @@
+/**
+ * Minimal governance state machine - extend for custom use cases.
+ */
+export declare const govUniversalDef: {
+    readonly metadata: {
+        readonly name: "GovernanceUniversal";
+        readonly app: "governance";
+        readonly type: "universal";
+        readonly version: "1.0.0";
+        readonly description: "Minimal governance state machine - extend for custom use cases";
+    };
+    readonly createSchema: {
+        readonly properties: {};
+    };
+    readonly stateSchema: {
+        readonly properties: {
+            readonly status: {
+                readonly type: "string";
+            };
+            readonly proposal: {
+                readonly type: "object";
+            };
+            readonly proposedAt: {
+                readonly type: "timestamp";
+            };
+            readonly votes: {
+                readonly type: "object";
+                readonly computed: true;
+            };
+            readonly lastProposal: {
+                readonly type: "object";
+            };
+            readonly lastResult: {
+                readonly type: "string";
+            };
+            readonly dissolvedAt: {
+                readonly type: "timestamp";
+            };
+        };
+    };
+    readonly eventSchemas: {
+        readonly propose: {
+            readonly description: "Submit a new proposal";
+            readonly properties: {
+                readonly proposal: {
+                    readonly type: "object";
+                };
+            };
+        };
+        readonly vote: {
+            readonly description: "Cast a vote on the active proposal";
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly vote: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly finalize: {
+            readonly description: "Finalize the current proposal";
+            readonly properties: {
+                readonly result: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly dissolve: {
+            readonly description: "Dissolve the governance entity";
+        };
+    };
+    readonly states: {
+        readonly ACTIVE: {
+            readonly id: "ACTIVE";
+            readonly isFinal: false;
+            readonly metadata: null;
+        };
+        readonly VOTING: {
+            readonly id: "VOTING";
+            readonly isFinal: false;
+            readonly metadata: null;
+        };
+        readonly DISSOLVED: {
+            readonly id: "DISSOLVED";
+            readonly isFinal: true;
+            readonly metadata: null;
+        };
+    };
+    readonly initialState: "ACTIVE";
+    readonly transitions: readonly [{
+        readonly from: "ACTIVE";
+        readonly to: "VOTING";
+        readonly eventName: "propose";
+        readonly guard: {
+            readonly "==": readonly [1, 1];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "VOTING";
+                readonly proposal: {
+                    readonly var: "event.proposal";
+                };
+                readonly proposedAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly votes: {};
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "VOTING";
+        readonly to: "VOTING";
+        readonly eventName: "vote";
+        readonly guard: {
+            readonly "==": readonly [1, 1];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly votes: {
+                    readonly merge: readonly [{
+                        readonly var: "state.votes";
+                    }, {
+                        readonly __key: {
+                            readonly var: "event.agent";
+                        };
+                        readonly __value: {
+                            readonly var: "event.vote";
+                        };
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "VOTING";
+        readonly to: "ACTIVE";
+        readonly eventName: "finalize";
+        readonly guard: {
+            readonly "==": readonly [1, 1];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "ACTIVE";
+                readonly lastProposal: {
+                    readonly var: "state.proposal";
+                };
+                readonly lastResult: {
+                    readonly var: "event.result";
+                };
+                readonly proposal: null;
+                readonly votes: null;
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "ACTIVE";
+        readonly to: "DISSOLVED";
+        readonly eventName: "dissolve";
+        readonly guard: {
+            readonly "==": readonly [1, 1];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "DISSOLVED";
+                readonly dissolvedAt: {
+                    readonly var: "$timestamp";
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }];
+};