Keosd Overview

The program keosd, located in the eos/build/programs/keosd folder within the EOSIO/eos repository, can be used to store private keys that cleos will use to sign transactions sent to the block chain. keosd runs on your local machine and stores your private keys locally.

For most users the easiest way to use keosd is to have cleos launch it automatically. Wallet files (named foo.wallet for example) will also be created in this directory by default.

Auto locking

By default keosd is set to auto lock your wallets after 15 minutes of inactivity. This is configurable in the config.ini. Be aware if you need to disable this feature you will have to set an enormous number -- setting it to 0 will cause keosd to always lock your wallet.

Launching keosd manually

It is possible to launch keosd manually simply with

$ keosd

By default, keosd creates the folder ~/eosio-wallet and populates it with a basic config.ini file. The location of the config file can be specified on the command line using the --config-dir argument. The configuration file contains the http server endpoint for incoming http connections and other parameters for cross origin resource sharing. Be aware that if you allowed cleos to auto launch keosd, a config.ini will be generated that will be sightly different than if you had launched keosd manually.

The location of the wallet data folder can be specified on the command line using the --data-dir argument.

Stopping keosd

The most effective way to stop keosd is to find the keosd process and send a SIGTERM signal to it. Note that because cleos auto-launches keosd, it is possible to end up with multiple instances of the keosd running. The following will find and terminate all instances.

$ pkill keosd

JSON RPC Endpoint

Because of security reason, wallet API is removed in nodeos. Currently wallet api plugin is alive, you may use it for now, but it will be completely removed and you will not be able to use API in nodeos anymore. Instead, you should use API in keosd directly.

But all endpoints are same as previous API. You just change domain into keosd's address and port. It uses 8900 in default. And you can find all endpoints in previous api version, then find WALLET section.

Other options

For a full list of possible options you can run keosd --help:

$ keosd --help
Application Options:

Config Options for eosio::http_plugin:
  --http-server-address arg (=
                                        The local IP and port to listen for
                                        incoming http connections; set blank to
  --https-server-address arg            The local IP and port to listen for
                                        incoming https connections; leave blank
                                        to disable.
  --https-certificate-chain-file arg    Filename with the certificate chain to
                                        present on https connections. PEM
                                        format. Required for https.
  --https-private-key-file arg          Filename with https private key in PEM
                                        format. Required for https
  --access-control-allow-origin arg     Specify the Access-Control-Allow-Origin
                                        to be returned on each request.
  --access-control-allow-headers arg    Specify the Access-Control-Allow-Header
                                        s to be returned on each request.
  --access-control-allow-credentials    Specify if Access-Control-Allow-Credent
                                        ials: true should be returned on each

Config Options for eosio::wallet_plugin:
  --wallet-dir arg (=".")               The path of the wallet files (absolute
                                        path or relative to application data
  --unlock-timeout arg (=900)           Timeout for unlocked wallet in seconds
                                        (default 900 (15 minutes)). Wallets
                                        will automatically lock after specified
                                        number of seconds of inactivity.
                                        Activity is defined as any wallet
                                        command e.g. list-wallets.
  --eosio-key arg                       eosio key that will be imported
                                        automatically when a wallet is created.

Application Config Options:
  --plugin arg                          Plugin(s) to enable, may be specified
                                        multiple times

Application Command Line Options:
  -h [ --help ]                         Print this help message and exit.
  -v [ --version ]                      Print version information.
  --print-default-config                Print default configuration template
  -d [ --data-dir ] arg                 Directory containing program runtime
  --config-dir arg                      Directory containing configuration
                                        files such as config.ini
  -c [ --config ] arg (=config.ini)     Configuration file name relative to
  -l [ --logconf ] arg (=logging.json)  Logging configuration file name/path
                                        for library users

Updated about a year ago

Keosd Overview

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.