Alex Sears
93a195e38d
|
3 years ago | |
---|---|---|
proto | 3 years ago | |
src | 3 years ago | |
web-admin | 3 years ago | |
.gitignore | 3 years ago | |
Cargo.lock | 3 years ago | |
Cargo.toml | 3 years ago | |
LICENSE-APACHE | 3 years ago | |
LICENSE-MIT | 3 years ago | |
LICENSE.md | 3 years ago | |
README.md | 3 years ago | |
build.rs | 3 years ago |
README.md
WARNING: This software is in beta. Do not use it on mainnet until this warning is removed. Expect breaking changes to the api and database schema until the 0.1.0 release.
Sensei is a new lightning node implementation with a focus on easing the onboarding experience for users new to Bitcoin. It is built using the bitcoin development kit and the lightning development kit.
Dependencies
At the moment you will need Bitcoind and an Electrum server to use Sensei. More flexible backend options are coming.
I recommend using Nigiri to get both services running locally.
Building and running from source
To run from source you will need to take the following steps:
- Clone the repo:
git clone git@github.com:L2-Technology/sensei.git
- Build the web-admin:
cd sensei/web-admin && npm install && npm run build && cd ..
- Run senseid on regtest:
cargo run --bin senseid -- --network=regtest --electrum-url=localhost:50000
- Open the admin at
http://localhost:5401/admin/nodes
Developing the web-admin
In order to see your changes live you will need to:
- Run the web-admin dev server:
cd sensei/web-admin && npm install && npm run start
- Visit the admin using port 3000:
http://localhost:3000/admin/nodes
Using with Nigiri
Nigiri is a great tool for running local docker images of bitcoind, electrum, esplora, and much more. Once it's running you can use localhost:50000
as your Electrum URL
when setting up your Sensei node.
Once your node is setup you can:
- Visit the 'Fund Node' page in the Sensei admin to get an unused receive address.
- Send 100M sats to your Sensei node via:
nigiri faucet <sensei_fund_address>
- After you open a channel you can mine blocks using nigiri by:
- Getting an address to mine to
nigiri rpc getnewaddress "" "bech32"
- Mine some blocks to that address
nigiri rpc generatetoaddress 10 "<address_from_previous_command>"
- Getting an address to mine to
Other Development Notes
Currently the on-chain wallet is only sycned once every 30 seconds in the background. This means after you fund your wallet or open channels it can take up to 30 seconds for the changes to be reflected in Sensei admin. You'll also need to navigate or refresh the page.
I'm hoping to fix this asap.
Data directory
You can pass a custom data directory using --data_dir flag but the default will be a .sensei
directory in your operating systems home directory.
Home directory is retrieved using the dirs crate.
Platform | Value | Example |
---|---|---|
Linux | $HOME |
/home/alice/.sensei |
macOS | $HOME |
/Users/Alice/.sensei |
Windows | {FOLDERID_Profile} |
C:\Users\Alice.sensei |
Linux and macOS:
- Use
$HOME
if it is set and not empty. - If
$HOME
is not set or empty, then the functiongetpwuid_r
is used to determine the home directory of the current user. - If
getpwuid_r
lacks an entry for the current user id or the home directory field is empty, then the function returnsNone
.
Windows:
This function retrieves the user profile folder using SHGetKnownFolderPath
.
Configuration Files
Sensei will create a root config.json
file inside the data directory. These are configurations that will be applied across all networks.
Sensei will also create subdirectories for each network (e.g. mainnet, testnet, regtest) that you instantiate the daemon with. Each network subdirectory will have it's own config.json
file.
Sensei will merge the network specific configuration into the root configuration to create the final configuration.
This means any configuration set at the network level will override configuration at the root level.
Command Line Args & Environment Variables
Some of the configuration options can be set using command line arguments or environment variables.
These will have the highest precedence and overwrite the network specific configuration.
instance > network > root
Documentation
Please visit the documentation website for installation and getting started instructions.
Community
Please join our discord community to discuss anything related to this project.