fix(prt-contracts): avoid circular dependencies

cartesi · Sep 5, 2024 · b596110 · b596110
1 parent 38726af
commit b596110
Show file tree

Hide file tree

Showing 11 changed files with 63 additions and 44 deletions.
diff --git a/prt/contracts/src/IMultiLevelTournamentFactory.sol b/prt/contracts/src/IMultiLevelTournamentFactory.sol
@@ -0,0 +1,38 @@
+// (c) Cartesi and individual authors (see AUTHORS)
+// SPDX-License-Identifier: Apache-2.0 (see LICENSE)
+
+pragma solidity ^0.8.17;
+
+import "./ITournamentFactory.sol";
+
+import "./tournament/concretes/TopTournament.sol";
+import "./tournament/concretes/MiddleTournament.sol";
+import "./tournament/concretes/BottomTournament.sol";
+
+interface IMultiLevelTournamentFactory is ITournamentFactory {
+    function instantiateTop(Machine.Hash _initialHash)
+        external
+        returns (TopTournament);
+
+    function instantiateMiddle(
+        Machine.Hash _initialHash,
+        Tree.Node _contestedCommitmentOne,
+        Machine.Hash _contestedFinalStateOne,
+        Tree.Node _contestedCommitmentTwo,
+        Machine.Hash _contestedFinalStateTwo,
+        Time.Duration _allowance,
+        uint256 _startCycle,
+        uint64 _level
+    ) external returns (MiddleTournament);
+
+    function instantiateBottom(
+        Machine.Hash _initialHash,
+        Tree.Node _contestedCommitmentOne,
+        Machine.Hash _contestedFinalStateOne,
+        Tree.Node _contestedCommitmentTwo,
+        Machine.Hash _contestedFinalStateTwo,
+        Time.Duration _allowance,
+        uint256 _startCycle,
+        uint64 _level
+    ) external returns (BottomTournament);
+}
diff --git a/prt/contracts/src/tournament/abstracts/NonLeafTournament.sol b/prt/contracts/src/tournament/abstracts/NonLeafTournament.sol
@@ -3,8 +3,7 @@
 
 pragma solidity ^0.8.17;
 
-// import "../factories/multilevel/IMultiLevelTournamentFactory.sol";
-import "../factories/MultiLevelTournamentFactory.sol";
+import "../../IMultiLevelTournamentFactory.sol";
 import "./Tournament.sol";
 import "./NonRootTournament.sol";
 
@@ -22,7 +21,7 @@ abstract contract NonLeafTournament is Tournament {
     //
     // Constants
     //
-    MultiLevelTournamentFactory immutable tournamentFactory;
+    IMultiLevelTournamentFactory immutable tournamentFactory;
 
     //
     // Storage
@@ -47,7 +46,7 @@ abstract contract NonLeafTournament is Tournament {
     //
     // Constructor
     //
-    constructor(MultiLevelTournamentFactory _tournamentFactory) {
+    constructor(IMultiLevelTournamentFactory _tournamentFactory) {
         tournamentFactory = _tournamentFactory;
     }
 

diff --git a/prt/contracts/src/tournament/abstracts/NonRootTournament.sol b/prt/contracts/src/tournament/abstracts/NonRootTournament.sol
@@ -14,8 +14,6 @@ abstract contract NonRootTournament is Tournament {
     //
     // Constants
     //
-    NonLeafTournament immutable parentTournament;
-
     Tree.Node immutable contestedCommitmentOne;
     Machine.Hash immutable contestedFinalStateOne;
     Tree.Node immutable contestedCommitmentTwo;
@@ -32,11 +30,8 @@ abstract contract NonRootTournament is Tournament {
         Machine.Hash _contestedFinalStateTwo,
         Time.Duration _allowance,
         uint256 _startCycle,
-        uint64 _level,
-        NonLeafTournament _parent
+        uint64 _level
     ) Tournament(_initialHash, _allowance, _startCycle, _level) {
-        parentTournament = _parent;
-
         contestedCommitmentOne = _contestedCommitmentOne;
         contestedFinalStateOne = _contestedFinalStateOne;
         contestedCommitmentTwo = _contestedCommitmentTwo;

diff --git a/prt/contracts/src/tournament/concretes/BottomTournament.sol b/prt/contracts/src/tournament/concretes/BottomTournament.sol
@@ -16,8 +16,7 @@ contract BottomTournament is LeafTournament, NonRootTournament {
         Machine.Hash _contestedFinalStateTwo,
         Time.Duration _allowance,
         uint256 _startCycle,
-        uint64 _level,
-        NonLeafTournament _parent
+        uint64 _level
     )
         LeafTournament()
         NonRootTournament(
@@ -28,8 +27,7 @@ contract BottomTournament is LeafTournament, NonRootTournament {
             _contestedFinalStateTwo,
             _allowance,
             _startCycle,
-            _level,
-            _parent
+            _level
         )
     {}
 }
diff --git a/prt/contracts/src/tournament/concretes/MiddleTournament.sol b/prt/contracts/src/tournament/concretes/MiddleTournament.sol
@@ -6,7 +6,7 @@ pragma solidity ^0.8.17;
 import "../abstracts/NonLeafTournament.sol";
 import "../abstracts/NonRootTournament.sol";
 
-import "../factories/MultiLevelTournamentFactory.sol";
+import "../../IMultiLevelTournamentFactory.sol";
 
 /// @notice Middle tournament is non-top, non-bottom of a multi-level instance
 contract MiddleTournament is NonLeafTournament, NonRootTournament {
@@ -19,8 +19,7 @@ contract MiddleTournament is NonLeafTournament, NonRootTournament {
         Time.Duration _allowance,
         uint256 _startCycle,
         uint64 _level,
-        NonLeafTournament _parent,
-        MultiLevelTournamentFactory _tournamentFactory
+        IMultiLevelTournamentFactory _tournamentFactory
     )
         NonLeafTournament(_tournamentFactory)
         NonRootTournament(
@@ -31,8 +30,7 @@ contract MiddleTournament is NonLeafTournament, NonRootTournament {
             _contestedFinalStateTwo,
             _allowance,
             _startCycle,
-            _level,
-            _parent
+            _level
         )
     {}
 }
diff --git a/prt/contracts/src/tournament/concretes/TopTournament.sol b/prt/contracts/src/tournament/concretes/TopTournament.sol
@@ -6,14 +6,14 @@ pragma solidity ^0.8.17;
 import "../abstracts/RootTournament.sol";
 import "../abstracts/NonLeafTournament.sol";
 
-import "../factories/MultiLevelTournamentFactory.sol";
+import "../../IMultiLevelTournamentFactory.sol";
 
 import "../../Machine.sol";
 
 /// @notice Top tournament of a multi-level instance
 contract TopTournament is NonLeafTournament, RootTournament {
-    constructor(Machine.Hash _initialHash, MultiLevelTournamentFactory _factory)
-        NonLeafTournament(_factory)
-        RootTournament(_initialHash)
-    {}
+    constructor(
+        Machine.Hash _initialHash,
+        IMultiLevelTournamentFactory _factory
+    ) NonLeafTournament(_factory) RootTournament(_initialHash) {}
 }
diff --git a/prt/contracts/src/tournament/factories/MultiLevelTournamentFactory.sol b/prt/contracts/src/tournament/factories/MultiLevelTournamentFactory.sol
@@ -3,17 +3,13 @@
 
 pragma solidity ^0.8.17;
 
-import "../../ITournamentFactory.sol";
-
-import "../concretes/TopTournament.sol";
-import "../concretes/MiddleTournament.sol";
-import "../concretes/BottomTournament.sol";
+import "../../IMultiLevelTournamentFactory.sol";
 
 import "./multilevel/TopTournamentFactory.sol";
 import "./multilevel/MiddleTournamentFactory.sol";
 import "./multilevel/BottomTournamentFactory.sol";
 
-contract MultiLevelTournamentFactory is ITournamentFactory {
+contract MultiLevelTournamentFactory is IMultiLevelTournamentFactory {
     TopTournamentFactory immutable topFactory;
     MiddleTournamentFactory immutable middleFactory;
     BottomTournamentFactory immutable bottomFactory;
@@ -64,8 +60,7 @@ contract MultiLevelTournamentFactory is ITournamentFactory {
             _contestedFinalStateTwo,
             _allowance,
             _startCycle,
-            _level,
-            NonLeafTournament(msg.sender)
+            _level
         );
 
         return _tournament;
@@ -89,8 +84,7 @@ contract MultiLevelTournamentFactory is ITournamentFactory {
             _contestedFinalStateTwo,
             _allowance,
             _startCycle,
-            _level,
-            NonLeafTournament(msg.sender)
+            _level
         );
 
         return _tournament;

diff --git a/prt/contracts/src/tournament/factories/multilevel/BottomTournamentFactory.sol b/prt/contracts/src/tournament/factories/multilevel/BottomTournamentFactory.sol
@@ -16,8 +16,7 @@ contract BottomTournamentFactory {
         Machine.Hash _contestedFinalStateTwo,
         Time.Duration _allowance,
         uint256 _startCycle,
-        uint64 _level,
-        NonLeafTournament _parent
+        uint64 _level
     ) external returns (BottomTournament) {
         BottomTournament _tournament = new BottomTournament(
             _initialHash,
@@ -27,8 +26,7 @@ contract BottomTournamentFactory {
             _contestedFinalStateTwo,
             _allowance,
             _startCycle,
-            _level,
-            _parent
+            _level
         );
 
         return _tournament;

diff --git a/prt/contracts/src/tournament/factories/multilevel/MiddleTournamentFactory.sol b/prt/contracts/src/tournament/factories/multilevel/MiddleTournamentFactory.sol
@@ -6,7 +6,7 @@ pragma solidity ^0.8.17;
 import "../../abstracts/NonLeafTournament.sol";
 import "../../concretes/MiddleTournament.sol";
 
-import "../../factories/MultiLevelTournamentFactory.sol";
+import "../../../IMultiLevelTournamentFactory.sol";
 
 import "../../../Machine.sol";
 import "../../../Tree.sol";
@@ -23,8 +23,7 @@ contract MiddleTournamentFactory {
         Machine.Hash _contestedFinalStateTwo,
         Time.Duration _allowance,
         uint256 _startCycle,
-        uint64 _level,
-        NonLeafTournament _parent
+        uint64 _level
     ) external returns (MiddleTournament) {
         MiddleTournament _tournament = new MiddleTournament(
             _initialHash,
@@ -35,8 +34,7 @@ contract MiddleTournamentFactory {
             _allowance,
             _startCycle,
             _level,
-            _parent,
-            MultiLevelTournamentFactory(msg.sender)
+            IMultiLevelTournamentFactory(msg.sender)
         );
 
         return _tournament;

diff --git a/prt/contracts/src/tournament/factories/multilevel/TopTournamentFactory.sol b/prt/contracts/src/tournament/factories/multilevel/TopTournamentFactory.sol
@@ -13,7 +13,7 @@ contract TopTournamentFactory {
         returns (TopTournament)
     {
         TopTournament _tournament = new TopTournament(
-            _initialHash, MultiLevelTournamentFactory(msg.sender)
+            _initialHash, IMultiLevelTournamentFactory(msg.sender)
         );
 
         return _tournament;

diff --git a/prt/contracts/test/Util.sol b/prt/contracts/test/Util.sol
@@ -16,6 +16,7 @@ import "src/tournament/concretes/TopTournament.sol";
 import "src/tournament/concretes/MiddleTournament.sol";
 
 import "src/tournament/factories/SingleLevelTournamentFactory.sol";
+import "src/tournament/factories/MultiLevelTournamentFactory.sol";
 import "src/tournament/factories/multilevel/TopTournamentFactory.sol";
 import "src/tournament/factories/multilevel/MiddleTournamentFactory.sol";
 import "src/tournament/factories/multilevel/BottomTournamentFactory.sol";