SDK Reference

export interface RequestSignedDataOptions {
  feedId: string;
  signaturesRequired: number;
  apiConfig: APIConfig;
  subscriptionOwner?: string;
  consumerAuthority?: string;
  /** Override gateway auth signer for this call. */
  signer?: Signer;
  /** Encrypt private API secrets for selected nodes. */
  encrypt?: { secrets: Record<string, string> };
  /** Max accepted value age in seconds. Default 60. */
  maxAge?: number;
  /** Each retry re-rolls the timestamp. Default 15. */
  maxRetries?: number;
  /** Per-request timeout in ms. Default 5000. */
  timeoutMs?: number;
  /** Reuse registry + nodes from `prepareContext` (opt-in cache). */
  context?: Partial<RoundContext>;
  verifyNodeKeys?: NodeKeyVerifier;
  /** Unsafe: skip node-key auth for private APIs. Default false. */
  allowUnverifiedNodeKeysForPrivateApi?: boolean;
}

export interface APIConfig {
  url: string;
  method?: "GET" | "POST" | "PUT";
  headers?: Record<string, string>;
  responseParser: string;
  valueTransform?: string;
}

export interface RoundContext {
  registryVersion: number;
  redundancyBuffer: number;
  nodes: Node[];
}

export interface DataUpdateResult {
  feedId: string;
  /** Human-readable value. */
  value: string;
  /** 32-byte packed value, hex. */
  valuePacked: string;
  /** canonicalTimestamp (seconds). */
  timestamp: number;
  registryVersion: number;
  signaturesRequired: number;
  /** 32-byte big-endian bitmap, hex. */
  signersBitmap: string;
  /** 32-byte scalar, hex. */
  s: string;
  /** 20-byte commitment address, hex. */
  commitmentAddr: string;
  /** Whether the value was freshly fetched this round. */
  fresh: boolean;
}

type MolphaWallet = Wallet & {
  signAuthMessage?: (msg: Uint8Array) => Promise<Uint8Array>;
};

enum PlanType {
  Basic = 0,
  // Standard / Professional / Enterprise reserved (on-chain ordinals 1–3)
}

// feedId = keccak256("MOLPHA_JOB_V1" || owner || apiConfigHash || [signaturesRequired])
export function deriveFeedId(
  owner: Uint8Array,
  apiConfigHash: Uint8Array,
  signaturesRequired: number,
): Uint8Array;

export function deriveFeedIdString(
  owner: Uint8Array,
  apiConfigHash: Uint8Array,
  signaturesRequired: number,
): string;

// 32-byte keccak commitment to the canonicalized API config
export function deriveApiConfigHash(apiConfig: APIConfig): Uint8Array;