Class: Nostr::Relay

Inherits:

Object

• Object
• Nostr::Relay

Defined in:

lib/nostr/relay.rb

Overview

Relays expose a websocket endpoint to which clients can connect.

Instance Attribute Summary

• #name ⇒ String readonly

  The name of the relay.

• #url ⇒ String readonly

  The websocket URL of the relay.

Instance Method Summary

• #initialize(url:, name:) ⇒ String constructor

  Instantiates a new Relay.

Constructor Details

#initialize(url:, name:) ⇒ String

Instantiates a new Relay

Examples:

relay = Nostr::Relay.new(url: 'wss://relay.damus.io', name: 'Damus')

# File 'lib/nostr/relay.rb', line 38

def initialize(url:, name:)
  @url = url
  @name = name
end

Instance Attribute Details

#name ⇒ String (readonly)

The name of the relay

Examples:

relay.name # => 'Damus'

Returns:

• (String)

# File 'lib/nostr/relay.rb', line 26

def name
  @name
end

#url ⇒ String (readonly)

The websocket URL of the relay

Examples:

relay.url # => 'wss://relay.damus.io'

Returns:

• (String)

# File 'lib/nostr/relay.rb', line 15

def url
  @url
end