Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/attestantio/dirk

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/attestantio/dirk
Owner: attestantio
License: apache-2.0
Created: 2020-08-09T21:09:02.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-08-28T08:51:31.000Z (5 months ago)
Last Synced: 2024-08-28T10:05:27.810Z (5 months ago)
Language: Go
Size: 915 KB
Stars: 73
Watchers: 6
Forks: 22
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

ultimate-defi-research-base - Ethereum 2.0 Distributed Remote Key Manager

README

        # Dirk

[![Tag](https://img.shields.io/github/tag/attestantio/dirk.svg)](https://github.com/attestantio/dirk/releases/)

[![License](https://img.shields.io/github/license/attestantio/dirk.svg)](LICENSE)

[![GoDoc](https://godoc.org/github.com/attestantio/dirk?status.svg)](https://godoc.org/github.com/attestantio/dirk)

[![Lint](https://github.com/attestantio/dirk/actions/workflows/golangci-lint.yml/badge.svg)](https://github.com/attestantio/dirk/actions/workflows/golangci-lint.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/attestantio/dirk)](https://goreportcard.com/report/github.com/attestantio/dirk)

An Ethereum 2 distributed remote keymanager, focused on security and long-term performance of signing operations.

## Table of Contents

- [Install](#install)

  - [Binaries](#binaries)

  - [Docker](#docker)

  - [Source](#source)

- [Usage](#usage)

- [Maintainers](#maintainers)

- [Contribute](#contribute)

- [License](#license)

## Install

### Binaries

Binaries for the latest version of `dirk` can be obtained from [the releases page](https://github.com/attestantio/dirk/releases/latest).

### 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:

```sh

go install github.com/attestantio/dirk@latest

```

## 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).

Although `dirk` can work with a single instance, it is best used with multiple instances and distributed keys.  Multiple instances allow high levels of resiliency and maintainability, providing a safer operating environment.

`dirk` is designed to "front load" expensive operations, providing an initial period on startup where signing operations may be slower whilst it caches information such as the presence (or not) of particular accounts.  One consequence of this is that `dirk` does not attempt to rescan its wallets for new keys created externally (although new distributed accounts are acknowledged as they are created by `dirk` itself).

## Documentation

The following documentation is available:

  - [Getting started](docs/getting_started.md) an introduction to configuring Dirk

  - [Distributed key generation](docs/distributed_key_generation.md) setting up multiple instances of Dirk to carry out distributed key generation

  - [Prometheus metrics](docs/metrics/prometheus.md) Prometheus metrics

  - [Configuration](docs/configuration.md) Sample annotated configuration file

  - [Permissions](docs/permissions.md) Detailed information about Dirk's permissions

  - [Slashing protection interchange](docs/interchange.md) importing and exporting slashing protection data

## Maintainers

Jim McDonald: [@mcdee](https://github.com/mcdee).

## Contribute

Contributions welcome. Please check out [the issues](https://github.com/attestantio/dirk/issues).

## License

[Apache-2.0](LICENSE) © 2020 - 2024 Attestant Limited.