Derive Types

This patch adds a set of macros to derive types.json automatically. This is, all in all, a little complicated because the best way to analyze the code is through macros (since we can easily mark types that need to be exported) but macros, for obvious reasons, are run at compile-time and are not _meant_ to be side-effecty. That is, you can't easily just store a bunch of global data and when you're finished just emit it. Instead, we truncate and re-write a file-system temp file each time we encounter a new type and eventually we stop encountering new ones and we're good. We do this separately for each project in `scripts/build_types.json` since partial compilation and project-by-project compilation makes this even harder to do. We also need to clean and rebuild each time to ensure every macro is run. _Also_ there is some compile time slowness added here since I can't seem to remove the macros via features or other settings since this runs in the same layer as those types of tools. All-in-all, it's significantly fast enough and hopefully will make the process of updating our types.json trivial going forward.

Note: some of the code is pretty spaghetti in the derive code itself and can be upgraded over time. The issue is that there is a ton of possibilities that could occur in the syntax and we probably don't want to handle all of them.

The most complex one that we need to consider is `WIDTH` which, as a const, is not very easy to determine its value, so for now, we just use its value directly, since literals are fairly easy.

Note: the goal of `types-derive` is that it is generic and can be added to substrate's core, so we try to avoid "Gateway-specific" features in the code.

Author: hayesgm

.gitignore

@@ -42,3 +42,6 @@ releases
 # Chains
 chains/dev/*
 *.gateway_history
+
+# Backups
+*.bak

Cargo.lock

@@ -12,5 +12,6 @@ members = [
     'gateway-crypto',
     'ethereum-client',
     'test-utils/open-oracle-mock-reporter',
-    'trx-request'
+    'trx-request',
+    'types-derive',
 ]

Cargo.toml

@@ -21,6 +21,8 @@ sp-std = { default-features = false, git = 'https://github.com/compound-finance/
 
 our-std = { path = '../our-std', default-features = false }
 
+types-derive = { path = '../types-derive' }
+
 [features]
 default = ['std']
 std = [

ethereum-client/Cargo.toml

@@ -3,7 +3,9 @@ use codec::{Decode, Encode};
 use our_std::convert::TryInto;
 use our_std::RuntimeDebug;
 
-#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+use types_derive::Types;
+
+#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum EthereumEvent {
     Lock {
         asset: [u8; 20],

ethereum-client/src/events.rs

@@ -13,7 +13,9 @@ use our_std::RuntimeDebug;
 use serde::Deserialize;
 use sp_runtime::offchain::{http, Duration};
 
-#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+use types_derive::Types;
+
+#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum EthereumClientError {
     HttpIoError,
     HttpTimeout,
@@ -22,27 +24,27 @@ pub enum EthereumClientError {
     JsonParseError,
 }
 
-#[derive(Deserialize, RuntimeDebug, PartialEq)]
+#[derive(Deserialize, RuntimeDebug, PartialEq, Types)]
 pub struct ResponseError {
     pub message: Option<String>,
     pub code: Option<i64>,
 }
 
-#[derive(Deserialize, RuntimeDebug, PartialEq)]
+#[derive(Deserialize, RuntimeDebug, PartialEq, Types)]
 pub struct EventsResponse<T> {
     pub id: Option<u64>,
     pub result: Option<Vec<T>>,
     pub error: Option<ResponseError>,
 }
 
-#[derive(Deserialize, RuntimeDebug, PartialEq)]
+#[derive(Deserialize, RuntimeDebug, PartialEq, Types)]
 pub struct BlockResponse {
     pub id: Option<u64>,
     pub result: Option<String>,
     pub error: Option<ResponseError>,
 }
 
-#[derive(Deserialize, RuntimeDebug, PartialEq)]
+#[derive(Deserialize, RuntimeDebug, PartialEq, Types)]
 #[serde(rename_all = "camelCase")]
 pub struct LogObject {
     /// true when the log was removed, due to a chain reorganization. false if it's a valid log.

ethereum-client/src/lib.rs

@@ -46,6 +46,8 @@ gateway-crypto = { path = '../../gateway-crypto', default-features = false }
 trx-request = { path = '../../trx-request', default-features = false }
 our-std = { path = '../../our-std', default-features = false }
 
+types-derive = { path = '../../types-derive' }
+
 [dev-dependencies]
 frame-benchmarking = { git = 'https://github.com/compound-finance/substrate', branch = 'master'}
 serial_test = "*"

pallets/cash/Cargo.toml

@@ -9,9 +9,11 @@ use codec::{Decode, Encode};
 use gateway_crypto::public_key_bytes_to_eth_address;
 use our_std::{str::FromStr, Debuggable, Deserialize, RuntimeDebug, Serialize};
 
+use types_derive::{type_alias, Types};
+
 /// Type for representing the selection of a supported chain.
 #[derive(Serialize, Deserialize)] // used in config
-#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum ChainId {
     Gate,
     Eth,
@@ -99,7 +101,7 @@ impl Default for ChainId {
 }
 
 /// Type for an account tied to a chain.
-#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum ChainAccount {
     Gate(<Gateway as Chain>::Address),
     Eth(<Ethereum as Chain>::Address),
@@ -143,7 +145,7 @@ impl From<ChainAccount> for String {
 }
 
 /// Type for an asset tied to a chain.
-#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum ChainAsset {
     Gate(<Gateway as Chain>::Address),
     Eth(<Ethereum as Chain>::Address),
@@ -187,7 +189,7 @@ impl From<ChainAsset> for String {
 }
 
 /// Type for a signature and account tied to a chain.
-#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum ChainAccountSignature {
     Gate(<Gateway as Chain>::Address, <Gateway as Chain>::Signature),
     Eth(<Ethereum as Chain>::Address, <Ethereum as Chain>::Signature),
@@ -223,7 +225,7 @@ impl ChainAccountSignature {
 }
 
 /// Type for an hash tied to a chain.
-#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum ChainHash {
     Gate(<Gateway as Chain>::Hash),
     Eth(<Ethereum as Chain>::Hash),
@@ -233,7 +235,7 @@ pub enum ChainHash {
 }
 
 /// Type for a signature tied to a chain.
-#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum ChainSignature {
     Gate(<Gateway as Chain>::Signature),
     Eth(<Ethereum as Chain>::Signature),
@@ -262,7 +264,7 @@ impl ChainSignature {
 }
 
 /// Type for a list of chain signatures.
-#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum ChainSignatureList {
     Gate(Vec<(<Gateway as Chain>::Address, <Gateway as Chain>::Signature)>),
     Eth(Vec<(<Ethereum as Chain>::Address, <Ethereum as Chain>::Signature)>),
@@ -371,7 +373,34 @@ impl Chain for Gateway {
 impl Chain for Ethereum {
     const ID: ChainId = ChainId::Eth;
 
+    #[type_alias("Ethereum__Chain__")]
+    type Address = [u8; 20];
+
+    #[type_alias("Ethereum__Chain__")]
+    type Amount = u128;
+
+    #[type_alias("Ethereum__Chain__")]
+    type CashIndex = u128;
+
+    #[type_alias("Ethereum__Chain__")]
+    type Rate = u128;
+
+    #[type_alias("Ethereum__Chain__")]
+    type Timestamp = u64;
+
+    #[type_alias("Ethereum__Chain__")]
+    type Hash = [u8; 32];
+
+    #[type_alias("Ethereum__Chain__")]
+    type PublicKey = [u8; 64];
+
+    #[type_alias("Ethereum__Chain__")]
+    type Signature = [u8; 65];
+
+    #[type_alias("Ethereum__Chain__")]
     type EventId = eth::EventId;
+
+    #[type_alias("Ethereum__Chain__")]
     type Event = eth::Event;
 
     fn zero_hash() -> Self::Hash {
@@ -582,14 +611,20 @@ pub mod eth {
     use codec::{Decode, Encode};
     use our_std::RuntimeDebug;
 
+    use types_derive::type_alias;
+
     #[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
     pub enum RecoveryError {
         SignatureRecoveryError,
     }
 
+    #[type_alias("Eth__")]
     pub type BlockNumber = u64;
+
+    #[type_alias("Eth__")]
     pub type LogIndex = u64;
 
+    #[type_alias("Eth__")]
     pub type EventId = (BlockNumber, LogIndex);
 
     #[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]

pallets/cash/src/chains.rs

@@ -4,17 +4,20 @@ use crate::reason::Reason;
 use crate::types::SignersSet;
 use codec::alloc::string::String;
 use codec::{Decode, Encode};
+use ethereum_client::EthereumClientError;
 use our_std::{vec::Vec, RuntimeDebug};
 
+use types_derive::Types;
+
 extern crate ethereum_client;
 
-#[derive(RuntimeDebug)]
+#[derive(RuntimeDebug, Types)]
 pub struct EventInfo {
     pub latest_eth_block: u64,
     pub events: Vec<(ChainLogId, ChainLogEvent)>,
 }
 
-#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum ChainLogId {
     Eth(eth::BlockNumber, eth::LogIndex),
 }
@@ -29,7 +32,7 @@ impl ChainLogId {
     }
 }
 
-#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum ChainLogEvent {
     Eth(ethereum_client::EthereumLogEvent),
 }
@@ -47,7 +50,7 @@ impl ChainLogEvent {
 }
 
 /// Type for the status of an event on the queue.
-#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum EventState {
     Pending { signers: SignersSet },
     Failed { reason: Reason },
@@ -62,12 +65,12 @@ impl Default for EventState {
     }
 }
 
-#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug)]
+#[derive(Clone, Eq, PartialEq, Encode, Decode, RuntimeDebug, Types)]
 pub enum EventError {
     EthRpcUrlMissing,
     EthRpcUrlInvalid,
     StarportAddressInvalid,
-    EthereumClientError(ethereum_client::EthereumClientError),
+    EthereumClientError(EthereumClientError),
     ErrorDecodingHex,
 }
 

pallets/cash/src/events.rs

@@ -8,6 +8,8 @@ use crate::{
     types::{Decimals, Int, Uint},
 };
 
+use types_derive::Types;
+
 /// Type for wrapping intermediate signed calculations.
 pub struct BigInt(pub BigI);
 
@@ -92,7 +94,7 @@ impl BigUint {
 
 /// Type for an unsigned factor, with a large fixed number of decimals.
 #[derive(Serialize, Deserialize)] // used in config
-#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Encode, Decode, RuntimeDebug)]
+#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Encode, Decode, RuntimeDebug, Types)]
 pub struct Factor(pub Uint);
 
 impl Factor {

pallets/cash/src/factor.rs

@@ -12,7 +12,9 @@ use codec::{Decode, Encode};
 use frame_support::storage::StorageValue;
 use our_std::Debuggable;
 
-#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, Debuggable)]
+use types_derive::Types;
+
+#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, Debuggable, Types)]
 pub enum SetYieldNextError {
     TimestampTooSoonToNow,
     TimestampTooSoonToNext,

pallets/cash/src/internal/set_yield_next.rs

@@ -12,7 +12,9 @@ use frame_support::storage::{IterableStorageMap, StorageDoubleMap, StorageValue}
 use our_std::RuntimeDebug;
 use sp_runtime::transaction_validity::{TransactionSource, TransactionValidity, ValidTransaction};
 
-#[derive(Eq, PartialEq, RuntimeDebug)]
+use types_derive::Types;
+
+#[derive(Eq, PartialEq, RuntimeDebug, Types)]
 pub enum ValidationError {
     InvalidInternalOnly,
     InvalidNextCode,

pallets/cash/src/internal/validate_trx.rs

@@ -44,6 +44,7 @@ use pallet_oracle;
 use pallet_oracle::ticker::Ticker;
 use pallet_session;
 use pallet_timestamp;
+use types_derive::type_alias;
 
 #[macro_use]
 extern crate lazy_static;
@@ -74,6 +75,7 @@ pub mod benchmarking;
 mod tests;
 
 /// Type for linking sessions to validators.
+#[type_alias]
 pub type SubstrateId = AccountId32;
 
 /// Configure the pallet by specifying the parameters and types on which it depends.