Skip to main content

SDK API Reference

This page documents the public SDK surface shipped in 0.8.4.

Start here if

Use this page when you need the exported helper, builder, reader, constant, or module name. Use SDK Workflows first if you are still mapping a product flow.

Current release

The reference tracks SDK 0.8.4 against the current public Solana devnet beta protocol surface.

How to scan this page​

NeedGo to
Build transactionsCanonical builder surface
Read protocol stateCanonical readers
Derive addressesPDA helpers
Recompute reserve viewsReserve-model helpers
Normalize claim failuresClaims helpers
Package oracle attestationsOracle helpers

Core runtime entrypoints​

  • PROTOCOL_PROGRAM_ID
  • createConnection(...)
  • getOmegaXNetworkInfo(...)
  • OMEGAX_NETWORKS
  • createRpcClient(...)
  • createProtocolClient(...)
  • getProtocolIdl()
  • listProtocolInstructionNames()
  • listProtocolInstructionAccounts(...)
  • listProtocolAccountNames()
  • accountExists(...)
  • decodeProtocolAccount(...)
  • buildProtocolInstruction(...)
  • buildProtocolTransaction(...)
  • compileTransactionToV0(...)

RPC client​

  • getRecentBlockhash()
  • broadcastSignedTx(...)
  • simulateSignedTx(...)
  • getSignatureStatus(...)

Canonical builder surface​

Governance and controls​

  • buildInitializeProtocolGovernanceTx(...)
  • buildSetProtocolEmergencyPauseTx(...)
  • buildCreateReserveDomainTx(...)
  • buildUpdateReserveDomainControlsTx(...)
  • buildCreateDomainAssetVaultTx(...)
  • buildCreateHealthPlanTx(...)
  • buildUpdateHealthPlanControlsTx(...)
  • buildCreatePolicySeriesTx(...)
  • buildVersionPolicySeriesTx(...)
  • buildOpenMemberPositionTx(...)
  • buildUpdateMemberEligibilityTx(...)

Plan-side funding and liabilities​

  • buildOpenFundingLineTx(...)
  • buildFundSponsorBudgetTx(...)
  • buildRecordPremiumPaymentTx(...)
  • buildCreateObligationTx(...)
  • buildReserveObligationTx(...)
  • buildSettleObligationTx(...)
  • buildReleaseReserveTx(...)

Claims​

  • buildOpenClaimCaseTx(...)
  • buildAttachClaimEvidenceRefTx(...)
  • buildAttestClaimCaseTx(...)
  • buildAdjudicateClaimCaseTx(...)
  • buildSettleClaimCaseTx(...)

LP capital​

  • buildCreateLiquidityPoolTx(...)
  • buildCreateCapitalClassTx(...)
  • buildUpdateLpPositionCredentialingTx(...)
  • buildUpdateCapitalClassControlsTx(...)
  • buildDepositIntoCapitalClassTx(...)
  • buildRequestRedemptionTx(...)
  • buildProcessRedemptionQueueTx(...)

Fee vaults​

  • buildInitProtocolFeeVaultTx(...)
  • buildInitPoolTreasuryVaultTx(...)
  • buildInitPoolOracleFeeVaultTx(...)
  • buildWithdrawProtocolFeeSolTx(...)
  • buildWithdrawProtocolFeeSplTx(...)
  • buildWithdrawPoolTreasurySolTx(...)
  • buildWithdrawPoolTreasurySplTx(...)
  • buildWithdrawPoolOracleFeeSolTx(...)
  • buildWithdrawPoolOracleFeeSplTx(...)

Allocation and impairment​

  • buildCreateAllocationPositionTx(...)
  • buildUpdateAllocationCapsTx(...)
  • buildAllocateCapitalTx(...)
  • buildDeallocateCapitalTx(...)
  • buildMarkImpairmentTx(...)

Oracle and schema registry​

  • buildRegisterOracleTx(...)
  • buildClaimOracleTx(...)
  • buildUpdateOracleProfileTx(...)
  • buildSetPoolOracleTx(...)
  • buildSetPoolOraclePermissionsTx(...)
  • buildSetPoolOraclePolicyTx(...)
  • buildRegisterOutcomeSchemaTx(...)
  • buildVerifyOutcomeSchemaTx(...)
  • buildBackfillSchemaDependencyLedgerTx(...)
  • buildCloseOutcomeSchemaTx(...)

Custody-sensitive builders mirror the on-chain custody requirements. buildCreateDomainAssetVaultTx(...) derives the protocol-owned domain_asset_vault_token PDA. Sponsor funding, premium payments, LP capital deposits, and redemption processing require source or recipient token accounts, the canonical vault token account, asset mint, and token program accounts.

Canonical readers​

  • fetchProtocolGovernance(...)
  • fetchReserveDomain(...)
  • fetchDomainAssetVault(...)
  • fetchDomainAssetLedger(...)
  • fetchHealthPlan(...)
  • fetchPlanReserveLedger(...)
  • fetchPolicySeries(...)
  • fetchSeriesReserveLedger(...)
  • fetchMemberPosition(...)
  • fetchFundingLine(...)
  • fetchFundingLineLedger(...)
  • fetchClaimCase(...)
  • fetchClaimAttestation(...)
  • fetchObligation(...)
  • fetchLiquidityPool(...)
  • fetchCapitalClass(...)
  • fetchPoolClassLedger(...)
  • fetchLPPosition(...)
  • fetchAllocationPosition(...)
  • fetchAllocationLedger(...)
  • fetchOracleProfile(...)
  • fetchPoolOracleApproval(...)
  • fetchPoolOracleFeeVault(...)
  • fetchPoolOraclePolicy(...)
  • fetchPoolOraclePermissionSet(...)
  • fetchPoolTreasuryVault(...)
  • fetchProtocolFeeVault(...)
  • fetchOutcomeSchema(...)
  • fetchSchemaDependencyLedger(...)

PDA helpers​

  • getProgramId()
  • toPublicKey(...)
  • normalizeAddress(...)
  • utf8ByteLength(...)
  • isSeedIdSafe(...)
  • assertSeedId(...)
  • deriveProtocolGovernancePda(...)
  • deriveReserveDomainPda(...)
  • deriveDomainAssetVaultPda(...)
  • deriveDomainAssetVaultTokenAccountPda(...)
  • deriveDomainAssetLedgerPda(...)
  • deriveHealthPlanPda(...)
  • derivePlanReserveLedgerPda(...)
  • derivePolicySeriesPda(...)
  • deriveSeriesReserveLedgerPda(...)
  • deriveMemberPositionPda(...)
  • deriveMembershipAnchorSeatPda(...)
  • deriveFundingLinePda(...)
  • deriveFundingLineLedgerPda(...)
  • deriveClaimCasePda(...)
  • deriveObligationPda(...)
  • deriveLiquidityPoolPda(...)
  • deriveCapitalClassPda(...)
  • derivePoolClassLedgerPda(...)
  • deriveLpPositionPda(...)
  • deriveAllocationPositionPda(...)
  • deriveAllocationLedgerPda(...)
  • deriveOracleProfilePda(...)
  • derivePoolOracleApprovalPda(...)
  • derivePoolOracleFeeVaultPda(...)
  • derivePoolOraclePolicyPda(...)
  • derivePoolOraclePermissionSetPda(...)
  • derivePoolTreasuryVaultPda(...)
  • deriveProtocolFeeVaultPda(...)
  • deriveOutcomeSchemaPda(...)
  • deriveSchemaDependencyLedgerPda(...)
  • deriveClaimAttestationPda(...)

Seed constants​

  • SEED_PROTOCOL_GOVERNANCE
  • SEED_RESERVE_DOMAIN
  • SEED_DOMAIN_ASSET_VAULT
  • SEED_DOMAIN_ASSET_VAULT_TOKEN
  • SEED_DOMAIN_ASSET_LEDGER
  • SEED_HEALTH_PLAN
  • SEED_PLAN_RESERVE_LEDGER
  • SEED_POLICY_SERIES
  • SEED_SERIES_RESERVE_LEDGER
  • SEED_MEMBER_POSITION
  • SEED_MEMBERSHIP_ANCHOR_SEAT
  • SEED_FUNDING_LINE
  • SEED_FUNDING_LINE_LEDGER
  • SEED_CLAIM_CASE
  • SEED_OBLIGATION
  • SEED_LIQUIDITY_POOL
  • SEED_CAPITAL_CLASS
  • SEED_POOL_CLASS_LEDGER
  • SEED_LP_POSITION
  • SEED_ALLOCATION_POSITION
  • SEED_ALLOCATION_LEDGER
  • SEED_ORACLE_PROFILE
  • SEED_POOL_ORACLE_APPROVAL
  • SEED_POOL_ORACLE_FEE_VAULT
  • SEED_POOL_ORACLE_POLICY
  • SEED_POOL_ORACLE_PERMISSION_SET
  • SEED_POOL_TREASURY_VAULT
  • SEED_PROTOCOL_FEE_VAULT
  • SEED_OUTCOME_SCHEMA
  • SEED_SCHEMA_DEPENDENCY_LEDGER
  • SEED_CLAIM_ATTESTATION
  • ZERO_PUBKEY
  • ZERO_PUBKEY_KEY
  • MAX_ID_SEED_BYTES

Reserve-model helpers​

  • toBigIntAmount(...)
  • recomputeReserveBalanceSheet(...)
  • sumReserveBalanceSheets(...)
  • buildSponsorReadModel(...)
  • buildCapitalReadModel(...)
  • buildMemberReadModel(...)
  • bpsRatio(...)
  • shortenAddress(...)

Status and labeling helpers​

  • describeSeriesMode(...)
  • describeSeriesStatus(...)
  • describeFundingLineType(...)
  • describeEligibilityStatus(...)
  • describeClaimStatus(...)
  • describeObligationStatus(...)
  • describeCapitalRestriction(...)

Read-model constants​

  • SERIES_MODE_REWARD
  • SERIES_MODE_PROTECTION
  • SERIES_MODE_REIMBURSEMENT
  • SERIES_MODE_PARAMETRIC
  • SERIES_MODE_OTHER
  • SERIES_STATUS_DRAFT
  • SERIES_STATUS_ACTIVE
  • SERIES_STATUS_PAUSED
  • SERIES_STATUS_CLOSED
  • FUNDING_LINE_TYPE_SPONSOR_BUDGET
  • FUNDING_LINE_TYPE_PREMIUM_INCOME
  • FUNDING_LINE_TYPE_LIQUIDITY_POOL_ALLOCATION
  • FUNDING_LINE_TYPE_BACKSTOP
  • FUNDING_LINE_TYPE_SUBSIDY
  • FUNDING_LINE_STATUS_OPEN
  • FUNDING_LINE_STATUS_PAUSED
  • FUNDING_LINE_STATUS_CLOSED
  • ELIGIBILITY_PENDING
  • ELIGIBILITY_ELIGIBLE
  • ELIGIBILITY_PAUSED
  • ELIGIBILITY_CLOSED
  • CLAIM_INTAKE_OPEN
  • CLAIM_INTAKE_UNDER_REVIEW
  • CLAIM_INTAKE_APPROVED
  • CLAIM_INTAKE_DENIED
  • CLAIM_INTAKE_SETTLED
  • CLAIM_INTAKE_CLOSED
  • OBLIGATION_STATUS_PROPOSED
  • OBLIGATION_STATUS_RESERVED
  • OBLIGATION_STATUS_CLAIMABLE_PAYABLE
  • OBLIGATION_STATUS_SETTLED
  • OBLIGATION_STATUS_CANCELED
  • OBLIGATION_STATUS_IMPAIRED
  • OBLIGATION_STATUS_RECOVERED
  • OBLIGATION_DELIVERY_MODE_CLAIMABLE
  • OBLIGATION_DELIVERY_MODE_PAYABLE
  • REDEMPTION_POLICY_OPEN
  • REDEMPTION_POLICY_QUEUE_ONLY
  • REDEMPTION_POLICY_PAUSED
  • CAPITAL_CLASS_RESTRICTION_OPEN
  • CAPITAL_CLASS_RESTRICTION_RESTRICTED
  • CAPITAL_CLASS_RESTRICTION_WRAPPER_ONLY
  • LP_QUEUE_STATUS_NONE
  • LP_QUEUE_STATUS_PENDING
  • LP_QUEUE_STATUS_PROCESSED
  • PAUSE_FLAG_PROTOCOL_EMERGENCY
  • PAUSE_FLAG_DOMAIN_RAILS
  • PAUSE_FLAG_PLAN_OPERATIONS
  • PAUSE_FLAG_CLAIM_INTAKE
  • PAUSE_FLAG_CAPITAL_SUBSCRIPTIONS
  • PAUSE_FLAG_REDEMPTION_QUEUE_ONLY
  • PAUSE_FLAG_ORACLE_FINALITY_HOLD
  • PAUSE_FLAG_ALLOCATION_FREEZE

Claims helpers​

  • validateSignedClaimTx(...)
  • mapValidationReasonToClaimFailure(...)
  • normalizeClaimSimulationFailure(...)
  • normalizeClaimRpcFailure(...)

Claim attestation decision constants​

  • CLAIM_ATTESTATION_DECISION_SUPPORT_APPROVE
  • CLAIM_ATTESTATION_DECISION_SUPPORT_DENY
  • CLAIM_ATTESTATION_DECISION_REQUEST_REVIEW
  • CLAIM_ATTESTATION_DECISION_ABSTAIN

Oracle helpers​

  • createOracleSignerFromEnv(...)
  • createOracleSignerFromKmsAdapter(...)
  • attestOutcome(...)

Transaction helpers​

  • decodeSolanaTransaction(...)
  • serializeSolanaTransaction(...)
  • serializeSolanaTransactionBase64(...)
  • solanaTransactionMessageBytes(...)
  • solanaTransactionIntentMessageBytes(...)
  • solanaTransactionMessageBase64(...)
  • solanaTransactionRequiredSigner(...)
  • solanaTransactionFirstSignature(...)
  • solanaTransactionSignerSignature(...)

Utilities​

  • stableStringify(...)
  • sha256Hex(...)
  • sha256Bytes(...)
  • toIsoString(...)
  • nowIso()
  • newId(...)
  • anchorDiscriminator(...)
  • encodeU64Le(...)
  • encodeI64Le(...)
  • encodeU32Le(...)
  • encodeU16Le(...)
  • encodeString(...)
  • readU32Le(...)
  • readU16Le(...)
  • readU64Le(...)
  • readI64Le(...)
  • readString(...)
  • toHex(...)
  • fromHex(...)
  • hashStringTo32(...)

Next read​

Download PDF