| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475 |
- /* This file is part of DarkFi (https://dark.fi)
- *
- * Copyright (C) 2020-2025 Dyne.org foundation
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
- use std::{collections::HashMap, fmt, str::FromStr};
- use lazy_static::lazy_static;
- use num_bigint::BigUint;
- use rand::rngs::OsRng;
- use rusqlite::types::Value;
- use darkfi::{
- tx::{ContractCallLeaf, Transaction, TransactionBuilder},
- util::parse::{decode_base10, encode_base10},
- zk::{empty_witnesses, halo2::Field, ProvingKey, ZkCircuit},
- zkas::ZkBinary,
- Error, Result,
- };
- use darkfi_dao_contract::{
- blockwindow,
- client::{
- make_mint_call, DaoAuthMoneyTransferCall, DaoExecCall, DaoProposeCall,
- DaoProposeStakeInput, DaoVoteCall, DaoVoteInput,
- },
- model::{
- Dao, DaoAuthCall, DaoBulla, DaoExecParams, DaoMintParams, DaoProposal, DaoProposalBulla,
- DaoProposeParams, DaoVoteParams,
- },
- DaoFunction, DAO_CONTRACT_ZKAS_DAO_AUTH_MONEY_TRANSFER_ENC_COIN_NS,
- DAO_CONTRACT_ZKAS_DAO_AUTH_MONEY_TRANSFER_NS, DAO_CONTRACT_ZKAS_DAO_EARLY_EXEC_NS,
- DAO_CONTRACT_ZKAS_DAO_EXEC_NS, DAO_CONTRACT_ZKAS_DAO_MINT_NS,
- DAO_CONTRACT_ZKAS_DAO_PROPOSE_INPUT_NS, DAO_CONTRACT_ZKAS_DAO_PROPOSE_MAIN_NS,
- DAO_CONTRACT_ZKAS_DAO_VOTE_INPUT_NS, DAO_CONTRACT_ZKAS_DAO_VOTE_MAIN_NS,
- };
- use darkfi_money_contract::{
- client::transfer_v1::{select_coins, TransferCallBuilder, TransferCallInput},
- model::{CoinAttributes, Nullifier, TokenId},
- MoneyFunction, MONEY_CONTRACT_ZKAS_BURN_NS_V1, MONEY_CONTRACT_ZKAS_FEE_NS_V1,
- MONEY_CONTRACT_ZKAS_MINT_NS_V1,
- };
- use darkfi_sdk::{
- bridgetree,
- crypto::{
- poseidon_hash,
- smt::{MemoryStorageFp, PoseidonFp, SmtMemoryFp, EMPTY_NODES_FP},
- util::{fp_mod_fv, fp_to_u64},
- BaseBlind, Blind, FuncId, FuncRef, MerkleNode, MerkleTree, PublicKey, ScalarBlind,
- SecretKey, DAO_CONTRACT_ID, MONEY_CONTRACT_ID,
- },
- dark_tree::DarkTree,
- pasta::pallas,
- tx::TransactionHash,
- ContractCall,
- };
- use darkfi_serial::{
- async_trait, deserialize_async, serialize, serialize_async, AsyncEncodable, SerialDecodable,
- SerialEncodable,
- };
- use crate::{
- cache::{CacheOverlay, CacheSmt, CacheSmtStorage, SLED_MONEY_SMT_TREE},
- convert_named_params,
- error::{WalletDbError, WalletDbResult},
- money::BALANCE_BASE10_DECIMALS,
- rpc::ScanCache,
- Drk,
- };
- // DAO Merkle trees Sled keys
- pub const SLED_MERKLE_TREES_DAO_DAOS: &[u8] = b"_dao_daos";
- pub const SLED_MERKLE_TREES_DAO_PROPOSALS: &[u8] = b"_dao_proposals";
- // Wallet SQL table constant names. These have to represent the `dao.sql`
- // SQL schema. Table names are prefixed with the contract ID to avoid collisions.
- lazy_static! {
- pub static ref DAO_DAOS_TABLE: String = format!("{}_dao_daos", DAO_CONTRACT_ID.to_string());
- pub static ref DAO_COINS_TABLE: String = format!("{}_dao_coins", DAO_CONTRACT_ID.to_string());
- pub static ref DAO_PROPOSALS_TABLE: String =
- format!("{}_dao_proposals", DAO_CONTRACT_ID.to_string());
- pub static ref DAO_VOTES_TABLE: String = format!("{}_dao_votes", DAO_CONTRACT_ID.to_string());
- }
- // DAO_DAOS_TABLE
- pub const DAO_DAOS_COL_BULLA: &str = "bulla";
- pub const DAO_DAOS_COL_NAME: &str = "name";
- pub const DAO_DAOS_COL_PARAMS: &str = "params";
- pub const DAO_DAOS_COL_LEAF_POSITION: &str = "leaf_position";
- pub const DAO_DAOS_COL_MINT_HEIGHT: &str = "mint_height";
- pub const DAO_DAOS_COL_TX_HASH: &str = "tx_hash";
- pub const DAO_DAOS_COL_CALL_INDEX: &str = "call_index";
- // DAO_PROPOSALS_TABLE
- pub const DAO_PROPOSALS_COL_BULLA: &str = "bulla";
- pub const DAO_PROPOSALS_COL_DAO_BULLA: &str = "dao_bulla";
- pub const DAO_PROPOSALS_COL_PROPOSAL: &str = "proposal";
- pub const DAO_PROPOSALS_COL_DATA: &str = "data";
- pub const DAO_PROPOSALS_COL_LEAF_POSITION: &str = "leaf_position";
- pub const DAO_PROPOSALS_COL_MONEY_SNAPSHOT_TREE: &str = "money_snapshot_tree";
- pub const DAO_PROPOSALS_COL_NULLIFIERS_SMT_SNAPSHOT: &str = "nullifiers_smt_snapshot";
- pub const DAO_PROPOSALS_COL_MINT_HEIGHT: &str = "mint_height";
- pub const DAO_PROPOSALS_COL_TX_HASH: &str = "tx_hash";
- pub const DAO_PROPOSALS_COL_CALL_INDEX: &str = "call_index";
- pub const DAO_PROPOSALS_COL_EXEC_HEIGHT: &str = "exec_height";
- pub const DAO_PROPOSALS_COL_EXEC_TX_HASH: &str = "exec_tx_hash";
- // DAO_VOTES_TABLE
- pub const DAO_VOTES_COL_PROPOSAL_BULLA: &str = "proposal_bulla";
- pub const DAO_VOTES_COL_VOTE_OPTION: &str = "vote_option";
- pub const DAO_VOTES_COL_YES_VOTE_BLIND: &str = "yes_vote_blind";
- pub const DAO_VOTES_COL_ALL_VOTE_VALUE: &str = "all_vote_value";
- pub const DAO_VOTES_COL_ALL_VOTE_BLIND: &str = "all_vote_blind";
- pub const DAO_VOTES_COL_BLOCK_HEIGHT: &str = "block_height";
- pub const DAO_VOTES_COL_TX_HASH: &str = "tx_hash";
- pub const DAO_VOTES_COL_CALL_INDEX: &str = "call_index";
- pub const DAO_VOTES_COL_NULLIFIERS: &str = "nullifiers";
- #[derive(Debug, Clone, SerialEncodable, SerialDecodable)]
- /// Parameters representing a DAO to be initialized
- pub struct DaoParams {
- /// The on chain representation of the DAO
- pub dao: Dao,
- /// DAO notes decryption secret key
- pub notes_secret_key: Option<SecretKey>,
- /// DAO proposals creator secret key
- pub proposer_secret_key: Option<SecretKey>,
- /// DAO proposals viewer secret key
- pub proposals_secret_key: Option<SecretKey>,
- /// DAO votes viewer secret key
- pub votes_secret_key: Option<SecretKey>,
- /// DAO proposals executor secret key
- pub exec_secret_key: Option<SecretKey>,
- /// DAO strongly supported proposals executor secret key
- pub early_exec_secret_key: Option<SecretKey>,
- }
- impl DaoParams {
- /// Generate new `DaoParams`. If a specific secret key is provided,
- /// the corresponding public key will be derived from it and ignore the provided one.
- #[allow(clippy::too_many_arguments)]
- pub fn new(
- proposer_limit: u64,
- quorum: u64,
- early_exec_quorum: u64,
- approval_ratio_base: u64,
- approval_ratio_quot: u64,
- gov_token_id: TokenId,
- notes_secret_key: Option<SecretKey>,
- notes_public_key: PublicKey,
- proposer_secret_key: Option<SecretKey>,
- proposer_public_key: PublicKey,
- proposals_secret_key: Option<SecretKey>,
- proposals_public_key: PublicKey,
- votes_secret_key: Option<SecretKey>,
- votes_public_key: PublicKey,
- exec_secret_key: Option<SecretKey>,
- exec_public_key: PublicKey,
- early_exec_secret_key: Option<SecretKey>,
- early_exec_public_key: PublicKey,
- bulla_blind: BaseBlind,
- ) -> Self {
- // Derive corresponding keys from their secret or use the provided ones.
- let notes_public_key = match notes_secret_key {
- Some(secret_key) => PublicKey::from_secret(secret_key),
- None => notes_public_key,
- };
- let proposer_public_key = match proposer_secret_key {
- Some(secret_key) => PublicKey::from_secret(secret_key),
- None => proposer_public_key,
- };
- let proposals_public_key = match proposals_secret_key {
- Some(secret_key) => PublicKey::from_secret(secret_key),
- None => proposals_public_key,
- };
- let votes_public_key = match votes_secret_key {
- Some(secret_key) => PublicKey::from_secret(secret_key),
- None => votes_public_key,
- };
- let exec_public_key = match exec_secret_key {
- Some(secret_key) => PublicKey::from_secret(secret_key),
- None => exec_public_key,
- };
- let early_exec_public_key = match early_exec_secret_key {
- Some(secret_key) => PublicKey::from_secret(secret_key),
- None => early_exec_public_key,
- };
- let dao = Dao {
- proposer_limit,
- quorum,
- early_exec_quorum,
- approval_ratio_base,
- approval_ratio_quot,
- gov_token_id,
- notes_public_key,
- proposer_public_key,
- proposals_public_key,
- votes_public_key,
- exec_public_key,
- early_exec_public_key,
- bulla_blind,
- };
- Self {
- dao,
- notes_secret_key,
- proposer_secret_key,
- proposals_secret_key,
- votes_secret_key,
- exec_secret_key,
- early_exec_secret_key,
- }
- }
- /// Parse provided toml string into `DaoParams`.
- /// If a specific secret key is provided, the corresponding public key
- /// will be derived from it and ignore the provided one.
- pub fn from_toml_str(toml: &str) -> Result<Self> {
- // Parse TOML file contents
- let Ok(contents) = toml::from_str::<toml::Value>(toml) else {
- return Err(Error::ParseFailed("Failed parsing TOML config"))
- };
- let Some(table) = contents.as_table() else {
- return Err(Error::ParseFailed("TOML not a map"))
- };
- // Grab configuration parameters
- let Some(proposer_limit) = table.get("proposer_limit") else {
- return Err(Error::ParseFailed("TOML does not contain proposer limit"))
- };
- let Some(proposer_limit) = proposer_limit.as_str() else {
- return Err(Error::ParseFailed("Invalid proposer limit: Not a string"))
- };
- if f64::from_str(proposer_limit).is_err() {
- return Err(Error::ParseFailed("Invalid proposer limit: Cannot be parsed to float"))
- }
- let proposer_limit = decode_base10(proposer_limit, BALANCE_BASE10_DECIMALS, true)?;
- let Some(quorum) = table.get("quorum") else {
- return Err(Error::ParseFailed("TOML does not contain quorum"))
- };
- let Some(quorum) = quorum.as_str() else {
- return Err(Error::ParseFailed("Invalid quorum: Not a string"))
- };
- if f64::from_str(quorum).is_err() {
- return Err(Error::ParseFailed("Invalid quorum: Cannot be parsed to float"))
- }
- let quorum = decode_base10(quorum, BALANCE_BASE10_DECIMALS, true)?;
- let Some(early_exec_quorum) = table.get("early_exec_quorum") else {
- return Err(Error::ParseFailed("TOML does not contain early exec quorum"))
- };
- let Some(early_exec_quorum) = early_exec_quorum.as_str() else {
- return Err(Error::ParseFailed("Invalid early exec quorum: Not a string"))
- };
- if f64::from_str(early_exec_quorum).is_err() {
- return Err(Error::ParseFailed("Invalid early exec quorum: Cannot be parsed to float"))
- }
- let early_exec_quorum = decode_base10(early_exec_quorum, BALANCE_BASE10_DECIMALS, true)?;
- let Some(approval_ratio) = table.get("approval_ratio") else {
- return Err(Error::ParseFailed("TOML does not contain approval ratio"))
- };
- let Some(approval_ratio) = approval_ratio.as_float() else {
- return Err(Error::ParseFailed("Invalid approval ratio: Not a float"))
- };
- if approval_ratio > 1.0 {
- return Err(Error::ParseFailed("Approval ratio cannot be >1.0"))
- }
- let approval_ratio_base = 100_u64;
- let approval_ratio_quot = (approval_ratio * approval_ratio_base as f64) as u64;
- let Some(gov_token_id) = table.get("gov_token_id") else {
- return Err(Error::ParseFailed("TOML does not contain gov token id"))
- };
- let Some(gov_token_id) = gov_token_id.as_str() else {
- return Err(Error::ParseFailed("Invalid gov token id: Not a string"))
- };
- let gov_token_id = TokenId::from_str(gov_token_id)?;
- let Some(bulla_blind) = table.get("bulla_blind") else {
- return Err(Error::ParseFailed("TOML does not contain bulla blind"))
- };
- let Some(bulla_blind) = bulla_blind.as_str() else {
- return Err(Error::ParseFailed("Invalid bulla blind: Not a string"))
- };
- let bulla_blind = BaseBlind::from_str(bulla_blind)?;
- // Grab DAO actions keypairs
- let notes_secret_key = match table.get("notes_secret_key") {
- Some(notes_secret_key) => {
- let Some(notes_secret_key) = notes_secret_key.as_str() else {
- return Err(Error::ParseFailed("Invalid notes secret key: Not a string"))
- };
- let Ok(notes_secret_key) = SecretKey::from_str(notes_secret_key) else {
- return Err(Error::ParseFailed("Invalid notes secret key: Decoding failed"))
- };
- Some(notes_secret_key)
- }
- None => None,
- };
- let notes_public_key = match notes_secret_key {
- Some(notes_secret_key) => PublicKey::from_secret(notes_secret_key),
- None => {
- let Some(notes_public_key) = table.get("notes_public_key") else {
- return Err(Error::ParseFailed("TOML does not contain notes public key"))
- };
- let Some(notes_public_key) = notes_public_key.as_str() else {
- return Err(Error::ParseFailed("Invalid notes public key: Not a string"))
- };
- let Ok(notes_public_key) = PublicKey::from_str(notes_public_key) else {
- return Err(Error::ParseFailed("Invalid notes public key: Decoding failed"))
- };
- notes_public_key
- }
- };
- let proposer_secret_key = match table.get("proposer_secret_key") {
- Some(proposer_secret_key) => {
- let Some(proposer_secret_key) = proposer_secret_key.as_str() else {
- return Err(Error::ParseFailed("Invalid proposer secret key: Not a string"))
- };
- let Ok(proposer_secret_key) = SecretKey::from_str(proposer_secret_key) else {
- return Err(Error::ParseFailed("Invalid proposer secret key: Decoding failed"))
- };
- Some(proposer_secret_key)
- }
- None => None,
- };
- let proposer_public_key = match proposer_secret_key {
- Some(proposer_secret_key) => PublicKey::from_secret(proposer_secret_key),
- None => {
- let Some(proposer_public_key) = table.get("proposer_public_key") else {
- return Err(Error::ParseFailed("TOML does not contain proposer public key"))
- };
- let Some(proposer_public_key) = proposer_public_key.as_str() else {
- return Err(Error::ParseFailed("Invalid proposer public key: Not a string"))
- };
- let Ok(proposer_public_key) = PublicKey::from_str(proposer_public_key) else {
- return Err(Error::ParseFailed("Invalid proposer public key: Decoding failed"))
- };
- proposer_public_key
- }
- };
- let proposals_secret_key = match table.get("proposals_secret_key") {
- Some(proposals_secret_key) => {
- let Some(proposals_secret_key) = proposals_secret_key.as_str() else {
- return Err(Error::ParseFailed("Invalid proposals secret key: Not a string"))
- };
- let Ok(proposals_secret_key) = SecretKey::from_str(proposals_secret_key) else {
- return Err(Error::ParseFailed("Invalid proposals secret key: Decoding failed"))
- };
- Some(proposals_secret_key)
- }
- None => None,
- };
- let proposals_public_key = match proposals_secret_key {
- Some(proposals_secret_key) => PublicKey::from_secret(proposals_secret_key),
- None => {
- let Some(proposals_public_key) = table.get("proposals_public_key") else {
- return Err(Error::ParseFailed("TOML does not contain proposals public key"))
- };
- let Some(proposals_public_key) = proposals_public_key.as_str() else {
- return Err(Error::ParseFailed("Invalid proposals public key: Not a string"))
- };
- let Ok(proposals_public_key) = PublicKey::from_str(proposals_public_key) else {
- return Err(Error::ParseFailed("Invalid proposals public key: Decoding failed"))
- };
- proposals_public_key
- }
- };
- let votes_secret_key = match table.get("votes_secret_key") {
- Some(votes_secret_key) => {
- let Some(votes_secret_key) = votes_secret_key.as_str() else {
- return Err(Error::ParseFailed("Invalid votes secret key: Not a string"))
- };
- let Ok(votes_secret_key) = SecretKey::from_str(votes_secret_key) else {
- return Err(Error::ParseFailed("Invalid votes secret key: Decoding failed"))
- };
- Some(votes_secret_key)
- }
- None => None,
- };
- let votes_public_key = match votes_secret_key {
- Some(votes_secret_key) => PublicKey::from_secret(votes_secret_key),
- None => {
- let Some(votes_public_key) = table.get("votes_public_key") else {
- return Err(Error::ParseFailed("TOML does not contain votes public key"))
- };
- let Some(votes_public_key) = votes_public_key.as_str() else {
- return Err(Error::ParseFailed("Invalid votes public key: Not a string"))
- };
- let Ok(votes_public_key) = PublicKey::from_str(votes_public_key) else {
- return Err(Error::ParseFailed("Invalid votes public key: Decoding failed"))
- };
- votes_public_key
- }
- };
- let exec_secret_key = match table.get("exec_secret_key") {
- Some(exec_secret_key) => {
- let Some(exec_secret_key) = exec_secret_key.as_str() else {
- return Err(Error::ParseFailed("Invalid exec secret key: Not a string"))
- };
- let Ok(exec_secret_key) = SecretKey::from_str(exec_secret_key) else {
- return Err(Error::ParseFailed("Invalid exec secret key: Decoding failed"))
- };
- Some(exec_secret_key)
- }
- None => None,
- };
- let exec_public_key = match exec_secret_key {
- Some(exec_secret_key) => PublicKey::from_secret(exec_secret_key),
- None => {
- let Some(exec_public_key) = table.get("exec_public_key") else {
- return Err(Error::ParseFailed("TOML does not contain exec public key"))
- };
- let Some(exec_public_key) = exec_public_key.as_str() else {
- return Err(Error::ParseFailed("Invalid exec public key: Not a string"))
- };
- let Ok(exec_public_key) = PublicKey::from_str(exec_public_key) else {
- return Err(Error::ParseFailed("Invalid exec public key: Decoding failed"))
- };
- exec_public_key
- }
- };
- let early_exec_secret_key = match table.get("early_exec_secret_key") {
- Some(early_exec_secret_key) => {
- let Some(early_exec_secret_key) = early_exec_secret_key.as_str() else {
- return Err(Error::ParseFailed("Invalid early exec secret key: Not a string"))
- };
- let Ok(early_exec_secret_key) = SecretKey::from_str(early_exec_secret_key) else {
- return Err(Error::ParseFailed("Invalid early exec secret key: Decoding failed"))
- };
- Some(early_exec_secret_key)
- }
- None => None,
- };
- let early_exec_public_key = match early_exec_secret_key {
- Some(early_exec_secret_key) => PublicKey::from_secret(early_exec_secret_key),
- None => {
- let Some(early_exec_public_key) = table.get("early_exec_public_key") else {
- return Err(Error::ParseFailed("TOML does not contain early exec public key"))
- };
- let Some(early_exec_public_key) = early_exec_public_key.as_str() else {
- return Err(Error::ParseFailed("Invalid early exec public key: Not a string"))
- };
- let Ok(early_exec_public_key) = PublicKey::from_str(early_exec_public_key) else {
- return Err(Error::ParseFailed("Invalid early exec public key: Decoding failed"))
- };
- early_exec_public_key
- }
- };
- Ok(Self::new(
- proposer_limit,
- quorum,
- early_exec_quorum,
- approval_ratio_base,
- approval_ratio_quot,
- gov_token_id,
- notes_secret_key,
- notes_public_key,
- proposer_secret_key,
- proposer_public_key,
- proposals_secret_key,
- proposals_public_key,
- votes_secret_key,
- votes_public_key,
- exec_secret_key,
- exec_public_key,
- early_exec_secret_key,
- early_exec_public_key,
- bulla_blind,
- ))
- }
- /// Generate a toml string containing the DAO configuration.
- pub fn toml_str(&self) -> String {
- // Header comments
- let mut toml = String::from(
- "## DAO configuration file\n\
- ##\n\
- ## Please make sure you go through all the settings so you can configure\n\
- ## your DAO properly.\n\
- ##\n\
- ## If you want to restrict access to certain actions, the corresponding\n\
- ## secret key can be omitted. All public keys, along with the DAO configuration\n\
- ## parameters must be shared.\n\
- ##\n\
- ## If you want to combine access to certain actions, you can use the same\n\
- ## secret and public key combination for them.\n\n",
- );
- // Configuration parameters
- toml += &format!(
- "## ====== DAO configuration parameters =====\n\n\
- ## The minimum amount of governance tokens needed to open a proposal for this DAO\n\
- proposer_limit = \"{}\"\n\n\
- ## Minimal threshold of participating total tokens needed for a proposal to pass\n\
- quorum = \"{}\"\n\n\
- ## Minimal threshold of participating total tokens needed for a proposal to\n\
- ## be considered as strongly supported, enabling early execution.\n\
- ## Must be greater or equal to normal quorum.\n\
- early_exec_quorum = \"{}\"\n\n\
- ## The ratio of winning votes/total votes needed for a proposal to pass (2 decimals)\n\
- approval_ratio = {}\n\n\
- ## DAO's governance token ID\n\
- gov_token_id = \"{}\"\n\n\
- ## Bulla blind\n\
- bulla_blind = \"{}\"\n\n",
- encode_base10(self.dao.proposer_limit, BALANCE_BASE10_DECIMALS),
- encode_base10(self.dao.quorum, BALANCE_BASE10_DECIMALS),
- encode_base10(self.dao.early_exec_quorum, BALANCE_BASE10_DECIMALS),
- self.dao.approval_ratio_quot as f64 / self.dao.approval_ratio_base as f64,
- self.dao.gov_token_id,
- self.dao.bulla_blind,
- );
- // DAO actions keypairs
- toml += &format!(
- "## ====== DAO actions keypairs =====\n\n\
- ## DAO notes decryption keypair\n\
- notes_public_key = \"{}\"\n",
- self.dao.notes_public_key,
- );
- match self.notes_secret_key {
- Some(secret_key) => toml += &format!("notes_secret_key = \"{secret_key}\"\n\n"),
- None => toml += "\n",
- }
- toml += &format!(
- "## DAO proposals creator keypair\n\
- proposer_public_key = \"{}\"\n",
- self.dao.proposer_public_key,
- );
- match self.proposer_secret_key {
- Some(secret_key) => toml += &format!("proposer_secret_key = \"{secret_key}\"\n\n"),
- None => toml += "\n",
- }
- toml += &format!(
- "## DAO proposals viewer keypair\n\
- proposals_public_key = \"{}\"\n",
- self.dao.proposals_public_key,
- );
- match self.proposals_secret_key {
- Some(secret_key) => toml += &format!("proposals_secret_key = \"{secret_key}\"\n\n"),
- None => toml += "\n",
- }
- toml += &format!(
- "## DAO votes viewer keypair\n\
- votes_public_key = \"{}\"\n",
- self.dao.votes_public_key,
- );
- match self.votes_secret_key {
- Some(secret_key) => toml += &format!("votes_secret_key = \"{secret_key}\"\n\n"),
- None => toml += "\n",
- }
- toml += &format!(
- "## DAO proposals executor keypair\n\
- exec_public_key = \"{}\"\n",
- self.dao.exec_public_key,
- );
- match self.exec_secret_key {
- Some(secret_key) => toml += &format!("exec_secret_key = \"{secret_key}\"\n\n"),
- None => toml += "\n",
- }
- toml += &format!(
- "## DAO strongly supported proposals executor keypair\n\
- early_exec_public_key = \"{}\"",
- self.dao.early_exec_public_key,
- );
- if let Some(secret_key) = self.early_exec_secret_key {
- toml += &format!("\nearly_exec_secret_key = \"{secret_key}\"")
- }
- toml
- }
- }
- impl fmt::Display for DaoParams {
- fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
- // Grab known secret keys
- let notes_secret_key = match self.notes_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let proposer_secret_key = match self.proposer_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let proposals_secret_key = match self.proposals_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let votes_secret_key = match self.votes_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let exec_secret_key = match self.exec_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let early_exec_secret_key = match self.early_exec_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let s = format!(
- "{}\n{}\n{}: {} ({})\n{}: {} ({})\n{}: {} ({})\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}",
- "DAO Parameters",
- "==============",
- "Proposer limit",
- encode_base10(self.dao.proposer_limit, BALANCE_BASE10_DECIMALS),
- self.dao.proposer_limit,
- "Quorum",
- encode_base10(self.dao.quorum, BALANCE_BASE10_DECIMALS),
- self.dao.quorum,
- "Early Exec Quorum",
- encode_base10(self.dao.early_exec_quorum, BALANCE_BASE10_DECIMALS),
- self.dao.early_exec_quorum,
- "Approval ratio",
- self.dao.approval_ratio_quot as f64 / self.dao.approval_ratio_base as f64,
- "Governance Token ID",
- self.dao.gov_token_id,
- "Notes Public key",
- self.dao.notes_public_key,
- "Notes Secret key",
- notes_secret_key,
- "Proposer Public key",
- self.dao.proposer_public_key,
- "Proposer Secret key",
- proposer_secret_key,
- "Proposals Public key",
- self.dao.proposals_public_key,
- "Proposals Secret key",
- proposals_secret_key,
- "Votes Public key",
- self.dao.votes_public_key,
- "Votes Secret key",
- votes_secret_key,
- "Exec Public key",
- self.dao.exec_public_key,
- "Exec Secret key",
- exec_secret_key,
- "Early Exec Public key",
- self.dao.early_exec_public_key,
- "Early Exec Secret key",
- early_exec_secret_key,
- "Bulla blind",
- self.dao.bulla_blind,
- );
- write!(f, "{s}")
- }
- }
- #[derive(Debug, Clone)]
- /// Structure representing a `DAO_DAOS_TABLE` record.
- pub struct DaoRecord {
- /// Name identifier for the DAO
- pub name: String,
- /// DAO parameters
- pub params: DaoParams,
- /// Leaf position of the DAO in the Merkle tree of DAOs
- pub leaf_position: Option<bridgetree::Position>,
- /// Block height of the transaction this DAO was deployed
- pub mint_height: Option<u32>,
- /// The transaction hash where the DAO was deployed
- pub tx_hash: Option<TransactionHash>,
- /// The call index in the transaction where the DAO was deployed
- pub call_index: Option<u8>,
- }
- impl DaoRecord {
- pub fn new(
- name: String,
- params: DaoParams,
- leaf_position: Option<bridgetree::Position>,
- mint_height: Option<u32>,
- tx_hash: Option<TransactionHash>,
- call_index: Option<u8>,
- ) -> Self {
- Self { name, params, leaf_position, mint_height, tx_hash, call_index }
- }
- pub fn bulla(&self) -> DaoBulla {
- self.params.dao.to_bulla()
- }
- }
- impl fmt::Display for DaoRecord {
- fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
- // Grab known secret keys
- let notes_secret_key = match self.params.notes_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let proposer_secret_key = match self.params.proposer_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let proposals_secret_key = match self.params.proposals_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let votes_secret_key = match self.params.votes_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let exec_secret_key = match self.params.exec_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- let early_exec_secret_key = match self.params.early_exec_secret_key {
- Some(secret_key) => format!("{secret_key}"),
- None => "None".to_string(),
- };
- // Grab mint information
- let leaf_position = match self.leaf_position {
- Some(p) => format!("{p:?}"),
- None => "None".to_string(),
- };
- let mint_height = match self.mint_height {
- Some(h) => format!("{h}"),
- None => "None".to_string(),
- };
- let tx_hash = match self.tx_hash {
- Some(t) => format!("{t}"),
- None => "None".to_string(),
- };
- let call_index = match self.call_index {
- Some(c) => format!("{c}"),
- None => "None".to_string(),
- };
- let s = format!(
- "{}\n{}\n{}: {}\n{}: {}\n{}: {} ({})\n{}: {} ({})\n{}: {} ({})\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}",
- "DAO Parameters",
- "==============",
- "Name",
- self.name,
- "Bulla",
- self.bulla(),
- "Proposer limit",
- encode_base10(self.params.dao.proposer_limit, BALANCE_BASE10_DECIMALS),
- self.params.dao.proposer_limit,
- "Quorum",
- encode_base10(self.params.dao.quorum, BALANCE_BASE10_DECIMALS),
- self.params.dao.quorum,
- "Early Exec Quorum",
- encode_base10(self.params.dao.early_exec_quorum, BALANCE_BASE10_DECIMALS),
- self.params.dao.early_exec_quorum,
- "Approval ratio",
- self.params.dao.approval_ratio_quot as f64 / self.params.dao.approval_ratio_base as f64,
- "Governance Token ID",
- self.params.dao.gov_token_id,
- "Notes Public key",
- self.params.dao.notes_public_key,
- "Notes Secret key",
- notes_secret_key,
- "Proposer Public key",
- self.params.dao.proposer_public_key,
- "Proposer Secret key",
- proposer_secret_key,
- "Proposals Public key",
- self.params.dao.proposals_public_key,
- "Proposals Secret key",
- proposals_secret_key,
- "Votes Public key",
- self.params.dao.votes_public_key,
- "Votes Secret key",
- votes_secret_key,
- "Exec Public key",
- self.params.dao.exec_public_key,
- "Exec Secret key",
- exec_secret_key,
- "Early Exec Public key",
- self.params.dao.early_exec_public_key,
- "Early Exec Secret key",
- early_exec_secret_key,
- "Bulla blind",
- self.params.dao.bulla_blind,
- "Leaf position",
- leaf_position,
- "Mint height",
- mint_height,
- "Transaction hash",
- tx_hash,
- "Call index",
- call_index,
- );
- write!(f, "{s}")
- }
- }
- #[derive(Debug, Clone, SerialEncodable, SerialDecodable)]
- /// Structure representing a `DAO_PROPOSALS_TABLE` record.
- pub struct ProposalRecord {
- /// The on chain representation of the proposal
- pub proposal: DaoProposal,
- /// Plaintext proposal call data the members share between them
- pub data: Option<Vec<u8>>,
- /// Leaf position of the proposal in the Merkle tree of proposals
- pub leaf_position: Option<bridgetree::Position>,
- /// Money merkle tree snapshot for reproducing the snapshot Merkle root
- pub money_snapshot_tree: Option<MerkleTree>,
- /// Money nullifiers SMT snapshot for reproducing the snapshot Merkle root
- pub nullifiers_smt_snapshot: Option<HashMap<BigUint, pallas::Base>>,
- /// Block height of the transaction this proposal was deployed
- pub mint_height: Option<u32>,
- /// The transaction hash where the proposal was deployed
- pub tx_hash: Option<TransactionHash>,
- /// The call index in the transaction where the proposal was deployed
- pub call_index: Option<u8>,
- /// Block height of the transaction this proposal was executed
- pub exec_height: Option<u32>,
- /// The transaction hash where the proposal was executed
- pub exec_tx_hash: Option<TransactionHash>,
- }
- impl ProposalRecord {
- pub fn bulla(&self) -> DaoProposalBulla {
- self.proposal.to_bulla()
- }
- }
- impl fmt::Display for ProposalRecord {
- fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
- let leaf_position = match self.leaf_position {
- Some(p) => format!("{p:?}"),
- None => "None".to_string(),
- };
- let mint_height = match self.mint_height {
- Some(h) => format!("{h}"),
- None => "None".to_string(),
- };
- let tx_hash = match self.tx_hash {
- Some(t) => format!("{t}"),
- None => "None".to_string(),
- };
- let call_index = match self.call_index {
- Some(c) => format!("{c}"),
- None => "None".to_string(),
- };
- let s = format!(
- "{}\n{}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {}\n{}: {} ({})",
- "Proposal parameters",
- "===================",
- "Bulla",
- self.bulla(),
- "DAO Bulla",
- self.proposal.dao_bulla,
- "Proposal leaf position",
- leaf_position,
- "Proposal mint height",
- mint_height,
- "Proposal transaction hash",
- tx_hash,
- "Proposal call index",
- call_index,
- "Creation block window",
- self.proposal.creation_blockwindow,
- "Duration",
- self.proposal.duration_blockwindows,
- "Block windows"
- );
- write!(f, "{s}")
- }
- }
- #[derive(Debug, Clone)]
- /// Structure representing a `DAO_VOTES_TABLE` record.
- pub struct VoteRecord {
- /// Numeric identifier for the vote
- pub id: u64,
- /// Bulla identifier of the proposal this vote is for
- pub proposal: DaoProposalBulla,
- /// The vote
- pub vote_option: bool,
- /// Blinding factor for the yes vote
- pub yes_vote_blind: ScalarBlind,
- /// Value of all votes
- pub all_vote_value: u64,
- /// Blinding facfor of all votes
- pub all_vote_blind: ScalarBlind,
- /// Block height of the transaction this vote was casted
- pub block_height: u32,
- /// Transaction hash where this vote was casted
- pub tx_hash: TransactionHash,
- /// Call index in the transaction where this vote was casted
- pub call_index: u8,
- /// Vote input nullifiers
- pub nullifiers: Vec<Nullifier>,
- }
- impl Drk {
- /// Initialize wallet with tables for the DAO contract.
- pub async fn initialize_dao(&self) -> WalletDbResult<()> {
- // Initialize DAO wallet schema
- let wallet_schema = include_str!("../dao.sql");
- self.wallet.exec_batch_sql(wallet_schema)?;
- Ok(())
- }
- /// Fetch DAO Merkle trees from the wallet.
- /// If a tree doesn't exists a new Merkle Tree is returned.
- pub async fn get_dao_trees(&self) -> Result<(MerkleTree, MerkleTree)> {
- let daos_tree = match self.cache.merkle_trees.get(SLED_MERKLE_TREES_DAO_DAOS)? {
- Some(tree_bytes) => deserialize_async(&tree_bytes).await?,
- None => MerkleTree::new(u32::MAX as usize),
- };
- let proposals_tree = match self.cache.merkle_trees.get(SLED_MERKLE_TREES_DAO_PROPOSALS)? {
- Some(tree_bytes) => deserialize_async(&tree_bytes).await?,
- None => MerkleTree::new(u32::MAX as usize),
- };
- Ok((daos_tree, proposals_tree))
- }
- /// Auxiliary function to parse a `DAO_DAOS_TABLE` record.
- async fn parse_dao_record(&self, row: &[Value]) -> Result<DaoRecord> {
- let Value::Text(ref name) = row[1] else {
- return Err(Error::ParseFailed("[parse_dao_record] Name parsing failed"))
- };
- let name = name.clone();
- let Value::Blob(ref params_bytes) = row[2] else {
- return Err(Error::ParseFailed("[parse_dao_record] Params bytes parsing failed"))
- };
- let params = deserialize_async(params_bytes).await?;
- let leaf_position = match row[3] {
- Value::Blob(ref leaf_position_bytes) => {
- Some(deserialize_async(leaf_position_bytes).await?)
- }
- Value::Null => None,
- _ => {
- return Err(Error::ParseFailed(
- "[parse_dao_record] Leaf position bytes parsing failed",
- ))
- }
- };
- let mint_height = match row[4] {
- Value::Integer(mint_height) => {
- let Ok(mint_height) = u32::try_from(mint_height) else {
- return Err(Error::ParseFailed("[parse_dao_record] Mint height parsing failed"))
- };
- Some(mint_height)
- }
- Value::Null => None,
- _ => return Err(Error::ParseFailed("[parse_dao_record] Mint height parsing failed")),
- };
- let tx_hash = match row[5] {
- Value::Blob(ref tx_hash_bytes) => Some(deserialize_async(tx_hash_bytes).await?),
- Value::Null => None,
- _ => {
- return Err(Error::ParseFailed(
- "[parse_dao_record] Transaction hash bytes parsing failed",
- ))
- }
- };
- let call_index = match row[6] {
- Value::Integer(call_index) => {
- let Ok(call_index) = u8::try_from(call_index) else {
- return Err(Error::ParseFailed("[parse_dao_record] Call index parsing failed"))
- };
- Some(call_index)
- }
- Value::Null => None,
- _ => return Err(Error::ParseFailed("[parse_dao_record] Call index parsing failed")),
- };
- let dao = DaoRecord::new(name, params, leaf_position, mint_height, tx_hash, call_index);
- Ok(dao)
- }
- /// Fetch all known DAOs from the wallet.
- pub async fn get_daos(&self) -> Result<Vec<DaoRecord>> {
- let rows = match self.wallet.query_multiple(&DAO_DAOS_TABLE, &[], &[]) {
- Ok(r) => r,
- Err(e) => {
- return Err(Error::DatabaseError(format!("[get_daos] DAOs retrieval failed: {e}")))
- }
- };
- let mut daos = Vec::with_capacity(rows.len());
- for row in rows {
- daos.push(self.parse_dao_record(&row).await?);
- }
- Ok(daos)
- }
- /// Auxiliary function to parse a proposal record row.
- async fn parse_dao_proposal(&self, row: &[Value]) -> Result<ProposalRecord> {
- let Value::Blob(ref proposal_bytes) = row[2] else {
- return Err(Error::ParseFailed(
- "[parse_dao_proposal] Proposal bytes bytes parsing failed",
- ))
- };
- let proposal = deserialize_async(proposal_bytes).await?;
- let data = match row[3] {
- Value::Blob(ref data_bytes) => Some(data_bytes.clone()),
- Value::Null => None,
- _ => return Err(Error::ParseFailed("[parse_dao_proposal] Data bytes parsing failed")),
- };
- let leaf_position = match row[4] {
- Value::Blob(ref leaf_position_bytes) => {
- Some(deserialize_async(leaf_position_bytes).await?)
- }
- Value::Null => None,
- _ => {
- return Err(Error::ParseFailed(
- "[parse_dao_proposal] Leaf position bytes parsing failed",
- ))
- }
- };
- let money_snapshot_tree = match row[5] {
- Value::Blob(ref money_snapshot_tree_bytes) => {
- Some(deserialize_async(money_snapshot_tree_bytes).await?)
- }
- Value::Null => None,
- _ => {
- return Err(Error::ParseFailed(
- "[parse_dao_proposal] Money snapshot tree bytes parsing failed",
- ))
- }
- };
- let nullifiers_smt_snapshot = match row[6] {
- Value::Blob(ref nullifiers_smt_snapshot_bytes) => {
- Some(deserialize_async(nullifiers_smt_snapshot_bytes).await?)
- }
- Value::Null => None,
- _ => {
- return Err(Error::ParseFailed(
- "[parse_dao_proposal] Nullifiers SMT snapshot bytes parsing failed",
- ))
- }
- };
- let mint_height = match row[7] {
- Value::Integer(mint_height) => {
- let Ok(mint_height) = u32::try_from(mint_height) else {
- return Err(Error::ParseFailed(
- "[parse_dao_proposal] Mint height parsing failed",
- ))
- };
- Some(mint_height)
- }
- Value::Null => None,
- _ => return Err(Error::ParseFailed("[parse_dao_proposal] Mint height parsing failed")),
- };
- let tx_hash = match row[8] {
- Value::Blob(ref tx_hash_bytes) => Some(deserialize_async(tx_hash_bytes).await?),
- Value::Null => None,
- _ => {
- return Err(Error::ParseFailed(
- "[parse_dao_proposal] Transaction hash bytes parsing failed",
- ))
- }
- };
- let call_index = match row[9] {
- Value::Integer(call_index) => {
- let Ok(call_index) = u8::try_from(call_index) else {
- return Err(Error::ParseFailed("[parse_dao_proposal] Call index parsing failed"))
- };
- Some(call_index)
- }
- Value::Null => None,
- _ => return Err(Error::ParseFailed("[parse_dao_proposal] Call index parsing failed")),
- };
- let exec_height = match row[10] {
- Value::Integer(exec_height) => {
- let Ok(exec_height) = u32::try_from(exec_height) else {
- return Err(Error::ParseFailed(
- "[parse_dao_proposal] Execution height parsing failed",
- ))
- };
- Some(exec_height)
- }
- Value::Null => None,
- _ => {
- return Err(Error::ParseFailed(
- "[parse_dao_proposal] Execution height parsing failed",
- ))
- }
- };
- let exec_tx_hash = match row[11] {
- Value::Blob(ref exec_tx_hash_bytes) => {
- Some(deserialize_async(exec_tx_hash_bytes).await?)
- }
- Value::Null => None,
- _ => {
- return Err(Error::ParseFailed(
- "[parse_dao_proposal] Execution transaction hash bytes parsing failed",
- ))
- }
- };
- Ok(ProposalRecord {
- proposal,
- data,
- leaf_position,
- money_snapshot_tree,
- nullifiers_smt_snapshot,
- mint_height,
- tx_hash,
- call_index,
- exec_height,
- exec_tx_hash,
- })
- }
- /// Fetch all known DAO proposals from the wallet given a DAO name.
- pub async fn get_dao_proposals(&self, name: &str) -> Result<Vec<ProposalRecord>> {
- let Ok(dao) = self.get_dao_by_name(name).await else {
- return Err(Error::DatabaseError(format!(
- "[get_dao_proposals] DAO with name {name} not found in wallet"
- )))
- };
- let rows = match self.wallet.query_multiple(
- &DAO_PROPOSALS_TABLE,
- &[],
- convert_named_params! {(DAO_PROPOSALS_COL_DAO_BULLA, serialize_async(&dao.bulla()).await)},
- ) {
- Ok(r) => r,
- Err(e) => {
- return Err(Error::DatabaseError(format!(
- "[get_dao_proposals] Proposals retrieval failed: {e}"
- )))
- }
- };
- let mut proposals = Vec::with_capacity(rows.len());
- for row in rows {
- let proposal = self.parse_dao_proposal(&row).await?;
- proposals.push(proposal);
- }
- Ok(proposals)
- }
- /// Auxiliary function to apply `DaoFunction::Mint` call data to
- /// the wallet and update the provided scan cache.
- /// Returns a flag indicating if the provided call refers to our
- /// own wallet.
- async fn apply_dao_mint_data(
- &self,
- scan_cache: &mut ScanCache,
- new_bulla: &DaoBulla,
- tx_hash: &TransactionHash,
- call_index: &u8,
- mint_height: &u32,
- ) -> Result<bool> {
- // Append the new dao bulla to the Merkle tree.
- // Every dao bulla has to be added.
- scan_cache.dao_daos_tree.append(MerkleNode::from(new_bulla.inner()));
- // Check if we have the DAO
- if !scan_cache.own_daos.contains_key(new_bulla) {
- return Ok(false)
- }
- // Confirm it
- scan_cache.log(format!(
- "[apply_dao_mint_data] Found minted DAO {new_bulla}, noting down for wallet update"
- ));
- if let Err(e) = self
- .confirm_dao(
- new_bulla,
- &scan_cache.dao_daos_tree.mark().unwrap(),
- tx_hash,
- call_index,
- mint_height,
- )
- .await
- {
- return Err(Error::DatabaseError(format!(
- "[apply_dao_mint_data] Confirm DAO failed: {e}"
- )))
- }
- Ok(true)
- }
- /// Auxiliary function to apply `DaoFunction::Propose` call data to
- /// the wallet and update the provided scan cache.
- /// Returns a flag indicating if the provided call refers to our
- /// own wallet.
- async fn apply_dao_propose_data(
- &self,
- scan_cache: &mut ScanCache,
- params: &DaoProposeParams,
- tx_hash: &TransactionHash,
- call_index: &u8,
- mint_height: &u32,
- ) -> Result<bool> {
- // Append the new proposal bulla to the Merkle tree.
- // Every proposal bulla has to be added.
- scan_cache.dao_proposals_tree.append(MerkleNode::from(params.proposal_bulla.inner()));
- // If we're able to decrypt this note, that's the way to link it
- // to a specific DAO.
- for (dao, (proposals_secret_key, _)) in &scan_cache.own_daos {
- // Check if we have the proposals key
- let Some(proposals_secret_key) = proposals_secret_key else { continue };
- // Try to decrypt the proposal note
- let Ok(note) = params.note.decrypt::<DaoProposal>(proposals_secret_key) else {
- continue
- };
- // We managed to decrypt it. Let's place this in a proper ProposalRecord object
- scan_cache.messages_buffer.push(format!(
- "[apply_dao_propose_data] Managed to decrypt proposal note for DAO: {dao}"
- ));
- // Check if we already got the record
- let our_proposal = if scan_cache.own_proposals.contains_key(¶ms.proposal_bulla) {
- // Grab the record from the db
- let mut our_proposal =
- self.get_dao_proposal_by_bulla(¶ms.proposal_bulla).await?;
- our_proposal.leaf_position = scan_cache.dao_proposals_tree.mark();
- our_proposal.money_snapshot_tree = Some(scan_cache.money_tree.clone());
- our_proposal.nullifiers_smt_snapshot = Some(scan_cache.money_smt.store.snapshot()?);
- our_proposal.mint_height = Some(*mint_height);
- our_proposal.tx_hash = Some(*tx_hash);
- our_proposal.call_index = Some(*call_index);
- our_proposal
- } else {
- let our_proposal = ProposalRecord {
- proposal: note,
- data: None,
- leaf_position: scan_cache.dao_proposals_tree.mark(),
- money_snapshot_tree: Some(scan_cache.money_tree.clone()),
- nullifiers_smt_snapshot: Some(scan_cache.money_smt.store.snapshot()?),
- mint_height: Some(*mint_height),
- tx_hash: Some(*tx_hash),
- call_index: Some(*call_index),
- exec_height: None,
- exec_tx_hash: None,
- };
- scan_cache.own_proposals.insert(params.proposal_bulla, *dao);
- our_proposal
- };
- // Update/store our record
- if let Err(e) = self.put_dao_proposal(&our_proposal).await {
- return Err(Error::DatabaseError(format!(
- "[apply_dao_propose_data] Put DAO proposals failed: {e}"
- )))
- }
- return Ok(true)
- }
- Ok(false)
- }
- /// Auxiliary function to apply `DaoFunction::Vote` call data to
- /// the wallet.
- /// Returns a flag indicating if the provided call refers to our
- /// own wallet.
- async fn apply_dao_vote_data(
- &self,
- scan_cache: &ScanCache,
- params: &DaoVoteParams,
- tx_hash: &TransactionHash,
- call_index: &u8,
- block_height: &u32,
- ) -> Result<bool> {
- // Check if we got the corresponding proposal
- let Some(dao_bulla) = scan_cache.own_proposals.get(¶ms.proposal_bulla) else {
- return Ok(false)
- };
- // Grab the proposal DAO votes key
- let Some((_, votes_secret_key)) = scan_cache.own_daos.get(dao_bulla) else {
- return Err(Error::DatabaseError(format!(
- "[apply_dao_vote_data] Couldn't find proposal {} DAO {}",
- params.proposal_bulla, dao_bulla,
- )))
- };
- // Check if we actually have the votes key
- let Some(votes_secret_key) = votes_secret_key else { return Ok(false) };
- // Decrypt the vote note
- let note = match params.note.decrypt_unsafe(votes_secret_key) {
- Ok(n) => n,
- Err(e) => {
- return Err(Error::DatabaseError(format!(
- "[apply_dao_vote_data] Couldn't decrypt proposal {} vote with DAO {} keys: {e}",
- params.proposal_bulla, dao_bulla,
- )))
- }
- };
- // Create the DAO vote record
- let vote_option = fp_to_u64(note[0]).unwrap();
- if vote_option > 1 {
- return Err(Error::DatabaseError(format!(
- "[apply_dao_vote_data] Malformed vote for proposal {}: {vote_option}",
- params.proposal_bulla,
- )))
- }
- let vote_option = vote_option != 0;
- let yes_vote_blind = Blind(fp_mod_fv(note[1]));
- let all_vote_value = fp_to_u64(note[2]).unwrap();
- let all_vote_blind = Blind(fp_mod_fv(note[3]));
- let v = VoteRecord {
- id: 0, // This will be set by SQLite AUTOINCREMENT
- proposal: params.proposal_bulla,
- vote_option,
- yes_vote_blind,
- all_vote_value,
- all_vote_blind,
- block_height: *block_height,
- tx_hash: *tx_hash,
- call_index: *call_index,
- nullifiers: params.inputs.iter().map(|i| i.vote_nullifier).collect(),
- };
- if let Err(e) = self.put_dao_vote(&v).await {
- return Err(Error::DatabaseError(format!(
- "[apply_dao_vote_data] Put DAO votes failed: {e}"
- )))
- }
- Ok(true)
- }
- /// Auxiliary function to apply `DaoFunction::Exec` call data to
- /// the wallet and update the provided scan cache.
- /// Returns a flag indicating if the provided call refers to our
- /// own wallet.
- async fn apply_dao_exec_data(
- &self,
- scan_cache: &ScanCache,
- params: &DaoExecParams,
- tx_hash: &TransactionHash,
- exec_height: &u32,
- ) -> Result<bool> {
- // Check if we got the corresponding proposal
- if !scan_cache.own_proposals.contains_key(¶ms.proposal_bulla) {
- return Ok(false)
- }
- // Grab proposal record key
- let key = serialize_async(¶ms.proposal_bulla).await;
- // Create an SQL `UPDATE` query to update proposal exec transaction hash
- let query = format!(
- "UPDATE {} SET {} = ?1, {} = ?2 WHERE {} = ?3;",
- *DAO_PROPOSALS_TABLE,
- DAO_PROPOSALS_COL_EXEC_HEIGHT,
- DAO_PROPOSALS_COL_EXEC_TX_HASH,
- DAO_PROPOSALS_COL_BULLA,
- );
- // Execute the query
- if let Err(e) = self
- .wallet
- .exec_sql(&query, rusqlite::params![Some(*exec_height), Some(serialize(tx_hash)), key])
- {
- return Err(Error::DatabaseError(format!(
- "[apply_dao_exec_data] Update DAO proposal failed: {e}"
- )))
- }
- Ok(true)
- }
- /// Append data related to DAO contract transactions into the
- /// wallet database and update the provided scan cache.
- /// Returns a flag indicating if provided data refer to our own
- /// wallet.
- pub async fn apply_tx_dao_data(
- &self,
- scan_cache: &mut ScanCache,
- data: &[u8],
- tx_hash: &TransactionHash,
- call_idx: &u8,
- block_height: &u32,
- ) -> Result<bool> {
- // Run through the transaction call data and see what we got:
- match DaoFunction::try_from(data[0])? {
- DaoFunction::Mint => {
- scan_cache.log(String::from("[apply_tx_dao_data] Found Dao::Mint call"));
- let params: DaoMintParams = deserialize_async(&data[1..]).await?;
- self.apply_dao_mint_data(
- scan_cache,
- ¶ms.dao_bulla,
- tx_hash,
- call_idx,
- block_height,
- )
- .await
- }
- DaoFunction::Propose => {
- scan_cache.log(String::from("[apply_tx_dao_data] Found Dao::Propose call"));
- let params: DaoProposeParams = deserialize_async(&data[1..]).await?;
- self.apply_dao_propose_data(scan_cache, ¶ms, tx_hash, call_idx, block_height)
- .await
- }
- DaoFunction::Vote => {
- scan_cache.log(String::from("[apply_tx_dao_data] Found Dao::Vote call"));
- let params: DaoVoteParams = deserialize_async(&data[1..]).await?;
- self.apply_dao_vote_data(scan_cache, ¶ms, tx_hash, call_idx, block_height).await
- }
- DaoFunction::Exec => {
- scan_cache.log(String::from("[apply_tx_dao_data] Found Dao::Exec call"));
- let params: DaoExecParams = deserialize_async(&data[1..]).await?;
- self.apply_dao_exec_data(scan_cache, ¶ms, tx_hash, block_height).await
- }
- DaoFunction::AuthMoneyTransfer => {
- scan_cache
- .log(String::from("[apply_tx_dao_data] Found Dao::AuthMoneyTransfer call"));
- // Does nothing, just verifies the other calls are correct
- Ok(false)
- }
- }
- }
- /// Confirm already imported DAO metadata into the wallet.
- /// Here we just write the leaf position, mint height, tx hash,
- /// and call index.
- pub async fn confirm_dao(
- &self,
- dao: &DaoBulla,
- leaf_position: &bridgetree::Position,
- tx_hash: &TransactionHash,
- call_index: &u8,
- mint_height: &u32,
- ) -> WalletDbResult<()> {
- // Grab dao record key
- let key = serialize_async(dao).await;
- // Create an SQL `UPDATE` query
- let query = format!(
- "UPDATE {} SET {} = ?1, {} = ?2, {} = ?3, {} = ?4 WHERE {} = ?5;",
- *DAO_DAOS_TABLE,
- DAO_DAOS_COL_LEAF_POSITION,
- DAO_DAOS_COL_MINT_HEIGHT,
- DAO_DAOS_COL_TX_HASH,
- DAO_DAOS_COL_CALL_INDEX,
- DAO_DAOS_COL_BULLA
- );
- // Create its params
- let params = rusqlite::params![
- serialize(leaf_position),
- Some(*mint_height),
- serialize(tx_hash),
- call_index,
- key,
- ];
- // Execute the query
- self.wallet.exec_sql(&query, params)
- }
- /// Import given DAO proposal into the wallet.
- pub async fn put_dao_proposal(&self, proposal: &ProposalRecord) -> Result<()> {
- // Check that we already have the proposal DAO
- if let Err(e) = self.get_dao_by_bulla(&proposal.proposal.dao_bulla).await {
- return Err(Error::DatabaseError(format!(
- "[put_dao_proposal] Couldn't find proposal {} DAO {}: {e}",
- proposal.bulla(),
- proposal.proposal.dao_bulla
- )))
- }
- // Grab proposal record key
- let key = serialize_async(&proposal.bulla()).await;
- // Create an SQL `INSERT OR REPLACE` query
- let query = format!(
- "INSERT OR REPLACE INTO {} ({}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}) VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12);",
- *DAO_PROPOSALS_TABLE,
- DAO_PROPOSALS_COL_BULLA,
- DAO_PROPOSALS_COL_DAO_BULLA,
- DAO_PROPOSALS_COL_PROPOSAL,
- DAO_PROPOSALS_COL_DATA,
- DAO_PROPOSALS_COL_LEAF_POSITION,
- DAO_PROPOSALS_COL_MONEY_SNAPSHOT_TREE,
- DAO_PROPOSALS_COL_NULLIFIERS_SMT_SNAPSHOT,
- DAO_PROPOSALS_COL_MINT_HEIGHT,
- DAO_PROPOSALS_COL_TX_HASH,
- DAO_PROPOSALS_COL_CALL_INDEX,
- DAO_PROPOSALS_COL_EXEC_HEIGHT,
- DAO_PROPOSALS_COL_EXEC_TX_HASH,
- );
- // Create its params
- let data = match &proposal.data {
- Some(data) => Some(data),
- None => None,
- };
- let leaf_position = match &proposal.leaf_position {
- Some(leaf_position) => Some(serialize_async(leaf_position).await),
- None => None,
- };
- let money_snapshot_tree = match &proposal.money_snapshot_tree {
- Some(money_snapshot_tree) => Some(serialize_async(money_snapshot_tree).await),
- None => None,
- };
- let nullifiers_smt_snapshot = match &proposal.nullifiers_smt_snapshot {
- Some(nullifiers_smt_snapshot) => Some(serialize_async(nullifiers_smt_snapshot).await),
- None => None,
- };
- let tx_hash = match &proposal.tx_hash {
- Some(tx_hash) => Some(serialize_async(tx_hash).await),
- None => None,
- };
- let exec_tx_hash = match &proposal.exec_tx_hash {
- Some(exec_tx_hash) => Some(serialize_async(exec_tx_hash).await),
- None => None,
- };
- let params = rusqlite::params![
- key,
- serialize(&proposal.proposal.dao_bulla),
- serialize(&proposal.proposal),
- data,
- leaf_position,
- money_snapshot_tree,
- nullifiers_smt_snapshot,
- proposal.mint_height,
- tx_hash,
- proposal.call_index,
- proposal.exec_height,
- exec_tx_hash,
- ];
- // Execute the query
- if let Err(e) = self.wallet.exec_sql(&query, params) {
- return Err(Error::DatabaseError(format!(
- "[put_dao_proposal] Proposal insert failed: {e}"
- )))
- }
- Ok(())
- }
- /// Import given DAO vote into the wallet.
- pub async fn put_dao_vote(&self, vote: &VoteRecord) -> WalletDbResult<()> {
- println!("Importing DAO vote into wallet");
- // Create an SQL `INSERT OR REPLACE` query
- let query = format!(
- "INSERT INTO {} ({}, {}, {}, {}, {}, {}, {}, {}, {}) VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9);",
- *DAO_VOTES_TABLE,
- DAO_VOTES_COL_PROPOSAL_BULLA,
- DAO_VOTES_COL_VOTE_OPTION,
- DAO_VOTES_COL_YES_VOTE_BLIND,
- DAO_VOTES_COL_ALL_VOTE_VALUE,
- DAO_VOTES_COL_ALL_VOTE_BLIND,
- DAO_VOTES_COL_BLOCK_HEIGHT,
- DAO_VOTES_COL_TX_HASH,
- DAO_VOTES_COL_CALL_INDEX,
- DAO_VOTES_COL_NULLIFIERS,
- );
- // Create its params
- let params = rusqlite::params![
- serialize(&vote.proposal),
- vote.vote_option as u64,
- serialize(&vote.yes_vote_blind),
- serialize(&vote.all_vote_value),
- serialize(&vote.all_vote_blind),
- vote.block_height,
- serialize(&vote.tx_hash),
- vote.call_index,
- serialize(&vote.nullifiers),
- ];
- // Execute the query
- self.wallet.exec_sql(&query, params)?;
- println!("DAO vote added to wallet");
- Ok(())
- }
- /// Reset the DAO Merkle trees in the cache.
- pub fn reset_dao_trees(&self, output: &mut Vec<String>) -> WalletDbResult<()> {
- output.push(String::from("Resetting DAO Merkle trees"));
- if let Err(e) = self.cache.merkle_trees.remove(SLED_MERKLE_TREES_DAO_DAOS) {
- output.push(format!("[reset_dao_trees] Resetting DAO DAOs Merkle tree failed: {e}"));
- return Err(WalletDbError::GenericError)
- }
- if let Err(e) = self.cache.merkle_trees.remove(SLED_MERKLE_TREES_DAO_PROPOSALS) {
- output
- .push(format!("[reset_dao_trees] Resetting DAO Proposals Merkle tree failed: {e}"));
- return Err(WalletDbError::GenericError)
- }
- output.push(String::from("Successfully reset DAO Merkle trees"));
- Ok(())
- }
- /// Reset confirmed DAOs in the wallet.
- pub fn reset_daos(&self, output: &mut Vec<String>) -> WalletDbResult<()> {
- output.push(String::from("Resetting DAO confirmations"));
- let query = format!(
- "UPDATE {} SET {} = NULL, {} = NULL, {} = NULL, {} = NULL;",
- *DAO_DAOS_TABLE,
- DAO_DAOS_COL_LEAF_POSITION,
- DAO_DAOS_COL_MINT_HEIGHT,
- DAO_DAOS_COL_TX_HASH,
- DAO_DAOS_COL_CALL_INDEX,
- );
- self.wallet.exec_sql(&query, &[])?;
- output.push(String::from("Successfully unconfirmed DAOs"));
- Ok(())
- }
- /// Reset confirmed DAOs in the wallet that were minted after
- /// provided height.
- pub fn unconfirm_daos_after(
- &self,
- height: &u32,
- output: &mut Vec<String>,
- ) -> WalletDbResult<()> {
- output.push(format!("Resetting DAO confirmations after: {height}"));
- let query = format!(
- "UPDATE {} SET {} = NULL, {} = NULL, {} = NULL, {} = NULL WHERE {} > ?1;",
- *DAO_DAOS_TABLE,
- DAO_DAOS_COL_LEAF_POSITION,
- DAO_DAOS_COL_MINT_HEIGHT,
- DAO_DAOS_COL_TX_HASH,
- DAO_DAOS_COL_CALL_INDEX,
- DAO_DAOS_COL_MINT_HEIGHT,
- );
- self.wallet.exec_sql(&query, rusqlite::params![Some(*height)])?;
- output.push(String::from("Successfully unconfirmed DAOs"));
- Ok(())
- }
- /// Reset all DAO proposals in the wallet.
- pub fn reset_dao_proposals(&self, output: &mut Vec<String>) -> WalletDbResult<()> {
- output.push(String::from("Resetting DAO proposals confirmations"));
- let query = format!(
- "UPDATE {} SET {} = NULL, {} = NULL, {} = NULL, {} = NULL, {} = NULL, {} = NULL, {} = NULL, {} = NULL;",
- *DAO_PROPOSALS_TABLE,
- DAO_PROPOSALS_COL_LEAF_POSITION,
- DAO_PROPOSALS_COL_MONEY_SNAPSHOT_TREE,
- DAO_PROPOSALS_COL_NULLIFIERS_SMT_SNAPSHOT,
- DAO_PROPOSALS_COL_MINT_HEIGHT,
- DAO_PROPOSALS_COL_TX_HASH,
- DAO_PROPOSALS_COL_CALL_INDEX,
- DAO_PROPOSALS_COL_EXEC_HEIGHT,
- DAO_PROPOSALS_COL_EXEC_TX_HASH,
- );
- self.wallet.exec_sql(&query, &[])?;
- output.push(String::from("Successfully unconfirmed DAO proposals"));
- Ok(())
- }
- /// Reset DAO proposals in the wallet that were minted after
- /// provided height.
- pub fn unconfirm_dao_proposals_after(
- &self,
- height: &u32,
- output: &mut Vec<String>,
- ) -> WalletDbResult<()> {
- output.push(format!("Resetting DAO proposals confirmations after: {height}"));
- let query = format!(
- "UPDATE {} SET {} = NULL, {} = NULL, {} = NULL, {} = NULL, {} = NULL, {} = NULL, {} = NULL, {} = NULL WHERE {} > ?1;",
- *DAO_PROPOSALS_TABLE,
- DAO_PROPOSALS_COL_LEAF_POSITION,
- DAO_PROPOSALS_COL_MONEY_SNAPSHOT_TREE,
- DAO_PROPOSALS_COL_NULLIFIERS_SMT_SNAPSHOT,
- DAO_PROPOSALS_COL_MINT_HEIGHT,
- DAO_PROPOSALS_COL_TX_HASH,
- DAO_PROPOSALS_COL_CALL_INDEX,
- DAO_PROPOSALS_COL_EXEC_HEIGHT,
- DAO_PROPOSALS_COL_EXEC_TX_HASH,
- DAO_PROPOSALS_COL_MINT_HEIGHT,
- );
- self.wallet.exec_sql(&query, rusqlite::params![Some(*height)])?;
- output.push(String::from("Successfully unconfirmed DAO proposals"));
- Ok(())
- }
- /// Reset execution information in the wallet for DAO proposals
- /// that were executed after provided height.
- pub fn unexec_dao_proposals_after(
- &self,
- height: &u32,
- output: &mut Vec<String>,
- ) -> WalletDbResult<()> {
- output.push(format!("Resetting DAO proposals execution information after: {height}"));
- let query = format!(
- "UPDATE {} SET {} = NULL, {} = NULL WHERE {} > ?1;",
- *DAO_PROPOSALS_TABLE,
- DAO_PROPOSALS_COL_EXEC_HEIGHT,
- DAO_PROPOSALS_COL_EXEC_TX_HASH,
- DAO_PROPOSALS_COL_EXEC_HEIGHT,
- );
- self.wallet.exec_sql(&query, rusqlite::params![Some(*height)])?;
- output.push(String::from("Successfully reset DAO proposals execution information"));
- Ok(())
- }
- /// Reset all DAO votes in the wallet.
- pub fn reset_dao_votes(&self, output: &mut Vec<String>) -> WalletDbResult<()> {
- output.push(String::from("Resetting DAO votes"));
- let query = format!("DELETE FROM {};", *DAO_VOTES_TABLE);
- self.wallet.exec_sql(&query, &[])?;
- output.push(String::from("Successfully reset DAO votes"));
- Ok(())
- }
- /// Remove the DAO votes in the wallet that were created after
- /// provided height.
- pub fn remove_dao_votes_after(
- &self,
- height: &u32,
- output: &mut Vec<String>,
- ) -> WalletDbResult<()> {
- output.push(format!("Removing DAO votes after: {height}"));
- let query =
- format!("DELETE FROM {} WHERE {} > ?1;", *DAO_VOTES_TABLE, DAO_VOTES_COL_BLOCK_HEIGHT);
- self.wallet.exec_sql(&query, rusqlite::params![height])?;
- output.push(String::from("Successfully removed DAO votes"));
- Ok(())
- }
- /// Import given DAO params into the wallet with a given name.
- pub async fn import_dao(
- &self,
- name: &str,
- params: &DaoParams,
- output: &mut Vec<String>,
- ) -> Result<()> {
- // Grab the params DAO
- let bulla = params.dao.to_bulla();
- // Check if we already have imported the DAO so we retain its
- // mint information.
- match self.get_dao_by_bulla(&bulla).await {
- Ok(dao) => {
- output.push(format!("Updating \"{}\" DAO keys into the wallet", dao.name));
- let query = format!(
- "UPDATE {} SET {} = ?1 WHERE {} = ?2;",
- *DAO_DAOS_TABLE, DAO_DAOS_COL_PARAMS, DAO_DAOS_COL_BULLA,
- );
- if let Err(e) =
- self.wallet.exec_sql(
- &query,
- rusqlite::params![
- serialize_async(params).await,
- serialize_async(&bulla).await,
- ],
- )
- {
- return Err(Error::DatabaseError(format!("[import_dao] DAO update failed: {e}")))
- };
- }
- Err(_) => {
- output.push(format!("Importing \"{name}\" DAO into the wallet"));
- let query = format!(
- "INSERT INTO {} ({}, {}, {}) VALUES (?1, ?2, ?3);",
- *DAO_DAOS_TABLE, DAO_DAOS_COL_BULLA, DAO_DAOS_COL_NAME, DAO_DAOS_COL_PARAMS,
- );
- if let Err(e) = self.wallet.exec_sql(
- &query,
- rusqlite::params![
- serialize_async(¶ms.dao.to_bulla()).await,
- name,
- serialize_async(params).await,
- ],
- ) {
- return Err(Error::DatabaseError(format!("[import_dao] DAO insert failed: {e}")))
- };
- }
- };
- Ok(())
- }
- /// Fetch a DAO given its bulla.
- pub async fn get_dao_by_bulla(&self, bulla: &DaoBulla) -> Result<DaoRecord> {
- let row = match self.wallet.query_single(
- &DAO_DAOS_TABLE,
- &[],
- convert_named_params! {(DAO_DAOS_COL_BULLA, serialize_async(bulla).await)},
- ) {
- Ok(r) => r,
- Err(e) => {
- return Err(Error::DatabaseError(format!(
- "[get_dao_by_bulla] DAO retrieval failed: {e}"
- )))
- }
- };
- self.parse_dao_record(&row).await
- }
- /// Fetch a DAO given its name.
- pub async fn get_dao_by_name(&self, name: &str) -> Result<DaoRecord> {
- let row = match self.wallet.query_single(
- &DAO_DAOS_TABLE,
- &[],
- convert_named_params! {(DAO_DAOS_COL_NAME, name)},
- ) {
- Ok(r) => r,
- Err(e) => {
- return Err(Error::DatabaseError(format!(
- "[get_dao_by_name] DAO retrieval failed: {e}"
- )))
- }
- };
- self.parse_dao_record(&row).await
- }
- /// List DAO(s) imported in the wallet. If a name is given, just print the
- /// metadata for that specific one, if found.
- pub async fn dao_list(&self, name: &Option<String>, output: &mut Vec<String>) -> Result<()> {
- if let Some(name) = name {
- let dao = self.get_dao_by_name(name).await?;
- output.push(format!("{dao}"));
- return Ok(());
- }
- let daos = self.get_daos().await?;
- for (i, dao) in daos.iter().enumerate() {
- output.push(format!("{i}. {}", dao.name));
- }
- Ok(())
- }
- /// Fetch known unspent balances from the wallet for the given DAO name.
- pub async fn dao_balance(&self, name: &str) -> Result<HashMap<String, u64>> {
- let dao = self.get_dao_by_name(name).await?;
- let dao_spend_hook =
- FuncRef { contract_id: *DAO_CONTRACT_ID, func_code: DaoFunction::Exec as u8 }
- .to_func_id();
- let mut coins = self.get_coins(false).await?;
- coins.retain(|x| x.0.note.spend_hook == dao_spend_hook);
- coins.retain(|x| x.0.note.user_data == dao.bulla().inner());
- // Fill this map with balances
- let mut balmap: HashMap<String, u64> = HashMap::new();
- for coin in coins {
- let mut value = coin.0.note.value;
- if let Some(prev) = balmap.get(&coin.0.note.token_id.to_string()) {
- value += prev;
- }
- balmap.insert(coin.0.note.token_id.to_string(), value);
- }
- Ok(balmap)
- }
- /// Fetch all known DAO proposalss from the wallet.
- pub async fn get_proposals(&self) -> Result<Vec<ProposalRecord>> {
- let rows = match self.wallet.query_multiple(&DAO_PROPOSALS_TABLE, &[], &[]) {
- Ok(r) => r,
- Err(e) => {
- return Err(Error::DatabaseError(format!(
- "[get_proposals] DAO proposalss retrieval failed: {e}"
- )))
- }
- };
- let mut daos = Vec::with_capacity(rows.len());
- for row in rows {
- daos.push(self.parse_dao_proposal(&row).await?);
- }
- Ok(daos)
- }
- /// Fetch a DAO proposal by its bulla.
- pub async fn get_dao_proposal_by_bulla(
- &self,
- bulla: &DaoProposalBulla,
- ) -> Result<ProposalRecord> {
- // Grab the proposal record
- let row = match self.wallet.query_single(
- &DAO_PROPOSALS_TABLE,
- &[],
- convert_named_params! {(DAO_PROPOSALS_COL_BULLA, serialize_async(bulla).await)},
- ) {
- Ok(r) => r,
- Err(e) => {
- return Err(Error::DatabaseError(format!(
- "[get_dao_proposal_by_bulla] DAO proposal retrieval failed: {e}"
- )))
- }
- };
- // Parse rest of the record
- self.parse_dao_proposal(&row).await
- }
- // Fetch all known DAO proposal votes from the wallet given a proposal ID.
- pub async fn get_dao_proposal_votes(
- &self,
- proposal: &DaoProposalBulla,
- ) -> Result<Vec<VoteRecord>> {
- let rows = match self.wallet.query_multiple(
- &DAO_VOTES_TABLE,
- &[],
- convert_named_params! {(DAO_VOTES_COL_PROPOSAL_BULLA, serialize_async(proposal).await)},
- ) {
- Ok(r) => r,
- Err(e) => {
- return Err(Error::DatabaseError(format!(
- "[get_dao_proposal_votes] Votes retrieval failed: {e}"
- )))
- }
- };
- let mut votes = Vec::with_capacity(rows.len());
- for row in rows {
- let Value::Integer(id) = row[0] else {
- return Err(Error::ParseFailed("[get_dao_proposal_votes] ID parsing failed"))
- };
- let Ok(id) = u64::try_from(id) else {
- return Err(Error::ParseFailed("[get_dao_proposal_votes] ID parsing failed"))
- };
- let Value::Blob(ref proposal_bytes) = row[1] else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] Proposal bytes bytes parsing failed",
- ))
- };
- let proposal = deserialize_async(proposal_bytes).await?;
- let Value::Integer(vote_option) = row[2] else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] Vote option parsing failed",
- ))
- };
- let Ok(vote_option) = u32::try_from(vote_option) else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] Vote option parsing failed",
- ))
- };
- let vote_option = vote_option != 0;
- let Value::Blob(ref yes_vote_blind_bytes) = row[3] else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] Yes vote blind bytes parsing failed",
- ))
- };
- let yes_vote_blind = deserialize_async(yes_vote_blind_bytes).await?;
- let Value::Blob(ref all_vote_value_bytes) = row[4] else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] All vote value bytes parsing failed",
- ))
- };
- let all_vote_value = deserialize_async(all_vote_value_bytes).await?;
- let Value::Blob(ref all_vote_blind_bytes) = row[5] else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] All vote blind bytes parsing failed",
- ))
- };
- let all_vote_blind = deserialize_async(all_vote_blind_bytes).await?;
- let Value::Integer(block_height) = row[6] else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] Block height parsing failed",
- ))
- };
- let Ok(block_height) = u32::try_from(block_height) else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] Block height parsing failed",
- ))
- };
- let Value::Blob(ref tx_hash_bytes) = row[7] else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] Transaction hash bytes parsing failed",
- ))
- };
- let tx_hash = deserialize_async(tx_hash_bytes).await?;
- let Value::Integer(call_index) = row[8] else {
- return Err(Error::ParseFailed("[get_dao_proposal_votes] Call index parsing failed"))
- };
- let Ok(call_index) = u8::try_from(call_index) else {
- return Err(Error::ParseFailed("[get_dao_proposal_votes] Call index parsing failed"))
- };
- let Value::Blob(ref nullifiers_bytes) = row[9] else {
- return Err(Error::ParseFailed(
- "[get_dao_proposal_votes] Nullifiers bytes parsing failed",
- ))
- };
- let nullifiers = deserialize_async(nullifiers_bytes).await?;
- let vote = VoteRecord {
- id,
- proposal,
- vote_option,
- yes_vote_blind,
- all_vote_value,
- all_vote_blind,
- block_height,
- tx_hash,
- call_index,
- nullifiers,
- };
- votes.push(vote);
- }
- Ok(votes)
- }
- /// Mint a DAO on-chain.
- pub async fn dao_mint(&self, name: &str) -> Result<Transaction> {
- // Retrieve the dao record
- let dao = self.get_dao_by_name(name).await?;
- // Check its not already minted
- if dao.tx_hash.is_some() {
- return Err(Error::Custom(
- "[dao_mint] This DAO seems to have already been minted on-chain".to_string(),
- ))
- }
- // Check that we have all the keys
- if dao.params.notes_secret_key.is_none() ||
- dao.params.proposer_secret_key.is_none() ||
- dao.params.proposals_secret_key.is_none() ||
- dao.params.votes_secret_key.is_none() ||
- dao.params.exec_secret_key.is_none() ||
- dao.params.early_exec_secret_key.is_none()
- {
- return Err(Error::Custom(
- "[dao_mint] We need all the secrets key to mint the DAO on-chain".to_string(),
- ))
- }
- // Now we need to do a lookup for the zkas proof bincodes, and create
- // the circuit objects and proving keys so we can build the transaction.
- // We also do this through the RPC. First we grab the fee call from money.
- let zkas_bins = self.lookup_zkas(&MONEY_CONTRACT_ID).await?;
- let Some(fee_zkbin) = zkas_bins.iter().find(|x| x.0 == MONEY_CONTRACT_ZKAS_FEE_NS_V1)
- else {
- return Err(Error::Custom("Fee circuit not found".to_string()))
- };
- let fee_zkbin = ZkBinary::decode(&fee_zkbin.1)?;
- let fee_circuit = ZkCircuit::new(empty_witnesses(&fee_zkbin)?, &fee_zkbin);
- // Creating Fee circuit proving key
- let fee_pk = ProvingKey::build(fee_zkbin.k, &fee_circuit);
- // Now we grab the DAO mint
- let zkas_bins = self.lookup_zkas(&DAO_CONTRACT_ID).await?;
- let Some(dao_mint_zkbin) = zkas_bins.iter().find(|x| x.0 == DAO_CONTRACT_ZKAS_DAO_MINT_NS)
- else {
- return Err(Error::DatabaseError("[dao_mint] DAO Mint circuit not found".to_string()))
- };
- let dao_mint_zkbin = ZkBinary::decode(&dao_mint_zkbin.1)?;
- let dao_mint_circuit = ZkCircuit::new(empty_witnesses(&dao_mint_zkbin)?, &dao_mint_zkbin);
- // Creating DAO Mint circuit proving key
- let dao_mint_pk = ProvingKey::build(dao_mint_zkbin.k, &dao_mint_circuit);
- // Create the DAO mint call
- let notes_secret_key = dao.params.notes_secret_key.unwrap();
- let (params, proofs) = make_mint_call(
- &dao.params.dao,
- ¬es_secret_key,
- &dao.params.proposer_secret_key.unwrap(),
- &dao.params.proposals_secret_key.unwrap(),
- &dao.params.votes_secret_key.unwrap(),
- &dao.params.exec_secret_key.unwrap(),
- &dao.params.early_exec_secret_key.unwrap(),
- &dao_mint_zkbin,
- &dao_mint_pk,
- )?;
- let mut data = vec![DaoFunction::Mint as u8];
- params.encode_async(&mut data).await?;
- let call = ContractCall { contract_id: *DAO_CONTRACT_ID, data };
- // Create the TransactionBuilder containing above call
- let mut tx_builder = TransactionBuilder::new(ContractCallLeaf { call, proofs }, vec![])?;
- // We first have to execute the fee-less tx to gather its used gas, and then we feed
- // it into the fee-creating function.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[notes_secret_key])?;
- tx.signatures.push(sigs);
- let tree = self.get_money_tree().await?;
- let (fee_call, fee_proofs, fee_secrets) =
- self.append_fee_call(&tx, &tree, &fee_pk, &fee_zkbin, None).await?;
- // Append the fee call to the transaction
- tx_builder.append(ContractCallLeaf { call: fee_call, proofs: fee_proofs }, vec![])?;
- // Now build the actual transaction and sign it with all necessary keys.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[notes_secret_key])?;
- tx.signatures.push(sigs);
- let sigs = tx.create_sigs(&fee_secrets)?;
- tx.signatures.push(sigs);
- Ok(tx)
- }
- /// Create a DAO transfer proposal.
- #[allow(clippy::too_many_arguments)]
- pub async fn dao_propose_transfer(
- &self,
- name: &str,
- duration_blockwindows: u64,
- amount: &str,
- token_id: TokenId,
- recipient: PublicKey,
- spend_hook: Option<FuncId>,
- user_data: Option<pallas::Base>,
- ) -> Result<ProposalRecord> {
- // Fetch DAO and check its deployed
- let dao = self.get_dao_by_name(name).await?;
- if dao.leaf_position.is_none() || dao.tx_hash.is_none() || dao.call_index.is_none() {
- return Err(Error::Custom(
- "[dao_propose_transfer] DAO seems to not have been deployed yet".to_string(),
- ))
- }
- // Check that we have the proposer key
- if dao.params.proposer_secret_key.is_none() {
- return Err(Error::Custom(
- "[dao_propose_transfer] We need the proposer secret key to create proposals for this DAO".to_string(),
- ))
- }
- // Fetch DAO unspent OwnCoins to see what its balance is
- let dao_spend_hook =
- FuncRef { contract_id: *DAO_CONTRACT_ID, func_code: DaoFunction::Exec as u8 }
- .to_func_id();
- let dao_bulla = dao.bulla();
- let dao_owncoins =
- self.get_contract_token_coins(&token_id, &dao_spend_hook, &dao_bulla.inner()).await?;
- if dao_owncoins.is_empty() {
- return Err(Error::Custom(format!(
- "[dao_propose_transfer] Did not find any {token_id} unspent coins owned by this DAO"
- )))
- }
- // Check DAO balance is sufficient
- let amount = decode_base10(amount, BALANCE_BASE10_DECIMALS, false)?;
- if dao_owncoins.iter().map(|x| x.note.value).sum::<u64>() < amount {
- return Err(Error::Custom(format!(
- "[dao_propose_transfer] Not enough DAO balance for token ID: {token_id}",
- )))
- }
- // Generate proposal coin attributes
- let proposal_coinattrs = CoinAttributes {
- public_key: recipient,
- value: amount,
- token_id,
- spend_hook: spend_hook.unwrap_or(FuncId::none()),
- user_data: user_data.unwrap_or(pallas::Base::ZERO),
- blind: Blind::random(&mut OsRng),
- };
- // Convert coin_params to actual coins
- let proposal_coins = vec![proposal_coinattrs.to_coin()];
- let mut proposal_data = vec![];
- proposal_coins.encode_async(&mut proposal_data).await?;
- // Create Auth calls
- let auth_calls = vec![
- DaoAuthCall {
- contract_id: *DAO_CONTRACT_ID,
- function_code: DaoFunction::AuthMoneyTransfer as u8,
- auth_data: proposal_data,
- },
- DaoAuthCall {
- contract_id: *MONEY_CONTRACT_ID,
- function_code: MoneyFunction::TransferV1 as u8,
- auth_data: vec![],
- },
- ];
- // Retrieve next block height and current block time target,
- // to compute their window.
- let next_block_height = self.get_next_block_height().await?;
- let block_target = self.get_block_target().await?;
- let creation_blockwindow = blockwindow(next_block_height, block_target);
- // Create the actual proposal
- let proposal = DaoProposal {
- auth_calls,
- creation_blockwindow,
- duration_blockwindows,
- user_data: user_data.unwrap_or(pallas::Base::ZERO),
- dao_bulla,
- blind: Blind::random(&mut OsRng),
- };
- let proposal_record = ProposalRecord {
- proposal,
- data: Some(serialize_async(&proposal_coinattrs).await),
- leaf_position: None,
- money_snapshot_tree: None,
- nullifiers_smt_snapshot: None,
- mint_height: None,
- tx_hash: None,
- call_index: None,
- exec_height: None,
- exec_tx_hash: None,
- };
- if let Err(e) = self.put_dao_proposal(&proposal_record).await {
- return Err(Error::DatabaseError(format!(
- "[dao_propose_transfer] Put DAO proposal failed: {e}"
- )))
- }
- Ok(proposal_record)
- }
- /// Create a DAO generic proposal.
- pub async fn dao_propose_generic(
- &self,
- name: &str,
- duration_blockwindows: u64,
- user_data: Option<pallas::Base>,
- ) -> Result<ProposalRecord> {
- // Fetch DAO and check its deployed
- let dao = self.get_dao_by_name(name).await?;
- if dao.leaf_position.is_none() || dao.tx_hash.is_none() || dao.call_index.is_none() {
- return Err(Error::Custom(
- "[dao_propose_generic] DAO seems to not have been deployed yet".to_string(),
- ))
- }
- // Check that we have the proposer key
- if dao.params.proposer_secret_key.is_none() {
- return Err(Error::Custom(
- "[dao_propose_generic] We need the proposer secret key to create proposals for this DAO".to_string(),
- ))
- }
- // Retrieve next block height and current block time target,
- // to compute their window.
- let next_block_height = self.get_next_block_height().await?;
- let block_target = self.get_block_target().await?;
- let creation_blockwindow = blockwindow(next_block_height, block_target);
- // Create the actual proposal
- let proposal = DaoProposal {
- auth_calls: vec![],
- creation_blockwindow,
- duration_blockwindows,
- user_data: user_data.unwrap_or(pallas::Base::ZERO),
- dao_bulla: dao.bulla(),
- blind: Blind::random(&mut OsRng),
- };
- let proposal_record = ProposalRecord {
- proposal,
- data: None,
- leaf_position: None,
- money_snapshot_tree: None,
- nullifiers_smt_snapshot: None,
- mint_height: None,
- tx_hash: None,
- call_index: None,
- exec_height: None,
- exec_tx_hash: None,
- };
- if let Err(e) = self.put_dao_proposal(&proposal_record).await {
- return Err(Error::DatabaseError(format!(
- "[dao_propose_generic] Put DAO proposal failed: {e}"
- )))
- }
- Ok(proposal_record)
- }
- /// Create a DAO transfer proposal transaction.
- pub async fn dao_transfer_proposal_tx(&self, proposal: &ProposalRecord) -> Result<Transaction> {
- // Check we know the plaintext data
- if proposal.data.is_none() {
- return Err(Error::Custom(
- "[dao_transfer_proposal_tx] Proposal plainext data is empty".to_string(),
- ))
- }
- let proposal_coinattrs: CoinAttributes =
- deserialize_async(proposal.data.as_ref().unwrap()).await?;
- // Fetch DAO and check its deployed
- let Ok(dao) = self.get_dao_by_bulla(&proposal.proposal.dao_bulla).await else {
- return Err(Error::Custom(format!(
- "[dao_transfer_proposal_tx] DAO {} was not found",
- proposal.proposal.dao_bulla
- )))
- };
- if dao.leaf_position.is_none() || dao.tx_hash.is_none() || dao.call_index.is_none() {
- return Err(Error::Custom(
- "[dao_transfer_proposal_tx] DAO seems to not have been deployed yet".to_string(),
- ))
- }
- // Check that we have the proposer key
- if dao.params.proposer_secret_key.is_none() {
- return Err(Error::Custom(
- "[dao_transfer_proposal_tx] We need the proposer secret key to create proposals for this DAO".to_string(),
- ))
- }
- // Fetch DAO unspent OwnCoins to see what its balance is for the coin
- let dao_spend_hook =
- FuncRef { contract_id: *DAO_CONTRACT_ID, func_code: DaoFunction::Exec as u8 }
- .to_func_id();
- let dao_owncoins = self
- .get_contract_token_coins(
- &proposal_coinattrs.token_id,
- &dao_spend_hook,
- &proposal.proposal.dao_bulla.inner(),
- )
- .await?;
- if dao_owncoins.is_empty() {
- return Err(Error::Custom(format!(
- "[dao_transfer_proposal_tx] Did not find any {} unspent coins owned by this DAO",
- proposal_coinattrs.token_id,
- )))
- }
- // Check DAO balance is sufficient
- if dao_owncoins.iter().map(|x| x.note.value).sum::<u64>() < proposal_coinattrs.value {
- return Err(Error::Custom(format!(
- "[dao_transfer_proposal_tx] Not enough DAO balance for token ID: {}",
- proposal_coinattrs.token_id,
- )))
- }
- // Fetch our own governance OwnCoins to see what our balance is
- let gov_owncoins = self.get_token_coins(&dao.params.dao.gov_token_id).await?;
- if gov_owncoins.is_empty() {
- return Err(Error::Custom(format!(
- "[dao_transfer_proposal_tx] Did not find any governance {} coins in wallet",
- dao.params.dao.gov_token_id
- )))
- }
- // Find which governance coins we can use
- let mut total_value = 0;
- let mut gov_owncoins_to_use = vec![];
- for gov_owncoin in gov_owncoins {
- if total_value >= dao.params.dao.proposer_limit {
- break
- }
- total_value += gov_owncoin.note.value;
- gov_owncoins_to_use.push(gov_owncoin);
- }
- // Check our governance coins balance is sufficient
- if total_value < dao.params.dao.proposer_limit {
- return Err(Error::Custom(format!(
- "[dao_transfer_proposal_tx] Not enough gov token {} balance to propose",
- dao.params.dao.gov_token_id
- )))
- }
- // Now we need to do a lookup for the zkas proof bincodes, and create
- // the circuit objects and proving keys so we can build the transaction.
- // We also do this through the RPC. First we grab the fee call from money.
- let zkas_bins = self.lookup_zkas(&MONEY_CONTRACT_ID).await?;
- let Some(fee_zkbin) = zkas_bins.iter().find(|x| x.0 == MONEY_CONTRACT_ZKAS_FEE_NS_V1)
- else {
- return Err(Error::Custom(
- "[dao_transfer_proposal_tx] Fee circuit not found".to_string(),
- ))
- };
- let fee_zkbin = ZkBinary::decode(&fee_zkbin.1)?;
- let fee_circuit = ZkCircuit::new(empty_witnesses(&fee_zkbin)?, &fee_zkbin);
- // Creating Fee circuit proving key
- let fee_pk = ProvingKey::build(fee_zkbin.k, &fee_circuit);
- // Now we grab the DAO bins
- let zkas_bins = self.lookup_zkas(&DAO_CONTRACT_ID).await?;
- let Some(propose_burn_zkbin) =
- zkas_bins.iter().find(|x| x.0 == DAO_CONTRACT_ZKAS_DAO_PROPOSE_INPUT_NS)
- else {
- return Err(Error::Custom(
- "[dao_transfer_proposal_tx] Propose Burn circuit not found".to_string(),
- ))
- };
- let Some(propose_main_zkbin) =
- zkas_bins.iter().find(|x| x.0 == DAO_CONTRACT_ZKAS_DAO_PROPOSE_MAIN_NS)
- else {
- return Err(Error::Custom(
- "[dao_transfer_proposal_tx] Propose Main circuit not found".to_string(),
- ))
- };
- let propose_burn_zkbin = ZkBinary::decode(&propose_burn_zkbin.1)?;
- let propose_main_zkbin = ZkBinary::decode(&propose_main_zkbin.1)?;
- let propose_burn_circuit =
- ZkCircuit::new(empty_witnesses(&propose_burn_zkbin)?, &propose_burn_zkbin);
- let propose_main_circuit =
- ZkCircuit::new(empty_witnesses(&propose_main_zkbin)?, &propose_main_zkbin);
- // Creating DAO ProposeBurn and ProposeMain circuits proving keys
- let propose_burn_pk = ProvingKey::build(propose_burn_zkbin.k, &propose_burn_circuit);
- let propose_main_pk = ProvingKey::build(propose_main_zkbin.k, &propose_main_circuit);
- // Fetch our money Merkle tree
- let money_merkle_tree = self.get_money_tree().await?;
- // Now we can create the proposal transaction parameters.
- // We first generate the `DaoProposeStakeInput` inputs,
- // using our governance OwnCoins.
- let mut inputs = Vec::with_capacity(gov_owncoins_to_use.len());
- for gov_owncoin in gov_owncoins_to_use {
- let input = DaoProposeStakeInput {
- secret: gov_owncoin.secret,
- note: gov_owncoin.note.clone(),
- leaf_position: gov_owncoin.leaf_position,
- merkle_path: money_merkle_tree.witness(gov_owncoin.leaf_position, 0).unwrap(),
- };
- inputs.push(input);
- }
- // Now create the parameters for the proposal tx
- let signature_secret = SecretKey::random(&mut OsRng);
- // Fetch the daos Merkle tree to compute the DAO Merkle path and root
- let (daos_tree, _) = self.get_dao_trees().await?;
- let (dao_merkle_path, dao_merkle_root) = {
- let root = daos_tree.root(0).unwrap();
- let leaf_pos = dao.leaf_position.unwrap();
- let dao_merkle_path = daos_tree.witness(leaf_pos, 0).unwrap();
- (dao_merkle_path, root)
- };
- // Generate the Money nullifiers Sparse Merkle Tree
- let store = CacheSmtStorage::new(CacheOverlay::new(&self.cache)?, SLED_MONEY_SMT_TREE);
- let money_null_smt = CacheSmt::new(store, PoseidonFp::new(), &EMPTY_NODES_FP);
- // Create the proposal call
- let call = DaoProposeCall {
- money_null_smt: &money_null_smt,
- inputs,
- proposal: proposal.proposal.clone(),
- dao: dao.params.dao,
- dao_leaf_position: dao.leaf_position.unwrap(),
- dao_merkle_path,
- dao_merkle_root,
- signature_secret,
- };
- let (params, proofs) = call.make(
- &dao.params.proposer_secret_key.unwrap(),
- &propose_burn_zkbin,
- &propose_burn_pk,
- &propose_main_zkbin,
- &propose_main_pk,
- )?;
- // Encode the call
- let mut data = vec![DaoFunction::Propose as u8];
- params.encode_async(&mut data).await?;
- let call = ContractCall { contract_id: *DAO_CONTRACT_ID, data };
- // Create the TransactionBuilder containing above call
- let mut tx_builder = TransactionBuilder::new(ContractCallLeaf { call, proofs }, vec![])?;
- // We first have to execute the fee-less tx to gather its used gas, and then we feed
- // it into the fee-creating function.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[signature_secret])?;
- tx.signatures = vec![sigs];
- let tree = self.get_money_tree().await?;
- let (fee_call, fee_proofs, fee_secrets) =
- self.append_fee_call(&tx, &tree, &fee_pk, &fee_zkbin, None).await?;
- // Append the fee call to the transaction
- tx_builder.append(ContractCallLeaf { call: fee_call, proofs: fee_proofs }, vec![])?;
- // Now build the actual transaction and sign it with all necessary keys.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[signature_secret])?;
- tx.signatures.push(sigs);
- let sigs = tx.create_sigs(&fee_secrets)?;
- tx.signatures.push(sigs);
- Ok(tx)
- }
- /// Create a DAO generic proposal transaction.
- pub async fn dao_generic_proposal_tx(&self, proposal: &ProposalRecord) -> Result<Transaction> {
- // Fetch DAO and check its deployed
- let Ok(dao) = self.get_dao_by_bulla(&proposal.proposal.dao_bulla).await else {
- return Err(Error::Custom(format!(
- "[dao_generic_proposal_tx] DAO {} was not found",
- proposal.proposal.dao_bulla
- )))
- };
- if dao.leaf_position.is_none() || dao.tx_hash.is_none() || dao.call_index.is_none() {
- return Err(Error::Custom(
- "[dao_generic_proposal_tx] DAO seems to not have been deployed yet".to_string(),
- ))
- }
- // Check that we have the proposer key
- if dao.params.proposer_secret_key.is_none() {
- return Err(Error::Custom(
- "[dao_generic_proposal_tx] We need the proposer secret key to create proposals for this DAO".to_string(),
- ))
- }
- // Fetch our own governance OwnCoins to see what our balance is
- let gov_owncoins = self.get_token_coins(&dao.params.dao.gov_token_id).await?;
- if gov_owncoins.is_empty() {
- return Err(Error::Custom(format!(
- "[dao_generic_proposal_tx] Did not find any governance {} coins in wallet",
- dao.params.dao.gov_token_id
- )))
- }
- // Find which governance coins we can use
- let mut total_value = 0;
- let mut gov_owncoins_to_use = vec![];
- for gov_owncoin in gov_owncoins {
- if total_value >= dao.params.dao.proposer_limit {
- break
- }
- total_value += gov_owncoin.note.value;
- gov_owncoins_to_use.push(gov_owncoin);
- }
- // Check our governance coins balance is sufficient
- if total_value < dao.params.dao.proposer_limit {
- return Err(Error::Custom(format!(
- "[dao_generic_proposal_tx] Not enough gov token {} balance to propose",
- dao.params.dao.gov_token_id
- )))
- }
- // Now we need to do a lookup for the zkas proof bincodes, and create
- // the circuit objects and proving keys so we can build the transaction.
- // We also do this through the RPC. First we grab the fee call from money.
- let zkas_bins = self.lookup_zkas(&MONEY_CONTRACT_ID).await?;
- let Some(fee_zkbin) = zkas_bins.iter().find(|x| x.0 == MONEY_CONTRACT_ZKAS_FEE_NS_V1)
- else {
- return Err(Error::Custom("[dao_generic_proposal_tx] Fee circuit not found".to_string()))
- };
- let fee_zkbin = ZkBinary::decode(&fee_zkbin.1)?;
- let fee_circuit = ZkCircuit::new(empty_witnesses(&fee_zkbin)?, &fee_zkbin);
- // Creating Fee circuit proving key
- let fee_pk = ProvingKey::build(fee_zkbin.k, &fee_circuit);
- // Now we grab the DAO bins
- let zkas_bins = self.lookup_zkas(&DAO_CONTRACT_ID).await?;
- let Some(propose_burn_zkbin) =
- zkas_bins.iter().find(|x| x.0 == DAO_CONTRACT_ZKAS_DAO_PROPOSE_INPUT_NS)
- else {
- return Err(Error::Custom(
- "[dao_generic_proposal_tx] Propose Burn circuit not found".to_string(),
- ))
- };
- let Some(propose_main_zkbin) =
- zkas_bins.iter().find(|x| x.0 == DAO_CONTRACT_ZKAS_DAO_PROPOSE_MAIN_NS)
- else {
- return Err(Error::Custom(
- "[dao_generic_proposal_tx] Propose Main circuit not found".to_string(),
- ))
- };
- let propose_burn_zkbin = ZkBinary::decode(&propose_burn_zkbin.1)?;
- let propose_main_zkbin = ZkBinary::decode(&propose_main_zkbin.1)?;
- let propose_burn_circuit =
- ZkCircuit::new(empty_witnesses(&propose_burn_zkbin)?, &propose_burn_zkbin);
- let propose_main_circuit =
- ZkCircuit::new(empty_witnesses(&propose_main_zkbin)?, &propose_main_zkbin);
- // Creating DAO ProposeBurn and ProposeMain circuits proving keys
- let propose_burn_pk = ProvingKey::build(propose_burn_zkbin.k, &propose_burn_circuit);
- let propose_main_pk = ProvingKey::build(propose_main_zkbin.k, &propose_main_circuit);
- // Fetch our money Merkle tree
- let money_merkle_tree = self.get_money_tree().await?;
- // Now we can create the proposal transaction parameters.
- // We first generate the `DaoProposeStakeInput` inputs,
- // using our governance OwnCoins.
- let mut inputs = Vec::with_capacity(gov_owncoins_to_use.len());
- for gov_owncoin in gov_owncoins_to_use {
- let input = DaoProposeStakeInput {
- secret: gov_owncoin.secret,
- note: gov_owncoin.note.clone(),
- leaf_position: gov_owncoin.leaf_position,
- merkle_path: money_merkle_tree.witness(gov_owncoin.leaf_position, 0).unwrap(),
- };
- inputs.push(input);
- }
- // Now create the parameters for the proposal tx
- let signature_secret = SecretKey::random(&mut OsRng);
- // Fetch the daos Merkle tree to compute the DAO Merkle path and root
- let (daos_tree, _) = self.get_dao_trees().await?;
- let (dao_merkle_path, dao_merkle_root) = {
- let root = daos_tree.root(0).unwrap();
- let leaf_pos = dao.leaf_position.unwrap();
- let dao_merkle_path = daos_tree.witness(leaf_pos, 0).unwrap();
- (dao_merkle_path, root)
- };
- // Generate the Money nullifiers Sparse Merkle Tree
- let store = CacheSmtStorage::new(CacheOverlay::new(&self.cache)?, SLED_MONEY_SMT_TREE);
- let money_null_smt = CacheSmt::new(store, PoseidonFp::new(), &EMPTY_NODES_FP);
- // Create the proposal call
- let call = DaoProposeCall {
- money_null_smt: &money_null_smt,
- inputs,
- proposal: proposal.proposal.clone(),
- dao: dao.params.dao,
- dao_leaf_position: dao.leaf_position.unwrap(),
- dao_merkle_path,
- dao_merkle_root,
- signature_secret,
- };
- let (params, proofs) = call.make(
- &dao.params.proposer_secret_key.unwrap(),
- &propose_burn_zkbin,
- &propose_burn_pk,
- &propose_main_zkbin,
- &propose_main_pk,
- )?;
- // Encode the call
- let mut data = vec![DaoFunction::Propose as u8];
- params.encode_async(&mut data).await?;
- let call = ContractCall { contract_id: *DAO_CONTRACT_ID, data };
- // Create the TransactionBuilder containing above call
- let mut tx_builder = TransactionBuilder::new(ContractCallLeaf { call, proofs }, vec![])?;
- // We first have to execute the fee-less tx to gather its used gas, and then we feed
- // it into the fee-creating function.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[signature_secret])?;
- tx.signatures = vec![sigs];
- let tree = self.get_money_tree().await?;
- let (fee_call, fee_proofs, fee_secrets) =
- self.append_fee_call(&tx, &tree, &fee_pk, &fee_zkbin, None).await?;
- // Append the fee call to the transaction
- tx_builder.append(ContractCallLeaf { call: fee_call, proofs: fee_proofs }, vec![])?;
- // Now build the actual transaction and sign it with all necessary keys.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[signature_secret])?;
- tx.signatures.push(sigs);
- let sigs = tx.create_sigs(&fee_secrets)?;
- tx.signatures.push(sigs);
- Ok(tx)
- }
- /// Vote on a DAO proposal
- pub async fn dao_vote(
- &self,
- proposal_bulla: &DaoProposalBulla,
- vote_option: bool,
- weight: Option<u64>,
- ) -> Result<Transaction> {
- // Feth the proposal and check its deployed
- let Ok(proposal) = self.get_dao_proposal_by_bulla(proposal_bulla).await else {
- return Err(Error::Custom(format!("[dao_vote] Proposal {proposal_bulla} was not found")))
- };
- if proposal.leaf_position.is_none() ||
- proposal.money_snapshot_tree.is_none() ||
- proposal.nullifiers_smt_snapshot.is_none() ||
- proposal.tx_hash.is_none() ||
- proposal.call_index.is_none()
- {
- return Err(Error::Custom(
- "[dao_vote] Proposal seems to not have been deployed yet".to_string(),
- ))
- }
- // Check proposal is not executed
- if let Some(exec_tx_hash) = proposal.exec_tx_hash {
- return Err(Error::Custom(format!(
- "[dao_vote] Proposal was executed on transaction: {exec_tx_hash}"
- )))
- }
- // Fetch DAO and check its deployed
- let Ok(dao) = self.get_dao_by_bulla(&proposal.proposal.dao_bulla).await else {
- return Err(Error::Custom(format!(
- "[dao_vote] DAO {} was not found",
- proposal.proposal.dao_bulla
- )))
- };
- if dao.leaf_position.is_none() || dao.tx_hash.is_none() || dao.call_index.is_none() {
- return Err(Error::Custom(
- "[dao_vote] DAO seems to not have been deployed yet".to_string(),
- ))
- }
- // Fetch all the proposal votes to check for duplicate nullifiers
- let votes = self.get_dao_proposal_votes(proposal_bulla).await?;
- let mut votes_nullifiers = vec![];
- for vote in votes {
- for nullifier in vote.nullifiers {
- if !votes_nullifiers.contains(&nullifier) {
- votes_nullifiers.push(nullifier);
- }
- }
- }
- // Fetch our own governance OwnCoins to see what our balance is
- let gov_owncoins = self.get_token_coins(&dao.params.dao.gov_token_id).await?;
- if gov_owncoins.is_empty() {
- return Err(Error::Custom(format!(
- "[dao_vote] Did not find any governance {} coins in wallet",
- dao.params.dao.gov_token_id
- )))
- }
- // Find which governance coins we can use
- let gov_owncoins_to_use = match weight {
- Some(_weight) => {
- // TODO: Build a proper coin selection algorithm so that we can use a
- // coins combination that matches the requested weight
- return Err(Error::Custom(
- "[dao_vote] Fractional vote weight not supported yet".to_string(),
- ))
- }
- // If no weight was specified, use them all
- None => gov_owncoins,
- };
- // Now we need to do a lookup for the zkas proof bincodes, and create
- // the circuit objects and proving keys so we can build the transaction.
- // We also do this through the RPC. First we grab the fee call from money.
- let zkas_bins = self.lookup_zkas(&MONEY_CONTRACT_ID).await?;
- let Some(fee_zkbin) = zkas_bins.iter().find(|x| x.0 == MONEY_CONTRACT_ZKAS_FEE_NS_V1)
- else {
- return Err(Error::Custom("[dao_vote] Fee circuit not found".to_string()))
- };
- let fee_zkbin = ZkBinary::decode(&fee_zkbin.1)?;
- let fee_circuit = ZkCircuit::new(empty_witnesses(&fee_zkbin)?, &fee_zkbin);
- // Creating Fee circuit proving key
- let fee_pk = ProvingKey::build(fee_zkbin.k, &fee_circuit);
- // Now we grab the DAO bins
- let zkas_bins = self.lookup_zkas(&DAO_CONTRACT_ID).await?;
- let Some(dao_vote_burn_zkbin) =
- zkas_bins.iter().find(|x| x.0 == DAO_CONTRACT_ZKAS_DAO_VOTE_INPUT_NS)
- else {
- return Err(Error::Custom("[dao_vote] DAO Vote Burn circuit not found".to_string()))
- };
- let Some(dao_vote_main_zkbin) =
- zkas_bins.iter().find(|x| x.0 == DAO_CONTRACT_ZKAS_DAO_VOTE_MAIN_NS)
- else {
- return Err(Error::Custom("[dao_vote] DAO Vote Main circuit not found".to_string()))
- };
- let dao_vote_burn_zkbin = ZkBinary::decode(&dao_vote_burn_zkbin.1)?;
- let dao_vote_main_zkbin = ZkBinary::decode(&dao_vote_main_zkbin.1)?;
- let dao_vote_burn_circuit =
- ZkCircuit::new(empty_witnesses(&dao_vote_burn_zkbin)?, &dao_vote_burn_zkbin);
- let dao_vote_main_circuit =
- ZkCircuit::new(empty_witnesses(&dao_vote_main_zkbin)?, &dao_vote_main_zkbin);
- // Creating DAO VoteBurn and VoteMain circuits proving keys
- let dao_vote_burn_pk = ProvingKey::build(dao_vote_burn_zkbin.k, &dao_vote_burn_circuit);
- let dao_vote_main_pk = ProvingKey::build(dao_vote_main_zkbin.k, &dao_vote_main_circuit);
- // Now create the parameters for the vote tx
- let signature_secret = SecretKey::random(&mut OsRng);
- let mut inputs = Vec::with_capacity(gov_owncoins_to_use.len());
- for gov_owncoin in gov_owncoins_to_use {
- // Skip governance coins that are not part of the snapshot
- let Ok(merkle_path) = proposal
- .money_snapshot_tree
- .as_ref()
- .unwrap()
- .witness(gov_owncoin.leaf_position, 0)
- else {
- continue
- };
- let nullifier = poseidon_hash([gov_owncoin.secret.inner(), gov_owncoin.coin.inner()]);
- let vote_nullifier =
- poseidon_hash([nullifier, gov_owncoin.secret.inner(), proposal_bulla.inner()]);
- if votes_nullifiers.contains(&vote_nullifier.into()) {
- return Err(Error::Custom("[dao_vote] Duplicate input nullifier found".to_string()))
- };
- let input = DaoVoteInput {
- secret: gov_owncoin.secret,
- note: gov_owncoin.note.clone(),
- leaf_position: gov_owncoin.leaf_position,
- merkle_path,
- signature_secret,
- };
- inputs.push(input);
- }
- if inputs.is_empty() {
- return Err(Error::Custom(format!(
- "[dao_vote] Did not find any governance {} coins in wallet before proposal snapshot",
- dao.params.dao.gov_token_id
- )))
- }
- // Retrieve next block height and current block time target,
- // to compute their window.
- let next_block_height = self.get_next_block_height().await?;
- let block_target = self.get_block_target().await?;
- let current_blockwindow = blockwindow(next_block_height, block_target);
- // Generate the Money nullifiers Sparse Merkle Tree
- let store = MemoryStorageFp { tree: proposal.nullifiers_smt_snapshot.unwrap() };
- let money_null_smt = SmtMemoryFp::new(store, PoseidonFp::new(), &EMPTY_NODES_FP);
- // Create the vote call
- let call = DaoVoteCall {
- money_null_smt: &money_null_smt,
- inputs,
- vote_option,
- proposal: proposal.proposal.clone(),
- dao: dao.params.dao.clone(),
- current_blockwindow,
- };
- let (params, proofs) = call.make(
- &dao_vote_burn_zkbin,
- &dao_vote_burn_pk,
- &dao_vote_main_zkbin,
- &dao_vote_main_pk,
- )?;
- // Encode the call
- let mut data = vec![DaoFunction::Vote as u8];
- params.encode_async(&mut data).await?;
- let call = ContractCall { contract_id: *DAO_CONTRACT_ID, data };
- // Create the TransactionBuilder containing above call
- let mut tx_builder = TransactionBuilder::new(ContractCallLeaf { call, proofs }, vec![])?;
- // We first have to execute the fee-less tx to gather its used gas, and then we feed
- // it into the fee-creating function.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[signature_secret])?;
- tx.signatures = vec![sigs];
- let tree = self.get_money_tree().await?;
- let (fee_call, fee_proofs, fee_secrets) =
- self.append_fee_call(&tx, &tree, &fee_pk, &fee_zkbin, None).await?;
- // Append the fee call to the transaction
- tx_builder.append(ContractCallLeaf { call: fee_call, proofs: fee_proofs }, vec![])?;
- // Now build the actual transaction and sign it with all necessary keys.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[signature_secret])?;
- tx.signatures.push(sigs);
- let sigs = tx.create_sigs(&fee_secrets)?;
- tx.signatures.push(sigs);
- Ok(tx)
- }
- /// Execute a DAO transfer proposal.
- pub async fn dao_exec_transfer(
- &self,
- proposal: &ProposalRecord,
- early: bool,
- ) -> Result<Transaction> {
- if proposal.leaf_position.is_none() ||
- proposal.money_snapshot_tree.is_none() ||
- proposal.nullifiers_smt_snapshot.is_none() ||
- proposal.tx_hash.is_none() ||
- proposal.call_index.is_none()
- {
- return Err(Error::Custom(
- "[dao_exec_transfer] Proposal seems to not have been deployed yet".to_string(),
- ))
- }
- // Check proposal is not executed
- if let Some(exec_tx_hash) = proposal.exec_tx_hash {
- return Err(Error::Custom(format!(
- "[dao_exec_transfer] Proposal was executed on transaction: {exec_tx_hash}"
- )))
- }
- // Check we know the plaintext data and they are valid
- if proposal.data.is_none() {
- return Err(Error::Custom(
- "[dao_exec_transfer] Proposal plainext data is empty".to_string(),
- ))
- }
- let proposal_coinattrs: CoinAttributes =
- deserialize_async(proposal.data.as_ref().unwrap()).await?;
- // Fetch DAO and check its deployed
- let Ok(dao) = self.get_dao_by_bulla(&proposal.proposal.dao_bulla).await else {
- return Err(Error::Custom(format!(
- "[dao_exec_transfer] DAO {} was not found",
- proposal.proposal.dao_bulla
- )))
- };
- if dao.leaf_position.is_none() || dao.tx_hash.is_none() || dao.call_index.is_none() {
- return Err(Error::Custom(
- "[dao_exec_transfer] DAO seems to not have been deployed yet".to_string(),
- ))
- }
- // Check that we have the exec key
- if dao.params.exec_secret_key.is_none() {
- return Err(Error::Custom(
- "[dao_exec_transfer] We need the exec secret key to execute proposals for this DAO"
- .to_string(),
- ))
- }
- // If early flag is provided, check that we have the early exec key
- if early && dao.params.early_exec_secret_key.is_none() {
- return Err(Error::Custom(
- "[dao_exec_transfer] We need the early exec secret key to execute proposals early for this DAO"
- .to_string(),
- ))
- }
- // Check proposal is approved
- let votes = self.get_dao_proposal_votes(&proposal.bulla()).await?;
- let mut yes_vote_value = 0;
- let mut yes_vote_blind = Blind::ZERO;
- let mut all_vote_value = 0;
- let mut all_vote_blind = Blind::ZERO;
- for vote in votes {
- if vote.vote_option {
- yes_vote_value += vote.all_vote_value;
- };
- yes_vote_blind += vote.yes_vote_blind;
- all_vote_value += vote.all_vote_value;
- all_vote_blind += vote.all_vote_blind;
- }
- let approval_ratio = (yes_vote_value as f64 * 100.0) / all_vote_value as f64;
- if all_vote_value < dao.params.dao.quorum ||
- approval_ratio <
- (dao.params.dao.approval_ratio_quot / dao.params.dao.approval_ratio_base)
- as f64
- {
- return Err(Error::Custom(
- "[dao_exec_transfer] Proposal is not approved yet".to_string(),
- ))
- };
- // Fetch DAO unspent OwnCoins to see what its balance is for the coin
- let dao_spend_hook =
- FuncRef { contract_id: *DAO_CONTRACT_ID, func_code: DaoFunction::Exec as u8 }
- .to_func_id();
- let dao_owncoins = self
- .get_contract_token_coins(
- &proposal_coinattrs.token_id,
- &dao_spend_hook,
- &proposal.proposal.dao_bulla.inner(),
- )
- .await?;
- if dao_owncoins.is_empty() {
- return Err(Error::Custom(format!(
- "[dao_exec_transfer] Did not find any {} unspent coins owned by this DAO",
- proposal_coinattrs.token_id,
- )))
- }
- // Check DAO balance is sufficient
- if dao_owncoins.iter().map(|x| x.note.value).sum::<u64>() < proposal_coinattrs.value {
- return Err(Error::Custom(format!(
- "[dao_exec_transfer] Not enough DAO balance for token ID: {}",
- proposal_coinattrs.token_id,
- )))
- }
- // Find which DAO coins we can use
- let (spent_coins, change_value) = select_coins(dao_owncoins, proposal_coinattrs.value)?;
- // Now we need to do a lookup for the zkas proof bincodes, and create
- // the circuit objects and proving keys so we can build the transaction.
- // We also do this through the RPC. First we grab the calls from money.
- let zkas_bins = self.lookup_zkas(&MONEY_CONTRACT_ID).await?;
- let Some(mint_zkbin) = zkas_bins.iter().find(|x| x.0 == MONEY_CONTRACT_ZKAS_MINT_NS_V1)
- else {
- return Err(Error::Custom("[dao_exec_transfer] Mint circuit not found".to_string()))
- };
- let Some(burn_zkbin) = zkas_bins.iter().find(|x| x.0 == MONEY_CONTRACT_ZKAS_BURN_NS_V1)
- else {
- return Err(Error::Custom("[dao_exec_transfer] Burn circuit not found".to_string()))
- };
- let Some(fee_zkbin) = zkas_bins.iter().find(|x| x.0 == MONEY_CONTRACT_ZKAS_FEE_NS_V1)
- else {
- return Err(Error::Custom("[dao_exec_transfer] Fee circuit not found".to_string()))
- };
- let mint_zkbin = ZkBinary::decode(&mint_zkbin.1)?;
- let burn_zkbin = ZkBinary::decode(&burn_zkbin.1)?;
- let fee_zkbin = ZkBinary::decode(&fee_zkbin.1)?;
- let mint_circuit = ZkCircuit::new(empty_witnesses(&mint_zkbin)?, &mint_zkbin);
- let burn_circuit = ZkCircuit::new(empty_witnesses(&burn_zkbin)?, &burn_zkbin);
- let fee_circuit = ZkCircuit::new(empty_witnesses(&fee_zkbin)?, &fee_zkbin);
- // Creating Mint, Burn and Fee circuits proving keys
- let mint_pk = ProvingKey::build(mint_zkbin.k, &mint_circuit);
- let burn_pk = ProvingKey::build(burn_zkbin.k, &burn_circuit);
- let fee_pk = ProvingKey::build(fee_zkbin.k, &fee_circuit);
- // Now we grab the DAO bins
- let zkas_bins = self.lookup_zkas(&DAO_CONTRACT_ID).await?;
- let (namespace, early_exec_secret_key) = match early {
- true => (
- DAO_CONTRACT_ZKAS_DAO_EARLY_EXEC_NS,
- Some(dao.params.early_exec_secret_key.unwrap()),
- ),
- false => (DAO_CONTRACT_ZKAS_DAO_EXEC_NS, None),
- };
- let Some(dao_exec_zkbin) = zkas_bins.iter().find(|x| x.0 == namespace) else {
- return Err(Error::Custom(format!(
- "[dao_exec_transfer] DAO {namespace} circuit not found"
- )))
- };
- let Some(dao_auth_transfer_zkbin) =
- zkas_bins.iter().find(|x| x.0 == DAO_CONTRACT_ZKAS_DAO_AUTH_MONEY_TRANSFER_NS)
- else {
- return Err(Error::Custom(
- "[dao_exec_transfer] DAO AuthTransfer circuit not found".to_string(),
- ))
- };
- let Some(dao_auth_transfer_enc_coin_zkbin) =
- zkas_bins.iter().find(|x| x.0 == DAO_CONTRACT_ZKAS_DAO_AUTH_MONEY_TRANSFER_ENC_COIN_NS)
- else {
- return Err(Error::Custom(
- "[dao_exec_transfer] DAO AuthTransferEncCoin circuit not found".to_string(),
- ))
- };
- let dao_exec_zkbin = ZkBinary::decode(&dao_exec_zkbin.1)?;
- let dao_auth_transfer_zkbin = ZkBinary::decode(&dao_auth_transfer_zkbin.1)?;
- let dao_auth_transfer_enc_coin_zkbin =
- ZkBinary::decode(&dao_auth_transfer_enc_coin_zkbin.1)?;
- let dao_exec_circuit = ZkCircuit::new(empty_witnesses(&dao_exec_zkbin)?, &dao_exec_zkbin);
- let dao_auth_transfer_circuit =
- ZkCircuit::new(empty_witnesses(&dao_auth_transfer_zkbin)?, &dao_auth_transfer_zkbin);
- let dao_auth_transfer_enc_coin_circuit = ZkCircuit::new(
- empty_witnesses(&dao_auth_transfer_enc_coin_zkbin)?,
- &dao_auth_transfer_enc_coin_zkbin,
- );
- // Creating DAO Exec, AuthTransfer and AuthTransferEncCoin circuits proving keys
- let dao_exec_pk = ProvingKey::build(dao_exec_zkbin.k, &dao_exec_circuit);
- let dao_auth_transfer_pk =
- ProvingKey::build(dao_auth_transfer_zkbin.k, &dao_auth_transfer_circuit);
- let dao_auth_transfer_enc_coin_pk = ProvingKey::build(
- dao_auth_transfer_enc_coin_zkbin.k,
- &dao_auth_transfer_enc_coin_circuit,
- );
- // Fetch our money Merkle tree
- let tree = self.get_money_tree().await?;
- // Retrieve next block height and current block time target,
- // to compute their window.
- let next_block_height = self.get_next_block_height().await?;
- let block_target = self.get_block_target().await?;
- let current_blockwindow = blockwindow(next_block_height, block_target);
- // Now we can create the transfer call parameters
- let input_user_data_blind = Blind::random(&mut OsRng);
- let mut inputs = vec![];
- for coin in &spent_coins {
- inputs.push(TransferCallInput {
- coin: coin.clone(),
- merkle_path: tree.witness(coin.leaf_position, 0).unwrap(),
- user_data_blind: input_user_data_blind,
- });
- }
- let mut outputs = vec![];
- outputs.push(proposal_coinattrs.clone());
- let dao_coin_attrs = CoinAttributes {
- public_key: dao.params.dao.notes_public_key,
- value: change_value,
- token_id: proposal_coinattrs.token_id,
- spend_hook: dao_spend_hook,
- user_data: proposal.proposal.dao_bulla.inner(),
- blind: Blind::random(&mut OsRng),
- };
- outputs.push(dao_coin_attrs.clone());
- // Create the transfer call
- let transfer_builder = TransferCallBuilder {
- clear_inputs: vec![],
- inputs,
- outputs,
- mint_zkbin: mint_zkbin.clone(),
- mint_pk: mint_pk.clone(),
- burn_zkbin: burn_zkbin.clone(),
- burn_pk: burn_pk.clone(),
- };
- let (transfer_params, transfer_secrets) = transfer_builder.build()?;
- // Encode the call
- let mut data = vec![MoneyFunction::TransferV1 as u8];
- transfer_params.encode_async(&mut data).await?;
- let transfer_call = ContractCall { contract_id: *MONEY_CONTRACT_ID, data };
- // Create the exec call
- let exec_signature_secret = SecretKey::random(&mut OsRng);
- let exec_builder = DaoExecCall {
- proposal: proposal.proposal.clone(),
- dao: dao.params.dao.clone(),
- yes_vote_value,
- all_vote_value,
- yes_vote_blind,
- all_vote_blind,
- signature_secret: exec_signature_secret,
- current_blockwindow,
- };
- let (exec_params, exec_proofs) = exec_builder.make(
- &dao.params.exec_secret_key.unwrap(),
- &early_exec_secret_key,
- &dao_exec_zkbin,
- &dao_exec_pk,
- )?;
- // Encode the call
- let mut data = vec![DaoFunction::Exec as u8];
- exec_params.encode_async(&mut data).await?;
- let exec_call = ContractCall { contract_id: *DAO_CONTRACT_ID, data };
- // Now we can create the auth call
- // Auth module
- let auth_transfer_builder = DaoAuthMoneyTransferCall {
- proposal: proposal.proposal.clone(),
- proposal_coinattrs: vec![proposal_coinattrs],
- dao: dao.params.dao.clone(),
- input_user_data_blind,
- dao_coin_attrs,
- };
- let (auth_transfer_params, auth_transfer_proofs) = auth_transfer_builder.make(
- &dao_auth_transfer_zkbin,
- &dao_auth_transfer_pk,
- &dao_auth_transfer_enc_coin_zkbin,
- &dao_auth_transfer_enc_coin_pk,
- )?;
- // Encode the call
- let mut data = vec![DaoFunction::AuthMoneyTransfer as u8];
- auth_transfer_params.encode_async(&mut data).await?;
- let auth_transfer_call = ContractCall { contract_id: *DAO_CONTRACT_ID, data };
- // Create the TransactionBuilder containing above calls
- let mut tx_builder = TransactionBuilder::new(
- ContractCallLeaf { call: exec_call, proofs: exec_proofs },
- vec![
- DarkTree::new(
- ContractCallLeaf { call: auth_transfer_call, proofs: auth_transfer_proofs },
- vec![],
- None,
- None,
- ),
- DarkTree::new(
- ContractCallLeaf { call: transfer_call, proofs: transfer_secrets.proofs },
- vec![],
- None,
- None,
- ),
- ],
- )?;
- // We first have to execute the fee-less tx to gather its used gas, and then we feed
- // it into the fee-creating function.
- let mut tx = tx_builder.build()?;
- let auth_transfer_sigs = tx.create_sigs(&[])?;
- let transfer_sigs = tx.create_sigs(&transfer_secrets.signature_secrets)?;
- let exec_sigs = tx.create_sigs(&[exec_signature_secret])?;
- tx.signatures = vec![auth_transfer_sigs, transfer_sigs, exec_sigs];
- let (fee_call, fee_proofs, fee_secrets) =
- self.append_fee_call(&tx, &tree, &fee_pk, &fee_zkbin, None).await?;
- // Append the fee call to the transaction
- tx_builder.append(ContractCallLeaf { call: fee_call, proofs: fee_proofs }, vec![])?;
- // Now build the actual transaction and sign it with all necessary keys.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[])?;
- tx.signatures.push(sigs);
- let sigs = tx.create_sigs(&transfer_secrets.signature_secrets)?;
- tx.signatures.push(sigs);
- let sigs = tx.create_sigs(&[exec_signature_secret])?;
- tx.signatures.push(sigs);
- let sigs = tx.create_sigs(&fee_secrets)?;
- tx.signatures.push(sigs);
- Ok(tx)
- }
- /// Execute a DAO generic proposal.
- pub async fn dao_exec_generic(
- &self,
- proposal: &ProposalRecord,
- early: bool,
- ) -> Result<Transaction> {
- if proposal.leaf_position.is_none() ||
- proposal.money_snapshot_tree.is_none() ||
- proposal.nullifiers_smt_snapshot.is_none() ||
- proposal.tx_hash.is_none() ||
- proposal.call_index.is_none()
- {
- return Err(Error::Custom(
- "[dao_exec_generic] Proposal seems to not have been deployed yet".to_string(),
- ))
- }
- // Check proposal is not executed
- if let Some(exec_tx_hash) = proposal.exec_tx_hash {
- return Err(Error::Custom(format!(
- "[dao_exec_generic] Proposal was executed on transaction: {exec_tx_hash}"
- )))
- }
- // Fetch DAO and check its deployed
- let Ok(dao) = self.get_dao_by_bulla(&proposal.proposal.dao_bulla).await else {
- return Err(Error::Custom(format!(
- "[dao_exec_generic] DAO {} was not found",
- proposal.proposal.dao_bulla
- )))
- };
- if dao.leaf_position.is_none() || dao.tx_hash.is_none() || dao.call_index.is_none() {
- return Err(Error::Custom(
- "[dao_exec_generic] DAO seems to not have been deployed yet".to_string(),
- ))
- }
- // Check that we have the exec key
- if dao.params.exec_secret_key.is_none() {
- return Err(Error::Custom(
- "[dao_exec_generic] We need the exec secret key to execute proposals for this DAO"
- .to_string(),
- ))
- }
- // If early flag is provided, check that we have the early exec key
- if early && dao.params.early_exec_secret_key.is_none() {
- return Err(Error::Custom(
- "[dao_exec_generic] We need the early exec secret key to execute proposals early for this DAO"
- .to_string(),
- ))
- }
- // Check proposal is approved
- let votes = self.get_dao_proposal_votes(&proposal.bulla()).await?;
- let mut yes_vote_value = 0;
- let mut yes_vote_blind = Blind::ZERO;
- let mut all_vote_value = 0;
- let mut all_vote_blind = Blind::ZERO;
- for vote in votes {
- if vote.vote_option {
- yes_vote_value += vote.all_vote_value;
- };
- yes_vote_blind += vote.yes_vote_blind;
- all_vote_value += vote.all_vote_value;
- all_vote_blind += vote.all_vote_blind;
- }
- let approval_ratio = (yes_vote_value as f64 * 100.0) / all_vote_value as f64;
- if all_vote_value < dao.params.dao.quorum ||
- approval_ratio <
- (dao.params.dao.approval_ratio_quot / dao.params.dao.approval_ratio_base)
- as f64
- {
- return Err(Error::Custom("[dao_exec_generic] Proposal is not approved yet".to_string()))
- };
- // Now we need to do a lookup for the zkas proof bincodes, and create
- // the circuit objects and proving keys so we can build the transaction.
- // We also do this through the RPC. First we grab the calls from money.
- let zkas_bins = self.lookup_zkas(&MONEY_CONTRACT_ID).await?;
- let Some(fee_zkbin) = zkas_bins.iter().find(|x| x.0 == MONEY_CONTRACT_ZKAS_FEE_NS_V1)
- else {
- return Err(Error::Custom("[dao_exec_generic] Fee circuit not found".to_string()))
- };
- let fee_zkbin = ZkBinary::decode(&fee_zkbin.1)?;
- let fee_circuit = ZkCircuit::new(empty_witnesses(&fee_zkbin)?, &fee_zkbin);
- let fee_pk = ProvingKey::build(fee_zkbin.k, &fee_circuit);
- // Now we grab the DAO bins
- let zkas_bins = self.lookup_zkas(&DAO_CONTRACT_ID).await?;
- let (namespace, early_exec_secret_key) = match early {
- true => (
- DAO_CONTRACT_ZKAS_DAO_EARLY_EXEC_NS,
- Some(dao.params.early_exec_secret_key.unwrap()),
- ),
- false => (DAO_CONTRACT_ZKAS_DAO_EXEC_NS, None),
- };
- let Some(dao_exec_zkbin) = zkas_bins.iter().find(|x| x.0 == namespace) else {
- return Err(Error::Custom(format!(
- "[dao_exec_generic] DAO {namespace} circuit not found"
- )))
- };
- let dao_exec_zkbin = ZkBinary::decode(&dao_exec_zkbin.1)?;
- let dao_exec_circuit = ZkCircuit::new(empty_witnesses(&dao_exec_zkbin)?, &dao_exec_zkbin);
- let dao_exec_pk = ProvingKey::build(dao_exec_zkbin.k, &dao_exec_circuit);
- // Fetch our money Merkle tree
- let tree = self.get_money_tree().await?;
- // Retrieve next block height and current block time target,
- // to compute their window.
- let next_block_height = self.get_next_block_height().await?;
- let block_target = self.get_block_target().await?;
- let current_blockwindow = blockwindow(next_block_height, block_target);
- // Create the exec call
- let exec_signature_secret = SecretKey::random(&mut OsRng);
- let exec_builder = DaoExecCall {
- proposal: proposal.proposal.clone(),
- dao: dao.params.dao.clone(),
- yes_vote_value,
- all_vote_value,
- yes_vote_blind,
- all_vote_blind,
- signature_secret: exec_signature_secret,
- current_blockwindow,
- };
- let (exec_params, exec_proofs) = exec_builder.make(
- &dao.params.exec_secret_key.unwrap(),
- &early_exec_secret_key,
- &dao_exec_zkbin,
- &dao_exec_pk,
- )?;
- // Encode the call
- let mut data = vec![DaoFunction::Exec as u8];
- exec_params.encode_async(&mut data).await?;
- let exec_call = ContractCall { contract_id: *DAO_CONTRACT_ID, data };
- // Create the TransactionBuilder containing above calls
- let mut tx_builder = TransactionBuilder::new(
- ContractCallLeaf { call: exec_call, proofs: exec_proofs },
- vec![],
- )?;
- // We first have to execute the fee-less tx to gather its used gas, and then we feed
- // it into the fee-creating function.
- let mut tx = tx_builder.build()?;
- let exec_sigs = tx.create_sigs(&[exec_signature_secret])?;
- tx.signatures = vec![exec_sigs];
- let (fee_call, fee_proofs, fee_secrets) =
- self.append_fee_call(&tx, &tree, &fee_pk, &fee_zkbin, None).await?;
- // Append the fee call to the transaction
- tx_builder.append(ContractCallLeaf { call: fee_call, proofs: fee_proofs }, vec![])?;
- // Now build the actual transaction and sign it with all necessary keys.
- let mut tx = tx_builder.build()?;
- let sigs = tx.create_sigs(&[exec_signature_secret])?;
- tx.signatures.push(sigs);
- let sigs = tx.create_sigs(&fee_secrets)?;
- tx.signatures.push(sigs);
- Ok(tx)
- }
- }
|