Dokumentacja portfela

Węzeł Ergo zapewnia wbudowany portfel do przechowywania kluczy prywatnych i podpisywania transakcji. Poniżej opisano, jak skonfigurować i zabezpieczyć swój portfel Ergo.

Portfel korzysta ze standardu BIP39 do generowania nasion z zdania mnemonicznego, które następnie jest używane do generowania kluczy prywatnych zgodnie ze standardem BIP32 (Hierarchiczne Portfele Deterministyczne). Możesz użyć własnego zdania mnemonicznego składającego się z wyrazów z jednej z tych list słów, jeśli chcesz.
Dopuszczalne długości zdań to 12, 15, 18, 21, 24, co odpowiada odpowiednio 128, 160, 192, 224, 256 bitom bezpieczeństwa. Aby zainicjować portfel z takim mnemonikiem, powinieneś użyć punktu końcowego API wallet/restore.
Jednak znacznie bezpieczniej jest użyć mnemoniki generowanej przez portfel.

Na tym etapie wszystkie interakcje z portfelem mogą być realizowane tylko przez REST API węzła. Upewnij się, że ustawiłeś klucz API w swoim węźle przed wykonaniem kolejnych kroków.

Konfigurowanie portfela

Portfel jest konfigurowany za pomocą pliku konfiguracyjnego węzła. Poniżej znajdują się parametry konfiguracyjne, na które warto zwrócić uwagę przy pierwszej konfiguracji portfela:

• ergo.wallet.seedStrengthBits - Długość bitowa nasienia w przypadku, gdy będzie generowane przez węzeł. Uwaga: im silniejsze nasienie, tym dłuższa długość zdania mnemonicznego. Opcje: 128, 160, 192, 224, 256
• ergo.wallet.secretStorage.secretDir - Katalog, w którym sekret będzie przechowywany w formie zaszyfrowanej
• ergo.wallet.mnemonicPhraseLanguage - Język, który ma być użyty w zdaniu mnemonicznym. Opcje: "chinese_simplified", "chinese_traditional", "english", "french", "italian", "japanese", "korean", "spanish"

Używanie portfela po raz pierwszy

Portfel musi być zainicjowany za pomocą REST API podczas uruchamiania węzła po raz pierwszy. Dostępne są tutaj dwie opcje:

1. Zainicjuj go od podstaw (nasienie zostanie wygenerowane przez węzeł) wykonując żądanie POST do /wallet/init z danymi body: {"pass": "123", "mnemonicPass": "abc"}. Nie zapomnij zapisać zdania mnemonicznego, które zwróci węzeł. (Uwaga: parametr mnemonicPass w ciele żądania jest opcjonalny i służy do ochrony zdania mnemonicznego).
2. Przywróć portfel z istniejącego nasienia. Będziesz musiał podać swoje zdanie mnemoniczne, korzystając z tej opcji. Można to zrobić, wykonując żądanie POST do /wallet/restore z danymi body: {"pass": "123", "mnemonic": "abandon abandon ...", "mnemonicPass": "abc"} (Uwaga: pole mnemonicPass jest wymagane tylko w przypadku, gdy twoje zdanie mnemoniczne było chronione dodatkowym hasłem podczas tworzenia).

Odblokowywanie portfela

Po inicjalizacji i przed każdym użyciem portfel musi być odblokowany, wykonując żądanie POST do /wallet/unlock z danymi body: {"pass": "123"}. (Uwaga: użyj hasła, które wybrałeś na etapie inicjalizacji)

Musisz wykonać ten krok za każdym razem, gdy węzeł jest ponownie uruchamiany lub portfel jest zablokowany.
W szczególności portfel musi być odblokowany do następujących operacji:

• Używanie wewnętrznego górnika
• Podpisywanie transakcji
• Śledzenie skrzynek

Zamykanie portfela

Portfel jest automatycznie blokowany po pewnym czasie, co oznacza, że wszystkie aktualnie załadowane sekrety są usuwane z pamięci. Możesz również użyć REST API, aby zablokować portfel, wykonując żądanie GET do /wallet/lock.
Zaleca się zablokowanie portfela, gdy nie jest używany.
Po zablokowaniu będziesz musiał odblokować portfel, aby użyć go ponownie.

Zarządzanie kluczami

Portfel implementuje BIP32 ("Hierarchiczne portfele deterministyczne"). Gdy portfel jest inicjowany, tworzony jest tylko klucz główny.
Aby uzyskać dodatkową parę kluczy odpowiadającą określonej ścieżce pochodzenia (metoda: POST, ciało żądania: {"derivationPath": "m/1/2"}) można użyć trasy API /wallet/deriveKey.
Aby po prostu utworzyć dodatkową parę kluczy, użyj trasy API /wallet/deriveNextKey (metoda: GET).