/opensea-creatures

Example non-fungible collectible, to demonstrate OpenSea integration

Primary LanguageJavaScript

OpenSeaCreatures ERC721 contracts

About OpenSeaCreatures.

This is a very simple sample ERC721 for the purposes of demonstrating integration with the OpenSea marketplace. We include a script for minting the items.

Additionally, this contract whitelists the proxy accounts of OpenSea users so that they are automatically able to trade the ERC721 item on OpenSea (without having to pay gas for an additional approval). On OpenSea, each user has a "proxy" account that they control, and is ultimately called by the exchange contracts to trade their items. (Note that this addition does not mean that OpenSea itself has access to the items, simply that the users can list them more easily if they wish to do so)

Requirements

Node version

Either make sure you're running a version of node compliant with the engines requirement in package.json, or install Node Version Manager nvm and run nvm use to use the correct version of node.

Installation

Run

npm install

If you run into an error while building the dependencies and you're on a Mac, run the code below, remove your node_modules folder, and do a fresh npm install:

xcode-select --install # Install Command Line Tools if you haven't already.
sudo xcode-select --switch /Library/Developer/CommandLineTools # Enable command line tools
sudo npm explore npm -g -- npm install node-gyp@latest # Update node-gyp

Deploying

Deploying to the Rinkeby network.

  1. You'll need to sign up for Infura. and get an API key.
  2. Using your API key and the mnemonic for your Metamask wallet (make sure you're using a Metamask seed phrase that you're comfortable using for testing purposes), run:
export INFURA_KEY="<your_infura_project_id>"
export MNEMONIC="<metmask_mnemonic>"
truffle deploy --network rinkeby

Minting tokens.

After deploying to the Rinkeby network, there will be a contract on Rinkeby that will be viewable on Rinkeby Etherscan. For example, here is a recently deployed contract. You should set this contract address and the address of your Metamask account as environment variables when running the minting script:

export OWNER_ADDRESS="<my_address>"
export NFT_CONTRACT_ADDRESS="<deployed_contract_address>"
export NETWORK="rinkeby"
node scripts/mint.js

Diagnosing Common Issues

When running the minting script on mainnet, your environment variable needs to be set to mainnet not live. The environment variable affects the Infura URL in the minting script, not truffle. When you deploy, you're using truffle and you need to give truffle an argument that corresponds to the naming in truffle.js (--network live). But when you mint, you're relying on the environment variable you set to build the URL (https://github.com/ProjectOpenSea/opensea-creatures/blob/master/scripts/mint.js#L54), so you need to use the term that makes Infura happy (mainnet). Truffle and Infura use the same terminology for Rinkeby, but different terminology for mainnet. If you start your minting script, but nothing happens, double check your environment variables.

If you're running a modified version of sell.js and not getting expected behavior, check the following:

  • Is the expirationTime in future? If no, change it to a time in the future.

  • Is the expirationTime a fractional second? If yes, round the listing time to the nearest second.

  • Are the input addresses all strings? If no, convert them to strings.

  • Are the input addresses checksummed? You might need to use the checksummed version of the address.

  • Is your computer's internal clock accurate? If no, try enabling automatic clock adjustment locally or following this tutorial to update an Amazon EC2 instance.

  • Do you have any conflicts that result from globally installed node packages? If yes, try npm uninstall -g truffle; npm install -g truffle@5.0.37

  • Are you running a version of node compliant with the engines requirement in package.json? If no, try nvm use 8.11.2; rm -rf node_modules; npm i