Created
November 12, 2022 16:52
-
-
Save jongan69/948cced2b22c4e01afb4b7788c76c5af to your computer and use it in GitHub Desktop.
Chainlink VRF Contract for rolling 20 sided die
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.8.7; | |
import '@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol'; | |
import '@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol'; | |
/** | |
* @notice A Chainlink VRF consumer which uses randomness to mimic the rolling | |
* of a 20 sided dice | |
*/ | |
/** | |
* Request testnet LINK and ETH here: https://faucets.chain.link/ | |
* Find information on LINK Token Contracts and get the latest ETH and LINK faucets here: https://docs.chain.link/docs/link-token-contracts/ | |
*/ | |
/** | |
* THIS IS AN EXAMPLE CONTRACT THAT USES HARDCODED VALUES FOR CLARITY. | |
* THIS IS AN EXAMPLE CONTRACT THAT USES UN-AUDITED CODE. | |
* DO NOT USE THIS CODE IN PRODUCTION. | |
*/ | |
contract VRFD20 is VRFConsumerBaseV2 { | |
uint256 private constant ROLL_IN_PROGRESS = 42; | |
VRFCoordinatorV2Interface COORDINATOR; | |
// Your subscription ID. | |
uint64 s_subscriptionId; | |
// Goerli coordinator. For other networks, | |
// see https://docs.chain.link/docs/vrf-contracts/#configurations | |
address vrfCoordinator = 0x2Ca8E0C643bDe4C2E08ab1fA0da3401AdAD7734D; | |
// The gas lane to use, which specifies the maximum gas price to bump to. | |
// For a list of available gas lanes on each network, | |
// see https://docs.chain.link/docs/vrf-contracts/#configurations | |
bytes32 s_keyHash = 0x79d3d8832d904592c0bf9818b621522c988bb8b0c05cdc3b15aea1b6e8db0c15; | |
// Depends on the number of requested values that you want sent to the | |
// fulfillRandomWords() function. Storing each word costs about 20,000 gas, | |
// so 40,000 is a safe default for this example contract. Test and adjust | |
// this limit based on the network that you select, the size of the request, | |
// and the processing of the callback request in the fulfillRandomWords() | |
// function. | |
uint32 callbackGasLimit = 40000; | |
// The default is 3, but you can set this higher. | |
uint16 requestConfirmations = 3; | |
// For this example, retrieve 1 random value in one request. | |
// Cannot exceed VRFCoordinatorV2.MAX_NUM_WORDS. | |
uint32 numWords = 1; | |
address s_owner; | |
// map rollers to requestIds | |
mapping(uint256 => address) private s_rollers; | |
// map vrf results to rollers | |
mapping(address => uint256) private s_results; | |
event DiceRolled(uint256 indexed requestId, address indexed roller); | |
event DiceLanded(uint256 indexed requestId, uint256 indexed result); | |
/** | |
* @notice Constructor inherits VRFConsumerBaseV2 | |
* | |
* @dev NETWORK: Goerli | |
* | |
* @param subscriptionId subscription id that this consumer contract can use | |
*/ | |
constructor(uint64 subscriptionId) VRFConsumerBaseV2(vrfCoordinator) { | |
COORDINATOR = VRFCoordinatorV2Interface(vrfCoordinator); | |
s_owner = msg.sender; | |
s_subscriptionId = subscriptionId; | |
} | |
/** | |
* @notice Requests randomness | |
* @dev Warning: if the VRF response is delayed, avoid calling requestRandomness repeatedly | |
* as that would give miners/VRF operators latitude about which VRF response arrives first. | |
* @dev You must review your implementation details with extreme care. | |
* | |
* @param roller address of the roller | |
*/ | |
function rollDice(address roller) public onlyOwner returns (uint256 requestId) { | |
require(s_results[roller] == 0, 'Already rolled'); | |
// Will revert if subscription is not set and funded. | |
requestId = COORDINATOR.requestRandomWords( | |
s_keyHash, | |
s_subscriptionId, | |
requestConfirmations, | |
callbackGasLimit, | |
numWords | |
); | |
s_rollers[requestId] = roller; | |
s_results[roller] = ROLL_IN_PROGRESS; | |
emit DiceRolled(requestId, roller); | |
} | |
/** | |
* @notice Callback function used by VRF Coordinator to return the random number to this contract. | |
* | |
* @dev Some action on the contract state should be taken here, like storing the result. | |
* @dev WARNING: take care to avoid having multiple VRF requests in flight if their order of arrival would result | |
* in contract states with different outcomes. Otherwise miners or the VRF operator would could take advantage | |
* by controlling the order. | |
* @dev The VRF Coordinator will only send this function verified responses, and the parent VRFConsumerBaseV2 | |
* contract ensures that this method only receives randomness from the designated VRFCoordinator. | |
* | |
* @param requestId uint256 | |
* @param randomWords uint256[] The random result returned by the oracle. | |
*/ | |
function fulfillRandomWords(uint256 requestId, uint256[] memory randomWords) internal override { | |
uint256 d20Value = (randomWords[0] % 20) + 1; | |
s_results[s_rollers[requestId]] = d20Value; | |
emit DiceLanded(requestId, d20Value); | |
} | |
/** | |
* @notice Get the house assigned to the player once the address has rolled | |
* @param player address | |
* @return house as a string | |
*/ | |
function house(address player) public view returns (string memory) { | |
require(s_results[player] != 0, 'Dice not rolled'); | |
require(s_results[player] != ROLL_IN_PROGRESS, 'Roll in progress'); | |
return getHouseName(s_results[player]); | |
} | |
/** | |
* @notice Get the house namne from the id | |
* @param id uint256 | |
* @return house name string | |
*/ | |
function getHouseName(uint256 id) private pure returns (string memory) { | |
string[20] memory houseNames = [ | |
'Targaryen', | |
'Lannister', | |
'Stark', | |
'Tyrell', | |
'Baratheon', | |
'Martell', | |
'Tully', | |
'Bolton', | |
'Greyjoy', | |
'Arryn', | |
'Frey', | |
'Mormont', | |
'Tarley', | |
'Dayne', | |
'Umber', | |
'Valeryon', | |
'Manderly', | |
'Clegane', | |
'Glover', | |
'Karstark' | |
]; | |
return houseNames[id - 1]; | |
} | |
modifier onlyOwner() { | |
require(msg.sender == s_owner); | |
_; | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment