Skip to content

Add instructions for using TMKMS with Mars #7

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.

Sign up for GitHub

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

Open
keefertaylor wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add instructions for using TMKMS with Mars #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 38 additions & 1 deletion docs/validate/validators/key-management/tmkms.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,41 @@ sidebar_position: 5

# TMKMS

## TBD
You can enable remote signing with `TMKMS`, a [key management tool for Tendermint validators](https://github.com/iqlusioninc/tmkms). You can install TMKMS by [following the provided instructions](https://github.com/iqlusioninc/tmkms#installation) from the TMKMS maintainers.

To enable remote signing, edit your `.mars/config/config.toml` to read

```
priv_validator_laddr = "tcp://0.0.0.0:26658"
```

You'll then need to edit `tmkms.toml` to be configured with the Mars network. A sample configuration is provided below.
```
# Tendermint KMS configuration file
## Chain Configuration
### Mars Network

[[chain]]
id = "mars-1"
key_format = { type = "cosmos-json", account_key_prefix = "marspub", consensus_key_prefix = "marsvalconspub" }
state_file = "/home/user/tmkms/state/mars-1-consensus.json"

## Signing Provider Configuration
### YubiHSM2 Provider Configuration

[[providers.yubihsm]]
adapter = { type = "usb" }
auth = { key = <VALIDATOR AUTH KEY NUMBER>, password_file = "<PASSWORD FILE>" }
keys = [
{ key = <MARS CONSENSUS KEY NUMBER>, type = "consensus", chain_ids = ["mars-1"] },
]

## Validator Configuration

[[validator]]
chain_id = "mars-1"
addr = "tcp://<YOUR VALIDATOR IP>:<YOUR VALIDATOR LISTEN ADDRESS (default 26658)>"
secret_key = "/home/user/tmkms/secrets/kms-identity.key"
protocol_version = "v0.34"
reconnect = true
```