README
¶
This sync package contains the code related to negentropy (event-set-reconciliation) and using the BitTorrent / Mainline DHT for broadcast and discovery of relays.
BEP44: BitTorrent DHT Token Management
BEP44 is a BitTorrent protocol that enables posting arbitrary signed data to hashes derived from a BitTorrent public key.
How It Works
- DHT Key: Nestr users that supply a dht_key can declare their list of known relays (urls) to the DHT
- Target: The input to the DHT for BEP44 is SHA1(pubkey + salt) where the salt is optional bytes (we use empty salt)
- Periodic Upload: The RelayStore object periodically re-uploads the users' relay lists to the DHT, which holds it for about 2 hours
- Relay Retrieval: Other users can query the DHT using the dht_key to retrieve the relay list
- Negentropy Sync: The RelayStore object periodically tries to sync with all relays that it is aware of
- Sync Store: There is a sqlite db that stores info about relays for uploading to dht and syncing
For more detailed information, please refer to the official BEP44 specification.
Documentation
¶
Index ¶
- func CreateDHTKeyFromPrivateKey(privateKey *btcec.PrivateKey) (string, error)
- func CreateDHTKeyFromPublicKey(publicKey *btcec.PublicKey) (string, error)
- func DeriveKeyFromNsec(nsec string) (string, error)
- func GenerateDHTKey(privateKeyHex string) (string, error)
- func GetDHTKeyForPubkey(pubkey string) (string, error)
- func SignRelayList(relayList []string, nsec string) (string, error)
- func VerifyRelayList(relayList []string, signature string, pubkey string) (bool, error)
- type RelayList
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateDHTKeyFromPrivateKey ¶
func CreateDHTKeyFromPrivateKey(privateKey *btcec.PrivateKey) (string, error)
CreateDHTKeyFromPrivateKey creates a DHT key from a btcec.PrivateKey
func CreateDHTKeyFromPublicKey ¶
CreateDHTKeyFromPublicKey creates a DHT key from a btcec.PublicKey
func DeriveKeyFromNsec ¶
DeriveKeyFromNsec derives a DHT key from a user's nsec (private key) This provides a consistent way to generate DHT keys from private keys using the same approach as GenerateDHTKey for consistency
func GenerateDHTKey ¶
GenerateDHTKey generates a DHT key from a private key hex string
func GetDHTKeyForPubkey ¶
GetDHTKeyForPubkey derives a DHT key for a given public key This is useful when you only have the public key and need to find the corresponding DHT key to retrieve data
func SignRelayList ¶
SignRelayList signs a relay list with the user's private key The signature can be verified to ensure the relay list was created by the owner
Source Files