Installation

For use in Node.js or web

npm install --save \
    @lightprotocol/compressed-token \
    @lightprotocol/stateless.js \

Documentation and examples

• Latest Source code
• Creating and sending compressed tokens

Getting help

Have a question or a problem? Check out the Light and Helius Developer Discord servers!

When asking for help, please include:

• A detailed description of what you're trying to achieve
• Source code, if possible
• The text of any errors you encountered, with stacktraces if available

Contributing

The ZK Compression system programs and clients are maintained by Light as a part of the Light Protocol.

The ZK Compression RPC API and its indexer implementation is maintained by Helius Labs.

Light and ZK Compression are open protocols and contributions are welcome. If you have a contribution, please open a PR on the respective repository.

If you found a bug or would like to request a feature, please file an issue.

If you found a security vulnerability, please follow the security policy.

Disclaimer

All claims, content, designs, algorithms, estimates, roadmaps, specifications, and performance measurements described in this project are done with Light Protocol Labs' ("Labs") best efforts. It is up to the reader to check and validate their accuracy and truthfulness. Furthermore nothing in this project constitutes a solicitation for investment.

Any content produced by Labs or developer resources that Labs provides, are for educational and inspiration purposes only. Labs does not encourage, induce or sanction the deployment, integration or use of any such applications (including the code comprising the Light blockchain protocol) in violation of applicable laws or regulations and hereby prohibits any such deployment, integration or use. This includes use of any such applications by the reader (a) in violation of export control or sanctions laws of the United States or any other applicable jurisdiction, (b) if the reader is located in or ordinarily resident in a country or territory subject to comprehensive sanctions administered by the U.S. Office of Foreign Assets Control (OFAC), or (c) if the reader is or is working on behalf of a Specially Designated National (SDN) or a person subject to similar blocking or denied party prohibitions.

The reader should be aware that U.S. export control and sanctions laws prohibit U.S. persons (and other persons that are subject to such laws) from transacting with persons in certain countries and territories or that are on the SDN list. As a project based primarily on open-source software, it is possible that such sanctioned persons may nevertheless bypass prohibitions, obtain the code comprising the Light blockchain protocol (or other project code or applications) and deploy, integrate, or otherwise use it. Accordingly, there is a risk to individuals that other persons using the Light blockchain protocol may be sanctioned persons and that transactions with such persons would be a violation of U.S. export controls and sanctions law. This risk applies to individuals, organizations, and other ecosystem participants that deploy, integrate, or use the Light blockchain protocol code directly (e.g., as a node operator), and individuals that transact on the Light blockchain protocol implementation through clients, other kinds of nodes, third party interfaces, and/or wallet software.