x1-sfc
v3.0.4-rc.5
Published
Special Fee Contract
Downloads
2
Readme
Special Fee Contract
The SFC (Special Fee Contract) maintains a group of validators and their delegations.
It distributes the rewards, based on internal transaction created by the Opera node.
Compile in docker
make
Build output can be found in build/
Test in docker
make test
If everything is all right, it should output something along this:
Contract: SFC
Nde
✓ Should migrate to New address (67ms)
✓ Should not migrate if not owner (56ms)
✓ Should not copyCode if not owner (41ms)
✓ Should copyCode (49ms)
✓ Should not copyCode if not SFC address (43ms)
✓ Should update network version (43ms)
✓ Should not update network version if not owner (38ms)
✓ Should advance epoch
✓ Should not set a new storage if not backend address (43ms)
✓ Should not advance epoch if not owner (43ms)
✓ Should not set backend if not backend address
✓ Should not swap code if not backend address (40ms)
✓ Should not be possible add a Genesis Validator through NodeDriver if not called by Node (55ms)
✓ Should not be possible to deactivate a validator through NodeDriver if not called by Node (40ms)
✓ Should not be possible to add a Genesis Delegation through NodeDriver if not called by node
✓ Should not be possible to seal Epoch Validators through NodeDriver if not called by node
✓ Should not be possible to seal Epoch through NodeDriver if not called by node (40ms)
Genesis Validator
✓ Set Genesis Validator with bad Status (44ms)
✓ should reject sealEpoch if not called by Node
✓ should reject SealEpochValidators if not called by Node
Contract: SFC
Basic functions
Constants
✓ Returns current Epoch
✓ Returns minimum amount to stake for a Validator
✓ Returns the maximum ratio of delegations a validator can have
✓ Returns commission fee in percentage a validator will get from a delegation
✓ Returns commission fee in percentage a validator will get from a contract
✓ Returns the ratio of the reward rate at base rate (without lockup)
✓ Returns the minimum duration of a stake/delegation lockup
✓ Returns the maximum duration of a stake/delegation lockup
✓ Returns the period of time that stake is locked
✓ Returns the number of epochs that stake is locked
✓ Returns the version of the current implementation
✓ Should create a Validator and return the ID (99ms)
✓ Should fail to create a Validator insufficient self-stake (39ms)
✓ Should fail if pubkey is empty (40ms)
✓ Should create two Validators and return the correct last validator ID (193ms)
✓ Should return Delegation (118ms)
✓ Should reject if amount is insufficient for self-stake (61ms)
✓ Returns current Epoch
✓ Should return current Sealed Epoch
✓ Should return Now()
✓ Should return getTime()
Initialize
✓ Should have been initialized with firstValidator
Ownable
✓ Should return the owner of the contract
✓ Should return true if the caller is the owner of the contract
✓ Should return address(0) if owner leaves the contract without owner (58ms)
✓ Should transfer ownership to the new owner (60ms)
✓ Should not be able to transfer ownership if not owner
✓ Should not be able to transfer ownership to address(0)
Events emitters
✓ Should call updateNetworkRules
✓ Should call updateOfflinePenaltyThreshold
Contract: SFC
Prevent Genesis Call if not node
✓ Should not be possible add a Genesis Validator if called not by node (53ms)
✓ Should not be possible add a Genesis Delegation if called not by node
Create validators
✓ Should create Validators (216ms)
✓ Should return the right ValidatorID by calling getValidatorID (275ms)
✓ Should not be able to stake if Validator not created yet (307ms)
✓ Should stake with different delegators (403ms)
✓ Should return the amount of delegated for each Delegator (704ms)
✓ Should return the total of received Stake (238ms)
✓ Should return the total of received Stake (232ms)
Contract: SFC
Returns Validator
✓ Should returns Validator' status
✓ Should returns Validator' Deactivated Time
✓ Should returns Validator' Deactivated Epoch
✓ Should returns Validator's Received Stake
✓ Should returns Validator's Created Epoch
✓ Should returns Validator's Created Time
✓ Should returns Validator's Auth (address)
EpochSnapshot
✓ Returns stashedRewardsUntilEpoch (267ms)
Methods tests
✓ checking createValidator function (395ms)
✓ checking sealing epoch (481ms)
Contract: SFC
Staking / Sealed Epoch functions
✓ Should return claimed Rewards until Epoch (458ms)
✓ Check pending Rewards of delegators (333ms)
✓ Check if pending Rewards have been increased after sealing Epoch (466ms)
✓ Should increase balances after claiming Rewards (415ms)
✓ Should increase stake after restaking Rewards (562ms)
✓ Should increase locked stake after restaking Rewards (643ms)
✓ Should return stashed Rewards (411ms)
✓ Should update the validator on node (48ms)
✓ Should not be able to deactivate validator if not Node (61ms)
✓ Should seal Epochs (187ms)
✓ Should seal Epoch on Validators (167ms)
Stake lockup
✓ Check pending Rewards of delegators (301ms)
✓ Check if pending Rewards have been increased after sealing Epoch (473ms)
✓ Should increase balances after claiming Rewards (440ms)
✓ Should return stashed Rewards (438ms)
✓ Should return pending rewards after unlocking and re-locking (3653ms)
NodeDriver
✓ Should not be able to call `setGenesisValidator` if not NodeDriver (45ms)
✓ Should not be able to call `setGenesisDelegation` if not NodeDriver
✓ Should not be able to call `deactivateValidator` if not NodeDriver
✓ Should not be able to call `deactivateValidator` with wrong status (40ms)
✓ Should deactivate Validator (41ms)
✓ Should not be able to call `sealEpochValidators` if not NodeDriver
✓ Should not be able to call `sealEpoch` if not NodeDriver (68ms)
Epoch getters
✓ should return EpochvalidatorIds
✓ should return the Epoch Received Stake
✓ should return the Epoch Accumulated Reward Per Token
✓ should return the Epoch Accumulated Uptime
✓ should return the Epoch Accumulated Originated Txs Fee
✓ should return the Epoch Offline time
✓ should return Epoch Offline Blocks
Unlock features
✓ should fail if trying to unlock stake if not lockedup
✓ should fail if trying to unlock stake if amount is 0
false
✓ should return if slashed
✓ should fail if delegating to an unexisting validator (40ms)
✓ should fail if delegating to an unexisting validator (2)
SFC Rewards getters / Features
<BN: 0>
✓ should return stashed rewards
<BN: 0>
✓ should return locked stake
<BN: 0>
✓ should return locked stake (2)
Contract: SFC
Staking / Sealed Epoch functions
✓ Should setGenesisDelegation Validator (64ms)
Contract: SFC
Test Rewards Calculation
✓ Calculation of validators rewards should be equal to 30% (245ms)
✓ Should not be able withdraw if request does not exist
✓ Should not be able to undelegate 0 amount (246ms)
✓ Should not be able to undelegate if not enough unlocked stake (246ms)
✓ Should not be able to unlock if not enough unlocked stake (302ms)
✓ should return the unlocked stake (220ms)
✓ Should not be able to claim Rewards if 0 rewards (515ms)
Contract: SFC
Test Calculation Rewards with Lockup
✓ Should not be able to lock 0 amount (218ms)
✓ Should not be able to lock more than a year (270ms)
✓ Should not be able to lock more than validator lockup period (273ms)
✓ Should not be able to lock more than validator lockup period (260ms)
✓ Should be able to lock for 1 month (417ms)
✓ Should not unlock if not locked up FTM (453ms)
✓ Should not be able to unlock more than locked stake (464ms)
✓ Should unlock after period ended and stash rewards (834ms)
Contract: SFC
Test Rewards with lockup Calculation
✓ Should not update slashing refund ratio (377ms)
✓ Should not sync if validator does not exist
125 passing (2m)