Code refactoring and comments

CHANGELOG.md

@@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bump `subxt` to `0.32.0` - [#1352](https://github.com/paritytech/cargo-contract/pull/1352)
 - Remove check for compatible `scale` and `scale-info` versions - [#1370](https://github.com/paritytech/cargo-contract/pull/1370)
 - Add workspace support -[#1358](https://github.com/paritytech/cargo-contract/pull/1358)
-- Add `Storage Total Deposit` to `info` command output - [#1347](https://github.com/paritytech/cargo-contract/pull/1347)
+- Add dynamic types support - [#1399](https://github.com/paritytech/cargo-contract/pull/1399)
 
 ## [4.0.0-alpha]
 

crates/extrinsics/src/contract_info.rs

@@ -40,17 +40,6 @@ use subxt::{
     utils::AccountId32,
 };
 
-#[derive(DecodeAsType, Debug)]
-#[decode_as_type(crate_path = "subxt::ext::scale_decode")]
-struct AccountData {
-    pub free: Balance,
-    pub reserved: Balance,
-}
-
-#[derive(DecodeAsType, Debug)]
-#[decode_as_type(crate_path = "subxt::ext::scale_decode")]
-pub struct BoundedVec<T>(pub ::std::vec::Vec<T>);
-
 /// Return the account data for an account ID.
 async fn get_account_balance(
     account: &AccountId32,
@@ -68,24 +57,12 @@ async fn get_account_balance(
         .await?
         .ok_or_else(|| anyhow::anyhow!("Failed to fetch account data"))?;
 
-    #[derive(DecodeAsType, Debug)]
-    #[decode_as_type(crate_path = "subxt::ext::scale_decode")]
-    struct AccountInfo {
-        data: AccountData,
-    }
-
     let data = account.as_type::<AccountInfo>()?.data;
     Ok(data)
 }
 
 /// Decode the deposit account from the contract info
 fn get_deposit_account_id(contract_info: &DecodedValueThunk) -> Result<AccountId32> {
-    #[derive(DecodeAsType)]
-    #[decode_as_type(crate_path = "subxt::ext::scale_decode")]
-    struct DepositAccount {
-        deposit_account: AccountId32,
-    }
-
     let account = contract_info.as_type::<DepositAccount>()?;
     Ok(account.deposit_account)
 }
@@ -115,15 +92,6 @@ pub async fn fetch_contract_info(
             )
         })?;
 
-    #[derive(DecodeAsType, Debug)]
-    #[decode_as_type(crate_path = "subxt::ext::scale_decode")]
-    struct ContractInfoOf {
-        trie_id: BoundedVec<u8>,
-        code_hash: CodeHash,
-        storage_items: u32,
-        storage_item_deposit: Balance,
-    }
-
     // Pallet-contracts [>=10, <15] store the contract's deposit as a free balance
     // in a secondary account (deposit account). Other versions store it as
     // reserved balance on the main contract's account. If the
@@ -226,7 +194,7 @@ fn parse_contract_account_address(
         .map_err(|err| anyhow!("AccountId deserialization error: {}", err))
 }
 
-/// Fetch all contract addresses from the storage using the provided client
+/// Fetch all contract addresses from the storage using the provided client.
 pub async fn fetch_all_contracts(
     client: &Client,
     rpc: &LegacyRpcMethods<DefaultConfig>,
@@ -254,6 +222,43 @@ pub async fn fetch_all_contracts(
     Ok(contract_accounts)
 }
 
+/// A struct used in the storage reads to access account info.
+#[derive(DecodeAsType, Debug)]
+#[decode_as_type(crate_path = "subxt::ext::scale_decode")]
+struct AccountInfo {
+    data: AccountData,
+}
+
+/// A struct used in the storage reads to access account data.
+#[derive(Debug, DecodeAsType)]
+#[decode_as_type(crate_path = "subxt::ext::scale_decode")]
+struct AccountData {
+    pub free: Balance,
+    pub reserved: Balance,
+}
+
+/// A struct representing `Vec`` used in the storage reads.
+#[derive(Debug, DecodeAsType)]
+#[decode_as_type(crate_path = "subxt::ext::scale_decode")]
+struct BoundedVec<T>(pub ::std::vec::Vec<T>);
+
+/// A struct used in the storage reads to access contract info.
+#[derive(Debug, DecodeAsType)]
+#[decode_as_type(crate_path = "subxt::ext::scale_decode")]
+struct ContractInfoOf {
+    trie_id: BoundedVec<u8>,
+    code_hash: CodeHash,
+    storage_items: u32,
+    storage_item_deposit: Balance,
+}
+
+/// A struct used in storage reads to access the deposit account from contract info.
+#[derive(Debug, DecodeAsType)]
+#[decode_as_type(crate_path = "subxt::ext::scale_decode")]
+struct DepositAccount {
+    deposit_account: AccountId32,
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -267,7 +272,7 @@ mod tests {
         DecodeWithMetadata,
     };
 
-    /// Find the type index in the metadata.
+    // Find the type index in the metadata.
     fn get_metadata_type_index(
         ident: &'static str,
         module_path: &'static str,

crates/extrinsics/src/events.rs

@@ -48,6 +48,7 @@ use subxt::{
     Config,
 };
 
+/// A custom event emitted by the contract.
 #[derive(
     scale::Decode,
     scale::Encode,
@@ -57,7 +58,6 @@ use subxt::{
 )]
 #[decode_as_type(crate_path = "subxt::ext::scale_decode")]
 #[encode_as_type(crate_path = "subxt::ext::scale_encode")]
-/// A custom event emitted by the contract.
 pub struct ContractEmitted {
     pub contract: <DefaultConfig as Config>::AccountId,
     pub data: Vec<u8>,
@@ -90,6 +90,7 @@ impl StaticEvent for ContractInstantiated {
     const EVENT: &'static str = "Instantiated";
 }
 
+/// An event triggered by either the `instantiate_with_code` or the `upload_code` call.
 #[derive(
     Debug,
     scale::Decode,
@@ -109,6 +110,7 @@ impl StaticEvent for CodeStored {
     const EVENT: &'static str = "CodeStored";
 }
 
+/// An event triggered by the `remove_code` call.
 #[derive(
     Debug,
     scale::Decode,
@@ -151,7 +153,7 @@ impl Field {
     }
 }
 
-/// An event produced from from invoking a contract extrinsic.
+/// An event produced from invoking a contract extrinsic.
 #[derive(serde::Serialize)]
 pub struct Event {
     /// name of a pallet

crates/extrinsics/src/instantiate.rs

@@ -367,7 +367,6 @@ impl InstantiateExec {
         code: Vec<u8>,
         gas_limit: Weight,
     ) -> Result<InstantiateExecResult, ErrorVariant> {
-        // TODO: check if should be used unvalidated
         let call = subxt::tx::Payload::new(
             "Contracts",
             "instantiate_with_code",

crates/extrinsics/src/lib.rs

@@ -38,10 +38,6 @@ use contract_build::{
     CrateMetadata,
     DEFAULT_KEY_COL_WIDTH,
 };
-use pallet_contracts_primitives::{
-    ContractResult,
-    InstantiateReturnValue,
-};
 use scale::{
     Decode,
     Encode,
@@ -57,8 +53,6 @@ use subxt::{
 };
 use subxt_signer::sr25519::Keypair;
 
-use sp_runtime::DispatchError;
-
 pub use balance::{
     BalanceVariant,
     TokenMetadata,
@@ -113,13 +107,6 @@ pub type Client = OnlineClient<DefaultConfig>;
 pub type Balance = u128;
 pub type CodeHash = <DefaultConfig as Config>::Hash;
 
-/// Result type of a `bare_instantiate` call as well as `ContractsApi::instantiate`.
-pub type ContractInstantiateResult<AccountId, Balance, EventRecord> = ContractResult<
-    Result<InstantiateReturnValue<AccountId>, DispatchError>,
-    Balance,
-    EventRecord,
->;
-
 /// The Wasm code of a contract.
 #[derive(Debug)]
 pub struct WasmCode(Vec<u8>);

crates/extrinsics/src/remove.rs

@@ -145,7 +145,7 @@ impl RemoveCommandBuilder<state::ExtrinsicOptions> {
 }
 #[derive(scale_encode::EncodeAsType)]
 #[encode_as_type(crate_path = "subxt::ext::scale_encode")]
-struct RemoveCode {
+pub struct RemoveCode {
     code_hash: CodeHash,
 }