Merge pull request #160 from confio/138-todo-fixme-review

Review TODO / FIXMEs

Author: maurolacy

contracts/tg4-mixer/src/contract.rs

@@ -66,7 +66,6 @@ pub fn instantiate(
     })?;
 
     // add hooks to listen for all changes
-    // TODO: what events to return here?
     let res = Response::new()
         .add_submessage(groups.left.add_hook(&env.contract.address)?)
         .add_submessage(groups.right.add_hook(&env.contract.address)?)

contracts/tg4-mixer/src/error.rs

@@ -19,10 +19,6 @@ pub enum ContractError {
     #[error("Unauthorized: {0}")]
     Unauthorized(String),
 
-    /// TODO: Remove this when we are ready to ensure we finished implementing everything
-    #[error("Unimplemented")]
-    Unimplemented {},
-
     #[error("Contract {0} doesn't fulfill the tg4 interface")]
     NotTg4(String),
 

contracts/tg4-mixer/src/functions.rs

@@ -8,7 +8,7 @@ use cosmwasm_std::{Decimal as StdDecimal, Fraction, Uint64};
 use crate::error::ContractError;
 
 pub fn std_to_decimal(std_decimal: StdDecimal) -> Decimal {
-    Decimal::from_i128_with_scale(std_decimal.numerator().u128() as i128, 18) // FIXME: StdDecimal::DECIMAL_PLACES is private
+    Decimal::from_i128_with_scale(std_decimal.numerator().u128() as i128, 18) // FIXME: StdDecimal::DECIMAL_PLACES is private (https://github.com/CosmWasm/cosmwasm/issues/1361)
 }
 
 /// This defines the functions we can use for proof of engagement points.

contracts/tg4-stake/src/contract.rs

@@ -475,7 +475,7 @@ pub fn execute_claim<Q: CustomQuery>(
     Ok(res)
 }
 
-// TODO: put in cosmwasm-std
+// TODO: put in cosmwasm-std (https://github.com/CosmWasm/cosmwasm/issues/1359)
 fn coins_to_string(coins: &[Coin]) -> String {
     let strings: Vec<_> = coins
         .iter()

contracts/tgrade-validator-voting/src/msg.rs

@@ -14,7 +14,6 @@ pub struct InstantiateMsg {
     pub group_addr: String,
 }
 
-// TODO: add some T variants? Maybe good enough as fixed Empty for now
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
 #[serde(rename_all = "snake_case")]
 pub enum ExecuteMsg {

contracts/tgrade-valset/src/contract.rs

@@ -638,10 +638,7 @@ fn privilege_change<Q: CustomQuery>(_deps: DepsMut<Q>, change: PrivilegeChangeMs
             ]);
             Response::new().add_submessages(msgs)
         }
-        PrivilegeChangeMsg::Demoted {} => {
-            // TODO: signal this is frozen?
-            Response::new()
-        }
+        PrivilegeChangeMsg::Demoted {} => Response::new(),
     }
 }
 

contracts/tgrade-valset/src/msg.rs

@@ -20,7 +20,6 @@ pub struct InstantiateMsg {
     pub membership: String,
     /// Minimum points needed by an address in `membership` to be considered for the validator set.
     /// 0-point members are always filtered out.
-    /// TODO: if we allow sub-1 scaling factors, determine if this is pre-/post- scaling
     /// (use points for cw4, power for Tendermint)
     pub min_points: u64,
     /// The maximum number of validators that can be included in the Tendermint validator set.
@@ -45,7 +44,6 @@ pub struct InstantiateMsg {
     pub initial_keys: Vec<OperatorInitInfo>,
 
     /// A scaling factor to multiply cw4-group points to produce the Tendermint validator power
-    /// (TODO: should we allow this to reduce points? Like 1/1000?)
     pub scaling: Option<u32>,
 
     /// Percentage of total accumulated fees that is subtracted from tokens minted as rewards.
@@ -355,7 +353,6 @@ impl ValidatorMetadata {
 #[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema, Debug)]
 pub struct OperatorInitInfo {
     pub operator: String,
-    /// TODO: better name to specify this is the Tendermint pubkey for consensus?
     pub validator_pubkey: Pubkey,
     pub metadata: ValidatorMetadata,
 }

contracts/tgrade-valset/src/state.rs

@@ -19,7 +19,6 @@ pub struct Config {
     pub membership: Tg4Contract,
     /// minimum points needed by an address in `membership` to be considered for the validator set.
     /// 0-point members are always filtered out.
-    /// TODO: if we allow sub-1 scaling factors, determine if this is pre-/post- scaling
     /// (use points for tg4, power for tendermint)
     pub min_points: u64,
     /// The maximum number of validators that can be included in the Tendermint validator set.
@@ -28,7 +27,6 @@ pub struct Config {
     /// lexicographically sorted).
     pub max_validators: u32,
     /// A scaling factor to multiply tg4-engagement points to produce the tendermint validator power
-    /// (TODO: should we allow this to reduce points? Like 1/1000?)
     pub scaling: Option<u32>,
     /// Total reward paid out each epoch. This will be split among all validators during the last
     /// epoch.
@@ -93,7 +91,6 @@ pub struct EpochInfo {
 /// additions and updates.
 #[derive(Serialize, Deserialize, Clone, PartialEq, Eq, PartialOrd, Ord, JsonSchema, Debug)]
 pub struct ValidatorInfo {
-    /// TODO: better name to specify this is the Tendermint pubkey for consensus?
     pub validator_pubkey: Pubkey,
     pub operator: Addr,
     /// The voting power in Tendermint sdk