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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
use crate::{Hash, Uint256, VarInt};
use encodings::{FromHex, FromHexError, ToHex};
use std::fmt;
use std::ops;

#[derive(Debug)]
pub enum BufferError {
    OutOfBounds,
    InvalidString(std::string::FromUtf8Error),
    NonMinimalVarInt,
}

impl From<std::string::FromUtf8Error> for BufferError {
    fn from(e: std::string::FromUtf8Error) -> Self {
        BufferError::InvalidString(e)
    }
}

impl fmt::Display for BufferError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            BufferError::OutOfBounds => write!(f, "Read Out of Bounds"),
            BufferError::InvalidString(ref e) => write!(f, "Invalid String {}", e),
            BufferError::NonMinimalVarInt => write!(f, "Non Minimal VarInt!"),
        }
    }
}

pub type Result<T> = std::result::Result<T, BufferError>;

//Our version of Buffer that is implemented in bio - > https://github.com/bcoin-org/bufio
#[derive(Default, PartialEq, Clone, Eq)]
pub struct Buffer {
    data: Vec<u8>,
    offset: usize,
}

impl Buffer {
    pub fn new() -> Self {
        Buffer::default()
    }

    //Accept anything that implements into buffer.
    // pub fn new_with() -> Self {

    // }

    //Unsigned Integers - Little Endian
    pub fn write_u8(&mut self, data: u8) {
        self.data.extend_from_slice(&data.to_le_bytes());
    }

    pub fn write_u16(&mut self, data: u16) {
        self.data.extend_from_slice(&data.to_le_bytes());
    }

    pub fn write_u32(&mut self, data: u32) {
        self.data.extend_from_slice(&data.to_le_bytes());
    }

    pub fn write_u64(&mut self, data: u64) {
        self.data.extend_from_slice(&data.to_le_bytes());
    }

    //TODO u128

    pub fn write_u256(&mut self, data: Uint256) {
        self.data.extend_from_slice(&data.to_le_bytes());
    }

    //Big Endian
    pub fn write_u8_be(&mut self, data: u8) {
        self.data.extend_from_slice(&data.to_be_bytes());
    }

    pub fn write_u16_be(&mut self, data: u16) {
        self.data.extend_from_slice(&data.to_be_bytes());
    }

    pub fn write_u32_be(&mut self, data: u32) {
        self.data.extend_from_slice(&data.to_be_bytes());
    }

    pub fn write_u64_be(&mut self, data: u64) {
        self.data.extend_from_slice(&data.to_be_bytes());
    }

    //TODO u128, and u256

    //Signed Integers
    pub fn write_i8(&mut self, data: u8) {
        self.data.extend_from_slice(&data.to_le_bytes());
    }

    pub fn write_i16(&mut self, data: u16) {
        self.data.extend_from_slice(&data.to_le_bytes());
    }

    pub fn write_i32(&mut self, data: u32) {
        self.data.extend_from_slice(&data.to_le_bytes());
    }

    pub fn write_i64(&mut self, data: u64) {
        self.data.extend_from_slice(&data.to_le_bytes());
    }

    //Big Endian
    pub fn write_i8_be(&mut self, data: u8) {
        self.data.extend_from_slice(&data.to_be_bytes());
    }

    pub fn write_i16_be(&mut self, data: u16) {
        self.data.extend_from_slice(&data.to_be_bytes());
    }

    pub fn write_i32_be(&mut self, data: u32) {
        self.data.extend_from_slice(&data.to_be_bytes());
    }

    pub fn write_i64_be(&mut self, data: u64) {
        self.data.extend_from_slice(&data.to_be_bytes());
    }

    pub fn write_bytes(&mut self, bytes: &[u8]) {
        //TODO should we clone here or just pass in
        self.data.extend_from_slice(bytes);
    }

    pub fn write_var_bytes(&mut self, bytes: &[u8]) {
        self.write_varint(bytes.len());

        if bytes.len() == 0 {
            return;
        }

        self.data.extend_from_slice(bytes);
    }

    pub fn write_str(&mut self, string: &str) {
        self.data.extend_from_slice(string.as_bytes());
    }

    pub fn write_string(&mut self, string: String) {
        self.data.extend_from_slice(string.as_bytes());
    }

    pub fn write_hash(&mut self, hash: Hash) {
        self.data.extend(&hash.to_array());
    }

    pub fn write_varint(&mut self, data: usize) {
        if data < 0xFD {
            self.write_u8(data as u8);
            return;
        }

        if data < 0xFFFF {
            self.write_u8(0xFD);
            self.write_u16(data as u16);
            return;
        }

        if data < 0xFFFFFFFF {
            self.write_u8(0xFE);
            self.write_u32(data as u32);
            return;
        }

        self.write_u8(0xFF);
        self.write_u64(data as u64);
    }

    pub fn fill(&mut self, value: u8, amount: usize) {
        //See what's faster, this or resize_with/resize TODO
        let fill_amount = vec![value; amount];
        self.data.extend(fill_amount);
    }

    pub fn extend(&mut self, buffer: Buffer) {
        self.data.extend_from_slice(&buffer);
    }

    pub fn extend_from_slice(&mut self, slice: &[u8]) {
        self.data.extend_from_slice(slice);
    }

    ////Return Hex string of the buffer, Consumes the Buffer
    pub fn into_hex(self) -> String {
        self.data.to_hex()
    }

    //Check for length
    pub fn check(&self, size: usize) -> Result<()> {
        if self.offset + size > self.data.len() {
            return Err(BufferError::OutOfBounds);
        }
        Ok(())
    }

    //These can probably all be macro'd out.
    pub fn read_u8(&mut self) -> Result<u8> {
        self.check(1)?;
        let result = self.data[self.offset];

        self.offset += 1;

        Ok(result)
    }

    pub fn read_u16(&mut self) -> Result<u16> {
        self.check(2)?;
        let range = self.offset..self.offset + 2;

        let mut buf = [0; 2];
        buf.copy_from_slice(&self.data[range]);

        let ret = u16::from_le_bytes(buf);

        self.offset += 2;

        Ok(ret)
    }

    //TODO do we see any need for reading u24s, 48s, etc?

    pub fn read_u32(&mut self) -> Result<u32> {
        self.check(4)?;
        let range = self.offset..self.offset + 4;

        let mut buf = [0; 4];
        buf.copy_from_slice(&self.data[range]);

        let ret = u32::from_le_bytes(buf);

        self.offset += 4;

        Ok(ret)
    }

    pub fn read_u64(&mut self) -> Result<u64> {
        self.check(8)?;
        let range = self.offset..self.offset + 8;

        let mut buf = [0; 8];
        buf.copy_from_slice(&self.data[range]);

        let ret = u64::from_le_bytes(buf);

        self.offset += 8;

        Ok(ret)
    }

    pub fn read_u256(&mut self) -> Result<Uint256> {
        self.check(32)?;

        let range = self.offset..self.offset + 32;
        let ret = Uint256::from_bytes(&self.data[range]);

        self.offset += 32;

        Ok(ret)
    }

    pub fn read_varint(&mut self) -> Result<VarInt> {
        let len = self.read_u8()?;

        match len {
            0xFF => {
                let num = self.read_u64()?;
                if num < 0x100000000 {
                    Err(BufferError::NonMinimalVarInt)
                } else {
                    Ok(VarInt::from(num))
                }
            }
            0xFE => {
                let num = self.read_u32()?;
                if num < 0x10000 {
                    Err(BufferError::NonMinimalVarInt)
                } else {
                    Ok(VarInt::from(num))
                }
            }
            0xFD => {
                let num = self.read_u16()?;
                if num < 0xFD {
                    Err(BufferError::NonMinimalVarInt)
                } else {
                    Ok(VarInt::from(num))
                }
            }

            len => Ok(VarInt::from(len)),
        }
    }

    pub fn read_string(&mut self, size: usize) -> Result<String> {
        self.check(size)?;

        let range = self.offset..self.offset + size;
        let ret = String::from_utf8(self.data[range].to_vec())?;

        self.offset += size;

        Ok(ret)
    }

    pub fn read_bytes(&mut self, size: usize) -> Result<Vec<u8>> {
        self.check(size)?;

        let range = self.offset..self.offset + size;
        let ret = self.data[range].to_vec();

        self.offset += size;

        Ok(ret)
    }

    pub fn read_var_bytes(&mut self) -> Result<Vec<u8>> {
        let length = self.read_varint()?;

        //TODO make an as_usize for varint.
        let size = length.as_u64() as usize;

        let range = self.offset..self.offset + size;
        let ret = self.data[range].to_vec();

        self.offset += size;

        Ok(ret)
    }

    pub fn read_hash(&mut self) -> Result<Hash> {
        self.check(32)?;

        let mut array = [0; 32];

        let range = self.offset..self.offset + 32;
        array.copy_from_slice(&self.data[range]);

        let hash = Hash::from(array);

        self.offset += 32;

        Ok(hash)
    }

    //Essentially shifts the offset to offset += off
    pub fn seek(&mut self, off: usize) -> Result<()> {
        self.check(off)?;

        self.offset += off;

        Ok(())
    }
}

impl From<Vec<u8>> for Buffer {
    fn from(buf: Vec<u8>) -> Self {
        Buffer {
            data: buf,
            offset: 0,
        }
    }
}

impl From<&[u8]> for Buffer {
    fn from(buf: &[u8]) -> Self {
        Buffer {
            data: buf.to_vec(),
            offset: 0,
        }
    }
}

//@todo commenting out for now. Not sure how we should implement this. FromStr technically should
//return an error, but writing a string to a Buffer will never error out. Also it might add some
//confusion as to whether we are creating the buffer from the raw string or from a hex string. So
//it might just be in our interest to not have these funcitons period.
//TODO review, seems inefficent
//impl From<&str> for Buffer {
//    fn from(buf: &str) -> Self {
//        Buffer {
//            data: buf.as_bytes().to_vec(),
//            offset: 0,
//        }
//    }
//}

////TODO review, seems inefficent
//impl From<String> for Buffer {
//    fn from(buf: String) -> Self {
//        Buffer {
//            data: buf.as_bytes().to_vec(),
//            offset: 0,
//        }
//    }
//}

//Allows us to grab specific bytes from the buffer e.g.
//grab the merkle tree from the middle of the buffer.
impl ops::Deref for Buffer {
    type Target = Vec<u8>;

    fn deref(&self) -> &Self::Target {
        &self.data
    }
}

//Allows us to grab specific bytes from the buffer e.g.
//grab the merkle tree from the middle of the buffer.
//Same as above, but allows us to grab those bytes and mutable, thus changing them without
//having to allocate more mem.
impl ops::DerefMut for Buffer {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.data
    }
}

//Allows Buffer to be used as a reference for a [u8] TODO double check this.
//And thoroughly comment for everyone
impl AsRef<[u8]> for Buffer {
    fn as_ref(&self) -> &[u8] {
        &self.data
    }
}

//Allows Buffer to be used as a mut for a [u8] TODO double check this.
//And thoroughly comment for everyone
impl AsMut<[u8]> for Buffer {
    fn as_mut(&mut self) -> &mut [u8] {
        &mut self.data
    }
}

impl FromHex for Buffer {
    type Error = FromHexError;

    fn from_hex<T: AsRef<[u8]>>(hex: T) -> std::result::Result<Self, Self::Error> {
        Ok(Buffer::from(Vec::from_hex(hex)?))
    }
}

impl ToHex for Buffer {
    fn to_hex(&self) -> String {
        self.data.to_hex()
    }
}

impl fmt::Display for Buffer {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Offset: {}, Buffer: {})",
            self.offset,
            self.data.to_hex(),
        )
    }
}

impl fmt::Debug for Buffer {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Offset: {}, Buffer: {})",
            self.offset,
            self.data.to_hex(),
        )
    }
}

#[cfg(feature = "serialization")]
impl serde::Serialize for Buffer {
    fn serialize<S: serde::Serializer>(&self, s: S) -> std::result::Result<S::Ok, S::Error> {
        if s.is_human_readable() {
            s.serialize_str(&self.to_hex())
        } else {
            s.serialize_bytes(&self[..])
        }
    }
}

#[cfg(feature = "serialization")]
impl<'de> serde::Deserialize<'de> for Buffer {
    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> std::result::Result<Buffer, D::Error> {
        if d.is_human_readable() {
            struct HexVisitor;

            impl<'de> serde::de::Visitor<'de> for HexVisitor {
                type Value = Buffer;

                fn expecting(&self, formatter: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
                    formatter.write_str("an ASCII hex string")
                }

                fn visit_bytes<E>(self, v: &[u8]) -> std::result::Result<Self::Value, E>
                where
                    E: ::serde::de::Error,
                {
                    if let Ok(hex) = ::std::str::from_utf8(v) {
                        Buffer::from_hex(hex).map_err(E::custom)
                    } else {
                        return Err(E::invalid_value(serde::de::Unexpected::Bytes(v), &self));
                    }
                }

                fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
                where
                    E: ::serde::de::Error,
                {
                    Buffer::from_hex(v).map_err(E::custom)
                }
            }

            d.deserialize_str(HexVisitor)
        } else {
            struct BytesVisitor;

            impl<'de> ::serde::de::Visitor<'de> for BytesVisitor {
                type Value = Buffer;

                fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                    formatter.write_str("a bytestring")
                }

                fn visit_bytes<E>(self, v: &[u8]) -> std::result::Result<Self::Value, E>
                where
                    E: ::serde::de::Error,
                {
                    Ok(Buffer::from(v))
                }
            }

            d.deserialize_bytes(BytesVisitor)
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_write_u32() {
        let version: u32 = 123456789;

        let mut buffer = Buffer::new();

        buffer.write_u32(version);

        assert_eq!(buffer, Buffer::from([21, 205, 91, 7].to_vec()));
    }

    // #[test]
    // fn test_write_hash() {
    //     let hash = Hash::from("bb42edce1895f9a969e81d7371ec113a0966e5d55035a84f87ca098e4f0a1a86");

    //     let mut buffer = Buffer::new();

    //     buffer.write_hash(hash);
    // }

    #[test]
    fn test_to_hex() {
        let version: u32 = 123456789;

        let mut buffer = Buffer::new();

        buffer.write_u32(version);

        assert_eq!(buffer, Buffer::from([21, 205, 91, 7].to_vec()));

        let hex = buffer.to_hex();

        assert_eq!(hex, "15cd5b07")
    }

    #[test]
    fn test_into_hex() {
        let version: u32 = 123456789;

        let mut buffer = Buffer::new();

        buffer.write_u32(version);

        assert_eq!(buffer, Buffer::from([21, 205, 91, 7].to_vec()));

        let hex = buffer.into_hex();

        assert_eq!(hex, "15cd5b07")
    }

    #[test]
    fn test_from_hex() {
        //@todo would really like to support this type of from/toHx.
        let mut buffer = Buffer::from_hex("FF00").unwrap();

        dbg!(&buffer);

        assert_eq!(buffer, Buffer::from(vec![255, 0]));
    }

    #[cfg(feature = "serialization")]
    #[test]
    fn test_serde() {
        use serde_test::{assert_tokens, Configure, Token};

        let version: u32 = 123456789;

        let mut buffer = Buffer::new();

        buffer.write_u32(version);

        static version_bytes: [u8; 4] = [21, 205, 91, 7];

        let buffer_readable = buffer.clone();

        assert_tokens(&buffer.compact(), &[Token::BorrowedBytes(&version_bytes)]);
        assert_tokens(&buffer_readable.readable(), &[Token::Str("15cd5b07")]);
    }
}