bitcoin

Documentation

Overview

Detect payment records in the Bitcoin Block Chain

Payments are indicated by OP_RETURN embedded data, this is compressed to fit it within the 80 byte Bitcoin limit.

The OP_RETURN(0x6a) data structure:

+---------------------------------------------------------------------------------+
|         1         2         3         4          5         6         7         8|
|123456789012345678901234567890123456789012345678 90123456789012345678901234567890|
+------------------------------------------------+--------------------------------+
|                                                |                                |
|     pay id                                     |                                |
|                                                |                                |
+------------------------------------------------+--------------------------------+
|             1         2         3         4    |         1         2         3  |
|123456789012345678901234567890123456789012345678|12345678901234567890123456789012|
+------------------------------------------------+--------------------------------+

Index

• func Finalise() error
• func Initialise(configuration *Configuration, verifier chan<- reservoir.PayId) error
• func QueueItem(payId reservoir.PayId, txId string, confirmations uint64, ...) bool
• type Configuration

Functions

func Finalise

func Finalise() error

finialise - stop all background tasks also calls the internal finalisePayment()

func Initialise

func Initialise(configuration *Configuration, verifier chan<- reservoir.PayId) error

initialise for bitcoin payments also calls the internal initialisePayment() and register()

func QueueItem

func QueueItem(payId reservoir.PayId, txId string, confirmations uint64, payments []*transactionrecord.Payment) bool

accept a new payment to monitor

Types

type Configuration

type Configuration struct {
	Username      string `libucl:"username"`
	Password      string `libucl:"password"`
	URL           string `libucl:"url"`
	ServerName    string `libucl:"server_name"`
	CACertificate string `libucl:"ca_certificate"`
	Certificate   string `libucl:"certificate"`
	PrivateKey    string `libucl:"private_key"`
}

a block of configuration data this is read from a libucl configuration file