Official Blockfrost SDK Client

Getting started

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

Installation

blockfrost-go can be installed through go get

$ go get https://github.com/blockfrost/blockfrost-go

Usage

Cardano API

package main

import (
    "context"
    "fmt"
    "log"

    "github.com/blockfrost/blockfrost-go"
)

func main() {
    api, err := blockfrost.NewAPIClient(
        blockfrost.APIClientOptions{
            ProjectID: "YOUR_PROJECT_ID_HERE", // Exclude to load from env:BLOCKFROST_PROJECT_ID
        },
    )
    if err != nil {
        log.Fatal(err)
    }

    info, err := api.Info(context.TODO())
    if err != nil {
        log.Fatal(err)
    }

    fmt.Printf("API Info:\n\tUrl: %s\n\tVersion: %s", info.Url, info.Version)
}

IPFS

package main

import (
    "context"
    "flag"
    "fmt"
    "log"

    "github.com/blockfrost/blockfrost-go"
)

var (
    fp = flag.String("file", "", "Path to file")
)

func main() {
    flag.Parse()
    // Load project_id from env:BLOCKFROST_IPFS_PROJECT_ID
    ipfs := blockfrost.NewIPFSClient(blockfrost.IPFSClientOptions{})

    ipo, err := ipfs.Add(context.TODO(), *fp)
    if err != nil {
        log.Fatal(err)
    }

    fmt.Printf("IPFS Object: %+v\n", ipo)

    // Pin item to avoid being garbage collected.
    pin, err := ipfs.Pin(context.TODO(), ipo.IPFSHash)
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("Pin: %+v", pin)
}

More examples of usage can be found in example folder.

Developing

To run specific test:

go test -run <name>

To run all tests:

make test

License

Licensed under the Apache License 2.0, see LICENSE