substrate-abi 0.3.7

#![cfg_attr(not(feature = "std"), no_std)]

use codec::{Decode, Encode};
use error::Error;
use sp_core::U256;
use sp_runtime::traits::Convert;
use sp_std::marker::PhantomData;
use sp_std::prelude::*;
use sp_std::vec;

/// Global XBI Types.
pub type Data = Vec<u8>;

/// A representation of an Asset Id, this is utilised for xbi instructions relating to multiple assets
pub type AssetId = u32;
pub type Gas = u64;
pub type AccountId32 = sp_runtime::AccountId32;
pub type AccountId20 = sp_core::H160;

pub type Value32 = u32;
pub type Value64 = u64;
pub type Value128 = u128;
pub type Value256 = U256;

pub type Value = Value128;
pub type ValueEvm = Value256;

pub mod error;

pub enum ValueLen {
    U32,
    U64,
    U128,
    U256,
}

/// Extensible conversion trait. Generic over only source type, with destination type being
/// associated.
/// This being associated over outcome allows us to implement for any Type over some provider struct,
/// allowing us to minimise the need for newtypes if using `TryFrom`.
pub trait TryConvert<A> {
    /// The type into which `A` is mutated.
    type Outcome;

    /// Make conversion.
    fn try_convert(a: A) -> Self::Outcome;
}

/// Provide the required data type conversions for a converter to be marked as a `SubstrateAbi`.
pub trait SubstrateAbi:
    TryConvert<(AccountId20, [u8; 12]), Outcome = Result<AccountId32, Error>>
    + TryConvert<AccountId32, Outcome = Result<AccountId20, Error>>
    + Convert<u32, u64>
    + Convert<u32, u128>
    + Convert<u32, U256>
    + Convert<u64, u32>
    + Convert<u64, u128>
    + Convert<u64, U256>
    + Convert<u128, u32>
    + Convert<u128, u64>
    + Convert<u128, U256>
{
}

/// Providing access to the SubstrateAbi
pub struct SubstrateAbiConverter;

impl TryConvert<(AccountId20, [u8; 12])> for SubstrateAbiConverter {
    type Outcome = Result<AccountId32, Error>;

    /// Convert an `AccountId20` to an `AccountId32`. Providing some buffer for the extra bytes to fill.
    fn try_convert(value: (AccountId20, [u8; 12])) -> Self::Outcome {
        let mut dest_bytes: Vec<u8> = vec![];
        dest_bytes.append(&mut value.0.encode());
        dest_bytes.append(&mut value.1.encode());

        Decode::decode(&mut dest_bytes.as_slice())
            .map_err(|_e| Error::FailedToCastBetweenTypesValue)
    }
}

impl TryConvert<AccountId32> for SubstrateAbiConverter {
    type Outcome = Result<AccountId20, Error>;

    /// Convert an `AccountId32` to an `AccountId20`, taking the short hash of the first 20 bytes.
    fn try_convert(account_32: AccountId32) -> Self::Outcome {
        let mut dest_bytes: Vec<u8> = vec![];
        let account_32_encoded = account_32.encode(); // FIXME: ensure len is not provided here

        dest_bytes.append(&mut account_32_encoded[..20].to_vec());

        Decode::decode(&mut dest_bytes.as_slice())
            .map_err(|_e| Error::FailedToCastBetweenTypesValue)
    }
}

/// Try to associate a value to some associated type, as long as they are each part of `Codec`.
pub fn associate<T: Decode, U: Encode>(value: U) -> Result<T, Error> {
    Decode::decode(&mut &value.encode()[..]).map_err(|_| Error::FailedToAssociateTypes)
}

/// A representation of a morphism from T to O. This provides some metadata so we can have a single
/// blanket implementation of some T to Some O where Self has some way of converting the morphism.
pub struct ValueMorphism<T, O> {
    pub to_morph: T,
    pub output: PhantomData<O>,
}

impl<T, O> ValueMorphism<T, O> {
    pub fn new(to_morph: T) -> Self {
        ValueMorphism {
            to_morph,
            output: Default::default(),
        }
    }
}

impl<T, O> From<T> for ValueMorphism<T, O> {
    fn from(value: T) -> Self {
        ValueMorphism::new(value)
    }
}

/// Morph some bytes into `O` as long as `O` can be converted into.
impl<O> TryConvert<ValueMorphism<&mut &[u8], O>> for SubstrateAbiConverter
where
    SubstrateAbiConverter: Convert<u32, O>,
    SubstrateAbiConverter: Convert<u64, O>,
    SubstrateAbiConverter: Convert<u128, O>,
    SubstrateAbiConverter: Convert<U256, O>,
{
    type Outcome = Result<O, Error>;

    fn try_convert(a: ValueMorphism<&mut &[u8], O>) -> Self::Outcome {
        match a.to_morph.len() {
            4 => {
                let val: Result<Value32, Error> =
                    Decode::decode(a.to_morph).map_err(|_| Error::FailedToCastBetweenTypesValue);
                val.map(Self::convert)
            }
            8 => {
                let val: Result<Value64, Error> =
                    Decode::decode(a.to_morph).map_err(|_| Error::FailedToCastBetweenTypesValue);
                val.map(Self::convert)
            }
            16 => {
                let val: Result<Value128, Error> =
                    Decode::decode(a.to_morph).map_err(|_| Error::FailedToCastBetweenTypesValue);
                val.map(Self::convert)
            }
            32 => {
                let val: Result<Value256, Error> =
                    Decode::decode(a.to_morph).map_err(|_| Error::FailedToCastBetweenTypesValue);
                val.map(Self::convert)
            }
            _ => Err(Error::FailedToCastBetweenTypesValue),
        }
    }
}

/// Morph some bytes into `Option<O>` as long as `O` can be converted into, and the bytes representation
/// of `Some<O>` exists.
impl<O> TryConvert<ValueMorphism<&mut &[u8], Option<O>>> for SubstrateAbiConverter
where
    SubstrateAbiConverter: Convert<u32, O>,
    SubstrateAbiConverter: Convert<u64, O>,
    SubstrateAbiConverter: Convert<u128, O>,
    SubstrateAbiConverter: Convert<U256, O>,
    SubstrateAbiConverter: Convert<U256, O>,
{
    type Outcome = Result<Option<O>, Error>;

    fn try_convert(a: ValueMorphism<&mut &[u8], Option<O>>) -> Self::Outcome {
        match a.to_morph.len() {
            1 => Ok(None),
            5 => {
                let val: Result<Value32, Error> =
                    Decode::decode(a.to_morph).map_err(|_| Error::FailedToCastBetweenTypesValue);
                val.map(Self::convert).map(|o| Some(o))
            }
            9 => {
                let val: Result<Value64, Error> =
                    Decode::decode(a.to_morph).map_err(|_| Error::FailedToCastBetweenTypesValue);
                val.map(Self::convert).map(|o| Some(o))
            }
            17 => {
                let val: Result<Value128, Error> =
                    Decode::decode(a.to_morph).map_err(|_| Error::FailedToCastBetweenTypesValue);
                val.map(Self::convert).map(|o| Some(o))
            }
            33 => {
                let val: Result<Value256, Error> =
                    Decode::decode(a.to_morph).map_err(|_| Error::FailedToCastBetweenTypesValue);
                val.map(Self::convert).map(|o| Some(o))
            }
            _ => Err(Error::FailedToCastBetweenTypesValue),
        }
    }
}

/// Identity conversion for types to ensure `O` -> `O` conversions in blanket implementations.
impl<T> Convert<T, T> for SubstrateAbiConverter {
    fn convert(a: T) -> T {
        a
    }
}

/// Convert a load of types, short circuitting on overflows.
/// This might change to utilise saturation instead.
impl Convert<u32, u64> for SubstrateAbiConverter {
    fn convert(a: u32) -> u64 {
        a as u64
    }
}

impl Convert<u32, u128> for SubstrateAbiConverter {
    fn convert(a: u32) -> u128 {
        a as u128
    }
}

impl Convert<u32, U256> for SubstrateAbiConverter {
    fn convert(a: u32) -> U256 {
        U256::from(a)
    }
}

impl Convert<u64, u32> for SubstrateAbiConverter {
    fn convert(a: u64) -> u32 {
        a as u32
    }
}

impl Convert<u64, u128> for SubstrateAbiConverter {
    fn convert(a: u64) -> u128 {
        a as u128
    }
}

impl Convert<u64, U256> for SubstrateAbiConverter {
    fn convert(a: u64) -> U256 {
        U256::from(a)
    }
}

impl Convert<u128, u32> for SubstrateAbiConverter {
    fn convert(a: u128) -> u32 {
        a as u32
    }
}

impl Convert<u128, u64> for SubstrateAbiConverter {
    fn convert(a: u128) -> u64 {
        a as u64
    }
}

impl Convert<u128, U256> for SubstrateAbiConverter {
    fn convert(a: u128) -> U256 {
        U256::from(a)
    }
}

impl Convert<U256, u32> for SubstrateAbiConverter {
    fn convert(a: U256) -> u32 {
        a.as_u32()
    }
}

impl Convert<U256, u64> for SubstrateAbiConverter {
    fn convert(a: U256) -> u64 {
        a.as_u64()
    }
}

impl Convert<U256, u128> for SubstrateAbiConverter {
    fn convert(a: U256) -> u128 {
        a.as_u128()
    }
}

impl SubstrateAbi for SubstrateAbiConverter {}

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

    #[test]
    fn sabi_decodes_u128_to_target_values_correctly() {
        let input_val: u128 = 88;
        let output_256: U256 = SubstrateAbiConverter::convert(input_val);
        assert_eq!(output_256, U256::from(input_val));
    }

    #[test]
    fn convert_account_id_20_to_32() {
        let original_account = AccountId20::repeat_byte(1u8);
        let padding = [4_u8; 12];
        let origin_source: AccountId32 =
            SubstrateAbiConverter::try_convert((original_account, padding)).unwrap();
        assert_eq!(
            origin_source,
            AccountId32::from([
                1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // original
                4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, // padding
            ])
        )
    }

    #[test]
    fn convert_account_id_32_to_20() {
        let original_account = AccountId32::new([1u8; 32]);
        let origin_source: AccountId20 =
            SubstrateAbiConverter::try_convert(original_account).unwrap();
        assert_eq!(origin_source, AccountId20::repeat_byte(1_u8))
    }

    #[test]
    fn try_convert_u32_to_everything() {
        let value = 563_u32;

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u32>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u64>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value as u64);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u128>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value as u128);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, U256>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, U256::from(value));
    }

    #[test]
    fn try_convert_u64_to_everything() {
        let value = 563324_u64;

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u32>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value as u32);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u64>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u128>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value as u128);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, U256>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, U256::from(value));
    }

    #[test]
    fn try_convert_u128_to_everything() {
        let value = 563321231232134_u128;

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u32>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value as u32);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u64>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value as u64);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u128>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, U256>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, U256::from(value));
    }

    #[test]
    fn try_convert_u256_to_everything_that_is_within_range() {
        let value = U256::from(563321231232134_u128);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u64>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value.low_u64());

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u128>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value.low_u128());

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, U256>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value);
    }

    #[test]
    #[should_panic] // TODO: do we want to use `.as` for u256 casts? this would silently fail though.
    fn try_convert_u256_panic_overflow() {
        let value = U256::from(563321231232134_u128);

        let next = SubstrateAbiConverter::try_convert(ValueMorphism::<_, u32>::new(
            &mut &value.encode()[..],
        ))
        .unwrap();
        assert_eq!(next, value.low_u32());
    }
}