@ottochain/sdk 2.0.0 → 2.2.0

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

@@ -0,0 +1,652 @@
+/**
+ * Simple org governance: manage members, update rules, resolve disputes.
+ */
+export declare const govSimpleDef: {
+    readonly metadata: {
+        readonly name: "Governance";
+        readonly app: "governance";
+        readonly type: "simple";
+        readonly version: "1.0.0";
+        readonly description: "Simple org governance: manage members, update rules, resolve disputes";
+    };
+    readonly createSchema: {
+        readonly required: readonly ["admins", "passingThreshold", "disputeQuorum", "votingPeriodMs"];
+        readonly properties: {
+            readonly admins: {
+                readonly type: "array";
+                readonly description: "Initial admin addresses";
+                readonly immutable: false;
+            };
+            readonly passingThreshold: {
+                readonly type: "number";
+                readonly description: "Fraction of members required to pass (0-1)";
+            };
+            readonly disputeQuorum: {
+                readonly type: "number";
+                readonly description: "Min votes to resolve a dispute";
+            };
+            readonly votingPeriodMs: {
+                readonly type: "number";
+                readonly description: "Voting window in milliseconds";
+            };
+        };
+    };
+    readonly stateSchema: {
+        readonly properties: {
+            readonly admins: {
+                readonly type: "array";
+                readonly immutable: false;
+            };
+            readonly members: {
+                readonly type: "object";
+                readonly computed: true;
+            };
+            readonly rules: {
+                readonly type: "object";
+                readonly computed: true;
+            };
+            readonly history: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+            readonly proposal: {
+                readonly type: "object";
+            };
+            readonly votes: {
+                readonly type: "object";
+                readonly computed: true;
+            };
+            readonly dispute: {
+                readonly type: "object";
+            };
+            readonly passingThreshold: {
+                readonly type: "number";
+            };
+            readonly disputeQuorum: {
+                readonly type: "number";
+            };
+            readonly votingPeriodMs: {
+                readonly type: "number";
+            };
+        };
+    };
+    readonly eventSchemas: {
+        readonly add_member: {
+            readonly description: "Add a member (admin only)";
+            readonly required: readonly ["member", "role"];
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly member: {
+                    readonly type: "address";
+                };
+                readonly role: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly remove_member: {
+            readonly description: "Remove a member (admin only)";
+            readonly required: readonly ["member"];
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly member: {
+                    readonly type: "address";
+                };
+            };
+        };
+        readonly propose: {
+            readonly description: "Submit a rule change proposal";
+            readonly required: readonly ["proposalId", "type", "changes"];
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly proposalId: {
+                    readonly type: "string";
+                };
+                readonly type: {
+                    readonly type: "string";
+                };
+                readonly changes: {
+                    readonly type: "object";
+                };
+            };
+        };
+        readonly vote: {
+            readonly description: "Cast a vote on the active proposal or dispute";
+            readonly required: readonly ["vote"];
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly vote: {
+                    readonly type: "string";
+                };
+                readonly ruling: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly finalize: {
+            readonly description: "Finalize the voting period";
+            readonly required: readonly ["forCount"];
+            readonly properties: {
+                readonly forCount: {
+                    readonly type: "number";
+                };
+            };
+        };
+        readonly file_dispute: {
+            readonly description: "File a dispute against a member";
+            readonly required: readonly ["disputeId", "defendant", "claim"];
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly disputeId: {
+                    readonly type: "string";
+                };
+                readonly defendant: {
+                    readonly type: "address";
+                };
+                readonly claim: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly submit_evidence: {
+            readonly description: "Submit evidence in a dispute";
+            readonly required: readonly ["content"];
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly content: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly resolve: {
+            readonly description: "Resolve the active dispute";
+            readonly required: readonly ["ruling", "remedy"];
+            readonly properties: {
+                readonly ruling: {
+                    readonly type: "string";
+                };
+                readonly remedy: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly dissolve: {
+            readonly description: "Dissolve the organization (requires 90% approval)";
+            readonly required: readonly ["approvalCount"];
+            readonly properties: {
+                readonly approvalCount: {
+                    readonly type: "number";
+                };
+            };
+        };
+    };
+    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 DISPUTE: {
+            readonly id: "DISPUTE";
+            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: "ACTIVE";
+        readonly eventName: "add_member";
+        readonly guard: {
+            readonly in: readonly [{
+                readonly var: "event.agent";
+            }, {
+                readonly var: "state.admins";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly members: {
+                    readonly setKey: readonly [{
+                        readonly var: "state.members";
+                    }, {
+                        readonly var: "event.member";
+                    }, {
+                        readonly role: {
+                            readonly var: "event.role";
+                        };
+                        readonly addedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "ACTIVE";
+        readonly to: "ACTIVE";
+        readonly eventName: "remove_member";
+        readonly guard: {
+            readonly in: readonly [{
+                readonly var: "event.agent";
+            }, {
+                readonly var: "state.admins";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly members: {
+                    readonly deleteKey: readonly [{
+                        readonly var: "state.members";
+                    }, {
+                        readonly var: "event.member";
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "ACTIVE";
+        readonly to: "VOTING";
+        readonly eventName: "propose";
+        readonly guard: {
+            readonly getKey: readonly [{
+                readonly var: "state.members";
+            }, {
+                readonly var: "event.agent";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly proposal: {
+                    readonly id: {
+                        readonly var: "event.proposalId";
+                    };
+                    readonly type: {
+                        readonly var: "event.type";
+                    };
+                    readonly changes: {
+                        readonly var: "event.changes";
+                    };
+                    readonly proposer: {
+                        readonly var: "event.agent";
+                    };
+                    readonly proposedAt: {
+                        readonly var: "$timestamp";
+                    };
+                    readonly deadline: {
+                        readonly "+": readonly [{
+                            readonly var: "$timestamp";
+                        }, {
+                            readonly var: "state.votingPeriodMs";
+                        }];
+                    };
+                };
+                readonly votes: {};
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "VOTING";
+        readonly to: "VOTING";
+        readonly eventName: "vote";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly getKey: readonly [{
+                    readonly var: "state.members";
+                }, {
+                    readonly var: "event.agent";
+                }];
+            }, {
+                readonly "!": readonly [{
+                    readonly getKey: readonly [{
+                        readonly var: "state.votes";
+                    }, {
+                        readonly var: "event.agent";
+                    }];
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly votes: {
+                    readonly setKey: readonly [{
+                        readonly var: "state.votes";
+                    }, {
+                        readonly var: "event.agent";
+                    }, {
+                        readonly vote: {
+                            readonly var: "event.vote";
+                        };
+                        readonly votedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "VOTING";
+        readonly to: "ACTIVE";
+        readonly eventName: "finalize";
+        readonly guard: {
+            readonly ">=": readonly [{
+                readonly var: "event.forCount";
+            }, {
+                readonly "*": readonly [{
+                    readonly size: {
+                        readonly var: "state.members";
+                    };
+                }, {
+                    readonly var: "state.passingThreshold";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly rules: {
+                    readonly merge: readonly [{
+                        readonly var: "state.rules";
+                    }, {
+                        readonly var: "state.proposal.changes";
+                    }];
+                };
+                readonly history: {
+                    readonly cat: readonly [{
+                        readonly var: "state.history";
+                    }, readonly [{
+                        readonly type: "rule_change";
+                        readonly proposal: {
+                            readonly var: "state.proposal";
+                        };
+                        readonly outcome: "passed";
+                        readonly finalizedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }]];
+                };
+                readonly proposal: null;
+                readonly votes: {};
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "VOTING";
+        readonly to: "ACTIVE";
+        readonly eventName: "finalize";
+        readonly guard: {
+            readonly "<": readonly [{
+                readonly var: "event.forCount";
+            }, {
+                readonly "*": readonly [{
+                    readonly size: {
+                        readonly var: "state.members";
+                    };
+                }, {
+                    readonly var: "state.passingThreshold";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly history: {
+                    readonly cat: readonly [{
+                        readonly var: "state.history";
+                    }, readonly [{
+                        readonly type: "rule_change";
+                        readonly proposal: {
+                            readonly var: "state.proposal";
+                        };
+                        readonly outcome: "failed";
+                        readonly finalizedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }]];
+                };
+                readonly proposal: null;
+                readonly votes: {};
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "ACTIVE";
+        readonly to: "DISPUTE";
+        readonly eventName: "file_dispute";
+        readonly guard: {
+            readonly getKey: readonly [{
+                readonly var: "state.members";
+            }, {
+                readonly var: "event.agent";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly dispute: {
+                    readonly id: {
+                        readonly var: "event.disputeId";
+                    };
+                    readonly plaintiff: {
+                        readonly var: "event.agent";
+                    };
+                    readonly defendant: {
+                        readonly var: "event.defendant";
+                    };
+                    readonly claim: {
+                        readonly var: "event.claim";
+                    };
+                    readonly filedAt: {
+                        readonly var: "$timestamp";
+                    };
+                    readonly evidence: readonly [];
+                };
+                readonly votes: {};
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "DISPUTE";
+        readonly to: "DISPUTE";
+        readonly eventName: "submit_evidence";
+        readonly guard: {
+            readonly or: readonly [{
+                readonly "===": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.dispute.plaintiff";
+                }];
+            }, {
+                readonly "===": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.dispute.defendant";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly dispute: {
+                    readonly merge: readonly [{
+                        readonly var: "state.dispute";
+                    }, {
+                        readonly evidence: {
+                            readonly cat: readonly [{
+                                readonly var: "state.dispute.evidence";
+                            }, readonly [{
+                                readonly from: {
+                                    readonly var: "event.agent";
+                                };
+                                readonly content: {
+                                    readonly var: "event.content";
+                                };
+                                readonly at: {
+                                    readonly var: "$timestamp";
+                                };
+                            }]];
+                        };
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "DISPUTE";
+        readonly to: "DISPUTE";
+        readonly eventName: "vote";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly getKey: readonly [{
+                    readonly var: "state.members";
+                }, {
+                    readonly var: "event.agent";
+                }];
+            }, {
+                readonly "!==": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.dispute.plaintiff";
+                }];
+            }, {
+                readonly "!==": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.dispute.defendant";
+                }];
+            }, {
+                readonly "!": readonly [{
+                    readonly getKey: readonly [{
+                        readonly var: "state.votes";
+                    }, {
+                        readonly var: "event.agent";
+                    }];
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly votes: {
+                    readonly setKey: readonly [{
+                        readonly var: "state.votes";
+                    }, {
+                        readonly var: "event.agent";
+                    }, {
+                        readonly ruling: {
+                            readonly var: "event.ruling";
+                        };
+                        readonly votedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "DISPUTE";
+        readonly to: "ACTIVE";
+        readonly eventName: "resolve";
+        readonly guard: {
+            readonly ">=": readonly [{
+                readonly size: {
+                    readonly var: "state.votes";
+                };
+            }, {
+                readonly var: "state.disputeQuorum";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly history: {
+                    readonly cat: readonly [{
+                        readonly var: "state.history";
+                    }, readonly [{
+                        readonly type: "dispute";
+                        readonly dispute: {
+                            readonly var: "state.dispute";
+                        };
+                        readonly ruling: {
+                            readonly var: "event.ruling";
+                        };
+                        readonly remedy: {
+                            readonly var: "event.remedy";
+                        };
+                        readonly resolvedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }]];
+                };
+                readonly dispute: null;
+                readonly votes: {};
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "ACTIVE";
+        readonly to: "DISSOLVED";
+        readonly eventName: "dissolve";
+        readonly guard: {
+            readonly ">=": readonly [{
+                readonly var: "event.approvalCount";
+            }, {
+                readonly "*": readonly [{
+                    readonly size: {
+                        readonly var: "state.members";
+                    };
+                }, 0.9];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly dissolvedAt: {
+                    readonly var: "$timestamp";
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }];
+};