Skip to content

blockfrost/blockfrost-arduino

Repository files navigation

GitHub Actions Made by Five Binaries

blockfrost-arduino


Arduino SDK for Blockfrost.io API.

AboutGetting startedInstallationUsage


About

Arduino SDK for the Blockfrost.io API targeting ESP32 development boards.

Block, slot within an epoch, wen, transaction volume

Getting started

To use this SDK, you first need to log in to blockfrost.io, create your project and retrieve the API token.


Installation

The SDK uses platformio.

You can either work directly with this repository or add this package as a dependency of your project using

lib_deps =
  https://github.com/blockfrost/blockfrost-arduino

To enter a development shell, use nix-shell.

Usage

To build the example, copy example/creds.h.sample to example/creds.h and fill in your credentials.

git clone https://github.com/blockfrost/blockfrost-arduino
cd blockfrost-arduino
cp example/creds.h.sample example/creds.h

Plug in your ESP32 development board, build and upload using:

pio run --target upload

Testing

It is possible to test correct JSON (de)serialisation natively using:

pio test -c platformio-test.ini -e native