@cascade-fyi/compression-kit 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright
+      owner or by an individual or Legal Entity authorized to submit on behalf
+      of the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Cascade Protocol
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,230 @@
+# @cascade-fyi/compression-kit
+
+Solana Kit native implementation of Light Protocol compression. Works in any runtime (browsers, Cloudflare Workers, Deno, Node.js).
+
+> **Status:** Beta
+
+## Features
+
+- **Edge/browser compatible** - No Node.js dependencies, works everywhere
+- **Native bigint** - Uses native bigint instead of BN.js for better performance
+- **Solana Kit types** - Uses `Address` type from `@solana/kit` instead of `PublicKey`
+- **Full Photon RPC** - Complete implementation of Light Protocol's Photon indexer API
+- **Lightweight** - Minimal dependencies (~25KB gzip)
+
+## Install
+
+```bash
+npm install @cascade-fyi/compression-kit
+```
+
+```bash
+pnpm add @cascade-fyi/compression-kit
+```
+
+```bash
+yarn add @cascade-fyi/compression-kit
+```
+
+## Quickstart
+
+```typescript
+import { createPhotonRpc, deriveAddress, deriveAddressSeed } from '@cascade-fyi/compression-kit';
+import { address } from '@solana/kit';
+
+// 1. Create RPC client
+const rpc = createPhotonRpc('https://mainnet.helius-rpc.com/?api-key=YOUR_KEY');
+
+// 2. Query compressed accounts
+const ownerAddress = address('YOUR_WALLET_ADDRESS');
+const accounts = await rpc.getCompressedAccountsByOwner(ownerAddress);
+
+// 3. Derive a compressed account address
+const programId = address('YOUR_PROGRAM_ID');
+const seed = deriveAddressSeed([new TextEncoder().encode('my-seed')], programId);
+const compressedAddress = deriveAddress(seed);
+```
+
+## Common Flows
+
+### Query Compressed Accounts
+
+```typescript
+import { createPhotonRpc } from '@cascade-fyi/compression-kit';
+
+const rpc = createPhotonRpc('https://mainnet.helius-rpc.com/?api-key=YOUR_KEY');
+
+// Get all compressed accounts for an owner
+const accounts = await rpc.getCompressedAccountsByOwner(ownerAddress);
+
+// Get compressed token accounts
+const tokenAccounts = await rpc.getCompressedTokenAccountsByOwner(ownerAddress, {
+  mint: mintAddress,
+});
+
+// Get a specific compressed account by hash
+const account = await rpc.getCompressedAccount(accountHash);
+```
+
+### Derive Addresses (V1 & V2)
+
+```typescript
+import {
+  deriveAddressSeed,
+  deriveAddress,
+  deriveAddressSeedV2,
+  deriveAddressV2,
+  getDefaultAddressTreeInfo,
+} from '@cascade-fyi/compression-kit';
+
+// V1 Address derivation (mainnet)
+const seedV1 = deriveAddressSeed([Buffer.from('my-seed')], programId);
+const addressV1 = deriveAddress(seedV1);
+
+// V2 Address derivation (devnet, more efficient)
+const seedV2 = deriveAddressSeedV2([Buffer.from('my-seed')]);
+const treeInfo = getDefaultAddressTreeInfo();
+const addressV2 = deriveAddressV2(seedV2, treeInfo.tree, programId);
+```
+
+### Get Validity Proofs
+
+```typescript
+import { createPhotonRpc } from '@cascade-fyi/compression-kit';
+
+const rpc = createPhotonRpc('https://mainnet.helius-rpc.com/?api-key=YOUR_KEY');
+
+// Get proof for existing accounts (update/close operations)
+const proof = await rpc.getValidityProof({
+  hashes: [{ hash: accountHash, tree: treeAddress, queue: queueAddress }],
+});
+
+// Get proof for new addresses (create operations)
+const newAddressProof = await rpc.getValidityProof({
+  newAddresses: [{ address: newAddress, tree: addressTree, queue: addressQueue }],
+});
+```
+
+### Build Instruction Accounts
+
+```typescript
+import {
+  PackedAccounts,
+  createSystemAccountConfig,
+  getLightSystemAccountMetas,
+} from '@cascade-fyi/compression-kit';
+
+// Create packed accounts helper
+const packedAccounts = new PackedAccounts();
+
+// Add Light system accounts
+const systemConfig = createSystemAccountConfig(programId);
+packedAccounts.addSystemAccounts(getLightSystemAccountMetas(systemConfig));
+
+// Add tree accounts and get indices
+const treeIndex = packedAccounts.insertOrGet(treeAddress);
+
+// Convert to account metas for instruction
+const { remainingAccounts } = packedAccounts.toAccountMetas();
+```
+
+### BN254 Field Operations
+
+```typescript
+import {
+  createBN254,
+  bn254FromBytes,
+  bn254ToBytes,
+  bn254Add,
+  isSmallerThanFieldSize,
+} from '@cascade-fyi/compression-kit';
+
+// Create field element from bigint
+const element = createBN254(123456789n);
+
+// Convert from/to bytes
+const bytes = bn254ToBytes(element);
+const restored = bn254FromBytes(bytes);
+
+// Field arithmetic
+const sum = bn254Add(element1, element2);
+
+// Validate field size
+if (isSmallerThanFieldSize(someBytes)) {
+  // Safe to use as BN254
+}
+```
+
+## Configuration
+
+### RPC Endpoints
+
+| Network | Endpoint |
+|---------|----------|
+| Mainnet | `https://mainnet.helius-rpc.com/?api-key=YOUR_KEY` |
+| Devnet | `https://devnet.helius-rpc.com/?api-key=YOUR_KEY` |
+| Localnet | `http://localhost:8784` |
+
+### Default Tree Addresses
+
+The package exports default tree addresses for mainnet and devnet:
+
+```typescript
+import {
+  MERKLE_TREE_PUBKEY,      // V1 State tree (mainnet)
+  NULLIFIER_QUEUE_PUBKEY,  // V1 Nullifier queue (mainnet)
+  ADDRESS_TREE,            // V1 Address tree
+  BATCH_MERKLE_TREE_1,     // V2 Batch tree (devnet)
+  defaultTestStateTreeAccounts, // Local testing
+} from '@cascade-fyi/compression-kit';
+```
+
+## API Reference
+
+### RPC Methods
+
+| Method | Description |
+|--------|-------------|
+| `getCompressedAccount(hash)` | Get compressed account by hash |
+| `getCompressedAccountsByOwner(owner)` | Get all compressed accounts for owner |
+| `getCompressedTokenAccountsByOwner(owner, config?)` | Get token accounts for owner |
+| `getCompressedTokenBalancesByOwner(owner)` | Get token balances for owner |
+| `getValidityProof(params)` | Get validity proof for accounts/addresses |
+| `getMultipleCompressedAccounts(hashes)` | Batch fetch multiple accounts |
+| `getCompressionSignaturesForOwner(owner)` | Get compression transaction signatures |
+| `getLatestCompressionSignatures()` | Get recent compression signatures |
+| `getIndexerHealth()` | Check indexer health status |
+| `getIndexerSlot()` | Get current indexer slot |
+
+### Types
+
+| Type | Description |
+|------|-------------|
+| `CompressedAccount` | Compressed account data structure |
+| `TreeInfo` | Merkle tree metadata |
+| `ValidityProof` | ZK validity proof |
+| `BN254` | BN254 field element (branded bigint) |
+| `PackedAccounts` | Helper for building instruction accounts |
+
+### Constants
+
+| Constant | Description |
+|----------|-------------|
+| `LIGHT_SYSTEM_PROGRAM` | Light system program ID |
+| `ACCOUNT_COMPRESSION_PROGRAM` | Account compression program ID |
+| `COMPRESSED_TOKEN_PROGRAM` | Compressed token program ID |
+| `FIELD_SIZE` | BN254 field size |
+
+## Requirements
+
+- Node.js >= 20.18.0
+- TypeScript >= 5.0 (for type definitions)
+
+## Related Packages
+
+- [`@solana/kit`](https://www.npmjs.com/package/@solana/kit) - Solana Kit for modern Solana development
+- [`@lightprotocol/stateless.js`](https://www.npmjs.com/package/@lightprotocol/stateless.js) - Original Light Protocol JS SDK
+
+## License
+
+Apache-2.0