PackVRFDirect
NOTE: This contract is a work in progress.
Methods
DEFAULT_ADMIN_ROLE
function DEFAULT_ADMIN_ROLE() external view returns (bytes32)Returns
_0
bytes32
undefined
balanceOf
function balanceOf(address account, uint256 id) external view returns (uint256)See {IERC1155-balanceOf}. Requirements: - account cannot be the zero address.
Parameters
account
address
undefined
id
uint256
undefined
Returns
_0
uint256
undefined
balanceOfBatch
function balanceOfBatch(address[] accounts, uint256[] ids) external view returns (uint256[])See {IERC1155-balanceOfBatch}. Requirements: - accounts and ids must have the same length.
Parameters
accounts
address[]
undefined
ids
uint256[]
undefined
Returns
_0
uint256[]
undefined
canClaimRewards
function canClaimRewards(address _opener) external view returns (bool)Returns whether a pack opener is ready to call claimRewards.
Parameters
_opener
address
undefined
Returns
_0
bool
undefined
claimRewards
function claimRewards() external nonpayable returns (struct ITokenBundle.Token[])Lets a pack owner open packs and receive the packs' reward units.
Returns
_0
ITokenBundle.Token[]
undefined
contractType
function contractType() external pure returns (bytes32)Returns the type of the contract.
Returns
_0
bytes32
undefined
contractURI
function contractURI() external view returns (string)Returns the contract metadata URI.
Returns
_0
string
undefined
contractVersion
function contractVersion() external pure returns (uint8)Returns the version of the contract.
Returns
_0
uint8
undefined
createPack
function createPack(ITokenBundle.Token[] _contents, uint256[] _numOfRewardUnits, string _packUri, uint128 _openStartTimestamp, uint128 _amountDistributedPerOpen, address _recipient) external payable returns (uint256 packId, uint256 packTotalSupply)Parameters
_contents
ITokenBundle.Token[]
undefined
_numOfRewardUnits
uint256[]
undefined
_packUri
string
undefined
_openStartTimestamp
uint128
undefined
_amountDistributedPerOpen
uint128
undefined
_recipient
address
undefined
Returns
packId
uint256
undefined
packTotalSupply
uint256
undefined
getDefaultRoyaltyInfo
function getDefaultRoyaltyInfo() external view returns (address, uint16)Returns the defualt royalty recipient and BPS for this contract's NFTs.
Returns
_0
address
undefined
_1
uint16
undefined
getPackContents
function getPackContents(uint256 _packId) external view returns (struct ITokenBundle.Token[] contents, uint256[] perUnitAmounts)Returns the underlying contents of a pack.
Parameters
_packId
uint256
undefined
Returns
contents
ITokenBundle.Token[]
undefined
perUnitAmounts
uint256[]
undefined
getRoleAdmin
function getRoleAdmin(bytes32 role) external view returns (bytes32)Returns the admin role that controls the specified role.
See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
Returns
_0
bytes32
undefined
getRoyaltyInfoForToken
function getRoyaltyInfoForToken(uint256 _tokenId) external view returns (address, uint16)View royalty info for a given token.
Returns royalty recipient and bps for _tokenId.
Parameters
_tokenId
uint256
The tokenID of the NFT for which to query royalty info.
Returns
_0
address
undefined
_1
uint16
undefined
getTokenCountOfBundle
function getTokenCountOfBundle(uint256 _bundleId) external view returns (uint256)Returns the total number of assets in a particular bundle.
Parameters
_bundleId
uint256
undefined
Returns
_0
uint256
undefined
getTokenOfBundle
function getTokenOfBundle(uint256 _bundleId, uint256 index) external view returns (struct ITokenBundle.Token)Returns an asset contained in a particular bundle, at a particular index.
Parameters
_bundleId
uint256
undefined
index
uint256
undefined
Returns
_0
ITokenBundle.Token
undefined
getUriOfBundle
function getUriOfBundle(uint256 _bundleId) external view returns (string)Returns the uri of a particular bundle.
Parameters
_bundleId
uint256
undefined
Returns
_0
string
undefined
grantRole
function grantRole(bytes32 role, address account) external nonpayableGrants a role to an account, if not previously granted.
Caller must have admin role for the role. Emits {RoleGranted Event}.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account to which the role is being granted.
hasRole
function hasRole(bytes32 role, address account) external view returns (bool)Checks whether an account has a particular role.
Returns true if account has been granted role.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account for which the role is being checked.
Returns
_0
bool
undefined
hasRoleWithSwitch
function hasRoleWithSwitch(bytes32 role, address account) external view returns (bool)Checks whether an account has a particular role; role restrictions can be swtiched on and off.
Returns true if account has been granted role. Role restrictions can be swtiched on and off: - If address(0) has ROLE, then the ROLE restrictions don't apply. - If address(0) does not have ROLE, then the ROLE restrictions will apply.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account for which the role is being checked.
Returns
_0
bool
undefined
initialize
function initialize(address _defaultAdmin, string _name, string _symbol, string _contractURI, address[] _trustedForwarders, address _royaltyRecipient, uint256 _royaltyBps) external nonpayableInitiliazes the contract, like a constructor.
Parameters
_defaultAdmin
address
undefined
_name
string
undefined
_symbol
string
undefined
_contractURI
string
undefined
_trustedForwarders
address[]
undefined
_royaltyRecipient
address
undefined
_royaltyBps
uint256
undefined
isApprovedForAll
function isApprovedForAll(address account, address operator) external view returns (bool)See {IERC1155-isApprovedForAll}.
Parameters
account
address
undefined
operator
address
undefined
Returns
_0
bool
undefined
isTrustedForwarder
function isTrustedForwarder(address forwarder) external view returns (bool)Parameters
forwarder
address
undefined
Returns
_0
bool
undefined
multicall
function multicall(bytes[] data) external nonpayable returns (bytes[] results)Receives and executes a batch of function calls on this contract.
Parameters
data
bytes[]
undefined
Returns
results
bytes[]
undefined
name
function name() external view returns (string)Returns
_0
string
undefined
nextTokenIdToMint
function nextTokenIdToMint() external view returns (uint256)The token Id of the next set of packs to be minted.
Returns
_0
uint256
undefined
onERC1155BatchReceived
function onERC1155BatchReceived(address, address, uint256[], uint256[], bytes) external nonpayable returns (bytes4)Parameters
_0
address
undefined
_1
address
undefined
_2
uint256[]
undefined
_3
uint256[]
undefined
_4
bytes
undefined
Returns
_0
bytes4
undefined
onERC1155Received
function onERC1155Received(address, address, uint256, uint256, bytes) external nonpayable returns (bytes4)Parameters
_0
address
undefined
_1
address
undefined
_2
uint256
undefined
_3
uint256
undefined
_4
bytes
undefined
Returns
_0
bytes4
undefined
onERC721Received
function onERC721Received(address, address, uint256, bytes) external nonpayable returns (bytes4)See {IERC721Receiver-onERC721Received}. Always returns IERC721Receiver.onERC721Received.selector.
Parameters
_0
address
undefined
_1
address
undefined
_2
uint256
undefined
_3
bytes
undefined
Returns
_0
bytes4
undefined
openPack
function openPack(uint256 _packId, uint256 _amountToOpen) external nonpayable returns (uint256)Lets a pack owner open packs and receive the packs' reward units.
Parameters
_packId
uint256
undefined
_amountToOpen
uint256
undefined
Returns
_0
uint256
undefined
openPackAndClaimRewards
function openPackAndClaimRewards(uint256 _packId, uint256 _amountToOpen, uint32 _callBackGasLimit) external nonpayable returns (uint256)Called by a pack opener to open a pack in a single transaction, instead of calling openPack and claimRewards separately.
Parameters
_packId
uint256
undefined
_amountToOpen
uint256
undefined
_callBackGasLimit
uint32
undefined
Returns
_0
uint256
undefined
owner
function owner() external view returns (address)Returns the owner of the contract.
Returns
_0
address
undefined
rawFulfillRandomWords
function rawFulfillRandomWords(uint256 _requestId, uint256[] _randomWords) external nonpayableParameters
_requestId
uint256
undefined
_randomWords
uint256[]
undefined
renounceRole
function renounceRole(bytes32 role, address account) external nonpayableRevokes role from the account.
Caller must have the role, with caller being the same as account. Emits {RoleRevoked Event}.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account from which the role is being revoked.
revokeRole
function revokeRole(bytes32 role, address account) external nonpayableRevokes role from an account.
Caller must have admin role for the role. Emits {RoleRevoked Event}.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account from which the role is being revoked.
royaltyInfo
function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address receiver, uint256 royaltyAmount)View royalty info for a given token and sale price.
Returns royalty amount and recipient for tokenId and salePrice.
Parameters
tokenId
uint256
The tokenID of the NFT for which to query royalty info.
salePrice
uint256
Sale price of the token.
Returns
receiver
address
Address of royalty recipient account.
royaltyAmount
uint256
Royalty amount calculated at current royaltyBps value.
safeBatchTransferFrom
function safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, bytes data) external nonpayableSee {IERC1155-safeBatchTransferFrom}.
Parameters
from
address
undefined
to
address
undefined
ids
uint256[]
undefined
amounts
uint256[]
undefined
data
bytes
undefined
safeTransferFrom
function safeTransferFrom(address from, address to, uint256 id, uint256 amount, bytes data) external nonpayableSee {IERC1155-safeTransferFrom}.
Parameters
from
address
undefined
to
address
undefined
id
uint256
undefined
amount
uint256
undefined
data
bytes
undefined
sendRewardsIndirect
function sendRewardsIndirect(address _opener) external nonpayableLets a pack owner open packs and receive the packs' reward units.
Parameters
_opener
address
undefined
setApprovalForAll
function setApprovalForAll(address operator, bool approved) external nonpayableSee {IERC1155-setApprovalForAll}.
Parameters
operator
address
undefined
approved
bool
undefined
setContractURI
function setContractURI(string _uri) external nonpayableLets a contract admin set the URI for contract-level metadata.
Caller should be authorized to setup contractURI, e.g. contract admin. See {_canSetContractURI}. Emits {ContractURIUpdated Event}.
Parameters
_uri
string
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
setDefaultRoyaltyInfo
function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps) external nonpayableUpdates default royalty recipient and bps.
Caller should be authorized to set royalty info. See {_canSetRoyaltyInfo}. Emits {DefaultRoyalty Event}; See {_setupDefaultRoyaltyInfo}.
Parameters
_royaltyRecipient
address
Address to be set as default royalty recipient.
_royaltyBps
uint256
Updated royalty bps.
setOwner
function setOwner(address _newOwner) external nonpayableLets an authorized wallet set a new owner for the contract.
Parameters
_newOwner
address
The address to set as the new owner of the contract.
setRoyaltyInfoForToken
function setRoyaltyInfoForToken(uint256 _tokenId, address _recipient, uint256 _bps) external nonpayableUpdates default royalty recipient and bps for a particular token.
Sets royalty info for _tokenId. Caller should be authorized to set royalty info. See {_canSetRoyaltyInfo}. Emits {RoyaltyForToken Event}; See {_setupRoyaltyInfoForToken}.
Parameters
_tokenId
uint256
undefined
_recipient
address
Address to be set as royalty recipient for given token Id.
_bps
uint256
Updated royalty bps for the token Id.
supportsInterface
function supportsInterface(bytes4 interfaceId) external view returns (bool)See ERC 165
Parameters
interfaceId
bytes4
undefined
Returns
_0
bool
undefined
symbol
function symbol() external view returns (string)Returns
_0
string
undefined
totalSupply
function totalSupply(uint256) external view returns (uint256)Mapping from token ID => total circulating supply of token with that ID.
Parameters
_0
uint256
undefined
Returns
_0
uint256
undefined
uri
function uri(uint256 _tokenId) external view returns (string)Returns the URI for a given tokenId.
Parameters
_tokenId
uint256
undefined
Returns
_0
string
undefined
Events
ApprovalForAll
event ApprovalForAll(address indexed account, address indexed operator, bool approved)Parameters
account indexed
address
undefined
operator indexed
address
undefined
approved
bool
undefined
ContractURIUpdated
event ContractURIUpdated(string prevURI, string newURI)Parameters
prevURI
string
undefined
newURI
string
undefined
DefaultRoyalty
event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps)Parameters
newRoyaltyRecipient indexed
address
undefined
newRoyaltyBps
uint256
undefined
Initialized
event Initialized(uint8 version)Parameters
version
uint8
undefined
OwnerUpdated
event OwnerUpdated(address indexed prevOwner, address indexed newOwner)Parameters
prevOwner indexed
address
undefined
newOwner indexed
address
undefined
PackCreated
event PackCreated(uint256 indexed packId, address recipient, uint256 totalPacksCreated)Emitted when a set of packs is created.
Parameters
packId indexed
uint256
undefined
recipient
address
undefined
totalPacksCreated
uint256
undefined
PackOpenRequested
event PackOpenRequested(address indexed opener, uint256 indexed packId, uint256 amountToOpen, uint256 requestId)Emitted when the opening of a pack is requested.
Parameters
opener indexed
address
undefined
packId indexed
uint256
undefined
amountToOpen
uint256
undefined
requestId
uint256
undefined
PackOpened
event PackOpened(uint256 indexed packId, address indexed opener, uint256 numOfPacksOpened, ITokenBundle.Token[] rewardUnitsDistributed)Emitted when a pack is opened.
Parameters
packId indexed
uint256
undefined
opener indexed
address
undefined
numOfPacksOpened
uint256
undefined
rewardUnitsDistributed
ITokenBundle.Token[]
undefined
PackRandomnessFulfilled
event PackRandomnessFulfilled(uint256 indexed packId, uint256 indexed requestId)Emitted when Chainlink VRF fulfills a random number request.
Parameters
packId indexed
uint256
undefined
requestId indexed
uint256
undefined
RoleAdminChanged
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)Parameters
role indexed
bytes32
undefined
previousAdminRole indexed
bytes32
undefined
newAdminRole indexed
bytes32
undefined
RoleGranted
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender)Parameters
role indexed
bytes32
undefined
account indexed
address
undefined
sender indexed
address
undefined
RoleRevoked
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender)Parameters
role indexed
bytes32
undefined
account indexed
address
undefined
sender indexed
address
undefined
RoyaltyForToken
event RoyaltyForToken(uint256 indexed tokenId, address indexed royaltyRecipient, uint256 royaltyBps)Parameters
tokenId indexed
uint256
undefined
royaltyRecipient indexed
address
undefined
royaltyBps
uint256
undefined
TransferBatch
event TransferBatch(address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] values)Parameters
operator indexed
address
undefined
from indexed
address
undefined
to indexed
address
undefined
ids
uint256[]
undefined
values
uint256[]
undefined
TransferSingle
event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value)Parameters
operator indexed
address
undefined
from indexed
address
undefined
to indexed
address
undefined
id
uint256
undefined
value
uint256
undefined
URI
event URI(string value, uint256 indexed id)Parameters
value
string
undefined
id indexed
uint256
undefined
Last updated