chorus/CHANGELOG.md

v2.0.0

• IMPORTANT: You need to manually Migrate your users and moderators.
• Management commands have been added: listadmins, listmoderators, grantmoderator, revokemoderator, listusers, grantuser, revokeuser, stats, listeventsneedingmoderation, clearevent, clearpubkey, listrole, grantrole, revokerole, fetchbannedevents
• fix: subscriptions will be CLOSED: auth-required if any matching event requires auth. Chorus will serve the redacted results first, but will not EOSE.
• fix: subscriptions will be CLOSED when completed, without EOSE, if the filter has any ids set.

v1.7.2

• Support for NIP-62 (PR #1256) Right to Vanish
• Fix NIP-86 management request header determination
• Management adds: numconnections, uptime
• chorus_cmd: fetch_by_id

v1.7.1

• Config setting allow_scrape_if_negentropy=true
• CLOSED no longer sent after CLOSE

v1.7.0

• Negentropy support (you must set enable_negentropy=true)
• Blossom extensions are better

v1.6.1

• base_url added (you should set this if you are behind a proxy like nginx)
• NIP-45 COUNT support
• NIP-45 PR #1561 HyperLogLog count support

v1.6.0

• Support for running as a blossom server
• Websocket close frames provided on close
• Better pre-flight checks
• server-wide OPTIONS requests now handled

v1.5.3

• Performance improvements (streaming body)
• Approval not required for kinds 0, 3, and reactions (as well as prior list)
• FIX honor enable_ip_blocking = false
• NEW chorus_cmd with delete_by_id and delete_by_pubkey
• optional icon_url for NIP-11

version 1.5.2 (2024-07-31, d8689540)

• NEW CONFIG: throttling_bytes_per_second how many bytes are allowed per second
• NEW CONFIG: throttling_burst how many bytes can be accepted per connection in a burst
• Don't wait more than 5 seconds for connections to close when shutting down

version 1.5.1 (2024-07-14, c9c71311)

• FIX: large non-utf8 messages were attempted to be logged causing a panic
• FIX: parse errors were not being punished so a nasty client could do a DoS of chorus with simple junk.

version 1.5.0 (2024-07-13, 870e470d)

• BREAKING: If you run chorus behind a proxy like nginx, you MUST set the new chorus_is_behind_a_proxy config variable to true, and your proxy MUST set the X-Real-IP header. If the header is missing, connections will not be served. If you fail to set the chorus_is_behind_a_proxy setting, the proxy IP address will be used directly, generally causing all connections to quickly become banned due to the bad behavior of just one client, or due to too many connections from a single IP.
• NEW CONFIG: chorus_is_behind_a_proxy (please set to true or false)
• NEW CONFIG: max_connections_per_ip (defaults to 5)
• NEW CONFIG: moderator_hex_keys (see next bullet point)
• A rudimentary Management API is now available using https://github.com/nostr-protocol/nips/pull/1325 To use management front ends against chorus, you must add hex pubkeys to moderator_hex_keys.
• Errors about DM kinds are much less common now, as we don't explicitly error unless they specify some set of kinds (we implicitly filter out the DMs still)
• Accurate count of bytes sent/received (SSL header data is now counted)
• Kind 10050 dm relay list events are now treated the same way as kind 10002 relay list events.
• Error message detail (e.g. source code line numbers) is now no longer sent to clients.
• Some mild errors are now swallowed.
• Updates of many dependencies, some updates were very large jumps and may change network/http behavior.
• Receipt of a deleted EVENT now returns OK false (was OK true)

v1.4.0 (2024-05-07, 25058ef4)

• Origin header logged
• CLOSED: auth-required sent if DMs requested and not authenticated yet
• config: minimum_ban_seconds, timeout_seconds, enable_ip_blocking
• default for allow_scrape_if_max_seconds raised from 3600 to 7200
• default for max_subscriptions raised from 32 to 128
• timeouts no longer affect ban seconds
• Internal: switched to pocket for the backend storage
• creates lmdb subdirectory if missing
• several bugfixes: filter parsing, empty tags, event ordering, chorus_compress was fixed

v1.3.0 (2024-04-10, 7883d754)

• chorus_moderate tool to approve events or pubkeys
• chorus_dump_approvals tool to view prior approvals
• chorus_compress to backup and rebuild your data, compressing as it goes.
• NIP-40 event expiration support
• extended NIP-11 document, with updates to supported NIPs
• Traffic bytes counted and logged on exit (or HUP)
• Logging improvements
• Data migrations. Less space consumed.
• performance improved via 8-byte alignment of events

v1.2.0 (2024-03-22, a701e148)

• Config option to run as an open relay
• Config variable for scraper behavior
• More efficient scraping
• Reload config on HUP without dropping connections
• IP addresses no longer logged. They are hashed and tracked by their hash.

v1.1.1 (2024-03-02, fda607a6)

• FIX some LIMIT related bugs
• FIX some indexing bugs that cuased some events that should have been returned to not be.
• Allow scrape up to limit=100, or time range of 1 hour

v1.1.0 (2024-02-21, ec315d98)

• Update docs

v1.0.7 (2024-02-21, 4ebe2545)

• BREAKING: Config changed to TOML format
• Logging improvements
• Error handling improvements
• Ban time improvements
• Documentation updates
• Restructured into a bin and a lib
• Tool to dump all events as JSON to stdout

v1.0.6 (2024-02-21, 50995a75)

• FIX: REQ errors now properly CLOSED
• Logging improvements
• Persistent IP reputation data for adjusting ban times
• Config settings for serve_ephmeral and serve_relay_lists
• Uses 'X-Real-Ip' header if behind a proxy

v1.0.5 (2024-02-20, 5e7c1c38)

• FIX: significant performance problem addressed
• Logging improvements
• EVENTs submitted that are known to be deleted are now responded to with 'blocked:'
• Longer filters now accepted

v1.0.4 (2024-02-20, 9c7aa299)

• FIX: after EOSE, outbound events were not being screened properly
• FIX: shutdown issue
• NIP-11 updated
• Idle connections with no REQs now timed out at 5 seconds

v1.0.3 (2024-02-20, 015d847f)

• FIX: limits were not working properly
• Update IP banning logic and timing
• Improve logging
• Allow more REQ filters (with low limits)
• Better performance when filters are more open

v1.0.2 (2024-02-19, b85cd929)

• FIX: deadlock (nested transaction issue)
• Logging changes
• Documentation updated

v1.0.1 (2024-02-19, 9d65d773)

• FIX: AUTH was failing due to a bad time difference comparison
• AUTH failures now include detail as to why
• documentation updated

v1.0.0 (2024-02-19, 7ed36b95)

• Initial release.
• Works as a personal relay
• Supported NIPs: 1, 4, 9, 11, 42, 59, 65
• Bans IPs to prevent abuse
• Limits to 32 subscriptions by default, configurable