codex-storage
/
codex-testnet-starter
mirror of https://github.com/codex-storage/codex-testnet-starter.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Codex Testnet Starter https://testnet.codex.storage
20 Commits 1 Branch 0 Tags 1.6 MiB
Shell 68.8%
Batchfile 31.2%
Go to file
Ben 8b7a561216
Nicer overview image 		2024-03-29 14:40:07 +01:00
docs Nicer overview image 2024-03-29 14:40:07 +01:00
.gitignore Feat/add geth init (#1) 2023-12-11 19:01:25 +02:00
README.md small readme update 2024-03-29 14:27:10 +01:00
USINGCODEX.md small readme update 2024-03-29 14:27:10 +01:00
docker-compose.yaml Add CODEX_DATA_DIR (#7) 2024-03-29 13:44:44 +02:00
genesis.json Update genesis.json with same as in the cluster (#6) 2024-03-29 13:28:46 +02:00
keys.txt Updates marketplace address 2024-01-15 15:48:00 +01:00

README.md

Codex Testnet Starter

Hit the ground running with Codex.

Overview

Overview Using the Testnet Starter, you can run a (mostly preconfigured) Codex node on your machine. You always have the option to build and run Codex from sources Here.

  1. How to start
  2. How to get ready
  3. How to use
  4. How to stop
  5. How to stop and delete everything
  6. Troubleshooting

How to start

  • Create an Ethereum public/private key pair.
  • Have Docker installed.
  • Have Discord installed.
  • Clone this repo.
  • Define variables: 
    export PRIV_KEY=9721fb80cf32275ce80ae41927130adc767d435dbb1d80114dac2ef2d7c951f0

# export CODEX_ETH_PROVIDER=https://rpc.testnet.codex.storage
# export GETH_VERBOSITY=4
  • docker-compose up -d

How to get ready

When starting the Testnet Starter for the first time, (or restarting after a long pause) please keep in mind:

  • Your local Geth node will need time to sync.
  • Codex should automatically wait until Geth is ready. However, in some situations Codex will attempt to start too soon and promptly crash. This is a known issue. When this happens, please manually restart Codex's container when your Geth node is synced.

Before you can use the marketplace functionality of Codex, you will need to obtain some tokens in the testnet.

  1. Join the Codex Discord server: [Here](LINK PENDING)
  2. Find the appropriate testnet channel.
  3. Give your public key to the bot using set command. Bot-Set
  4. Ask it politely to mint some tokens for you using mint command. Bot-Mint (It may or may not happen in the future that testnet participation will be rewarded automatically with Discord server roles.)

How to use

Once running, Codex exposes a web-api at the API port. (default: 8080) To read more about how to use the API, go Here

How to stop

  • docker-compose down

How to stop and delete everything

  • docker-compose down --rmi all -v

Troubleshooting

Geth

# List peers
docker exec -it geth geth attach --exec net.peerCount /data/geth.ipc

# Connected peers
docker exec -it geth geth attach --exec admin.peers /data/geth.ipc

# Add a peer
docker exec -it geth geth attach --exec 'admin.addPeer("enode://cff0c44c62ecd6e00d72131f336bb4e4968f2c1c1abeca7d4be2d35f818608b6d8688b6b65a18f1d57796eaca32fd9d08f15908a88afe18c1748997235ea6fe7@159.223.243.50:40010")' /data/geth.ipc

# Sync status
docker exec -it geth geth attach --exec eth.syncing /data/geth.ipc

# Geth own enode
docker exec -it geth geth attach --exec admin.nodeInfo.enode /data/geth.ipc