@lightprotocol/stateless.js 0.14.4 → 0.15.1

package/README.md

@@ -2,10 +2,10 @@
   <img src="https://github.com/ldiego08/light-protocol/raw/main/assets/logo.svg" width="90" />
 </p>
 
-<h1 align="center">Stateless.js</h1>
+<h1 align="center">@lightprotocol/stateless.js</h1>
 
 <p align="center">
-  <b>Integrate server and web applications with ZK Compression on Solana.</b>
+  <b>This is the JavaScript SDK for building Solana applications with ZK Compression for Node and web.</b>
 </p>
 
 <p align="center">
@@ -16,14 +16,6 @@
   <img src="https://img.shields.io/npm/dw/%40lightprotocol%2Fstateless.js" alt="package weekly downloads" height="18" />
 </p>
 
-## Overview
-
-This package provides server and web applications with clients, utilities, and types to leverage the power of [ZK Compression](https://www.zkcompression.com/) on Solana via the Compression RPC API.
-
-> The core ZK Compression Solana programs and clients are maintained by
-> [Light](https://github.com/lightprotocol) as a part of the Light Protocol. The RPC API and indexer are maintained by
-> [Helius Labs](https://github.com/helius-labs).
-
 ## Usage
 
 ### Installation
@@ -31,22 +23,14 @@ This package provides server and web applications with clients, utilities, and t
 Install this package in your project by running the following terminal command:
 
 ```bin
-npm install --save \
-    @lightprotocol/stateless.js \
-    @solana/web3.js \
-    @coral-xyz/anchor@0.29
+npm install --save @lightprotocol/stateless.js
 ```
 
-### Dependencies
-
--   [`@solana/web3.js`](https://www.npmjs.com/package/@solana/web3.js) — provides access to the Solana network via RPC.
--   [`@coral-xyz/anchor`](https://www.npmjs.com/package/@coral-xyz/anchor) — a client for [Anchor](https://www.anchor-lang.com/) Solana programs.
-
 ## Documentation and Examples
 
 For a more detailed documentation on usage, please check [the respective section at the ZK Compression documentation.](https://www.zkcompression.com/developers/typescript-client)
 
-For example implementations, including web and server, refer to the respective repositories:
+For example implementations, including web and Node, refer to the respective repositories:
 
 -   [Web application example implementation](https://github.com/Lightprotocol/example-web-client)
 
@@ -55,7 +39,7 @@ For example implementations, including web and server, refer to the respective r
 ## Troubleshooting
 
 Have a question or a problem?
-Feel free to ask in the [Light](https://discord.gg/CYvjBgzRFP) and [Helius](https://discord.gg/Uzzf6a7zKr) developer Discord servers. Please, include the following information to better be able to respond:
+Feel free to ask in the [Light](https://discord.gg/CYvjBgzRFP) and [Helius](https://discord.gg/Uzzf6a7zKr) developer Discord servers. Please, include the following information:
 
 -   A detailed description or context of the issue or what you are trying to achieve.
 -   A code example that we can use to test and debug (if possible). Use [CodeSandbox](https://codesandbox.io/p/sandbox/vanilla-ts) or any other live environment provider.

package/dist/cjs/browser/index.cjs

@@ -11727,128 +11727,23 @@ const IDL = {
     errors: [
         {
             code: 6000,
-            name: 'PublicKeyAmountMissmatch',
-            msg: 'public keys and amounts must be of same length',
+            name: 'SignerCheckFailed',
+            msg: 'Signer check failed',
         },
         {
             code: 6001,
-            name: 'ComputeInputSumFailed',
-            msg: 'ComputeInputSumFailed',
+            name: 'CreateTransferInstructionFailed',
+            msg: 'Create transfer instruction failed',
         },
         {
             code: 6002,
-            name: 'ComputeOutputSumFailed',
-            msg: 'ComputeOutputSumFailed',
+            name: 'AccountNotFound',
+            msg: 'Account not found',
         },
         {
             code: 6003,
-            name: 'ComputeCompressSumFailed',
-            msg: 'ComputeCompressSumFailed',
-        },
-        {
-            code: 6004,
-            name: 'ComputeDecompressSumFailed',
-            msg: 'ComputeDecompressSumFailed',
-        },
-        {
-            code: 6005,
-            name: 'SumCheckFailed',
-            msg: 'SumCheckFailed',
-        },
-        {
-            code: 6006,
-            name: 'DecompressRecipientUndefinedForDecompress',
-            msg: 'DecompressRecipientUndefinedForDecompress',
-        },
-        {
-            code: 6007,
-            name: 'CompressedPdaUndefinedForDecompress',
-            msg: 'CompressedPdaUndefinedForDecompress',
-        },
-        {
-            code: 6008,
-            name: 'DeCompressAmountUndefinedForDecompress',
-            msg: 'DeCompressAmountUndefinedForDecompress',
-        },
-        {
-            code: 6009,
-            name: 'CompressedPdaUndefinedForCompress',
-            msg: 'CompressedPdaUndefinedForCompress',
-        },
-        {
-            code: 6010,
-            name: 'DeCompressAmountUndefinedForCompress',
-            msg: 'DeCompressAmountUndefinedForCompress',
-        },
-        {
-            code: 6011,
-            name: 'DelegateSignerCheckFailed',
-            msg: 'DelegateSignerCheckFailed',
-        },
-        {
-            code: 6012,
-            name: 'MintTooLarge',
-            msg: 'Minted amount greater than u64::MAX',
-        },
-        {
-            code: 6013,
-            name: 'SplTokenSupplyMismatch',
-            msg: 'SplTokenSupplyMismatch',
-        },
-        {
-            code: 6014,
-            name: 'HeapMemoryCheckFailed',
-            msg: 'HeapMemoryCheckFailed',
-        },
-        {
-            code: 6015,
-            name: 'InstructionNotCallable',
-            msg: 'The instruction is not callable',
-        },
-        {
-            code: 6016,
-            name: 'ArithmeticUnderflow',
-            msg: 'ArithmeticUnderflow',
-        },
-        {
-            code: 6017,
-            name: 'HashToFieldError',
-            msg: 'HashToFieldError',
-        },
-        {
-            code: 6018,
-            name: 'InvalidAuthorityMint',
-            msg: 'Expected the authority to be also a mint authority',
-        },
-        {
-            code: 6019,
-            name: 'InvalidFreezeAuthority',
-            msg: 'Provided authority is not the freeze authority',
-        },
-        {
-            code: 6020,
-            name: 'InvalidDelegateIndex',
-        },
-        {
-            code: 6021,
-            name: 'TokenPoolPdaUndefined',
-        },
-        {
-            code: 6022,
-            name: 'IsTokenPoolPda',
-            msg: 'Compress or decompress recipient is the same account as the token pool pda.',
-        },
-        {
-            code: 6023,
-            name: 'InvalidTokenPoolPda',
-        },
-        {
-            code: 6024,
-            name: 'NoInputTokenAccountsProvided',
-        },
-        {
-            code: 6025,
-            name: 'NoInputsProvided',
+            name: 'SerializationError',
+            msg: 'Serialization error',
         },
     ],
 };
@@ -12637,6 +12532,10 @@ const TokenBalanceListResult = type({
     tokenBalances: array(TokenBalanceResult),
     cursor: nullable(string()),
 });
+const TokenBalanceListResultV2 = type({
+    items: array(TokenBalanceResult),
+    cursor: nullable(string()),
+});
 const CompressedMintTokenHoldersResult = type({
     cursor: nullable(string()),
     items: array(type({
@@ -13094,8 +12993,10 @@ class Rpc extends web3_js.Connection {
         return { amount: bn(res.result.value.amount) };
     }
     /**
+     * @deprecated use {@link getCompressedTokenBalancesByOwnerV2} instead.
+     *
      * Fetch all the compressed token balances owned by the specified public
-     * key. Can filter by mint
+     * key. Can filter by mint. Returns without context.
      */
     async getCompressedTokenBalancesByOwner(owner, options) {
         var _a, _b;
@@ -13122,6 +13023,38 @@ class Rpc extends web3_js.Connection {
             cursor: res.result.value.cursor,
         };
     }
+    /**
+     * Fetch the compressed token balances owned by the specified public
+     * key. Paginated. Can filter by mint. Returns with context.
+     */
+    async getCompressedTokenBalancesByOwnerV2(owner, options) {
+        var _a, _b;
+        if (!options)
+            options = {};
+        const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getCompressedTokenBalancesByOwnerV2', {
+            owner: owner.toBase58(),
+            mint: (_a = options.mint) === null || _a === void 0 ? void 0 : _a.toBase58(),
+            limit: (_b = options.limit) === null || _b === void 0 ? void 0 : _b.toNumber(),
+            cursor: options.cursor,
+        });
+        const res = create(unsafeRes, jsonRpcResultAndContext(TokenBalanceListResultV2));
+        if ('error' in res) {
+            throw new web3_js.SolanaJSONRPCError(res.error, `failed to get compressed token balances for owner ${owner.toBase58()}`);
+        }
+        if (res.result.value === null) {
+            throw new Error(`failed to get compressed token balances for owner ${owner.toBase58()}`);
+        }
+        const maybeFiltered = options.mint
+            ? res.result.value.items.filter(tokenBalance => tokenBalance.mint.toBase58() === options.mint.toBase58())
+            : res.result.value.items;
+        return {
+            context: res.result.context,
+            value: {
+                items: maybeFiltered,
+                cursor: res.result.value.cursor,
+            },
+        };
+    }
     /**
      * Returns confirmed compression signatures for transactions involving the specified
      * account hash forward in time from genesis to the most recent confirmed
@@ -13191,8 +13124,13 @@ class Rpc extends web3_js.Connection {
      *
      * @param address queried compressed account address
      */
-    async getCompressionSignaturesForAddress(address) {
-        const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getCompressionSignaturesForAddress', { address: address.toBase58() });
+    async getCompressionSignaturesForAddress(address, options) {
+        var _a;
+        const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getCompressionSignaturesForAddress', {
+            address: address.toBase58(),
+            cursor: options === null || options === void 0 ? void 0 : options.cursor,
+            limit: (_a = options === null || options === void 0 ? void 0 : options.limit) === null || _a === void 0 ? void 0 : _a.toNumber(),
+        });
         const res = create(unsafeRes, jsonRpcResultAndContext(SignatureListWithCursorResult));
         if ('error' in res) {
             throw new web3_js.SolanaJSONRPCError(res.error, `failed to get signatures for address ${address.toBase58()}`);
@@ -13209,8 +13147,13 @@ class Rpc extends web3_js.Connection {
      *
      * @param owner queried owner public key
      */
-    async getCompressionSignaturesForOwner(owner) {
-        const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getCompressionSignaturesForOwner', { owner: owner.toBase58() });
+    async getCompressionSignaturesForOwner(owner, options) {
+        var _a;
+        const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getCompressionSignaturesForOwner', {
+            owner: owner.toBase58(),
+            cursor: options === null || options === void 0 ? void 0 : options.cursor,
+            limit: (_a = options === null || options === void 0 ? void 0 : options.limit) === null || _a === void 0 ? void 0 : _a.toNumber(),
+        });
         const res = create(unsafeRes, jsonRpcResultAndContext(SignatureListWithCursorResult));
         if ('error' in res) {
             throw new web3_js.SolanaJSONRPCError(res.error, `failed to get signatures for owner ${owner.toBase58()}`);
@@ -13220,14 +13163,18 @@ class Rpc extends web3_js.Connection {
         }
         return res.result.value;
     }
-    /// TODO(photon): needs mint
     /**
      * Returns confirmed signatures for compression transactions involving the
      * specified token account owner forward in time from genesis to the most
      * recent confirmed block
      */
-    async getCompressionSignaturesForTokenOwner(owner) {
-        const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getCompressionSignaturesForTokenOwner', { owner: owner.toBase58() });
+    async getCompressionSignaturesForTokenOwner(owner, options) {
+        var _a;
+        const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getCompressionSignaturesForTokenOwner', {
+            owner: owner.toBase58(),
+            cursor: options === null || options === void 0 ? void 0 : options.cursor,
+            limit: (_a = options === null || options === void 0 ? void 0 : options.limit) === null || _a === void 0 ? void 0 : _a.toNumber(),
+        });
         const res = create(unsafeRes, jsonRpcResultAndContext(SignatureListWithCursorResult));
         if ('error' in res) {
             throw new web3_js.SolanaJSONRPCError(res.error, `failed to get signatures for owner ${owner.toBase58()}`);
@@ -13277,6 +13224,9 @@ class Rpc extends web3_js.Connection {
         }
         return res.result;
     }
+    /**
+     * Fetch all the compressed token holders for a given mint. Paginated.
+     */
     async getCompressedMintTokenHolders(mint, options) {
         var _a;
         const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getCompressedMintTokenHolders', {
@@ -13305,8 +13255,8 @@ class Rpc extends web3_js.Connection {
     /**
      * Fetch all non-voting signatures
      */
-    async getLatestNonVotingSignatures(limit) {
-        const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getLatestNonVotingSignatures', { limit });
+    async getLatestNonVotingSignatures(limit, cursor) {
+        const unsafeRes = await rpcRequest(this.compressionApiEndpoint, 'getLatestNonVotingSignatures', { limit, cursor });
         const res = create(unsafeRes, jsonRpcResultAndContext(LatestNonVotingSignaturesResult));
         if ('error' in res) {
             throw new web3_js.SolanaJSONRPCError(res.error, 'failed to get latest non-voting signatures');
@@ -17218,8 +17168,9 @@ class TestRpc extends web3_js.Connection {
         return { amount: bn(account.parsed.amount) };
     }
     /**
+     * @deprecated use {@link getCompressedTokenBalancesByOwnerV2}.
      * Fetch all the compressed token balances owned by the specified public
-     * key. Can filter by mint
+     * key. Can filter by mint.
      */
     async getCompressedTokenBalancesByOwner(publicKey, options) {
         const accounts = await getCompressedTokenAccountsByOwnerTest(this, publicKey, options.mint);
@@ -17231,6 +17182,23 @@ class TestRpc extends web3_js.Connection {
             cursor: null,
         };
     }
+    /**
+     * Fetch all the compressed token balances owned by the specified public
+     * key. Can filter by mint. Uses context.
+     */
+    async getCompressedTokenBalancesByOwnerV2(publicKey, options) {
+        const accounts = await getCompressedTokenAccountsByOwnerTest(this, publicKey, options.mint);
+        return {
+            context: { slot: 1 },
+            value: {
+                items: accounts.items.map(account => ({
+                    balance: bn(account.parsed.amount),
+                    mint: account.parsed.mint,
+                })),
+                cursor: null,
+            },
+        };
+    }
     /**
      * Returns confirmed signatures for transactions involving the specified
      * account hash forward in time from genesis to the most recent confirmed
@@ -17238,14 +17206,14 @@ class TestRpc extends web3_js.Connection {
      *
      * @param hash queried account hash
      */
-    async getCompressionSignaturesForAccount(hash) {
+    async getCompressionSignaturesForAccount(_hash) {
         throw new Error('getCompressionSignaturesForAccount not implemented in test-rpc');
     }
     /**
      * Fetch a confirmed or finalized transaction from the cluster. Return with
      * CompressionInfo
      */
-    async getTransactionWithCompressionInfo(signature) {
+    async getTransactionWithCompressionInfo(_signature) {
         throw new Error('getCompressedTransaction not implemented in test-rpc');
     }
     /**
@@ -17255,7 +17223,7 @@ class TestRpc extends web3_js.Connection {
      *
      * @param address queried compressed account address
      */
-    async getCompressionSignaturesForAddress(_address) {
+    async getCompressionSignaturesForAddress(_address, _options) {
         throw new Error('getSignaturesForAddress3 not implemented');
     }
     /**
@@ -17265,7 +17233,7 @@ class TestRpc extends web3_js.Connection {
      *
      * @param owner queried owner public key
      */
-    async getCompressionSignaturesForOwner(owner) {
+    async getCompressionSignaturesForOwner(_owner, _options) {
         throw new Error('getSignaturesForOwner not implemented');
     }
     /**
@@ -17273,7 +17241,7 @@ class TestRpc extends web3_js.Connection {
      * specified token account owner forward in time from genesis to the most
      * recent confirmed block
      */
-    async getCompressionSignaturesForTokenOwner(owner) {
+    async getCompressionSignaturesForTokenOwner(_owner, _options) {
         throw new Error('getSignaturesForTokenOwner not implemented');
     }
     /**
@@ -17517,6 +17485,7 @@ exports.SlotResult = SlotResult;
 exports.TRANSACTION_MERKLE_TREE_ROLLOVER_THRESHOLD = TRANSACTION_MERKLE_TREE_ROLLOVER_THRESHOLD;
 exports.TestRpc = TestRpc;
 exports.TokenBalanceListResult = TokenBalanceListResult;
+exports.TokenBalanceListResultV2 = TokenBalanceListResultV2;
 exports.TokenBalanceResult = TokenBalanceResult;
 exports.TokenDataResult = TokenDataResult;
 exports.UTXO_MERGE_MAXIMUM = UTXO_MERGE_MAXIMUM;