Skip to content

与随机数预编译交互

Randomness Moonbeam Banner

概览

Moonbeam使用可验证随机函数(Verifiable Random Functions,VRF)生成可以在链上验证的随机数。VRF是一种利用一些输入值并产生随机数的加密函数,并证明这些数值是由提交者生成。此证明可以由任何人验证,以确保准确计算生成的随机数计算。

目前有两种提供随机输入的可用随机数来源,分别基于区块生产者的VRF私钥以及过去的随机数结果:本地VRFBABE Epoch随机数。本地VRF在Moonbeam中使用区块的VRF私钥以及最新区块的VRF输出值决定。而BABE Epoch随机数基于所有由中继链验证人在完整Epoch期间生产的VRF。

关于更多两种随机数来源的信息,如何请求和完成工作流程以及安全考虑,请查看Moonbeam上的随机数页面。

Moonbeam提供一个随机数预编译,其为一个允许智能合约开发者使用以太坊API通过本地VRF或BABE Epoch随机数来生成随机数。Moonbeam同样提供一个随机数消费者Solidity合约,您的合约必须继承此Solidity合约才能实现已完成的随机数请求。

此教程将会包含如何使用随机数预编译以及随机数消费者合约创建一个随机选取赢家的彩票。同时,您将学习如何直接与随机数预编译交互以执行操作,例如清除过期的随机数请求。

此预编译合约位于以下地址:

0x0000000000000000000000000000000000000809
0x0000000000000000000000000000000000000809
0x0000000000000000000000000000000000000809

注意事项

在Moonbeam使用预编译合约时,可能会出现一些意想不到的后果。 请参阅安全注意事项 页面了解更多信息。

随机数Solidity接口

Randomness.sol为一个允许开发者与预编译方法交互的Solidity接口。

此接口包含函数、常量、事件以及枚举,如下列部分所包含。

函数

此接口包含以下函数:

  • relayEpochIndex() — 返回当前的中继Epoch索引,Epoch代表当前实际时间而非区块编号
  • requiredDeposit() — 返回使用随机数请求要求的保证金
  • getRequestStatus(uint256 requestId) — 根据给定的随机数请求返回请求状态
  • getRequest(uint256 requestId) — 根据给定的随机数请求返回请求细节
  • requestLocalVRFRandomWords(address refundAddress, uint256 fee, uint64 gasLimit, bytes32 salt, uint8 numWords, uint64 delay) — 请求由平行链VRF生成的随机词
  • requestRelayBabeEpochRandomWords(address refundAddress, uint256 fee, uint64 gasLimit, bytes32 salt, uint8 numWords) — 请求由中继链BABE共识生成的随机词
  • fulfillRequest(uint256 requestId) — 完成调用消费者合约方法fulfillRandomWords的请求。调用者的费用将会在请求可完成后退还
  • increaseRequestFee(uint256 requestId, uint256 feeIncrease) — 根据给定的随机数请求提高相关费用。此适用于在请求被完成前Gas价格突然升高的情况
  • purgeExpiredRequest(uint256 requestId) — 从存储库中移除给定的过期请求,并将请求费用和保证金转移给调用者

以下为需要被定义的输入值:

  • requestId - 随机数请求的ID
  • refundAddress - 过程完成后收取剩余费用的地址
  • fee - 设定为支付完成费用的数值
  • gasLimit - 用于完成请求设置的Gas限制
  • salt - 包含随机数种子以获得不同随机词的字符串
  • numWords - 请求的随机词数量,最大至随机词的生成最大数值
  • delay - 在请求被完成前所需要经过的区块数量。此数值将需要在本地VRF请求能被完成的最大和最小区块数值之间
  • feeIncrease - 需要提高费用的数值

常量

此接口包含以下常量:

  • MAX_RANDOM_WORDS - 被请求的随机词的最大值
  • MIN_VRF_BLOCKS_DELAY - 在请求能被本地VRF请求完成前的最小区块数量
  • MAX_VRF_BLOCKS_DELAY - 在请求能被本地VRF请求完成前的最大区块数量
  • REQUEST_DEPOSIT_AMOUNT - 请求随机词所需的保证金。每个请求需要一笔保证金
变量
MAX_RANDOM_WORDS 100 words
MIN_VRF_BLOCKS_DELAY 2 blocks
MAX_VRF_BLOCKS_DELAY 2000 blocks
REQUEST_DEPOSIT_AMOUNT 1 GLMR
变量
MAX_RANDOM_WORDS 100 words
MIN_VRF_BLOCKS_DELAY 2 blocks
MAX_VRF_BLOCKS_DELAY 2000 blocks
REQUEST_DEPOSIT_AMOUNT 1 MOVR
变量
MAX_RANDOM_WORDS 100 words
MIN_VRF_BLOCKS_DELAY 2 blocks
MAX_VRF_BLOCKS_DELAY 2000 blocks
REQUEST_DEPOSIT_AMOUNT 1 DEV

事件

此接口包含以下事件:

  • FulfillmentSucceeded() - 在请求被成功执行后发起
  • FulfillmentFailed() - 在请求执行失败后发起

枚举

以下接口包含下列枚举:

  • RequestStatus - 请求的状态,分别能为DoesNotExist (0)、Pending (1)、Ready (2)或Expired (3)
  • RandomnessSource - 随机数资源的类型,分别能为LocalVRF (0)或RelayBabeEpoch (1)

随机数消费者Solidity接口

RandomnessConsumer.sol Solidity接口使智能合约能够更简单地与随机数预编译交互。使用随机数消费者能确保完成来自随机数预编译。

消费者接口包含以下函数:

  • fulfillRandomWords(uint256 requestId, uint256[] memory randomWords) - 根据给定的请求处理VRF回应,此函数将会通过rawFulfillRandomWords的调用而启动
  • rawFulfillRandomWords(uint256 requestId, uint256[] memory randomWords) - 在随机数预编译的fulfillRequest函数被调用时启动。调用的源头将被验证,确保随机数预编译为调用的源头以及fulfillRandomWords方法确实被调用

请求和完成过程

要启用随机性,您必须有一个执行以下操作的合约:

通过预编译的requestLocalVRFRandomWordsrequestRelayBabeEpochRandomWords方法请求随机数时,将会设置一个用于支付请求完成过程的费用。当使用本地VRF时,为提高不可预测性,制定的延迟时间段(以区块计算)将需要在请求被完成时经过。在最后,延迟的时间段必须大于一个区块。至于BABE Epoch随机数,您不需要制定一个延迟时间段,而可以在当前Epoch的第二个Epoch完成要求。

延迟时间段过后,请求的完成可以由任何人使用fulfillRequest方法以及先前在提交要求时设置的费用完成请求。

在通过预编译的fulfillRequest方法完成随机数请求时,RandomnessConsumer.sol合约中的 rawFulfillRandomWords函数将会被调用,其将会验证传送者为随机预编译。自其, fulfillRandomWords将被调用而请求的随机词数量将由当前区块的随机数结果以及给定的salt计算并得出。如果整个过程是成功的,FulfillmentSucceeded事件将被触发,否则FulfillmentFailed事件将被触发。

至于已完成的请求,执行的费用将会从请求费用退还给fulfillRequest调用者。任何剩余的费用以及要求的保证金将被转移回指定的退还地址。

您合约的fulfillRandomWords回调将负责处理整个完成过程。举例来说,在彩票合约中,回调将会使用随机词选取赢家并支付奖品。

如果一个请求已经过期,它可以通过预编译的purgeExpiredRequest函数删除。当此函数被调用且请求费用已经被支付给调用者,保证金将被退还给原先的请求者。

随机数请求的过程如下所示:

Randomness request happy path diagram

通过彩票合约与Solidity接口交互

在接下来的教程中,您将会学习如何与随机数预编译交互,包含需要您拥有多个账户以参与彩票抽奖的彩票合约。预设彩票合约将最小参与者人量设置为3,然而您可以根据需求更改合约中的数值。

查看先决条件

如您使用预设合约,您需要准备以下内容:

范例彩票合约

在此教程中,您将会与使用随机数预编译和消费者接口的彩票合约交互。您将会生成用于公平选取彩票获胜者的随机词。您可以在Moonbeam Docs GitHub库中寻找将被用于此教程的彩票合约文档,RandomnessLotteryDemo.sol

此彩票合约导入Randomness.sol预编译以及RandomnessConsumer.sol接口,并衍生自客户合约。在合约的架构中,您可以制定随机数的来源为本地VRF或BABE Epoch随机数。

一般而言,彩票合约包含查看随机数请求状态的功能,其将被用于决定彩票是否将持续接受新的参与者、是否开始或是否过期。它将会根据您希望使用的随机数来源使用requestLocalVRFRandomWordsrequestRelayBabeEpochRandomWords函数选取随机词。除外,它将会执行fulfillRandomWords方法并回调将会完成请求以及使用随机词随机地选取彩票获胜者。

同样合约中具有一些能够编辑的常量,尤其是能够用于产生独特结果的SALT_PREFIX

Remix设置

您可以使用Remix与随机数预编译和消费者合约交互。要将接口新增至Remix并跟随其后教程,您需要跟随以下步骤:

  1. 复制RandomnessLotteryDemo.sol文件
  2. 将文件内容粘贴至一个命名为RandomnessLotteryDemo.sol的文件

Add contracts to Remix

编译并部署彩票合约

接着,您需要在Remix中编译RandomnessLotteryDemo.sol文件:

  1. 确保RandomnessLotteryDemo.sol文件已打开
  2. 点击从上至下的第二个Compile标签
  3. 点击Compile RandomnessLotteryDemo.sol编译合约

Compile RandomnessLotteryDemo

如果合约成功被编译,您将会在Compile标签旁看见绿色的打勾标志。

当合约成功被编译,您可以跟随以下步骤部署合约:

  1. 在Remix中的Compile标签下方点击Deploy and Run标签
  2. 确保在ENVIRONMENT下拉菜单中的Injected Provider - Metamask已被选取。选取后,您将会看见MetaMask跳出弹窗要求您将账户连接至Remix
  3. 确保正确的账户在ACCOUNT下方显示
  4. 您将会需要为随机数请求支付所需的保证金。以此合约来说,需要的保证金为1个DEV。因此将数值设定为1000000000000000000并在右方的下拉菜单中选取Wei
  5. 确保CONTRACT下拉菜单中的RandomnessLotteryDemo - RandomnessLotteryDemo.sol已被选取
  6. 接着在Deploy旁输入随机数来源,这与RandomnessSource枚举相关。以本地VRF来说,输入0,BABE Epoch随机数的话,请输入1。为跟随此范例,您可以输入0并点击Deploy
  7. 在MetaMask弹窗中点击Confirm确认交易

Deploy RandomnessLotteryDemo

RANDOMNESSLOTTERYDEMO合约将出现在Deployed Contracts的列表之中。

参与彩票

预设合约需要最少3跟参与者,您可以跟随以下步骤参与:

  1. 确保您在MetaMask中切换至您希望用于参与的账户,您可以在ACCOUNT下方确认账户是否已连接
  2. VALUE一栏输入您希望贡献值彩票池的数量,数值需大于或等于预设合约中设置的100000 gweiPARTICIPATION_FEE
  3. 点击participate
  4. 在MetaMask中确认交易

Participate in the lottery

由于最少需要3个人以开启彩票活动,您需要使用不同账户重复上述步骤以开启活动。

开启彩票活动

如果您仔细查看RandomnessLotteryDemo.sol合约中的startLottery函数,您将会注意到它有onlyOwner修饰符。因此,您将需要确认在开始彩票活动之前切换为先前部署此合约的账户。

要开始抽奖并提交随机数请求(这将调用预编译的requestLocalVRFRandomWords),您可以跟随以下步骤:

  1. 确认账户属于所有人
  2. 您需要支付费用以开启抽奖,其将用于完成随机数请求。您可以将VALUE设置为200000并选取Gwei,超过的费用将被退还给msg.sender
  3. 点击startLottery
  4. 在MetaMask之中确认交易

Start the lottery

当交易完成,彩票活动将会开始并不让任何人加入。在您完成随机数请求以挑选获胜者之前,您需要等待延迟,预设VRF_BLOCKS_DELAY2个区块。

挑选获胜者

要完成请求,您可以使用fulfillRequest函数来,该函数将使用合约的requestId变量来调用随机数预编译的fulfillRequest函数。如果成功,请求将被完成且会生成随机词并执行RandomnessLotteryDemo.sol合约中定义的fulfillRandomWords函数。 fulfillRandomWords函数回调后将调用pickWinners并将累积奖金分配给随机选取的获胜者。此外,执行费用将从请求费用中退还给fulfillRequest的调用者。然后,任何剩余费用和要求的保证金都会被转移到指定的退款地址。

您可以在延迟经过后在任何账户跟随以下步骤发起完成请求:

  1. 确保您连接至您希望完成请求的账户,可以是任何账户
  2. 点击fulfillRequest
  3. 在MetaMask中确认交易

Fulfill the randomness request

如果交易显示以下错误,您可以调用increaseRequestFee

{ 
  "code": -32603,
  "message": "VM Exception while processing transaction: revert",
  "data": "0x476173206c696d69742061742063757272656e74207072696365206d757374206265206c657373207468616e206665657320616c6c6f74746564"
}

data被转移为ASCII文本阅读为:Gas limit at current price must be less than fees allotted。因此,您可以使用increaseRequestFee函数为交易提高费用并重新尝试。

当交易完成,您可以在Remix控制台查看交易细节。您可以下滑页面查看logs,您应当看到4个事件以及事件细节。以下为您应当看到的事件:

  • "event": "Ended" - 在彩票活动结束后传送的事件,这将触发参与者数量、头奖以及整体获胜者数量。在RandomnessLotteryDemo.sol合约中被定义
  • "event": "Awarded" - 在获胜者获得奖励后传送的事件,将被触发两次因预设合约中设定为2个设置。其将会触发获胜者、随机词以及获胜数量。在RandomnessLotteryDemo.sol合约中被定义
  • "event": "FulFillmentSucceeded" - 在请求被成功完成后传送的事件。在Randomness.sol预编译中被定义

Fulfill the randomness request

恭喜!您已经成功使用随机数预编译和消费者合约参与和启用彩票活动,并使用随机词选取胜者。

直接与预编译Solidity接口交互

除了通过智能合约与随机预编译进行交互外,您还可以在Remix中直接与其交互以执行创建随机请求、检查请求状态和清除过期请求等操作。请记住,您需要有一个从消费者合约继承的合约才能满足请求,因此如果您直接使用预编译来完成请求,则无法使用结果。

Remix设置

要将接口添加至Remix并跟随以下教程步骤,您将需要:

  1. 复制Randomness.sol
  2. 在Remix文件中粘贴文件内容并命名为Randomness.sol

Add precompile to Remix

编译和访问随机数预编译

接着,您将需要在Remix中编译Randomness.sol文件。要开始操作,请确认您已打开Randomness.sol文件并跟随以下步骤:

  1. 点击从上至下的第二个Compile标签
  2. 点击Compile Randomness.sol编译合约

如果合约被成功编译,您将在Compile标签旁看见绿色打勾标志。

您将会根据给定的预编译合约地址访问接口,而非部署随机数预编译:

  1. 在Remix中Compile标签下方点击Deploy and Run标签,请注意预编译合约已部署
  2. 确保在ENVIRONMENT下拉菜单中Injected Provider - MetaMask已选取。当选取时,MetaMask将跳出弹窗要求您将账户连接至Remix
  3. 确保正确的账户在ACCOUNT下方显示
  4. 确保CONTRACT下拉菜单中Randomness - Randomness.sol已被选取。由于此为预编译合约,因此并不需要部署任何代码,我们反而将会在At Address一栏中提供预编译地址
  5. 提供批量预编译的地址0x0000000000000000000000000000000000000809并点击At Address

Access the address

RANDOMNESS预编译将会出现在Deployed Contracts列表中,您将会用其完成后续教程中彩票合约的随机数请求。

获得请求状态和删除过期请求

任何人都可以清除过期的请求。您不需要成为请求随机数者才能够清除它。当您清除过期的请求时,要求费用将转给您,要求的保证金将退还给请求发起者。

要清除请求,首先您必须确保请求已过期。为此,您可以使用预编译的getRequestStatus函数验证请求的状态。此调用返回的数字对应于RequestStatus枚举中值的索引。因此,您需要验证返回的数字是否为3表示Expired

当您验证请求已过期,您可以调用purgeExpiredRequest函数清除此请求。

要验证和清除请求,您可以跟随以下步骤:

  1. 展开RANDOMNESS合约
  2. 输入您希望验证其是否过期的请求ID并点击getRequestStatus
  3. 回应将会出现在函数下方,验证您是否获得3
  4. 展开purgeExpiredRequest函数并输入要求ID
  5. 点击transact
  6. MetaMask将会跳出弹窗,请确认交易

Purge an exired request

交易完成后,您可以通过使用相同的请求ID再次调用getRequestStatus函数来验证请求已被清除。您应该收到0DoesNotExist的状态。您还可以预期请求费用的金额将转入您的帐户。