eth_unsubscribe - Optimism

Example code for the eth_unsubscribe json-rpc method. Сomplete guide on how to use eth_unsubscribe json-rpc in GetBlock.io Web3 documentation.

This method cancels a subscription that was created with eth_subscribe. Once cancelled, no more notifications will be sent for that subscription. This should be called when real-time updates are no longer needed.

The eth_unsubscribe method cancels an existing WebSocket subscription on Optimism.

Parameters

Parameter

Type

Description

Required

subscriptionId

String

The subscription ID to cancel.

Yes

Request Sample

cURL (wscat)

# This method requires WebSocket connection
wscat -c wss://go.getblock.io/<ACCESS-TOKEN>/

> {"jsonrpc":"2.0","method":"eth_unsubscribe","params":["0x1"],"id":"getblock.io"}

JavaScript (ws)

const WebSocket = require('ws');

const ws = new WebSocket('wss://go.getblock.io/<ACCESS-TOKEN>/');

ws.on('open', () => {
    ws.send(JSON.stringify({
        jsonrpc: '2.0',
        method: 'eth_unsubscribe',
        params: ['0x1'],
        id: 'getblock.io'
    }));
});

ws.on('message', (data) => {
    console.log(JSON.parse(data));
});

Python (websockets)

import asyncio
import websockets
import json

async def unsubscribe():
    uri = "wss://go.getblock.io/<ACCESS-TOKEN>/"
    async with websockets.connect(uri) as ws:
        payload = {
            "jsonrpc": "2.0",
            "method": "eth_unsubscribe",
            "params": ["0x1"],
            "id": "getblock.io"
        }
        await ws.send(json.dumps(payload))
        response = await ws.recv()
        print(json.loads(response))

asyncio.run(unsubscribe())

Rust (tokio-tungstenite)

use tokio_tungstenite::connect_async;
use futures_util::{SinkExt, StreamExt};
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let url = "wss://go.getblock.io/<ACCESS-TOKEN>/";
    let (mut ws, _) = connect_async(url).await?;
    
    let payload = json!({
        "jsonrpc": "2.0",
        "method": "eth_unsubscribe",
        "params": ["0x1"],
        "id": "getblock.io"
    });
    
    ws.send(payload.to_string().into()).await?;
    
    if let Some(msg) = ws.next().await {
        println!("{:?}", msg?);
    }
    
    Ok(())
}

Response

A successful response returns the following:

{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": true
}

Response Parameters

id: A unique request identifier, matching the id sent in the request body.
jsonrpc: Specifies the use of JSON-RPC version 2.0.
result: Boolean indicating whether the subscription was successfully cancelled.

Use Case

The eth_unsubscribe method is commonly used for:

Subscription management
Resource cleanup
Connection lifecycle management

Error Handling

Error Code

Description

-32602

Invalid subscription ID

-32603

Internal error

SDK Integration

Ethers.js

const { ethers } = require('ethers');

const provider = new ethers.WebSocketProvider('wss://go.getblock.io/<ACCESS-TOKEN>/');

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

// Later: unsubscribe
provider.removeAllListeners('block');

Viem

import { createPublicClient, webSocket } from 'viem';
import { optimism } from 'viem/chains';

const client = createPublicClient({
    chain: optimism,
    transport: webSocket('wss://go.getblock.io/<ACCESS-TOKEN>/')
});

const unwatch = client.watchBlocks({
    onBlock: block => console.log(block.number)
});

// Later: unsubscribe
unwatch();

Previouseth_uninstallFilter - Optimism Nextnet_listening - Optimism

Last updated 2 days ago

Was this helpful?

hashtagParameters

hashtagRequest Sample

hashtagResponse

hashtagResponse Parameters

hashtagUse Case

hashtagError Handling

hashtagSDK Integration

Parameters

Request Sample

Response

Response Parameters

Use Case

Error Handling

SDK Integration