Add support for NIP22 - Comment

[reyamir]

Description

Close: #611
Support NIP22: https://github.com/nostr-protocol/nips/blob/master/22.md

Scope:

• Add Kind::Comment
• Support uppercase E in TagStandard::Event
• Support uppercase K in TagStandard::Kind
• Support uppercase I in TagStandard::ExternalIdentity
• Support uppercase A in TagStandard::Coordinate
• Add EventBuilder::comment
• Add client.comment()
• Add example

Checklist

• I followed the contribution guidelines
• I ran just precommit or just check before committing
• I updated the CHANGELOG (if applicable)

[reyamir]

Hi @yukibtc , I wonder is there a way when I set marker: None, it didn't shrink the vector with empty string too?

I reuse TagStandard::Event with added uppercase: bool instead of create a new standard for comment, but in NIP22 marker is unnecessary. But for compality I still keep marker attr. I wonder when marker: None is there a way to remove "" from vector too?

tags.push(Tag::from_standardized_without_cell(TagStandard::Event {
    event_id: root.id,
    relay_url: relay_url.clone(),
    marker: None,
    public_key: Some(root.pubkey),
    uppercase: true,
}));

"tags": [
  [
    "e",
    "b8c6832a2f2ec9172339c194b5e93f54fe7be1df7ec8389996c003302aa13214",
    "",
    "",
    "126103bfddc8df256b6e0abfd7f3797c80dcc4ea88f7c2f87dd4104220b4d65f"
  ],
  [
    "k",
    "1"
  ]
]

[reyamir]

Hi @yukibtc , I wonder is there a way when I set marker: None, it didn't shrink the vector with empty string too?

I reuse TagStandard::Event with added uppercase: bool instead of create a new standard for comment, but in NIP22 marker is unnecessary. But for compality I still keep marker attr. I wonder when marker: None is there a way to remove "" from vector too?

tags.push(Tag::from_standardized_without_cell(TagStandard::Event {
    event_id: root.id,
    relay_url: relay_url.clone(),
    marker: None,
    public_key: Some(root.pubkey),
    uppercase: true,
}));

"tags": [
  [
    "e",
    "b8c6832a2f2ec9172339c194b5e93f54fe7be1df7ec8389996c003302aa13214",
    "",
    "",
    "126103bfddc8df256b6e0abfd7f3797c80dcc4ea88f7c2f87dd4104220b4d65f"
  ],
  [
    "k",
    "1"
  ]
]

I've fixed by using:

if let Some(marker) = marker {
    tag.resize_with(3, String::new);
    tag.push(marker.to_string());

    if let Some(public_key) = public_key {
        tag.resize_with(4, String::new);
        tag.push(public_key.to_string());
    }
} else if let Some(public_key) = public_key {
    tag.resize_with(3, String::new);
    tag.push(public_key.to_string());
}

[reyamir]

My PR is only supporting comment on EventId - e tag, but NIP22 allow comment on Coordinate - a tag and ExternalIdentity - i tag. Do you have any ideas for implement it? create each comment function for each thing is a bit complex. @yukibtc

[yukibtc]

Thanks!

I done some changes/fixes in the master branch. I'll do a rebase and squash the commits during the cherry-picking.

My PR is only supporting comment on EventId - e tag, but NIP22 allow comment on Coordinate - a tag and ExternalIdentity - i tag. Do you have any ideas for implement it? create each comment function for each thing is a bit complex.

I'll add the support to these later, thanks!

[yukibtc]

I'm thinking to remove all these kind of methods from Client to keep the APIs more cleaned. At least, the ones that can be simply constructed directly with the EventBuilder:

let builder = EventBuilder::<name>;
self.send_event_builder(builder).await

The more complex ones (the ones that requre more than 2 steps, are dangerous if used incorrectly or are very frequently used) can be left, like set_metadata, gift_wrap, send_private_msg, etc.

This is still an idea. What do you think?
I started removing these methods in PR #608

[reyamir]

Yes, I prefer using EventBuilder than client's method