Plane Garage TON

A library to deploy and manage editable nft collections, NFT and deploy-wallet for Plane Garage on TON.

As mentioned above, basic architecture consists of 4 smart-contracts:

1. Deploy-wallet will be the owner of all other smart-contracts and will be used to send internal messages to other smart-contracts (e.g. to send message to collection for it to deploy new NFT or just load other smart-contract with coins)
2. Collection is a smart-contract of the collection, that has collection content in it's storage (link to JSON-file of collection) and some other data
3. NFT is a smart-contract of particular NFT, that has NFT content in it's storage (link to JSON-file) and some other data

This library has the following features:

• Compile deploy-wallet
• Mint deploy-wallet
• Mint collection
• Add collection address to file
• Mint NFT
• Edit collection
• Edit NFT
• Transfer NFT
• Withdraw ton from deloy-wallet

Installation

Step 1: Check ton-binaries

By default this library was made to run on Ubuntu 18.04 and this library contains ton-binaries for it, but if you want to use this library on other OS download nessesary TON pre-build here and change directories to lite-client, fift and func compilers on lines 6-8 of shell_config.sh as follows:

path_to_func_binaries=YOUR_PATH # func
path_to_fift_binaries=YOUR_PATH # fift
path_to_lite_client_binaries=YOUR_PATH # lite-client

Step 2: Compile deploy-wallet

First you need to compile your deploy wallet, that will send internal messages to other smart-contracts in the architecture and will be the owner of the contracts. After compiling the wallet you will find files with private key, wallet address and resulting BOC-file that we will send to blockchain on deploy in the directory src/build/wallet/

Example:

./use.sh compile-wallet

Step 3: Load TON's

Load coins to the address of your future deploy-wallet using Testnet TON Wallet in testnet and TON Wallet, Tonkeeper or Tonhub in mainnet.

You will find the address of your future wallet (where you need to send coins) in the output of the terminal after making the previous step. Search a line in output like this:

new wallet address = COPY_ADDRESS_THAT_WILL_BE_HERE

Step 4: Mint deploy-wallet

Use command below to deploy wallet:

./use.sh deploy-wallet [net]

Argument	Description
[net]	Stipulate "testnet" or "mainnet"

Example:

./use.sh deploy-wallet testnet

Mint collection

Use pattern below to deploy your collection.

./use.sh deploy-collection [net] [gateway_base_uri] [collection_uri] [royalty percent * 10]

Argument	Description
[net]	Stipulate "testnet" or "mainnet"
[gateway_base_uri]	Base URI of the Web3 gateway you use (everything in URL exept CID of the particular file on IPFS), e.g. https://cloudflare-ipfs.com/ipfs/ or https://ipfs.io/ipfs/. You can find full list of available gateways for IPFS here
[collection_uri]	Full URL to the JSON-file of your collection
[royalty percent * 10]	Integer that stands for royalty, e.g. if you want to set royalty to 2,5% you should stipulate "25" as an argument

Example:

./use.sh deploy-collection testnet https://cloudflare-ipfs.com/ipfs/ https://cloudflare-ipfs.com/ipfs/bafkreifdmjqhqvh6tpmqnhss3jb3qd7oeg6lbafqi5pyuyxh7ihg3nxw6m 50

Add collection address to file

This method creates file src/build/last_collection.txt and writes the address of the lastly deployed collection in it. You can also pass an argument with your file and the method will append the collection address to it. Use pattern below to add collection address to file.

./use.sh add-collection-addr-to-file [user_file_directory]

Argument	Description
[user_file_directory]	Optional. Stipulate the directory of the file you want to append the lastly deployed collection to

Example:

./use.sh add-collection-addr-to-file

Mint NFT

Use the following pattern to deploy NFT

./use.sh deploy-nft [net] [collection_addr] [nft_index] [CID]

Argument	Description
[net]	Stipulate "testnet" or "mainnet"
[collection_addr]	Address of the smart-contract of your collection in user-friendly format
[nft_index]	Sequence number of the NFT you are deploying in the collection (do not confuse with SEQNO in wallet smart-contracts)
[CID]	CID of the JSON-file of your particular NFT that you get on IPFS

Example:

./use.sh deploy-nft testnet EQCNzB_nhErFna-OgXaeszHF_CvkdZPCuCow5pngjFErJvfe 0 bafkreic27uqjmsam4ghn7gch4ldhok7h2wthzdtc7stpjdrvlitwxh3mqi

Edit collection

Use pattern below to edit your collection.

./use.sh edit-collection [net] [collection_addr] [new_base_uri] [new_collection_uri] [new_royalty_numerator] [new_royalty_addr]

Argument	Description
[net]	Stipulate "testnet" or "mainnet"
[collection_addr]	Address of the smart-contract of your collection in user-friendly format
[new_base_uri]	Base URI of the Web3 gateway you use (everything in URL exept CID of the particular file on IPFS), e.g. https://cloudflare-ipfs.com/ipfs/ or https://ipfs.io/ipfs/. You can find full list of available gateways for IPFS here
[new_collection_uri]	Full URL to the JSON-file of your collection
[new_royalty_numerator]	Integer that stands for royalty, e.g. if you want to set royalty to 2,5% you should stipulate "25" as an argument
[new_royalty_addr]	New address, where earned royalty will be sent

Example:

./use.sh edit-collection testnet EQDkQFpi0wJL08wrPErslfr3i2_pIx4JyLVrfvDzMsavDhYA https://ipfs.io/ipfs/ https://ipfs.io/ipfs/bafkreicqouhcwhkiza7ogvpo7ncmzzhhfdvdt65xjdhmycjegqwyh6e3h4 10 EQD57OL7n9KjwN5vxrW5KOJ-WIQTEw85mSMXmkdcSS_eLzi7

You can change data back after testing:

./use.sh edit-collection testnet EQDkQFpi0wJL08wrPErslfr3i2_pIx4JyLVrfvDzMsavDhYA https://cloudflare-ipfs.com/ipfs/ https://cloudflare-ipfs.com/ipfs/bafkreifdmjqhqvh6tpmqnhss3jb3qd7oeg6lbafqi5pyuyxh7ihg3nxw6m 50

Edit NFT

Use pattern below to edit your NFT.

./use.sh edit-nft [net] [nft_addr] [new_cid]

Argument	Description
[net]	Stipulate "testnet" or "mainnet"
[nft_addr]	Address of the smart-contract of your NFT in user-friendly format
[new_cid]	CID of the new JSON-file of your particular NFT that you get on IPFS

Example:

./use.sh edit-nft testnet EQD1PZVkaUM1jAaf12aChzlLImJZj3IPjS2BfSzunuPY4Lm2 bafkreifhuhy3u3c2lvu26us6kulx64gicfjy7uvu5vnrf5c6qsejxaeaza

You can change data back after testing:

./use.sh edit-nft testnet EQD1PZVkaUM1jAaf12aChzlLImJZj3IPjS2BfSzunuPY4Lm2 bafkreic27uqjmsam4ghn7gch4ldhok7h2wthzdtc7stpjdrvlitwxh3mqi

Transfer NFT

Use pattern below to transfer your NFT (Deploy-wallet should be the owner of the nft).

./use.sh transfer-nft [net] [nft_addr] [new_owner]

Argument	Description
[net]	Stipulate "testnet" or "mainnet"
[nft_addr]	Address of the nft you want to transfer
[new_owner]	Address of the new owner

Example:

./use.sh transfer-nft testnet EQD9T_-01dCe6BevqFJOGOkJaQe7iO07Ylp2-sKxq01td5Zt EQD57OL7n9KjwN5vxrW5KOJ-WIQTEw85mSMXmkdcSS_eLzi7

Withdraw ton from deloy-wallet

Use pattern below to withdraw ton from deloy-wallet to your other wallet.

./use.sh withdraw-ton-from-deploy-wallet [net] [ton_amount] [withdrawal_addr]

Argument	Description
[net]	Stipulate "testnet" or "mainnet"
[ton_amount]	The amount of tons you want to transfer
[withdrawal_addr]	The address where the coins will be transfered

Example:

./use.sh withdraw-ton-from-deploy-wallet testnet 1 EQD57OL7n9KjwN5vxrW5KOJ-WIQTEw85mSMXmkdcSS_eLzi7