@orangecheck/relay-filter / FilterOptions
Interface: FilterOptions
Defined in: types.ts:14
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
<a id="property-allowkinds"></a> allowKinds? | number[] | Event kinds that bypass the filter. Useful for bootstrapping — e.g., allow kind-0 profile metadata and kind-3 contact lists so users can publish their handles before they've created a proof. Default: [0, 3, 10002] (profile meta, contacts, relay list). | types.ts:27 |
<a id="property-allowpubkeys"></a> allowPubkeys? | string[] | Pubkeys that bypass the filter entirely. Accepts hex or npub. Useful for operator / admin keys. | types.ts:33 |
<a id="property-cachemax"></a> cacheMax? | number | Max cache entries. Default 1_000. | types.ts:41 |
<a id="property-cachettlms"></a> cacheTtlMs? | number | How long the filter caches a per-pubkey decision. Default 60_000 ms (matches /api/check's cache). | types.ts:39 |
<a id="property-failopen"></a> failOpen? | boolean | If the OrangeCheck lookup throws (relays unreachable, network down), let the event through. Default false — we fail closed. | types.ts:47 |
<a id="property-mindays"></a> minDays? | number | Minimum days unspent. Default 0. | types.ts:18 |
<a id="property-minsats"></a> minSats? | number | Minimum sats bonded for the pubkey's attestation. Default 0. | types.ts:16 |
<a id="property-ondecision"></a> onDecision? | (event: MinimalNostrEvent, decision: FilterDecision) => void | Called with each decision. Use for logging / metrics. | types.ts:53 |
<a id="property-relays"></a> relays? | string[] | Override the discovery relays used by the SDK's check(). | types.ts:50 |