Skip to content

A fully-featured javascript/typescript library for interacting with the Zcash network from the browser

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

ChainSafe/WebZjs

Repository files navigation

WebZjs

GitHub License

A javascript client library for building Zcash browser wallets

Overview

WebZjs aims to make it simple to securely interact with Zcash from within the browser. This is primarily to support the development of web wallets and browser plugins.

Being a private blockchain Zcash places a lot more demands on the wallet than a public blockchain like Ethereum. WebZjs uses everything at its disposal to give efficient sync times and a good user experience.

Usage

// TODO

Building

Prerequisites

  • This repo uses just as a command runner. Please install this first.
  • Install wasm-pack
  • Requires clang 17 or later
    • On Mac this can be installed by updating LLVM using your preferred package manager (e.g. macports, brew)
  • Tested with Rust nightly-2024-08-07

Building for Browser

This just script uses wasm-pack to build a web-ready javascript library.

just build-web

After building the resulting lib can be found in packages/webz-core.

Development

The .cargo/config.toml file sets the build target to wasm32-unknown-unknown so the regular cargo commands (e.g. check, build) will run against this target.

Testing

Tests are run in a headless browser environment and can be run with

just test-web

Security Warnings

These libraries are currently under development, have received no reviews or audit, and come with no guarantees whatsoever.

License

All code in this workspace is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

A fully-featured javascript/typescript library for interacting with the Zcash network from the browser

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published