Skip to content

IPaintswapVRFCoordinator.md

Latest commit

 

History

History
516 lines (303 loc) · 9.9 KB

IPaintswapVRFCoordinator.md

File metadata and controls

516 lines (303 loc) · 9.9 KB
Raw

IPaintswapVRFCoordinator

Methods

calculateRequestPriceNative

function calculateRequestPriceNative(uint256 callbackGasLimit) external view returns (uint256 payment)

Calculate the payment for a given amount of gas using native currency

Parameters

Name Type Description
callbackGasLimit uint256 The amount of gas to provide for the callback

Returns

Name Type Description
payment uint256 The amount to pay

fulfillRandomWords

function fulfillRandomWords(uint256 requestId, address consumer, uint256 callbackGasLimit, uint256 numWords, address refundee, uint256 gasPricePaid, uint256[2] publicKey, uint256[4] proof, uint256[2] uPoint, uint256[4] vComponents, uint8 proofCtr) external nonpayable returns (bool callSuccess)

Fulfill the request for random words

Parameters

Name Type Description
requestId uint256 The ID of the request
consumer address The amount of gas fees paid to fulfill the request
callbackGasLimit uint256 undefined
numWords uint256 The number of words to fulfill
refundee address The address to refund the gas fees to
gasPricePaid uint256 The gas price paid for the request
publicKey uint256[2] The public key of the oracle
proof uint256[4] The proof of the random words
uPoint uint256[2] The u EC point defined as U = s*B - c*Y
vComponents uint256[4] The components required to compute v as V = s*H - c*Gamma
proofCtr uint8 The proof counter

Returns

Name Type Description
callSuccess bool If the fulfillment call succeeded

isRequestPending

function isRequestPending(uint256 requestId) external view returns (bool isPending)

Check to see if a request is pending

Parameters

Name Type Description
requestId uint256 The ID of the request

Returns

Name Type Description
isPending bool True if the request is pending, false otherwise/does not exist

requestRandomnessPayInNative

function requestRandomnessPayInNative(uint256 callbackGasLimit, uint256 numWords, address refundee) external payable returns (uint256 requestId)

Request some random words

Parameters

Name Type Description
callbackGasLimit uint256 The amount of gas to provide for the callback
numWords uint256 The number of words to request
refundee address The address to refund the gas fees to

Returns

Name Type Description
requestId uint256 The ID of the request

Events

ConsumerCallbackFailed

event ConsumerCallbackFailed(uint256 indexed requestId, uint8 indexed reason, address indexed target, uint256 gasLeft)

Emitted when a consumer callback is not successful

Parameters

Name Type Description
requestId indexed uint256 undefined
reason indexed uint8 undefined
target indexed address undefined
gasLeft uint256 undefined

FulfillmentGasRefunded

event FulfillmentGasRefunded(uint256 indexed requestId, address indexed refundee, uint256 gasRefunded, bool refundedSuccessfully)

Emitted when the excess gas is refunded to the refundee

Parameters

Name Type Description
requestId indexed uint256 undefined
refundee indexed address undefined
gasRefunded uint256 undefined
refundedSuccessfully bool undefined

GasPriceHistoryWindowUpdated

event GasPriceHistoryWindowUpdated(uint256 newWindow)

Emitted whne the gas price history window is updated

Parameters

Name Type Description
newWindow uint256 undefined

OracleRegistered

event OracleRegistered(address indexed oracle)

Emitted when a new oracle is registered

Parameters

Name Type Description
oracle indexed address undefined

RandomRequestLimitsUpdated

event RandomRequestLimitsUpdated(uint32 minimumGasLimit, uint32 maximumGasLimit, uint16 maxNumWords)

Emitted when request limits are updated

Parameters

Name Type Description
minimumGasLimit uint32 undefined
maximumGasLimit uint32 undefined
maxNumWords uint16 undefined

RandomWordsFulfilled

event RandomWordsFulfilled(uint256 indexed requestId, uint256[] randomWords, address indexed oracle, bool callSuccess, uint256 fulfilledAt)

Emitted when PaintswapVRFCoordinator fulfills a request

Parameters

Name Type Description
requestId indexed uint256 undefined
randomWords uint256[] undefined
oracle indexed address undefined
callSuccess bool undefined
fulfilledAt uint256 undefined

RandomWordsRequested

event RandomWordsRequested(uint256 indexed requestId, uint256 callbackGasLimit, uint256 numWords, address indexed origin, address indexed consumer, uint256 nonce, address refundee, uint256 gasPricePaid, uint256 requestedAt)

Emitted when a request is made to PaintswapVRFCoordinator

Parameters

Name Type Description
requestId indexed uint256 undefined
callbackGasLimit uint256 undefined
numWords uint256 undefined
origin indexed address undefined
consumer indexed address undefined
nonce uint256 undefined
refundee address undefined
gasPricePaid uint256 undefined
requestedAt uint256 undefined

RequestGasRefunded

event RequestGasRefunded(uint256 indexed requestId, address indexed refundee, uint256 gasRefunded, bool refundedSuccessfully)

Emitted when excess gas payment is refunded to the refundee

Parameters

Name Type Description
requestId indexed uint256 undefined
refundee indexed address undefined
gasRefunded uint256 undefined
refundedSuccessfully bool undefined

SignerAddressUpdated

event SignerAddressUpdated(address indexed signerAddress)

Emitted when the signer address is updated

Parameters

Name Type Description
signerAddress indexed address undefined

Errors

CommitmentMismatch

error CommitmentMismatch(uint256 requestId)

Revert when the fufillment call does not match the commitment

Parameters

Name Type Description
requestId uint256 undefined

FundingFailed

error FundingFailed(address oracle, uint256 amount)

Revert when funding has failed

Parameters

Name Type Description
oracle address undefined
amount uint256 undefined

InsufficientGasLimit

error InsufficientGasLimit(uint256 sent, uint256 required)

Revert when the request has an insufficient gas limit to fulfill

Parameters

Name Type Description
sent uint256 undefined
required uint256 undefined

InsufficientGasPayment

error InsufficientGasPayment(uint256 sent, uint256 required)

Revert when the payment is too low for the requested gas limit

Parameters

Name Type Description
sent uint256 undefined
required uint256 undefined

InsufficientOracleBalance

error InsufficientOracleBalance(address oracle, uint256 balance)

Revert when the oracle has an insufficient balance

Parameters

Name Type Description
oracle address undefined
balance uint256 undefined

InvalidGasPriceHistoryWindow

error InvalidGasPriceHistoryWindow(uint256 window)

Revert when the gas price history is invalid

Parameters

Name Type Description
window uint256 undefined

InvalidNumWords

error InvalidNumWords(uint256 numWords, uint256 max)

Revert when the request has an invalid number of words

Parameters

Name Type Description
numWords uint256 undefined
max uint256 undefined

InvalidProof

error InvalidProof(uint256 requestId)

Revert when the proof is invalid

Parameters

Name Type Description
requestId uint256 undefined

InvalidPublicKey

error InvalidPublicKey(uint256 requestId, address proofSigner, address vrfSigner)

Revert when the oracle has an invalid public key

Parameters

Name Type Description
requestId uint256 undefined
proofSigner address undefined
vrfSigner address undefined

NotOracle

error NotOracle(address invalid)

Revert when the address is not an oracle

Parameters

Name Type Description
invalid address undefined

OracleAlreadyRegistered

error OracleAlreadyRegistered(address oracle)

Revert when the oracle is already registered

Parameters

Name Type Description
oracle address undefined

OverConsumerGasLimit

error OverConsumerGasLimit(uint256 sent, uint256 max)

Revert when the consumer gas limit is too high

Parameters

Name Type Description
sent uint256 undefined
max uint256 undefined

WithdrawFailed

error WithdrawFailed(address recipient, uint256 amount)

Revert when the withdraw fails

Parameters

Name Type Description
recipient address undefined
amount uint256 undefined

ZeroAddress

error ZeroAddress()

Revert when submitted address is the zero address