|
1 | 1 | - name: eth_newFilter
|
2 |
| - summary: Creates a filter object, based on filter options, to notify when the state changes (logs). |
| 2 | + summary: Install a log filter in the server, allowing for later polling. Registers client interest in logs matching the filter, and returns an identifier. |
3 | 3 | params:
|
4 | 4 | - name: Filter
|
5 | 5 | schema:
|
6 | 6 | $ref: '#/components/schemas/Filter'
|
| 7 | + required: true |
7 | 8 | result:
|
8 | 9 | name: Filter identifier
|
9 | 10 | schema:
|
|
21 | 22 | name: Filter identifier
|
22 | 23 | value: '0x01'
|
23 | 24 | - name: eth_newBlockFilter
|
24 |
| - summary: Creates a filter in the node, to notify when a new block arrives. |
| 25 | + summary: Creates a filter in the node, allowing for later polling. Registers client interest in new blocks, and returns an identifier. |
25 | 26 | params: []
|
26 | 27 | result:
|
27 | 28 | name: Filter identifier
|
|
34 | 35 | name: Filter identifier
|
35 | 36 | value: '0x01'
|
36 | 37 | - name: eth_newPendingTransactionFilter
|
37 |
| - summary: Creates a filter in the node, to notify when new pending transactions arrive. |
| 38 | + summary: Creates a filter in the node, allowing for later polling. Registers client interest in new transactions, and returns an identifier. |
38 | 39 | params: []
|
39 | 40 | result:
|
40 | 41 | name: Filter identifier
|
|
52 | 53 | - name: Filter identifier
|
53 | 54 | schema:
|
54 | 55 | $ref: '#/components/schemas/uint'
|
| 56 | + required: true |
55 | 57 | result:
|
56 | 58 | name: Success
|
57 | 59 | schema:
|
|
65 | 67 | name: Success
|
66 | 68 | value: true
|
67 | 69 | - name: eth_getFilterChanges
|
68 |
| - summary: Polling method for the filter with the given ID (created using `eth_newFilter`). Returns an array of logs which occurred since last poll. |
| 70 | + summary: Polling method for the filter with the given ID (created using `eth_newFilter`). Returns an array of logs, block hashes, or transaction hashes since last poll, depending on the installed filter. |
69 | 71 | params:
|
70 | 72 | - name: Filter identifier
|
71 | 73 | schema:
|
72 | 74 | $ref: '#/components/schemas/uint'
|
| 75 | + required: true |
73 | 76 | result:
|
74 | 77 | name: Log objects
|
75 | 78 | schema:
|
|
110 | 113 | - name: Filter identifier
|
111 | 114 | schema:
|
112 | 115 | $ref: '#/components/schemas/uint'
|
| 116 | + required: true |
113 | 117 | result:
|
114 | 118 | name: Log objects
|
115 | 119 | schema:
|
|
150 | 154 | - name: Filter
|
151 | 155 | schema:
|
152 | 156 | $ref: '#/components/schemas/Filter'
|
| 157 | + required: true |
153 | 158 | result:
|
154 | 159 | name: Log objects
|
155 | 160 | schema:
|
|
0 commit comments