Arcium TS SDK Docs@arcium-hq/reader
Type Aliases
| Type Alias | Description |
|---|---|
| ArciumEvent | All events emitted by the Arcium program, keyed by event name. |
| ArciumEventData | Data structure for any Arcium event, as parsed from logs. |
| ArciumEventName | Capitalized event names, matching the format as emitted by the program. |
| ArciumInstructionName | Valid instruction names from the Arcium IDL. |
| ArciumTypes | Arcium IDL types derived from the Arcium program interface. |
| ArxNodeAccount | ArxNode account data structure for individual computation nodes. |
| CallbackComputationIx | Callback computation instruction type from the Arcium IDL. |
| ClusterAccount | Cluster account data structure containing node information. |
| ComputationAccount | Computation account data structure tracking computation state. |
| ComputationDefinitionAccount | Computation definition account containing circuit configuration. |
| ComputationReference | Reference to a computation in a mempool or executing pool. |
| ComputationStatus | Status values for a computation, as defined by the Arcium protocol. |
| Connection | Solana Connection type alias for convenience. |
| MXEAccount | MXE (Multi-party eXecution Environment) account data structure. |
| MxeRecoveryAccount | MXE recovery account data structure tracking key recovery session state. |
| Program | Anchor Program type alias with generic IDL support. |
| PublicKey | Solana PublicKey type alias for convenience. |
| QueueComputationIx | Queue computation instruction type from the Arcium IDL. |
| RecoveryClusterAccount | Recovery cluster account data structure containing recovery peers information. |
Functions
| Function | Description |
|---|---|
| getArciumProgram | Returns an Anchor program instance for the Arcium program. |
| getArxNodeAccAddress | Derives the ArxNode account address for a given offset. |
| getArxNodeAccAddresses | Returns all ArxNode account addresses. |
| getArxNodeAccInfo | Fetches and parses a given ArxNode account. |
| getClockAccAddress | Derives the clock account address. |
| getClusterAccAddress | Derives the cluster account address for a given offset. |
| getClusterAccAddresses | Returns all Cluster account addresses. |
| getClusterAccInfo | Fetches and parses a given Cluster account. |
| getCompDefAccAddress | Derives the computation definition account address for a given MXE program ID and offset. |
| getCompDefAccInfo | Fetches and parses a given ComputationDefinition account. |
| getComputationAccAddress | Derives the computation account address for a given cluster and computation offset. |
| getComputationAccInfo | Fetches and parses a given Computation account. |
| getComputationOffset | Gets the computation offset from a transaction. |
| getComputationsInMempool | Returns all computation references in the mempool for a given account. Only non-stake computations are included. |
| getExecutingPoolAccAddress | Derives the executing pool account address for a given cluster. |
| getFeePoolAccAddress | Derives the fee pool account address. |
| getMempoolAccAddress | Derives the mempool account address for a given cluster. |
| getMempoolPriorityFeeStats | Calculates priority fee statistics for computations in a mempool. |
| getMXEAccAddress | Derives the MXE account address for a given MXE program ID. |
| getMXEAccAddresses | Returns all MXE account addresses. |
| getMXEAccInfo | Fetches and parses a given MXE account. |
| getMxeRecoveryAccInfo | Fetches and parses a given MxeRecovery account. |
| getRecoveryClusterAccInfo | Fetches and parses a given recovery cluster account. |
| subscribeComputations | Subscribes to computation-related events for a given MXE program ID. |
| unsubscribeComputations | Unsubscribes from computation-related events using the subscription ID. |