README.md

Monorepo for the Hyperledger FireFly implementation for Cardano blockchain

Introduction

The Hyperledger FireFly monorepo for Cardano blockchain offers a unified repository containing all the code, documentation, and tools necessary for developing and deploying multi-enterprise blockchain applications on the Cardano network.

Configuration of components

For the FireFly Cardano Connector config, see config.md.

For the FireFly Cardano Signer config, see config.md.

Getting started

To setup the components, you need a valid Blockfrost key, you can either get it from the online service or your can run your own cluster.

Run it with Docker compose

Requires at least Docker Compose version 2.22.0, uses Compose Watch: https://docs.docker.com/compose/how-tos/file-watch/

The easier way to get started is to use Docker compose to build your entire cluster.

# To compose a cluster using Blockfrost as a backing store
BLOCKFROST_KEY=previewXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX docker compose -f infra/docker-compose.yaml up --build -d

# If you are running your own Blockfrost instance, you can pass the url
BLOCKFROST_BASE_URL=https://localhost:3000 docker compose -f infra/docker-compose.yaml up --build -d

# To create a cluster with a local cardano node (takes longer to spin up)
docker compose -f infra/docker-compose.node.yaml up --build -d

# Watch the build
docker compose watch

Demo application to showcase the Cardano FireFly connector

• Export your blockfrost key:

  export BLOCKFROST_KEY=previewXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  

• Create Cardano wallet and put the signing key in infra/wallet/${address}.skey

    cargo run --bin firefly-cardano-generate-key -- --wallet-dir infra/wallet --testnet
  
    # or if you can run makefiles...
    make generate-key

• To start up the connector please execute:

  BLOCKFROST_KEY=previewXX docker compose -f ./infra/docker-compose.node.yaml -f ./infra/docker-compose.yaml -p preview up --build -d
  docker compose -f ./infra/docker-compose.yaml -p preview watch # Auto rebuild on changes

  NOTE: If you want to avoid running it in the background, omit the -d flag.

  NOTE: If you want to skip building, omit the --build flag.

• Swagger definitions can be viewed at http://localhost:5018/api and http://localhost:8555/api

• Execute make demo to run the demo application

Engage with the community

• Join us on Discord