Arcium LogoArcium TS SDK Docs

@arcium-hq/reader

Type Aliases

Type AliasDescription
ArciumEventAll events emitted by the Arcium program, keyed by event name.
ArciumEventDataData structure for any Arcium event, as parsed from logs.
ArciumEventNameCapitalized event names, matching the format as emitted by the program.
ArciumTypes-
ArxNodeAccount-
CallbackComputationIx-
ClusterAccount-
ComputationAccount-
ComputationDefinitionAccount-
ComputationReference-
ComputationStatusStatus values for a computation, as defined by the Arcium protocol.
Connection-
FinalizeComputationIx-
MXEAccount-
Program-
PublicKey-
QueueComputationIx-

Functions

FunctionDescription
getArciumProgramReadonlyReturns a read-only Anchor program instance for the Arcium program.
getArxNodeAccAddressDerives the ArxNode account address for a given offset.
getArxNodeAccAddressesReturns all ArxNode account addresses.
getArxNodeAccInfoFetches and parses a given ArxNode account.
getClockAccAddressDerives the clock account address.
getClusterAccAddressDerives the cluster account address for a given offset.
getClusterAccAddressesReturns all Cluster account addresses.
getClusterAccInfoFetches and parses a given Cluster account.
getCompDefAccAddressDerives the computation definition account address for a given MXE program ID and offset.
getCompDefAccInfoFetches and parses a given ComputationDefinition account.
getComputationAccAddressDerives the computation account address for a given MXE program ID and offset.
getComputationAccInfoFetches and parses a given Computation account.
getComputationOffsetGets the computation offset from a transaction.
getComputationsInMempoolReturns all computation references in the mempool for a given account. Only non-stake computations are included.
getExecutingPoolAccAddressDerives the executing pool account address for a given MXE program ID.
getMempoolAccAddressDerives the mempool account address for a given MXE program ID.
getMXEAccAddressDerives the MXE account address for a given MXE program ID.
getMXEAccAddressesReturns all MXE account addresses.
getMXEAccInfoFetches and parses a given MXE account.
getStakingPoolAccAddressDerives the staking pool account address.
subscribeComputationsSubscribes to computation-related events for a given MXE program ID.
unsubscribeComputationsUnsubscribes from computation-related events using the subscription ID.