docs update

Author: mikekeke

CHANGELOG.md

@@ -7,6 +7,24 @@ This format is based on [Keep A Changelog](https://keepachangelog.com/en/1.0.0).
 - Wallets with Base Address support
 - Lookups for wallets in tasty integration
 
+## [1.3.1] - 2022-10-26
+
+### Added
+
+- control on `chain-index` launch
+  - `chainIndexPort` in `PlutipConfig` replaced with `chainIndexMode :: ChainIndexMode`
+  - `local-cluster` options added: `--chain-index-port`, `--no-index`
+
+## [1.2.1] - 2022-10-25
+
+### Fixed
+
+- eDSL function to await till wallet is funded `awaitWalletFunded`
+
+### Added
+
+- package with example of how to execute arbitrary contract on private network from Haskell
+
 ## [1.2.0] - 2022-10-21
 
 ### Added

README.md

@@ -41,6 +41,7 @@ NOTE: This branch launches local network in `Vasil`. It was tested with node `1.
 ## Tutorials
 
 * [Running disposable local network and building own runners](./local-cluster/README.md)
+* [Running chain-index](./docs/running-chain-index.md)
 * [Tasty integration](./docs/tasty-integration.md)
 * [Running Contracts is REPL](./docs/interactive-plutip.md)
 * [Providing constant keys](./docs/constant-keys.md)

docs/running-chain-index.md

@@ -0,0 +1,7 @@
+# Running chain index
+
+It is possible to launch private network with or without `chain-index`.
+
+This can be configured via `PlutipConfig` using `chainIndexMode :: ChainIndexMode` field. BE AWARE, that `chain-index` is required to run contracts with `Plutip` in [tasty integration](./tasty-integration.md), [interactive mode](./interactive-plutip.md) or with [custom runner](../contract-execution/Main.hs).
+
+In case of `local-cluster` launch of `chain-index` can be controlled via options, see [readme](../local-cluster/README.md#available-arguments) for details.

local-cluster/Main.hs

@@ -180,20 +180,20 @@ pEpochSize =
 
 pChainIndexMode :: Parser ChainIndexMode
 pChainIndexMode =
-  withIndex <|> withIndexPort <|> pure NotNeeded
+  noIndex <|> withIndexPort <|> pure DefaultPort
   where
-    withIndex =
+    noIndex =
       Options.flag'
-        DefaultPort
-        ( Options.long "with-index"
+        NotNeeded
+        ( Options.long "no-index"
             <> Options.help "Start cluster with chain-index on default port"
         )
     withIndexPort = CustomPort <$> portParser
 
     portParser =
       Options.option
         Options.auto
-        ( Options.long "with-index-port"
+        ( Options.long "chain-index-port"
             <> Options.metavar "PORT"
             <> Options.help "Start cluster with chain-index on custom port"
         )

local-cluster/README.md

@@ -40,6 +40,8 @@ Full | Short | Description
 --working-dir /path/ | -w /path/ | This determines where the node database, chain-index database, and bot-plutus-interface files will be stored for a running cluster. If specified, this will store cluster data in the provided path (can be relative or absolute), the files will be deleted on cluster shutdown by default. Otherwise, the cluster data is stored in a temporary directory and will be deleted on cluster shutdown.
 --slot-len SECONDS | -s SECONDS | Sets slot length of created network, is seconds. E.g. `--slot-len 1s`, `-s 0.2s`. <br /> Addition of `s` is important for correct parsing of this option.
 --epoch-size NUM | -s NUM | Sets epoch size of created network, is slots.
+--slot-len SECONDS | -s SECONDS | Sets slot length of created network, is seconds. E.g. `--slot-len 1s`, `-s 0.2s`. <br /> Addition of `s` is important for correct parsing of this option.
+--chain-index-port PORT<br />or<br />--no-index| - | With `--chain-index-port` and `PORT` specified `chain-index` will be launched on specified port together with private network.<br /> With `--no-index` only private network will be launched without `chain-index`.<br /> When nothing specified `chain-index` will be launched on default port `9083`.<br />
 
 ## Making own local network launcher