Skip to main content

SDK API Reference

Complete public surface for @omegax/protocol-sdk.

Core entrypoints​

  • createConnection(rpcUrl, commitment?)
  • createRpcClient(connection)
  • createProtocolClient(connection, programId)
  • derivePoolAddress(...)

Claims helpers​

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

Oracle helpers​

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

RPC client methods​

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

Protocol builders (selected groups)​

Governance + protocol controls​

  • buildInitializeProtocolV2Tx(...)
  • buildSetProtocolParamsTx(...)
  • buildRotateGovernanceAuthorityTx(...)
  • buildRegisterOutcomeSchemaTx(...)
  • buildVerifyOutcomeSchemaTx(...)

Oracle lifecycle​

  • buildRegisterOracleV2Tx(...)
  • buildClaimOracleV2Tx(...)
  • buildUpdateOracleProfileV2Tx(...)
  • buildUpdateOracleMetadataTx(...)
  • buildStakeOracleTx(...)
  • buildRequestUnstakeTx(...)
  • buildFinalizeUnstakeTx(...)
  • buildSlashOracleTx(...)

Pool + reward flows​

  • buildCreatePoolV2Tx(...)
  • buildSetPoolStatusTx(...)
  • buildSetPoolOraclePolicyTx(...)
  • buildSetPoolTermsHashTx(...)
  • buildSetPoolOutcomeRuleTx(...)
  • buildFundPoolSolTx(...)
  • buildFundPoolSplTx(...)
  • buildSubmitRewardClaimTx(...)

Enrollment + delegates​

  • buildEnrollMemberOpenTx(...)
  • buildEnrollMemberTokenGateTx(...)
  • buildEnrollMemberInvitePermitTx(...)
  • buildSetClaimDelegateTx(...)

Coverage flows​

  • buildRegisterCoverageProductV2Tx(...)
  • buildUpdateCoverageProductV2Tx(...)
  • buildSubscribeCoverageProductV2Tx(...)
  • buildIssueCoveragePolicyFromProductV2Tx(...)
  • buildCreateCoveragePolicyTx(...)
  • buildMintPolicyNftTx(...)
  • buildPayPremiumOnchainTx(...)
  • buildAttestPremiumPaidOffchainTx(...)
  • buildSubmitCoverageClaimTx(...)
  • buildSettleCoverageClaimTx(...)

Protocol account readers​

Core readers​

  • fetchProtocolConfigV2()
  • fetchPool(...)
  • fetchPoolTerms(...)
  • fetchPoolOraclePolicy(...)
  • fetchMembershipRecord(...)
  • fetchClaimRecordV2(...)

Oracle readers​

  • fetchOracleProfile(...)
  • fetchOracleStakePosition(...)
  • fetchAttestationVote(...)

Coverage readers​

  • fetchCoverageProduct(...)
  • fetchCoveragePolicy(...)
  • fetchCoveragePolicyPositionNft(...)
  • fetchPremiumLedger(...)
  • fetchCoverageClaimRecord(...)

PDA / seed helpers​

Examples:

  • derivePoolPda(...)
  • deriveMembershipPda(...)
  • deriveOraclePda(...)
  • deriveOracleStakePda(...)
  • derivePoolOraclePolicyPda(...)
  • deriveClaimV2Pda(...)
  • deriveCoveragePolicyPda(...)
  • deriveCoverageProductPda(...)
  • deriveCoverageClaimPda(...)

Stable subpath exports​

  • @omegax/protocol-sdk/claims
  • @omegax/protocol-sdk/protocol
  • @omegax/protocol-sdk/protocol_seeds
  • @omegax/protocol-sdk/rpc
  • @omegax/protocol-sdk/oracle
  • @omegax/protocol-sdk/types
  • @omegax/protocol-sdk/utils
Download PDF