Merge pull request #124 from mlabs-haskell/issue-89-better-collateral

Issue 89 better collateral handling.

Author: IAmPara0x

.gitignore

@@ -59,3 +59,11 @@ geth-node/chaindata/geth/*
 geth-node/chaindata/history
 *.ipc
 .direnv
+
+# emacs stuff
+*.~undo-tree~
+
+# debug configs
+examples/debug/ci-test.http
+examples/debug/run-test-lc.sh
+examples/debug/run-test-tn.sh

README.md

@@ -77,7 +77,7 @@ main = do
   BotPlutusInterface.runPAB @MyContracts pabConf
 ```
 
-Configuration format (example: <examples/plutus-game/pabConfig.value>): 
+Configuration format (example: <examples/plutus-game/pabConfig.value>):
 
 ``` console
 $ cabal repl --disable-optimisation --repl-options -Wwarn

STANDARDS.md

@@ -60,11 +60,11 @@ Haskell is a language that is older than some of the people currently writing
 it; parts of its ecosystem are not exempt from it. With age comes legacy, and
 much of it is based on historical decisions which we now know to be problematic
 or wrong. We can't avoid our history, but we can minimize its impact on our
-current work. 
+current work.
 
 Thus, we aim to codify good practices in this document _as seen today_. We also
 try to avoid obvious 'sharp edges' by proscribing them away in a principled,
-consistent and justifiable manner. 
+consistent and justifiable manner.
 
 ## Automate away drudgery
 
@@ -155,7 +155,7 @@ difficult to read even without a split screen. We don't _enforce_ a maximum of
 ## Naming
 
 camelCase MUST be used for all non-type, non-data-constructor names; otherwise,
-TitleCase MUST be used. Acronyms used as part of a naming identifier (such as 
+TitleCase MUST be used. Acronyms used as part of a naming identifier (such as
 'JSON', 'API', etc) SHOULD be downcased; thus ``repairJson`` and
 ``fromHttpService`` are correct. Exceptions are allowed for external libraries
 (Aeson's ``parseJSON`` for example).
@@ -315,11 +315,11 @@ wrappers around monadic stacks:
 ```haskell
 newtype FooM a = FooM (ReaderT Int (StateT Text IO) a)
   deriving newtype (
-    Functor, 
-    Applicative, 
-    Monad, 
-    MonadReader Int, 
-    MonadState Text, 
+    Functor,
+    Applicative,
+    Monad,
+    MonadReader Int,
+    MonadState Text,
     MonadIO
     )
 ```
@@ -341,8 +341,8 @@ Thus, even for popularity and compatibility reasons, these should be on by
 default.
 
 ``InstanceSigs`` are harmless by default, and introduce no complications. Their
-not being default is strange. ``ImportQualifiedPost`` is already a convention 
-of this project, and helps with formatting of imports. 
+not being default is strange. ``ImportQualifiedPost`` is already a convention
+of this project, and helps with formatting of imports.
 
 ``LambdaCase`` reduces a lot of code in the common case of analysis of sum
 types. Without it, we are forced to either write a dummy ``case`` argument:
@@ -383,7 +383,7 @@ instead of the one from ``base``.
 ``OverloadedStrings`` deals with the problem that ``String`` is a suboptimal
 choice of string representation for basically _any_ problem, with the general
 recommendation being to use ``Text`` instead. It is not, however, without its
-problems: 
+problems:
 
 * ``ByteString``s are treated as ASCII strings by their ``IsString`` instance;
 * Overly polymorphic behaviour of many functions (especially in the presence of
@@ -438,8 +438,8 @@ alternatives. This means that, when a non-``base`` ``Prelude`` is in scope, it
 often requires familiarity with its specific decisions, in addition to whatever
 cognitive load the current module and its other imports impose. Given that we
 already use an alternative prelude (in tandem with the one from ``base``),
-additional alternatives present an unnecessary cognitive load. Lastly, the 
-dependency footprint of many alternative ``Prelude``s is _highly_ non-trivial; 
+additional alternatives present an unnecessary cognitive load. Lastly, the
+dependency footprint of many alternative ``Prelude``s is _highly_ non-trivial;
 it isn't clear if we need all of this in our dependency tree.
 
 For all of the above reasons, the best choice is 'default to Plutus, with local
@@ -470,7 +470,7 @@ Every publically-exported definition MUST have a Haddock comment, detailing its
 purpose. If a definition is a function, it SHOULD also have examples of use
 using [Bird tracks][bird-tracks]. The Haddock for a publically-exported
 definition SHOULD also provide an explanation of any caveats, complexities of
-its use, or common issues a user is likely to encounter. 
+its use, or common issues a user is likely to encounter.
 
 If the code project is a library, these Haddock comments SHOULD carry an
 [``@since``][haddock-since] annotation, stating what version of the library they
@@ -502,15 +502,15 @@ also the expected behaviour of its instances.
 ## Other
 
 Lists SHOULD NOT be field values of types; this extends to ``String``s. Instead,
-``Vector``s (``Text``s) SHOULD be used, unless a more appropriate structure exists. 
+``Vector``s (``Text``s) SHOULD be used, unless a more appropriate structure exists.
 On-chain code, due to a lack of alternatives, is one place lists can be used as
 field values of types.
 
 Partial functions MUST NOT be defined. Partial functions SHOULD NOT be used
 except to ensure that another function is total (and the type system cannot be
-used to prove it). 
+used to prove it).
 
-Derivations MUST use an explicit [strategy][deriving-strategies]. Thus, the 
+Derivations MUST use an explicit [strategy][deriving-strategies]. Thus, the
 following is wrong:
 
 ```haskell

bot-plutus-interface.cabal

@@ -25,9 +25,11 @@ source-repository head
 common common-lang
   ghc-options:
     -Wall -Wcompat -Wincomplete-record-updates
-    -Wincomplete-uni-patterns -Wredundant-constraints -Werror
-    -fobject-code -fno-ignore-interface-pragmas
-    -fno-omit-interface-pragmas -fplugin=RecordDotPreprocessor
+    -Wincomplete-uni-patterns -Wredundant-constraints -fobject-code
+    -fno-ignore-interface-pragmas -fno-omit-interface-pragmas
+    -fplugin=RecordDotPreprocessor
+
+  -- -Werror
 
   build-depends:
     , base                     ^>=4.14
@@ -80,6 +82,7 @@ library
     BotPlutusInterface.BodyBuilder
     BotPlutusInterface.CardanoCLI
     BotPlutusInterface.ChainIndex
+    BotPlutusInterface.Collateral
     BotPlutusInterface.Config
     BotPlutusInterface.Contract
     BotPlutusInterface.Effects
@@ -173,6 +176,7 @@ test-suite bot-plutus-interface-test
   ghc-options:    -fplugin-opt PlutusTx.Plugin:defer-errors
   other-modules:
     Spec.BotPlutusInterface.Balance
+    Spec.BotPlutusInterface.Collateral
     Spec.BotPlutusInterface.Config
     Spec.BotPlutusInterface.Contract
     Spec.BotPlutusInterface.ContractStats

cabal.project

@@ -4,6 +4,7 @@ packages: ./bot-plutus-interface.cabal
           ./examples/plutus-game/plutus-game.cabal
           ./examples/plutus-transfer/plutus-transfer.cabal
           ./examples/plutus-nft/plutus-nft.cabal
+          ./examples/debug/debug.cabal
 
 tests: true
 benchmarks: true

examples/debug/app/Main.hs

@@ -0,0 +1,11 @@
+module Main (main) where
+
+import TestRun qualified
+import Prelude
+
+{- | For running fast live tests using Plutip's local cluster,
+ needed only for debugging period
+-}
+main :: IO ()
+main = do
+  TestRun.testnetRun

examples/debug/debug.cabal

@@ -0,0 +1,109 @@
+cabal-version:      3.0
+name:               debug
+version:            0.1.0.0
+synopsis:           NFT example
+description:        NFT example running on the fake pab
+homepage:           https://github.com/mlabs-haskell/bot-plutus-interface
+bug-reports:        https://github.com/mlabs-haskell/bot-plutus-interface
+license:
+license-file:
+author:             MLabs
+maintainer:         gergely@mlabs.city
+copyright:          TODO
+build-type:         Simple
+tested-with:        GHC ==8.10.4
+extra-source-files: README.md
+
+source-repository head
+  type:     git
+  location: https://github.com/mlabs-haskell/bot-plutus-interface
+
+-- Common sections
+
+common common-lang
+  ghc-options:
+    -Wall -Wcompat -Wincomplete-record-updates
+    -Wincomplete-uni-patterns -Wredundant-constraints -fobject-code
+    -fno-ignore-interface-pragmas -fno-omit-interface-pragmas
+    -Wunused-packages -fplugin-opt PlutusTx.Plugin:defer-errors
+
+  -- -Werror
+
+  build-depends:      base ^>=4.14
+  default-extensions:
+    NoImplicitPrelude
+    BangPatterns
+    BinaryLiterals
+    ConstraintKinds
+    DataKinds
+    DeriveFunctor
+    DeriveGeneric
+    DeriveTraversable
+    DerivingStrategies
+    DerivingVia
+    DuplicateRecordFields
+    EmptyCase
+    FlexibleContexts
+    FlexibleInstances
+    GADTs
+    GeneralizedNewtypeDeriving
+    HexFloatLiterals
+    ImportQualifiedPost
+    InstanceSigs
+    KindSignatures
+    LambdaCase
+    MultiParamTypeClasses
+    NumericUnderscores
+    OverloadedStrings
+    ScopedTypeVariables
+    StandaloneDeriving
+    TemplateHaskell
+    TupleSections
+    TypeApplications
+    TypeFamilies
+    TypeOperators
+    TypeSynonymInstances
+    UndecidableInstances
+
+  default-language:   Haskell2010
+
+-- Libraries
+
+
+library
+  import:          common-lang
+  exposed-modules:
+    SomeDebugContract
+    TestRun
+    TimeDebugContract
+    Tools
+
+  build-depends:
+    , aeson
+    , bot-plutus-interface
+    , cardano-api
+    , containers
+    , data-default
+    , directory
+    , filepath
+    , plutus-contract
+    , plutus-ledger
+    , plutus-ledger-api
+    , plutus-ledger-constraints
+    , plutus-pab
+    , plutus-tx
+    , plutus-tx-plugin
+    , pretty-show
+    , random
+    , servant-client
+    , stm
+    , text
+    , uuid
+
+  hs-source-dirs:  src
+
+executable debug-run
+  import:         common-lang
+  build-depends:  debug
+  main-is:        Main.hs
+  hs-source-dirs: app

examples/debug/hie.yaml

@@ -0,0 +1,7 @@
+cradle:
+  cabal:
+    - path: "./src"
+      component: "lib:debug"
+
+    - path: "./app"
+      component: "exe:debug-run"

examples/debug/pab.conf

@@ -0,0 +1,19 @@
+cliLocation:        local
+chainIndexUrl:      "http://localhost:9083"
+networkId:          42
+scriptFileDir:      "./result-scripts"
+signingKeyFileDir:  "./signing-keys"
+txFileDir:          "./txs"
+metadataDir:        "./protocol.json"
+protocolParamsFile: "/metadata"
+dryRun:             true
+logLevel:           info
+ownPubKeyHash:      ""
+ownStakePubKeyHash: nothing
+tipPollingInterval: 10000000
+port:               9080
+enableTxEndpoint:   false
+collectStats:       false
+pcTxStatusPolling:
+  pollingInterval: 1000
+  pollingTimeout:  8

examples/debug/setup.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+
+# export CARDANO_NODE_SOCKET_PATH=/home/mike/dev/mlabs/net-setups/testnet-bpi-setup/socket/forwarded-node.socket
+export CARDANO_NODE_SOCKET_PATH="/home/mike/dev/mlabs/plutip-fixed-dir/node/node.socket"
+export PATH="$PWD/binaries:$PATH"
+export MAGIC=1097911063
+cardano-cli query tip --testnet-magic $MAGIC