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
use super::hrpset::HrpSet;
use crate::address::errors::AddressBech32EncodeError;
use crate::network::NetworkDefinition;
use crate::types::EntityType;
use bech32::{self, ToBase32, Variant, WriteBase32};
use sbor::rust::prelude::*;
/// Represents an encoder which understands how to encode Scrypto addresses in Bech32.
#[derive(Debug)]
pub struct AddressBech32Encoder {
pub hrp_set: HrpSet,
}
impl AddressBech32Encoder {
pub fn for_simulator() -> Self {
Self::new(&NetworkDefinition::simulator())
}
/// Instantiates a new AddressBech32Encoder with the HRP corresponding to the passed network.
pub fn new(network: &NetworkDefinition) -> Self {
Self {
hrp_set: network.into(),
}
}
pub fn encode(&self, full_data: &[u8]) -> Result<String, AddressBech32EncodeError> {
let mut buf = String::new();
self.encode_to_fmt(&mut buf, full_data)?;
Ok(buf)
}
/// Low level method which performs the Bech32 encoding of the data.
pub fn encode_to_fmt<F: fmt::Write>(
&self,
fmt: &mut F,
full_data: &[u8],
) -> Result<(), AddressBech32EncodeError> {
// Decode the entity type
let entity_type = EntityType::from_repr(
*full_data
.get(0)
.ok_or(AddressBech32EncodeError::MissingEntityTypeByte)?,
)
.ok_or_else(|| AddressBech32EncodeError::InvalidEntityTypeId(full_data[0]))?;
// Obtain the HRP corresponding to this entity type
let hrp = self.hrp_set.get_entity_hrp(&entity_type);
match bech32_encode_to_fmt(fmt, hrp, full_data.to_base32(), Variant::Bech32m) {
Ok(Ok(())) => Ok(()),
Ok(Err(format_error)) => Err(AddressBech32EncodeError::FormatError(format_error)),
Err(encoding_error) => Err(AddressBech32EncodeError::Bech32mEncodingError(
encoding_error,
)),
}
}
}
/**
* NOTE:
* The below code is copied with minor alterations from the bech32 crate.
* These alterations are to avoid using std for allocations, and fit with the sbor no-alloc options.
*
* The original source for the bech32 crate is under MIT license: https://crates.io/crates/bech32
* This license permits modification without restriction, but requires the license copying below.
*
* Important additional note - the use of this modified code is also covered under the Radix license,
* as per all code in this repository.
*
* -----------------
*
* MIT License
*
* Copyright (c) [year] [fullname]
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/// Encode a bech32 payload to an [fmt::Write].
/// This method is intended for implementing traits from [std::fmt].
/// This method uses the std::fmt traits
///
/// # Errors
/// * If [check_hrp] returns an error for the given HRP.
/// # Deviations from standard
/// * No length limits are enforced for the data part
pub fn bech32_encode_to_fmt<F: fmt::Write, T: AsRef<[bech32::u5]>>(
fmt: &mut F,
hrp: &str,
data: T,
variant: Variant,
) -> Result<fmt::Result, bech32::Error> {
let hrp_lower = match bech32_check_hrp(hrp)? {
Bech32Case::Upper => Cow::Owned(hrp.to_lowercase()),
Bech32Case::Lower | Bech32Case::None => Cow::Borrowed(hrp),
};
match bech32::Bech32Writer::new(&hrp_lower, variant, fmt) {
Ok(mut writer) => {
Ok(writer.write(data.as_ref()).and_then(|_| {
// Finalize manually to avoid panic on drop if write fails
writer.finalize()
}))
}
Err(e) => Ok(Err(e)),
}
}
/// Check if the HRP is valid. Returns the case of the HRP, if any.
///
/// # Errors
/// * **MixedCase**: If the HRP contains both uppercase and lowercase characters.
/// * **InvalidChar**: If the HRP contains any non-ASCII characters (outside 33..=126).
/// * **InvalidLength**: If the HRP is outside 1..83 characters long.
fn bech32_check_hrp(hrp: &str) -> Result<Bech32Case, bech32::Error> {
if hrp.is_empty() || hrp.len() > 83 {
return Err(bech32::Error::InvalidLength);
}
let mut has_lower: bool = false;
let mut has_upper: bool = false;
for b in hrp.bytes() {
// Valid subset of ASCII
if !(33..=126).contains(&b) {
return Err(bech32::Error::InvalidChar(b as char));
}
if (b'a'..=b'z').contains(&b) {
has_lower = true;
} else if (b'A'..=b'Z').contains(&b) {
has_upper = true;
};
if has_lower && has_upper {
return Err(bech32::Error::MixedCase);
}
}
Ok(match (has_upper, has_lower) {
(true, false) => Bech32Case::Upper,
(false, true) => Bech32Case::Lower,
(false, false) => Bech32Case::None,
(true, true) => unreachable!(),
})
}
#[derive(Clone, Copy, PartialEq, Eq)]
enum Bech32Case {
Upper,
Lower,
None,
}