Skip to content

Instantly share code, notes, and snippets.

@ccdle12
Last active August 5, 2019 13:21
Show Gist options
  • Save ccdle12/9cf1082631571310ef070c4cfb71438e to your computer and use it in GitHub Desktop.
Save ccdle12/9cf1082631571310ef070c4cfb71438e to your computer and use it in GitHub Desktop.
Notes on the Grin Mimble Wimble Project

Grin

Project Structure

  • src: The entry point of the daemon, also has the commandline interface binaries.
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── README.md
├── SECURITY.md
├── api
├── azure-pipelines.yml
├── chain
├── config
├── core
├── doc
├── etc
├── keychain
├── p2p
├── pool
├── rustfmt.toml
├── servers
├── src
├── store
├── target
└── util

src

Holds the command line interface binaries and code.

$ grin client

Shows the available commands to iteract with the grin server

Communicates with the Grin server

USAGE:
    grin client [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    ban                   Ban peer
    help                  Prints this message or the help of the given subcommand(s)
    listconnectedpeers    Print a list of currently connected peers
    status                Current status of the Grin chain
    unban                 Unban peer

$grin server

Runs the grin Daemon.

Control the Grin server

USAGE:
    grin server [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -a, --api_port <api_port>          Port on which to start the api server (e.g. transaction pool api)
    -c, --config_file <config_file>    Path to a grin-server.toml configuration file
    -p, --port <port>                  Port to start the P2P server on
    -s, --seed <seed>                  Override seed node(s) to connect to
    -w, --wallet_url <wallet_url>      The wallet listener to which mining rewards will be sent

SUBCOMMANDS:
    config    Generate a configuration grin-server.toml file in the current directory
    help      Prints this message or the help of the given subcommand(s)
    run       Run the Grin server in this console
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment