123# NFT Parachain45## Project Description67The NFT Pallet is the core of NFT functionality. Like ERC-721 standard in Ethereum ecosystem, this pallet provides the basement for creating collections of unique non-divisible things, also called Non Fungible Tokens (NFTs), minting NFT of a given Collection, and managing their ownership.89The pallet also enables storing NFT properties. Though (according to ERC-721) NFT properties belong to logic of a concrete application that operates a Collection, so purposefully the NFT Tracking Module does not have any knowledge about properties except their byte size leaving application logic out to be controlled by Smart Contracts.1011The NFT Chain also provides:1213* Smart Contracts Pallet and example smart contract that interacts with NFT Runtime14* ERC-1155 Functionality (currently PoC as Re-Fungible tokens, i.e. items that are still unique, but that can be split between multiple users)15* Variety of economic options for dapp producers to choose from to create freemium games and other ways to attract users. As a step one, we implemented an economic model when a collection sponsor can be set to pay for collection Transfer transactions.1617Wider NFT Ecosystem (most of it was developed during Hackusama):18* [SubstraPunks Game hosted on IPFS](https://github.com/usetech-llc/substrapunks)19* [NFT Wallet and UI](https://uniqueapps.usetech.com/#/nft)20* [NFT Asset for Unity Framework](https://github.com/usetech-llc/nft_unity)2122Please see our [walk-thorugh instructions](doc/hackusama_walk_through.md) to try everything out!2324## Hackusama Update2526During the Kusama Hackaphon the following changes were made:27* Enabled Smart Contracts Pallet28* Enabled integration between Smart Contracts and NFT Pallet (required special edition of RC4 Substrate version)29* Fixed misc. bugs in NFT Pallet30* Deployed NFT TestNet. Public node available at wss://unique.usetech.com, custom UI types - see below in this README.31* New Features:32 * Re-Fungible Token Mode33 * Off-Chain Schema to store token image URLs34 * Alternative economic model35 * White Lists and Public Mint Permission36* Use example: [SubstraPunks Game](https://github.com/usetech-llc/substrapunks), fully hosted on IPFS and NFT Testnet Blockchain.3738## Application Development3940If you are building an application that operates NFT tokens, use [this document](doc/application_development.md).4142## Building4344Building NFT chain requires special versions of Rust and toolchain. We don't use the most recent versions of everything so that we can keep the builds stable.45461. Install Rust:4748```bash49curl https://sh.rustup.rs -sSf | sh50sudo apt-get install libssl-dev pkg-config libclang-dev clang51```52532. Remove all installed toolchains with `rustup toolchain list` and `rustup toolchain uninstall <toolchain>`.54553. Install Rust Toolchain 1.44.0:5657```bash58rustup install 1.44.059```60614. Make it default (actual toochain version may be different, so do a `rustup toolchain list` first)62```bash63rustup toolchain list64rustup default 1.44.0-x86_64-unknown-linux-gnu65```66675. Install nightly toolchain and add wasm target for it:6869```bash70rustup toolchain install nightly-2020-05-0171rustup target add wasm32-unknown-unknown --toolchain nightly-2020-05-01-x86_64-unknown-linux-gnu72```73746. Build:75```bash76cargo build77```7879## Run8081You can start a development chain with:8283```bash84cargo run -- --dev85```8687Detailed logs may be shown by running the node with the following environment variables set: `RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev`.8889If you want to see the multi-node consensus algorithm in action locally, then you can create a local testnet with two validator nodes for Alice and Bob, who are the initial authorities of the genesis chain that have been endowed with testnet units. Give each node a name and expose them so they are listed on the Polkadot [telemetry site](https://telemetry.polkadot.io/#/Local%20Testnet). You'll need two terminal windows open.9091We'll start Alice's substrate node first on default TCP port 30333 with her chain database stored locally at `/tmp/alice`. The bootnode ID of her node is `QmQZ8TjTqeDj3ciwr93EJ95hxfDsb9pEYDizUAbWpigtQN`, which is generated from the `--node-key` value that we specify below:9293```bash94cargo run -- \95 --base-path /tmp/alice \96 --chain=local \97 --alice \98 --node-key 0000000000000000000000000000000000000000000000000000000000000001 \99 --telemetry-url ws://telemetry.polkadot.io:1024 \100 --validator101```102103In the second terminal, we'll start Bob's substrate node on a different TCP port of 30334, and with his chain database stored locally at `/tmp/bob`. We'll specify a value for the `--bootnodes` option that will connect his node to Alice's bootnode ID on TCP port 30333:104105```bash106cargo run -- \107 --base-path /tmp/bob \108 --bootnodes /ip4/127.0.0.1/tcp/30333/p2p/QmQZ8TjTqeDj3ciwr93EJ95hxfDsb9pEYDizUAbWpigtQN \109 --chain=local \110 --bob \111 --port 30334 \112 --telemetry-url ws://telemetry.polkadot.io:1024 \113 --validator114```115116Additional CLI usage options are available and may be shown by running `cargo run -- --help`.117118## Benchmarks119120First of all, add rust toolchain and make it default.121```bash122rustup target add wasm32-unknown-unknown --toolchain nightly-2020-10-01123```124125Then in "/node/src" run build command below126```bash127cargo +nightly-2020-10-01 build --release --features runtime-benchmarks128```129130Run benchmark131```bash132target/release/nft benchmark --chain dev --pallet "pallet_nft" --extrinsic "*" --repeat 1133```134135## UI custom types136```137{138 "Schedule": {139 "version": "u32",140 "put_code_per_byte_cost": "Gas",141 "grow_mem_cost": "Gas",142 "regular_op_cost": "Gas",143 "return_data_per_byte_cost": "Gas",144 "event_data_per_byte_cost": "Gas",145 "event_per_topic_cost": "Gas",146 "event_base_cost": "Gas",147 "call_base_cost": "Gas",148 "instantiate_base_cost": "Gas",149 "dispatch_base_cost": "Gas",150 "sandbox_data_read_cost": "Gas",151 "sandbox_data_write_cost": "Gas",152 "transfer_cost": "Gas",153 "instantiate_cost": "Gas",154 "max_event_topics": "u32",155 "max_stack_height": "u32",156 "max_memory_pages": "u32",157 "max_table_size": "u32",158 "enable_println": "bool",159 "max_subject_len": "u32"160 },161 "AccessMode": {162 "_enum": [163 "Normal",164 "WhiteList"165 ]166 },167 "CollectionMode": {168 "_enum": {169 "Invalid": null,170 "NFT": null,171 "Fungible": "u32",172 "ReFungible": "u32"173 }174 },175 "Ownership": {176 "Owner": "AccountId",177 "Fraction": "u128"178 },179 "FungibleItemType": {180 "Collection": "u64",181 "Owner": "AccountId",182 "Value": "u128"183 },184 "ReFungibleItemType": {185 "Collection": "u64",186 "Owner": "Vec<Ownership>",187 "Data": "Vec<u8>"188 },189 "NftItemType": {190 "Collection": "u64",191 "Owner": "AccountId",192 "ConstData": "Vec<u8>",193 "VariableData": "Vec<u8>"194 },195 "Ownership": {196 "owner": "AccountId",197 "fraction": "u128"198 },199 "ReFungibleItemType": {200 "Collection": "u64",201 "Owner": "Vec<Ownership<AccountId>>",202 "ConstData": "Vec<u8>",203 "VariableData": "Vec<u8>"204 },205 "CollectionType": {206 "Owner": "AccountId",207 "Mode": "CollectionMode",208 "Access": "AccessMode",209 "DecimalPoints": "u32",210 "Name": "Vec<u16>",211 "Description": "Vec<u16>",212 "TokenPrefix": "Vec<u8>",213 "MintMode": "bool",214 "OffchainSchema": "Vec<u8>",215 "Sponsor": "AccountId",216 "UnconfirmedSponsor": "AccountId",217 "VariableOnChainSchema": "Vec<u8>",218 "ConstOnChainSchema": "Vec<u8>"219 },220 "ApprovePermissions": {221 "Approved": "AccountId",222 "Amount": "u64"223 },224 "RawData": "Vec<u8>",225 "Address": "AccountId",226 "LookupSource": "AccountId",227 "Weight": "u64",228 "CreateNftData": {229 "const_data": "Vec<u8>",230 "variable_data": "Vec<u8>" 231 },232 "CreateFungibleData": {},233 "CreateReFungibleData": {234 "const_data": "Vec<u8>",235 "variable_data": "Vec<u8>" 236 },237 "CreateItemData": {238 "_enum": {239 "NFT": "CreateNftData",240 "Fungible": "CreateFungibleData",241 "ReFungible": "CreateReFungibleData"242 }243 }244}245246```