btc

Documentation

Overview

Package btc defines primitives to work with Bitcoin.

Index

• Variables
• type Broadcaster
• type Network
  • func GetNetworkFromWIF(key string) (Network, error)
  • func (n Network) ID() byte
  • func (n Network) String() string
• type Output
• type UnspentFinder
• type UnspentResult

Variables

var (
	// ErrUnknownBitcoinNetwork is returned when the network ID associated to the WIF is unknown.
	ErrUnknownBitcoinNetwork = errors.New("WIF encoded private key uses unknown Bitcoin network")

	// ErrBadWIF is returned when the WIF encoded private key could not be decoded.
	ErrBadWIF = errors.New("Failed to decode WIF encoded private key")
)

Types

type Broadcaster

type Broadcaster interface {
	// Broadcast broadcasts a raw transaction.
	Broadcast(ctx context.Context, raw []byte) error
}

Broadcaster is able to broadcast raw Bitcoin transactions.

type Network

type Network string

Network represents a Bitcoin network.

const (
	// Component name for monitoring.
	Component = "btc"

	// NetworkTest3 is an identified for the test Bitcoin network.
	NetworkTest3 Network = "bitcoin:test3"

	// NetworkMain is an identified for the main Bitcoin network.
	NetworkMain Network = "bitcoin:main"
)

func GetNetworkFromWIF

func GetNetworkFromWIF(key string) (Network, error)

GetNetworkFromWIF returns the network ID associated to a bitcoin wallet.

func (Network) ID

func (n Network) ID() byte

ID returns the byte ID of the network.

func (Network) String

func (n Network) String() string

String implements fmt.Stringer.

type Output

type Output struct {
	TXHash   types.ReversedBytes32
	PKScript []byte
	Index    int
}

Output represents a transaction output.

type UnspentFinder

type UnspentFinder interface {
	// FindUnspent find unspent outputs for the given address and the
	// required amount.
	FindUnspent(ctx context.Context, address *types.ReversedBytes20, amount int64) (UnspentResult, error)
}

UnspentFinder is used to find unspent outputs.

type UnspentResult

type UnspentResult struct {
	// Outputs contains enough outputs to cover the requested amount.
	Outputs []Output

	// Sum is the sum of the balance of the returned outputs.
	Sum int64

	// Total is the sum all of the outputs including the returned outputs.
	Total int64
}

UnspentResult contains the result of a call to UnspentFinder.FindUnspent.