fixup! Implement basic multisig example

Author: richardpringle

x/contracts/examples/multisig/src/lib.rs

@@ -11,12 +11,18 @@ use wasmlanche::{
 pub type ProposalId = usize;
 
 state_schema! {
+    /// Number of total proposals, doubles as the next `ProposalId`
     ProposalCount => ProposalId,
+    /// The proposal itself
     ProposalItem(ProposalId) => Proposal,
-    ProposalVoteInfo(ProposalId) => ProposalMeta,
+    /// Voting information include who can vote and how many yeas left until quorum is reached
+    VoteInfo(ProposalId) => ProposalMeta,
+    /// Votes cast by a voter
+    /// Any address can vote for any proposal, but that doesn't mean that the proposal will count toward quorum
     Vote(ProposalId, Address) => bool,
 }
 
+/// Create a proposal
 #[public]
 pub fn propose(
     ctx: &mut Context,
@@ -46,14 +52,15 @@ pub fn propose(
     ctx.store((
         (ProposalCount, id + 1),
         (ProposalItem(id), proposal),
-        (ProposalVoteInfo(id), meta),
+        (VoteInfo(id), meta),
         (Vote(id, actor), true),
     ))
     .expect("failed to store proposal");
 
     id
 }
 
+/// Vote on a proposal
 #[public]
 pub fn vote(ctx: &mut Context, proposal_id: ProposalId, vote: bool) -> Option<Vec<u8>> {
     let actor = ctx.actor();
@@ -77,7 +84,7 @@ pub fn vote(ctx: &mut Context, proposal_id: ProposalId, vote: bool) -> Option<Ve
         voters,
         votes_remaining,
     } = ctx
-        .get(ProposalVoteInfo(proposal_id))
+        .get(VoteInfo(proposal_id))
         .expect("failed to deserialize")
         .expect("proposal not found");
 
@@ -88,7 +95,7 @@ pub fn vote(ctx: &mut Context, proposal_id: ProposalId, vote: bool) -> Option<Ve
     let votes_remaining = votes_remaining - 1;
 
     ctx.store_by_key(
-        ProposalVoteInfo(proposal_id),
+        VoteInfo(proposal_id),
         ProposalMeta {
             voters,
             votes_remaining,
@@ -121,14 +128,19 @@ pub fn vote(ctx: &mut Context, proposal_id: ProposalId, vote: bool) -> Option<Ve
     }
 }
 
+/// A proposal consists of an address of a contract to call
+/// a function name to call on that contract
+/// and a set of serialized arguments to pass to that function
 #[derive(BorshSerialize, BorshDeserialize)]
+// TODO: re-derive these traits to automatically inject the crate
 #[borsh(crate = "wasmlanche::borsh")]
 pub struct Proposal {
     pub contract_address: Address,
     pub function_name: String,
     pub args: Vec<u8>,
 }
 
+/// Contains a set of `Voters` as well as `votes_remaining` (until quorum is reached)
 #[derive(BorshSerialize, BorshDeserialize)]
 #[borsh(crate = "wasmlanche::borsh")]
 struct ProposalMeta {
@@ -137,6 +149,10 @@ struct ProposalMeta {
     // TODO: add expiry
 }
 
+/// Either a specific set of addresses OR an open vote in which the quorum voter will actually have to pay
+/// for the final execution
+// TODO:
+// reward the final voter with to refund their fuel contributions
 #[cfg_attr(test, derive(Debug))]
 pub enum Voters {
     Any,
@@ -322,7 +338,7 @@ mod tests {
         let ProposalMeta {
             votes_remaining, ..
         } = ctx
-            .get(ProposalVoteInfo(id))
+            .get(VoteInfo(id))
             .expect("failed to deserialize")
             .expect("proposal not found");