Welshman

Appearance

Welshman Docs / @welshman/util / ManagementApi

Class: ManagementApi ​

Defined in: packages/util/src/Nip86.ts:212

A NIP-86 relay management client bound to one relay and one signer. Each method builds the request, signs a fresh NIP-98 auth event, and POSTs it — e.g. new ManagementApi(url, sign).deleteRole(roleId). Management shares the relay's websocket URI but is served over HTTP, so ws(s):// is normalized to http(s)://.

Constructors ​

Constructor ​

new ManagementApi(url, sign): ManagementApi

Defined in: packages/util/src/Nip86.ts:215

Parameters ​

url ​

string

sign ​

ManagementSign

Returns ​

ManagementApi

Properties ​

sign ​

readonly sign: ManagementSign

Defined in: packages/util/src/Nip86.ts:217

url ​

readonly url: string

Defined in: packages/util/src/Nip86.ts:213

Methods ​

allowEvent() ​

allowEvent(id, reason?): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:262

Parameters ​

id ​

string

reason? ​

string

Returns ​

Promise<ManagementResponse>

allowKind() ​

allowKind(kind): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:275

Parameters ​

kind ​

number

Returns ​

Promise<ManagementResponse>

allowPubkey() ​

allowPubkey(pubkey, reason?): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:236

Parameters ​

pubkey ​

string

reason? ​

string

Returns ​

Promise<ManagementResponse>

assignRole() ​

assignRole(pubkey, roleId): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:250

Parameters ​

pubkey ​

string

roleId ​

string

Returns ​

Promise<ManagementResponse>

banEvent() ​

banEvent(id, reason?): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:264

Parameters ​

id ​

string

reason? ​

string

Returns ​

Promise<ManagementResponse>

banPubkey() ​

banPubkey(pubkey, reason?): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:230

Parameters ​

pubkey ​

string

reason? ​

string

Returns ​

Promise<ManagementResponse>

blockIp() ​

blockIp(ip, reason?): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:281

Parameters ​

ip ​

string

reason? ​

string

Returns ​

Promise<ManagementResponse>

changeRelayDescription() ​

changeRelayDescription(description): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:270

Parameters ​

description ​

string

Returns ​

Promise<ManagementResponse>

changeRelayIcon() ​

changeRelayIcon(iconUrl): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:273

Parameters ​

iconUrl ​

string

Returns ​

Promise<ManagementResponse>

changeRelayName() ​

changeRelayName(name): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:268

Parameters ​

name ​

string

Returns ​

Promise<ManagementResponse>

createClaim() ​

createClaim(claim): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:256

Parameters ​

claim ​

string

Returns ​

Promise<ManagementResponse>

createRole() ​

createRole(id, label, description, color, order): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:242

Parameters ​

id ​

string

label ​

string

description ​

string

color ​

string

order ​

number

Returns ​

Promise<ManagementResponse>

deleteClaim() ​

deleteClaim(claim): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:258

Parameters ​

claim ​

string

Returns ​

Promise<ManagementResponse>

deleteRole() ​

deleteRole(id): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:248

Parameters ​

id ​

string

Returns ​

Promise<ManagementResponse>

disallowKind() ​

disallowKind(kind): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:277

Parameters ​

kind ​

number

Returns ​

Promise<ManagementResponse>

editRole() ​

editRole(id, label, description, color, order): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:245

Parameters ​

id ​

string

label ​

string

description ​

string

color ​

string

order ​

number

Returns ​

Promise<ManagementResponse>

listAllowedKinds() ​

listAllowedKinds(): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:279

Returns ​

Promise<ManagementResponse>

listAllowedPubkeys() ​

listAllowedPubkeys(): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:240

Returns ​

Promise<ManagementResponse>

listBannedEvents() ​

listBannedEvents(): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:266

Returns ​

Promise<ManagementResponse>

listBannedPubkeys() ​

listBannedPubkeys(): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:234

Returns ​

Promise<ManagementResponse>

listBlockedIps() ​

listBlockedIps(): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:285

Returns ​

Promise<ManagementResponse>

listClaims() ​

listClaims(): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:254

Returns ​

Promise<ManagementResponse>

listEventsNeedingModeration() ​

listEventsNeedingModeration(): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:260

Returns ​

Promise<ManagementResponse>

send() ​

send(request): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:222

Parameters ​

request ​

ManagementRequest

Returns ​

Promise<ManagementResponse>

signEvent() ​

signEvent(event): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:287

Parameters ​

event ​

EventTemplate

Returns ​

Promise<ManagementResponse>

supportedMethods() ​

supportedMethods(): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:228

Returns ​

Promise<ManagementResponse>

unallowPubkey() ​

unallowPubkey(pubkey, reason?): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:238

Parameters ​

pubkey ​

string

reason? ​

string

Returns ​

Promise<ManagementResponse>

unassignRole() ​

unassignRole(pubkey, roleId): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:252

Parameters ​

pubkey ​

string

roleId ​

string

Returns ​

Promise<ManagementResponse>

unbanPubkey() ​

unbanPubkey(pubkey, reason?): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:232

Parameters ​

pubkey ​

string

reason? ​

string

Returns ​

Promise<ManagementResponse>

unblockIp() ​

unblockIp(ip): Promise<ManagementResponse>

Defined in: packages/util/src/Nip86.ts:283

Parameters ​

ip ​

string

Returns ​

Promise<ManagementResponse>