Skip to content

Commit cd0408a

Browse files
authored
remove reference to priv methods from public reference (#1897)
* remove reference to priv_getLogs from public reference Signed-off-by: Sally MacFarlane <[email protected]> * remove reference to priv_subscribe from public reference Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]>
1 parent 32169b1 commit cd0408a

3 files changed

Lines changed: 6 additions & 14 deletions

File tree

docs/public-networks/how-to/use-besu-api/access-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ When a filter is no longer required, use [`eth_uninstallFilter`](../../reference
136136

137137
## Get logs using a filter options object
138138

139-
To get all logs for a filter options object, use [`eth_getLogs`](../../reference/api/index.md#eth_getlogs) or [`priv_getLogs`](../../../private-networks/reference/api.md#priv_getlogs) for a private contract.
139+
To get all logs for a filter options object, use [`eth_getLogs`](../../reference/api/index.md#eth_getlogs).
140140

141141
The following request for `eth_getLogs` returns all the logs where the example contract has been deployed to `0x42699a7612a82f1d9c36148af9c77354759b210b` and executed with `valueIndexed` set to 5.
142142

docs/public-networks/how-to/use-besu-api/rpc-pubsub.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ Unlike other [Besu API methods](../../reference/api/index.md), you cannot call t
3131

3232
[WebSockets](json-rpc.md#http-and-websocket-requests) supports the RPC Pub/Sub API.
3333

34-
To create subscriptions, use `eth_subscribe` or `priv_subscribe`. Once subscribed, the API publishes notifications using `eth_subscription` or `priv_subscription`.
34+
To create subscriptions, use `eth_subscribe`. Once subscribed, the API publishes notifications using `eth_subscription`.
3535

3636
Subscriptions couple with connections. If a connection is closed, all subscriptions created over the connection are removed.
3737

3838
### Subscription ID
3939

40-
`eth_subscribe` and `priv_subscribe` return a subscription ID for each subscription created. Notifications include the subscription ID.
40+
`eth_subscribe` returns a subscription ID for each subscription created. Notifications include the subscription ID.
4141

4242
For example, to create a synchronizing subscription:
4343

@@ -82,14 +82,6 @@ Use `eth_subscribe` to create subscriptions for the following event types:
8282
- [Dropped transactions](#dropped-transactions)
8383
- [Synchronizing](#synchronizing)
8484

85-
Use `priv_subscribe` to [create subscriptions for logs on private contracts](#logs).
86-
87-
:::tip
88-
89-
Only logs subscriptions are relevant for private transactions because private transactions are anchored to the public chain rather than having their own private blockchain.
90-
91-
:::
92-
9385
### New headers
9486

9587
To notify you about each block added to the blockchain, use the `newHeads` parameter with `eth_subscribe`.

docs/public-networks/reference/api/objects.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Returned by [`eth_feeHistory`](index.md#eth_feehistory) for the requested block
8787

8888
## Filter options object
8989

90-
Parameter for [`eth_newFilter`](index.md#eth_newfilter), [`eth_getLogs`](index.md#eth_getlogs), and [`priv_getLogs`](../../../private-networks/reference/api.md#priv_getlogs). Used to [`filter logs`](../../how-to/use-besu-api/access-logs.md).
90+
Parameter for [`eth_newFilter`](index.md#eth_newfilter), and [`eth_getLogs`](index.md#eth_getlogs).
9191

9292
| Key | Type | Required/Optional | Value |
9393
| --- | :-: | :-: | --- |
@@ -96,15 +96,15 @@ Parameter for [`eth_newFilter`](index.md#eth_newfilter), [`eth_getLogs`](index.m
9696
| `address` | Data &#124; Array | Optional | Contract address or array of addresses from which [logs](../../concepts/events-and-logs.md) originate. |
9797
| `topics` | Array of Data, 32&nbsp;bytes each | Optional | Array of topics by which to [filter logs](../../concepts/events-and-logs.md#topic-filters). |
9898

99-
[`eth_getLogs`](index.md#eth_getlogs) and [`priv_getLogs`](../../../private-networks/reference/api.md#priv_getlogs) have an extra key.
99+
[`eth_getLogs`](index.md#eth_getlogs) has an extra key.
100100

101101
| Key | Type | Required/Optional | Value |
102102
| --- | :-: | :-: | --- |
103103
| `blockHash` | Data, 32&nbsp;bytes | Optional. | Hash of block for which to return logs. If you specify `blockHash`, you cannot specify `fromBlock` and `toBlock`. |
104104

105105
## Log object
106106

107-
Returned by [`eth_getFilterChanges`](index.md#eth_getfilterchanges) and [`priv_getLogs`](../../../private-networks/reference/api.md#priv_getlogs).
107+
Returned by [`eth_getFilterChanges`](index.md#eth_getfilterchanges).
108108
[Transaction receipt objects](#transaction-receipt-object) and [call result objects](#call-result-object) can contain an array of log objects.
109109

110110
| Key | Type | Value |

0 commit comments

Comments
 (0)