Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/readme #50

Merged
merged 3 commits into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.MD → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,31 +36,38 @@ to:

Binaries for the latest version of `dkc` can be obtained from [the releases page](https://github.com/p2p-org/dkc/releases/latest).

### Nix

If you have nix flakes enabled you can run `dkc` using this command:

```sh
$ nix run github:p2p-org/dkc
```

### Source

`dkc` can be built locally using the command

```sh
go build .
$ go build .
```

## Usage

> [!CAUTION]
> Before you begin, make sure you backup keys and store recovered wallets and passwords securely.

`dkc` uses [herumi/bls-eth-go-binary](https://github.com/herumi/bls-eth-go-binary). Some research code of using [herumi/bls-eth-go-binary](https://github.com/herumi/bls-eth-go-binary) in `dkc` is available [here](./research/research.go)

You can test `dkc` on predefiened inputs [here](.github/workflows/func-tests.yml).
`dkc` uses [herumi/bls-eth-go-binary](https://github.com/herumi/bls-eth-go-binary). You can test `dkc` on predefiened inputs [here](.github/workflows/func-tests.yml).

### Config

An example config for each pair could be found [here](.github/examples/)

The example below shows how to convert wallets from `distributed` type to `hierarchical deterministic` type.

`Base-dir` for `distributed` wallets is located in `./i_wallet` see more info about `distributed` wallet file structure [here](#distributed)
`base-dir` for `distributed` wallets is located in `./i_wallet` see more info about `distributed` wallet file structure [here](#distributed)

`Base-dir` for `hierarchical deterministic` wallets is located in `./o_wallet` see more info about `hierarchical deterministic` wallet file structure [here](#hierarchical-deterministic)
`base-dir` for `hierarchical deterministic` wallets is located in `./o_wallet` see more info about `hierarchical deterministic` wallet file structure [here](#hierarchical-deterministic)

```yaml
input: #Input section
Expand Down
2 changes: 1 addition & 1 deletion nix/package.nix
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
}: let
inherit (inputs'.ethereum-nix.packages) mcl bls;
pname = "dkc";
version = "0.1.1";
version = "1.0.0";
dkc = pkgs.buildGoModule {
inherit pname version;
src = ../.;
Expand Down
72 changes: 0 additions & 72 deletions research/docker-compose.yaml

This file was deleted.

69 changes: 0 additions & 69 deletions research/research.go

This file was deleted.

Loading