From 9b5aa4e2e609cda152a7e22526d0d91cf0350097 Mon Sep 17 00:00:00 2001 From: Sam Ricotta Date: Wed, 11 Dec 2024 13:00:56 +0200 Subject: [PATCH] comments --- covenant-signer/docs/transition-from-phase1.md | 17 ++++++++++------- docs/covenant-emulator-setup.md | 4 ++-- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/covenant-signer/docs/transition-from-phase1.md b/covenant-signer/docs/transition-from-phase1.md index d28f15f..3a56d7a 100644 --- a/covenant-signer/docs/transition-from-phase1.md +++ b/covenant-signer/docs/transition-from-phase1.md @@ -225,7 +225,9 @@ One you have the `babylond` binary installed, navigate to the directory you want to set up your keyring and run: ```shell -babylond keys import-hex cov fe1c56c494c730f13739c0655bf06e615409870200047fc65cdf781837cf7f06 --keyring-backend file +babylond keys import-hex cov fe1c56c494c730f13739c0655bf06e615409870200047fc65cdf781837cf7f06 \ + --keyring-backend file \ + --keyring-dir /path/to/your/keyring/directory ``` This command: @@ -236,10 +238,12 @@ This command: The passphrase you set here will be needed later on, keep this in mind. -> ⚡ Note: Use the `file` backend to store the private key in encrypted form on -> disk. When running `import-hex` with the encrypted file backend, you will be -> prompted for a passphrase. This passphrase will be required to unlock the signer -> later. +> ⚡ Note: While both `os` and `file` backends are supported, we recommend +using the `file` backend as it has been thoroughly tested across different +environments. The `file` backend stores the private key in encrypted form +on disk. When running `import-hex` with the `file` backend, you will be +prompted for a passphrase. This passphrase will be required to unlock the +signer later. To confirm that the import was successful, run: @@ -312,8 +316,7 @@ Below are brief explanations of the configuration entries: ### 4.2. Starting the daemon -We will then run the following command to start the daemon from the -`covenant-signer` directory: +We will then run the following command to start the daemon: ```shell covenant-signer start --config ./path/to/config.toml diff --git a/docs/covenant-emulator-setup.md b/docs/covenant-emulator-setup.md index e75511b..f13ded5 100644 --- a/docs/covenant-emulator-setup.md +++ b/docs/covenant-emulator-setup.md @@ -167,7 +167,7 @@ signs signatures and interacts with Babylon. Use the following command to genera the key: ```bash -$ covd create-key --key-name --chain-id bbn-test-5 --keyring-backend +covd create-key --key-name --chain-id bbn-test-5 --keyring-backend { "name": "covenant-key", "public-key": "9bd5baaba3d3fb5a8bcb8c2995c51793e14a1e32f1665cade168f638e3b15538" @@ -192,7 +192,7 @@ address. You can start the covenant emulator daemon using the following command: ```bash -$ covd start +covd start 2024-01-05T05:59:09.429615Z info Starting Covenant Emulator 2024-01-05T05:59:09.429713Z info Covenant Emulator Daemon is fully active! ```