-
Notifications
You must be signed in to change notification settings - Fork 1
/
wrap_ret_address.rs
360 lines (301 loc) · 13.4 KB
/
wrap_ret_address.rs
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
use crate::prelude::*;
pub trait AddressViaRet: Sized {
fn new(
node_id: impl Into<ScryptoNodeId>,
network_id: NetworkID,
) -> Result<Self>;
}
pub trait IsAddress:
IsNetworkAware
+ Serialize
+ for<'a> Deserialize<'a>
+ std::fmt::Display
+ FromStr
{
}
/// Helps with unit testing, so that we do not need to explicitly specify each
/// (Sargon) Address types corresponding RET address type, but can use, e.g.
/// `AccountAddress::RetAddress` instead of `radix_engine_toolkit::models::canonical_address_types::CanonicalAccountAddress`
pub(crate) trait FromRetAddress {
type RetAddress;
}
pub(crate) fn format_string(
s: impl AsRef<str>,
start: usize,
end: usize,
) -> String {
let s = s.as_ref();
let prefix = &s[0..start];
let suffix = suffix_str(end, s);
format!("{}...{}", prefix, suffix)
}
pub trait IntoScryptoAddress: IsNetworkAware {
fn scrypto(&self) -> ScryptoGlobalAddress;
}
/// This macro exists since UniFFI does not support generics currently, when/if
/// UniFFI does, we SHOULD remove this macro and use generics.
macro_rules! decl_ret_wrapped_address {
(
$(
#[doc = $expr: expr]
)*
$address_type: ident
) => {
paste! {
$(
#[doc = $expr]
)*
#[derive(
Clone,
Copy,
PartialEq,
Eq,
Hash,
derive_more::Display,
derive_more::Debug,
SerializeDisplay,
DeserializeFromStr,
uniffi::Record,
)]
#[display("{secret_magic}")]
#[debug("{secret_magic}")]
pub struct [< $address_type:camel Address >] {
pub(crate) secret_magic: [< Ret $address_type:camel Address >], // Do NOT add comments above
}
#[uniffi::export]
pub fn [<new_ $address_type:snake _address>](bech32: String) -> Result<[< $address_type:camel Address >]> {
[< $address_type:camel Address >]::try_from_bech32(&bech32)
}
/// Returns a new address, with the same node_id, but using `network_id` as
/// network.
#[uniffi::export]
pub fn [<$address_type:snake _address_map_to_network>](address: &[< $address_type:camel Address >], network_id: NetworkID) -> [< $address_type:camel Address >] {
address.map_to_network(network_id)
}
#[uniffi::export]
pub fn [<$address_type:snake _address_network_id>](address: &[< $address_type:camel Address >]) -> NetworkID {
address.network_id()
}
#[uniffi::export]
pub fn [<$address_type:snake _address_bech32_address>](address: &[< $address_type:camel Address >]) -> String {
address.address()
}
#[uniffi::export]
pub fn [<$address_type:snake _address_formatted>](address: &[< $address_type:camel Address >], format: AddressFormat) -> String {
address.formatted(format)
}
/// Returns a random address in `network_id` as Network
#[uniffi::export]
pub fn [<new_ $address_type:snake _address_random>](network_id: NetworkID) -> [<$address_type:camel Address >] {
[<$address_type:camel Address >]::random(network_id)
}
uniffi::custom_type!([< Ret $address_type:camel Address >], String);
/// UniFFI conversion for RET types which are DisplayFromStr using String as builtin.
impl crate::UniffiCustomTypeConverter for [< Ret $address_type:camel Address >] {
type Builtin = String;
fn into_custom(val: Self::Builtin) -> uniffi::Result<Self> {
val.parse::<Self>()
.map_err(|_| {
CommonError::FailedToDecodeAddressFromBech32 { bad_value: val }.into()
})
}
fn from_custom(obj: Self) -> Self::Builtin {
obj.to_string()
}
}
impl From<[< Ret $address_type:camel Address >]> for [< $address_type:camel Address >] {
fn from(value: [< Ret $address_type:camel Address >]) -> Self {
Self { secret_magic: value }
}
}
impl FromStr for [< $address_type:camel Address >] {
type Err = CommonError;
fn from_str(s: &str) -> Result<Self> {
Self::try_from_bech32(s)
}
}
#[cfg(test)]
impl From<&str> for [< $address_type:camel Address >] {
/// TEST ONLY
fn from(value: &str) -> Self {
value.parse().expect(&format!("Test failed since the passed in str is not a valid address: '{}'", value))
}
}
impl IsAddress for [< $address_type:camel Address >] {
}
impl FromRetAddress for [< $address_type:camel Address >] {
type RetAddress = [< Ret $address_type:camel Address >];
}
impl From<[< $address_type:camel Address >]> for ScryptoGlobalAddress {
fn from(value: [< $address_type:camel Address >]) -> ScryptoGlobalAddress {
value.scrypto()
}
}
impl Ord for [< $address_type:camel Address >] {
fn cmp(&self, other: &Self) -> Ordering {
self.address().cmp(&other.address())
}
}
impl PartialOrd for [< $address_type:camel Address >] {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
impl [< $address_type:camel Address >] {
pub fn random(network_id: NetworkID) -> Self {
Self::with_node_id_bytes(&generate_byte_array::<{ ScryptoNodeId::RID_LENGTH }>(), network_id)
}
pub fn with_node_id_bytes(
node_id_bytes: &[u8; { ScryptoNodeId::RID_LENGTH }],
network_id: NetworkID
) -> Self {
let entity_byte = Self::sample().node_id().as_bytes()[0];
let node_id = ScryptoNodeId::new(entity_byte, node_id_bytes);
let ret_address = [<Ret $address_type:camel Address>]::new(node_id, network_id.discriminant()).unwrap();
Self::from(ret_address)
}
pub fn formatted(&self, format: AddressFormat) -> String {
match format {
AddressFormat::Default => format_string(self.address(), 4, 6),
AddressFormat::Full | AddressFormat::Raw => self.address(),
}
}
pub(crate) fn scrypto(&self) -> ScryptoGlobalAddress {
ScryptoGlobalAddress::try_from(self.node_id())
.expect("Should always be able to convert a Sargon Address into radix engine 'GlobalAddress'.")
}
pub(crate) fn node_id(&self) -> ScryptoNodeId {
self.secret_magic.node_id()
}
/// Returns a new address, with the same node_id, but using `network_id` as
/// network.
pub fn map_to_network(&self, network_id: NetworkID) -> Self {
if network_id == self.network_id() {
return *self
}
<Self as AddressViaRet>::new(self.node_id(), network_id).expect("Should always be able to map an address to a different network.")
}
pub fn address(&self) -> String {
self.to_string()
}
pub fn entity_type(&self) -> ScryptoEntityType {
self.secret_magic.entity_type()
}
pub fn try_from_bech32(bech32: impl AsRef<str>) -> Result<Self> {
bech32.as_ref().parse::<[< Ret $address_type:camel Address >]>()
.map_err(|e| {
error!("Failed Bech32 decode String, RET error: {:?}", e);
CommonError::FailedToDecodeAddressFromBech32 { bad_value: bech32.as_ref().to_owned() }
})
.map(Self::from)
}
}
impl From<[< $address_type:camel Address >]> for ScryptoManifestValue {
fn from(value: [< $address_type:camel Address >]) -> ScryptoManifestValue {
ScryptoManifestValue::Custom {
value: ScryptoManifestCustomValue::Address(
ScryptoManifestAddress::Static(
value.node_id(),
),
),
}
}
}
#[cfg(test)]
mod [<tests_of_ $address_type:snake>] {
use super::*;
#[allow(clippy::upper_case_acronyms)]
type SUT = [< $address_type:camel Address >];
#[test]
fn random_address_bech32_roundtrip() {
for network_id in NetworkID::all() {
let sut = SUT::random(network_id);
// Bech32 roundtrip ensures the correct [Scrypto]`EntityType`
// is used across, and thus correct Bech32 HRP.
assert_eq!(SUT::from_str(&sut.to_string()).unwrap(), sut);
}
}
#[test]
fn random_address_is_random() {
let n = 100;
for network_id in NetworkID::all() {
let addresses = (0..n)
.map(|_| SUT::random(network_id))
.collect::<HashSet<SUT>>();
assert_eq!(addresses.len(), n);
}
}
}
#[cfg(test)]
mod [<uniffi_tests_of_ $address_type:snake>] {
use super::*;
#[allow(clippy::upper_case_acronyms)]
type SUT = [< $address_type:camel Address >];
#[test]
fn map_to_network() {
let sut = SUT::sample();
assert_eq!([<$address_type:snake _address_map_to_network>](&sut, sut.network_id()), sut); // unchanged
}
#[test]
fn random_address() {
let n = 100;
for network_id in NetworkID::all() {
let addresses = (0..n)
.map(|_| [<new_ $address_type:snake _address_random>](network_id))
.collect::<HashSet<SUT>>();
assert_eq!(addresses.len(), n);
}
}
}
impl IsNetworkAware for [< $address_type:camel Address >] {
fn network_id(&self) -> NetworkID {
self.secret_magic.network_id().try_into().expect("Should have known all network ids")
}
}
impl IntoScryptoAddress for [< $address_type:camel Address >] {
fn scrypto(&self) -> ScryptoGlobalAddress {
ScryptoGlobalAddress::try_from(self.node_id())
.expect("Should always be able to convert a Sargon Address into radix engine 'GlobalAddress'.")
}
}
impl AddressViaRet for [< $address_type:camel Address >] {
fn new(
node_id: impl Into<ScryptoNodeId>,
network_id: NetworkID,
) -> Result<Self, CommonError> {
let node_id: ScryptoNodeId = node_id.into();
[< Ret $address_type:camel Address >]::new(node_id.clone(), network_id.discriminant())
.map_err(|e| {
error!("Failed create address, from node and network_id, RET error: {:?}", e);
CommonError::FailedToCreateAddressViaRetAddressFromNodeIdAndNetworkID { node_id_as_hex: node_id.to_hex(), network_id }
})
.map(|i| [< $address_type:camel Address >]::from(i))
}
}
impl TryInto<ScryptoDynamicGlobalAddress> for &[< $address_type:camel Address >] {
type Error = crate::CommonError;
fn try_into(
self,
) -> Result<ScryptoDynamicGlobalAddress, Self::Error> {
Ok(ScryptoDynamicGlobalAddress::Static(self.scrypto()))
}
}
}
};
}
pub(crate) use decl_ret_wrapped_address;
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn account_address_from_invalid_node_id() {
let unknown_node_id = ScryptoNodeId::new(222, &[0xff; 29]);
assert_eq!(
<AccountAddress as AddressViaRet>::new(unknown_node_id, NetworkID::Mainnet),
Err(CommonError::FailedToCreateAddressViaRetAddressFromNodeIdAndNetworkID {
node_id_as_hex: "deffffffffffffffffffffffffffffffffffffffffffffffffffffffffff".to_owned(),
network_id: NetworkID::Mainnet,
})
);
}
}