https://github.com/revault/revault-gui

Revault terminal
https://github.com/revault/revault-gui

bitcoin custody gui revault rust

Last synced: 4 days ago
JSON representation

Revault terminal

• Host: GitHub
• URL: https://github.com/revault/revault-gui
• Owner: revault
• License: bsd-3-clause
• Created: 2020-09-16T09:12:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-02T08:57:48.000Z (over 2 years ago)
• Last Synced: 2025-01-30T07:37:56.161Z (13 days ago)
• Topics: bitcoin, custody, gui, revault, rust
• Language: Rust
• Homepage: https://revault.dev
• Size: 2.26 MB
• Stars: 52
• Watchers: 3
• Forks: 9
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-iced - revault-gui - GUI for the [Revault daemon](https://github.com/revault/revaultd), a Bitcoin valut architecture. (Projects Using iced)

README

        
# revault-gui

Revault GUI is an user graphical interface written in rust for the 

[Revault daemon](https://github.com/revault/revaultd).





## Dependencies

- `fontconfig` (On Debian/Ubuntu `apt install libfontconfig1-dev`)

- [`pkg-config`](https://www.freedesktop.org/wiki/Software/pkg-config/) (On Debian/Ubuntu `apt install pkg-config`)

- [`libxkbcommon`](https://xkbcommon.org/) for the dummy signer (On Debian/Ubuntu `apt install libxkbcommon-dev`)

- Vulkan drivers (On Debian/Ubuntu `apt install mesa-vulkan-drivers libvulkan-dev`)

- `libudev-dev` (On Debian/Ubuntu `apt install libudev-dev`)

We are striving to remove dependencies, especially the 3D ones.

## Usage

`revault-gui --datadir  --`

The default `datadir` is the default `revaultd` `datadir` (`~/.revault`

for linux) and the default `network` is the bitcoin mainnet.

If no argument is provided, the GUI checks in the default `datadir` 

the configuration file for the bitcoin mainnet.

If the provided `datadir` is empty or does not have the configuration

file for the targeted `network`, the GUI starts with the installer mode.

Instead of using `--datadir` and `--`, a direct path to

the GUI configuration file can be provided with `--conf`.

After start up, The GUI will connect to the running revaultd.

A command starting revaultd is launched if no connection is made.

## Get started

See [aquarium](https://github.com/revault/aquarium) for trying out a

Revault deployment in no time. 

See [doc/DEMO_TESTNET.md](doc/DEMO_TESTNET.md) for instructions on how

to setup Revault on testnet (more involved and likely needs more

participants).

## Troubleshooting

- If you encounter layout issue on `X11`, try to start the GUI with

  `WINIT_X11_SCALE_FACTOR` manually set to 1