KOSIUM PIONEERS MINT ERC721

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

yarn

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 yarn 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. To access a Rinkeby testnet node, you'll need to sign up for Alchemy and get a free API key. Click "View Key" and then copy the part of the URL after v2/. a. You can use Infura if you want as well. Just change ALCHEMY_KEY below to INFURA_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 ALCHEMY_KEY="<your_alchemy_project_id>"
export MNEMONIC="<metmask_mnemonic>"
DEPLOY_CREATURES_SALE=1 yarn truffle deploy --network rinkeby

WINDOWS 10

set ALCHEMY_KEY=xZkLoVb57y4wBv6dPmjyqqa9hsqsu08c
set MNEMONIC="island craft tell senior talk photo post fat tomorrow option harbor fame"
set DEPLOY_PIONEERS=1
yarn truffle.cmd migrate --reset --network rinkeby

TESTING ON GANACHE LOCALLY

DEPLOYMENT WINDOWS 10 cd to test start truffleTest.bat //yarn truffle.cmd migrate --network development

export MNEMONIC="<your-mnemonic-from-ganache-cli-here>"
export DEPLOY_PIONEERS=1
yarn truffle test

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. If a CreatureFactory was deployed, which the sample deploy steps above do, you'll need to specify its address below as it will be the owner on the NFT contract, and only it will have mint permissions. In that case, you won't need NFT_CONTRACT_ADDRESS, as all we need is the contract with mint permissions here.

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

WINDOWS 10 Running Scripts with Rinkeby Deployment

set ALCHEMY_KEY=xZkLoVb57y4wBv6dPmjyqqa9hsqsu08c
set MNEMONIC="island craft tell senior talk photo post fat tomorrow option harbor fame"
set OWNER_ADDRESS=0x7390ceF3391A2E2079D74E8fFd8EFEF478e1b793
set NFT_CONTRACT_ADDRESS=0x23a8784654796Df7C37c016381707821a763e785
set NETWORK=rinkeby
node scripts/setBaseUri.js

Diagnosing Common Issues

If you're 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 yarn remove -g truffle; yarn

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

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

yarn

Deploying

Deploying to the Rinkeby network.

1. Follow the steps above to get a Rinkeby node 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 ALCHEMY_KEY="<alchemy_project_id>" # or you can use INFURA_KEY
export MNEMONIC="<metmask_mnemonic>"
DEPLOY_ACCESSORIES_SALE=1 yarn truffle migrate --network rinkeby

export ALCHEMY_KEY="xZkLoVb57y4wBv6dPmjyqqa9hsqsu08c"
export MNEMONIC="island craft tell senior talk photo post fat tomorrow option harbor fame"
DEPLOY_ACCESSORIES_SALE=1 yarn truffle migrate --network rinkeby

Deploying to the mainnet Ethereum network.

Make sure your wallet has at least a few dollars worth of ETH in it. Then run:

yarn truffle migrate --network live

Look for your newly deployed contract address in the logs! 🥳

Viewing your items on OpenSea

OpenSea will automatically pick up transfers on your contract. You can visit an asset by going to https://opensea.io/assets/CONTRACT_ADDRESS/TOKEN_ID.

To load all your metadata on your items at once, visit https://opensea.io/get-listed and enter your address to load the metadata into OpenSea! You can even do this for the Rinkeby test network if you deployed there, by going to https://rinkeby.opensea.io/get-listed.

Troubleshooting

It doesn't compile!

Install truffle locally: yarn add truffle. Then run yarn truffle migrate ....

You can also debug just the compile step by running yarn truffle compile.

It doesn't deploy anything!

This is often due to the truffle-hdwallet provider not being able to connect. Go to your Alchemy Dashboard (or infura.io) and create a new project. Use your "project ID" as your new ALCHEMY_KEY and make sure you export that command-line variable above.

Running Local Tests

In one terminal window, run:

yarn run ganache-cli

Once Ganache has started, run the following in another terminal window:

yarn run test