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
#![deny(
warnings,
clippy::all,
missing_debug_implementations,
missing_copy_implementations,
missing_docs,
missing_crate_level_docs,
missing_doc_code_examples,
non_ascii_idents,
unreachable_pub
)]
#![doc(test(attr(deny(warnings))))]
#![doc(html_root_url = "https://docs.rs/ripple-address-codec/0.1.1")]
use std::{convert::TryInto, result};
use base_x;
use ring::digest::{digest, SHA256};
mod error;
pub use self::error::{Error, Error::DecodeError};
pub use self::Algorithm::{Ed25519, Secp256k1};
const ALPHABET: &str = "rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz";
const CHECKSUM_LENGTH: usize = 4;
const ENTROPY_LEN: usize = 16;
pub type Entropy = [u8; ENTROPY_LEN];
pub type Result<T> = result::Result<T, Error>;
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Algorithm {
Secp256k1,
Ed25519,
}
impl Default for Algorithm {
fn default() -> Self {
Self::Secp256k1
}
}
pub fn encode_seed(entropy: &Entropy, algorithm: &Algorithm) -> String {
let prefix = match algorithm {
Secp256k1 => SeedSecP256K1.prefix(),
Ed25519 => SeedEd25519.prefix(),
};
encode_bytes_with_prefix(prefix, entropy)
}
pub fn decode_seed(seed: &str) -> Result<(Entropy, &'static Algorithm)> {
decode_seed_secp256k1(seed).or(decode_seed_ed25519(seed))
}
pub fn encode_account_id(bytes: &[u8; Address::PAYLOAD_LEN]) -> String {
encode_bytes_with_prefix(Address.prefix(), bytes)
}
pub fn decode_account_id(account_id: &str) -> Result<[u8; Address::PAYLOAD_LEN]> {
let decoded_bytes = decode_with_xrp_alphabet(account_id)?;
let payload = get_payload(decoded_bytes, Address)?;
Ok(payload.try_into().unwrap())
}
trait Settings {
const PAYLOAD_LEN: usize;
const PREFIX: &'static [u8] = &[];
fn prefix(&self) -> &'static [u8] {
Self::PREFIX
}
fn prefix_len(&self) -> usize {
Self::PREFIX.len()
}
fn payload_len(&self) -> usize {
Self::PAYLOAD_LEN
}
}
struct Address;
impl Settings for Address {
const PREFIX: &'static [u8] = &[0x00];
const PAYLOAD_LEN: usize = 20;
}
struct SeedSecP256K1;
impl SeedSecP256K1 {
const ALG: Algorithm = Secp256k1;
}
impl Settings for SeedSecP256K1 {
const PREFIX: &'static [u8] = &[0x21];
const PAYLOAD_LEN: usize = ENTROPY_LEN;
}
struct SeedEd25519;
impl SeedEd25519 {
const ALG: Algorithm = Ed25519;
}
impl Settings for SeedEd25519 {
const PREFIX: &'static [u8] = &[0x01, 0xE1, 0x4B];
const PAYLOAD_LEN: usize = ENTROPY_LEN;
}
fn decode_seed_secp256k1(s: &str) -> Result<(Entropy, &'static Algorithm)> {
let decoded_bytes = decode_with_xrp_alphabet(s)?;
let payload = get_payload(decoded_bytes, SeedSecP256K1)?;
Ok((payload.try_into().unwrap(), &SeedSecP256K1::ALG))
}
fn decode_seed_ed25519(s: &str) -> Result<(Entropy, &'static Algorithm)> {
let decoded_bytes = decode_with_xrp_alphabet(s)?;
let payload = get_payload(decoded_bytes, SeedEd25519)?;
Ok((payload.try_into().unwrap(), &SeedEd25519::ALG))
}
fn encode_bytes_with_prefix(prefix: &[u8], bytes: &[u8]) -> String {
encode_bytes(&[prefix, bytes].concat())
}
fn encode_bytes(bytes: &[u8]) -> String {
let checked_bytes = [bytes, &calc_checksum(bytes)].concat();
base_x::encode(ALPHABET, &checked_bytes)
}
fn decode_with_xrp_alphabet(s: &str) -> Result<Vec<u8>> {
Ok(base_x::decode(ALPHABET, s)?)
}
fn get_payload(bytes: Vec<u8>, settings: impl Settings) -> Result<Vec<u8>> {
verify_payload_len(&bytes, settings.prefix_len(), settings.payload_len())?;
verify_prefix(settings.prefix(), &bytes)?;
let checked_bytes = get_checked_bytes(bytes)?;
Ok(checked_bytes[settings.prefix_len()..].try_into().unwrap())
}
fn verify_prefix(prefix: &[u8], bytes: &[u8]) -> Result<()> {
if bytes.starts_with(prefix) {
return Ok(());
}
Err(DecodeError)
}
fn verify_payload_len(bytes: &[u8], prefix_len: usize, expected_len: usize) -> Result<()> {
if bytes[prefix_len..bytes.len() - CHECKSUM_LENGTH].len() == expected_len {
return Ok(());
}
Err(DecodeError)
}
fn get_checked_bytes(mut bytes_with_checksum: Vec<u8>) -> Result<Vec<u8>> {
verify_checksum_lenght(&bytes_with_checksum)?;
let checksum = bytes_with_checksum.split_off(bytes_with_checksum.len() - CHECKSUM_LENGTH);
let bytes = bytes_with_checksum;
verify_checksum(&bytes, &checksum)?;
Ok(bytes)
}
fn verify_checksum(input: &[u8], checksum: &[u8]) -> Result<()> {
if calc_checksum(input) == checksum {
Ok(())
} else {
Err(DecodeError)
}
}
fn verify_checksum_lenght(bytes: &[u8]) -> Result<()> {
let len = bytes.len();
if len < CHECKSUM_LENGTH + 1 {
return Err(DecodeError);
}
Ok(())
}
fn calc_checksum(bytes: &[u8]) -> [u8; CHECKSUM_LENGTH] {
sha256_digest(&sha256_digest(bytes))[..CHECKSUM_LENGTH]
.try_into()
.unwrap()
}
fn sha256_digest(data: &[u8]) -> Vec<u8> {
digest(&SHA256, data).as_ref().to_vec()
}