Two weeks ago we asked our community to help bring open source NFT reserve auction functionality to the world. Today, we’re auctioning off that code (with the code!) as a 1/1 NFT.
Reserve Auctions are a mechanism for selling NFTs widely credited with creating more value for artists, but they have typically been limited to proprietary marketplaces. We wanted to bring a robust and completely permissionless version to anyone who wants to use it.
By open-sourcing this implementation of a reserve auction, we hope to directly empower creators by giving them the tools they need to freely sell their work, on their terms.
In just over an hour we raised 7 ETH from 40 backers, who in turn received $BOUNTY tokens representing their patronage of this community-focused initiative.
What made this approach to crowdfunding even more unique is that the resulting smart contract code would be made open source, minted as an NFT and then auctioned off, with the value of the NFT flowing back to $BOUNTY holders. See all the details of $BOUNTY in the original crowdfund post.
Today we’re excited to announce that $BOUNTY: The First Tokenized, Crowdfunded Smart Contract is officially minted and up for auction.
Importantly, this NFT is being auctioned using the auction code embedded in the NFT itself. Cue inception memes
At the end of this post is the initial commit of the smart contract code. Since this post is minted as an NFT, this code is immortalized as part of it. Owning this NFT means owning a 1/1 collectible representing the initial commit of the open-source implementation of reserve auctions, which will live on Mint Fund’s GitHub repo.
The Process
Initially Mint Fund created a bounty via a Mirror crowdfund to fund the development of an open source version of reserve auction smart contract, which was fulfilled by Solidity developer Billy Rennekamp.
The Mirror team took this code and improved on it until it was production ready. The final version (included at the bottom of this post) was used to auction off two NFTs on April 1st, 2021 for a combined value of 26.1 ETH.
In a testament to open source collaboration and smart contract composability, this auction code builds on top of the open Zora NFT protocol and honors the creator share of zNFTs.
Furthermore, it also supports specifying a curator fee for facilitating the auction. This enables organizations like Mint Fund or other galleries a potential business model to sustain their operations .
We’d like to credit projects that have pioneered and improved on the reserve auction mechanism and experience, such as SuperRare and Foundation.
Next Steps
The Zora team is working on adding functionality to the reserve auction code that more fully utilizes the power of the Zora Protocol. Zora's update will support bidding in any ERC20 token, and honoring the sell-on-share fee that users will know from the Zora interface.
What $BOUNTY holders get.
Following the initial crowdfund, $BOUNTY tokens were distributed to all backers. 25% of $BOUNTY tokens were retained by MintFund, with 5% allocated to the developer implementing the bounty. The remaining 70% were distributed to the $BOUNTY crowdfund backers.
$BOUNTY represents the shared value created through the crowdfunding, development and auction of the NFT. If the $BOUNTY NFT sells, the proceeds will go to the crowdfund and thereby the $BOUNTY backers. Holding $BOUNTY tokens also grant one access to a private channel on the Mint Fund discord only accessible by those holding at least 15 $BOUNTY.
The future of public goods funding
As far as we know, this has been the first experiment to combine crypto-native crowdfunding with public works minted as an NFT. Recently, Vitalik wrote about the potential to use token incentives, NFTs, and decentralized governance to fund public goods like scientific research, local journalism, and poverty relief.
We believe this new model has the opportunity to create win-win scenarios for all parties involved: backers, creators, developers, collectors, and end-consumers of these funded projects.
MintFund hopes to see others experiment with this model and push the boundaries of how creative work is financed, produced, and owned using the internet and crypto-native tools.
The Code
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity 0.6.8;
pragma experimental ABIEncoderV2;
// OpenZeppelin library for performing math operations without overflows.
import {SafeMath} from "@openzeppelin/contracts/math/SafeMath.sol";
// OpenZeppelin security library for preventing reentrancy attacks.
import {
ReentrancyGuard
} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
// For interacting with Zora's Market contract.
import {IMarket} from "./interfaces/IMarket.sol";
// For checking `supportsInterface`.
import {IERC165} from "@openzeppelin/contracts/introspection/IERC165.sol";
// For interacting with NFT tokens.
import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
contract IMediaModified {
mapping(uint256 => address) public tokenCreators;
address public marketContract;
}
interface IWETH {
function deposit() external payable;
function transfer(address to, uint256 value) external returns (bool);
}
contract ReserveAuctionV3 is ReentrancyGuard {
// Use OpenZeppelin's SafeMath library to prevent overflows.
using SafeMath for uint256;
// ============ Constants ============
// The minimum amount of time left in an auction after a new bid is created; 15 min.
uint16 public constant TIME_BUFFER = 900;
// The ETH needed above the current bid for a new bid to be valid; 0.001 ETH.
uint8 public constant MIN_BID_INCREMENT_PERCENT = 10;
// Interface constant for ERC721, to check values in constructor.
bytes4 private constant ERC721_INTERFACE_ID = 0x80ac58cd;
// Allows external read `getVersion()` to return a version for the auction.
uint256 private constant RESERVE_AUCTION_VERSION = 1;
// ============ Immutable Storage ============
// The address of the ERC721 contract for tokens auctioned via this contract.
address public immutable nftContract;
// The address of the WETH contract, so that ETH can be transferred via
// WETH if native ETH transfers fail.
address public immutable wethAddress;
// The address that initially is able to recover assets.
address public immutable adminRecoveryAddress;
// ============ Mutable Storage ============
/**
* To start, there will be an admin account that can recover funds
* if anything goes wrong. Later, this public flag will be irrevocably
* set to false, removing any admin privileges forever.
*
* To check if admin recovery is enabled, call the public function `adminRecoveryEnabled()`.
*/
bool private _adminRecoveryEnabled;
/**
* The account `adminRecoveryAddress` can also pause the contracts
* while _adminRecoveryEnabled is enabled. This prevents people from using
* the contract if there is a known problem with it.
*/
bool private _paused;
// A mapping of all of the auctions currently running.
mapping(uint256 => Auction) public auctions;
// ============ Structs ============
struct Auction {
// The value of the current highest bid.
uint256 amount;
// The amount of time that the auction should run for,
// after the first bid was made.
uint256 duration;
// The time of the first bid.
uint256 firstBidTime;
// The minimum price of the first bid.
uint256 reservePrice;
uint8 curatorFeePercent;
// The address of the auction's curator. The curator
// can cancel the auction if it hasn't had a bid yet.
address curator;
// The address of the current highest bid.
address payable bidder;
// The address that should receive funds once the NFT is sold.
address payable fundsRecipient;
}
// ============ Events ============
// All of the details of a new auction,
// with an index created for the tokenId.
event AuctionCreated(
uint256 indexed tokenId,
address nftContractAddress,
uint256 duration,
uint256 reservePrice,
uint8 curatorFeePercent,
address curator,
address fundsRecipient
);
// All of the details of a new bid,
// with an index created for the tokenId.
event AuctionBid(
uint256 indexed tokenId,
address nftContractAddress,
address sender,
uint256 value
);
// All of the details of an auction's cancelation,
// with an index created for the tokenId.
event AuctionCanceled(
uint256 indexed tokenId,
address nftContractAddress,
address curator
);
// All of the details of an auction's close,
// with an index created for the tokenId.
event AuctionEnded(
uint256 indexed tokenId,
address nftContractAddress,
address curator,
address winner,
uint256 amount,
address nftCreator,
address payable fundsRecipient
);
// When the curator recevies fees, emit the details including the amount,
// with an index created for the tokenId.
event CuratorFeePercentTransfer(
uint256 indexed tokenId,
address curator,
uint256 amount
);
// Emitted in the case that the contract is paused.
event Paused(address account);
// Emitted when the contract is unpaused.
event Unpaused(address account);
// ============ Modifiers ============
// Reverts if the sender is not admin, or admin
// functionality has been turned off.
modifier onlyAdminRecovery() {
require(
// The sender must be the admin address, and
// adminRecovery must be set to true.
adminRecoveryAddress == msg.sender && adminRecoveryEnabled(),
"Caller does not have admin privileges"
);
_;
}
// Reverts if the sender is not the auction's curator.
modifier onlyCurator(uint256 tokenId) {
require(
auctions[tokenId].curator == msg.sender,
"Can only be called by auction curator"
);
_;
}
// Reverts if the contract is paused.
modifier whenNotPaused() {
require(!paused(), "Contract is paused");
_;
}
// Reverts if the auction does not exist.
modifier auctionExists(uint256 tokenId) {
// The auction exists if the curator is not null.
require(!auctionCuratorIsNull(tokenId), "Auction doesn't exist");
_;
}
// Reverts if the auction exists.
modifier auctionNonExistant(uint256 tokenId) {
// The auction does not exist if the curator is null.
require(auctionCuratorIsNull(tokenId), "Auction already exists");
_;
}
// Reverts if the auction is expired.
modifier auctionNotExpired(uint256 tokenId) {
require(
// Auction is not expired if there's never been a bid, or if the
// current time is less than the time at which the auction ends.
auctions[tokenId].firstBidTime == 0 ||
block.timestamp < auctionEnds(tokenId),
"Auction expired"
);
_;
}
// Reverts if the auction is not complete.
// Auction is complete if there was a bid, and the time has run out.
modifier auctionComplete(uint256 tokenId) {
require(
// Auction is complete if there has been a bid, and the current time
// is greater than the auction's end time.
auctions[tokenId].firstBidTime > 0 &&
block.timestamp >= auctionEnds(tokenId),
"Auction hasn't completed"
);
_;
}
// ============ Constructor ============
constructor(
address nftContract_,
address wethAddress_,
address adminRecoveryAddress_
) public {
require(
IERC165(nftContract_).supportsInterface(ERC721_INTERFACE_ID),
"Contract at nftContract_ address does not support NFT interface"
);
// Initialize immutable memory.
nftContract = nftContract_;
wethAddress = wethAddress_;
adminRecoveryAddress = adminRecoveryAddress_;
// Initialize mutable memory.
_paused = false;
_adminRecoveryEnabled = true;
}
// ============ Create Auction ============
function createAuction(
uint256 tokenId,
uint256 duration,
uint256 reservePrice,
uint8 curatorFeePercent,
address curator,
address payable fundsRecipient
) external nonReentrant whenNotPaused auctionNonExistant(tokenId) {
// Check basic input requirements are reasonable.
require(curator != address(0));
require(fundsRecipient != address(0));
require(curatorFeePercent < 100, "Curator fee should be < 100");
// Initialize the auction details, including null values.
auctions[tokenId] = Auction({
duration: duration,
reservePrice: reservePrice,
curatorFeePercent: curatorFeePercent,
curator: curator,
fundsRecipient: fundsRecipient,
amount: 0,
firstBidTime: 0,
bidder: address(0)
});
// Transfer the NFT into this auction contract, from whoever owns it.
IERC721(nftContract).transferFrom(
IERC721(nftContract).ownerOf(tokenId),
address(this),
tokenId
);
// Emit an event describing the new auction.
emit AuctionCreated(
tokenId,
nftContract,
duration,
reservePrice,
curatorFeePercent,
curator,
fundsRecipient
);
}
// ============ Create Bid ============
function createBid(uint256 tokenId, uint256 amount)
externalpayablenonReentrant
whenNotPaused
auctionExists(tokenId)
auctionNotExpired(tokenId)
{
// Validate that the user's expected bid value matches the ETH deposit.
require(amount == msg.value, "Amount doesn't equal msg.value");
require(amount > 0, "Amount must be greater than 0");
// Check if the current bid amount is 0.
if (auctions[tokenId].amount == 0) {
// If so, it is the first bid.
auctions[tokenId].firstBidTime = block.timestamp;
// We only need to check if the bid matches reserve bid for the first bid,
// since future checks will need to be higher than any previous bid.
require(
amount >= auctions[tokenId].reservePrice,
"Must bid reservePrice or more"
);
} else {
// Check that the new bid is sufficiently higher than the previous bid, by
// the percentage defined as MIN_BID_INCREMENT_PERCENT.
require(
amount >=
auctions[tokenId].amount.add(
// Add 10% of the current bid to the current bid.
auctions[tokenId]
.amount
.mul(MIN_BID_INCREMENT_PERCENT)
.div(100)
),
"Must bid more than last bid by MIN_BID_INCREMENT_PERCENT amount"
);
// Refund the previous bidder.
transferETHOrWETH(
auctions[tokenId].bidder,
auctions[tokenId].amount
);
}
// Update the current auction.
auctions[tokenId].amount = amount;
auctions[tokenId].bidder = msg.sender;
// Compare the auction's end time with the current time plus the 15 minute extension,
// to see whether we're near the auctions end and should extend the auction.
if (auctionEnds(tokenId) < block.timestamp.add(TIME_BUFFER)) {
// We add onto the duration whenever time increment is required, so
// that the auctionEnds at the current time plus the buffer.
auctions[tokenId].duration += block.timestamp.add(TIME_BUFFER).sub(
auctionEnds(tokenId)
);
}
// Emit the event that a bid has been made.
emit AuctionBid(tokenId, nftContract, msg.sender, amount);
}
// ============ End Auction ============
function endAuction(uint256 tokenId)
externalnonReentrant
whenNotPaused
auctionComplete(tokenId)
{
// Store relevant auction data in memory for the life of this function.
address winner = auctions[tokenId].bidder;
uint256 amount = auctions[tokenId].amount;
address curator = auctions[tokenId].curator;
uint8 curatorFeePercent = auctions[tokenId].curatorFeePercent;
address payable fundsRecipient = auctions[tokenId].fundsRecipient;
// Remove all auction data for this token from storage.
delete auctions[tokenId];
// We don't use safeTransferFrom, to prevent reverts at this point,
// which would break the auction.
IERC721(nftContract).transferFrom(address(this), winner, tokenId);
// First handle the curator's fee.
if (curatorFeePercent > 0) {
// Determine the curator amount, which is some percent of the total.
uint256 curatorAmount = amount.mul(curatorFeePercent).div(100);
// Send it to the curator.
transferETHOrWETH(curator, curatorAmount);
// Subtract the curator amount from the total funds available
// to send to the funds recipient and original NFT creator.
amount = amount.sub(curatorAmount);
// Emit the details of the transfer as an event.
emit CuratorFeePercentTransfer(tokenId, curator, curatorAmount);
}
// Get the address of the original creator, so that we can split shares
// if appropriate.
address payable nftCreator =
payable(
address(IMediaModified(nftContract).tokenCreators(tokenId))
);
// If the creator and the recipient of the funds are the same
// (and we expect this to be common), we can just do one transaction.
if (nftCreator == fundsRecipient) {
transferETHOrWETH(nftCreator, amount);
} else {
// Otherwise, we should determine the percent that goes to the creator.
// Collect share data from Zora.
uint256 creatorAmount =
// Call the splitShare function on the market contract, which
// takes in a Decimal and an amount.
IMarket(IMediaModified(nftContract).marketContract())
.splitShare(
// Fetch the decimal from the BidShares data on the market.
IMarket(IMediaModified(nftContract).marketContract())
.bidSharesForToken(tokenId)
.creator,
// Specify the amount.
amount
);
// Send the creator's share to the creator.
transferETHOrWETH(nftCreator, creatorAmount);
// Send the remainder of the amount to the funds recipient.
transferETHOrWETH(fundsRecipient, amount.sub(creatorAmount));
}
// Emit an event describing the end of the auction.
emit AuctionEnded(
tokenId,
nftContract,
curator,
winner,
amount,
nftCreator,
fundsRecipient
);
}
// ============ Cancel Auction ============
function cancelAuction(uint256 tokenId)
externalnonReentrant
auctionExists(tokenId)
onlyCurator(tokenId)
{
// Check that there hasn't already been a bid for this NFT.
require(
uint256(auctions[tokenId].firstBidTime) == 0,
"Auction already started"
);
// Pull the creator address before removing the auction.
address curator = auctions[tokenId].curator;
// Remove all data about the auction.
delete auctions[tokenId];
// Transfer the NFT back to the curator.
IERC721(nftContract).transferFrom(address(this), curator, tokenId);
// Emit an event describing that the auction has been canceled.
emit AuctionCanceled(tokenId, nftContract, curator);
}
// ============ Admin Functions ============
// Irrevocably turns off admin recovery.
function turnOffAdminRecovery() external onlyAdminRecovery {
_adminRecoveryEnabled = false;
}
function pauseContract() external onlyAdminRecovery {
_paused = true;
emit Paused(msg.sender);
}
function unpauseContract() external onlyAdminRecovery {
_paused = false;
emit Unpaused(msg.sender);
}
// Allows the admin to transfer any NFT from this contract
// to the recovery address.
function recoverNFT(uint256 tokenId) external onlyAdminRecovery {
IERC721(nftContract).transferFrom(
// From the auction contract.
address(this),
// To the recovery account.
adminRecoveryAddress,
// For the specified token.
tokenId
);
}
// Allows the admin to transfer any ETH from this contract to the recovery address.
function recoverETH(uint256 amount)
externalonlyAdminRecovery
returns (bool success)
{
// Attempt an ETH transfer to the recovery account, and return true if it succeeds.
success = attemptETHTransfer(adminRecoveryAddress, amount);
}
// ============ Miscellaneous Public and External ============
// Returns true if the contract is paused.
function paused() public view returns (bool) {
return _paused;
}
// Returns true if admin recovery is enabled.
function adminRecoveryEnabled() public view returns (bool) {
return _adminRecoveryEnabled;
}
// Returns the version of the deployed contract.
function getVersion() external pure returns (uint256 version) {
version = RESERVE_AUCTION_VERSION;
}
// ============ Private Functions ============
// Will attempt to transfer ETH, but will transfer WETH instead if it fails.
function transferETHOrWETH(address to, uint256 value) private {
// Try to transfer ETH to the given recipient.
if (!attemptETHTransfer(to, value)) {
// If the transfer fails, wrap and send as WETH, so that
// the auction is not impeded and the recipient still
// can claim ETH via the WETH contract (similar to escrow).
IWETH(wethAddress).deposit{value: value}();
IWETH(wethAddress).transfer(to, value);
// At this point, the recipient can unwrap WETH.
}
}
// Sending ETH is not guaranteed complete, and the method used here will return false if
// it fails. For example, a contract can block ETH transfer, or might use
// an excessive amount of gas, thereby griefing a new bidder.
// We should limit the gas used in transfers, and handle failure cases.
function attemptETHTransfer(address to, uint256 value)
privatereturns (bool)
{
// Here increase the gas limit a reasonable amount above the default, and try
// to send ETH to the recipient.
// NOTE: This might allow the recipient to attempt a limited reentrancy attack.
(bool success, ) = to.call{value: value, gas: 30000}("");
return success;
}
// Returns true if the auction's curator is set to the null address.
function auctionCuratorIsNull(uint256 tokenId) private view returns (bool) {
// The auction does not exist if the curator is the null address,
// since the NFT would not have been transferred in `createAuction`.
return auctions[tokenId].curator == address(0);
}
// Returns the timestamp at which an auction will finish.
function auctionEnds(uint256 tokenId) private view returns (uint256) {
// Derived by adding the auction's duration to the time of the first bid.
// NOTE: duration can be extended conditionally after each new bid is added.
return auctions[tokenId].firstBidTime.add(auctions[tokenId].duration);
}
}