Add storage reward pools (#4779) (#4789)

automerge

programs/storage_api/Cargo.toml

@@ -12,6 +12,7 @@ edition = "2018"
 assert_matches = "1.3.0"
 bincode = "1.1.4"
 log = "0.4.2"
+rand = "0.6.5"
 num-derive = "0.2"
 num-traits = "0.2"
 serde = "1.0.92"

programs/storage_api/src/lib.rs

@@ -1,3 +1,4 @@
+pub mod rewards_pools;
 pub mod storage_contract;
 pub mod storage_instruction;
 pub mod storage_processor;

programs/storage_api/src/rewards_pools.rs

@@ -0,0 +1,63 @@
+//! rewards_pools
+//! * initialize genesis with rewards pools
+//! * keep track of rewards
+//! * own mining pools
+
+use crate::storage_contract::create_rewards_pool;
+use rand::{thread_rng, Rng};
+use solana_sdk::genesis_block::Builder;
+use solana_sdk::hash::{hash, Hash};
+use solana_sdk::pubkey::Pubkey;
+
+// base rewards pool ID
+const ID: [u8; 32] = [
+    6, 162, 25, 123, 127, 71, 141, 232, 129, 171, 58, 183, 79, 88, 181, 17, 163, 11, 51, 111, 22,
+    123, 67, 115, 5, 131, 109, 161, 16, 0, 0, 0,
+];
+
+solana_sdk::solana_name_id!(ID, "StorageMiningPoo111111111111111111111111111");
+
+// to cut down on collisions for redemptions, we make multiple accounts
+pub const NUM_REWARDS_POOLS: usize = 32;
+
+pub fn genesis(mut builder: Builder) -> Builder {
+    let mut pubkey = id();
+
+    for _i in 0..NUM_REWARDS_POOLS {
+        builder = builder.rewards_pool(pubkey, create_rewards_pool());
+        pubkey = Pubkey::new(hash(pubkey.as_ref()).as_ref());
+    }
+    builder
+}
+
+pub fn random_id() -> Pubkey {
+    let mut id = Hash::new(&ID);
+
+    for _i in 0..thread_rng().gen_range(0, NUM_REWARDS_POOLS) {
+        id = hash(id.as_ref());
+    }
+
+    Pubkey::new(id.as_ref())
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use solana_sdk::genesis_block::Builder;
+
+    #[test]
+    fn test() {
+        let builder = Builder::new();
+
+        let genesis_block = genesis(builder).build();
+
+        for _i in 0..NUM_REWARDS_POOLS {
+            let id = random_id();
+            assert!(genesis_block
+                .rewards_pools
+                .iter()
+                .position(|x| x.0 == id)
+                .is_some());
+        }
+    }
+}

programs/storage_api/src/storage_contract.rs

@@ -79,7 +79,7 @@ pub enum StorageContract {
         reward_validations: BTreeMap<usize, BTreeMap<Pubkey, Vec<ProofStatus>>>,
     },
 
-    MiningPool,
+    RewardsPool,
 }
 
 // utility function, used by Bank, tests, genesis
@@ -99,17 +99,6 @@ pub fn create_validator_storage_account(owner: Pubkey, lamports: u64) -> Account
     storage_account
 }
 
-// utility function, used by genesis
-pub fn create_mining_pool_account(lamports: u64) -> Account {
-    let mut storage_account = Account::new(lamports, STORAGE_ACCOUNT_SPACE as usize, &crate::id());
-
-    storage_account
-        .set_state(&StorageContract::MiningPool)
-        .expect("set_state");
-
-    storage_account
-}
-
 pub struct StorageAccount<'a> {
     pub(crate) id: Pubkey,
     account: &'a mut Account,
@@ -120,16 +109,6 @@ impl<'a> StorageAccount<'a> {
         Self { id, account }
     }
 
-    pub fn initialize_mining_pool(&mut self) -> Result<(), InstructionError> {
-        let storage_contract = &mut self.account.state()?;
-        if let StorageContract::Uninitialized = storage_contract {
-            *storage_contract = StorageContract::MiningPool;
-            self.account.set_state(storage_contract)
-        } else {
-            Err(InstructionError::AccountAlreadyInitialized)?
-        }
-    }
-
     pub fn initialize_replicator_storage(&mut self, owner: Pubkey) -> Result<(), InstructionError> {
         let storage_contract = &mut self.account.state()?;
         if let StorageContract::Uninitialized = storage_contract {
@@ -379,7 +358,7 @@ impl<'a> StorageAccount<'a> {
 
     pub fn claim_storage_reward(
         &mut self,
-        mining_pool: &mut KeyedAccount,
+        rewards_pool: &mut KeyedAccount,
         owner: &mut StorageAccount,
     ) -> Result<(), InstructionError> {
         let mut storage_contract = &mut self.account.state()?;
@@ -397,12 +376,13 @@ impl<'a> StorageAccount<'a> {
             }
 
             let pending = *pending_lamports;
-            if mining_pool.account.lamports < pending {
+            if rewards_pool.account.lamports < pending {
+                println!("reward pool has {}", rewards_pool.account.lamports);
                 Err(InstructionError::CustomError(
                     StorageError::RewardPoolDepleted as u32,
                 ))?
             }
-            mining_pool.account.lamports -= pending;
+            rewards_pool.account.lamports -= pending;
             owner.account.lamports += pending;
             //clear pending_lamports
             *pending_lamports = 0;
@@ -432,7 +412,7 @@ impl<'a> StorageAccount<'a> {
             let total_proofs = checked_proofs.len() as u64;
             let num_validations = count_valid_proofs(&checked_proofs);
             let reward = num_validations * REPLICATOR_REWARD * (num_validations / total_proofs);
-            mining_pool.account.lamports -= reward;
+            rewards_pool.account.lamports -= reward;
             owner.account.lamports += reward;
             self.account.set_state(storage_contract)
         } else {
@@ -441,6 +421,10 @@ impl<'a> StorageAccount<'a> {
     }
 }
 
+pub fn create_rewards_pool() -> Account {
+    Account::new_data(std::u64::MAX, &StorageContract::RewardsPool, &crate::id()).unwrap()
+}
+
 /// Store the result of a proof validation into the replicator account
 fn store_validation_result(
     me: &Pubkey,

programs/storage_api/src/storage_instruction.rs

@@ -1,5 +1,5 @@
-use crate::id;
 use crate::storage_contract::{ProofStatus, STORAGE_ACCOUNT_SPACE};
+use crate::{id, rewards_pools};
 use serde_derive::{Deserialize, Serialize};
 use solana_sdk::hash::Hash;
 use solana_sdk::instruction::{AccountMeta, Instruction};
@@ -10,11 +10,10 @@ use solana_sdk::system_instruction;
 
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub enum StorageInstruction {
-    /// Initialize the account as a mining pool, validator or replicator
+    /// Initialize the account as a validator or replicator
     ///
     /// Expects 1 Account:
     ///    0 - Account to be initialized
-    InitializeMiningPool,
     InitializeValidatorStorage {
         owner: Pubkey,
     },
@@ -128,27 +127,6 @@ pub fn create_replicator_storage_account(
     ]
 }
 
-pub fn create_mining_pool_account(
-    from_pubkey: &Pubkey,
-    storage_pubkey: &Pubkey,
-    lamports: u64,
-) -> Vec<Instruction> {
-    vec![
-        system_instruction::create_account(
-            from_pubkey,
-            storage_pubkey,
-            lamports,
-            STORAGE_ACCOUNT_SPACE,
-            &id(),
-        ),
-        Instruction::new(
-            id(),
-            &StorageInstruction::InitializeMiningPool,
-            vec![AccountMeta::new(*storage_pubkey, false)],
-        ),
-    ]
-}
-
 pub fn mining_proof(
     storage_pubkey: &Pubkey,
     sha_state: Hash,
@@ -200,15 +178,11 @@ pub fn proof_validation(
     Instruction::new(id(), &storage_instruction, account_metas)
 }
 
-pub fn claim_reward(
-    owner_pubkey: &Pubkey,
-    storage_pubkey: &Pubkey,
-    mining_pool_pubkey: &Pubkey,
-) -> Instruction {
+pub fn claim_reward(owner_pubkey: &Pubkey, storage_pubkey: &Pubkey) -> Instruction {
     let storage_instruction = StorageInstruction::ClaimStorageReward;
     let account_metas = vec![
         AccountMeta::new(*storage_pubkey, false),
-        AccountMeta::new(*mining_pool_pubkey, false),
+        AccountMeta::new(rewards_pools::random_id(), false),
         AccountMeta::new(*owner_pubkey, false),
     ];
     Instruction::new(id(), &storage_instruction, account_metas)

programs/storage_api/src/storage_processor.rs

@@ -20,12 +20,6 @@ pub fn process_instruction(
     let mut storage_account = StorageAccount::new(*me[0].unsigned_key(), &mut me[0].account);
 
     match bincode::deserialize(data).map_err(|_| InstructionError::InvalidInstructionData)? {
-        StorageInstruction::InitializeMiningPool => {
-            if !rest.is_empty() {
-                Err(InstructionError::InvalidArgument)?;
-            }
-            storage_account.initialize_mining_pool()
-        }
         StorageInstruction::InitializeReplicatorStorage { owner } => {
             if !rest.is_empty() {
                 Err(InstructionError::InvalidArgument)?;