This docker compose file is starting following containers:
- apex-relay (standalone, prerequisite for dbsync and wallet-api)
- postgres (standalone, prerequisite for dbsync and blockfrost)
- dbsync (requires apex-relay and postgres)
- blockfrost (requires postgres and consequently dbsync to keep it up to date)
- wallet-api (requires apex-relay)
- icarus (requires wallet-api)
- ogmios (requires apex-relay)
The docker compose file is envisioned as example of available tooling and will start all of them in sequence. It is safe to start this compose setup alongside of existing vector testnet compose file in local settings they will not collide as they are started on different ports and use different docker volumes as long as they are started from separate folders (as they target the same genesis/config/node-ipc subfolders). Feel free to exclude/modify listed services as per your requirements, following the dependency comments.
For detals consult the docker compose file but at the time of writing, the followinge versions apply:
| Component | Version | Docker registry |
|---|---|---|
| apex-relay | 8.7.3 | ghcr.io/intersectmbo/cardano-node |
| postgres | 14.10-alpine | postgres |
| dbsync | 13.2.0.1 | ghcr.io/intersectmbo/cardano-db-sync |
| blockfrost | v1.7.0 | blockfrost/backend-ryo |
| wallet-api | 2023.12.18 | cardanofoundation/cardano-wallet |
| icarus | v2023-04-14 | piotrstachyra/icarus |
| ogmios | v6.1.0 | cardanosolutions/ogmios |
The additional info can be found in following files:
- WALLET.md (some information about
wallet-cliand mnemonics handling) - TRANSACIONS.md (short recap of
cardano-cliand simple transaciton handling)
- intel based linux system (this was tested on)
- docker with compose
- network
Run:
docker compose up -d
This is a relay node connected to a running prime3-testnet network. All cardano-cli commands apply as usual. For example:
To check the tip (at the moment it is about 10 min to sync, will definitely vary over time):
docker exec -it prime3-testnet-tools-v3-apex-relay-1 cardano-cli query tip --testnet-magic 1133 --socket-path /ipc/node.socket
DbSync is indexer created as ETL tool coprised of three components:
- running node relay (to track blockchain state)
- dbsync etl tool (to react to block events, parse them and store them to postgres database)
- postgres database
Credentials to access the postgres database are in secrets/dbsync/ folder.
Blockfrost is an instant, highly optimized and accessible API as a Service that serves as an alternative access to the Cardano blockchain and related networks, with extra features.
For blockfrost api consult the online documentation.
To check the blockfrost point a browser to localhost port 3030, for example:
http://localhost:3030
http://localhost:3030/epochs/latest
Wallet API provides an HTTP Application Programming Interface (API) and command-line interface (CLI) for working with wallets. It also featuers a lightweight frontend web interface called Icarus.
For wallet-api consult the online documentation.
To check the wallet-api point a browser to localhost port 8190, for example:
http://localhost:8190/v2/network/information
http://localhost:8190/v2/network/clock
To check the icarus wallet-api ui point a browser to localhost port 4455 and then click Connect button, for example:
http://localhost:4455/
http://localhost:4455/network-info
Note that if you are also running a vector testnet compose setup on the same machine you can connect icarus from either prime or vector setup on either wallet-api by targetting the desired one. Default ports for them are 8190 for prime testnet and 8090 for vector testnet.
For ogmios api consult the online documentation.
To check ogmios http api point a browser to localhost port 1377, for example:
http://localhost:1377/
To remove containers and volumes, images will be left for fast restart:
docker compose down
docker volume rm \
prime3-testnet-tools-v3_db-sync-data \
prime3-testnet-tools-v3_node-db \
prime3-testnet-tools-v3_node-ipc \
prime3-testnet-tools-v3_postgres \
prime3-testnet-tools-v3_wallet-api-data