CoinToss.md

CoinToss

Romuald Hog (based on Yakitori's Coin Toss)

BetSwirl's Coin Toss game

The game is played with a two-sided coin. The game's goal is to guess whether the lucky coin face will be Heads or Tails.

Methods

bank

function bank() external view returns (contract IBank)

The bank that manage to payout a won bet and collect a loss bet.

Returns

Name	Type	Description
_0	contract IBank	undefined

bets

function bets(uint256) external view returns (bool resolved, address user, address token, uint256 id, uint256 amount, uint256 blockNumber, uint256 payout, uint256 vrfCost)

Maps bets IDs to Bet information.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
resolved	bool	undefined
user	address	undefined
token	address	undefined
id	uint256	undefined
amount	uint256	undefined
blockNumber	uint256	undefined
payout	uint256	undefined
vrfCost	uint256	undefined

coinTossBets

function coinTossBets(uint256) external view returns (bool face, bool rolled)

Maps bets IDs to chosen and rolled coin faces.

Coin faces: true = Tails, false = Heads.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
face	bool	undefined
rolled	bool	undefined

getChainlinkConfig

function getChainlinkConfig() external view returns (uint16 requestConfirmations, bytes32 keyHash, contract IVRFCoordinatorV2 chainlinkCoordinator, uint256 gasAfterCalculation)

Returns the Chainlink VRF config.

Returns

Name	Type	Description
requestConfirmations	uint16	undefined
keyHash	bytes32	undefined
chainlinkCoordinator	contract IVRFCoordinatorV2	undefined
gasAfterCalculation	uint256	undefined

getChainlinkVRFCost

function getChainlinkVRFCost(address token) external view returns (uint256)

Returns the amount of ETH that should be passed to the wager transaction. to cover Chainlink VRF fee.

Parameters

Name	Type	Description
token	address	undefined

Returns

Name	Type	Description
_0	uint256	The bet resolution cost amount.

getLastUserBets

function getLastUserBets(address user, uint256 dataLength) external view returns (struct CoinToss.FullCoinTossBet[])

Gets the list of the last user bets.

Parameters

Name	Type	Description
user	address	Address of the gamer.
dataLength	uint256	The amount of bets to return.

Returns

Name	Type	Description
_0	CoinToss.FullCoinTossBet[]	A list of Coin Toss bet.

hasPendingBets

function hasPendingBets(address token) external view returns (bool)

Returns whether the token has pending bets.

Parameters

Name	Type	Description
token	address	undefined

Returns

Name	Type	Description
_0	bool	Whether the token has pending bets.

multicall

function multicall(bytes[] data) external nonpayable returns (bytes[] results)

Receives and executes a batch of function calls on this contract.

Parameters

Name	Type	Description
data	bytes[]	undefined

Returns

Name	Type	Description
results	bytes[]	undefined

owner

function owner() external view returns (address)

Returns the address of the current owner.

Returns

Name	Type	Description
_0	address	undefined

pause

function pause() external nonpayable

Pauses the contract to disable new bets.

paused

function paused() external view returns (bool)

Returns true if the contract is paused, and false otherwise.

Returns

Name	Type	Description
_0	bool	undefined

rawFulfillRandomWords

function rawFulfillRandomWords(uint256 requestId, uint256[] randomWords) external nonpayable

Parameters

Name	Type	Description
requestId	uint256	undefined
randomWords	uint256[]	undefined

refundBet

function refundBet(uint256 id) external nonpayable

Refunds the bet to the user if the Chainlink VRF callback failed.

Parameters

Name	Type	Description
id	uint256	The Bet ID.

renounceOwnership

function renounceOwnership() external nonpayable

Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

setChainlinkConfig

function setChainlinkConfig(uint16 requestConfirmations, bytes32 keyHash, uint256 gasAfterCalculation) external nonpayable

Sets the Chainlink VRF V2 configuration.

Parameters

Name	Type	Description
requestConfirmations	uint16	How many confirmations the Chainlink node should wait before responding.
keyHash	bytes32	Hash of the public key used to verify the VRF proof.
gasAfterCalculation	uint256	Gas to be added for VRF cost refund.

setHouseEdge

function setHouseEdge(address token, uint16 houseEdge) external nonpayable

Sets the game house edge rate for a specific token.

The house edge rate couldn't exceed 4%.

Parameters

Name	Type	Description
token	address	Address of the token.
houseEdge	uint16	House edge rate.

setVRFCallbackGasLimit

function setVRFCallbackGasLimit(address token, uint32 callbackGasLimit) external nonpayable

Sets the Chainlink VRF V2 configuration.

Parameters

Name	Type	Description
token	address	undefined
callbackGasLimit	uint32	How much gas is needed in the Chainlink VRF callback.

tokens

function tokens(address) external view returns (uint16 houseEdge, uint64 pendingCount, uint32 VRFCallbackGasLimit, uint256 VRFFees)

Maps tokens addresses to token configuration.

Parameters

Name	Type	Description
_0	address	undefined

Returns

Name	Type	Description
houseEdge	uint16	undefined
pendingCount	uint64	undefined
VRFCallbackGasLimit	uint32	undefined
VRFFees	uint256	undefined

transferOwnership

function transferOwnership(address newOwner) external nonpayable

Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

Parameters

Name	Type	Description
newOwner	address	undefined

userOverchargedVRFCost

function userOverchargedVRFCost(address) external view returns (uint256)

Maps user addresses to VRF overcharged cost.

Parameters

Name	Type	Description
_0	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

wager

function wager(bool face, address token, uint256 tokenAmount) external payable

Creates a new bet and stores the chosen coin face.

Parameters

Name	Type	Description
face	bool	The chosen coin face.
token	address	Address of the token.
tokenAmount	uint256	The number of tokens bet.

withdrawOverchargedVRFCost

function withdrawOverchargedVRFCost(address user) external nonpayable

Withdraw user's overcharged Chainlink fees.

Parameters

Name	Type	Description
user	address	undefined

withdrawTokensVRFFees

function withdrawTokensVRFFees(address token) external nonpayable

Distributes the token's collected Chainlink fees.

Parameters

Name	Type	Description
token	address	Address of the token.

Events

AccountOverchargedVRFCost

event AccountOverchargedVRFCost(address indexed user, uint256 overchargedVRFCost)

Emitted after the overcharged VRF cost amount is accounted.

Parameters

Name	Type	Description
user indexed	address	undefined
overchargedVRFCost	uint256	undefined

BetRefunded

event BetRefunded(uint256 id, address user, uint256 amount, uint256 chainlinkVRFCost)

Emitted after the bet amount is transfered to the user.

Parameters

Name	Type	Description
id	uint256	undefined
user	address	undefined
amount	uint256	undefined
chainlinkVRFCost	uint256	undefined

DistributeOverchargedVRFCost

event DistributeOverchargedVRFCost(address indexed user, uint256 overchargedVRFCost)

Emitted after the user's overcharged VRF cost amount is transfered.

Parameters

Name	Type	Description
user indexed	address	undefined
overchargedVRFCost	uint256	undefined

DistributeTokenVRFFees

event DistributeTokenVRFFees(address indexed token, uint256 amount)

Emitted after the token's VRF fees amount is transfered to the user.

Parameters

Name	Type	Description
token indexed	address	undefined
amount	uint256	undefined

OwnershipTransferred

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

Name	Type	Description
previousOwner indexed	address	undefined
newOwner indexed	address	undefined

Paused

event Paused(address account)

Parameters

Name	Type	Description
account	address	undefined

PlaceBet

event PlaceBet(uint256 id, address indexed user, address indexed token, uint256 amount, uint256 vrfCost, bool face)

Emitted after a bet is placed.

Parameters

Name	Type	Description
id	uint256	The bet ID.
user indexed	address	Address of the gamer.
token indexed	address	Address of the token.
amount	uint256	The bet amount.
vrfCost	uint256	The Chainlink VRF cost paid by player.
face	bool	The chosen coin face.

Roll

event Roll(uint256 id, address indexed user, address indexed token, uint256 amount, bool face, bool rolled, uint256 payout)

Emitted after a bet is rolled.

Parameters

Name	Type	Description
id	uint256	The bet ID.
user indexed	address	Address of the gamer.
token indexed	address	Address of the token.
amount	uint256	The bet amount.
face	bool	The chosen coin face.
rolled	bool	The rolled coin face.
payout	uint256	The payout amount.

SetChainlinkConfig

event SetChainlinkConfig(uint16 requestConfirmations, bytes32 keyHash, uint256 gasAfterCalculation)

Emitted after the Chainlink config is set.

Parameters

Name	Type	Description
requestConfirmations	uint16	undefined
keyHash	bytes32	undefined
gasAfterCalculation	uint256	undefined

SetHouseEdge

event SetHouseEdge(address indexed token, uint16 houseEdge)

Emitted after the house edge is set for a token.

Parameters

Name	Type	Description
token indexed	address	undefined
houseEdge	uint16	undefined

SetVRFCallbackGasLimit

event SetVRFCallbackGasLimit(address indexed token, uint32 callbackGasLimit)

Emitted after the Chainlink callback gas limit is set for a token.

Parameters

Name	Type	Description
token indexed	address	undefined
callbackGasLimit	uint32	undefined

Unpaused

event Unpaused(address account)

Parameters

Name	Type	Description
account	address	undefined

Errors

AccessDenied

error AccessDenied()

Reverting error when sender isn't allowed.

ExcessiveHouseEdge

error ExcessiveHouseEdge()

House edge is capped at 4%.

ForbiddenToken

error ForbiddenToken()

Token is not allowed.

InvalidAddress

error InvalidAddress()

Reverting error when provided address isn't valid.

InvalidLinkWeiPrice

error InvalidLinkWeiPrice(int256 linkWei)

Chainlink price feed not working

Parameters

Name	Type	Description
linkWei	int256	LINK/ETH price returned.

NoOverchargedVRFCost

error NoOverchargedVRFCost()

No user's overcharged Chainlink fee.

NotFulfilled

error NotFulfilled()

Bet isn't resolved yet.

NotPendingBet

error NotPendingBet()

Bet provided doesn't exist or was already resolved.

OnlyCoordinatorCanFulfill

error OnlyCoordinatorCanFulfill(address have, address want)

Parameters

Name	Type	Description
have	address	undefined
want	address	undefined

TokenHasPendingBets

error TokenHasPendingBets()

Reverting error when token has pending bets.

UnderMinBetAmount

error UnderMinBetAmount(uint256 minBetAmount)

Insufficient bet amount.

Parameters

Name	Type	Description
minBetAmount	uint256	Bet amount.

WrongGasValueToCoverFee

error WrongGasValueToCoverFee()

The msg.value is not enough to cover Chainlink's fee.