Menu 0.6.0 preview

Reference

Versions and Relay Address

Values follow the accepted ADRs for the Developer Preview.

Versions

FactValueMeaningSource
TrueSeal Release 0.6.0 The lockstep release of trueseal-sync and the three SDKs these docs describe. trueseal-sync ADR-0030
Transport Version 1 Device to Relay: the Noise handshake and frames. trueseal-sync ADR-0022; code: trueseal-sync docs/shared-facts.json (generated)
End-to-End Version 1 Device to Device: the Envelope, signatures and Addressed Encryption. trueseal-sync ADR-0022; code: trueseal-sync docs/shared-facts.json (generated)
Session State Store Version 1 The Store Version the first preview release writes to Session State. trueseal-sync ADR-0032; code: trueseal-sync docs/shared-facts.json (generated)
Relay Store Version 1 The Store Version the first preview relay writes to inbox.db. trueseal-relay ADR-0013

A component speaks exactly one Transport Version and one End-to-End Version and negotiates nothing. Version 0 is reserved. See Protocol and wire format for how each version is rejected. Each SDK reports sdkVersion, transportVersion and endToEndVersion in TrueSeal.info.

Relay Address

A Relay Address is one string: trueseal://<relay public key hex>@host[:receivePort][?push=pushPort].

FactValueMeaningSource
Relay Address format trueseal://<relay public key hex>@host[:receivePort][?push=pushPort] The single string a client is configured with. trueseal-sync ADR-0028; code: trueseal-sync docs/shared-facts.json (generated)
Default receive port 7700 The Receive Session listener, Noise XX. trueseal-sync ADR-0028; code: trueseal-sync src/ffi.rs, trueseal-relay internal/config/config.go
Default push port 7701 The Push Session listener, Noise NK. trueseal-sync ADR-0028; code: trueseal-sync src/ffi.rs, trueseal-relay internal/config/config.go
  • TrueSeal.open accepts the string or the typed form RelayAddress(host, publicKey, receivePort, pushPort).
  • A port missing from the string takes its default; a port given is never dropped.
  • The relay public key is the relay’s 32-byte X25519 public key in hex. The preview has no relay key rotation; changing the key breaks every client’s Relay Address.

Sources: trueseal-sync ADR-0028 and trueseal-relay ADR-0012.