Welshman Docs / @welshman/util / ManagementApi

Class: ManagementApi

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

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:225

Parameters

url

string

sign

ManagementSign

Returns

ManagementApi

Properties

sign

readonly sign: ManagementSign

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

---

url

readonly url: string

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

Methods

allowEvent()

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

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

Parameters

id

string

reason?

string

Returns

Promise<ManagementResponse>

---

allowKind()

allowKind(kind): Promise<ManagementResponse>

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

Parameters

kind

number

Returns

Promise<ManagementResponse>

---

allowPubkey()

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

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

Parameters

pubkey

string

reason?

string

Returns

Promise<ManagementResponse>

---

assignMethod()

assignMethod(pubkey, method): Promise<ManagementResponse>

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

Parameters

pubkey

string

method

string

Returns

Promise<ManagementResponse>

---

assignRole()

assignRole(pubkey, roleId): Promise<ManagementResponse>

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

Parameters

pubkey

string

roleId

string

Returns

Promise<ManagementResponse>

---

banEvent()

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

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

Parameters

id

string

reason?

string

Returns

Promise<ManagementResponse>

---

banPubkey()

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

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

Parameters

pubkey

string

reason?

string

Returns

Promise<ManagementResponse>

---

blockIp()

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

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

Parameters

ip

string

reason?

string

Returns

Promise<ManagementResponse>

---

changeRelayDescription()

changeRelayDescription(description): Promise<ManagementResponse>

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

Parameters

description

string

Returns

Promise<ManagementResponse>

---

changeRelayIcon()

changeRelayIcon(iconUrl): Promise<ManagementResponse>

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

Parameters

iconUrl

string

Returns

Promise<ManagementResponse>

---

changeRelayName()

changeRelayName(name): Promise<ManagementResponse>

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

Parameters

name

string

Returns

Promise<ManagementResponse>

---

createClaim()

createClaim(claim): Promise<ManagementResponse>

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

Parameters

claim

string

Returns

Promise<ManagementResponse>

---

createRole()

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

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

Parameters

id

string

label

string

description

string

color

number

order

number

Returns

Promise<ManagementResponse>

---

deleteClaim()

deleteClaim(claim): Promise<ManagementResponse>

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

Parameters

claim

string

Returns

Promise<ManagementResponse>

---

deleteRole()

deleteRole(id): Promise<ManagementResponse>

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

Parameters

id

string

Returns

Promise<ManagementResponse>

---

disallowKind()

disallowKind(kind): Promise<ManagementResponse>

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

Parameters

kind

number

Returns

Promise<ManagementResponse>

---

editRole()

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

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

Parameters

id

string

label

string

description

string

color

number

order

number

Returns

Promise<ManagementResponse>

---

listAllowedKinds()

listAllowedKinds(): Promise<ManagementResponse>

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

Returns

Promise<ManagementResponse>

---

listAllowedPubkeys()

listAllowedPubkeys(): Promise<ManagementResponse>

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

Returns

Promise<ManagementResponse>

---

listBannedEvents()

listBannedEvents(): Promise<ManagementResponse>

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

Returns

Promise<ManagementResponse>

---

listBannedPubkeys()

listBannedPubkeys(): Promise<ManagementResponse>

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

Returns

Promise<ManagementResponse>

---

listBlockedIps()

listBlockedIps(): Promise<ManagementResponse>

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

Returns

Promise<ManagementResponse>

---

listClaims()

listClaims(): Promise<ManagementResponse>

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

Returns

Promise<ManagementResponse>

---

listEventsNeedingModeration()

listEventsNeedingModeration(): Promise<ManagementResponse>

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

Returns

Promise<ManagementResponse>

---

listMethodAssignees()

listMethodAssignees(): Promise<ManagementResponse>

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

Returns

Promise<ManagementResponse>

---

send()

send(request): Promise<ManagementResponse>

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

Parameters

request

ManagementRequest

Returns

Promise<ManagementResponse>

---

supportedMethods()

supportedMethods(): Promise<ManagementResponse>

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

Returns

Promise<ManagementResponse>

---

unallowPubkey()

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

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

Parameters

pubkey

string

reason?

string

Returns

Promise<ManagementResponse>

---

unassignMethod()

unassignMethod(pubkey, method): Promise<ManagementResponse>

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

Parameters

pubkey

string

method

string

Returns

Promise<ManagementResponse>

---

unassignRole()

unassignRole(pubkey, roleId): Promise<ManagementResponse>

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

Parameters

pubkey

string

roleId

string

Returns

Promise<ManagementResponse>

---

unbanPubkey()

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

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

Parameters

pubkey

string

reason?

string

Returns

Promise<ManagementResponse>

---

unblockIp()

unblockIp(ip): Promise<ManagementResponse>

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

Parameters

ip

string

Returns

Promise<ManagementResponse>