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
/*
*
* 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 hedera_proto::services;
use hedera_proto::services::smart_contract_service_client::SmartContractServiceClient;
use tonic::transport::Channel;
use crate::ledger_id::RefLedgerId;
use crate::protobuf::FromProtobuf;
use crate::transaction::{
AnyTransactionData,
ChunkInfo,
ToTransactionDataProtobuf,
TransactionData,
TransactionExecute,
};
use crate::{
BoxGrpcFuture,
Error,
FileId,
Hbar,
ToProtobuf,
Transaction,
ValidateChecksums,
};
/// Submit an Ethereum transaction.
pub type EthereumTransaction = Transaction<EthereumTransactionData>;
#[derive(Debug, Default, Clone)]
pub struct EthereumTransactionData {
/// The raw Ethereum transaction (RLP encoded type 0, 1, and 2).
ethereum_data: Vec<u8>,
/// For large transactions (for example contract create) this should be used to
/// set the FileId of an HFS file containing the call_data
/// of the ethereum_data. The data in the ethereum_data will be re-written with
/// the call_data element as a zero length string with the original contents in
/// the referenced file at time of execution. The ethereum_data will need to be
/// "rehydrated" with the call_data for signature validation to pass.
call_data_file_id: Option<FileId>,
/// The maximum amount that the payer of the hedera transaction
/// is willing to pay to complete the transaction.
max_gas_allowance_hbar: Hbar,
}
impl EthereumTransaction {
/// Returns the raw Ethereum transaction (RLP encoded type 0, 1, and 2).
#[must_use]
pub fn get_ethereum_data(&self) -> &[u8] {
&self.data().ethereum_data
}
/// Sets the raw Ethereum transaction (RLP encoded type 0, 1, and 2).
pub fn ethereum_data(&mut self, data: Vec<u8>) -> &mut Self {
self.data_mut().ethereum_data = data;
self
}
/// Returns the file ID to find the raw Ethereum transaction (RLP encoded type 0, 1, and 2).
#[must_use]
pub fn get_call_data_file_id(&self) -> Option<FileId> {
self.data().call_data_file_id
}
/// Sets a file ID to find the raw Ethereum transaction (RLP encoded type 0, 1, and 2).
///
/// For large transactions (for example contract create) this should be used to
/// set the [`FileId`] of an HFS file containing the `call_data`
/// of the `ethereum_data`. The data in `the ethereum_data` will be re-written with
/// the `call_data` element as a zero length string with the original contents in
/// the referenced file at time of execution. `The ethereum_data` will need to be
/// "rehydrated" with the `call_data` for signature validation to pass.
pub fn call_data_file_id(&mut self, id: FileId) -> &mut Self {
self.data_mut().call_data_file_id = Some(id);
self
}
/// Returns the maximum amount that the payer of the hedera transaction
/// is willing to pay to complete the transaction.
#[must_use]
pub fn get_max_gas_allowance_hbar(&self) -> Hbar {
self.data().max_gas_allowance_hbar
}
/// Sets the maximum amount that the payer of the hedera transaction
/// is willing to pay to complete the transaction.
pub fn max_gas_allowance_hbar(&mut self, allowance: Hbar) -> &mut Self {
self.data_mut().max_gas_allowance_hbar = allowance;
self
}
}
impl TransactionData for EthereumTransactionData {}
impl TransactionExecute for EthereumTransactionData {
fn execute(
&self,
channel: Channel,
request: services::Transaction,
) -> BoxGrpcFuture<'_, services::TransactionResponse> {
Box::pin(async { SmartContractServiceClient::new(channel).call_ethereum(request).await })
}
}
impl ValidateChecksums for EthereumTransactionData {
fn validate_checksums(&self, ledger_id: &RefLedgerId) -> Result<(), Error> {
self.call_data_file_id.validate_checksums(ledger_id)
}
}
impl ToTransactionDataProtobuf for EthereumTransactionData {
fn to_transaction_data_protobuf(
&self,
chunk_info: &ChunkInfo,
) -> services::transaction_body::Data {
let _ = chunk_info.assert_single_transaction();
let call_data = self.call_data_file_id.to_protobuf();
services::transaction_body::Data::EthereumTransaction(services::EthereumTransactionBody {
ethereum_data: self.ethereum_data.clone(),
call_data,
max_gas_allowance: self.max_gas_allowance_hbar.to_tinybars(),
})
}
}
impl From<EthereumTransactionData> for AnyTransactionData {
fn from(transaction: EthereumTransactionData) -> Self {
Self::Ethereum(transaction)
}
}
impl FromProtobuf<services::EthereumTransactionBody> for EthereumTransactionData {
fn from_protobuf(pb: services::EthereumTransactionBody) -> crate::Result<Self> {
Ok(Self {
ethereum_data: pb.ethereum_data,
call_data_file_id: Option::from_protobuf(pb.call_data)?,
max_gas_allowance_hbar: Hbar::from_tinybars(pb.max_gas_allowance),
})
}
}
#[cfg(test)]
mod tests {
use expect_test::expect;
use crate::transaction::test_helpers::{
check_body,
transaction_body,
};
use crate::{
AnyTransaction,
EthereumTransaction,
};
fn make_transaction() -> EthereumTransaction {
let mut tx = EthereumTransaction::new_for_tests();
tx.ethereum_data(vec![0xde, 0xad, 0xbe, 0xef])
.call_data_file_id("4.5.6".parse().unwrap())
.max_gas_allowance_hbar("3".parse().unwrap())
.freeze()
.unwrap();
tx
}
#[test]
fn serialize() {
let tx = make_transaction();
let tx = transaction_body(tx);
let tx = check_body(tx);
expect![[r#"
EthereumTransaction(
EthereumTransactionBody {
ethereum_data: [
222,
173,
190,
239,
],
call_data: Some(
FileId {
shard_num: 4,
realm_num: 5,
file_num: 6,
},
),
max_gas_allowance: 300000000,
},
)
"#]]
.assert_debug_eq(&tx)
}
#[test]
fn to_from_bytes() {
let tx = make_transaction();
let tx2 = AnyTransaction::from_bytes(&tx.to_bytes().unwrap()).unwrap();
let tx = transaction_body(tx);
let tx2 = transaction_body(tx2);
assert_eq!(tx, tx2);
}
}