nostr_types/versioned/event2.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
use super::{TagV2, ZapDataV1};
use crate::types::{
EventDelegation, EventKind, EventReference, Id, KeySigner, MilliSatoshi, NAddr, NostrBech32,
NostrUrl, PrivateKey, PublicKey, PublicKeyHex, RelayUrl, Signature, Signer, Unixtime,
};
use crate::{Error, IntoVec};
use lightning_invoice::Bolt11Invoice;
#[cfg(feature = "speedy")]
use regex::Regex;
use serde::{Deserialize, Serialize};
#[cfg(feature = "speedy")]
use speedy::{Readable, Writable};
use std::str::FromStr;
/// The main event type
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[cfg_attr(feature = "speedy", derive(Readable, Writable))]
pub struct EventV2 {
/// The Id of the event, generated as a SHA256 of the inner event data
pub id: Id,
/// The public key of the actor who created the event
pub pubkey: PublicKey,
/// The (unverified) time at which the event was created
pub created_at: Unixtime,
/// The kind of event
pub kind: EventKind,
/// The signature of the event, which cryptographically verifies that the holder of
/// the PrivateKey matching the event's PublicKey generated (or authorized) this event.
/// The signature is taken over the id field only, but the id field is taken over
/// the rest of the event data.
pub sig: Signature,
/// The content of the event
pub content: String,
/// A set of tags that apply to the event
pub tags: Vec<TagV2>,
}
macro_rules! serialize_inner_event {
($pubkey:expr, $created_at:expr, $kind:expr, $tags:expr,
$content:expr) => {{
format!(
"[0,{},{},{},{},{}]",
serde_json::to_string($pubkey)?,
serde_json::to_string($created_at)?,
serde_json::to_string($kind)?,
serde_json::to_string($tags)?,
serde_json::to_string($content)?
)
}};
}
/// Data used to construct an event
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[cfg_attr(feature = "speedy", derive(Readable, Writable))]
pub struct PreEventV2 {
/// The public key of the actor who is creating the event
pub pubkey: PublicKey,
/// The time at which the event was created
pub created_at: Unixtime,
/// The kind of event
pub kind: EventKind,
/// A set of tags that apply to the event
pub tags: Vec<TagV2>,
/// The content of the event
pub content: String,
}
impl PreEventV2 {
/// Generate an ID from this PreEvent for use in an Event or a Rumor
pub fn hash(&self) -> Result<Id, Error> {
use secp256k1::hashes::Hash;
let serialized: String = serialize_inner_event!(
&self.pubkey,
&self.created_at,
&self.kind,
&self.tags,
&self.content
);
// Hash
let hash = secp256k1::hashes::sha256::Hash::hash(serialized.as_bytes());
let id: [u8; 32] = hash.to_byte_array();
Ok(Id(id))
}
}
/// A Rumor is an Event without a signature
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[cfg_attr(feature = "speedy", derive(Readable, Writable))]
pub struct RumorV2 {
/// The Id of the event, generated as a SHA256 of the inner event data
pub id: Id,
/// The public key of the actor who created the event
pub pubkey: PublicKey,
/// The (unverified) time at which the event was created
pub created_at: Unixtime,
/// The kind of event
pub kind: EventKind,
/// The content of the event
pub content: String,
/// A set of tags that apply to the event
pub tags: Vec<TagV2>,
}
impl RumorV2 {
/// Create a new rumor
pub fn new(input: PreEventV2) -> Result<RumorV2, Error> {
// Generate Id
let id = input.hash()?;
Ok(RumorV2 {
id,
pubkey: input.pubkey,
created_at: input.created_at,
kind: input.kind,
tags: input.tags,
content: input.content,
})
}
/// Turn into an Event (the signature will be all zeroes)
pub fn into_event_with_bad_signature(self) -> EventV2 {
EventV2 {
id: self.id,
pubkey: self.pubkey,
created_at: self.created_at,
kind: self.kind,
sig: Signature::zeroes(),
content: self.content,
tags: self.tags,
}
}
}
impl EventV2 {
/// Check the validity of an event. This is useful if you deserialize an event
/// from the network. If you create an event using new() it should already be
/// trustworthy.
pub fn verify(&self, maxtime: Option<Unixtime>) -> Result<(), Error> {
use secp256k1::hashes::Hash;
let serialized: String = serialize_inner_event!(
&self.pubkey,
&self.created_at,
&self.kind,
&self.tags,
&self.content
);
// Verify the signature
self.pubkey.verify(serialized.as_bytes(), &self.sig)?;
// Also verify the ID is the SHA256
// (the above verify function also does it internally,
// so there is room for improvement here)
let hash = secp256k1::hashes::sha256::Hash::hash(serialized.as_bytes());
let id: [u8; 32] = hash.to_byte_array();
// Optional verify that the message was in the past
if let Some(mt) = maxtime {
if self.created_at > mt {
return Err(Error::EventInFuture);
}
}
if id != self.id.0 {
Err(Error::HashMismatch)
} else {
Ok(())
}
}
/// Mock data for testing
#[allow(dead_code)]
pub(crate) fn mock() -> EventV2 {
let signer = {
let private_key = PrivateKey::mock();
KeySigner::from_private_key(private_key, "", 1).unwrap()
};
let public_key = signer.public_key();
let pre = PreEventV2 {
pubkey: public_key,
created_at: Unixtime::mock(),
kind: EventKind::mock(),
tags: vec![TagV2::mock(), TagV2::mock()],
content: "This is a test".to_string(),
};
signer.sign_event2(pre).unwrap()
}
/// Get the k-tag kind, if any
pub fn k_tag_kind(&self) -> Option<EventKind> {
for tag in self.tags.iter() {
if let TagV2::Kind { kind, .. } = tag {
return Some(*kind);
}
}
None
}
/// If the event refers to people by tag, get all the PublicKeys it refers to
/// along with recommended relay URL and petname for each
pub fn people(&self) -> Vec<(PublicKeyHex, Option<RelayUrl>, Option<String>)> {
let mut output: Vec<(PublicKeyHex, Option<RelayUrl>, Option<String>)> = Vec::new();
// All 'p' tags
for tag in self.tags.iter() {
if let TagV2::Pubkey {
pubkey,
recommended_relay_url,
petname,
..
} = tag
{
output.push((
pubkey.to_owned(),
recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok()),
petname.to_owned(),
));
}
}
output
}
/// If the pubkey is tagged in the event
pub fn is_tagged(&self, pubkey: &PublicKey) -> bool {
let pkh: PublicKeyHex = pubkey.into();
for tag in self.tags.iter() {
if let TagV2::Pubkey { pubkey, .. } = tag {
if *pubkey == pkh {
return true;
}
}
}
false
}
/// If the event refers to people within the contents, get all the PublicKeys it refers
/// to within the contents.
pub fn people_referenced_in_content(&self) -> Vec<PublicKey> {
let mut output = Vec::new();
for nurl in NostrUrl::find_all_in_string(&self.content).drain(..) {
if let NostrBech32::Pubkey(pk) = nurl.0 {
output.push(pk);
}
if let NostrBech32::Profile(prof) = nurl.0 {
output.push(prof.pubkey);
}
}
output
}
/// All events IDs that this event refers to, whether root, reply, mention, or otherwise
/// along with optional recommended relay URLs
pub fn referred_events(&self) -> Vec<EventReference> {
let mut output: Vec<EventReference> = Vec::new();
// Collect every 'e' tag and 'a' tag
for tag in self.tags.iter() {
if let TagV2::Event {
id,
recommended_relay_url,
marker,
..
} = tag
{
output.push(EventReference::Id {
id: *id,
author: None,
relays: recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok())
.into_vec(),
marker: marker.clone(),
});
} else if let TagV2::Address {
kind,
pubkey,
d,
relay_url: Some(rurl),
..
} = tag
{
if let Ok(pk) = PublicKey::try_from_hex_string(pubkey.as_str(), true) {
output.push(EventReference::Addr(NAddr {
d: d.to_string(),
relays: vec![rurl.clone()],
kind: *kind,
author: pk,
}));
}
}
}
output
}
/// Get a reference to another event that this event replies to.
/// An event can only reply to one other event via 'e' or 'a' tag from a feed-displayable
/// event that is not a Repost.
pub fn replies_to(&self) -> Option<EventReference> {
if !self.kind.is_feed_displayable() {
return None;
}
// Repost 'e' and 'a' tags are always considered mentions, not replies.
if self.kind == EventKind::Repost || self.kind == EventKind::GenericRepost {
return None;
}
// If there are no 'e' tags nor 'a' tags, then none
let num_event_ref_tags = self
.tags
.iter()
.filter(|e| matches!(e, TagV2::Event { .. }) || matches!(e, TagV2::Address { .. }))
.count();
if num_event_ref_tags == 0 {
return None;
}
// look for an 'e' tag with marker 'reply'
for tag in self.tags.iter() {
if let TagV2::Event {
id,
recommended_relay_url,
marker,
..
} = tag
{
if marker.is_some() && marker.as_deref().unwrap() == "reply" {
return Some(EventReference::Id {
id: *id,
author: None,
relays: recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok())
.into_vec(),
marker: marker.clone(),
});
}
}
}
// look for an 'e' tag with marker 'root'
for tag in self.tags.iter() {
if let TagV2::Event {
id,
recommended_relay_url,
marker,
..
} = tag
{
if marker.is_some() && marker.as_deref().unwrap() == "root" {
return Some(EventReference::Id {
id: *id,
author: None,
relays: recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok())
.into_vec(),
marker: marker.to_owned(),
});
}
}
}
// Use the last unmarked 'e' tag or any 'a' tag
if let Some(tag) = self.tags.iter().rev().find(|t| {
matches!(t, TagV2::Event { marker: None, .. })
|| matches!(t, TagV2::Address { marker: None, .. })
}) {
if let TagV2::Event {
id,
recommended_relay_url,
marker,
..
} = tag
{
return Some(EventReference::Id {
id: *id,
author: None,
relays: recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok())
.into_vec(),
marker: marker.clone(),
});
} else if let TagV2::Address {
kind,
pubkey,
d,
relay_url: Some(rurl),
..
} = tag
{
if let Ok(pk) = PublicKey::try_from_hex_string(pubkey.as_str(), true) {
return Some(EventReference::Addr(NAddr {
d: d.to_string(),
relays: vec![rurl.clone()],
kind: *kind,
author: pk,
}));
}
}
}
None
}
/// If this event replies to a thread, get that threads root event Id if
/// available, along with an optional recommended_relay_url
pub fn replies_to_root(&self) -> Option<EventReference> {
if !self.kind.is_feed_displayable() {
return None;
}
// look for an 'e' tag with marker 'root'
for tag in self.tags.iter() {
if let TagV2::Event {
id,
recommended_relay_url,
marker,
..
} = tag
{
if marker.is_some() && marker.as_deref().unwrap() == "root" {
return Some(EventReference::Id {
id: *id,
author: None,
relays: recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok())
.into_vec(),
marker: marker.to_owned(),
});
}
}
}
// otherwise use the first unmarked 'e' tag or first 'a' tag
// (even if there is only 1 'e' or 'a' tag which means it is both root and reply)
if let Some(tag) = self.tags.iter().find(|t| {
matches!(t, TagV2::Event { marker: None, .. })
|| matches!(t, TagV2::Address { marker: None, .. })
}) {
if let TagV2::Event {
id,
recommended_relay_url,
marker,
..
} = tag
{
return Some(EventReference::Id {
id: *id,
author: None,
relays: recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok())
.into_vec(),
marker: marker.to_owned(),
});
} else if let TagV2::Address {
kind,
pubkey,
d,
relay_url: Some(rurl),
..
} = tag
{
if let Ok(pk) = PublicKey::try_from_hex_string(pubkey.as_str(), true) {
return Some(EventReference::Addr(NAddr {
d: d.to_string(),
relays: vec![rurl.clone()],
kind: *kind,
author: pk,
}));
}
}
}
None
}
/// If this event mentions others, get those other event Ids
/// and optional recommended relay Urls
pub fn mentions(&self) -> Vec<EventReference> {
if !self.kind.is_feed_displayable() {
return vec![];
}
let mut output: Vec<EventReference> = Vec::new();
// For kind=6 and kind=16, all 'e' and 'a' tags are mentions
if self.kind == EventKind::Repost || self.kind == EventKind::GenericRepost {
for tag in self.tags.iter() {
if let TagV2::Event {
id,
recommended_relay_url,
marker,
..
} = tag
{
output.push(EventReference::Id {
id: *id,
author: None,
relays: recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok())
.into_vec(),
marker: marker.clone(),
});
} else if let TagV2::Address {
kind,
pubkey,
d,
relay_url: Some(rurl),
marker: _,
trailing: _,
} = tag
{
if let Ok(pk) = PublicKey::try_from_hex_string(pubkey.as_str(), true) {
output.push(EventReference::Addr(NAddr {
d: d.to_string(),
relays: vec![rurl.clone()],
kind: *kind,
author: pk,
}));
}
}
}
return output;
}
// Look for nostr links within the content
// Collect every 'e' tag marked as 'mention'
for tag in self.tags.iter() {
if let TagV2::Event {
id,
recommended_relay_url,
marker,
..
} = tag
{
if marker.is_some() && marker.as_deref().unwrap() == "mention" {
output.push(EventReference::Id {
id: *id,
author: None,
relays: recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok())
.into_vec(),
marker: marker.clone(),
});
}
}
}
// Collect every unmarked 'e' or 'a' tag that is not the first (root) or the last (reply)
let e_tags: Vec<&TagV2> = self
.tags
.iter()
.filter(|e| {
matches!(e, TagV2::Event { marker: None, .. })
|| matches!(e, TagV2::Address { marker: None, .. })
})
.collect();
if e_tags.len() > 2 {
// mentions are everything other than first and last
for tag in &e_tags[1..e_tags.len() - 1] {
if let TagV2::Event {
id,
recommended_relay_url,
marker,
..
} = tag
{
output.push(EventReference::Id {
id: *id,
author: None,
relays: recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok())
.into_vec(),
marker: marker.to_owned(),
});
} else if let TagV2::Address {
kind,
pubkey,
d,
relay_url: Some(rurl),
..
} = tag
{
if let Ok(pk) = PublicKey::try_from_hex_string(pubkey.as_str(), true) {
output.push(EventReference::Addr(NAddr {
d: d.to_string(),
relays: vec![rurl.clone()],
kind: *kind,
author: pk,
}));
}
}
}
}
output
}
/// If this event reacts to another, get that other event's Id,
/// the reaction content, and an optional Recommended relay Url
pub fn reacts_to(&self) -> Option<(Id, String, Option<RelayUrl>)> {
if self.kind != EventKind::Reaction {
return None;
}
// The last 'e' tag is it
if let Some(TagV2::Event {
id,
recommended_relay_url,
..
}) = self
.tags
.iter()
.rev()
.find(|t| matches!(t, TagV2::Event { .. }))
{
return Some((
*id,
self.content.clone(),
recommended_relay_url
.as_ref()
.and_then(|rru| RelayUrl::try_from_unchecked_url(rru).ok()),
));
}
None
}
/// If this event deletes others, get all the EventReferences of the events that it
/// deletes along with the reason for the deletion
pub fn deletes(&self) -> Option<(Vec<EventReference>, String)> {
if self.kind != EventKind::EventDeletion {
return None;
}
let mut erefs: Vec<EventReference> = Vec::new();
for tag in self.tags.iter() {
// All 'e' tags are deleted
if let TagV2::Event { id, .. } = tag {
erefs.push(EventReference::Id {
id: *id,
author: None,
relays: vec![],
marker: None,
});
}
// All 'a' tag groups are deleted
else if let TagV2::Address {
kind,
pubkey,
d,
relay_url,
..
} = tag
{
if let Ok(pk) = PublicKey::try_from_hex_string(pubkey, false) {
let ea = NAddr {
d: d.clone(),
relays: match relay_url {
Some(url) => vec![url.clone()],
None => vec![],
},
kind: *kind,
author: pk,
};
erefs.push(EventReference::Addr(ea));
}
}
}
if erefs.is_empty() {
None
} else {
Some((erefs, self.content.clone()))
}
}
/// Can this event be deleted by the given public key?
pub fn delete_author_allowed(&self, by: PublicKey) -> bool {
// Author can always delete
if self.pubkey == by {
return true;
}
if self.kind == EventKind::GiftWrap {
for tag in self.tags.iter() {
if let TagV2::Pubkey { pubkey, .. } = tag {
let pkh: PublicKeyHex = by.into();
return pkh == *pubkey;
}
}
}
false
}
/// If this event zaps another event, get data about that.
///
/// That includes the Id, the amount, and the public key of the provider,
/// all of which should be verified by the caller.
///
/// Errors returned from this are not fatal, but may be useful for
/// explaining to a user why a zap receipt is invalid.
pub fn zaps(&self) -> Result<Option<ZapDataV1>, Error> {
if self.kind != EventKind::Zap {
return Ok(None);
}
let mut zapped_id: Option<Id> = None;
let mut zapped_amount: Option<MilliSatoshi> = None;
let mut zapped_pubkey: Option<PublicKey> = None;
for tag in self.tags.iter() {
if let TagV2::Other { tag, data } = tag {
// Find the bolt11 tag
if tag != "bolt11" {
continue;
}
if data.is_empty() {
return Err(Error::ZapReceipt("missing bolt11 tag value".to_string()));
}
// Extract as an Invoice
let result = Bolt11Invoice::from_str(&data[0]);
if let Err(e) = result {
return Err(Error::ZapReceipt(format!("bolt11 failed to parse: {}", e)));
}
let invoice = result.unwrap();
// Verify the signature
if let Err(e) = invoice.check_signature() {
return Err(Error::ZapReceipt(format!(
"bolt11 signature check failed: {}",
e
)));
}
// Get the public key
let secpk = match invoice.payee_pub_key() {
Some(pubkey) => pubkey.to_owned(),
None => invoice.recover_payee_pub_key(),
};
let (xonlypk, _) = secpk.x_only_public_key();
let pubkeybytes = xonlypk.serialize();
let pubkey = match PublicKey::from_bytes(&pubkeybytes, false) {
Ok(pubkey) => pubkey,
Err(e) => {
return Err(Error::ZapReceipt(format!("payee public key error: {}", e)))
}
};
zapped_pubkey = Some(pubkey);
if let Some(u) = invoice.amount_milli_satoshis() {
zapped_amount = Some(MilliSatoshi(u));
} else {
return Err(Error::ZapReceipt(
"Amount missing from zap receipt".to_string(),
));
}
}
if let TagV2::Event { id, .. } = tag {
zapped_id = Some(*id);
}
}
if zapped_id.is_none() {
// This probably means a person was zapped, not a note. So not an error.
return Ok(None);
}
if zapped_amount.is_none() {
return Err(Error::ZapReceipt("Missing amount".to_string()));
}
if zapped_pubkey.is_none() {
return Err(Error::ZapReceipt("Missing payee public key".to_string()));
}
Ok(Some(ZapDataV1 {
id: zapped_id.unwrap(),
amount: zapped_amount.unwrap(),
pubkey: zapped_pubkey.unwrap(),
provider_pubkey: self.pubkey,
}))
}
/// If this event specifies the client that created it, return that client string
pub fn client(&self) -> Option<String> {
for tag in self.tags.iter() {
if let TagV2::Other { tag, data } = tag {
if tag == "client" && !data.is_empty() {
return Some(data[0].clone());
}
}
}
None
}
/// If this event specifies a subject, return that subject string
pub fn subject(&self) -> Option<String> {
for tag in self.tags.iter() {
if let TagV2::Subject { subject, .. } = tag {
return Some(subject.clone());
}
}
None
}
/// If this event specifies a title, return that title string
pub fn title(&self) -> Option<String> {
for tag in self.tags.iter() {
if let TagV2::Title { title, .. } = tag {
return Some(title.clone());
}
}
None
}
/// If this event specifies a summary, return that summary string
pub fn summary(&self) -> Option<String> {
for tag in self.tags.iter() {
if let TagV2::Other { tag, data } = tag {
if tag == "summary" && !data.is_empty() {
return Some(data[0].clone());
}
}
}
None
}
/// If this event specifies a content warning, return that subject string
pub fn content_warning(&self) -> Option<String> {
for tag in self.tags.iter() {
if let TagV2::ContentWarning { warning, .. } = tag {
return Some(warning.clone());
}
}
None
}
/// If this is a parameterized event, get the parameter
pub fn parameter(&self) -> Option<String> {
if self.kind.is_parameterized_replaceable() {
for tag in self.tags.iter() {
if let TagV2::Identifier { d, .. } = tag {
return Some(d.to_owned());
}
}
Some("".to_owned()) // implicit
} else {
None
}
}
/// Return all the hashtags this event refers to
pub fn hashtags(&self) -> Vec<String> {
if !self.kind.is_feed_displayable() {
return vec![];
}
let mut output: Vec<String> = Vec::new();
for tag in self.tags.iter() {
if let TagV2::Hashtag { hashtag, .. } = tag {
output.push(hashtag.clone());
}
}
output
}
/// Return all the URLs this event refers to
pub fn urls(&self) -> Vec<RelayUrl> {
if !self.kind.is_feed_displayable() {
return vec![];
}
let mut output: Vec<RelayUrl> = Vec::new();
for tag in self.tags.iter() {
if let TagV2::Reference { url, .. } = tag {
if let Ok(relay_url) = RelayUrl::try_from_unchecked_url(url) {
output.push(relay_url);
}
}
}
output
}
/// Get the proof-of-work count of leading bits
pub fn pow(&self) -> u8 {
// Count leading bits in the Id field
let zeroes: u8 = crate::get_leading_zero_bits(&self.id.0);
// Check that they meant it
let mut target_zeroes: u8 = 0;
for tag in self.tags.iter() {
if let TagV2::Nonce { target, .. } = tag {
if let Some(t) = target {
target_zeroes = t.parse::<u8>().unwrap_or(0);
}
break;
}
}
zeroes.min(target_zeroes)
}
/// Was this event delegated, was that valid, and if so what is the pubkey of
/// the delegator?
pub fn delegation(&self) -> EventDelegation {
for tag in self.tags.iter() {
if let TagV2::Delegation {
pubkey,
conditions,
sig,
..
} = tag
{
// Convert hex strings into functional types
let signature = match Signature::try_from_hex_string(sig) {
Ok(sig) => sig,
Err(e) => return EventDelegation::InvalidDelegation(format!("{e}")),
};
let delegator_pubkey = match PublicKey::try_from_hex_string(pubkey, true) {
Ok(pk) => pk,
Err(e) => return EventDelegation::InvalidDelegation(format!("{e}")),
};
// Verify the delegation tag
match conditions.verify_signature(&delegator_pubkey, &self.pubkey, &signature) {
Ok(_) => {
// Check conditions
if let Some(kind) = conditions.kind {
if self.kind != kind {
return EventDelegation::InvalidDelegation(
"Event Kind not delegated".to_owned(),
);
}
}
if let Some(created_after) = conditions.created_after {
if self.created_at < created_after {
return EventDelegation::InvalidDelegation(
"Event created before delegation started".to_owned(),
);
}
}
if let Some(created_before) = conditions.created_before {
if self.created_at > created_before {
return EventDelegation::InvalidDelegation(
"Event created after delegation ended".to_owned(),
);
}
}
return EventDelegation::DelegatedBy(delegator_pubkey);
}
Err(e) => {
return EventDelegation::InvalidDelegation(format!("{e}"));
}
}
}
}
EventDelegation::NotDelegated
}
/// If the event came through a proxy, get the (Protocol, Id)
pub fn proxy(&self) -> Option<(&str, &str)> {
for t in self.tags.iter() {
if let TagV2::Other { tag, data } = t {
if tag == "proxy" && data.len() >= 2 {
return Some((&data[1], &data[0]));
}
}
}
None
}
}
// Direct access into speedy-serialized bytes, to avoid alloc-deserialize just to peek
// at one of these fields
#[cfg(feature = "speedy")]
impl EventV2 {
/// Read the ID of the event from a speedy encoding without decoding
/// (zero allocation)
///
/// Note this function is fragile, if the Event structure is reordered,
/// or if speedy code changes, this will break. Neither should happen.
pub fn get_id_from_speedy_bytes(bytes: &[u8]) -> Option<Id> {
if bytes.len() < 32 {
None
} else if let Ok(arr) = <[u8; 32]>::try_from(&bytes[0..32]) {
Some(unsafe { std::mem::transmute(arr) })
} else {
None
}
}
/// Read the pubkey of the event from a speedy encoding without decoding
/// (close to zero allocation, VerifyingKey does stuff I didn't check)
///
/// Note this function is fragile, if the Event structure is reordered,
/// or if speedy code changes, this will break. Neither should happen.
pub fn get_pubkey_from_speedy_bytes(bytes: &[u8]) -> Option<PublicKey> {
if bytes.len() < 64 {
None
} else {
PublicKey::from_bytes(&bytes[32..64], false).ok()
}
}
/// Read the created_at of the event from a speedy encoding without decoding
/// (zero allocation)
///
/// Note this function is fragile, if the Event structure is reordered,
/// or if speedy code changes, this will break. Neither should happen.
pub fn get_created_at_from_speedy_bytes(bytes: &[u8]) -> Option<Unixtime> {
if bytes.len() < 72 {
None
} else if let Ok(i) = i64::read_from_buffer(&bytes[64..72]) {
Some(Unixtime(i))
} else {
None
}
}
/// Read the kind of the event from a speedy encoding without decoding
/// (zero allocation)
///
/// Note this function is fragile, if the Event structure is reordered,
/// or if speedy code changes, this will break. Neither should happen.
pub fn get_kind_from_speedy_bytes(bytes: &[u8]) -> Option<EventKind> {
if bytes.len() < 76 {
None
} else if let Ok(u) = u32::read_from_buffer(&bytes[72..76]) {
Some(u.into())
} else {
None
}
}
// Read the sig of the event from a speedy encoding without decoding
// (offset would be 76..140
/// Read the content of the event from a speedy encoding without decoding
/// (zero allocation)
///
/// Note this function is fragile, if the Event structure is reordered,
/// or if speedy code changes, this will break. Neither should happen.
pub fn get_content_from_speedy_bytes(bytes: &[u8]) -> Option<&str> {
let len = u32::from_ne_bytes(bytes[140..140 + 4].try_into().unwrap());
unsafe {
Some(std::str::from_utf8_unchecked(
&bytes[140 + 4..140 + 4 + len as usize],
))
}
}
/// Check if any human-readable tag matches the Regex in the speedy encoding
/// without decoding the whole thing (because our TagV2 representation is so complicated,
/// we do deserialize the tags for now)
///
/// Note this function is fragile, if the Event structure is reordered,
/// or if speedy code changes, this will break. Neither should happen.
pub fn tag_search_in_speedy_bytes(bytes: &[u8], re: &Regex) -> Result<bool, Error> {
if bytes.len() < 140 {
return Ok(false);
}
// skip content
let len = u32::from_ne_bytes(bytes[140..140 + 4].try_into().unwrap());
let offset = 140 + 4 + len as usize;
// Deserialize the tags
let tags: Vec<TagV2> = Vec::<TagV2>::read_from_buffer(&bytes[offset..])?;
// Search through them
for tag in &tags {
match tag {
TagV2::ContentWarning { warning, .. } => {
if re.is_match(warning.as_ref()) {
return Ok(true);
}
}
TagV2::Hashtag { hashtag, .. } => {
if re.is_match(hashtag.as_ref()) {
return Ok(true);
}
}
TagV2::Subject { subject, .. } => {
if re.is_match(subject.as_ref()) {
return Ok(true);
}
}
TagV2::Title { title, .. } => {
if re.is_match(title.as_ref()) {
return Ok(true);
}
}
TagV2::Other { tag, data } => {
if tag == "summary" && !data.is_empty() && re.is_match(data[0].as_ref()) {
return Ok(true);
}
}
_ => {}
}
}
Ok(false)
}
}
impl From<EventV2> for RumorV2 {
fn from(e: EventV2) -> RumorV2 {
RumorV2 {
id: e.id,
pubkey: e.pubkey,
created_at: e.created_at,
kind: e.kind,
content: e.content,
tags: e.tags,
}
}
}
impl From<RumorV2> for PreEventV2 {
fn from(r: RumorV2) -> PreEventV2 {
PreEventV2 {
pubkey: r.pubkey,
created_at: r.created_at,
kind: r.kind,
content: r.content,
tags: r.tags,
}
}
}
impl TryFrom<PreEventV2> for RumorV2 {
type Error = Error;
fn try_from(e: PreEventV2) -> Result<RumorV2, Error> {
RumorV2::new(e)
}
}
#[cfg(test)]
mod test {
use super::*;
use crate::types::{DelegationConditions, Signer, UncheckedUrl};
test_serde! {EventV2, test_event_serde}
#[test]
fn test_event_new_and_verify() {
let signer = {
let privkey = PrivateKey::mock();
KeySigner::from_private_key(privkey, "", 1).unwrap()
};
let pubkey = signer.public_key();
let preevent = PreEventV2 {
pubkey,
created_at: Unixtime::mock(),
kind: EventKind::TextNote,
tags: vec![TagV2::Event {
id: Id::mock(),
recommended_relay_url: Some(UncheckedUrl::mock()),
marker: None,
trailing: Vec::new(),
}],
content: "Hello World!".to_string(),
};
let mut event = signer.sign_event2(preevent).unwrap();
assert!(event.verify(None).is_ok());
// Now make sure it fails when the message has been modified
event.content = "I'm changing this message".to_string();
let result = event.verify(None);
assert!(result.is_err());
// Change it back
event.content = "Hello World!".to_string();
let result = event.verify(None);
assert!(result.is_ok());
// Tweak the id only
event.id = Id([
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23,
24, 25, 26, 27, 28, 29, 30, 31,
]);
let result = event.verify(None);
assert!(result.is_err());
}
// helper
fn create_event_with_delegation<S>(created_at: Unixtime, real_signer: &S) -> EventV2
where
S: Signer,
{
let delegated_signer = {
let privkey = PrivateKey::mock();
KeySigner::from_private_key(privkey, "", 1).unwrap()
};
let conditions = DelegationConditions::try_from_str(
"kind=1&created_at>1680000000&created_at<1680050000",
)
.unwrap();
let sig = real_signer
.generate_delegation_signature(delegated_signer.public_key(), &conditions)
.unwrap();
let preevent = PreEventV2 {
pubkey: delegated_signer.public_key(),
created_at,
kind: EventKind::TextNote,
tags: vec![
TagV2::Event {
id: Id::mock(),
recommended_relay_url: Some(UncheckedUrl::mock()),
marker: None,
trailing: Vec::new(),
},
TagV2::Delegation {
pubkey: PublicKeyHex::try_from_string(real_signer.public_key().as_hex_string())
.unwrap(),
conditions,
sig: sig.into(),
trailing: Vec::new(),
},
],
content: "Hello World!".to_string(),
};
delegated_signer.sign_event2(preevent).unwrap()
}
#[test]
fn test_event_with_delegation_ok() {
let delegator_signer = {
let delegator_privkey = PrivateKey::mock();
KeySigner::from_private_key(delegator_privkey, "", 1).unwrap()
};
let delegator_pubkey = delegator_signer.public_key();
let event = create_event_with_delegation(Unixtime(1680000012), &delegator_signer);
assert!(event.verify(None).is_ok());
// check delegation
if let EventDelegation::DelegatedBy(pk) = event.delegation() {
// expected type, check returned delegator key
assert_eq!(pk, delegator_pubkey);
} else {
panic!("Expected DelegatedBy result, got {:?}", event.delegation());
}
}
#[test]
fn test_event_with_delegation_invalid_created_after() {
let delegator_privkey = PrivateKey::mock();
let signer = KeySigner::from_private_key(delegator_privkey, "", 1).unwrap();
let event = create_event_with_delegation(Unixtime(1690000000), &signer);
assert!(event.verify(None).is_ok());
// check delegation
if let EventDelegation::InvalidDelegation(reason) = event.delegation() {
// expected type, check returned delegator key
assert_eq!(reason, "Event created after delegation ended");
} else {
panic!(
"Expected InvalidDelegation result, got {:?}",
event.delegation()
);
}
}
#[test]
fn test_event_with_delegation_invalid_created_before() {
let signer = {
let delegator_privkey = PrivateKey::mock();
KeySigner::from_private_key(delegator_privkey, "", 1).unwrap()
};
let event = create_event_with_delegation(Unixtime(1610000000), &signer);
assert!(event.verify(None).is_ok());
// check delegation
if let EventDelegation::InvalidDelegation(reason) = event.delegation() {
// expected type, check returned delegator key
assert_eq!(reason, "Event created before delegation started");
} else {
panic!(
"Expected InvalidDelegation result, got {:?}",
event.delegation()
);
}
}
#[test]
fn test_realworld_event_with_naddr_tag() {
let raw = r##"{"id":"7760408f6459b9546c3a4e70e3e56756421fba34526b7d460db3fcfd2f8817db","pubkey":"460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c","created_at":1687616920,"kind":1,"tags":[["p","1bc70a0148b3f316da33fe3c89f23e3e71ac4ff998027ec712b905cd24f6a411","","mention"],["a","30311:1bc70a0148b3f316da33fe3c89f23e3e71ac4ff998027ec712b905cd24f6a411:1687612774","","mention"]],"content":"Watching Karnage's stream to see if I learn something about design. \n\nnostr:naddr1qq9rzd3cxumrzv3hxu6qygqmcu9qzj9n7vtd5vl78jyly037wxkyl7vcqflvwy4eqhxjfa4yzypsgqqqwens0qfplk","sig":"dbc5d05a24bfe990a1faaedfcb81a98940d86a105711dbdad9145d05b0ad0f46e3e24eaa3fc283818f27e057fe836a029fd9a68e7f1de06ff477493199d64064"}"##;
let _: EventV2 = serde_json::from_str(&raw).unwrap();
}
#[cfg(feature = "speedy")]
#[test]
fn test_speedy_encoded_direct_field_access() {
use speedy::Writable;
let signer = {
let privkey = PrivateKey::mock();
KeySigner::from_private_key(privkey, "", 1).unwrap()
};
let preevent = PreEventV2 {
pubkey: signer.public_key(),
created_at: Unixtime(1680000012),
kind: EventKind::TextNote,
tags: vec![
TagV2::Event {
id: Id::mock(),
recommended_relay_url: Some(UncheckedUrl::mock()),
marker: None,
trailing: Vec::new(),
},
TagV2::Hashtag {
hashtag: "foodstr".to_string(),
trailing: Vec::new(),
},
],
content: "Hello World!".to_string(),
};
let event = signer.sign_event2(preevent).unwrap();
let bytes = event.write_to_vec().unwrap();
let id = EventV2::get_id_from_speedy_bytes(&bytes).unwrap();
assert_eq!(id, event.id);
let pubkey = EventV2::get_pubkey_from_speedy_bytes(&bytes).unwrap();
assert_eq!(pubkey, event.pubkey);
let created_at = EventV2::get_created_at_from_speedy_bytes(&bytes).unwrap();
assert_eq!(created_at, Unixtime(1680000012));
let kind = EventV2::get_kind_from_speedy_bytes(&bytes).unwrap();
assert_eq!(kind, event.kind);
let content = EventV2::get_content_from_speedy_bytes(&bytes);
assert_eq!(content, Some(&*event.content));
let re = regex::Regex::new("foodstr").unwrap();
let found_foodstr = EventV2::tag_search_in_speedy_bytes(&bytes, &re).unwrap();
assert!(found_foodstr);
// Print to work out encoding
// test like this to see printed data:
// cargo test --features=speedy test_speedy_encoded_direct_field_access -- --nocapture
println!("EVENT BYTES: {:?}", bytes);
println!("ID: {:?}", event.id.0);
println!("PUBKEY: {:?}", event.pubkey.as_slice());
println!("CREATED AT: {:?}", event.created_at.0.to_ne_bytes());
let kind32: u32 = event.kind.into();
println!("KIND: {:?}", kind32.to_ne_bytes());
println!("SIG: {:?}", event.sig.0.as_ref());
println!(
"CONTENT: [len={:?}] {:?}",
(event.content.as_bytes().len() as u32).to_ne_bytes(),
event.content.as_bytes()
);
println!("TAGS: [len={:?}]", (event.tags.len() as u32).to_ne_bytes());
}
#[test]
fn test_event_gift_wrap() {
let signer1 = {
let sec1 = PrivateKey::try_from_hex_string(
"0000000000000000000000000000000000000000000000000000000000000001",
)
.unwrap();
KeySigner::from_private_key(sec1, "", 1).unwrap()
};
let signer2 = {
let sec2 = PrivateKey::try_from_hex_string(
"0000000000000000000000000000000000000000000000000000000000000002",
)
.unwrap();
KeySigner::from_private_key(sec2, "", 1).unwrap()
};
let pre = PreEventV2 {
pubkey: signer1.public_key(),
created_at: Unixtime(1692_000_000),
kind: EventKind::TextNote,
content: "Hey man, this rocks! Please reply for a test.".to_string(),
tags: vec![],
};
let gift_wrap = signer1
.giftwrap2(pre.clone(), signer2.public_key())
.unwrap();
let rumor = signer2.unwrap_giftwrap2(&gift_wrap).unwrap();
let output_pre: PreEventV2 = rumor.into();
assert_eq!(pre, output_pre);
}
}