Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lnbits/hardware-wallet
Use a world of microcontrollers to contruct your own bitcoin hardware wallet
https://github.com/lnbits/hardware-wallet
Last synced: about 1 month ago
JSON representation
Use a world of microcontrollers to contruct your own bitcoin hardware wallet
- Host: GitHub
- URL: https://github.com/lnbits/hardware-wallet
- Owner: lnbits
- License: mit
- Created: 2022-07-21T21:10:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T05:15:39.000Z (8 months ago)
- Last Synced: 2024-08-03T06:05:10.316Z (4 months ago)
- Language: C
- Size: 6.05 MB
- Stars: 67
- Watchers: 2
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-lnbits - hardware wallet - DIY Bitcoin Hardware Wallet (Uncategorized / Uncategorized)
README
# WALLY, the Bitcoin Hardware Wallet
Check out this [video tutorial](https://www.youtube.com/watch?v=uMg598-3wIk) on the Makerbits channel.
## Flash and configure via webinstaller https://lnbits.github.io/hardware-wallet
Data is sent to/from the **Hardware Wallet** over webdev serial. It is not the most secure data transmission method, but fine for handling small-medium sized amounts of funds or if you need a hardware wallet for a small period of time like e.g. on a vacation.
You can use LNbits OnchainWallet extension, your terminal or any other serial monitor.
### Wally is in BETA, use with TESTNET only, or with an amount of funds you are willing to lose
## What you need
- Lilygo TTGO/Tdisplay or any other ESP32 version
- Optional: a case
=> or get the kit in the [LNbits shop](https://shop.lnbits.com/product-category/hardware/hardware-wallets)
- Data Cable
- Desktop PC and Chrome/Chromium/Brave Browser
- LNbits Onchain Extension
Got questions ? Join us t.me/lnbits, t.me/makerbits
## Manual Install instructions (without webinstaller)
- Buy a Lilygo Tdisplay (although with a little tinkering any ESP32 will do)
- Install Arduino IDE 1.8.19
- Install ESP32 boards, using boards manager
- Download this repo
- Copy these libraries into your Arduino install "libraries" folder
- Open this wallet.ino file in the Arduino IDE
- Select "TTGO-LoRa32-OLED-V1" from tools>board
- Upload to device
## Device Commands
The client (OnchainWallet extension or anyother one) communicates with the device using strings (called commands) of this form:
`/command-name {param1} {param2} ... {paramn}`
- the order of the parametes is relevant (the position gives its meaning)
- if no the value is specified then the minus (`-`) character should be used at the respective position
- eg: `/password my-password-1`
The device (HWW) can respond (not mandatory) with a string of the same form:
- `/command-name {resp1} {resp2} ... {respn}`
The documentation for each command can be found in the linked `.ino` file so you can build on top of it.
- `/ping` [720_ping.ino](https://github.com/lnbits/hardware-wallet/blob/main/wallet/720_ping.ino)
- `/pair` [712_cmd_pair.ino](https://github.com/lnbits/hardware-wallet/blob/main/wallet/712_cmd_pair.ino)
- `/check_pairing` [721_check_pairing.ino](https://github.com/lnbits/hardware-wallet/blob/main/wallet/721_check_pairing.ino)
- `/password` [713_cmd_password_check.ino](https://github.com/lnbits/hardware-wallet/blob/main/wallet/713_cmd_password_check.ino)
- `/password-clear` [714_cmd_password_clear.ino](https://github.com/lnbits/hardware-wallet/blob/main/wallet/714_cmd_password_clear.ino)
- `/restore` [717_cmd_restore.ino](https://github.com/lnbits/hardware-wallet/blob/main/wallet/717_cmd_restore.ino)
- `/wipe` [716_cmd_wipe_hww.ino](https://github.com/lnbits/hardware-wallet/blob/main/wallet/716_cmd_wipe_hww.ino)
- `/psbt` [718_cmd_sign_psbt](https://github.com/lnbits/hardware-wallet/blob/main/wallet/718_cmd_sign_psbt.ino)
- `/seed` [719_show_seed](https://github.com/lnbits/hardware-wallet/blob/main/wallet/719_show_seed.ino)
- `/xpub` [715_cmd_xpub.ino](https://github.com/lnbits/hardware-wallet/blob/main/wallet/715_cmd_xpub.ino)
- `/address` [722_show_address](https://github.com/lnbits/hardware-wallet/blob/main/wallet/722_show_address.ino)
- `/help` [711_cmd_help](https://github.com/lnbits/hardware-wallet/blob/main/wallet/711_cmd_help.ino)
## Run from SD Card (air-gapped)
**Note**: the device is not fully airgapped when other communication mediums are enabled (wifi, bluetooth, serial-port, etc).
In order to run from an SD Card one must:
- mount the SD Card into a computer
- create a file named `commands.in.txt` on the top level directory (no parent directory) of the SD Card
- add the commands to the file. See sample files in [examples/sd-card](https://github.com/lnbits/hardware-wallet/tree/main/examples/sd-card)
- mount the SD Card into the hardware device
- reboot the device. On reboot the device will detect the `commands.in.txt` on the SD Card and will start executing the commands
- wait for the device to complete execution
- mount the SD Card into the computer. Two new files should be present:
- `commands.out.txt` - contains the outputs of the commands. Here you will find the relevant data (like the signed PSBT)
- `commands.log.txt` - contains the logs
## How to use
// Guide to go here
> _Note: If using MacOS, you will need the CP210x USB to UART Bridge VCP Drivers available here https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers_
> If you are using **MacOS Big Sur or an Mac with M1 chip**, you might encounter the issue `A fatal error occurred: Failed to write to target RAM (result was 0107)`, this is related to the chipsest used by TTGO, you can find the correct driver and more info in this GitHub issue
This repo is powered by the uBitcoin library.