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
use crate::{
parents::Parents,
payload::{option_payload_pack, option_payload_packed_len, option_payload_unpack, Payload},
Error, MessageId,
};
use bee_common::packable::{Packable, Read, Write};
use bee_pow::providers::{miner::Miner, NonceProvider, NonceProviderBuilder};
use crypto::hashes::{blake2b::Blake2b256, Digest};
pub const MESSAGE_LENGTH_MIN: usize = 53;
pub const MESSAGE_LENGTH_MAX: usize = 32768;
const DEFAULT_POW_SCORE: f64 = 4000f64;
const DEFAULT_NONCE: u64 = 0;
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Message {
network_id: u64,
parents: Parents,
payload: Option<Payload>,
nonce: u64,
}
impl Message {
pub fn builder() -> MessageBuilder {
MessageBuilder::new()
}
pub fn id(&self) -> (MessageId, Vec<u8>) {
let bytes = self.pack_new();
let id = Blake2b256::digest(&bytes);
(MessageId::new(id.into()), bytes)
}
pub fn network_id(&self) -> u64 {
self.network_id
}
pub fn parents(&self) -> &Parents {
&self.parents
}
pub fn payload(&self) -> &Option<Payload> {
&self.payload
}
pub fn nonce(&self) -> u64 {
self.nonce
}
pub fn into_parents(self) -> Parents {
self.parents
}
}
impl Packable for Message {
type Error = Error;
fn packed_len(&self) -> usize {
self.network_id.packed_len()
+ self.parents.packed_len()
+ option_payload_packed_len(self.payload.as_ref())
+ self.nonce.packed_len()
}
fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error> {
self.network_id.pack(writer)?;
self.parents.pack(writer)?;
option_payload_pack(writer, self.payload.as_ref())?;
self.nonce.pack(writer)?;
Ok(())
}
fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(reader: &mut R) -> Result<Self, Self::Error> {
let network_id = u64::unpack_inner::<R, CHECK>(reader)?;
let parents = Parents::unpack_inner::<R, CHECK>(reader)?;
let (payload_len, payload) = option_payload_unpack::<R, CHECK>(reader)?;
if CHECK
&& !matches!(
payload,
None | Some(Payload::Transaction(_)) | Some(Payload::Milestone(_)) | Some(Payload::Indexation(_))
)
{
return Err(Error::InvalidPayloadKind(payload.unwrap().kind()));
}
let nonce = u64::unpack_inner::<R, CHECK>(reader)?;
let message_len = network_id.packed_len() + parents.packed_len() + payload_len + nonce.packed_len();
if CHECK && message_len > MESSAGE_LENGTH_MAX {
return Err(Error::InvalidMessageLength(message_len));
}
if CHECK && reader.bytes().next().is_some() {
return Err(Error::RemainingBytesAfterMessage);
}
Ok(Self {
network_id,
parents,
payload,
nonce,
})
}
}
pub struct MessageBuilder<P: NonceProvider = Miner> {
network_id: Option<u64>,
parents: Option<Parents>,
payload: Option<Payload>,
nonce_provider: Option<(P, f64)>,
}
impl<P: NonceProvider> Default for MessageBuilder<P> {
fn default() -> Self {
Self {
network_id: None,
parents: None,
payload: None,
nonce_provider: None,
}
}
}
impl<P: NonceProvider> MessageBuilder<P> {
pub fn new() -> Self {
Default::default()
}
pub fn with_network_id(mut self, network_id: u64) -> Self {
self.network_id = Some(network_id);
self
}
pub fn with_parents(mut self, parents: Parents) -> Self {
self.parents = Some(parents);
self
}
pub fn with_payload(mut self, payload: Payload) -> Self {
self.payload = Some(payload);
self
}
pub fn with_nonce_provider(mut self, nonce_provider: P, target_score: f64) -> Self {
self.nonce_provider = Some((nonce_provider, target_score));
self
}
pub fn finish(self) -> Result<Message, Error> {
let network_id = self.network_id.ok_or(Error::MissingField("network_id"))?;
let parents = self.parents.ok_or(Error::MissingField("parents"))?;
if !matches!(
self.payload,
None | Some(Payload::Transaction(_)) | Some(Payload::Milestone(_)) | Some(Payload::Indexation(_))
) {
return Err(Error::InvalidPayloadKind(self.payload.unwrap().kind()));
}
let mut message = Message {
network_id,
parents,
payload: self.payload,
nonce: 0,
};
let message_bytes = message.pack_new();
if message_bytes.len() > MESSAGE_LENGTH_MAX {
return Err(Error::InvalidMessageLength(message_bytes.len()));
}
let (nonce_provider, target_score) = self
.nonce_provider
.unwrap_or((P::Builder::new().finish(), DEFAULT_POW_SCORE));
message.nonce = nonce_provider
.nonce(
&message_bytes[..message_bytes.len() - std::mem::size_of::<u64>()],
target_score,
)
.unwrap_or(DEFAULT_NONCE);
Ok(message)
}
}