ton-blockchain · igroman787 · May 25, 2020 · May 21, 2020 · May 21, 2020 · May 21, 2020
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.Ru.md b/README.Ru.md
@@ -0,0 +1,87 @@
+## Что это
+Данная консольная программа является оберткой над `fift`, `lite-client` и `validator-engine-console`. Она была создана для облегчения управления кошельками, доменами и валидатором на операционной системе `Linux`.
+Проект находится в активной разработке, поэтому стабильность работы не гарантируется.
+![](https://raw.githubusercontent.com/igroman787/mytonctrl/master/screens/mytonctrl-status.png)
+
+## Функционал
+- [x] Показать статус сети TON
+- [x] Управление локальными кошельками
+	- [x] Создать локальный кошелек
+	- [x] Активировать локальный кошелек
+	- [x] Показать локальные кошельки
+	- [x] Импортировать кошелек из файла (.pk)
+	- [x] Сохранить адрес кошелька в файл (.addr)
+	- [x] Удалить локальный кошелек
+- [x] Показать статус аккаунта
+	- [x] Показать баланс аккаунта
+	- [x] Показать историю аккаунта
+	- [x] Показать статус аккаунта из закладок
+- [x] Перевод средств на кошелек
+	- [x] Перевод фиксированной суммы
+	- [x] Перевод всей суммы (all)
+	- [x] Перевод всей суммы с диактивацией кошелька (alld)
+	- [x] Перевод средств на кошелек из закладок
+	- [ ] Пропустить средства через миксер
+- [x] Управление закладками
+	- [x] Добавить аккаунт в закладки
+	- [x] Показать закладки
+	- [x] Удалить закладку
+- [x] Управление предложениями
+	- [x] Показать предложения
+	- [x] Проголосовать за предложение
+	- [x] Автоматическое голосование за ранее проголосованные предложения
+- [x] Управление доменами
+	- [x] Арендовать новый домен
+	- [x] Показать арендованные домены
+	- [x] Показать статус домена
+	- [x] Удалить домен
+	- [ ] Автоматическое продление доменов
+- [ ] Автоматическая отправка средств по расписанию
+	- [ ] Добавить правило в расписание
+	- [ ] Показать правила расписания
+	- [ ] Удалить правило из расписания
+- [x] Управление валидатором
+	- [x] Участвовать в выборах валидатора
+	- [x] Возвращать ставку + вознаграждение
+	- [ ] Автозапуск валидатора при аварийном завершении
+	- [ ] Отправлять статистику валидатора на http://validators.ton
+
+## Список проверенных операционных систем
+```
+Ubuntu 18.04.2
+Debian 10.3
+```
+
+## Описание установочных скриптов
+- `toninstaller.sh` - Данный скрипт клонирует исходники `TON` и `mytonctrl` в папки `/usr/src/ton` и `/usr/src/mytonctrl`, компилирует программы из исходников и прописывает их в `/usr/bin/`.
+- `vpreparation.sh` - Данный скрипт создает пользователя `validator` для работы валидатора и пропишет его в автозагрузку через крон.
+- `mytoninstaller.py` - Данный скрипт производит настройку `mytonctrl` и создание ключей для подключения к валидатору.
+- `vconfig.sh` - Данный скрипт настроит доступ для подключения к валидатору `lite-client` и `validator-engine-console`.
+
+## Режимы установки
+Есть два режима установки: `lite` и `full`. Оба они **компилируют** и устанавливают компоненты `TON`. Однако `lite` версия не настраивает и не запускает валидатор. В данный момент `full` установка сырая/баганутая/недоделанная, поэтому вы можете установить в режиме `lite` и дальше уже руками дописать настройки в конфигурацию `mytonctrl` для взаимодействия с вашим валидатором.
+
+## Установка (Ubuntu)
+1. Скачайте и выполните скрипт `install.sh` с нужным вам режимом установки. Мы будем устанавливать в режиме `lite`. В ходе установки у вас будет несколько раз запрошен пароль суперпользователя.
+```sh
+wget https://raw.githubusercontent.com/igroman787/mytonctrl/master/scripts/install.sh
+sudo sh install.sh -m lite
+```
+
+2. Готово. Можете пробовать запустить программу `mytonctrl`.
+```sh
+mytonctrl
+```
+
+
+## Установка (Debian)
+1. Скачайте и выполните скрипт `install.sh` с нужным вам режимом установки. Мы будем устанавливать в режиме `lite`. В ходе установки у вас будет несколько раз запрошен пароль суперпользователя.
+```sh
+wget https://raw.githubusercontent.com/igroman787/mytonctrl/master/scripts/install.sh
+su root -c 'sh install.sh -m lite'
+```
+
+2. Готово. Можете пробовать запустить программу `mytonctrl`.
+```sh
+mytonctrl
+```
diff --git a/README.md b/README.md
@@ -1,87 +1,145 @@
-## Что это
-Данная консольная программа является оберткой над `fift`, `lite-client` и `validator-engine-console`. Она была создана для облегчения управления кошельками, доменами и валидатором на операционной системе `Linux`.
-Проект находится в активной разработке, поэтому стабильность работы не гарантируется.
-![](https://raw.githubusercontent.com/igroman787/mytonctrl/master/screens/mytonctrl-status.png)
-
-## Функционал
-- [x] Показать статус сети TON
-- [x] Управление локальными кошельками
-	- [x] Создать локальный кошелек
-	- [x] Активировать локальный кошелек
-	- [x] Показать локальные кошельки
-	- [x] Импортировать кошелек из файла (.pk)
-	- [x] Сохранить адрес кошелька в файл (.addr)
-	- [x] Удалить локальный кошелек
-- [x] Показать статус аккаунта
-	- [x] Показать баланс аккаунта
-	- [x] Показать историю аккаунта
-	- [x] Показать статус аккаунта из закладок
-- [x] Перевод средств на кошелек
-	- [x] Перевод фиксированной суммы
-	- [x] Перевод всей суммы (all)
-	- [x] Перевод всей суммы с диактивацией кошелька (alld)
-	- [x] Перевод средств на кошелек из закладок
-	- [ ] Пропустить средства через миксер
-- [x] Управление закладками
-	- [x] Добавить аккаунт в закладки
-	- [x] Показать закладки
-	- [x] Удалить закладку
-- [x] Управление предложениями
-	- [x] Показать предложения
-	- [x] Проголосовать за предложение
-	- [x] Автоматическое голосование за ранее проголосованные предложения
-- [x] Управление доменами
-	- [x] Арендовать новый домен
-	- [x] Показать арендованные домены
-	- [x] Показать статус домена
-	- [x] Удалить домен
-	- [ ] Автоматическое продление доменов
-- [ ] Автоматическая отправка средств по расписанию
-	- [ ] Добавить правило в расписание
-	- [ ] Показать правила расписания
-	- [ ] Удалить правило из расписания
-- [x] Управление валидатором
-	- [x] Участвовать в выборах валидатора
-	- [x] Возвращать ставку + вознаграждение
-	- [ ] Автозапуск валидатора при аварийном завершении
-	- [ ] Отправлять статистику валидатора на http://validators.ton
-
-## Список проверенных операционных систем
-```
-Ubuntu 18.04.2
-Debian 10.3
-```
+## MyTonCtrl
+This console program is a wrapper over `fift`,` lite-client` and `validator-engine-console`. It was created to facilitate the management of wallets, domains, and validators on the Linux.
+
+The instructions and scripts below were verified on ```Ubuntu 18.04``` and ```Debian 10.3```.
+
+## System requirements
+
+To start a validator (full node) in testnet we recommend looking at these system requirements.
+
+| Configuration | CPU (cores) | RAM (GB) | SSD/NVME (GB) | Network (Mbit/s)|
+|---|:---|:---|:---|:---|
+| Minimum |6|16|256|100|
+| Recommended |8|32|480|500|
+
+UP and DOWN traffic is symmetrical during the validator is working and equal to average 50 Mbit/s in both directions.
+
+These minimum requirements were obtained based on our experience of raising validators. In order to save your personal funds on powerful servers and more people can join the network, we tried to specify the minimum parameters that are possible for the validator to work :)
+
+## Console features
+- [x] TON network status
+- [x] Local Wallets Management
+- [x] Show account status
+- [x] Show account balance
+- [x] Show account history
+- [x] Show account status from bookmarks
+- [x] Transfer funds to wallet
+- [x] Transfer a fixed amount
+- [x] Transfer the entire amount (all)
+- [x] Transferring the entire amount with wallet deactivation (all)
+- [x] Transfer funds to your wallet from bookmarks
+- [x] Bookmark management
+- [x] Bookmark this account
+- [x] Show bookmarks
+- [x] Delete bookmark
+- [x] Offer Management
+- [x] Show offers
+- [x] Vote for the proposal
+- [x] Automatic voting for previously voted offers
+- [x] Domain Management
+- [x] Rent a new domain
+- [x] Show leased domains
+- [x] Show domain status
+- [x] Delete domain
+- [x] Validator Management
+- [x] Participate in the election of a validator
+- [x] Return bid + reward
+
+##TODO
+- [] Automatically renew domains
+- [] Automatic scheduled funds sending
+- [] Add rule to schedule
+- [] Show schedule rules
+- [] Remove rule from schedule
+- [] Autostart validator during abnormal termination
+- [] Send validator statistics to http://validators.ton
+- [] Pass funds through the mixer
 
-## Описание установочных скриптов
-- `toninstaller.sh` - Данный скрипт клонирует исходники `TON` и `mytonctrl` в папки `/usr/src/ton` и `/usr/src/mytonctrl`, компилирует программы из исходников и прописывает их в `/usr/bin/`.
-- `vpreparation.sh` - Данный скрипт создает пользователя `validator` для работы валидатора и пропишет его в автозагрузку через крон.
-- `mytoninstaller.py` - Данный скрипт производит настройку `mytonctrl` и создание ключей для подключения к валидатору.
-- `vconfig.sh` - Данный скрипт настроит доступ для подключения к валидатору `lite-client` и `validator-engine-console`.
 
-## Режимы установки
-Есть два режима установки: `lite` и `full`. Оба они **компилируют** и устанавливают компоненты `TON`. Однако `lite` версия не настраивает и не запускает валидатор. В данный момент `full` установка сырая/баганутая/недоделанная, поэтому вы можете установить в режиме `lite` и дальше уже руками дописать настройки в конфигурацию `mytonctrl` для взаимодействия с вашим валидатором.
 
-## Установка (Ubuntu)
-1. Скачайте и выполните скрипт `install.sh` с нужным вам режимом установки. Мы будем устанавливать в режиме `lite`. В ходе установки у вас будет несколько раз запрошен пароль суперпользователя.
+## Installation Modes
+There are two installation modes: `lite` and `full`. Both of them compile and install `TON` components.
+However, the `lite` version does not configure or launch the validator.
+`full` installation mode will compile and install all the necessary components for your node to participate in the election of validators.
+
+## Installation (Ubuntu)
+1. Download and run the `install.sh` script with the installation mode you need. During installation, you will be asked for the superuser password several times.
 ```sh
 wget https://raw.githubusercontent.com/igroman787/mytonctrl/master/scripts/install.sh
+```
+
+2. If you want to install `full` node to participate in elections run:
+```sh
+sudo sh install.sh -m full
+```
+or  install `lite` version of the client:
+```sh
 sudo sh install.sh -m lite
 ```
 
-2. Готово. Можете пробовать запустить программу `mytonctrl`.
+If the installation was completed successfully, then you will receive the following response in the console:
+
+![](https://raw.githubusercontent.com/igroman787/mytonctrl/master/screens/mytonctrl-inst.jpeg)
+
+
+3. Then you can run `MytonCtrl` with the command:
 ```sh
-mytonctrl
+MyTonCtrl
 ```
 
+4. To learn more about the available commands type `help`
+
 
-## Установка (Debian)
-1. Скачайте и выполните скрипт `install.sh` с нужным вам режимом установки. Мы будем устанавливать в режиме `lite`. В ходе установки у вас будет несколько раз запрошен пароль суперпользователя.
+## Installation (Debian)
+1. Download and run the `install.sh` script with the installation mode you need. During installation, you will be asked for the superuser password several times.
 ```sh
 wget https://raw.githubusercontent.com/igroman787/mytonctrl/master/scripts/install.sh
+```
+2. If you want to install `full` node to participate in elections run:
+```sh
+su root -c 'sh install.sh -m full'
+```
+or  install `lite` version of the client:
+```sh
 su root -c 'sh install.sh -m lite'
 ```
 
-2. Готово. Можете пробовать запустить программу `mytonctrl`.
+If the installation was completed successfully, then you will receive the following response in the console:
+
+![](https://raw.githubusercontent.com/igroman787/mytonctrl/master/screens/mytonctrl-inst.jpeg)
+
+ 3. Then you can run `MytonCtrl` with the command:
+```sh
+MyTonCtrl
+```
+
+ 4. To learn more about the available commands type `help`.
+
+
+## How to become a validator
+
+TON network automatically turns on when MytonCtrl is installed.
+To view the logs type:
+
 ```sh
-mytonctrl
+tail -f ~/.local/share/mytoncore/mytoncore.log
 ```
+Go to the console, enter `help` and wait until the parameter "Time difference" will be in the range of -1 to -10.
+Now your node is synchronized!
+
+### Creating and activating a wallet
+
+`MytonCtrl` automatically creates a wallet for your validator during installation.
+Type `wl` to display a list of wallets.
+Now you see your wallet address, balance and status: `empty`
+
+![](https://raw.githubusercontent.com/igroman787/mytonctrl/master/screens/mytonctrl-ewl.jpeg)
+
+To activate your wallet type `aw` (Activate Wallet).
+After that, you will see that the wallet is activated:
+
+![](https://raw.githubusercontent.com/igroman787/mytonctrl/master/screens/mytonctrl-awl.jpeg)
+
+Now you need to fund the wallet balance by an amount sufficient for voting. (This parameter is opposite the column "Minimum stake")
+
+// TODO: Write to faucet bot and take some tokens.