parity-zcash/rpc/src/v1/impls/raw.rs

use jsonrpc_core::Error;
use ser::{deserialize, serialize, Reader};
use v1::helpers::errors::{execution, invalid_params};
use v1::traits::Raw;
use v1::types::H256;
use v1::types::{
    GetRawTransactionResponse, RawTransaction, Transaction, TransactionInput, TransactionOutput,
    TransactionOutputs,
};
use zebra_chain::{
    IndexedTransaction as GlobalIndexedTransaction, Transaction as GlobalTransaction,
    SAPLING_TX_VERSION, SAPLING_TX_VERSION_GROUP_ID,
};
use zebra_primitives::bytes::Bytes as GlobalBytes;
use zebra_primitives::hash::H256 as GlobalH256;
use zebra_sync;

/// Default expiry height delta (best blocks number + height in blocks) for transactions
/// created by `createrawtransaction` RPC.
const DEFAULT_TX_EXPIRY_DELTA: u32 = 20;

pub struct RawClient<T: RawClientCoreApi> {
    core: T,
}

pub trait RawClientCoreApi: Send + Sync + 'static {
    fn accept_transaction(&self, transaction: GlobalTransaction) -> Result<GlobalH256, String>;
    fn create_raw_transaction(
        &self,
        inputs: Vec<TransactionInput>,
        outputs: TransactionOutputs,
        lock_time: Option<u32>,
        expiry_height: Option<u32>,
    ) -> Result<GlobalTransaction, String>;
}

pub struct RawClientCore {
    local_sync_node: zebra_sync::LocalNodeRef,
}

impl RawClientCore {
    pub fn new(local_sync_node: zebra_sync::LocalNodeRef) -> Self {
        RawClientCore {
            local_sync_node: local_sync_node,
        }
    }

    pub fn do_create_raw_transaction(
        best_block_number: u32,
        inputs: Vec<TransactionInput>,
        outputs: TransactionOutputs,
        lock_time: Option<u32>,
        expiry_height: Option<u32>,
    ) -> Result<GlobalTransaction, String> {
        use global_script::Builder as ScriptBuilder;

        // overwinter is active atm => assume that all new transactions are created for sapling era
        let version = SAPLING_TX_VERSION;
        let version_group_id = SAPLING_TX_VERSION_GROUP_ID;

        // to make lock_time work at least one input must have sequence < SEQUENCE_FINAL
        let lock_time = lock_time.unwrap_or_default();
        let default_sequence = if lock_time != 0 {
            zebra_chain::constants::SEQUENCE_FINAL - 1
        } else {
            zebra_chain::constants::SEQUENCE_FINAL
        };

        // by default we're creating transactions that are expired in DEFAULT_TX_EXPIRY_DELTA blocks
        let expiry_height =
            expiry_height.unwrap_or_else(|| best_block_number + DEFAULT_TX_EXPIRY_DELTA);

        // prepare inputs
        let inputs: Vec<_> = inputs
            .into_iter()
            .map(|input| zebra_chain::TransactionInput {
                previous_output: zebra_chain::OutPoint {
                    hash: Into::<GlobalH256>::into(input.txid).reversed(),
                    index: input.vout,
                },
                script_sig: GlobalBytes::new(), // default script
                sequence: input.sequence.unwrap_or(default_sequence),
            })
            .collect();

        // prepare outputs
        let outputs: Vec<_> = outputs
            .outputs
            .into_iter()
            .map(|output| match output {
                TransactionOutput::Address(with_address) => {
                    let amount_in_satoshis = (with_address.amount
                        * (zebra_chain::constants::SATOSHIS_IN_COIN as f64))
                        as u64;
                    let script = match with_address.address.kind {
                        zebra_keys::Type::P2PKH => {
                            ScriptBuilder::build_p2pkh(&with_address.address.hash)
                        }
                        zebra_keys::Type::P2SH => {
                            ScriptBuilder::build_p2sh(&with_address.address.hash)
                        }
                    };

                    zebra_chain::TransactionOutput {
                        value: amount_in_satoshis,
                        script_pubkey: script.to_bytes(),
                    }
                }
                TransactionOutput::ScriptData(with_script_data) => {
                    let script = ScriptBuilder::default()
                        .return_bytes(&*with_script_data.script_data)
                        .into_script();

                    zebra_chain::TransactionOutput {
                        value: 0,
                        script_pubkey: script.to_bytes(),
                    }
                }
            })
            .collect();

        // now construct && serialize transaction
        let transaction = GlobalTransaction {
            overwintered: true,
            version: version,
            version_group_id: version_group_id,
            inputs: inputs,
            outputs: outputs,
            lock_time: lock_time,
            expiry_height: expiry_height,
            ..Default::default()
        };

        Ok(transaction)
    }
}

impl RawClientCoreApi for RawClientCore {
    fn accept_transaction(&self, transaction: GlobalTransaction) -> Result<GlobalH256, String> {
        self.local_sync_node
            .accept_transaction(GlobalIndexedTransaction::from_raw(transaction))
    }

    fn create_raw_transaction(
        &self,
        inputs: Vec<TransactionInput>,
        outputs: TransactionOutputs,
        lock_time: Option<u32>,
        expiry_height: Option<u32>,
    ) -> Result<GlobalTransaction, String> {
        RawClientCore::do_create_raw_transaction(
            self.local_sync_node.best_block_number(),
            inputs,
            outputs,
            lock_time,
            expiry_height,
        )
    }
}

impl<T> RawClient<T>
where
    T: RawClientCoreApi,
{
    pub fn new(core: T) -> Self {
        RawClient { core: core }
    }
}

impl<T> Raw for RawClient<T>
where
    T: RawClientCoreApi,
{
    fn send_raw_transaction(&self, raw_transaction: RawTransaction) -> Result<H256, Error> {
        let raw_transaction_data: Vec<u8> = raw_transaction.into();
        let transaction =
            try!(deserialize(Reader::new(&raw_transaction_data))
                .map_err(|e| invalid_params("tx", e)));
        self.core
            .accept_transaction(transaction)
            .map(|h| h.reversed().into())
            .map_err(|e| execution(e))
    }

    fn create_raw_transaction(
        &self,
        inputs: Vec<TransactionInput>,
        outputs: TransactionOutputs,
        lock_time: Option<u32>,
        expiry_height: Option<u32>,
    ) -> Result<RawTransaction, Error> {
        // reverse hashes of inputs
        let inputs: Vec<_> = inputs
            .into_iter()
            .map(|mut input| {
                input.txid = input.txid.reversed();
                input
            })
            .collect();

        let transaction = self
            .core
            .create_raw_transaction(inputs, outputs, lock_time, expiry_height)
            .map_err(|e| execution(e))?;
        let transaction = serialize(&transaction);
        Ok(transaction.into())
    }

    fn decode_raw_transaction(&self, _transaction: RawTransaction) -> Result<Transaction, Error> {
        rpc_unimplemented!()
    }

    fn get_raw_transaction(
        &self,
        _hash: H256,
        _verbose: Option<bool>,
    ) -> Result<GetRawTransactionResponse, Error> {
        rpc_unimplemented!()
    }
}

#[cfg(test)]
pub mod tests {
    use super::*;
    use jsonrpc_core::IoHandler;
    use v1::traits::Raw;
    use v1::types::{TransactionInput, TransactionOutputs};
    use zebra_chain::Transaction;
    use zebra_primitives::hash::H256 as GlobalH256;

    #[derive(Default)]
    struct SuccessRawClientCore;
    #[derive(Default)]
    struct ErrorRawClientCore;

    impl RawClientCoreApi for SuccessRawClientCore {
        fn accept_transaction(&self, transaction: Transaction) -> Result<GlobalH256, String> {
            Ok(transaction.hash())
        }

        fn create_raw_transaction(
            &self,
            _inputs: Vec<TransactionInput>,
            _outputs: TransactionOutputs,
            _lock_time: Option<u32>,
            _expiry_height: Option<u32>,
        ) -> Result<Transaction, String> {
            Ok("0100000001ad9d38823d95f31dc6c0cb0724c11a3cf5a466ca4147254a10cd94aade6eb5b3230000006b483045022100b7683165c3ecd57b0c44bf6a0fb258dc08c328458321c8fadc2b9348d4e66bd502204fd164c58d1a949a4d39bb380f8f05c9f6b3e9417f06bf72e5c068428ca3578601210391c35ac5ee7cf82c5015229dcff89507f83f9b8c952b8fecfa469066c1cb44ccffffffff0170f30500000000001976a914801da3cb2ed9e44540f4b982bde07cd3fbae264288ac00000000".into())
        }
    }

    impl RawClientCoreApi for ErrorRawClientCore {
        fn accept_transaction(&self, _transaction: Transaction) -> Result<GlobalH256, String> {
            Err("error".to_owned())
        }

        fn create_raw_transaction(
            &self,
            _inputs: Vec<TransactionInput>,
            _outputs: TransactionOutputs,
            _lock_time: Option<u32>,
            _expiry_height: Option<u32>,
        ) -> Result<Transaction, String> {
            Err("error".to_owned())
        }
    }

    #[test]
    fn sendrawtransaction_accepted() {
        let client = RawClient::new(SuccessRawClientCore::default());
        let mut handler = IoHandler::new();
        handler.extend_with(client.to_delegate());

        let sample = handler.handle_request_sync(&(r#"
			{
				"jsonrpc": "2.0",
				"method": "sendrawtransaction",
				"params": ["00000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a0000000000000000000101000000000000000000000000"],
				"id": 1
			}"#)
		).unwrap();

        // direct hash is 0791efccd035c5fe501023ff888106eba5eff533965de4a6e06400f623bcac34
        // but client expects reverse hash
        assert_eq!(r#"{"jsonrpc":"2.0","result":"34acbc23f60064e0a6e45d9633f5efa5eb068188ff231050fec535d0ccef9107","id":1}"#, &sample);
    }

    #[test]
    fn sendrawtransaction_rejected() {
        let client = RawClient::new(ErrorRawClientCore::default());
        let mut handler = IoHandler::new();
        handler.extend_with(client.to_delegate());

        let sample = handler.handle_request_sync(&(r#"
			{
				"jsonrpc": "2.0",
				"method": "sendrawtransaction",
				"params": ["00000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a0000000000000000000101000000000000000000000000"],
				"id": 1
			}"#)
		).unwrap();

        assert_eq!(r#"{"jsonrpc":"2.0","error":{"code":-32015,"message":"Execution error.","data":"\"error\""},"id":1}"#, &sample);
    }

    #[test]
    fn createrawtransaction_success() {
        let client = RawClient::new(SuccessRawClientCore::default());
        let mut handler = IoHandler::new();
        handler.extend_with(client.to_delegate());

        let sample = handler.handle_request_sync(&(r#"
			{
				"jsonrpc": "2.0",
				"method": "createrawtransaction",
				"params": [[{"txid":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","vout":0}],{"t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi":0.01}],
				"id": 1
			}"#)
		).unwrap();

        assert_eq!(r#"{"jsonrpc":"2.0","result":"0100000001ad9d38823d95f31dc6c0cb0724c11a3cf5a466ca4147254a10cd94aade6eb5b3230000006b483045022100b7683165c3ecd57b0c44bf6a0fb258dc08c328458321c8fadc2b9348d4e66bd502204fd164c58d1a949a4d39bb380f8f05c9f6b3e9417f06bf72e5c068428ca3578601210391c35ac5ee7cf82c5015229dcff89507f83f9b8c952b8fecfa469066c1cb44ccffffffff0170f30500000000001976a914801da3cb2ed9e44540f4b982bde07cd3fbae264288ac00000000","id":1}"#, &sample);
    }

    #[test]
    fn createrawtransaction_with_expiry_height_success() {
        let client = RawClient::new(SuccessRawClientCore::default());
        let mut handler = IoHandler::new();
        handler.extend_with(client.to_delegate());

        let sample = handler.handle_request_sync(&(r#"
			{
				"jsonrpc": "2.0",
				"method": "createrawtransaction",
				"params": [[{"txid":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","vout":0}],{"t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi":0.01}, 100, 200],
				"id": 1
			}"#)
		).unwrap();

        assert_eq!(r#"{"jsonrpc":"2.0","result":"0100000001ad9d38823d95f31dc6c0cb0724c11a3cf5a466ca4147254a10cd94aade6eb5b3230000006b483045022100b7683165c3ecd57b0c44bf6a0fb258dc08c328458321c8fadc2b9348d4e66bd502204fd164c58d1a949a4d39bb380f8f05c9f6b3e9417f06bf72e5c068428ca3578601210391c35ac5ee7cf82c5015229dcff89507f83f9b8c952b8fecfa469066c1cb44ccffffffff0170f30500000000001976a914801da3cb2ed9e44540f4b982bde07cd3fbae264288ac00000000","id":1}"#, &sample);
    }

    #[test]
    fn createrawtransaction_error() {
        let client = RawClient::new(ErrorRawClientCore::default());
        let mut handler = IoHandler::new();
        handler.extend_with(client.to_delegate());

        let sample = handler.handle_request_sync(&(r#"
			{
				"jsonrpc": "2.0",
				"method": "createrawtransaction",
				"params": [[{"txid":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","vout":0}],{"t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi":0.01}],
				"id": 1
			}"#)
		).unwrap();

        assert_eq!(r#"{"jsonrpc":"2.0","error":{"code":-32015,"message":"Execution error.","data":"\"error\""},"id":1}"#, &sample);
    }
}