feat: add a integration testing case (#51)

Author: felicityin

Cargo.lock

@@ -7,7 +7,7 @@ edition = "2021"
 [dependencies]
 anyhow = "1.0"
 async-trait = "0.1"
-axon-types = { git = "https://github.com/axonweb3/axon-contract", rev = "33e1736" }
+axon-types = { git = "https://github.com/axonweb3/axon-contract", rev = "991eaa0" }
 bytes = "1.0"
 chrono = "0.4"
 ckb-fixed-hash-core = "0.109"

common/Cargo.toml

@@ -17,8 +17,7 @@ pub trait IInitTxBuilder<'a, C: CkbRpc> {
         seeder_key: PrivateKey,
         max_supply: Amount,
         checkpoint: Checkpoint,
-        epoch0_metadata: Metadata,
-        epoch1_metadata: Metadata,
+        metadata: MetadataInfo,
         stakers: Vec<StakerEthAddr>,
     ) -> Self;
 
@@ -78,16 +77,16 @@ where
     C: CkbRpc,
     S: RewardSmtStorage + StakeSmtStorage + DelegateSmtStorage + ProposalSmtStorage,
 {
-    fn new(
+    async fn new(
         ckb: &'a C,
         type_ids: RewardTypeIds,
         smt: S,
-        info: RewardInfo,
         user: EthAddress,
         current_epoch: Epoch,
+        epoch_count: u64,
     ) -> Self;
 
-    async fn build_tx(self) -> Result<TransactionView>;
+    async fn build_tx(mut self) -> Result<TransactionView>;
 }
 
 #[async_trait]
@@ -128,7 +127,6 @@ pub trait IStakeSmtTxBuilder<'a, C: CkbRpc, S: StakeSmtStorage> {
         kicker: PrivateKey,
         current_epoch: Epoch,
         type_ids: StakeSmtTypeIds,
-        quorum: u16,
         stake_cells: Vec<Cell>,
         stake_smt_storage: S,
     ) -> Self;

common/src/traits/tx_builder.rs

@@ -522,10 +522,16 @@ impl From<Metadata> for AMetadata {
     }
 }
 
-pub struct RewardInfo {
+#[derive(Clone, Default)]
+pub struct RewardMeta {
     pub base_reward:           Amount,
     pub half_reward_cycle:     Epoch,
-    pub minimum_propose_count: u64,
+    pub propose_minimum_rate:  u8,
     pub propose_discount_rate: u8,
-    pub epoch_count:           u64,
+}
+
+pub struct MetadataInfo {
+    pub reward_meta:     RewardMeta,
+    pub epoch0_metadata: Metadata,
+    pub epoch1_metadata: Metadata,
 }

common/src/types/tx_builder.rs

@@ -28,32 +28,42 @@ delegator_privkeys = [
 ```
 
 # Run
+
+## Run cases
+
+```
+cd spark/devtools/tx-tests
+
+cargo run -- cases -n test -1
+```
+
+## Run single tx
 ```
 cd spark/devtools/tx-tests
 
-cargo run -- -f  // faucet (only used on the dev chain)
+cargo run -- single-tx -n test -f  // faucet (only used on the dev chain)
 
-cargo run -- -i  // init tx
+cargo run -- single-tx -n test -i  // init tx
 
-cargo run -- -m  // mint tx
+cargo run -- single-tx -n test -m  // mint tx
 
 // stake tx
-cargo run -- -s first   // first stake
-cargo run -- -s add     // add stake
-cargo run -- -s redeem  // redeem stake
+cargo run -- single-tx -n test -s first   // first stake
+cargo run -- single-tx -n test -s add     // add stake
+cargo run -- single-tx -n test -s redeem  // redeem stake
 
 // delegate tx
-cargo run -- -s first   // first delegate
-cargo run -- -s add     // add delegate
-cargo run -- -s redeem  // redeem delegate
+cargo run -- single-tx -n test -s first   // first delegate
+cargo run -- single-tx -n test -s add     // add delegate
+cargo run -- single-tx -n test -s redeem  // redeem delegate
 
-cargo run -- -t  // stake smt tx
+cargo run -- single-tx -n test -t  // stake smt tx
 
-cargo run -- -e  // delegate smt tx
+cargo run -- single-tx -n test -e  // delegate smt tx
 
-cargo run -- -w  // withdraw tx
+cargo run -- single-tx -n test -w  // withdraw tx
 
-cargo run -- -a  // metadata tx
+cargo run -- single-tx -n test -a  // metadata tx
 
-cargo run -- -r  // reward tx
+cargo run -- single-tx -n test -r  // reward tx
 ```

devtools/tx-tests/README.md

@@ -0,0 +1,47 @@
+use std::fs;
+use std::path::Path;
+
+use rpc_client::ckb_client::ckb_rpc_client::CkbRpcClient;
+use tx_builder::ckb::helper::OmniEth;
+
+use crate::config::types::PrivKeys;
+use crate::tx::*;
+use crate::ROCKSDB_PATH;
+
+// There is only one staker or delegator.
+pub async fn run_case1(ckb: &CkbRpcClient, priv_keys: PrivKeys) {
+    if Path::new(ROCKSDB_PATH).exists() {
+        fs::remove_dir_all(ROCKSDB_PATH).unwrap();
+    }
+
+    let kicker_key = priv_keys.staker_privkeys[0].clone().into_h256().unwrap();
+    let staker_key = priv_keys.staker_privkeys[0].clone().into_h256().unwrap();
+    let delegator_key = priv_keys.delegator_privkeys[0].clone().into_h256().unwrap();
+    let staker_eth_addr = OmniEth::new(staker_key.clone()).address().unwrap();
+
+    run_init_tx(ckb, priv_keys.clone()).await;
+    run_mint_tx(ckb, priv_keys.clone()).await;
+
+    first_stake_tx(ckb, staker_key.clone()).await;
+    add_stake_tx(ckb, staker_key.clone()).await;
+    run_stake_smt_tx(ckb, kicker_key.clone()).await;
+
+    reedem_stake_tx(ckb, staker_key.clone()).await;
+    run_stake_smt_tx(ckb, kicker_key.clone()).await;
+
+    first_delegate_tx(ckb, delegator_key.clone(), staker_eth_addr.clone()).await;
+    add_delegate_tx(ckb, delegator_key.clone(), staker_eth_addr.clone()).await;
+    run_delegate_smt_tx(ckb, kicker_key.clone()).await;
+
+    reedem_delegate_tx(ckb, delegator_key, staker_eth_addr).await;
+    run_delegate_smt_tx(ckb, kicker_key.clone()).await;
+
+    run_metadata_tx(ckb, kicker_key.clone()).await;
+
+    run_checkpoint_tx(ckb, priv_keys.clone(), 1).await;
+    run_checkpoint_tx(ckb, priv_keys.clone(), 2).await;
+
+    run_reward_tx(ckb, staker_key.clone()).await;
+
+    run_withdraw_tx(ckb, staker_key.clone()).await;
+}

devtools/tx-tests/src/cases/case1.rs

@@ -0,0 +1,3 @@
+mod case1;
+
+pub use case1::run_case1;

devtools/tx-tests/src/cases/mod.rs

@@ -4,12 +4,25 @@ use std::fs;
 use std::io::Write;
 use std::path::Path;
 
-use serde::{de, ser};
+use serde::ser;
 
-use common::config_parser::parse_file as cparse_file;
+use common::config_parser::{parse_file, types::ConfigLogger};
 
-pub fn parse_file<T: de::DeserializeOwned>(path: impl AsRef<Path>) -> T {
-    cparse_file(path, false).unwrap()
+use crate::config::types::{PrivKeys, TypeIds};
+
+pub fn parse_priv_keys(path: impl AsRef<Path>) -> PrivKeys {
+    let priv_keys: PrivKeys = parse_file(path, false).expect("priv keys");
+    priv_keys
+}
+
+pub fn parse_type_ids(path: impl AsRef<Path>) -> TypeIds {
+    let type_ids: TypeIds = parse_file(path, false).expect("type ids");
+    type_ids
+}
+
+pub fn parse_log_config(path: impl AsRef<Path>) -> ConfigLogger {
+    let config: ConfigLogger = parse_file(path, false).expect("log config");
+    config
 }
 
 pub fn write_file<T: ser::Serialize>(path: impl AsRef<Path>, content: &T) {
@@ -27,11 +40,11 @@ pub fn write_file<T: ser::Serialize>(path: impl AsRef<Path>, content: &T) {
 #[cfg(test)]
 mod tests {
     use super::types::*;
-    use super::{parse_file, write_file};
+    use super::{parse_priv_keys, parse_type_ids, write_file};
 
     fn _test_parse_config() {
         let file_path = "./src/config/priv_keys.toml";
-        let priv_keys: PrivKeys = parse_file(file_path);
+        let priv_keys: PrivKeys = parse_priv_keys(file_path);
         println!("{:?}", priv_keys);
     }
 
@@ -66,7 +79,7 @@ mod tests {
         };
         write_file(file_path, &type_ids);
 
-        let type_ids: TypeIds = parse_file(file_path);
+        let type_ids: TypeIds = parse_type_ids(file_path);
         println!("{:?}", type_ids);
     }
 }