Rewards

Universal decentralized ERC20 tokens rewards contract. * One ERC20 token serves as a shares, and any number of other ERC20 tokens serve as rewards(assets). Rewards distribution are divided in periods, the only thing that shareholder needs to do in order to take part in distribution is prove to rewards contract that he possess certain amount of shares before period closes. Prove is made through allowing rewards contract to take shares from the shareholder, and then depositing it through a call to rewards contract. Proof is needed for every period. * When calculating rewards distribution, resulting amount is always rounded down. * In order to be able to deposit shares, user needs to create allowance for wallet contract, using standard ERC20 approve() function, so that contract can take shares from the user, when user makes a dpeosit. * Users can withdraw their shares at any moment, but only remaining shares will be used for rewards distribution. Users can withdraw their accumulated rewards at any moment. * State flow: 1. Period closed, next period started; 2. Reward assets registered for last closed preiod; 3. Rewards distributed for closed period; 4. Shares deposited into current period; 5. Repeat. * Note: all the non constant functions return false instead of throwing in case if state change didn't happen yet.
/contracts/reward/Rewards.sol

constructor

`Rewards`

inputs	0	address	`_store`
inputs	inputs	1	bytes32	`_crate`

event

`AssetRegistered` `0700b0f4`

inputs 0 address assetAddress

event

`DepositStored` `8df23d40`

inputs 0 uint256 _part

event

`Error` `9cf38cf2`

inputs	0	address	`self`
inputs	inputs	1	uint256	`errorCode`

event

`PeriodClosed` `3a273a33`

event

`WithdrawnRewardSuccess` `9e059fe0`

inputs	0	address	`asset`
	inputs	1	address	`addr`
	inputs	2	uint256	`amountReward`

event

`WithdrawnSuccess` `9733cd8d`

inputs	0	address	`addr`
	inputs	1	uint256	`amount`
	inputs	2	uint256	`total`

function

`_emitAssetRegistered` `77e9f6fc`

inputs 0 address assetAddress

function

`_emitDepositStored` `d1ddb8b3`

inputs 0 uint256 _part

function

`_emitError` `06d44278`

inputs 0 uint256 e

function

`_emitPeriodClosed` `3e87a56d`

function

`_emitWithdrawn` `670bcab1`

inputs	0	address	`addr`
	inputs	1	uint256	`amount`
	inputs	2	uint256	`total`

function

`_emitWithdrawnReward` `2f65fa59`

inputs	0	address	`asset`
	inputs	1	address	`addr`
	inputs	2	uint256	`amount`

function, constant

`assetBalanceInPeriod` `43369c59`

Returns amount of accumulated rewards assets in a period. Always 0 for active period.

inputs	0	address	`_assetAddress`	rewards asset contract address.
inputs	inputs	1	uint256	`_period`	period.
outputs	0	uint256

function

`changeContractOwnership` `557f4bc9`

Prepares ownership pass. * Can only be called by current owner.

inputs	0	address	`_to`	address of the next owner. 0x0 is not allowed.
outputs	0	bool

function

`claimContractOwnership` `4592cd1d`

Finalize ownership pass. * Can only be called by pending owner.

outputs

bool

function

`closePeriod` `507a7328`

Close current active period and start the new period. * Can only be done if period was active longer than minimum length.

outputs 0 uint256 resultCode

function, constant

`contractOwner` `ce606ee0`

function, constant

`contractsManager` `53253d31`

function, constant

`depositBalance` `956501bb`

Returns shares amount deposited by a particular shareholder.

inputs	0	address	`_address`	shareholder address.
outputs	0	uint256

function, constant

`depositBalanceInPeriod` `cce53fc4`

Returns proven amount of shares possessed by a shareholder in a period.

inputs	0	address	`_address`	shareholder address.
inputs	inputs	1	uint256	`_period`	period.
outputs	0	uint256

function

`destroy` `83197ef0`

function

`emitAssetRegistered` `b1a97052`

inputs 0 address assetAddress

function

`emitDepositStored` `1bc24083`

inputs 0 uint256 _part

function

`emitError` `df26ca08`

inputs 0 uint256 error

function

`emitPeriodClosed` `e29065d6`

function

`emitWithdrawn` `1bbf65ef`

inputs	0	address	`addr`
	inputs	1	uint256	`amount`
	inputs	2	uint256	`total`

function

`emitWithdrawnReward` `3752f49a`

inputs	0	address	`asset`
	inputs	1	address	`addr`
	inputs	2	uint256	`amount`

function, constant

`getAssets` `67e4ac2c`

function, constant

`getCloseInterval` `9d3c7370`

function, constant

`getEventsHistory` `fff10aba`

function, constant

`getMaxSharesTransfer` `fe82b458`

function, constant

`getPeriodStartDate` `aef54664`

inputs 0 uint256 _period

function, constant

`getRewardsLeft` `be0ab3cb`

inputs 0 address shareholder

function

`init` `46639dba`

Sets ContractManager contract and period minimum length. Starts the first period. * Can be set only once.

inputs	0	address	`_contractsManager`	contracts Manager contract address.
	inputs	1	address	`_wallet`
	inputs	2	address	`_targetPlatform`
	inputs	3	uint256	`_closeIntervalDays`	period minimum length, in days.
outputs	0	uint256

function, constant

`isAuthorized` `fe9fbb80`

inputs 0 address key

function, constant

`isCalculatedFor` `76807249`

Check if shareholder have calculated rewards in a period.

inputs	0	address	`_assetAddress`	rewards asset contract address.
	inputs	1	address	`_address`	shareholder address.
	inputs	2	uint256	`_period`	period.
outputs	0	bool

function, constant

`isClosed` `d5c78a28`

Check if period is closed or not.

inputs	0	uint256	`_period`	period.
outputs	0	bool

function, constant

`lastClosedPeriod` `8632779c`

Returns last closed period.

throws in case if there is no closed periods yet.

outputs

uint256

function, constant

`lastPeriod` `d340ef8a`

Returns current active period.

outputs

uint256

function, constant

`lookupManager` `4fe59012`

Will crash if no manager in the system with given identifier.

Returns manager's address by its identifier (type).

inputs

bytes32

_identifier

is a manager's identifier. 0x0 is not allowed.

function, constant

`pendingContractOwner` `5aa77d3c`

function, constant

`periodUnique` `57bd8522`

inputs 0 uint256 _period

function, constant

`periodsLength` `6abe602d`

function, constant

`rewardsFor` `0f09330b`

Returns accumulated asset rewards available for withdrawal for shareholder.

inputs	0	address	`_assetAddress`	rewards asset contract address.
inputs	inputs	1	address	`_address`	shareholder address.
outputs	0	uint256

function

`setCloseInterval` `d5309c60`

inputs 0 uint256 _closeInterval

function

`setContractsManager` `71d3b573`

Setter for ContractsManager. Force overrides currect manager.

inputs

address

_contractsManager

contracts manager. 0x0 is not allowed.

function

`setEventsHistory` `6521afd7`

inputs 0 address _eventsHistory

function

`setMaxSharesTransfer` `896efbd6`

inputs 0 uint256 _maxSharesTransfer

function

`storeDeposits` `98af444e`

outputs 0 uint256 resultCode

function, constant

`totalDepositInPeriod` `9a24159b`

Returns total proven amount of shares possessed by shareholders in a period.

inputs	0	uint256	`_period`	period.
outputs	0	uint256

function

`transferContractOwnership` `a843c51f`

Direct ownership pass without change/claim pattern. Can be invoked only by current contract owner

inputs	0	address	`_to`	the next contract owner
outputs	0	bool

function, constant

`wallet` `521eb273`

Gets wallet address used to store tokens

outputs

address

function

`withdrawAllRewardsTotal` `590f8c93`

Withdraw all accumulated rewards. * Withdrawals are made for caller and total amount.

outputs

uint256

function

`withdrawReward` `58d3232f`

Withdraw accumulated reward of a specified rewards asset. * Withdrawal is made for caller and specified amount.

inputs	0	address	`_asset`	registered rewards asset contract address.
inputs	inputs	1	uint256	`_amount`	amount to withdraw.
outputs	0	uint256

function

`withdrawRewardTotal` `f6b003e5`

Withdraw accumulated reward of a specified rewards asset. * Withdrawal is made for caller and total amount.

inputs	0	address	`_asset`	registered rewards asset contract address.
outputs	0	uint256

function

`withdrawnTokens` `d8f9659b`

inputs	0	address[]	`tokens`
inputs	inputs	1	address	`_to`

AssetRegistered 0700b0f4

DepositStored 8df23d40

Error 9cf38cf2

PeriodClosed 3a273a33

WithdrawnRewardSuccess 9e059fe0

WithdrawnSuccess 9733cd8d

_emitAssetRegistered 77e9f6fc

_emitDepositStored d1ddb8b3

_emitError 06d44278

_emitPeriodClosed 3e87a56d

_emitWithdrawn 670bcab1

_emitWithdrawnReward 2f65fa59

assetBalanceInPeriod 43369c59

Returns amount of accumulated rewards assets in a period. Always 0 for active period.

changeContractOwnership 557f4bc9

Prepares ownership pass. * Can only be called by current owner.

claimContractOwnership 4592cd1d

Finalize ownership pass. * Can only be called by pending owner.

closePeriod 507a7328

Close current active period and start the new period. * Can only be done if period was active longer than minimum length.

contractOwner ce606ee0

contractsManager 53253d31

depositBalance 956501bb

Returns shares amount deposited by a particular shareholder.

depositBalanceInPeriod cce53fc4

Returns proven amount of shares possessed by a shareholder in a period.

destroy 83197ef0

emitAssetRegistered b1a97052

emitDepositStored 1bc24083

emitError df26ca08

emitPeriodClosed e29065d6

emitWithdrawn 1bbf65ef

emitWithdrawnReward 3752f49a

getAssets 67e4ac2c

getCloseInterval 9d3c7370

getEventsHistory fff10aba

getMaxSharesTransfer fe82b458

getPeriodStartDate aef54664

getRewardsLeft be0ab3cb

init 46639dba

Sets ContractManager contract and period minimum length. Starts the first period. * Can be set only once.

isAuthorized fe9fbb80

isCalculatedFor 76807249

Check if shareholder have calculated rewards in a period.

isClosed d5c78a28

Check if period is closed or not.

lastClosedPeriod 8632779c

Returns last closed period.

lastPeriod d340ef8a

Returns current active period.

lookupManager 4fe59012

Will crash if no manager in the system with given identifier.

pendingContractOwner 5aa77d3c

periodUnique 57bd8522

periodsLength 6abe602d

rewardsFor 0f09330b

Returns accumulated asset rewards available for withdrawal for shareholder.

setCloseInterval d5309c60

setContractsManager 71d3b573

setEventsHistory 6521afd7

setMaxSharesTransfer 896efbd6

storeDeposits 98af444e

totalDepositInPeriod 9a24159b

Returns total proven amount of shares possessed by shareholders in a period.

transferContractOwnership a843c51f

wallet 521eb273

withdrawAllRewardsTotal 590f8c93

Withdraw all accumulated rewards. * Withdrawals are made for caller and total amount.

withdrawReward 58d3232f

Withdraw accumulated reward of a specified rewards asset. * Withdrawal is made for caller and specified amount.

withdrawRewardTotal f6b003e5

Withdraw accumulated reward of a specified rewards asset. * Withdrawal is made for caller and total amount.

withdrawnTokens d8f9659b

`Rewards`

`AssetRegistered` `0700b0f4`

`DepositStored` `8df23d40`

`Error` `9cf38cf2`

`PeriodClosed` `3a273a33`

`WithdrawnRewardSuccess` `9e059fe0`

`WithdrawnSuccess` `9733cd8d`

`_emitAssetRegistered` `77e9f6fc`

`_emitDepositStored` `d1ddb8b3`

`_emitError` `06d44278`

`_emitPeriodClosed` `3e87a56d`

`_emitWithdrawn` `670bcab1`

`_emitWithdrawnReward` `2f65fa59`

`assetBalanceInPeriod` `43369c59`

`changeContractOwnership` `557f4bc9`

`claimContractOwnership` `4592cd1d`

`closePeriod` `507a7328`

`contractOwner` `ce606ee0`

`contractsManager` `53253d31`

`depositBalance` `956501bb`

`depositBalanceInPeriod` `cce53fc4`

`destroy` `83197ef0`

`emitAssetRegistered` `b1a97052`

`emitDepositStored` `1bc24083`

`emitError` `df26ca08`

`emitPeriodClosed` `e29065d6`

`emitWithdrawn` `1bbf65ef`

`emitWithdrawnReward` `3752f49a`

`getAssets` `67e4ac2c`

`getCloseInterval` `9d3c7370`

`getEventsHistory` `fff10aba`

`getMaxSharesTransfer` `fe82b458`

`getPeriodStartDate` `aef54664`

`getRewardsLeft` `be0ab3cb`

`init` `46639dba`

`isAuthorized` `fe9fbb80`

`isCalculatedFor` `76807249`

`isClosed` `d5c78a28`

`lastClosedPeriod` `8632779c`

`lastPeriod` `d340ef8a`

`lookupManager` `4fe59012`

`pendingContractOwner` `5aa77d3c`

`periodUnique` `57bd8522`

`periodsLength` `6abe602d`

`rewardsFor` `0f09330b`

`setCloseInterval` `d5309c60`

`setContractsManager` `71d3b573`

`setEventsHistory` `6521afd7`

`setMaxSharesTransfer` `896efbd6`

`storeDeposits` `98af444e`

`totalDepositInPeriod` `9a24159b`

`transferContractOwnership` `a843c51f`

`wallet` `521eb273`

`withdrawAllRewardsTotal` `590f8c93`

`withdrawReward` `58d3232f`

`withdrawRewardTotal` `f6b003e5`

`withdrawnTokens` `d8f9659b`