@lightprotocol/compressed-token 0.1.0 → 0.1.2

package/README.md

@@ -1,63 +1,85 @@
-js client to interact with the compressed-token program
-
-WIP.
-
-### Requirements
-
-reproduced on mac m2:
-
--   node: v20.9.0
--   rustup 1.26.0, rustc 1.73.0, cargo 1.73.0
--   solana-cli 1.17.5
-
-## Producing events for indexing
-
-First, activate the devenv
-
-`. ./scripts/devenv.sh`
-
-If you're new, run
-
-`./scripts/install.sh`
-
-Run the monorepo build script
-`./scripts/build.sh`
-
-Go to stateless.js
-`cd js/stateless.js`
-
-and run
-`pnpm run test-validator`
-
-this starts a solana-test-validator + auto-initialized the env, programs, and accounts Light needs.
-It should print: "Executing command solana-test-validator...
-Waiting for fees to stabilize 1..."
-Keep the validator running.
-
-Now open another terminal, activate the devenv again + move to js/compressed-token.
-
-now run:
-
-`pnpm emit-event:create_mint`
-`pnpm emit-event:mint_to`
-`pnpm emit-event:transfer`
-
-You'll be able to index the emitted events (output utxos) according to the event rust struct on localnet. Create mint doesn't create an output utxo, mint_to doesn't use input_utxos. also note that currently we're creating mock inputs for the transfer, meaning you don't need to run mint_to before transfer.
-
-### Troubleshooting
-
-If you're having trouble building the project or cli,
-
--   Nuke git clean -xfd (careful)
-
--   re-run install.sh etc
-
--   you may want to manually build the programs (anchor build)
-    or manually build the cli (`pnpm run build` in ./cli) before running
-    `./cli/test_bin/run test-validator`
-
-### Other side notes
-
-1. This is unsafe. We don't verify ZKPs yet, nor do we validate tree roots.
-2. this is also what allows us to make up input-utxos for emit-event:transfer
-3. on-chain runs a sumcheck on the state transition (outputs, inputs).
+# TS client for Interacting with the Compressed-Token Program
+
+Use this to interact with the compressed-token program on Solana via the
+Compression RPC API.
+
+### Installation
+
+**For use in Node.js or a web application**
+
+```bash
+npm install --save \
+    @lightprotocol/compressed-token \
+    @lightprotocol/stateless.js \
+    @solana/web3.js \
+    @coral-xyz/anchor
+```
+
+### Documentation and examples
+
+-   [Latest Source code](https://github.com/lightprotocol/lightprotocol/tree/main/js/compressed-token)
+-   Documentation and examples will be linked here soon!
+
+### Getting help
+
+Have a question or a problem?
+Check out the [Light](https://discord.gg/CYvjBgzRFP) and [Helius](https://discord.gg/Uzzf6a7zKr) 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](https://github.com/lightprotocol) as a part of the Light Protocol.
+
+The ZK Compression RPC API and its indexer implementation is maintained by
+[Helius Labs](https://github.com/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](https://github.com/lightprotocol/lightprotocol/issues/new).
+
+If you found a security vulnerability, please follow the [security policy](https://github.com/Lightprotocol/light-protocol/blob/main/SECURITY.md).
+
+### 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.