Примеры кода

Готовые к запуску примеры для рабочих процессов, которые нужны большинству интеграций, — в виде командной строки и на Python.

Запросы к узлу

Высота блока цепочки, блоки, мемпул и пиры. Без процедуры аутентификации — хорошая отправная точка.

Кошелёк: подключение и чтение

Зашифрованное рукопожатие, открытие кошелька и чтение баланса.

Wallet: отправка и получение

Полный перевод, получение, отмена и доказательства платежа.

Выбор целевого интерфейса

Задача	Поверхность	Учётные данные
Статус узла, пиры	Node API /v2/owner	Базовый, секрет создаётся автоматически
Блоки, заголовки, ядра (kernels), мемпул	Node /v2/foreign	Нет
Опубликовать сырую транзакцию	Node /v2/foreign	Нет
Всё, что связано с ключами или балансом	Wallet Owner API /v3/owner	Базовая аутентификация с .owner_api_secret, затем ECDH-обмен и токен кошелька
Получить перевод	Foreign API кошелька, или epic-wallet listen	Нет

JSON-RPC методы узла разделены по двум путям: /v2/owner — администрирование, а все операции чтения цепочки — на /v2/foreign. См. API узла.

Предварительные требования

CLI

curl и jq.

sudo apt install curl jq      # Debian и Ubuntu

winget install jqlang.jq      # Windows, где curl уже установлен

Python

Python 3.10 или новее.

pip install requests coincurve pycryptodome

coincurve предоставляет secp256k1, а pycryptodome — AES-GCM, оба для Owner API кошелька. Для запросов к узлу нужен только requests.

Соглашения в примерах

• Запускайте команды из каталога examples репозитория — именно там находятся модули Python. import each other from.
• Узел доступен на порту 3413, Owner API кошелька — на 3420, Foreign API кошелька — на 3415. Каждый клиент поддерживает NODE_URL, EPIC_OWNER_URL и EPIC_FOREIGN_URL, так что можно указать другой адрес.
• Суммы — целые числа, в единицах freeman. 1 EPIC равен 100,000,000.
• Секреты считываются из файлов, а пароль кошелька — из EPIC_WALLET_PASSWORD.

Конверт ответа

Каждый JSON-RPC метод Epic возвращает HTTP 200 с JSON-RPC result, внутри которого находится второй конверт. Успешная операция содержит Ok:

{"id": 1, "jsonrpc": "2.0", "result": {"Ok": {"...": "the actual data"}}}

Неуспешная содержит Err на той же позиции:

{"id": 1, "jsonrpc": "2.0", "result": {"Err": {"NotEnoughFunds": {"available": 0, "needed": 100000000}}}}

Напишите один вспомогательный метод разворачивания и используйте его везде. _unwrap в клиенте кошелька на странице подключения и чтения вызывает исключение при Err и возвращает значение при Ok, и все вызовы в этом клиенте проходят через него.

Поле за полем конверт описан в обзоре API.

Расположение референсных клиентов

Репозиторий кошелька поставляется с клиентом на Python, который выполняет то же рукопожатие: doc/samples/python/secure_api_example.py.

Сигнатуры методов определены в api/src/owner_rpc_s.rs; в комментарии к документации почти каждого метода приведены готовые примеры JSON-запроса и ответа.