Skip to content

Commit

Permalink
chore: remove unneeded deltas
Browse files Browse the repository at this point in the history
  • Loading branch information
EclesioMeloJunior committed Aug 10, 2023
1 parent 426fd88 commit b8ef3f8
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions cmd/gossamer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ cd gossamer
### Compile

To put the binary in ./bin, run:

```bash
make build
```
Expand Down Expand Up @@ -63,7 +62,7 @@ The node configuration can be modified in the `config.toml` file.
### Start the node

```bash
gossamer --basepath /tmp/gossamer --key alice
gossamer --basepath /tmp/gossamer --key alice
```

**Note: The `init` command is optional. If the node is not initialised, it will be initialised with the default configuration.**
Expand Down Expand Up @@ -109,22 +108,19 @@ This subcommand provides capabilities that are similar to
[Parity's Subkey utility](https://docs.substrate.io/v3/tools/subkey).

The account command supports following arguments:

- `generate` - generates a new key pair; specify `--scheme ed25519`, `--scheme secp256k1`, or `--scheme sr25519` (default)
- `list` - lists the keys in the Gossamer keystore
- `import` - imports a key from a keystore file
- `import-raw` - imports a raw key from a keystore file

Supported flags:

- `keystore-path` - path to the Gossamer keystore
- `keystore-file` - path to the keystore file
- `chain` - path to the human-readable chain-spec file
- `--scheme` - `ed25519`, `secp256k1`, or `sr25519` (default)
- `--password` - allows the user to provide a password to either encrypt a generated key or unlock the Gossamer keystore

Examples:

- `gossamer account generate --scheme ed25519` - generates an `ed25519` key pair
- `gossamer account list` - lists the keys in the Gossamer keystore
- `gossamer account import --keystore-file keystore.json` - imports a key from a keystore file
Expand All @@ -149,7 +145,6 @@ represent the Gossamer default configuration.
- `--output-path` - path to the file where the compiled chain-spec should be written

Examples:

- `gossamer build-spec --chain chain-spec.json --output-path compiled-chain-spec.json` - compiles a human-readable
chain-spec into a format that Gossamer can consume
- `gossamer build-spec --chain chain-spec.json --raw --output-path compiled-chain-spec.json` - compiles a human-readable
Expand All @@ -171,7 +166,6 @@ of a JSON file. The input for this subcommand can be retrieved from
- `--chain` - path to the human-readable chain-spec file

Examples:

- `gossamer import-state --first-slot 1 --header header.json --state state.json --chain chain-spec.json` - seeds Gossamer
storage with key-value pairs from a JSON file

Expand All @@ -191,7 +185,6 @@ What follows is a list that describes the services and capabilities that inform

#### State

// TODO: update the `State` description to pebble db
This service is a wrapper around an instance of [`chaindb`](https://github.com/ChainSafe/chaindb), a key-value database
that is built on top of [BadgerDB](https://github.com/dgraph-io/badger) from [Dgraph](https://dgraph.io/). The state
service provides storage capabilities for the other Gossamer services - each service is assigned a prefix that is added
Expand Down Expand Up @@ -278,4 +271,4 @@ capabilities are defined in the [dot/telemetry](../../dot/telemetry) package and
The default listening address for Prometheus metrics is `localhost:9876`, and Gossamer allows the user to configure this parameter with the
`--metrics-address` command-line parameter. The Gossamer telemetry server publishes telemetry data that is compatible with
[Polkadot Telemetry](https://github.com/paritytech/substrate-telemetry) and
[its helpful UI](https://telemetry.polkadot.io/).
[its helpful UI](https://telemetry.polkadot.io/).

0 comments on commit b8ef3f8

Please sign in to comment.