Truffle NFT Box¶
The NFT Box has the following requirements:
First ensure you are in a new and empty directory.
npxand skip to step 3. This will install all necessary dependencies. A Create-React-App is generated in the
npx truffle unbox nft-box
Alternatively, you can install Truffle globally and run the
npm install -g truffle truffle unbox nft-box
In the root directory install the required dependices. This will install a few things along with Open Zeppelin Contracts check them out here for more info.
Add the contructor arguments to
2_deploy_contracts.js. The URI for your NFT images must be passed as the first argument. The
Run the development console.
Compile and migrate the smart contracts. Note inside the development console we don't preface commands with
clientdirectory, we run the React app. Smart contract changes must be manually recompiled and migrated.
// in another terminal (i.e. not in the truffle develop prompt) cd client npm install npm run start
After migrating your contracts head to the
clientdirectory and run
npm run startto view the application in your
http://localhost:3000/. Connect your wallet and mint your first NFT!
You can check the developer console to see the transaction has and if you deploy to
rinkebyyou will be able to see the NFT on their test-net site here.
To build the application for production, use the build script. A production build will be in the
// ensure you are inside the client directory when running this npm run build
To deploy your contracts to a public network (such as a testnet or mainnet) there are two approaches. The first uses Truffle Dashboard which provides "an easy way to use your existing MetaMask wallet for your deployments". The second, requires copying your private key or mnemonic into your project so the deployment transactions can be signed prior to submission to the network.
Using Truffle Dashboard (recommended)¶
Truffle Dashboard ships with Truffle and can be started with
truffle dashboard. This in turn loads the dashboard at http://localhost:24012 and beyond that you'll just need to run your migration (
truffle migrate). A more detailed guide to using Truffle Dashboard is available here.
Using the env File¶
You will need at least one mnemonic to use with the network. The
.dotenv npm package has been installed for you, and you will need to create a
.env file for storing your mnemonic and any other needed private information.
.env file is ignored by git in this project, to help protect your private data. In general, it is good security practice to avoid committing information about your private keys to github. The
truffle-config.js file expects a
MNEMONIC value to exist in
.env for running commands on each of these networks, as well as a default
MNEMONIC for the Arbitrum network we will run locally.
If you are unfamiliar with using
.env for managing your mnemonics and other keys, the basic steps for doing so are below:
touch .env in the command line to create a
.env file at the root of your project. 2) Open the
.env file in your preferred IDE 3) Add the following, filling in your own Infura project key and mnemonics:
MNEMONIC="<YOUR MNEMONIC HERE>" INFURA_KEY="<Your Infura Project ID>" RINKEBY_MNEMONIC="<Your Rinkeby Mnemonic>" MAINNET_MNEMONIC="<Your Mainnet Mnemonic>"
4) As you develop your project, you can put any other sensitive information in this file. You can access it from other files with
require('dotenv').config() and refer to the variable you need with
Support for this box is available via the Truffle community available here.