Skip to content

Commit

Permalink
docs(RREL-0015): clarify usage of mnemonic and privateKey
Browse files Browse the repository at this point in the history
  • Loading branch information
antomor committed Sep 21, 2023
1 parent 18662c1 commit e9aebcb
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
8 changes: 6 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ File [./config/default.json5](config/default.json5) contains all configuration p
register: {
stake: "0.01", // amount of stake to set up
funds: "0.02", // amount of funds to set up
mnemonic: "", // mnemonic to use for unlocking the account parameter
privateKey: "", // private key to retrieve the account address from
mnemonic: "", // mnemonic to use for unlocking the account parameter; DO NOT STORE IT HERE, use REGISTER_MNEMONIC as env variable.
privateKey: "", // private key to retrieve the account address from; DO NOT STORE IT HERE, use REGISTER_PRIVATE_KEY as env variable.
relayHub: "",
gasPrice: 60000000,
unstakeDelay: 1000,
Expand Down Expand Up @@ -208,6 +208,10 @@ Some of these options will be overrideable using environment variables defined i

```

> ### :warning: Warning
>
> Keep in mind that there neither `mnemonic` or `privateKey` are intended to be set in the file directly and doing it can lead to security issues. Please refer to the [server registration section](#server-registration) for further details.
</details>

To use these overrides, you'd prepend an environment variable, e.g.:
Expand Down
4 changes: 2 additions & 2 deletions config/default.json5
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@
register: {
stake: "0.01", // amount of stake to set up
funds: "0.02", // amount of funds to set up
mnemonic: "", // mnemonic to use for unlocking the account parameter
privateKey: "", // private key to retrieve the account address from
mnemonic: "", // mnemonic to use for unlocking the account parameter; DO NOT STORE IT HERE, use REGISTER_MNEMONIC as env variable.
privateKey: "", // private key to retrieve the account address from; DO NOT STORE IT HERE, use REGISTER_PRIVATE_KEY as env variable.
relayHub: "",
gasPrice: 60000000,
unstakeDelay: 1000,
Expand Down

0 comments on commit e9aebcb

Please sign in to comment.