Skip to main content

OmegaX Protocol SDK

Build health apps, oracle services, and outcome-triggered settlement flows on Solana devnet beta with @omegax/protocol-sdk.

@omegax/protocol-sdk gives builders unsigned transaction builders, readers, PDA helpers, reserve-aware read models, and oracle attestation helpers for the current public OmegaX surface.

Start here if

Use this overview to decide whether you need the SDK, which builder lane you are in, and which reference page to open next.

Current public targets

  • protocol current devnet surface
  • SDK v0.8.4
  • public integration network: Solana devnet beta
Current public status

The SDK is for public devnet beta integrations today. Genesis Protect Acute has a bounded mainnet launch target, but it is reserve-gated, operator-reviewed in Phase 0, and not broadly available insurance today.

What you can build today

  • oracle and event-production services that register operators, manage policy, and emit compatible outcome and claim-case attestations
  • health apps, wallets, and agents that read member, claim, obligation, and payout state
  • sponsor and capital integrations that create plans, funding lines, pools, classes, allocations, and redemptions

Who should use it

  • oracle and event producers
  • health / wallet / app builders
  • sponsor, treasury, and capital integrators

Choose your path

Builder laneWhat you need firstBest next page
Oracle and event producersOperator registration, policy controls, and attestations.SDK Workflows
Health / wallet / app buildersMember, claim, obligation, and payout reads.SDK Getting Started
Sponsor and capital integratorsReserve domains, plans, funding lines, pools, classes, and allocations.API Reference

Oracle and event producers

Use the protocol registry builders plus @omegax/protocol-sdk/oracle to register oracles, manage pool policy, and package attestations.

Start with:

Health / wallet / app builders

Use reader helpers and member and claim builders to power user-facing views and outcome-driven product flows.

Start with:

Use reserve-domain, plan, capital, allocation, and queue builders to launch or manage sponsor and LP lanes on the canonical model.

Start with:

Install

npm install @omegax/protocol-sdk

Runtime basics

  • Node.js >=20
  • ESM-only package
  • Protocol builders are unsigned
  • programId must be configured explicitly in runtime integrations
  • Public integrations should stay on devnet until OmegaX announces mainnet availability

Quickstart

Create clients once, then branch into the workflow that matches your product.

import {
PROTOCOL_PROGRAM_ID,
createConnection,
createProtocolClient,
createRpcClient,
getOmegaXNetworkInfo,
listProtocolInstructionNames,
} from '@omegax/protocol-sdk';

const network =
(process.env.OMEGAX_NETWORK as 'devnet' | 'mainnet' | undefined) ?? 'devnet';
const networkInfo = getOmegaXNetworkInfo(network);

const connection = createConnection({
network,
rpcUrl: process.env.SOLANA_RPC_URL ?? networkInfo.defaultRpcUrl,
commitment: 'confirmed',
});

const programId = process.env.OMEGAX_PROGRAM_ID ?? PROTOCOL_PROGRAM_ID;
const protocol = createProtocolClient(connection, programId);
const rpc = createRpcClient(connection);
const instructions = listProtocolInstructionNames();

From there:

  • oracle and event producers usually move into buildRegisterOracleTx(...), buildClaimOracleTx(...), buildSetPoolOraclePolicyTx(...), buildAttestClaimCaseTx(...), and attestOutcome(...)
  • health and wallet builders usually move into member and claim reads plus buildOpenMemberPositionTx(...) and buildOpenClaimCaseTx(...)
  • sponsor and capital integrators usually move into reserve-domain, plan, pool, class, allocation, and redemption builders from SDK Workflows

Public surface coverage

This package exposes the current canonical object model:

  • protocol governance and scoped controls
  • reserve domains and domain asset vaults
  • health plans and policy series
  • member positions
  • funding lines, obligations, claim cases, and claim attestations
  • liquidity pools, capital classes, LP positions, and allocation positions
  • oracle profiles, pool oracle approvals, pool oracle policies, and permission sets
  • outcome schemas and schema dependency ledgers
  • reserve-aware read models for sponsors, members, and capital providers
  • RPC helpers for unsigned transaction submission flows

Release status

  • Current SDK release: 0.8.4
  • Current protocol surface: current devnet beta surface
  • Public integration network: Solana devnet beta
  • Public docs: docs.omegax.health

Latest release note

  • 0.8.4 refreshes generated bindings for fee-vault hardening: domain vault token accounts are protocol-owned PDAs, pool treasury and protocol fee vaults are first-class SDK accounts, and signed simulation fallback is fail-closed by default.

Canonical module map

  • Root package: connection helpers, RPC helpers, protocol builders, PDA helpers, reserve-model helpers, shared types
  • @omegax/protocol-sdk/protocol: IDL-backed builder and reader helpers such as createProtocolClient(...), listProtocolInstructionNames(...), decodeProtocolAccount(...), and compileTransactionToV0(...)
  • @omegax/protocol-sdk/protocol_seeds: deterministic PDA helpers such as deriveReserveDomainPda(...), deriveHealthPlanPda(...), deriveFundingLinePda(...), and deriveCapitalClassPda(...)
  • @omegax/protocol-sdk/protocol_models: constants and read-model helpers such as recomputeReserveBalanceSheet(...), buildSponsorReadModel(...), buildCapitalReadModel(...), and buildMemberReadModel(...)
  • @omegax/protocol-sdk/claims: claim and obligation failure normalization helpers such as normalizeClaimSimulationFailure(...)
  • @omegax/protocol-sdk/oracle: oracle attestation helpers such as createOracleSignerFromEnv(...), createOracleSignerFromKmsAdapter(...), and attestOutcome(...), alongside the root-level buildAttestClaimCaseTx(...) helper for on-chain claim-case attestations
  • @omegax/protocol-sdk/rpc: createConnection(...), createRpcClient(...), and network metadata helpers
  • @omegax/protocol-sdk/utils: hashing, binary encoding, and misc utilities
  • @omegax/protocol-sdk/types: generated protocol contract types plus SDK RPC and failure types

What the SDK is for

  • Sponsors and operators can build reserve-domain, health-plan, policy-series, funding-line, obligation, and claim-case transactions directly.
  • Capital providers can derive capital-class and allocation addresses, inspect ledgers, and build deposit and redemption flows against canonical pool and class objects.
  • Wallet apps and members can inspect plan participation, obligations, claim state, and payout history with the read-model helpers.
  • Oracle operators can register profiles, configure pool policy, and use a narrower attestation helper surface for outcome packaging.
  • External integrators can enumerate the current instruction and account surface with listProtocolInstructionNames(...) and listProtocolAccountNames(...).

What the SDK does not do

  • It does not keep pool-first compatibility aliases.
  • It does not hide settlement-critical accounting in offchain helpers.
  • It does not invent a second protocol surface for wrappers or regulated participation.
  • It does not sign transactions on your behalf.

Next read