@cross-nft-marketplace/auction-house
TypeScript icon, indicating that this package has built-in type declarations

1.0.0-alpha.5 • Public • Published

cross-nft-marketplace — Auction House

The cross-nft-marketplace Auction House based on Zora Auction House.

The cross-nft-marketplace Auction House is an open and permissionless system that allows any creator, community, platform or DAO to create and run their own curated auction houses.

These auction houses run reserve timed auctions for NFTs, with special emphasis given to the role of curators. If an owner of an NFT chooses to list with a curator, that curator can charge a curator fee and has to approve any auction before it commences with that curators auction house.

Anyone is able to run an NFT auction on the protocol for free by simply not specifying a curator.

The cross-nft-marketplace ethos is to create public goods that are either owned by the community or by no one. As such, we have deployed this without admin functionality, and is therefore entirely permissionless and unstoppable.

Mainnet address: 0x77621dE54F690a62D525b95c979d3FbDe73cBC11

Rinkeby address: 0x11B409911f6cF5a9d3aE336eD350D78D134159E0

Table of Contents

Architecture

This protocol allows a holder of any NFT to create and perform a permissionless reserve auction. It also acknowledges the role of curators in auctions, and optionally allows the auction creator to dedicate a portion of the winnings from the auction to a curator of their choice.

Note that if a curator is specified, the curator decides when to start the auction. Additionally, the curator is able to cancel an auction before it begins.

Curators

In a metaverse of millions of NFTs, the act of curation is critical. Curators create and facilitate context and community which augment the value of NFTs that they select. The act of curation creates value for the NFT by contextualizing it and signalling its importance to a particular community. The act of curation is extremely valuable, and is directly recognized by the Auction House system. A curator who successfully auctions off an NFT for an owner can earn a share in the sale.

We have defined a curator role in the auction house. A curator can:

  • Approve and deny proposals for an NFT to be listed with them.
  • Earn a fee for their curation
  • Cancel an auction prior to bidding being commenced

Creators and collectors can submit a proposal to list their NFTs with a curator onchain, which the curator must accept (or optionally reject). This creates an onchain record of a curators activity and value creation.

Creators and collectors always have the option to run an auction themselves for free.

Create Auction

At any time, the holder of a token can create an auction. When an auction is created, the token is moved out of their wallet and held in escrow by the auction. The owner can retrieve the token at any time, so long as the auction has not begun.

Name Type Description
tokenId uint256 The tokenID to use in the auction
tokenContract address The address of the nft contract the token is from
duration uint256 The length of time, in seconds, that the auction should run for once the reserve price is hit.
reserveAndBuyNowCurrency address The currency for price checking and buy now
reservePrice uint256 The minimum price for the first bid, starting the auction
buyNowPrice address The minimum price for buy now
curator address The address of the curator for this auction
curatorFeePercentage uint8 The percentage of the winning bid to share with the curator
auctionCurrencies address[] The currencies to perform this auction in, or 0x0 for ETH

Cancel Auction

If an auction has not started yet, the curator or the creator of the auction may cancel the auction, and remove it from the registry. This action returns the token to the previous holder.

Name Type Description
auctionId uint256 The ID of the auction

Set Auction Approval

If a created auction specifies a curator to start the auction, the curator must approve it in order for it to start. This is to allow curators to specifically choose which auctions they are willing to curate and perform.

Name Type Description
auctionId uint256 The ID of the auction
approved bool The approval state to set on the auction

Create Bid

If an auction is approved, anyone is able to bid. The first bid must be greater than the reserve price. Once the first bid is successfully placed, other bidders may continue to place bids up until the auction's duration has passed.

If a bid is placed in the final 15 minutes of the auction, the auction is extended for another 15 minutes.

Name Type Description
auctionId uint256 The ID of the auction
buyNow bool The buy now action flag.
currency address The currency of bid., or 0x0 for ETH
amount uint256 The amount of currency to bid. If the bid is in ETH, this must match the sent ETH value

End Auction

Once the auction is no longer receiving bids, Anyone may finalize the auction. This action transfers the NFT to the winner, places the winning bid on the piece, and pays out the auction creator and curator.

Name Type Description
auctionId uint256 The ID of the auction

Local Development

The following assumes node >= 12

Install Dependencies

yarn

Compile Contracts

npx hardhat compile

Run Tests

npx hardhat test

Package Sidebar

Install

npm i @cross-nft-marketplace/auction-house

Weekly Downloads

2

Version

1.0.0-alpha.5

License

GPL-3.0

Unpacked Size

1.82 MB

Total Files

186

Last publish

Collaborators

  • cross-nft-marketplace