This project is designed for two things:
- Provide language bindings for the zcash rust library, in the
rust
directory. - Packaging for common dependency managers within those language eco systems.
Currently implemented is building for apple platforms as an xcframework
and for distribution via Swift Package Manager.
Add the package as a dependency
dependencies: [
.package(url: "https://github.com/Electric-Coin-Company/zcash-light-client-ffi", from: "0.1.2")
// other dependencies
]
and reference it as product in the target that it will be used
targets: [
.target(
name: "MyTarget",
dependencies: [
.product(name: "libzcashlc", package: "zcash-light-client-ffi")
],
Most of the building is done with the rust compiler, and depending on the target will need different toolchains. To install these you will need to install rustup
. Once this is installed, the rest of the dependencies can be installed by running make install
.
Currently the only build product that is supported. This can be built with make xcframework
and the result will be in releases/XCFramework/libzcashlc.xcframework
.
Depending on what state the intermediate build products might be in, you may first want to do make clean
to do a clean build.
- Build the framework as described above.
- Commit the result.
- Tag this commit with the new release version, (following semantic versioning).
- Push the commit and tag to the remote repository.
Licensed under MIT license (LICENSE or http://opensource.org/licenses/MIT).