Skip to main content

eth_newFilter

Method​

  • JSON-RPC method name: eth_newFilter
  • JSON-RPC version: 2.0

Parameters​

NameTypeRequiredDescription
Filterobjectno

Parameter schema​

{
  "Filter": {
    "required": false,
    "schema": {
      "title": "filter",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "fromBlock": {
          "title": "from block",
          "type": "string",
          "pattern": "^0x([1-9a-f]+[0-9a-f]*|0)$"
        },
        "toBlock": {
          "title": "to block",
          "type": "string",
          "pattern": "^0x([1-9a-f]+[0-9a-f]*|0)$"
        },
        "address": {
          "title": "Address(es)",
          "oneOf": [
            {
              "title": "Any Address",
              "type": "null"
            },
            {
              "title": "Address",
              "type": "string",
              "pattern": "^0x[0-9a-fA-F]{40}$"
            },
            {
              "title": "Addresses",
              "type": "array",
              "items": {
                "title": "hex encoded address",
                "type": "string",
                "pattern": "^0x[0-9a-fA-F]{40}$"
              }
            }
          ]
        },
        "topics": {
          "title": "Topics",
          "oneOf": [
            {
              "title": "Any Topic Match",
              "type": "null"
            },
            {
              "title": "Specified Filter Topics",
              "type": "array",
              "items": {
                "title": "Filter Topic List Entry",
                "oneOf": [
                  {
                    "title": "Single Topic Match",
                    "type": "string",
                    "pattern": "^0x[0-9a-f]{64}$"
                  },
                  {
                    "title": "Multiple Topic Match",
                    "type": "array",
                    "items": {
                      "title": "32 hex encoded bytes",
                      "type": "string",
                      "pattern": "^0x[0-9a-f]{64}$"
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}

Result​

  • Name: Filter identifier
  • Type: string

Result schema​

{
  "title": "hex encoded unsigned integer",
  "type": "string",
  "pattern": "^0x([1-9a-f]+[0-9a-f]*|0)$"
}

Positional parameters​

Parameter order:

  1. Filter

Errors​

This method may return JSON-RPC standard errors (e.g. -32600, -32601, -32602, -32603) as well as application-specific errors.

TODO: Document method-specific error codes and conditions.

Named Parameters
{
  "jsonrpc": "2.0",
  "method": "eth_newFilter",
  "params": {
    "Filter": {
      "fromBlock": "string",
      "toBlock": "string",
      "address": "example",
      "topics": "example"
    }
  },
  "id": 1
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": "string",
  "id": 1
}
Positional Parameters
{
  "jsonrpc": "2.0",
  "method": "eth_newFilter",
  "params": [
    {
      "fromBlock": "string",
      "toBlock": "string",
      "address": "example",
      "topics": "example"
    }
  ],
  "id": 2
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": "string",
  "id": 2
}