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

use raiden_blockchain::keys::PrivateKey;
use raiden_primitives::types::{
	Address,
	AddressMetadata,
	BlockNumber,
	MessageIdentifier,
	QueueIdentifier,
	H256,
	U256,
};
use serde::{
	Deserialize,
	Serialize,
};
use web3::signing::{
	Key,
	Signature,
	SigningError,
};

mod metadata;
mod monitoring_service;
mod pathfinding;
mod synchronization;
mod transfer;
mod withdraw;

pub use metadata::*;
pub use monitoring_service::*;
pub use pathfinding::*;
pub use synchronization::*;
pub use transfer::*;
pub use withdraw::*;

/// Identifier for off-chain messages.
///
/// These magic numbers are used to identify the type of a message.
enum CmdId {
	Processed = 0,
	SecretRequest = 3,
	Unlock = 4,
	LockedTransfer = 7,
	RevealSecret = 11,
	Delivered = 12,
	LockExpired = 13,
	WithdrawExpired = 17,
}

impl From<CmdId> for [u8; 1] {
	fn from(val: CmdId) -> Self {
		(val as u8).to_be_bytes()
	}
}

/// An enum containing the commands to send to the transport layer.
#[derive(Debug, Eq, PartialEq)]
pub enum TransportServiceMessage {
	Enqueue((QueueIdentifier, OutgoingMessage)),
	Dequeue((Option<QueueIdentifier>, MessageIdentifier)),
	Send(MessageIdentifier),
	Broadcast(OutgoingMessage),
	UpdateServiceAddresses(Address, U256),
	ExpireServiceAddresses(U256, BlockNumber),
	Clear(QueueIdentifier),
}

/// An enum containing all message types to be sent / received by the transport.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum MessageInner {
	LockedTransfer(LockedTransfer),
	LockExpired(LockExpired),
	SecretRequest(SecretRequest),
	SecretReveal(SecretReveal),
	Unlock(Unlock),
	WithdrawRequest(WithdrawRequest),
	WithdrawConfirmation(WithdrawConfirmation),
	WithdrawExpired(WithdrawExpired),
	PFSCapacityUpdate(PFSCapacityUpdate),
	PFSFeeUpdate(PFSFeeUpdate),
	MSUpdate(RequestMonitoring),
	Processed(Processed),
	Delivered(Delivered),
}

/// Message to be sent out to the partner node.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct OutgoingMessage {
	pub message_identifier: MessageIdentifier,
	pub recipient: Address,
	pub recipient_metadata: AddressMetadata,
	#[serde(flatten)]
	pub inner: MessageInner,
}

impl OutgoingMessage {
	/// Returns the string type name of the message.
	pub fn type_name(&self) -> &'static str {
		match self.inner {
			MessageInner::LockedTransfer(_) => "LockedTransfer",
			MessageInner::LockExpired(_) => "LockExpired",
			MessageInner::SecretRequest(_) => "SecretRequest",
			MessageInner::SecretReveal(_) => "SecretReveal",
			MessageInner::Unlock(_) => "Unlock",
			MessageInner::WithdrawRequest(_) => "WithdrawRequest",
			MessageInner::WithdrawConfirmation(_) => "WithdrawConfirmation",
			MessageInner::WithdrawExpired(_) => "WithdrawExpired",
			MessageInner::PFSCapacityUpdate(_) => "PFSCapacityUpdate",
			MessageInner::PFSFeeUpdate(_) => "PFSFeeUpdate",
			MessageInner::MSUpdate(_) => "MSUpdate",
			MessageInner::Processed(_) => "Processed",
			MessageInner::Delivered(_) => "Delivered",
		}
	}
}

/// Message received from the partner node.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct IncomingMessage {
	pub message_identifier: MessageIdentifier,
	pub inner: MessageInner,
}

impl IncomingMessage {
	/// Returns the string type name of the message.
	pub fn type_name(&self) -> &'static str {
		match self.inner {
			MessageInner::LockedTransfer(_) => "LockedTransfer",
			MessageInner::LockExpired(_) => "LockExpired",
			MessageInner::SecretRequest(_) => "SecretRequest",
			MessageInner::SecretReveal(_) => "SecretReveal",
			MessageInner::Unlock(_) => "Unlock",
			MessageInner::WithdrawRequest(_) => "WithdrawRequest",
			MessageInner::WithdrawConfirmation(_) => "WithdrawConfirmation",
			MessageInner::WithdrawExpired(_) => "WithdrawExpired",
			MessageInner::PFSCapacityUpdate(_) => "PFSCapacityUpdate",
			MessageInner::PFSFeeUpdate(_) => "PFSFeeUpdate",
			MessageInner::MSUpdate(_) => "MSUpdate",
			MessageInner::Processed(_) => "Processed",
			MessageInner::Delivered(_) => "Delivered",
		}
	}
}

/// Trait to be implemented by the messages that have to be signed before being sent.
pub trait SignedMessage {
	fn bytes_to_sign(&self) -> Vec<u8>;
	fn sign(&mut self, key: PrivateKey) -> Result<(), SigningError>;
	fn sign_message(&self, key: PrivateKey) -> Result<Signature, SigningError> {
		let bytes = self.bytes_to_sign();
		key.sign_message(&bytes)
	}
}

/// A trait for the signed message that contains a balance proof.
pub trait SignedEnvelopeMessage: SignedMessage {
	fn message_hash(&self) -> H256;
}

/// Convert state machine event into a signed message.
#[macro_export]
macro_rules! to_message {
	( $send_message_event:ident, $private_key:ident, $message_type:tt ) => {{
		let message_identifier = $send_message_event.inner.message_identifier;
		let recipient = $send_message_event.inner.recipient;
		let address_metadata = $send_message_event
			.inner
			.recipient_metadata
			.clone()
			.expect("Address metadata should be set at this point");
		let mut message: $message_type = $send_message_event.into();
		let _ = message.sign($private_key);
		OutgoingMessage {
			message_identifier,
			recipient,
			recipient_metadata: address_metadata,
			inner: MessageInner::$message_type(message),
		}
	}};
}