📢 NDK 1.0 is out!
Codename: Outbox ✅
When I set out to write NDK my main goal was implementing the gossip protocol, now known as *outbox model*. I wanted nostr applications to have decentralizing tendencies by *default*; transparent to the developer.
After a few failed attempts, it's finally here, which, paired with a bunch of non-backward compatible changes, prompts me to do a major version bump.
# What is outbox model?
In short, the outbox model allows nostr to fragment, instead of everybody coalescing around a few popular relay and using things like Blastr. Nostr simply doesn't work without the outbox model.
# Main changes:
* Outbox model support, obviously.
* `fetchEvent(s)` is now faster, (particularly with queries using exclusively `ids` filters).
* Fixed unstable relay back-off code (credit goes to NVK (npub1az9…m8y8) for the valuable testing infrastructure)
* Defaults to blacklisting wss://brb.io #censorship (credit goes to NVK (npub1az9…m8y8) for the widely hinted-at dead relay)
* Subscription aggregation now works when multiple filters run at the same time
* Subscriptions that should close when EOSEd are now closed when each individual relay EOSEs instead of waiting for all of them to EOSE.
* A better algorithm on when to signal a subscription's EOSE. The margin that NDK now gives to relays to EOSE is now a function of how many of the connected relays in the relay set have EOSEd (accounting for relays that are still sending events).
* There are *many* more changes that I needed to do to accommodate for this that I don't remember now.
Some of the most glaring breaking changes:
* `ndk.subscribe` now defaults to keeping the subscription alive; the default of closing subscriptions on EOSE was bothering me
* NDKUser changes the `hexpubkey` from a function to a getter, so wherever you were using `user.hexpubkey()` needs to change to `user.hexpubkey`.
# Enabling outbox model
Outbox model comes disabled by default *for now*, as soon as I test it more throughogly it will be the default.
To enable it you need to instantiate NDK with:
```
const ndk = new NDK({
explicitRelayUrls: [...],
outboxRelayUrls: ["wss://purplepag.es"],
enableOutboxModel: true,
})
```
The outbox model will largely be transparent to you and will work on the background once you enable it.
PABLOF7z
npub1l2…tajft
2023-09-07 15:33:56
Author Public Key
npub1l2vyh47mk2p0qlsku7hg0vn29faehy9hy34ygaclpn66ukqp3afqutajftPublished at
2023-09-07 15:33:56Event JSON
{
"id": "71be410e9688044aba603c46ed1b945f8b1874c6d09d5922d47d9bb3e8d00583",
"pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52",
"created_at": 1694100836,
"kind": 1,
"tags": [
[
"p",
"e88a691e98d9987c964521dff60025f60700378a4879180dcbbb4a5027850411"
],
[
"p",
"e88a691e98d9987c964521dff60025f60700378a4879180dcbbb4a5027850411"
],
[
"t",
"censorship"
]
],
"content": "📢 NDK 1.0 is out!\n\nCodename: Outbox ✅\n\nWhen I set out to write NDK my main goal was implementing the gossip protocol, now known as *outbox model*. I wanted nostr applications to have decentralizing tendencies by *default*; transparent to the developer.\n\nAfter a few failed attempts, it's finally here, which, paired with a bunch of non-backward compatible changes, prompts me to do a major version bump.\n\n# What is outbox model?\n\nIn short, the outbox model allows nostr to fragment, instead of everybody coalescing around a few popular relay and using things like Blastr. Nostr simply doesn't work without the outbox model.\n\n# Main changes:\n\n* Outbox model support, obviously.\n* `fetchEvent(s)` is now faster, (particularly with queries using exclusively `ids` filters).\n* Fixed unstable relay back-off code (credit goes to nostr:npub1az9xj85cmxv8e9j9y80lvqp97crsqdu2fpu3srwthd99qfu9qsgstam8y8 for the valuable testing infrastructure)\n* Defaults to blacklisting wss://brb.io #censorship (credit goes to nostr:npub1az9xj85cmxv8e9j9y80lvqp97crsqdu2fpu3srwthd99qfu9qsgstam8y8 for the widely hinted-at dead relay)\n* Subscription aggregation now works when multiple filters run at the same time\n* Subscriptions that should close when EOSEd are now closed when each individual relay EOSEs instead of waiting for all of them to EOSE.\n* A better algorithm on when to signal a subscription's EOSE. The margin that NDK now gives to relays to EOSE is now a function of how many of the connected relays in the relay set have EOSEd (accounting for relays that are still sending events).\n* There are *many* more changes that I needed to do to accommodate for this that I don't remember now.\n\nSome of the most glaring breaking changes:\n\n* `ndk.subscribe` now defaults to keeping the subscription alive; the default of closing subscriptions on EOSE was bothering me \n* NDKUser changes the `hexpubkey` from a function to a getter, so wherever you were using `user.hexpubkey()` needs to change to `user.hexpubkey`.\n\n# Enabling outbox model\n\nOutbox model comes disabled by default *for now*, as soon as I test it more throughogly it will be the default.\n\nTo enable it you need to instantiate NDK with:\n\n```\nconst ndk = new NDK({\n explicitRelayUrls: [...],\n outboxRelayUrls: [\"wss://purplepag.es\"],\n enableOutboxModel: true,\n})\n```\n\nThe outbox model will largely be transparent to you and will work on the background once you enable it.\n",
"sig": "5722be4b944f9118240f80f3258f713079b558ef975648c781112a1f223239f01af4cbde7876622b902381b3104931d6a284d28468376d0ea48164b03f9f0eec"
}