live · mainnetoc · docs
specs · api · guides
docs / documentation

@orangecheck/relay-filter


@orangecheck/relay-filter / filterEvent

Function: filterEvent()

function filterEvent(event: MinimalNostrEvent, options: FilterOptions): Promise<FilterDecision>;

Defined in: filter.ts:84

Decide whether a relay should accept an event based on the OrangeCheck status of the author's pubkey.

Framework-agnostic. Use this from a custom relay, nostr-tools, or whatever. For Strfry, see @orangecheck/relay-filter/strfry.

Parameters

ParameterType
eventMinimalNostrEvent
optionsFilterOptions

Returns

Promise&lt;FilterDecision>