Adds custom address_reference

# Conflicts:
#	rust/tw_evm/src/modules/tx_builder.rs

Author: dchatzieleftheriou-bc

rust/tw_evm/src/abi/function.rs

@@ -64,7 +64,11 @@ impl Function {
             }
         }
 
+        // Note: the `short_signature` methods only takes the `input_param_types` which come from the ERC20 abi (see erc20.abi.json)
+        // as a result it will create the correct signature regardless of the passed Tokens, 
+        // Any extra Token that do not appear on the ERC20 Abi json will be ignored!
         let signed = short_signature(&self.name, &input_param_types);
+        // this encodes all the given Tokens
         let encoded = encode_tokens(tokens);
         Ok(signed.into_iter().chain(encoded).collect())
     }

rust/tw_evm/src/abi/prebuild/erc20.rs

@@ -21,9 +21,13 @@ lazy_static! {
 pub struct Erc20;
 
 impl Erc20 {
-    pub fn transfer(recipient: Address, amount: U256) -> AbiResult<Data> {
+    pub fn transfer(recipient: Address, amount: U256, address_reference: Option<Address>) -> AbiResult<Data> {
         let func = ERC20.function("transfer")?;
-        func.encode_input(&[Token::Address(recipient), Token::u256(amount)])
+        if let Some(address_ref) = address_reference {
+            func.encode_input(&[Token::Address(recipient), Token::u256(amount), Token::Address(address_ref)])    
+        } else {
+            func.encode_input(&[Token::Address(recipient), Token::u256(amount)])
+        }
     }
 
     pub fn approve(spender: Address, amount: U256) -> AbiResult<Data> {

rust/tw_evm/src/modules/tx_builder.rs

@@ -59,7 +59,9 @@ impl<Context: EvmContext> TxBuilder<Context> {
                 let contract_address =
                     Self::parse_address(&input.to_address).context("Invalid Contract address")?;
 
-                let payload = Erc20::transfer(token_to_address, token_amount)
+                let token_address_reference = Self::parse_address_optional(&erc20_transfer.address_reference)?;
+
+                let payload = Erc20::transfer(token_to_address, token_amount, token_address_reference)
                     .map_err(abi_to_signing_error)?;
                 (U256::zero(), payload, Some(contract_address))
             },

rust/tw_evm/tests/barz.rs

@@ -141,7 +141,8 @@ fn test_barz_batched_account_deployed() {
     {
         let recipient = Address::from("0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789");
         let amount = U256::from(0x8AC7_2304_89E8_0000_u64);
-        let payload = Erc20::transfer(recipient, amount).unwrap();
+        let address_ref: Option<Address> = None;
+        let payload = Erc20::transfer(recipient, amount, address_ref).unwrap();
 
         calls.push(Proto::mod_Transaction::mod_Batch::BatchedCall {
             address: contract_address.into(),

rust/tw_evm/tests/signer.rs

@@ -19,6 +19,7 @@ fn test_sign_transaction_non_typed_erc20_transfer() {
     let erc20_transfer = Proto::mod_Transaction::ERC20Transfer {
         to: "0x5322b34c88ed0691971bf52a7047448f0f4efc84".into(),
         amount: U256::encode_be_compact(2_000_000_000_000_000_000),
+        address_reference: Cow::default()
     };
 
     let input = Proto::SigningInput {
@@ -52,6 +53,48 @@ fn test_sign_transaction_non_typed_erc20_transfer() {
     );
 }
 
+#[test]
+fn test_sign_transaction_non_typed_erc20_transfer_address_ref() {
+    let private =
+        hex::decode("0x608dcb1742bb3fb7aec002074e3420e4fab7d00cced79ccdac53ed5b27138151").unwrap();
+
+    let erc20_transfer = Proto::mod_Transaction::ERC20Transfer {
+        to: "0x5322b34c88ed0691971bf52a7047448f0f4efc84".into(),
+        amount: U256::encode_be_compact(2_000_000_000_000_000_000),
+        address_reference: "0x3535353535353535353535353535353535353535".into()
+    };
+
+    let input = Proto::SigningInput {
+        chain_id: U256::encode_be_compact(1),
+        tx_mode: TransactionMode::Legacy,
+        // 42000000000
+        gas_price: U256::encode_be_compact(0x09_c765_2400),
+        // 78009
+        gas_limit: U256::encode_be_compact(0x01_30B9),
+        // DAI
+        to_address: "0x6b175474e89094c44da98b954eedeac495271d0f".into(),
+        transaction: Some(Proto::Transaction {
+            transaction_oneof: Proto::mod_Transaction::OneOftransaction_oneof::erc20_transfer(
+                erc20_transfer,
+            ),
+        }),
+        private_key: private.into(),
+        ..Proto::SigningInput::default()
+    };
+
+    let output = Signer::<StandardEvmContext>::sign_proto(input);
+    assert_eq!(output.error, SigningErrorType::OK);
+    assert!(output.error_message.is_empty());
+
+    let expected = "f8ca808509c7652400830130b9946b175474e89094c44da98b954eedeac495271d0f80b864a9059cbb0000000000000000000000005322b34c88ed0691971bf52a7047448f0f4efc840000000000000000000000000000000000000000000000001bc16d674ec80000000000000000000000000000353535353535353535353535353535353535353525a04bf4664fc9a274a5b8cfa0d6ee7c904787c02825856d25896d225aff4efd3802a04e174f780c13a4b99ac1ee9528cef4e22dc475be68d4eb4944b7c61bd016be60";
+    assert_eq!(hex::encode(output.encoded, false), expected);
+
+    assert_eq!(
+        hex::encode(output.data, false),
+        "a9059cbb0000000000000000000000005322b34c88ed0691971bf52a7047448f0f4efc840000000000000000000000000000000000000000000000001bc16d674ec800000000000000000000000000003535353535353535353535353535353535353535"
+    );
+}
+
 #[test]
 fn test_sign_transaction_non_typed_native() {
     let private =
@@ -247,6 +290,7 @@ fn test_sign_transaction_eip1559_erc20_transfer() {
     let erc20_transfer = Proto::mod_Transaction::ERC20Transfer {
         to: "0x5322b34c88ed0691971bf52a7047448f0f4efc84".into(),
         amount: U256::encode_be_compact(2_000_000_000_000_000_000),
+        address_reference: Cow::default(),
     };
 
     let input = Proto::SigningInput {
@@ -468,6 +512,7 @@ fn test_sign_transaction_non_typed_erc20_transfer_invalid_address() {
     let erc20_transfer = Proto::mod_Transaction::ERC20Transfer {
         to: "0x5322b34c88ed0691971bf52a7047448f0f4efc84".into(),
         amount: U256::encode_be_compact(2_000_000_000_000_000_000),
+        address_reference: Cow::default()
     };
 
     let input = Proto::SigningInput {

rust/tw_proto/tests/proto_tests.rs

@@ -64,6 +64,7 @@ fn test_serialize_deserialize() {
     let expected_erc20 = Ethereum::Proto::mod_Transaction::ERC20Transfer {
         to: Cow::from("0x5322b34c88ed0691971bf52a7047448f0f4efc84"),
         amount: Cow::Borrowed(&[27u8, 193, 109, 103, 78, 200, 0, 0]),
+        address_reference: Cow::default(),
     };
     let expected_tx = Ethereum::Proto::Transaction {
         transaction_oneof: Ethereum::Proto::mod_Transaction::OneOftransaction_oneof::erc20_transfer(

src/proto/Ethereum.proto

@@ -23,6 +23,9 @@ message Transaction {
 
         // Amount to send (uint256, serialized big endian)
         bytes amount = 2;
+
+        // Optional address
+        string address_reference = 3;
     }
 
     // ERC20 approve transaction

swift/Tests/Blockchains/EthereumTests.swift

@@ -62,6 +62,29 @@ class EthereumTests: XCTestCase {
         XCTAssertEqual(output.encoded.hexString, "f8aa808509c7652400830130b9946b175474e89094c44da98b954eedeac495271d0f80b844a9059cbb0000000000000000000000005322b34c88ed0691971bf52a7047448f0f4efc840000000000000000000000000000000000000000000000001bc16d674ec8000025a0724c62ad4fbf47346b02de06e603e013f26f26b56fdc0be7ba3d6273401d98cea0032131cae15da7ddcda66963e8bef51ca0d9962bfef0547d3f02597a4a58c931")
         XCTAssertEqual(output.data.hexString, "a9059cbb0000000000000000000000005322b34c88ed0691971bf52a7047448f0f4efc840000000000000000000000000000000000000000000000001bc16d674ec80000")
     }
+    
+    func testSignERC20Transfer_addressReference() {
+        let input = EthereumSigningInput.with {
+            $0.chainID = Data(hexString: "01")!
+            $0.nonce = Data(hexString: "00")!
+            // txMode not set, Legacy is the default
+            $0.gasPrice = Data(hexString: "09c7652400")! // 42000000000
+            $0.gasLimit = Data(hexString: "0130B9")! // 78009
+            $0.toAddress = "0x6b175474e89094c44da98b954eedeac495271d0f" // DAI
+            $0.privateKey = Data(hexString: "0x608dcb1742bb3fb7aec002074e3420e4fab7d00cced79ccdac53ed5b27138151")!
+            $0.transaction = EthereumTransaction.with {
+                $0.erc20Transfer = EthereumTransaction.ERC20Transfer.with {
+                    $0.to = "0x5322b34c88ed0691971bf52a7047448f0f4efc84"
+                    $0.amount = Data(hexString: "1bc16d674ec80000")! // 2000000000000000000
+                    $0.addressReference = "0x3535353535353535353535353535353535353535"
+                }
+            }
+        }
+        let output: EthereumSigningOutput = AnySigner.sign(input: input, coin: .ethereum)
+        
+        XCTAssertEqual(output.encoded.hexString, "f8ca808509c7652400830130b9946b175474e89094c44da98b954eedeac495271d0f80b864a9059cbb0000000000000000000000005322b34c88ed0691971bf52a7047448f0f4efc840000000000000000000000000000000000000000000000001bc16d674ec80000000000000000000000000000353535353535353535353535353535353535353525a04bf4664fc9a274a5b8cfa0d6ee7c904787c02825856d25896d225aff4efd3802a04e174f780c13a4b99ac1ee9528cef4e22dc475be68d4eb4944b7c61bd016be60")
+        XCTAssertEqual(output.data.hexString, "a9059cbb0000000000000000000000005322b34c88ed0691971bf52a7047448f0f4efc840000000000000000000000000000000000000000000000001bc16d674ec800000000000000000000000000003535353535353535353535353535353535353535")
+    }
 
     func testSignERC20Transfer_1559() {
         let input = EthereumSigningInput.with {