zcash_script

Rust bindings to the ECC's zcash_script C++ library.

Developing

This crate works by manually including the zcash_script .h and .cpp files, using bindgen to generate Rust bindings, and compiling everything together into a single library. Due to the way the zcash_script is written we unfortunately need to include a lot of other stuff e.g. the orchard library.

Note that zcash_script (the C++ library/folder inside zcash) uses some Rust FFI functions from zcash; and it also links to librustzcash which is written in Rust. Therefore, when updating zcash_script (this crate), we need to make sure that shared dependencies between all of those are the same versions (and are patched to the same revisions, if applicable). To do that, check for versions in:

• zcash/Cargo.toml in the revision pointed to by this crate (also check for patches)
• librustzcash/Cargo.toml in the revision pointed to by zcash (also check for patches)
• librustzcash/<crate>/Cargo.toml in the revision pointed to by zcash

Cloning and checking out depend/zcash

Clone this repository using:

git clone --recurse-submodules

Or if you've already cloned:

git submodule update --init

To pull the latest version, use:

git pull --recurse-submodules

Updating depend/zcash

If you need to change the submodule's base branch:

git config -f .gitmodules submodule.depend/zcash.branch <branch-name>

To pull in recent changes from the upstream repo:

git submodule update --remote

To use a specific commit:

cd depend/zcash
git checkout <commit-hash>

Publishing New Releases

Releases for zcash-script are made with the help of cargo release.

Checklist:

• create a new branch batch the release commits into a PR
• update CHANGELOG.md to document any major changes since the last release
• open a PR to merge your branch into master
• locally run cargo release -- <level> where level can be patch, minor, or major (source)

NOTE: It's important to specify the level when using cargo release because of the way it implements the substitutions. We specify a number of automatic substitutions in Cargo.toml but they will only be applied if cargo release also handles incrementing the version itself, do not increment the version by hand and then run cargo release or cargo release -- release, or it will not correctly update all version references in the codebase.