Class RelayManagement

constructor

• new RelayManagement(relay: Relay, signer: AuthSigner): RelayManagement

  Parameters

  • relay: Relay
  • signer: AuthSigner

  Returns RelayManagement

allowedKinds$

allowedPubkeys$

bannedEvents$

bannedPubkeys$

blockedIps$

eventsNeedingModeration$

Readonlyrelay

Readonlysigner

supportMethods$

allowEvent

• allowEvent(eventId: string, reason?: string): Promise<true>

  Allow an event

  Parameters

  • eventId: string
  • Optionalreason: string

  Returns Promise<true>

allowKind

• allowKind(kind: number): Promise<true>

  Allow a kind

  Parameters

  • kind: number

  Returns Promise<true>

allowPubkey

• allowPubkey(pubkey: string, reason?: string): Promise<true>

  Allow a pubkey

  Parameters

  • pubkey: string
  • Optionalreason: string

  Returns Promise<true>

banEvent

• banEvent(eventId: string, reason?: string): Promise<true>

  Ban an event

  Parameters

  • eventId: string
  • Optionalreason: string

  Returns Promise<true>

banPubkey

• banPubkey(pubkey: string, reason?: string): Promise<true>

  Ban a pubkey

  Parameters

  • pubkey: string
  • Optionalreason: string

  Returns Promise<true>

blockIp

• blockIp(ip: string, reason?: string): Promise<true>

  Block an IP address

  Parameters

  • ip: string
  • Optionalreason: string

  Returns Promise<true>

changeRelayDescription

• changeRelayDescription(description: string): Promise<true>

  Change relay description

  Parameters

  • description: string

  Returns Promise<true>

changeRelayIcon

• changeRelayIcon(iconUrl: string): Promise<true>

  Change relay icon

  Parameters

  • iconUrl: string

  Returns Promise<true>

changeRelayName

• changeRelayName(name: string): Promise<true>

  Change relay name

  Parameters

  • name: string

  Returns Promise<true>

disallowKind

• disallowKind(kind: number): Promise<true>

  Disallow a kind

  Parameters

  • kind: number

  Returns Promise<true>

listAllowedKinds

• listAllowedKinds(): Promise<number[]>

  List all allowed kinds

  Returns Promise<number[]>

listAllowedPubkeys

• listAllowedPubkeys(): Promise<{ pubkey: string; reason?: string }[]>

  List all allowed pubkeys

  Returns Promise<{ pubkey: string; reason?: string }[]>

listBannedEvents

• listBannedEvents(): Promise<{ id: string; reason?: string }[]>

  List all banned events

  Returns Promise<{ id: string; reason?: string }[]>

listBannedPubkeys

• listBannedPubkeys(): Promise<{ pubkey: string; reason?: string }[]>

  List all banned pubkeys

  Returns Promise<{ pubkey: string; reason?: string }[]>

listBlockedIps

• listBlockedIps(): Promise<{ ip: string; reason?: string }[]>

  List all blocked IPs

  Returns Promise<{ ip: string; reason?: string }[]>

listEventsNeedingModeration

• listEventsNeedingModeration(): Promise<{ id: string; reason?: string }[]>

  List events needing moderation

  Returns Promise<{ id: string; reason?: string }[]>

request

• request<Method extends RelayManagementMethods>(
      method: Method["method"],
      params: Method["request"]["params"],
  ): Promise<Method["response"]["result"]>

  Core request method that handles all RPC calls with NIP-98 authentication

  Type Parameters

  • Method extends RelayManagementMethods

  Parameters

  • method: Method["method"]
  • params: Method["request"]["params"]

  Returns Promise<Method["response"]["result"]>

supportedMethods

• supportedMethods(): Promise<string[]>

  Get list of supported methods

  Returns Promise<string[]>

unblockIp

• unblockIp(ip: string): Promise<true>

  Unblock an IP address

  Parameters

  • ip: string

  Returns Promise<true>