Marketplace

Methods

DEFAULT_ADMIN_ROLE

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

MAX_BPS

function MAX_BPS() external view returns (uint64)

The max bps of the contract. So, 10_000 == 100 %

Returns

Name	Type	Description
_0	uint64	undefined

acceptOffer

function acceptOffer(uint256 _listingId, address _offeror, address _currency, uint256 _pricePerToken) external nonpayable

Lets a listing's creator accept an offer for their direct listing.

Parameters

Name	Type	Description
_listingId	uint256	undefined
_offeror	address	undefined
_currency	address	undefined
_pricePerToken	uint256	undefined

bidBufferBps

function bidBufferBps() external view returns (uint64)

The minimum % increase required from the previous winning bid. Default: 5%.

Returns

Name	Type	Description
_0	uint64	undefined

buy

function buy(uint256 _listingId, address _buyFor, uint256 _quantityToBuy, address _currency, uint256 _totalPrice) external payable

Lets an account buy a given quantity of tokens from a listing.

Parameters

Name	Type	Description
_listingId	uint256	undefined
_buyFor	address	undefined
_quantityToBuy	uint256	undefined
_currency	address	undefined
_totalPrice	uint256	undefined

cancelDirectListing

function cancelDirectListing(uint256 _listingId) external nonpayable

Lets a direct listing creator cancel their listing.

Parameters

Name	Type	Description
_listingId	uint256	undefined

closeAuction

function closeAuction(uint256 _listingId, address _closeFor) external nonpayable

Lets an account close an auction for either the (1) winning bidder, or (2) auction creator.

Parameters

Name	Type	Description
_listingId	uint256	undefined
_closeFor	address	undefined

contractType

function contractType() external pure returns (bytes32)

Returns the type of the contract.

Returns

Name	Type	Description
_0	bytes32	undefined

contractURI

function contractURI() external view returns (string)

Contract level metadata.

Returns

Name	Type	Description
_0	string	undefined

contractVersion

function contractVersion() external pure returns (uint8)

Returns the version of the contract.

Returns

Name	Type	Description
_0	uint8	undefined

createListing

function createListing(IMarketplace.ListingParameters _params) external nonpayable

Parameters

Name	Type	Description
_params	IMarketplace.ListingParameters	undefined

getPlatformFeeInfo

function getPlatformFeeInfo() external view returns (address, uint16)

Returns the platform fee recipient and bps.

Returns

Name	Type	Description
_0	address	undefined
_1	uint16	undefined

getRoleAdmin

function getRoleAdmin(bytes32 role) external view returns (bytes32)

Returns the admin role that controls role. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.

Parameters

Name	Type	Description
role	bytes32	undefined

Returns

Name	Type	Description
_0	bytes32	undefined

getRoleMember

function getRoleMember(bytes32 role, uint256 index) external view returns (address)

Returns one of the accounts that have role. index must be a value between 0 and {getRoleMemberCount}, non-inclusive. Role bearers are not sorted in any particular way, and their ordering may change at any point. WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure you perform all queries on the same block. See the following https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296 for more information.

Parameters

Name	Type	Description
role	bytes32	undefined
index	uint256	undefined

Returns

Name	Type	Description
_0	address	undefined

getRoleMemberCount

function getRoleMemberCount(bytes32 role) external view returns (uint256)

Returns the number of accounts that have role. Can be used together with {getRoleMember} to enumerate all bearers of a role.

Parameters

Name	Type	Description
role	bytes32	undefined

Returns

Name	Type	Description
_0	uint256	undefined

grantRole

function grantRole(bytes32 role, address account) external nonpayable

Grants role to account. If account had not been already granted role, emits a {RoleGranted} event. Requirements: - the caller must have role's admin role. May emit a {RoleGranted} event.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

hasRole

function hasRole(bytes32 role, address account) external view returns (bool)

Returns true if account has been granted role.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

initialize

function initialize(address _defaultAdmin, string _contractURI, address[] _trustedForwarders, address _platformFeeRecipient, uint256 _platformFeeBps) external nonpayable

Initiliazes the contract, like a constructor.

Parameters

Name	Type	Description
_defaultAdmin	address	undefined
_contractURI	string	undefined
_trustedForwarders	address[]	undefined
_platformFeeRecipient	address	undefined
_platformFeeBps	uint256	undefined

isTrustedForwarder

function isTrustedForwarder(address forwarder) external view returns (bool)

Parameters

Name	Type	Description
forwarder	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

listings

function listings(uint256) external view returns (uint256 listingId, address tokenOwner, address assetContract, uint256 tokenId, uint256 startTime, uint256 endTime, uint256 quantity, address currency, uint256 reservePricePerToken, uint256 buyoutPricePerToken, enum IMarketplace.TokenType tokenType, enum IMarketplace.ListingType listingType)

Mapping from uid of listing => listing info.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
listingId	uint256	undefined
tokenOwner	address	undefined
assetContract	address	undefined
tokenId	uint256	undefined
startTime	uint256	undefined
endTime	uint256	undefined
quantity	uint256	undefined
currency	address	undefined
reservePricePerToken	uint256	undefined
buyoutPricePerToken	uint256	undefined
tokenType	enum IMarketplace.TokenType	undefined
listingType	enum IMarketplace.ListingType	undefined

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

offer

function offer(uint256 _listingId, uint256 _quantityWanted, address _currency, uint256 _pricePerToken, uint256 _expirationTimestamp) external payable

Lets an account (1) make an offer to a direct listing, or (2) make a bid in an auction.

Parameters

Name	Type	Description
_listingId	uint256	undefined
_quantityWanted	uint256	undefined
_currency	address	undefined
_pricePerToken	uint256	undefined
_expirationTimestamp	uint256	undefined

offers

function offers(uint256, address) external view returns (uint256 listingId, address offeror, uint256 quantityWanted, address currency, uint256 pricePerToken, uint256 expirationTimestamp)

Mapping from uid of a direct listing => offeror address => offer made to the direct listing by the respective offeror.

Parameters

Name	Type	Description
_0	uint256	undefined
_1	address	undefined

Returns

Name	Type	Description
listingId	uint256	undefined
offeror	address	undefined
quantityWanted	uint256	undefined
currency	address	undefined
pricePerToken	uint256	undefined
expirationTimestamp	uint256	undefined

onERC1155BatchReceived

function onERC1155BatchReceived(address, address, uint256[], uint256[], bytes) external nonpayable returns (bytes4)

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined
_2	uint256[]	undefined
_3	uint256[]	undefined
_4	bytes	undefined

Returns

Name	Type	Description
_0	bytes4	undefined

onERC1155Received

function onERC1155Received(address, address, uint256, uint256, bytes) external nonpayable returns (bytes4)

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined
_2	uint256	undefined
_3	uint256	undefined
_4	bytes	undefined

Returns

Name	Type	Description
_0	bytes4	undefined

onERC721Received

function onERC721Received(address, address, uint256, bytes) external pure returns (bytes4)

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined
_2	uint256	undefined
_3	bytes	undefined

Returns

Name	Type	Description
_0	bytes4	undefined

renounceRole

function renounceRole(bytes32 role, address account) external nonpayable

Revokes role from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked role, emits a {RoleRevoked} event. Requirements: - the caller must be account. May emit a {RoleRevoked} event.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

revokeRole

function revokeRole(bytes32 role, address account) external nonpayable

Revokes role from account. If account had been granted role, emits a {RoleRevoked} event. Requirements: - the caller must have role's admin role. May emit a {RoleRevoked} event.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

setAuctionBuffers

function setAuctionBuffers(uint256 _timeBuffer, uint256 _bidBufferBps) external nonpayable

Lets a contract admin set auction buffers.

Parameters

Name	Type	Description
_timeBuffer	uint256	undefined
_bidBufferBps	uint256	undefined

setContractURI

function setContractURI(string _uri) external nonpayable

Lets a contract admin set the URI for the contract-level metadata.

Parameters

Name	Type	Description
_uri	string	undefined

setPlatformFeeInfo

function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps) external nonpayable

Lets a contract admin update platform fee recipient and bps.

Parameters

Name	Type	Description
_platformFeeRecipient	address	undefined
_platformFeeBps	uint256	undefined

supportsInterface

function supportsInterface(bytes4 interfaceId) external view returns (bool)

Parameters

Name	Type	Description
interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

timeBuffer

function timeBuffer() external view returns (uint64)

The amount of time added to an auction's 'endTime', if a bid is made within timeBuffer seconds of the existing endTime. Default: 15 minutes.

Returns

Name	Type	Description
_0	uint64	undefined

totalListings

function totalListings() external view returns (uint256)

Total number of listings ever created in the marketplace.

Returns

Name	Type	Description
_0	uint256	undefined

updateListing

function updateListing(uint256 _listingId, uint256 _quantityToList, uint256 _reservePricePerToken, uint256 _buyoutPricePerToken, address _currencyToAccept, uint256 _startTime, uint256 _secondsUntilEndTime) external nonpayable

Lets a listing's creator edit the listing's parameters.

Parameters

Name	Type	Description
_listingId	uint256	undefined
_quantityToList	uint256	undefined
_reservePricePerToken	uint256	undefined
_buyoutPricePerToken	uint256	undefined
_currencyToAccept	address	undefined
_startTime	uint256	undefined
_secondsUntilEndTime	uint256	undefined

winningBid

function winningBid(uint256) external view returns (uint256 listingId, address offeror, uint256 quantityWanted, address currency, uint256 pricePerToken, uint256 expirationTimestamp)

Mapping from uid of an auction listing => current winning bid in an auction.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
listingId	uint256	undefined
offeror	address	undefined
quantityWanted	uint256	undefined
currency	address	undefined
pricePerToken	uint256	undefined
expirationTimestamp	uint256	undefined

Events

AuctionBuffersUpdated

event AuctionBuffersUpdated(uint256 timeBuffer, uint256 bidBufferBps)

Parameters

Name	Type	Description
timeBuffer	uint256	undefined
bidBufferBps	uint256	undefined

AuctionClosed

event AuctionClosed(uint256 indexed listingId, address indexed closer, bool indexed cancelled, address auctionCreator, address winningBidder)

Parameters

Name	Type	Description
listingId indexed	uint256	undefined
closer indexed	address	undefined
cancelled indexed	bool	undefined
auctionCreator	address	undefined
winningBidder	address	undefined

Initialized

event Initialized(uint8 version)

Parameters

Name	Type	Description
version	uint8	undefined

ListingAdded

event ListingAdded(uint256 indexed listingId, address indexed assetContract, address indexed lister, IMarketplace.Listing listing)

Parameters

Name	Type	Description
listingId indexed	uint256	undefined
assetContract indexed	address	undefined
lister indexed	address	undefined
listing	IMarketplace.Listing	undefined

ListingRemoved

event ListingRemoved(uint256 indexed listingId, address indexed listingCreator)

Parameters

Name	Type	Description
listingId indexed	uint256	undefined
listingCreator indexed	address	undefined

ListingUpdated

event ListingUpdated(uint256 indexed listingId, address indexed listingCreator)

Parameters

Name	Type	Description
listingId indexed	uint256	undefined
listingCreator indexed	address	undefined

NewOffer

event NewOffer(uint256 indexed listingId, address indexed offeror, enum IMarketplace.ListingType indexed listingType, uint256 quantityWanted, uint256 totalOfferAmount, address currency)

Parameters

Name	Type	Description
listingId indexed	uint256	undefined
offeror indexed	address	undefined
listingType indexed	enum IMarketplace.ListingType	undefined
quantityWanted	uint256	undefined
totalOfferAmount	uint256	undefined
currency	address	undefined

NewSale

event NewSale(uint256 indexed listingId, address indexed assetContract, address indexed lister, address buyer, uint256 quantityBought, uint256 totalPricePaid)

Parameters

Name	Type	Description
listingId indexed	uint256	undefined
assetContract indexed	address	undefined
lister indexed	address	undefined
buyer	address	undefined
quantityBought	uint256	undefined
totalPricePaid	uint256	undefined

PlatformFeeInfoUpdated

event PlatformFeeInfoUpdated(address indexed platformFeeRecipient, uint256 platformFeeBps)

Parameters

Name	Type	Description
platformFeeRecipient indexed	address	undefined
platformFeeBps	uint256	undefined

RoleAdminChanged

event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)

Parameters

Name	Type	Description
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

Name	Type	Description
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

Name	Type	Description
role indexed	bytes32	undefined
account indexed	address	undefined
sender indexed	address	undefined