chore: move unused modules

docs/src/content/modules/dispute/bonded_dispute_module.md

@@ -1,5 +1,10 @@
 # Bonded Dispute Module
 
+## This is an example module
+The contracts included in the examples folder have not been thoroughly tested nor audited.
+This are meant to use as example or inspiration for new modules.                          
+==DO NOT USE IN A PRODUCTIVE ENVIRONMENT==
+
 See [IBondedDisputeModule.sol](/solidity/interfaces/modules/dispute/IBondedDisputeModule.sol/interface.IBondedDisputeModule.md) for more details.
 
 ## 1. Introduction

docs/src/content/modules/dispute/circuit_resolver_module.md

@@ -1,5 +1,10 @@
 # Circuit Resolver Module
 
+## This is an example module
+The contracts included in the examples folder have not been thoroughly tested nor audited.
+This are meant to use as example or inspiration for new modules.                          
+==DO NOT USE IN A PRODUCTIVE ENVIRONMENT==
+
 See [ICircuitResolverModule.sol](/solidity/interfaces/modules/dispute/ICircuitResolverModule.sol/interface.ICircuitResolverModule.md) for more details.
 
 ## 1. Introduction

docs/src/content/modules/dispute/root_verification_module.md

@@ -1,5 +1,10 @@
 # Root Verification Module
 
+## This is an example module
+The contracts included in the examples folder have not been thoroughly tested nor audited.
+This are meant to use as example or inspiration for new modules.                          
+==DO NOT USE IN A PRODUCTIVE ENVIRONMENT==
+
 See [IRootVerificationModule.sol](/solidity/interfaces/modules/dispute/IRootVerificationModule.sol/interface.IRootVerificationModule.md) for more details.
 
 ## 1. Introduction

docs/src/content/modules/finality/multiple_callbacks_module.md

@@ -1,5 +1,10 @@
 # Multiple Callbacks Module
 
+## This is an example module
+The contracts included in the examples folder have not been thoroughly tested nor audited.
+This are meant to use as example or inspiration for new modules.                          
+==DO NOT USE IN A PRODUCTIVE ENVIRONMENT==
+
 See [IMultipleCallbacksModule.sol](/solidity/interfaces/modules/finality/IMultipleCallbacksModule.sol/interface.IMultipleCallbacksModule.md) for more details.
 
 ## 1. Introduction

docs/src/content/modules/request/contract_call_request_module.md

@@ -1,5 +1,10 @@
 # Contract Call Request Module
 
+## This is an example module
+The contracts included in the examples folder have not been thoroughly tested nor audited.
+This are meant to use as example or inspiration for new modules.                          
+==DO NOT USE IN A PRODUCTIVE ENVIRONMENT==
+
 See [IContractCallRequestModule.sol](/solidity/interfaces/modules/request/IContractCallRequestModule.sol/interface.IContractCallRequestModule.md) for more details.
 
 ## 1. Introduction

docs/src/content/modules/request/sparse_merkle_tree_request_module.md

@@ -1,5 +1,10 @@
 # Sparse Merkle Tree Request Module
 
+## This is an example module
+The contracts included in the examples folder have not been thoroughly tested nor audited.
+This are meant to use as example or inspiration for new modules.                          
+==DO NOT USE IN A PRODUCTIVE ENVIRONMENT==
+
 See [ISparseMerkleTreeRequestModule.sol](/solidity/interfaces/modules/request/ISparseMerkleTreeRequestModule.sol/interface.ISparseMerkleTreeRequestModule.md) for more details.
 
 ## 1. Introduction

docs/src/content/modules/resolution/bond_escalation_resolution_module.md

@@ -1,5 +1,10 @@
 # Bond Escalation Resolution Module
 
+## This is an example module
+The contracts included in the examples folder have not been thoroughly tested nor audited.
+This are meant to use as example or inspiration for new modules.                          
+==DO NOT USE IN A PRODUCTIVE ENVIRONMENT==
+
 See [IBondEscalationResolutionModule.sol](/solidity/interfaces/modules/resolution/IBondEscalationResolutionModule.sol/interface.IBondEscalationResolutionModule.md) for more details.
 
 ## 1. Introduction

docs/src/content/modules/resolution/erc20_resolution_module.md

@@ -1,5 +1,10 @@
 # ERC20 Resolution Module
 
+## This is an example module
+The contracts included in the examples folder have not been thoroughly tested nor audited.
+This are meant to use as example or inspiration for new modules.                          
+==DO NOT USE IN A PRODUCTIVE ENVIRONMENT==
+
 See [IERC20ResolutionModule.sol](/solidity/interfaces/modules/resolution/IERC20ResolutionModule.sol/interface.IERC20ResolutionModule.md) for more details.
 
 ## 1. Introduction

docs/src/content/modules/resolution/private_erc20_resolution_module.md

@@ -1,5 +1,10 @@
 # Private ERC20 Resolution Module
 
+## This is an example module
+The contracts included in the examples folder have not been thoroughly tested nor audited.
+This are meant to use as example or inspiration for new modules.                          
+==DO NOT USE IN A PRODUCTIVE ENVIRONMENT==
+
 See [IPrivateERC20ResolutionModule.sol](/solidity/interfaces/modules/resolution/IPrivateERC20ResolutionModule.sol/interface.IPrivateERC20ResolutionModule.md) for more details.
 
 ## 1. Introduction

solidity/contracts/examples/README.md

@@ -0,0 +1,4 @@
+> [!CAUTION]
+> Do not use the contracts in the example folder for production.
+
+The contracts included in the examples folder have not been thoroughly tested nor audited. This are meant to use as example or inspiration for new modules. Do not use them in a production environment.

solidity/contracts/modules/dispute/BondedDisputeModule.sol → solidity/contracts/examples/modules/dispute/BondedDisputeModule.sol

@@ -4,8 +4,13 @@ pragma solidity ^0.8.19;
 import {IModule, Module} from '@defi-wonderland/prophet-core/solidity/contracts/Module.sol';
 import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle.sol';
 
-import {IBondedDisputeModule} from '../../../interfaces/modules/dispute/IBondedDisputeModule.sol';
+import {IBondedDisputeModule} from '../../../../interfaces/examples/modules/dispute/IBondedDisputeModule.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 contract BondedDisputeModule is Module, IBondedDisputeModule {
   constructor(IOracle _oracle) Module(_oracle) {}
 

solidity/contracts/modules/dispute/CircuitResolverModule.sol → solidity/contracts/examples/modules/dispute/CircuitResolverModule.sol

@@ -4,9 +4,14 @@ pragma solidity ^0.8.19;
 import {IModule, Module} from '@defi-wonderland/prophet-core/solidity/contracts/Module.sol';
 import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle.sol';
 
-import {IProphetVerifier} from '../../../interfaces/IProphetVerifier.sol';
-import {ICircuitResolverModule} from '../../../interfaces/modules/dispute/ICircuitResolverModule.sol';
-
+import {IProphetVerifier} from '../../../../interfaces/IProphetVerifier.sol';
+import {ICircuitResolverModule} from '../../../../interfaces/examples/modules/dispute/ICircuitResolverModule.sol';
+
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 contract CircuitResolverModule is Module, ICircuitResolverModule {
   /// @notice Keeps track of the correct responses to requests
   mapping(bytes32 _requestId => bytes _correctResponse) internal _correctResponses;

solidity/contracts/modules/dispute/RootVerificationModule.sol → solidity/contracts/examples/modules/dispute/RootVerificationModule.sol

@@ -4,9 +4,14 @@ pragma solidity ^0.8.19;
 import {IModule, Module} from '@defi-wonderland/prophet-core/solidity/contracts/Module.sol';
 import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle.sol';
 
-import {IRootVerificationModule} from '../../../interfaces/modules/dispute/IRootVerificationModule.sol';
-import {MerkleLib} from '../../libraries/MerkleLib.sol';
-
+import {IRootVerificationModule} from '../../../../interfaces/examples/modules/dispute/IRootVerificationModule.sol';
+import {MerkleLib} from '../../../libraries/MerkleLib.sol';
+
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 contract RootVerificationModule is Module, IRootVerificationModule {
   using MerkleLib for MerkleLib.Tree;
 

solidity/contracts/modules/finality/MultipleCallbacksModule.sol → solidity/contracts/examples/modules/finality/MultipleCallbacksModule.sol

@@ -4,9 +4,14 @@ pragma solidity ^0.8.19;
 import {IModule, Module} from '@defi-wonderland/prophet-core/solidity/contracts/Module.sol';
 import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle.sol';
 
-import {IProphetCallback} from '../../../interfaces/IProphetCallback.sol';
-import {IMultipleCallbacksModule} from '../../../interfaces/modules/finality/IMultipleCallbacksModule.sol';
+import {IProphetCallback} from '../../../../interfaces/IProphetCallback.sol';
+import {IMultipleCallbacksModule} from '../../../../interfaces/examples/modules/finality/IMultipleCallbacksModule.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 contract MultipleCallbacksModule is Module, IMultipleCallbacksModule {
   constructor(IOracle _oracle) Module(_oracle) {}
 

solidity/contracts/modules/request/ContractCallRequestModule.sol → solidity/contracts/examples/modules/request/ContractCallRequestModule.sol

@@ -4,8 +4,14 @@ pragma solidity ^0.8.19;
 import {IModule, Module} from '@defi-wonderland/prophet-core/solidity/contracts/Module.sol';
 import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle.sol';
 
-import {IContractCallRequestModule} from '../../../interfaces/modules/request/IContractCallRequestModule.sol';
+import {IContractCallRequestModule} from
+  '../../../../interfaces/examples/modules/request/IContractCallRequestModule.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 contract ContractCallRequestModule is Module, IContractCallRequestModule {
   constructor(IOracle _oracle) Module(_oracle) {}
 

solidity/contracts/modules/request/SparseMerkleTreeRequestModule.sol → solidity/contracts/examples/modules/request/SparseMerkleTreeRequestModule.sol

@@ -4,8 +4,14 @@ pragma solidity ^0.8.19;
 import {IModule, Module} from '@defi-wonderland/prophet-core/solidity/contracts/Module.sol';
 import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle.sol';
 
-import {ISparseMerkleTreeRequestModule} from '../../../interfaces/modules/request/ISparseMerkleTreeRequestModule.sol';
+import {ISparseMerkleTreeRequestModule} from
+  '../../../../interfaces/examples/modules/request/ISparseMerkleTreeRequestModule.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 contract SparseMerkleTreeRequestModule is Module, ISparseMerkleTreeRequestModule {
   constructor(IOracle _oracle) Module(_oracle) {}
 

solidity/contracts/modules/resolution/BondEscalationResolutionModule.sol → solidity/contracts/examples/modules/resolution/BondEscalationResolutionModule.sol

@@ -3,7 +3,7 @@
 
 // solhint-disable-next-line no-unused-import
 
 import {IERC20} from '@openzeppelin/contracts/token/ERC20/IERC20.sol';
 import {SafeERC20} from '@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol';
 import {FixedPointMathLib} from 'solmate/src/utils/FixedPointMathLib.sol';
 
@@ -15,8 +15,13 @@
   '@defi-wonderland/prophet-core/solidity/interfaces/modules/resolution/IResolutionModule.sol';
 
 import {IBondEscalationResolutionModule} from
-  '../../../interfaces/modules/resolution/IBondEscalationResolutionModule.sol';
+  '../../../../interfaces/examples/modules/resolution/IBondEscalationResolutionModule.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 contract BondEscalationResolutionModule is Module, IBondEscalationResolutionModule {
   using SafeERC20 for IERC20;
 

solidity/contracts/modules/resolution/ERC20ResolutionModule.sol → solidity/contracts/examples/modules/resolution/ERC20ResolutionModule.sol

@@ -9,7 +9,12 @@ import {EnumerableSet} from '@openzeppelin/contracts/utils/structs/EnumerableSet
 import {IModule, Module} from '@defi-wonderland/prophet-core/solidity/contracts/Module.sol';
 import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle.sol';
 
-import {IERC20ResolutionModule} from '../../../interfaces/modules/resolution/IERC20ResolutionModule.sol';
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
+import {IERC20ResolutionModule} from '../../../../interfaces/examples/modules/resolution/IERC20ResolutionModule.sol';
 
 contract ERC20ResolutionModule is Module, IERC20ResolutionModule {
   using SafeERC20 for IERC20;

solidity/contracts/modules/resolution/PrivateERC20ResolutionModule.sol → solidity/contracts/examples/modules/resolution/PrivateERC20ResolutionModule.sol

@@ -9,8 +9,14 @@ import {EnumerableSet} from '@openzeppelin/contracts/utils/structs/EnumerableSet
 import {IModule, Module} from '@defi-wonderland/prophet-core/solidity/contracts/Module.sol';
 import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle.sol';
 
-import {IPrivateERC20ResolutionModule} from '../../../interfaces/modules/resolution/IPrivateERC20ResolutionModule.sol';
-
+import {IPrivateERC20ResolutionModule} from
+  '../../../../interfaces/examples/modules/resolution/IPrivateERC20ResolutionModule.sol';
+
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 contract PrivateERC20ResolutionModule is Module, IPrivateERC20ResolutionModule {
   using SafeERC20 for IERC20;
   using EnumerableSet for EnumerableSet.AddressSet;

solidity/interfaces/modules/dispute/IBondedDisputeModule.sol → solidity/interfaces/examples/modules/dispute/IBondedDisputeModule.sol

@@ -5,8 +5,13 @@ import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle
 import {IDisputeModule} from '@defi-wonderland/prophet-core/solidity/interfaces/modules/dispute/IDisputeModule.sol';
 import {IERC20} from '@openzeppelin/contracts/token/ERC20/IERC20.sol';
 
-import {IAccountingExtension} from '../../extensions/IAccountingExtension.sol';
+import {IAccountingExtension} from '../../../extensions/IAccountingExtension.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 /*
   * @title BondedDisputeModule
   * @notice Module allowing users to dispute a proposed response

solidity/interfaces/modules/dispute/ICircuitResolverModule.sol → solidity/interfaces/examples/modules/dispute/ICircuitResolverModule.sol

@@ -5,8 +5,13 @@ import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle
 import {IDisputeModule} from '@defi-wonderland/prophet-core/solidity/interfaces/modules/dispute/IDisputeModule.sol';
 import {IERC20} from '@openzeppelin/contracts/token/ERC20/IERC20.sol';
 
-import {IAccountingExtension} from '../../extensions/IAccountingExtension.sol';
+import {IAccountingExtension} from '../../../extensions/IAccountingExtension.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 /**
  * @title CircuitResolverModule
  * @notice Module allowing users to dispute a proposed response by bonding tokens.

solidity/interfaces/modules/dispute/IRootVerificationModule.sol → solidity/interfaces/examples/modules/dispute/IRootVerificationModule.sol

@@ -5,9 +5,14 @@ import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle
 import {IDisputeModule} from '@defi-wonderland/prophet-core/solidity/interfaces/modules/dispute/IDisputeModule.sol';
 import {IERC20} from '@openzeppelin/contracts/token/ERC20/IERC20.sol';
 
-import {ITreeVerifier} from '../../ITreeVerifier.sol';
-import {IAccountingExtension} from '../../extensions/IAccountingExtension.sol';
+import {ITreeVerifier} from '../../../ITreeVerifier.sol';
+import {IAccountingExtension} from '../../../extensions/IAccountingExtension.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 /*
   * @title RootVerificationModule
   * @notice Dispute module allowing disputers to calculate the correct root for a given request and propose it as a response.

solidity/interfaces/modules/finality/IMultipleCallbacksModule.sol → solidity/interfaces/examples/modules/finality/IMultipleCallbacksModule.sol

@@ -4,6 +4,11 @@ pragma solidity ^0.8.19;
 import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle.sol';
 import {IFinalityModule} from '@defi-wonderland/prophet-core/solidity/interfaces/modules/finality/IFinalityModule.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 /**
  * @title MultipleCallbackModule
  * @notice Module allowing users to make multiple calls to different contracts

solidity/interfaces/modules/request/IContractCallRequestModule.sol → solidity/interfaces/examples/modules/request/IContractCallRequestModule.sol

@@ -5,8 +5,13 @@ import {IOracle} from '@defi-wonderland/prophet-core/solidity/interfaces/IOracle
 import {IRequestModule} from '@defi-wonderland/prophet-core/solidity/interfaces/modules/request/IRequestModule.sol';
 import {IERC20} from '@openzeppelin/contracts/token/ERC20/IERC20.sol';
 
-import {IAccountingExtension} from '../../../interfaces/extensions/IAccountingExtension.sol';
+import {IAccountingExtension} from '../../../../interfaces/extensions/IAccountingExtension.sol';
 
+// ==========================================WARNING========================================= //
+// The contracts included in the examples folder have not been thoroughly tested nor audited. //
+// This are meant to use as example or inspiration for new modules.                           //
+// DO NOT USE IN A PRODUCTIVE ENVIRONMENT.                                                    //
+// ==========================================WARNING========================================= //
 /**
  * @title ContractCallRequestModule
  * @notice Request module for making contract calls