Skip to content

Commit ec2a15c

Browse files
fix: #1259 fix protobuf spec to clarify that "infinite" is uint64_max. (#1264)
* Fixed the proto spec for subscribe stream API * Fixed a missing project value for the bug template. Signed-off-by: Joseph S <121976561+jsync-swirlds@users.noreply.github.com>
1 parent 54c9eba commit ec2a15c

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

.github/ISSUE_TEMPLATE/03-Bug-Template.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# SPDX-License-Identifier: Apache-2.0
22
name: Block Node Bug Report
33
description: Create a report to help us improve
4+
projects:
5+
- "hiero-ledger/9"
46
labels:
57
- bug
6-
type: Bug
8+
type: "Bug"
79
body:
810
- type: markdown
911
attributes:

protobuf-sources/src/main/proto/block-node/api/block_stream_subscribe_service.proto

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,10 @@ message SubscribeStreamRequest {
3737

3838
/**
3939
* A block number to end the stream.<br/>
40-
* This is optional, and if not set (0), the stream will be "infinite".
4140
* <p>
42-
* This field MAY be zero (`0`) to indicate the stream SHOULD continue
41+
* This field MAY be `uint64_max` to indicate the stream SHOULD continue
4342
* indefinitely, streaming new blocks as each becomes available.<br/>
44-
* If this value is greater than zero (`0`)
43+
* If this value is greater than or equal to zero (`0`)
4544
* <ul>
4645
* <li>This value SHALL be the number of the last block returned.</li>
4746
* <li>This field MUST NOT be less than `start_block_number`.</li>
@@ -125,7 +124,7 @@ message SubscribeStreamResponse {
125124
/**
126125
* The requested end block number is not valid.<br/>
127126
* The end block number is greater than the highest current block
128-
* number, less than `0`, or otherwise invalid.<br/>
127+
* number, less than `start_block_number`, or otherwise invalid.<br/>
129128
* The client MAY retry this request, but MUST change the
130129
* `end_block_number` field to a valid end block.
131130
*/
@@ -174,9 +173,9 @@ service BlockStreamSubscribeService {
174173
* The blocks shall be streamed in ascending order by `block_number`.<br/>
175174
* The block node SHALL end the stream when the last requested block,
176175
* if set, has been sent.<br/>
177-
* A request with an end block of `0` SHALL be interpreted to indicate the
178-
* stream has no end. The block node SHALL continue to stream new blocks
179-
* as soon as each becomes available.<br/>
176+
* A request with an end block of `uint64_max` SHALL be interpreted to
177+
* indicate the stream has no end. The block node SHALL continue to stream
178+
* new blocks as soon as each becomes available.<br/>
180179
* The block node SHALL end the stream with response code containing a
181180
* status of SUCCESS when the stream is complete.<br/>
182181
* The block node SHALL end the stream with a response code containing a

0 commit comments

Comments
 (0)