blockcypher

Documentation

Overview

Package blockcypher defines primitives to work with the BlockCypher API.

Index

• Constants
• func RegisterFlags()
• type Client
  • func New(c *Config) *Client
  • func RunWithFlags(ctx context.Context, key string) *Client
  • func (c *Client) Broadcast(raw []byte) error
  • func (c *Client) FindUnspent(address *types.ReversedBytes20, amount int64) ([]btc.Output, int64, error)
  • func (c *Client) Start(ctx context.Context)
• type Config

Constants

const (
	// DefaultLimiterInterval is the default BlockCypher API limiter
	// interval.
	DefaultLimiterInterval = time.Minute

	// DefaultLimiterSize is the default BlockCypher API limiter size.
	DefaultLimiterSize = 2
)

Functions

func RegisterFlags

func RegisterFlags()

RegisterFlags registers the flags used by InitializeWithFlags.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a BlockCypher API client.

func New

func New(c *Config) *Client

New creates a client for a Bitcoin network, using an optional BlockCypher API key.

func RunWithFlags

func RunWithFlags(ctx context.Context, key string) *Client

RunWithFlags should be called after RegisterFlags and flag.Parse to initialize a blockcypher client using flag values.

func (*Client) Broadcast

func (c *Client) Broadcast(raw []byte) error

Broadcast implements github.com/stratumn/go-indigocore/blockchain/btc.Broadcaster.Broadcast.

func (*Client) FindUnspent

func (c *Client) FindUnspent(address *types.ReversedBytes20, amount int64) ([]btc.Output, int64, error)

FindUnspent implements github.com/stratumn/go-indigocore/blockchain/btc.UnspentFinder.FindUnspent.

func (*Client) Start

func (c *Client) Start(ctx context.Context)

Start starts the client.

type Config

type Config struct {
	// Network is the Bitcoin network.
	Network btc.Network

	// APIKey is an optional BlockCypher API key.
	APIKey string

	// LimiterInterval is the BlockCypher API limiter interval.
	LimiterInterval time.Duration

	// LimiterSize is the BlockCypher API limiter size.
	LimiterSize int
}

Config contains configuration options for the client.