Update and rename LIGHTPUSH.md to lightpush.md

This commit is contained in:
Jimmy Debe 2024-02-01 21:53:25 -05:00 committed by GitHub
parent 244ea55480
commit c88680ab64
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 9 deletions

View File

@ -10,7 +10,7 @@ contributors:
**Protocol identifier**: `/vac/waku/lightpush/2.0.0-beta1` **Protocol identifier**: `/vac/waku/lightpush/2.0.0-beta1`
# Motivation and Goals ## Motivation and Goals
Light nodes with short connection windows and limited bandwidth wish to publish messages into the Waku network. Light nodes with short connection windows and limited bandwidth wish to publish messages into the Waku network.
Additionally, there is sometimes a need for confirmation that a message has been received "by the network" Additionally, there is sometimes a need for confirmation that a message has been received "by the network"
@ -18,7 +18,7 @@ Additionally, there is sometimes a need for confirmation that a message has been
`19/WAKU2-LIGHTPUSH` is a request/response protocol for this. `19/WAKU2-LIGHTPUSH` is a request/response protocol for this.
# Payloads ## Payloads
```protobuf ```protobuf
syntax = "proto3"; syntax = "proto3";
@ -41,11 +41,11 @@ message PushRPC {
} }
``` ```
## Message Relaying ### Message Relaying
Nodes that respond to `PushRequests` MUST either Nodes that respond to `PushRequests` MUST either
relay the encapsulated message via [11/WAKU2-RELAY](/spec/11) protocol on the specified `pubsub_topic`, relay the encapsulated message via [11/WAKU2-RELAY](../11/relay.md) protocol on the specified `pubsub_topic`,
or forward the `PushRequest` via 19/LIGHTPUSH on a [44/WAKU2-DANDELION](https://rfc.vac.dev/spec/44/) stem. or forward the `PushRequest` via 19/LIGHTPUSH on a [44/WAKU2-DANDELION](https://github.com/waku-org/specs/blob/waku-RFC/standards/application/dandelion.md) stem.
If they are unable to do so for some reason, they SHOULD return an error code in `PushResponse`. If they are unable to do so for some reason, they SHOULD return an error code in `PushResponse`.
## Security Considerations ## Security Considerations
@ -55,11 +55,12 @@ This can be done by rate limiting via [17/WAKU2-RLN-RELAY](https://rfc.vac.dev/s
Note that the above is currently not fully implemented. Note that the above is currently not fully implemented.
# Copyright ## Copyright
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
# References ## References
* [11/WAKU2-RELAY](/spec/11) * [11/WAKU2-RELAY](../11/relay.md)
* [44/WAKU2-DANDELION](https://rfc.vac.dev/spec/44/) * [44/WAKU2-DANDELION](https://github.com/waku-org/specs/blob/waku-RFC/standards/application/dandelion.md)
* [17/WAKU2-RLN-RELAY](../17/rln-relay.md)