Skip to content

Commit aff9b73

Browse files
authored
Merge pull request #215 from ton-blockchain/mytonctrl2_dev
merge mytonctrl2_dev to mytonctrl2
2 parents 60ca597 + cb7b39e commit aff9b73

30 files changed

+1961
-735
lines changed

docs/en/controllers.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Controllers
2+
3+
## Launching a Validator in Controller Mode
4+
5+
1. Prepare the hardware for the validator - 32 virtual cores, 64GB of memory, 1TB SSD, fixed IP address, and 1Gb/s internet speed.
6+
7+
To maintain network stability, it is recommended to place validators in different locations around the world, rather than concentrating them in a single data center. You can use [this site](https://status.toncenter.com/) to determine the load on various locations. According to the map, there is a high load on data centers in Europe, especially in Finland, Germany, and Paris. Therefore, using providers such as Hetzner and OVH is not recommended.
8+
9+
> Ensure your hardware meets or exceeds the specified configuration. Running the validator on inappropriate hardware can harm the network and result in penalties.
10+
> Since May 2021, Hetzner has prohibited mining on its servers. This rule currently applies to both PoW and PoS algorithms. Even installing a regular node will be considered a breach of contract.
11+
12+
2. Install and synchronize **mytonctrl** according to the description in [this instruction](https://github.com/ton-blockchain/mytonctrl/blob/master/docs/en/manual-ubuntu.md) — follow **only** paragraphs 1, 2, and 3.
13+
14+
You can also refer to this [Video Tutorial](https://docs.ton.org/participate/run-nodes/full-node#installation) for additional help.
15+
16+
3. Transfer 1 TON to the validator wallet address, which is displayed in the `wl` list.
17+
18+
4. Use the `aw` command to activate the validator's wallet.
19+
20+
5. Transfer enough TON to the validator wallet address.
21+
22+
6. Enable the ton-http-api service:
23+
```
24+
mytonctrl -> installer -> enable THA
25+
```
26+
Exit installer mode with `Ctrl+D`
27+
28+
7. Set liquid-staking mode:
29+
30+
```bash
31+
enable_mode liquid-staking
32+
set stake null
33+
```
34+
35+
> (!) If you were previously using nominator pools, do not forget to disable them using the `disable_mode nominator-pool` command.
36+
37+
8Set the liquid pool address, which will lend TON for validation:
38+
```
39+
set liquid_pool_addr <liquid-pool-address>
40+
```
41+
42+
9. Set the lending parameters that acceptable to you:
43+
```
44+
set min_loan 41000
45+
set max_loan 43000
46+
set max_interest_percent 1.5
47+
```
48+
49+
where
50+
* `41000` is the minimum loan amount we are willing to receive from the liquid pool,
51+
* `43000` is the maximum loan amount we are willing to receive from the liquid pool,
52+
* `1.5` 1.5 is the maximum interest rate value for the liquid pool per validation cycle, which we have agreed upon.
53+
54+
10. Display the annual percentage of profit from the liquid pool:
55+
```
56+
calculate_annual_controller_percentage
57+
```
58+
59+
11. Create two controllers with a single command:
60+
61+
```
62+
new_controllers
63+
```
64+
65+
12. Enter `controllers_list` to display the controller addresses:
66+
67+
```
68+
controllers_list
69+
Address Status Balance
70+
kf89KYOeRPRRDyjt_3bPsz92cKSghRqw64efNr8mT1eeHDaS active 0.704345
71+
kf_lT8QNykLh5PN5ictNX22maiyIf9iK787fXg6nJ_zB-jbN active 0.720866
72+
```
73+
74+
13. Make a validator deposit in each controller:
75+
76+
77+
```
78+
deposit_to_controller kf89KYOeRPRRDyjt_3bPsz92cKSghRqw64efNr8mT1eeHDaS 10000
79+
deposit_to_controller kf_lT8QNykLh5PN5ictNX22maiyIf9iK787fXg6nJ_zB-jbN 10000
80+
```
81+
82+
83+
where `10000` TON is the deposit amount.
84+
85+
14. Get approval for the controllers. Each pool may have its own approval issuance policy, check with the operator.
86+
87+
## Switching a Regular Validator to Controller Operating Mode
88+
89+
1. Enter `set stake 0` to stop participating in elections.
90+
91+
2. Wait until both of your deposits have been returned from the Elector.
92+
93+
3. Follow the instructions under "Launching a Validator in Controller Mode", beginning with **Step 6**.

docs/en/nominator-pool.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,14 @@
2020

2121
4. Use the `aw` command to activate your validator wallet.
2222

23-
5. Create two pools (for even and odd validation rounds):
23+
5. Activate pool mode:
24+
25+
```bash
26+
enable_mode nominator-pool
27+
set stake null
28+
```
29+
30+
6. Create two pools (for even and odd validation rounds):
2431

2532
```bash
2633
new_pool p1 0 1 1000 300000
@@ -38,7 +45,7 @@
3845
3946
> (!) Use https://tonmon.xyz/ to determine the current minimum validator stake.
4047
41-
6. Type `pools_list` to display pool addresses:
48+
7. Type `pools_list` to display pool addresses:
4249
4350
```bash
4451
pools_list
@@ -47,7 +54,7 @@
4754
p2 empty 0 0f9qtmnzs2-PumMisKDmv6KNjNfOMDQG70mQdp-BcAhnV5jL
4855
```
4956
50-
7. Send 1 TON to each pool and activate the pools:
57+
8. Send 1 TON to each pool and activate the pools:
5158
5259
```bash
5360
mg validator_wallet_001 0f98YhXA9wnr0d5XRXT-I2yH54nyQzn0tuAYC4FunT780qIT 1
@@ -56,7 +63,7 @@
5663
activate_pool p2
5764
```
5865
59-
8. Type `pools_list` to display pools:
66+
9. Type `pools_list` to display pools:
6067
6168
```bash
6269
pools_list
@@ -65,9 +72,9 @@
6572
p2 active 0.731199806 kf9qtmnzs2-PumMisKDmv6KNjNfOMDQG70mQdp-BcAhnV8UO
6673
```
6774
68-
9. Open each pool via the link "https://tonscan.org/nominator/<address_of_pool>" and verify pool configurations.
75+
10. Open each pool via the link "https://tonscan.org/nominator/<address_of_pool>" and verify pool configurations.
6976
70-
10. Proceed with the validator deposit to each pool:
77+
11. Proceed with the validator deposit to each pool:
7178
7279
```bash
7380
deposit_to_pool validator_wallet_001 <address_of_pool_1> 1005
@@ -76,7 +83,7 @@
7683
7784
In these commands, `1005` TON is the deposit amount. Be aware that 1 TON will be deducted by the pool for processing the deposit.
7885
79-
11. Proceed with the nominator deposit to each pool:
86+
12. Proceed with the nominator deposit to each pool:
8087
8188
Visit the pool link (from **Step 9**) and click **ADD STAKE**.
8289
You can also make a deposit using **mytonctrl**, using the following commands:
@@ -92,13 +99,6 @@
9299
93100
> To withdraw a nominator deposit, send a transaction with the comment `w` to the pool address (attach 1 TON to process the transaction). You can also perform this action using **mytonctrl**.
94101
95-
12. Activate pool mode:
96-
97-
```bash
98-
set usePool true
99-
set stake null
100-
```
101-
102102
13. Invite nominators to deposit into your pools. The participation in validation will commence automatically.
103103
104104
> (!) Ensure that you have at least 200 TON/month in your validator wallet for operation fees.

docs/ru/controllers.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Контроллеры
2+
3+
## Запуск валидатора в режиме работы контроллеров
4+
5+
1. Подготовьте аппаратное обеспечение для валидатора - 32 виртуальных ядер, 64GB памяти, 1TB SSD, фиксированный IP-адрес, скорость интернета 1Gb/s.
6+
7+
Для поддержания стабильности сети рекомендуется разместить валидаторы в различных местах по всему миру, а не концентрировать их в одном дата-центре. Вы можете использовать [этот сайт](https://status.toncenter.com/) для определения нагрузки на различные места. Согласно карте, высокая нагрузка на дата-центры в Европе, особенно в Финляндии, Германии и Париже. Поэтому использование провайдеров, таких как Hetzner и OVH, не рекомендуется.
8+
9+
> Ваше оборудование должно соответствовать указанной конфигурации или быть выше. Запуск валидатора на слабом оборудовании негативно влияет на сеть и может привести к штрафам.
10+
11+
> С мая 2021 года Hetzner запретил майнинг на своих серверах, в настоящее время под это правило попадают алгоритмы PoW и PoS. Установка даже обычного узла будет считаться нарушением условий договора.
12+
13+
2. Установите и синхронизируйте **mytonctrl** в соответствии с описанием в [этой инструкции](https://github.com/ton-blockchain/mytonctrl/blob/master/docs/ru/manual-ubuntu.md) — следуйте **только** пунктам 1, 2 и 3.
14+
15+
Вы также можете обратиться к этой [Видеоинструкции](https://docs.ton.org/participate/run-nodes/full-node#installation) для дополнительной помощи.
16+
17+
3. Переведите 1 TON на адрес кошелька валидатора, который отображается в списке `wl`.
18+
19+
4. Используйте команду `aw` для активации кошелька валидатора.
20+
21+
5. Переведите достаточно TON на адрес кошелька валидатора.
22+
23+
6. Включите ton-http-api службу:
24+
```
25+
mytonctrl -> installer -> enable THA
26+
```
27+
Выйдите из режима установщика сочетанием клавиш `Ctrl+D`
28+
29+
7. Активируйте режим работы контроллеров:
30+
31+
```bash
32+
enable_mode liquid-staking
33+
set stake null
34+
```
35+
36+
> (!) Если до этого вы использовали номинатор-пулы, не забудьте отключить их использование командой `disable_mode nominator-pool`.
37+
38+
8. Задайте адрес ликвидного пула, который будет одалживать TON для валидации:
39+
```
40+
set liquid_pool_addr <liquid-pool-address>
41+
```
42+
43+
9. Задайте параметры кредитования, которые вам подходят:
44+
```
45+
set min_loan 41000
46+
set max_loan 43000
47+
set max_interest_percent 1.5
48+
```
49+
50+
где
51+
* `41000` - это минимальная сумма кредита который мы готовы получить у ликвидного пула,
52+
* `43000` - это максимальная сумма кредита который мы готовы получить у ликвидного пула,
53+
* `1.5` - это максимальная процентная ставка ликвидного пула за один цикл валидации на которую мы согласны.
54+
55+
10. Отобразите годовой процент прибыли от ликвидного пула:
56+
```
57+
calculate_annual_controller_percentage
58+
```
59+
60+
11. Создайте два контроллера одной командой:
61+
62+
```
63+
new_controllers
64+
```
65+
66+
12. Введите `controllers_list` чтобы отобразить адреса контроллеров:
67+
68+
```
69+
controllers_list
70+
Address Status Balance
71+
kf89KYOeRPRRDyjt_3bPsz92cKSghRqw64efNr8mT1eeHDaS active 0.704345
72+
kf_lT8QNykLh5PN5ictNX22maiyIf9iK787fXg6nJ_zB-jbN active 0.720866
73+
```
74+
75+
13. Совершите депозит валидатора в каждый контроллер:
76+
77+
```
78+
deposit_to_controller kf89KYOeRPRRDyjt_3bPsz92cKSghRqw64efNr8mT1eeHDaS 10000
79+
deposit_to_controller kf_lT8QNykLh5PN5ictNX22maiyIf9iK787fXg6nJ_zB-jbN 10000
80+
```
81+
82+
где `10000` TON - это сумма депозита.
83+
84+
14. Получите аппрувал контроллеров. У каждого пула может быть своя политика выдачи аппруволов, уточняйте у оператора.
85+
86+
## Переключение обычного валидатора в режим работы контроллеров
87+
88+
1. Введите `set stake 0`, чтобы отключить участие в выборах.
89+
90+
2. Дождитесь, когда оба ваших депозита вернутся от электора.
91+
92+
3. Следуйте инструкциям "Запуск валидатора в режиме работы контроллеров", начиная с **6-го шага**.

docs/ru/nominator-pool.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,14 @@
2020

2121
4. Используйте команду `aw` для активации кошелька валидатора.
2222

23-
5. Создайте два пула (для четного и нечетного раунда проверки):
23+
5. Активируйте режим пула:
24+
25+
```bash
26+
enable_mode nominator-pool
27+
set stake null
28+
```
29+
30+
6. Создайте два пула (для четного и нечетного раунда проверки):
2431

2532
```
2633
new_pool p1 0 1 1000 300000
@@ -38,7 +45,7 @@
3845
3946
> (!) Используйте https://tonmon.xyz/, чтобы определить текущую минимальную ставку валидатора.
4047
41-
6. Введите `pools_list` чтобы отобразить адреса пулов:
48+
7. Введите `pools_list` чтобы отобразить адреса пулов:
4249
4350
```
4451
pools_list
@@ -47,7 +54,7 @@
4754
p2 empty 0 0f9qtmnzs2-PumMisKDmv6KNjNfOMDQG70mQdp-BcAhnV5jL
4855
```
4956
50-
7. Отправьте по 1 TON в каждый пул и активируйте пулы:
57+
8. Отправьте по 1 TON в каждый пул и активируйте пулы:
5158
5259
```
5360
mg validator_wallet_001 0f98YhXA9wnr0d5XRXT-I2yH54nyQzn0tuAYC4FunT780qIT 1
@@ -56,7 +63,7 @@
5663
activate_pool p2
5764
```
5865
59-
8. Введите `pools_list` чтобы отобразить адреса пулов:
66+
9. Введите `pools_list` чтобы отобразить адреса пулов:
6067
6168
```
6269
pools_list
@@ -65,9 +72,9 @@
6572
p2 active 0.731199806 kf9qtmnzs2-PumMisKDmv6KNjNfOMDQG70mQdp-BcAhnV8UO
6673
```
6774
68-
9. Откройте каждый пул по ссылке "https://tonscan.org/nominator/<address_of_pool>" и проверьте конфигурацию пулов.
75+
10. Откройте каждый пул по ссылке "https://tonscan.org/nominator/<address_of_pool>" и проверьте конфигурацию пулов.
6976
70-
10. Совершите депозит валидатора в каждый пул:
77+
11. Совершите депозит валидатора в каждый пул:
7178
7279
```bash
7380
deposit_to_pool validator_wallet_001 <address_of_pool_1> 1005
@@ -76,7 +83,7 @@
7683
7784
где `1005` TON - это сумма депозита. Обратите внимание, что пул вычтет 1 TON за обработку депозита.
7885
79-
11. Совершите депозит номинатора в каждый пул:
86+
12. Совершите депозит номинатора в каждый пул:
8087
8188
Перейдите по ссылке пула (из **шага 9**) и нажмите **ADD STAKE**.
8289
Вы также можете сделать депозит, используя **mytonctrl**, с помощью следующих команд:
@@ -92,13 +99,6 @@
9299
93100
> Чтобы снять депозит номинатора, отправьте транзакцию с комментарием `w` на адрес пула (должен быть прикреплен 1 TON для обработки транзакции). Вы также можете сделать это с помощью **mytonctrl**.
94101
95-
12. Активируйте режим пула:
96-
97-
```bash
98-
set usePool true
99-
set stake null
100-
```
101-
102102
13. Пригласите номинаторов сделать депозиты в ваши пулы. Участие в валидации начнется автоматически.
103103
104104
> (!) Убедитесь, что у вас на кошельке валидатора есть как минимум 200 TON в месяц на операционные расходы.
@@ -109,7 +109,7 @@
109109
110110
Если вы создаете пул для многих номинантов, то используйте что-то вроде этого: `new_pool p1 40 40 10000 10000` (максимум 40 номинантов, 40% доли валидатора, минимальная ставка участника 10K TON).
111111
112-
## Переключение обычного валидатора в режим номинантского пула
112+
## Переключение обычного валидатора в режим номинаторского пула
113113
114114
1. Введите `set stake 0`, чтобы отключить участие в выборах.
115115

0 commit comments

Comments
 (0)