Установка и использование платформы
gRPC: получение информации об участниках сети¶
Для получения информации об участниках сети предусмотрены gRPC сервисы AddressPublicService и AliasPublicService.
gRPC: получение информации об адресах участников сети¶
Для получения информации об адресах участников сети предусмотрен gRPC сервис AddressPublicService.
У сервиса AddressPublicService есть следующие методы, описанные в protobuf-файле address_public_service.proto:
GetAddresses;
GetAddressData;
GetAddressDataByKey.
Важно
Типы данных полей для запросов и ответов указаны в protobuf-файле.
Примечание
Для получения информации об адресах участников сети также можно использовать REST методы группы addresses.
Получение всех адресов участников¶
Используйте метод GetAddresses для получения всех адресов участников, ключевые пары которых хранятся в keystore ноды. Метод не требует ввода дополнительных параметров запроса.
Метод возвращает массив адресов участников.
Примечание
Для получения адресов участников, ключевые пары которых хранятся в keystore ноды, также можно использовать REST методы GET /addresses и GET /addresses/seq/{from}/{to}.
Получение данных c указанного адреса¶
Используйте метод GetAddressData для получения данных, записанных на указанном адресе при помощи транзакций 12. Метод требует ввода следующих параметров запроса:
address
– адрес ноды;
limit
– максимальное количество записей, которые вернет метод;
offset
– количество первых записей по данному адресу, которые метод пропустит.
Метод возвращает данные, записанные на указанном адресе.
Примечание
Для получения данных, записанных на указанном адресе при помощи транзакций Data Transaction, также можно использовать REST метод GET /addresses/data/{address}.
Получение данных c указанного адреса по ключу¶
Используйте метод GetAddressDataByKey для получения данных, записанных на указанном адресе с ключом при помощи транзакций 12. Этот ключ указывается в транзакции 12 в поле data.key
. Метод требует ввода следующих параметров запроса:
address
– адрес ноды;
key
– ключ.
Метод возвращает данные, записанные на указанном адресе с ключом key
.
Примечание
Для получения данных, записанных на указанном адресе при помощи транзакций Data Transaction с ключом {key}
, также можно использовать REST метод GET addresses/data/{address}/{key}.
gRPC: получение информации об участниках сети по псевдониму¶
Для получения информации об участниках сети по их псевдониму предусмотрен gRPC сервис AliasPublicService.
У сервиса AliasPublicService есть следующие методы, описанные в protobuf-файле alias_public_service.proto:
AddressByAlias;
AliasesByAddress.
Примечание
Для получения информации об участниках сети по псевдониму также можно использовать REST методы группы alias.
Получение адреса по псевдониму¶
Используйте метод AddressByAlias для получения адреса по псевдониму. Метод требует ввода одного параметра запроса:
alias
– псевдоним участника сети.
Метод возвращает адрес участника сети.
Примечание
Для получения адреса участника сети по его псевдониму также можно использовать REST метод GET /alias/by-alias/{alias}.
Получение псевдонима по адресу¶
Используйте метод AliasesByAddress для получения псевдонима по адресу. Метод требует ввода в запросе адреса участника сети.
Метод возвращает все псевдонимы участника сети.
Примечание
Для получения псевдонима участника сети по его адресу также можно использовать REST метод GET /alias/by-address/{address}.