Skip to content

Latest commit

 

History

History
 
 

scripts

README.md

Cardano SL Scripts

This directory contains Bash scripts we use for different tasks (e.g. building, launching, CI).

Build

  • build/cardano-sl.sh - build Cardano SL, both in dev and prod modes.

Please note that running mode depends on building mode! E.g. if you built Cardano SL in dev mode, it will run in dev mode as well, and if you built it in prod mode, it will run in prod mode as well.

Launch

  • launch/demo.sh - run nodes in tmux-session (3 nodes by default).
  • launch/demo-nix.sh - run demo cluster using nix with 4 core nodes, 1 relay, 1 wallet in background
  • launch/demo-with-wallet-api.sh - run nodes in tmux-session, with enabled wallet web API (3 nodes by default).
  • launch/kill-demo.sh - kill tmux-session with running nodes.
  • launch/testnet-{public,staging}.sh - connect one node to the cluster (testnet or testnet staging
  • launch/update-scenario.sh - scenario for testing of update mechanism.
  • launch/wallet.sh - helper script for launch/update-scenario.sh.

Bench

Analyze

  • analyze/blocks.sh - analyze node logs: search information about block creation.
  • analyze/block-events.sh - analyze node logs: search information about different block-related events.

AVVM

  • avvm-files/full_blacklist.js - file for cardano-keygen. It contains a list of blacklisted addresses.
  • avvm-files/utxo-dump-last-new.json - file for cardano-keygen. It contains AVVM stakes data.

Clean

  • clean/db.sh - clean Cardano SL DB data.
  • clean/all.sh - do previous steps and clean .stack-work directory as well (in this case full rebuilding is required).

Generate

  • generate/certificates.sh - generate certificates using postvend-app. Please make sure you have postvend-cli command in your PATH.
  • generate/genesis.sh - generate keys using cardano-keygen.

Haskell

  • haskell/lint.sh - hlint command for Cardano SL source code. It uses HLint.hs-settings (from the project's root).
  • haskell/stylish.sh - stylish-haskell command for Cardano SL source code.
  • haskell/update-cabal-versions.sh - update Cardano SL version in all .cabal-files.
  • haskell/recover-from-stack-clean.sh - useful if you're using Atom editor with haskell-ghc-mod.

CI

Please note that these scripts are for CI only (we use Buildkite and AppVeyor). These scripts rely on specific environment variables, so manual running of these scripts on your machine is not implied.

  • ci/ci.sh - main script for Buildkite CI.
  • ci/update-cli-docs.sh - update Cardano SL CLI Options chapter.
  • ci/update-haddock.sh - update Haddock-documentation for Cardano SL source code.
  • ci/update-wallet-web-api-docs.sh - update Cardano SL Wallet Web API chapter.
  • ci/update-explorer-web-api-docs.sh - update Cardano SL Explorer Web API chapter.
  • ci/appveyor-retry.cmd - command we use in appveyor.yml configuration file.

Common

  • common-functions.sh - different Bash-functions we call in other scripts.
  • grep.sh - search in Cardano SL source code.