Skip to content

Commit

Permalink
updated readme and permmissions
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulLaux committed Nov 26, 2024
1 parent 40a1723 commit c735391
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ This repository includes a simple Zebra Docker image that incorporates the Orcha
- **ZSA Support**: Work with Zcash Shielded Assets (Orchard ZSA).
- **Version Compatibility**: Supports transaction versions V5 and V6.

## Supported systems
- Tested on Ubuntu 22.04 LTS but should work on any Linux distribution that support the Prerequisites.

## Core Components

1. **[librustzcash](https://github.com/zcash/librustzcash)**: Used for transaction creation and serialization. This version includes slight modifications for additional functionality.
Expand All @@ -38,6 +41,12 @@ This repository includes a simple Zebra Docker image that incorporates the Orcha
- **Docker**: [Install Docker](https://www.docker.com/get-started)
- **Rust & Cargo**: [Install Rust and Cargo](https://www.rust-lang.org/tools/install)
- **Diesel CLI**: Installed via Cargo.
- **Linux Dev tools**:
```bash
sudo apt update

sudo apt install pkg-config libssl-dev libsqlite3-dev
```

## Getting Started

Expand All @@ -46,10 +55,10 @@ This repository includes a simple Zebra Docker image that incorporates the Orcha
Open a terminal and execute the following commands:

```bash
# Build the Docker image
# Build the Zebra Docker image
docker build -t qedit/zebra-regtest-txv6 .

# Run the Docker container
# Run the Zebra Docker container
docker run -p 18232:18232 qedit/zebra-regtest-txv6
```

Expand All @@ -59,16 +68,19 @@ For more details on how the Docker image is created and synchronized, refer to t

In a separate terminal window, perform the following steps:

#### One-Time Diesel Setup
#### One-Time Setup

Install Diesel CLI and set up the database:
Install Diesel CLI and set up the database and get Zcash Params for Sapling:

```bash
# Install Diesel CLI with SQLite support
cargo install diesel_cli --no-default-features --features sqlite

# Set up the database
diesel setup

# Get Zcash Params for Sapling (if needed)
./zcutil/fetch-params.sh
```

#### Build and Run the Orchard ZSA Test Case
Expand Down
Empty file modified zcutil/fetch-params.sh
100644 → 100755
Empty file.

0 comments on commit c735391

Please sign in to comment.