Create a wallet with celestia-node
This tutorial will go over using the cel-key
utility to generate a wallet on celestia-node.
While this tutorial will go over installation process of cel-key
, it is recommended that you complete the following prerequisites first:
Once you completed the prerequisite, you can proceed with this tutorial.
Using the cel-key
utility
Inside the celestia-node repository is a utility called cel-key
that uses the key utility provided by Cosmos-SDK under the hood. The utility can be used to add
, delete
, and manage keys for any DA node type (bridge || full || light)
, or just keys in general.
Installation
You need to first pull down the celestia-node repository:
git clone https://github.com/celestiaorg/celestia-node.git
cd celestia-node/
git clone https://github.com/celestiaorg/celestia-node.git
cd celestia-node/
It can be built using either of the following commands:
# dumps binary in current working directory, accessible via `./cel-key`
make cel-key
# dumps binary in current working directory, accessible via `./cel-key`
make cel-key
or
# installs binary in GOBIN path, accessible via `cel-key`
make install-key
# installs binary in GOBIN path, accessible via `cel-key`
make install-key
For the purpose of this guide, we will use the make cel-key
command.
Steps for generating node keys
To generate a key for a Celestia node, select the tab for your node type:
TIP
You do not need to declare a network for Mainnet Beta. Refer to the chain ID section on the troubleshooting page for more information
./cel-key add <key-name> --keyring-backend test --node.type bridge \
--p2p.network <network>
./cel-key add <key-name> --keyring-backend test --node.type bridge \
--p2p.network <network>
./cel-key add <key-name> --keyring-backend test --node.type full \
--p2p.network <network>
./cel-key add <key-name> --keyring-backend test --node.type full \
--p2p.network <network>
./cel-key add <key-name> --keyring-backend test --node.type light \
--p2p.network <network>
./cel-key add <key-name> --keyring-backend test --node.type light \
--p2p.network <network>
This will load the key <key-name>
into the directory of the node.
Further flags you can use to customize your key are the following:
--p2p.network
: Specifies which network you want the key for. Values arearabica
andmocha
. Please note the default network will bemocha
.
Keep in mind that your celestia-node will only pick up keys that are inside the default directory under /keys
so you should make sure to point cel-key
utility to the correct directory via the p2p.network
or home
flags if you have specified a custom directory or network other than Arabica, Mocha, or Mainnet Beta.
Also keep in mind that if you do not specify a network with --p2p.network
, the default one will always be celestia
(Mainnet Beta).
Steps for exporting node keys
You can export a private key from the local keyring in encrypted and ASCII-armored format.
./cel-key export <key-name> --keyring-backend test --node.type bridge \
--p2p.network <network>
./cel-key export <key-name> --keyring-backend test --node.type bridge \
--p2p.network <network>
./cel-key export <key-name> --keyring-backend test --node.type full \
--p2p.network <network>
./cel-key export <key-name> --keyring-backend test --node.type full \
--p2p.network <network>
./cel-key export <key-name> --keyring-backend test --node.type light \
--p2p.network <network>
./cel-key export <key-name> --keyring-backend test --node.type light \
--p2p.network <network>
Steps for importing node keys
To import from a mnemonic, use the following command, then enter your bip39 mnemonic:
./cel-key add <key-name> --recover --keyring-backend test \
--node.type bridge --p2p.network <network>
./cel-key add <key-name> --recover --keyring-backend test \
--node.type bridge --p2p.network <network>
./cel-key add <key-name> --recover --keyring-backend test \
--node.type full --p2p.network <network>
./cel-key add <key-name> --recover --keyring-backend test \
--node.type full --p2p.network <network>
./cel-key add <key-name> --recover --keyring-backend test \
--node.type light --p2p.network <network>
./cel-key add <key-name> --recover --keyring-backend test \
--node.type light --p2p.network <network>
View all options for cel-key
./cel-key --help
./cel-key --help
Docker and cel-key
Prerequisites
- Docker installed on your machine
- Understanding of the guide on how to run celestia-node with Docker.
Running your node
Run the Docker image (in this example, we are using a light node on Mocha testnet):
docker run --name celestia-node -e NODE_TYPE=light -e P2P_NETWORK=mocha -p 26659:26659 \
ghcr.io/celestiaorg/celestia-node:v0.18.2-mocha celestia light start \
--core.ip rpc-mocha.pops.one --p2p.network mocha
docker run --name celestia-node -e NODE_TYPE=light -e P2P_NETWORK=mocha -p 26659:26659 \
ghcr.io/celestiaorg/celestia-node:v0.18.2-mocha celestia light start \
--core.ip rpc-mocha.pops.one --p2p.network mocha
TIP
Refer to the ports section of the celestia-node troubleshooting page for information on which ports are required to be open on your machine.
You do not need to declare a network for Mainnet Beta. Refer to the chain ID section on the troubleshooting page for more information
List active containers in another window with:
docker ps
docker ps
The response will look like:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
<container-id> celestia-node "/entrypoint.sh cele…" 22 seconds ago Up 21 seconds 2121/tcp docker-compose-test-celestia-1
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
<container-id> celestia-node "/entrypoint.sh cele…" 22 seconds ago Up 21 seconds 2121/tcp docker-compose-test-celestia-1
Interact with the container by replacing <container-id>
for the container ID:
docker exec -ti <container-id> /bin/bash
docker exec -ti <container-id> /bin/bash
Now, interact with cel-key
to check for the key that was autogenerated when you started the node:
./cel-key list --keyring-backend test --node.type light
./cel-key list --keyring-backend test --node.type light
You can also export your key from the container. In the next section, you'll learn how to mount existing keys to the container.
Mounting existing keys to container
In this example, we'll be mounting an existing key to the container. We're also using an existing image called celestia-node. This will mount the entire /.celestia-light-<p2p-network>/keys
directory to your image, or on Mainnet Beta the /.celestia-light/keys
directory.
Write a docker-compose.yml
to accomplish this:
version: "3.8"
services:
celestia:
image: celestia-node
environment:
- NODE_TYPE=light
command: celestia light start --core.ip rpc-mocha.pops.one --p2p.network mocha --keyring.keyname my_celes_key
volumes:
- ${PWD}/keys:/root/.celestia-light-mocha-4/keys
ports:
- 26659:26659
version: "3.8"
services:
celestia:
image: celestia-node
environment:
- NODE_TYPE=light
command: celestia light start --core.ip rpc-mocha.pops.one --p2p.network mocha --keyring.keyname my_celes_key
volumes:
- ${PWD}/keys:/root/.celestia-light-mocha-4/keys
ports:
- 26659:26659
Start the container by running the following command in the directory with your docker-compose.yml
:
docker-compose up
docker-compose up
List active containers in another window with:
docker ps
docker ps
The response will look like:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
<container-id> celestia-node "/entrypoint.sh cele…" 22 seconds ago Up 21 seconds 2121/tcp docker-compose-test-celestia-1
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
<container-id> celestia-node "/entrypoint.sh cele…" 22 seconds ago Up 21 seconds 2121/tcp docker-compose-test-celestia-1
Interact with the container by replacing <container-id>
for the container ID:
docker exec -ti <container-id> /bin/bash
docker exec -ti <container-id> /bin/bash
Now, interact with cel-key
to check your address matches the address you expect with the key you mounted:
root@<container-id>:/# ./cel-key list --keyring-backend test --node.type light
using directory: ~/.celestia-light-mocha-4/keys
- address: celestia1wkhyhr7ngf0ayqlpnsnxg4d72hfs5453dvunm9
name: my_celes_key
pubkey: '{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"A1/NsoY0RGL7Hqt4VWLg441GQKJsZ2fBUnZXipgns8oV"}'
type: local
root@<container-id>:/# ./cel-key list --keyring-backend test --node.type light
using directory: ~/.celestia-light-mocha-4/keys
- address: celestia1wkhyhr7ngf0ayqlpnsnxg4d72hfs5453dvunm9
name: my_celes_key
pubkey: '{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"A1/NsoY0RGL7Hqt4VWLg441GQKJsZ2fBUnZXipgns8oV"}'
type: local