AtHeartEngineer/specs
1
0
Fork 0
mirror of https://github.com/vacp2p/specs.git synced 2026-01-08 23:08:09 -05:00
Code Issues Packages Projects Releases Wiki Activity

relay/circuit-v2: Make Reservation::expire as required (#384)

Browse Source 
The Go implementation of the circuit relay v2 implementation treats the
`Reservation::expire` field as `required`:

``` Golang
result := &Reservation{}
result.Expiration = time.Unix(int64(rsvp.GetExpire()), 0)
if result.Expiration.Before(time.Now()) {
	return nil, fmt.Errorf("received reservation with expiration date in the past: %s", result.Expiration)
}
```

bfee9f5935/p2p/protocol/circuitv2/client/reservation.go (L88-L92)

Where `rsvp.GetExpire` returns `0` when `Reservation::expire` is not set:

``` Golang
func (m *Reservation) GetExpire() uint64 {
	if m != nil && m.Expire != nil {
		return *m.Expire
	}
	return 0
}
```

bfee9f5935/p2p/protocol/circuitv2/pb/circuit.pb.go (L414-L419)

While inexplicable to me why Go treats the non-set case equal to the default
value (`0`), we unfortunately have to take the go implementation as the source
of truth, given that it is already released.

With the above in mind and to prevent confusion for other implementations in
languages which do not treat the non-set case equal to the default value (`0`),
this commit marks the `Reservation::expire` field as `required`.
This commit is contained in:
Max Inden
2021-12-19 15:30:26 +01:00
committed by GitHub
parent efac6aceda
commit 70d7fda47d
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
relay/circuit-v2.md
View File

@@ -4,7 +4,7 @@ This is the version 2 of the libp2p Circuit Relay protocol.
| Lifecycle Stage | Maturity | Status | Latest Revision |
|-----------------|----------------|--------|-----------------|
| 1A | DRAFT | Active | r0, 2021-05-05 |
| 1A | DRAFT | Active | r1, 2021-12-17 |
Authors: [@vyzo]
@@ -398,7 +398,7 @@ message Peer {
}
message Reservation {
optional uint64 expire = 1; // Unix expiration time (UTC)
required uint64 expire = 1; // Unix expiration time (UTC)
repeated bytes addrs = 2; // relay addrs for reserving peer
optional bytes voucher = 3; // reservation voucher
}