Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.76 KB

README.md

File metadata and controls

55 lines (36 loc) · 1.76 KB
Raw

zcash-light-client-ffi

This project is designed for two things:

  1. Provide language bindings for the zcash rust library, in the rust directory.
  2. 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.

importing the package

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")
            ],

Building

Pre-requisites

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.

XCFramework

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.

Releasing

Swift Package Manager

  1. Build the framework as described above.
  2. Commit the result.
  3. Tag this commit with the new release version, (following semantic versioning).
  4. Push the commit and tag to the remote repository.

License

Licensed under MIT license (LICENSE or http://opensource.org/licenses/MIT).