Skip to content

Commit

Permalink
Merge branch 'update-doc' into 'dev'
Browse files Browse the repository at this point in the history
add new configs

See merge request ergo/rosen-bridge/operation!29
  • Loading branch information
vorujack committed Jun 10, 2024
2 parents 6cfc60a + 2ea72cd commit 9197b10
Showing 1 changed file with 61 additions and 13 deletions.
74 changes: 61 additions & 13 deletions docs/guard/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,52 @@ cardano:
coldStorageAddress: ''
```

## Bitcoin

### Network

Specify your network. If you are using esplora, set `chainNetwork` field as
`esplora` and set your esplora url.

```yaml
bitcoin:
chainNetwork: 'esplora' # 'esplora'
esplora:
url: 'https://blockstream.info'
```

### Address Info

Other than network, you need to specify generated public key in `key generation ceremony`, chain code and derivation path selected by moderator and cold storage address on bitcoin.

```yaml
bitcoin:
bankPublicKey: 'GENERATED_PUBLIC_KEY'
coldStorageAddress: 'COLD_ADDRESS'
tssChainCode: ''
derivationPath:
-
```

> **NOTE**: Leave `coldStorageAddress` empty for now. This field will be set
in further notice.

### Overall

Your Bitcoin config will be something like this:

```yaml
bitcoin:
chainNetwork: 'esplora' # 'esplora'
esplora:
url: 'https://blockstream.info'
bankPublicKey: 'GENERATED_PUBLIC_KEY'
coldStorageAddress: ''
tssChainCode: ''
derivationPath:
-
```

## Ergo

### Network
Expand Down Expand Up @@ -283,15 +329,19 @@ between all guards, so get these values from moderator. The structure will be:
```yaml
tss:
secret: 'TSS_SECRET'
publicKeys:
- 'PK_1'
- 'PK_2'
- 'PK_3'
...
ks:
- 'SHARE_1'
- 'SHARE_2'
- 'SHARE_3'
pubs:
- curvePub: 'PK_1' # ECDSA
edwardPub: 'PK_1' # EdDSA
curveShareId: 'SHARE_1'
edwardShareId: 'SHARE_1'
- curvePub: 'PK_2' # ECDSA
edwardPub: 'PK_2' # EdDSA
curveShareId: 'SHARE_2'
edwardShareId: 'SHARE_2'
- curvePub: 'PK_3' # ECDSA
edwardPub: 'PK_3' # EdDSA
curveShareId: 'SHARE_3'
edwardShareId: 'SHARE_3'
...
```

Expand All @@ -301,10 +351,6 @@ tss:

Keep the config provided by keygen moderator for `key generation ceremony`.

## Keygen

Keygen mode should be deactivated. Delete whole `keygen` section from your config file.

## Mnemonic

Specify your Ergo address mnemonic under `guard` path:
Expand Down Expand Up @@ -405,6 +451,8 @@ api:
apiKeyHash: ''
cardano:
...
bitcoin:
...
ergo:
...
reward:
Expand Down

0 comments on commit 9197b10

Please sign in to comment.