git.delta.rocks / unique-network / refs/commits / db7a4acde0a0

difftreelog

source

README.md4.7 KiBsourcehistory
1![Docker build](https://github.com/usetech-llc/nft_parachain/workflows/Docker%20build/badge.svg)23# Unique Parachain45## Project Description67The Unique Pallet is the core of NFT functionality. Like ERC-721 standard in Ethereum ecosystem, this pallet provides the8basement for creating collections of unique non-divisible things, also called Non Fungible Tokens (NFTs), minting NFT of9a given Collection, and managing their ownership.1011The pallet also enables storing NFT properties. Though (according to ERC-721) NFT properties belong to logic of a12concrete application that operates a Collection, so purposefully the NFT Tracking Module does not have any knowledge13about properties except their byte size leaving application logic out to be controlled by Smart Contracts.1415The Unique Chain also provides:1617-   Smart Contracts Pallet and example smart contract that interacts with Unique Runtime18-   ERC-1155 Functionality (currently PoC as Re-Fungible tokens, i.e. items that are still unique, but that can be split19    between multiple users)20-   Variety of economic options for dapp producers to choose from to create freemium games and other ways to attract21    users. As a step one, we implemented an economic model when a collection sponsor can be set to pay for collection22    Transfer transactions.2324Wider Unique Ecosystem (most of it was developed during Hackusama):2526-   [SubstraPunks Game hosted on IPFS](https://github.com/usetech-llc/substrapunks)27-   [Unique Wallet and UI](https://uniqueapps.usetech.com/#/nft)28-   [NFT Asset for Unity Framework](https://github.com/usetech-llc/nft_unity)2930Please see our [walk-through instructions](doc/hackusama_walk_through.md) to try everything out!3132## Application Development3334If you are building an application that operates NFT tokens, use [this document](doc/application_development.md).353637## Building3839Building Unique chain requires special versions of Rust and toolchain. We don't use the most recent versions of everything40so that we can keep the builds stable.41421. Install Rust:4344```bash45sudo apt-get install git curl libssl-dev llvm pkg-config libclang-dev clang make46curl https://sh.rustup.rs -sSf | sh47```48492. Remove all installed toolchains with `rustup toolchain list` and `rustup toolchain uninstall <toolchain>`.50513. Install install nightly 2021-11-11 and make it default:5253```bash54rustup toolchain install nightly-2022-05-1155rustup default nightly-2022-05-1156```57584. Add wasm target for nightly toolchain:5960```bash61rustup target add wasm32-unknown-unknown --toolchain nightly-2022-05-1162```63645. Build:6566Opal67```bash68cargo build --release69```70Quartz71```bash72cargo build --features=quartz-runtime --release73```74Unique75```bash76cargo build --features=unique-runtime --release77```7879## Building as Parachain locally8081Note: checkout this project and all related projects (see below) in the sibling folders (both under the same folder)8283### Polkadot launch utility8485```86git clone https://github.com/paritytech/polkadot-launch87```8889### Build relay9091```92git clone https://github.com/paritytech/polkadot.git93cd polkadot94git checkout release-v0.9.2395cargo build --release96```9798### Build Unique parachain99100Run in the root of this project:101```102cargo build --release103```104105### Build Acala parachain (optional, full config only)106107```108git clone https://github.com/AcalaNetwork/Acala109cd Acala110git checkout 54db3acd409a0b787f116f20e163a3b24101ce38111make build-release112```113114## Running as Parachain locally115116```117./launch-testnet.sh118```119120Optional, full setup with Acala and Statemint121```122./launch-testnet-full.sh123```124125## Run Integration Tests1261271. Install all needed dependecies128```129cd tests130yarn install131```1321332. Run tests134```135yarn test136```137138139## Code Formatting140141### Apply formatting and clippy fixes142```bash143cargo clippy144cargo fmt145```146147### Format tests148```bash149pushd tests && yarn fix ; popd150```151152### Check code style in tests153```bash154cd tests && yarn eslint --ext .ts,.js src/155```156157158## Karura token transfer159160To get started, you need to open inbound and outbound hrmp channels.161162### Next, we need to register our asset at Karura.163```164assetRegistry -> registerForeignAsset(location, metadata)165location:166	V0(X2(Parent, Parachain(PARA_ID)))167metadata:168	name         QTZ169	symbol       QTZ170	decimals     18171minimalBalance	 1172```173174### Next, we can send tokens from Quartz to Karura:175```176polkadotXcm -> reserveTransferAssets177dest:178	V0(X2(Parent, Parachain(<KARURA_PARA_ID>)))179beneficiary:180	X1(AccountId(Any, <ACCOUNT>))181assets:182	V1(Concrete(0,Here), Fungible(<AMOUNT>))183feeAssetItem:184	0185weightLimit:186	<LIMIT>187```188189The result will be displayed in ChainState190tokens -> accounts191192### To send tokens from Karura to Quartz:193```194xtokens -> transfer195196currencyId:197	ForeingAsset198		<TOKEN_ID>199200amount:201		<AMOUNT>202dest:203	V1204	(205		Parents:1,206		X2(Parachain(<KARURA_PARA_ID>), AccountId(Any, <ACCOUNT>)207	)208destWeight:209	<WEIGHT>210```