Choosing the Right Provider

Provider Types

JSONRpcProvider

The JSONRpcProvider communicates over HTTP using the standard JSON-RPC protocol. Each method call sends an independent request and waits for a response, with no persistent connection maintained between calls. This stateless model makes it the default choice for most applications.

Best suited for:

• Standard request/response operations.
• Server-side applications and backend services where real-time updates are not required.
• Stateless interactions.
• Simple integrations.

import { JSONRpcProvider } from 'opnet';
import { networks } from '@btc-vision/bitcoin';

const provider = new JSONRpcProvider({
    url: 'https://regtest.opnet.org',
    network: networks.regtest
});

import { JSONRpcProvider } from 'opnet';
import { networks } from '@btc-vision/bitcoin';

const provider = new JSONRpcProvider({
    url: 'https://regtest.opnet.org',
    network: networks.regtest
});

WebSocketRpcProvider (experimental)

The WebSocketRpcProvider maintains a persistent WebSocket connection to the OP_NET node, enabling the server to push updates to the client without polling. In addition to supporting all standard provider methods, it exposes subscription-based APIs for receiving real-time notifications as events occur on the network.

Best suited for:

• Real-time block and epoch notifications without continuous polling.
• Event-driven applications that need to react immediately to on-chain state changes.
• Long-running processes that benefit from a persistent connection.

import { WebSocketRpcProvider } from 'opnet';
import { networks } from '@btc-vision/bitcoin';

const provider = new WebSocketRpcProvider({
    url: 'wss://regtest.opnet.org/ws',
    network: networks.regtest
);

// Subscribe to new blocks
provider.subscribeToBlocks((block) => {
    console.log('New block:', block.height);
});

import { WebSocketRpcProvider } from 'opnet';
import { networks } from '@btc-vision/bitcoin';

const provider = new WebSocketRpcProvider({
    url: 'wss://regtest.opnet.org/ws',
    network: networks.regtest
);

// Subscribe to new blocks
provider.subscribeToBlocks((block) => {
    console.log('New block:', block.height);
});

Provider Selection

Use the following diagram to select the appropriate provider based on your application requirements: