pezkuwi-subxt-core 0.44.0

// Copyright 2019-2024 Parity Technologies (UK) Ltd.
// This file is dual-licensed as Apache-2.0 or GPL-3.0.
// see LICENSE for license details.

//! The "default" Bizinikiwi/Pezkuwi AccountId. This is used in codegen, as well as signing related
//! bits. This doesn't contain much functionality itself, but is easy to convert to/from an
//! `sp_core::AccountId32` for instance, to gain functionality without forcing a dependency on
//! Bizinikiwi crates here.

use alloc::{format, string::String, vec, vec::Vec};
use codec::{Decode, Encode};
use serde::{Deserialize, Serialize};
use thiserror::Error as DeriveError;

/// A 32-byte cryptographic identifier. This is a simplified version of Bizinikiwi's
/// `sp_core::crypto::AccountId32`. To obtain more functionality, convert this into
/// that type.
#[derive(
	Clone,
	Eq,
	PartialEq,
	Ord,
	PartialOrd,
	Encode,
	Decode,
	Debug,
	scale_encode::EncodeAsType,
	scale_decode::DecodeAsType,
	scale_info::TypeInfo,
)]
pub struct AccountId32(pub [u8; 32]);

impl AsRef<[u8]> for AccountId32 {
	fn as_ref(&self) -> &[u8] {
		&self.0[..]
	}
}

impl AsRef<[u8; 32]> for AccountId32 {
	fn as_ref(&self) -> &[u8; 32] {
		&self.0
	}
}

impl From<[u8; 32]> for AccountId32 {
	fn from(x: [u8; 32]) -> Self {
		AccountId32(x)
	}
}

impl AccountId32 {
	// Return the ss58-check string for this key. Adapted from `sp_core::crypto`. We need this to
	// serialize our account appropriately but otherwise don't care.
	fn to_ss58check(&self) -> String {
		// For serializing to a string to obtain the account nonce, we use the default bizinikiwi
		// prefix (since we have no way to otherwise pick one). It doesn't really matter, since when
		// it's deserialized back in system_accountNextIndex, we ignore this (so long as it's
		// valid).
		const SUBSTRATE_SS58_PREFIX: u8 = 42;
		// prefix <= 63 just take up one byte at the start:
		let mut v = vec![SUBSTRATE_SS58_PREFIX];
		// then push the account ID bytes.
		v.extend(self.0);
		// then push a 2 byte checksum of what we have so far.
		let r = ss58hash(&v);
		v.extend(&r[0..2]);
		// then encode to base58.
		use base58::ToBase58;
		v.to_base58()
	}

	// This isn't strictly needed, but to give our AccountId32 a little more usefulness, we also
	// implement the logic needed to decode an AccountId32 from an SS58 encoded string. This is
	// exposed via a `FromStr` impl.
	fn from_ss58check(s: &str) -> Result<Self, FromSs58Error> {
		const CHECKSUM_LEN: usize = 2;
		let body_len = 32;

		use base58::FromBase58;
		let data = s.from_base58().map_err(|_| FromSs58Error::BadBase58)?;
		if data.len() < 2 {
			return Err(FromSs58Error::BadLength);
		}
		let prefix_len = match data[0] {
			0..=63 => 1,
			64..=127 => 2,
			_ => return Err(FromSs58Error::InvalidPrefix),
		};
		if data.len() != prefix_len + body_len + CHECKSUM_LEN {
			return Err(FromSs58Error::BadLength);
		}
		let hash = ss58hash(&data[0..body_len + prefix_len]);
		let checksum = &hash[0..CHECKSUM_LEN];
		if data[body_len + prefix_len..body_len + prefix_len + CHECKSUM_LEN] != *checksum {
			// Invalid checksum.
			return Err(FromSs58Error::InvalidChecksum);
		}

		let result = data[prefix_len..body_len + prefix_len]
			.try_into()
			.map_err(|_| FromSs58Error::BadLength)?;
		Ok(AccountId32(result))
	}
}

/// An error obtained from trying to interpret an SS58 encoded string into an AccountId32
#[derive(Clone, Copy, Eq, PartialEq, Debug, DeriveError)]
#[allow(missing_docs)]
pub enum FromSs58Error {
	#[error("Base 58 requirement is violated")]
	BadBase58,
	#[error("Length is bad")]
	BadLength,
	#[error("Invalid checksum")]
	InvalidChecksum,
	#[error("Invalid SS58 prefix byte.")]
	InvalidPrefix,
}

// We do this just to get a checksum to help verify the validity of the address in to_ss58check
fn ss58hash(data: &[u8]) -> Vec<u8> {
	use blake2::{Blake2b512, Digest};
	const PREFIX: &[u8] = b"SS58PRE";
	let mut ctx = Blake2b512::new();
	ctx.update(PREFIX);
	ctx.update(data);
	ctx.finalize().to_vec()
}

impl Serialize for AccountId32 {
	fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
	where
		S: serde::Serializer,
	{
		serializer.serialize_str(&self.to_ss58check())
	}
}

impl<'de> Deserialize<'de> for AccountId32 {
	fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
	where
		D: serde::Deserializer<'de>,
	{
		AccountId32::from_ss58check(&String::deserialize(deserializer)?)
			.map_err(|e| serde::de::Error::custom(format!("{e:?}")))
	}
}

impl core::fmt::Display for AccountId32 {
	fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
		write!(f, "{}", self.to_ss58check())
	}
}

impl core::str::FromStr for AccountId32 {
	type Err = FromSs58Error;
	fn from_str(s: &str) -> Result<Self, Self::Err> {
		AccountId32::from_ss58check(s)
	}
}

#[cfg(test)]
mod test {
	use super::*;
	use pezsp_core::{self, crypto::Ss58Codec};
	use pezsp_keyring::sr25519::Keyring;

	#[test]
	fn ss58_is_compatible_with_bizinikiwi_impl() {
		let keyrings = vec![Keyring::Alice, Keyring::Bob, Keyring::Charlie];

		for keyring in keyrings {
			let bizinikiwi_account = keyring.to_account_id();
			let local_account = AccountId32(bizinikiwi_account.clone().into());

			// Both should encode to ss58 the same way:
			let bizinikiwi_ss58 = bizinikiwi_account.to_ss58check();
			assert_eq!(bizinikiwi_ss58, local_account.to_ss58check());

			// Both should decode from ss58 back to the same:
			assert_eq!(
				pezsp_core::crypto::AccountId32::from_ss58check(&bizinikiwi_ss58).unwrap(),
				bizinikiwi_account
			);
			assert_eq!(AccountId32::from_ss58check(&bizinikiwi_ss58).unwrap(), local_account);
		}
	}
}