client/rpc/types/cfx/
log.rs

1// Copyright 2019 Conflux Foundation. All rights reserved.
2// Conflux is free software and distributed under GNU General Public License.
3// See http://www.gnu.org/licenses/
4
5use crate::rpc::types::{Bytes, RpcAddress};
6use cfx_addr::Network;
7use cfx_types::{Space, H256, U256};
8use primitives::log_entry::{LocalizedLogEntry, LogEntry};
9use serde::{Deserialize, Serialize};
10
11#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Hash, Clone)]
12#[serde(rename_all = "camelCase")]
13pub struct Log {
14    /// Address
15    pub address: RpcAddress,
16
17    /// Topics
18    pub topics: Vec<H256>,
19
20    /// Data
21    pub data: Bytes,
22
23    /// Block Hash
24    #[serde(skip_serializing_if = "Option::is_none")]
25    pub block_hash: Option<H256>,
26
27    /// Epoch Number
28    #[serde(skip_serializing_if = "Option::is_none")]
29    pub epoch_number: Option<U256>,
30
31    /// Transaction Hash
32    #[serde(skip_serializing_if = "Option::is_none")]
33    pub transaction_hash: Option<H256>,
34
35    /// Transaction Index
36    #[serde(skip_serializing_if = "Option::is_none")]
37    pub transaction_index: Option<U256>,
38
39    /// Log Index in Block
40    #[serde(skip_serializing_if = "Option::is_none")]
41    pub log_index: Option<U256>,
42
43    /// Log Index in Transaction
44    #[serde(skip_serializing_if = "Option::is_none")]
45    pub transaction_log_index: Option<U256>,
46
47    /// Log space
48    #[serde(skip_serializing_if = "Option::is_none")]
49    pub space: Option<Space>,
50
51    /// Log timestamp
52    #[serde(skip_serializing_if = "Option::is_none")]
53    pub block_timestamp: Option<U256>,
54}
55
56impl Log {
57    pub fn try_from_localized(
58        e: LocalizedLogEntry, network: Network,
59    ) -> Result<Log, String> {
60        Ok(Log {
61            address: RpcAddress::try_from_h160(e.entry.address, network)?,
62            topics: e.entry.topics.into_iter().map(Into::into).collect(),
63            data: e.entry.data.into(),
64            block_hash: Some(e.block_hash.into()),
65            epoch_number: Some(e.epoch_number.into()),
66            transaction_hash: Some(e.transaction_hash.into()),
67            transaction_index: Some(e.transaction_index.into()),
68            log_index: Some(e.log_index.into()),
69            transaction_log_index: Some(e.transaction_log_index.into()),
70            space: None,
71            block_timestamp: e.block_timestamp.map(U256::from),
72        })
73    }
74
75    pub fn try_from(
76        e: LogEntry, network: Network, include_space: bool,
77    ) -> Result<Log, String> {
78        Ok(Log {
79            address: RpcAddress::try_from_h160(e.address, network)?,
80            topics: e.topics.into_iter().map(Into::into).collect(),
81            data: e.data.into(),
82            block_hash: None,
83            epoch_number: None,
84            transaction_hash: None,
85            transaction_index: None,
86            log_index: None,
87            transaction_log_index: None,
88            space: if include_space { Some(e.space) } else { None },
89            block_timestamp: None,
90        })
91    }
92}
93
94#[cfg(test)]
95mod tests {
96    use crate::rpc::types::{Log, RpcAddress};
97    use cfx_addr::Network;
98    use cfx_types::{Space, H160, H256, U256};
99    use serde_json;
100    use std::str::FromStr;
101
102    #[test]
103    fn log_serialization() {
104        let s = r#"{"address":"CFXTEST:TYPE.USER:AAK3WAKCPSF3CP0MFHDWHTTUG924VERHBUV9NMM3YC","topics":["0xa6697e974e6a320f454390be03f74955e8978f1a6971ea6730542e37b66179bc","0x4861736852656700000000000000000000000000000000000000000000000000"],"data":"0x","blockHash":"0xed76641c68a1c641aee09a94b3b471f4dc0316efe5ac19cf488e2674cf8d05b5","epochNumber":"0x4510c","transactionHash":"0x0000000000000000000000000000000000000000000000000000000000000000","transactionIndex":"0x0","logIndex":"0x1","transactionLogIndex":"0x1","space":"evm"}"#;
105
106        let log = Log {
107            address: RpcAddress::try_from_h160(H160::from_str("13990122638b9132ca29c723bdf037f1a891a70c").unwrap(), Network::Test).unwrap(),
108            topics: vec![
109                H256::from_str("a6697e974e6a320f454390be03f74955e8978f1a6971ea6730542e37b66179bc").unwrap(),
110                H256::from_str("4861736852656700000000000000000000000000000000000000000000000000").unwrap(),
111            ],
112            data: vec![].into(),
113            block_hash: Some(H256::from_str("ed76641c68a1c641aee09a94b3b471f4dc0316efe5ac19cf488e2674cf8d05b5").unwrap()),
114            epoch_number: Some(U256::from(0x4510c)),
115            transaction_hash: Some(H256::default()),
116            transaction_index: Some(U256::default()),
117            transaction_log_index: Some(1.into()),
118            log_index: Some(U256::from(1)),
119            space: Some(Space::Ethereum),
120            block_timestamp: None,
121        };
122
123        let serialized = serde_json::to_string(&log).unwrap();
124        assert_eq!(serialized, s);
125    }
126}
client/rpc/types/cfx/log.rs

client/rpc/types/cfx/
log.rs
