@arcium-hq/reader 0.8.5 → 0.9.1

package/README.md

@@ -147,14 +147,12 @@ for (const address of arxNodeAddresses) {
 Track available computation definitions and their configurations.
 
 ```typescript
-import { getCompDefAccInfo } from "@arcium-hq/reader";
-import { getCompDefAccAddress } from "@arcium-hq/reader";
+import { getCompDefAccInfo, getCompDefAccAddress } from "@arcium-hq/reader";
 
 // Get computation definition for a specific circuit
-const circuitName = "your_circuit_name";
 const mxeProgramId = new anchor.web3.PublicKey("YOUR_MXE_PROGRAM_ID");
-
-const compDefAddress = getCompDefAccAddress(mxeProgramId, /* offset */);
+const compDefOffset = 0; // Your computation definition offset
+const compDefAddress = getCompDefAccAddress(mxeProgramId, compDefOffset);
 const compDefInfo = await getCompDefAccInfo(arciumProgram, compDefAddress);
 
 console.log("Computation Definition:", {
@@ -170,12 +168,12 @@ console.log("Computation Definition:", {
 Monitor individual computation instances and their status.
 
 ```typescript
-import { getComputationAccInfo } from "@arcium-hq/reader";
-import { getComputationAccAddress } from "@arcium-hq/reader";
+import { getComputationAccInfo, getComputationAccAddress } from "@arcium-hq/reader";
 
 // Get computation account info
+const clusterOffset = 0; // Your cluster offset
 const computationOffset = new anchor.BN("123456789");
-const computationAddress = getComputationAccAddress(mxeProgramId, computationOffset);
+const computationAddress = getComputationAccAddress(clusterOffset, computationOffset);
 const computationInfo = await getComputationAccInfo(arciumProgram, computationAddress);
 
 console.log("Computation:", {
@@ -191,13 +189,14 @@ console.log("Computation:", {
 Analyze pending computations in the network's memory pools.
 
 ```typescript
-import { 
+import {
   getComputationsInMempool,
   getMempoolAccAddress
 } from "@arcium-hq/reader";
 
-// Get mempool for an MXE
-const mempoolAddress = getMempoolAccAddress(mxeProgramId);
+// Get mempool for a cluster (use your cluster offset)
+const clusterOffset = 0; // Your cluster offset
+const mempoolAddress = getMempoolAccAddress(clusterOffset);
 const pendingComputations = await getComputationsInMempool(arciumProgram, mempoolAddress);
 
 console.log(`Found ${pendingComputations.length} pending computations:`);

package/build/index.cjs

@@ -73,95 +73,104 @@ new anchor__namespace.EventParser(ARCIUM_PROGRAM_ID, new anchor__namespace.Borsh
 const ARCIUM_BORSH_CODER = new anchor__namespace.BorshCoder(client.ARCIUM_IDL);
 
 /**
- * Returns all MXE account addresses.
- * @param conn - The Solana connection object.
+ * Return all MXE account addresses.
+ * @param conn - Solana connection object.
  * @returns Array of MXE account public keys.
  */
 async function getMXEAccAddresses(conn) {
     return getArciumAccPubkeys(conn, MXE_ACC_DISCRIMINATOR);
 }
 /**
- * Returns all Cluster account addresses.
- * @param conn - The Solana connection object.
+ * Return all Cluster account addresses.
+ * @param conn - Solana connection object.
  * @returns Array of Cluster account public keys.
  */
 async function getClusterAccAddresses(conn) {
     return getArciumAccPubkeys(conn, CLUSTER_ACC_DISCRIMINATOR);
 }
 /**
- * Returns all ArxNode account addresses.
- * @param conn - The Solana connection object.
+ * Return all ArxNode account addresses.
+ * @param conn - Solana connection object.
  * @returns Array of ArxNode account public keys.
  */
 async function getArxNodeAccAddresses(conn) {
     return getArciumAccPubkeys(conn, ARX_NODE_ACC_DISCRIMINATOR);
 }
 /**
- * Fetches and parses a given MXE account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the MXE account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The MXEAccount object.
+ * Fetch and parse an MXE account.
+ *
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the MXE account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed MXE account data.
+ *
+ * @example
+ * import { getArciumProgram, getMXEAccAddress, getMXEAccInfo } from '@arcium-hq/reader';
+ *
+ * const program = getArciumProgram(provider);
+ * const mxeAddress = getMXEAccAddress(mxeProgramId);
+ * const mxeAccount = await getMXEAccInfo(program, mxeAddress);
+ * console.log('MXE authority:', mxeAccount.authority?.toBase58());
  */
 async function getMXEAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.mxeAccount.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given Cluster account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the Cluster account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The ClusterAccount object.
+ * Fetch and parse a Cluster account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the Cluster account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ClusterAccount data.
  */
 async function getClusterAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.cluster.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given recovery cluster account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the recovery cluster account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The RecoveryClusterAccount object.
+ * Fetch and parse a recovery cluster account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the recovery cluster account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed RecoveryClusterAccount data.
  */
 async function getRecoveryClusterAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.recoveryClusterAccount.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given MxeRecovery account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the MxeRecovery account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The MxeRecoveryAccount object.
+ * Fetch and parse an MxeRecovery account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the MxeRecovery account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed MxeRecoveryAccount data.
  */
 async function getMxeRecoveryAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.mxeRecoveryAccount.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given ArxNode account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the ArxNode account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The ArxNodeAccount object.
+ * Fetch and parse an ArxNode account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the ArxNode account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ArxNodeAccount data.
  */
 async function getArxNodeAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.arxNode.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given ComputationDefinition account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the ComputationDefinition account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The ComputationDefinitionAccount object.
+ * Fetch and parse a ComputationDefinition account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the ComputationDefinition account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ComputationDefinitionAccount data.
  */
 async function getCompDefAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.computationDefinitionAccount.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given Computation account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the Computation account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The Computation object.
+ * Fetch and parse a Computation account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the Computation account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ComputationAccount data.
  */
 async function getComputationAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.computationAccount.fetch(address, commitment);
@@ -183,11 +192,28 @@ async function getArciumAccPubkeys(conn, discriminator) {
 }
 
 /**
- * Subscribes to computation-related events for a given MXE program ID.
- * @param conn - The Solana connection object.
- * @param mxeProgramId - The public key of the MXE program.
- * @param callback - Callback function to handle each computation event and its name.
- * @returns The subscription ID for the logs listener.
+ * Subscribe to computation events for an MXE program.
+ *
+ * Listens for queue, execute, and finalize events via Solana log subscriptions.
+ *
+ * @param conn - Solana connection object.
+ * @param mxeProgramId - Public key of the MXE program to monitor.
+ * @param callback - Handler called for each event with event data and event name.
+ * @returns Subscription ID for cleanup with {@link unsubscribeComputations}.
+ *
+ * @example
+ * const subId = await subscribeComputations(
+ *   connection,
+ *   mxeProgramId,
+ *   (event, name) => {
+ *     if (name === 'FinalizeComputationEvent') {
+ *       console.log('Computation finalized:', event.computationOffset.toString());
+ *     }
+ *   },
+ * );
+ *
+ * // When done, clean up the subscription
+ * await unsubscribeComputations(connection, subId);
  */
 async function subscribeComputations(conn, mxeProgramId, callback) {
     return conn.onLogs(mxeProgramId, (logs) => {
@@ -198,17 +224,17 @@ async function subscribeComputations(conn, mxeProgramId, callback) {
     });
 }
 /**
- * Unsubscribes from computation-related events using the subscription ID.
- * @param conn - The Solana connection object.
- * @param subscriptionId - The subscription ID returned by subscribeComputations.
+ * Unsubscribe from computation events.
+ * @param conn - Solana connection object.
+ * @param subscriptionId - Subscription ID returned by {@link subscribeComputations}.
  */
 async function unsubscribeComputations(conn, subscriptionId) {
     conn.removeOnLogsListener(subscriptionId);
 }
 /**
- * Gets the computation offset from a transaction.
- * @param tx - The transaction to get the computation offset from.
- * @returns The computation offset if one is found, otherwise undefined.
+ * Get the computation offset from a transaction.
+ * @param tx - Transaction to extract the computation offset from.
+ * @returns Computation offset if found, otherwise undefined.
  * @throws Error if multiple computation offsets are found in the transaction.
  */
 function getComputationOffset(tx) {
@@ -224,7 +250,7 @@ function getComputationOffset(tx) {
     return computationOffset;
 }
 /**
- * Get the events related to arcium computations from a transaction's logs
+ * Get the events related to Arcium computations from a transaction's logs.
  *
  * Note: This implements a direct decode approach instead of using Anchor's EventParser.parseLogs().
  *
@@ -235,7 +261,7 @@ function getComputationOffset(tx) {
  * 3. Only parses events when execution.program() === EventParser.programId
  *
  * This breaks our use case:
- * - We subscribe to MXE program logs (line 29) via conn.onLogs(mxeProgramId, ...)
+ * - We subscribe to MXE program logs via conn.onLogs(mxeProgramId, ...) in {@link subscribeComputations}
  * - But we need to parse Arcium events emitted during MXE→Arcium CPI calls
  * - When MXE is the root program, execution.program() = MXE_PROGRAM_ID
  * - EventParser expects execution.program() = ARCIUM_PROGRAM_ID
@@ -247,8 +273,8 @@ function getComputationOffset(tx) {
  * - Works regardless of which program is root or subscription target
  * - Handles both MXE→Arcium and Arcium→MXE CPI patterns
  *
- * @param logs - The logs to get the events from
- * @returns The events in the logs.
+ * @param logs - Logs to get the events from.
+ * @returns Array of parsed Arcium computation events.
  */
 function getComputationEventsFromLogs(logs) {
     const events = [];

package/build/index.d.ts

@@ -70,11 +70,11 @@ type ComputationDefinitionAccount = ArciumTypes['computationDefinitionAccount'];
 /**
  * Queue computation instruction type from the Arcium IDL.
  */
-type QueueComputationIx = ArciumIdlType['instructions']['35'];
+type QueueComputationIx = ArciumIdlType['instructions']['38'];
 /**
  * Callback computation instruction type from the Arcium IDL.
  */
-type CallbackComputationIx = ArciumIdlType['instructions']['3'];
+type CallbackComputationIx = ArciumIdlType['instructions']['4'];
 /**
  * Valid instruction names from the Arcium IDL.
  */
@@ -85,98 +85,124 @@ type ArciumInstructionName = ArciumIdlType['instructions'][number]['name'];
 type ComputationStatus = 'queued' | 'executing' | 'executed' | 'finalized' | 'failed';
 
 /**
- * Returns all MXE account addresses.
- * @param conn - The Solana connection object.
+ * Return all MXE account addresses.
+ * @param conn - Solana connection object.
  * @returns Array of MXE account public keys.
  */
 declare function getMXEAccAddresses(conn: Connection): Promise<PublicKey[]>;
 /**
- * Returns all Cluster account addresses.
- * @param conn - The Solana connection object.
+ * Return all Cluster account addresses.
+ * @param conn - Solana connection object.
  * @returns Array of Cluster account public keys.
  */
 declare function getClusterAccAddresses(conn: Connection): Promise<PublicKey[]>;
 /**
- * Returns all ArxNode account addresses.
- * @param conn - The Solana connection object.
+ * Return all ArxNode account addresses.
+ * @param conn - Solana connection object.
  * @returns Array of ArxNode account public keys.
  */
 declare function getArxNodeAccAddresses(conn: Connection): Promise<PublicKey[]>;
 /**
- * Fetches and parses a given MXE account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the MXE account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The MXEAccount object.
+ * Fetch and parse an MXE account.
+ *
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the MXE account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed MXE account data.
+ *
+ * @example
+ * import { getArciumProgram, getMXEAccAddress, getMXEAccInfo } from '@arcium-hq/reader';
+ *
+ * const program = getArciumProgram(provider);
+ * const mxeAddress = getMXEAccAddress(mxeProgramId);
+ * const mxeAccount = await getMXEAccInfo(program, mxeAddress);
+ * console.log('MXE authority:', mxeAccount.authority?.toBase58());
  */
 declare function getMXEAccInfo(arciumProgram: anchor.Program<ArciumIdlType>, address: PublicKey, commitment?: anchor.web3.Commitment): Promise<MXEAccount>;
 /**
- * Fetches and parses a given Cluster account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the Cluster account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The ClusterAccount object.
+ * Fetch and parse a Cluster account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the Cluster account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ClusterAccount data.
  */
 declare function getClusterAccInfo(arciumProgram: anchor.Program<ArciumIdlType>, address: PublicKey, commitment?: anchor.web3.Commitment): Promise<ClusterAccount>;
 /**
- * Fetches and parses a given recovery cluster account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the recovery cluster account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The RecoveryClusterAccount object.
+ * Fetch and parse a recovery cluster account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the recovery cluster account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed RecoveryClusterAccount data.
  */
 declare function getRecoveryClusterAccInfo(arciumProgram: anchor.Program<ArciumIdlType>, address: PublicKey, commitment?: anchor.web3.Commitment): Promise<RecoveryClusterAccount>;
 /**
- * Fetches and parses a given MxeRecovery account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the MxeRecovery account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The MxeRecoveryAccount object.
+ * Fetch and parse an MxeRecovery account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the MxeRecovery account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed MxeRecoveryAccount data.
  */
 declare function getMxeRecoveryAccInfo(arciumProgram: anchor.Program<ArciumIdlType>, address: PublicKey, commitment?: anchor.web3.Commitment): Promise<MxeRecoveryAccount>;
 /**
- * Fetches and parses a given ArxNode account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the ArxNode account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The ArxNodeAccount object.
+ * Fetch and parse an ArxNode account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the ArxNode account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ArxNodeAccount data.
  */
 declare function getArxNodeAccInfo(arciumProgram: anchor.Program<ArciumIdlType>, address: PublicKey, commitment?: anchor.web3.Commitment): Promise<ArxNodeAccount>;
 /**
- * Fetches and parses a given ComputationDefinition account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the ComputationDefinition account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The ComputationDefinitionAccount object.
+ * Fetch and parse a ComputationDefinition account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the ComputationDefinition account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ComputationDefinitionAccount data.
  */
 declare function getCompDefAccInfo(arciumProgram: anchor.Program<ArciumIdlType>, address: PublicKey, commitment?: anchor.web3.Commitment): Promise<ComputationDefinitionAccount>;
 /**
- * Fetches and parses a given Computation account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the Computation account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The Computation object.
+ * Fetch and parse a Computation account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the Computation account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ComputationAccount data.
  */
 declare function getComputationAccInfo(arciumProgram: anchor.Program<ArciumIdlType>, address: PublicKey, commitment?: anchor.web3.Commitment): Promise<ComputationAccount>;
 
 /**
- * Subscribes to computation-related events for a given MXE program ID.
- * @param conn - The Solana connection object.
- * @param mxeProgramId - The public key of the MXE program.
- * @param callback - Callback function to handle each computation event and its name.
- * @returns The subscription ID for the logs listener.
+ * Subscribe to computation events for an MXE program.
+ *
+ * Listens for queue, execute, and finalize events via Solana log subscriptions.
+ *
+ * @param conn - Solana connection object.
+ * @param mxeProgramId - Public key of the MXE program to monitor.
+ * @param callback - Handler called for each event with event data and event name.
+ * @returns Subscription ID for cleanup with {@link unsubscribeComputations}.
+ *
+ * @example
+ * const subId = await subscribeComputations(
+ *   connection,
+ *   mxeProgramId,
+ *   (event, name) => {
+ *     if (name === 'FinalizeComputationEvent') {
+ *       console.log('Computation finalized:', event.computationOffset.toString());
+ *     }
+ *   },
+ * );
+ *
+ * // When done, clean up the subscription
+ * await unsubscribeComputations(connection, subId);
  */
 declare function subscribeComputations(conn: Connection, mxeProgramId: PublicKey, callback: (event: ArciumEventData, name: ArciumEventName) => void): Promise<number>;
 /**
- * Unsubscribes from computation-related events using the subscription ID.
- * @param conn - The Solana connection object.
- * @param subscriptionId - The subscription ID returned by subscribeComputations.
+ * Unsubscribe from computation events.
+ * @param conn - Solana connection object.
+ * @param subscriptionId - Subscription ID returned by {@link subscribeComputations}.
  */
 declare function unsubscribeComputations(conn: Connection, subscriptionId: number): Promise<void>;
 /**
- * Gets the computation offset from a transaction.
- * @param tx - The transaction to get the computation offset from.
- * @returns The computation offset if one is found, otherwise undefined.
+ * Get the computation offset from a transaction.
+ * @param tx - Transaction to extract the computation offset from.
+ * @returns Computation offset if found, otherwise undefined.
  * @throws Error if multiple computation offsets are found in the transaction.
  */
 declare function getComputationOffset(tx: anchor.web3.VersionedTransactionResponse): anchor.BN | undefined;

package/build/index.mjs

@@ -53,95 +53,104 @@ new anchor.EventParser(ARCIUM_PROGRAM_ID, new anchor.BorshCoder(ARCIUM_IDL));
 const ARCIUM_BORSH_CODER = new anchor.BorshCoder(ARCIUM_IDL);
 
 /**
- * Returns all MXE account addresses.
- * @param conn - The Solana connection object.
+ * Return all MXE account addresses.
+ * @param conn - Solana connection object.
  * @returns Array of MXE account public keys.
  */
 async function getMXEAccAddresses(conn) {
     return getArciumAccPubkeys(conn, MXE_ACC_DISCRIMINATOR);
 }
 /**
- * Returns all Cluster account addresses.
- * @param conn - The Solana connection object.
+ * Return all Cluster account addresses.
+ * @param conn - Solana connection object.
  * @returns Array of Cluster account public keys.
  */
 async function getClusterAccAddresses(conn) {
     return getArciumAccPubkeys(conn, CLUSTER_ACC_DISCRIMINATOR);
 }
 /**
- * Returns all ArxNode account addresses.
- * @param conn - The Solana connection object.
+ * Return all ArxNode account addresses.
+ * @param conn - Solana connection object.
  * @returns Array of ArxNode account public keys.
  */
 async function getArxNodeAccAddresses(conn) {
     return getArciumAccPubkeys(conn, ARX_NODE_ACC_DISCRIMINATOR);
 }
 /**
- * Fetches and parses a given MXE account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the MXE account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The MXEAccount object.
+ * Fetch and parse an MXE account.
+ *
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the MXE account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed MXE account data.
+ *
+ * @example
+ * import { getArciumProgram, getMXEAccAddress, getMXEAccInfo } from '@arcium-hq/reader';
+ *
+ * const program = getArciumProgram(provider);
+ * const mxeAddress = getMXEAccAddress(mxeProgramId);
+ * const mxeAccount = await getMXEAccInfo(program, mxeAddress);
+ * console.log('MXE authority:', mxeAccount.authority?.toBase58());
  */
 async function getMXEAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.mxeAccount.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given Cluster account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the Cluster account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The ClusterAccount object.
+ * Fetch and parse a Cluster account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the Cluster account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ClusterAccount data.
  */
 async function getClusterAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.cluster.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given recovery cluster account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the recovery cluster account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The RecoveryClusterAccount object.
+ * Fetch and parse a recovery cluster account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the recovery cluster account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed RecoveryClusterAccount data.
  */
 async function getRecoveryClusterAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.recoveryClusterAccount.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given MxeRecovery account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the MxeRecovery account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The MxeRecoveryAccount object.
+ * Fetch and parse an MxeRecovery account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the MxeRecovery account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed MxeRecoveryAccount data.
  */
 async function getMxeRecoveryAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.mxeRecoveryAccount.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given ArxNode account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the ArxNode account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The ArxNodeAccount object.
+ * Fetch and parse an ArxNode account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the ArxNode account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ArxNodeAccount data.
  */
 async function getArxNodeAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.arxNode.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given ComputationDefinition account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the ComputationDefinition account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The ComputationDefinitionAccount object.
+ * Fetch and parse a ComputationDefinition account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the ComputationDefinition account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ComputationDefinitionAccount data.
  */
 async function getCompDefAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.computationDefinitionAccount.fetch(address, commitment);
 }
 /**
- * Fetches and parses a given Computation account.
- * @param arciumProgram - The Anchor program instance.
- * @param address - The public key of the Computation account.
- * @param commitment - (Optional) RPC commitment level.
- * @returns The Computation object.
+ * Fetch and parse a Computation account.
+ * @param arciumProgram - Anchor program instance.
+ * @param address - Public key of the Computation account.
+ * @param commitment - RPC commitment level.
+ * @returns Parsed ComputationAccount data.
  */
 async function getComputationAccInfo(arciumProgram, address, commitment) {
     return arciumProgram.account.computationAccount.fetch(address, commitment);
@@ -163,11 +172,28 @@ async function getArciumAccPubkeys(conn, discriminator) {
 }
 
 /**
- * Subscribes to computation-related events for a given MXE program ID.
- * @param conn - The Solana connection object.
- * @param mxeProgramId - The public key of the MXE program.
- * @param callback - Callback function to handle each computation event and its name.
- * @returns The subscription ID for the logs listener.
+ * Subscribe to computation events for an MXE program.
+ *
+ * Listens for queue, execute, and finalize events via Solana log subscriptions.
+ *
+ * @param conn - Solana connection object.
+ * @param mxeProgramId - Public key of the MXE program to monitor.
+ * @param callback - Handler called for each event with event data and event name.
+ * @returns Subscription ID for cleanup with {@link unsubscribeComputations}.
+ *
+ * @example
+ * const subId = await subscribeComputations(
+ *   connection,
+ *   mxeProgramId,
+ *   (event, name) => {
+ *     if (name === 'FinalizeComputationEvent') {
+ *       console.log('Computation finalized:', event.computationOffset.toString());
+ *     }
+ *   },
+ * );
+ *
+ * // When done, clean up the subscription
+ * await unsubscribeComputations(connection, subId);
  */
 async function subscribeComputations(conn, mxeProgramId, callback) {
     return conn.onLogs(mxeProgramId, (logs) => {
@@ -178,17 +204,17 @@ async function subscribeComputations(conn, mxeProgramId, callback) {
     });
 }
 /**
- * Unsubscribes from computation-related events using the subscription ID.
- * @param conn - The Solana connection object.
- * @param subscriptionId - The subscription ID returned by subscribeComputations.
+ * Unsubscribe from computation events.
+ * @param conn - Solana connection object.
+ * @param subscriptionId - Subscription ID returned by {@link subscribeComputations}.
  */
 async function unsubscribeComputations(conn, subscriptionId) {
     conn.removeOnLogsListener(subscriptionId);
 }
 /**
- * Gets the computation offset from a transaction.
- * @param tx - The transaction to get the computation offset from.
- * @returns The computation offset if one is found, otherwise undefined.
+ * Get the computation offset from a transaction.
+ * @param tx - Transaction to extract the computation offset from.
+ * @returns Computation offset if found, otherwise undefined.
  * @throws Error if multiple computation offsets are found in the transaction.
  */
 function getComputationOffset(tx) {
@@ -204,7 +230,7 @@ function getComputationOffset(tx) {
     return computationOffset;
 }
 /**
- * Get the events related to arcium computations from a transaction's logs
+ * Get the events related to Arcium computations from a transaction's logs.
  *
  * Note: This implements a direct decode approach instead of using Anchor's EventParser.parseLogs().
  *
@@ -215,7 +241,7 @@ function getComputationOffset(tx) {
  * 3. Only parses events when execution.program() === EventParser.programId
  *
  * This breaks our use case:
- * - We subscribe to MXE program logs (line 29) via conn.onLogs(mxeProgramId, ...)
+ * - We subscribe to MXE program logs via conn.onLogs(mxeProgramId, ...) in {@link subscribeComputations}
  * - But we need to parse Arcium events emitted during MXE→Arcium CPI calls
  * - When MXE is the root program, execution.program() = MXE_PROGRAM_ID
  * - EventParser expects execution.program() = ARCIUM_PROGRAM_ID
@@ -227,8 +253,8 @@ function getComputationOffset(tx) {
  * - Works regardless of which program is root or subscription target
  * - Handles both MXE→Arcium and Arcium→MXE CPI patterns
  *
- * @param logs - The logs to get the events from
- * @returns The events in the logs.
+ * @param logs - Logs to get the events from.
+ * @returns Array of parsed Arcium computation events.
  */
 function getComputationEventsFromLogs(logs) {
     const events = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcium-hq/reader",
-  "version": "0.8.5",
+  "version": "0.9.1",
   "description": "Reader SDK for fetching onchain data for Arcium network programs",
   "author": "Arcium",
   "license": "GPL-3.0-only",
@@ -58,7 +58,7 @@
     "@coral-xyz/anchor": "^0.32.1",
     "@noble/curves": "^1.9.5",
     "@noble/hashes": "^1.7.1",
-    "@arcium-hq/client": "0.8.5"
+    "@arcium-hq/client": "0.9.1"
   },
   "keywords": [
     "Cryptography",