Skip to content

Commit 39743f8

Browse files
author
Michał Sieczkowski
authored
💫 Rename contracts in contracts-por package (#1206)
* Fix a comment * Rename IPoRToken -> IProofOfReserveToken * Rename TrueCurrencyWithPoR -> TrueCurrencyWithProofOfReserve * Rename TrueUSDWithPoR -> TrueUSD * Fix comments
1 parent ad4dd7e commit 39743f8

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

packages/contracts-por/contracts/TokenControllerV3.sol

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
66
import {IRegistry} from "./interface/IRegistry.sol";
77
import {IOwnedUpgradeabilityProxy} from "./interface/IOwnedUpgradeabilityProxy.sol";
88
import {ITrueCurrency} from "./interface/ITrueCurrency.sol";
9-
import {IPoRToken} from "./interface/IPoRToken.sol";
9+
import {IProofOfReserveToken} from "./interface/IProofOfReserveToken.sol";
1010

1111
/**
1212
* @dev Contract that can be called with a gas refund
@@ -640,27 +640,27 @@ contract TokenControllerV3 {
640640
* Set new chainReserveFeed address
641641
*/
642642
function setChainReserveFeed(address newFeed) external onlyOwner {
643-
IPoRToken(address(token)).setChainReserveFeed(newFeed);
643+
IProofOfReserveToken(address(token)).setChainReserveFeed(newFeed);
644644
}
645645

646646
/**
647647
* Set new chainReserveHeartbeat
648648
*/
649649
function setChainReserveHeartbeat(uint256 newHeartbeat) external onlyProofOfReserveEnablerOrOwner {
650-
IPoRToken(address(token)).setChainReserveHeartbeat(newHeartbeat);
650+
IProofOfReserveToken(address(token)).setChainReserveHeartbeat(newHeartbeat);
651651
}
652652

653653
/**
654654
* Disable Proof of Reserve check
655655
*/
656656
function disableProofOfReserve() external onlyProofOfReserveEnablerOrOwner {
657-
IPoRToken(address(token)).disableProofOfReserve();
657+
IProofOfReserveToken(address(token)).disableProofOfReserve();
658658
}
659659

660660
/**
661661
* Enable Proof of Reserve check
662662
*/
663663
function enableProofOfReserve() external onlyProofOfReserveEnablerOrOwner {
664-
IPoRToken(address(token)).enableProofOfReserve();
664+
IProofOfReserveToken(address(token)).enableProofOfReserve();
665665
}
666666
}

packages/contracts-por/contracts/TrueCurrencyWithPoR.sol renamed to packages/contracts-por/contracts/TrueCurrencyWithProofOfReserve.sol

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ pragma solidity 0.6.10;
33

44
import {TrueCurrency} from "./TrueCurrency.sol";
55
import {AggregatorV3Interface} from "@chainlink/contracts/src/v0.6/interfaces/AggregatorV3Interface.sol";
6-
import {IPoRToken} from "./interface/IPoRToken.sol";
6+
import {IProofOfReserveToken} from "./interface/IProofOfReserveToken.sol";
77
import {SafeMath} from "@openzeppelin/contracts/math/SafeMath.sol";
88

99
/**
10-
* @title TrueCurrencyWithPoR
11-
* @dev TrueCurrencyPoR is an ERC20 with blacklist & redemption addresses.
10+
* @title TrueCurrencyWithProofOfReserve
11+
* @dev TrueCurrencyWithProofOfReserve is an ERC20 with blacklist & redemption addresses.
1212
* Please see TrueCurrency for the implementation that this contract inherits from.
1313
* This contract implements an additional check against a Proof-of-Reserves feed before
1414
* allowing tokens to be minted.
1515
*/
16-
abstract contract TrueCurrencyWithPoR is TrueCurrency, IPoRToken {
16+
abstract contract TrueCurrencyWithProofOfReserve is TrueCurrency, IProofOfReserveToken {
1717
using SafeMath for uint256;
1818

1919
/**

packages/contracts-por/contracts/common/ProxyStorage.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ contract ProxyStorage {
5656
mapping(address => bool) isBlacklisted;
5757
mapping(address => bool) public canBurn;
5858

59-
// PoR feed-related variables
59+
// Proof of Reserve feed related variables
6060
uint256 public chainReserveHeartbeat;
6161
address public chainReserveFeed;
6262
bool public proofOfReserveEnabled;

packages/contracts-por/contracts/interface/IPoRToken.sol renamed to packages/contracts-por/contracts/interface/IProofOfReserveToken.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-License-Identifier: MIT
22
pragma solidity 0.6.10;
33

4-
interface IPoRToken {
4+
interface IProofOfReserveToken {
55
/*** Admin Functions ***/
66

77
function setChainReserveFeed(address newFeed) external;

packages/contracts-por/contracts/tokens/TrueUSDWithPoR.sol renamed to packages/contracts-por/contracts/tokens/TrueUSD.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
// SPDX-License-Identifier: MIT
22
pragma solidity 0.6.10;
33

4-
import {TrueCurrencyWithPoR} from "../TrueCurrencyWithPoR.sol";
4+
import {TrueCurrencyWithProofOfReserve} from "../TrueCurrencyWithProofOfReserve.sol";
55

66
/**
77
* @title TrueUSD
88
* @dev This is the top-level ERC20 contract, but most of the interesting functionality is
99
* inherited - see the documentation on the corresponding contracts.
1010
*/
11-
contract TrueUSDWithPoR is TrueCurrencyWithPoR {
11+
contract TrueUSD is TrueCurrencyWithProofOfReserve {
1212
uint8 constant DECIMALS = 18;
1313
uint8 constant ROUNDING = 2;
1414

packages/contracts-por/test/TrueCurrencyWithPoR.test.ts renamed to packages/contracts-por/test/TrueUSD.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ import { timeTravel } from 'utils/timeTravel'
77
import {
88
MockV3Aggregator,
99
MockV3Aggregator__factory,
10-
TrueCurrencyWithPoR,
11-
TrueUSDWithPoR__factory,
10+
TrueUSD,
11+
TrueUSD__factory,
1212
} from 'contracts'
1313

1414
use(waffle.solidity)
@@ -22,15 +22,15 @@ describe('TrueCurrency with Proof-of-reserves check', () => {
2222
const ONE_DAY_SECONDS = 24 * 60 * 60 // seconds in a day
2323
const TUSD_FEED_INITIAL_ANSWER = exp(1_000_000, 18).toString() // "1M TUSD in reserves"
2424
const AMOUNT_TO_MINT = utils.parseEther('1000000')
25-
let token: TrueCurrencyWithPoR
25+
let token: TrueUSD
2626
let mockV3Aggregator: MockV3Aggregator
2727
let owner: Wallet
2828

2929
before(async () => {
3030
const provider = waffle.provider;
3131
[owner] = provider.getWallets()
3232

33-
token = (await new TrueUSDWithPoR__factory(owner).deploy()) as TrueCurrencyWithPoR
33+
token = (await new TrueUSD__factory(owner).deploy()) as TrueUSD
3434

3535
// Deploy a mock aggregator to mock Proof of Reserve feed answers
3636
mockV3Aggregator = await new MockV3Aggregator__factory(owner).deploy(

0 commit comments

Comments
 (0)