@lightprotocol/stateless.js 0.21.0 → 0.22.0

package/dist/cjs/node/test-helpers/test-rpc/get-compressed-accounts.d.ts

@@ -1,16 +1,7 @@
 import { PublicKey } from '@solana/web3.js';
 import BN from 'bn.js';
 import { Rpc } from '../../rpc';
-import { CompressedAccountWithMerkleContext, StateTreeInfo } from '../../state';
-/**
- * Get the info for a given tree or queue
- *
- * @param info          The active state tree addresses
- * @param treeOrQueue   The tree or queue to get the info for
- * @returns The info for the given tree or queue, or throws an error if not
- * found
- */
-export declare function getStateTreeInfoByPubkey(treeInfos: StateTreeInfo[], treeOrQueue: PublicKey): StateTreeInfo;
+import { CompressedAccountWithMerkleContext } from '../../state';
 export declare function getCompressedAccountsByOwnerTest(rpc: Rpc, owner: PublicKey): Promise<CompressedAccountWithMerkleContext[]>;
 export declare function getCompressedAccountByHashTest(rpc: Rpc, hash: BN): Promise<CompressedAccountWithMerkleContext | undefined>;
 export declare function getMultipleCompressedAccountsByHashTest(rpc: Rpc, hashes: BN[]): Promise<CompressedAccountWithMerkleContext[]>;

package/dist/cjs/node/test-helpers/test-rpc/get-compressed-token-accounts.d.ts

@@ -2,7 +2,7 @@ import { PublicKey } from '@solana/web3.js';
 import BN from 'bn.js';
 import { Rpc } from '../../rpc';
 import { ParsedTokenAccount, WithCursor } from '../../rpc-interface';
-import { CompressedAccount, PublicTransactionEvent } from '../../state';
+import { PublicTransactionEvent, CompressedAccountLegacy } from '../../state';
 import { Layout } from '@coral-xyz/borsh';
 type TokenData = {
     mint: PublicKey;
@@ -22,7 +22,7 @@ export type EventWithParsedTokenTlvData = {
  * @param compressedAccount - The compressed account
  * @returns The parsed token data
  */
-export declare function parseTokenLayoutWithIdl(compressedAccount: CompressedAccount, programId?: PublicKey): TokenData | null;
+export declare function parseTokenLayoutWithIdl(compressedAccount: CompressedAccountLegacy, programId?: PublicKey): TokenData | null;
 /**
  * Retrieves all compressed token accounts for a given mint and owner.
  *

package/dist/cjs/node/test-helpers/test-rpc/test-rpc.d.ts

@@ -4,17 +4,8 @@ import { AddressWithTree, CompressedMintTokenHolders, CompressedTransaction, Get
 import { ValidityProofWithContext, CompressionApiInterface, GetCompressedTokenAccountsByOwnerOrDelegateOptions, ParsedTokenAccount, TokenBalance } from '../../rpc-interface';
 import { BN254, CompressedAccountWithMerkleContext, MerkleContextWithMerkleProof } from '../../state';
 import { MerkleContextWithNewAddressProof } from '../../rpc';
-import { StateTreeInfo } from '../../state/types';
+import { TreeInfo } from '../../state/types';
 export interface TestRpcConfig {
-    /**
-     * Address of the state tree to index. Default: public default test state
-     * tree.
-     */
-    merkleTreeAddress?: PublicKey;
-    /**
-     * Nullifier queue associated with merkleTreeAddress
-     */
-    nullifierQueueAddress?: PublicKey;
     /**
      * Depth of state tree. Defaults to the public default test state tree depth
      */
@@ -23,15 +14,6 @@ export interface TestRpcConfig {
      * Log proof generation time
      */
     log?: boolean;
-    /**
-     * Address of the address tree to index. Default: public default test
-     * address tree.
-     */
-    addressTreeAddress?: PublicKey;
-    /**
-     * Address queue associated with addressTreeAddress
-     */
-    addressQueueAddress?: PublicKey;
 }
 export type ClientSubscriptionId = number;
 export interface LightWasm {
@@ -57,13 +39,13 @@ export interface LightWasm {
  */
 export declare function getTestRpc(lightWasm: LightWasm, endpoint?: string, compressionApiEndpoint?: string, proverEndpoint?: string, depth?: number, log?: boolean): Promise<TestRpc>;
 /**
- * Simple mock rpc for unit tests that simulates the compression rpc interface.
- * Fetches, parses events and builds merkletree on-demand, i.e. it does not persist state.
+ * Mock RPC for unit tests that simulates the ZK Compression RPC interface.
+ * Parses events and builds merkletree on-demand. It does not persist state.
  * Constraints:
- * - Can only index 1 merkletree
  * - Can only index up to 1000 transactions
  *
- * For advanced testing use photon: https://github.com/helius-labs/photon
+ * For advanced testing use `Rpc` class which uses photon:
+ * https://github.com/helius-labs/photon
  */
 export declare class TestRpc extends Connection implements CompressionApiInterface {
     compressionApiEndpoint: string;
@@ -71,9 +53,9 @@ export declare class TestRpc extends Connection implements CompressionApiInterfa
     lightWasm: LightWasm;
     depth: number;
     log: boolean;
-    allStateTreeInfos: StateTreeInfo[] | null;
+    allStateTreeInfos: TreeInfo[] | null;
     lastStateTreeFetchTime: number | null;
-    fetchPromise: Promise<StateTreeInfo[]> | null;
+    fetchPromise: Promise<TreeInfo[]> | null;
     CACHE_TTL: number;
     /**
      * Establish a Compression-compatible JSON RPC mock-connection
@@ -88,6 +70,10 @@ export declare class TestRpc extends Connection implements CompressionApiInterfa
      * @param testRpcConfig             Config for the mock rpc
      */
     constructor(endpoint: string, hasher: LightWasm, compressionApiEndpoint: string, proverEndpoint: string, connectionConfig?: ConnectionConfig, testRpcConfig?: TestRpcConfig);
+    /**
+     * @deprecated Use {@link getStateTreeInfos} instead
+     */
+    getCachedActiveStateTreeInfo(): Promise<void>;
     /**
      * @deprecated Use {@link getStateTreeInfos} instead
      */
@@ -95,8 +81,8 @@ export declare class TestRpc extends Connection implements CompressionApiInterfa
     /**
      * Returns local test state trees.
      */
-    getStateTreeInfos(): Promise<StateTreeInfo[]>;
-    doFetch(): Promise<StateTreeInfo[]>;
+    getStateTreeInfos(): Promise<TreeInfo[]>;
+    doFetch(): Promise<TreeInfo[]>;
     /**
      * Fetch the compressed account for the specified account hash
      */
@@ -184,7 +170,7 @@ export declare class TestRpc extends Connection implements CompressionApiInterfa
      * Fetch a confirmed or finalized transaction from the cluster. Return with
      * CompressionInfo
      */
-    getTransactionWithCompressionInfo(_signature: string): Promise<CompressedTransaction | null>;
+    getTransactionWithCompressionInfo(_signature: string): Promise<CompressedTransaction>;
     /**
      * Returns confirmed signatures for transactions involving the specified
      * address forward in time from genesis to the most recent confirmed
@@ -225,16 +211,6 @@ export declare class TestRpc extends Connection implements CompressionApiInterfa
      */
     getMultipleNewAddressProofs(addresses: BN254[]): Promise<MerkleContextWithNewAddressProof[]>;
     getCompressedMintTokenHolders(_mint: PublicKey, _options?: PaginatedOptions): Promise<WithContext<WithCursor<CompressedMintTokenHolders[]>>>;
-    /**
-     * Advanced usage of getValidityProof: fetches ZKP directly from a custom
-     * non-rpcprover. Note: This uses the proverEndpoint specified in the
-     * constructor. For normal usage, please use {@link getValidityProof}
-     * instead.
-     *
-     * Note: Use RPC class for forested trees. TestRpc is only for custom
-     * testing purposes.
-     */
-    getValidityProofDirect(hashes?: BN254[], newAddresses?: BN254[]): Promise<ValidityProofWithContext>;
     /**
      * @deprecated This method is not available for TestRpc. Please use
      * {@link getValidityProof} instead.

package/dist/cjs/node/utils/calculate-compute-unit-price.d.ts

@@ -2,6 +2,6 @@
  * @param targetLamports - Target priority fee in lamports
  * @param computeUnits - Expected compute units used by the transaction
  * @returns microLamports per compute unit (use in
- * `ComputeBudgetProgram.setComputeUnitPrice`)
+ * {@link https://github.com/solana-foundation/solana-web3.js/blob/maintenance/v1.x/src/programs/compute-budget.ts#L218})
  */
 export declare function calculateComputeUnitPrice(targetLamports: number, computeUnits: number): number;

package/dist/cjs/node/utils/conversion.d.ts

@@ -1,6 +1,7 @@
 import { Buffer } from 'buffer';
 import { Keypair } from '@solana/web3.js';
 import BN from 'bn.js';
+import { InstructionDataInvoke } from '../state';
 export declare function byteArrayToKeypair(byteArray: number[]): Keypair;
 /**
  * @internal
@@ -31,3 +32,4 @@ export declare function hashToBn254FieldSizeBe(bytes: Buffer): [Buffer, number]
 export declare function hashvToBn254FieldSizeBe(bytes: Uint8Array[]): Uint8Array;
 /** Mutates array in place */
 export declare function pushUniqueItems<T>(items: T[], map: T[]): void;
+export declare function convertInvokeCpiWithReadOnlyToInvoke(data: any): InstructionDataInvoke;

package/dist/cjs/node/utils/get-state-tree-infos.d.ts

@@ -1,6 +1,11 @@
 import { Connection, PublicKey } from '@solana/web3.js';
-import { StateTreeInfo, TreeType } from '../state/types';
+import { TreeInfo, TreeType } from '../state/types';
 import { StateTreeLUTPair } from '../constants';
+/**
+ * @deprecated use {@link getTreeInfoByPubkey} instead
+ */
+export declare function getStateTreeInfoByPubkey(treeInfos: TreeInfo[], treeOrQueue: PublicKey): TreeInfo;
+export declare function getTreeInfoByPubkey(treeInfos: TreeInfo[], treeOrQueue: PublicKey): TreeInfo;
 /**
  * @deprecated use {@link selectStateTreeInfo} instead.
  *
@@ -9,24 +14,26 @@ import { StateTreeLUTPair } from '../constants';
  * @param infos Set of state tree infos
  * @returns A random tree and queue
  */
-export declare function pickRandomTreeAndQueue(infos: StateTreeInfo[]): {
+export declare function pickRandomTreeAndQueue(infos: TreeInfo[]): {
     tree: PublicKey;
     queue: PublicKey;
 };
 /**
- * Get a pseudo-random active state tree info from the set of provided state
+ * Select a pseudo-random active state tree info from the set of provided state
  * tree infos.
  *
- * Using this mitigates write lock contention on state trees.
+ * Using this reduces write-lock contention on state trees.
  *
  * @param infos                 Set of state tree infos
- * @param treeType              The type of tree. Defaults to `TreeType.StateV1`
- * @param useMaxConcurrency     If true, return all infos. If false, return at
- *                              most {@link MAX_HOTSPOTS}. Defaults to `false`.
+ *
+ * @param treeType              Optional: Only use if you know what you are
+ *                              doing. The type of tree.
+ * @param useMaxConcurrency     Optional: Only use if you know what you are
+ *                              doing. If true, select from all infos.
  *
  * @returns A pseudo-randomly selected tree info
  */
-export declare function selectStateTreeInfo(infos: StateTreeInfo[], treeType?: TreeType, useMaxConcurrency?: boolean): StateTreeInfo;
+export declare function selectStateTreeInfo(infos: TreeInfo[], treeType?: TreeType, useMaxConcurrency?: boolean): TreeInfo;
 /**
  * Get active state tree infos from LUTs.
  *
@@ -38,4 +45,4 @@ export declare function selectStateTreeInfo(infos: StateTreeInfo[], treeType?: T
 export declare function getAllStateTreeInfos({ connection, stateTreeLUTPairs, }: {
     connection: Connection;
     stateTreeLUTPairs: StateTreeLUTPair[];
-}): Promise<StateTreeInfo[]>;
+}): Promise<TreeInfo[]>;

package/dist/cjs/node/utils/index.d.ts

@@ -3,11 +3,10 @@ export * from './airdrop';
 export * from './calculate-compute-unit-price';
 export * from './conversion';
 export * from './dedupe-signer';
-export * from './get-state-tree-infos';
 export * from './parse-validity-proof';
 export * from './pipe';
 export * from './send-and-confirm';
 export * from './sleep';
-export * from './state-tree-lookup-table';
 export * from './validation';
+export * from './state-tree-lookup-table';
 export * from './get-state-tree-infos';

package/dist/cjs/node/utils/send-and-confirm.d.ts

@@ -34,7 +34,7 @@ export declare function sendAndConfirmTx(rpc: Rpc, tx: VersionedTransaction, con
  * @param blockHashCtx      blockhash context for confirmation
  * @return SignatureResult
  */
-export declare function confirmTx(rpc: Rpc, txId: string, confirmOptions?: ConfirmOptions, blockHashCtx?: {
+export declare function confirmTx(rpc: Rpc, txId: string, confirmOptions?: ConfirmOptions, _blockHashCtx?: {
     blockhash: string;
     lastValidBlockHeight: number;
 }): Promise<RpcResponseAndContext<SignatureResult>>;

package/dist/cjs/node/utils/validation.d.ts

@@ -1,7 +1,7 @@
 import BN from 'bn.js';
-import { CompressedAccount, CompressedAccountWithMerkleContext } from '../state';
+import { CompressedAccountLegacy, CompressedAccountWithMerkleContext } from '../state';
 export declare const validateSufficientBalance: (balance: BN) => void;
-export declare const validateSameOwner: (compressedAccounts: CompressedAccount[] | CompressedAccountWithMerkleContext[]) => void;
+export declare const validateSameOwner: (compressedAccounts: CompressedAccountLegacy[] | CompressedAccountWithMerkleContext[]) => void;
 export declare const validateNumbersForProof: (hashesLength: number, newAddressesLength: number) => void;
 export declare const validateNumbersForInclusionProof: (hashesLength: number) => void;
 export declare const validateNumbersForNonInclusionProof: (newAddressesLength: number) => void;