simple-faucet-go

Go client for the Nimiq Simple Faucet. Zero external dependencies; standard library only.

Install

go get github.com/PanoramicRum/nimiq-simple-faucet/packages/sdk-go

Requires Go 1.22+.

Usage

import (
    "context"
    "time"

    faucet "github.com/PanoramicRum/nimiq-simple-faucet/packages/sdk-go"
)

client := faucet.New(faucet.Config{URL: "https://faucet.example.com"})
resp, err := client.Claim(context.Background(), "NQ00...", faucet.ClaimOptions{})
if err != nil { return err }

final, err := client.WaitForConfirmation(context.Background(), resp.ID, 60*time.Second)

Server-to-server with HMAC

client := faucet.New(faucet.Config{
    URL: "https://faucet.example.com",
    APIKey: "ak_...",
    HMACSecret: "sk_...",
})

Hashcash

resp, err := client.SolveAndClaim(ctx, addr, faucet.ClaimOptions{})

Mirrors the surface of @nimiq-faucet/sdk: Claim, Status, WaitForConfirmation, Config, RequestChallenge, SolveAndClaim. See example/main.go.