Skip to content

Commit

Permalink
update block header messages and add deprecation notes
Browse files Browse the repository at this point in the history
  • Loading branch information
BrandtH22 committed Jan 14, 2025
1 parent 74fc86a commit aef0691
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions docs/protocol/wallet-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@ class NewPeakWallet(Streamable):

## request_block_header

DEPRECATED: this message has been deprecated and replaced with request_block_headers (plural).
A request from the wallet to the full node for a HeaderBlock at a specific height.

```python
Expand All @@ -121,7 +120,6 @@ class RequestBlockHeader(Streamable):

## respond_block_header

DEPRECATED: this message has been deprecated and replaced with respond_block_headers (plural).
A response to a `request_block_header` request.

```python
Expand All @@ -131,7 +129,8 @@ class RespondBlockHeader(Streamable):

## request_block_headers

A request from the wallet to the full node for a HeaderBlock at a specific height.
A request from the wallet to the full node for a HeaderBlock at a specific height.
NOTE: this message deprecates and replaces `request_header_blocks` (flip block and header).

```python
class RequestBlockHeaders(Streamable):
Expand All @@ -140,13 +139,25 @@ class RequestBlockHeaders(Streamable):

## respond_block_headers

A response to a `request_block_headers` request.
A response to a `request_block_headers` request.
NOTE: this message deprecates and replaces `respond_header_blocks` (flip block and header).

```python
class RespondBlockHeaders(Streamable):
header_block: HeaderBlock
```

## reject_block_headers

A rejection to a `request_block_headers` request.
NOTE: this message deprecates and replaces `reject_header_blocks` (flip block and header).

```python
class RejectBlockHeaders(Streamable):
start_height: uint32
end_height: uint32
```

## reject_header_request

A rejection to a `request_block_header` request.
Expand Down Expand Up @@ -235,6 +246,7 @@ class RejectAdditionsRequest(Streamable):

## request_header_blocks

DEPRECATED: this message has been deprecated and replaced with `request_block_headers` (flip block and header).
A request from the wallet to the full node for a list of consecutive header blocks, inclusive.

```python
Expand All @@ -245,6 +257,7 @@ class RequestHeaderBlocks(Streamable):

## reject_header_blocks

DEPRECATED: this message has been deprecated and replaced with `reject_block_headers` (flip block and header).
A rejection for a `request_header_blocks` request.

```python
Expand All @@ -255,6 +268,7 @@ class RejectHeaderBlocks(Streamable):

## respond_header_blocks

DEPRECATED: this message has been deprecated and replaced with `respond_block_headers` (flip block and header).
A response to a `request_header_blocks` request.

```python
Expand Down

0 comments on commit aef0691

Please sign in to comment.