Merge pull request #215 from SethDusek/newtype_params

Add newtypes for BlockHeight/EpochLength/etc

Author: greenhat

core/src/box_kind/ballot_box.rs

@@ -2,6 +2,7 @@ use crate::{
     contracts::ballot::{
         BallotContract, BallotContractError, BallotContractInputs, BallotContractParameters,
     },
+    oracle_types::BlockHeight,
     pool_config::CastBallotBoxVoteParameters,
     spec_token::{BallotTokenId, SpecToken, TokenIdKind, UpdateTokenId},
 };
@@ -265,21 +266,21 @@ impl BallotBox for VoteBallotBoxWrapper {
 pub fn make_local_ballot_box_candidate(
     contract: &BallotContract,
     ballot_token_owner: ProveDlog,
-    update_box_creation_height: u32,
+    update_box_creation_height: BlockHeight,
     ballot_token: SpecToken<BallotTokenId>,
     pool_box_address_hash: Digest32,
     reward_tokens: Token,
     value: BoxValue,
-    creation_height: u32,
+    creation_height: BlockHeight,
 ) -> Result<ErgoBoxCandidate, ErgoBoxCandidateBuilderError> {
-    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height);
+    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height.0);
     builder.set_register_value(
         NonMandatoryRegisterId::R4,
         (*ballot_token_owner.h).clone().into(),
     );
     builder.set_register_value(
         NonMandatoryRegisterId::R5,
-        (update_box_creation_height as i32).into(),
+        (update_box_creation_height.0 as i32).into(),
     );
     builder.set_register_value(NonMandatoryRegisterId::R6, pool_box_address_hash.into());
     builder.set_register_value(NonMandatoryRegisterId::R7, reward_tokens.token_id.into());

core/src/box_kind/oracle_box.rs

@@ -14,6 +14,8 @@ use crate::contracts::oracle::OracleContract;
 use crate::contracts::oracle::OracleContractError;
 use crate::contracts::oracle::OracleContractInputs;
 use crate::contracts::oracle::OracleContractParameters;
+use crate::oracle_types::BlockHeight;
+use crate::oracle_types::EpochCounter;
 use crate::spec_token::OracleTokenId;
 use crate::spec_token::PoolTokenId;
 use crate::spec_token::RewardTokenId;
@@ -248,12 +250,14 @@ impl PostedOracleBox {
         &self.ergo_box
     }
 
-    pub fn epoch_counter(&self) -> u32 {
-        self.ergo_box
-            .get_register(NonMandatoryRegisterId::R5.into())
-            .unwrap()
-            .try_extract_into::<i32>()
-            .unwrap() as u32
+    pub fn epoch_counter(&self) -> EpochCounter {
+        EpochCounter(
+            self.ergo_box
+                .get_register(NonMandatoryRegisterId::R5.into())
+                .unwrap()
+                .try_extract_into::<i32>()
+                .unwrap() as u32,
+        )
     }
 
     pub fn rate(&self) -> u64 {
@@ -323,15 +327,15 @@ pub fn make_oracle_box_candidate(
     contract: &OracleContract,
     public_key: ProveDlog,
     datapoint: i64,
-    epoch_counter: u32,
+    epoch_counter: EpochCounter,
     oracle_token: SpecToken<OracleTokenId>,
     reward_token: SpecToken<RewardTokenId>,
     value: BoxValue,
-    creation_height: u32,
+    creation_height: BlockHeight,
 ) -> Result<ErgoBoxCandidate, ErgoBoxCandidateBuilderError> {
-    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height);
+    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height.0);
     builder.set_register_value(NonMandatoryRegisterId::R4, (*public_key.h).clone().into());
-    builder.set_register_value(NonMandatoryRegisterId::R5, (epoch_counter as i32).into());
+    builder.set_register_value(NonMandatoryRegisterId::R5, (epoch_counter.0 as i32).into());
     builder.set_register_value(NonMandatoryRegisterId::R6, datapoint.into());
     builder.add_token(oracle_token.into());
     builder.add_token(reward_token.into());
@@ -346,9 +350,9 @@ pub fn make_collected_oracle_box_candidate(
     oracle_token: SpecToken<OracleTokenId>,
     reward_token: SpecToken<RewardTokenId>,
     value: BoxValue,
-    creation_height: u32,
+    creation_height: BlockHeight,
 ) -> Result<ErgoBoxCandidate, ErgoBoxCandidateBuilderError> {
-    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height);
+    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height.0);
     builder.set_register_value(NonMandatoryRegisterId::R4, (*public_key.h).clone().into());
     builder.add_token(oracle_token.into());
     builder.add_token(reward_token.into());

core/src/box_kind/pool_box.rs

@@ -12,6 +12,8 @@ use crate::contracts::pool::PoolContract;
 use crate::contracts::pool::PoolContractError;
 use crate::contracts::pool::PoolContractInputs;
 use crate::contracts::pool::PoolContractParameters;
+use crate::oracle_types::BlockHeight;
+use crate::oracle_types::EpochCounter;
 use crate::spec_token::PoolTokenId;
 use crate::spec_token::RefreshTokenId;
 use crate::spec_token::RewardTokenId;
@@ -23,7 +25,7 @@ pub trait PoolBox {
     fn contract(&self) -> &PoolContract;
     fn pool_nft_token(&self) -> SpecToken<PoolTokenId>;
     fn reward_token(&self) -> SpecToken<RewardTokenId>;
-    fn epoch_counter(&self) -> u32;
+    fn epoch_counter(&self) -> EpochCounter;
     fn rate(&self) -> i64;
     fn get_box(&self) -> &ErgoBox;
 }
@@ -113,12 +115,14 @@ impl PoolBox for PoolBoxWrapper {
         }
     }
 
-    fn epoch_counter(&self) -> u32 {
-        self.ergo_box
-            .get_register(NonMandatoryRegisterId::R5.into())
-            .unwrap()
-            .try_extract_into::<i32>()
-            .unwrap() as u32
+    fn epoch_counter(&self) -> EpochCounter {
+        EpochCounter(
+            self.ergo_box
+                .get_register(NonMandatoryRegisterId::R5.into())
+                .unwrap()
+                .try_extract_into::<i32>()
+                .unwrap() as u32,
+        )
     }
 
     fn rate(&self) -> i64 {
@@ -205,15 +209,15 @@ impl PoolBoxWrapperInputs {
 pub fn make_pool_box_candidate(
     contract: &PoolContract,
     datapoint: i64,
-    epoch_counter: i32,
+    epoch_counter: EpochCounter,
     pool_nft_token: SpecToken<PoolTokenId>,
     reward_token: SpecToken<RewardTokenId>,
     value: BoxValue,
-    creation_height: u32,
+    creation_height: BlockHeight,
 ) -> Result<ErgoBoxCandidate, ErgoBoxCandidateBuilderError> {
-    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height);
+    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height.0);
     builder.set_register_value(NonMandatoryRegisterId::R4, datapoint.into());
-    builder.set_register_value(NonMandatoryRegisterId::R5, epoch_counter.into());
+    builder.set_register_value(NonMandatoryRegisterId::R5, (epoch_counter.0 as i32).into());
     builder.add_token(pool_nft_token.into());
     builder.add_token(reward_token.into());
     builder.build()
@@ -223,15 +227,15 @@ pub fn make_pool_box_candidate(
 pub fn make_pool_box_candidate_unchecked(
     contract: &PoolContract,
     datapoint: i64,
-    epoch_counter: i32,
+    epoch_counter: EpochCounter,
     pool_nft_token: SpecToken<PoolTokenId>,
     reward_token: Token,
     value: BoxValue,
-    creation_height: u32,
+    creation_height: BlockHeight,
 ) -> Result<ErgoBoxCandidate, ErgoBoxCandidateBuilderError> {
-    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height);
+    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height.0);
     builder.set_register_value(NonMandatoryRegisterId::R4, datapoint.into());
-    builder.set_register_value(NonMandatoryRegisterId::R5, epoch_counter.into());
+    builder.set_register_value(NonMandatoryRegisterId::R5, (epoch_counter.0 as i32).into());
     builder.add_token(pool_nft_token.into());
     builder.add_token(reward_token);
     builder.build()

core/src/box_kind/refresh_box.rs

@@ -11,6 +11,7 @@ use crate::contracts::refresh::RefreshContract;
 use crate::contracts::refresh::RefreshContractError;
 use crate::contracts::refresh::RefreshContractInputs;
 use crate::contracts::refresh::RefreshContractParameters;
+use crate::oracle_types::BlockHeight;
 use crate::spec_token::OracleTokenId;
 use crate::spec_token::PoolTokenId;
 use crate::spec_token::RefreshTokenId;
@@ -131,9 +132,9 @@ pub fn make_refresh_box_candidate(
     contract: &RefreshContract,
     refresh_nft: Token,
     value: BoxValue,
-    creation_height: u32,
+    creation_height: BlockHeight,
 ) -> Result<ErgoBoxCandidate, ErgoBoxCandidateBuilderError> {
-    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height);
+    let mut builder = ErgoBoxCandidateBuilder::new(value, contract.ergo_tree(), creation_height.0);
     builder.add_token(refresh_nft.clone());
     builder.build()
 }

core/src/cli_commands/bootstrap.rs

@@ -49,6 +49,7 @@ use crate::{
         SignTransactionWithInputs, SubmitTransaction,
     },
     oracle_config::{BASE_FEE, ORACLE_CONFIG},
+    oracle_types::{BlockHeight, EpochCounter},
     pool_config::{
         PoolConfig, PoolConfigError, PredefinedDataPointSource, TokenIds,
         DEFAULT_POOL_CONFIG_FILE_NAME,
@@ -83,7 +84,7 @@ pub fn bootstrap(config_file_name: String) -> Result<(), BootstrapError> {
         tx_fee: *BASE_FEE,
         erg_value_per_box,
         change_address: change_address.address(),
-        height: node_api.node.current_block_height()? as u32,
+        height: BlockHeight(node_api.node.current_block_height()? as u32),
     };
     let (oracle_config, submitted_tx_ids) = perform_bootstrap_chained_transaction(input)?;
     wait_for_txs_confirmation(submitted_tx_ids);
@@ -121,7 +122,7 @@ pub struct BootstrapInput<'a> {
     pub tx_fee: BoxValue,
     pub erg_value_per_box: BoxValue,
     pub change_address: Address,
-    pub height: u32,
+    pub height: BlockHeight,
 }
 
 /// Perform and submit to the mempool the chained-transaction to boostrap the oracle pool. We first
@@ -212,14 +213,15 @@ pub(crate) fn perform_bootstrap_chained_transaction(
         };
         let token_box_guard =
             different_token_box_guard.unwrap_or_else(|| wallet_pk_ergo_tree.clone());
-        let mut builder = ErgoBoxCandidateBuilder::new(erg_value_per_box, token_box_guard, height);
+        let mut builder =
+            ErgoBoxCandidateBuilder::new(erg_value_per_box, token_box_guard, height.0);
         builder.mint_token(token.clone(), token_name, token_desc, 0);
         let mut output_candidates = vec![builder.build()?];
 
         let remaining_funds = ErgoBoxCandidateBuilder::new(
             calc_target_balance(*num_transactions_left - 1)?,
             wallet_pk_ergo_tree.clone(),
-            height,
+            height.0,
         )
         .build()?;
         output_candidates.push(remaining_funds.clone());
@@ -228,7 +230,7 @@ pub(crate) fn perform_bootstrap_chained_transaction(
         let tx_builder = TxBuilder::new(
             box_selection,
             output_candidates,
-            height,
+            height.0,
             tx_fee,
             change_address.clone(),
         );
@@ -392,7 +394,7 @@ pub(crate) fn perform_bootstrap_chained_transaction(
         &pool_contract,
         // We intentionally set the initial datapoint to be 0, as it's treated as 'undefined' during bootstrap.
         0,
-        1,
+        EpochCounter(1),
         SpecToken {
             token_id: token_ids.pool_nft_token_id.clone(),
             amount: pool_nft_token.amount,
@@ -410,7 +412,7 @@ pub(crate) fn perform_bootstrap_chained_transaction(
     let builder = ErgoBoxCandidateBuilder::new(
         calc_target_balance(num_transactions_left - 1)?,
         wallet_pk_ergo_tree.clone(),
-        height,
+        height.0,
     );
     output_candidates.push(builder.build()?);
 
@@ -442,7 +444,7 @@ pub(crate) fn perform_bootstrap_chained_transaction(
     let tx_builder = TxBuilder::new(
         box_selection,
         output_candidates,
-        height,
+        height.0,
         tx_fee,
         change_address.clone(),
     );
@@ -498,7 +500,7 @@ pub(crate) fn perform_bootstrap_chained_transaction(
     let tx_builder = TxBuilder::new(
         box_selection,
         output_candidates,
-        height,
+        height.0,
         tx_fee,
         change_address.clone(),
     );
@@ -721,7 +723,7 @@ pub(crate) mod tests {
 
         let bootstrap_config = BootstrapConfig::default();
 
-        let height = ctx.pre_header.height;
+        let height = BlockHeight(ctx.pre_header.height);
         let submit_tx = SubmitTxMock::default();
         let oracle_config = perform_bootstrap_chained_transaction(BootstrapInput {
             oracle_address: address,
@@ -907,6 +909,6 @@ data_point_source_custom_script: ~
 oracle_address: 3Wy3BaCjGDWE3bjjZkNo3aWaMz3cYrePMFhchcKovY9uG9vhpAuW
 base_fee: 1100000
 ").unwrap();
-        assert_eq!(config.refresh_contract_parameters.min_data_points(), 2);
+        assert_eq!(config.refresh_contract_parameters.min_data_points().0, 2);
     }
 }

core/src/cli_commands/extract_reward_tokens.rs

@@ -30,6 +30,7 @@ use crate::{
     node_interface::{SignTransaction, SubmitTransaction},
     oracle_config::BASE_FEE,
     oracle_state::{LocalDatapointBoxSource, StageError},
+    oracle_types::BlockHeight,
     spec_token::SpecToken,
     wallet::{WalletDataError, WalletDataSource},
 };
@@ -70,7 +71,7 @@ pub fn extract_reward_tokens(
     tx_submit: &dyn SubmitTransaction,
     local_datapoint_box_source: &dyn LocalDatapointBoxSource,
     rewards_destination_str: String,
-    height: u32,
+    height: BlockHeight,
 ) -> Result<(), ExtractRewardTokensActionError> {
     let rewards_destination =
         AddressEncoder::unchecked_parse_network_address_from_str(&rewards_destination_str)?;
@@ -110,7 +111,7 @@ fn build_extract_reward_tokens_tx(
     local_datapoint_box_source: &dyn LocalDatapointBoxSource,
     wallet: &dyn WalletDataSource,
     rewards_destination: Address,
-    height: u32,
+    height: BlockHeight,
     change_address: Address,
 ) -> Result<(UnsignedTransaction, u64), ExtractRewardTokensActionError> {
     let in_oracle_box = local_datapoint_box_source
@@ -154,7 +155,7 @@ fn build_extract_reward_tokens_tx(
 
         // Build box to hold extracted tokens
         let mut builder =
-            ErgoBoxCandidateBuilder::new(*BASE_FEE, rewards_destination.script()?, height);
+            ErgoBoxCandidateBuilder::new(*BASE_FEE, rewards_destination.script()?, height.0);
 
         let extracted_reward_tokens = Token {
             token_id: in_oracle_box.reward_token().token_id(),
@@ -180,7 +181,7 @@ fn build_extract_reward_tokens_tx(
         let mut tx_builder = TxBuilder::new(
             box_selection,
             vec![oracle_box_candidate, reward_box_candidate],
-            height,
+            height.0,
             *BASE_FEE,
             change_address,
         );
@@ -204,6 +205,7 @@ mod tests {
     use super::*;
     use crate::box_kind::{OracleBoxWrapper, OracleBoxWrapperInputs};
     use crate::contracts::oracle::OracleContractParameters;
+    use crate::oracle_types::EpochCounter;
     use crate::pool_commands::test_utils::{
         find_input_boxes, generate_token_ids, make_datapoint_box, make_wallet_unspent_box,
         OracleBoxMock, WalletDataMock,
@@ -218,7 +220,7 @@ mod tests {
     #[test]
     fn test_extract_reward_tokens() {
         let ctx = force_any_val::<ErgoStateContext>();
-        let height = ctx.pre_header.height;
+        let height = BlockHeight(ctx.pre_header.height);
         let token_ids = generate_token_ids();
         let secret = force_any_val::<DlogProverInput>();
         let wallet = Wallet::from_secrets(vec![secret.clone().into()]);
@@ -233,10 +235,10 @@ mod tests {
             make_datapoint_box(
                 *oracle_pub_key,
                 200,
-                1,
+                EpochCounter(1),
                 &token_ids,
                 BASE_FEE.checked_mul_u32(100).unwrap(),
-                height - 9,
+                BlockHeight(height.0),
             ),
             &oracle_box_wrapper_inputs,
         )