Документация по кошельку

Узел Ergo предоставляет встроенный кошелек для хранения приватных ключей и подписания транзакций. Далее описывается, как настроить и защитить ваш кошелек Ergo.

Кошелек использует стандарт BIP39 для генерации семени из мнемонической фразы, которая затем используется для генерации приватных ключей в соответствии со стандартом BIP32 (Иерархические детерминированные кошельки). Вы можете использовать свою собственную мнемоническую фразу, составленную из слов из одного из этих списков слов, если хотите.
Допустимые длины фраз составляют 12, 15, 18, 21, 24, что соответствует 128, 160, 192, 224, 256 битам безопасности соответственно. Для инициализации кошелька с такой мнемоникой вы должны использовать API-эндпоинт wallet/restore.
Тем не менее, гораздо безопаснее использовать мнемонику, сгенерированную кошельком.

На этом этапе все взаимодействия с кошельком могут осуществляться только через REST API узла. Пожалуйста, убедитесь, что вы установили API-ключ в вашем узле перед выполнением следующих шагов.

Настройка кошелька

Кошелек настраивается через файл конфигурации узла. Ниже приведены параметры конфигурации, на которые стоит обратить внимание при первой настройке кошелька:

• ergo.wallet.seedStrengthBits - Длина семени в битах в случае, если оно будет сгенерировано узлом. Примечание: чем сильнее семя, тем длиннее длина мнемонической фразы. Опции: 128, 160, 192, 224, 256
• ergo.wallet.secretStorage.secretDir - Директория, где секрет будет храниться в зашифрованном виде
• ergo.wallet.mnemonicPhraseLanguage - Язык, который будет использоваться в мнемонической фразе. Опции: "chinese_simplified", "chinese_traditional", "english", "french", "italian", "japanese", "korean", "spanish"

Использование кошелька в первый раз

Кошелек необходимо инициализировать через REST API при первом запуске узла. Здесь доступны два варианта:

1. Инициализировать его с нуля (семя будет сгенерировано узлом), сделав POST-запрос на /wallet/init с данными body: {"pass": "123", "mnemonicPass": "abc"}. Не забудьте сохранить мнемоническую фразу, с которой ответит узел. (Примечание: параметр mnemonicPass в теле запроса является необязательным и используется для защиты мнемонической фразы).
2. Восстановить кошелек из существующего семени. Вам нужно будет предоставить вашу мнемоническую фразу при использовании этого варианта. Это делается путем отправки POST-запроса на /wallet/restore с данными body: {"pass": "123", "mnemonic": "abandon abandon ...", "mnemonicPass": "abc"} (Примечание: поле mnemonicPass обязательно только в случае, если ваша мнемоническая фраза была защищена дополнительным паролем при создании).

Разблокировка кошелька

После инициализации и перед каждым использованием кошелек необходимо разблокировать, сделав POST запрос на /wallet/unlock с данными body: {"pass": "123"}. (Примечание: используйте пароль, который вы выбрали на этапе инициализации)

Вы должны выполнять этот шаг каждый раз, когда узел перезапускается или кошелек блокируется.
В частности, кошелек должен быть разблокирован для следующих операций:

• Использование внутреннего майнера
• Подписание транзакций
• Отслеживание коробок

Блокировка кошелька

Кошелек автоматически блокируется через некоторое время, что означает, что все текущие загруженные секреты очищаются из памяти. Вы также можете использовать REST API для блокировки кошелька, сделав GET запрос на /wallet/lock.
Рекомендуется блокировать кошелек, когда он не используется.
После блокировки вам нужно будет разблокировать кошелек, чтобы использовать его снова.

Управление ключами

Кошелек реализует BIP32 ("Иерархические детерминированные кошельки"). Когда кошелек инициализируется, создается только корневой ключ.
Чтобы получить дополнительную пару ключей, соответствующую конкретному пути деривации (метод: POST, тело запроса: {"derivationPath": "m/1/2"}), можно использовать API-эндпоинт /wallet/deriveKey.
Чтобы просто создать дополнительную пару ключей, используйте API-эндпоинт /wallet/deriveNextKey (метод: GET).