sensei

** ADVERTENCIA: Este software está en beta. No lo use con muchos fondos.

Sensei es una nueva implementación del nodo Lightning con un enfoque en facilitar la experiencia de incorporación para los usuarios nuevos en Bitcoin. Se construye utilizando el kit de desarrollo de Bitcoin y el kit de desarrollo Lightning.

Dependencias

Necesitará una instancia de Bitcoind para usar Sensei.

Recomiendo usar Nigiri para que todo funcione localmente.

Construyendo y corriendo desde la fuente

Para correr desde la fuente, deberá dar los siguientes pasos:

1. Clone the Repo: git clone [email protected]:L2-Technology/sensei.git
2. Construya el Web-Admin: cd sensei/web-admin && npm install && npm run build && cd ..
3. Run SenseID en Regtest: 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. Abra el administrador en http://localhost:5401/admin/nodes

Backends de la base de datos

Sensei admite bases de datos sqlite , mysql y postgres . Puede configurar qué base de datos utilizar al especificar un argumento de línea de comandos de comandos de entorno DATABASE_URL --database-url

Sqlite

Para SQLite, solo especifica el nombre de archivo para usar para la base de datos. Se guardará en el directorio de datos Sensei.

Ejemplo: --database-url=sensei.db

Postgres y mysql

Sensei incluye un archivo docker-compose.yml que puede ejecutar automáticamente estas bases de datos para usted localmente. Siéntase libre de usarlos o simplemente sustituir las credenciales a cualquier base de datos que ya tenga.

Iniciar bases de datos basadas en Docker: docker-compose up -d

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

Desarrollo del Web-Admin

Para ver sus cambios en vivo, deberá:

1. Permitir las solicitudes de la web-admin local: 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. Ejecute el servidor de desarrollo web-admin: cd sensei/web-admin && npm install && npm run start
3. Visite el administrador usando el puerto 3001: http://localhost:3001/admin/nodes

Usando con nigiri

Nigiri es una gran herramienta para ejecutar imágenes locales de Docker de Bitcoind, Electrum, Esplora y mucho más. Una vez que se está ejecutando, puede usar la instancia de bitcoind que proporciona al iniciar su nodo sensei.

Una vez que su nodo esté configurado, puede:

1. Visite la página 'Fund Node' en el administrador Sensei para obtener una dirección de recepción no utilizada.
2. Envíe 100m SAT a su nodo Sensei a través de: nigiri faucet <sensei_fund_address>
3. Después de abrir un canal, puedes minas de bloques usando Nigiri por:
   • Obtener una dirección para la mía a nigiri rpc getnewaddress "" "bech32"
   • Mine algunos bloques a esa dirección nigiri rpc generatetoaddress 10 "<address_from_previous_command>"

Directorio de datos

Puede pasar un directorio de datos personalizado usando el indicador --data_dir, pero el predeterminado será un directorio .sensei en el directorio de inicio de su sistema operativo.

El directorio de inicio se recupera utilizando la caja DIRS.

Plataforma	Valor	Ejemplo
Linux	$HOME	/home/alice/.sensei
macosa	$HOME	/Users/alice/.sensei
Windows	{FOLDERID_Profile}	C: users alice.sensei

Linux y macOS:

• Use $HOME si está configurado y no está vacío.
• Si $HOME no está configurado o vacía, entonces la función getpwuid_r se usa para determinar el directorio de inicio del usuario actual.
• Si getpwuid_r carece de una entrada para la ID de usuario actual o el campo de directorio de inicio está vacío, entonces la función no devuelve None .

Windows:

Esta función recupera la carpeta de perfil de usuario utilizando SHGetKnownFolderPath .

Archivos de configuración

Sensei creará un archivo Root config.json dentro del directorio de datos. Estas son configuraciones que se aplicarán en todas las redes.

Sensei también creará subdirectorios para cada red (por ejemplo, MainNet, Testnet, RegTest) con el que instancia el Daemon. Cada subdirectorio de red tendrá su propio archivo config.json .

Sensei fusionará la configuración específica de la red en la configuración raíz para crear la configuración final.

Esto significa que cualquier configuración establecida en el nivel de red anulará la configuración en el nivel raíz.

Args de línea de comandos y variables de entorno

Algunas de las opciones de configuración se pueden configurar utilizando argumentos de línea de comando o variables de entorno.

Estos tendrán la mayor precedencia y sobrescribirán la configuración específica de la red.

instancia> red> root

Documentación

Visite el sitio web de documentación para obtener instrucciones de instalación y iniciar.

Comunidad

Únase a nuestra comunidad de Discord para discutir cualquier cosa relacionada con este proyecto.