comments v1

Author: jobyreuben

pallets/contracts/src/benchmarking/mod.rs

@@ -399,7 +399,10 @@ benchmarks! {
 // contract has the full value
 assert_eq!(T::ContractCurrency::free_balance(&addr), value + Pallet::<T>::min_balance());
 }
-
+
+
+// We construct two unique contracts (with input and salt as instantiate benchmark) (PoCS)
+// The primary contract is assigned a mock stake to pass delegate criteria
 #[pov_mode = Measured]
 delegate {
 let c in 0 .. T::MaxCodeLen::get();
@@ -422,6 +425,7 @@ benchmarks! {
 }: _(origin,contract_addr.clone(),delegate_to.clone())
 verify{
 let delegate_info = <DelegateInfo<T>>::get(&contract_addr)?;
+// We assert if the delegate information has been updated
 assert_eq!(delegate_info.delegate_to(),delegate_to)
 }
 

pallets/contracts/src/exec.rs

@@ -947,7 +947,7 @@ where
 );
 },
 }
-// Initiate Stake
+// Initiate Stake (PoCS)
 StakeRequest::<T>::stake(&caller, &account_id, &gas)?;
 
 Ok(output)
@@ -1283,6 +1283,7 @@ where
 beneficiary: beneficiary.clone(),
 },
 );
+// Delete Stake (PoCS)
 StakeRequest::<T>::delete(&frame.account_id);
 Ok(())
 }

pallets/contracts/src/lib.rs

@@ -74,7 +74,7 @@
 //! calls its constructor to initialize the contract.
 //! * [`Pallet::instantiate`] - The same as `instantiate_with_code` but instead of uploading new
 //! code an existing `code_hash` is supplied.
-//! * [`Pallet::update_delegate`] - Updates the delegate information of the contract. (PoCS)
+//! * [`Pallet::delegate`] - Updates the stake-delegate information of the contract. (PoCS)
 //! * [`Pallet::call`] - Makes a call to an account, optionally transferring some balance.
 //! * [`Pallet::upload_code`] - Uploads new code without instantiating a contract from it.
 //! * [`Pallet::remove_code`] - Removes the stored code and refunds the deposit to its owner. Only
@@ -695,7 +695,6 @@ use stake::{DelegateRequest, ValidateRequest};
 /// - If the `code_hash` already exists on the chain the underlying `code` will be shared.
 /// - The destination address is computed based on the sender, code_hash and the salt.
 /// - The smart-contract account is created at the computed address.
-/// - The [`gasstakeinfo::AccountStakeinfo`] and [`gasstakeinfo::ContractScarcityinfo`] values are set to default to contract address (PoCS)
 /// - The `value` is transferred to the new account.
 /// - The `deploy` function is executed in the context of the newly-created account.
 #[pallet::call_index(7)]
@@ -917,18 +916,29 @@ use stake::{DelegateRequest, ValidateRequest};
 code_hash: CodeHash<T>,
 },
 
-// PoCS
+/// Stake Score is updated for a contract (PoCS)
 Staked {
+/// The contract address for which stake information is updated
 contract: T::AccountId,
+/// The contract's associated stake score
 stake_score: u128,
 },
+
+/// Delegate Information is updated for a contract via [`Pallet::delegate`] (PoCS) 
 Delegated {
+/// The contract address for which delegate information is updated by its owner
 contract: T::AccountId,
+/// The contract delegated to which account address i.e., the validator
 delegate_to: T::AccountId,
 },
+
+/// Validator validation criteria information as event (PoCS)
 ValidateInfo {
+/// The validator's account address i.e., a contract address
 validator: T::AccountId,
+/// Number of delegates which the validator can utilize for validation
 num_delegates: u32,
+/// Provides Assurance if the validator can start validating
 can_validate: bool
 }
 
@@ -940,17 +950,27 @@ use stake::{DelegateRequest, ValidateRequest};
 InvalidSchedule,
 /// Invalid combination of flags supplied to `seal_call` or `seal_delegate_call`.
 InvalidCallFlags,
-/// PoCS
+/// Invalid Owner of a contract (PoCS)
 InvalidContractOwner,
+/// Stake Information i.e., `StakeInfoMap` doesn't hold the stake information for a given contract address (PoCS)
 NoStakeExists,
+/// No validator was found for the given contract address (PoCS)
 NoValidatorFound,
+/// The contract does not meet the minimum reputation requirement for updating delegates (PoCS)
 LowReputation,
+/// The contract or account is already delegated to the same address (PoCS)
 AlreadyDelegated,
+/// Failed to create a new bond for staking (PoCS)
 NewBondFailed,
+/// Failed to add extra funds to an existing bond (PoCS)
 BondExtraFailed,
+/// Failed to remove an existing bond (PoCS)
 BondRemoveFailed,
+/// The nomination process for selecting a validator has failed (PoCS)
 NominationFailed,
+/// The validation process has failed for a valid-to-be validator (PoCS)
 ValidationFailed,
+/// The required minimum number of delegates has not been met for validation (PoCS)
 InsufficientDelegates,
 /// The executed contract exhausted its gas limit.
 OutOfGas,
@@ -1073,13 +1093,19 @@ use stake::{DelegateRequest, ValidateRequest};
 
 use crate::stake::{DelegateInfo,StakeInfo};
 
-/// PoCS
+/// Tracks Delegate Information of a staked contract (PoCS)
 #[pallet::storage]
 #[pallet::getter(fn get_delegate_info)]
 pub type DelegateInfoMap<T: Config> = StorageMap<_, Twox64Concat, T::AccountId, DelegateInfo<T>>;
+
+/// Tracks Stake Score Information of a contract (PoCS)
 #[pallet::storage]
 #[pallet::getter(fn get_stake_info)]
 pub type StakeInfoMap<T: Config> = StorageMap<_, Twox64Concat, T::AccountId, StakeInfo<T>>;
+
+/// Tracks Number of delegates associated with a validator (PoCS)
+/// 
+/// Gets updated via [`Pallet::delegate`] extrinsic.
 #[pallet::storage]
 #[pallet::getter(fn get_validator_info)]
 pub type ValidatorInfoMap<T: Config> = StorageMap<_, Twox64Concat, T::AccountId, u32>;

pallets/contracts/src/stake/chain_ext.rs

@@ -1,6 +1,24 @@
-use crate::{Config as ContractsConfig, Pallet as ContractsPallet};
+// This file is part of Substrate.
+// Copyright (C) Auguth Research Foundation, India.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// This file is utilized for Proof of Contract Stake Protocol (PoCS).
+//
+use crate::Config as ContractsConfig;
 use codec::Encode;
-use frame_support::log::{error, info}; // Import logging functions
+use frame_support::log::error; // Import logging functions
 use crate::{
  chain_extension::{ChainExtension, Environment, Ext, InitState, RetVal},
  stake::{DelegateInfo, StakeInfo},

pallets/contracts/src/stake/mod.rs

@@ -1,3 +1,27 @@
+// This file is part of Substrate.
+// Copyright (C) Auguth Research Foundation, India.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// This file is utilized for Proof of Contract Stake Protocol (PoCS).
+//
+
+// Module Imports
+pub mod chain_ext;
+
+
+// Imports 
 use crate::{
 Config, Error, Event, OriginFor, Pallet as Contracts, DelegateInfoMap, StakeInfoMap, ValidatorInfoMap,
 };
@@ -10,13 +34,24 @@ use sp_runtime::{
 use sp_std::prelude::*;
 use pallet_staking::{Pallet as Staking, ValidatorPrefs,Bonded};
 
+/// The minimum reputation required to participate in staking contracts.
 pub const MIN_REPUTATION: u32 = 3; 
+
+/// The minimum number of delegates required for a validator to be eligible.
 pub const MIN_DELEGATES: u32 = 10; 
-pub const REPUTATION_FACTOR : u32 = 1;
-pub const INITIAL_STAKE_SCORE : u128 = 0;
 
-pub mod chain_ext;
+/// The fixed unit used for incrementing reputation and initializing it during instantiation.
+pub const REPUTATION_FACTOR: u32 = 1;
+
+/// The initial stake score, set to zero for contract constructor purposes.
+pub const INITIAL_STAKE_SCORE: u128 = 0;
 
+
+/// Represents the delegation details of a deployed contract.
+/// It includes:
+/// - The owner of the contract.
+/// - The validator account i.e., contract to which the contract is delegated.
+/// - The block number when the delegation was set.
 #[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo, MaxEncodedLen)]
 #[scale_info(skip_type_params(T))]
 pub struct DelegateInfo<T: Config> {
@@ -26,42 +61,52 @@ pub struct DelegateInfo<T: Config> {
 }
 
 impl<T: Config> DelegateInfo<T> {
-
+ /// Returns the owner `AccountId` of the contract associated with this `DelegateInfo`.
  pub fn owner(&self) -> T::AccountId {
  self.owner.clone()
  }
 
+ /// Returns the `AccountId` of the validator to whom the contract is delegated.
  pub fn delegate_to(&self) -> T::AccountId {
  self.delegate_to.clone()
  }
 
+ /// Returns the block number when the delegate information was last updated.
  pub fn delegate_at(&self) -> BlockNumberFor<T> {
  self.delegate_at
  }
 
+ /// Retrieves the `DelegateInfo` for a given contract address.
  pub fn get(contract_addr: &T::AccountId) -> Result<DelegateInfo<T>, DispatchError> {
  Contracts::<T>::get_delegate_info(contract_addr)
- .ok_or_else(|| Error::<T>::NoStakeExists.into())
+  .ok_or_else(|| Error::<T>::NoStakeExists.into())
  }
 
-fn new(owner: &T::AccountId,) -> Self {
-Self {
-owner: owner.clone(),
+ /// Creates a new `DelegateInfo` instance where the deployer is both the owner and delegate.
+ pub fn new(owner: &T::AccountId) -> Self {
+ Self {
+ owner: owner.clone(),
  delegate_to: owner.clone(),
-delegate_at: frame_system::Pallet::<T>::block_number()
-}
-}
-
-fn update(&self, delegate: &T::AccountId) -> Self {
-Self{
-owner: self.owner.clone(), 
-delegate_to: delegate.clone(),
-delegate_at: frame_system::Pallet::<T>::block_number()
-}
-}
+ delegate_at: frame_system::Pallet::<T>::block_number(),
+ }
+ }
 
+ /// Updates the `delegate_to` field and returns an updated `DelegateInfo` instance.
+ pub fn update(&self, delegate: &T::AccountId) -> Self {
+ Self {
+ owner: self.owner.clone(),
+ delegate_to: delegate.clone(),
+ delegate_at: frame_system::Pallet::<T>::block_number(),
+ }
+ }
 }
 
+
+/// Tracks the gas usage metrics of a contract for staking purposes.
+/// It includes:
+/// - The reputation score of the contract.
+/// - The block height of its most recent usage.
+/// - The stake score associated with the contract.
 #[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo, MaxEncodedLen)]
 #[scale_info(skip_type_params(T))]
 pub struct StakeInfo<T: Config> {
@@ -72,23 +117,28 @@ pub struct StakeInfo<T: Config> {
 
 impl<T: Config> StakeInfo<T>{
 
+ /// Returns the stake score of a contract's `StakeInfo`. 
  pub fn stake_score(&self) -> u128 {
  self.stake_score
  }
 
+ /// Returns the reputation score of a contract's `StakeInfo`.
  pub fn reputation(&self) -> u32 {
  self.reputation
  }
 
+ /// Returns the block height of the most recent interaction with the contract. 
  pub fn blockheight(&self) -> BlockNumberFor<T> {
  self.blockheight
  }
 
+ /// Retrieves the `StakeInfo` of an instantiated contract.
  pub fn get(contract_addr: &T::AccountId) -> Result<StakeInfo<T>,DispatchError> {
  Contracts::<T>::get_stake_info(contract_addr)
  .ok_or_else(|| Error::<T>::NoStakeExists.into())
  }
 
+ /// Creates a mock `StakeInfo` instance for testing with a given stake score and reputation.
  pub fn mock_stake(stake_score: u128, reputation: u32) -> Self{
  Self{
  reputation: reputation,
@@ -97,6 +147,7 @@ impl<T: Config> StakeInfo<T>{
  }
  }
 
+ /// Creates a new `StakeInfo` instance using predefined constants for instantiation. 
 fn new() -> Self {
 Self{
 reputation: REPUTATION_FACTOR,
@@ -105,6 +156,7 @@ impl<T: Config> StakeInfo<T>{
 }
 }
 
+ /// Resets the stake score in `StakeInfo` to zero, updates the block number, and retains the reputation. 
 fn reset(&self)-> Self {
 Self{
 reputation: self.reputation,
@@ -113,6 +165,7 @@ impl<T: Config> StakeInfo<T>{
 }
 }
 
+ /// Updates the stake score based on gas usage provided and adjusts reputation if the block height has changed.
  fn update(&self, gas: &u64) -> Self {
  let current_block_height = <frame_system::Pallet<T>>::block_number();
  let current_reputation = self.reputation;
@@ -227,6 +280,14 @@ impl<T: Config> StakeRequest<T>{
  if StakeInfoMap::<T>::contains_key(&contract_addr) {
  StakeInfoMap::<T>::remove(&contract_addr);
  } 
+ if DelegateInfoMap::<T>::contains_key(&contract_addr){
+ let delegate_info = <DelegateInfo<T>>::get(&contract_addr).unwrap();
+ let delegate_to = delegate_info.delegate_to();
+ if delegate_to != delegate_info.owner(){
+ <DelegateRequest<T>>::decrement(&delegate_to);
+ }
+ DelegateInfoMap::<T>::remove(&contract_addr);
+ }
  }
 
  fn nominate(owner: &T::AccountId, validator: &T::AccountId) -> Result<(),DispatchError>{

pallets/contracts/src/tests.rs

@@ -6843,41 +6843,3 @@ fn pocs_stake_score_increment_during_delegate_call(){
 assert!(<StakeInfo<Test>>::get(&callee_addr).unwrap().stake_score() > init_stake_score);
 });
 }
-
-#[test]
-fn pocs_delegate_by_owner_contract_via_chain_extension(){
-
-}
-
-#[test]
-fn pocs_delegate_by_non_owner_contract_via_chain_extension(){
-
-}
-
-#[test]
-fn pocs_fetch_delegate_to_via_chain_extension(){
-
-}
-
-#[test]
-fn pocs_fetch_delegate_at_via_chain_extension(){
-
-}
-#[test]
-fn pocs_check_is_delegate_via_chain_extension(){
-
-}
-#[test]
-fn pocs_fetch_stake_score_via_chain_extension(){
-
-}
-
-#[test]
-fn pocs_fetch_reputation_via_chain_extension(){
-
-}
-
-#[test]
-fn pocs_fetch_stake_info_tuple_via_chain_extension(){
-
-}