Release v0.1.2 to stable changes into the Meta Vote contract.

.gitignore

@@ -65,3 +65,4 @@ front/.vercel
 
 # typescript
 front/*.tsbuildinfo
+.npmrc

README.md

@@ -8,7 +8,7 @@ Implementation of a general voting system using the $META token.
 
 The last version of the deployed contract, in Near `mainnet`, is in the `stable` branch.
 
-Current stable version: [**v0.1.0**](https://github.com/Narwallets/meta-vote/releases/tag/v0.1.0)
+Current stable version: [**v0.1.1**](https://github.com/Narwallets/meta-vote/releases/tag/v0.1.1)
 Check all releases in [Meta Vote Releases](https://github.com/Narwallets/meta-vote/releases).
 
 To get the stable version, run the commands:
@@ -18,7 +18,7 @@ git clone https://github.com/Narwallets/meta-vote.git
 cd meta-vote
 git fetch origin --tags
 
-git checkout tags/v0.1.0 -b stable
+git checkout tags/v0.1.1 -b stable
 ```
 
 ## Type Notation
@@ -67,9 +67,24 @@ pub fn new(
 ) -> Self;
 ```
 
+The best way to deploy Meta Vote is using the scripts for `mainnet` and `testnet`:
+
+- [main_deploy.sh](contract/scripts/main_deploy.sh)
+- [test_deploy.sh](contract/scripts/test_deploy.sh)
+
+## Getting a list of paginated Voters
+
+Getting all the voters with pagination using `testnet`:
+
+```rs
+NEAR_ENV=testnet near view metavote.testnet get_voters '{"from_index": 0, "limit": 100}'
+```
+
 ## View Contract Functions
 
 ```rs
+pub fn get_voters(&self, from_index: u32, limit: u32) -> Vec<VoterJSON>;
+
 pub fn get_balance(&self, voter_id: VoterId) -> U128;
 
 pub fn get_locked_balance(&self, voter_id: VoterId) -> U128;

contract/meta-vote-contract/Cargo.toml

@@ -10,4 +10,4 @@ crate-type = ["cdylib", "rlib"]
 [dependencies]
 near-sdk = "4.0.0"
 near-contract-standards = "4.0.0"
-uint = "0.9.3"
+uint = "0.9.3"

contract/meta-vote-contract/src/lib.rs

@@ -7,7 +7,7 @@ use near_sdk::json_types::U128;
 use near_sdk::{env, log, near_bindgen, AccountId, Balance, PanicOnDefault, require};
 use types::*;
 use utils::{generate_hash_id, get_current_epoch_millis};
-use voter::Voter;
+use voter::{Voter, VoterJSON};
 
 mod constants;
 mod deposit;
@@ -555,6 +555,21 @@ impl MetaVoteContract {
     /*   View functions   */
     /**********************/
 
+    pub fn get_voters(&self, from_index: u32, limit: u32) -> Vec<VoterJSON> {
+        let keys = self.voters.keys_as_vector();
+        let voters_len = keys.len() as u64;
+        let start = from_index as u64;
+        let limit = limit as u64;
+
+        let mut results = Vec::<VoterJSON>::new();
+        for index in start..std::cmp::min(start + limit, voters_len) {
+            let voter_id = keys.get(index).unwrap();
+            let voter = self.voters.get(&voter_id).unwrap();
+            results.push(voter.to_json(voter_id));
+        }
+        results
+    }
+
     pub fn get_balance(&self, voter_id: VoterId) -> U128 {
         let voter = self.internal_get_voter(&voter_id);
         let balance = voter.balance + voter.sum_unlocked();
@@ -631,8 +646,9 @@ impl MetaVoteContract {
         &self,
         contract_address: ContractAddress
     ) -> Vec<VotableObjectJSON> {
-        let objects = self.votes.get(&contract_address)
-            .expect("Contract Address not in Meta Vote.");
+       let objects = self.votes.get(&contract_address)
+        .unwrap_or(UnorderedMap::new(StorageKey::Votes));
+
         let mut results: Vec<VotableObjectJSON> = Vec::new();
         for (id, voting_power) in objects.iter() {
             results.push(

contract/meta-vote-contract/src/locking_position.rs

@@ -56,7 +56,7 @@ impl LockingPosition {
             unlocking_started_at: self.unlocking_started_at,
             is_unlocked: self.is_unlocked(),
             is_unlocking: self.is_unlocking(),
-            is_locked: self.is_locked(),
+            is_locked: self.is_locked()
         }
     }
 }

contract/meta-vote-contract/src/tests/mod.rs

@@ -48,6 +48,13 @@ fn test_single_deposit() {
         msg.parse::<Days>().unwrap()
     );
     assert_eq!(vote_power, voter.voting_power, "Incorrect voting power calculation!");
+
+    let voters = contract.get_voters(0, 10);
+    assert_eq!(voters.len(), 1);
+    let locking_position = &voters.first().unwrap().locking_positions;
+    assert_eq!(locking_position.len(), 1);
+    let vote_position = &voters.first().unwrap().vote_positions;
+    assert_eq!(vote_position.len(), 0);
 }
 
 #[test]
@@ -105,6 +112,13 @@ fn test_multiple_deposit_same_locking_period() {
         contract.get_balance(sender_id.clone()),
         "Incorrect balance!"
     );
+
+    let voters = contract.get_voters(0, 10);
+    assert_eq!(voters.len(), 1);
+    let locking_position = &voters.first().unwrap().locking_positions;
+    assert_eq!(locking_position.len(), 1);
+    let vote_position = &voters.first().unwrap().vote_positions;
+    assert_eq!(vote_position.len(), 0);
 }
 
 #[test]
@@ -147,7 +161,6 @@ fn test_multiple_deposit_diff_locking_period() {
     );
     testing_env!(context.clone());
     assert_eq!(
-
         U128::from(total_vote_power),
         contract.get_available_voting_power(sender_id.clone()),
         "Incorrect voting power calculation!"
@@ -164,6 +177,13 @@ fn test_multiple_deposit_diff_locking_period() {
         contract.get_balance(sender_id.clone()),
         "Incorrect balance!"
     );
+
+    let voters = contract.get_voters(0, 10);
+    assert_eq!(voters.len(), 1);
+    let locking_position = &voters.first().unwrap().locking_positions;
+    assert_eq!(locking_position.len(), 2);
+    let vote_position = &voters.first().unwrap().vote_positions;
+    assert_eq!(vote_position.len(), 0);
 }
 
 #[test]
@@ -748,10 +768,16 @@ fn test_clear_locking_position() {
         Meta::from(contract.get_balance(sender_id.clone())),
         "Incorrect balance!"
     );
+
+    let voters = contract.get_voters(0, 10);
+    assert_eq!(voters.len(), 1);
+    let locking_position = &voters.first().unwrap().locking_positions;
+    assert_eq!(locking_position.len(), 0);
+    let vote_position = &voters.first().unwrap().vote_positions;
+    assert_eq!(vote_position.len(), 0);
 }
 
 #[test]
-
 #[should_panic(expected="Not enough free voting power to unlock! You have 0, required 20370370370370370370370370.")]
 fn test_unlock_position_without_voting_power() {
     const LOCKING_PERIOD: u64 = 100;
@@ -873,6 +899,13 @@ fn test_rebalance_increase_and_decrease() {
     let votes_for_address = voter.get_votes_for_address(&sender_id, &contract_address);
     let votes = votes_for_address.get(&votable_object_id).unwrap();
     assert_eq!(votes, u128::from(additional_votes), "Incorrect Voting Power calculation.");
+
+    let voters = contract.get_voters(0, 10);
+    assert_eq!(voters.len(), 1);
+    let locking_position = &voters.first().unwrap().locking_positions;
+    assert_eq!(locking_position.len(), 1);
+    let vote_position = &voters.first().unwrap().vote_positions;
+    assert_eq!(vote_position.len(), 1);
 }
 
 #[test]
@@ -1009,4 +1042,10 @@ fn test_multi_voter_contract() {
         "Incorrect vote count for project 2, object 1."
     );
 
+    let voters = contract.get_voters(0, 10);
+    assert_eq!(voters.len(), 4);
+    let locking_position = &voters.first().unwrap().locking_positions;
+    assert_eq!(locking_position.len(), 1);
+    let vote_position = &voters.first().unwrap().vote_positions;
+    assert_eq!(vote_position.len(), 1);
 }

contract/meta-vote-contract/src/types.rs

@@ -17,7 +17,7 @@ construct_uint! {
     pub struct U256(4);
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Serialize, Deserialize, Debug)]
 #[serde(crate = "near_sdk::serde")]
 pub struct LockingPositionJSON {
     pub index: Option<PositionIndex>,
@@ -37,3 +37,11 @@ pub struct VotableObjectJSON {
     pub id: VotableObjId,
     pub current_votes: U128
 }
+
+#[derive(Serialize, Deserialize, Debug)]
+#[serde(crate = "near_sdk::serde")]
+pub struct VotePositionJSON {
+    pub votable_address: AccountId,
+    pub votable_object_id: String,
+    pub voting_power: U128
+}

contract/meta-vote-contract/src/voter.rs

@@ -1,5 +1,15 @@
 use crate::*;
 use near_sdk::borsh::{self, BorshDeserialize, BorshSerialize};
+use near_sdk::serde::{Deserialize, Serialize};
+
+#[derive(Serialize, Deserialize, Debug)]
+#[serde(crate = "near_sdk::serde")]
+pub struct VoterJSON {
+    pub voter_id: AccountId,
+    pub locking_positions: Vec<LockingPositionJSON>,
+    pub voting_power: U128,
+    pub vote_positions: Vec<VotePositionJSON>
+}
 
 #[derive(BorshDeserialize, BorshSerialize)]
 pub struct Voter {
@@ -117,4 +127,34 @@ impl Voter {
         }
         result
     }
+
+    pub(crate) fn to_json(&self, voter_id: VoterId) -> VoterJSON {
+        let mut locking_positions = Vec::<LockingPositionJSON>::new();
+        for index in 0..self.locking_positions.len() {
+            let pos = self.locking_positions.get(index).unwrap();
+            locking_positions.push(pos.to_json(Some(index)));
+        }
+
+        let mut vote_positions = Vec::<VotePositionJSON>::new();
+        for address in self.vote_positions.keys_as_vector().iter() {
+            let pos = self.vote_positions.get(&address).unwrap();
+            for obj in pos.keys_as_vector().iter() {
+                let value = pos.get(&obj).unwrap();
+                vote_positions.push(
+                    VotePositionJSON {
+                        votable_address: address.clone(),
+                        votable_object_id: obj,
+                        voting_power: U128::from(value)
+                    }
+                );
+            }
+        }
+
+        VoterJSON {
+            voter_id,
+            locking_positions,
+            voting_power: U128::from(self.voting_power),
+            vote_positions
+        }
+    }
 }

front/.env.example

@@ -3,4 +3,7 @@ NEXT_PUBLIC_METAPOOL_CONTRACT_ID=
 NEXT_PUBLIC_META_CONTRACT_ID=
 NEXT_PUBLIC_CONTRACT_ADDRESS_METAVOTE=
 NEXT_PUBLIC_GA_TRACKING_ID=
-NEXT_PUBLIC_VERCEL_ENV=
+NEXT_PUBLIC_VOTES_REFETCH_INTERVAL=
+NEXT_PUBLIC_VOTER_DATA_REFETCH_INTERVAL=
+NEXT_PUBLIC_VERCEL_ENV=
+NEXT_PUBLIC_GET_META_CONTRACT=

front/config.ts

@@ -12,7 +12,7 @@ export const getConfig = (env: string)  => {
         helperUrl: "https://helper.mainnet.near.org",
         explorerUrl: "https://explorer.mainnet.near.org",
         metapoolUrl: "https://metapool.app/dapp/mainnet/meta",
-        refFinance: "https://www.ref.finance/",
+        refFinance: "https://app.ref.finance/#meta-pool.near%7Cmeta-token.near",
         metayieldUrl: "https://metayield.app" 
 
       };
@@ -27,7 +27,7 @@ export const getConfig = (env: string)  => {
         helperUrl: "https://helper.testnet.near.org",
         explorerUrl: "https://explorer.testnet.near.org",
         metapoolUrl: "https://metapool.app/dapp/testnet/meta",
-        refFinance: "https://www.ref.finance/",
+        refFinance: "https://app.ref.finance/#meta-pool.near%7Cmeta-token.near",
         metayieldUrl: "https://metayield.app" 
       };
     case "betanet":
@@ -39,7 +39,7 @@ export const getConfig = (env: string)  => {
         helperUrl: "https://helper.betanet.near.org",
         explorerUrl: "https://explorer.betanet.near.org",
         metapoolUrl: "https://metapool.app/dapp/testnet/meta",
-        refFinance: "https://www.ref.finance/",
+        refFinance: "https://app.ref.finance/#meta-pool.near%7Cmeta-token.near",
         metayieldUrl: "https://metayield.app" 
       };
     case "local":
@@ -49,7 +49,7 @@ export const getConfig = (env: string)  => {
         keyPath: `${process.env.HOME}/.near/validator_key.json`,
         walletUrl: "http://localhost:4000/wallet",
         metapoolUrl: "https://metapool.app/dapp/testnet/meta",
-        refFinance: "https://www.ref.finance/",
+        refFinance: "https://app.ref.finance/#meta-pool.near%7Cmeta-token.near",
         contractName: CONTRACT_NAME,
         metayieldUrl: "https://metayield.app" 
       };

front/constants/index.tsx

@@ -1,5 +1,26 @@
+export const MIN_LOCK_DAYS = 30;
+export const DEFAULT_LOCK_DAYS = 90;
 
- export const CONTRACT_ADDRESS = process.env.NEXT_PUBLIC_CONTRACT_ADDRESS_METAVOTE;
+export const MAX_LOCK_DAYS = 300;
+
+export const MODAL_DURATION = {
+  LONG: 9000,
+  SUCCESS: 3000,
+  ERROR: 5000
+}
+
+export const FETCH_VOTES_INTERVAL = process.env.NEXT_PUBLIC_VOTER_DATA_REFETCH_INTERVAL ? parseInt(process.env.NEXT_PUBLIC_VOTER_DATA_REFETCH_INTERVAL) : 5000;
+export const FETCH_VOTER_DATA_INTERVAL = process.env.NEXT_PUBLIC_VOTES_REFETCH_INTERVAL ? parseInt(process.env.NEXT_PUBLIC_VOTES_REFETCH_INTERVAL) : 5000;
+export const FETCH_WHITELISTED_TOKENS_INTERVAL = 10000;
+export const FETCH_METAPOOL_STATE_INTERVAL = 2000;
+export const FETCH_NEAR_PRICE_INTERVAL = 2000;
+export const FETCH_TOKEN_BALANCE_INTERVAL = 5000;
+
+export const GET_META_DEFAULT_SLIPPAGE = 0.3;
+export const GET_META_MIN_SLIPPAGE = 0.01;
+export const GET_META_ENABLED =  (process.env.NEXT_PUBLIC_ENABLE_GET_META && process.env.NEXT_PUBLIC_ENABLE_GET_META == "true") || false;
+
+export const CONTRACT_ADDRESS = process.env.NEXT_PUBLIC_CONTRACT_ADDRESS_METAVOTE||"metayield.app";
 
 export const enum ACTION_TYPE {
     RELOCK,
@@ -13,7 +34,7 @@ export const MODAL_TEXT = {
     UNLOCK: {
       CONFIRM: {
         title: `Start unlocking`,
-        text: `Are you sure you want to start unlocking this position? Your tokens will be releases when the locking period ends.`
+        text: `Are you sure you want to start unlocking this position? Your tokens will be released when the locking period ends.`
       },
       ERROR_NOT_ENOUGH: {
         title: `Not Enough Available Voting Power`,

front/constants/whitelist.ts

@@ -1,10 +1,17 @@
 export const WHITELIST_SITES = [
     {
         platform: 'metayield.app',
-        isologo: 'metayield_iso.png'
+        isologo: 'metayield_iso.png',
+        url: 'https://metayield.app/vote/'
     },
     {
         platform: 'metapool.app',
-        isologo: 'metapool_iso.png'
+        isologo: 'metapool_iso.png',
+        url: 'https://vote.metapool.app/'
+    },
+    {
+        platform: 'metastaking.app',
+        isologo: 'metapool_iso.png',
+        url: 'https://vote.metapool.app/'
     },
 ]