use alloc::{format, string::String, vec::Vec};
use core::fmt::{self, Debug, Display, Formatter};
use hex_fmt::HexFmt;
use crate::{
account::AccountHash,
bytesrepr::{self, Error, FromBytes, ToBytes},
URef, UREF_SERIALIZED_LENGTH,
};
const ACCOUNT_ID: u8 = 0;
const HASH_ID: u8 = 1;
const UREF_ID: u8 = 2;
pub const BLAKE2B_DIGEST_LENGTH: usize = 32;
pub const KEY_HASH_LENGTH: usize = 32;
const KEY_ID_SERIALIZED_LENGTH: usize = 1;
const KEY_HASH_SERIALIZED_LENGTH: usize = KEY_ID_SERIALIZED_LENGTH + KEY_HASH_LENGTH;
const KEY_UREF_SERIALIZED_LENGTH: usize = KEY_ID_SERIALIZED_LENGTH + UREF_SERIALIZED_LENGTH;
pub type HashAddr = [u8; KEY_HASH_LENGTH];
impl From<HashAddr> for Key {
fn from(addr: HashAddr) -> Self {
Key::Hash(addr)
}
}
pub type ContractHash = HashAddr;
pub type ContractWasmHash = HashAddr;
pub type ContractPackageHash = HashAddr;
#[repr(C)]
#[derive(PartialEq, Eq, Clone, Copy, PartialOrd, Ord, Hash)]
pub enum Key {
Account(AccountHash),
Hash(HashAddr),
URef(URef),
}
impl Key {
#[doc(hidden)]
pub fn type_string(&self) -> String {
match self {
Key::Account(_) => String::from("Key::Account"),
Key::Hash(_) => String::from("Key::Hash"),
Key::URef(_) => String::from("Key::URef"),
}
}
pub const fn max_serialized_length() -> usize {
KEY_UREF_SERIALIZED_LENGTH
}
pub fn normalize(self) -> Key {
match self {
Key::URef(uref) => Key::URef(uref.remove_access_rights()),
other => other,
}
}
pub fn as_string(&self) -> String {
match self {
Key::Account(account_hash) => format!(
"account-account_hash-{}",
base16::encode_lower(&account_hash.value())
),
Key::Hash(addr) => format!("hash-{}", base16::encode_lower(addr)),
Key::URef(uref) => uref.as_string(),
}
}
pub fn into_account(self) -> Option<AccountHash> {
match self {
Key::Account(bytes) => Some(bytes),
_ => None,
}
}
pub fn into_hash(self) -> Option<HashAddr> {
match self {
Key::Hash(hash) => Some(hash),
_ => None,
}
}
pub fn as_uref(&self) -> Option<&URef> {
match self {
Key::URef(uref) => Some(uref),
_ => None,
}
}
pub fn into_uref(self) -> Option<URef> {
match self {
Key::URef(uref) => Some(uref),
_ => None,
}
}
pub fn into_seed(self) -> [u8; BLAKE2B_DIGEST_LENGTH] {
match self {
Key::Account(account_hash) => account_hash.value(),
Key::Hash(bytes) => bytes,
Key::URef(uref) => uref.addr(),
}
}
}
impl Display for Key {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
match self {
Key::Account(account_hash) => write!(f, "Key::Account({})", account_hash),
Key::Hash(addr) => write!(f, "Key::Hash({})", HexFmt(addr)),
Key::URef(uref) => write!(f, "Key::{}", uref),
}
}
}
impl Debug for Key {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
write!(f, "{}", self)
}
}
impl From<URef> for Key {
fn from(uref: URef) -> Key {
Key::URef(uref)
}
}
impl From<AccountHash> for Key {
fn from(account_hash: AccountHash) -> Key {
Key::Account(account_hash)
}
}
impl ToBytes for Key {
fn to_bytes(&self) -> Result<Vec<u8>, Error> {
let mut result = bytesrepr::unchecked_allocate_buffer(self);
match self {
Key::Account(account_hash) => {
result.push(ACCOUNT_ID);
result.append(&mut account_hash.to_bytes()?);
}
Key::Hash(hash) => {
result.push(HASH_ID);
result.append(&mut hash.to_bytes()?);
}
Key::URef(uref) => {
result.push(UREF_ID);
result.append(&mut uref.to_bytes()?);
}
}
Ok(result)
}
fn serialized_length(&self) -> usize {
match self {
Key::Account(account_hash) => {
KEY_ID_SERIALIZED_LENGTH + account_hash.serialized_length()
}
Key::Hash(_) => KEY_HASH_SERIALIZED_LENGTH,
Key::URef(_) => KEY_UREF_SERIALIZED_LENGTH,
}
}
}
impl FromBytes for Key {
fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error> {
let (id, remainder) = u8::from_bytes(bytes)?;
match id {
ACCOUNT_ID => {
let (account_hash, rem) = AccountHash::from_bytes(remainder)?;
Ok((Key::Account(account_hash), rem))
}
HASH_ID => {
let (hash, rem) = <[u8; KEY_HASH_LENGTH]>::from_bytes(remainder)?;
Ok((Key::Hash(hash), rem))
}
UREF_ID => {
let (uref, rem) = URef::from_bytes(remainder)?;
Ok((Key::URef(uref), rem))
}
_ => Err(Error::Formatting),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{
bytesrepr::{Error, FromBytes},
AccessRights, URef,
};
fn test_readable(right: AccessRights, is_true: bool) {
assert_eq!(right.is_readable(), is_true)
}
#[test]
fn test_is_readable() {
test_readable(AccessRights::READ, true);
test_readable(AccessRights::READ_ADD, true);
test_readable(AccessRights::READ_WRITE, true);
test_readable(AccessRights::READ_ADD_WRITE, true);
test_readable(AccessRights::ADD, false);
test_readable(AccessRights::ADD_WRITE, false);
test_readable(AccessRights::WRITE, false);
}
fn test_writable(right: AccessRights, is_true: bool) {
assert_eq!(right.is_writeable(), is_true)
}
#[test]
fn test_is_writable() {
test_writable(AccessRights::WRITE, true);
test_writable(AccessRights::READ_WRITE, true);
test_writable(AccessRights::ADD_WRITE, true);
test_writable(AccessRights::READ, false);
test_writable(AccessRights::ADD, false);
test_writable(AccessRights::READ_ADD, false);
test_writable(AccessRights::READ_ADD_WRITE, true);
}
fn test_addable(right: AccessRights, is_true: bool) {
assert_eq!(right.is_addable(), is_true)
}
#[test]
fn test_is_addable() {
test_addable(AccessRights::ADD, true);
test_addable(AccessRights::READ_ADD, true);
test_addable(AccessRights::READ_WRITE, false);
test_addable(AccessRights::ADD_WRITE, true);
test_addable(AccessRights::READ, false);
test_addable(AccessRights::WRITE, false);
test_addable(AccessRights::READ_ADD_WRITE, true);
}
#[test]
fn should_display_key() {
let expected_hash = core::iter::repeat("0").take(64).collect::<String>();
let addr_array = [0u8; 32];
let account_hash = AccountHash::new(addr_array);
let account_key = Key::Account(account_hash);
assert_eq!(
format!("{}", account_key),
format!("Key::Account({})", expected_hash)
);
let uref_key = Key::URef(URef::new(addr_array, AccessRights::READ));
assert_eq!(
format!("{}", uref_key),
format!("Key::URef({}, READ)", expected_hash)
);
let hash_key = Key::Hash(addr_array);
assert_eq!(
format!("{}", hash_key),
format!("Key::Hash({})", expected_hash)
);
}
#[test]
fn abuse_vec_key() {
let bytes: Vec<u8> = vec![255, 255, 255, 255, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
let res: Result<(Vec<Key>, &[u8]), _> = FromBytes::from_bytes(&bytes);
#[cfg(target_os = "linux")]
assert_eq!(res.expect_err("should fail"), Error::OutOfMemory);
#[cfg(target_os = "macos")]
assert_eq!(res.expect_err("should fail"), Error::EarlyEndOfStream);
}
#[test]
fn check_key_account_getters() {
let account = [42; 32];
let account_hash = AccountHash::new(account);
let key1 = Key::Account(account_hash);
assert_eq!(key1.into_account(), Some(account_hash));
assert!(key1.into_hash().is_none());
assert!(key1.as_uref().is_none());
}
#[test]
fn check_key_hash_getters() {
let hash = [42; KEY_HASH_LENGTH];
let key1 = Key::Hash(hash);
assert!(key1.into_account().is_none());
assert_eq!(key1.into_hash(), Some(hash));
assert!(key1.as_uref().is_none());
}
#[test]
fn check_key_uref_getters() {
let uref = URef::new([42; 32], AccessRights::READ_ADD_WRITE);
let key1 = Key::URef(uref);
assert!(key1.into_account().is_none());
assert!(key1.into_hash().is_none());
assert_eq!(key1.as_uref(), Some(&uref));
}
#[test]
fn key_max_serialized_length() {
let key_account = Key::Account(AccountHash::new([42; BLAKE2B_DIGEST_LENGTH]));
assert!(key_account.serialized_length() <= Key::max_serialized_length());
let key_hash = Key::Hash([42; KEY_HASH_LENGTH]);
assert!(key_hash.serialized_length() <= Key::max_serialized_length());
let key_uref = Key::URef(URef::new([42; BLAKE2B_DIGEST_LENGTH], AccessRights::READ));
assert!(key_uref.serialized_length() <= Key::max_serialized_length());
}
}