Substrate NFTs Node

The Substrate NFTs node is a specialized blockchain for testing use cases with the FRAME NFTs Pallet. 🚀

The purpose of this node is to provide developers with an easy way to experiment with the NFTs pallet in a sand-boxed environment. This node may be useful for anyone making guides, tutorials or workshops that cover use cases for the NFTs Pallet.

Depending on your operating system and Rust version, there might be additional packages required to compile this template. Check the Install instructions for your platform for the most common dependencies. Alternatively, you can use one of the alternative installation options.

Launch the chain

The easiest way to launch a node is to download the node from the releases page. Alternatively, you can build and launch the node locally.

Download the node binary

Launch the chain by downloading the binary in the releases page of this repository (macOS and Linux) and executing it:

substrate-nfts-node 

Build the node locally

Follow the official installation steps to set up all Substrate prerequisites.

Afterwards you can install this node using:

cargo install substrate-nfts-node --git https://github.com/sacha-l/substrate-nfts-node.git

Alternatively, you can clone this repo and build the node using this command:

cargo build --release

To launch the chain in development mode (recommended):

./target/release/substrate-nfts-node --dev

About Development mode:

• Maintains state in a tmp folder while the node is running.
• Uses the Alice and Bob accounts as default validator authorities.
• Uses the Alice account as the default sudo account.
• Has a preconfigured genesis state (/node/src/chain_spec.rs) that includes several prefunded development accounts.

Embedded Docs

After you build the project, you can use the following command to explore its parameters and subcommands:

./target/release/node-template -h

You can generate and view the Rust Docs for this template with this command:

cargo +nightly doc --open

Connect with Polkadot-JS Apps Front-End

After you start the node template locally, you can interact with it using the hosted version of the Polkadot/Substrate Portal front-end by connecting to the local node endpoint. A hosted version is also available on IPFS (redirect) here or IPNS (direct) here. You can also find the source code and instructions for hosting your own instance on the polkadot-js/apps repository.

Alternatives Installations

Instead of installing dependencies and building this source directly, consider the following alternatives.

Nix

Install nix, and optionally direnv and lorri for a fully plug-and-play experience for setting up the development environment. To get all the correct dependencies, activate direnv direnv allow and lorri lorri shell.

Docker

Please follow the Substrate Docker instructions here to build the Docker container with the Substrate Node Template binary.

How to upgrade to new Polkadot release

• Check Substrate's node-template for new commits between the new Polkadot release branch and the one this repository is currently synced with. The current branch is mentioned in this readme.
• Apply each commit that happened in this node-template folder since the last sync.
• Check commits for pallet-nfts since the last time someone synchronized this repository with Substrate in order to not miss any important changes.
• Execute diener update -s --branch my_polkadot_release_branch.
• Increment the minor version number in node/Cargo.toml and runtime/Cargo.toml.
• Execute cargo run --release. If successful, it should produce blocks and a new, up to date, Cargo.lock will be created.
• Update this README with the hash of the Substrate master commit with which you synchronized. The hash appears two times in this README.
• Create a PR with the changes, have it reviewed and merged.
• Replace XX in this command with your incremented version number and execute it: git checkout main && git pull && git tag v0.XX.0 && git push origin v0.XX.0. This will push a new tag with the version number to this repository.