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) error
• func ScanTx(log *logger.L, tx *Transaction)
• type Configuration
• type Transaction

Functions

func Finalise

func Finalise() error

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

func Initialise

func Initialise(configuration *Configuration) error

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

func ScanTx

func ScanTx(log *logger.L, tx *Transaction)

Types

type Configuration

type Configuration struct {
	URL string `libucl:"url" hcl:"url" json:"url"`
}

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

type Transaction

type Transaction struct {
	TxID          string `json:"txid"`
	Confirmations uint64 `json:"confirmations"`
	Vout          []vout `json:"vout"`
}