1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 /// Maximum block height that can be used in a `short_channel_id`. This
11 /// value is based on the 3-bytes available for block height.
12 pub const MAX_SCID_BLOCK: u64 = 0x00ffffff;
14 /// Maximum transaction index that can be used in a `short_channel_id`.
15 /// This value is based on the 3-bytes available for tx index.
16 pub const MAX_SCID_TX_INDEX: u64 = 0x00ffffff;
18 /// Maximum vout index that can be used in a `short_channel_id`. This
19 /// value is based on the 2-bytes available for the vout index.
20 pub const MAX_SCID_VOUT_INDEX: u64 = 0xffff;
22 /// A `short_channel_id` construction error
23 #[derive(Debug, PartialEq)]
24 pub enum ShortChannelIdError {
30 /// Extracts the block height (most significant 3-bytes) from the `short_channel_id`
31 pub fn block_from_scid(short_channel_id: &u64) -> u32 {
32 return (short_channel_id >> 40) as u32;
35 /// Constructs a `short_channel_id` using the components pieces. Results in an error
36 /// if the block height, tx index, or vout index overflow the maximum sizes.
37 pub fn scid_from_parts(block: u64, tx_index: u64, vout_index: u64) -> Result<u64, ShortChannelIdError> {
38 if block > MAX_SCID_BLOCK {
39 return Err(ShortChannelIdError::BlockOverflow);
42 if tx_index > MAX_SCID_TX_INDEX {
43 return Err(ShortChannelIdError::TxIndexOverflow);
46 if vout_index > MAX_SCID_VOUT_INDEX {
47 return Err(ShortChannelIdError::VoutIndexOverflow);
50 Ok((block << 40) | (tx_index << 16) | vout_index)
58 fn test_block_from_scid() {
59 assert_eq!(block_from_scid(&0x000000_000000_0000), 0);
60 assert_eq!(block_from_scid(&0x000001_000000_0000), 1);
61 assert_eq!(block_from_scid(&0x000001_ffffff_ffff), 1);
62 assert_eq!(block_from_scid(&0x800000_ffffff_ffff), 0x800000);
63 assert_eq!(block_from_scid(&0xffffff_ffffff_ffff), 0xffffff);
67 fn test_scid_from_parts() {
68 assert_eq!(scid_from_parts(0x00000000, 0x00000000, 0x0000).unwrap(), 0x000000_000000_0000);
69 assert_eq!(scid_from_parts(0x00000001, 0x00000002, 0x0003).unwrap(), 0x000001_000002_0003);
70 assert_eq!(scid_from_parts(0x00111111, 0x00222222, 0x3333).unwrap(), 0x111111_222222_3333);
71 assert_eq!(scid_from_parts(0x00ffffff, 0x00ffffff, 0xffff).unwrap(), 0xffffff_ffffff_ffff);
72 assert_eq!(scid_from_parts(0x01ffffff, 0x00000000, 0x0000).err().unwrap(), ShortChannelIdError::BlockOverflow);
73 assert_eq!(scid_from_parts(0x00000000, 0x01ffffff, 0x0000).err().unwrap(), ShortChannelIdError::TxIndexOverflow);
74 assert_eq!(scid_from_parts(0x00000000, 0x00000000, 0x010000).err().unwrap(), ShortChannelIdError::VoutIndexOverflow);