Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PatrickAlphaC/nft-mix
https://github.com/PatrickAlphaC/nft-mix
brownie chainlink nft opensea python solidity
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/PatrickAlphaC/nft-mix
- Owner: PatrickAlphaC
- License: mit
- Created: 2021-03-01T20:53:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T00:55:47.000Z (8 months ago)
- Last Synced: 2024-11-05T04:51:34.730Z (about 2 months ago)
- Topics: brownie, chainlink, nft, opensea, python, solidity
- Language: Solidity
- Homepage:
- Size: 94.7 KB
- Stars: 825
- Watchers: 28
- Forks: 414
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Update: The code has been modified to use Sepolia as Rinkeby Testnet is not supported anymore.
> Update: You should use `ipfs://` instead of `https://ipfs.io/` for your tokenURI
# nft-mix
This is a repo to work with and use NFTs smart contracts in a python environment, using the Chainlink-mix as a starting point.
If you'd like to see another repo using random NFTs that are deployed to mainnet, check out the [D&D package](https://github.com/PatrickAlphaC/dungeons-and-dragons-nft).
## Prerequisites
Please install or have installed the following:
- [nodejs and npm](https://nodejs.org/en/download/)
- [python](https://www.python.org/downloads/)
## Installation
1. [Install Brownie](https://eth-brownie.readthedocs.io/en/stable/install.html), if you haven't already. Here is a simple way to install brownie.
```bash
pip install eth-brownie
```
Or, if that doesn't work, via pipx
```bash
pip install --user pipx
pipx ensurepath
# restart your terminal
pipx install eth-brownie
```
2. Clone this repo
```
brownie bake nft-mix
cd nft
```
1. [Install ganache-cli](https://www.npmjs.com/package/ganache-cli)
```bash
npm install -g ganache-cli
```
If you want to be able to deploy to testnets, do the following.
4. Set your environment variables
Set your `WEB3_INFURA_PROJECT_ID`, and `PRIVATE_KEY` [environment variables](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html).
You can get a `WEB3_INFURA_PROJECT_ID` by getting a free trial of [Infura](https://infura.io/). At the moment, it does need to be infura with brownie. You can find your `PRIVATE_KEY` from your ethereum wallet like [metamask](https://metamask.io/).
You'll also need testnet Sepolia ETH and LINK. You can get LINK and ETH into your wallet by using the [Sepolia faucets located here](https://faucets.chain.link/sepolia). If you're new to this, [watch this video.](https://www.youtube.com/watch?v=P7FX_1PePX0)
You can add your environment variables to the `.env` file:
```
export WEB3_INFURA_PROJECT_ID=
export PRIVATE_KEY=
```
Then, make sure your `brownie-config.yaml` has:
```
dotenv: .env
```
You can also [learn how to set environment variables easier](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html)
Or you can run the above in your shell.
# Usage
There are 2 types of NFTs here.
1. `SimpleCollectibles.sol`
2. `AdvancedCollectibles.sol`
They each deploy unique dogs. The advanced version gives you a random breed (out of a Pug, Shiba Inu, and St. Bernard).
The advanced collection uses a [Chainlink VRF](https://docs.chain.link/docs/get-a-random-number) to deploy the random dog.
You can 100% use the Sepolia testnet to see your NFTs rendered on opensea, but it's suggested that you test and build on a local development network so you don't have to wait as long for transactions.
### Running Scripts
The simple collectibles work on a local network, however the advanced requires a testnet. When the video tutorial was launched, Rinkeby was used, but ever since it was discontinued we have switched to Sepolia as it is the testing standard for NFT platforms. You will need testnet Sepolia ETH and testnet Sepolia LINK. You can find faucets for both in the [Chainlink documentation](https://docs.chain.link/resources/link-token-contracts).
# For the Simple ERC721
```
brownie run scripts/simple_collectible/deploy_simple.py --network sepolia
brownie run scripts/simple_collectible/create_collectible.py --network sepolia
```
# For the Advanced ERC721
You'll need [testnet ETH](https://sepoliafaucet.com/) and [testnet LINK](https://faucets.chain.link/sepolia/) in the wallet associated with your private key.
```
brownie run scripts/advanced_collectible/deploy_advanced.py --network sepolia
brownie run scripts/advanced_collectible/create_collectible.py --network sepolia
```
Then:
```
brownie run scripts/advanced_collectible/create_metadata.py --network sepolia
brownie run scripts/advanced_collectible/set_tokenuri.py --network sepolia
```
# Verify on Etherscan
The simple contract and the advanced contract can be verified if you just set your `ETHERSCAN_TOKEN`.
## Misc
There are some helpful scripts in `helpful_scripts.py`.
# Viewing on OpenSea
After running the scripts from the `For the Advanced ERC721` section
1. Create the metadata
Metadata is the URI needed to upload data. You can either:
- Upload to IPFS yourself
- Use the metadata already created when you cloned this repo.
### If you want to upload to IPFS yourself
Download [IPFS](https://ipfs.io/)
Set `export IPFS_URL=http://127.0.0.1:5001` and `export UPLOAD_IPFS=true` environment variables
Run the IPFS daemon: `ipfs daemon`
Then Run
```
brownie run scripts/advanced_collectible/create_metadata.py --network sepolia
```
Alternatively, you could upload the uri manually:
Add the file created in `metadata/sepolia/NAME.json` to [IPFS](https://ipfs.io/) or [Pinata](https://pinata.cloud/).
### If you want to use the metadata from this repo
Just run:
```
brownie run scripts/advanced_collectible/create_metadata.py --network sepolia
```
2. Set the tokenURI
Run
```
brownie run scripts/advanced_collectible/set_tokenuri.py --network sepolia
```
And after some time, (you may have to wait up to 20 minutes for it to render on opensea), you should see your NFT on opensea! [It'll look something like this.](https://testnets.opensea.io/assets/0x8acb7ca932892eb83e4411b59309d44dddbc4cdf/0)
## *NEW* Pinata
If you want to auto-upload to pinata instead of IPFS automatically, you can do so by getting a [Pinata API Key.](https://pinata.cloud/documentation#GettingStarted)
You'll need the following environment variables (you can get them from Pinata)
```
PINATA_API_KEY
PINATA_API_SECRET
```
Then run:
```
python scripts/upload_to_pinata.py
```
## Testing
```
brownie test
```
## Linting
```
pip install black
pip install autoflake
autoflake --in-place --remove-unused-variables -r .
black .
```
## Resources
To get started with Brownie:
* [Chainlink Documentation](https://docs.chain.link/docs)
* Check out the [Chainlink documentation](https://docs.chain.link/docs) to get started from any level of smart contract engineering.
* Check out the other [Brownie mixes](https://github.com/brownie-mix/) that can be used as a starting point for your own contracts. They also provide example code to help you get started.
* ["Getting Started with Brownie"](https://medium.com/@iamdefinitelyahuman/getting-started-with-brownie-part-1-9b2181f4cb99) is a good tutorial to help you familiarize yourself with Brownie.
* For more in-depth information, read the [Brownie documentation](https://eth-brownie.readthedocs.io/en/stable/).
Shoutout to [TheLinkMarines](https://twitter.com/TheLinkMarines) on twitter for the puppies!
Any questions? Join our [Discord](https://discord.gg/2YHSAey)
## License
This project is licensed under the [MIT license](LICENSE).