lukechilds
/
sensei
mirror of https://github.com/lukechilds/sensei.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10 Commits
4 Branches
6 Tags
1.3 MiB
 
 
 
 
Tree: 92e3e6f11e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '92e3e6f11e'
${ noResults }
John Cantrell 92e3e6f11e
update development instructions in readme 		3 years ago
proto first public commit 3 years ago
src relicense to dual mit and apache license, add license header to rust src 3 years ago
web-admin add run from source instructions, minor admin url tweaks 3 years ago
.gitignore remove .DS_store from git and add to .gitignore 3 years ago
Cargo.lock use bundled feature of rusqlite 3 years ago
Cargo.toml use bundled feature of rusqlite 3 years ago
LICENSE-APACHE relicense to dual mit and apache license, add license header to rust src 3 years ago
LICENSE-MIT relicense to dual mit and apache license, add license header to rust src 3 years ago
LICENSE.md relicense to dual mit and apache license, add license header to rust src 3 years ago
README.md update development instructions in readme 3 years ago
build.rs relicense to dual mit and apache license, add license header to rust src 3 years ago

README.md

Sensei Logo

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.

Running from source

To run from source you will need to take the following steps:

  1. Clone the repo: git clone git@github.com:L2-Technology/sensei.git
  2. Build the web-admin: cd sensei/web-admin && npm install && npm run build && cd ..
  3. Run senseid on regtest: cargo run --bin senseid -- --network=regtest
  4. Open the admin at http://localhost:5401/admin/nodes

Developing the web-admin

In order to see your changes live you will need to:

  1. Run the web-admin dev server: cd sensei/web-admin && npm install && npm run start
  2. 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:

  1. Visit the 'Fund Node' page in the Sensei admin to get an unused receive address.
  2. Send 100M sats to your Sensei node via: nigiri faucet <sensei_fund_address>
  3. 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>"

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.

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.