Skip to content

Latest commit

 

History

History
139 lines (92 loc) · 6.73 KB

handbook.md

File metadata and controls

139 lines (92 loc) · 6.73 KB
Raw

使用说明

Instruction

新建活动

New Campaign

随机数需求方，想要生成随机数，首先需要新建一轮活动，需要使用newCampaign函数：

Anyone who wants to generate random number, firstly need to create a campaign by calling newCampaign function.

  function newCampaign(
      uint32 _bnum,
      uint96 _deposit,
      uint8 _commitBalkline,
      uint8 _commitDeadline
  )

新建活动需要4个参数：

  • _bnum：随机数生成的目标块数
  • _deposit：参与者需要提交的押金
  • _commitBalkline：开始提交到目标块的距离
  • _commitDeadline：结束提交到目标块的距离

This function has four parameters:

  • _bnum: The target block number
  • _deposit: The deposit for commiter
  • _commitBalkline: The distance between block number of begining to commit and _bnum
  • _commitDeadline: The distance between block number of ending to commit and _bnum

比如当前块高度是1840602，我们需要在1840900这个块时需要一个随机数，希望每个参与者提交押金为20 ether，在目标块前200个块开始提交（即从1840700块起，包含1840700），在目标块前100个块结束提交（即1840800块截止，包含1840800块），在1840800之后（不包含1840800）1840900块之前（不包含1840900）属于Reveal阶段。可以使用如下方式来调用：

For instance, the current block number is 1840602, we need a random number at 1840900, and we wish the deposit to be 20 ethers, begin to commit at the block before 200 blocks of target block(i.e. start at 1840700, include 1840700), finish to commit at the block before 100 blocks of target block(i.e. end at 1840800, include 1840800).It's the reveal phase between 1840800(not include 1840800) and 1840900(not include 1840900).We can call the function as below:

newCampaign(1840700, 20000000000000000000, 200, 100)，并且需要发送至少 1 ether 作为参与者奖励费用。 newCampaign(1840700, 20000000000000000000, 200, 100)，and we need to send 1 ether as the bounty.

跟随活动

Follow Campaign

随机数需求方可以选择不创建一轮活动，而是选择跟随某一轮随机数活动作为自己的随机数，这时可以使用 Follow 函数。

The RANDAO demonder can follow a campaign by calling Follow function instead of creating a new campaign.

function follow(uint256 _campaignID)

Follow 函数需要一个参数_campaignID，可以使用 Mist 钱包，找到某个campaignID的 Campaign 具体信息。

The Follow function has one parameter_campaignID.Anyone can find the detail infomation of the specified campaign.

跟随活动必须是在提交随机数窗口期或之前进行，否则就会失败。以前面例子为例，跟随活动必须在1840800块之前（包括1840800）。同样跟随活动需要至少 1 ether 作为参与者的奖励费用。

The follow action must at the collecting phase or before it, otherwise it will fail.In previous example, the follow action must before the 1840800 block(include 1840800).The follower need to send 1 ether for the bounty as well.

提交随机数

Collecting valid sha3(s)

参与者可以通过提交随机数来参与随机数的生成。提交随机可以调用函数：

Anyone can commit random number to participate in the campaign by calling commit function:

function commit(uint256 _campaignID, bytes32 _hs)

commit 函数有两个参数：

  • _campaignID： 活动ID
  • _hs：随机数的 sha3 值。

The commit function has two parameters:

  • _campaignID
  • _hs: The sha3 of random number.

提交随机数需要发送押金到合约，不能多于或者少于活动押金，必须刚好等于。提交随机数，必须在提交随机数窗口期提交，否则会失败。以前面例子为例，提交随机数窗口期为：1840700到1840800。

Commiting the random number must send deposit, can not more or less than the deposit must be exactly equal to the deposit.Commiting must be in the collecting phase, otherwise it will fail.In previous example, the collecting phase is between 1840700 and 1840800.

披露随机数

Reveal seed

function reveal(uint256 _campaignID, uint256 _s)

reveal函数有两个参数： reveal function has two parameters:

  • _campaignID：活动ID
  • _s：随机数

在随机数提交阶段结束之后，进入Reveal阶段，随机数提交者可以披露自己的随机数，合约会验证是否是有效的随机数，如果有效，将计算到最终的随机数结果中。以前面例子为例，随机数披露窗口期为：1840800到1840900。

After the collecting phase, then it's reveal phase, every commiter then can reveal his seed, and the contract will verify the seed.If the seed is valid, it will be used to generate final random number.In previous example, the reveal phase is between 1840800 and 1840900.

获取随机数

Fetch random number

function getRandom(uint256 _campaignID)

任何人可以在随机数目标块数之后，获取该轮活动的随机数。只有当所有的随机数提交者提交的随机数全部都收集到，才认为本轮随机数生成有效。对于没有在收集阶段提交随机数的参与者，将罚没其提交的押金，并均分给其他参与者。

Anyone can fetch the random number after the target block number.Only all the commiter succussfully reveal the seed, we take this round of campaign as valid.Otherwise, the campaign fails, and the contract confiscats the deposit of who did not reveal succussfully and distributes to the other participants.

获取奖励和押金

Get bounty and deposit

function getMyBounty(uint256 _campaignID)

在目标块之后，随机数提交者可以收回其押金和收益。

  • 如果随机数生成成功，将平分奖励费用，并返还押金
  • 如果随机数生成失败，将平分未披露随机数的参与者的押金，并返还押金
  • 如果随机数生成失败，且没有任何人成功披露随机数，所有人参与者可以取回自己的押金

After the target block, the participants can get his deposit and bounty.

  • If Campaign succeeds.Every revealer gets his deposit and the bounty.
  • Someones revel succussfully,but some does not,Campaign fails.The revealer can get the deposit,and the fines are distributed to the honest ones.
  • Nobody reveals,Campaign fails.Every commiter can get his deposit back.

退还奖励

Refund bounty

function refundBounty(uint256 _campaignID)

如果本轮随机数生成失败，随机数需求方可以通过refundBounty函数，返还其提交的奖励。

If the campaign fails, the campaign owner and the followers can get the bounty back by calling refundBounty function.