Arcium TypeScript SDK - API Reference

API reference for the Arcium TypeScript SDK packages (@arcium-hq/client, @arcium-hq/reader, and @arcium-hq/staking), which let you interact with confidential Solana programs and the Arcium network.

Looking for more information about the Arcium network?

To learn more about Arcium:

• Arcium Documentation - Learn about network architecture, confidential computation concepts, and platform overview
• Developer Documentation - Technical guides, tutorials, and best practices

Available SDK Packages

Client SDK (@arcium-hq/client)

The Client SDK provides functionality for interacting with confidential Solana programs on the Arcium network.

• Browse API Documentation → API reference for the Client SDK
• NPM Package

npm install @arcium-hq/client

• Key Features:
  • Handle encryption/decryption operations
  • Fetch Arcium network PDAs
  • Track computation status and results

Reader SDK (@arcium-hq/reader)

The Reader SDK enables fetching and monitoring on-chain data from Arcium network programs.

• Browse API Documentation → API reference for the Reader SDK
• NPM Package

npm install @arcium-hq/reader

• Key Features:
  • Query computation states and results
  • Fetch network account addresses (nodes, clusters, MXEs)
  • Subscribe to real-time computation updates
  • Monitor cluster and MXE status

Staking SDK (@arcium-hq/staking)

The Staking SDK provides PDA helpers, account readers, and instruction builders for the Arcium staking program.

• Browse API Documentation → API reference for the Staking SDK
• NPM Package

npm install @arcium-hq/staking

• Key Features:
  • Derive staking PDAs (pool, primary, delegated, master, cluster)
  • Fetch and discover stake account state
  • Build staking instructions (stake, delegate, claim rewards)

Getting Started

For implementation guides and tutorials on using these SDKs:

1. Visit the Arcium Developer Documentation
2. Check out code examples
3. Join the community for support and discussions