1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
/*
*
* Hedera Rust SDK
*
* Copyright (C) 2022 - 2023 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
use std::collections::HashMap;
use hedera_proto::services;
use time::OffsetDateTime;
use crate::{
AccountId,
AssessedCustomFee,
ContractFunctionResult,
EvmAddress,
FromProtobuf,
Hbar,
PublicKey,
ScheduleId,
Tinybar,
TokenAssociation,
TokenId,
TokenNftTransfer,
TransactionId,
TransactionReceipt,
Transfer,
};
/// The complete record for a transaction on Hedera that has reached consensus.
/// Response from [`TransactionRecordQuery`][crate::TransactionRecordQuery].
#[derive(Debug, Clone)]
pub struct TransactionRecord {
/// The status (reach consensus, or failed, or is unknown) and the ID of
/// any new account/file/instance created.
pub receipt: TransactionReceipt,
/// The hash of the Transaction that executed (not the hash of any Transaction that failed for
/// having a duplicate TransactionID).
pub transaction_hash: Vec<u8>,
/// The consensus timestamp.
pub consensus_timestamp: OffsetDateTime,
/// Record of the value returned by the smart contract function or constructor.
pub contract_function_result: Option<ContractFunctionResult>,
/// All hbar transfers as a result of this transaction, such as fees, or
/// transfers performed by the transaction, or by a smart contract it calls,
/// or by the creation of threshold records that it triggers.
pub transfers: Vec<Transfer>,
/// All fungible token transfers as a result of this transaction.
pub token_transfers: HashMap<TokenId, HashMap<AccountId, i64>>,
/// All NFT Token transfers as a result of this transaction.
pub token_nft_transfers: HashMap<TokenId, Vec<TokenNftTransfer>>,
/// The ID of the transaction this record represents.
pub transaction_id: TransactionId,
/// The memo that was submitted as part of the transaction.
pub transaction_memo: String,
/// The actual transaction fee charged.
pub transaction_fee: Hbar,
/// Reference to the scheduled transaction ID that this transaction record represents.
pub schedule_ref: Option<ScheduleId>,
/// All custom fees that were assessed during a [`TransferTransaction`](crate::TransferTransaction), and must be paid if the
/// transaction status resolved to SUCCESS.
pub assessed_custom_fees: Vec<AssessedCustomFee>,
/// All token associations implicitly created while handling this transaction
pub automatic_token_associations: Vec<TokenAssociation>,
/// In the record of an internal transaction, the consensus timestamp of the user
/// transaction that spawned it.
pub parent_consensus_timestamp: Option<OffsetDateTime>,
/// In the record of an internal CryptoCreate transaction triggered by a user
/// transaction with a (previously unused) alias, the new account's alias.
pub alias_key: Option<PublicKey>,
/// The records of processing all child transaction spawned by the transaction with the given
/// top-level id, in consensus order. Always empty if the top-level status is UNKNOWN.
pub children: Vec<Self>,
/// The records of processing all consensus transaction with the same id as the distinguished
/// record above, in chronological order.
pub duplicates: Vec<Self>,
/// The keccak256 hash of the ethereumData. This field will only be populated for
/// `EthereumTransaction`.
#[cfg_attr(feature = "ffi", serde(with = "serde_with::As::<serde_with::base64::Base64>"))]
pub ethereum_hash: Vec<u8>,
/// In the record of a PRNG transaction with no output range, a pseudorandom 384-bit string.
#[cfg_attr(
feature = "ffi",
serde(with = "serde_with::As::<Option<serde_with::base64::Base64>>")
)]
pub prng_bytes: Option<Vec<u8>>,
/// In the record of a PRNG transaction with an output range, the output of a PRNG
/// whose input was a 384-bit string.
pub prng_number: Option<u32>,
/// The last 20 bytes of the keccak-256 hash of a ECDSA_SECP256K1 primitive key.
pub evm_address: Option<EvmAddress>,
}
// TODO: paid_staking_rewards
impl TransactionRecord {
fn from_protobuf(
record: services::TransactionRecord,
duplicates: Vec<Self>,
children: Vec<Self>,
) -> crate::Result<Self> {
use services::transaction_record::Body;
let receipt = pb_getf!(record, receipt)?;
let receipt = TransactionReceipt::from_protobuf(receipt)?;
let consensus_timestamp = pb_getf!(record, consensus_timestamp)?;
let transaction_id = pb_getf!(record, transaction_id)?;
let schedule_ref = Option::from_protobuf(record.schedule_ref)?;
let parent_consensus_timestamp = record.parent_consensus_timestamp.map(Into::into);
let alias_key =
(!record.alias.is_empty()).then(|| PublicKey::from_bytes(&record.alias)).transpose()?;
let automatic_token_associations = Vec::from_protobuf(record.automatic_token_associations)?;
let contract_function_result = record.body.map(|it| match it {
Body::ContractCallResult(it) | Body::ContractCreateResult(it) => it,
});
let contract_function_result = Option::from_protobuf(contract_function_result)?;
let transfers = record.transfer_list.map_or_else(Vec::new, |it| it.account_amounts);
let transfers = Vec::from_protobuf(transfers)?;
let (token_transfers, token_nft_transfers) = {
let mut token_transfers = HashMap::with_capacity(record.token_transfer_lists.len());
let mut token_nft_transfers: HashMap<TokenId, Vec<TokenNftTransfer>> =
HashMap::with_capacity(record.token_transfer_lists.len());
for transfer_list in record.token_transfer_lists {
let token_id = pb_getf!(transfer_list, token)?;
let token_id = TokenId::from_protobuf(token_id)?;
// `.insert` would be the most idiomatic way, but this matches behavior with Java.
let token_transfers = token_transfers
.entry(token_id)
.or_insert_with(|| HashMap::with_capacity(transfer_list.transfers.len()));
for it in transfer_list.transfers {
let account_id = AccountId::from_protobuf(pb_getf!(it, account_id)?)?;
token_transfers.insert(account_id, it.amount);
}
let nft_transfers: Result<Vec<_>, _> = transfer_list
.nft_transfers
.into_iter()
.map(|it| TokenNftTransfer::from_protobuf(it, token_id))
.collect();
let nft_transfers = nft_transfers?;
token_nft_transfers.entry(token_id).or_default().extend_from_slice(&nft_transfers);
}
(token_transfers, token_nft_transfers)
};
let evm_address = if record.evm_address.is_empty() {
None
} else {
Some(EvmAddress::try_from(record.evm_address)?)
};
let (prng_bytes, prng_number) = match record.entropy {
Some(services::transaction_record::Entropy::PrngBytes(it)) => (Some(it), None),
Some(services::transaction_record::Entropy::PrngNumber(it)) => (None, Some(it as u32)),
None => (None, None),
};
Ok(Self {
receipt,
transaction_hash: record.transaction_hash,
consensus_timestamp: consensus_timestamp.into(),
contract_function_result,
transaction_id: TransactionId::from_protobuf(transaction_id)?,
transaction_memo: record.memo,
transaction_fee: Hbar::from_tinybars(record.transaction_fee as Tinybar),
schedule_ref,
automatic_token_associations,
parent_consensus_timestamp,
duplicates,
ethereum_hash: record.ethereum_hash,
children,
alias_key,
transfers,
token_transfers,
token_nft_transfers,
assessed_custom_fees: Vec::from_protobuf(record.assessed_custom_fees)?,
evm_address,
prng_bytes,
prng_number,
})
}
}
impl FromProtobuf<services::response::Response> for TransactionRecord {
fn from_protobuf(pb: services::response::Response) -> crate::Result<Self>
where
Self: Sized,
{
let pb = pb_getv!(pb, TransactionGetRecord, services::response::Response);
let record = pb_getf!(pb, transaction_record)?;
let duplicates = Vec::from_protobuf(pb.duplicate_transaction_records)?;
let children = Vec::from_protobuf(pb.child_transaction_records)?;
Self::from_protobuf(record, duplicates, children)
}
}
impl FromProtobuf<services::TransactionRecord> for TransactionRecord {
fn from_protobuf(receipt: services::TransactionRecord) -> crate::Result<Self>
where
Self: Sized,
{
Self::from_protobuf(receipt, Vec::new(), Vec::new())
}
}