sensei

** WARNUNG: Diese Software befindet sich in Beta. Bitte verwenden Sie es nicht mit vielen Mitteln.

Sensei ist eine neue Lightning -Knoten -Implementierung, die sich darauf konzentriert, das Onboarding -Erlebnis für Benutzer in Bitcoin zu lindern. Es wird mit dem Bitcoin Development Kit und dem Lightning Development Kit gebaut.

Abhängigkeiten

Sie benötigen eine Bitcoind -Instanz, um Sensei zu verwenden.

Ich empfehle, Nigiri zu verwenden, um alles vor Ort zum Laufen zu bringen.

Bauen und Laufen von der Quelle

Um aus der Quelle zu laufen, müssen Sie die folgenden Schritte ausführen:

1. Klon The Repo: git clone [email protected]:L2-Technology/sensei.git
2. Erstellen Sie das Web-admin: cd sensei/web-admin && npm install && npm run build && cd ..
3. Run cargo run --bin senseid -- --network=regtest --bitcoind-rpc-host=localhost --bitcoind-rpc-port=18443 --bitcoind-rpc-username=admin1 --bitcoind-rpc-password=123 --database-url=sensei.db
4. Öffnen Sie den Administrator unter http://localhost:5401/admin/nodes

Datenbank -Backends

Sensei unterstützt sqlite , mysql und postgres -Datenbanken. Sie können konfigurieren, welche Datenbank verwendet werden soll, indem Sie eine DATABASE_URL -Umgebung oder --database-url Befehlszeilenargument angeben.

Sqlite

Für SQLite geben Sie den Dateinamen für die Datenbank nur an. Es wird im Sensei -Datenverzeichnis gespeichert.

Beispiel: --database-url=sensei.db

Postgres & Mysql

Sensei enthält eine docker-compose.yml Datei, mit der diese Datenbanken automatisch für Sie lokal ausgeführt werden können. Fühlen Sie sich frei, diese zu verwenden oder nur die Anmeldeinformationen in jeder Datenbank zu ersetzen, die Sie bereits haben.

Docker -basierte Datenbanken starten: docker-compose up -d

Postgres Beispiel: --database-url=postgres://sensei:sensei@localhost:5432/sensei mysql Beispiel:-- --database-url=mysql://sensei:sensei@localhost:3306/sensei

Entwicklung des Webminens

Um Ihre Änderungen live zu sehen, müssen Sie:

1. Erlauben Sie Anforderungen von lokalem Web-admin: cargo run --bin senseid -- --network=regtest --bitcoind-rpc-host=localhost --bitcoind-rpc-port=18443 --bitcoind-rpc-username=admin1 --bitcoind-rpc-password=123 --allow-origins=http://localhost:3001
2. Führen Sie den Web-Admin Dev Server aus: cd sensei/web-admin && npm install && npm run start
3. Besuchen Sie den Administrator mit Port 3001: http://localhost:3001/admin/nodes

Verwendung mit Nigiri

Nigiri ist ein großartiges Werkzeug, um lokale Docker -Bilder von Bitcoind, Electrum, Esplora und vielem mehr auszuführen. Sobald es ausgeführt wird, können Sie die Bitcoind -Instanz verwenden, die es bietet, wenn Sie Ihren Sensei -Knoten starten.

Sobald Ihr Knoten eingerichtet ist, können Sie:

1. Besuchen Sie die Seite "Fundknoten" im Sensei -Administrator, um eine nicht verwendete Empfangsadresse zu erhalten.
2. Senden Sie 100 m SATs an Ihren Sensei -Knoten über: nigiri faucet <sensei_fund_address>
3. Nachdem Sie einen Kanal geöffnet haben, können Sie Blöcke mit Nigiri abbauen.
   • Eine Adresse zu Mine an nigiri rpc getnewaddress "" "bech32" erhalten
   • Mine einige Blöcke zu dieser Adresse nigiri rpc generatetoaddress 10 "<address_from_previous_command>"

Datenverzeichnis

Sie können ein benutzerdefiniertes Datenverzeichnis über das Flag - -data_dir -Flag übergeben, aber der Standard ist ein .sensei -Verzeichnis in Ihrem Home -Verzeichnis in Betriebssystemen.

Home Directory wird mit der Dirs -Kiste abgerufen.

Plattform	Wert	Beispiel
Linux	$HOME	/home/alice/.Sensei
macos	$HOME	/Users/alice/.Sensei
Fenster	{FOLDERID_Profile}	C: Benutzer Alice.Sensei

Linux und MacOS:

• Verwenden Sie $HOME , wenn es festgelegt und nicht leer ist.
• Wenn $HOME nicht festgelegt oder leer ist, wird die Funktion getpwuid_r verwendet, um das Home -Verzeichnis des aktuellen Benutzers zu bestimmen.
• Wenn getpwuid_r einen Eintrag für die aktuelle Benutzer -ID fehlt oder das Feld Home -Verzeichnis leer ist, gibt die Funktion None zurück.

Fenster:

Diese Funktion ruft den Ordner des Benutzerprofils mit SHGetKnownFolderPath ab.

Konfigurationsdateien

Sensei erstellt im Datenverzeichnis eine Root config.json -Datei. Dies sind Konfigurationen, die in allen Netzwerken angewendet werden.

Sensei erstellt auch Unterverzeichnisse für jedes Netzwerk (z. B. Mainnet, testNet, Regtest), mit dem Sie den Daemon instanziieren. Jedes Netzwerk -Unterverzeichnis verfügt über seine eigene config.json -Datei.

Sensei fügt die netzwerkspezifische Konfiguration in die Stammkonfiguration zusammen, um die endgültige Konfiguration zu erstellen.

Dies bedeutet, dass jede auf Netzwerkebene festgelegte Konfiguration die Konfiguration auf der Stammebene überschreibt.

Befehlszeilen -Argumente und Umgebungsvariablen

Einige der Konfigurationsoptionen können mit Befehlszeilenargumenten oder Umgebungsvariablen festgelegt werden.

Diese haben die höchste Vorrang und überschreiben die netzwerkspezifische Konfiguration.

Instanz> Netzwerk> Root

Dokumentation

Bitte besuchen Sie die Dokumentations -Website, um Installation und Anweisungen zu erstellen.

Gemeinschaft

Bitte schließen Sie sich unserer Discord -Community an, um alles zu diskutieren, was mit diesem Projekt zu tun hat.