Merge pull request #139 from cyberway/devel-ru

Devel ru

Author: anazarov79

developers/golos_contracts/golos.ctrl_contract.md

@@ -26,7 +26,7 @@ ctrl_param, types: [
     }
 ]
 ```
-Параметры:  
+**Параметры:**  
  * `ctrl_token` — символ токена (тип данных, однозначно определяющий токен):
     * имя токена, состоящее из набора прописных букв;  
     * поле, задающее точность стоимости токена в виде количества знаков после запятой.  
@@ -42,39 +42,40 @@ ctrl_param, types: [
 
 
 ## Операции-действия, применяемые в смарт-контракте golos.ctrl
-Смарт-контракт `golos.ctrl` поддерживает следующие операции-действия: [setparams](#operaciya-deistvie-setparams), [validateprms](#operaciya-deistvie-validateprms), [regwitness](#operaciya-deistvie-regwitness), [unregwitness](#operaciya-deistvie-unregwitness), [stopwitness](#operaciya-deistvie-stopwitness), [startwitness](#operaciya-deistvie-startwitness), [votewitness](#operaciya-deistvie-votewitness), [unvotewitn](#operaciya-deistvie-unvotewitn), [changevest](#operaciya-deistvie-changevest).
+Смарт-контракт `golos.ctrl` поддерживает следующие операции-действия: [setparams](#setparams), [validateprms](#validateprms), [regwitness](#regwitness), [unregwitness](#unregwitness), [stopwitness](#stopwitness), [startwitness](#startwitness), [votewitness](#votewitness), [unvotewitn](#unvotewitn), [changevest](#changevest).  
 
-## Операция-действие setparams 
+
+## setparams 
 Операция-действие `setparams` используется для настройки параметров смарт-контракта `golos.ctrl`. Операция-действие имеет следующий вид:
 
 ```cpp
 void control::setparams(vector<ctrl_param> params)
 ```
 Параметр `params` — значение в виде структуры, содержащей поля с настраиваемыми параметрами. 
 
-## Операция-действие validateprms
+## validateprms
 Операция-действие `validateprms ` проверяет параметры на валидность, контролирует наличие в них ошибок. Операция-действие `validateprms` вызывается смарт-контрактом, имеет следующий вид:
 
 ```cpp 
 void control::validateprms(vector<ctrl_param> params)
 ```
-Параметр `params` — значение в виде структуры, содержащей проверяемые параметры.
+Параметр `params` — значение в виде структуры, содержащей проверяемые параметры.  
 
-## Операция-действие regwitness
+## regwitness
 Операция-действие `regwitness` используется для регистрации кандидатов в делегаты приложения. Операция-действие `regwitness` имеет следующий вид:  
 ```cpp
 void control::regwitness(
     name witness,
     string url
 )
 ```
-Параметры:  
-`witness` — имя кандидата в делегаты приложения;  
-`url` — адрес веб-сайта, откуда можно получить информацию о кандидате в делегаты, в том числе о мотивах, по которым он изъявил желание стать делегатом. Длина строки адреса не должна превышать 256 символов.  
+**Параметры:**  
+  * `witness` — имя кандидата в делегаты приложения;  
+  * `url` — адрес веб-сайта, откуда можно получить информацию о кандидате в делегаты, в том числе о мотивах, по которым он изъявил желание стать делегатом. Длина строки адреса не должна превышать 256 символов.  
 
 Выполнение операции-действия `regwitness` требует подписи самого кандидата в делегаты `witness`.  
 
-## Операция-действие unregwitness
+## unregwitness
 Операция-действие `unregwitness` используется для снятия кандидатуры пользователя из числа зарегистрированных в качестве кандидатов в делегаты приложения. Операция-действие `unregwitness` имеет следующий вид:
 ```cpp
 void control::unregwitness(name witness)
@@ -87,7 +88,7 @@ void control::unregwitness(name witness)
   * отсутствие голосов за данного кандидата в делегаты. Голоса всех проголосовавших за него пользователей должны быть удалены;  
   * транзакция должна быть подписана самим кандидатом в делегаты `witness`.
 
-## Операция-действие stopwitness
+## stopwitness
 Операция-действие `stopwitness` используется для временного прекращения активных действий делегата (или кандидата в делегаты). Операция-действие имеет следующий вид:
 ```cpp
 void stopwitness(name witness)
@@ -101,7 +102,7 @@ void stopwitness(name witness)
 Активность аккаунта `witness` может быть продолжена после выполнения им операции-действия `startwitness`
 
 
-## Операция-действие startwitness
+## startwitness
 Операция-действие `startwitness` используется для возобновления приостановленных активных действий делегата (или кандидата в делегаты). Операция-действие имеет следующий вид:
 ```cpp
 void startwitness(name witness)
@@ -113,7 +114,7 @@ void startwitness(name witness)
   * транзакция должна быть подписана аккаунтом `witness`.
 
 
-## Операция-действие votewitness
+## votewitness
 Операция-действие `votewitness` используется для голосования за кандидата в делегаты приложения.
 Операция-действие `votewitness` имеет следующий вид:
 ```cpp
@@ -122,17 +123,17 @@ void control::votewitness(
     name witness
 )
 ```
-Параметры:  
-`voter` — имя аккаунта, голосующего за кандидата в делегаты;  
-`witness` — имя кандидата в делегаты, за которого отдается голос.  
+**Параметры:**  
+  * `voter` — имя аккаунта, голосующего за кандидата в делегаты;  
+  * `witness` — имя кандидата в делегаты, за которого отдается голос.  
 
 Выполнение операции-действия `votewitness` требует подписи аккаунта `voter`.  
 
-Ограничения:  
+**Ограничения:**  
   * имя кандидата в делегаты `witness` предварительно должно быть зарегистрировано через вызов `regwitness`;
   * количество голосов, отданных аккаунтом `voter` за кандидаты в делегаты, не должно превышать значение параметра `max_witness_votes`.    
 
-## Операция-действие unvotewitn
+## unvotewitn
 Операция-действие `unvotewitn` используется для снятия ранее отданного голоса за кандидата в делегаты приложения.
 Операция-действие `unvotewitn` имеет следующий вид:
 ```cpp
@@ -141,13 +142,13 @@ void control::unvotewitn(
     name witness
 )
 ```
-Параметры:  
-`voter` —  имя аккаунта, который намеревается снять свой ранее отданный голос за кандидата в делегаты;  
-`witness` — имя кандидата в делегаты, у которого снимается ранее отданный за него голос.  
+**Параметры:**  
+  * `voter` —  имя аккаунта, который намеревается снять свой ранее отданный голос за кандидата в делегаты;  
+  * `witness` — имя кандидата в делегаты, у которого снимается ранее отданный за него голос.  
 
 Выполнение операции-действия `unvotewitn` требует подписи аккаунта `voter`.  
 
-## Операция-действие changevest
+## changevest
 Операция-действие `changevest`  является внутренней и пользователю недоступна. Используется смарт-контрактом вестинг для оповещения смарт-контракта управления об изменении количества вестинга на балансе пользователя. 
 Операция-действие `changevest` имеет следующий вид:
 ```cpp
@@ -156,9 +157,9 @@ void control::changevest(
     asset diff
 )
 ```
-Параметры:  
-`who` — имя аккаунта, на балансе которого изменилась сумма вестинга;  
-`diff` — количество относительного изменения вестинга.  
+**Параметры:**  
+  * `who` — имя аккаунта, на балансе которого изменилась сумма вестинга;  
+  * `diff` — количество относительного изменения вестинга.  
 
 Вызов операции-действия `changevest` происходит автоматически при изменении суммы вестинга на балансе каждого из пользователей. Смарт-контракт вестинг информирует об этом изменении смарт-контракт управления. Поскольку сумма вестинга на балансе пользователя влияет на вес голоса этого пользователя, то рейтинг делегата, за которого проголосовал этот пользователь, также будет зависеть от вестинга этого пользователя. Смарт-контракт управления корректирует рейтинг среди верхушки делегатов с учетом полученной информации об изменении.  Данные таблицы смарт-контракта вестинга при этом не модифицируются.  
 При изменении списка верхушки делегатов также автоматически изменяется их авторизация.