status-im
/
EIPs
mirror of https://github.com/status-im/EIPs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Automatically merged updates to draft EIP(s) 918 

Hi, I'm a bot! This change was automatically merged because:

 - It only modifies existing draft EIP(s)
 - The PR was approved or written by at least one author of each modified EIP
 - The build is passing
This commit is contained in:
Jay Logelin 2018-05-17 19:00:00 -03:00 committed by EIP Automerge Bot
parent 30add13f74
commit 348fb46e2d
1 changed files with 33 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
EIPS/eip-918.md
View File

@ -27,33 +27,34 @@ The general behavioral specification includes a primary function that defines th
``` js ``` js
contract EIP918Interface { contract EIP918Interface {
function mint(uint256 nonce) public returns (bool success);
function mint(uint256 nonce, bytes32 challenge_digest) public returns (bool success); function merge(uint256 nonce, address[] mineTokens) public returns (bool) {}
function getAdjustmentInterval() public view returns (uint); function getAdjustmentInterval() public view returns (uint);
function getChallengeNumber() public view returns (bytes32);
function getChallengeNumber() public constant returns (bytes32); function getMiningDifficulty() public view returns (uint);
function getMiningTarget() public view returns (uint);
function getMiningDifficulty() public constant returns (uint); function getMiningReward() public view returns (uint);
function hash(uint256 nonce) public returns (bytes32 digest);
function getMiningTarget() public constant returns (uint); function _reward() internal returns (uint);
function _epoch() internal returns (uint);
function getMiningReward() public constant returns (uint); function _adjustDifficulty() internal returns (uint);
// Optional
function merge(uint256 nonce, bytes32 challenge_digest, address[] mineTokens) public returns (bool success){}
event Mint(address indexed from, uint reward_amount, uint epochCount, bytes32 newChallengeNumber); event Mint(address indexed from, uint reward_amount, uint epochCount, bytes32 newChallengeNumber);
} }
``` ```
#### Abstract Contract #### Abstract Contract
The Abstract Contract adheres to the EIP918 Interface and extends behavioral definition through the introduction of 4 internal phases of token mining and minting: hash, reward, epoch and adjust difficulty, all called during the mint() operation. This construct provides a balance between being too general for use while providing amply room for multiple mined implementation types. The Abstract Contract adheres to the EIP918 Interface and extends behavioral definition through the introduction of 4 internal phases of token mining and minting: hash, reward, epoch and adjust difficulty, all called during the mint() operation. This construct provides a balance between being too general for use while providing ample room for multiple mined implementation types.
### Fields ### Fields
#### adjustmentInterval
The amount of time between difficulty adjustments in seconds.
``` js
bytes32 public adjustmentInterval;
```
#### challengeNumber #### challengeNumber
The current challenge number. It is expected tha a new challenge number is generated after a new reward is minted. The current challenge number. It is expected tha a new challenge number is generated after a new reward is minted.
@ -75,13 +76,20 @@ Cumulative counter of the total minted tokens, usually modified during the \_rew
uint public tokensMinted; uint public tokensMinted;
``` ```
#### epochCount
Number of 'blocks' mined
``` js
uint public epochCount;
```
### Mining Operations ### Mining Operations
#### mint #### mint
Returns a flag indicating a successful hash digest verification, and reward allocation to msg.sender. In order to prevent MiTM attacks, it is recommended that the digest include a recent ethereum block hash and msg.sender's address. Once verified, the mint function calculates and delivers a mining reward to the sender and performs internal accounting operations on the contract's supply. Returns a flag indicating a successful hash digest verification, and reward allocation to msg.sender. In order to prevent MiTM attacks, it is recommended that the digest include a recent ethereum block hash and msg.sender's address. Once verified, the mint function calculates and delivers a mining reward to the sender and performs internal accounting operations on the contract's supply.
The mint operation exists as a public function that invokes 4 separate phases, represented as internal functions \_hash, \_reward, \_newEpoch, and \_adjustDifficulty. In order to create the most flexible implementation while adhering to a necessary contract protocol, it is recommended that token implementors override the internal methods, allowing the base contract to handle their execution via mint. The mint operation exists as a public function that invokes 4 separate phases, represented as functions hash, \_reward, \_newEpoch, and \_adjustDifficulty. In order to create the most flexible implementation while adhering to a necessary contract protocol, it is recommended that token implementors override the internal methods, allowing the base contract to handle their execution via mint.
This externally facing function is called by miners to validate challenge digests, calculate reward, This externally facing function is called by miners to validate challenge digests, calculate reward,
populate statistics, mutate epoch variables and adjust the solution difficulty as required. Once complete, populate statistics, mutate epoch variables and adjust the solution difficulty as required. Once complete,
@ -91,7 +99,7 @@ a Mint event is emitted before returning a boolean success flag.
contract AbstractERC918 is EIP918Interface { contract AbstractERC918 is EIP918Interface {
// the amount of time between difficulty adjustments // the amount of time between difficulty adjustments
uint public adjustmentInterval = 10 minutes; uint public adjustmentInterval;
// generate a new challenge number after a new reward is minted // generate a new challenge number after a new reward is minted
bytes32 public challengeNumber; bytes32 public challengeNumber;
@ -113,11 +121,11 @@ contract AbstractERC918 is EIP918Interface {
* populate statistics, mutate epoch variables and adjust the solution difficulty as required. Once complete, * populate statistics, mutate epoch variables and adjust the solution difficulty as required. Once complete,
* a Mint event is emitted before returning a success indicator. * a Mint event is emitted before returning a success indicator.
**/ **/
function mint(uint256 nonce, bytes32 challenge_digest) public returns (bool success) { function mint(uint256 nonce) public returns (bool success) {
require(msg.sender != address(0)); require(msg.sender != address(0));
// perform the hash function validation // perform the hash function validation
_hash(nonce, challenge_digest); hash(nonce);
// calculate the current reward // calculate the current reward
uint rewardAmount = _reward(); uint rewardAmount = _reward();
@ -137,31 +145,6 @@ contract AbstractERC918 is EIP918Interface {
return true; return true;
} }
/*
* Internal interface function _hash. Overide in implementation to define hashing algorithm and
* validation
**/
function _hash(uint256 nonce, bytes32 challenge_digest) internal returns (bytes32 digest);
/*
* Internal interface function _reward. Overide in implementation to calculate and return reward
* amount
**/
function _reward() internal returns (uint);
/*
* Internal interface function _newEpoch. Overide in implementation to define a cutpoint for mutating
* mining variables in preparation for the next epoch
**/
function _epoch() internal returns (uint);
/*
* Internal interface function _adjustDifficulty. Overide in implementation to adjust the difficulty
* of the mining as required
**/
function _adjustDifficulty() internal returns (uint);
} }
``` ```
@ -180,15 +163,15 @@ event Mint(address indexed from, uint reward_amount, uint epochCount, bytes32 ne
Operationally similar to mint, except the merge function offers a list of token target addresses intended to be used to merge multiple token rewards. Operationally similar to mint, except the merge function offers a list of token target addresses intended to be used to merge multiple token rewards.
``` js ``` js
function merge(uint256 nonce, bytes32 challenge_digest, address[] mineTokens) public returns (bool success); function merge(uint256 nonce, address[] mineTokens) public returns (bool success);
``` ```
#### \_hash #### hash
Internal interface function \_hash, meant to be overridden in implementation to define hashing algorithm and validation. Returns the validated digest Public interface function hash, meant to be overridden in implementation to define hashing algorithm and validation. Returns the validated digest
``` js ``` js
function _hash(uint256 nonce, bytes32 challenge_digest) internal returns (bytes32 digest); function _hash(uint256 nonce) public returns (bytes32 digest);
``` ```
#### \_reward #### \_reward