Merge branch 'master' into struct-namespace

# Conflicts:
#	wrappers/QuantumGravityBridge.sol/wrapper.go

Author: rach-id

Diff for: .github/workflows/contract-inheritance-check.yml

@@ -0,0 +1,28 @@
+name: Check Contract Inheritance
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  check_inheritance:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+
+      - name: Install Surya
+        run: |
+          npm install -g surya
+
+      - name: Run Surya Inheritance Check
+        run: |
+          ./scripts/upgradability_check.sh

Diff for: .github/workflows/lint.yml

@@ -10,7 +10,7 @@ jobs:
   check-solidity-formatting:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 

Diff for: .github/workflows/tests.yml

@@ -18,7 +18,7 @@ jobs:
   forge-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -39,7 +39,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: forge-test
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 

Diff for: .gitmodules

@@ -4,3 +4,6 @@
 [submodule "ethereum/solidity/lib/openzeppelin-contracts"]
 	path = lib/openzeppelin-contracts
 	url = https://github.com/openzeppelin/openzeppelin-contracts
+[submodule "lib/openzeppelin-contracts-upgradeable"]
+	path = lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable

Diff for: README.md

@@ -81,7 +81,7 @@ It does not support bridging assets such as fungible or non-fungible tokens dire
 It works by relying on a set of signers to attest to some event on Celestia: the Celestia validator set.
 The QGB contract keeps track of the Celestia validator set by updating its view of the validator set with `updateValidatorSet()`.
 More than 2/3 of the voting power of the current view of the validator set must sign off on new relayed events, submitted with `submitDataRootTupleRoot()`.
-Each event is a batch of `DataRootTuple`s, with each tuple representing a single [data root (i.e. block header)](https://celestiaorg.github.io/celestia-specs/latest/specs/data_structures.html#header).
+Each event is a batch of `DataRootTuple`s, with each tuple representing a single [data root (i.e. block header)](https://celestiaorg.github.io/celestia-app/specs/data_structures.html#header).
 Relayed tuples are in the same order as Celestia block headers.
 
 ### Events and messages relayed

Diff for: lib/openzeppelin-contracts-upgradeable

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# this script will check if the QGB contract is inheriting the correct upgradability contracts.
+
+out=$(surya inheritance src/QuantumGravityBridge.sol | grep -i "\"QuantumGravityBridge\" ->" | cut -d ">" -f 2  | sed 's/[";]//g')
+
+required_contracts=("Initializable" "UUPSUpgradeable" "OwnableUpgradeable")
+missing_contracts=()
+
+for field in "${required_contracts[@]}"; do
+    if ! grep -q "\<$field\>" <<< "$out"; then
+        missing_contracts+=("$field")
+    fi
+done
+
+if [ ${#missing_contracts[@]} -eq 0 ]; then
+    echo "The QuantumGravityBridge contract is inheriting the right contracts. Exiting."
+    exit 0
+else
+    echo "The QuantumGravityBridge contract is missing the necessary inherited contracts: ${missing_contracts[*]}"
+    exit 1
+fi

Diff for: scripts/upgradability_check.sh

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import "openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol";
+import "openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
+import "openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol";
 import "openzeppelin-contracts/contracts/utils/cryptography/ECDSA.sol";
 
 import "./Constants.sol";
@@ -31,7 +34,9 @@ struct Signature {
 /// (see ./DataRootTuple.sol), with each tuple representing a single data root
 /// in a Celestia block header. Relayed tuples are in the same order as the
 /// block headers.
-contract QuantumGravityBridge is IDAOracle {
+/// @dev DO NOT REMOVE INHERITENCE OF THE FOLLOWING CONTRACTS: Initializable, UUPSUpgradeable and
+/// OwnableUpgradeable! They're essential for upgradability.
+contract QuantumGravityBridge is IDAOracle, Initializable, UUPSUpgradeable, OwnableUpgradeable {
     // Don't change the order of state for working upgrades AND BE AWARE OF
     // INHERITANCE VARIABLES! Inherited contracts contain storage slots and must
     // be accounted for in any upgrades. Always test an exact upgrade on testnet
@@ -99,7 +104,8 @@ contract QuantumGravityBridge is IDAOracle {
     /// @param _validatorSetHash Initial validator set hash. This does not need
     /// to be the genesis validator set of the bridged chain, only the initial
     /// validator set of the bridge.
-    constructor(uint256 _nonce, uint256 _powerThreshold, bytes32 _validatorSetHash) {
+    /// @dev DO NOT REMOVE THE INITIALIZER! It is mandatory for upgradability.
+    function initialize(uint256 _nonce, uint256 _powerThreshold, bytes32 _validatorSetHash) public initializer {
         // CHECKS
 
         bytes32 newCheckpoint = domainSeparateValidatorSetHash(_nonce, _powerThreshold, _validatorSetHash);
@@ -110,11 +116,20 @@ contract QuantumGravityBridge is IDAOracle {
         state_lastValidatorSetCheckpoint = newCheckpoint;
         state_powerThreshold = _powerThreshold;
 
+        /// @dev Initialize the OwnableUpgradeable explicitly.
+        /// DO NOT REMOVE! It is mandatory for allowing the owner to upgrade.
+        __Ownable_init(_msgSender());
+
         // LOGS
 
         emit ValidatorSetUpdatedEvent(_nonce, _powerThreshold, _validatorSetHash);
     }
 
+    /// @dev only authorize the upgrade for the owner of the contract.
+    /// Additional access control logic can be added to allow multiple actors to upgrade.
+    /// @dev DO NOT REMOVE! It is mandatory for upgradability.
+    function _authorizeUpgrade(address) internal override onlyOwner {}
+
     /// @notice Utility function to check if a signature is nil.
     /// If all bytes of the 65-byte signature are zero, then it's a nil signature.
     function isSigNil(Signature calldata _sig) private pure returns (bool) {

Diff for: src/QuantumGravityBridge.sol

@@ -77,7 +77,8 @@ contract DAVerifierTest is DSTest {
 
         validators.push(Validator(cheats.addr(testPriv1), votingPower));
         bytes32 hash = computeValidatorSetHash(validators);
-        bridge = new QuantumGravityBridge(initialVelsetNonce, (2 * votingPower) / 3, hash);
+        bridge = new QuantumGravityBridge();
+        bridge.initialize(initialVelsetNonce, (2 * votingPower) / 3, hash);
 
         bytes32 newDataRootTupleRoot =
             domainSeparateDataRootTupleRoot(fixture.dataRootTupleRootNonce(), fixture.dataRootTupleRoot());

Diff for: src/lib/verifier/test/DAVerifier.t.sol

@@ -35,7 +35,8 @@ contract RelayerTest is DSTest {
 
         validators.push(Validator(cheats.addr(testPriv1), votingPower));
         bytes32 hash = computeValidatorSetHash(validators);
-        bridge = new QuantumGravityBridge(initialVelsetNonce, (2 * votingPower) / 3, hash);
+        bridge = new QuantumGravityBridge();
+        bridge.initialize(initialVelsetNonce, (2 * votingPower) / 3, hash);
     }
 
     function testUpdateValidatorSet() public {