Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 4.71 KB

README.md

File metadata and controls

66 lines (47 loc) · 4.71 KB
Raw

Disposable private network with chain-index

Plutip's local-cluster executable can start a local network of several nodes (4 currently) and provide access to the socket of one of the nodes for arbitrary interactions. Users can also fund several addresses to work with and get .vkey's and .skey's for them (this addresses could also be referenced as "wallets" further in the documentation).

User can interact with the network until the executable is stopped. After that network will be disposed and new launch will start the network from scratch.

The node socket path as well as funded addresses and their public key hashes can be obtained from console output.

NOTE: This branch launches local network in Vasil and was tested with node 1.35.3. Please use appropriate node version if running w/o Nix.

chain-index is started on port 9083.

Usage

The local cluster can be started by running

nix build .#plutip:exe:local-cluster  
./result/bin/local-cluster

or

nix develop
cabal run local-cluster

When you see in terminal message like "Cluster is running. Press Enter to stop." it means that the local network started successfully and all desired wallets are created and funded.

Available arguments

Full Short Description
--wallets NUM -n NUM Creates NUM wallets and saves keys into a default directory and also to a user-specified directory if the --wallet-dir argument is used. Defaults to 1 if not specified, and can be set to 0 if you do not wish to create any wallets.
--wallet-dir /path/ -d /path/ If specified, saves the wallet keys to an extra directory specified by the user. This is useful if you wish to have wallet keys easily accessible by other code or tools.
--ada AMOUNT -a AMOUNT Puts AMOUNT Ada into each UTxO in every wallet created. This defaults to 10,000 ADA. If you wish to specify an additional amount in Lovelace, you can use the --lovelace argument below. Note that if you want to specify the amount to create entirely in Lovelace, you'll have to use -a0 --lovelace AMOUNT.
--lovelace AMOUNT -l AMOUNT Puts AMOUNT Lovelace into each UTxO in every wallet created, in addition to the amount specified by the --ada argument. Note that if you don't specify the amount of ADA to add, the total amount will be 10,000 ADA + AMOUNT lovelace.
Note that both --ada and --lovelace can not be 0 at the same time.
--utxos NUM -u NUM Create NUM UTxOs in each wallet created. Note that each UTxO created has the amount of ADA determined by the --ada and --lovelace arguments.
--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.
Addition of s is important for correct parsing of this option.
--epoch-size NUM -e NUM Sets epoch size of created network, is slots.
--chain-index-port PORT
or
--no-index		 - With --chain-index-port and PORT specified chain-index will be launched on specified port together with private network.
With --no-index only private network will be launched without chain-index.
When nothing specified chain-index will be launched on default port 9083.
--dump-info-json /path/
or
--dump-info-json		 - Sets a path for which to write some preliminary runtime information (wallets and node socket). Defaults to ./local-cluster-info.json

Making own local network launcher

The Main.hs module can serve as an example of how to make your own executable for starting local cluster with funded wallets. Note that when a wallet is added with addSomeWallet it is recommended to wait some time (2-3 seconds) with waitSeconds while funding transactions are sent and confirmed.

It is also possible to run arbitrary contracts (of type Contract w s e a) using runContract and runContractWithLogLvl from Test.Plutip.Contract module, e.g.:

main :: IO ()
main = do
  let executeContract wallet contract =
     ask >>= \cEnv -> runContract cEnv wallet contract
     
  (st, _) <- startCluster def $ do
    w <- addSomeWallet [100_000_000, 10_000_000] -- 10 Ada will be used as collateral
    awaitWalletFunded w 1
    result <- executeContract w someContract
    doSomething result
  stopCluster st

For working example see contract-execution.