refactor(Contracts): set non-zero .head during initialize (#32)

Author: fubuloubu

contracts/Caravan.vy

@@ -93,6 +93,24 @@ def eip712Domain() -> (
     )
 
 
+@view
+def _DOMAIN_SEPARATOR() -> bytes32:
+    return keccak256(
+        abi_encode(EIP712_DOMAIN_TYPEHASH, NAMEHASH, VERSIONHASH, chain.id, self)
+    )
+
+
+@view
+@external
+def DOMAIN_SEPARATOR() -> bytes32:
+    return self._DOMAIN_SEPARATOR()
+
+
+@view
+def _hash_typed_data_v4(struct_hash: bytes32) -> bytes32:
+    return keccak256(concat(x"1901", self._DOMAIN_SEPARATOR(), struct_hash))
+
+
 @external
 def initialize(signers: DynArray[address, 11], threshold: uint256):
     assert self.IMPLEMENTATION != empty(address)  # dev: only Proxy can initialize
@@ -102,6 +120,23 @@ def initialize(signers: DynArray[address, 11], threshold: uint256):
     self._signers = signers
     self.threshold = threshold
 
+    # NOTE: Initialize head to non-zero, network-specific value as if this action was performed
+    self.head = self._hash_typed_data_v4(
+        keccak256(
+            abi_encode(
+                MODIFY_TYPEHASH,
+                empty(bytes32),
+                ICaravan.ActionType.ROTATE_SIGNERS,
+                # NOTE: Per EIP712, Dynamic structures are encoded as the hash of their contents
+                keccak256(
+                    abi_encode(
+                        signers, empty(DynArray[address, 11]), threshold
+                    )
+                ),
+            )
+        )
+    )
+
 
 @view
 @external
@@ -148,24 +183,6 @@ def _verify_signatures(msghash: bytes32, signatures: DynArray[Bytes[65], 11]):
         already_approved.append(signer)
 
 
-@view
-def _DOMAIN_SEPARATOR() -> bytes32:
-    return keccak256(
-        abi_encode(EIP712_DOMAIN_TYPEHASH, NAMEHASH, VERSIONHASH, chain.id, self)
-    )
-
-
-@view
-@external
-def DOMAIN_SEPARATOR() -> bytes32:
-    return self._DOMAIN_SEPARATOR()
-
-
-@view
-def _hash_typed_data_v4(struct_hash: bytes32) -> bytes32:
-    return keccak256(concat(x"1901", self._DOMAIN_SEPARATOR(), struct_hash))
-
-
 def _rotate_signers(
     signers_to_add: DynArray[address, 11],
     signers_to_rm: DynArray[address, 11],

sdk/py/caravan/factory.py

@@ -33,7 +33,7 @@ def __init__(self, address: AddressType | None = None):
         self._cached_releases: dict[Version, "ContractInstance"] = {
             # NOTE: This is the deterministic deployment address for v1 via CreateX
             Version("1"): PackageType.SINGLETON("1").at(
-                "0xf7AC37e8A31Da4D2Fbe7687118c142dd46e63517"
+                "0xB810c65972596d213DCdf0A73b27fa7be59Ef3E2"
             ),
         }
 

sdk/py/caravan/queue.py

@@ -107,7 +107,7 @@ class QueueManager(BaseModel):
 
     # QueueItem => list[QueueItem.hash]
     queue: dict[QueueItem, list[HexBytes]] = dict()
-    base: HexBytes = HexBytes("00" * 32)
+    base: HexBytes  # NOTE: Must always provide head!
 
     @model_validator(mode="after")
     def ensure_base(self) -> Self:

tests/conftest.py

@@ -85,7 +85,7 @@ def new_van(
 
         van = factory.new(owners, threshold, version=version, **txn_args)
         # NOTE: Make sure to use empty queue for testing
-        van.queue = QueueManager()
+        van.queue = QueueManager(base=van.head)
         return van
 
     return new_van

tests/test_operation.py

@@ -1,6 +1,8 @@
 import ape
 import pytest
 
+from caravan.messages import ActionType
+
 
 def test_configuration(networks, van, VERSION, THRESHOLD, owners):
     assert set(van.signers) == set(o.address for o in owners)
@@ -20,6 +22,20 @@ def test_configuration(networks, van, VERSION, THRESHOLD, owners):
     assert salt == b"\x00" * 32
     assert extensions == []
 
+    # NOTE: Initial head should be as if it did a ROTATE_SIGNERS modification
+    assert (
+        van.head
+        == ActionType.ROTATE_SIGNERS(
+            [o.address for o in owners],
+            [],
+            THRESHOLD,
+            address=address,
+            chain_id=chain_id,
+            version=version,
+            parent=b"\x00" * 32,
+        ).hash
+    )
+
 
 def test_initialize(singleton, van, THRESHOLD, owners):
     assert van.contract.IMPLEMENTATION() == singleton