add runtime module log and copyright (paritytech#150)

chainx-org · Dec 5, 2018 · ed97f3f · ed97f3f
1 parent 3d7f792
commit ed97f3f
Show file tree

Hide file tree

Showing 19 changed files with 135 additions and 33 deletions.
diff --git a/cxrml/associations/src/lib.rs b/cxrml/associations/src/lib.rs
@@ -1,4 +1,6 @@
-//! this module is for bch-bridge
+// Copyright 2018 Chainpool.
+
+//! this module is for associations
 
 #![cfg_attr(not(feature = "std"), no_std)]
 // for encode/decode
@@ -22,8 +24,7 @@ extern crate substrate_primitives;
 // for substrate runtime
 // map!, vec! marco.
 extern crate sr_std as rstd;
-// Needed for tests (`with_externalities`).
-#[cfg(feature = "std")]
+
 extern crate sr_io as runtime_io;
 extern crate sr_primitives as runtime_primitives;
 // for substrate runtime module lib
@@ -122,6 +123,7 @@ impl<T: Trait> Module<T> {
 
 impl<T: Trait> Module<T> {
     pub fn init_account(origin: T::Origin, who: T::AccountId) -> Result {
+        runtime_io::print("[associations] init_account");
         let from = ensure_signed(origin)?;
         // deduct fee first
         T::OnCalcFee::on_calc_fee(&from, Self::init_fee())?;
@@ -150,6 +152,7 @@ impl<T: Trait> Module<T> {
     }
 
     pub fn init_exchange_relationship(origin: T::Origin, who: T::AccountId) -> Result {
+        runtime_io::print("[associations] init_exchange_relationship");
         let from = ensure_signed(origin)?;
         // deduct fee first
         T::OnCalcFee::on_calc_fee(&from, Self::init_fee())?;

diff --git a/cxrml/bridge/btc/src/blockchain.rs b/cxrml/bridge/btc/src/blockchain.rs
@@ -1,6 +1,10 @@
+// Copyright 2018 Chainpool.
+
+use codec::Encode;
 use rstd::marker::PhantomData;
 use rstd::prelude::*;
 use rstd::result::Result;
+use runtime_io;
 use runtime_primitives::traits::As;
 use runtime_support::{StorageMap, StorageValue};
 use {BtcFee, IrrBlock};
@@ -73,12 +77,12 @@ impl ChainErr {
         match *self {
             ChainErr::CannotCanonize => "Cannot canonize block",
             ChainErr::UnknownParent => "Block parent is unknown",
-            ChainErr::NotFound => "not to find orphaned side chain in header collection; qed",
+            ChainErr::NotFound => "Not to find orphaned side chain in header collection; qed",
             ChainErr::AncientFork => "Fork is too long to proceed",
-            ChainErr::Unreachable => "should not occur",
+            ChainErr::Unreachable => "Should not occur",
             ChainErr::CanonizeMustZero => "[canonize] must be zero in this case",
             ChainErr::DecanonizeMustZero => "[decanonize] must be zero in this case",
-            ChainErr::ForkErr => "the hash should same",
+            ChainErr::ForkErr => "The hash should same",
             ChainErr::OtherErr(s) => s,
         }
     }
@@ -96,16 +100,21 @@ impl<T: Trait> Chain<T> {
             // case 1: block has been added to the main branch
             BlockOrigin::CanonChain { .. } => {
                 Self::canonize(&header.hash())?;
+                runtime_io::print("[Main] block has been added to the main branch");
                 Ok(())
             }
             // case 2: block has been added to the side branch with reorganization to this branch
             BlockOrigin::SideChainBecomingCanonChain(origin) => {
                 Self::fork(origin.clone())?;
                 Self::canonize(&header.hash())?;
+                runtime_io::print("[Switch to Main] block has been added to the side branch with reorganization to this branch");
                 Ok(())
             }
             // case 3: block has been added to the side branch without reorganization to this branch
-            BlockOrigin::SideChain(_origin) => Ok(()),
+            BlockOrigin::SideChain(_origin) => {
+                runtime_io::print("[Side] block has been added to the side branch without reorganization to this branch");
+                Ok(())
+            }
         }
     }
 
@@ -114,9 +123,13 @@ impl<T: Trait> Chain<T> {
         let best_hash = best_index.hash;
         let best_bumber = best_index.number;
 
-        //todo change unwrap
-        let (best_header, _, _): (BlockHeader, T::AccountId, T::BlockNumber) =
-            <BlockHeaderFor<T>>::get(&best_hash).unwrap();
+        let best_header: BlockHeader =
+            if let Some((header, _, _)) = <BlockHeaderFor<T>>::get(&best_hash) {
+                header
+            } else {
+                return Err(ChainErr::OtherErr("not found blockheader for this hash"));
+            };
+
         let new_best_header = BestHeader {
             hash: best_header.previous_header_hash.clone(),
             number: if best_bumber > 0 {
@@ -145,9 +158,12 @@ impl<T: Trait> Chain<T> {
         let best_hash = best_index.hash;
         let best_number = best_index.number;
 
-        //todo change unwrap
-        let (header, _, _): (BlockHeader, T::AccountId, T::BlockNumber) =
-            <BlockHeaderFor<T>>::get(hash).unwrap();
+        let header: BlockHeader = if let Some((header, _, _)) = <BlockHeaderFor<T>>::get(hash) {
+            header
+        } else {
+            return Err(ChainErr::OtherErr("not found blockheader for this hash"));
+        };
+
         if best_hash != header.previous_header_hash {
             return Err(ChainErr::CannotCanonize);
         }
@@ -171,19 +187,26 @@ impl<T: Trait> Chain<T> {
                 v.push(h);
             }
         });
+        runtime_io::print("best header");
+        runtime_io::print(new_best_header.number as u64);
         // best chain choose finish
-        <BestIndex<T>>::put(new_best_header.clone());
+        <BestIndex<T>>::put(&new_best_header);
 
         // deposit/withdraw handle start
         let symbol: Symbol = Module::<T>::SYMBOL.to_vec();
         let irr_block = <IrrBlock<T>>::get();
         // Deposit
         if let Some(vec) = <DepositCache<T>>::take() {
+            runtime_io::print("deposit start ---accountid---amount---tx_hash---blocknum");
             let mut uncomplete_cache: Vec<(T::AccountId, u64, H256, H256)> = Vec::new();
             for (account_id, amount, tx_hash, block_hash) in vec {
                 match <NumberForHash<T>>::get(block_hash.clone()) {
                     Some(height) => {
                         if new_best_header.number >= height + irr_block {
+                            runtime_io::print(account_id.encode().as_slice());
+                            runtime_io::print(amount);
+                            runtime_io::print(&tx_hash[..]);
+                            runtime_io::print(height as u64);
                             // TODO handle err
                             let _ = <financial_records::Module<T>>::deposit(
                                 &account_id,
@@ -192,10 +215,14 @@ impl<T: Trait> Chain<T> {
                                 Some(tx_hash.as_ref().to_vec()),
                             );
                         } else {
+                            runtime_io::print("not reach irr_block --best --height");
+                            runtime_io::print(new_best_header.number as u64);
+                            runtime_io::print(height as u64);
                             uncomplete_cache.push((account_id, amount, tx_hash, block_hash));
                         }
                     }
                     None => {
+                        // TODO 遇到分叉，需要从deposit cache剔除相应的交易
                         uncomplete_cache.push((account_id, amount, tx_hash, block_hash));
                     } // Optmise
                 }
@@ -210,11 +237,16 @@ impl<T: Trait> Chain<T> {
             let mut candidate = Module::<T>::tx_proposal(len - 1).unwrap();
             // candidate: CandidateTx
             if candidate.confirmed == false {
+                runtime_io::print("withdraw start ---accountid---tx_hash---blocknum");
                 match <NumberForHash<T>>::get(&candidate.block_hash) {
                     Some(height) => {
                         if new_best_header.number >= height + irr_block {
                             let txid = candidate.tx.hash();
                             for (account_id, _) in candidate.outs.clone() {
+                                runtime_io::print(account_id.encode().as_slice());
+                                runtime_io::print(&txid[..]);
+                                runtime_io::print(height as u64);
+
                                 // TODO handle err
                                 let _ = <financial_records::Module<T>>::withdrawal_finish(
                                     &account_id,
@@ -225,9 +257,15 @@ impl<T: Trait> Chain<T> {
                             candidate.confirmed = true;
                             // mark this tx withdraw finish!
                             TxProposal::<T>::insert(len - 1, candidate);
+                        } else {
+                            runtime_io::print("not reach irr_block --best --height");
+                            runtime_io::print(new_best_header.number as u64);
+                            runtime_io::print(height as u64);
                         }
                     }
-                    None => {}
+                    None => {
+                        // todo 处理分叉问题
+                    }
                 }
             }
         }
@@ -238,6 +276,7 @@ impl<T: Trait> Chain<T> {
         // 标记该链上这笔proposal由于BTC 托管人没有按着正常逻辑签名广播， 该proposal可能永远不会confirmed.
         // 所以开始重新创建proposal.
         if len == 0 {
+            runtime_io::print("crate_proposal case 1");
             // no withdraw cache would return None
             if let Some(indexs) = financial_records::Module::<T>::withdrawal_cache_indexs(&symbol) {
                 let btc_fee = <BtcFee<T>>::get();
@@ -249,6 +288,9 @@ impl<T: Trait> Chain<T> {
         if len > 0 {
             let candidate = Module::<T>::tx_proposal(len - 1).unwrap();
             if candidate.confirmed || candidate.unexpect {
+                runtime_io::print("crate_proposal case 2,3  ---confirmed---unexpect");
+                runtime_io::print(candidate.confirmed.encode().as_slice());
+                runtime_io::print(candidate.unexpect.encode().as_slice());
                 // no withdraw cache would return None
                 if let Some(indexs) =
                     financial_records::Module::<T>::withdrawal_cache_indexs(&symbol)
@@ -263,6 +305,7 @@ impl<T: Trait> Chain<T> {
 
         // SendCert
         if let Some(cert_info) = <CertCache<T>>::take() {
+            runtime_io::print("send cert start");
             if let Err(e) = <staking::Module<T>>::issue(cert_info.0, cert_info.1, cert_info.2) {
                 return Err(ChainErr::OtherErr(e));
             }
@@ -294,9 +337,14 @@ impl<T: Trait> Chain<T> {
 
     fn block_origin(header: &BlockHeader) -> Result<BlockOrigin, ChainErr> {
         let best_index: BestHeader = <BestIndex<T>>::get();
-        // TODO change unwrap
-        let (best_header, _, _): (BlockHeader, T::AccountId, T::BlockNumber) =
-            <BlockHeaderFor<T>>::get(&best_index.hash).unwrap();
+
+        let best_header: BlockHeader =
+            if let Some((header, _, _)) = <BlockHeaderFor<T>>::get(&best_index.hash) {
+                header
+            } else {
+                return Err(ChainErr::OtherErr("not found blockheader for this hash"));
+            };
+
         if <NumberForHash<T>>::exists(header.hash()) {
             return Ok(BlockOrigin::KnownBlock);
         }

diff --git a/cxrml/bridge/btc/src/lib.rs b/cxrml/bridge/btc/src/lib.rs
@@ -1,3 +1,5 @@
+// Copyright 2018 Chainpool.
+
 //! this module is for btc-bridge
 
 #![cfg_attr(not(feature = "std"), no_std)]
@@ -26,7 +28,7 @@ extern crate substrate_primitives;
 // for substrate runtime
 // map!, vec! marco.
 extern crate sr_std as rstd;
-// Needed for tests (`with_externalities`).
+
 extern crate sr_io as runtime_io;
 extern crate sr_primitives as runtime_primitives;
 // for substrate runtime module lib
@@ -332,6 +334,7 @@ impl<T: Trait> Module<T> {
 impl<T: Trait> Module<T> {
     // public call
     pub fn push_header(origin: T::Origin, header: Vec<u8>) -> Result {
+        runtime_io::print("[bridge_btc] push btc header");
         let from = ensure_signed(origin)?;
         // parse header
         let header: BlockHeader =
@@ -341,13 +344,15 @@ impl<T: Trait> Module<T> {
     }
 
     pub fn push_transaction(origin: T::Origin, tx: Vec<u8>) -> Result {
+        runtime_io::print("[bridge_btc] push btc tx");
         let from = ensure_signed(origin)?;
         let tx: RelayTx = Decode::decode(&mut tx.as_slice()).ok_or("parse RelayTx err")?;
         Self::process_tx(tx, &from)?;
         Ok(())
     }
 
     pub fn propose_transaction(origin: T::Origin, tx: Vec<u8>) -> Result {
+        runtime_io::print("[bridge_btc] propose btc tx");
         let from = ensure_signed(origin)?;
 
         let tx: BTCTransaction =
@@ -375,6 +380,7 @@ impl<T: Trait> Module<T> {
         }
         // check
         {
+            runtime_io::print("check header");
             let c = verify_header::HeaderVerifier::new::<T>(&header).map_err(|e| e.info())?;
             c.check::<T>()?;
         }
@@ -404,7 +410,7 @@ impl<T: Trait> Module<T> {
         } else {
             return Err("should set CERT_address first");
         };
-        let tx_type = validate_transaction::<T>(&tx, (&receive_address, &cert_address)).unwrap();
+        let tx_type = validate_transaction::<T>(&tx, (&receive_address, &cert_address))?;
         match tx_type {
             TxType::Withdraw => {
                 handle_input::<T>(&tx.raw, &tx.block_hash, &who, &receive_address);

diff --git a/cxrml/bridge/btc/src/tests.rs b/cxrml/bridge/btc/src/tests.rs
@@ -1,3 +1,5 @@
+// Copyright 2018 Chainpool.
+
 extern crate srml_consensus as consensus;
 extern crate srml_session as session;
 

diff --git a/cxrml/bridge/btc/src/tx/mod.rs b/cxrml/bridge/btc/src/tx/mod.rs
@@ -376,7 +376,7 @@ pub fn handle_input<T: Trait>(
                 <TxProposal<T>>::insert(len - 1, candidate);
             }
         } else {
-            // To do: handle_input error not expect
+            // Todo: handle_input error not expect
             runtime_io::print("-----------handle_input error not expect");
         }
     }

diff --git a/cxrml/bridge/btc/src/utils.rs b/cxrml/bridge/btc/src/utils.rs
@@ -1,3 +1,5 @@
+// Copyright 2018 Chainpool.
+
 use rstd::prelude::Vec;
 
 pub fn vec_to_u32(date: Vec<u8>) -> Option<u32> {

diff --git a/cxrml/bridge/btc/src/verify_header.rs b/cxrml/bridge/btc/src/verify_header.rs
@@ -1,4 +1,4 @@
-//#![cfg_attr(not(feature = "std"), no_std)]
+// Copyright 2018 Chainpool.
 
 use rstd::cmp;
 use rstd::result::Result as StdResult;

diff --git a/cxrml/exchange/pendingorders/src/lib.rs b/cxrml/exchange/pendingorders/src/lib.rs
@@ -27,8 +27,7 @@ extern crate substrate_primitives;
 // map!, vec! marco.
 //#[cfg_attr(feature = "std", macro_use)]
 extern crate sr_std as rstd;
-// Needed for tests (`with_externalities`).
-#[cfg(test)]
+
 extern crate sr_io as runtime_io;
 extern crate sr_primitives as runtime_primitives;
 
@@ -411,6 +410,8 @@ impl<T: Trait> Module<T> {
         price: T::Price,
         channel_name: Channel,
     ) -> Result {
+        runtime_io::print("[exchange pendingorders] put_order");
+
         if channel_name.len() > 32 {
             return Err("channel name too long");
         }
@@ -435,6 +436,7 @@ impl<T: Trait> Module<T> {
         );
     }
     pub fn cancel_order(origin: T::Origin, pair: OrderPair, index: u64) -> Result {
+        runtime_io::print("[exchange pendingorders] cancel_order");
         let transactor = ensure_signed(origin)?;
 
         if let Some(mut order) = Self::order_of((transactor.clone(), pair.clone(), index)) {

diff --git a/cxrml/funds/financialrecords/src/lib.rs b/cxrml/funds/financialrecords/src/lib.rs
@@ -24,8 +24,7 @@ extern crate substrate_primitives;
 // for substrate runtime
 // map!, vec! marco.
 extern crate sr_std as rstd;
-// Needed for tests (`with_externalities`).
-#[cfg(test)]
+
 extern crate sr_io as runtime_io;
 extern crate sr_primitives as runtime_primitives;
 
@@ -47,10 +46,10 @@ extern crate cxrml_tokenbalances as tokenbalances;
 #[cfg(test)]
 mod tests;
 
-use codec::Codec;
+use codec::{Codec, Encode};
 use rstd::prelude::*;
 use rstd::result::Result as StdResult;
-use runtime_primitives::traits::OnFinalise;
+use runtime_primitives::traits::{OnFinalise, As};
 use runtime_support::dispatch::Result;
 use runtime_support::{StorageMap, StorageValue};
 
@@ -417,6 +416,13 @@ impl<T: Trait> Module<T> {
         txid: Option<Vec<u8>>,
     ) -> Result {
         let index = Self::deposit_with_index(who, sym, balance)?;
+
+        runtime_io::print("deposit ---who---sym---balance--index");
+        runtime_io::print(who.encode().as_slice());
+        runtime_io::print(sym.as_slice());
+        runtime_io::print(balance.as_() as u64);
+        runtime_io::print(index as u64);
+
         Self::deposit_finish_with_index(who, index, txid).map(|_| ())
     }
 
@@ -429,6 +435,11 @@ impl<T: Trait> Module<T> {
         ext: Vec<u8>,
     ) -> Result {
         let index = Self::withdrawal_with_index(who, sym, balance, addr, ext)?;
+        runtime_io::print("withdrawal ---who---sym---balance--index");
+        runtime_io::print(who.encode().as_slice());
+        runtime_io::print(sym.as_slice());
+        runtime_io::print(balance.as_() as u64);
+        runtime_io::print(index as u64);
 
         // set to withdraw cache
         let n = Node::new(WithdrawLog::<T::AccountId> {