https://github.com/mikedilger/gossip/blob/master/filter.example.rhai
- - - - - -
This is a sample spam filtering script for the gossip nostr
client. The language is called Rhai, details are at:
https:rhai.rs/book/
For gossip to find your spam filtering script, put it in your
gossip profile directory. See
https:docs.rs/dirs/latest/dirs/fn.data_dir.html
to find the base directory. A subdirectory "gossip" is your
gossip data directory which for most people is their profile
directory too. (Note: if you use a GOSSIP_PROFILE, you'll need
to put it one directory deeper into that profile directory).
This filter is used to filter out and refuse to process incoming
events as they flow in from relays, and also to filter which
events get displayed in certain circumstances. It is only run on
feed-displayable event kinds, and only events by authors you are
not following. In case of error, nothing is filtered.
You must define a function called 'filter' which returns one of
these constant values:
DENY (the event is filtered out)
ALLOW (the event is allowed through)
MUTE (the event is filtered out, and the author is
automatically muted)
Your script will be provided the following:
caller - a string that is one of "Process", "Thread",
"Inbox" or "Global" indicating which part of
the code is running your script
content - the event content as a string
id - the event ID, as a hex string
kind - the event kind as an integer
muted - if the author is in your mute list
name - if we have it, the name of the author (or your
petname), else an empty string
nip05valid - whether nip05 is valid for the author, as a
boolean
pow - the Proof of Work on the event
pubkey - the event author public key, as a hex string
seconds_known - the number of seconds that the author of the
event has been known to gossip
spamsafe - true only if the event came in from a relay
marked as SpamSafe during Process (even if the
global setting for SpamSafe is off)
dtonon / daniele
npub100…8vwqk
2024-09-20 10:09:09
in reply to nevent1q…3kvk
Author Public Key
npub10000003zmk89narqpczy4ff6rnuht2wu05na7kpnh3mak7z2tqzsv8vwqkPublished at
2024-09-20 10:09:09Event JSON
{
"id": "b049bedb564604ce834a0b14bf126ab4be0210b042135a5d7aa7691ed07e29d9",
"pubkey": "7bdef7be22dd8e59f4600e044aa53a1cf975a9dc7d27df5833bc77db784a5805",
"created_at": 1726826949,
"kind": 1,
"tags": [
[
"p",
"b2d670de53b27691c0c3400225b65c35a26d06093bcc41f48ffc71e0907f9d4a"
],
[
"e",
"1908ec9cce525732cac7dc95157823fd7eb8904459a2772fdbd5dedf19962f31",
"wss://wot.dtonon.com/",
"root"
],
[
"e",
"cead350fbfe4c0c9fa2e7f1ad5b281941ec2350e019eed8e475171bbcd470bda",
"wss://nostr.wine/",
"reply"
]
],
"content": "https://github.com/mikedilger/gossip/blob/master/filter.example.rhai\n\n- - - - - -\n\nThis is a sample spam filtering script for the gossip nostr\nclient. The language is called Rhai, details are at:\nhttps:rhai.rs/book/\n\nFor gossip to find your spam filtering script, put it in your\ngossip profile directory. See\n https:docs.rs/dirs/latest/dirs/fn.data_dir.html\nto find the base directory. A subdirectory \"gossip\" is your\ngossip data directory which for most people is their profile\ndirectory too. (Note: if you use a GOSSIP_PROFILE, you'll need\nto put it one directory deeper into that profile directory).\n\nThis filter is used to filter out and refuse to process incoming\nevents as they flow in from relays, and also to filter which\nevents get displayed in certain circumstances. It is only run on\nfeed-displayable event kinds, and only events by authors you are\nnot following. In case of error, nothing is filtered.\n\nYou must define a function called 'filter' which returns one of\nthese constant values:\n\n DENY (the event is filtered out)\n ALLOW (the event is allowed through)\n MUTE (the event is filtered out, and the author is\n automatically muted)\n\nYour script will be provided the following:\n\n caller - a string that is one of \"Process\", \"Thread\",\n \"Inbox\" or \"Global\" indicating which part of\n the code is running your script\n content - the event content as a string\n id - the event ID, as a hex string\n kind - the event kind as an integer\n muted - if the author is in your mute list\n name - if we have it, the name of the author (or your\n petname), else an empty string\n nip05valid - whether nip05 is valid for the author, as a\n boolean\n pow - the Proof of Work on the event\n pubkey - the event author public key, as a hex string\n seconds_known - the number of seconds that the author of the\n event has been known to gossip\n spamsafe - true only if the event came in from a relay\n marked as SpamSafe during Process (even if the\n global setting for SpamSafe is off)\n",
"sig": "c6759edfe8830fda43d1ce03ce694e1e3f9c64a69727f8f9114a230f5d0534a3f6a20d6368bbae18805983ab98e3e7828d95098440200f80cfa6325343915327"
}