@ottochain/sdk 1.7.0-beta.2 → 2.1.0

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

@@ -0,0 +1,601 @@
+/**
+ * Token-weighted voting. Voting power proportional to token holdings.
+ */
+export declare const daoTokenDef: {
+    readonly metadata: {
+        readonly name: "TokenDAO";
+        readonly app: "governance";
+        readonly type: "daoToken";
+        readonly version: "1.0.0";
+        readonly description: "Token-weighted voting. Voting power proportional to token holdings.";
+        readonly category: "governance/dao";
+        readonly crossReferences: {
+            readonly Identity: "voter verification";
+            readonly Token: "balance snapshots";
+            readonly Contract: "action execution";
+            readonly Treasury: "fund management";
+        };
+    };
+    readonly createSchema: {
+        readonly required: readonly ["balances", "proposalThreshold", "quorum", "votingPeriodMs", "timelockMs"];
+        readonly properties: {
+            readonly balances: {
+                readonly type: "object";
+                readonly description: "Initial token balances by address";
+            };
+            readonly proposalThreshold: {
+                readonly type: "number";
+                readonly description: "Min token balance to submit a proposal";
+            };
+            readonly quorum: {
+                readonly type: "number";
+                readonly description: "Min total votes (weighted) to pass";
+            };
+            readonly votingPeriodMs: {
+                readonly type: "number";
+                readonly description: "Voting window in milliseconds";
+            };
+            readonly timelockMs: {
+                readonly type: "number";
+                readonly description: "Time-lock delay before execution";
+            };
+        };
+    };
+    readonly stateSchema: {
+        readonly properties: {
+            readonly balances: {
+                readonly type: "object";
+            };
+            readonly delegations: {
+                readonly type: "object";
+                readonly computed: true;
+            };
+            readonly proposalThreshold: {
+                readonly type: "number";
+            };
+            readonly quorum: {
+                readonly type: "number";
+            };
+            readonly votingPeriodMs: {
+                readonly type: "number";
+            };
+            readonly timelockMs: {
+                readonly type: "number";
+            };
+            readonly proposal: {
+                readonly type: "object";
+            };
+            readonly votes: {
+                readonly type: "object";
+                readonly computed: true;
+            };
+            readonly executedProposals: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+            readonly rejectedProposals: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+            readonly cancelledProposals: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+        };
+    };
+    readonly eventSchemas: {
+        readonly propose: {
+            readonly description: "Submit a proposal (requires >= proposalThreshold tokens)";
+            readonly required: readonly ["proposalId", "title", "description", "actionType", "payload"];
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly proposalId: {
+                    readonly type: "string";
+                };
+                readonly title: {
+                    readonly type: "string";
+                };
+                readonly description: {
+                    readonly type: "string";
+                };
+                readonly actionType: {
+                    readonly type: "string";
+                };
+                readonly payload: {
+                    readonly type: "object";
+                };
+                readonly snapshotBlock: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly vote: {
+            readonly description: "Cast a token-weighted vote (must hold tokens, no double-vote, within window)";
+            readonly required: readonly ["vote"];
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly vote: {
+                    readonly type: "string";
+                    readonly description: "\"for\" | \"against\" | \"abstain\"";
+                };
+            };
+        };
+        readonly queue: {
+            readonly description: "Queue passing proposal into timelock (voting ended, for > against, quorum met)";
+            readonly properties: {};
+        };
+        readonly execute: {
+            readonly description: "Execute queued proposal after timelock expires";
+            readonly properties: {};
+        };
+        readonly reject: {
+            readonly description: "Formally reject a failed proposal (voting ended, failed conditions)";
+            readonly properties: {};
+        };
+        readonly cancel: {
+            readonly description: "Cancel a queued proposal (proposer only)";
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+            };
+        };
+        readonly delegate: {
+            readonly description: "Delegate voting power to another address";
+            readonly required: readonly ["delegateTo"];
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+                readonly delegateTo: {
+                    readonly type: "address";
+                };
+            };
+        };
+        readonly undelegate: {
+            readonly description: "Revoke delegation";
+            readonly properties: {
+                readonly agent: {
+                    readonly type: "address";
+                };
+            };
+        };
+    };
+    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 QUEUED: {
+            readonly id: "QUEUED";
+            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 [{
+                readonly getKey: readonly [{
+                    readonly var: "state.balances";
+                }, {
+                    readonly var: "event.agent";
+                }];
+            }, {
+                readonly var: "state.proposalThreshold";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly proposal: {
+                    readonly id: {
+                        readonly var: "event.proposalId";
+                    };
+                    readonly title: {
+                        readonly var: "event.title";
+                    };
+                    readonly description: {
+                        readonly var: "event.description";
+                    };
+                    readonly actionType: {
+                        readonly var: "event.actionType";
+                    };
+                    readonly payload: {
+                        readonly var: "event.payload";
+                    };
+                    readonly proposer: {
+                        readonly var: "event.agent";
+                    };
+                    readonly proposedAt: {
+                        readonly var: "$timestamp";
+                    };
+                    readonly votingEndsAt: {
+                        readonly "+": readonly [{
+                            readonly var: "$timestamp";
+                        }, {
+                            readonly var: "state.votingPeriodMs";
+                        }];
+                    };
+                    readonly snapshotBlock: {
+                        readonly var: "event.snapshotBlock";
+                    };
+                };
+                readonly votes: {
+                    readonly for: 0;
+                    readonly against: 0;
+                    readonly abstain: 0;
+                    readonly voters: {};
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "VOTING";
+        readonly to: "VOTING";
+        readonly eventName: "vote";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly getKey: readonly [{
+                        readonly var: "state.balances";
+                    }, {
+                        readonly var: "event.agent";
+                    }];
+                }, 0];
+            }, {
+                readonly "!": readonly [{
+                    readonly getKey: readonly [{
+                        readonly var: "state.votes.voters";
+                    }, {
+                        readonly var: "event.agent";
+                    }];
+                }];
+            }, {
+                readonly "<=": readonly [{
+                    readonly var: "$timestamp";
+                }, {
+                    readonly var: "state.proposal.votingEndsAt";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly votes: {
+                    readonly merge: readonly [{
+                        readonly var: "state.votes";
+                    }, {
+                        readonly if: readonly [{
+                            readonly "===": readonly [{
+                                readonly var: "event.vote";
+                            }, "for"];
+                        }, {
+                            readonly for: {
+                                readonly "+": readonly [{
+                                    readonly var: "state.votes.for";
+                                }, {
+                                    readonly getKey: readonly [{
+                                        readonly var: "state.balances";
+                                    }, {
+                                        readonly var: "event.agent";
+                                    }];
+                                }];
+                            };
+                        }, {
+                            readonly "===": readonly [{
+                                readonly var: "event.vote";
+                            }, "against"];
+                        }, {
+                            readonly against: {
+                                readonly "+": readonly [{
+                                    readonly var: "state.votes.against";
+                                }, {
+                                    readonly getKey: readonly [{
+                                        readonly var: "state.balances";
+                                    }, {
+                                        readonly var: "event.agent";
+                                    }];
+                                }];
+                            };
+                        }, {
+                            readonly abstain: {
+                                readonly "+": readonly [{
+                                    readonly var: "state.votes.abstain";
+                                }, {
+                                    readonly getKey: readonly [{
+                                        readonly var: "state.balances";
+                                    }, {
+                                        readonly var: "event.agent";
+                                    }];
+                                }];
+                            };
+                        }];
+                    }, {
+                        readonly voters: {
+                            readonly setKey: readonly [{
+                                readonly var: "state.votes.voters";
+                            }, {
+                                readonly var: "event.agent";
+                            }, {
+                                readonly vote: {
+                                    readonly var: "event.vote";
+                                };
+                                readonly weight: {
+                                    readonly getKey: readonly [{
+                                        readonly var: "state.balances";
+                                    }, {
+                                        readonly var: "event.agent";
+                                    }];
+                                };
+                                readonly votedAt: {
+                                    readonly var: "$timestamp";
+                                };
+                            }];
+                        };
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "VOTING";
+        readonly to: "QUEUED";
+        readonly eventName: "queue";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly var: "$timestamp";
+                }, {
+                    readonly var: "state.proposal.votingEndsAt";
+                }];
+            }, {
+                readonly ">": readonly [{
+                    readonly var: "state.votes.for";
+                }, {
+                    readonly var: "state.votes.against";
+                }];
+            }, {
+                readonly ">=": readonly [{
+                    readonly "+": readonly [{
+                        readonly var: "state.votes.for";
+                    }, {
+                        readonly var: "state.votes.against";
+                    }, {
+                        readonly var: "state.votes.abstain";
+                    }];
+                }, {
+                    readonly var: "state.quorum";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly proposal: {
+                    readonly merge: readonly [{
+                        readonly var: "state.proposal";
+                    }, {
+                        readonly queuedAt: {
+                            readonly var: "$timestamp";
+                        };
+                        readonly executableAt: {
+                            readonly "+": readonly [{
+                                readonly var: "$timestamp";
+                            }, {
+                                readonly var: "state.timelockMs";
+                            }];
+                        };
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "QUEUED";
+        readonly to: "ACTIVE";
+        readonly eventName: "execute";
+        readonly guard: {
+            readonly ">=": readonly [{
+                readonly var: "$timestamp";
+            }, {
+                readonly var: "state.proposal.executableAt";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly executedProposals: {
+                    readonly cat: readonly [{
+                        readonly var: "state.executedProposals";
+                    }, readonly [{
+                        readonly merge: readonly [{
+                            readonly var: "state.proposal";
+                        }, {
+                            readonly votes: {
+                                readonly var: "state.votes";
+                            };
+                            readonly executedAt: {
+                                readonly var: "$timestamp";
+                            };
+                        }];
+                    }]];
+                };
+                readonly proposal: null;
+                readonly votes: null;
+            }];
+        };
+        readonly emits: readonly [{
+            readonly event: "proposal_executed";
+            readonly to: "external";
+        }];
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "VOTING";
+        readonly to: "ACTIVE";
+        readonly eventName: "reject";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly var: "$timestamp";
+                }, {
+                    readonly var: "state.proposal.votingEndsAt";
+                }];
+            }, {
+                readonly or: readonly [{
+                    readonly "<=": readonly [{
+                        readonly var: "state.votes.for";
+                    }, {
+                        readonly var: "state.votes.against";
+                    }];
+                }, {
+                    readonly "<": readonly [{
+                        readonly "+": readonly [{
+                            readonly var: "state.votes.for";
+                        }, {
+                            readonly var: "state.votes.against";
+                        }, {
+                            readonly var: "state.votes.abstain";
+                        }];
+                    }, {
+                        readonly var: "state.quorum";
+                    }];
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly rejectedProposals: {
+                    readonly cat: readonly [{
+                        readonly var: "state.rejectedProposals";
+                    }, readonly [{
+                        readonly merge: readonly [{
+                            readonly var: "state.proposal";
+                        }, {
+                            readonly votes: {
+                                readonly var: "state.votes";
+                            };
+                            readonly rejectedAt: {
+                                readonly var: "$timestamp";
+                            };
+                        }];
+                    }]];
+                };
+                readonly proposal: null;
+                readonly votes: null;
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "QUEUED";
+        readonly to: "ACTIVE";
+        readonly eventName: "cancel";
+        readonly guard: {
+            readonly "===": readonly [{
+                readonly var: "event.agent";
+            }, {
+                readonly var: "state.proposal.proposer";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly cancelledProposals: {
+                    readonly cat: readonly [{
+                        readonly var: "state.cancelledProposals";
+                    }, readonly [{
+                        readonly merge: readonly [{
+                            readonly var: "state.proposal";
+                        }, {
+                            readonly cancelledAt: {
+                                readonly var: "$timestamp";
+                            };
+                        }];
+                    }]];
+                };
+                readonly proposal: null;
+                readonly votes: null;
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "ACTIVE";
+        readonly to: "ACTIVE";
+        readonly eventName: "delegate";
+        readonly guard: {
+            readonly ">": readonly [{
+                readonly getKey: readonly [{
+                    readonly var: "state.balances";
+                }, {
+                    readonly var: "event.agent";
+                }];
+            }, 0];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly delegations: {
+                    readonly setKey: readonly [{
+                        readonly var: "state.delegations";
+                    }, {
+                        readonly var: "event.agent";
+                    }, {
+                        readonly var: "event.delegateTo";
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "ACTIVE";
+        readonly to: "ACTIVE";
+        readonly eventName: "undelegate";
+        readonly guard: {
+            readonly getKey: readonly [{
+                readonly var: "state.delegations";
+            }, {
+                readonly var: "event.agent";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly delegations: {
+                    readonly deleteKey: readonly [{
+                        readonly var: "state.delegations";
+                    }, {
+                        readonly var: "event.agent";
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }];
+};