dirk

README

Dirk

An Ethereum 2 distributed remote keymanager.

Table of Contents

• Install
  • Binaries
  • Docker
  • Source
• Usage
• Maintainers
• Contribute
• License

Install

Binaries

Binaries for the latest version of dirk can be obtained from the releases page.

Docker

You can obtain the latest version of dirk using docker with:

docker pull attestant/dirk

Source

dirk is a standard Go module which can be installed with:

go get github.com/attestantio/dirk

Usage

dirk provides an interface to wallet operations such as listing accounts and signing requests. The daemon provides a number of security measures to avoid unauthorised uses of the private keys, and protection against invalid actions (e.g. slashing events).

Documentation

The following documentation is available:

• Getting started an introduction to configuring Dirk
• Distributed key generation setting up multiple instances of Dirk to carry out distributed key generation
• Prometheus metrics Prometheus metrics
• Configuration Sample annotated configuration file
• Permissions Detailed information about Dirk's permissions
• Slashing protection interchange importing and exporting slashing protection data

Maintainers

Jim McDonald: @mcdee.

Contribute

Contributions welcome. Please check out the issues.

License

Apache-2.0 © 2020 Attestant Limited.