zenith/README.md

70 lines
2.2 KiB
Markdown
Raw Normal View History

2022-06-20 21:46:13 +00:00
# Zenith
```
______ _ _ _
|___ / (_) | | |
/ / ___ _ __ _| |_| |__
/ / / _ \ '_ \| | __| '_ \
/ /_| __/ | | | | |_| | | |
/_____\___|_| |_|_|\__|_| |_|
Zcash Full Node CLI
```
2024-02-12 21:39:41 +00:00
[![Please don't upload to GitHub](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page) ![](https://img.shields.io/badge/License-MIT-green
)
2023-01-22 13:52:11 +00:00
2024-05-09 19:08:49 +00:00
Zenith is a wallet for the [Zebra](https://zfnd.org/zebra/) Zcash node . It has the following features:
2022-06-20 21:46:13 +00:00
2024-05-09 19:08:49 +00:00
- Creating new wallets.
- Creating new accounts.
- Creating new Unified Addresses.
2022-06-20 21:46:13 +00:00
- Listing transactions for specific addresses, decoding memos for easy reading.
- Copying addresses to the clipboard.
- Sending transactions with shielded memo support.
2024-06-02 00:20:38 +00:00
- Address Book for storing frequently used zcash addresses
2022-06-20 21:46:13 +00:00
## Installation
- Install dependencies:
2024-05-09 19:08:49 +00:00
- [Cabal](https://www.haskell.org/cabal/#install-upgrade)
- [Zebra](https://zfnd.org/zebra/)
- [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
- Install `cargo-c`:
```shell
cargo install cargo-c
```
2022-06-20 21:46:13 +00:00
- `xclip`
- `libsecp256k1-dev`
- `libxss-dev`
2023-01-03 20:34:12 +00:00
- `libxrandr-dev`
- Clone the repository.
```bash
git clone https://git.vergara.tech/Vergara_Tech/zenith.git
cd zenith
git submodule init
2024-02-28 21:11:19 +00:00
git submodule update --remote
2023-01-03 20:34:12 +00:00
```
2024-02-28 21:11:19 +00:00
- Install using `cabal`:
2022-06-20 21:46:13 +00:00
```
2024-02-28 21:11:19 +00:00
cabal install
2022-06-20 21:46:13 +00:00
```
## Configuration
2024-05-09 19:08:49 +00:00
- Copy the sample `zenith.cfg` file to your home directory and update the values of your Zebra host and port.
2022-06-20 21:46:13 +00:00
## Usage
2024-05-09 19:08:49 +00:00
**Note:** This is beta software under active development. We recommend to use it on testnet. Zenith runs on the network Zebra is running, to use the testnet you need to configure your Zebra node to run on testnet.
2022-06-20 21:46:13 +00:00
2024-05-09 19:08:49 +00:00
From the location where the configured `zenith.cfg` file is placed, use `zenith cli` to start.
2022-06-20 21:46:13 +00:00
2024-05-09 19:08:49 +00:00
Zenith will attempt to connect to the node and start up, the app will guide you through the creation of the first wallet.
2022-06-20 21:46:13 +00:00
2022-06-27 14:25:36 +00:00
### Support
2022-06-20 21:46:13 +00:00
2024-05-09 19:08:49 +00:00
If you would have any questions or suggestions, please join us on our [Support channel](https://matrix.to/#/#support:vergara.tech)