openethereum/ethcore/src/transaction.rs

320 lines
9.3 KiB
Rust
Raw Normal View History

2016-02-05 13:40:41 +01:00
// Copyright 2015, 2016 Ethcore (UK) Ltd.
// This file is part of Parity.
// Parity 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.
// Parity 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 Parity. If not, see <http://www.gnu.org/licenses/>.
2016-02-02 15:29:53 +01:00
//! Transaction data structure.
use util::*;
use error::*;
2016-01-12 01:30:30 +01:00
use evm::Schedule;
2015-12-09 00:45:33 +01:00
2016-02-08 15:53:22 +01:00
#[derive(Debug, Clone, PartialEq, Eq)]
/// Transaction action type.
2016-01-11 13:52:40 +01:00
pub enum Action {
/// Create creates new contract.
2016-01-11 13:52:40 +01:00
Create,
/// Calls contract at given address.
2016-01-11 13:52:40 +01:00
Call(Address),
2016-01-07 19:05:44 +01:00
}
impl Default for Action {
fn default() -> Action { Action::Create }
}
2016-02-04 23:48:29 +01:00
impl Decodable for Action {
fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
let rlp = decoder.as_rlp();
match rlp.is_empty() {
true => Ok(Action::Create),
false => Ok(Action::Call(try!(rlp.as_val())))
}
}
}
/// A set of information describing an externally-originating message call
/// or contract creation operation.
2016-02-08 15:53:22 +01:00
#[derive(Default, Debug, Clone, PartialEq, Eq)]
2015-12-09 00:45:33 +01:00
pub struct Transaction {
2016-02-02 15:55:44 +01:00
/// Nonce.
2016-01-07 19:05:44 +01:00
pub nonce: U256,
2016-02-02 15:55:44 +01:00
/// Gas price.
2016-01-07 19:05:44 +01:00
pub gas_price: U256,
2016-02-02 15:55:44 +01:00
/// Gas paid up front for transaction execution.
2016-01-07 19:05:44 +01:00
pub gas: U256,
2016-02-02 15:55:44 +01:00
/// Action, can be either call or contract create.
2016-01-11 15:23:27 +01:00
pub action: Action,
2016-02-02 15:55:44 +01:00
/// Transfered value.
2016-01-07 19:05:44 +01:00
pub value: U256,
2016-02-02 15:55:44 +01:00
/// Transaction data.
2016-01-11 15:23:27 +01:00
pub data: Bytes,
2015-12-09 00:45:33 +01:00
}
2016-01-07 19:05:44 +01:00
2016-01-11 20:36:29 +01:00
impl Transaction {
2016-02-04 17:23:53 +01:00
/// Append object with a without signature into RLP stream
pub fn rlp_append_unsigned_transaction(&self, s: &mut RlpStream) {
s.begin_list(6);
s.append(&self.nonce);
s.append(&self.gas_price);
s.append(&self.gas);
2016-01-11 13:52:40 +01:00
match self.action {
Action::Create => s.append_empty_data(),
2016-02-04 17:23:53 +01:00
Action::Call(ref to) => s.append(to)
2016-01-11 13:52:40 +01:00
};
s.append(&self.value);
s.append(&self.data);
2016-01-11 20:36:29 +01:00
}
}
2016-02-04 23:48:29 +01:00
impl FromJson for SignedTransaction {
fn from_json(json: &Json) -> SignedTransaction {
let t = Transaction {
2016-01-14 21:58:37 +01:00
nonce: xjson!(&json["nonce"]),
gas_price: xjson!(&json["gasPrice"]),
gas: xjson!(&json["gasLimit"]),
action: match Bytes::from_json(&json["to"]) {
2016-01-17 15:56:09 +01:00
ref x if x.is_empty() => Action::Create,
2016-01-14 21:58:37 +01:00
ref x => Action::Call(Address::from_slice(x)),
},
value: xjson!(&json["value"]),
data: xjson!(&json["data"]),
};
2016-02-04 23:48:29 +01:00
match json.find("secretKey") {
Some(&Json::String(ref secret_key)) => t.sign(&h256_from_hex(clean(secret_key))),
_ => SignedTransaction {
unsigned: t,
2016-02-04 23:48:29 +01:00
v: match json.find("v") { Some(ref j) => u16::from_json(j) as u8, None => 0 },
r: match json.find("r") { Some(j) => xjson!(j), None => x!(0) },
s: match json.find("s") { Some(j) => xjson!(j), None => x!(0) },
hash: RefCell::new(None),
sender: match json.find("sender") {
Some(&Json::String(ref sender)) => RefCell::new(Some(address_from_hex(clean(sender)))),
_ => RefCell::new(None),
}
}
2016-01-14 21:58:37 +01:00
}
}
}
impl Transaction {
2016-01-11 21:57:22 +01:00
/// The message hash of the transaction.
pub fn hash(&self) -> H256 {
2016-02-04 17:23:53 +01:00
let mut stream = RlpStream::new();
self.rlp_append_unsigned_transaction(&mut stream);
stream.out().sha3()
2016-01-12 18:10:10 +01:00
}
2016-01-12 01:30:30 +01:00
2016-01-12 17:40:34 +01:00
/// Signs the transaction as coming from `sender`.
2016-02-04 17:23:53 +01:00
pub fn sign(self, secret: &Secret) -> SignedTransaction {
let sig = ec::sign(secret, &self.hash());
2016-01-12 17:40:34 +01:00
let (r, s, v) = sig.unwrap().to_rsv();
2016-02-04 17:23:53 +01:00
SignedTransaction {
unsigned: self,
2016-02-04 17:23:53 +01:00
r: r,
s: s,
2016-02-04 23:48:29 +01:00
v: v + 27,
2016-02-04 17:23:53 +01:00
hash: RefCell::new(None),
sender: RefCell::new(None)
}
2016-01-12 17:40:34 +01:00
}
2016-02-04 23:48:29 +01:00
/// Useful for test incorrectly signed transactions.
#[cfg(test)]
2016-02-04 23:48:29 +01:00
pub fn fake_sign(self) -> SignedTransaction {
SignedTransaction {
unsigned: self,
2016-02-04 23:48:29 +01:00
r: U256::zero(),
s: U256::zero(),
v: 0,
hash: RefCell::new(None),
sender: RefCell::new(None)
}
2016-01-12 01:30:30 +01:00
}
2016-01-12 18:10:10 +01:00
2016-01-12 01:30:30 +01:00
/// Get the transaction cost in gas for the given params.
2016-01-12 17:40:34 +01:00
pub fn gas_required_for(is_create: bool, data: &[u8], schedule: &Schedule) -> u64 {
2016-01-12 01:30:30 +01:00
data.iter().fold(
2016-01-12 17:40:34 +01:00
(if is_create {schedule.tx_create_gas} else {schedule.tx_gas}) as u64,
|g, b| g + (match *b { 0 => schedule.tx_data_zero_gas, _ => schedule.tx_data_non_zero_gas }) as u64
2016-01-12 01:30:30 +01:00
)
}
/// Get the transaction cost in gas for this transaction.
2016-01-12 17:40:34 +01:00
pub fn gas_required(&self, schedule: &Schedule) -> u64 {
Self::gas_required_for(match self.action{Action::Create=>true, Action::Call(_)=>false}, &self.data, schedule)
}
2015-12-09 00:45:33 +01:00
}
2016-02-04 23:48:29 +01:00
2016-02-04 17:23:53 +01:00
2016-02-08 15:53:22 +01:00
#[derive(Debug, Clone, Eq)]
2016-02-04 17:23:53 +01:00
pub struct SignedTransaction {
2016-02-04 23:48:29 +01:00
/// Plain Transaction.
unsigned: Transaction,
2016-02-04 23:48:29 +01:00
/// The V field of the signature, either 27 or 28; helps describe the point on the curve.
2016-02-04 17:23:53 +01:00
v: u8,
2016-02-04 23:48:29 +01:00
/// The R field of the signature; helps describe the point on the curve.
2016-02-04 17:23:53 +01:00
r: U256,
2016-02-04 23:48:29 +01:00
/// The S field of the signature; helps describe the point on the curve.
2016-02-04 17:23:53 +01:00
s: U256,
2016-02-04 23:48:29 +01:00
/// Cached hash.
2016-02-04 17:23:53 +01:00
hash: RefCell<Option<H256>>,
2016-02-04 23:48:29 +01:00
/// Cached sender.
2016-02-04 17:23:53 +01:00
sender: RefCell<Option<Address>>
}
2016-02-08 15:53:22 +01:00
impl PartialEq for SignedTransaction {
fn eq(&self, other: &SignedTransaction) -> bool {
self.unsigned == other.unsigned && self.v == other.v && self.r == other.r && self.s == other.s
}
}
2016-02-04 17:23:53 +01:00
impl Deref for SignedTransaction {
type Target = Transaction;
fn deref(&self) -> &Self::Target {
&self.unsigned
2016-02-04 17:23:53 +01:00
}
}
impl Decodable for SignedTransaction {
fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
2016-01-29 13:59:29 +01:00
let d = decoder.as_rlp();
if d.item_count() != 9 {
2016-01-12 01:30:30 +01:00
return Err(DecoderError::RlpIncorrectListLen);
}
2016-02-04 17:23:53 +01:00
Ok(SignedTransaction {
unsigned: Transaction {
2016-02-04 17:23:53 +01:00
nonce: try!(d.val_at(0)),
gas_price: try!(d.val_at(1)),
gas: try!(d.val_at(2)),
action: try!(d.val_at(3)),
value: try!(d.val_at(4)),
data: try!(d.val_at(5)),
},
2016-01-29 13:59:29 +01:00
v: try!(d.val_at(6)),
r: try!(d.val_at(7)),
s: try!(d.val_at(8)),
2016-01-12 18:10:10 +01:00
hash: RefCell::new(None),
sender: RefCell::new(None),
2016-01-11 20:36:29 +01:00
})
2015-12-09 00:45:33 +01:00
}
}
2016-02-04 17:23:53 +01:00
impl Encodable for SignedTransaction {
fn rlp_append(&self, s: &mut RlpStream) { self.rlp_append_sealed_transaction(s) }
}
impl SignedTransaction {
/// Append object with a signature into RLP stream
pub fn rlp_append_sealed_transaction(&self, s: &mut RlpStream) {
s.begin_list(9);
s.append(&self.nonce);
2016-02-04 23:48:29 +01:00
s.append(&self.gas_price);
2016-02-04 17:23:53 +01:00
s.append(&self.gas);
match self.action {
Action::Create => s.append_empty_data(),
Action::Call(ref to) => s.append(to)
};
s.append(&self.value);
s.append(&self.data);
s.append(&self.v);
s.append(&self.r);
s.append(&self.s);
}
/// Get the hash of this header (sha3 of the RLP).
pub fn hash(&self) -> H256 {
let mut hash = self.hash.borrow_mut();
match &mut *hash {
&mut Some(ref h) => h.clone(),
hash @ &mut None => {
*hash = Some(self.rlp_sha3());
hash.as_ref().unwrap().clone()
}
}
}
/// 0 is `v` is 27, 1 if 28, and 4 otherwise.
pub fn standard_v(&self) -> u8 { match self.v { 27 => 0, 28 => 1, _ => 4 } }
/// Construct a signature object from the sig.
pub fn signature(&self) -> Signature { Signature::from_rsv(&From::from(&self.r), &From::from(&self.s), self.standard_v()) }
2016-01-16 18:30:27 +01:00
/// Checks whether the signature has a low 's' value.
pub fn check_low_s(&self) -> Result<(), Error> {
if !ec::is_low_s(&self.s) {
Err(Error::Util(UtilError::Crypto(CryptoError::InvalidSignature)))
} else {
Ok(())
}
}
2016-02-04 17:23:53 +01:00
/// Returns transaction sender.
pub fn sender(&self) -> Result<Address, Error> {
let mut sender = self.sender.borrow_mut();
match &mut *sender {
&mut Some(ref h) => Ok(h.clone()),
sender @ &mut None => {
*sender = Some(From::from(try!(ec::recover(&self.signature(), &self.unsigned.hash())).sha3()));
2016-02-04 17:23:53 +01:00
Ok(sender.as_ref().unwrap().clone())
}
}
}
2016-02-04 23:48:29 +01:00
/// Do basic validation, checking for valid signature and minimum gas,
// TODO: consider use in block validation.
#[cfg(test)]
#[cfg(feature = "json-tests")]
2016-02-04 23:48:29 +01:00
pub fn validate(self, schedule: &Schedule, require_low: bool) -> Result<SignedTransaction, Error> {
if require_low && !ec::is_low_s(&self.s) {
return Err(Error::Util(UtilError::Crypto(CryptoError::InvalidSignature)));
}
try!(self.sender());
2016-01-12 17:40:34 +01:00
if self.gas < U256::from(self.gas_required(&schedule)) {
Err(From::from(TransactionError::InvalidGasLimit(OutOfBounds{min: Some(U256::from(self.gas_required(&schedule))), max: None, found: self.gas})))
} else {
Ok(self)
}
2016-01-12 01:30:30 +01:00
}
}
#[test]
fn sender_test() {
2016-02-04 23:48:29 +01:00
let t: SignedTransaction = decode(&FromHex::from_hex("f85f800182520894095e7baea6a6c7c4c2dfeb977efac326af552d870a801ba048b55bfa915ac795c431978d8a6a992b628d557da5ff759b307d495a36649353a0efffd310ac743f371de3b9f7f9cb56c0b28ad43601b4ab949f53faa07bd2c804").unwrap());
assert_eq!(t.data, b"");
assert_eq!(t.gas, U256::from(0x5208u64));
assert_eq!(t.gas_price, U256::from(0x01u64));
assert_eq!(t.nonce, U256::from(0x00u64));
if let Action::Call(ref to) = t.action {
assert_eq!(*to, address_from_hex("095e7baea6a6c7c4c2dfeb977efac326af552d87"));
} else { panic!(); }
assert_eq!(t.value, U256::from(0x0au64));
assert_eq!(t.sender().unwrap(), address_from_hex("0f65fe9276bc9a24ae7083ae28e2660ef72df99e"));
2016-01-12 01:30:30 +01:00
}
2016-01-12 18:10:10 +01:00
#[test]
fn signing() {
let key = KeyPair::create().unwrap();
2016-02-04 23:48:29 +01:00
let t = Transaction {
action: Action::Create,
nonce: U256::from(42),
gas_price: U256::from(3000),
gas: U256::from(50_000),
value: U256::from(1),
data: b"Hello!".to_vec()
}.sign(&key.secret());
2016-01-12 18:10:10 +01:00
assert_eq!(Address::from(key.public().sha3()), t.sender().unwrap());
2016-01-17 15:56:09 +01:00
}