Cli-wallet API
Страница содержит справочную информацию о методах в cli_wallet API для блокчейна версии HF18. Для каждого метода приводится перечень используемых в нем параметров с кратким их описанием, а также функциональное назначение этого метода.
variant_object about()const
Возвращает информацию о времени компиляции и о клиенте, в том числе версию клиента, версию git graphene/fc, версии boost, openssl и зависимостей.
void add_operation_copy_to_builder_transaction(
transaction_handle_type src_handle,
transaction_handle_type dst_handle,
uint32_t op_index
)
Параметры:
src_handle — уникальный номер конструктора, из которого копируется операция;
dst_handle — уникальный номер конструктора, на который копируется операция;
op_index — номер копируемой операции.Используется для копирования операции между конструкторами транзакций.
void add_operation_to_builder_transaction(transaction_handle_type handle, const operation& op)
Параметры:
handle — уникальный номер конструктора;
op — добавляемая операция.Используется для добавления операции в список операций конструктора транзакций.
signed_transaction approve_proposal(
const std::string& author, const std::string& title,
const approval_delta& delta,
bool broadcast
)
Параметры:
author — автор предложенной транзакции;
title — заголовок предложенной на подпись транзакции;
delta — список подписей, необходимых для одобрения (или удаления) транзакции.
broadcast — “true”, если транзакция пересылается на демон; “false”, если выполняется базовый контроль с выдачей подписанной транзакции на консоль.Возвращает подписанную версию транзакции.
transaction_handle_type wallet_api::begin_builder_transaction()
Метод вызывает операцию создания конструктора транзакций и возвращает уникальный номер созданного конструктора. Начальное значение уникального номера принимается равным «0» и увеличивается на единицу с каждым вызовом метода.
annotated_signed_transaction wallet_api::cancel_order(
string owner,
uint32_t orderid,
bool broadcast
)
Параметры:
owner — имя аккаунта, созданного заявку на отмену транзакции;
orderid — идентификационный номер заявки на отмену транзакции;
broadcast — "true", если транзакция пересылается на демон.Возвращает транзакцию, выполнение которой отменяется.
annotated_signed_transaction wallet_api::cancel_transfer_from_savings(
string from,
uint32_t request_id,
bool broadcast
)
Параметры:
from — имя аккаунта, инициировавшего отмену;
reques_id — идентификационный номер заявки, используемый в вызове transfer_from_savings() для отмены или перевызова операции;
broadcast — "true", если транзакция пересылается на демон.Возвращает подписанную транзакцию, выполнение которой отменяется.
annotated_signed_transaction wallet_api::change_recovery_account(
string owner,
string new_recovery_account,
bool broadcast
)
Параметры:
owner — имя аккаунта;
new_recovery_account — новое имя, которое будет присвоено восстановленному аккаунту;
broadcast— "true", если транзакция пересылается на демон.Возвращает подписанную транзакцию на изменение данных аккаунта.
annotated_signed_transaction wallet_api::convert_sbd(string from, asset amount, bool broadcast)
Параметры:
from — имя аккаунта, запрашивающего конвертацию своей криптовалюты вида SBD;
amount — сумма средств в виде SBD для конвертации;
broadcast — "true", если транзакция пересылается на демон.Используется для конвертации SBD в STEEM в соответствии с их отношением, приведенным в
current_median_history, за неделю с момента выполнения операции.void wallet_api::check_memo(
const string& memo,
const golos::api::account_api_object& account
)const
Параметры:
memo — поле, записи которого проверяются;
account — имя аккаунта.Проверяет записи из поля
memo, относящиеся к личным ключам аккаунта и импортированные в кошелек.annotated_signed_transaction wallet_api::create_account(
string creator,
string new_account_name,
string json_meta,
bool broadcast
)
Параметры:
creator — пользователь, который создает новый аккаунт;
new_account_name — имя нового аккаунта;
json_meta — метаданные профиля нового аккаунта поля json_metadata;
broadcast — "true", если транзакция пересылается на демон; "false", если выполняется базовый контроль с выдачей подписанной транзакции на консоль.Используется для создания нового аккаунта и генерацией ключей
owner, active, и memo для этого аккаунта. За создание аккаунта в качестве комиссионных отчислений с баланса кошелька создателя аккаунта (автора) снимается определенная сумма fee. Величина этих отчислений не может быть меньше значения параметра account_creation_fee, устанавливаемого по результатам голосования делегатов.annotated_signed_transaction wallet_api::create_account_delegated(
string creator, asset steem_fee,
asset delegated_vests,
string new_account_name,
string json_meta,
bool broadcast
)
Параметры:
creator — пользователь, который создает новый аккаунт;
steem_fee — сумма комиссионных отчислений в криптовалюте Голос, снимаемая с баланса кошелька пользователя за создание нового аккаунта и зачисляемая на баланс кошелька созданного аккаунта в криптовалюте Сила Голоса. Эта сумма не может быть возвращена обратно в кошелек создателя аккаунта;
delegated_vests — сумма комиссионных отчислений в криптовалюте Сила Голоса, снимаемая с баланса кошелька пользователя за операцию делегирования и зачисляемая на баланс кошелька нового аккаунта в криптовалюте Сила Голоса. Эта сумма может быть возвращена обратно в кошелек создателя аккаунта по истечении определенного периода, устанавливаемого голосованием делегатов;
new_account_name — имя нового аккаунта;
json_meta — метаданные профиля нового аккаунта поля json_metadata;
bool broadcast — "true", если транзакция пересылается на демон; "false", если выполняется базовый контроль с выдачей подписанной транзакции на консоль.Используется для создания аккаунта с делегированием. Автоматически генерирует публичные ключи
owner, active, posting и memo для нового аккаунта.annotated_signed_transaction wallet_api::create_account_with_keys(
string creator, string newname,
string json_meta, asset fee,
public_key_type owner,
public_key_type active,
public_key_type posting,
public_key_type memo,
bool broadcast
)const
Параметры:
creator — пользователь, который создает новый аккаунт;
newname — имя нового аккаунта;
json_meta — метаданные профиля нового аккаунта поля json_metadata;
fee — сумма комиссионных отчислений в криптовалюте Голос, снимаемая с баланса кошелька пользователя за создание нового аккаунта и зачисляемая на баланс кошелька созданного аккаунта в криптовалюте Сила Голоса. Эта сумма не может быть меньше значения account_creation_fee, устанавливаемого по результатам голосования делегатов;
owner — значение публичного ключа owner нового аккаунта;
active — значение публичного ключа active нового аккаунта;
posting — значение публичного ключа posting нового аккаунта;
memo — значение публичного ключа memo нового аккаунта;
broadcast — "true", если транзакция пересылается на демон.Используется для создания аккаунта, требуется явное задание ключей.
annotated_signed_transaction wallet_api::create_account_with_keys_delegated(
string creator, asset steem_fee,
asset delegated_vests,
string new_account_name,
string json_meta, public_key_type owner,
public_key_type active,
public_key_type posting,
public_key_type memo,
bool broadcast
)const
Параметры:
creator — пользователь, который создает новый аккаунт;
steem_fee — сумма комиссионных отчислений в криптовалют е Голос, снимаемая с баланса кошелька пользователя за создание нового аккаунта и зачисляемая на баланс кошелька созданного аккаунта в криптовалюте Сила Голоса. Эта сумма не может быть возвращена обратно в кошелек создателя аккаунта;
delegated_vests — сумма комиссионных отчислений в криптовалюте Сила Голоса, снимаемая с баланса кошелька пользователя за операцию делегирования и зачисляемая на баланс кошелька нового аккаунта в криптовалюте Сила Голоса. Эта сумма может быть возвращена обратно в кошелек создателя аккаунта по истечении определенного периода, устанавливаемого голосованием делегатов;
new_account_name — имя нового аккаунта;
json_meta — метаданные профиля нового аккаунта поля json_metadata;
owner — значение публичного ключа owner нового аккаунта;
active — значение публичного ключа active нового аккаунта;
posting — значение публичного ключа posting нового аккаунта;
memo — значение публичного ключа memo нового аккаунта;
broadcast — “true”, если транзакция пересылается на демон.Используется для создания нового аккаунта через вызов операции
account_create. Требуется явное задание ключей owner, active, posting и memo для нового аккаунта.annotated_signed_transaction wallet_api::create_order(
string owner,
uint32_t order_id,
asset amount_to_sell,
asset min_to_receive,
bool fill_or_kill,
uint32_t expiration,
bool broadcast
)
Параметры:
owner — имя аккаунта, создаваемого заказ;
order_id — идентификационный номер заказа, присваиваемый аккаунтом, создающий этот заказ;
amount_to_sell — сумма средств в виде SBD или STEAM, выставляемая на продажу;
min_to_receive — минимальная сумма средств, предполагаемая к получению;
fill_or_kill — “true”, если заказ следует отменить в случае его немедленного невыполнения;
expiration — время отведенное на выполнение заказа, по истечении которого он будет отменен;
broadcast — “true”, если транзакция пересылается на демон.Используется для создания заказа на продажу с кошелька ограниченной суммы средств в виде SBD или STEAM по цене в соответствии с отношением
amount_to_sell / min_to_receive.
Возвращает подписанную транзакцию.variant_object database_info()const
Возвращает справочную информацию о текущем статусе разделяемой памяти, в том числе: общий объем разделяемой памяти, размер свободного и зарезервированного пространства для определенных нужд, а также список индексов, хранящихся в разделяемой памяти (название индекса, количество записей).
annotated_signed_transaction wallet_api::decline_voting_rights(
string account,
bool decline,
bool broadcast
)
Параметры:
account — имя аккаунта, который лишается права голоса;
decline — “true”, если аккаунт лишается права голоса; broadcast — “true”, если транзакция пересылается на демон.Используется для лишения права голоса аккаунта с указанным именем.
Возвращает подписанную транзакцию.
string wallet_api::decrypt_memo( string encrypted_memo )
Параметр:
encrypted_memo — запись, приведенная для прочтения.Возвращает текст в расшифрованном виде (если это возможно), находящийся в кошельке и заш ифрованный с помощью одного из известных личных ключей.
annotated_signed_transaction wallet_api::delegate_vesting_shares(
string delegator,
string delegatee,
asset vesting_shares,
bool broadcast
)
Параметры:
delegator — имя аккаунта, который делегирует Силу Голоса;
delegatee — имя аккаунта, на который делегируется Сила Голоса;
vesting_shares — сумма делегирования;
broadcast — “true”, если транзакция пересылается на демон.Используется для делегирования части криптовалюты Силы Голоса (значение в GESTS) с одного аккаунта на другой.
void encrypt_keys()
Используется для шифрования текста (примечания) с помощью одного из личных к лючей.
annotated_signed_transaction wallet_api::escrow_approve(
string from,
string to,
string agent,
string who,
uint32_t escrow_id,
bool approve,
bool broadcast
)
Параметры:
from — имя аккаунта, передающего средства на условное депонирование;
to — имя аккаунта, принимающего средства на условное депонирование;
agent — имя аккаунта, выступающего в качестве агента в случае возникновения спорных ситуаций;
who — имя аккаунта, утверждающего сделку (to или agent);
escrow_id — идентификационный номер операции;
approve — “true”, если сделка утверждается. Иначе транзакция отменяется с возвратом средств аккаунту с именем from;
broadcast — “true”, если транзакция пересылается на демон.Используется для утверждения предложенной транзакции с операцией передачи средств на условное депонирование. Средства могут быть разблокированы только после утверждения транзакции.
Возвращает подписанную транзакцию.
annotated_signed_transaction wallet_api::escrow_dispute(
string from,
string to,
string agent,
string who,
uint32_t escrow_id,
bool broadcast
)
Параметры:
from — имя аккаунта, передавшего средства на условное депонирование;
to — имя аккаунта, принявшего средства на условное депонирование;
agent — имя аккаунта, выступающего в качестве агента в случае возникновения спорных ситуаций;
who — имя аккаунта, открывшего спор (from или to);
escrow_id — идентификационный номер операции;
broadcast — “true”, если транзакция пересылается на демон.Используется для открытия спора по передачи средств на условное депонирование. Спор может быть открыт до истечения срока, отведенного на условное депонирование.
Возвращает подписанную транзакцию.
annotated_signed_transaction wallet_api::escrow_release(
string from,
string to,
string agent,
string who,
string receiver,
uint32_t escrow_id,
asset sbd_amount,
asset steem_amount,
bool broadcast
)
Параметры:
from — имя аккаунта, передавшего средства на условное депонирование;
to — имя аккаунта, изначально принявшего средства на условное депонирование;
agent — имя аккаунта, выступающего в качестве агента в случае возникновения спорных ситуаций;
who — имя аккаунта, утвердившего сделку;
receiver — имя аккаунта, в кошелек которого поступят отпущенные средства;
escrow_id — идентификационный номер операции;
sbd_amount — сумма отпущенных средств в виде SBD;
steem_amount — сумма отпущенных средств в виде STEEM;
broadcast — “true”, если транзакция пересылается на демон.Используется для разблокирования (освобождение) средств, передаваемых на условное депонирование.
Возвращает подписанную транзакцию.
annotated_signed_transaction wallet_api::escrow_transfer(
string from,
string to,
string agent,
uint32_t escrow_id,
asset sbd_amount,
asset steem_amount,
asset fee,
time_point_sec ratification_deadline,
time_point_sec escrow_expiration,
string json_meta,
bool broadcast
)
Параметры:
from — имя аккаунта, от которого передаются средства на условное депонирование;
to — имя аккаунта, к которому передаются средства на условное депонирование;
agent — имя аккаунта, выступающего в качестве агента в случае возникновения спорных ситуаций;
escrow_id — идентификационный номер операции (значения from и escrow_id должны составлять уникальную пару);
sbd_amount — сумма средств в виде SBD, передаваемых на условное депонирование;
steem_amount — сумма средств в виде STEEM, передаваемых на условное депонирование;
fee — комиссионные отчисления для агента;
ratification_deadline — время, до наступления которого транзакция должна быть одобрена аккаунтами с именами to и agent;
escrow_expiration — время, по истечении которого любая из сторон может потребовать возврат средств;
json_meta — метаданные в кодировке JSON;
broadcast — “true”, если транзакция пересылается на демон.Используется для передачи средств в виде STEEM или SBD на условное депонирование от одного аккаунта другому.
Возвращает подписанную транзакцию.
int find_first_unused_derived_key_index(const fc::ecc::private_key& parent_key)
Параметр:
parent_key — родительский ключ.Используется для генерации ключей, производных от родительского. Генерация ключей начинается с индекса «0» с последующим приращением его на единицу. Если очередные индексы будут отсутствовать (обнаружение незарегистрированных ключей) в блокчейне, процесс прекращается. Алгоритм поиска зарегистрированного ключа в блокчейне по очередному индексу предусматривает возможное отсутствие нескольких номеров (наличие «дыр») в последовательности. Размер «дыры» не должен превышать более пяти подряд идущих номеров.
annotated_signed_transaction wallet_api::follow(
string& follower,
string& following,
const set<string>& what,
bool broadcast
)
Параметры:
follower — имя аккаунта, являющегося последователем другого;
following — имя аккаунта, от которого наследуется набор вещей;
what — набор вещей, который наследуется (посты, комментарии, голоса, игнорирования);
broadcast — “true”, если транзакция пересылается на демон.Помечает одного аккаунта как последователь (наследник) другого. Требует для последователя авторизацию ключом
posting.
Возвращает подписанную транзакцию.golos::api::account_api_object get_account(string account_name)const
Параметр:
account_name — имя аккаунта, информация о котором предоставляется.
Возвращает информацию об аккаунте с заданным именем, имеющемся в базе данных блокчейна.
map< uint32_t, golos::plugins::operation_history::applied_operation >
wallet_api::get_account_history(
string account,
uint32_t from,
uint32_t limit
)
Параметры:
account — аккаунт, история которого запрашивается;
from — порядковый номер операции. «-1» — означает последний номер операции;
limit — максимальное количество запрашиваемых элементов. Принимает значение 0-1000.Возвращает историю всех действий в виде транзакций пользователя в сети GOLOS.
vector< account_name_type > wallet_api::get_active_witnesses()const
Возвращает список всех активных делегатов, создавших блоки в текущем окружении (21 блок).
optional<signed_block_with_info> wallet_api::get_block (uint32_t num)
Параметр:
num — номер блока.Возвращает расширенную информацию по блоку с номером
num.vector< database_api::convert_request_api_object > wallet_api::get_conversion_requests(
string owner_account
)
Параметр:
owner_account — имя аккаунта, создавшего запросы.Возвращает текущие запросы на конвертацию указанным пользователем, в том числе все ожидающие запросы
string wallet_api::get_encrypted_memo( string from, string to, string memo )
Параметры:
from — имя аккаунта, с кошелька которого снимаются средства;
to — имя аккаунта, в кошелек которого поступают средства;
memo — текст заметки (примечания).Возвращает заметку в зашифрованном виде, если ее текст начинается с символа «#». В противном случае возвращает заметку в ее оригинальном виде.
witness_api::feed_history_api_object wallet_api::get_feed_history()const
Возвращает историю конверсий GBG / GOLOS на блокчейне.
vector<extended_message_object> wallet_api::get_inbox(
const std::string& to,
time_point newest,
uint16_t limit,
std::uint64_t offset
)
Параметры:
to — имя аккаунта, для которого запрашиваются входящие к нему сообщения;
newest — время, с момента которого запрашиваются сообщения;
limit — пороговое значение на количество запрашиваемых сообщений;
offset — смещение (в секундах) к заданному времени newest.Используется для просмотра входящих личных сообщений для аккаунта с именем
to, хранящихся в блокчейне.vector<account_name_type> wallet_api::get_miner_queue()const
Возвращает список майнеров, ожидающих создание блоков.
vector< database_api::extended_limit_order > wallet_api::get_open_orders( string owner )
Параметр:
owner — пользователь, для которого отображается список заявок.Возвращает список заявок на внутренней бирже на покупку и продажу в сети GOLOS для указанного пользователя.
vector< golos::plugins::operation_history::applied_operation > wallet_api::get_ops_in_block(
uint32_t block_num,
bool only_virtual
)
Параметры:
num — номер (позиция) блока;
only_virtual — только виртуальные операции.Возвращает виртуальные операции в заданном блоке.
market_history::order_book wallet_api::get_order_book(uint32_t limit)
Параметр:
limit — максимальное количество заказов для возврата заявок и запросов (максимальное значение — 1000).Возвращает список заявок на внутренней бирже на покупку и продажу в сети GOLOS.
vector<extended_message_object> wallet_api::get_outbox(
const std::string& from,
time_point newest,
uint16_t limit,
std::uint64_t offset
)
Параметры:
from — имя аккаунта, для которого запрашиваются исходящие от него сообщения;
newest — время, с момента которого запрашиваются сообщения;
limit — пороговое значение на количество запрашиваемых сообщений;
offset — смещение (в секундах) к заданному времени newest.Используется для просмотра исходящих личных сообщений для аккаунта с именем
from, хранящихся в блокчейне.vector< database_api::owner_authority_history_api_object > wallet_api::get_owner_history(
string account
)const
Параметры:
account — пользователь, история которого отображается.Возвращает историю полномочий (прав собственности) пользователя в блокчейне.
fc::ecc::private_key get_private_key(const public_key_type pubkey)const
Параметр:
pubkey — тип публичного ключа.Используется для получения личного ключа в формате WIF, соответствующего публичному ключу. Личный ключ к этому моменту должен быть в кошельке.
Возвращает подтверждение о наличие ключа или его отсутствие.
fc::ecc::private_key get_private_key_for_account(
const golos::api::account_api_object& account
)const
Параметр:
account — имя аккаунта, получающего ключ.Возвращает данные ключа
active в формате WIF.pair<public_key_type,string> wallet_api::get_private_key_from_password(
string account,
string role,
string password
)const
Параметры:
account — имя аккаунта, который получает ключ;
role — тип ключа (active | owner | posting | memo);
password — пароль, который будет использоваться во время генерации ключа.Возвращает публичный ключ, соответствующий сгенерированному личному ключу, а также личный ключ в формате WIF.
std::vector<database_api::proposal_api_object> get_proposed_transactions(
std::string account,
uint32_t from,
uint32_t limit
)
Параметры:
account — аккаунт, информацию о предложенных транзакциях которого необходимо получить;
from — начальный номер транзакции;
limit — пороговое значение количества транзакций.Используется для получения информации о всех предложенных транзакциях применительно к одному и тому же аккаунту. Для получения информации об ограниченном количестве транзакций, необходимо задать начальный номер транзакции
from и пороговое значение limit.operation get_prototype_operation(string operation_type)
Параметр:
operation_type — тип операции. Операция должна быть определена в файле steem/chain/operations.hpp.Используется для получения и заполнения шаблона для операции, создаваемой с помощью вызова
add_operation_to_builder_transaction(). Возвращает неинициализированный объект в виде заданной последовательности операций. Созданный объект может быть дополнен любой операцией с помощью вызова add_operation_to_builder_transaction().annotated_signed_transaction wallet_api::get_transaction(transaction_id_type id)const
Параметр:
id — идентификатор транзакции.
Возвращает информацию о транзакции с указанном идентификатором.
string get_wallet_filename()
Возвращает текущее имя файла кошелька. Данное имя файла используется при автоматическом сохранении кошелька.
vector< database_api::withdraw_vesting_route_api_object > wallet_api::get_withdraw_routes(
string account,
database_api::withdraw_route_type type
)const
Параметры:
account — пользователь, для которого запрашивается возврат;
type — тип возврата (задается строкой вида incoming, outgoing или all).Возвращает перечень переводов, осуществляющих на счет пользователя в зависимости от задаваемого типа возврата (входящий, исходящий или все).
optional < witness_api::witness_api_object > get_witness(string owner_account)
Параметр:
owner_account — имя или идентификатор делегата.Возвращает информацию о заданном делегате, хранимую в блокчейне.
string wallet_api::gethelp(const string & method)const
Параметр:
method — имя API команды, информация о которой запрашивается.Возвращает справочную информацию по отдельной команде API.
string wallet_api::help()const
Возвращает на терминал справочный перечень всех команд, поддерживаемых приложением wallet API.
Информация содержит команды, их аргументы и возвращаемые типы. Для получения более подробной информации по отдельной команде следует использовать
get_help().vector< database_api::withdraw_vesting_route_api_object > wallet_api::get_withdraw_routes(
string account,
database_api::withdraw_route_type type
)const
Параметры:
account — имя аккаунта, запрашивающего маршруты;
type — тип вывода (входящий, исходящий или все).Возвращает маршруты вывода средств для аккаунта.
bool import_key(string wif_key)
Параметр:
wif_key — личный ключ в формате WIF.Используется для импорта личного ключа в формате WIF в кошелек для его дальнейшего использования аккаунтом при подписании транзакций.
Пример использования команды:
import_key 5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3
variant wallet_api::info()const
Возвращает актуальную информацию о блокчейне, в том числе:
witness_majority_version — актуальное состояние делегирования;
hardfork_version — версию HF Golos;
head_block_num — актуальный номер блока;
head_block_id — идентификатор блока;
head_block_age — время жизни блока (в секундах);
median_sbd_price — медианное значение SBD;
account_creation_fee — размер комиссионных отчислений, требуемых на создание аккаунта без делегирования;
create_account_min_golos_fee — минимальный размер комиссионных отчислений в криптовалюте Голос, требуемых на создание аккаунта с делегированием;
create_account_min_delegation — минимально возможное количество Силы Голоса при создании аккаунта с делегированием;
create_account_delegation_time — минимально возможное время (в секундах) «заморозки» делегированной Силы Голоса при создании аккаунта с делегированием;
min_delegation — минимально возможное количество Силы Голоса для делегирования на аккаунт.bool wallet_api::is_locked()const
Проверяет состояние кошелька: заблокирован или нет. Если кошелек находится в заблокированном состоянии, находящиеся в нем личные ключи использованы быть не могут. Состояние ключа изменяется вызовами
lock() или unlock().
Возвращает “true”, если кошелек заблокирован.bool wallet_api::is_new()const
Проверяет состояние кошелька: новый (пароль еще не установлен) или нет. Установка пароля осуществляется с помощью вызова
set_password(). Во время выполнении этой команды кошелек переводится в заблокированное состояние.
Возвращает “true”, если кошелек новый.vector< account_name_type > wallet_api::list_accounts(const string& lowerbound, uint32_t limit)
Параметры:
lowerbound — имя первого возвращаемого аккаунта. Если такое имя отсутствует, список будет начинаться с имени, непосредственно следующего за lowerbound;
limit — значение, ограничивающее количество выводимых на монитор имен аккаунтов. Максимальное значение — 1000.Используется для получения списка всех аккаунтов, зарегистрированных в блокчейне. Задание параметров
lowerbound и limit позволяет формировать страницу в удобной для просмотра форме. Для просмотра всего списка имен аккаунтов рекомендуется вначале значение lowerbound устанавливать в виде пустой строки (“”). Затем на каждой итерации параметру lowerbound передавать последнее возвращаемое имя аккаунта для следующего вызова list_accaunt().
Возвращает список всех зарегистрированных в блокчейне имен аккаунтов с соответствующими им идентификаторами, отсортированный по именам в алфавитном порядке.map<public_key_type, string> wallet_api::list_keys()
Используется для выдачи (распечатки) всех личных ключей, принадлежащих кошельку. Данные ключей выдаются в формате WIF. Ключи могут быть импортированы в другой кошелек вызовом
import_key.
Возвращает карту, содержащую личные ключи, индексированные по их публичному ключу.vector< golos::api::account_api_object > wallet_api::list_my_accounts()
Используется для получения информации об аккаунтах с помощью личного ключа, имеющегося в кошельке. Кошелек должен быть предварительно разблокирован. Метод использует вызов
get_account().vector< account_name_type > wallet_api::ist_witnesses(const string& lowerbound, uint32_t limit)
Параметры:
lowerbound — имя первого возвращаемого делегата. Если такое имя отсутствует, список будет начинаться с имени, непосредственно следующего за lowerbound;
limit — значение, ограничивающее количество выводимых на монитор имен делегатов. Максимальное значение — 1000.Используется для получения списка всех имен делегатов, зарегистрированных в блокчейне. В списке также выделяются имена делегатов, голосующих на данный момент. Задание параметров
lowerbound и limit позволяет формировать страницу в удобной для просмотра форме. Для просмотра всего списка имен делегатов рекомендуется вначале значение lowerbound устанавливать в виде пустой строки (“”). Затем на каждой итерации параметру lowerbound передавать последнее возвращаемое имя делегата для следующего вызова list_witnesses().
Возвращает список всех зарегистрированных в блокчейне имен делегатов с соответствующими им идентификаторами, отсортированный по именам в алфавитном порядке.bool wallet_api::load_wallet_file(string wallet_filename)
Параметр:
wallet_filename — имя файла кошелька в формате JSON, который загружается.Используется для загрузки заданного кошелька платформы Graphene. Перед тем, как новый кошелек будет загружен, текущий кошелек закрывается. Если поле
wallet_filename задано пустым, выполнится перезагрузка существующего файла кошелька.
Возвращает “true”, если заданный кошелек успешно загружен.void wallet_api::lock()
Используется для немедленного блокирования кошелька.
string normalize_brain_key(string s)
Параметр:
s — brain-ключ в оригинальном формате.Используется для преобразования формата brain-клю ча с целью снижения риска возникновения ошибок при повторных вводах-выводах ключа из памяти.
Оригинальный формат brain-ключа преобразуется в формат, используемый для генерации личных ключей. Новый формат содержит верхние регистры всех символов ASCII, а также упакованные последовательно идущие пробелы в один.
Возвращает brain-ключ в нормализованном виде.
annotated_signed_transaction wallet_api::post_comment(
string author,
string permlink,
string parent_author,
string parent_permlink,
string title, string body,
string json,
bool broadcast
)
Параметры:
author — имя аккаунта, являющего автором комментария;
permlink — ссылка на комментарий;
parent_author — имя аккаунта комментария верхнего уровня. Пустая строка означает верхний уровень комментария;
parent_permlink — категория ссылки (для случая, если parent_author — пустая строка);
title — заголовок комментария;
body — тело комментария;
json — метаданные комментария в формате JSON;
broadcast — “true”, если транзакция пересылается на демон.Используется для публикации или обновления комментария.
Возвращает подписанную транзакцию.
transaction preview_builder_transaction(transaction_handle_type handle)
Параметр:
handle — уникальный номер получаемого конструктора.Возвращает уникальный номер для очередного создаваемого конструктора транзакций.
signed_transaction propose_builder_transaction(
transaction_handle_type handle,
std::string author,
std::string title,
std::string memo,
time_point_sec expiration,
time_point_sec review_period_time,
bool broadcast
)
Параметры:
handle — уникальный номер создаваемого конструктора транзакций;
author — автор предлагаемой транзакции;
title — заголовок предлагаемой транзакции;
memo — примечание, текст которого дополняет смысловое значение заголовка;
expiration — время, по истечении которого прекращается подписание транзакции;
review_period_time — период, выделенный для подписания транзакции;
broadcast — “true”, если транзакция пересылается на демон.Используется для создания конструктора предлагаемых транзакций. Возвращает созданный конструктор транзакций под номером
handle.annotated_signed_transaction wallet_api::publish_feed(
string witness,
price exchange_rate,
bool broadcast
)
Параметры:
witness — делегат, публикующий ценовой тариф (потолок котировок);
exchange_rate — предлагаемый курс обмена;
broadcast — “true”, если транзакция пересылается на демон.Используется для публикации потолка котировок криптовалют.
Делегат может публиковать потолок котировок криптовалют STEEM:SBD на бирже. Медианное значение этих котировок используется для обработки запросов на конвертацию SBD в STEEM.
Возвращает подписанную транзакцию.
void wallet_api::quit()
Ипользуется для выхода из кошелька.
annotated_signed_transaction wallet_api::recover_account(
string account_to_recover,
authority recent_authority,
authority new_authority,
bool broadcast
)
Параметры:
account_to_recover — имя аккаунта; у которого восстанавливаются полномочия; recent_authority — недавние полномочия аккаунта; new_authority — новые полномочия, которые задаются в запросе на восстановление;
broadcast — “true”, если транзакция пересылается на демон.Используется для восстановления полномочий (авторизацию) аккаунта с использованием запроса на восстановление, созданного самим аккаунтом. Синтаксис этой команды содержит сериализованный объект авторизации. Пример авторизации объекта показан в следующей строке:
recover_account "account_to_recover"
{ " weight_threshold": 1,"account_auths": [], "key_auths": [["old_public_key",1]] }
{"weight_threshold": 1,"account_auths": [], "key_auths": [["new_public_key",1]]} true
void remove_builder_transaction(transaction_handle_type handle)
Параметр:
handle — уникальный номер конструктора транзакций. Этот номер уменьшается на единицу после каждого вызова метода.Используется для удаления конструктора транзакций по заданному идентификационному номеру.
void replace_operation_in_builder_transaction(
transaction_handle_type handle,
unsigned op_index,
const operation& new_op
)
Параметры:
handle — уникальный номер конструктора;
op_index — номер операции в конструкторе транзакций, которую необходимо заменить;
op — заменяющая операция.Используется для замены операции под номером
op_index в конструкторе транзакций на операцию op.annotated_signed_transaction wallet_api::request_account_recovery(
string recovery_account,
string account_to_recover,
authority new_authority,
bool broadcast
)
Параметры:
recovery_account — имя аккаунта, создающего запрос на восстановление;
account_to_recover — имя аккаунта, который необходимо восстановить;
new_authority — новая авторизация “owner” для восстанавливаемого аккаунта;
broadcast — “true”, если транзакция пересылается на демон.Создает запрос на восстановление аккаунта. Синтаксис этой команды содержит сериализованный объект авторизации. Передача авторизации приведена в следующем примере:
request_account_recovery "recovery_account" "account_to_recover"
{"weight_threshold": 1,"account_auths": [], "key_auths": [["new_public_key",1]]} true
void wallet_api::save_wallet_file(string wallet_filename)
Параметр:
wallet_filename — имя нового файла формата JSON, в который сохраняется кошелек.Используется для сохранения кошелька в файл с заданным именем. Если поле
wallet_filename задается пустым, кошелек сохраняется в старый файл. Для выполнения операции «Сохранить как …» следует использовать вызов set_wallet_filename().string wallet_api::serialize_transaction(signed_transaction tx)const
Параметр:
tx — подписанная транзакция для сериализации.Конвертирует подписанную транзакцию в формате JSON в ее бинарное представление.
Возвращает подписанную транзакцию в бинарном представлении, имеющую вид неструктурированной (бесформенной) строки, в которой могут содержаться нулевые символы.
void wallet_api::set_password(string password)
Параметр:
password— новый пароль.Используется для установки нового пароля для кошелька. Кошелек должен быть либо новым, либо предварительно открытым командой
unlocked().void set_transaction_expiration(uint32_t seconds)
Параметр:
seconds — период времени в секундах.Возвращает заданный период времени (в секундах) в будущем, обозначающим срок действия транзакции.
signed_transaction set_voting_proxy(
string account_to_modify,
string voting_account,
bool broadcast
)
Параметры:
account_to_modify— имя или идентификационный номер аккаунта, чьи полномочия в голосовании изменяются;
voting_account — имя аккаунта (заместитель), который наделяется полномочиями в голосовании. Пустая строка означает отсутствие заместителя;
broadcast — “true”, если транзакция пересылается на демон.Используется для установки полномочий в голосовании для аккаунта. Если пользователь не желает принимать активное участие в голосовании, он может разрешить другому аккаунту (заместителю) использовать его долю голоса при голосовании. Наделение полномочиями заместителя в голосовании не удаляет предыдущие голоса аккаунта из блокчейна, они будут сохранены, но игнорированы. Если аккаунт позже аннулирует полномочия заместителя в голосовании, его предыдущие голоса снова вступят в силу.
annotated_signed_transaction wallet_api::set_withdraw_vesting_route(
string from,
string to,
uint16_t percent,
bool auto_vest,
bool broadcast
)
Параметры:
from — имя аккаунта, с кошелька которого снимаются средства в виде VESTS;
to — имя аккаунта, в кошелек которого возвращаются средства в виде VESTS или STEEM;
percent — процент отчисления от суммы возвращаемых средств аккаунту с именем “to”. Это значение должно устанавливаться в пределах от 1 до 100000 включительно (например, 100 составляет 1 %, 10000 составляет 100 %);
auto_vest — “true”, если аккаунт с именем “from” должен получить средства в виде VESTS, и “false”, если в виде STEEM;
broadcast — “true”, если подписанную транзакцию необходимо переслать на демон.Используется для настройки маршрута вывода средств, полученных по наделенным акциям. При возврате наделенных ак ций получаемые средства будут перенаправлены к аккаунтам с именами “from” и “to” в соответствии с указанными весовыми долями.
signed_transaction wallet_api::sign_builder_transaction(
transaction_handle_type handle,
bool broadcast
)
Параметры:
handle — уникальный номер конструктора транзакций;
broadcast — “true”, если подписанные транзакции необходимо переслать на демон.Используется для подписания всех транзакций в конструкторе транзакций. Возвращает подписанные транзакции в конструкторе транзакций под номером
handle.annotated_signed_transaction wallet_api::sign_transaction(signed_transaction tx, bool broadcast)
Параметры:
tx — транзакция; предоставленная на подпись;
broadcast — “true”, если подписанную транзакцию необходимо переслать на демон.Используется для предоставления на подпись полностью сформированную транзакцию. Транзакция подписывается необходимыми ключами и пересылается при необходимости на демон.
Возвращает подписанную версию транзакции.