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

@orangecheck/relay-filter


@orangecheck/relay-filter / FilterDecision

Interface: FilterDecision

Defined in: types.ts:56

Properties

PropertyTypeDescriptionDefined in
<a id="property-action"></a> action"accept" | "reject" | "shadowReject"accept — relay SHOULD accept the event. reject — relay MUST reject, returning msg to the client. shadowReject — relay should accept but silently discard (drop without informing the client). Strfry supports this; most others treat it as reject. Use sparingly — it hides errors from honest users.types.ts:64
<a id="property-check"></a> check?CheckResultUnderlying SDK result when a lookup happened.types.ts:78
<a id="property-message"></a> message?stringHuman-readable message to send the client on reject.types.ts:76
<a id="property-pubkey"></a> pubkey?stringThe pubkey that was looked up (hex).types.ts:80
<a id="property-reason"></a> reason| "ok" | "allowed_kind" | "allowed_pubkey" | "no_attestation" | "below_threshold" | "invalid_proof" | "lookup_error" | "fail_open"Why this decision was made.types.ts:66