Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.67 KB

QUICKSTART.md

File metadata and controls

45 lines (34 loc) · 1.67 KB

powHSM quickstart guide

Whether new to the project or just wanting to quickly get an environment up and running to e.g. verify binary hashes or run tests, here is a checklist that will get you sorted in no time:

Prerequisites

  • Make sure you have Docker installed.
  • If running MacOS, make sure you have also got coreutils installed (link using homebrew).
  • Build all required docker images:
~/repo> docker/mware/build # Middleware image
~/repo> docker/ledger/build # Ledger image
~/repo> docker/packer/build # Middleware binary packer image

Supported platforms

Unless otherwise stated, only x86 platforms are supported for building this project and running the tools provided. The only exception is the TCPSigner bundle, which can be built and ran in x86 and arm64 platforms.

Common tasks

  • Run tests:
~/repo> middleware/test-all # Middleware unit tests
~/repo> ledger/test/test-all # Ledger signer application tests
~/repo/ledger/src/signer/test/*> make test # Run ledger signer application unit tests
~/repo/ledger/src/common/test/*> make test # Run ledger common libraries unit tests
  • Build firmware binaries:
~/repo> ledger/build/build-signer <checkpoint> <difficulty> <network> # Build signer
~/repo> ledger/build/build-ui <signer_hash> <signer_iteration> <signers_file> # Build UI
  • Build middleware binaries:
~/repo> middleware/build/all
  • Build a complete powHSM distribution:
~/repo> ./build-dist <destination path> <checkpoint> <minimum difficulty> <network> <ui_iteration> <ui_authorizers>