Updated naming on reward vault

This commit is contained in:
Greg Hysen 2019-06-17 17:24:11 -07:00
parent bbacce2986
commit cafa3c827c
6 changed files with 32 additions and 38 deletions

View File

@ -318,7 +318,7 @@ contract Staking is
///// REWARDS ///// ///// REWARDS /////
function computeOperatorReward(address operator, bytes32 poolId) function computeOperatorRewardBalance(address operator, bytes32 poolId)
external external
view view
returns (uint256) returns (uint256)
@ -326,7 +326,7 @@ contract Staking is
} }
function computeDelegatorReward(address owner, bytes32 poolId) function computeDelegatorRewardBalance(address owner, bytes32 poolId)
external external
view view
returns (uint256) returns (uint256)

View File

@ -173,7 +173,7 @@ contract MixinStake is
// update delegator's share of reward pool // update delegator's share of reward pool
// note that this uses the snapshot parameters // note that this uses the snapshot parameters
uint256 poolBalance = rewardVault.poolBalanceOf(poolId); uint256 poolBalance = rewardVault.balanceOfPool(poolId);
uint256 buyIn = _computeBuyInDenominatedInShadowAsset( uint256 buyIn = _computeBuyInDenominatedInShadowAsset(
amount, amount,
_delegatedStakeByPoolId, _delegatedStakeByPoolId,
@ -215,7 +215,7 @@ contract MixinStake is
// get payout // get payout
// TODO -- not full balance, just balance that belongs to delegators. // TODO -- not full balance, just balance that belongs to delegators.
uint256 poolBalance = rewardVault.poolBalanceOf(poolId); uint256 poolBalance = rewardVault.balanceOfPool(poolId);
uint256 payoutInRealAsset; uint256 payoutInRealAsset;
uint256 payoutInShadowAsset; uint256 payoutInShadowAsset;
if (_delegatedStakeToPoolByOwner == amount) { if (_delegatedStakeToPoolByOwner == amount) {

View File

@ -49,12 +49,12 @@ interface IRewardVault {
view view
returns (uint256); returns (uint256);
function operatorBalanceOf(bytes32 poolId) function balanceOfOperator(bytes32 poolId)
external external
view view
returns (uint256); returns (uint256);
function poolBalanceOf(bytes32 poolId) function balanceOfPool(bytes32 poolId)
external external
view view
returns (uint256); returns (uint256);

View File

@ -136,7 +136,7 @@ contract RewardVault is
return balance.operatorBalance + balance.poolBalance; return balance.operatorBalance + balance.poolBalance;
} }
function operatorBalanceOf(bytes32 poolId) function balanceOfOperator(bytes32 poolId)
external external
view view
returns (uint256) returns (uint256)
@ -144,7 +144,7 @@ contract RewardVault is
return balanceByPoolId[poolId].operatorBalance; return balanceByPoolId[poolId].operatorBalance;
} }
function poolBalanceOf(bytes32 poolId) function balanceOfPool(bytes32 poolId)
external external
view view
returns (uint256) returns (uint256)

View File

@ -558,15 +558,15 @@ describe('Staking Core', () => {
const stakingContractAddress = stakingWrapper.getStakingContract().address; const stakingContractAddress = stakingWrapper.getStakingContract().address;
const notStakingContractAddress = poolOperator; const notStakingContractAddress = poolOperator;
// create pool in vault // create pool in vault
await stakingWrapper.rewardVaultCreatePoolAsync(poolId, poolOperator, operatorShare, stakingContractAddress); await stakingWrapper.rewardVaultCreatePoolAsync(poolId, operatorShare, stakingContractAddress);
// should fail to create pool if it already exists // should fail to create pool if it already exists
await expectTransactionFailedAsync( await expectTransactionFailedAsync(
stakingWrapper.rewardVaultCreatePoolAsync(poolId, poolOperator, operatorShare, stakingContractAddress), stakingWrapper.rewardVaultCreatePoolAsync(poolId, operatorShare, stakingContractAddress),
RevertReason.PoolAlreadyExists RevertReason.PoolAlreadyExists
); );
// should fail to create a pool from an address other than the staking contract // should fail to create a pool from an address other than the staking contract
await expectTransactionFailedAsync( await expectTransactionFailedAsync(
stakingWrapper.rewardVaultCreatePoolAsync(poolId, poolOperator, operatorShare, notStakingContractAddress), stakingWrapper.rewardVaultCreatePoolAsync(poolId, operatorShare, notStakingContractAddress),
RevertReason.OnlyCallableByStakingContract RevertReason.OnlyCallableByStakingContract
); );
}); });
@ -923,9 +923,9 @@ describe('Staking Core', () => {
new BigNumber('20.31028'), // 20.31028447343014834523983759032242063760612769662934308289 new BigNumber('20.31028'), // 20.31028447343014834523983759032242063760612769662934308289
]; ];
const payoutByPoolOperator = await Promise.all([ const payoutByPoolOperator = await Promise.all([
stakingWrapper.rewardVaultGetBalanceAsync(poolIds[0]), stakingWrapper.rewardVaultBalanceOfAsync(poolIds[0]),
stakingWrapper.rewardVaultGetBalanceAsync(poolIds[1]), stakingWrapper.rewardVaultBalanceOfAsync(poolIds[1]),
stakingWrapper.rewardVaultGetBalanceAsync(poolIds[2]), stakingWrapper.rewardVaultBalanceOfAsync(poolIds[2]),
]); ]);
const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([ const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[0], 18), 5), stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[0], 18), 5),
@ -1070,9 +1070,9 @@ describe('Staking Core', () => {
]; ];
const payoutByPoolOperator = await Promise.all([ const payoutByPoolOperator = await Promise.all([
stakingWrapper.rewardVaultGetBalanceAsync(poolIds[0]), stakingWrapper.rewardVaultBalanceOfAsync(poolIds[0]),
stakingWrapper.rewardVaultGetBalanceAsync(poolIds[1]), stakingWrapper.rewardVaultBalanceOfAsync(poolIds[1]),
stakingWrapper.rewardVaultGetBalanceAsync(poolIds[2]), stakingWrapper.rewardVaultBalanceOfAsync(poolIds[2]),
]); ]);
const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([ const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([
@ -1089,9 +1089,9 @@ describe('Staking Core', () => {
///// 10 CHECK DELEGATOR BY UNDELEGATING ///// ///// 10 CHECK DELEGATOR BY UNDELEGATING /////
const poolPayoutById = await Promise.all([ const poolPayoutById = await Promise.all([
stakingWrapper.rewardVaultPoolBalanceOfAsync(poolIds[0]), stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[0]),
stakingWrapper.rewardVaultPoolBalanceOfAsync(poolIds[1]), stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[1]),
stakingWrapper.rewardVaultPoolBalanceOfAsync(poolIds[2]), stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[2]),
]); ]);
const ethBalancesByDelegatorInit = await Promise.all([ const ethBalancesByDelegatorInit = await Promise.all([
stakingWrapper.getEthBalanceAsync(delegators[0]), stakingWrapper.getEthBalanceAsync(delegators[0]),
@ -1259,9 +1259,9 @@ describe('Staking Core', () => {
]; ];
const payoutByPoolOperator = await Promise.all([ const payoutByPoolOperator = await Promise.all([
stakingWrapper.rewardVaultGetBalanceAsync(poolIds[0]), stakingWrapper.rewardVaultBalanceOfAsync(poolIds[0]),
stakingWrapper.rewardVaultGetBalanceAsync(poolIds[1]), stakingWrapper.rewardVaultBalanceOfAsync(poolIds[1]),
stakingWrapper.rewardVaultGetBalanceAsync(poolIds[2]), stakingWrapper.rewardVaultBalanceOfAsync(poolIds[2]),
]); ]);
const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([ const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([
@ -1275,9 +1275,9 @@ describe('Staking Core', () => {
///// 10 CHECK DELEGATOR PAYOUT BY UNDELEGATING ///// ///// 10 CHECK DELEGATOR PAYOUT BY UNDELEGATING /////
const poolPayoutById = await Promise.all([ const poolPayoutById = await Promise.all([
stakingWrapper.rewardVaultPoolBalanceOfAsync(poolIds[0]), stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[0]),
stakingWrapper.rewardVaultPoolBalanceOfAsync(poolIds[1]), stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[1]),
stakingWrapper.rewardVaultPoolBalanceOfAsync(poolIds[2]), stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[2]),
]); ]);
const ethBalancesByDelegatorInit = await Promise.all([ const ethBalancesByDelegatorInit = await Promise.all([
stakingWrapper.getEthBalanceAsync(delegators[0]), stakingWrapper.getEthBalanceAsync(delegators[0]),

View File

@ -448,29 +448,23 @@ export class StakingWrapper {
const txReceipt = await this._executeTransactionAsync(calldata, zeroExMultisigAddress); const txReceipt = await this._executeTransactionAsync(calldata, zeroExMultisigAddress);
return txReceipt; return txReceipt;
} }
public async rewardVaultGetBalanceAsync(poolId: string): Promise<BigNumber> { public async rewardVaultBalanceOfAsync(poolId: string): Promise<BigNumber> {
const balance = await this.getRewardVaultContract().balanceOf.callAsync(poolId); const balance = await this.getRewardVaultContract().balanceOf.callAsync(poolId);
return balance; return balance;
} }
public async rewardVaultOperatorBalanceOfAsync(poolId: string): Promise<BigNumber> { public async rewardVaultBalanceOfOperatorAsync(poolId: string): Promise<BigNumber> {
const balance = await this.getRewardVaultContract().operatorBalanceOf.callAsync(poolId); const balance = await this.getRewardVaultContract().balanceOfOperator.callAsync(poolId);
return balance; return balance;
} }
public async rewardVaultPoolBalanceOfAsync(poolId: string): Promise<BigNumber> { public async rewardVaultBalanceOfPoolAsync(poolId: string): Promise<BigNumber> {
const balance = await this.getRewardVaultContract().poolBalanceOf.callAsync(poolId); const balance = await this.getRewardVaultContract().balanceOfPool.callAsync(poolId);
return balance; return balance;
} }
public async rewardVaultCreatePoolAsync(poolId: string, poolOperator: string, poolOperatorShare: number, stakingContractAddress: string): Promise<TransactionReceiptWithDecodedLogs> { public async rewardVaultCreatePoolAsync(poolId: string, poolOperatorShare: number, stakingContractAddress: string): Promise<TransactionReceiptWithDecodedLogs> {
const calldata = this.getRewardVaultContract().createPool.getABIEncodedTransactionData(poolId, poolOperatorShare); const calldata = this.getRewardVaultContract().createPool.getABIEncodedTransactionData(poolId, poolOperatorShare);
const txReceipt = await this._executeTransactionAsync(calldata, stakingContractAddress); const txReceipt = await this._executeTransactionAsync(calldata, stakingContractAddress);
return txReceipt; return txReceipt;
} }
/*
public async getEthBalanceOfRewardVaultAsync(): Promise<BigNumber> {
const balance = await this.getRewardVaultContract().balanceOf.callAsync(this.getZrxVaultContract().address);
return balance;
}
*/
///// ZRX VAULT ///// ///// ZRX VAULT /////
public async getZrxVaultBalance(holder: string): Promise<BigNumber> { public async getZrxVaultBalance(holder: string): Promise<BigNumber> {
const balance = await this.getZrxVaultContract().balanceOf.callAsync(holder); const balance = await this.getZrxVaultContract().balanceOf.callAsync(holder);