Merge pull request #145 from Supercolony-net/feature/lending-integrat…

…ion-tests

Integration tests for example project structure

docs/docs/smart-contracts/example/impls.md

@@ -61,11 +61,16 @@ pub trait Lending {
   #[ink(message)]
   fn total_shares(&self, asset_address: AccountId) -> Result<Balance, LendingError>;
 
+  /// This function  will return the address of shares
+  /// which is bound to `asset_address` asset token
+  #[ink(message)]
+  fn get_asset_shares(&self, asset_address: AccountId) -> Result<AccountId, LendingError>;
+
   /// This function will return true if the asset is accepted by the contract
   #[ink(message)]
   fn is_accepted_lending(&self, asset_address: AccountId) -> bool;
 
-  /// This function will return true if the asset is accepted by the contract
+  /// This function will return true if the asset is accepted for using as collateral
   #[ink(message)]
   fn is_accepted_collateral(&self, asset_address: AccountId) -> bool;
 
@@ -183,8 +188,9 @@ In this example we will not be using price oracles, we will do
 our own simulated oracle. Since oracles are not the point of this example,
 it will be enough for us. We will store prices info in our data struct.
 
-```rust// Importing everything publicly from traits allows you to import every stuff related to lending
-// by one import
+```rust
+// Importing everything publicly from traits allows you to import 
+// every stuff related to lending by one import
 use crate::traits::lending::*;
 use openbrush::{
     storage::{
@@ -193,10 +199,8 @@ use openbrush::{
     },
     traits::{
         AccountId,
-        AccountIdExt,
         Balance,
         Hash,
-        ZERO_ADDRESS,
     },
 };
 
@@ -263,36 +267,28 @@ where
 
 /// Internal function which will return the address of the shares token
 /// which are minted when `asset_address` is borrowed
-pub fn get_reserve_asset<T>(instance: &T, asset_address: &AccountId) -> Result<AccountId, LendingError>
-where
+pub fn get_reserve_asset<T>(instance: &T, asset_address: &AccountId) -> Result<AccountId, LendingError> 
+where 
     T: Storage<Data>,
 {
-    let reserve_asset = instance
+    instance
         .data()
         .asset_shares
         .get(&asset_address)
-        .unwrap_or(ZERO_ADDRESS.into());
-    if reserve_asset.is_zero() {
-        return Err(LendingError::AssetNotSupported)
-    }
-    Ok(reserve_asset)
+        .ok_or(LendingError::AssetNotSupported)
 }
 
 /// internal function which will return the address of asset
 /// which is bound to `shares_address` shares token
-pub fn get_asset_from_shares<T>(instance: &T, shares_address: &AccountId) -> Result<AccountId, LendingError>
+pub fn get_asset_from_shares<T>(instance: &T, shares_address: &AccountId) -> Result<AccountId, LendingError> 
 where
     T: Storage<Data>,
-{
-    let token = instance
+{ 
+    instance
         .data()
         .shares_asset
         .get(shares_address)
-        .unwrap_or(ZERO_ADDRESS.into());
-    if token.is_zero() {
-        return Err(LendingError::AssetNotSupported)
-    }
-    Ok(token)
+        .ok_or(LendingError::AssetNotSupported)
 }
 
 ```
@@ -476,8 +472,8 @@ The `Storage<pausable::Data>` restriction is required to use `when_paused`, `whe
 from [pausable](https://github.com/Supercolony-net/openbrush-contracts/blob/main/contracts/src/security/pausable/mod.rs#L24).
 
 ```rust
-// Importing everything publicly from traits allows you to import every stuff related to lending
-// by one import
+// Importing everything publicly from traits allows you to import 
+// every stuff related to lending by one import
 pub use crate::{
     impls::lending::{
         data,
@@ -552,7 +548,15 @@ impl<T: Storage<data::Data> + Storage<pausable::Data>> Lending for T {
         }
         Ok(PSP22Ref::total_supply(&mapped_asset))
     }
-
+
+    default fn get_asset_shares(&self, asset_address: AccountId) -> Result<AccountId, LendingError> {
+        self
+            .data::<data::Data>()
+            .asset_shares
+            .get(&asset_address)
+            .ok_or(LendingError::AssetNotSupported)
+    }
+
     default fn is_accepted_lending(&self, asset_address: AccountId) -> bool {
         !self
             .data::<data::Data>()
@@ -724,7 +728,7 @@ impl<T: Storage<data::Data> + Storage<pausable::Data>> Lending for T {
             SharesRef::mint(
                 &reserve_asset,
                 contract,
-                to_repay - repay_amount - loan_info.borrow_amount,
+                to_repay - repay_amount,
             )?;
             LoanRef::update_loan(
                 &loan_account,

docs/docs/smart-contracts/example/loan.md

@@ -250,6 +250,7 @@ impl LoanContract {
                 String::from("LoanContract NFT").into_bytes(),
                 String::from("L-NFT").into_bytes(),
             );
+            instance._init_with_owner(instance.env().caller());
         })
     }
 

docs/docs/smart-contracts/example/psp22.md

@@ -22,14 +22,15 @@ we will implement that trait to be sure that all super traits are also implement
 ```rust
 use openbrush::contracts::traits::psp22::{
     extensions::metadata::*,
+    extensions::mintable::*,
     *,
 };
 
 #[openbrush::wrapper]
-pub type StableCoinRef = dyn PSP22 + PSP22Metadata;
+pub type StableCoinRef = dyn PSP22 + PSP22Metadata + PSP22Mintable;
 
 #[openbrush::trait_definition]
-pub trait StableCoin: PSP22 + PSP22Metadata {}
+pub trait StableCoin: PSP22 + PSP22Metadata + PSP22Mintable {}
 ```
 
 ## Add dependencies
@@ -58,6 +59,7 @@ pub mod token {
     use lending_project::traits::stable_coin::*;
     use openbrush::{
         contracts::psp22::extensions::metadata::*,
+        contracts::psp22::extensions::mintable::*,
         traits::Storage,
     };
 ```
@@ -92,6 +94,9 @@ impl PSP22 for StableCoinContract {}
 /// Implement PSP22Metadata Trait for our coin
 impl PSP22Metadata for StableCoinContract {}
 
+/// implement PSP22Mintable Trait for our coin
+impl PSP22Mintable for StableCoinContract {}
+
 // It forces the compiler to check that you implemented all super traits
 impl StableCoin for StableCoinContract {}
 

docs/docs/smart-contracts/example/shares.md

@@ -104,28 +104,17 @@ We will be using these extensions in our token, so we will implement them for
 our storage.
 
 ```rust
-/// Implement PSP22 Trait for our coin
-impl PSP22 for StableCoinContract {}
+// Implement PSP22 Trait for our share
+impl PSP22 for SharesContract {}
 
-/// Implement PSP22Metadata Trait for our coin
-impl PSP22Metadata for StableCoinContract {}
+// Implement Ownable Trait for our share
+impl Ownable for SharesContract {}
 
-// It forces the compiler to check that you implemented all super traits
-impl StableCoin for StableCoinContract {}
+// Implement Metadata Trait for our share
+impl PSP22Metadata for SharesContract {}
 
-impl StableCoinContract {
-    /// Constructor with name and symbol
-    #[ink(constructor)]
-    pub fn new(name: Option<String>, symbol: Option<String>) -> Self {
-        ink_lang::codegen::initialize_contract(|instance: &mut StableCoinContract| {
-            instance.metadata.name = name;
-            instance.metadata.symbol = symbol;
-            instance.metadata.decimals = 18;
-            let total_supply = 1_000_000 * 10_u128.pow(18);
-            assert!(instance._mint(instance.env().caller(), total_supply).is_ok());
-        })
-    }
-}
+// It forces the compiler to check that you implemented all super traits
+impl Shares for SharesContract {}
 ```
 
 ## Implement the Burnable and Mintable traits

example_project_structure/contracts/loan/lib.rs

@@ -103,6 +103,7 @@ pub mod loan {
                     String::from("LoanContract NFT").into_bytes(),
                     String::from("L-NFT").into_bytes(),
                 );
+                instance._init_with_owner(instance.env().caller());
             })
         }
 

example_project_structure/contracts/stable_coin/lib.rs

@@ -9,6 +9,7 @@ pub mod token {
     use lending_project::traits::stable_coin::*;
     use openbrush::{
         contracts::psp22::extensions::metadata::*,
+        contracts::psp22::extensions::mintable::*,
         traits::Storage,
     };
 
@@ -28,6 +29,9 @@ pub mod token {
     /// Implement PSP22Metadata Trait for our coin
     impl PSP22Metadata for StableCoinContract {}
 
+    /// implement PSP22Mintable Trait for our coin
+    impl PSP22Mintable for StableCoinContract {}
+
     // It forces the compiler to check that you implemented all super traits
     impl StableCoin for StableCoinContract {}
 

example_project_structure/impls/lending/data.rs

@@ -8,10 +8,8 @@ use openbrush::{
     },
     traits::{
         AccountId,
-        AccountIdExt,
         Balance,
         Hash,
-        ZERO_ADDRESS,
     },
 };
 
@@ -82,15 +80,11 @@ pub fn get_reserve_asset<T>(instance: &T, asset_address: &AccountId) -> Result<A
 where
     T: Storage<Data>,
 {
-    let reserve_asset = instance
+    instance
         .data()
         .asset_shares
         .get(&asset_address)
-        .unwrap_or(ZERO_ADDRESS.into());
-    if reserve_asset.is_zero() {
-        return Err(LendingError::AssetNotSupported)
-    }
-    Ok(reserve_asset)
+        .ok_or(LendingError::AssetNotSupported)
 }
 
 /// internal function which will return the address of asset
@@ -99,13 +93,9 @@ pub fn get_asset_from_shares<T>(instance: &T, shares_address: &AccountId) -> Res
 where
     T: Storage<Data>,
 {
-    let token = instance
+    instance
         .data()
         .shares_asset
         .get(shares_address)
-        .unwrap_or(ZERO_ADDRESS.into());
-    if token.is_zero() {
-        return Err(LendingError::AssetNotSupported)
-    }
-    Ok(token)
+        .ok_or(LendingError::AssetNotSupported)
 }

example_project_structure/impls/lending/lending.rs

@@ -75,6 +75,14 @@ impl<T: Storage<data::Data> + Storage<pausable::Data>> Lending for T {
         Ok(PSP22Ref::total_supply(&mapped_asset))
     }
 
+    default fn get_asset_shares(&self, asset_address: AccountId) -> Result<AccountId, LendingError> {
+        self
+            .data::<data::Data>()
+            .asset_shares
+            .get(&asset_address)
+            .ok_or(LendingError::AssetNotSupported)
+    }
+
     default fn is_accepted_lending(&self, asset_address: AccountId) -> bool {
         !self
             .data::<data::Data>()
@@ -246,7 +254,7 @@ impl<T: Storage<data::Data> + Storage<pausable::Data>> Lending for T {
             SharesRef::mint(
                 &reserve_asset,
                 contract,
-                to_repay - repay_amount - loan_info.borrow_amount,
+                to_repay - repay_amount,
             )?;
             LoanRef::update_loan(
                 &loan_account,

example_project_structure/traits/lending.rs

@@ -36,11 +36,16 @@ pub trait Lending {
     #[ink(message)]
     fn total_shares(&self, asset_address: AccountId) -> Result<Balance, LendingError>;
 
+    /// This function  will return the address of shares
+    /// which is bound to `asset_address` asset token
+    #[ink(message)]
+    fn get_asset_shares(&self, asset_address: AccountId) -> Result<AccountId, LendingError>;
+
     /// This function will return true if the asset is accepted by the contract
     #[ink(message)]
     fn is_accepted_lending(&self, asset_address: AccountId) -> bool;
 
-    /// This function will return true if the asset is accepted by the contract
+    /// This function will return true if the asset is accepted for using as collateral
     #[ink(message)]
     fn is_accepted_collateral(&self, asset_address: AccountId) -> bool;
 

example_project_structure/traits/stable_coin.rs

@@ -1,10 +1,11 @@
 use openbrush::contracts::traits::psp22::{
     extensions::metadata::*,
+    extensions::mintable::*,
     *,
 };
 
 #[openbrush::wrapper]
-pub type StableCoinRef = dyn PSP22 + PSP22Metadata;
+pub type StableCoinRef = dyn PSP22 + PSP22Metadata + PSP22Mintable;
 
 #[openbrush::trait_definition]
-pub trait StableCoin: PSP22 + PSP22Metadata {}
+pub trait StableCoin: PSP22 + PSP22Metadata + PSP22Mintable {}

package.json

@@ -21,6 +21,7 @@
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.1.0",
+    "prettier": "^2.7.1",
     "redspot": "^0.13.5",
     "ts-node": "^10.8.0"
   },

redspot.config.ts

@@ -44,4 +44,4 @@ export default {
   mocha: {
     timeout: 60000
   }
-} as RedspotUserConfig
+} as RedspotUserConfig

tests/e2e/constants.ts

@@ -4,5 +4,6 @@ export const consts = {
 
 export const Roles = {
   DefaultAdminRole: 0,
-  Minter: 0xfd9ab216
+  Minter: 0xfd9ab216,
+  Manager: 0x73a5ca6d,
 }