Welshman Docs / @welshman/util

@welshman/util

Enumerations

WalletType

Defined in: packages/util/src/Wallet.ts:18

Enumeration Members

NWC

NWC: "nwc"

Defined in: packages/util/src/Wallet.ts:20

WebLN

WebLN: "webln"

Defined in: packages/util/src/Wallet.ts:19

Classes

• Address
• ManagementApi
• Pubkey
• RelayScenario
• Resolver

Interfaces

• EncryptedFile

Type Aliases

BlossomAuthAction

BlossomAuthAction = "get" | "upload" | "list" | "delete"

Defined in: packages/util/src/Blossom.ts:6

---

BlossomAuthEventOpts

BlossomAuthEventOpts = object

Defined in: packages/util/src/Blossom.ts:8

Properties

action

action: BlossomAuthAction

Defined in: packages/util/src/Blossom.ts:9

content?

optional content: string

Defined in: packages/util/src/Blossom.ts:13

expiration?

optional expiration: number

Defined in: packages/util/src/Blossom.ts:12

hashes?

optional hashes: string[]

Defined in: packages/util/src/Blossom.ts:11

server

server: string

Defined in: packages/util/src/Blossom.ts:10

---

BlossomErrorResponse

BlossomErrorResponse = object

Defined in: packages/util/src/Blossom.ts:21

Properties

message

message: string

Defined in: packages/util/src/Blossom.ts:22

reason?

optional reason: string

Defined in: packages/util/src/Blossom.ts:23

---

BlossomServer

BlossomServer = object

Defined in: packages/util/src/Blossom.ts:16

Properties

pubkey?

optional pubkey: string

Defined in: packages/util/src/Blossom.ts:18

url

url: string

Defined in: packages/util/src/Blossom.ts:17

---

EventContent

EventContent = object

Defined in: packages/util/src/Events.ts:15

Properties

content

content: string

Defined in: packages/util/src/Events.ts:17

tags

tags: string[][]

Defined in: packages/util/src/Events.ts:16

---

EventRef

EventRef = object

Defined in: packages/util/src/RelaySelection.ts:18

Properties

id?

optional id: string

Defined in: packages/util/src/RelaySelection.ts:19

identifier?

optional identifier: string

Defined in: packages/util/src/RelaySelection.ts:22

kind?

optional kind: number

Defined in: packages/util/src/RelaySelection.ts:21

pubkey?

optional pubkey: string

Defined in: packages/util/src/RelaySelection.ts:20

relays?

optional relays: string[]

Defined in: packages/util/src/RelaySelection.ts:23

---

EventTemplate

EventTemplate = EventContent & object

Defined in: packages/util/src/Events.ts:20

Type declaration

kind

kind: number

---

FallbackPolicy()

FallbackPolicy = (count, limit) => number

Defined in: packages/util/src/RelaySelection.ts:103

Parameters

count

number

limit

number

Returns

number

---

Filter

Filter = object

Defined in: packages/util/src/Filters.ts:22

Indexable

[key: `#${string}`]: string[]

Properties

authors?

optional authors: string[]

Defined in: packages/util/src/Filters.ts:25

ids?

optional ids: string[]

Defined in: packages/util/src/Filters.ts:23

kinds?

optional kinds: number[]

Defined in: packages/util/src/Filters.ts:24

limit?

optional limit: number

Defined in: packages/util/src/Filters.ts:28

search?

optional search: string

Defined in: packages/util/src/Filters.ts:29

since?

optional since: number

Defined in: packages/util/src/Filters.ts:26

until?

optional until: number

Defined in: packages/util/src/Filters.ts:27

---

Handle

Handle = object

Defined in: packages/util/src/Handles.ts:8

NIP-05: mapping nostr public keys to DNS-based internet identifiers (e.g. name@example.com), resolved via each domain's /.well-known/nostr.json.

Properties

nip05

nip05: string

Defined in: packages/util/src/Handles.ts:9

nip46?

optional nip46: string[]

Defined in: packages/util/src/Handles.ts:11

pubkey?

optional pubkey: string

Defined in: packages/util/src/Handles.ts:10

relays?

optional relays: string[]

Defined in: packages/util/src/Handles.ts:12

---

HashedEvent

HashedEvent = OwnedEvent & object

Defined in: packages/util/src/Events.ts:32

Type declaration

id

id: string

---

MakeEventOpts

MakeEventOpts = object

Defined in: packages/util/src/Events.ts:46

Properties

content?

optional content: string

Defined in: packages/util/src/Events.ts:47

created_at?

optional created_at: number

Defined in: packages/util/src/Events.ts:49

tags?

optional tags: string[][]

Defined in: packages/util/src/Events.ts:48

---

ManagementRequest

ManagementRequest = object

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

Properties

method

method: string

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

params

params: any[]

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

---

ManagementResponse

ManagementResponse = object

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

Properties

error?

optional error: string

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

result?

optional result: any

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

---

ManagementSign()

ManagementSign = (event) => Promise<SignedEvent>

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

Parameters

event

StampedEvent

Returns

Promise<SignedEvent>

---

NWCInfo

NWCInfo = object

Defined in: packages/util/src/Wallet.ts:10

Properties

lud16

lud16: string

Defined in: packages/util/src/Wallet.ts:11

nostrWalletConnectUrl

nostrWalletConnectUrl: string

Defined in: packages/util/src/Wallet.ts:15

relayUrl

relayUrl: string

Defined in: packages/util/src/Wallet.ts:13

secret

secret: string

Defined in: packages/util/src/Wallet.ts:12

walletPubkey

walletPubkey: string

Defined in: packages/util/src/Wallet.ts:14

---

NWCWallet

NWCWallet = object

Defined in: packages/util/src/Wallet.ts:28

Properties

info

info: NWCInfo

Defined in: packages/util/src/Wallet.ts:30

type

type: NWC

Defined in: packages/util/src/Wallet.ts:29

---

OwnedEvent

OwnedEvent = StampedEvent & object

Defined in: packages/util/src/Events.ts:28

Type declaration

pubkey

pubkey: string

---

ProofOfWork

ProofOfWork = object

Defined in: packages/util/src/Pow.ts:85

Properties

result

result: Promise<HashedEvent>

Defined in: packages/util/src/Pow.ts:87

worker

worker: Worker

Defined in: packages/util/src/Pow.ts:86

---

RelayRoute

RelayRoute = { type: "userInbox"; } | { type: "userOutbox"; } | { type: "userMessaging"; } | { pubkey: string; type: "pubkeyInbox"; } | { pubkey: string; type: "pubkeyOutbox"; } | { pubkey: string; type: "pubkeyMessaging"; } | { ref: EventRef; type: "eventInbox"; } | { ref: EventRef; type: "eventOutbox"; } | { ref: EventRef; type: "seen"; } | { type: "relay"; url: string; } | { type: "index"; } | { type: "search"; }

Defined in: packages/util/src/RelaySelection.ts:26

---

RelayScenarioOptions

RelayScenarioOptions = object

Defined in: packages/util/src/RelaySelection.ts:117

Properties

allowInsecure?

optional allowInsecure: boolean

Defined in: packages/util/src/RelaySelection.ts:122

allowLocal?

optional allowLocal: boolean

Defined in: packages/util/src/RelaySelection.ts:120

allowOnion?

optional allowOnion: boolean

Defined in: packages/util/src/RelaySelection.ts:121

getDefaultRelays()?

optional getDefaultRelays: () => string[]

Defined in: packages/util/src/RelaySelection.ts:124

Returns

string[]

getRelayQuality()?

optional getRelayQuality: (url) => number

Defined in: packages/util/src/RelaySelection.ts:123

Parameters

url

string

Returns

number

limit?

optional limit: number

Defined in: packages/util/src/RelaySelection.ts:119

policy?

optional policy: FallbackPolicy

Defined in: packages/util/src/RelaySelection.ts:118

---

RelaySelection

RelaySelection = object

Defined in: packages/util/src/RelaySelection.ts:48

Properties

route

route: RelayRoute

Defined in: packages/util/src/RelaySelection.ts:49

weight

weight: number

Defined in: packages/util/src/RelaySelection.ts:50

---

ResolveRoute()

ResolveRoute = (route) => MaybeAsync<string[]>

Defined in: packages/util/src/RelaySelection.ts:201

Parameters

route

RelayRoute

Returns

MaybeAsync<string[]>

---

Selection

Selection = object

Defined in: packages/util/src/RelaySelection.ts:91

Properties

relays

relays: string[]

Defined in: packages/util/src/RelaySelection.ts:93

weight

weight: number

Defined in: packages/util/src/RelaySelection.ts:92

---

SignedEvent

SignedEvent = HashedEvent & object

Defined in: packages/util/src/Events.ts:36

Type declaration

[verifiedSymbol]?

optional [verifiedSymbol]: boolean

sig

sig: string

---

StampedEvent

StampedEvent = EventTemplate & object

Defined in: packages/util/src/Events.ts:24

Type declaration

created_at

created_at: number

---

TagSpec<T>

TagSpec<T> = object

Defined in: packages/util/src/Tags.ts:7

Type Parameters

T

T = string

Properties

keys

keys: string[]

Defined in: packages/util/src/Tags.ts:8

matchValue()?

optional matchValue: (value) => boolean

Defined in: packages/util/src/Tags.ts:9

Parameters

value

string

Returns

boolean

normalizeValue()?

optional normalizeValue: (value) => T

Defined in: packages/util/src/Tags.ts:10

Parameters

value

string

Returns

T

---

TrustedEvent

TrustedEvent = HashedEvent & object

Defined in: packages/util/src/Events.ts:41

Type declaration

[verifiedSymbol]?

optional [verifiedSymbol]: boolean

sig?

optional sig: string

---

Wallet

Wallet = WebLNWallet | NWCWallet

Defined in: packages/util/src/Wallet.ts:33

---

WebLNInfo

WebLNInfo = object

Defined in: packages/util/src/Wallet.ts:1

Properties

methods?

optional methods: string[]

Defined in: packages/util/src/Wallet.ts:2

node?

optional node: object

Defined in: packages/util/src/Wallet.ts:5

alias

alias: string

supports?

optional supports: string[]

Defined in: packages/util/src/Wallet.ts:3

version?

optional version: string

Defined in: packages/util/src/Wallet.ts:4

---

WebLNWallet

WebLNWallet = object

Defined in: packages/util/src/Wallet.ts:23

Properties

info

info: WebLNInfo

Defined in: packages/util/src/Wallet.ts:25

type

type: WebLN

Defined in: packages/util/src/Wallet.ts:24

Variables

ALERT_ANDROID

const ALERT_ANDROID: 32833 = 32833

Defined in: packages/util/src/Kinds.ts:205

---

ALERT_EMAIL

const ALERT_EMAIL: 32830 = 32830

Defined in: packages/util/src/Kinds.ts:202

---

ALERT_IOS

const ALERT_IOS: 32834 = 32834

Defined in: packages/util/src/Kinds.ts:206

---

ALERT_STATUS

const ALERT_STATUS: 32831 = 32831

Defined in: packages/util/src/Kinds.ts:203

---

ALERT_WEB

const ALERT_WEB: 32832 = 32832

Defined in: packages/util/src/Kinds.ts:204

---

APP_DATA

const APP_DATA: 30078 = 30078

Defined in: packages/util/src/Kinds.ts:189

---

APPROVAL

const APPROVAL: 4550 = 4550

Defined in: packages/util/src/Kinds.ts:79

---

AUDIO

const AUDIO: 31337 = 31337

Defined in: packages/util/src/Kinds.ts:194

---

BADGE_AWARD

const BADGE_AWARD: 8 = 8

Defined in: packages/util/src/Kinds.ts:42

---

BADGE_DEFINITION

const BADGE_DEFINITION: 30009 = 30009

Defined in: packages/util/src/Kinds.ts:181

---

BADGES

const BADGES: 30008 = 30008

Defined in: packages/util/src/Kinds.ts:180

---

benchmark

benchmark: number = 0

Defined in: packages/util/src/Pow.ts:6

---

benchmarkDifficulty

const benchmarkDifficulty: 15 = 15

Defined in: packages/util/src/Pow.ts:8

---

BID

const BID: 1021 = 1021

Defined in: packages/util/src/Kinds.ts:57

---

BID_CONFIRMATION

const BID_CONFIRMATION: 1022 = 1022

Defined in: packages/util/src/Kinds.ts:58

---

BLOCKED_RELAYS

const BLOCKED_RELAYS: 10006 = 10006

Defined in: packages/util/src/Kinds.ts:141

---

BLOSSOM_AUTH

const BLOSSOM_AUTH: 24242 = 24242

Defined in: packages/util/src/Kinds.ts:156

---

BLOSSOM_SERVERS

const BLOSSOM_SERVERS: 10063 = 10063

Defined in: packages/util/src/Kinds.ts:148

---

BOOKMARKS

const BOOKMARKS: 10003 = 10003

Defined in: packages/util/src/Kinds.ts:138

---

CALENDAR

const CALENDAR: 31924 = 31924

Defined in: packages/util/src/Kinds.ts:196

---

CHANNEL_CREATE

const CHANNEL_CREATE: 40 = 40

Defined in: packages/util/src/Kinds.ts:50

---

CHANNEL_HIDE_MESSAGE

const CHANNEL_HIDE_MESSAGE: 43 = 43

Defined in: packages/util/src/Kinds.ts:53

---

CHANNEL_MESSAGE

const CHANNEL_MESSAGE: 42 = 42

Defined in: packages/util/src/Kinds.ts:52

---

CHANNEL_MUTE_USER

const CHANNEL_MUTE_USER: 44 = 44

Defined in: packages/util/src/Kinds.ts:54

---

CHANNEL_UPDATE

const CHANNEL_UPDATE: 41 = 41

Defined in: packages/util/src/Kinds.ts:51

---

CHANNELS

const CHANNELS: 10005 = 10005

Defined in: packages/util/src/Kinds.ts:140

---

CLASSIFIED

const CLASSIFIED: 30402 = 30402

Defined in: packages/util/src/Kinds.ts:192

---

CLIENT_AUTH

const CLIENT_AUTH: 22242 = 22242

Defined in: packages/util/src/Kinds.ts:155

---

COMMENT

const COMMENT: 1111 = 1111

Defined in: packages/util/src/Kinds.ts:64

---

COMMUNITIES

const COMMUNITIES: 10004 = 10004

Defined in: packages/util/src/Kinds.ts:139

---

COMMUNITY

const COMMUNITY: 34550 = 34550

Defined in: packages/util/src/Kinds.ts:207

---

DELETE

const DELETE: 5 = 5

Defined in: packages/util/src/Kinds.ts:39

---

DEPRECATED_DIRECT_MESSAGE

const DEPRECATED_DIRECT_MESSAGE: 4 = 4

Defined in: packages/util/src/Kinds.ts:219

---

DEPRECATED_NAMED_GENERIC

const DEPRECATED_NAMED_GENERIC: 30001 = 30001

Defined in: packages/util/src/Kinds.ts:220

---

DEPRECATED_RELAY_RECOMMENDATION

const DEPRECATED_RELAY_RECOMMENDATION: 2 = 2

Defined in: packages/util/src/Kinds.ts:218

---

DIRECT_MESSAGE

const DIRECT_MESSAGE: 14 = 14

Defined in: packages/util/src/Kinds.ts:46

---

DIRECT_MESSAGE_FILE

const DIRECT_MESSAGE_FILE: 15 = 15

Defined in: packages/util/src/Kinds.ts:47

---

DRAFT_CLASSIFIED

const DRAFT_CLASSIFIED: 30403 = 30403

Defined in: packages/util/src/Kinds.ts:193

---

DVM_FEEDBACK

const DVM_FEEDBACK: 7000 = 7000

Defined in: packages/util/src/Kinds.ts:116

---

DVM_REQUEST_COUNT

const DVM_REQUEST_COUNT: 5400 = 5400

Defined in: packages/util/src/Kinds.ts:93

---

DVM_REQUEST_DISCOVER_CONTENT

const DVM_REQUEST_DISCOVER_CONTENT: 5300 = 5300

Defined in: packages/util/src/Kinds.ts:89

---

DVM_REQUEST_DISCOVER_PEOPLE

const DVM_REQUEST_DISCOVER_PEOPLE: 5301 = 5301

Defined in: packages/util/src/Kinds.ts:90

---

DVM_REQUEST_IMAGE_GENERATION

const DVM_REQUEST_IMAGE_GENERATION: 5100 = 5100

Defined in: packages/util/src/Kinds.ts:84

---

DVM_REQUEST_IMAGE_TO_VIDEO_CONVERSION

const DVM_REQUEST_IMAGE_TO_VIDEO_CONVERSION: 5202 = 5202

Defined in: packages/util/src/Kinds.ts:87

---

DVM_REQUEST_MALWARE_SCAN

const DVM_REQUEST_MALWARE_SCAN: 5500 = 5500

Defined in: packages/util/src/Kinds.ts:94

---

DVM_REQUEST_OP_RETURN

const DVM_REQUEST_OP_RETURN: 5901 = 5901

Defined in: packages/util/src/Kinds.ts:96

---

DVM_REQUEST_OTS

const DVM_REQUEST_OTS: 5900 = 5900

Defined in: packages/util/src/Kinds.ts:95

---

DVM_REQUEST_PUBLISH_SCHEDULE

const DVM_REQUEST_PUBLISH_SCHEDULE: 5905 = 5905

Defined in: packages/util/src/Kinds.ts:97

---

DVM_REQUEST_SEARCH_CONTENT

const DVM_REQUEST_SEARCH_CONTENT: 5302 = 5302

Defined in: packages/util/src/Kinds.ts:91

---

DVM_REQUEST_SEARCH_PEOPLE

const DVM_REQUEST_SEARCH_PEOPLE: 5303 = 5303

Defined in: packages/util/src/Kinds.ts:92

---

DVM_REQUEST_TEXT_EXTRACTION

const DVM_REQUEST_TEXT_EXTRACTION: 5000 = 5000

Defined in: packages/util/src/Kinds.ts:80

---

DVM_REQUEST_TEXT_GENERATION

const DVM_REQUEST_TEXT_GENERATION: 5050 = 5050

Defined in: packages/util/src/Kinds.ts:83

---

DVM_REQUEST_TEXT_SUMMARY

const DVM_REQUEST_TEXT_SUMMARY: 5001 = 5001

Defined in: packages/util/src/Kinds.ts:81

---

DVM_REQUEST_TEXT_TO_SPEECH

const DVM_REQUEST_TEXT_TO_SPEECH: 5250 = 5250

Defined in: packages/util/src/Kinds.ts:88

---

DVM_REQUEST_TEXT_TRANSLATION

const DVM_REQUEST_TEXT_TRANSLATION: 5002 = 5002

Defined in: packages/util/src/Kinds.ts:82

---

DVM_REQUEST_VIDEO_CONVERSION

const DVM_REQUEST_VIDEO_CONVERSION: 5200 = 5200

Defined in: packages/util/src/Kinds.ts:85

---

DVM_REQUEST_VIDEO_TRANSLATION

const DVM_REQUEST_VIDEO_TRANSLATION: 5201 = 5201

Defined in: packages/util/src/Kinds.ts:86

---

DVM_RESPONSE_COUNT

const DVM_RESPONSE_COUNT: 6400 = 6400

Defined in: packages/util/src/Kinds.ts:111

---

DVM_RESPONSE_DISCOVER_CONTENT

const DVM_RESPONSE_DISCOVER_CONTENT: 6300 = 6300

Defined in: packages/util/src/Kinds.ts:107

---

DVM_RESPONSE_DISCOVER_PEOPLE

const DVM_RESPONSE_DISCOVER_PEOPLE: 6301 = 6301

Defined in: packages/util/src/Kinds.ts:108

---

DVM_RESPONSE_IMAGE_GENERATION

const DVM_RESPONSE_IMAGE_GENERATION: 6100 = 6100

Defined in: packages/util/src/Kinds.ts:102

---

DVM_RESPONSE_IMAGE_TO_VIDEO_CONVERSION

const DVM_RESPONSE_IMAGE_TO_VIDEO_CONVERSION: 6202 = 6202

Defined in: packages/util/src/Kinds.ts:105

---

DVM_RESPONSE_MALWARE_SCAN

const DVM_RESPONSE_MALWARE_SCAN: 6500 = 6500

Defined in: packages/util/src/Kinds.ts:112

---

DVM_RESPONSE_OP_RETURN

const DVM_RESPONSE_OP_RETURN: 6901 = 6901

Defined in: packages/util/src/Kinds.ts:114

---

DVM_RESPONSE_OTS

const DVM_RESPONSE_OTS: 6900 = 6900

Defined in: packages/util/src/Kinds.ts:113

---

DVM_RESPONSE_PUBLISH_SCHEDULE

const DVM_RESPONSE_PUBLISH_SCHEDULE: 6905 = 6905

Defined in: packages/util/src/Kinds.ts:115

---

DVM_RESPONSE_SEARCH_CONTENT

const DVM_RESPONSE_SEARCH_CONTENT: 6302 = 6302

Defined in: packages/util/src/Kinds.ts:109

---

DVM_RESPONSE_SEARCH_PEOPLE

const DVM_RESPONSE_SEARCH_PEOPLE: 6303 = 6303

Defined in: packages/util/src/Kinds.ts:110

---

DVM_RESPONSE_TEXT_EXTRACTION

const DVM_RESPONSE_TEXT_EXTRACTION: 6000 = 6000

Defined in: packages/util/src/Kinds.ts:98

---

DVM_RESPONSE_TEXT_GENERATION

const DVM_RESPONSE_TEXT_GENERATION: 6050 = 6050

Defined in: packages/util/src/Kinds.ts:101

---

DVM_RESPONSE_TEXT_SUMMARY

const DVM_RESPONSE_TEXT_SUMMARY: 6001 = 6001

Defined in: packages/util/src/Kinds.ts:99

---

DVM_RESPONSE_TEXT_TO_SPEECH

const DVM_RESPONSE_TEXT_TO_SPEECH: 6250 = 6250

Defined in: packages/util/src/Kinds.ts:106

---

DVM_RESPONSE_TEXT_TRANSLATION

const DVM_RESPONSE_TEXT_TRANSLATION: 6002 = 6002

Defined in: packages/util/src/Kinds.ts:100

---

DVM_RESPONSE_VIDEO_CONVERSION

const DVM_RESPONSE_VIDEO_CONVERSION: 6200 = 6200

Defined in: packages/util/src/Kinds.ts:103

---

DVM_RESPONSE_VIDEO_TRANSLATION

const DVM_RESPONSE_VIDEO_TRANSLATION: 6201 = 6201

Defined in: packages/util/src/Kinds.ts:104

---

EMOJIS

const EMOJIS: 10030 = 10030

Defined in: packages/util/src/Kinds.ts:146

---

EPOCH

const EPOCH: 1609459200 = 1609459200

Defined in: packages/util/src/Filters.ts:18

---

EVENT_DATE

const EVENT_DATE: 31922 = 31922

Defined in: packages/util/src/Kinds.ts:197

---

EVENT_RSVP

const EVENT_RSVP: 31925 = 31925

Defined in: packages/util/src/Kinds.ts:199

---

EVENT_TIME

const EVENT_TIME: 31923 = 31923

Defined in: packages/util/src/Kinds.ts:198

---

FEED

const FEED: 31890 = 31890

Defined in: packages/util/src/Kinds.ts:195

---

FEEDS

const FEEDS: 10014 = 10014

Defined in: packages/util/src/Kinds.ts:144

---

FILE_METADATA

const FILE_METADATA: 1063 = 1063

Defined in: packages/util/src/Kinds.ts:62

---

FILE_SERVERS

const FILE_SERVERS: 10096 = 10096

Defined in: packages/util/src/Kinds.ts:149

---

FOLLOW_PACK

const FOLLOW_PACK: 39089 = 39089

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

---

FOLLOWS

const FOLLOWS: 3 = 3

Defined in: packages/util/src/Kinds.ts:38

---

GENERIC_REPOST

const GENERIC_REPOST: 16 = 16

Defined in: packages/util/src/Kinds.ts:48

---

GIT_ISSUE

const GIT_ISSUE: 1621 = 1621

Defined in: packages/util/src/Kinds.ts:67

---

GIT_PATCH

const GIT_PATCH: 1617 = 1617

Defined in: packages/util/src/Kinds.ts:66

---

GIT_REPLY

const GIT_REPLY: 1622 = 1622

Defined in: packages/util/src/Kinds.ts:68

---

GIT_REPOSITORY

const GIT_REPOSITORY: 30403 = 30403

Defined in: packages/util/src/Kinds.ts:73

---

GIT_STATUS_CLOSED

const GIT_STATUS_CLOSED: 1632 = 1632

Defined in: packages/util/src/Kinds.ts:71

---

GIT_STATUS_COMPLETE

const GIT_STATUS_COMPLETE: 1631 = 1631

Defined in: packages/util/src/Kinds.ts:70

---

GIT_STATUS_DRAFT

const GIT_STATUS_DRAFT: 1633 = 1633

Defined in: packages/util/src/Kinds.ts:72

---

GIT_STATUS_OPEN

const GIT_STATUS_OPEN: 1630 = 1630

Defined in: packages/util/src/Kinds.ts:69

---

HANDLER_INFORMATION

const HANDLER_INFORMATION: 31990 = 31990

Defined in: packages/util/src/Kinds.ts:201

---

HANDLER_RECOMMENDATION

const HANDLER_RECOMMENDATION: 31989 = 31989

Defined in: packages/util/src/Kinds.ts:200

---

HIGHLIGHT

const HIGHLIGHT: 9802 = 9802

Defined in: packages/util/src/Kinds.ts:134

---

HTTP_AUTH

const HTTP_AUTH: 27235 = 27235

Defined in: packages/util/src/Kinds.ts:169

---

LABEL

const LABEL: 1985 = 1985

Defined in: packages/util/src/Kinds.ts:77

---

LIGHTNING_PUB_RPC

const LIGHTNING_PUB_RPC: 21000 = 21000

Defined in: packages/util/src/Kinds.ts:154

---

LIVE_CHAT_MESSAGE

const LIVE_CHAT_MESSAGE: 1311 = 1311

Defined in: packages/util/src/Kinds.ts:65

---

LIVE_EVENT

const LIVE_EVENT: 30311 = 30311

Defined in: packages/util/src/Kinds.ts:190

---

LOCAL_RELAY_URL

const LOCAL_RELAY_URL: "local://welshman.relay/" = "local://welshman.relay/"

Defined in: packages/util/src/Relay.ts:5

---

LONG_FORM

const LONG_FORM: 30023 = 30023

Defined in: packages/util/src/Kinds.ts:187

---

LONG_FORM_DRAFT

const LONG_FORM_DRAFT: 30024 = 30024

Defined in: packages/util/src/Kinds.ts:188

---

MARKET_UI

const MARKET_UI: 30019 = 30019

Defined in: packages/util/src/Kinds.ts:184

---

MESSAGE

const MESSAGE: 9 = 9

Defined in: packages/util/src/Kinds.ts:43

---

MESSAGING_RELAYS

const MESSAGING_RELAYS: 10050 = 10050

Defined in: packages/util/src/Kinds.ts:147

---

MUTES

const MUTES: 10000 = 10000

Defined in: packages/util/src/Kinds.ts:135

---

NAMED_ARTIFACTS

const NAMED_ARTIFACTS: 30063 = 30063

Defined in: packages/util/src/Kinds.ts:178

---

NAMED_BOOKMARKS

const NAMED_BOOKMARKS: 30003 = 30003

Defined in: packages/util/src/Kinds.ts:172

---

NAMED_COMMUNITIES

const NAMED_COMMUNITIES: 30064 = 30064

Defined in: packages/util/src/Kinds.ts:179

---

NAMED_CURATIONS

const NAMED_CURATIONS: 30004 = 30004

Defined in: packages/util/src/Kinds.ts:173

---

NAMED_EMOJIS

const NAMED_EMOJIS: 30030 = 30030

Defined in: packages/util/src/Kinds.ts:176

---

NAMED_PEOPLE

const NAMED_PEOPLE: 30000 = 30000

Defined in: packages/util/src/Kinds.ts:170

---

NAMED_RELAYS

const NAMED_RELAYS: 30002 = 30002

Defined in: packages/util/src/Kinds.ts:171

---

NAMED_TOPICS

const NAMED_TOPICS: 30015 = 30015

Defined in: packages/util/src/Kinds.ts:177

---

NAMED_WIKI_AUTHORS

const NAMED_WIKI_AUTHORS: 30101 = 30101

Defined in: packages/util/src/Kinds.ts:174

---

NAMED_WIKI_RELAYS

const NAMED_WIKI_RELAYS: 30102 = 30102

Defined in: packages/util/src/Kinds.ts:175

---

neverFilter

const neverFilter: object

Defined in: packages/util/src/Filters.ts:20

Type declaration

ids

ids: never[] = []

---

NOSTR_CONNECT

const NOSTR_CONNECT: 24133 = 24133

Defined in: packages/util/src/Kinds.ts:168

---

NOSTROCKET_PROBLEM

const NOSTROCKET_PROBLEM: 1971 = 1971

Defined in: packages/util/src/Kinds.ts:75

---

NOTE

const NOTE: 1 = 1

Defined in: packages/util/src/Kinds.ts:37

---

OTS

const OTS: 1040 = 1040

Defined in: packages/util/src/Kinds.ts:59

---

PICTURE_NOTE

const PICTURE_NOTE: 20 = 20

Defined in: packages/util/src/Kinds.ts:49

---

PIN

const PIN: 39067 = 39067

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

---

PINBOARD

const PINBOARD: 30067 = 30067

Defined in: packages/util/src/Kinds.ts:214

---

PINS

const PINS: 10001 = 10001

Defined in: packages/util/src/Kinds.ts:136

---

POLL

const POLL: 1068 = 1068

Defined in: packages/util/src/Kinds.ts:63

---

POLL_RESPONSE

const POLL_RESPONSE: 1018 = 1018

Defined in: packages/util/src/Kinds.ts:56

---

PRODUCT

const PRODUCT: 30018 = 30018

Defined in: packages/util/src/Kinds.ts:183

---

PRODUCT_SOLD_AS_AUCTION

const PRODUCT_SOLD_AS_AUCTION: 30020 = 30020

Defined in: packages/util/src/Kinds.ts:185

---

PROFILE

const PROFILE: 0 = 0

Defined in: packages/util/src/Kinds.ts:36

---

PROMENADE_COMMIT

const PROMENADE_COMMIT: 26431 = 26431

Defined in: packages/util/src/Kinds.ts:160

---

PROMENADE_CONFIG

const PROMENADE_CONFIG: 26430 = 26430

Defined in: packages/util/src/Kinds.ts:159

---

PROMENADE_REGISTER_ACCOUNT

const PROMENADE_REGISTER_ACCOUNT: 16430 = 16430

Defined in: packages/util/src/Kinds.ts:152

---

PROMENADE_REQUEST

const PROMENADE_REQUEST: 26432 = 26432

Defined in: packages/util/src/Kinds.ts:161

---

PROMENADE_RESULT

const PROMENADE_RESULT: 26433 = 26433

Defined in: packages/util/src/Kinds.ts:162

---

PROMENADE_SHARD_ACK

const PROMENADE_SHARD_ACK: 26429 = 26429

Defined in: packages/util/src/Kinds.ts:158

---

PROMENADE_SHARD_SHARE

const PROMENADE_SHARD_SHARE: 26428 = 26428

Defined in: packages/util/src/Kinds.ts:157

---

REACTION

const REACTION: 7 = 7

Defined in: packages/util/src/Kinds.ts:41

---

RELAY_ADD_MEMBER

const RELAY_ADD_MEMBER: 8000 = 8000

Defined in: packages/util/src/Kinds.ts:117

---

RELAY_INVITE

const RELAY_INVITE: 28935 = 28935

Defined in: packages/util/src/Kinds.ts:164

---

RELAY_JOIN

const RELAY_JOIN: 28934 = 28934

Defined in: packages/util/src/Kinds.ts:163

---

RELAY_LEAVE

const RELAY_LEAVE: 28936 = 28936

Defined in: packages/util/src/Kinds.ts:165

---

RELAY_MEMBERS

const RELAY_MEMBERS: 13534 = 13534

Defined in: packages/util/src/Kinds.ts:151

---

RELAY_REMOVE_MEMBER

const RELAY_REMOVE_MEMBER: 8001 = 8001

Defined in: packages/util/src/Kinds.ts:118

---

RELAY_ROLE

const RELAY_ROLE: 33534 = 33534

Defined in: packages/util/src/Kinds.ts:216

---

RELAYS

const RELAYS: 10002 = 10002

Defined in: packages/util/src/Kinds.ts:137

---

REMIX

const REMIX: 1808 = 1808

Defined in: packages/util/src/Kinds.ts:74

---

REPORT

const REPORT: 1984 = 1984

Defined in: packages/util/src/Kinds.ts:76

---

REPOST

const REPOST: 6 = 6

Defined in: packages/util/src/Kinds.ts:40

---

REVIEW

const REVIEW: 1986 = 1986

Defined in: packages/util/src/Kinds.ts:78

---

ROOM

const ROOM: 35834 = 35834

Defined in: packages/util/src/Kinds.ts:208

---

ROOM_ADD_MEMBER

const ROOM_ADD_MEMBER: 9000 = 9000

Defined in: packages/util/src/Kinds.ts:119

---

ROOM_ADD_PERM

const ROOM_ADD_PERM: 9003 = 9003

Defined in: packages/util/src/Kinds.ts:122

---

ROOM_ADMINS

const ROOM_ADMINS: 39001 = 39001

Defined in: packages/util/src/Kinds.ts:210

---

ROOM_CREATE

const ROOM_CREATE: 9007 = 9007

Defined in: packages/util/src/Kinds.ts:126

---

ROOM_CREATE_PERMISSION

const ROOM_CREATE_PERMISSION: 19004 = 19004

Defined in: packages/util/src/Kinds.ts:153

---

ROOM_DELETE

const ROOM_DELETE: 9008 = 9008

Defined in: packages/util/src/Kinds.ts:127

---

ROOM_DELETE_EVENT

const ROOM_DELETE_EVENT: 9005 = 9005

Defined in: packages/util/src/Kinds.ts:124

---

ROOM_EDIT_META

const ROOM_EDIT_META: 9002 = 9002

Defined in: packages/util/src/Kinds.ts:121

---

ROOM_EDIT_STATUS

const ROOM_EDIT_STATUS: 9006 = 9006

Defined in: packages/util/src/Kinds.ts:125

---

ROOM_JOIN

const ROOM_JOIN: 9021 = 9021

Defined in: packages/util/src/Kinds.ts:129

---

ROOM_LEAVE

const ROOM_LEAVE: 9022 = 9022

Defined in: packages/util/src/Kinds.ts:130

---

ROOM_MEMBERS

const ROOM_MEMBERS: 39002 = 39002

Defined in: packages/util/src/Kinds.ts:211

---

ROOM_META

const ROOM_META: 39000 = 39000

Defined in: packages/util/src/Kinds.ts:209

---

ROOM_PINS

const ROOM_PINS: 39005 = 39005

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

---

ROOM_REMOVE_MEMBER

const ROOM_REMOVE_MEMBER: 9001 = 9001

Defined in: packages/util/src/Kinds.ts:120

---

ROOM_REMOVE_PERM

const ROOM_REMOVE_PERM: 9004 = 9004

Defined in: packages/util/src/Kinds.ts:123

---

ROOM_UPDATE_PINS

const ROOM_UPDATE_PINS: 9010 = 9010

Defined in: packages/util/src/Kinds.ts:128

---

ROOMS

const ROOMS: 10009 = 10009

Defined in: packages/util/src/Kinds.ts:143

---

SEAL

const SEAL: 13 = 13

Defined in: packages/util/src/Kinds.ts:45

---

SEARCH_RELAYS

const SEARCH_RELAYS: 10007 = 10007

Defined in: packages/util/src/Kinds.ts:142

---

STALL

const STALL: 30017 = 30017

Defined in: packages/util/src/Kinds.ts:182

---

STATUS

const STATUS: 30315 = 30315

Defined in: packages/util/src/Kinds.ts:191

---

THREAD

const THREAD: 11 = 11

Defined in: packages/util/src/Kinds.ts:44

---

TOPICS

const TOPICS: 10015 = 10015

Defined in: packages/util/src/Kinds.ts:145

---

VANISH

const VANISH: 62 = 62

Defined in: packages/util/src/Kinds.ts:55

---

verifiedSymbol

const verifiedSymbol: unique symbol

Defined in: node_modules/.pnpm/nostr-tools@2.19.4_typescript@5.8.2/node_modules/nostr-tools/lib/types/core.d.ts:8

Designates a verified event signature.

---

verifyEvent()

const verifyEvent: (event) => boolean

Defined in: packages/util/src/Events.ts:61

Parameters

event

TrustedEvent

Returns

boolean

---

WALLET_INFO

const WALLET_INFO: 13194 = 13194

Defined in: packages/util/src/Kinds.ts:150

---

WALLET_REQUEST

const WALLET_REQUEST: 23194 = 23194

Defined in: packages/util/src/Kinds.ts:166

---

WALLET_RESPONSE

const WALLET_RESPONSE: 23195 = 23195

Defined in: packages/util/src/Kinds.ts:167

---

WIKI

const WIKI: 30818 = 30818

Defined in: packages/util/src/Kinds.ts:186

---

WRAP

const WRAP: 1059 = 1059

Defined in: packages/util/src/Kinds.ts:60

---

WRAP_NIP04

const WRAP_NIP04: 1060 = 1060

Defined in: packages/util/src/Kinds.ts:61

---

WRAPPED_KINDS

const WRAPPED_KINDS: number[]

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

---

ZAP_GOAL

const ZAP_GOAL: 9041 = 9041

Defined in: packages/util/src/Kinds.ts:131

---

ZAP_RECEIPT

const ZAP_RECEIPT: 9735 = 9735

Defined in: packages/util/src/Kinds.ts:133

---

ZAP_REQUEST

const ZAP_REQUEST: 9734 = 9734

Defined in: packages/util/src/Kinds.ts:132

Functions

addMaximalFallbacks()

addMaximalFallbacks(count, limit): number

Defined in: packages/util/src/RelaySelection.ts:109

Parameters

count

number

limit

number

Returns

number

---

addMinimalFallbacks()

addMinimalFallbacks(count, limit): 0 | 1

Defined in: packages/util/src/RelaySelection.ts:107

Parameters

count

number

limit

number

Returns

0 | 1

---

addNoFallbacks()

addNoFallbacks(count, limit): number

Defined in: packages/util/src/RelaySelection.ts:105

Parameters

count

number

limit

number

Returns

number

---

addRepostFilters()

addRepostFilters(filters): Filter[]

Defined in: packages/util/src/Filters.ts:231

Parameters

filters

Filter[]

Returns

Filter[]

---

addressTags()

addressTags(keys): TagSpec<string>

Defined in: packages/util/src/Tags.ts:26

Parameters

keys

string | string[]

Returns

TagSpec<string>

---

asEventTemplate()

asEventTemplate(e): EventTemplate

Defined in: packages/util/src/Events.ts:108

Parameters

e

EventTemplate

Returns

EventTemplate

---

asHashedEvent()

asHashedEvent(e): HashedEvent

Defined in: packages/util/src/Events.ts:117

Parameters

e

HashedEvent

Returns

HashedEvent

---

asOwnedEvent()

asOwnedEvent(e): OwnedEvent

Defined in: packages/util/src/Events.ts:114

Parameters

e

OwnedEvent

Returns

OwnedEvent

---

asSignedEvent()

asSignedEvent(e): SignedEvent

Defined in: packages/util/src/Events.ts:120

Parameters

e

SignedEvent

Returns

SignedEvent

---

asStampedEvent()

asStampedEvent(e): StampedEvent

Defined in: packages/util/src/Events.ts:111

Parameters

e

StampedEvent

Returns

StampedEvent

---

buildBlobUrl()

buildBlobUrl(server, sha256, extension?): string

Defined in: packages/util/src/Blossom.ts:51

Parameters

server

string

sha256

string

extension?

string

Returns

string

---

calculateFilterGroup()

calculateFilterGroup(__namedParameters): string

Defined in: packages/util/src/Filters.ts:80

Parameters

__namedParameters

Filter

Returns

string

---

canUploadBlob()

canUploadBlob(server, __namedParameters): Promise<Response>

Defined in: packages/util/src/Blossom.ts:119

Parameters

server

string

__namedParameters

authEvent?

SignedEvent

headers?

Record<string, string> = {}

Returns

Promise<Response>

---

checkBlobExists()

checkBlobExists(server, sha256, __namedParameters): Promise<{ exists: boolean; size: number; }>

Defined in: packages/util/src/Blossom.ts:57

Parameters

server

string

sha256

string

__namedParameters

authEvent?

SignedEvent

headers?

Record<string, string> = {}

Returns

Promise<{ exists: boolean; size: number; }>

---

decryptFile()

decryptFile(__namedParameters): Promise<Uint8Array<ArrayBufferLike>>

Defined in: packages/util/src/Blossom.ts:243

Parameters

__namedParameters

EncryptedFile

Returns

Promise<Uint8Array<ArrayBufferLike>>

---

deduplicateEvents()

deduplicateEvents(events): TrustedEvent[]

Defined in: packages/util/src/Events.ts:132

Parameters

events

TrustedEvent[]

Returns

TrustedEvent[]

---

deleteBlob()

deleteBlob(server, sha256, __namedParameters): Promise<Response>

Defined in: packages/util/src/Blossom.ts:161

Parameters

server

string

sha256

string

__namedParameters

authEvent?

SignedEvent

headers?

Record<string, string> = {}

Returns

Promise<Response>

---

displayHandle()

displayHandle(handle): string

Defined in: packages/util/src/Handles.ts:47

Parameters

handle

Handle

Returns

string

---

displayNip05()

displayNip05(nip05): string

Defined in: packages/util/src/Handles.ts:44

Parameters

nip05

string

Returns

string

---

displayRelayUrl()

displayRelayUrl(url): string

Defined in: packages/util/src/Relay.ts:59

Parameters

url

string

Returns

string

---

encryptFile()

encryptFile(file): Promise<EncryptedFile>

Defined in: packages/util/src/Blossom.ts:225

Parameters

file

Blob

Returns

Promise<EncryptedFile>

---

estimateWork()

estimateWork(difficulty): number

Defined in: packages/util/src/Pow.ts:10

Parameters

difficulty

number

Returns

number

---

eventInbox()

eventInbox(ref, weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:70

Parameters

ref

EventRef

weight

number = 1

Returns

RelaySelection

---

eventOutbox()

eventOutbox(ref, weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:72

Parameters

ref

EventRef

weight

number = 1

Returns

RelaySelection

---

fromMsats()

fromMsats(msats): number

Defined in: packages/util/src/Lightning.ts:16

Parameters

msats

number

Returns

number

---

fromNostrURI()

fromNostrURI(s): string

Defined in: packages/util/src/Links.ts:1

Parameters

s

string

Returns

string

---

getAddress()

getAddress(e): string

Defined in: packages/util/src/Address.ts:59

Parameters

e

AddressableEvent

Returns

string

---

getBlob()

getBlob(server, sha256, __namedParameters): Promise<Response>

Defined in: packages/util/src/Blossom.ts:91

Parameters

server

string

sha256

string

__namedParameters

authEvent?

SignedEvent

headers?

Record<string, string> = {}

range?

{ end: number; start: number; }

range.end?

number

range.start

number

Returns

Promise<Response>

---

getCommentFilters()

getCommentFilters(events, filter, __namedParameters): Filter[]

Defined in: packages/util/src/Filters.ts:196

Parameters

events

TrustedEvent[]

filter

Filter

__namedParameters

root

boolean

Returns

Filter[]

---

getCommentFiltersForParent()

getCommentFiltersForParent(events, filter): Filter[]

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

Parameters

events

TrustedEvent[]

filter

Filter = {}

Returns

Filter[]

---

getCommentFiltersForRoot()

getCommentFiltersForRoot(events, filter): Filter[]

Defined in: packages/util/src/Filters.ts:225

Parameters

events

TrustedEvent[]

filter

Filter = {}

Returns

Filter[]

---

getFilterGenerality()

getFilterGenerality(filter): number

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

Parameters

filter

Filter

Returns

number

---

getFilterId()

getFilterId(filter): string

Defined in: packages/util/src/Filters.ts:64

Parameters

filter

Filter

Returns

string

---

getFilterResultCardinality()

getFilterResultCardinality(filter): undefined | number

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

Parameters

filter

Filter

Returns

undefined | number

---

getHash()

getHash(event): string

Defined in: packages/util/src/Keys.ts:19

Parameters

event

OwnedEvent

Returns

string

---

getIdAndAddress()

getIdAndAddress(e): string[]

Defined in: packages/util/src/Events.ts:129

Parameters

e

HashedEvent

Returns

string[]

---

getIdentifier()

getIdentifier(e): undefined | string

Defined in: packages/util/src/Events.ts:125

Parameters

e

EventTemplate

Returns

undefined | string

---

getIdFilters()

getIdFilters(idsOrAddresses): Filter[]

Defined in: packages/util/src/Filters.ts:144

Parameters

idsOrAddresses

string[]

Returns

Filter[]

---

getIdOrAddress()

getIdOrAddress(e): string

Defined in: packages/util/src/Events.ts:127

Parameters

e

HashedEvent

Returns

string

---

getInvoiceAmount()

getInvoiceAmount(bolt11): number

Defined in: packages/util/src/Lightning.ts:47

Parameters

bolt11

string

Returns

number

---

getLnUrl()

getLnUrl(address): undefined | string

Defined in: packages/util/src/Lightning.ts:53

Parameters

address

string

Returns

undefined | string

---

getPow()

getPow(event): number

Defined in: packages/util/src/Pow.ts:117

Parameters

event

HashedEvent

Returns

number

---

getPubkey()

getPubkey(secret): string

Defined in: packages/util/src/Keys.ts:17

Parameters

secret

string

Returns

string

---

getReplyFilters()

getReplyFilters(events, filter): ({ #a: string[]; authors: string[]; ids: string[]; kinds: number[]; limit: number; search: string; since: number; until: number; } | { #e: string[]; authors: string[]; ids: string[]; kinds: number[]; limit: number; search: string; since: number; until: number; })[]

Defined in: packages/util/src/Filters.ts:171

Parameters

events

TrustedEvent[]

filter

Filter = {}

Returns

({ #a: string[]; authors: string[]; ids: string[]; kinds: number[]; limit: number; search: string; since: number; until: number; } | { #e: string[]; authors: string[]; ids: string[]; kinds: number[]; limit: number; search: string; since: number; until: number; })[]

---

getSig()

getSig(event, secret): string

Defined in: packages/util/src/Keys.ts:21

Parameters

event

HashedEvent

secret

string

Returns

string

---

getWalletAddress()

getWalletAddress(wallet): undefined | string

Defined in: packages/util/src/Wallet.ts:40

Parameters

wallet

Wallet

Returns

undefined | string

---

guessFilterDelta()

guessFilterDelta(filters, max): number

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

Parameters

filters

Filter[]

max

number = ...

Returns

number

---

hash()

hash(event): object

Defined in: packages/util/src/Keys.ts:28

Parameters

event

OwnedEvent

Returns

object

content

content: string

created_at

created_at: number

id

id: string

kind

kind: number

pubkey

pubkey: string

tags

tags: string[][]

---

hexTags()

hexTags(keys): TagSpec<string>

Defined in: packages/util/src/Tags.ts:20

Parameters

keys

string | string[]

Returns

TagSpec<string>

---

hrpToMillisat()

hrpToMillisat(hrpString): bigint

Defined in: packages/util/src/Lightning.ts:18

Parameters

hrpString

string

Returns

bigint

---

inbox()

inbox(pubkey, weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:57

Parameters

pubkey

string

weight

number = 1

Returns

RelaySelection

---

inboxes()

inboxes(pubkeys, weight): RelaySelection[]

Defined in: packages/util/src/RelaySelection.ts:82

Parameters

pubkeys

string[]

weight

number = 1

Returns

RelaySelection[]

---

indexers()

indexers(weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:85

Parameters

weight

number = 1

Returns

RelaySelection

---

intersectFilters()

intersectFilters(groups): Filter[]

Defined in: packages/util/src/Filters.ts:112

Parameters

groups

Filter[][]

Returns

Filter[]

---

isDVMKind()

isDVMKind(kind): boolean

Defined in: packages/util/src/Kinds.ts:34

Parameters

kind

number

Returns

boolean

---

isEphemeral()

isEphemeral(e): boolean

Defined in: packages/util/src/Events.ts:146

Parameters

e

EventTemplate

Returns

boolean

---

isEphemeralKind()

isEphemeralKind(kind): boolean

Defined in: packages/util/src/Kinds.ts:22

Events are ephemeral, which means they are not expected to be stored by relays.

Parameters

kind

number

Returns

boolean

---

isEventTemplate()

isEventTemplate(e): e is EventTemplate

Defined in: packages/util/src/Events.ts:86

Parameters

e

EventTemplate

Returns

e is EventTemplate

---

isHashedEvent()

isHashedEvent(e): e is HashedEvent

Defined in: packages/util/src/Events.ts:100

Parameters

e

HashedEvent

Returns

e is HashedEvent

---

isIPAddress()

isIPAddress(url): boolean

Defined in: packages/util/src/Relay.ts:36

Parameters

url

string

Returns

boolean

---

isKind()

isKind(k): boolean

Defined in: packages/util/src/Kinds.ts:5

Parameters

k

string | number

Returns

boolean

---

isLocalUrl()

isLocalUrl(url): boolean

Defined in: packages/util/src/Relay.ts:33

Parameters

url

string

Returns

boolean

---

isNWCWallet()

isNWCWallet(wallet): wallet is NWCWallet

Defined in: packages/util/src/Wallet.ts:38

Parameters

wallet

Wallet

Returns

wallet is NWCWallet

---

isOnionUrl()

isOnionUrl(url): boolean

Defined in: packages/util/src/Relay.ts:31

Parameters

url

string

Returns

boolean

---

isOwnedEvent()

isOwnedEvent(e): e is OwnedEvent

Defined in: packages/util/src/Events.ts:97

Parameters

e

OwnedEvent

Returns

e is OwnedEvent

---

isParameterizedReplaceable()

isParameterizedReplaceable(e): boolean

Defined in: packages/util/src/Events.ts:152

Parameters

e

EventTemplate

Returns

boolean

---

isParameterizedReplaceableKind()

isParameterizedReplaceableKind(kind): boolean

Defined in: packages/util/src/Kinds.ts:27

Events are parameterized replaceable, which means that, for each combination of pubkey, kind and the d tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded.

Parameters

kind

number

Returns

boolean

---

isPlainReplaceable()

isPlainReplaceable(e): boolean

Defined in: packages/util/src/Events.ts:150

Parameters

e

EventTemplate

Returns

boolean

---

isPlainReplaceableKind()

isPlainReplaceableKind(kind): boolean

Defined in: packages/util/src/Kinds.ts:17

Events are replaceable, which means that, for each combination of pubkey and kind, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded.

Parameters

kind

number

Returns

boolean

---

isRegularKind()

isRegularKind(kind): boolean

Defined in: packages/util/src/Kinds.ts:10

Events are regular, which means they're all expected to be stored by relays.

Parameters

kind

number

Returns

boolean

---

isRelayUrl()

isRelayUrl(url): boolean

Defined in: packages/util/src/Relay.ts:7

Parameters

url

string

Returns

boolean

---

isReplaceable()

isReplaceable(e): boolean

Defined in: packages/util/src/Events.ts:148

Parameters

e

EventTemplate

Returns

boolean

---

isReplaceableKind()

isReplaceableKind(kind): boolean

Defined in: packages/util/src/Kinds.ts:31

Parameters

kind

number

Returns

boolean

---

isShareableRelayUrl()

isShareableRelayUrl(url): boolean

Defined in: packages/util/src/Relay.ts:38

Parameters

url

string

Returns

boolean

---

isSignedEvent()

isSignedEvent(e): e is SignedEvent

Defined in: packages/util/src/Events.ts:103

Parameters

e

TrustedEvent

Returns

e is SignedEvent

---

isStampedEvent()

isStampedEvent(e): e is StampedEvent

Defined in: packages/util/src/Events.ts:94

Parameters

e

StampedEvent

Returns

e is StampedEvent

---

isWebLNWallet()

isWebLNWallet(wallet): wallet is WebLNWallet

Defined in: packages/util/src/Wallet.ts:35

Parameters

wallet

Wallet

Returns

wallet is WebLNWallet

---

kindTags()

kindTags(keys): TagSpec<undefined | number>

Defined in: packages/util/src/Tags.ts:22

Parameters

keys

string | string[]

Returns

TagSpec<undefined | number>

---

listBlobs()

listBlobs(server, pubkey, __namedParameters): Promise<Response>

Defined in: packages/util/src/Blossom.ts:181

Parameters

server

string

pubkey

string

__namedParameters

authEvent?

SignedEvent

headers?

Record<string, string> = {}

since?

number

until?

number

Returns

Promise<Response>

---

makeAllowEvent()

makeAllowEvent(id, reason?): ManagementRequest

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

Parameters

id

string

reason?

string

Returns

ManagementRequest

---

makeAllowKind()

makeAllowKind(kind): ManagementRequest

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

Parameters

kind

number

Returns

ManagementRequest

---

makeAllowPubkey()

makeAllowPubkey(pubkey, reason?): ManagementRequest

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

Parameters

pubkey

string

reason?

string

Returns

ManagementRequest

---

makeAssignRole()

makeAssignRole(pubkey, roleId): ManagementRequest

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

Parameters

pubkey

string

roleId

string

Returns

ManagementRequest

---

makeBanEvent()

makeBanEvent(id, reason?): ManagementRequest

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

Parameters

id

string

reason?

string

Returns

ManagementRequest

---

makeBanPubkey()

makeBanPubkey(pubkey, reason?): ManagementRequest

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

Parameters

pubkey

string

reason?

string

Returns

ManagementRequest

---

makeBlockIp()

makeBlockIp(ip, reason?): ManagementRequest

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

Parameters

ip

string

reason?

string

Returns

ManagementRequest

---

makeBlossomAuthEvent()

makeBlossomAuthEvent(__namedParameters): object

Defined in: packages/util/src/Blossom.ts:26

Parameters

__namedParameters

BlossomAuthEventOpts

Returns

object

content

content: string

created_at

created_at: number

kind

kind: number

tags

tags: string[][]

---

makeChangeRelayDescription()

makeChangeRelayDescription(description): ManagementRequest

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

Parameters

description

string

Returns

ManagementRequest

---

makeChangeRelayIcon()

makeChangeRelayIcon(iconUrl): ManagementRequest

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

Parameters

iconUrl

string

Returns

ManagementRequest

---

makeChangeRelayName()

makeChangeRelayName(name): ManagementRequest

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

Parameters

name

string

Returns

ManagementRequest

---

makeCreateClaim()

makeCreateClaim(claim): ManagementRequest

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

Parameters

claim

string

Returns

ManagementRequest

---

makeCreateRole()

makeCreateRole(id, label, description, color, order): ManagementRequest

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

Parameters

id

string

label

string

description

string

color

string

order

number

Returns

ManagementRequest

---

makeDeleteClaim()

makeDeleteClaim(claim): ManagementRequest

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

Parameters

claim

string

Returns

ManagementRequest

---

makeDeleteRole()

makeDeleteRole(id): ManagementRequest

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

Parameters

id

string

Returns

ManagementRequest

---

makeDisallowKind()

makeDisallowKind(kind): ManagementRequest

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

Parameters

kind

number

Returns

ManagementRequest

---

makeEditRole()

makeEditRole(id, label, description, color, order): ManagementRequest

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

Parameters

id

string

label

string

description

string

color

string

order

number

Returns

ManagementRequest

---

makeEvent()

makeEvent(kind, __namedParameters): object

Defined in: packages/util/src/Events.ts:54

Parameters

kind

number

__namedParameters

MakeEventOpts = {}

Returns

object

content

content: string

created_at

created_at: number

kind

kind: number

tags

tags: string[][]

---

makeHttpAuth()

makeHttpAuth(url, method, body?): Promise<{ content: string; created_at: number; kind: number; tags: string[][]; }>

Defined in: packages/util/src/Nip98.ts:6

Parameters

url

string

method

string = "GET"

body?

string

Returns

Promise<{ content: string; created_at: number; kind: number; tags: string[][]; }>

---

makeHttpAuthHeader()

makeHttpAuthHeader(event): string

Defined in: packages/util/src/Nip98.ts:19

Parameters

event

SignedEvent

Returns

string

---

makeListAllowedKinds()

makeListAllowedKinds(): ManagementRequest

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

Returns

ManagementRequest

---

makeListAllowedPubkeys()

makeListAllowedPubkeys(): ManagementRequest

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

Returns

ManagementRequest

---

makeListBannedEvents()

makeListBannedEvents(): ManagementRequest

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

Returns

ManagementRequest

---

makeListBannedPubkeys()

makeListBannedPubkeys(): ManagementRequest

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

Returns

ManagementRequest

---

makeListBlockedIps()

makeListBlockedIps(): ManagementRequest

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

Returns

ManagementRequest

---

makeListClaims()

makeListClaims(): ManagementRequest

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

Returns

ManagementRequest

---

makeListEventsNeedingModeration()

makeListEventsNeedingModeration(): ManagementRequest

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

Returns

ManagementRequest

---

makePow()

makePow(event, difficulty): ProofOfWork

Defined in: packages/util/src/Pow.ts:90

Parameters

event

OwnedEvent

difficulty

number

Returns

ProofOfWork

---

makeRelayAuth()

makeRelayAuth(url, challenge): object

Defined in: packages/util/src/Nip42.ts:4

Parameters

url

string

challenge

string

Returns

object

content

content: string

created_at

created_at: number

kind

kind: number

tags

tags: string[][]

---

makeSecret()

makeSecret(): string

Defined in: packages/util/src/Keys.ts:15

Returns

string

---

makeSelection()

makeSelection(relays, weight): Selection

Defined in: packages/util/src/RelaySelection.ts:96

Parameters

relays

string[]

weight

number = 1

Returns

Selection

---

makeSignEvent()

makeSignEvent(event): ManagementRequest

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

Parameters

event

EventTemplate

Returns

ManagementRequest

---

makeSupportedMethods()

makeSupportedMethods(): ManagementRequest

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

Returns

ManagementRequest

---

makeUnallowPubkey()

makeUnallowPubkey(pubkey, reason?): ManagementRequest

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

Parameters

pubkey

string

reason?

string

Returns

ManagementRequest

---

makeUnassignRole()

makeUnassignRole(pubkey, roleId): ManagementRequest

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

Parameters

pubkey

string

roleId

string

Returns

ManagementRequest

---

makeUnbanPubkey()

makeUnbanPubkey(pubkey, reason?): ManagementRequest

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

Parameters

pubkey

string

reason?

string

Returns

ManagementRequest

---

makeUnblockIp()

makeUnblockIp(ip): ManagementRequest

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

Parameters

ip

string

Returns

ManagementRequest

---

matchFilter()

matchFilter<E>(filter, event): boolean

Defined in: packages/util/src/Filters.ts:33

Type Parameters

E

E extends HashedEvent

Parameters

filter

Filter

event

E

Returns

boolean

---

matchFilters()

matchFilters<E>(filters, event): boolean

Defined in: packages/util/src/Filters.ts:54

Type Parameters

E

E extends HashedEvent

Parameters

filters

Filter[]

event

E

Returns

boolean

---

matchTag()

matchTag<T>(spec, tags): undefined | string[]

Defined in: packages/util/src/Tags.ts:40

Type Parameters

T

T

Parameters

spec

TagSpec<T>

tags

string[][]

Returns

undefined | string[]

---

matchTags()

matchTags<T>(spec, tags): string[][]

Defined in: packages/util/src/Tags.ts:38

Type Parameters

T

T

Parameters

spec

TagSpec<T>

tags

string[][]

Returns

string[][]

---

messaging()

messaging(pubkey, weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:61

Parameters

pubkey

string

weight

number = 1

Returns

RelaySelection

---

normalizeKind()

normalizeKind(k): undefined | number

Defined in: packages/util/src/Kinds.ts:7

Parameters

k

string | number

Returns

undefined | number

---

normalizeRelayUrl()

normalizeRelayUrl(url): string

Defined in: packages/util/src/Relay.ts:40

Parameters

url

string

Returns

string

---

outbox()

outbox(pubkey, weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:59

Parameters

pubkey

string

weight

number = 1

Returns

RelaySelection

---

own()

own(event, pubkey): object

Defined in: packages/util/src/Keys.ts:26

Parameters

event

StampedEvent

pubkey

string

Returns

object

content

content: string

created_at

created_at: number

kind

kind: number

pubkey

pubkey: string

tags

tags: string[][]

---

prep()

prep(event, pubkey, created_at): HashedEvent

Defined in: packages/util/src/Keys.ts:32

Parameters

event

EventTemplate

pubkey

string

created_at

number = ...

Returns

HashedEvent

---

queryProfile()

queryProfile(nip05): Promise<Maybe<Handle>>

Defined in: packages/util/src/Handles.ts:15

Parameters

nip05

string

Returns

Promise<Maybe<Handle>>

---

relay()

relay(url, weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:77

Parameters

url

string

weight

number = 1

Returns

RelaySelection

---

relays()

relays(urls, weight): RelaySelection[]

Defined in: packages/util/src/RelaySelection.ts:79

Parameters

urls

string[]

weight

number = 1

Returns

RelaySelection[]

---

relayTags()

relayTags(keys): TagSpec<string>

Defined in: packages/util/src/Tags.ts:29

Parameters

keys

string | string[]

Returns

TagSpec<string>

---

searchRelays()

searchRelays(weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:87

Parameters

weight

number = 1

Returns

RelaySelection

---

seen()

seen(ref, weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:75

Parameters

ref

EventRef

weight

number = 1

Returns

RelaySelection

---

sendManagementRequest()

sendManagementRequest(url, request, authEvent): Promise<ManagementResponse>

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

Parameters

url

string

request

ManagementRequest

authEvent

SignedEvent

Returns

Promise<ManagementResponse>

---

sign()

sign(event, secret): object

Defined in: packages/util/src/Keys.ts:30

Parameters

event

HashedEvent

secret

string

Returns

object

content

content: string

created_at

created_at: number

id

id: string

kind

kind: number

pubkey

pubkey: string

sig

sig: string

tags

tags: string[][]

---

sortEventsAsc()

sortEventsAsc(events): TrustedEvent[]

Defined in: packages/util/src/Events.ts:155

Parameters

events

Iterable<TrustedEvent>

Returns

TrustedEvent[]

---

sortEventsDesc()

sortEventsDesc(events): TrustedEvent[]

Defined in: packages/util/src/Events.ts:157

Parameters

events

Iterable<TrustedEvent>

Returns

TrustedEvent[]

---

stamp()

stamp(event, created_at): object

Defined in: packages/util/src/Keys.ts:24

Parameters

event

EventTemplate

created_at

number = ...

Returns

object

content

content: string

created_at

created_at: number

kind

kind: number

tags

tags: string[][]

---

tagMatcher()

tagMatcher(spec): (tag) => boolean

Defined in: packages/util/src/Tags.ts:31

Parameters

spec

TagSpec<any>

Returns

(tag): boolean

Parameters

tag

string[]

Returns

boolean

---

tagSpec()

tagSpec<T>(keys, matchValue?, normalizeValue?): TagSpec<T>

Defined in: packages/util/src/Tags.ts:14

Type Parameters

T

T = string

Parameters

keys

string | string[]

matchValue?

(value) => boolean

normalizeValue?

(value) => T

Returns

TagSpec<T>

---

tagValue()

tagValue<T>(spec, tags): undefined | T

Defined in: packages/util/src/Tags.ts:50

Type Parameters

T

T

Parameters

spec

TagSpec<T>

tags

string[][]

Returns

undefined | T

---

tagValueExtractor()

tagValueExtractor<T>(spec): (tag) => T

Defined in: packages/util/src/Tags.ts:43

Type Parameters

T

T

Parameters

spec

TagSpec<T>

Returns

(tag): T

Parameters

tag

string[]

Returns

T

---

tagValues()

tagValues<T>(spec, tags): NonNullable<T>[]

Defined in: packages/util/src/Tags.ts:47

Type Parameters

T

T

Parameters

spec

TagSpec<T>

tags

string[][]

Returns

NonNullable<T>[]

---

toMsats()

toMsats(sats): number

Defined in: packages/util/src/Lightning.ts:14

Parameters

sats

number

Returns

number

---

toNostrURI()

toNostrURI(s): string

Defined in: packages/util/src/Links.ts:3

Parameters

s

string

Returns

string

---

topicTags()

topicTags(keys): TagSpec<string>

Defined in: packages/util/src/Tags.ts:24

Parameters

keys

string | string[]

Returns

TagSpec<string>

---

trimFilter()

trimFilter(filter): Filter

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

Parameters

filter

Filter

Returns

Filter

---

trimFilters()

trimFilters(filters): Filter[]

Defined in: packages/util/src/Filters.ts:288

Parameters

filters

Filter[]

Returns

Filter[]

---

unionFilters()

unionFilters(filters): Filter[]

Defined in: packages/util/src/Filters.ts:91

Parameters

filters

Filter[]

Returns

Filter[]

---

uploadBlob()

uploadBlob(server, blob, __namedParameters): Promise<Response>

Defined in: packages/util/src/Blossom.ts:139

Parameters

server

string

blob

Blob | ArrayBuffer

__namedParameters

authEvent?

SignedEvent

headers?

Record<string, string> = {}

Returns

Promise<Response>

---

userInbox()

userInbox(weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:64

Parameters

weight

number = 1

Returns

RelaySelection

---

userMessaging()

userMessaging(weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:68

Parameters

weight

number = 1

Returns

RelaySelection

---

userOutbox()

userOutbox(weight): RelaySelection

Defined in: packages/util/src/RelaySelection.ts:66

Parameters

weight

number = 1

Returns

RelaySelection