1333 lines
76 KiB
TypeScript
1333 lines
76 KiB
TypeScript
import {
|
|
chaiSetup,
|
|
constants,
|
|
expectTransactionFailedAsync,
|
|
provider,
|
|
txDefaults,
|
|
web3Wrapper,
|
|
} from '@0x/contracts-test-utils';
|
|
import { DummyERC20TokenContract } from '@0x/contracts-erc20';
|
|
import { BlockchainLifecycle } from '@0x/dev-utils';
|
|
import { RevertReason } from '@0x/types';
|
|
import { BigNumber } from '@0x/utils';
|
|
import * as chai from 'chai';
|
|
import { LogWithDecodedArgs } from 'ethereum-types';
|
|
import * as _ from 'lodash';
|
|
|
|
import { constants as stakingConstants } from './utils/constants';
|
|
|
|
import { StakingWrapper } from './utils/staking_wrapper';
|
|
|
|
import { ERC20Wrapper, ERC20ProxyContract } from '@0x/contracts-asset-proxy';
|
|
import { StakingContract } from '../src';
|
|
|
|
|
|
import { StakerActor } from './actors/StakerActor';
|
|
import { DelegatorActor } from './actors/DelegatorActor';
|
|
|
|
chaiSetup.configure();
|
|
const expect = chai.expect;
|
|
const blockchainLifecycle = new BlockchainLifecycle(web3Wrapper);
|
|
// tslint:disable:no-unnecessary-type-assertion
|
|
describe('Staking Core', () => {
|
|
// constants
|
|
const ZRX_TOKEN_DECIMALS = new BigNumber(18);
|
|
// tokens & addresses
|
|
let accounts: string[];
|
|
let owner: string;
|
|
let exchange: string;
|
|
let stakers: string[];
|
|
let makers: string[];
|
|
let delegators: string[];
|
|
let zrxTokenContract: DummyERC20TokenContract;
|
|
let erc20ProxyContract: ERC20ProxyContract;
|
|
// wrappers
|
|
let stakingWrapper: StakingWrapper;
|
|
let erc20Wrapper: ERC20Wrapper;
|
|
// tests
|
|
before(async () => {
|
|
await blockchainLifecycle.startAsync();
|
|
});
|
|
after(async () => {
|
|
await blockchainLifecycle.revertAsync();
|
|
});
|
|
before(async () => {
|
|
// create accounts
|
|
accounts = await web3Wrapper.getAvailableAddressesAsync();
|
|
owner = accounts[0];
|
|
exchange = accounts[1];
|
|
stakers = accounts.slice(2, 5);
|
|
makers = accounts.slice(4, 10);
|
|
// deploy erc20 proxy
|
|
erc20Wrapper = new ERC20Wrapper(provider, accounts, owner);
|
|
erc20ProxyContract = await erc20Wrapper.deployProxyAsync();
|
|
// deploy zrx token
|
|
[zrxTokenContract] = await erc20Wrapper.deployDummyTokensAsync(1, ZRX_TOKEN_DECIMALS);
|
|
await erc20Wrapper.setBalancesAndAllowancesAsync();
|
|
// deploy staking contracts
|
|
stakingWrapper = new StakingWrapper(provider, owner, erc20ProxyContract, zrxTokenContract, accounts);
|
|
await stakingWrapper.deployAndConfigureContracts();
|
|
});
|
|
beforeEach(async () => {
|
|
await blockchainLifecycle.startAsync();
|
|
});
|
|
afterEach(async () => {
|
|
await blockchainLifecycle.revertAsync();
|
|
});
|
|
describe('end-to-end tests', () => {
|
|
it('epochs & timelock periods', async () => {
|
|
///// 0/3 Validate Assumptions /////
|
|
expect(await stakingWrapper.getEpochPeriodInSecondsAsync()).to.be.bignumber.equal(stakingConstants.EPOCH_PERIOD_IN_SECONDS);
|
|
expect(await stakingWrapper.getTimelockPeriodInEpochsAsync()).to.be.bignumber.equal(stakingConstants.TIMELOCK_PERIOD_IN_EPOCHS);
|
|
|
|
///// 1/3 Validate Initial Epoch & Timelock Period /////
|
|
{
|
|
// epoch
|
|
const currentEpoch = await stakingWrapper.getCurrentEpochAsync();
|
|
expect(currentEpoch).to.be.bignumber.equal(stakingConstants.INITIAL_EPOCH);
|
|
// timelock period
|
|
const currentTimelockPeriod = await stakingWrapper.getCurrentTimelockPeriodAsync();
|
|
expect(currentTimelockPeriod).to.be.bignumber.equal(stakingConstants.INITIAL_TIMELOCK_PERIOD);
|
|
}
|
|
///// 2/3 Increment Epoch (Timelock Should Not Increment) /////
|
|
await stakingWrapper.skipToNextEpochAsync();
|
|
{
|
|
// epoch
|
|
const currentEpoch = await stakingWrapper.getCurrentEpochAsync();
|
|
expect(currentEpoch).to.be.bignumber.equal(stakingConstants.INITIAL_EPOCH.plus(1));
|
|
// timelock period
|
|
const currentTimelockPeriod = await stakingWrapper.getCurrentTimelockPeriodAsync();
|
|
expect(currentTimelockPeriod).to.be.bignumber.equal(stakingConstants.INITIAL_TIMELOCK_PERIOD);
|
|
}
|
|
///// 3/3 Increment Epoch (Timelock Should Increment) /////
|
|
await stakingWrapper.skipToNextTimelockPeriodAsync();
|
|
{
|
|
// timelock period
|
|
const currentTimelockPeriod = await stakingWrapper.getCurrentTimelockPeriodAsync();
|
|
expect(currentTimelockPeriod).to.be.bignumber.equal(stakingConstants.INITIAL_TIMELOCK_PERIOD.plus(1));
|
|
}
|
|
});
|
|
|
|
it.only('staking/unstaking', async () => {
|
|
// setup test parameters
|
|
const amountToStake = stakingWrapper.toBaseUnitAmount(10);
|
|
const amountToDeactivate = stakingWrapper.toBaseUnitAmount(4);
|
|
const amountToReactivate = stakingWrapper.toBaseUnitAmount(1);
|
|
const amountToWithdraw = stakingWrapper.toBaseUnitAmount(1.5);
|
|
// run test - this actor will validate its own state
|
|
const staker = new StakerActor(stakers[0], stakingWrapper);
|
|
await staker.depositAndStakeAsync(amountToStake);
|
|
await staker.deactivateAndTimelockStakeAsync(amountToDeactivate);
|
|
// note - we cannot re-activate this timelocked stake until at least one full timelock period has passed.
|
|
// attempting to do so should revert.
|
|
await staker.activateStakeAsync(amountToReactivate, RevertReason.InsufficientBalance);
|
|
await staker.skipToNextTimelockPeriodAsync();
|
|
await staker.activateStakeAsync(amountToReactivate, RevertReason.InsufficientBalance);
|
|
await staker.skipToNextTimelockPeriodAsync();
|
|
// this forces the internal state to update; it is not necessary to activate stake, but
|
|
// allows us to check that state is updated correctly after a timelock period rolls over.
|
|
await staker.forceTimelockSyncAsync();
|
|
// now we can activate stake
|
|
await staker.activateStakeAsync(amountToReactivate);
|
|
await staker.withdrawAsync(amountToWithdraw);
|
|
});
|
|
|
|
it.only('delegating/undelegating', async () => {
|
|
// setup test parameters
|
|
const amountToDelegate = stakingWrapper.toBaseUnitAmount(10);
|
|
const amountToDeactivate = stakingWrapper.toBaseUnitAmount(4);
|
|
const amountToReactivate = stakingWrapper.toBaseUnitAmount(1);
|
|
const amountToWithdraw = stakingWrapper.toBaseUnitAmount(1.5);
|
|
const poolOperator = stakers[1];
|
|
const operatorShare = 39;
|
|
const poolId = await stakingWrapper.createPoolAsync(poolOperator, operatorShare);
|
|
// run test
|
|
const delegator = new DelegatorActor(stakers[0], stakingWrapper);
|
|
await delegator.depositAndDelegateAsync(poolId, amountToDelegate);
|
|
await delegator.deactivateAndTimelockDelegatedStakeAsync(poolId, amountToDeactivate);
|
|
// note - we cannot re-activate this timelocked stake until at least one full timelock period has passed.
|
|
// attempting to do so should revert.
|
|
await delegator.activateStakeAsync(amountToReactivate, RevertReason.InsufficientBalance);
|
|
await delegator.skipToNextTimelockPeriodAsync();
|
|
await delegator.activateStakeAsync(amountToReactivate, RevertReason.InsufficientBalance);
|
|
await delegator.skipToNextTimelockPeriodAsync();
|
|
// this forces the internal state to update; it is not necessary to activate stake, but
|
|
// allows us to check that state is updated correctly after a timelock period rolls over.
|
|
await delegator.forceTimelockSyncAsync();
|
|
// now we can activate stake
|
|
await delegator.activateAndDelegateStakeAsync(poolId, amountToReactivate);
|
|
await delegator.withdrawAsync(amountToWithdraw);
|
|
});
|
|
|
|
it('Exchange Tracking', async () => {
|
|
// 1 try querying an invalid addresses
|
|
const invalidAddress = "0x0000000000000000000000000000000000000001";
|
|
const isInvalidAddressValid = await stakingWrapper.isValidExchangeAddressAsync(invalidAddress);
|
|
expect(isInvalidAddressValid).to.be.false();
|
|
// 2 add valid address
|
|
await stakingWrapper.addExchangeAddressAsync(exchange);
|
|
const isValidAddressValid = await stakingWrapper.isValidExchangeAddressAsync(exchange);
|
|
expect(isValidAddressValid).to.be.true();
|
|
// 3 try adding valid address again
|
|
await expectTransactionFailedAsync(
|
|
stakingWrapper.addExchangeAddressAsync(exchange),
|
|
RevertReason.ExchangeAddressAlreadyRegistered
|
|
);
|
|
// 4 remove valid address
|
|
await stakingWrapper.removeExchangeAddressAsync(exchange);
|
|
const isValidAddressStillValid = await stakingWrapper.isValidExchangeAddressAsync(exchange);
|
|
expect(isValidAddressStillValid).to.be.false();
|
|
// 5 try removing valid address again
|
|
await expectTransactionFailedAsync(
|
|
stakingWrapper.removeExchangeAddressAsync(exchange),
|
|
RevertReason.ExchangeAddressNotRegistered
|
|
);
|
|
});
|
|
|
|
it.skip('Reward Vault', async () => {
|
|
// 1 setup test parameters
|
|
const poolOperator = stakers[1];
|
|
const operatorShare = 39;
|
|
const poolId = await stakingWrapper.createPoolAsync(poolOperator, operatorShare);
|
|
const stakingContractAddress = stakingWrapper.getStakingContract().address;
|
|
const notStakingContractAddress = poolOperator;
|
|
// create pool in vault
|
|
await stakingWrapper.rewardVaultCreatePoolAsync(poolId, operatorShare, stakingContractAddress);
|
|
// should fail to create pool if it already exists
|
|
await expectTransactionFailedAsync(
|
|
stakingWrapper.rewardVaultCreatePoolAsync(poolId, operatorShare, stakingContractAddress),
|
|
RevertReason.PoolAlreadyExists
|
|
);
|
|
// should fail to create a pool from an address other than the staking contract
|
|
await expectTransactionFailedAsync(
|
|
stakingWrapper.rewardVaultCreatePoolAsync(poolId, operatorShare, notStakingContractAddress),
|
|
RevertReason.OnlyCallableByStakingContract
|
|
);
|
|
});
|
|
|
|
it('Protocol Fees', async () => {
|
|
///// 0 DEPLOY EXCHANGE /////
|
|
await stakingWrapper.addExchangeAddressAsync(exchange);
|
|
///// 1 SETUP POOLS /////
|
|
const poolOperators = stakers.slice(0, 3);
|
|
const operatorShares = [39, 59, 43];
|
|
const poolIds = await Promise.all([
|
|
stakingWrapper.createPoolAsync(poolOperators[0], operatorShares[0]),
|
|
stakingWrapper.createPoolAsync(poolOperators[1], operatorShares[1]),
|
|
stakingWrapper.createPoolAsync(poolOperators[2], operatorShares[2]),
|
|
]);
|
|
const makersByPoolId = [
|
|
[
|
|
makers[0],
|
|
],
|
|
[
|
|
makers[1],
|
|
makers[2]
|
|
],
|
|
[
|
|
makers[3],
|
|
makers[4],
|
|
makers[5]
|
|
],
|
|
];
|
|
const protocolFeesByMaker = [
|
|
// pool 1 - adds up to protocolFeesByPoolId[0]
|
|
stakingWrapper.toBaseUnitAmount(0.304958),
|
|
// pool 2 - adds up to protocolFeesByPoolId[1]
|
|
stakingWrapper.toBaseUnitAmount(3.2),
|
|
stakingWrapper.toBaseUnitAmount(12.123258),
|
|
// pool 3 - adds up to protocolFeesByPoolId[2]
|
|
stakingWrapper.toBaseUnitAmount(23.577),
|
|
stakingWrapper.toBaseUnitAmount(4.54522236),
|
|
stakingWrapper.toBaseUnitAmount(0)
|
|
];
|
|
const makerSignatures = [
|
|
// pool 0
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[0], makersByPoolId[0][0]).signature,
|
|
// pool 1
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][1]).signature,
|
|
// pool 2
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][1]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][2]).signature,
|
|
]
|
|
await Promise.all([
|
|
// pool 0
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[0], makersByPoolId[0][0], makerSignatures[0], poolOperators[0]),
|
|
// pool 1
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][0], makerSignatures[1], poolOperators[1]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][1], makerSignatures[2], poolOperators[1]),
|
|
// pool 2
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][0], makerSignatures[3], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][1], makerSignatures[4], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][2], makerSignatures[5], poolOperators[2]),
|
|
]);
|
|
///// 2 PAY FEES /////
|
|
await Promise.all([
|
|
// pool 0 - split into two payments
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
// pool 1 - pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[1], protocolFeesByMaker[1], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[2], protocolFeesByMaker[2], exchange),
|
|
// pool 2 -- pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[3], protocolFeesByMaker[3], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[4], protocolFeesByMaker[4], exchange),
|
|
// maker 5 doesn't pay anything
|
|
]);
|
|
///// 3 VALIDATE FEES RECORDED FOR EACH POOL /////
|
|
const recordedProtocolFeesByPool = await Promise.all([
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[0]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[1]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[2]),
|
|
]);
|
|
expect(recordedProtocolFeesByPool[0]).to.be.bignumber.equal(protocolFeesByMaker[0]);
|
|
expect(recordedProtocolFeesByPool[1]).to.be.bignumber.equal(protocolFeesByMaker[1].plus(protocolFeesByMaker[2]));
|
|
expect(recordedProtocolFeesByPool[2]).to.be.bignumber.equal(protocolFeesByMaker[3].plus(protocolFeesByMaker[4]));
|
|
///// 4 VALIDATE TOTAL FEES /////
|
|
const recordedTotalProtocolFees = await stakingWrapper.getTotalProtocolFeesThisEpochAsync();
|
|
const totalProtocolFeesAsNumber = _.sumBy(protocolFeesByMaker, (value: BigNumber) => {return value.toNumber()});
|
|
const totalProtocolFees = new BigNumber(totalProtocolFeesAsNumber);
|
|
expect(recordedTotalProtocolFees).to.be.bignumber.equal(totalProtocolFees);
|
|
///// 5 TRY TO RECORD FEE FROM ADDRESS OTHER THAN 0x EXCHANGE /////
|
|
await expectTransactionFailedAsync(
|
|
stakingWrapper.payProtocolFeeAsync(makers[4], protocolFeesByMaker[4], owner),
|
|
RevertReason.OnlyCallableByExchange
|
|
);
|
|
});
|
|
|
|
it('nth root', async () => {
|
|
const base = new BigNumber(1419857);
|
|
const n = new BigNumber(5);
|
|
const root = await stakingWrapper.nthRoot(base, n);
|
|
expect(root).to.be.bignumber.equal(17);
|
|
});
|
|
|
|
it('nth root #2', async () => {
|
|
const base = new BigNumber(3375);
|
|
const n = new BigNumber(3);
|
|
const root = await stakingWrapper.nthRoot(base, n);
|
|
expect(root).to.be.bignumber.equal(15);
|
|
});
|
|
|
|
it('nth root #3 with fixed point', async () => {
|
|
const decimals = 18;
|
|
const base = stakingWrapper.toFixedPoint(4.234, decimals);
|
|
const n = new BigNumber(2);
|
|
const root = await stakingWrapper.nthRootFixedPoint(base, n);
|
|
const rootAsFloatingPoint = stakingWrapper.toFloatingPoint(root, decimals);
|
|
const expectedResult = new BigNumber(2.057668584);
|
|
expect(rootAsFloatingPoint).to.be.bignumber.equal(expectedResult);
|
|
});
|
|
|
|
it('nth root #3 with fixed point (integer nth root would fail here)', async () => {
|
|
const decimals = 18;
|
|
const base = stakingWrapper.toFixedPoint(5429503678976, decimals);
|
|
console.log(base);
|
|
const n = new BigNumber(9);
|
|
const root = await stakingWrapper.nthRootFixedPoint(base, n);
|
|
const rootAsFloatingPoint = stakingWrapper.toFloatingPoint(root, decimals);
|
|
const expectedResult = new BigNumber(26);
|
|
expect(rootAsFloatingPoint).to.be.bignumber.equal(expectedResult);
|
|
});
|
|
|
|
it.skip('nth root #4 with fixed point (integer nth root would fail here) (max number of decimals - currently does not retain)', async () => {
|
|
const decimals = 18;
|
|
const base = stakingWrapper.toFixedPoint(new BigNumber('5429503678976.295036789761543678', 10), decimals);
|
|
console.log(base);
|
|
const n = new BigNumber(9);
|
|
const root = await stakingWrapper.nthRootFixedPoint(base, n);
|
|
console.log(`root - ${root}`);
|
|
const rootAsFloatingPoint = stakingWrapper.toFloatingPoint(root, decimals);
|
|
const expectedResult = new BigNumber(26);
|
|
expect(rootAsFloatingPoint).to.be.bignumber.equal(expectedResult);
|
|
});
|
|
|
|
it('cobb douglas - approximate', async() => {
|
|
const totalRewards = stakingWrapper.toBaseUnitAmount(57.154398);
|
|
const ownerFees = stakingWrapper.toBaseUnitAmount(5.64375);
|
|
const totalFees = stakingWrapper.toBaseUnitAmount(29.00679);
|
|
const ownerStake = stakingWrapper.toBaseUnitAmount(56);
|
|
const totalStake = stakingWrapper.toBaseUnitAmount(10906);
|
|
const alphaNumerator = new BigNumber(3);
|
|
const alphaDenominator = new BigNumber(7);
|
|
// create expected output
|
|
// https://www.wolframalpha.com/input/?i=57.154398+*+(5.64375%2F29.00679)+%5E+(3%2F7)+*+(56+%2F+10906)+%5E+(1+-+3%2F7)
|
|
const expectedOwnerReward = new BigNumber(1.3934);
|
|
// run computation
|
|
const ownerReward = await stakingWrapper.cobbDouglasAsync(
|
|
totalRewards,
|
|
ownerFees,
|
|
totalFees,
|
|
ownerStake,
|
|
totalStake,
|
|
alphaNumerator,
|
|
alphaDenominator
|
|
);
|
|
const ownerRewardFloatingPoint = stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(ownerReward, 18), 4);
|
|
// validation
|
|
expect(ownerRewardFloatingPoint).to.be.bignumber.equal(expectedOwnerReward);
|
|
});
|
|
|
|
it('cobb douglas - simplified (alpha = 1/x)', async() => {
|
|
// setup test parameters
|
|
const totalRewards = stakingWrapper.toBaseUnitAmount(57.154398);
|
|
const ownerFees = stakingWrapper.toBaseUnitAmount(5.64375);
|
|
const totalFees = stakingWrapper.toBaseUnitAmount(29.00679);
|
|
const ownerStake = stakingWrapper.toBaseUnitAmount(56);
|
|
const totalStake = stakingWrapper.toBaseUnitAmount(10906);
|
|
const alphaDenominator = new BigNumber(3);
|
|
// create expected output
|
|
// https://www.wolframalpha.com/input/?i=57.154398+*+(5.64375%2F29.00679)+%5E+(1%2F3)+*+(56+%2F+10906)+%5E+(1+-+1%2F3)
|
|
const expectedOwnerReward = new BigNumber(0.98572107681878);
|
|
// run computation
|
|
const ownerReward = await stakingWrapper.cobbDouglasSimplifiedAsync(
|
|
totalRewards,
|
|
ownerFees,
|
|
totalFees,
|
|
ownerStake,
|
|
totalStake,
|
|
alphaDenominator
|
|
);
|
|
const ownerRewardFloatingPoint = stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(ownerReward, 18), 14);
|
|
// validation
|
|
expect(ownerRewardFloatingPoint).to.be.bignumber.equal(expectedOwnerReward);
|
|
});
|
|
|
|
it('cobb douglas - simplified inverse (1 - alpha = 1/x)', async() => {
|
|
const totalRewards = stakingWrapper.toBaseUnitAmount(57.154398);
|
|
const ownerFees = stakingWrapper.toBaseUnitAmount(5.64375);
|
|
const totalFees = stakingWrapper.toBaseUnitAmount(29.00679);
|
|
const ownerStake = stakingWrapper.toBaseUnitAmount(56);
|
|
const totalStake = stakingWrapper.toBaseUnitAmount(10906);
|
|
const inverseAlphaDenominator = new BigNumber(3);
|
|
// create expected output
|
|
// https://www.wolframalpha.com/input/?i=57.154398+*+(5.64375%2F29.00679)+%5E+(2%2F3)+*+(56+%2F+10906)+%5E+(1+-+2%2F3)
|
|
const expectedOwnerReward = new BigNumber(3.310822494188);
|
|
// run computation
|
|
const ownerReward = await stakingWrapper.cobbDouglasSimplifiedInverseAsync(
|
|
totalRewards,
|
|
ownerFees,
|
|
totalFees,
|
|
ownerStake,
|
|
totalStake,
|
|
inverseAlphaDenominator
|
|
);
|
|
const ownerRewardFloatingPoint = stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(ownerReward, 18), 12);
|
|
// validation
|
|
expect(ownerRewardFloatingPoint).to.be.bignumber.equal(expectedOwnerReward);
|
|
});
|
|
|
|
it('pool management', async() => {
|
|
// create first pool
|
|
const operatorAddress = stakers[0];
|
|
const operatorShare = 39;
|
|
const poolId = await stakingWrapper.createPoolAsync(operatorAddress, operatorShare);
|
|
expect(poolId).to.be.equal(stakingConstants.INITIAL_POOL_ID);
|
|
// check that the next pool id was incremented
|
|
const expectedNextPoolId = "0x0000000000000000000000000000000200000000000000000000000000000000";
|
|
const nextPoolId = await stakingWrapper.getNextPoolIdAsync();
|
|
expect(nextPoolId).to.be.equal(expectedNextPoolId);
|
|
// add maker to pool
|
|
const makerAddress = makers[0];
|
|
const makerApproval = stakingWrapper.signApprovalForStakingPool(poolId, makerAddress);
|
|
await stakingWrapper.addMakerToPoolAsync(poolId, makerAddress, makerApproval.signature, operatorAddress);
|
|
// check the pool id of the maker
|
|
const poolIdOfMaker = await stakingWrapper.getMakerPoolId(makerAddress);
|
|
expect(poolIdOfMaker).to.be.equal(poolId);
|
|
// check the list of makers for the pool
|
|
const makerAddressesForPool = await stakingWrapper.getMakerAddressesForPool(poolId);
|
|
expect(makerAddressesForPool).to.be.deep.equal([makerAddress]);
|
|
// try to add the same maker address again
|
|
await expectTransactionFailedAsync(
|
|
stakingWrapper.addMakerToPoolAsync(poolId, makerAddress, makerApproval.signature, operatorAddress),
|
|
RevertReason.MakerAddressAlreadyRegistered
|
|
);
|
|
// try to add a new maker address with a bad signature
|
|
const anotherMakerAddress = makers[1];
|
|
const badPrivateKey = constants.TESTRPC_PRIVATE_KEYS[accounts.indexOf(operatorAddress)];
|
|
const anotherMakerApproval = stakingWrapper.signApprovalForStakingPool(poolId, anotherMakerAddress, badPrivateKey);
|
|
await expectTransactionFailedAsync(
|
|
stakingWrapper.addMakerToPoolAsync(poolId, anotherMakerAddress, anotherMakerApproval.signature, operatorAddress),
|
|
RevertReason.InvalidMakerSignature
|
|
);
|
|
// try to add a new maker address from an address other than the pool operator
|
|
const notOperatorAddress = owner;
|
|
const anotherMakerAddress2 = makers[1];
|
|
const anotherMakerApproval2 = stakingWrapper.signApprovalForStakingPool(poolId, anotherMakerAddress);
|
|
await expectTransactionFailedAsync(
|
|
stakingWrapper.addMakerToPoolAsync(poolId, anotherMakerAddress2, anotherMakerApproval2.signature, notOperatorAddress),
|
|
RevertReason.OnlyCallableByPoolOperator
|
|
);
|
|
// try to remove the maker address from an address other than the operator
|
|
await expectTransactionFailedAsync(
|
|
stakingWrapper.removeMakerFromPoolAsync(poolId, makerAddress, notOperatorAddress),
|
|
RevertReason.OnlyCallableByPoolOperator
|
|
);
|
|
// remove maker from pool
|
|
await stakingWrapper.removeMakerFromPoolAsync(poolId, makerAddress, operatorAddress);
|
|
// check the pool id of the maker
|
|
const poolIdOfMakerAfterRemoving = await stakingWrapper.getMakerPoolId(makerAddress);
|
|
expect(poolIdOfMakerAfterRemoving).to.be.equal(stakingConstants.NIL_POOL_ID);
|
|
// check the list of makers for the pool
|
|
const makerAddressesForPoolAfterRemoving = await stakingWrapper.getMakerAddressesForPool(poolId);
|
|
expect(makerAddressesForPoolAfterRemoving).to.be.deep.equal([]);
|
|
});
|
|
|
|
it('Finalization with Protocol Fees (no delegators)', async () => {
|
|
///// 0 DEPLOY EXCHANGE /////
|
|
await stakingWrapper.addExchangeAddressAsync(exchange);
|
|
///// 1 SETUP POOLS /////
|
|
const poolOperators = stakers.slice(0, 3);
|
|
const operatorShares = [100, 100, 100];
|
|
const poolIds = await Promise.all([
|
|
stakingWrapper.createPoolAsync(poolOperators[0], operatorShares[0]),
|
|
stakingWrapper.createPoolAsync(poolOperators[1], operatorShares[1]),
|
|
stakingWrapper.createPoolAsync(poolOperators[2], operatorShares[2]),
|
|
]);
|
|
const makersByPoolId = [
|
|
[
|
|
makers[0],
|
|
],
|
|
[
|
|
makers[1],
|
|
makers[2]
|
|
],
|
|
[
|
|
makers[3],
|
|
makers[4],
|
|
makers[5]
|
|
],
|
|
];
|
|
const protocolFeesByMaker = [
|
|
// pool 1 - adds up to protocolFeesByPoolId[0]
|
|
stakingWrapper.toBaseUnitAmount(0.304958),
|
|
// pool 2 - adds up to protocolFeesByPoolId[1]
|
|
stakingWrapper.toBaseUnitAmount(3.2),
|
|
stakingWrapper.toBaseUnitAmount(12.123258),
|
|
// pool 3 - adds up to protocolFeesByPoolId[2]
|
|
stakingWrapper.toBaseUnitAmount(23.577),
|
|
stakingWrapper.toBaseUnitAmount(4.54522236),
|
|
stakingWrapper.toBaseUnitAmount(0)
|
|
];
|
|
const makerSignatures = [
|
|
// pool 0
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[0], makersByPoolId[0][0]).signature,
|
|
// pool 1
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][1]).signature,
|
|
// pool 2
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][1]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][2]).signature,
|
|
]
|
|
await Promise.all([
|
|
// pool 0
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[0], makersByPoolId[0][0], makerSignatures[0], poolOperators[0]),
|
|
// pool 1
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][0], makerSignatures[1], poolOperators[1]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][1], makerSignatures[2], poolOperators[1]),
|
|
// pool 2
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][0], makerSignatures[3], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][1], makerSignatures[4], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][2], makerSignatures[5], poolOperators[2]),
|
|
]);
|
|
///// 2 PAY FEES /////
|
|
await Promise.all([
|
|
// pool 0 - split into two payments
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
// pool 1 - pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[1], protocolFeesByMaker[1], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[2], protocolFeesByMaker[2], exchange),
|
|
// pool 2 -- pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[3], protocolFeesByMaker[3], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[4], protocolFeesByMaker[4], exchange),
|
|
// maker 5 doesn't pay anything
|
|
]);
|
|
///// 3 VALIDATE FEES RECORDED FOR EACH POOL /////
|
|
const recordedProtocolFeesByPool = await Promise.all([
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[0]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[1]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[2]),
|
|
]);
|
|
expect(recordedProtocolFeesByPool[0]).to.be.bignumber.equal(protocolFeesByMaker[0]);
|
|
expect(recordedProtocolFeesByPool[1]).to.be.bignumber.equal(protocolFeesByMaker[1].plus(protocolFeesByMaker[2]));
|
|
expect(recordedProtocolFeesByPool[2]).to.be.bignumber.equal(protocolFeesByMaker[3].plus(protocolFeesByMaker[4]));
|
|
///// 4 VALIDATE TOTAL FEES /////
|
|
const recordedTotalProtocolFees = await stakingWrapper.getTotalProtocolFeesThisEpochAsync();
|
|
const totalProtocolFeesAsNumber = _.sumBy(protocolFeesByMaker, (value: BigNumber) => {return value.toNumber()});
|
|
const totalProtocolFees = new BigNumber(totalProtocolFeesAsNumber);
|
|
expect(recordedTotalProtocolFees).to.be.bignumber.equal(totalProtocolFees);
|
|
///// 5 STAKE /////
|
|
const stakeByPoolOperator = [
|
|
stakingWrapper.toBaseUnitAmount(42),
|
|
stakingWrapper.toBaseUnitAmount(84),
|
|
stakingWrapper.toBaseUnitAmount(97),
|
|
];
|
|
await Promise.all([
|
|
// pool 0
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[0], stakeByPoolOperator[0]),
|
|
// pool 1
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[1], stakeByPoolOperator[1]),
|
|
// pool 2
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[2], stakeByPoolOperator[2]),
|
|
]);
|
|
|
|
///// 6 FINALIZE /////
|
|
await stakingWrapper.skipToNextEpochAsync();
|
|
|
|
///// 7 CHECK PROFITS /////
|
|
// the expected payouts were computed by hand
|
|
// @TODO - get computations more accurate
|
|
const expectedPayoutByPoolOperator = [
|
|
new BigNumber('4.75677'), // 4.756772362932728793619590327361600155564384201215274334070
|
|
new BigNumber('16.28130'), // 16.28130500394935316563988584956596823402223838026190634525
|
|
new BigNumber('20.31028'), // 20.31028447343014834523983759032242063760612769662934308289
|
|
];
|
|
const payoutByPoolOperator = await Promise.all([
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[0]),
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[1]),
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[2]),
|
|
]);
|
|
const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[0], 18), 5),
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[1], 18), 5),
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[2], 18), 5),
|
|
]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[0]).to.be.bignumber.equal(expectedPayoutByPoolOperator[0]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[1]).to.be.bignumber.equal(expectedPayoutByPoolOperator[1]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[2]).to.be.bignumber.equal(expectedPayoutByPoolOperator[2]);
|
|
///// 8 CHECK PROFITS VIA STAKING CONTRACT /////
|
|
const payoutByPoolOperatorFromStakingContract = await Promise.all([
|
|
stakingWrapper.getRewardBalanceAsync(poolIds[0]),
|
|
stakingWrapper.getRewardBalanceAsync(poolIds[1]),
|
|
stakingWrapper.getRewardBalanceAsync(poolIds[2]),
|
|
]);
|
|
expect(payoutByPoolOperatorFromStakingContract[0]).to.be.bignumber.equal(payoutByPoolOperator[0]);
|
|
expect(payoutByPoolOperatorFromStakingContract[1]).to.be.bignumber.equal(payoutByPoolOperator[1]);
|
|
expect(payoutByPoolOperatorFromStakingContract[2]).to.be.bignumber.equal(payoutByPoolOperator[2]);
|
|
///// 9 WITHDRAW PROFITS VIA STAKING CONTRACT /////
|
|
const initOperatorBalances = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[0]),
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[1]),
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[2]),
|
|
]);
|
|
await Promise.all([
|
|
stakingWrapper.withdrawTotalOperatorRewardAsync(poolIds[0], poolOperators[0]),
|
|
stakingWrapper.withdrawTotalOperatorRewardAsync(poolIds[1], poolOperators[1]),
|
|
stakingWrapper.withdrawTotalOperatorRewardAsync(poolIds[2], poolOperators[2]),
|
|
]);
|
|
const finalOperatorBalances = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[0]),
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[1]),
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[2]),
|
|
]);
|
|
const payoutBalancesByOperator = [
|
|
finalOperatorBalances[0].minus(initOperatorBalances[0]),
|
|
finalOperatorBalances[1].minus(initOperatorBalances[1]),
|
|
finalOperatorBalances[2].minus(initOperatorBalances[2]),
|
|
];
|
|
expect(payoutBalancesByOperator[0]).to.be.bignumber.equal(payoutByPoolOperator[0]);
|
|
expect(payoutBalancesByOperator[1]).to.be.bignumber.equal(payoutByPoolOperator[1]);
|
|
expect(payoutBalancesByOperator[2]).to.be.bignumber.equal(payoutByPoolOperator[2]);
|
|
});
|
|
|
|
it('Finalization with Protocol Fees and Delegation', async () => {
|
|
///// 0 DEPLOY EXCHANGE /////
|
|
await stakingWrapper.addExchangeAddressAsync(exchange);
|
|
///// 1 SETUP POOLS /////
|
|
const poolOperators = makers.slice(0, 3);
|
|
const operatorShares = [39, 59, 43];
|
|
const poolIds = await Promise.all([
|
|
stakingWrapper.createPoolAsync(poolOperators[0], operatorShares[0]),
|
|
stakingWrapper.createPoolAsync(poolOperators[1], operatorShares[1]),
|
|
stakingWrapper.createPoolAsync(poolOperators[2], operatorShares[2]),
|
|
]);
|
|
const makersByPoolId = [
|
|
[
|
|
makers[0],
|
|
],
|
|
[
|
|
makers[1],
|
|
makers[2]
|
|
],
|
|
[
|
|
makers[3],
|
|
makers[4],
|
|
makers[5]
|
|
],
|
|
];
|
|
const protocolFeesByMaker = [
|
|
// pool 1 - adds up to protocolFeesByPoolId[0]
|
|
stakingWrapper.toBaseUnitAmount(0.304958),
|
|
// pool 2 - adds up to protocolFeesByPoolId[1]
|
|
stakingWrapper.toBaseUnitAmount(3.2),
|
|
stakingWrapper.toBaseUnitAmount(12.123258),
|
|
// pool 3 - adds up to protocolFeesByPoolId[2]
|
|
stakingWrapper.toBaseUnitAmount(23.577),
|
|
stakingWrapper.toBaseUnitAmount(4.54522236),
|
|
stakingWrapper.toBaseUnitAmount(0)
|
|
];
|
|
const makerSignatures = [
|
|
// pool 0
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[0], makersByPoolId[0][0]).signature,
|
|
// pool 1
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][1]).signature,
|
|
// pool 2
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][1]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][2]).signature,
|
|
]
|
|
await Promise.all([
|
|
// pool 0
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[0], makersByPoolId[0][0], makerSignatures[0], poolOperators[0]),
|
|
// pool 1
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][0], makerSignatures[1], poolOperators[1]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][1], makerSignatures[2], poolOperators[1]),
|
|
// pool 2
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][0], makerSignatures[3], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][1], makerSignatures[4], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][2], makerSignatures[5], poolOperators[2]),
|
|
]);
|
|
///// 2 PAY FEES /////
|
|
await Promise.all([
|
|
// pool 0 - split into two payments
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
// pool 1 - pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[1], protocolFeesByMaker[1], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[2], protocolFeesByMaker[2], exchange),
|
|
// pool 2 -- pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[3], protocolFeesByMaker[3], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[4], protocolFeesByMaker[4], exchange),
|
|
// maker 5 doesn't pay anything
|
|
]);
|
|
///// 3 VALIDATE FEES RECORDED FOR EACH POOL /////
|
|
const recordedProtocolFeesByPool = await Promise.all([
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[0]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[1]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[2]),
|
|
]);
|
|
expect(recordedProtocolFeesByPool[0]).to.be.bignumber.equal(protocolFeesByMaker[0]);
|
|
expect(recordedProtocolFeesByPool[1]).to.be.bignumber.equal(protocolFeesByMaker[1].plus(protocolFeesByMaker[2]));
|
|
expect(recordedProtocolFeesByPool[2]).to.be.bignumber.equal(protocolFeesByMaker[3].plus(protocolFeesByMaker[4]));
|
|
///// 4 VALIDATE TOTAL FEES /////
|
|
const recordedTotalProtocolFees = await stakingWrapper.getTotalProtocolFeesThisEpochAsync();
|
|
const totalProtocolFeesAsNumber = _.sumBy(protocolFeesByMaker, (value: BigNumber) => {return value.toNumber()});
|
|
const totalProtocolFees = new BigNumber(totalProtocolFeesAsNumber);
|
|
expect(recordedTotalProtocolFees).to.be.bignumber.equal(totalProtocolFees);
|
|
///// 5 STAKE /////
|
|
const stakeByPoolOperator = [
|
|
stakingWrapper.toBaseUnitAmount(42),
|
|
stakingWrapper.toBaseUnitAmount(84),
|
|
stakingWrapper.toBaseUnitAmount(97),
|
|
];
|
|
const totalStakeByPoolOperator = stakeByPoolOperator[0].plus(stakeByPoolOperator[1]).plus(stakeByPoolOperator[2]);
|
|
await Promise.all([
|
|
// pool 0
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[0], stakeByPoolOperator[0]),
|
|
// pool 1
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[1], stakeByPoolOperator[1]),
|
|
// pool 2
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[2], stakeByPoolOperator[2]),
|
|
])
|
|
|
|
///// 6 Add some delegators to pool 2 /////
|
|
const delegators = stakers.slice(0, 3);
|
|
const stakeByDelegator = [
|
|
stakingWrapper.toBaseUnitAmount(17),
|
|
stakingWrapper.toBaseUnitAmount(75),
|
|
stakingWrapper.toBaseUnitAmount(90),
|
|
];
|
|
const totalStakeByDelegators = stakeByDelegator[0].plus(stakeByDelegator[1]).plus(stakeByDelegator[2]);
|
|
await Promise.all([
|
|
stakingWrapper.depositAndDelegateAsync(delegators[0], poolIds[2], stakeByDelegator[0]),
|
|
stakingWrapper.depositAndDelegateAsync(delegators[1], poolIds[2], stakeByDelegator[1]),
|
|
stakingWrapper.depositAndDelegateAsync(delegators[2], poolIds[2], stakeByDelegator[2]),
|
|
]);
|
|
|
|
///// 6 FINALIZE /////
|
|
await stakingWrapper.skipToNextEpochAsync();
|
|
|
|
///// 7 CHECK PROFITS /////
|
|
// the expected payouts were computed by hand
|
|
// @TODO - get computations more accurate
|
|
/*
|
|
Pool | Total Fees | Total Stake | Total Delegated Stake | Total Stake (Scaled)
|
|
0 | 0.304958 | 42 | 0 | 42
|
|
1 | 15.323258 | 84 | 0 | 84
|
|
3 | 28.12222236 | 97 | 182 | 260.8
|
|
...
|
|
Cumulative Fees = 43.75043836
|
|
Cumulative Stake = 405
|
|
Total Rewards = 43.75043836
|
|
*/
|
|
|
|
const expectedPayoutByPoolOperator = [
|
|
new BigNumber('2.89303'), // 2.8930364057678784829875695710382241749912199174798475
|
|
new BigNumber('9.90218'), // 9.9021783083174087034787071054543342142019746753770943
|
|
new BigNumber('28.16463'), // 28.164631904035798614670299155719067954180760345463798
|
|
];
|
|
|
|
const payoutByPoolOperator = await Promise.all([
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[0]),
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[1]),
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[2]),
|
|
]);
|
|
|
|
const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[0], 18), 5),
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[1], 18), 5),
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[2], 18), 5),
|
|
]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[0]).to.be.bignumber.equal(expectedPayoutByPoolOperator[0]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[1]).to.be.bignumber.equal(expectedPayoutByPoolOperator[1]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[2]).to.be.bignumber.equal(expectedPayoutByPoolOperator[2]);
|
|
|
|
///// 8 CHECK PROFITS VIA STAKING CONTRACT /////
|
|
const payoutByPoolOperatorFromStakingContract = await Promise.all([
|
|
stakingWrapper.getRewardBalanceAsync(poolIds[0]),
|
|
stakingWrapper.getRewardBalanceAsync(poolIds[1]),
|
|
stakingWrapper.getRewardBalanceAsync(poolIds[2]),
|
|
]);
|
|
expect(payoutByPoolOperatorFromStakingContract[0]).to.be.bignumber.equal(payoutByPoolOperator[0]);
|
|
expect(payoutByPoolOperatorFromStakingContract[1]).to.be.bignumber.equal(payoutByPoolOperator[1]);
|
|
expect(payoutByPoolOperatorFromStakingContract[2]).to.be.bignumber.equal(payoutByPoolOperator[2]);
|
|
|
|
|
|
///// 8 CHECK DELEGATOR PROFITS /////
|
|
const poolPayoutById = await Promise.all([
|
|
stakingWrapper.getRewardBalanceOfPoolAsync(poolIds[0]),
|
|
stakingWrapper.getRewardBalanceOfPoolAsync(poolIds[1]),
|
|
stakingWrapper.getRewardBalanceOfPoolAsync(poolIds[2]),
|
|
]);
|
|
const expectedRewardByDelegator = [
|
|
poolPayoutById[2].times(stakeByDelegator[0]).dividedToIntegerBy(totalStakeByDelegators),
|
|
poolPayoutById[2].times(stakeByDelegator[1]).dividedToIntegerBy(totalStakeByDelegators),
|
|
poolPayoutById[2].times(stakeByDelegator[2]).dividedToIntegerBy(totalStakeByDelegators),
|
|
];
|
|
|
|
const rewardBalanceByDelegator = await Promise.all([
|
|
stakingWrapper.computeRewardBalanceAsync(poolIds[2], delegators[0]),
|
|
stakingWrapper.computeRewardBalanceAsync(poolIds[2], delegators[1]),
|
|
stakingWrapper.computeRewardBalanceAsync(poolIds[2], delegators[2]),
|
|
]);
|
|
expect(rewardBalanceByDelegator[0]).to.to.bignumber.equal(expectedRewardByDelegator[0]);
|
|
expect(rewardBalanceByDelegator[1]).to.to.bignumber.equal(expectedRewardByDelegator[1]);
|
|
expect(rewardBalanceByDelegator[2]).to.to.bignumber.equal(expectedRewardByDelegator[2]);
|
|
|
|
///// 8 CHECK DELEGATOR BY UNDELEGATING /////
|
|
const ethBalancesByDelegatorInit = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(delegators[0]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[1]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[2]),
|
|
]);
|
|
await Promise.all([
|
|
stakingWrapper.deactivateAndTimelockDelegatedStakeAsync(delegators[0], poolIds[2], stakeByDelegator[0]),
|
|
stakingWrapper.deactivateAndTimelockDelegatedStakeAsync(delegators[1], poolIds[2], stakeByDelegator[1]),
|
|
stakingWrapper.deactivateAndTimelockDelegatedStakeAsync(delegators[2], poolIds[2], stakeByDelegator[2]),
|
|
]);
|
|
const ethBalancesByDelegatorFinal = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(delegators[0]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[1]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[2]),
|
|
]);
|
|
const rewardByDelegator = [
|
|
ethBalancesByDelegatorFinal[0].minus(ethBalancesByDelegatorInit[0]),
|
|
ethBalancesByDelegatorFinal[1].minus(ethBalancesByDelegatorInit[1]),
|
|
ethBalancesByDelegatorFinal[2].minus(ethBalancesByDelegatorInit[2]),
|
|
];
|
|
expect(rewardByDelegator[0]).to.be.bignumber.equal(expectedRewardByDelegator[0]);
|
|
expect(rewardByDelegator[1]).to.be.bignumber.equal(expectedRewardByDelegator[1]);
|
|
// note that these may be slightly off due to rounding down on each entry
|
|
// there is a carry over between calls, which we account for here.
|
|
// if the last person to leave rounded down, then there is some trace amount left in the pool.
|
|
// carry-over here is 00000000000000000002
|
|
expect(rewardByDelegator[2]).to.be.bignumber.equal(expectedRewardByDelegator[2].plus('00000000000000000002', 10));
|
|
|
|
///// 9 CHECK OPERATOR PROFITS VIA STAKING CONTRACT /////
|
|
const operatorPayoutByPoolOperatorFromStakingContract = await Promise.all([
|
|
stakingWrapper.getRewardBalanceOfOperatorAsync(poolIds[0]),
|
|
stakingWrapper.getRewardBalanceOfOperatorAsync(poolIds[1]),
|
|
stakingWrapper.getRewardBalanceOfOperatorAsync(poolIds[2]),
|
|
]);
|
|
const expectedOperatorPayoutByPoolOperatorFromStakingContract = [
|
|
payoutByPoolOperator[0].times(operatorShares[0]).plus(99).dividedToIntegerBy(100),
|
|
payoutByPoolOperator[1].times(operatorShares[1]).plus(99).dividedToIntegerBy(100),
|
|
payoutByPoolOperator[2].times(operatorShares[2]).plus(99).dividedToIntegerBy(100)
|
|
];
|
|
expect(operatorPayoutByPoolOperatorFromStakingContract[0]).to.be.bignumber.equal(expectedOperatorPayoutByPoolOperatorFromStakingContract[0]);
|
|
expect(operatorPayoutByPoolOperatorFromStakingContract[1]).to.be.bignumber.equal(expectedOperatorPayoutByPoolOperatorFromStakingContract[1]);
|
|
expect(operatorPayoutByPoolOperatorFromStakingContract[2]).to.be.bignumber.equal(expectedOperatorPayoutByPoolOperatorFromStakingContract[2]);
|
|
|
|
///// 10 WITHDRAW PROFITS VIA STAKING CONTRACT /////
|
|
const initOperatorBalances = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[0]),
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[1]),
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[2]),
|
|
]);
|
|
await Promise.all([
|
|
stakingWrapper.withdrawTotalOperatorRewardAsync(poolIds[0], poolOperators[0]),
|
|
stakingWrapper.withdrawTotalOperatorRewardAsync(poolIds[1], poolOperators[1]),
|
|
stakingWrapper.withdrawTotalOperatorRewardAsync(poolIds[2], poolOperators[2]),
|
|
]);
|
|
const finalOperatorBalances = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[0]),
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[1]),
|
|
stakingWrapper.getEthBalanceAsync(poolOperators[2]),
|
|
]);
|
|
const payoutBalancesByOperator = [
|
|
finalOperatorBalances[0].minus(initOperatorBalances[0]),
|
|
finalOperatorBalances[1].minus(initOperatorBalances[1]),
|
|
finalOperatorBalances[2].minus(initOperatorBalances[2]),
|
|
];
|
|
expect(payoutBalancesByOperator[0]).to.be.bignumber.equal(expectedOperatorPayoutByPoolOperatorFromStakingContract[0]);
|
|
expect(payoutBalancesByOperator[1]).to.be.bignumber.equal(expectedOperatorPayoutByPoolOperatorFromStakingContract[1]);
|
|
expect(payoutBalancesByOperator[2]).to.be.bignumber.equal(expectedOperatorPayoutByPoolOperatorFromStakingContract[2]);
|
|
});
|
|
|
|
it('Finalization with Protocol Fees and Delegation with shadow ETH', async () => {
|
|
///// 0 DEPLOY EXCHANGE /////
|
|
await stakingWrapper.addExchangeAddressAsync(exchange);
|
|
///// 1 SETUP POOLS /////
|
|
const poolOperators = makers.slice(0, 3);
|
|
const operatorShares = [39, 59, 43];
|
|
const poolIds = await Promise.all([
|
|
stakingWrapper.createPoolAsync(poolOperators[0], operatorShares[0]),
|
|
stakingWrapper.createPoolAsync(poolOperators[1], operatorShares[1]),
|
|
stakingWrapper.createPoolAsync(poolOperators[2], operatorShares[2]),
|
|
]);
|
|
const makersByPoolId = [
|
|
[
|
|
makers[0],
|
|
],
|
|
[
|
|
makers[1],
|
|
makers[2]
|
|
],
|
|
[
|
|
makers[3],
|
|
makers[4],
|
|
makers[5]
|
|
],
|
|
];
|
|
const protocolFeesByMaker = [
|
|
// pool 1 - adds up to protocolFeesByPoolId[0]
|
|
stakingWrapper.toBaseUnitAmount(0.304958),
|
|
// pool 2 - adds up to protocolFeesByPoolId[1]
|
|
stakingWrapper.toBaseUnitAmount(3.2),
|
|
stakingWrapper.toBaseUnitAmount(12.123258),
|
|
// pool 3 - adds up to protocolFeesByPoolId[2]
|
|
stakingWrapper.toBaseUnitAmount(23.577),
|
|
stakingWrapper.toBaseUnitAmount(4.54522236),
|
|
stakingWrapper.toBaseUnitAmount(0)
|
|
];
|
|
const makerSignatures = [
|
|
// pool 0
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[0], makersByPoolId[0][0]).signature,
|
|
// pool 1
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][1]).signature,
|
|
// pool 2
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][1]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][2]).signature,
|
|
]
|
|
await Promise.all([
|
|
// pool 0
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[0], makersByPoolId[0][0], makerSignatures[0], poolOperators[0]),
|
|
// pool 1
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][0], makerSignatures[1], poolOperators[1]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][1], makerSignatures[2], poolOperators[1]),
|
|
// pool 2
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][0], makerSignatures[3], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][1], makerSignatures[4], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][2], makerSignatures[5], poolOperators[2]),
|
|
]);
|
|
///// 2 PAY FEES /////
|
|
await Promise.all([
|
|
// pool 0 - split into two payments
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
// pool 1 - pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[1], protocolFeesByMaker[1], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[2], protocolFeesByMaker[2], exchange),
|
|
// pool 2 -- pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[3], protocolFeesByMaker[3], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[4], protocolFeesByMaker[4], exchange),
|
|
// maker 5 doesn't pay anything
|
|
]);
|
|
///// 3 VALIDATE FEES RECORDED FOR EACH POOL /////
|
|
const recordedProtocolFeesByPool = await Promise.all([
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[0]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[1]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[2]),
|
|
]);
|
|
expect(recordedProtocolFeesByPool[0]).to.be.bignumber.equal(protocolFeesByMaker[0]);
|
|
expect(recordedProtocolFeesByPool[1]).to.be.bignumber.equal(protocolFeesByMaker[1].plus(protocolFeesByMaker[2]));
|
|
expect(recordedProtocolFeesByPool[2]).to.be.bignumber.equal(protocolFeesByMaker[3].plus(protocolFeesByMaker[4]));
|
|
///// 4 VALIDATE TOTAL FEES /////
|
|
const recordedTotalProtocolFees = await stakingWrapper.getTotalProtocolFeesThisEpochAsync();
|
|
const totalProtocolFeesAsNumber = _.sumBy(protocolFeesByMaker, (value: BigNumber) => {return value.toNumber()});
|
|
const totalProtocolFees = new BigNumber(totalProtocolFeesAsNumber);
|
|
expect(recordedTotalProtocolFees).to.be.bignumber.equal(totalProtocolFees);
|
|
///// 5 STAKE /////
|
|
const stakeByPoolOperator = [
|
|
stakingWrapper.toBaseUnitAmount(42),
|
|
stakingWrapper.toBaseUnitAmount(84),
|
|
stakingWrapper.toBaseUnitAmount(97),
|
|
];
|
|
const totalStakeByPoolOperator = stakeByPoolOperator[0].plus(stakeByPoolOperator[1]).plus(stakeByPoolOperator[2]);
|
|
await Promise.all([
|
|
// pool 0
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[0], stakeByPoolOperator[0]),
|
|
// pool 1
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[1], stakeByPoolOperator[1]),
|
|
// pool 2
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[2], stakeByPoolOperator[2]),
|
|
]);
|
|
|
|
///// 6 FINALIZE /////
|
|
await stakingWrapper.skipToNextEpochAsync();
|
|
|
|
///// 7 ADD DELEGATORS (Requires Shadow ETH) /////
|
|
const delegators = stakers.slice(0, 3);
|
|
const stakeByDelegator = [
|
|
stakingWrapper.toBaseUnitAmount(17),
|
|
stakingWrapper.toBaseUnitAmount(75),
|
|
stakingWrapper.toBaseUnitAmount(90),
|
|
];
|
|
const totalStakeByDelegators = stakeByDelegator[0].plus(stakeByDelegator[1]).plus(stakeByDelegator[2]);
|
|
await Promise.all([
|
|
stakingWrapper.depositAndDelegateAsync(delegators[0], poolIds[2], stakeByDelegator[0]),
|
|
stakingWrapper.depositAndDelegateAsync(delegators[1], poolIds[2], stakeByDelegator[1]),
|
|
stakingWrapper.depositAndDelegateAsync(delegators[2], poolIds[2], stakeByDelegator[2]),
|
|
]);
|
|
|
|
///// 7 FINALIZE AGAIN /////
|
|
await stakingWrapper.skipToNextEpochAsync();
|
|
|
|
///// 7 CHECK PROFITS /////
|
|
// the expected payouts were computed by hand
|
|
// @TODO - get computations more accurate
|
|
/*
|
|
Pool | Total Fees | Total Stake | Total Delegated Stake | Total Stake (Scaled)
|
|
0 | 0.304958 | 42 | 0 | 42
|
|
1 | 15.323258 | 84 | 0 | 84
|
|
3 | 28.12222236 | 97 | 182 | 260.8
|
|
...
|
|
Cumulative Fees = 43.75043836
|
|
Cumulative Stake = 405
|
|
Total Rewards = 43.75043836
|
|
*/
|
|
|
|
const expectedPayoutByPoolOperator = [
|
|
new BigNumber('4.75677'), // 4.756772362932728793619590327361600155564384201215274334070
|
|
new BigNumber('16.28130'), // 16.28130500394935316563988584956596823402223838026190634525
|
|
new BigNumber('20.31028'), // 20.31028447343014834523983759032242063760612769662934308289
|
|
];
|
|
|
|
const payoutByPoolOperator = await Promise.all([
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[0]),
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[1]),
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[2]),
|
|
]);
|
|
|
|
const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[0], 18), 5),
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[1], 18), 5),
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[2], 18), 5),
|
|
]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[0]).to.be.bignumber.equal(expectedPayoutByPoolOperator[0]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[1]).to.be.bignumber.equal(expectedPayoutByPoolOperator[1]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[2]).to.be.bignumber.equal(expectedPayoutByPoolOperator[2]);
|
|
|
|
///// 10 CHECK DELEGATOR PAYOUT BY UNDELEGATING /////
|
|
const poolPayoutById = await Promise.all([
|
|
stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[0]),
|
|
stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[1]),
|
|
stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[2]),
|
|
]);
|
|
const ethBalancesByDelegatorInit = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(delegators[0]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[1]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[2]),
|
|
]);
|
|
await Promise.all([
|
|
stakingWrapper.deactivateAndTimelockDelegatedStakeAsync(delegators[0], poolIds[2], stakeByDelegator[0]),
|
|
stakingWrapper.deactivateAndTimelockDelegatedStakeAsync(delegators[1], poolIds[2], stakeByDelegator[1]),
|
|
stakingWrapper.deactivateAndTimelockDelegatedStakeAsync(delegators[2], poolIds[2], stakeByDelegator[2]),
|
|
]);
|
|
const ethBalancesByDelegatorFinal = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(delegators[0]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[1]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[2]),
|
|
]);
|
|
const rewardByDelegator = [
|
|
ethBalancesByDelegatorFinal[0].minus(ethBalancesByDelegatorInit[0]),
|
|
ethBalancesByDelegatorFinal[1].minus(ethBalancesByDelegatorInit[1]),
|
|
ethBalancesByDelegatorFinal[2].minus(ethBalancesByDelegatorInit[2]),
|
|
];
|
|
|
|
// In this case, there was already a pot of ETH in the delegator pool that nobody had claimed.
|
|
// The first delegator got to claim it all. This is due to the necessary conservation of payouts.
|
|
// When a new delegator arrives, their new stake should not affect existing delegator payouts.
|
|
// In this case, there was unclaimed $$ in the delegator pool - which is claimed by the first delegator.
|
|
const expectedRewardByDelegator = [
|
|
poolPayoutById[2],
|
|
new BigNumber(0),
|
|
new BigNumber(0),
|
|
];
|
|
expect(rewardByDelegator[0]).to.be.bignumber.equal(expectedRewardByDelegator[0]);
|
|
expect(rewardByDelegator[1]).to.be.bignumber.equal(expectedRewardByDelegator[1]);
|
|
expect(rewardByDelegator[2]).to.be.bignumber.equal(expectedRewardByDelegator[2]);
|
|
});
|
|
|
|
it('Finalization with Protocol Fees and Delegation with shadow ETH (withdraw w/o undelegating)', async () => {
|
|
///// 0 DEPLOY EXCHANGE /////
|
|
await stakingWrapper.addExchangeAddressAsync(exchange);
|
|
///// 1 SETUP POOLS /////
|
|
const poolOperators = makers.slice(0, 3);
|
|
const operatorShares = [39, 59, 43];
|
|
const poolIds = await Promise.all([
|
|
stakingWrapper.createPoolAsync(poolOperators[0], operatorShares[0]),
|
|
stakingWrapper.createPoolAsync(poolOperators[1], operatorShares[1]),
|
|
stakingWrapper.createPoolAsync(poolOperators[2], operatorShares[2]),
|
|
]);
|
|
const makersByPoolId = [
|
|
[
|
|
makers[0],
|
|
],
|
|
[
|
|
makers[1],
|
|
makers[2]
|
|
],
|
|
[
|
|
makers[3],
|
|
makers[4],
|
|
makers[5]
|
|
],
|
|
];
|
|
const protocolFeesByMaker = [
|
|
// pool 1 - adds up to protocolFeesByPoolId[0]
|
|
stakingWrapper.toBaseUnitAmount(0.304958),
|
|
// pool 2 - adds up to protocolFeesByPoolId[1]
|
|
stakingWrapper.toBaseUnitAmount(3.2),
|
|
stakingWrapper.toBaseUnitAmount(12.123258),
|
|
// pool 3 - adds up to protocolFeesByPoolId[2]
|
|
stakingWrapper.toBaseUnitAmount(23.577),
|
|
stakingWrapper.toBaseUnitAmount(4.54522236),
|
|
stakingWrapper.toBaseUnitAmount(0)
|
|
];
|
|
const makerSignatures = [
|
|
// pool 0
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[0], makersByPoolId[0][0]).signature,
|
|
// pool 1
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[1], makersByPoolId[1][1]).signature,
|
|
// pool 2
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][0]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][1]).signature,
|
|
stakingWrapper.signApprovalForStakingPool(poolIds[2], makersByPoolId[2][2]).signature,
|
|
]
|
|
await Promise.all([
|
|
// pool 0
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[0], makersByPoolId[0][0], makerSignatures[0], poolOperators[0]),
|
|
// pool 1
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][0], makerSignatures[1], poolOperators[1]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[1], makersByPoolId[1][1], makerSignatures[2], poolOperators[1]),
|
|
// pool 2
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][0], makerSignatures[3], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][1], makerSignatures[4], poolOperators[2]),
|
|
stakingWrapper.addMakerToPoolAsync(poolIds[2], makersByPoolId[2][2], makerSignatures[5], poolOperators[2]),
|
|
]);
|
|
///// 2 PAY FEES /////
|
|
await Promise.all([
|
|
// pool 0 - split into two payments
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[0], protocolFeesByMaker[0].div(2), exchange),
|
|
// pool 1 - pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[1], protocolFeesByMaker[1], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[2], protocolFeesByMaker[2], exchange),
|
|
// pool 2 -- pay full amounts
|
|
stakingWrapper.payProtocolFeeAsync(makers[3], protocolFeesByMaker[3], exchange),
|
|
stakingWrapper.payProtocolFeeAsync(makers[4], protocolFeesByMaker[4], exchange),
|
|
// maker 5 doesn't pay anything
|
|
]);
|
|
///// 3 VALIDATE FEES RECORDED FOR EACH POOL /////
|
|
const recordedProtocolFeesByPool = await Promise.all([
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[0]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[1]),
|
|
stakingWrapper.getProtocolFeesThisEpochByPoolAsync(poolIds[2]),
|
|
]);
|
|
expect(recordedProtocolFeesByPool[0]).to.be.bignumber.equal(protocolFeesByMaker[0]);
|
|
expect(recordedProtocolFeesByPool[1]).to.be.bignumber.equal(protocolFeesByMaker[1].plus(protocolFeesByMaker[2]));
|
|
expect(recordedProtocolFeesByPool[2]).to.be.bignumber.equal(protocolFeesByMaker[3].plus(protocolFeesByMaker[4]));
|
|
///// 4 VALIDATE TOTAL FEES /////
|
|
const recordedTotalProtocolFees = await stakingWrapper.getTotalProtocolFeesThisEpochAsync();
|
|
const totalProtocolFeesAsNumber = _.sumBy(protocolFeesByMaker, (value: BigNumber) => {return value.toNumber()});
|
|
const totalProtocolFees = new BigNumber(totalProtocolFeesAsNumber);
|
|
expect(recordedTotalProtocolFees).to.be.bignumber.equal(totalProtocolFees);
|
|
///// 5 STAKE /////
|
|
const stakeByPoolOperator = [
|
|
stakingWrapper.toBaseUnitAmount(42),
|
|
stakingWrapper.toBaseUnitAmount(84),
|
|
stakingWrapper.toBaseUnitAmount(97),
|
|
];
|
|
const totalStakeByPoolOperator = stakeByPoolOperator[0].plus(stakeByPoolOperator[1]).plus(stakeByPoolOperator[2]);
|
|
await Promise.all([
|
|
// pool 0
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[0], stakeByPoolOperator[0]),
|
|
// pool 1
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[1], stakeByPoolOperator[1]),
|
|
// pool 2
|
|
stakingWrapper.depositAndStakeAsync(poolOperators[2], stakeByPoolOperator[2]),
|
|
]);
|
|
|
|
///// 6 FINALIZE /////
|
|
await stakingWrapper.skipToNextEpochAsync();
|
|
|
|
///// 7 ADD DELEGATORS (Requires Shadow ETH) /////
|
|
const delegators = stakers.slice(0, 3);
|
|
const stakeByDelegator = [
|
|
stakingWrapper.toBaseUnitAmount(17),
|
|
stakingWrapper.toBaseUnitAmount(75),
|
|
stakingWrapper.toBaseUnitAmount(90),
|
|
];
|
|
const totalStakeByDelegators = stakeByDelegator[0].plus(stakeByDelegator[1]).plus(stakeByDelegator[2]);
|
|
await Promise.all([
|
|
stakingWrapper.depositAndDelegateAsync(delegators[0], poolIds[2], stakeByDelegator[0]),
|
|
stakingWrapper.depositAndDelegateAsync(delegators[1], poolIds[2], stakeByDelegator[1]),
|
|
stakingWrapper.depositAndDelegateAsync(delegators[2], poolIds[2], stakeByDelegator[2]),
|
|
]);
|
|
|
|
///// 7 FINALIZE AGAIN /////
|
|
await stakingWrapper.skipToNextEpochAsync();
|
|
|
|
///// 7 CHECK PROFITS /////
|
|
// the expected payouts were computed by hand
|
|
// @TODO - get computations more accurate
|
|
/*
|
|
Pool | Total Fees | Total Stake | Total Delegated Stake | Total Stake (Scaled)
|
|
0 | 0.304958 | 42 | 0 | 42
|
|
1 | 15.323258 | 84 | 0 | 84
|
|
3 | 28.12222236 | 97 | 182 | 260.8
|
|
...
|
|
Cumulative Fees = 43.75043836
|
|
Cumulative Stake = 405
|
|
Total Rewards = 43.75043836
|
|
*/
|
|
|
|
const expectedPayoutByPoolOperator = [
|
|
new BigNumber('4.75677'), // 4.756772362932728793619590327361600155564384201215274334070
|
|
new BigNumber('16.28130'), // 16.28130500394935316563988584956596823402223838026190634525
|
|
new BigNumber('20.31028'), // 20.31028447343014834523983759032242063760612769662934308289
|
|
];
|
|
|
|
const payoutByPoolOperator = await Promise.all([
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[0]),
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[1]),
|
|
stakingWrapper.rewardVaultBalanceOfAsync(poolIds[2]),
|
|
]);
|
|
|
|
const payoutAcurateToFiveDecimalsByPoolOperator = await Promise.all([
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[0], 18), 5),
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[1], 18), 5),
|
|
stakingWrapper.trimFloat(stakingWrapper.toFloatingPoint(payoutByPoolOperator[2], 18), 5),
|
|
]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[0]).to.be.bignumber.equal(expectedPayoutByPoolOperator[0]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[1]).to.be.bignumber.equal(expectedPayoutByPoolOperator[1]);
|
|
expect(payoutAcurateToFiveDecimalsByPoolOperator[2]).to.be.bignumber.equal(expectedPayoutByPoolOperator[2]);
|
|
|
|
|
|
///// 10 CHECK DELEGATOR PAYOUT BY WITHDRAWING /////
|
|
{
|
|
const poolPayoutById = await Promise.all([
|
|
stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[0]),
|
|
stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[1]),
|
|
stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[2]),
|
|
]);
|
|
const ethBalancesByDelegatorInit = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(delegators[0]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[1]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[2]),
|
|
]);
|
|
await Promise.all([
|
|
stakingWrapper.withdrawTotalRewardAsync(poolIds[2], delegators[0]),
|
|
stakingWrapper.withdrawTotalRewardAsync(poolIds[2], delegators[1]),
|
|
stakingWrapper.withdrawTotalRewardAsync(poolIds[2], delegators[2]),
|
|
]);
|
|
const ethBalancesByDelegatorFinal = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(delegators[0]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[1]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[2]),
|
|
]);
|
|
const rewardByDelegator = [
|
|
ethBalancesByDelegatorFinal[0].minus(ethBalancesByDelegatorInit[0]),
|
|
ethBalancesByDelegatorFinal[1].minus(ethBalancesByDelegatorInit[1]),
|
|
ethBalancesByDelegatorFinal[2].minus(ethBalancesByDelegatorInit[2]),
|
|
];
|
|
|
|
// In this case, there was already a pot of ETH in the delegator pool that nobody had claimed.
|
|
// The first delegator got to claim it all. This is due to the necessary conservation of payouts.
|
|
// When a new delegator arrives, their new stake should not affect existing delegator payouts.
|
|
// In this case, there was unclaimed $$ in the delegator pool - which is claimed by the first delegator.
|
|
const expectedRewardByDelegator = [
|
|
poolPayoutById[2],
|
|
new BigNumber(0),
|
|
new BigNumber(0),
|
|
];
|
|
expect(rewardByDelegator[0]).to.be.bignumber.equal(expectedRewardByDelegator[0]);
|
|
expect(rewardByDelegator[1]).to.be.bignumber.equal(expectedRewardByDelegator[1]);
|
|
expect(rewardByDelegator[2]).to.be.bignumber.equal(expectedRewardByDelegator[2]);
|
|
}
|
|
|
|
{
|
|
///// 10 CHECK DELEGATOR PAYOUT BY UNDELEGATING /////
|
|
const poolPayoutById = await Promise.all([
|
|
stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[0]),
|
|
stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[1]),
|
|
stakingWrapper.rewardVaultBalanceOfPoolAsync(poolIds[2]),
|
|
]);
|
|
const ethBalancesByDelegatorInit = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(delegators[0]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[1]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[2]),
|
|
]);
|
|
await Promise.all([
|
|
stakingWrapper.deactivateAndTimelockDelegatedStakeAsync(delegators[0], poolIds[2], stakeByDelegator[0]),
|
|
stakingWrapper.deactivateAndTimelockDelegatedStakeAsync(delegators[1], poolIds[2], stakeByDelegator[1]),
|
|
stakingWrapper.deactivateAndTimelockDelegatedStakeAsync(delegators[2], poolIds[2], stakeByDelegator[2]),
|
|
]);
|
|
const ethBalancesByDelegatorFinal = await Promise.all([
|
|
stakingWrapper.getEthBalanceAsync(delegators[0]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[1]),
|
|
stakingWrapper.getEthBalanceAsync(delegators[2]),
|
|
]);
|
|
const rewardByDelegator = [
|
|
ethBalancesByDelegatorFinal[0].minus(ethBalancesByDelegatorInit[0]),
|
|
ethBalancesByDelegatorFinal[1].minus(ethBalancesByDelegatorInit[1]),
|
|
ethBalancesByDelegatorFinal[2].minus(ethBalancesByDelegatorInit[2]),
|
|
];
|
|
|
|
// In this case, there was already a pot of ETH in the delegator pool that nobody had claimed.
|
|
// The first delegator got to claim it all. This is due to the necessary conservation of payouts.
|
|
// When a new delegator arrives, their new stake should not affect existing delegator payouts.
|
|
// In this case, there was unclaimed $$ in the delegator pool - which is claimed by the first delegator.
|
|
const expectedRewardByDelegator = [
|
|
new BigNumber(0),
|
|
new BigNumber(0),
|
|
new BigNumber(0),
|
|
];
|
|
expect(rewardByDelegator[0]).to.be.bignumber.equal(expectedRewardByDelegator[0]);
|
|
expect(rewardByDelegator[1]).to.be.bignumber.equal(expectedRewardByDelegator[1]);
|
|
expect(rewardByDelegator[2]).to.be.bignumber.equal(expectedRewardByDelegator[2]);
|
|
}
|
|
});
|
|
});
|
|
});
|
|
// tslint:enable:no-unnecessary-type-assertion
|