---

ArxPool SDK

Encrypted Pooling SDK for Arcium
Collect encrypted inputs from users, compute privately inside Arcium’s Multi-party Execution (MXE), and verify results without revealing individual data.

---

✨ What is ArxPool

ArxPool is a reusable, privacy-first SDK that provides a simple API for:

• Collecting encrypted user inputs (votes, metrics, AI updates)
• Performing private aggregation inside Arcium MXE
• Verifying attested results offline (job_commit, signature)

Use-cases:

• 🗳️ Private DAO voting
• 📊 Encrypted analytics
• 🤖 Federated AI collaboration
• 💸 Confidential DeFi data

⚠️ ArxPool currently runs in stub mode (local compute) until Arcium public API access is open.
Once available, flip one flag to go live.

---

🚀 Features

• 🔒 Privacy by design — no plaintext data ever leaves the user
• 🧩 Simple API — createPool → joinPool → computePool → verifyResult
• ✅ Ed25519 attestation for verifiable results
• 🔁 Stub ↔ Live switch in one line
• ⚙️ Written in TypeScript (ESM ready)

---

📦 Installation

npm install @arxpool-hq/sdk
# or
yarn add @arxpool-hq/sdk

⚙️ Configuration

Create a .env file:

# Stub (default)
USE_STUB=true
ARXPOOL_ATTESTER_SECRET=local-dev

# Testnet
# USE_STUB=false
ARXPOOL_NODE=https://testnet.arx.arcium.com
ARXPOOL_ATTESTER_KEY=ed25519:your_private_key

Initialize in your app:

import { configure } from "@arxpool-hq/sdk";

configure({
  mode: process.env.USE_STUB === "true" ? "stub" : "testnet",
  node: process.env.ARXPOOL_NODE,
  attesterSecret: process.env.ARXPOOL_ATTESTER_SECRET,
  attesterKey: process.env.ARXPOOL_ATTESTER_KEY,
});

🔐 Never expose signing keys (ARXPOOL_ATTESTER_SECRET / ARXPOOL_ATTESTER_KEY) to frontend code.

---

🧪 Quickstart

import {
  configure,
  createPool,
  joinPool,
  computePool,
  verifyResult,
} from "@arxpool/sdk";

configure({ mode: "stub", attesterSecret: "local-dev" });

// 1. Create a new pool
await createPool({ id: "poll-123", mode: "tally" });

// 2. Submit encrypted inputs
await joinPool("poll-123", {
  ciphertext: "base64-or-hpke-ciphertext",
  senderPubkey: "BASE58_PUBKEY",
  ttlSeconds: 300
});

// 3. Compute (stub or testnet)
const result = await computePool("poll-123");

// 4. Verify result
console.log(verifyResult(result)); // true

---

🧰 API Reference

configure(config)

Configure global SDK behavior.

type ArxPoolConfig = { mode: "stub" | "testnet"; node?: string; attesterSecret?: string; attesterKey?: string; };

---

createPool(pool)

Create a new pool.

type Pool = { id: string; mode: "tally" | "compute"; };

---

joinPool(poolId, blob)

Submit encrypted data to a pool.

type EncryptedBlob = { ciphertext: string; // base64 or HPKE payload senderPubkey: string; // wallet/public key ttlSeconds?: number; metadata?: Record<string, unknown>; };

---

computePool(poolId, options)

Run the computation.

type ComputeOptions = { metadata?: Record<string, unknown>; };

Returns a signed result:

type SignedResult = { payload: unknown; signer_pubkey: string; signature: string; };

---

verifyResult(result)

Verify the Ed25519 signature locally.

verifyResult(result); // returns true or false

---

🔐 Security

Policy Description

No plaintext SDK never decrypts user data Secrets in ENV Never hardcode sensitive keys Deterministic signing Ed25519 + canonical JSON Offline verification No network required Redacted logs [ENCRYPTED_PAYLOAD] instead of raw data HTTPS only Required for backend/collector

---

🧭 Modes

Mode Use Case Behavior

Stub Local dev, demo Deterministic simulated compute Testnet Arcium public testnet HTTPS requests with signed attestation

Toggle via configure({ mode }) or the USE_STUB environment flag.

---

🌐 Example (Node Script)

import { configure, createPool, joinPool, computePool, verifyResult } from "@arxpool-hq/sdk";

async function main() { configure({ mode: "stub", attesterSecret: "local-dev" });

await createPool({ id: "poll-xyz", mode: "tally" }); await joinPool("poll-xyz", { ciphertext: "b64:...", senderPubkey: "BASE58...", ttlSeconds: 300 });

const res = await computePool("poll-xyz"); console.log("Signed:", res); console.log("Verified:", verifyResult(res)); } main();

---

🌐 Related Project

ArxPool Web Portal Interactive demo + docs + collector API. 🔗 https://arxpool-web-test.vercel.app

---

🗺️ Roadmap

[ ] Integrate Arcium MXE client once public

[ ] Reader proof verification

[ ] Support for new aggregation modes

[ ] Wallet bindings (EVM, Solana)

[ ] On-chain anchoring of compute receipts

---

🤝 Contributing

1. Use TypeScript strict mode

2. Include unit tests for crypto logic

3. Never log or commit secrets

4. Avoid telemetry / analytics

---

📄 License

MIT — 2025 ArxPool

---