proposal 47 submission 11

proposal-47/submission-11/NFT_collection_distributor/.gitignore

@@ -0,0 +1,12 @@
+dist
+node_modules
+package-lock.json
+src/module/test/*
+src/services/temp/*
+src/contracts/tests/utils/__pycache__
+src/contracts/tests/__pycache__
+!src/services/temp/.gitkeep
+.idea
+.env
+.DS_Store
+result

proposal-47/submission-11/NFT_collection_distributor/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 itway-team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

proposal-47/submission-11/NFT_collection_distributor/README.md

@@ -0,0 +1,97 @@
+#  NFT_collection_distributor
+
+# Table of content
+- [How to use](#how-to-use)
+- [How to create a token generator](#how-to-create-a-token-generator)
+	- [General information about collection](#general-information-about-collection)
+	- [Add rarity to the tokens](#add-rarity-to-the-tokens)
+	- [Parameters](#parameters)
+- [How to create token generator from JSON file](#how-to-create-token-generator-from-JSON-file)
+- [How to create your tokens](#how-to-create-your-tokens)
+	- [Token minting](#token-minting)
+	- [Information about token](#information-about-token)
+	- [Sale tokens](#sale-tokens)
+- [How to run tests](#how-to-run-tests)
+
+## How to use
+1. Clone repository
+2. Run `npm install`
+3. Go to */src/config/everscale-settings.ts* and set your parameters
+4. Run `npm run build`
+5. Run `npm run start`
+6. Go to the `localhost:3001`
+
+## Detailed description
+---
+First of all you need to create a token generator.
+# How to create a token generator
+
+After you went to the main page, click on the button `Root contract form` to go to the page for creating a token generator.
+![main-page](./public/readme-photos/main-page.png)
+## General information about collection
+In the `Collection Name` field (marked 1), enter the name of the collection you create. And in the `Maximum number of tokenes` field (marked 2) enter  maximum number of tokenes you want to create.
+After filling out data about your collection you  can click on one of the buttons: 
+ - `Save data` button (marked 3) to create a data about you collection in JSON format.
+ - `Generate contract code` button (marked 4) to generate code of your collection, **without contracts deployment**,  wich will be saved in the `*/results/collections/collection_address/` folder, where `collection_address` is the address of your token generator.
+ - `Deploy contracts` button (marked 5) to deploy your collection in the blockchain. **The token generator and debot contracts will be created and deployed.**
+![root-contract-form](./public/readme-photos/root-contract-form.png)
+## Add rarity to the tokens
+When you clicked on the `Rarity` tab, you can add the degree of value to the tokens from your collection. 
+To do this, click on the tick `Use Rarity Types for tokens`. 
+ - In the `Collection type` and  `Number of tokens` fields, enter the name of the type and the tokens number of this type respectively.
+ - You can add and delete the type of tokens with buttons `Add type` and `Delete type` respectively.
+ ![rarity-tab](./public/readme-photos/rarity-tab.png)
+## Commisions
+You can set some commission will be held when creating and selling tokens, If you press the corresponding ticks in the `Comission` tab. 
+- The `Commision to Collection Owner` checkmark is responsible for determining the commission for the author who created this collection.
+- In the `Minting prices for user` field you can specify the price that the user will pay when creating a token from your collection.
+![commision](./public/readme-photos/commision.png)
+## Parameters
+You can add any parameters for each token, to do this, click on the `Token Parameters` tab.
+Enter the parameter name to the `Parameter name` field and select the parameter type in the drop-down `Choose parameter type` list. You can add several parameters of different types.
+![token-params](./public/readme-photos/token-params.png)
+
+# How to create token generator from JSON file
+---
+1) Click to the `Deploy from file` button to generate your collection from JSON file. Your collection will be saved in the `*/results/collections/collection_address/` folder where `collection_address` is the address of your token generator
+![deploy-from-file](./public/readme-photos/deploy-from-file.png)
+
+2) Click to the `Choose file` field (marked 1) to select JSON file and then cick the `Deploy` button (marked 2) to deploy your collection.
+![deploy-from-file-2](./public/readme-photos/deploy-from-file_2.png)
+
+# How to create your tokens
+---
+1) To show collection list you have click to the `Collection list` button.
+![collection-list](./public/readme-photos/collection-list.png)
+
+2) You can see the collections list you have. You can have more then one collection. 
+- To mint token of collection click to the `Minting token` button.
+- To get information about collection click to the `Info Root` button.
+![collection-list-2](./public/readme-photos/collection-list_2.png)
+
+## Token minting
+1) When you clicked to the `Minting token` button, you will go to the minting page.
+- In the drop-down list (marked 1) , you need to select one of the rariry type that you entered when creating a token generator.
+- Then you need to fill the parameters for token (marked 2).
+- Click to the `Minting token` button (marked 3) to create your token.
+![mint-token](./public/readme-photos/mint-token.png)
+
+2) if you clicked on the  `Minting token` button your token is created and you are in the `Generator info` page. Here you would have been if you click on the `Info root` button. On this page you can: 
+- find general information (marked 1) about your collection such as `Root address`, `Collection name`, `Debot address`.
+- go to the debot for also to create tokens (marked 2).
+- see information about each token by clicking on the address of the token in the list (marked 3).
+![root-info](./public/readme-photos/root-info.png)
+
+## Information about token
+We will go to the `Token information` page if you clicked to the address of the token in the tokens list. On this page you can:
+- find information about an another token if you enter the an another token address in the field (marked 1)  
+- see information about this token in the field with information (marked 2) 
+- sale token by clicking to the `Sale token` button (marked 3)
+![token-info](./public/readme-photos/token-information.png)
+
+## Sale tokens
+You can set the price of your token and sell it. 
+![sell](./public/readme-photos/sell-token.png)
+
+# How to run tests
+Execute `python -m unittest -v` from */src/contracts/tests* (TestSuite4 required)

proposal-47/submission-11/NFT_collection_distributor/deploy_debot_local.sh

@@ -0,0 +1,66 @@
+#!/bin/bash
+set -e
+
+TEMP_DIR=../temp
+CONTRACTS_DIR=../
+DEBOT_NAME=SellingDebot
+NETWORK=http://127.0.0.1
+
+#
+# This is TON OS SE giver address, correct it if you use another giver
+#
+GIVER_ADDRESS=0:841288ed3b55d9cdafa806807f02a0ae0c169aa5edfe88a789a6482429756a94
+CRYSTALS_AMOUNT=100000000000
+
+# Check if tonos-cli installed 
+tos=tonos-cli
+if $tos --version > /dev/null 2>&1; then
+    echo "OK $tos installed locally."
+else 
+    tos=tonos-cli
+    if $tos --version > /dev/null 2>&1; then
+        echo "OK $tos installed globally."
+    else 
+        echo "$tos not found globally or in the current directory. Please install it and rerun script."
+    fi
+fi
+
+function giver {
+    $tos --url $NETWORK call --abi local_giver.abi.json $GIVER_ADDRESS \
+         sendGrams "{\"dest\":\"$1\",\"amount\":$CRYSTALS_AMOUNT}" 1>/dev/null
+}
+
+function get_address {
+    echo $(cat $TEMP_DIR/$1.log | grep "Raw address:" | cut -d ' ' -f 3)
+}
+
+function genaddr {
+    $tos genaddr $CONTRACTS_DIR/$1.tvc $CONTRACTS_DIR/$1.abi.json --genkey $TEMP_DIR/$1.keys.json > $TEMP_DIR/$1.log
+}
+
+echo "Step 1. Calculating debot address"
+genaddr $DEBOT_NAME
+DEBOT_ADDRESS=$(get_address $DEBOT_NAME)
+
+echo "Step 2. Sending $CRYSTALS_AMOUNT tokens to address: $DEBOT_ADDRESS"
+giver $DEBOT_ADDRESS
+
+echo "Step 3. Deploying debot"
+$tos --url $NETWORK deploy $CONTRACTS_DIR/$DEBOT_NAME.tvc '{}' \
+     --sign $TEMP_DIR/$DEBOT_NAME.keys.json \
+     --abi $CONTRACTS_DIR/$DEBOT_NAME.abi.json 1>/dev/null
+
+# tvm_linker init $CONTRACTS_DIR/$DEBOT_NAME.tvc '{"_addrDirectSaleRoot":"0:61ba0ce8efac25adbc514b755ef4287e1c0d80b28b506d029e2166864802ee45"}' $CONTRACTS_DIR/$DEBOT_NAME.abi.json
+
+DEBOT_ABI=$(cat $CONTRACTS_DIR/$DEBOT_NAME.abi.json | xxd -ps -c 20000)
+
+$tos --url $NETWORK call $DEBOT_ADDRESS setABI "{\"dabi\":\"$DEBOT_ABI\"}" \
+     --sign $TEMP_DIR/$DEBOT_NAME.keys.json --abi $CONTRACTS_DIR/$DEBOT_NAME.abi.json \
+     1>/dev/null
+
+echo "Step 4. Getting debot info"
+$tos --url $NETWORK run \
+     --abi $CONTRACTS_DIR/$DEBOT_NAME.abi.json \
+     $DEBOT_ADDRESS getDebotInfo "{}"
+
+echo "Done! Deployed debot with address: $DEBOT_ADDRESS"