Skip to content

Commit

Permalink
fix: renamed TokenCircuitBreaker to AssetCircuitBreaker
Browse files Browse the repository at this point in the history
  • Loading branch information
Keinberger committed Aug 22, 2023
1 parent 816f950 commit 36c75ca
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ import {IERC20} from "openzeppelin-contracts/token/ERC20/IERC20.sol";
import {Ownable} from "openzeppelin-contracts/access/Ownable.sol";

import {IERC7265CircuitBreaker} from "../interfaces/IERC7265CircuitBreaker.sol";
import {ITokenCircuitBreaker} from "../interfaces/ITokenCircuitBreaker.sol";
import {IAssetCircuitBreaker} from "../interfaces/IAssetCircuitBreaker.sol";
import {ISettlementModule} from "../interfaces/ISettlementModule.sol";

import {CircuitBreaker} from "./CircuitBreaker.sol";

import {Limiter} from "../static/Structs.sol";
import {LimiterLib, LimitStatus} from "../utils/LimiterLib.sol";

contract TokenCircuitBreaker is CircuitBreaker, ITokenCircuitBreaker {
contract AssetCircuitBreaker is CircuitBreaker, IAssetCircuitBreaker {
using LimiterLib for Limiter;
using SafeERC20 for IERC20;

Expand Down
6 changes: 3 additions & 3 deletions assets/eip-7265/src/core/ProtectedContract.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ pragma solidity ^0.8.20;

import {SafeERC20} from "openzeppelin-contracts/token/ERC20/utils/SafeERC20.sol";
import {IERC20} from "openzeppelin-contracts/token/ERC20/IERC20.sol";
import {ITokenCircuitBreaker} from "../interfaces/ITokenCircuitBreaker.sol";
import {IAssetCircuitBreaker} from "../interfaces/IAssetCircuitBreaker.sol";

// The ProtectedContract that uses a circuitBreaker for enforcing the circuit breaker
contract ProtectedContract {
// Use the SafeERC20 library for the IERC20 interface
using SafeERC20 for IERC20;

// The circuitBreaker used by this contract
ITokenCircuitBreaker public circuitBreaker;
IAssetCircuitBreaker public circuitBreaker;

// Initialize the contract with a circuitBreaker
constructor(address _circuitBreaker) {
circuitBreaker = ITokenCircuitBreaker(_circuitBreaker);
circuitBreaker = IAssetCircuitBreaker(_circuitBreaker);
}

// Internal function to be used when tokens are deposited
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ pragma solidity ^0.8.19;

import {IERC7265CircuitBreaker} from "./IERC7265CircuitBreaker.sol";

/// @title ITokenCircuitBreaker
/// @dev This interface defines the methods for the TokenCircuitBreaker
interface ITokenCircuitBreaker is IERC7265CircuitBreaker {
/// @title IAssetCircuitBreaker
/// @dev This interface defines the methods for the AssetCircuitBreaker
interface IAssetCircuitBreaker is IERC7265CircuitBreaker {
/// @dev MUST be emitted in `onTokenInflow` and `onNativeAssetInflow` when an asset is successfully deposited
/// @param asset MUST be the address of the asset withdrawn.
/// For any EIP-20 token, MUST be an EIP-20 token contract.
Expand Down
10 changes: 5 additions & 5 deletions assets/eip-7265/test/core/admin/CircuitBreakerAdminOps.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pragma solidity ^0.8.19;
import {Test} from "forge-std/Test.sol";
import {MockToken} from "../../mocks/MockToken.sol";
import {MockDeFiProtocol} from "../../mocks/MockDeFiProtocol.sol";
import {TokenCircuitBreaker} from "../../../src/core/TokenCircuitBreaker.sol";
import {AssetCircuitBreaker} from "../../../src/core/AssetCircuitBreaker.sol";
import {DelayedSettlementModule} from "../../../src/settlement/DelayedSettlementModule.sol";
import {LimiterLib} from "../../../src/utils/LimiterLib.sol";

Expand All @@ -14,7 +14,7 @@ contract CircuitBreakerAdminOpsTest is Test {
MockToken internal unlimitedToken;

address internal NATIVE_ADDRESS_PROXY = address(1);
TokenCircuitBreaker internal circuitBreaker;
AssetCircuitBreaker internal circuitBreaker;
DelayedSettlementModule internal delayedSettlementModule;
MockDeFiProtocol internal deFi;

Expand All @@ -24,7 +24,7 @@ contract CircuitBreakerAdminOpsTest is Test {

function setUp() public {
token = new MockToken("USDC", "USDC");
circuitBreaker = new TokenCircuitBreaker(4 hours, 5 minutes, admin);
circuitBreaker = new AssetCircuitBreaker(4 hours, 5 minutes, admin);
deFi = new MockDeFiProtocol(address(circuitBreaker));

address[] memory addresses = new address[](1);
Expand Down Expand Up @@ -52,7 +52,7 @@ contract CircuitBreakerAdminOpsTest is Test {
}

function test_initialization_shouldBeSuccessful() public {
TokenCircuitBreaker newCircuitBreaker = new TokenCircuitBreaker(
AssetCircuitBreaker newCircuitBreaker = new AssetCircuitBreaker(
3 hours,
5 minutes,
admin
Expand Down Expand Up @@ -190,7 +190,7 @@ contract CircuitBreakerAdminOpsTest is Test {
}

function testSetLimiterOverriden() public {
circuitBreaker = new TokenCircuitBreaker(4 hours, 5 minutes, admin);
circuitBreaker = new AssetCircuitBreaker(4 hours, 5 minutes, admin);
bytes32 identifier = "test";
bool overrideStatus = true;
bool expected = true;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {MockToken} from "../../mocks/MockToken.sol";
import {MockDeFiProtocol} from "../../mocks/MockDeFiProtocol.sol";

import "../../../src/core/CircuitBreaker.sol";
import {TokenCircuitBreaker} from "../../../src/core/TokenCircuitBreaker.sol";
import {AssetCircuitBreaker} from "../../../src/core/AssetCircuitBreaker.sol";
import {DelayedSettlementModule} from "../../../src/settlement/DelayedSettlementModule.sol";
import {LimiterLib} from "../../../src/utils/LimiterLib.sol";

Expand All @@ -25,7 +25,7 @@ contract CircuitBreakerEmergencyOpsTest is Test {
MockToken internal unlimitedToken;

address internal NATIVE_ADDRESS_PROXY = address(1);
TokenCircuitBreaker internal circuitBreaker;
AssetCircuitBreaker internal circuitBreaker;
DelayedSettlementModule internal delayedSettlementModule;
MockDeFiProtocol internal deFi;

Expand All @@ -34,7 +34,7 @@ contract CircuitBreakerEmergencyOpsTest is Test {
address internal admin = vm.addr(0x3);

function setUp() public {
circuitBreaker = new TokenCircuitBreaker(4 hours, 5 minutes, admin);
circuitBreaker = new AssetCircuitBreaker(4 hours, 5 minutes, admin);
delayedSettlementModule = new DelayedSettlementModule(
1 seconds,
new address[](0),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ import "forge-std/console.sol";

import {Test} from "forge-std/Test.sol";
import {MockToken} from "../../mocks/MockToken.sol";
import {TokenCircuitBreaker} from "../../../src/core/TokenCircuitBreaker.sol";
import {AssetCircuitBreaker} from "../../../src/core/AssetCircuitBreaker.sol";
import {DelayedSettlementModule} from "../../../src/settlement/DelayedSettlementModule.sol";
import {LimiterLib} from "../../../src/utils/LimiterLib.sol";

contract TokenCircuitBreakerTest is Test {
contract AssetCircuitBreakerTest is Test {
MockToken internal token;
MockToken internal secondToken;
MockToken internal unlimitedToken;

address internal NATIVE_ADDRESS_PROXY = address(1);
TokenCircuitBreaker internal circuitBreaker;
AssetCircuitBreaker internal circuitBreaker;
DelayedSettlementModule internal delayedSettlementModule;

address internal alice = vm.addr(0x1);
Expand All @@ -37,7 +37,7 @@ contract TokenCircuitBreakerTest is Test {

function setUp() public {
token = new MockToken("USDC", "USDC");
circuitBreaker = new TokenCircuitBreaker(4 hours, 5 minutes, admin);
circuitBreaker = new AssetCircuitBreaker(4 hours, 5 minutes, admin);
delayedSettlementModule = new DelayedSettlementModule(
1 seconds,
new address[](0),
Expand Down
6 changes: 3 additions & 3 deletions assets/eip-7265/test/core/user/CircuitBreakerUserOps.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pragma solidity ^0.8.19;
import {Test} from "forge-std/Test.sol";
import {MockToken} from "../../mocks/MockToken.sol";
import {MockDeFiProtocol} from "../../mocks/MockDeFiProtocol.sol";
import {TokenCircuitBreaker} from "../../../src/core/TokenCircuitBreaker.sol";
import {AssetCircuitBreaker} from "../../../src/core/AssetCircuitBreaker.sol";
import {DelayedSettlementModule} from "../../../src/settlement/DelayedSettlementModule.sol";
import {LimiterLib} from "../../../src/utils/LimiterLib.sol";

Expand All @@ -14,7 +14,7 @@ contract CircuitBreakerUserOpsTest is Test {
MockToken internal unlimitedToken;

address internal NATIVE_ADDRESS_PROXY = address(1);
TokenCircuitBreaker internal circuitBreaker;
AssetCircuitBreaker internal circuitBreaker;
DelayedSettlementModule internal delayedSettlementModule;
MockDeFiProtocol internal deFi;

Expand All @@ -24,7 +24,7 @@ contract CircuitBreakerUserOpsTest is Test {

function setUp() public {
token = new MockToken("USDC", "USDC");
circuitBreaker = new TokenCircuitBreaker(4 hours, 5 minutes, admin);
circuitBreaker = new AssetCircuitBreaker(4 hours, 5 minutes, admin);
delayedSettlementModule = new DelayedSettlementModule(
1 seconds,
new address[](0),
Expand Down

0 comments on commit 36c75ca

Please sign in to comment.