Organized the directory structure

JOJOexchange · Aug 26, 2024 · dffe9cb · dffe9cb
1 parent b1b01ed
commit dffe9cb
Show file tree

Hide file tree

Showing 47 changed files with 96 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -134,7 +134,7 @@ See `newSubaccount()` in [SubaccountFactory.sol](./src/subaccount/SubaccountFact
 
 ## Lending System
 
-There are only one core smart contracts: [JUSDBank.sol](./src/JUSDBank.sol).
+There are only one core smart contracts: [JUSDBank.sol](./src/JUSDBank/JUSDBank.sol).
 
 - `JUSDBank.sol` is the core accounting sheet of the whole collateral lending system and contains all "external" functions.
 

diff --git a/script/deployDepositStableCoin.s.sol b/script/deployDepositStableCoin.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "../lib/forge-std/src/Script.sol";
-import "../src/DepositStableCoinToDealer.sol";
+import "../src/helpers/DepositStableCoinToDealer.sol";
 
 contract DepositStableCoinToDealerScript is Script {
     // add this to be excluded from coverage report

diff --git a/script/deployDistrobutor.s.sol b/script/deployDistrobutor.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "../lib/forge-std/src/Script.sol";
-import "../src/MerkleDistributorWithDeadline.sol";
+import "../src/token/MerkleDistributorWithDeadline.sol";
 
 contract MerkleDistributorWithDeadlineScript is Script {
     // add this to be excluded from coverage report

diff --git a/script/deployFlashLiquidate.s.sol b/script/deployFlashLiquidate.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "forge-std/Script.sol";
-import "../src/FlashLoanLiquidate.sol";
+import "../src/JUSDBank/FlashLoanLiquidate.sol";
 
 contract FlashLiquidateScript is Script {
     // add this to be excluded from coverage report

diff --git a/script/deployFlashRepay.s.sol b/script/deployFlashRepay.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "forge-std/Script.sol";
-import "../src/FlashLoanRepay.sol";
+import "../src/JUSDBank/FlashLoanRepay.sol";
 
 contract FlashRepayScript is Script {
     // add this to be excluded from coverage report

diff --git a/script/deployFundingRateArbitrageScript.s.sol b/script/deployFundingRateArbitrageScript.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "forge-std/Script.sol";
-import "../src/FundingRateArbitrage.sol";
+import "../src/fundingRateArbitrage/FundingRateArbitrage.sol";
 
 contract FundingRateArbitrageScript is Script {
     // add this to be excluded from coverage report

diff --git a/script/deployFundingRateLimiter.s.sol b/script/deployFundingRateLimiter.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "../lib/forge-std/src/Script.sol";
-import "../src/FundingRateUpdateLimiter.sol";
+import "../src/fundingRateLimiter/FundingRateUpdateLimiter.sol";
 
 contract FundingRateUpdateLimiterScript is Script {
     // add this to be excluded from coverage report

diff --git a/script/deployGeneralRepay.s.sol b/script/deployGeneralRepay.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "forge-std/Script.sol";
-import "../src/GeneralRepay.sol";
+import "../src/JUSDBank/GeneralRepay.sol";
 
 contract GeneralRepayScript is Script {
     // add this to be excluded from coverage report

diff --git a/script/deployJUSDBank.s.sol b/script/deployJUSDBank.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "forge-std/Script.sol";
-import "../src/JUSDBank.sol";
+import "../src/JUSDBank/JUSDBank.sol";
 
 contract JUSDBankScript is Script {
     // add this to be excluded from coverage report

diff --git a/script/deployJUSDExchange.s.sol b/script/deployJUSDExchange.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "forge-std/Script.sol";
-import "../src/JUSDExchange.sol";
+import "../src/JUSDBank/JUSDExchange.sol";
 
 contract JUSDExchangeScript is Script {
     // add this to be excluded from coverage report

diff --git a/script/deployJUSDRepayHelper.s.sol b/script/deployJUSDRepayHelper.s.sol
@@ -3,7 +3,7 @@
 pragma solidity ^0.8.19;
 
 import "forge-std/Script.sol";
-import "../src/JUSDRepayHelper.sol";
+import "../src/JUSDBank/JUSDRepayHelper.sol";
 
 contract JUSDRepayHelperScript is Script {
     // add this to be excluded from coverage report

diff --git a/src/FlashLoanLiquidate.sol → src/JUSDBank/FlashLoanLiquidate.sol b/src/FlashLoanLiquidate.sol → src/JUSDBank/FlashLoanLiquidate.sol
@@ -8,9 +8,9 @@ pragma solidity ^0.8.19;
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import "./interfaces/IJUSDBank.sol";
-import "./interfaces/IJUSDExchange.sol";
-import "./libraries/SignedDecimalMath.sol";
+import "../interfaces/IJUSDBank.sol";
+import "../interfaces/IJUSDExchange.sol";
+import "../libraries/SignedDecimalMath.sol";
 
 contract FlashLoanLiquidate is Ownable {
     using SafeERC20 for IERC20;

diff --git a/src/FlashLoanLiquidateJwrapMUSDC.sol → ...JUSDBank/FlashLoanLiquidateJwrapMUSDC.sol b/src/FlashLoanLiquidateJwrapMUSDC.sol → ...JUSDBank/FlashLoanLiquidateJwrapMUSDC.sol
@@ -7,10 +7,10 @@ pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import "./interfaces/IJUSDBank.sol";
-import "./interfaces/IJUSDExchange.sol";
-import "./libraries/SignedDecimalMath.sol";
-import "./token/JWrapMUSDC.sol";
+import "../interfaces/IJUSDBank.sol";
+import "../interfaces/IJUSDExchange.sol";
+import "../libraries/SignedDecimalMath.sol";
+import "../token/JWrapMUSDC.sol";
 
 interface MTokenInter {
     function redeem(uint256 redeemTokens) external returns (uint256);

diff --git a/src/FlashLoanLiquidateMtoken.sol → src/JUSDBank/FlashLoanLiquidateMtoken.sol b/src/FlashLoanLiquidateMtoken.sol → src/JUSDBank/FlashLoanLiquidateMtoken.sol
@@ -7,9 +7,9 @@ pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import "./interfaces/IJUSDBank.sol";
-import "./interfaces/IJUSDExchange.sol";
-import "./libraries/SignedDecimalMath.sol";
+import "../interfaces/IJUSDBank.sol";
+import "../interfaces/IJUSDExchange.sol";
+import "../libraries/SignedDecimalMath.sol";
 
 interface MTokenInterface {
     function redeem(uint redeemTokens) external returns (uint);

diff --git a/src/FlashLoanRepay.sol → src/JUSDBank/FlashLoanRepay.sol b/src/FlashLoanRepay.sol → src/JUSDBank/FlashLoanRepay.sol
@@ -8,9 +8,9 @@ pragma solidity ^0.8.19;
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import "./interfaces/IJUSDBank.sol";
-import "./interfaces/IJUSDExchange.sol";
-import "./libraries/SignedDecimalMath.sol";
+import "../interfaces/IJUSDBank.sol";
+import "../interfaces/IJUSDExchange.sol";
+import "../libraries/SignedDecimalMath.sol";
 
 contract FlashLoanRepay is Ownable {
     using SafeERC20 for IERC20;

diff --git a/src/GeneralRepay.sol → src/JUSDBank/GeneralRepay.sol b/src/GeneralRepay.sol → src/JUSDBank/GeneralRepay.sol
@@ -5,8 +5,8 @@
 
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import "./interfaces/IJUSDBank.sol";
-import "./interfaces/IJUSDExchange.sol";
+import "../interfaces/IJUSDBank.sol";
+import "../interfaces/IJUSDExchange.sol";
 
 pragma solidity ^0.8.19;
 

diff --git a/src/JUSDBank.sol → src/JUSDBank/JUSDBank.sol b/src/JUSDBank.sol → src/JUSDBank/JUSDBank.sol
@@ -6,10 +6,10 @@
 pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import "./interfaces/IJUSDBank.sol";
-import "./interfaces/IFlashLoanReceive.sol";
-import "./interfaces/IDealer.sol";
-import "./interfaces/internal/IPriceSource.sol";
+import "../interfaces/IJUSDBank.sol";
+import "../interfaces/IFlashLoanReceive.sol";
+import "../interfaces/IDealer.sol";
+import "../interfaces/internal/IPriceSource.sol";
 import "./JUSDOperation.sol";
 import "./JUSDView.sol";
 import "./JUSDBankStorage.sol";

diff --git a/src/JUSDBankStorage.sol → src/JUSDBank/JUSDBankStorage.sol b/src/JUSDBankStorage.sol → src/JUSDBank/JUSDBankStorage.sol
@@ -7,9 +7,9 @@ pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
-import "./libraries/FlashLoanReentrancyGuard.sol";
-import "./libraries/SignedDecimalMath.sol";
-import "./libraries/Types.sol";
+import "../libraries/FlashLoanReentrancyGuard.sol";
+import "../libraries/SignedDecimalMath.sol";
+import "../libraries/Types.sol";
 
 abstract contract JUSDBankStorage is Ownable, ReentrancyGuard, FlashLoanReentrancyGuard {
     using SignedDecimalMath for uint256;

diff --git a/src/JUSDExchange.sol → src/JUSDBank/JUSDExchange.sol b/src/JUSDExchange.sol → src/JUSDBank/JUSDExchange.sol
@@ -7,9 +7,9 @@ pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import "./interfaces/IJUSDExchange.sol";
-import "./interfaces/IDealer.sol";
-import "./libraries/Errors.sol";
+import "../interfaces/IJUSDExchange.sol";
+import "../interfaces/IDealer.sol";
+import "../libraries/Errors.sol";
 
 contract JUSDExchange is IJUSDExchange, Ownable {
     using SafeERC20 for IERC20;

diff --git a/src/JUSDMulticall.sol → src/JUSDBank/JUSDMulticall.sol b/src/JUSDMulticall.sol → src/JUSDBank/JUSDMulticall.sol
@@ -5,7 +5,7 @@
 
 pragma solidity ^0.8.19;
 
-import "./libraries/SignedDecimalMath.sol";
+import "../libraries/SignedDecimalMath.sol";
 import "./JUSDBank.sol";
 
 /// @notice User's multi-step operation on the JUSDBank like: deposit and borrow

diff --git a/src/JUSDOperation.sol → src/JUSDBank/JUSDOperation.sol b/src/JUSDOperation.sol → src/JUSDBank/JUSDOperation.sol
@@ -5,8 +5,8 @@
 
 pragma solidity ^0.8.19;
 
-import "./libraries/Errors.sol";
-import "./libraries/SignedDecimalMath.sol";
+import "../libraries/Errors.sol";
+import "../libraries/SignedDecimalMath.sol";
 import "./JUSDBankStorage.sol";
 
 /// @notice Owner-only functions

diff --git a/src/JUSDRepayHelper.sol → src/JUSDBank/JUSDRepayHelper.sol b/src/JUSDRepayHelper.sol → src/JUSDBank/JUSDRepayHelper.sol
@@ -4,7 +4,7 @@
 */
 
 import "@openzeppelin/contracts/access/Ownable.sol";
-import "./interfaces/IJUSDExchange.sol";
+import "../interfaces/IJUSDExchange.sol";
 import "./JUSDBank.sol";
 
 pragma solidity ^0.8.19;

diff --git a/src/JUSDView.sol → src/JUSDBank/JUSDView.sol b/src/JUSDView.sol → src/JUSDBank/JUSDView.sol
@@ -5,10 +5,10 @@
 
 pragma solidity ^0.8.19;
 
-import "./interfaces/IJUSDBank.sol";
-import "./interfaces/internal/IPriceSource.sol";
+import "../interfaces/IJUSDBank.sol";
+import "../interfaces/internal/IPriceSource.sol";
+import "../libraries/SignedDecimalMath.sol";
 import "./JUSDBankStorage.sol";
-import "./libraries/SignedDecimalMath.sol";
 
 abstract contract JUSDView is JUSDBankStorage, IJUSDBank {
     using SignedDecimalMath for uint256;

diff --git a/src/DegenDealer.sol → src/degen/DegenDealer.sol b/src/DegenDealer.sol → src/degen/DegenDealer.sol
@@ -5,7 +5,7 @@
 
 pragma solidity ^0.8.19;
 
-import "./interfaces/IDealer.sol";
+import "../interfaces/IDealer.sol";
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 

diff --git a/src/DegenDepositHelper.sol → src/degen/DegenDepositHelper.sol b/src/DegenDepositHelper.sol → src/degen/DegenDepositHelper.sol
diff --git a/src/FundingRateArbitrage.sol → ...ingRateArbitrage/FundingRateArbitrage.sol b/src/FundingRateArbitrage.sol → ...ingRateArbitrage/FundingRateArbitrage.sol
@@ -7,9 +7,9 @@ import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "@openzeppelin/contracts/utils/math/SafeCast.sol";
-import "./JOJODealer.sol";
-import "./libraries/SignedDecimalMath.sol";
-import "./interfaces/internal/IPriceSource.sol";
+import "../JOJODealer.sol";
+import "../libraries/SignedDecimalMath.sol";
+import "../interfaces/internal/IPriceSource.sol";
 
 pragma solidity ^0.8.19;
 

diff --git a/src/FundingRateUpdateLimiter.sol → ...gRateLimiter/FundingRateUpdateLimiter.sol b/src/FundingRateUpdateLimiter.sol → ...gRateLimiter/FundingRateUpdateLimiter.sol
@@ -6,11 +6,11 @@
 pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/access/Ownable.sol";
-import "./interfaces/internal/IPriceSource.sol";
-import "./interfaces/IDealer.sol";
-import "./interfaces/IPerpetual.sol";
-import "./libraries/Types.sol";
-import "./libraries/SignedDecimalMath.sol";
+import "../interfaces/internal/IPriceSource.sol";
+import "../interfaces/IDealer.sol";
+import "../interfaces/IPerpetual.sol";
+import "../libraries/Types.sol";
+import "../libraries/SignedDecimalMath.sol";
 
 /// @notice Limiting funding rate change speed
 /// Mainly for preventing JOJO's backend errors

diff --git a/src/FundingRateUpdateZk.sol → ...undingRateLimiter/FundingRateUpdateZk.sol b/src/FundingRateUpdateZk.sol → ...undingRateLimiter/FundingRateUpdateZk.sol
@@ -7,13 +7,13 @@ pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/utils/math/SafeCast.sol";
-import "./libraries/brevis/IBrevisProof.sol";
-import "./libraries/brevis/BrevisApp.sol";
-import "./interfaces/internal/IPriceSource.sol";
-import "./interfaces/IDealer.sol";
-import "./interfaces/IPerpetual.sol";
-import "./libraries/Types.sol";
-import "./libraries/SignedDecimalMath.sol";
+import "../libraries/brevis/IBrevisProof.sol";
+import "../libraries/brevis/BrevisApp.sol";
+import "../interfaces/internal/IPriceSource.sol";
+import "../interfaces/IDealer.sol";
+import "../interfaces/IPerpetual.sol";
+import "../libraries/Types.sol";
+import "../libraries/SignedDecimalMath.sol";
 
 /// @notice Limiting funding rate change speed
 /// Mainly for preventing JOJO's backend errors

diff --git a/src/DepositStableCoinToDealer.sol → src/helpers/DepositStableCoinToDealer.sol b/src/DepositStableCoinToDealer.sol → src/helpers/DepositStableCoinToDealer.sol
@@ -6,7 +6,7 @@ pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import "./interfaces/IDealer.sol";
+import "../interfaces/IDealer.sol";
 
 interface IWETH {
     function deposit() external payable;

diff --git a/src/DepositStableCoinToDegenDealer.sol → ...elpers/DepositStableCoinToDegenDealer.sol b/src/DepositStableCoinToDegenDealer.sol → ...elpers/DepositStableCoinToDegenDealer.sol
@@ -6,7 +6,7 @@ pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import "./DegenDealer.sol";
+import "../degen/DegenDealer.sol";
 
 interface IWETH {
     function deposit() external payable;

diff --git a/src/oracle/EarnOracle.sol b/src/oracle/EarnOracle.sol
@@ -6,7 +6,7 @@
 pragma solidity ^0.8.19;
 
 
-import "../FundingRateArbitrage.sol";
+import "../fundingRateArbitrage/FundingRateArbitrage.sol";
 
 contract EarnOracle {
 

diff --git a/src/PriceFollowOrder.sol → src/smartOrders/PriceFollowOrder.sol b/src/PriceFollowOrder.sol → src/smartOrders/PriceFollowOrder.sol
@@ -5,14 +5,14 @@
 
 pragma solidity ^0.8.9;
 
-import "./JOJODealer.sol";
-import "./libraries/EIP712.sol";
-import "./libraries/Types.sol";
-import "./libraries/Trading.sol";
-import "./libraries/SignedDecimalMath.sol";
-import "./interfaces/IDealer.sol";
-import "./interfaces/IPerpetual.sol";
-import "./interfaces/internal/IPriceSource.sol";
+import "../JOJODealer.sol";
+import "../libraries/EIP712.sol";
+import "../libraries/Types.sol";
+import "../libraries/Trading.sol";
+import "../libraries/SignedDecimalMath.sol";
+import "../interfaces/IDealer.sol";
+import "../interfaces/IPerpetual.sol";
+import "../interfaces/internal/IPriceSource.sol";
 import "@openzeppelin/contracts/access/Ownable.sol";
 
 contract PriceFollowOrder is Ownable {

diff --git a/src/support/FlattenHelper.sol b/src/support/FlattenHelper.sol
@@ -5,16 +5,16 @@
 
 pragma solidity ^0.8.19;
 
-import "../DegenDepositHelper.sol";
-import "../FlashLoanLiquidate.sol";
-import "../FlashLoanRepay.sol";
-import "../FundingRateUpdateLimiter.sol";
-import "../FundingRateArbitrage.sol";
+import "../degen/DegenDepositHelper.sol";
+import "../JUSDBank/FlashLoanLiquidate.sol";
+import "../JUSDBank/FlashLoanRepay.sol";
+import "../fundingRateLimiter/FundingRateUpdateLimiter.sol";
+import "../fundingRateArbitrage/FundingRateArbitrage.sol";
 import "../JOJODealer.sol";
-import "../DegenDealer.sol";
-import "../JUSDBank.sol";
+import "../degen/DegenDealer.sol";
+import "../JUSDBank/JUSDBank.sol";
 import "../Perpetual.sol";
-import "../MerkleDistributorWithDeadline.sol";
+import "../token/MerkleDistributorWithDeadline.sol";
 import "../oracle/EmergencyOracle.sol";
 import "../oracle/OracleAdaptor.sol";
 import "../subaccount/SubaccountFactory.sol";

diff --git a/src/support/HelperContract.sol b/src/support/HelperContract.sol
@@ -10,7 +10,7 @@ import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import "../interfaces/IJUSDBank.sol";
 import "../interfaces/IPerpetual.sol";
 import "../libraries/Types.sol";
-import "../FundingRateArbitrage.sol";
+import "../fundingRateArbitrage/FundingRateArbitrage.sol";
 
 contract HelperContract {
     JOJODealer public jojoDealer;

diff --git a/src/MerkleDistributor.sol → src/token/MerkleDistributor.sol b/src/MerkleDistributor.sol → src/token/MerkleDistributor.sol
diff --git a/src/MerkleDistributorWithDeadline.sol → src/token/MerkleDistributorWithDeadline.sol b/src/MerkleDistributorWithDeadline.sol → src/token/MerkleDistributorWithDeadline.sol