Skip to content

Commit

Permalink
Rename bridge fee to bridge reward
Browse files Browse the repository at this point in the history
  • Loading branch information
@varasev
varasev committed Feb 20, 2020
1 parent 16ed5ff commit 9785899
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 56 deletions.
24 changes: 12 additions & 12 deletions contracts/base/BlockRewardAuRaBase.sol
View file
Expand Up @@ -50,8 +50,8 @@ contract BlockRewardAuRaBase is UpgradeableOwned, IBlockRewardAuRa {
mapping(uint256 => mapping(address => uint256)) public blocksCreated;

/// @dev The current bridge's total fee amount of native coins accumulated by
/// the `addBridgeNativeFeeReceivers` function.
uint256 public bridgeNativeFee;
/// the `addBridgeNativeRewardReceivers` function.
uint256 public bridgeNativeReward;

/// @dev The reward amount to be distributed in native coins among participants (the validator and their
/// delegators) of the specified pool (mining address) for the specified staking epoch.
Expand Down Expand Up @@ -110,13 +110,13 @@ contract BlockRewardAuRaBase is UpgradeableOwned, IBlockRewardAuRa {
/// @param bridge The bridge address which called the `addExtraReceiver` function.
event AddedReceiver(uint256 amount, address indexed receiver, address indexed bridge);

/// @dev Emitted by the `addBridgeNativeFeeReceivers` function.
/// @dev Emitted by the `addBridgeNativeRewardReceivers` function.
/// @param amount The fee amount in native coins passed to the
/// `addBridgeNativeFeeReceivers` function as a parameter.
/// @param cumulativeAmount The value of `bridgeNativeFee` state variable
/// `addBridgeNativeRewardReceivers` function as a parameter.
/// @param cumulativeAmount The value of `bridgeNativeReward` state variable
/// after adding the `amount` to it.
/// @param bridge The bridge address which called the `addBridgeNativeFeeReceivers` function.
event BridgeNativeFeeAdded(uint256 amount, uint256 cumulativeAmount, address indexed bridge);
/// @param bridge The bridge address which called the `addBridgeNativeRewardReceivers` function.
event BridgeNativeRewardAdded(uint256 amount, uint256 cumulativeAmount, address indexed bridge);

/// @dev Emitted by the `_mintNativeCoins` function which is called by the `reward` function.
/// This event is only used by the unit tests because the `reward` function cannot emit events.
Expand Down Expand Up @@ -169,10 +169,10 @@ contract BlockRewardAuRaBase is UpgradeableOwned, IBlockRewardAuRa {
/// and distributed to participants (validators and their delegators) in native coins. The specified amount
/// is used by the `_distributeRewards` function.
/// @param _amount The fee amount distributed to participants.
function addBridgeNativeFeeReceivers(uint256 _amount) external onlyErcToNativeBridge {
function addBridgeNativeRewardReceivers(uint256 _amount) external onlyErcToNativeBridge {
require(_amount != 0);
bridgeNativeFee = bridgeNativeFee.add(_amount);
emit BridgeNativeFeeAdded(_amount, bridgeNativeFee, msg.sender);
bridgeNativeReward = bridgeNativeReward.add(_amount);
emit BridgeNativeRewardAdded(_amount, bridgeNativeReward, msg.sender);
}

/// @dev Called by the `erc-to-native` bridge contract when the bridge needs to mint a specified amount of native
Expand Down Expand Up @@ -583,15 +583,15 @@ contract BlockRewardAuRaBase is UpgradeableOwned, IBlockRewardAuRa {
uint256[] memory _blocksCreatedShareNum,
uint256 _blocksCreatedShareDenom
) internal returns(uint256) {
uint256 totalReward = bridgeNativeFee + nativeRewardUndistributed;
uint256 totalReward = bridgeNativeReward + nativeRewardUndistributed;

totalReward += _coinInflationAmount(_stakingEpoch, _validators);

if (totalReward == 0) {
return 0;
}

bridgeNativeFee = 0;
bridgeNativeReward = 0;

uint256 rewardToDistribute = 0;
uint256 distributedAmount = 0;
Expand Down
24 changes: 12 additions & 12 deletions contracts/base/BlockRewardAuRaTokens.sol
View file
Expand Up @@ -19,8 +19,8 @@ contract BlockRewardAuRaTokens is BlockRewardAuRaBase, IBlockRewardAuRaTokens {
address[] internal _nativeToErcBridgesAllowed;

/// @dev The current bridge's total fee amount of staking tokens accumulated by
/// the `addBridgeTokenFeeReceivers` function.
uint256 public bridgeTokenFee;
/// the `addBridgeTokenRewardReceivers` function.
uint256 public bridgeTokenReward;

/// @dev The reward amount to be distributed in staking tokens among participants (the validator and their
/// delegators) of the specified pool (mining address) for the specified staking epoch.
Expand All @@ -40,13 +40,13 @@ contract BlockRewardAuRaTokens is BlockRewardAuRaBase, IBlockRewardAuRaTokens {

// ================================================ Events ========================================================

/// @dev Emitted by the `addBridgeTokenFeeReceivers` function.
/// @dev Emitted by the `addBridgeTokenRewardReceivers` function.
/// @param amount The fee amount in tokens passed to the
/// `addBridgeTokenFeeReceivers` function as a parameter.
/// @param cumulativeAmount The value of `bridgeTokenFee` state variable
/// `addBridgeTokenRewardReceivers` function as a parameter.
/// @param cumulativeAmount The value of `bridgeTokenReward` state variable
/// after adding the `amount` to it.
/// @param bridge The bridge address which called the `addBridgeTokenFeeReceivers` function.
event BridgeTokenFeeAdded(uint256 amount, uint256 cumulativeAmount, address indexed bridge);
/// @param bridge The bridge address which called the `addBridgeTokenRewardReceivers` function.
event BridgeTokenRewardAdded(uint256 amount, uint256 cumulativeAmount, address indexed bridge);

// ============================================== Modifiers =======================================================

Expand All @@ -62,10 +62,10 @@ contract BlockRewardAuRaTokens is BlockRewardAuRaBase, IBlockRewardAuRaTokens {
/// minted and distributed to participants in staking tokens. The specified amount is used by the
/// `_distributeRewards` function.
/// @param _amount The fee amount distributed to participants.
function addBridgeTokenFeeReceivers(uint256 _amount) external onlyXToErcBridge {
function addBridgeTokenRewardReceivers(uint256 _amount) external onlyXToErcBridge {
require(_amount != 0);
bridgeTokenFee = bridgeTokenFee.add(_amount);
emit BridgeTokenFeeAdded(_amount, bridgeTokenFee, msg.sender);
bridgeTokenReward = bridgeTokenReward.add(_amount);
emit BridgeTokenRewardAdded(_amount, bridgeTokenReward, msg.sender);
}

/// @dev Sets the array of `erc-to-erc` bridge addresses which are allowed to call some of the functions with
Expand Down Expand Up @@ -218,15 +218,15 @@ contract BlockRewardAuRaTokens is BlockRewardAuRaBase, IBlockRewardAuRaTokens {
uint256[] memory _blocksCreatedShareNum,
uint256 _blocksCreatedShareDenom
) internal {
uint256 totalReward = bridgeTokenFee + tokenRewardUndistributed;
uint256 totalReward = bridgeTokenReward + tokenRewardUndistributed;

totalReward += _inflationAmount(_stakingEpoch, _validators, STAKE_TOKEN_INFLATION_RATE);

if (totalReward == 0) {
return;
}

bridgeTokenFee = 0;
bridgeTokenReward = 0;

IERC677Minting erc677TokenContract = IERC677Minting(
IStakingAuRaTokens(_stakingContract).erc677TokenContract()
Expand Down
56 changes: 28 additions & 28 deletions test/BlockRewardAuRa.js
View file
Expand Up @@ -201,8 +201,8 @@ contract('BlockRewardAuRa', async accounts => {
(await validatorSetAuRa.emitInitiateChangeCallable.call()).should.be.equal(true);

(await erc677Token.balanceOf.call(blockRewardAuRa.address)).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.tokenRewardUndistributed.call()).should.be.bignumber.equal(tokenRewardUndistributed);

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
Expand Down Expand Up @@ -300,8 +300,8 @@ contract('BlockRewardAuRa', async accounts => {
tokenRewardUndistributed.should.be.bignumber.equal(await blockRewardAuRa.tokenRewardUndistributed.call());

(await erc677Token.balanceOf.call(blockRewardAuRa.address)).should.be.bignumber.equal(rewardDistributed);
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -442,8 +442,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward.add(rewardDistributed));
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -597,8 +597,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward.add(rewardDistributed));
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -724,8 +724,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward);
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -886,8 +886,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward.add(rewardDistributed));
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -1041,8 +1041,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward);
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -1196,8 +1196,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward);
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -1363,8 +1363,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward.add(rewardDistributed));
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -1533,8 +1533,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward.add(rewardDistributed));
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -1671,8 +1671,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward);
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -1806,8 +1806,8 @@ contract('BlockRewardAuRa', async accounts => {
const blockRewardBalanceAfterReward = await erc677Token.balanceOf.call(blockRewardAuRa.address);

blockRewardBalanceAfterReward.should.be.bignumber.equal(blockRewardBalanceBeforeReward.add(rewardDistributed));
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(new BN(0));
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(new BN(0));

const pendingValidators = await validatorSetAuRa.getPendingValidators.call();
pendingValidators.sortedEqual([
Expand Down Expand Up @@ -1852,10 +1852,10 @@ contract('BlockRewardAuRa', async accounts => {
const fee = web3.utils.toWei('1');
await blockRewardAuRa.setNativeToErcBridgesAllowed([owner], {from: owner}).should.be.fulfilled;
await blockRewardAuRa.setErcToNativeBridgesAllowed([owner], {from: owner}).should.be.fulfilled;
await blockRewardAuRa.addBridgeTokenFeeReceivers(fee, {from: owner}).should.be.fulfilled;
await blockRewardAuRa.addBridgeNativeFeeReceivers(fee, {from: owner}).should.be.fulfilled;
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(fee);
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(fee);
await blockRewardAuRa.addBridgeTokenRewardReceivers(fee, {from: owner}).should.be.fulfilled;
await blockRewardAuRa.addBridgeNativeRewardReceivers(fee, {from: owner}).should.be.fulfilled;
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(fee);
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(fee);
return new BN(fee);
}

Expand Down
8 changes: 4 additions & 4 deletions test/StakingAuRa.js
View file
Expand Up @@ -2947,10 +2947,10 @@ contract('StakingAuRa', async accounts => {
const fee = web3.utils.toWei('1');
await blockRewardAuRa.setNativeToErcBridgesAllowed([owner], {from: owner}).should.be.fulfilled;
await blockRewardAuRa.setErcToNativeBridgesAllowed([owner], {from: owner}).should.be.fulfilled;
await blockRewardAuRa.addBridgeTokenFeeReceivers(fee, {from: owner}).should.be.fulfilled;
await blockRewardAuRa.addBridgeNativeFeeReceivers(fee, {from: owner}).should.be.fulfilled;
(await blockRewardAuRa.bridgeTokenFee.call()).should.be.bignumber.equal(fee);
(await blockRewardAuRa.bridgeNativeFee.call()).should.be.bignumber.equal(fee);
await blockRewardAuRa.addBridgeTokenRewardReceivers(fee, {from: owner}).should.be.fulfilled;
await blockRewardAuRa.addBridgeNativeRewardReceivers(fee, {from: owner}).should.be.fulfilled;
(await blockRewardAuRa.bridgeTokenReward.call()).should.be.bignumber.equal(fee);
(await blockRewardAuRa.bridgeNativeReward.call()).should.be.bignumber.equal(fee);
return new BN(fee);
}

Expand Down

0 comments on commit 9785899

Please sign in to comment.