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
//! # Dht Operations
use crate::{
Action, ActionRef, ActionType, AppEntryDef, Create, CreateLink, Delete, DeleteLink, Entry,
EntryType, LinkTag, MembraneProof, Record, SignedActionHashed, SignedHashed, UnitEnum, Update,
};
use holo_hash::{ActionHash, AgentPubKey, AnyLinkableHash, DnaHash, EntryHash, HashableContent};
use holochain_serialized_bytes::prelude::*;
use kitsune_p2p_timestamp::Timestamp;
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, SerializedBytes)]
#[cfg_attr(feature = "test_utils", derive(arbitrary::Arbitrary))]
/// These are the operations that can be applied to Holochain data.
/// Every [`Action`] produces a set of operations.
/// These operations are each sent to an authority for validation.
///
/// ## Producing Operations
/// The following is a list of the operations that can be produced by each [`Action`]:
/// - Every [`Action`] produces a [`Op::RegisterAgentActivity`] and a [`Op::StoreRecord`].
/// - [`Action::Create`] also produces a [`Op::StoreEntry`].
/// - [`Action::Update`] also produces a [`Op::StoreEntry`] and a [`Op::RegisterUpdate`].
/// - [`Action::Delete`] also produces a [`Op::RegisterDelete`].
/// - [`Action::CreateLink`] also produces a [`Op::RegisterCreateLink`].
/// - [`Action::DeleteLink`] also produces a [`Op::RegisterDeleteLink`].
///
/// ## Authorities
/// There are three types of authorities in Holochain:
///
/// #### The Action Authority
/// This set of authorities receives the [`Op::StoreRecord`].
/// This is where you can implement your own logic for checking
/// that it is valid to store any of the [`Action`] variants
/// according to your own applications rules.
///
/// #### The Entry Authority
/// This set of authorities receives the [`Op::StoreEntry`].
/// This is where you can implement your own logic for checking
/// that it is valid to store an [`Entry`].
/// You can think of this as the "Create" from the CRUD acronym.
///
/// ##### Metadata
/// The entry authority is also responsible for storing the metadata for each entry.
/// They receive the [`Op::RegisterUpdate`] and [`Op::RegisterDelete`].
/// This is where you can implement your own logic for checking that it is valid to
/// update or delete any of the [`Entry`] types defined in your application.
/// You can think of this as the "Update" and "Delete" from the CRUD acronym.
///
/// They receive the [`Op::RegisterCreateLink`] and [`Op::RegisterDeleteLink`].
/// This is where you can implement your own logic for checking that it is valid to
/// place a link on a base [`Entry`].
///
/// #### The Chain Authority
/// This set of authorities receives the [`Op::RegisterAgentActivity`].
/// This is where you can implement your own logic for checking that it is valid to
/// add a new [`Action`] to an agent source chain.
/// You are not validating the individual record but the entire agents source chain.
///
/// ##### Author
/// When authoring a new [`Action`] to your source chain, the
/// validation will be run from the perspective of every authority.
///
/// ##### A note on metadata for the Action authority.
/// Technically speaking the Action authority also receives and validates the
/// [`Op::RegisterUpdate`] and [`Op::RegisterDelete`] but they run the same callback
/// as the Entry authority because it would be inconsistent to have two separate
/// validation outcomes for these ops.
///
/// ## Running Validation
/// When the `fn validate(op: Op) -> ExternResult<ValidateCallbackResult>` is called
/// it will be passed the operation variant for the authority that is
/// actually running the validation.
///
/// For example the entry authority will be passed the [`Op::StoreEntry`] operation.
/// The operations that can be applied to Holochain data.
/// Operations beginning with `Store` are concerned with creating and
/// storing data.
/// Operations beginning with `Register` are concerned with registering
/// metadata about the data.
pub enum Op {
/// Stores a new [`Record`] in the DHT.
/// This is the act of creating a new [`Action`]
/// and publishing it to the DHT.
/// Note that not all [`Action`]s contain an [`Entry`].
StoreRecord(StoreRecord),
/// Stores a new [`Entry`] in the DHT.
/// This is the act of creating a either a [`Action::Create`] or
/// a [`Action::Update`] and publishing it to the DHT.
/// These actions create a new instance of an [`Entry`].
StoreEntry(StoreEntry),
/// Registers an update from an instance of an [`Entry`] in the DHT.
/// This is the act of creating a [`Action::Update`] and
/// publishing it to the DHT.
/// Note that the [`Action::Update`] stores an new instance
/// of an [`Entry`] and registers it as an update to the original [`Entry`].
/// This operation is only concerned with registering the update.
RegisterUpdate(RegisterUpdate),
/// Registers a deletion of an instance of an [`Entry`] in the DHT.
/// This is the act of creating a [`Action::Delete`] and
/// publishing it to the DHT.
RegisterDelete(RegisterDelete),
/// Registers a new [`Action`] on an agent source chain.
/// This is the act of creating any [`Action`] and
/// publishing it to the DHT.
RegisterAgentActivity(RegisterAgentActivity),
/// Registers a link between two [`Entry`]s.
/// This is the act of creating a [`Action::CreateLink`] and
/// publishing it to the DHT.
/// The authority is the entry authority for the base [`Entry`].
RegisterCreateLink(RegisterCreateLink),
/// Deletes a link between two [`Entry`]s.
/// This is the act of creating a [`Action::DeleteLink`] and
/// publishing it to the DHT.
/// The delete always references a specific [`Action::CreateLink`].
RegisterDeleteLink(RegisterDeleteLink),
}
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, SerializedBytes)]
#[cfg_attr(feature = "test_utils", derive(arbitrary::Arbitrary))]
/// Stores a new [`Record`] in the DHT.
/// This is the act of creating a new [`Action`]
/// and publishing it to the DHT.
/// Note that not all [`Action`]s contain an [`Entry`].
pub struct StoreRecord {
/// The [`Record`] to store.
pub record: Record,
}
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, SerializedBytes)]
#[cfg_attr(feature = "test_utils", derive(arbitrary::Arbitrary))]
/// Stores a new [`Entry`] in the DHT.
/// This is the act of creating a either a [`Action::Create`] or
/// a [`Action::Update`] and publishing it to the DHT.
/// These actions create a new instance of an [`Entry`].
pub struct StoreEntry {
/// The signed and hashed [`EntryCreationAction`] that creates
/// a new instance of the [`Entry`].
pub action: SignedHashed<EntryCreationAction>,
/// The new [`Entry`] to store.
pub entry: Entry,
}
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, SerializedBytes)]
#[cfg_attr(feature = "test_utils", derive(arbitrary::Arbitrary))]
/// Registers an update from an instance of an [`Entry`] in the DHT.
/// This is the act of creating a [`Action::Update`] and
/// publishing it to the DHT.
/// Note that the [`Action::Update`] stores an new instance
/// of an [`Entry`] and registers it as an update to the original [`Entry`].
/// This operation is only concerned with registering the update.
pub struct RegisterUpdate {
/// The signed and hashed [`Action::Update`] that registers the update.
pub update: SignedHashed<Update>,
/// The new [`Entry`] that is being updated to.
/// This will be [`None`] when the [`Entry`] being
/// created is [`EntryVisibility::Private`](crate::entry_def::EntryVisibility::Private).
pub new_entry: Option<Entry>,
/// The original [`EntryCreationAction`] that created
/// the original [`Entry`].
/// Note that the update points to a specific instance of the
/// of the original [`Entry`].
pub original_action: EntryCreationAction,
/// The original [`Entry`] that is being updated from.
/// This will be [`None`] when the [`Entry`] being
/// updated is [`EntryVisibility::Private`](crate::entry_def::EntryVisibility::Private).
pub original_entry: Option<Entry>,
}
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, SerializedBytes)]
#[cfg_attr(feature = "test_utils", derive(arbitrary::Arbitrary))]
/// Registers a deletion of an instance of an [`Entry`] in the DHT.
/// This is the act of creating a [`Action::Delete`] and
/// publishing it to the DHT.
pub struct RegisterDelete {
/// The signed and hashed [`Action::Delete`] that registers the deletion.
pub delete: SignedHashed<Delete>,
/// The original [`EntryCreationAction`] that created
/// the original [`Entry`].
pub original_action: EntryCreationAction,
/// The original [`Entry`] that is being deleted.
/// This will be [`None`] when the [`Entry`] being
/// deleted is [`EntryVisibility::Private`](crate::entry_def::EntryVisibility::Private).
pub original_entry: Option<Entry>,
}
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, SerializedBytes)]
#[cfg_attr(feature = "test_utils", derive(arbitrary::Arbitrary))]
/// Registers a new [`Action`] on an agent source chain.
/// This is the act of creating any [`Action`] and
/// publishing it to the DHT.
pub struct RegisterAgentActivity {
/// The signed and hashed [`Action`] that is being registered.
pub action: SignedActionHashed,
/// Entries can be cached with agent authorities if
/// `cached_at_agent_activity` is set to true for an entries
/// definitions.
/// If it is cached for this action then this will be some.
pub cached_entry: Option<Entry>,
}
impl AsRef<SignedActionHashed> for RegisterAgentActivity {
fn as_ref(&self) -> &SignedActionHashed {
&self.action
}
}
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, SerializedBytes)]
#[cfg_attr(feature = "test_utils", derive(arbitrary::Arbitrary))]
/// Registers a link between two [`Entry`]s.
/// This is the act of creating a [`Action::CreateLink`] and
/// publishing it to the DHT.
/// The authority is the entry authority for the base [`Entry`].
pub struct RegisterCreateLink {
/// The signed and hashed [`Action::CreateLink`] that registers the link.
pub create_link: SignedHashed<CreateLink>,
}
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, SerializedBytes)]
#[cfg_attr(feature = "test_utils", derive(arbitrary::Arbitrary))]
/// Deletes a link between two [`Entry`]s.
/// This is the act of creating a [`Action::DeleteLink`] and
/// publishing it to the DHT.
/// The delete always references a specific [`Action::CreateLink`].
pub struct RegisterDeleteLink {
/// The signed and hashed [`Action::DeleteLink`] that registers the deletion.
pub delete_link: SignedHashed<DeleteLink>,
/// The link that is being deleted.
pub create_link: CreateLink,
}
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, SerializedBytes)]
#[cfg_attr(feature = "test_utils", derive(arbitrary::Arbitrary))]
/// Either a [`Action::Create`] or a [`Action::Update`].
/// These actions both create a new instance of an [`Entry`].
pub enum EntryCreationAction {
/// A [`Action::Create`] that creates a new instance of an [`Entry`].
Create(Create),
/// A [`Action::Update`] that creates a new instance of an [`Entry`].
Update(Update),
}
impl Op {
/// Get the [`AgentPubKey`] for the author of this op.
pub fn author(&self) -> &AgentPubKey {
match self {
Op::StoreRecord(StoreRecord { record }) => record.action().author(),
Op::StoreEntry(StoreEntry { action, .. }) => action.hashed.author(),
Op::RegisterUpdate(RegisterUpdate { update, .. }) => &update.hashed.author,
Op::RegisterDelete(RegisterDelete { delete, .. }) => &delete.hashed.author,
Op::RegisterAgentActivity(RegisterAgentActivity { action, .. }) => {
action.hashed.author()
}
Op::RegisterCreateLink(RegisterCreateLink { create_link }) => {
&create_link.hashed.author
}
Op::RegisterDeleteLink(RegisterDeleteLink { delete_link, .. }) => {
&delete_link.hashed.author
}
}
}
/// Get the [`Timestamp`] for when this op was created.
pub fn timestamp(&self) -> Timestamp {
match self {
Op::StoreRecord(StoreRecord { record }) => record.action().timestamp(),
Op::StoreEntry(StoreEntry { action, .. }) => *action.hashed.timestamp(),
Op::RegisterUpdate(RegisterUpdate { update, .. }) => update.hashed.timestamp,
Op::RegisterDelete(RegisterDelete { delete, .. }) => delete.hashed.timestamp,
Op::RegisterAgentActivity(RegisterAgentActivity { action, .. }) => {
action.hashed.timestamp()
}
Op::RegisterCreateLink(RegisterCreateLink { create_link }) => {
create_link.hashed.timestamp
}
Op::RegisterDeleteLink(RegisterDeleteLink { delete_link, .. }) => {
delete_link.hashed.timestamp
}
}
}
/// Get the action sequence this op.
pub fn action_seq(&self) -> u32 {
match self {
Op::StoreRecord(StoreRecord { record }) => record.action().action_seq(),
Op::StoreEntry(StoreEntry { action, .. }) => *action.hashed.action_seq(),
Op::RegisterUpdate(RegisterUpdate { update, .. }) => update.hashed.action_seq,
Op::RegisterDelete(RegisterDelete { delete, .. }) => delete.hashed.action_seq,
Op::RegisterAgentActivity(RegisterAgentActivity { action, .. }) => {
action.hashed.action_seq()
}
Op::RegisterCreateLink(RegisterCreateLink { create_link }) => {
create_link.hashed.action_seq
}
Op::RegisterDeleteLink(RegisterDeleteLink { delete_link, .. }) => {
delete_link.hashed.action_seq
}
}
}
/// Get the [`ActionHash`] for the the previous action from this op if there is one.
pub fn prev_action(&self) -> Option<&ActionHash> {
match self {
Op::StoreRecord(StoreRecord { record }) => record.action().prev_action(),
Op::StoreEntry(StoreEntry { action, .. }) => Some(action.hashed.prev_action()),
Op::RegisterUpdate(RegisterUpdate { update, .. }) => Some(&update.hashed.prev_action),
Op::RegisterDelete(RegisterDelete { delete, .. }) => Some(&delete.hashed.prev_action),
Op::RegisterAgentActivity(RegisterAgentActivity { action, .. }) => {
action.hashed.prev_action()
}
Op::RegisterCreateLink(RegisterCreateLink { create_link }) => {
Some(&create_link.hashed.prev_action)
}
Op::RegisterDeleteLink(RegisterDeleteLink { delete_link, .. }) => {
Some(&delete_link.hashed.prev_action)
}
}
}
/// Get the [`ActionType`] of this op.
pub fn action_type(&self) -> ActionType {
match self {
Op::StoreRecord(StoreRecord { record }) => record.action().action_type(),
Op::StoreEntry(StoreEntry { action, .. }) => action.hashed.action_type(),
Op::RegisterUpdate(RegisterUpdate { .. }) => ActionType::Update,
Op::RegisterDelete(RegisterDelete { .. }) => ActionType::Delete,
Op::RegisterAgentActivity(RegisterAgentActivity { action, .. }) => {
action.hashed.action_type()
}
Op::RegisterCreateLink(RegisterCreateLink { .. }) => ActionType::CreateLink,
Op::RegisterDeleteLink(RegisterDeleteLink { .. }) => ActionType::DeleteLink,
}
}
}
impl EntryCreationAction {
/// The author of this action.
pub fn author(&self) -> &AgentPubKey {
match self {
EntryCreationAction::Create(Create { author, .. })
| EntryCreationAction::Update(Update { author, .. }) => author,
}
}
/// The [`Timestamp`] for this action.
pub fn timestamp(&self) -> &Timestamp {
match self {
EntryCreationAction::Create(Create { timestamp, .. })
| EntryCreationAction::Update(Update { timestamp, .. }) => timestamp,
}
}
/// The action sequence number of this action.
pub fn action_seq(&self) -> &u32 {
match self {
EntryCreationAction::Create(Create { action_seq, .. })
| EntryCreationAction::Update(Update { action_seq, .. }) => action_seq,
}
}
/// The previous [`ActionHash`] of the previous action in the source chain.
pub fn prev_action(&self) -> &ActionHash {
match self {
EntryCreationAction::Create(Create { prev_action, .. })
| EntryCreationAction::Update(Update { prev_action, .. }) => prev_action,
}
}
/// The [`EntryType`] of the [`Entry`] being created.
pub fn entry_type(&self) -> &EntryType {
match self {
EntryCreationAction::Create(Create { entry_type, .. })
| EntryCreationAction::Update(Update { entry_type, .. }) => entry_type,
}
}
/// The [`EntryHash`] of the [`Entry`] being created.
pub fn entry_hash(&self) -> &EntryHash {
match self {
EntryCreationAction::Create(Create { entry_hash, .. })
| EntryCreationAction::Update(Update { entry_hash, .. }) => entry_hash,
}
}
/// The [`AppEntryDef`] of the [`Entry`] being created if it
/// is an application defined [`Entry`].
pub fn app_entry_def(&self) -> Option<&AppEntryDef> {
match self.entry_type() {
EntryType::App(app_entry_def) => Some(app_entry_def),
_ => None,
}
}
/// Returns `true` if this action creates an [`EntryType::AgentPubKey`] [`Entry`].
pub fn is_agent_entry_type(&self) -> bool {
matches!(self.entry_type(), EntryType::AgentPubKey)
}
/// Returns `true` if this action creates an [`EntryType::CapClaim`] [`Entry`].
pub fn is_cap_claim_entry_type(&self) -> bool {
matches!(self.entry_type(), EntryType::CapClaim)
}
/// Returns `true` if this action creates an [`EntryType::CapGrant`] [`Entry`].
pub fn is_cap_grant_entry_type(&self) -> bool {
matches!(self.entry_type(), EntryType::CapGrant)
}
/// Get the [`ActionType`] for this.
pub fn action_type(&self) -> ActionType {
match self {
EntryCreationAction::Create(_) => ActionType::Create,
EntryCreationAction::Update(_) => ActionType::Update,
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
/// A convenience type for validation [`Op`]s.
pub enum OpType<ET, LT>
where
ET: UnitEnum,
{
/// The [`Op::StoreRecord`] which is validated by the authority
/// for the [`ActionHash`] of this record.
///
/// This operation stores a [`Record`] on the DHT and is
/// returned when the authority receives a request
/// on the [`ActionHash`].
StoreRecord(OpRecord<ET, LT>),
/// The [`Op::StoreEntry`] which is validated by the authority
/// for the [`EntryHash`] of this entry.
///
/// This operation stores an [`Entry`] on the DHT and is
/// returned when the authority receives a request
/// on the [`EntryHash`].
StoreEntry(OpEntry<ET>),
/// The [`Op::RegisterAgentActivity`] which is validated by
/// the authority for the [`AgentPubKey`] for the author of this [`Action`].
///
/// This operation registers an [`Action`] to an agent's chain
/// on the DHT and is returned when the authority receives a request
/// on the [`AgentPubKey`] for chain data.
///
/// Note that [`Op::RegisterAgentActivity`] is the only operation
/// that is validated by all zomes regardless of entry or link types.
RegisterAgentActivity(OpActivity<<ET as UnitEnum>::Unit, LT>),
/// The [`Op::RegisterCreateLink`] which is validated by
/// the authority for the [`AnyLinkableHash`] in the base address
/// of this link.
///
/// This operation register's a link to the base address
/// on the DHT and is returned when the authority receives a request
/// on the base [`AnyLinkableHash`] for links.
RegisterCreateLink {
/// The base address where this link is stored.
base_address: AnyLinkableHash,
/// The target address of this link.
target_address: AnyLinkableHash,
/// The link's tag data.
tag: LinkTag,
/// The app defined link type of this link.
link_type: LT,
},
/// The [`Op::RegisterDeleteLink`] which is validated by
/// the authority for the [`AnyLinkableHash`] in the base address
/// of the link that is being deleted.
///
/// This operation registers a deletion of a link to the base address
/// on the DHT and is returned when the authority receives a request
/// on the base [`AnyLinkableHash`] for the link that is being deleted.
RegisterDeleteLink {
/// The hash deleted links [`Action`].
original_link_hash: ActionHash,
/// The base address where this link is stored.
/// This is the base address of the link that is being deleted.
base_address: AnyLinkableHash,
/// The target address of the link being deleted.
target_address: AnyLinkableHash,
/// The deleted links tag data.
tag: LinkTag,
/// The app defined link type of the deleted link.
link_type: LT,
},
/// The [`Op::RegisterUpdate`] which is validated by
/// the authority for the [`ActionHash`] of the original entry
/// and the authority for the [`EntryHash`] of the original entry.
///
/// This operation registers an update from the original entry on
/// the DHT and is returned when the authority receives a request
/// for the [`ActionHash`] of the original entry [`Action`] or the
/// [`EntryHash`] of the original entry.
RegisterUpdate(OpUpdate<ET>),
/// The [`Op::RegisterDelete`] which is validated by
/// the authority for the [`ActionHash`] of the deleted entry
/// and the authority for the [`EntryHash`] of the deleted entry.
///
/// This operation registers a deletion to the original entry on
/// the DHT and is returned when the authority receives a request
/// for the [`ActionHash`] of the deleted entry [`Action`] or the
/// [`EntryHash`] of the deleted entry.
RegisterDelete(OpDelete<ET>),
}
#[derive(Debug, Clone, PartialEq, Eq)]
/// Data specific to the [`Op::StoreRecord`] operation.
pub enum OpRecord<ET, LT>
where
ET: UnitEnum,
{
/// This operation stores the [`Record`] for an
/// app defined entry type.
CreateEntry {
/// The hash of the [`Entry`] being created.
entry_hash: EntryHash,
/// The app defined entry type with the deserialized
/// [`Entry`] data.
entry_type: ET,
},
/// This operation stores the [`Record`] for an
/// app defined private entry type.
CreatePrivateEntry {
/// The hash of the [`Entry`] being created.
entry_hash: EntryHash,
/// The unit version of the app defined entry type.
/// Note it is not possible to deserialize the full
/// entry type here because we don't have the [`Entry`] data.
entry_type: <ET as UnitEnum>::Unit,
},
/// This operation stores the [`Record`] for an
/// [`AgentPubKey`] that has been created.
CreateAgent(AgentPubKey),
/// This operation stores the [`Record`] for a
/// Capability Claim that has been created.
CreateCapClaim(EntryHash),
/// This operation stores the [`Record`] for a
/// Capability Grant that has been created.
CreateCapGrant(EntryHash),
/// This operation stores the [`Record`] for an
/// updated app defined entry type.
UpdateEntry {
/// The hash of the newly created [`Entry`].
entry_hash: EntryHash,
/// The hash of the original [`Action`].
original_action_hash: ActionHash,
/// The hash of the original [`Entry`].
original_entry_hash: EntryHash,
/// The app defined entry type with the deserialized
/// [`Entry`] data from the new entry.
/// Note the new entry type is always the same as the
/// original entry type however the data may have changed.
entry_type: ET,
},
/// This operation stores the [`Record`] for an
/// updated app defined private entry type.
UpdatePrivateEntry {
/// The hash of the newly created [`Entry`].
entry_hash: EntryHash,
/// The hash of the original [`Action`].
original_action_hash: ActionHash,
/// The hash of the original [`Entry`].
original_entry_hash: EntryHash,
/// The unit version of the app defined entry type.
/// Note the new entry type is always the same as the
/// original entry type however the data may have changed.
entry_type: <ET as UnitEnum>::Unit,
},
/// This operation stores the [`Record`] for an
/// updated [`AgentPubKey`].
UpdateAgent {
/// The new [`AgentPubKey`].
new_key: AgentPubKey,
/// The original [`AgentPubKey`].
original_key: AgentPubKey,
/// The hash of the original keys [`Action`].
original_action_hash: ActionHash,
},
/// This operation stores the [`Record`] for an
/// updated Capability Claim.
UpdateCapClaim {
/// The hash of the newly created Capability Claim.
entry_hash: EntryHash,
/// The hash of the original Capability Claim's [`Action`].
original_action_hash: ActionHash,
/// The hash of the original Capability Claim.
original_entry_hash: EntryHash,
},
/// This operation stores the [`Record`] for an
/// updated Capability Grant.
UpdateCapGrant {
/// The hash of the newly created Capability Grant.
entry_hash: EntryHash,
/// The hash of the original Capability Grant's [`Action`].
original_action_hash: ActionHash,
/// The hash of the original Capability Grant.
original_entry_hash: EntryHash,
},
/// This operation stores the [`Record`] for a
/// deleted app defined entry type.
DeleteEntry {
/// The hash of the deleted entry's [`Action`].
original_action_hash: ActionHash,
/// The hash of the deleted entry.
original_entry_hash: EntryHash,
},
/// This operation stores the [`Record`] for a
/// new link.
CreateLink {
/// The base address of the link.
base_address: AnyLinkableHash,
/// The target address of the link.
target_address: AnyLinkableHash,
/// The link's tag.
tag: LinkTag,
/// The app defined link type of this link.
link_type: LT,
},
/// This operation stores the [`Record`] for a
/// deleted link and contains the original link's
/// [`Action`] hash.
DeleteLink(ActionHash),
/// This operation stores the [`Record`] for an
/// [`Action::Dna`].
Dna(DnaHash),
/// This operation stores the [`Record`] for an
/// [`Action::OpenChain`] and contains the previous
/// chains's [`DnaHash`].
OpenChain(DnaHash),
/// This operation stores the [`Record`] for an
/// [`Action::CloseChain`] and contains the new
/// chains's [`DnaHash`].
CloseChain(DnaHash),
/// This operation stores the [`Record`] for an
/// [`Action::AgentValidationPkg`] and contains
/// the membrane proof if there is one.
AgentValidationPkg(Option<MembraneProof>),
/// This operation stores the [`Record`] for an
/// [`Action::InitZomesComplete`].
InitZomesComplete,
}
#[derive(Debug, Clone, PartialEq, Eq)]
/// Data specific to the [`Op::RegisterAgentActivity`] operation.
pub enum OpActivity<UnitType, LT> {
/// This operation registers the [`Action`] for an
/// app defined entry type to the author's chain.
CreateEntry {
/// The hash of the [`Entry`] being created.
entry_hash: EntryHash,
/// The unit version of the app defined entry type.
/// If this is [`None`] then the entry type is defined
/// in a different zome.
entry_type: Option<UnitType>,
},
/// This operation registers the [`Action`] for an
/// app defined private entry type to the author's chain.
CreatePrivateEntry {
/// The hash of the [`Entry`] being created.
entry_hash: EntryHash,
/// The unit version of the app defined entry type.
/// If this is [`None`] then the entry type is defined
/// in a different zome.
entry_type: Option<UnitType>,
},
/// This operation registers the [`Action`] for an
/// [`AgentPubKey`] to the author's chain.
CreateAgent(AgentPubKey),
/// This operation registers the [`Action`] for a
/// Capability Claim to the author's chain.
CreateCapClaim(EntryHash),
/// This operation registers the [`Action`] for a
/// Capability Grant to the author's chain.
CreateCapGrant(EntryHash),
/// This operation registers the [`Action`] for an
/// updated app defined entry type to the author's chain.
UpdateEntry {
/// The hash of the newly created [`Entry`].
entry_hash: EntryHash,
/// The hash of the original [`Action`].
original_action_hash: ActionHash,
/// The hash of the original [`Entry`].
original_entry_hash: EntryHash,
/// The unit version of the app defined entry type.
/// If this is [`None`] then the entry type is defined
/// in a different zome.
entry_type: Option<UnitType>,
},
/// This operation registers the [`Action`] for an
/// updated app defined private entry type to the author's chain.
UpdatePrivateEntry {
/// The hash of the newly created [`Entry`].
entry_hash: EntryHash,
/// The hash of the original [`Action`].
original_action_hash: ActionHash,
/// The hash of the original [`Entry`].
original_entry_hash: EntryHash,
/// The unit version of the app defined private entry type.
/// If this is [`None`] then the entry type is defined
/// in a different zome.
entry_type: Option<UnitType>,
},
/// This operation registers the [`Action`] for an
/// updated [`AgentPubKey`] to the author's chain.
UpdateAgent {
/// The new [`AgentPubKey`].
new_key: AgentPubKey,
/// The original [`AgentPubKey`].
original_key: AgentPubKey,
/// The hash of the original keys [`Action`].
original_action_hash: ActionHash,
},
/// This operation registers the [`Action`] for an
/// updated Capability Claim to the author's chain.
UpdateCapClaim {
/// The hash of the newly created Capability Claim.
entry_hash: EntryHash,
/// The hash of the original Capability Claim's [`Action`].
original_action_hash: ActionHash,
/// The hash of the original Capability Claim.
original_entry_hash: EntryHash,
},
/// This operation registers the [`Action`] for an
/// updated Capability Grant to the author's chain.
UpdateCapGrant {
/// The hash of the newly created Capability Grant.
entry_hash: EntryHash,
/// The hash of the original Capability Grant's [`Action`].
original_action_hash: ActionHash,
/// The hash of the original Capability Grant.
original_entry_hash: EntryHash,
},
/// This operation registers the [`Action`] for a
/// deleted app defined entry type to the author's chain.
DeleteEntry {
/// The hash of the deleted entry's [`Action`].
original_action_hash: ActionHash,
/// The hash of the deleted entry.
original_entry_hash: EntryHash,
},
/// This operation registers the [`Action`] for a
/// new link to the author's chain.
CreateLink {
/// The base address of the link.
base_address: AnyLinkableHash,
/// The target address of the link.
target_address: AnyLinkableHash,
/// The link's tag.
tag: LinkTag,
/// The app defined link type of this link.
/// If this is [`None`] then the link type is defined
/// in a different zome.
link_type: Option<LT>,
},
/// This operation registers the [`Action`] for a
/// deleted link to the author's chain and contains
/// the original link's [`Action`] hash.
DeleteLink(ActionHash),
/// This operation registers the [`Action`] for an
/// [`Action::Dna`] to the author's chain.
Dna(DnaHash),
/// This operation registers the [`Action`] for an
/// [`Action::OpenChain`] to the author's chain
/// and contains the previous chains's [`DnaHash`].
OpenChain(DnaHash),
/// This operation registers the [`Action`] for an
/// [`Action::CloseChain`] to the author's chain
/// and contains the new chains's [`DnaHash`].
CloseChain(DnaHash),
/// This operation registers the [`Action`] for an
/// [`Action::AgentValidationPkg`] to the author's chain
/// and contains the membrane proof if there is one.
AgentValidationPkg(Option<MembraneProof>),
/// This operation registers the [`Action`] for an
/// [`Action::InitZomesComplete`] to the author's chain.
InitZomesComplete,
}
#[derive(Debug, Clone, PartialEq, Eq)]
/// Data specific to the [`Op::StoreEntry`] operation.
pub enum OpEntry<ET>
where
ET: UnitEnum,
{
/// This operation stores the [`Entry`] for an
/// app defined entry type.
CreateEntry {
/// The hash of the [`Entry`] being created.
entry_hash: EntryHash,
/// The app defined entry type with the deserialized
/// [`Entry`] data.
entry_type: ET,
},
/// This operation stores the [`Entry`] for an
/// [`AgentPubKey`].
CreateAgent(AgentPubKey),
/// This operation stores the [`Entry`] for the
/// newly created entry in an update.
UpdateEntry {
/// The hash of the newly created [`Entry`].
entry_hash: EntryHash,
/// The hash of the original [`Action`].
original_action_hash: ActionHash,
/// The hash of the original [`Entry`].
original_entry_hash: EntryHash,
/// The app defined entry type with the deserialized
/// [`Entry`] data of the new entry.
entry_type: ET,
},
/// This operation stores the [`Entry`] for an
/// updated [`AgentPubKey`].
UpdateAgent {
/// The new [`AgentPubKey`].
new_key: AgentPubKey,
/// The original [`AgentPubKey`].
original_key: AgentPubKey,
/// The hash of the original keys [`Action`].
original_action_hash: ActionHash,
},
}
#[derive(Debug, Clone, PartialEq, Eq)]
/// Data specific to the [`Op::RegisterUpdate`] operation.
pub enum OpUpdate<ET>
where
ET: UnitEnum,
{
/// This operation registers an update from
/// the original [`Entry`].
Entry {
/// The hash of the newly created [`Entry`].
entry_hash: EntryHash,
/// The hash of the original [`Action`].
original_action_hash: ActionHash,
/// The hash of the original [`Entry`].
original_entry_hash: EntryHash,
/// The app defined entry type with the deserialized
/// [`Entry`] data of the original entry.
original_entry_type: ET,
/// The app defined entry type with the deserialized
/// [`Entry`] data of the new entry.
new_entry_type: ET,
},
/// This operation registers an update from
/// the original private [`Entry`].
PrivateEntry {
/// The hash of the newly created [`Entry`].
entry_hash: EntryHash,
/// The hash of the original [`Action`].
original_action_hash: ActionHash,
/// The hash of the original [`Entry`].
original_entry_hash: EntryHash,
/// The unit version of the app defined entry type
/// for the original entry.
original_entry_type: <ET as UnitEnum>::Unit,
/// The unit version of the app defined entry type
/// for the new entry.
new_entry_type: <ET as UnitEnum>::Unit,
},
/// This operation registers an update from
/// the original [`AgentPubKey`].
Agent {
/// The new [`AgentPubKey`].
new_key: AgentPubKey,
/// The original [`AgentPubKey`].
original_key: AgentPubKey,
/// The hash of the original keys [`Action`].
original_action_hash: ActionHash,
},
/// This operation registers an update from
/// a Capability Claim.
CapClaim {
/// The hash of the newly created Capability Claim.
entry_hash: EntryHash,
/// The hash of the original Capability Claim's [`Action`].
original_action_hash: ActionHash,
/// The hash of the original Capability Claim.
original_entry_hash: EntryHash,
},
/// This operation registers an update from
/// a Capability Grant.
CapGrant {
/// The hash of the newly created Capability Grant.
entry_hash: EntryHash,
/// The hash of the original Capability Grant's [`Action`].
original_action_hash: ActionHash,
/// The hash of the original Capability Grant.
original_entry_hash: EntryHash,
},
}
#[derive(Debug, Clone, PartialEq, Eq)]
/// Data specific to the [`Op::RegisterDelete`] operation.
pub enum OpDelete<ET>
where
ET: UnitEnum,
{
/// This operation registers a deletion to the
/// original [`Entry`].
Entry {
/// The hash of the delete entry's [`Action`].
original_action_hash: ActionHash,
/// The hash of the delete entry.
original_entry_hash: EntryHash,
/// The app defined entry type with the deserialized
/// [`Entry`] data from the deleted entry.
original_entry_type: ET,
},
/// This operation registers a deletion to the
/// original private [`Entry`].
PrivateEntry {
/// The hash of the dleted entry's [`Action`].
original_action_hash: ActionHash,
/// The hash of the deleted entry.
original_entry_hash: EntryHash,
/// The unit version of the app defined entry type
/// of the deleted entry.
original_entry_type: <ET as UnitEnum>::Unit,
},
/// This operation registers a deletion to an
/// [`AgentPubKey`].
Agent {
/// The deleted [`AgentPubKey`].
original_key: AgentPubKey,
/// The hash of the deleted keys [`Action`].
original_action_hash: ActionHash,
},
/// This operation registers a deletion to a
/// Capability Claim.
CapClaim {
/// The hash of the deleted Capability Claim's [`Action`].
original_action_hash: ActionHash,
/// The hash of the deleted Capability Claim.
original_entry_hash: EntryHash,
},
/// This operation registers a deletion to a
/// Capability Grant.
CapGrant {
/// The hash of the deleted Capability Grant's [`Action`].
original_action_hash: ActionHash,
/// The hash of the deleted Capability Grant.
original_entry_hash: EntryHash,
},
}
/// Allows a [`EntryCreationAction`] to hash the same bytes as
/// the equivalent [`Action`] variant without needing to clone the action.
impl HashableContent for EntryCreationAction {
type HashType = holo_hash::hash_type::Action;
fn hash_type(&self) -> Self::HashType {
use holo_hash::PrimitiveHashType;
holo_hash::hash_type::Action::new()
}
fn hashable_content(&self) -> holo_hash::HashableContentBytes {
let h = match self {
EntryCreationAction::Create(create) => ActionRef::Create(create),
EntryCreationAction::Update(update) => ActionRef::Update(update),
};
let sb = SerializedBytes::from(UnsafeBytes::from(
holochain_serialized_bytes::encode(&h).expect("Could not serialize HashableContent"),
));
holo_hash::HashableContentBytes::Content(sb)
}
}
impl From<EntryCreationAction> for Action {
fn from(e: EntryCreationAction) -> Self {
match e {
EntryCreationAction::Create(c) => Action::Create(c),
EntryCreationAction::Update(u) => Action::Update(u),
}
}
}
impl From<Create> for EntryCreationAction {
fn from(c: Create) -> Self {
EntryCreationAction::Create(c)
}
}
impl From<Update> for EntryCreationAction {
fn from(u: Update) -> Self {
EntryCreationAction::Update(u)
}
}
impl TryFrom<Action> for EntryCreationAction {
type Error = crate::WrongActionError;
fn try_from(value: Action) -> Result<Self, Self::Error> {
match value {
Action::Create(h) => Ok(EntryCreationAction::Create(h)),
Action::Update(h) => Ok(EntryCreationAction::Update(h)),
_ => Err(crate::WrongActionError(format!("{:?}", value))),
}
}
}