JavaScript SDK

Integrate Incrypt Oracle into your JavaScript applications with our comprehensive SDK. Built for Node.js, React, and browser environments.

Get Started View on GitHub

Installation

Install the Incrypt Oracle SDK using your preferred package manager:

npm

npm install incrypt-oracle-sdk

📋 Requirements

• Node.js 16.0.0 or higher
• ethers.js ^6.0.0 (peer dependency)
• A BSC-compatible wallet or signer for write operations

Quick Start Examples

JavaScript

import { IncryptOracle } from 'incrypt-oracle-sdk';

// Initialize the oracle
const oracle = new IncryptOracle({
  network: 'bsc-mainnet',
  rpcUrl: 'https://bsc-dataseed1.binance.org/'
});

// Get latest price
const btcPrice = await oracle.getPrice('BTC/USD');
console.log(`BTC: $${btcPrice.value}`);

💡 Basic usage for getting oracle data in any JavaScript environment.

API Reference

constructor(config)

Initialize the Oracle SDK instance

METHOD

Parameters:

config.network(string)*

Network identifier (bsc-mainnet, bsc-testnet)

config.rpcUrl(string)

Custom RPC endpoint URL

config.contractAddress(string)

Custom oracle contract address

config.signer(Signer)

Ethers.js signer for write operations

Returns:

IncryptOracle instance

getPrice(feedId)

Get the latest price for a specific data feed

METHOD

Parameters:

feedId(string)*

Data feed identifier (e.g., "BTC/USD")

Returns:

Promise<PriceData>

Example:

const btcPrice = await oracle.getPrice("BTC/USD");

subscribe(feedId, callbacks)

Subscribe to real-time updates for a data feed

METHOD

Parameters:

feedId(string)*

Data feed identifier

callbacks.onData(function)*

Callback for data updates

callbacks.onError(function)

Callback for errors

Returns:

Subscription object with unsubscribe method

Example:

const sub = oracle.subscribe("ETH/USD", { onData: console.log });

getAllFeeds()

Get list of all available data feeds

METHOD

Returns:

Promise<DataFeed[]>

Example:

const feeds = await oracle.getAllFeeds();

getValidator(address)

Get validator information by address

METHOD

Parameters:

address(string)*

Validator wallet address

Returns:

Promise<ValidatorInfo>

Example:

const validator = await oracle.getValidator("0x...");

TypeScript Support

The Incrypt Oracle SDK includes comprehensive TypeScript definitions for better development experience.

TYPESCRIPT

interface PriceData {
  value: number;
  confidence: number;
  timestamp: number;
  feedId: string;
}

interface OracleConfig {
  network: 'bsc-mainnet' | 'bsc-testnet';
  rpcUrl?: string;
  contractAddress?: string;
  signer?: ethers.Signer;
}

declare class IncryptOracle {
  constructor(config: OracleConfig);
  getPrice(feedId: string): Promise<PriceData>;
  subscribe(feedId: string, callbacks: SubscriptionCallbacks): Subscription;
  getAllFeeds(): Promise<DataFeed[]>;
}