Struto Ruby

A ruby library to interact with the Nostr Protocol.

Note

Struto is highly inspired by nostr-ruby which is not maintained anymore.

Caution

This is a first proof of concept version, the API will probably change in the near future.

Installation

gem install struto

Usage

Manage the keys

require "struto"

nostr = Struto::Nostr.new(private_key: "964b29795d621cdacf05fd94fb23206c88742db1fa50b34d7545f3a2221d8124")
# => <Struto::Nostr:0x00000001063ffa28 @private_key="964b29795d621cdacf05fd94fb23206c88742db1fa50b34d7545f3a2221d8124" @public_key="da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81">

nostr.bech32_keys
# => {:public_key=>"npub1mg2nzunrsk9df94zr3uudhzltnu6lzq2muax09xmhu5gxxrvnkqsvpjg3p", :private_key=>"nsec1je9jj72avgwd4nc9lk20kgeqdjy8gtd3lfgtxnt4ghe6ygsasyjq7kh6c4"}

nostr = Struto::Nostr.new(private_key: "nsec1je9jj72avgwd4nc9lk20kgeqdjy8gtd3lfgtxnt4ghe6ygsasyjq7kh6c4")
# => #<Struto::Nostr:0x00000001060952c0 @private_key="964b29795d621cdacf05fd94fb23206c88742db1fa50b34d7545f3a2221d8124", @public_key="da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81">

nostr.keys
# => {:public_key=>"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81", :private_key=>"964b29795d621cdacf05fd94fb23206c88742db1fa50b34d7545f3a2221d8124"}

Set the user metadata

• NIP-01
• NIP-24

metadata = nostr.build_metadata_event(
  name: "@mr_robot",
  display_name: "Mr Robot",
  about: "I walk around the city",
  picture: "https://upload.wikimedia.org/wikipedia/commons/3/35/Mr_robot_photo.jpg",
  banner: "https://upload.wikimedia.org/wikipedia/commons/3/35/Mr_robot_photo.jpg",
  nip05: "[email protected]",
  lud16: "[email protected]",
  website: "https://mrrobot.com"
)
# =>
# ["EVENT",
#  {:pubkey=>"9be59510fa12b77340bb57e555bac716455fedf46d1a354185d4e72bd0340b6f",
#   :created_at=>1671546067,
#   :kind=>0,
#   :tags=>[],
#   :content=> "{\"name\":\"@mr_robot\",\"display_name\":\"Mr Robot\",\"about\":\"I walk around the city\",\"picture\":\"https://upload.wikimedia.org/wikipedia/commons/3/35/Mr_robot_photo.jpg\",\"banner\":\"https://upload.wikimedia.org/wikipedia/commons/3/35/Mr_robot_photo.jpg\",\"nip05\":\"[email protected]\",\"lud16\":\"[email protected]\",\"website\":\"https://mrrobot.com\"}",
#   "id"=>"3bd77596ea999dde26689c24370dc4adfa66c33abf1b4c23bf863a516106cda2",
#   "sig"=>"2ff752e9f3ed824e7677c41c73728315f0532f3437857774d7a50a577563f391785afd1f84bef3e3574939b14cf096380d4790375953c793504ffcf2f0467d69"}]

Create a post

note = nostr.build_note_event("Hello Nostr!")
# =>
# ["EVENT",
#  {:pubkey=>"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81",
#   :created_at=>1671406583,
#   :kind=>1,
#   :tags=>[],
#   :content=>"Hello Nostr!",
#   "id"=>"23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb",
#   "sig"=>"871177b77840bdf092dabacf98c47690647fd6ceb3cc79dd7af7e98c6aded0b808abd5566e2864bd438364cea2f17bd6f9d55091b3c5136839cf160beca42b63"}]

Create a channel post

channel_note = nostr.build_note_event("Welcome on my channel :)", "136b0b99eff742e0939799417d04d8b48049672beb6d8110ce6b0fc978cd67a1")
# =>
# ["EVENT",
#  {:pubkey=>"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81",
#   :created_at=>1671406522,
#   :kind=>42,
#   :tags=>[["e", "136b0b99eff742e0939799417d04d8b48049672beb6d8110ce6b0fc978cd67a1"]],
#   :content=>"Welcome on my channel :)",
#   "id"=>"96ac317516e9cc3bae8238cf11a95a2f12d1bd2f6553c0867d47f3165ca3483b",
#   "sig"=>"ccb6cbfa5c3cfac7b7f48dd9cda25d6a2493cbf8df91fa8f9fee2559a20c92613326a319f5b76aff9fef85278e04ce0ee78e636afb4ef2bb000ee8a6fdf418d2"}]

Recommend a relay

recommendation = nostr.build_recommended_relay_event("wss://relay.damus.io")
# =>
# ["EVENT",
#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
#   :created_at=>1672079256,
#   :kind=>2,
#   :tags=>[],
#   :content=>"wss://relay.damus.io",
#   "id"=>"1842c9feb3bf2ad7095c8a51238f598fa028116d4fd919af22ad2c63ba3b7d69",
#   "sig"=>"9c2f158f379b2d234fd0d363b46a7f90c25392f9296111b6cc04224df8aec69817fa62d7225c12b90fdc31eb89c7afaa427b18147cc8ad6cd411b47dda1331b6"}]

Share a contact list

contact_list = nostr.build_contact_list_event(
  [["54399b6d8200813bfc53177ad4f13d6ab712b6b23f91aefbf5da45aeb5c96b08", "wss://alicerelay.com/", "alice"],
  ["850708b7099215bf9a1356d242c2354939e9a844c1359d3b5209592a0b420452", "wss://bobrelay.com/nostr", "bob"],
  ["f7f4b0072368460a09138bf3966fb1c59d0bdadfc3aff4e59e6896194594a82a", "ws://carolrelay.com/ws", "carol"]]
)
# =>
# ["EVENT",
#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
#   :created_at=>1672079733,
#   :kind=>3,
#   :tags=>
#    [["p", "54399b6d8200813bfc53177ad4f13d6ab712b6b23f91aefbf5da45aeb5c96b08", "wss://alicerelay.com/", "alice"],
#     ["p", "850708b7099215bf9a1356d242c2354939e9a844c1359d3b5209592a0b420452", "wss://bobrelay.com/nostr", "bob"],
#     ["p", "f7f4b0072368460a09138bf3966fb1c59d0bdadfc3aff4e59e6896194594a82a", "ws://carolrelay.com/ws", "carol"]],
#   :content=>"",
#   "id"=>"3cdc1b5fa9d29aaa6b068cfb66cfd95f79784792beaec6cbb2645187b1c632e9",
#   "sig"=>"e560e0d1a42261900c8ec32bf2d2016b95c3291adb45c7bf82ef94061beb44a45d6a768d9be773ec48ba9f54d05b4505bda0c1f21805e2be681c7436b3d39791"}]

Create a private message

private_message = nostr.build_dm_event("Hello!", "da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81") # To myself
# =>
# ["EVENT",
#  {:pubkey=>"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81",
#   :created_at=>1671406025,
#   :kind=>4,
#   :tags=>[["p", "da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81"]],
#   :content=>"AIZ7vomEJEFgB934gWzlNA==?iv=mwKLb6lZSG5X1y1BNYv6dg==",
#   "id"=>"6a3efcf47a31bb05aeca0b13bf1f9b9e91b126e0a67e783253fb3bae20f0dc63",
#   "sig"=>"0e390bb3c783157b3e32c3f6641fb40df9f62e326ac8a3448a70c94103b909e80292a2c4530562298f2c3935899111843a43548185abf09abf583bc3e6e3ddde"}]

Decrypt a private message

# Get the reply from the relay
reply
# => ["EVENT","0.27631406274260906",{"tags":[["p","da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81"]],"content":"vWATHf2l/KI7RSyVlbxpvufZc+Lui/0oDysTyfEG5vs=?iv=G4SG7ArMGkglX0UJbJBDUA==","sig":"fe816b86579f5d13ab23c88410364442a9b4393ac0d74f4642cd51a1887f04908ff57ef60409d529a6939c50d77b048320417005460b0353c8f990d1b35c3661","id":"5a0274f33cdb064136c1423ac4b096d7f1e3fb36f60404ef2449ee44331de03f","kind":4,"pubkey":"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81","created_at":1671407520}]

nostr.decrypt_dm(reply)
# => "Nice to meet you!"

Delete an event

deletion = nostr.build_deletion_event(["23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb"], "Duplicate")
# =>
# ["EVENT",
#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
#   :created_at=>1672080450,
#   :kind=>5,
#   :tags=>[["e", "23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb"]],
#   :content=>"Duplicate",
#   "id"=>"e4a8556da9dc35da54dff747593073a90ac1de55131ca0deef6a5fd3b402d5fd",
#   "sig"=>"95ccb5e965c1a6ba36b919a00cd7d3b65286435f93f49a2ebb846dc791a61179e55d544ebf00d4f8eeb53b0a75a97c072287c7458dfbaccb70b4aef6b0acf766"

React to an event

reaction = nostr.build_reaction_event("🔥", "23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb", "d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef")
# =>
# ["EVENT",
#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
#   :created_at=>1672080671,
#   :kind=>7,
#   :tags=>[["e", "23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb"], ["p", "d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef"]],
#   :content=>"🔥",
#   "id"=>"f267c8ee24989b633b261efaa3892b07cdc90af80cedfd007b24a5c6232fc631",
#   "sig"=>"84f2fc213337c6d2c26a4638b1db4e39f788811acd5bce5b9141b7ef56a9aa80768fbbd1109a7783a0d3033732675e231de286c6c745e62436865f4f15b838b6"}]

Create events with a PoW difficulty

nostr.set_pow_difficulty(16)
note = nostr.build_note_event("Hello Nostr!")
# =>
# ["EVENT",
#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
#   :created_at=>1672095162,
#   :kind=>42,
#   :tags=>[["e", "d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef"], ["nonce", "232735", "16"]],
#   :content=>"Hello Nostr!",
#   "id"=>"0000fb0c4563274e742e56d7d6de08684a2a25dfb52b79cccdb49c649dccbf45",
#   "sig"=>"838a1457c75084319e4723fbd9cbcf4c3311c466daf3908ffa114682094140e3b188996a73ae9fd3d3c6dbf08beecf9081b8d2bf0e60163b07cdf36a50dea1c0"}]

Create events with a NIP-26 delegation

from = Time.now.to_i
to = (Time.now + 60*60).to_i
delegatee_pubkey = "b1d8dfd69fe8795042dbbc4d3f85938a01d4740c54d2daf11088c75c50ff19d9"
conditions = "kind=1&created_at>#{from}&created_at<#{to}"
tag = nostr.get_delegation_tag(delegatee_pubkey, conditions)
nostr.set_delegation(tag)
nostr.build_note_event("I delegate someone to post this!")
#=>
#["EVENT",
# {:pubkey=>"1ed41a3ce33edfc580102abfbdc01d922f8c7697beee3e395aa7dcd7115a3372",
#  :created_at=>1681503318,
#  :kind=>1,
#  :tags=>
#   [["delegation",
#     "1ed41a3ce33edfc580102abfbdc01d922f8c7697beee3e395aa7dcd7115a3372",
#     "kind=1&created_at>1681503305&created_at<1681506905",
#     "dbbdc7074a5c2d2a53ee174c43afb0bb03106ced866e0dfa7996fe2553a54aaa9af6affe915ec2e688e26357681bfcf0445d607ed85eca2217f79fb51094d816"]],
#  :content=>"I delegate someone to post this!",
#  "id"=>"f6fd20535db6748e0529052310c47dc788616b03f8cef20260ca6a2dfb5dedaf",
#  "sig"=>"826d7bd1f369f6ab8330746c236437610f13205809d12bc94af287b7ceec180443a3a750267d5152323329a1b2d02d0702364fa3ee8228bab57016b39975e449"}]

Verify a NIP-26 delegation

delegatee_pubkey = "b1d8dfd69fe8795042dbbc4d3f85938a01d4740c54d2daf11088c75c50ff19d9"
tag = ["delegation", delegator_pubkey, conditions, signature]
Struto::Nostr.verify_delegation_signature(delegatee_pubkey, tag)
#=> true

Reset the NIP-26 delegation

nostr.reset_delegation
#=> nil

Create a calendar event (NIP-52)

• NIP-52

Date based calendar event (kind 31922)

• Kind 31922

nostr.build_date_calendar_event(
  "Explosive shock and awe I only speak American country-fried Applebee's.",
  "Milkshakes patriotic southwest breakfast burrito microwaved Harley Davidson super bowl Hot Pockets second amendment rights. Low taxes 18-wheeler CSI: Miami liberty Home Depot. Checkers exploding stock market Harley Davidson Lynyrd Skynyrd.Hot dogs nuclear-powered aircraft carrier freedom fries Van Halen tomahawk cruise missile better dead than red."
  ,
  dates: {
    start: 1.week.from_now.to_date, # or '2023-12-12'
    end: 2.weeks.from_now.to_date, # or '2023-12-19'
  },
  location: {
    location: '170 Schinner Causeway',
    latitude: 39.9760149034563,
    longitude: -77.0739996811784
  },
  participants: [
    'a3bae54c0141539e0ffb771ee63dcc334f3f4d0eece9a1a900f9045a8af57c1d',
    '7bc9a69675ab8ad508732e953a19c8bd08c34f39c21feff5b3864e46062274d3'
  ],
  hashtags: ['optio', 'ad', 'necessitatibus'],
  references: ['http://borer.us']
)

#=>
#["EVENT",
# {:kind=>31922,
#  :created_at=>1701553659,
#  :tags=>
#   [[:d, "d9a2cd6b-3356-4e91-9b5e-a90c970a7b67"],
#    [:name, "Explosive shock and awe I only speak American country-fried Applebee's."],
#    [:start, '2023-12-12'],
#    [:end, '2023-12-19'],
#    [:location, "170 Schinner Causeway"],
#    [:g, "dqgkjytbzbcs"],
#    [:p, "a3bae54c0141539e0ffb771ee63dcc334f3f4d0eece9a1a900f9045a8af57c1d"],
#    [:p, "7bc9a69675ab8ad508732e953a19c8bd08c34f39c21feff5b3864e46062274d3"],
#    [:t, "optio"],
#    [:t, "ad"],
#    [:t, "necessitatibus"],
#    [:r, "http://borer.us"]],
#  :content=> "Milkshakes patriotic southwest breakfast burrito microwaved Harley Davidson super bowl Hot Pockets second amendment rights. Low taxes 18-wheeler CSI: Miami liberty Home Depot. Checkers exploding stock market Harley Davidson Lynyrd Skynyrd.Hot dogs nuclear-powered aircraft carrier freedom fries Van Halen tomahawk cruise missile better dead than red.",
#  :pubkey=>"8758a9fd232f0fe9a7afc8456a40d57bc46e2a586d37641c2d6c77bcac938f93",
#  :id=>"c057093e3f46bb300db8859daad07d766ce5daeb65835703534959dfb7ba312a",
#  :sig=> "e0a779509ab0308a485c10f9e95927b0b1d983595bed85ae5d84e70ed034823289abfe2539414ab318d9b3505e18d1334c9a2494fa8ce388cda1e77560447405"}]

Time based calendar event (kind 31923)

• Kind 31923

nostr.build_time_calendar_event(
  "Explosive shock and awe I only speak American country-fried Applebee's.",
  "Milkshakes patriotic southwest breakfast burrito microwaved Harley Davidson super bowl Hot Pockets second amendment rights. Low taxes 18-wheeler CSI: Miami liberty Home Depot. Checkers exploding stock market Harley Davidson Lynyrd Skynyrd.Hot dogs nuclear-powered aircraft carrier freedom fries Van Halen tomahawk cruise missile better dead than red."
  ,
  timestamps: {
    start: 1.day.from_now, # or 1701684118
    start_tzid: 'Europe/Belgrade',
    end: 2.days.from_now # or 1701770911
  },
  location: {
    location: '170 Schinner Causeway',
    latitude: 39.9760149034563,
    longitude: -77.0739996811784
  },
  participants: [
    'a3bae54c0141539e0ffb771ee63dcc334f3f4d0eece9a1a900f9045a8af57c1d',
    '7bc9a69675ab8ad508732e953a19c8bd08c34f39c21feff5b3864e46062274d3'
  ],
  hashtags: ['optio', 'ad', 'necessitatibus'],
  references: ['http://borer.us']
)

#=>
#["EVENT",
# {:kind=>31923,
#  :created_at=>1701553659,
#  :tags=>
#   [[:d, "d9a2cd6b-3356-4e91-9b5e-a90c970a7b67"],
#    [:name, "Explosive shock and awe I only speak American country-fried Applebee's."],
#    [:start, 1701684118],
#    [:start_tzid, "Europe/Belgrade"],
#    [:end, 1701770911],
#    [:end_tzid, "Europe/Belgrade"],
#    [:location, "170 Schinner Causeway"],
#    [:g, "dqgkjytbzbcs"],
#    [:p, "a3bae54c0141539e0ffb771ee63dcc334f3f4d0eece9a1a900f9045a8af57c1d"],
#    [:p, "7bc9a69675ab8ad508732e953a19c8bd08c34f39c21feff5b3864e46062274d3"],
#    [:t, "optio"],
#    [:t, "ad"],
#    [:t, "necessitatibus"],
#    [:r, "http://borer.us"]],
#  :content=> "Milkshakes patriotic southwest breakfast burrito microwaved Harley Davidson super bowl Hot Pockets second amendment rights. Low taxes 18-wheeler CSI: Miami liberty Home Depot. Checkers exploding stock market Harley Davidson Lynyrd Skynyrd.Hot dogs nuclear-powered aircraft carrier freedom fries Van Halen tomahawk cruise missile better dead than red.",
#  :pubkey=>"8758a9fd232f0fe9a7afc8456a40d57bc46e2a586d37641c2d6c77bcac938f93",
#  :id=>"c057093e3f46bb300db8859daad07d766ce5daeb65835703534959dfb7ba312a",
#  :sig=> "e0a779509ab0308a485c10f9e95927b0b1d983595bed85ae5d84e70ed034823289abfe2539414ab318d9b3505e18d1334c9a2494fa8ce388cda1e77560447405"}]

Create a Poll event (NIP-69)

• NIP-69 (still opened NIP)

nostr.build_poll_event(
  "What is your favorite color ?",
  [
    "Red",
    "Blue",
    "Green",
    "Yellow",
    "Other"
  ],
  value_minimum: '21', # optional
  value_maximum: '42', # optional
  closed_at: '1703352127' # optional
)
#=>
# ["EVENT",
#  {:pubkey=>"8758a9fd232f0fe9a7afc8456a40d57bc46e2a586d37641c2d6c77bcac938f93",
#   :created_at=>1700760127,
#   :kind=>6969,
#   :tags=>
#    [["p", "8758a9fd232f0fe9a7afc8456a40d57bc46e2a586d37641c2d6c77bcac938f93"],
#     ["poll_option", "0", "Red"],
#     ["poll_option", "1", "Blue"],
#     ["poll_option", "2", "Green"],
#     ["poll_option", "3", "Yellow"],
#     ["poll_option", "4", "Other"],
#     ["value_minimum", "21"],
#     ["value_maximum", "42"],
#     ["closed_at", "1703352127"]],
#   :content=>
#    "What is your favorite color ?",
#   "id"=>"35e67f8259d0004900c88df9ed4d3722bef024514e83412b15e4515612824c5e",
#   "sig"=>
#    "feda520e93bf05a81396ca806253b24567c2f7f7592d0b17389527f20f1fa528695414b1dc12896b4876e0ee50cb0e818a3ee7919e527bd59b5373825897e1bb"}]

Publish to Nostr

Once you have build your event, you can broadcast it to the relay:

nostr.post_event(event, 'wss://relay.damus.com')