Skip to main content

Introduction

This section will explain you how to use the Makina tools as an operator.

In order to use the makina-cli with your own strategies, you will need to write configuration files.

You can find the public configurations in the MakinaHQ/config repository. It will allow you to get an overview of the different strategies and how they are configured.

Creating a machine​

The default machine configuration is the following:

Directory structure
machines/
└── [machine-name-1]/
    ├── config.toml
    ├── [network-name-1]/
    │   ├── caliber.yaml                                    # the input file for the transpiler
    │   ├── instructions/                                   # instructions written by humans
    │   └── rootfiles/                                      # transpiled from instructions
    │       ├── [timestamp]-[name-of-the-migration1].toml   # generated by the transpiler
    │       ├── [timestamp]-[name-of-the-migration2].toml   # generated by the transpiler
    │       └── ...
    ├── [network-name-2]/
    └── ...

You can check the reference for the config.toml and the caliber.yaml files.

Generating the rootfiles​

The makina transpiler will generate the rootfiles from the caliber.yaml file.

cargo run -p transpiler -- -i crates/transpiler/test_data/caliber.yaml -o output.toml

Deploying the machine​

warning

This part is coming soon.