openethereum/crates/rpc/src/v1/types/transaction.rs

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.

// OpenEthereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// OpenEthereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.

use std::sync::Arc;

use ethcore::{contract_address, CreateContractAddress};
use ethereum_types::{H160, H256, H512, U256, U64};
use miner;
use serde::{ser::SerializeStruct, Serialize, Serializer};
use types::transaction::{
    Action, LocalizedTransaction, PendingTransaction, SignedTransaction, TypedTransaction,
    TypedTxId,
};
use v1::types::{AccessList, Bytes, TransactionCondition};

/// Transaction
#[derive(Debug, Default, Clone, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Transaction {
    /// transaction type
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub transaction_type: Option<U64>,
    /// Hash
    pub hash: H256,
    /// Nonce
    pub nonce: U256,
    /// Block hash
    pub block_hash: Option<H256>,
    /// Block number
    pub block_number: Option<U256>,
    /// Transaction Index
    pub transaction_index: Option<U256>,
    /// Sender
    pub from: H160,
    /// Recipient
    pub to: Option<H160>,
    /// Transfered value
    pub value: U256,
    /// Gas Price
    pub gas_price: U256,
    /// Max fee per gas
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_fee_per_gas: Option<U256>,
    /// Gas
    pub gas: U256,
    /// Data
    pub input: Bytes,
    /// Creates contract
    pub creates: Option<H160>,
    /// Raw transaction data
    pub raw: Bytes,
    /// Public key of the signer.
    pub public_key: Option<H512>,
    /// The network id of the transaction, if any.
    pub chain_id: Option<U64>,
    /// The standardised V field of the signature (0 or 1). Used by legacy transaction
    #[serde(skip_serializing_if = "Option::is_none")]
    pub standard_v: Option<U256>,
    /// The standardised V field of the signature.
    pub v: U256,
    /// The R field of the signature.
    pub r: U256,
    /// The S field of the signature.
    pub s: U256,
    /// Transaction activates at specified block.
    pub condition: Option<TransactionCondition>,
    /// optional access list
    #[serde(skip_serializing_if = "Option::is_none")]
    pub access_list: Option<AccessList>,
    /// miner bribe
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_priority_fee_per_gas: Option<U256>,
}

/// Local Transaction Status
#[derive(Debug)]
pub enum LocalTransactionStatus {
    /// Transaction is pending
    Pending,
    /// Transaction is in future part of the queue
    Future,
    /// Transaction was mined.
    Mined(Transaction),
    /// Transaction was removed from the queue, but not mined.
    Culled(Transaction),
    /// Transaction was dropped because of limit.
    Dropped(Transaction),
    /// Transaction was replaced by transaction with higher gas price.
    Replaced(Transaction, U256, H256),
    /// Transaction never got into the queue.
    Rejected(Transaction, String),
    /// Transaction is invalid.
    Invalid(Transaction),
    /// Transaction was canceled.
    Canceled(Transaction),
}

impl Serialize for LocalTransactionStatus {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        use self::LocalTransactionStatus::*;

        let elems = match *self {
            Pending | Future => 1,
            Mined(..) | Culled(..) | Dropped(..) | Invalid(..) | Canceled(..) => 2,
            Rejected(..) => 3,
            Replaced(..) => 4,
        };

        let status = "status";
        let transaction = "transaction";

        let mut struc = serializer.serialize_struct("LocalTransactionStatus", elems)?;
        match *self {
            Pending => struc.serialize_field(status, "pending")?,
            Future => struc.serialize_field(status, "future")?,
            Mined(ref tx) => {
                struc.serialize_field(status, "mined")?;
                struc.serialize_field(transaction, tx)?;
            }
            Culled(ref tx) => {
                struc.serialize_field(status, "culled")?;
                struc.serialize_field(transaction, tx)?;
            }
            Dropped(ref tx) => {
                struc.serialize_field(status, "dropped")?;
                struc.serialize_field(transaction, tx)?;
            }
            Canceled(ref tx) => {
                struc.serialize_field(status, "canceled")?;
                struc.serialize_field(transaction, tx)?;
            }
            Invalid(ref tx) => {
                struc.serialize_field(status, "invalid")?;
                struc.serialize_field(transaction, tx)?;
            }
            Rejected(ref tx, ref reason) => {
                struc.serialize_field(status, "rejected")?;
                struc.serialize_field(transaction, tx)?;
                struc.serialize_field("error", reason)?;
            }
            Replaced(ref tx, ref gas_price, ref hash) => {
                struc.serialize_field(status, "replaced")?;
                struc.serialize_field(transaction, tx)?;
                struc.serialize_field("hash", hash)?;
                struc.serialize_field("gasPrice", gas_price)?;
            }
        }

        struc.end()
    }
}

/// Geth-compatible output for eth_signTransaction method
#[derive(Debug, Default, Clone, PartialEq, Serialize)]
pub struct RichRawTransaction {
    /// Raw transaction RLP
    pub raw: Bytes,
    /// Transaction details
    #[serde(rename = "tx")]
    pub transaction: Transaction,
}

impl RichRawTransaction {
    /// Creates new `RichRawTransaction` from `SignedTransaction`.
    pub fn from_signed(tx: SignedTransaction) -> Self {
        let tx = Transaction::from_signed(tx);
        RichRawTransaction {
            raw: tx.raw.clone(),
            transaction: tx,
        }
    }
}

impl Transaction {
    /// Convert `LocalizedTransaction` into RPC Transaction.
    pub fn from_localized(mut t: LocalizedTransaction, base_fee: Option<U256>) -> Transaction {
        let signature = t.signature();
        let scheme = CreateContractAddress::FromSenderAndNonce;

        let access_list = match t.as_unsigned() {
            TypedTransaction::AccessList(tx) => {
                Some(tx.access_list.clone().into_iter().map(Into::into).collect())
            }
            TypedTransaction::EIP1559Transaction(tx) => Some(
                tx.transaction
                    .access_list
                    .clone()
                    .into_iter()
                    .map(Into::into)
                    .collect(),
            ),
            TypedTransaction::Legacy(_) => None,
        };

        let (max_fee_per_gas, max_priority_fee_per_gas) =
            if let TypedTransaction::EIP1559Transaction(tx) = t.as_unsigned() {
                (Some(tx.tx().gas_price), Some(tx.max_priority_fee_per_gas))
            } else {
                (None, None)
            };

        let standard_v = if t.tx_type() == TypedTxId::Legacy {
            Some(t.standard_v())
        } else {
            None
        };

        Transaction {
            hash: t.hash(),
            nonce: t.tx().nonce,
            block_hash: Some(t.block_hash),
            block_number: Some(t.block_number.into()),
            transaction_index: Some(t.transaction_index.into()),
            from: t.sender(),
            to: match t.tx().action {
                Action::Create => None,
                Action::Call(ref address) => Some(*address),
            },
            value: t.tx().value,
            gas_price: t.effective_gas_price(base_fee),
            max_fee_per_gas,
            gas: t.tx().gas,
            input: Bytes::new(t.tx().data.clone()),
            creates: match t.tx().action {
                Action::Create => {
                    Some(contract_address(scheme, &t.sender(), &t.tx().nonce, &t.tx().data).0)
                }
                Action::Call(_) => None,
            },
            raw: Bytes::new(t.signed.encode()),
            public_key: t.recover_public().ok().map(Into::into),
            chain_id: t.chain_id().map(U64::from),
            standard_v: standard_v.map(Into::into),
            v: t.v().into(),
            r: signature.r().into(),
            s: signature.s().into(),
            condition: None,
            transaction_type: t.signed.tx_type().to_U64_option_id(),
            access_list,
            max_priority_fee_per_gas,
        }
    }

    /// Convert `SignedTransaction` into RPC Transaction.
    pub fn from_signed(t: SignedTransaction) -> Transaction {
        let signature = t.signature();
        let scheme = CreateContractAddress::FromSenderAndNonce;

        let access_list = match t.as_unsigned() {
            TypedTransaction::AccessList(tx) => {
                Some(tx.access_list.clone().into_iter().map(Into::into).collect())
            }
            TypedTransaction::EIP1559Transaction(tx) => Some(
                tx.transaction
                    .access_list
                    .clone()
                    .into_iter()
                    .map(Into::into)
                    .collect(),
            ),
            TypedTransaction::Legacy(_) => None,
        };

        let (max_fee_per_gas, max_priority_fee_per_gas) =
            if let TypedTransaction::EIP1559Transaction(tx) = t.as_unsigned() {
                (Some(tx.tx().gas_price), Some(tx.max_priority_fee_per_gas))
            } else {
                (None, None)
            };

        let standard_v = if t.tx_type() == TypedTxId::Legacy {
            Some(t.standard_v())
        } else {
            None
        };

        Transaction {
            hash: t.hash(),
            nonce: t.tx().nonce,
            block_hash: None,
            block_number: None,
            transaction_index: None,
            from: t.sender(),
            to: match t.tx().action {
                Action::Create => None,
                Action::Call(ref address) => Some(*address),
            },
            value: t.tx().value,
            gas_price: t.tx().gas_price,
            max_fee_per_gas,
            gas: t.tx().gas,
            input: Bytes::new(t.tx().data.clone()),
            creates: match t.tx().action {
                Action::Create => {
                    Some(contract_address(scheme, &t.sender(), &t.tx().nonce, &t.tx().data).0)
                }
                Action::Call(_) => None,
            },
            raw: t.encode().into(),
            public_key: t.public_key().map(Into::into),
            chain_id: t.chain_id().map(U64::from),
            standard_v: standard_v.map(Into::into),
            v: t.v().into(),
            r: signature.r().into(),
            s: signature.s().into(),
            condition: None,
            transaction_type: t.tx_type().to_U64_option_id(),
            access_list,
            max_priority_fee_per_gas,
        }
    }

    /// Convert `PendingTransaction` into RPC Transaction.
    pub fn from_pending(t: PendingTransaction) -> Transaction {
        let mut r = Transaction::from_signed(t.transaction);
        r.condition = r.condition.map(Into::into);
        r
    }
}

impl LocalTransactionStatus {
    /// Convert `LocalTransactionStatus` into RPC `LocalTransactionStatus`.
    pub fn from(s: miner::pool::local_transactions::Status) -> Self {
        let convert = |tx: Arc<miner::pool::VerifiedTransaction>| {
            Transaction::from_signed(tx.signed().clone())
        };
        use miner::pool::local_transactions::Status::*;
        match s {
            Pending(_) => LocalTransactionStatus::Pending,
            Mined(tx) => LocalTransactionStatus::Mined(convert(tx)),
            Culled(tx) => LocalTransactionStatus::Culled(convert(tx)),
            Dropped(tx) => LocalTransactionStatus::Dropped(convert(tx)),
            Rejected(tx, reason) => LocalTransactionStatus::Rejected(convert(tx), reason),
            Invalid(tx) => LocalTransactionStatus::Invalid(convert(tx)),
            Canceled(tx) => LocalTransactionStatus::Canceled(convert(tx)),
            Replaced { old, new } => LocalTransactionStatus::Replaced(
                convert(old),
                new.signed().tx().gas_price,
                new.signed().hash(),
            ),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{LocalTransactionStatus, Transaction};
    use ethereum_types::H256;
    use serde_json;
    use types::transaction::TypedTxId;
    use v1::types::AccessListItem;

    #[test]
    fn test_transaction_serialize() {
        let mut t = Transaction::default();
        t.transaction_type = TypedTxId::AccessList.to_U64_option_id();
        t.access_list = Some(vec![AccessListItem::default()]);
        let serialized = serde_json::to_string(&t).unwrap();
        assert_eq!(
            serialized,
            r#"{"type":"0x1","hash":"0x0000000000000000000000000000000000000000000000000000000000000000","nonce":"0x0","blockHash":null,"blockNumber":null,"transactionIndex":null,"from":"0x0000000000000000000000000000000000000000","to":null,"value":"0x0","gasPrice":"0x0","gas":"0x0","input":"0x","creates":null,"raw":"0x","publicKey":null,"chainId":null,"v":"0x0","r":"0x0","s":"0x0","condition":null,"accessList":[{"address":"0x0000000000000000000000000000000000000000","storageKeys":[]}]}"#
        );
    }

    #[test]
    fn test_local_transaction_status_serialize() {
        let tx_ser = serde_json::to_string(&Transaction::default()).unwrap();
        let status1 = LocalTransactionStatus::Pending;
        let status2 = LocalTransactionStatus::Future;
        let status3 = LocalTransactionStatus::Mined(Transaction::default());
        let status4 = LocalTransactionStatus::Dropped(Transaction::default());
        let status5 = LocalTransactionStatus::Invalid(Transaction::default());
        let status6 =
            LocalTransactionStatus::Rejected(Transaction::default(), "Just because".into());
        let status7 = LocalTransactionStatus::Replaced(
            Transaction::default(),
            5.into(),
            H256::from_low_u64_be(10),
        );

        assert_eq!(
            serde_json::to_string(&status1).unwrap(),
            r#"{"status":"pending"}"#
        );
        assert_eq!(
            serde_json::to_string(&status2).unwrap(),
            r#"{"status":"future"}"#
        );
        assert_eq!(
            serde_json::to_string(&status3).unwrap(),
            r#"{"status":"mined","transaction":"#.to_owned() + &format!("{}", tx_ser) + r#"}"#
        );
        assert_eq!(
            serde_json::to_string(&status4).unwrap(),
            r#"{"status":"dropped","transaction":"#.to_owned() + &format!("{}", tx_ser) + r#"}"#
        );
        assert_eq!(
            serde_json::to_string(&status5).unwrap(),
            r#"{"status":"invalid","transaction":"#.to_owned() + &format!("{}", tx_ser) + r#"}"#
        );
        assert_eq!(
            serde_json::to_string(&status6).unwrap(),
            r#"{"status":"rejected","transaction":"#.to_owned()
                + &format!("{}", tx_ser)
                + r#","error":"Just because"}"#
        );
        assert_eq!(
            serde_json::to_string(&status7).unwrap(),
            r#"{"status":"replaced","transaction":"#.to_owned()
                + &format!("{}", tx_ser)
                + r#","hash":"0x000000000000000000000000000000000000000000000000000000000000000a","gasPrice":"0x5"}"#
        );
    }
}