Resolve conflicts, add mock oracles to tests

Author: performanceArtist

MetaLamp/lending-pool/README.md

@@ -1,35 +1,54 @@
-# Plutus Platform starter project
+# Lending Pool
 
-This project gives a simple starter project for using the Plutus Platform.
+Lending Pool is a smart contract application on Plutus Platform.
+The smart contract protocol is based on [Aave](https://aave.com/), but does not strictly follow it.
 
 ## Setting up
 
 - Install nix
 - Clone https://github.com/input-output-hk/plutus
 - Set up your machine to build things with Nix, following the Plutus README (make sure to set up the binary cache!)
 
-## The Plutus Application Backend (PAB) example
+## The Plutus Application Backend (PAB) usage
 
-We have provided an example PAB application in `./pab`. With the PAB we can serve and interact
-with contracts over a web API. You can read more about the PAB here: [PAB Architecture](https://github.com/input-output-hk/plutus/blob/master/plutus-pab/ARCHITECTURE.adoc).
+We have provided two PAB applications in `./pab` and `./pab-simulation`. The first one is made for real world usage and interaction through frontend [client](client/README.md), the second one is a big test scenario.
+With the PAB we can serve and interact with contracts over a web API. You can read more about the PAB here: [PAB Architecture](https://github.com/input-output-hk/plutus/blob/master/plutus-pab/ARCHITECTURE.adoc).
 
 1. Enter the nix shell (cd to the cloned Plutus repo):
 
 ```
-git checkout 58bf9ed626d498c140c69a859a508da03843d097
+git checkout 5cdd2c3d708bf4c33514681dee096da6463273b7
 nix-shell
 ```
 
-2. Build the PAB executable (cd to plutus-use-cases/MetaLamp/lending-pool):
+2. Build the PAB executables (cd to plutus-use-cases/MetaLamp/lending-pool):
 
 ```
-cabal build
+cabal build all
 ```
 
 3. Run the PAB binary:
 
 ```
-cabal run plutus-starter-pab
-````
+cabal run pab
+```
 
 This will then start up the server on port 8080.
+
+4. To run test simulation do:
+
+```
+cabal run pab-simulation
+```
+
+## Client
+
+See the client [readme](client/README.md).
+
+## Troubleshooting
+
+See [note](client/README.md/#Troubleshooting).
+
+## Protocol functionality
+
+See the description of user endpoints [here](src/Plutus/Contracts/Endpoints.hs)

MetaLamp/lending-pool/client/README.md

@@ -1,17 +1,51 @@
-# lending pool client
+# Lending pool client
+
+The client application has a minimalistic interface to the PAB [server](/MetaLamp/lending-pool/README.md).
 
 ## Running the project
 
+1. Install npm packages.
+
 ```
 npm install
 ```
 
+2. Generate necessary PureScript code from Haskell source. This step runs an executable(`generate-purs`) from `lending-pool` directory, which requires a certain environment. The setup steps are described in `lending-pool/README`. Provided that you are able to build the backend, you can use the same approach to run purescript generation from `client` folder, i.e.
+
+Enter the nix shell (cd to the cloned Plutus repo):
+
+```
+git checkout 5cdd2c3d708bf4c33514681dee096da6463273b7
+nix-shell
+```
+
+cd to `lending-pool/client` folder and execute
+
+```
+npm run generate-purs
+```
+
+3. Start the client:
+
 ```
 npm start
 ```
 
-CORS protection needs to be disabled. You can use this script to launch chrome:
+4. Open browser to interact with the app at https://localhost:8009/.
+CORS protection needs to be disabled. You can use this script to launch chromium (note that first you need to close chromium completely, otherwise security won't be disabled):
 
 ```
 npm run start-chrome
 ```
+
+## Troubleshooting
+
+Sometimes the build results in error with Haskell IDE enabled. If the build does not work or the app behaves strangely, disable IDE and clean all source files:
+
+```
+cd MetaLamp/lending-pool/ && cabal clean
+```
+
+```
+cd MetaLamp/lending-pool/client && rm -rf node_modules/ generated/ output/ plutus-purs/ .spago/
+```

MetaLamp/lending-pool/client/package.json

@@ -9,10 +9,10 @@
     "purs:compile": "spago build",
     "docs": "spago docs",
     "repl": "spago repl",
-    "generate-purs": "sh ./scripts/generate-purs.sh",
     "fetch-plutus-purs": "sh ./scripts/fetch-plutus-purs.sh",
+    "generate-purs-only": "sh ./scripts/generate-purs.sh",
+    "generate-purs": "npm run fetch-plutus-purs && npm run generate-purs-only",
     "start-chrome": "sh ./scripts/start-chrome.sh",
-    "preinstall": "npm run fetch-plutus-purs && npm run generate-purs",
     "start": "npm run purs:compile && npm run webpack:server"
   },
   "dependencies": {

MetaLamp/lending-pool/client/src/Business/AaveUser.purs

@@ -7,7 +7,7 @@ import Capability.PollContract (class PollContract, PollError)
 import Data.Either (Either)
 import Data.Maybe (Maybe)
 import Data.Newtype (class Newtype, unwrap)
-import Plutus.Contracts.Endpoints (BorrowParams, DepositParams, RepayParams, WithdrawParams, _Borrowed, _Deposited, _GetPubKey, _GetPubKeyBalance, _Repaid, _Withdrawn)
+import Plutus.Contracts.Endpoints (BorrowParams, ProvideCollateralParams, RevokeCollateralParams, DepositParams, RepayParams, WithdrawParams, _Borrowed, _Deposited, _GetPubKey, _GetPubKeyBalance, _Repaid, _Withdrawn, _CollateralProvided, _CollateralRevoked)
 import Plutus.PAB.Simulation (AaveContracts, _AaveUser)
 import Plutus.PAB.Webserver.Types (ContractInstanceClientState)
 import Plutus.V1.Ledger.Crypto (PubKeyHash)
@@ -33,6 +33,12 @@ borrow = getAaveResponseWith (Endpoint "borrow") _Borrowed <<< unwrap
 repay :: forall m. PollContract m => UserContractId -> RepayParams -> m (Either PollError Unit)
 repay = getAaveResponseWith (Endpoint "repay") _Repaid <<< unwrap
 
+provideCollateral :: forall m. PollContract m => UserContractId -> ProvideCollateralParams -> m (Either PollError Unit)
+provideCollateral = getAaveResponseWith (Endpoint "provideCollateral") _CollateralProvided <<< unwrap
+
+revokeCollateral :: forall m. PollContract m => UserContractId -> RevokeCollateralParams -> m (Either PollError Unit)
+revokeCollateral = getAaveResponseWith (Endpoint "revokeCollateral") _CollateralRevoked <<< unwrap
+
 ownPubKey :: forall m. PollContract m => UserContractId -> m (Either PollError PubKeyHash)
 ownPubKey cid = getAaveResponseWith (Endpoint "ownPubKey") _GetPubKey (unwrap cid) ContractUnit
 

MetaLamp/lending-pool/client/src/Component/Contract.purs

@@ -24,7 +24,7 @@ import Halogen as H
 import Halogen.HTML as HH
 import Network.RemoteData (RemoteData(..))
 import Network.RemoteData as RD
-import Plutus.Contracts.Endpoints (BorrowParams(..), DepositParams(..), RepayParams(..), WithdrawParams(..))
+import Plutus.Contracts.Endpoints (BorrowParams(..), DepositParams(..), RepayParams(..), WithdrawParams(..), ProvideCollateralParams(..), RevokeCollateralParams(..))
 import Plutus.V1.Ledger.Crypto (PubKeyHash)
 import Plutus.V1.Ledger.Value (AssetClass(..), TokenName(..), Value)
 import View.FundsTable (fundsTable)
@@ -38,6 +38,8 @@ type State
     , withdraw :: RemoteData String Unit
     , borrow :: RemoteData String Unit
     , repay :: RemoteData String Unit
+    , provideCollateral :: RemoteData String Unit
+    , revokeCollateral :: RemoteData String Unit
     , submit :: RemoteData String Unit
     }
 
@@ -53,6 +55,12 @@ _borrow = prop (SProxy :: SProxy "borrow")
 _repay :: Lens' State (RemoteData String Unit)
 _repay = prop (SProxy :: SProxy "repay")
 
+_provideCollateral :: Lens' State (RemoteData String Unit)
+_provideCollateral = prop (SProxy :: SProxy "provideCollateral")
+
+_revokeCollateral :: Lens' State (RemoteData String Unit)
+_revokeCollateral = prop (SProxy :: SProxy "revokeCollateral")
+
 _submit :: Lens' State (RemoteData String Unit)
 _submit = prop (SProxy :: SProxy "submit")
 
@@ -76,6 +84,8 @@ initialState { userFunds, userContractId, walletPubKey, reserves } =
   , deposit: NotAsked
   , borrow: NotAsked
   , repay: NotAsked
+  , provideCollateral: NotAsked
+  , revokeCollateral: NotAsked
   , submit: NotAsked
   }
 
@@ -84,6 +94,8 @@ data Action
   | Withdraw { amount :: BigInteger, asset :: AssetClass }
   | Borrow { amount :: BigInteger, asset :: AssetClass }
   | Repay { amount :: BigInteger, asset :: AssetClass }
+  | ProvideCollateral { amount :: BigInteger, asset :: AssetClass }
+  | RevokeCollateral { amount :: BigInteger, asset :: AssetClass }
   | OnSubmitAmount SubmitOperation AmountForm.Output
 
 -- potentially should be separate actions - just a convenience for now, while they are identical
@@ -92,6 +104,8 @@ data SubmitOperation
   | SubmitWithdraw
   | SubmitBorrow
   | SubmitRepay
+  | SubmitProvideCollateral
+  | SubmitRevokeCollateral
 
 derive instance genericSubmitOperation :: Generic SubmitOperation _
 
@@ -141,6 +155,18 @@ component =
             { userContractId, walletPubKey } <- lift H.get
             lift (AaveUser.repay userContractId $ RepayParams { rpAmount: amount, rpAsset: asset, rpOnBehalfOf: walletPubKey })
               >>= either (throwError <<< show) (const <<< lift <<< H.raise $ SubmitSuccess)
+    ProvideCollateral { amount, asset } ->
+      runRD _provideCollateral <<< runExceptT
+        $ do
+            { userContractId, walletPubKey } <- lift H.get
+            lift (AaveUser.provideCollateral userContractId $ ProvideCollateralParams { pcpUnderlyingAsset: asset, pcpAmount: amount, pcpOnBehalfOf: walletPubKey })
+              >>= either (throwError <<< show) (const <<< lift <<< H.raise $ SubmitSuccess)
+    RevokeCollateral { amount, asset } ->
+      runRD _revokeCollateral <<< runExceptT
+        $ do
+            { userContractId, walletPubKey } <- lift H.get
+            lift (AaveUser.revokeCollateral userContractId $ RevokeCollateralParams { rcpUnderlyingAsset: asset, rcpAmount: amount, rcpOnBehalfOf: walletPubKey })
+              >>= either (throwError <<< show) (const <<< lift <<< H.raise $ SubmitSuccess)
     OnSubmitAmount operation (AmountForm.Submit { name, amount }) ->
       runRD _submit <<< runExceptT
         $ do
@@ -175,6 +201,20 @@ component =
                     (throwError $ "Submit repay failed: " <> show repay)
                     (const <<< pure $ unit)
                     repay
+                SubmitProvideCollateral -> do
+                  lift $ handleAction (ProvideCollateral { amount, asset })
+                  { provideCollateral } <- lift H.get
+                  RD.maybe
+                    (throwError $ "Submit provideCollateral failed: " <> show provideCollateral)
+                    (const <<< pure $ unit)
+                    provideCollateral
+                SubmitRevokeCollateral -> do
+                  lift $ handleAction (RevokeCollateral { amount, asset })
+                  { revokeCollateral } <- lift H.get
+                  RD.maybe
+                    (throwError $ "Submit revokeCollateral failed: " <> show revokeCollateral)
+                    (const <<< pure $ unit)
+                    revokeCollateral
               Nothing -> throwError "Asset name not found"
 
   render :: State -> H.ComponentHTML Action Slots m
@@ -194,7 +234,7 @@ component =
                     , HH.slot _amountForm index AmountForm.component (reservesToAmounts state.reserves) (Just <<< (OnSubmitAmount operation))
                     ]
               )
-              [ Tuple "Deposit" SubmitDeposit, Tuple "Withdraw" SubmitWithdraw, Tuple "Borrow" SubmitBorrow, Tuple "Repay" SubmitRepay ]
+              [ Tuple "Deposit" SubmitDeposit, Tuple "Withdraw" SubmitWithdraw, Tuple "Borrow" SubmitBorrow, Tuple "Repay" SubmitRepay, Tuple "ProvideCollateral" SubmitProvideCollateral, Tuple "RevokeCollateral" SubmitRevokeCollateral ]
       ]
 
 reservesToAmounts :: Array { amount :: BigInteger, asset :: AssetClass } -> Array AmountForm.AmountInfo

MetaLamp/lending-pool/client/src/View/UsersTable.purs

@@ -18,9 +18,9 @@ poolUsers asset users =
     ]
 
 userInfo :: forall props act. Tuple String UserConfig -> HH.HTML props act
-userInfo (Tuple userId (UserConfig { ucDebt, ucUsingAsCollateral })) =
+userInfo (Tuple userId (UserConfig { ucDebt, ucCollateralizedInvestment })) =
   HH.div_
     [ HH.div_ [ HH.text $ "User " <> userId ]
-    , HH.div_ [ HH.text $ "Debt: " <> (show <<< fromMaybe (fromInt 0) $ ucDebt) ]
-    , HH.div_ [ HH.text $ "Using as collateral: " <> (show ucUsingAsCollateral) ]
+    , HH.div_ [ HH.text $ "Debt: " <> (show ucDebt) ]
+    , HH.div_ [ HH.text $ "Collateral: " <> (show ucCollateralizedInvestment) ]
     ]

MetaLamp/lending-pool/generate-purs/AaveTypes.hs

@@ -31,6 +31,7 @@ import           Language.PureScript.Bridge.TypeParameters (A, E)
 import qualified PSGenerator.Common
 import qualified Plutus.Contracts.Core                     as Aave
 import qualified Plutus.Contracts.Endpoints                as Aave
+import qualified Plutus.Contracts.Oracle                   as Oracle
 import           Plutus.PAB.Simulation                     (AaveContracts (..))
 import           Plutus.V1.Ledger.Value                    (AssetClass)
 
@@ -48,6 +49,7 @@ psRatio = expand <$> psTypeParameters
 aaveTypes :: [SumType 'Haskell]
 aaveTypes = [ (equal <*> (genericShow <*> mkSumType)) (Proxy @AaveContracts)
           , (equal <*> (genericShow <*> mkSumType)) (Proxy @Aave.Aave)
+          , (equal <*> (genericShow <*> mkSumType)) (Proxy @Oracle.Oracle)
           , (equal <*> (genericShow <*> mkSumType)) (Proxy @(Aave.ContractResponse E A))
           , (equal <*> (genericShow <*> mkSumType)) (Proxy @Aave.CreateParams)
           , (order <*> (equal <*> (genericShow <*> mkSumType))) (Proxy @AssetClass)
@@ -58,4 +60,6 @@ aaveTypes = [ (equal <*> (genericShow <*> mkSumType)) (Proxy @AaveContracts)
           , (equal <*> (genericShow <*> mkSumType)) (Proxy @Aave.DepositParams)
           , (equal <*> (genericShow <*> mkSumType)) (Proxy @Aave.WithdrawParams)
           , (equal <*> (genericShow <*> mkSumType)) (Proxy @Aave.BorrowParams)
-          , (equal <*> (genericShow <*> mkSumType)) (Proxy @Aave.RepayParams) ]
+          , (equal <*> (genericShow <*> mkSumType)) (Proxy @Aave.RepayParams)
+          , (equal <*> (genericShow <*> mkSumType)) (Proxy @Aave.ProvideCollateralParams)
+          , (equal <*> (genericShow <*> mkSumType)) (Proxy @Aave.RevokeCollateralParams) ]

MetaLamp/lending-pool/plutus-starter.cabal

@@ -23,7 +23,7 @@ maintainer:         Your email
 
 library
     exposed-modules:
-      Plutus.Contracts.Endpoints Plutus.Contracts.FungibleToken Plutus.Contracts.AToken Plutus.Contracts.Core Plutus.Contracts.State Plutus.State.Select Plutus.State.Update Plutus.Contracts.TxUtils Plutus.OutputValue Ext.Plutus.Ledger.Contexts Plutus.PAB.Simulation
+      Plutus.Contracts.Endpoints Plutus.Contracts.FungibleToken Plutus.Contracts.AToken Plutus.Contracts.Core Plutus.Contracts.Oracle Plutus.Contracts.State Plutus.State.Select Plutus.State.Update Plutus.Contracts.TxUtils Plutus.OutputValue Ext.Plutus.Ledger.Contexts Plutus.PAB.Simulation
     build-depends:
       base >= 4.9 && < 5,
       aeson,
@@ -102,7 +102,7 @@ test-suite test
     main-is: Main.hs
     hs-source-dirs: test
     other-modules:
-      Spec.Start Spec.Deposit Spec.Withdraw Spec.Shared Utils.Data Utils.Trace Fixtures Fixtures.Aave Fixtures.Asset Fixtures.Init Fixtures.Wallet
+      Spec.Start Spec.Deposit Spec.Withdraw Spec.Shared Utils.Data Utils.Trace Fixtures Fixtures.Policy Fixtures.Aave Fixtures.Asset Fixtures.Init Fixtures.Wallet
     default-language: Haskell2010
     ghc-options: -Wall -Wnoncanonical-monad-instances
                  -Wincomplete-uni-patterns -Wincomplete-record-updates

MetaLamp/lending-pool/src/Ext/Plutus/Ledger/Contexts.hs

@@ -37,6 +37,7 @@ findValueByDatumHash dh outs = mconcat $ mapMaybe f outs
                  | otherwise = Nothing
 
 {-# INLINABLE parseDatum #-}
+-- | Find datum inside pending transaction and parse it from data
 parseDatum :: PlutusTx.IsData a => TxInfo -> DatumHash -> Maybe a
 parseDatum txInfo dh = findDatum dh txInfo >>= (PlutusTx.fromData . getDatum)