ripple / opensource.ripple.com

Creative Commons Attribution 4.0 International
941 stars 28 forks source link

Missing $exrpd command in EVM Sidechain Devnet Documentation #68

Open jeongtai opened 1 year ago

jeongtai commented 1 year ago

Hello,

I was following the instructions on Join the EVM Sidechain Devnet page, and I noticed that there seems to be a missing step.

In the 'Pre-requisites' section, after creating an alias for exrpd, there's no instruction to actually run the $exrpd command. This could potentially lead to confusion for users who are not familiar with setting up aliases or using Docker.

Here is a suggestion for an additional step:

# Run exrpd
$ exrpd

And there is result when I run the $exrpd

Unable to find image 'peersyst/xrp-evm-blockchain:latest' locally
latest: Pulling from peersyst/xrp-evm-blockchain
f56be85fc22e: Pull complete
05aee0655c84: Pull complete
93746c630e3f: Pull complete
2a104fb99f3c: Pull complete
Digest: sha256:e081b783f5cf220496432694b9e5d909ae6e92fc37c2e104905ebaace886cb50
Status: Downloaded newer image for peersyst/xrp-evm-blockchain:latest
Ethermint Daemon

Usage:
  exrpd [command]

Available Commands:
  add-genesis-account Add a genesis account to genesis.json
  collect-gentxs      Collect genesis txs and output a genesis.json file
  config              Create or query an application CLI configuration file
  debug               Tool for helping with debugging your application
  export              Export state to JSON
  gentx               Generate a genesis tx carrying a self delegation
  help                Help about any command
  index-eth-tx        Index historical eth txs
  init                Initialize private validator, p2p, genesis, and application configuration files
  keys                Manage your application's keys
  migrate             Migrate genesis to a specified target version
  query               Querying subcommands
  rollback            rollback cosmos-sdk and tendermint state by one height
  rosetta             spin up a rosetta server
  start               Run the full node
  status              Query remote node for status
  tendermint          Tendermint subcommands
  testnet             subcommands for starting or configuring local testnets
  tx                  Transactions subcommands
  validate-genesis    validates the genesis file at the default location or at the location passed as an arg
  version             Print the application binary version information

Flags:
  -b, --broadcast-mode string    Transaction broadcasting mode (sync|async|block) (default "sync")
      --chain-id string          Specify Chain ID for sending Tx (default "testnet")
      --fees string              Fees to pay along with transaction; eg: 10aphoton
      --from string              Name or address of private key with which to sign
      --gas-adjustment float     adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored  (default 1)
      --gas-prices string        Gas prices to determine the transaction fee (e.g. 10aphoton)
  -h, --help                     help for exrpd
      --home string              directory for config and data (default "/root/.exrpd")
      --keyring-backend string   Select keyring's backend (default "os")
      --log_format string        The logging format (json|plain) (default "plain")
      --log_level string         The logging level (trace|debug|info|warn|error|fatal|panic) (default "info")
      --node string              <host>:<port> to tendermint rpc interface for this chain (default "tcp://localhost:26657")
      --trace                    print out full stack trace on errors

Use "exrpd [command] --help" for more information about a command.

After that, when I ran the command $exrpd config chain-id exrp_1440002-1 in the Initialize Node step, there was no error.

This might make it clearer for newcomers that they need to run exrpd after creating the alias.

Thank you!