Added possibility to send transactions with access list (#727)

sunce86 · web-flow · commit 1c5d50095893 · 2022-02-22T14:01:12.000+01:00
* added possibility to send transactions with access list
diff --git a/ethcontract/src/contract/method.rs b/ethcontract/src/contract/method.rs
@@ -6,7 +6,7 @@ use crate::transaction::{Account, GasPrice, TransactionBuilder, TransactionResul
 use crate::{batch::CallBatch, errors::MethodError, tokens::Tokenize};
 use ethcontract_common::abi::{Function, Token};
 use std::marker::PhantomData;
-use web3::types::{Address, BlockId, Bytes, CallRequest, U256};
+use web3::types::{AccessList, Address, BlockId, Bytes, CallRequest, U256};
 use web3::Transport;
 use web3::{api::Web3, BatchTransport};
 
@@ -114,6 +114,12 @@ impl<T: Transport, R: Tokenize> MethodBuilder<T, R> {
         self
     }
 
+    /// Specify the access list for the transaction, if not specified no access list will be used.
+    pub fn access_list(mut self, value: AccessList) -> Self {
+        self.tx = self.tx.access_list(value);
+        self
+    }
+
     /// Extract inner `TransactionBuilder` from this `SendBuilder`. This exposes
     /// `TransactionBuilder` only APIs.
     pub fn into_inner(self) -> TransactionBuilder<T> {
@@ -203,6 +209,12 @@ impl<T: Transport, R: Tokenize> ViewMethodBuilder<T, R> {
         self
     }
 
+    /// Specify the access list for the transaction, if not specified no access list will be used.
+    pub fn access_list(mut self, value: AccessList) -> Self {
+        self.m = self.m.access_list(value);
+        self
+    }
+
     /// Specify the block height for the call, if not specified then latest
     /// mined block will be used.
     pub fn block(mut self, value: BlockId) -> Self {
@@ -250,7 +262,7 @@ impl<T: Transport, R: Tokenize> ViewMethodBuilder<T, R> {
                 value: self.m.tx.value,
                 data: self.m.tx.data,
                 transaction_type: resolved_gas_price.transaction_type,
-                access_list: None,
+                access_list: self.m.tx.access_list,
                 max_fee_per_gas: resolved_gas_price.max_fee_per_gas,
                 max_priority_fee_per_gas: resolved_gas_price.max_priority_fee_per_gas,
             },
@@ -289,6 +301,7 @@ mod tests {
     use super::*;
     use crate::test::prelude::*;
     use ethcontract_common::abi::{Param, ParamType};
+    use web3::types::AccessListItem;
 
     fn test_abi_function() -> (Function, Bytes) {
         #[allow(deprecated)]
@@ -324,6 +337,7 @@ mod tests {
             .gas_price(2.0.into())
             .value(28.into())
             .nonce(42.into())
+            .access_list(vec![AccessListItem::default()])
             .into_inner();
 
         assert_eq!(tx.from.map(|a| a.address()), Some(from));
@@ -333,6 +347,7 @@ mod tests {
         assert_eq!(tx.value, Some(28.into()));
         assert_eq!(tx.data, Some(data));
         assert_eq!(tx.nonce, Some(42.into()));
+        assert_eq!(tx.access_list, Some(vec![AccessListItem::default()]));
         transport.assert_no_more_requests();
     }
 
diff --git a/ethcontract/src/transaction.rs b/ethcontract/src/transaction.rs
@@ -13,7 +13,7 @@ pub use self::send::TransactionResult;
 use crate::errors::ExecutionError;
 use crate::secret::{Password, PrivateKey};
 use web3::api::Web3;
-use web3::types::{Address, Bytes, CallRequest, TransactionCondition, U256};
+use web3::types::{AccessList, Address, Bytes, CallRequest, TransactionCondition, U256};
 use web3::Transport;
 
 /// The account type used for signing the transaction.
@@ -88,6 +88,8 @@ pub struct TransactionBuilder<T: Transport> {
     /// Optional resolve conditions. Defaults to waiting the transaction to be
     /// mined without any extra confirmation blocks.
     pub resolve: Option<ResolveCondition>,
+    /// Access list
+    pub access_list: Option<AccessList>,
 }
 
 impl<T: Transport> TransactionBuilder<T> {
@@ -103,6 +105,7 @@ impl<T: Transport> TransactionBuilder<T> {
             data: None,
             nonce: None,
             resolve: None,
+            access_list: None,
         }
     }
 
@@ -162,6 +165,12 @@ impl<T: Transport> TransactionBuilder<T> {
         self
     }
 
+    /// Specify the access list for the transaction, if not specified no access list will be used.
+    pub fn access_list(mut self, value: AccessList) -> Self {
+        self.access_list = Some(value);
+        self
+    }
+
     /// Specify the number of confirmations to use for the confirmation options.
     /// This is a utility method for specifying the resolve condition.
     pub fn confirmations(mut self, value: usize) -> Self {
@@ -197,7 +206,7 @@ impl<T: Transport> TransactionBuilder<T> {
                     value: self.value,
                     data: self.data.clone(),
                     transaction_type: resolved_gas_price.transaction_type,
-                    access_list: None,
+                    access_list: self.access_list,
                     max_fee_per_gas: resolved_gas_price.max_fee_per_gas,
                     max_priority_fee_per_gas: resolved_gas_price.max_priority_fee_per_gas,
                 },
@@ -214,7 +223,7 @@ mod tests {
     use crate::errors::ExecutionError;
     use crate::test::prelude::*;
     use hex_literal::hex;
-    use web3::types::{H2048, H256};
+    use web3::types::{AccessListItem, H2048, H256};
 
     #[test]
     fn tx_builder_estimate_gas() {
@@ -260,6 +269,7 @@ mod tests {
             .value(28.into())
             .data(Bytes(vec![0x13, 0x37]))
             .nonce(42.into())
+            .access_list(vec![AccessListItem::default()])
             .resolve(ResolveCondition::Pending)
             .send()
             .immediate()
@@ -277,6 +287,10 @@ mod tests {
                 "value": "0x1c",
                 "data": "0x1337",
                 "nonce": "0x2a",
+                "accessList": [{
+                    "address": "0x0000000000000000000000000000000000000000",
+                    "storageKeys": [],
+                }],
                 "condition": { "block": 100 },
             })],
         );
diff --git a/ethcontract/src/transaction/build.rs b/ethcontract/src/transaction/build.rs
@@ -10,8 +10,8 @@ use crate::transaction::gas_price::GasPrice;
 use crate::transaction::{Account, TransactionBuilder};
 use web3::api::Web3;
 use web3::types::{
-    Address, Bytes, CallRequest, RawTransaction, SignedTransaction, TransactionCondition,
-    TransactionParameters, TransactionRequest, H256, U256,
+    AccessList, Address, Bytes, CallRequest, RawTransaction, SignedTransaction,
+    TransactionCondition, TransactionParameters, TransactionRequest, H256, U256,
 };
 use web3::Transport;
 
@@ -29,6 +29,7 @@ impl<T: Transport> TransactionBuilder<T> {
             value: self.value,
             data: self.data,
             nonce: self.nonce,
+            access_list: self.access_list,
         };
 
         let tx = match self.from {
@@ -127,6 +128,8 @@ struct TransactionOptions {
     pub data: Option<Bytes>,
     /// The transaction nonce.
     pub nonce: Option<U256>,
+    /// The access list
+    pub access_list: Option<AccessList>,
 }
 
 /// Transaction options specific to `TransactionRequests` since they may also
@@ -154,7 +157,7 @@ impl TransactionRequestOptions {
             nonce: self.0.nonce,
             condition: self.1,
             transaction_type: resolved_gas_price.transaction_type,
-            access_list: None,
+            access_list: self.0.access_list,
             max_fee_per_gas: resolved_gas_price.max_fee_per_gas,
             max_priority_fee_per_gas: resolved_gas_price.max_priority_fee_per_gas,
         }
@@ -224,7 +227,7 @@ async fn build_offline_signed_transaction<T: Transport>(
                 data: options.data.unwrap_or_default(),
                 chain_id,
                 transaction_type: resolved_gas_price.transaction_type,
-                access_list: None,
+                access_list: options.access_list,
                 max_fee_per_gas: resolved_gas_price.max_fee_per_gas,
                 max_priority_fee_per_gas: resolved_gas_price.max_priority_fee_per_gas,
             },
@@ -257,7 +260,7 @@ async fn resolve_gas_limit<T: Transport>(
                     value: options.value,
                     data: options.data.clone(),
                     transaction_type: resolved_gas_price.transaction_type,
-                    access_list: None,
+                    access_list: options.access_list.clone(),
                     max_fee_per_gas: resolved_gas_price.max_fee_per_gas,
                     max_priority_fee_per_gas: resolved_gas_price.max_priority_fee_per_gas,
                 },
