Class RelayDiscovery

Cast a kind 30166 event to a RelayDiscovery

Hierarchy (View Summary)

EventCast<RelayDiscoveryEvent>
- RelayDiscovery

Index

Constructors

Properties

Accessors

acceptedKinds attributes author createdAt geohash id networkType requirements rttOpen rttRead rttWrite seen supportedNIPs topics uid url

Methods

Constructors

constructor

new RelayDiscovery(event: NostrEvent, store: CastRefEventStore): RelayDiscovery
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns RelayDiscovery
Overrides EventCast.constructor
- Defined in common/src/casts/relay-discovery.ts:19

Properties

`Readonly`event

event: RelayDiscoveryEvent

`Readonly`store

store: CastRefEventStore

Accessors

acceptedKinds

get acceptedKinds(): string[]
Gets all accepted and unaccepted kinds from this discovery event (from k tags)

Returns string[]
- Defined in common/src/casts/relay-discovery.ts:70

attributes

get attributes(): string[]
Gets all relay attributes from this discovery event (from W tags)

Returns string[]
- Defined in common/src/casts/relay-discovery.ts:50

author

get author(): User
Get the User that authored this event

Returns User
Inherited from EventCast.author
- Defined in common/src/casts/cast.ts:59

createdAt

get createdAt(): Date
Returns Date
Inherited from EventCast.createdAt
- Defined in common/src/casts/cast.ts:54

geohash

get geohash(): string | undefined
Gets the geohash from this discovery event (NIP-52 geohash)

Returns string | undefined
- Defined in common/src/casts/relay-discovery.ts:75

id

get id(): string
Returns string
Inherited from EventCast.id
- Defined in common/src/casts/cast.ts:47

networkType

get networkType(): string | undefined
Gets the network type from this discovery event (clearnet, tor, i2p, loki)

Returns string | undefined
- Defined in common/src/casts/relay-discovery.ts:45

requirements

get requirements(): string[]
Gets all requirements from this discovery event (from R tags)

Returns string[]
- Defined in common/src/casts/relay-discovery.ts:60

rttOpen

get rttOpen(): number | undefined
Gets the round-trip time (RTT) for opening the relay connection (in milliseconds)

Returns number | undefined
- Defined in common/src/casts/relay-discovery.ts:30

rttRead

get rttRead(): number | undefined
Gets the round-trip time (RTT) for reading from the relay (in milliseconds)

Returns number | undefined
- Defined in common/src/casts/relay-discovery.ts:35

rttWrite

get rttWrite(): number | undefined
Gets the round-trip time (RTT) for writing to the relay (in milliseconds)

Returns number | undefined
- Defined in common/src/casts/relay-discovery.ts:40

seen

get seen(): Set<string> | undefined
Return the set of relays this event was seen on

Returns Set<string> | undefined
Inherited from EventCast.seen
- Defined in common/src/casts/cast.ts:64

supportedNIPs

get supportedNIPs(): string[]
Gets all supported NIPs from this discovery event (from N tags)

Returns string[]
- Defined in common/src/casts/relay-discovery.ts:55

topics

get topics(): string[]
Gets all topics from this discovery event (from t tags)

Returns string[]
- Defined in common/src/casts/relay-discovery.ts:65

uid

get uid(): string
Returns string
Inherited from EventCast.uid
- Defined in common/src/casts/cast.ts:50

url

get url(): string | undefined
Gets the relay URL from this discovery event (from the d tag)

Returns string | undefined
- Defined in common/src/casts/relay-discovery.ts:25

Methods

`Protected`$$ref

$$ref<Return extends unknown>(
key: string,
builder: (store: CastRefEventStore) => Observable<Return>,
): ChainableObservable<Return>
Internal method for creating a reference
Type Parameters
- Return extends unknown
Parameters
- key: string
- builder: (store: CastRefEventStore) => Observable<Return>
Returns ChainableObservable<Return>
Inherited from EventCast.$$ref
- Defined in common/src/casts/cast.ts:78