diff --git a/api/api_full.go b/api/api_full.go index c07688ac0..c345bb12a 100644 --- a/api/api_full.go +++ b/api/api_full.go @@ -911,13 +911,21 @@ type FullNode interface { // GetActorEvents returns all FVM and built-in Actor events that match the given filter. // This is a request/response API. + // Results available from this API may be limited by the MaxFilterResults and MaxFilterHeightRange + // configuration options and also the amount of historical data available in the node. GetActorEvents(ctx context.Context, filter *types.ActorEventFilter) ([]*types.ActorEvent, error) //perm:read - // SubscribeActorEvents returns a long-lived stream of all FVM and built-in Actor events that match the given filter. - // Events that match the given filter are written to the stream in real-time as they are emitted from the FVM. - // The response stream is closed when the client disconnects or if there is an error while writing an event to the stream. - // This API also allows clients to read all historical events matching the given filter before - // any real-time events are written to the response stream. + // SubscribeActorEvents returns a long-lived stream of all FVM and built-in Actor events that + // match the given filter. + // Events that match the given filter are written to the stream in real-time as they are emitted + // from the FVM. + // The response stream is closed when the client disconnects, when a ToHeight is specified and is + // reached, or if there is an error while writing an event to the stream. + // This API also allows clients to read all historical events matching the given filter before any + // real-time events are written to the response stream if the filter specifies an earlier + // FromHeight. + // Results available from this API may be limited by the MaxFilterResults and MaxFilterHeightRange + // configuration options and also the amount of historical data available in the node. // NOTE: THIS API IS ONLY SUPPORTED OVER WEBSOCKETS FOR NOW SubscribeActorEvents(ctx context.Context, filter *types.ActorEventFilter) (<-chan *types.ActorEvent, error) //perm:read } diff --git a/build/openrpc/full.json.gz b/build/openrpc/full.json.gz index 10e58d209..97cd6f3d6 100644 Binary files a/build/openrpc/full.json.gz and b/build/openrpc/full.json.gz differ diff --git a/documentation/en/api-v1-unstable-methods.md b/documentation/en/api-v1-unstable-methods.md index 3185442ef..5aa9506cb 100644 --- a/documentation/en/api-v1-unstable-methods.md +++ b/documentation/en/api-v1-unstable-methods.md @@ -3392,6 +3392,8 @@ Response: ### GetActorEvents GetActorEvents returns all FVM and built-in Actor events that match the given filter. This is a request/response API. +Results available from this API may be limited by the MaxFilterResults and MaxFilterHeightRange +configuration options and also the amount of historical data available in the node. Perms: read @@ -8827,11 +8829,17 @@ Response: ### SubscribeActorEvents -SubscribeActorEvents returns a long-lived stream of all FVM and built-in Actor events that match the given filter. -Events that match the given filter are written to the stream in real-time as they are emitted from the FVM. -The response stream is closed when the client disconnects or if there is an error while writing an event to the stream. -This API also allows clients to read all historical events matching the given filter before -any real-time events are written to the response stream. +SubscribeActorEvents returns a long-lived stream of all FVM and built-in Actor events that +match the given filter. +Events that match the given filter are written to the stream in real-time as they are emitted +from the FVM. +The response stream is closed when the client disconnects, when a ToHeight is specified and is +reached, or if there is an error while writing an event to the stream. +This API also allows clients to read all historical events matching the given filter before any +real-time events are written to the response stream if the filter specifies an earlier +FromHeight. +Results available from this API may be limited by the MaxFilterResults and MaxFilterHeightRange +configuration options and also the amount of historical data available in the node. NOTE: THIS API IS ONLY SUPPORTED OVER WEBSOCKETS FOR NOW