Update rewards (#141)

* Process snapshot to output VoterHIR

Use VoterHIR as the output format for the snapshot
tool

* Add cap for voting influence in snapshot

Limit overall influence of actors in an election by capping their
maximum voting power at arbitrary levels.

Since a lot of configurations are going in the snapshot process,
I'm thinking of having it output two different artifacts:
the list of VoterHIRs, as already proposed, and another one which
is a light wrapper around VoterHIR which contains contributions
from snapshot, to be used for the reward process.

I'm proposing to keep the separate because the first one is
more general, while the second one is tied to our current
deployment and more likely to change.

* update rewards

* add test for representatives

* add missing cli options

* simplify direct voter rewards

* remove unused import

Author: zeegomo

catalyst-toolbox/Cargo.toml

@@ -58,7 +58,7 @@ image = "0.23.12"
 qrcode = "0.12"
 quircs = "0.10.0"
 symmetric-cipher = { git = "https://github.com/input-output-hk/chain-wallet-libs.git", branch = "master" }
-graphql_client = "0.10"
+graphql_client = { version = "0.10" }
 gag = "1"
 vit-servicing-station-lib = { git = "https://github.com/input-output-hk/vit-servicing-station.git", branch = "master" }
 env_logger = "0.9"

catalyst-toolbox/src/bin/cli/rewards/voters.rs

@@ -1,13 +1,9 @@
 use catalyst_toolbox::rewards::voters::{calc_voter_rewards, Rewards, VoteCount};
-use catalyst_toolbox::snapshot::{
-    registration::MainnetRewardAddress, voting_group::VotingGroupAssigner, Snapshot,
-};
+use catalyst_toolbox::snapshot::{registration::MainnetRewardAddress, SnapshotInfo};
 use catalyst_toolbox::utils::assert_are_close;
 
 use color_eyre::Report;
-use fraction::Fraction;
 use jcli_lib::jcli_lib::block::Common;
-use jormungandr_lib::{crypto::account::Identifier, interfaces::Block0Configuration};
 use structopt::StructOpt;
 
 use std::collections::BTreeMap;
@@ -22,19 +18,9 @@ pub struct VotersRewards {
     #[structopt(long)]
     total_rewards: u64,
 
-    /// Path to raw snapshot
+    /// Path to a json encoded list of `SnapshotInfo`
     #[structopt(long)]
-    snapshot_path: PathBuf,
-
-    /// Stake threshold to be able to participate in a Catalyst sidechain
-    /// Registrations with less than the threshold associated to the stake address
-    /// will be ignored
-    #[structopt(long)]
-    registration_threshold: u64,
-
-    /// Voting power cap for each account
-    #[structopt(short, long)]
-    voting_power_cap: Fraction,
+    snapshot_info_path: PathBuf,
 
     #[structopt(long)]
     votes_count_path: PathBuf,
@@ -66,30 +52,22 @@ impl VotersRewards {
         let VotersRewards {
             common,
             total_rewards,
-            snapshot_path,
-            registration_threshold,
+            snapshot_info_path,
             votes_count_path,
             vote_threshold,
-            voting_power_cap,
         } = self;
-        let block = common.input.load_block()?;
-        let block0 = Block0Configuration::from_block(&block)?;
 
         let vote_count: VoteCount = serde_json::from_reader(jcli_lib::utils::io::open_file_read(
             &Some(votes_count_path),
         )?)?;
 
-        let snapshot = Snapshot::from_raw_snapshot(
-            serde_json::from_reader(jcli_lib::utils::io::open_file_read(&Some(snapshot_path))?)?,
-            registration_threshold.into(),
-            voting_power_cap,
-            &DummyAssigner,
+        let snapshot: Vec<SnapshotInfo> = serde_json::from_reader(
+            jcli_lib::utils::io::open_file_read(&Some(snapshot_info_path))?,
         )?;
 
         let results = calc_voter_rewards(
             vote_count,
             vote_threshold,
-            &block0,
             snapshot,
             Rewards::from(total_rewards),
         )?;
@@ -101,10 +79,3 @@ impl VotersRewards {
         Ok(())
     }
 }
-
-struct DummyAssigner;
-impl VotingGroupAssigner for DummyAssigner {
-    fn assign(&self, _vk: &Identifier) -> String {
-        unimplemented!()
-    }
-}

catalyst-toolbox/src/bin/cli/snapshot/mod.rs

@@ -20,7 +20,7 @@ pub struct SnapshotCmd {
     snapshot: PathBuf,
     /// Registrations voting power threshold for eligibility
     #[structopt(short, long)]
-    threshold: Value,
+    min_stake_threshold: Value,
 
     /// Voter group to assign direct voters to.
     /// If empty, defaults to "voter"
@@ -59,7 +59,7 @@ impl SnapshotCmd {
         let assigner = RepsVotersAssigner::new(direct_voter, representative, self.reps_db_api_url)?;
         let initials = Snapshot::from_raw_snapshot(
             raw_snapshot,
-            self.threshold,
+            self.min_stake_threshold,
             self.voting_power_cap,
             &assigner,
         )?