Merge pull request #162 from input-output-hk/feature/npg-2640-update-snapshot-lib

Mr-Leshiy · web-flow · commit bc5239a60aba · 2022-08-16T13:27:12.000+03:00
Update snapshot lib
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/catalyst-toolbox/Cargo.toml b/catalyst-toolbox/Cargo.toml
@@ -63,7 +63,6 @@ gag = "1"
 vit-servicing-station-lib = { git = "https://github.com/input-output-hk/vit-servicing-station.git", branch = "master" }
 env_logger = "0.9"
 snapshot-lib = { path = "../snapshot-lib" }
-fraction = "0.10"
 
 [dev-dependencies]
 rand_chacha = "0.3"
diff --git a/catalyst-toolbox/src/bin/cli/kedqr/decode/mod.rs b/catalyst-toolbox/src/bin/cli/kedqr/decode/mod.rs
@@ -10,7 +10,7 @@ use std::path::PathBuf;
 use structopt::StructOpt;
 
 /// QCode CLI toolkit
-#[derive(Debug, PartialEq, StructOpt)]
+#[derive(Debug, PartialEq, Eq, StructOpt)]
 #[structopt(rename_all = "kebab-case")]
 pub struct DecodeQrCodeCmd {
     /// Path to file containing img or payload.
diff --git a/catalyst-toolbox/src/bin/cli/kedqr/encode/mod.rs b/catalyst-toolbox/src/bin/cli/kedqr/encode/mod.rs
@@ -10,7 +10,7 @@ use std::path::PathBuf;
 use structopt::StructOpt;
 
 /// QCode CLI toolkit
-#[derive(Debug, PartialEq, StructOpt)]
+#[derive(Debug, PartialEq, Eq, StructOpt)]
 #[structopt(rename_all = "kebab-case")]
 pub struct EncodeQrCodeCmd {
     /// Path to file containing ed25519extended bech32 value.
diff --git a/catalyst-toolbox/src/bin/cli/kedqr/mod.rs b/catalyst-toolbox/src/bin/cli/kedqr/mod.rs
@@ -31,7 +31,7 @@ impl QrCodeCmd {
     }
 }
 
-#[derive(Debug, PartialEq, StructOpt)]
+#[derive(Debug, PartialEq, Eq, StructOpt)]
 #[structopt(rename_all = "kebab-case")]
 pub enum QrCodeOpts {
     Img,
diff --git a/catalyst-toolbox/src/bin/cli/snapshot/mod.rs b/catalyst-toolbox/src/bin/cli/snapshot/mod.rs
@@ -1,16 +1,16 @@
 use color_eyre::Report;
-use fraction::Fraction;
 use jcli_lib::utils::{output_file::OutputFile, output_format::OutputFormat};
 use jormungandr_lib::interfaces::Value;
-use snapshot_lib::{voting_group::RepsVotersAssigner, RawSnapshot, Snapshot};
+use snapshot_lib::Fraction;
+use snapshot_lib::{
+    voting_group::{RepsVotersAssigner, DEFAULT_DIRECT_VOTER_GROUP, DEFAULT_REPRESENTATIVE_GROUP},
+    RawSnapshot, Snapshot,
+};
 use std::fs::File;
 use std::io::Write;
 use std::path::PathBuf;
 use structopt::StructOpt;
 
-const DEFAULT_DIRECT_VOTER_GROUP: &str = "direct";
-const DEFAULT_REPRESENTATIVE_GROUP: &str = "rep";
-
 /// Process raw registrations into blockchain initials
 #[derive(StructOpt)]
 #[structopt(rename_all = "kebab-case")]
@@ -32,10 +32,6 @@ pub struct SnapshotCmd {
     #[structopt(long)]
     representatives_group: Option<String>,
 
-    /// Url of the representative db api server
-    #[structopt(long)]
-    reps_db_api_url: reqwest::Url,
-
     /// Voting power cap for each account
     #[structopt(short, long)]
     voting_power_cap: Fraction,
@@ -56,7 +52,7 @@ impl SnapshotCmd {
         let representative = self
             .representatives_group
             .unwrap_or_else(|| DEFAULT_REPRESENTATIVE_GROUP.into());
-        let assigner = RepsVotersAssigner::new(direct_voter, representative, self.reps_db_api_url)?;
+        let assigner = RepsVotersAssigner::new(direct_voter, representative);
         let initials = Snapshot::from_raw_snapshot(
             raw_snapshot,
             self.min_stake_threshold,
diff --git a/catalyst-toolbox/src/bin/cli/vote_check/mod.rs b/catalyst-toolbox/src/bin/cli/vote_check/mod.rs
@@ -12,7 +12,7 @@ use std::path::PathBuf;
 /// Verify that your votes were correctly tallied.
 ///
 /// Requires Jormungandr to be installed in the system
-#[derive(Debug, PartialEq, StructOpt)]
+#[derive(Debug, PartialEq, Eq, StructOpt)]
 #[structopt(rename_all = "kebab-case")]
 pub struct VoteCheck {
     /// Path to folder containing the full blockchain history saved in Jormungandr
diff --git a/catalyst-toolbox/src/community_advisors/models/de.rs b/catalyst-toolbox/src/community_advisors/models/de.rs
@@ -37,7 +37,7 @@ pub struct AdvisorReviewRow {
     filtered_out: bool,
 }
 
-#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
+#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
 pub struct VeteranRankingRow {
     pub proposal_id: String,
     #[serde(alias = "Assessor")]
diff --git a/catalyst-toolbox/src/kedqr/mod.rs b/catalyst-toolbox/src/kedqr/mod.rs
@@ -9,7 +9,7 @@ use thiserror::Error;
 
 pub const PIN_LENGTH: usize = 4;
 
-#[derive(Debug, PartialEq)]
+#[derive(Debug, PartialEq, Eq)]
 pub struct QrPin {
     pub password: [u8; 4],
 }
diff --git a/catalyst-toolbox/src/rewards/voters.rs b/catalyst-toolbox/src/rewards/voters.rs
@@ -191,9 +191,9 @@ pub fn calc_voter_rewards(
 mod tests {
     use super::*;
     use crate::utils::assert_are_close;
-    use fraction::Fraction;
     use jormungandr_lib::crypto::account::Identifier;
     use snapshot_lib::registration::{Delegations, VotingRegistration};
+    use snapshot_lib::Fraction;
     use snapshot_lib::Snapshot;
     use test_strategy::proptest;
 
diff --git a/snapshot-lib/Cargo.toml b/snapshot-lib/Cargo.toml
@@ -17,7 +17,7 @@ test-strategy = { version = "0.2", optional = true }
 serde_test = { version = "1", optional = true }
 hex = { version = "0.4" }
 thiserror = "1.0"
-fraction = "0.10"
+fraction = { version = "0.10", features = ["with-serde-support"] }
 reqwest = { version = "0.11", features = ["blocking", "json"] }
 bech32 = "0.8.1"
 graphql_client = { version = "0.10" }
diff --git a/snapshot-lib/src/lib.rs b/snapshot-lib/src/lib.rs
@@ -1,4 +1,4 @@
-use fraction::Fraction;
+pub use fraction::Fraction;
 use jormungandr_lib::{crypto::account::Identifier, interfaces::Value};
 use registration::{Delegations, MainnetRewardAddress, VotingRegistration};
 use serde::{Deserialize, Serialize};
@@ -33,13 +33,13 @@ pub enum Error {
 }
 
 /// Contribution to a voting key for some registration
-#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
 pub struct KeyContribution {
     pub reward_address: MainnetRewardAddress,
     pub value: u64,
 }
 
-#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
 pub struct SnapshotInfo {
     /// The values in the contributions are the original values in the registration transactions and
     /// thus retain the original proportions.
@@ -49,7 +49,7 @@ pub struct SnapshotInfo {
     pub hir: VoterHIR,
 }
 
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub struct Snapshot {
     // a raw public key is preferred so that we don't have to worry about discrimination when deserializing from
     // a CIP-36 compatible encoding
diff --git a/snapshot-lib/src/registration.rs b/snapshot-lib/src/registration.rs
@@ -9,7 +9,7 @@ pub type MainnetStakeAddress = String;
 /// which is a generalization of CIP-15, allowing to distribute
 /// voting power among multiple keys in a single transaction and
 /// to tag the purpose of the vote.
-#[derive(Deserialize, Clone, Debug, PartialEq)]
+#[derive(Deserialize, Clone, Debug, PartialEq, Eq)]
 pub struct VotingRegistration {
     pub stake_public_key: MainnetStakeAddress,
     pub voting_power: Value,
@@ -35,7 +35,7 @@ impl VotingRegistration {
 /// To allow backward compatibility and avoid requiring existing users to
 /// re-register we still consider valid old CIP-15 registrations, with the
 /// simple correspondence between the two described in CIP-36.
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub enum Delegations {
     /// Tuples of (voting key, weight)
     New(Vec<(Identifier, u32)>),
diff --git a/snapshot-lib/src/voting_group.rs b/snapshot-lib/src/voting_group.rs
@@ -4,6 +4,9 @@ use jormungandr_lib::crypto::account::Identifier;
 use std::collections::HashSet;
 use thiserror::Error;
 
+pub const DEFAULT_DIRECT_VOTER_GROUP: &str = "direct";
+pub const DEFAULT_REPRESENTATIVE_GROUP: &str = "rep";
+
 pub trait VotingGroupAssigner {
     fn assign(&self, vk: &Identifier) -> VotingGroup;
 }
@@ -48,16 +51,12 @@ fn get_all_reps(_url: impl reqwest::IntoUrl) -> Result<HashSet<Identifier>, Erro
 }
 
 impl RepsVotersAssigner {
-    pub fn new(
-        direct_voters: VotingGroup,
-        reps: VotingGroup,
-        _repsdb_url: impl reqwest::IntoUrl,
-    ) -> Result<Self, Error> {
-        Ok(Self {
+    pub fn new(direct_voters: VotingGroup, reps: VotingGroup) -> Self {
+        Self {
             direct_voters,
             reps,
             repsdb: HashSet::new(),
-        })
+        }
     }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ impl QrCodeCmd {`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
`34`		`-#[derive(Debug, PartialEq, StructOpt)]`
	`34`	`+#[derive(Debug, PartialEq, Eq, StructOpt)]`
`35`	`35`	`#[structopt(rename_all = "kebab-case")]`
`36`	`36`	`pub enum QrCodeOpts {`
`37`	`37`	`Img,`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ pub struct AdvisorReviewRow {`
`37`	`37`	`filtered_out: bool,`
`38`	`38`	`}`
`39`	`39`
`40`		`-#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]`
	`40`	`+#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]`
`41`	`41`	`pub struct VeteranRankingRow {`
`42`	`42`	`pub proposal_id: String,`
`43`	`43`	`#[serde(alias = "Assessor")]`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ use thiserror::Error;`
`9`	`9`
`10`	`10`	`pub const PIN_LENGTH: usize = 4;`
`11`	`11`
`12`		`-#[derive(Debug, PartialEq)]`
	`12`	`+#[derive(Debug, PartialEq, Eq)]`
`13`	`13`	`pub struct QrPin {`
`14`	`14`	`pub password: [u8; 4],`
`15`	`15`	`}`