clean up file structure for external devs (#43)

* order file structure for contracts * update test dir imports * move GeneralMW to new directory called base * fix import * remove /src folder (unused)
open-ibc · Feb 19, 2024 · f915d5f · f915d5f
1 parent 4151e64
commit f915d5f
Show file tree

Hide file tree

Showing 28 changed files with 75 additions and 121 deletions.
diff --git a/contracts/GeneralMiddleware.sol → contracts/base/GeneralMiddleware.sol b/contracts/GeneralMiddleware.sol → contracts/base/GeneralMiddleware.sol
@@ -2,10 +2,10 @@
 
 pragma solidity ^0.8.9;
 
-import './Ibc.sol';
-import './IbcReceiver.sol';
-import './IbcDispatcher.sol';
-import './IbcMiddleware.sol';
+import '../libs/Ibc.sol';
+import '../interfaces/IbcReceiver.sol';
+import '../interfaces/IbcDispatcher.sol';
+import '../interfaces/IbcMiddleware.sol';
 
 contract GeneralMiddleware is IbcMwUser, IbcMiddleware, IbcMwEventsEmitter {
     /**

diff --git a/contracts/Dispatcher.sol → contracts/core/Dispatcher.sol b/contracts/Dispatcher.sol → contracts/core/Dispatcher.sol
@@ -4,9 +4,9 @@ pragma solidity ^0.8.9;
 
 import '@openzeppelin/contracts/utils/Strings.sol';
 import '@openzeppelin/contracts/access/Ownable.sol';
-import './IbcDispatcher.sol';
-import {IbcChannelReceiver, IbcPacketReceiver} from './IbcReceiver.sol';
-import './ConsensusStateManager.sol';
+import '../interfaces/IbcDispatcher.sol';
+import {IbcChannelReceiver, IbcPacketReceiver} from '../interfaces/IbcReceiver.sol';
+import '../interfaces/ConsensusStateManager.sol';
 
 /**
  * @title Dispatcher

diff --git a/contracts/OpConsensusStateManager.sol → contracts/core/OpConsensusStateManager.sol b/contracts/OpConsensusStateManager.sol → contracts/core/OpConsensusStateManager.sol
@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
-import './Ibc.sol';
-import './ConsensusStateManager.sol';
+import '../libs/Ibc.sol';
+import '../interfaces/ConsensusStateManager.sol';
 
 import {L1Block} from 'optimism/L2/L1Block.sol';
 

diff --git a/contracts/OpProofVerifier.sol → contracts/core/OpProofVerifier.sol b/contracts/OpProofVerifier.sol → contracts/core/OpProofVerifier.sol
@@ -5,7 +5,7 @@ import {SecureMerkleTrie} from 'optimism/libraries/trie/SecureMerkleTrie.sol';
 import {RLPReader} from 'optimism/libraries/rlp/RLPReader.sol';
 import {RLPWriter} from 'optimism/libraries/rlp/RLPWriter.sol';
 
-import './ProofVerifier.sol';
+import '../interfaces/ProofVerifier.sol';
 
 contract OpProofVerifier is ProofVerifier {
     using RLPReader for RLPReader.RLPItem;

diff --git a/contracts/UniversalChannelHandler.sol → contracts/core/UniversalChannelHandler.sol b/contracts/UniversalChannelHandler.sol → contracts/core/UniversalChannelHandler.sol
@@ -3,10 +3,10 @@
 pragma solidity ^0.8.9;
 
 import '@openzeppelin/contracts/access/Ownable.sol';
-import './IbcDispatcher.sol';
-import './IbcMiddleware.sol';
-import {IbcReceiver} from './IbcReceiver.sol';
-import './Ibc.sol';
+import '../interfaces/IbcDispatcher.sol';
+import '../interfaces/IbcMiddleware.sol';
+import {IbcReceiver} from '../interfaces/IbcReceiver.sol';
+import '../libs/Ibc.sol';
 
 contract UniversalChannelHandler is IbcReceiverBase, IbcUniversalChannelMW {
     constructor(IbcDispatcher _dispatcher) IbcReceiverBase(_dispatcher) {}

diff --git a/contracts/Earth.sol → contracts/examples/Earth.sol b/contracts/Earth.sol → contracts/examples/Earth.sol
@@ -2,10 +2,10 @@
 
 pragma solidity ^0.8.9;
 
-import './Ibc.sol';
-import './IbcReceiver.sol';
-import './IbcDispatcher.sol';
-import './IbcMiddleware.sol';
+import '../libs/Ibc.sol';
+import '../interfaces/IbcReceiver.sol';
+import '../interfaces/IbcDispatcher.sol';
+import '../interfaces/IbcMiddleware.sol';
 
 contract Earth is IbcMwUser, IbcUniversalPacketReceiver {
     struct UcPacketWithChannel {

diff --git a/contracts/Mars.sol → contracts/examples/Mars.sol b/contracts/Mars.sol → contracts/examples/Mars.sol
@@ -2,9 +2,9 @@
 
 pragma solidity ^0.8.9;
 
-import './Ibc.sol';
-import './IbcReceiver.sol';
-import './IbcDispatcher.sol';
+import '../libs/Ibc.sol';
+import '../interfaces/IbcReceiver.sol';
+import '../interfaces/IbcDispatcher.sol';
 
 contract Mars is IbcReceiverBase, IbcReceiver {
     // received packet as chain B

diff --git a/contracts/ConsensusStateManager.sol → ...acts/interfaces/ConsensusStateManager.sol b/contracts/ConsensusStateManager.sol → ...acts/interfaces/ConsensusStateManager.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
-import './Ibc.sol';
+import '../libs/Ibc.sol';
 import './ProofVerifier.sol';
 
 interface ConsensusStateManager {

diff --git a/contracts/IbcDispatcher.sol → contracts/interfaces/IbcDispatcher.sol b/contracts/IbcDispatcher.sol → contracts/interfaces/IbcDispatcher.sol
@@ -2,7 +2,7 @@
 
 pragma solidity ^0.8.9;
 
-import './Ibc.sol';
+import '../libs/Ibc.sol';
 import './IbcReceiver.sol';
 import './ProofVerifier.sol';
 

diff --git a/contracts/IbcMiddleware.sol → contracts/interfaces/IbcMiddleware.sol b/contracts/IbcMiddleware.sol → contracts/interfaces/IbcMiddleware.sol
@@ -2,7 +2,7 @@
 
 pragma solidity ^0.8.9;
 
-import './Ibc.sol';
+import '../libs/Ibc.sol';
 import './IbcDispatcher.sol';
 import './IbcReceiver.sol';
 

diff --git a/contracts/IbcReceiver.sol → contracts/interfaces/IbcReceiver.sol b/contracts/IbcReceiver.sol → contracts/interfaces/IbcReceiver.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.9;
 
 import '@openzeppelin/contracts/access/Ownable.sol';
 import './IbcDispatcher.sol';
-import './Ibc.sol';
+import '../libs/Ibc.sol';
 
 /**
  * @title IbcChannelReceiver

diff --git a/contracts/ProofVerifier.sol → contracts/interfaces/ProofVerifier.sol b/contracts/ProofVerifier.sol → contracts/interfaces/ProofVerifier.sol
diff --git a/contracts/Ibc.sol → contracts/libs/Ibc.sol b/contracts/Ibc.sol → contracts/libs/Ibc.sol
diff --git a/contracts/DummyConsensusStateManager.sol → ...acts/utils/DummyConsensusStateManager.sol b/contracts/DummyConsensusStateManager.sol → ...acts/utils/DummyConsensusStateManager.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
-import './ConsensusStateManager.sol';
+import '../interfaces/ConsensusStateManager.sol';
 
 /**
  * @title DummyConsensusStateManager

diff --git a/contracts/DummyProofVerifier.sol → contracts/utils/DummyProofVerifier.sol b/contracts/DummyProofVerifier.sol → contracts/utils/DummyProofVerifier.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
-import './ProofVerifier.sol';
+import '../interfaces/ProofVerifier.sol';
 
 contract DummyProofVerifier is ProofVerifier {
     function verifyStateUpdate(L1Header calldata, OpL2StateProof calldata, bytes32, bytes32, uint64) external pure {}

diff --git a/contracts/GasAudit.sol → contracts/utils/GasAudit.sol b/contracts/GasAudit.sol → contracts/utils/GasAudit.sol
diff --git a/src/index.ts b/src/index.ts
diff --git a/test/Dispatcher.base.t.sol b/test/Dispatcher.base.t.sol
@@ -3,14 +3,14 @@ pragma solidity ^0.8.13;
 
 import 'forge-std/Test.sol';
 import './Proof.base.t.sol';
-import '../contracts/Ibc.sol';
-import {Dispatcher} from '../contracts/Dispatcher.sol';
-import {IbcEventsEmitter} from '../contracts/IbcDispatcher.sol';
-import {IbcChannelReceiver} from '../contracts/IbcReceiver.sol';
-import '../contracts/Mars.sol';
-import '../contracts/OpConsensusStateManager.sol';
-import '../contracts/DummyConsensusStateManager.sol';
-import '../contracts/OpProofVerifier.sol';
+import '../contracts/libs/Ibc.sol';
+import {Dispatcher} from '../contracts/core/Dispatcher.sol';
+import {IbcEventsEmitter} from '../contracts/interfaces/IbcDispatcher.sol';
+import {IbcChannelReceiver} from '../contracts/interfaces/IbcReceiver.sol';
+import '../contracts/examples/Mars.sol';
+import '../contracts/core/OpConsensusStateManager.sol';
+import '../contracts/utils/DummyConsensusStateManager.sol';
+import '../contracts/core/OpProofVerifier.sol';
 
 struct LocalEnd {
     IbcChannelReceiver receiver;

diff --git a/test/Dispatcher.client.t.sol b/test/Dispatcher.client.t.sol
@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.13;
 
-import '../contracts/Ibc.sol';
-import {Dispatcher} from '../contracts/Dispatcher.sol';
-import {IbcEventsEmitter} from '../contracts/IbcDispatcher.sol';
-import {IbcReceiver} from '../contracts/IbcReceiver.sol';
-import '../contracts/Mars.sol';
-import '../contracts/OpConsensusStateManager.sol';
+import '../contracts/libs/Ibc.sol';
+import {Dispatcher} from '../contracts/core/Dispatcher.sol';
+import {IbcEventsEmitter} from '../contracts/interfaces/IbcDispatcher.sol';
+import {IbcReceiver} from '../contracts/interfaces/IbcReceiver.sol';
+import '../contracts/examples/Mars.sol';
+import '../contracts/core/OpConsensusStateManager.sol';
 import './Dispatcher.base.t.sol';
 
 contract ClientTestBase is Base {

diff --git a/test/Dispatcher.proof.t.sol b/test/Dispatcher.proof.t.sol
@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.15;
 
-import '../contracts/Ibc.sol';
-import {Dispatcher} from '../contracts/Dispatcher.sol';
-import '../contracts/Mars.sol';
-import '../contracts/OpConsensusStateManager.sol';
+import '../contracts/libs/Ibc.sol';
+import {Dispatcher} from '../contracts/core/Dispatcher.sol';
+import '../contracts/examples/Mars.sol';
+import '../contracts/core/OpConsensusStateManager.sol';
 import './Proof.base.t.sol';
 import {stdStorage, StdStorage} from 'forge-std/Test.sol';
 

diff --git a/test/Dispatcher.t.sol b/test/Dispatcher.t.sol
@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.13;
 
-import '../contracts/Ibc.sol';
-import {Dispatcher} from '../contracts/Dispatcher.sol';
-import {IbcEventsEmitter} from '../contracts/IbcDispatcher.sol';
-import {IbcReceiver} from '../contracts/IbcReceiver.sol';
-import '../contracts/Mars.sol';
-import '../contracts/OpConsensusStateManager.sol';
+import '../contracts/libs/Ibc.sol';
+import {Dispatcher} from '../contracts/core/Dispatcher.sol';
+import {IbcEventsEmitter} from '../contracts/interfaces/IbcDispatcher.sol';
+import {IbcReceiver} from '../contracts/interfaces/IbcReceiver.sol';
+import '../contracts/examples/Mars.sol';
+import '../contracts/core/OpConsensusStateManager.sol';
 import './Dispatcher.base.t.sol';
 
 contract ChannelHandshakeTest is Base {

diff --git a/test/Ibc.t.sol b/test/Ibc.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
-import '../contracts/Ibc.sol';
+import '../contracts/libs/Ibc.sol';
 import 'forge-std/Test.sol';
 
 contract IbcTest is Ibc, Test {

diff --git a/test/OpConsensusStateManager.t.sol b/test/OpConsensusStateManager.t.sol
@@ -2,8 +2,8 @@
 pragma solidity ^0.8.0;
 
 import 'forge-std/Test.sol';
-import '../contracts/OpConsensusStateManager.sol';
-import '../contracts/DummyProofVerifier.sol';
+import '../contracts/core/OpConsensusStateManager.sol';
+import '../contracts/utils/DummyProofVerifier.sol';
 import './Proof.base.t.sol';
 
 contract OptimisticConsensusStateManagerTest is ProofBase {

diff --git a/test/Proof.base.t.sol b/test/Proof.base.t.sol
@@ -2,8 +2,8 @@
 pragma solidity ^0.8.0;
 
 import 'forge-std/Test.sol';
-import '../contracts/Ibc.sol';
-import '../contracts/OpProofVerifier.sol';
+import '../contracts/libs/Ibc.sol';
+import '../contracts/core/OpProofVerifier.sol';
 import {L1Block} from 'optimism/L2/L1Block.sol';
 
 contract ProofBase is Test, Ibc {

diff --git a/test/Verifier.t.sol b/test/Verifier.t.sol
@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
-import '../contracts/OpProofVerifier.sol';
-import '../contracts/Ibc.sol';
+import '../contracts/core/OpProofVerifier.sol';
+import '../contracts/libs/Ibc.sol';
 import 'forge-std/Test.sol';
 import './Proof.base.t.sol';
 

diff --git a/test/VirtualChain.sol b/test/VirtualChain.sol
@@ -3,15 +3,15 @@ pragma solidity ^0.8.13;
 
 import 'forge-std/Test.sol';
 import '@openzeppelin/contracts/utils/Strings.sol';
-import '../contracts/Ibc.sol';
-import '../contracts/Dispatcher.sol';
-import '../contracts/ProofVerifier.sol';
-import {UniversalChannelHandler} from '../contracts/UniversalChannelHandler.sol';
-import {Mars} from '../contracts/Mars.sol';
-import {Earth} from '../contracts/Earth.sol';
-import {IbcMiddleware} from '../contracts/IbcMiddleware.sol';
-import {GeneralMiddleware} from '../contracts/GeneralMiddleware.sol';
-import '../contracts/DummyConsensusStateManager.sol';
+import '../contracts/libs/Ibc.sol';
+import '../contracts/core/Dispatcher.sol';
+import '../contracts/interfaces/ProofVerifier.sol';
+import {UniversalChannelHandler} from '../contracts/core/UniversalChannelHandler.sol';
+import {Mars} from '../contracts/examples/Mars.sol';
+import {Earth} from '../contracts/examples/Earth.sol';
+import {IbcMiddleware} from '../contracts/interfaces/IbcMiddleware.sol';
+import {GeneralMiddleware} from '../contracts/base/GeneralMiddleware.sol';
+import '../contracts/utils/DummyConsensusStateManager.sol';
 
 struct ChannelSetting {
     ChannelOrder ordering;

diff --git a/test/payload/ack.t.sol b/test/payload/ack.t.sol
@@ -3,7 +3,7 @@ pragma solidity ^0.8.13;
 
 import 'forge-std/Test.sol';
 
-import '../../contracts/Ibc.sol';
+import '../../contracts/libs/Ibc.sol';
 
 contract AckContract {
     // getAckPacketBytes returns the bytes representation of the AckPacket

diff --git a/test/universal.channel.t.sol b/test/universal.channel.t.sol
@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.13;
 
-import '../contracts/Ibc.sol';
-import {Dispatcher} from '../contracts/Dispatcher.sol';
-import {IbcEventsEmitter} from '../contracts/IbcDispatcher.sol';
-import {IbcReceiver} from '../contracts/IbcReceiver.sol';
-import '../contracts/UniversalChannelHandler.sol';
-import '../contracts/Mars.sol';
-import '../contracts/OpConsensusStateManager.sol';
+import '../contracts/libs/Ibc.sol';
+import {Dispatcher} from '../contracts/core/Dispatcher.sol';
+import {IbcEventsEmitter} from '../contracts/interfaces/IbcDispatcher.sol';
+import {IbcReceiver} from '../contracts/interfaces/IbcReceiver.sol';
+import '../contracts/core/UniversalChannelHandler.sol';
+import '../contracts/examples/Mars.sol';
+import '../contracts/core/OpConsensusStateManager.sol';
 import './Dispatcher.base.t.sol';
 import './VirtualChain.sol';