diff --git a/contrib/chorus.toml b/contrib/chorus.toml index b25bfd7..445a069 100644 --- a/contrib/chorus.toml +++ b/contrib/chorus.toml @@ -114,14 +114,12 @@ user_hex_keys = [] verify_events = true -# This is a boolean indicating whether or not scraping is allowed. -# Scraping is any filter that does not match one of the following conditions: +# This is a boolean indicating whether or not scraping is allowed. Scraping is any filter +# where all of the following are true: # -# A non-empty id list is set -# A non-empty authors list is set and a non-empty kinds list is set -# A non-empty authors list is set and at least one tag is set. -# A non-empty kinds list is set and at least one tag is set. -# Has a limit <= 10 +# - `ids` is missing or empty +# - `authors` is missing or empty +# - There are no `#X` tag filters # # Filter that fail to match these conditions will be rejected if allow_scraping is false. # diff --git a/docs/BEHAVIOR.md b/docs/BEHAVIOR.md index 4ab6a04..d8c0c7a 100644 --- a/docs/BEHAVIOR.md +++ b/docs/BEHAVIOR.md @@ -28,13 +28,11 @@ Chorus serves all events to AUTHed and authorized users. Chorus serves all events which were authored by an authorized user. -Filters which are broad are considered scrapers and are not serviced. Filters must meet one of the following criteria: +Filters which are broad are considered scrapers and are not serviced. Scraping is any filter where all of the following are true: -- A non-empty `id` list is set -- A non-empty `authors` list is set and a non-empty `kinds` list is set -- A non-empty `authors` list is set and at least one tag is set. -- A non-empty `kinds` list is set and at least one tag is set. -- Has a limit <= 10. +- `ids` is missing or empty +- `authors` is missing or empty +- There are no `#X` tag filters If you wish to change these rules, change the source code at `nostr.rs:screen_outgoing_event()` diff --git a/docs/CONFIG.md b/docs/CONFIG.md index d5f0e5f..f94d3b7 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -105,13 +105,11 @@ Default is true. ### allow_scraping -This is a boolean indicating whether or not scraping is allowed. Scraping is any filter that does not match one of the following conditions: +This is a boolean indicating whether or not scraping is allowed. Scraping is any filter where all of the following are true: -- A non-empty `id` list is set -- A non-empty `authors` list is set and a non-empty `kinds` list is set -- A non-empty `authors` list is set and at least one tag is set. -- A non-empty `kinds` list is set and at least one tag is set. -- Has a limit <= 10 +- `ids` is missing or empty +- `authors` is missing or empty +- There are no `#X` tag filters Filter that fail to match these conditions will be rejected if `allow_scraping` is false.