otx-pool-plugin-protocol 0.1.0

The open transaction pool plugin protocol
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
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

use otx_format::jsonrpc_types::OpenTransaction;

use ckb_types::core::service::Request;
use ckb_types::H256;
use crossbeam_channel::Sender;
use serde_derive::{Deserialize, Serialize};

use std::path::PathBuf;

pub trait Plugin: Send + Sync {
    fn get_name(&self) -> String;
    fn get_meta(&self) -> PluginMeta;
    fn get_info(&self) -> PluginInfo;
    fn on_new_otx(&self, _otx: OpenTransaction) {
        // This is a default implementation that does nothing.
    }
    fn on_new_intervel(&self, _interval: u64) {
        // This is a default implementation that does nothing.
    }
    fn on_commit_otx(&self, _otxs: Vec<H256>) {
        // This is a default implementation that does nothing.
    }
}

#[derive(Clone, Debug)]
pub struct PluginMeta {
    /// The installation path of the plug-in, the built-in plugin binary_path is default value.
    pub binary_path: PathBuf,
    /// Activation falg.
    pub is_active: bool,
    /// Built-in flag.
    pub is_built_in: bool,
}

impl PluginMeta {
    pub fn new(binary_path: PathBuf, is_active: bool, is_built_in: bool) -> PluginMeta {
        PluginMeta {
            binary_path,
            is_active,
            is_built_in,
        }
    }
}

pub type HostServiceHandler = Sender<Request<MessageFromPlugin, MessageFromHost>>;

pub enum MessageType {
    Request,
    Response,
    Notify,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum MessageFromHost {
    // Notify
    NewOtx(OpenTransaction),
    NewInterval(u64),
    OtxPoolStart,
    OtxPoolStop,
    CommitOtx(Vec<H256>),

    // Request
    GetPluginInfo,

    // Response
    Ok,
    Error(String),
}

impl MessageFromHost {
    pub fn get_message_type(&self) -> MessageType {
        match self {
            Self::NewOtx(_)
            | Self::NewInterval(_)
            | Self::OtxPoolStart
            | Self::OtxPoolStop
            | Self::CommitOtx(_) => MessageType::Notify,
            Self::GetPluginInfo | Self::Ok | Self::Error(_) => MessageType::Request,
        }
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum MessageFromPlugin {
    // Response
    Ok,
    Error(String),
    PluginInfo(PluginInfo),

    // Request
    NewMergedOtx((OpenTransaction, Vec<H256>)),
    DiscardOtx((H256, OpenTransaction)),
    ModifyOtx((H256, OpenTransaction)),
    SentToCkb(H256),
    MergeOtxsAndSentToCkb((Vec<H256>, H256)),
}

impl MessageFromPlugin {
    pub fn get_message_type(&self) -> MessageType {
        match self {
            Self::Ok | Self::Error(_) | Self::PluginInfo(_) => MessageType::Response,
            Self::NewMergedOtx(_)
            | Self::DiscardOtx(_)
            | Self::ModifyOtx(_)
            | Self::SentToCkb(_)
            | Self::MergeOtxsAndSentToCkb(_) => MessageType::Request,
        }
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct PluginInfo {
    pub name: String,
    pub description: String,
    pub version: String,
}

impl PluginInfo {
    pub fn new(name: &str, description: &str, version: &str) -> Self {
        PluginInfo {
            name: name.into(),
            description: description.into(),
            version: version.into(),
        }
    }
}