Add proposer field to multisigTransaction. (#1695)

Add proposer field to indicate the owner or delegator address that proposed a transaction.

safe_transaction_service/history/migrations/0075_multisigtransaction_proposer.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.5 on 2023-10-05 09:23
+
+from django.db import migrations
+
+import gnosis.eth.django.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("history", "0074_internaltx_history_internal_transfer_idx"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="multisigtransaction",
+            name="proposer",
+            field=gnosis.eth.django.models.EthereumAddressV2Field(null=True),
+        ),
+    ]

safe_transaction_service/history/models.py

@@ -1366,6 +1366,7 @@ class MultisigTransaction(TimeStampedModel):
     objects = MultisigTransactionManager.from_queryset(MultisigTransactionQuerySet)()
     safe_tx_hash = Keccak256Field(primary_key=True)
     safe = EthereumAddressV2Field(db_index=True)
+    proposer = EthereumAddressV2Field(null=True)
     ethereum_tx = models.ForeignKey(
         EthereumTx,
         null=True,

safe_transaction_service/history/serializers.py

@@ -257,6 +257,13 @@ def save(self, **kwargs):
             ):
                 trusted = user.has_perm("history.create_trusted")
 
+        if self.validated_data["sender"] in self.validated_data["safe_owners"]:
+            proposer = self.validated_data["sender"]
+        else:
+            proposer = SafeContractDelegate.objects.get(
+                delegate=self.validated_data["sender"]
+            ).delegator
+
         multisig_transaction, created = MultisigTransaction.objects.get_or_create(
             safe_tx_hash=safe_tx_hash,
             defaults={
@@ -275,6 +282,7 @@ def save(self, **kwargs):
                 "nonce": self.validated_data["nonce"],
                 "origin": origin,
                 "trusted": trusted,
+                "proposer": proposer,
             },
         )
 
@@ -546,6 +554,7 @@ class SafeMultisigTransactionResponseSerializer(SafeMultisigTxSerializerV1):
     block_number = serializers.SerializerMethodField()
     transaction_hash = Sha3HashField(source="ethereum_tx_id")
     safe_tx_hash = Sha3HashField()
+    proposer = EthereumAddressField()
     executor = serializers.SerializerMethodField()
     value = serializers.CharField()
     is_executed = serializers.BooleanField(source="executed")

safe_transaction_service/history/tests/test_migrations.py

@@ -7,8 +7,6 @@
 from eth_account import Account
 from web3 import Web3
 
-from safe_transaction_service.history.tests.factories import MultisigTransactionFactory
-
 
 class TestMigrations(TestCase):
     def setUp(self) -> None:
@@ -252,23 +250,28 @@ def test_migration_forward_0073_safe_apps_links(self):
         new_state = self.migrator.apply_initial_migration(
             ("history", "0072_safecontract_banned_and_more"),
         )
-
-        # Factories can be used as there are no database definition changes
-        # Make sure there are no issues with empty `origin` or `origin` lacking `url`
-        MultisigTransactionFactory(origin={"not_url": "random"})
-
-        # Make sure other urls are not affected
-        MultisigTransactionFactory(
-            origin={"url": "https://app.zerion.io", "name": "Zerion"}
-        )
-
-        # This origin must be replaced
-        MultisigTransactionFactory(
-            origin={
+        origins = [
+            {"not_url": "random"},
+            {"url": "https://app.zerion.io", "name": "Zerion"},
+            {
                 "url": "https://apps.gnosis-safe.io/tx-builder/",
                 "name": "Transaction Builder",
-            }
-        )
+            },
+        ]
+
+        MultisigTransaction = new_state.apps.get_model("history", "MultisigTransaction")
+        for origin in origins:
+            MultisigTransaction.objects.create(
+                safe_tx_hash=Web3.keccak(text=f"multisig-tx-{origin}").hex(),
+                safe=Account.create().address,
+                value=0,
+                operation=0,
+                safe_tx_gas=0,
+                base_gas=0,
+                gas_price=0,
+                nonce=0,
+                origin=origin,
+            )
 
         new_state = self.migrator.apply_tested_migration(
             ("history", "0073_safe_apps_links"),
@@ -295,22 +298,28 @@ def test_migration_backward_0073_safe_apps_links(self):
             ("history", "0073_safe_apps_links"),
         )
 
-        # Factories can be used as there are no database definition changes
-        # Make sure there are no issues with empty `origin` or `origin` lacking `url`
-        MultisigTransactionFactory(origin={"not_url": "random"})
-
-        # Make sure other urls are not affected
-        MultisigTransactionFactory(
-            origin={"url": "https://app.zerion.io", "name": "Zerion"}
-        )
-
-        # This origin must be replaced
-        MultisigTransactionFactory(
-            origin={
-                "url": "https://apps-portal.safe.global/tx-builder/",
+        origins = [
+            {"not_url": "random"},
+            {"url": "https://app.zerion.io", "name": "Zerion"},
+            {
+                "url": "https://apps.gnosis-safe.io/tx-builder/",
                 "name": "Transaction Builder",
-            }
-        )
+            },
+        ]
+
+        MultisigTransaction = new_state.apps.get_model("history", "MultisigTransaction")
+        for origin in origins:
+            MultisigTransaction.objects.create(
+                safe_tx_hash=Web3.keccak(text=f"multisig-tx-{origin}").hex(),
+                safe=Account.create().address,
+                value=0,
+                operation=0,
+                safe_tx_gas=0,
+                base_gas=0,
+                gas_price=0,
+                nonce=0,
+                origin=origin,
+            )
 
         new_state = self.migrator.apply_tested_migration(
             ("history", "0072_safecontract_banned_and_more"),

safe_transaction_service/history/tests/test_views.py

@@ -798,6 +798,7 @@ def test_get_multisig_transaction(self):
             "b1b3b164cf000000000000000000000000000000000000000000000000000000"
             "0000000001"
         )
+
         multisig_tx = MultisigTransactionFactory(data=add_owner_with_threshold_data)
         safe_tx_hash = multisig_tx.safe_tx_hash
         response = self.client.get(
@@ -814,6 +815,7 @@ def test_get_multisig_transaction(self):
         self.assertFalse(response.data["trusted"])
         self.assertIsNone(response.data["max_fee_per_gas"])
         self.assertIsNone(response.data["max_priority_fee_per_gas"])
+        self.assertIsNone(response.data["proposer"])
         self.assertEqual(
             response.data["data_decoded"],
             {
@@ -828,6 +830,7 @@ def test_get_multisig_transaction(self):
                 ],
             },
         )
+
         # Test camelCase
         self.assertEqual(
             response.json()["transactionHash"], multisig_tx.ethereum_tx.tx_hash
@@ -855,8 +858,19 @@ def test_get_multisig_transaction(self):
         self.assertEqual(response.data["origin"], json.dumps(origin))
         self.assertEqual(json.loads(response.data["origin"]), origin)
 
+        # Test proposer
+        proposer = Account.create().address
+        multisig_tx.proposer = proposer
+        multisig_tx.save()
+        response = self.client.get(
+            reverse("v1:history:multisig-transaction", args=(safe_tx_hash,)),
+            format="json",
+        )
+        self.assertEqual(response.data["proposer"], proposer)
+
     def test_get_multisig_transactions(self):
         safe_address = Account.create().address
+        proposer = Account.create().address
         response = self.client.get(
             reverse("v1:history:multisig-transactions", args=(safe_address,)),
             format="json",
@@ -865,7 +879,7 @@ def test_get_multisig_transactions(self):
         self.assertEqual(response.data["count"], 0)
         self.assertEqual(response.data["count_unique_nonce"], 0)
 
-        multisig_tx = MultisigTransactionFactory(safe=safe_address)
+        multisig_tx = MultisigTransactionFactory(safe=safe_address, proposer=proposer)
         response = self.client.get(
             reverse("v1:history:multisig-transactions", args=(safe_address,)),
             format="json",
@@ -889,7 +903,6 @@ def test_get_multisig_transactions(self):
         )
         # Check Etag header
         self.assertTrue(response["Etag"])
-
         MultisigConfirmationFactory(multisig_transaction=multisig_tx)
         response = self.client.get(
             reverse("v1:history:multisig-transactions", args=(safe_address,)),
@@ -898,6 +911,7 @@ def test_get_multisig_transactions(self):
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(len(response.data["results"]), 1)
         self.assertEqual(len(response.data["results"][0]["confirmations"]), 1)
+        self.assertEqual(response.data["results"][0]["proposer"], proposer)
 
         MultisigTransactionFactory(safe=safe_address, nonce=multisig_tx.nonce)
         response = self.client.get(
@@ -1182,6 +1196,7 @@ def test_post_multisig_transactions(self):
         self.assertEqual(len(response.data["results"]), 1)
         self.assertIsNone(response.data["results"][0]["executor"])
         self.assertEqual(len(response.data["results"][0]["confirmations"]), 0)
+        self.assertEqual(response.data["results"][0]["proposer"], data["sender"])
 
         # Test confirmation with signature
         data["signature"] = safe_owner_1.signHash(safe_tx.safe_tx_hash)[
@@ -1676,7 +1691,11 @@ def test_post_multisig_transactions_with_delegate(self):
         self.assertEqual(response.status_code, status.HTTP_201_CREATED)
         self.assertEqual(MultisigTransaction.objects.count(), 1)
         self.assertEqual(MultisigConfirmation.objects.count(), 0)
-        self.assertTrue(MultisigTransaction.objects.first().trusted)
+        multisig_transaction = MultisigTransaction.objects.first()
+        self.assertTrue(multisig_transaction.trusted)
+        # Proposer should be the owner address not the delegate
+        self.assertNotEqual(multisig_transaction.proposer, safe_delegate.address)
+        self.assertEqual(multisig_transaction.proposer, safe_owners[0].address)
 
         data["signature"] = data["signature"] + data["signature"][2:]
         response = self.client.post(