[Filter] klay_newFilter

Creates a filter object, based on filter options, to notify when the state changes (logs).

• To check if the state has changed, call klay_getFilterChanges.
• To obtain all logs matching the filter created by klay_newFilter, call klay_getFilterLogs.

A note on specifying topic filters: Topics are order-dependent. A transaction with a log with topics [A, B] will be matched by the following topic filters:

• [] "anything"
• [A] "A in first position (and anything after)"
• [null, B] "anything in first position AND B in second position (and anything after)"
• [A, B] "A in first position AND B in second position (and anything after)"
• [[A, B], [A, B]] "(A OR B) in first position AND (A OR B) in second position (and anything after)"

NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string "earliest" and "latest" are available.

JSONRPC: klay_newFilter

Request

application/json

Body

method stringrequired

Default value: klay_newFilter

Method name

id int64required

Default value: 1

Request ID, Random or Auto incrementation

jsonrpc stringrequired

Default value: 2.0

JSON-RPC Version (2.0)

params

object[]

required

Array [

fromBlock

object

(optional, default: "latest") Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter.

oneOf

IntegerBlockNumber

number

HexadecimalBlockNumber

string

BlockTag

string

toBlock

object

(optional, default: "latest") Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter.

oneOf

IntegerBlockNumber

number

HexadecimalBlockNumber

string

BlockTag

string

address

object

(optional) Contract address or a list of addresses from which logs should originate.

oneOf

MOD1

Array [

anyOf

Address

string

]

Address

string

topics 32-byte DATA[]

(optional) Array of 32-byte DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with "or" options.

]

Responses

200

Returns a filter id

application/json

Schema

Schema

jsonrpc stringrequired

Default value: 2.0

id int64required

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

| code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result hex

A filter id

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": "0xd32fd16b6906e67f6e2b65dcf48fc272"
}

Loading...