Setup

This page will walk you through the steps involved in setting up your environment to follow along with this guide from scratch.

Step 1: Install Nix

This repository uses the Nix package manager to manage dependencies. You will need to install Nix on your machine to setup the environment. Instructions for doing so can be found here.

Note

You should also configure your nix installation to use the IOG and NixOS binary caches so you don’t end up building everything locally, which will consume a lot of disk space and take a very long time. Edit your nix config and make sure the following options are set:

experimental-features = nix-command flakes fetch-closure
trusted-users = <your user name>
substituters = https://cache.iog.io https://cache.nixos.org/
trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=

Where <your user name> is your username (run the command whoami to print this if you are unsure). This file is normally located at /etc/nix/nix.conf. If it doesn’t exist, create it and paste the above contents (replace <your user name> with your real user name).

You will need to restart your nix daemon (or alternatively, reboot your machine) after editing this config file.

Step 2: Clone this repository

$ mkdir ~/repos
$ cd ~/repos
$ git clone git@github.com:IntersectMBO/credential-manager.git

Step 3: Enter the Nix Shell

Option 1: To enter the nix shell using the nix CLI, navigate to the root of the git repo and run nix develop:

$ cd credential-manager
$ nix develop

Option 2: The repository includes a .envrc file for direnv integration. If you want to use direnv, navigate to the root of the git repo and run direnv allow:

$ cd credential-manager
$ direnv allow

Step 4: Start the local Cardano testnet

The nix shell includes a command to spin up a local Cardano testnet running in the Conway era. It will initialize the network configuration files and run 3 SPO block producing nodes.

Note

If you have previously started a testnet and shut it down and want to spin up a new one, you will have to run the command purge-local-testnet first to get rid of the old network’s working directory.

$ deploy-local-testnet

Step 5: Open a new shell

Our previous shell is now running the testnet in the foreground, so open a new shell, navigate back to the repo root and enter the nix shell again.

Step 6: Initialize the Orchestrator’s wallet

We need a wallet to work with. Run the command:

$ setup-orchestrator

This will write three files to the repo root directory:

orchestrator.vkey the orchestrator’s verification key file
orchestrator.skey the orchestrator’s signing key file
orchestrator-stake.vkey a staking verification key file for gov action deposit returns.
orchestrator-stake.skey a signing key file for the staking verification key.
orchestrator.addr the orchestrator’s address file, which holds 600,000 ADA

Check the balance with the command

$ get-orchestrator-utxo
                        TxHash                                 TxIx        Amount
--------------------------------------------------------------------------------------
af00a0caf9924ae9d6a77727c914d8d370d4c0b5f888bd04221392a54094d363     0        600000000000 lovelace + TxOutDatumNone

Or alternatively to have it output JSON:

$ get-orchestrator-utxo --output-json
{
    "af00a0caf9924ae9d6a77727c914d8d370d4c0b5f888bd04221392a54094d363#0": {
        "address": "addr_test1vpqlddqywf5vcypagugpgvp5x8lslgw8e0ngze7a69zuuasrm5utw",
        "datum": null,
        "datumhash": null,
        "inlineDatum": null,
        "referenceScript": null,
        "value": {
            "lovelace": 600000000000
        }
    }
}

Other useful commands for querying the UTxO include get-output-by-policy-id and get-orchestrator-ada-only.