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