Skip to main content

Getting Started

Installation​

npm install -g @harmoniclabs/mutexo-server

if the installation was successfull you should be able to run

mutexo-server --version

which should output something like this

0.2.0

Cardano node​

Before running mutexo-server you will need a properly working Cardano node running for the tool to connect to.

cardano-node quickstart​

Here we'll go over some quick comands to quicly setup a node in preprod testnet.

First create a fresh directory if you don't have already one to work in

mkdir tmp-cardano
cd tmp-cardano
```synced
#### installation

If you don't already have one, install the `cardano-node` binaries from the [official github repository](https://github.com/IntersectMBO/cardano-node/releases/)

once you have the binaries, move or copy them in a directory where the computer can find it.

In linux usually `/usr/bin` should work

```shell
cp path/to/binary/cardano-node /usr/bin/cardano-node

if you have installed it correctly running

cardano-node --version

should work without errors.

running​

Once you have the node, inside our directory, we'll create a place for all the configurations files the cardano node needs

mkdir config_files
cd config_files

where we'll fetch the files needed as described in the cardano-node documentation

curl -O -J https://book.play.dev.cardano.org/environments/preprod/config.json
curl -O -J https://book.play.dev.cardano.org/environments/preprod/db-sync-config.json
curl -O -J https://book.play.dev.cardano.org/environments/preprod/submit-api-config.json
curl -O -J https://book.play.dev.cardano.org/environments/preprod/topology.json
curl -O -J https://book.play.dev.cardano.org/environments/preprod/byron-genesis.json
curl -O -J https://book.play.dev.cardano.org/environments/preprod/shelley-genesis.json
curl -O -J https://book.play.dev.cardano.org/environments/preprod/alonzo-genesis.json
curl -O -J https://book.play.dev.cardano.org/environments/preprod/conway-genesis.json

with this configuration files we can go back

cd ..

and finally we can run the node

cardano-node run \
   --topology ./config_files/topology.json \
   --database-path ./db \
   --socket-path ./db/node.socket \
   --config ./config_files/config.json \
   --host-addr 0.0.0.0 \
   --port 3000

cardano-node docs​

more info on how to run a node here.

run​

once you have installed mutexo-server and your cardano-node is synchronized you can simply run

mutexo-server start

which will run the mutxo server with the default configuration, using the environment variable CARDANO_NODE_SOCKET_PATH as path for the cardano-node socket.

you can pass more arguments to the command to fine tune the server, as an example you can explicitly pass the path where the socket for the cardano-node can be found

mutexo-server start --node-socket-path path/to/node.socket

so that you don`t have to rely on the environment.

for more infos on the options have a look at the cli section.