dusk-node-data 1.6.0

Types used for interacting with Dusk node.
Documentation 
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright (c) DUSK NETWORK. All rights reserved.

mod blocks;
mod transactions;

pub mod contract;

pub use blocks::{BlockEvent, BlockState};
pub use transactions::TransactionEvent;

/// Represents an event in the system, including its source (`component`),
/// type (`topic`), associated entity (`entity`), and optional data (`data`).
///
/// - `component`: Source of the event (e.g., `"transaction"/"block"`).
/// - `topic`: Type/category of the event (e.g., `"accepted"/"removed"`).
/// - `entity`: Identifier for the related entity (e.g., `transaction hash`).
/// - `data`: Optional JSON data with additional event details.
#[derive(Clone, Debug)]
pub struct Event {
    pub component: &'static str,
    pub topic: &'static str,
    pub entity: String,
    pub data: Option<serde_json::Value>,
}

trait EventSource {
    const COMPONENT: &'static str;

    fn topic(&self) -> &'static str;
    fn entity(&self) -> String;
    fn data(&self) -> Option<serde_json::Value>;
}

impl<ES: EventSource> From<ES> for Event {
    fn from(value: ES) -> Self {
        Self {
            data: value.data(),
            topic: value.topic(),
            entity: value.entity(),
            component: ES::COMPONENT,
        }
    }
}