Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixes for Readme and permmisions #8

Merged
merged 2 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
247 changes: 0 additions & 247 deletions fetch-params.sh

This file was deleted.

Empty file modified zcutil/fetch-params.sh
100644 → 100755
Empty file.