payment

Documentation

Index

• Constants
• func Finalise()
• func Initialise(configuration *Configuration) error
• func ScaledDifficulty(count int) *difficulty.Difficulty
• func Store(currencyName currency.Currency, transactions []byte, count int, canProof bool) (PayId, PayNonce, *difficulty.Difficulty)
• func TrackPayment(payId PayId, receipt string, confirmations uint64)
• func TryProof(payId PayId, clientNonce []byte) bool
• type Configuration
• type PayId
  • func NewPayId(packed []byte) PayId
  • func (payid PayId) GoString() string
  • func (payid PayId) MarshalText() ([]byte, error)
  • func (payid PayId) String() string
  • func (payid *PayId) UnmarshalText(s []byte) error
• type PayNonce
  • func NewPayNonce() PayNonce
  • func (paynonce PayNonce) GoString() string
  • func (paynonce PayNonce) MarshalText() ([]byte, error)
  • func (paynonce PayNonce) String() string
  • func (paynonce *PayNonce) UnmarshalText(s []byte) error

Constants

const (
	ReceiptLength         = 64 // hex bytes
	NonceLength           = 64 // hex bytes
	RequiredConfirmations = 3
)

maximum values

Functions

func Finalise

func Finalise()

stop all payment handlers

func Initialise

func Initialise(configuration *Configuration) error

create the tables

func ScaledDifficulty

func ScaledDifficulty(count int) *difficulty.Difficulty

produce a scaled difficulty based on the number of items in a block to be processed and include a quantity discount

func Store

func Store(currencyName currency.Currency, transactions []byte, count int, canProof bool) (PayId, PayNonce, *difficulty.Difficulty)

store an incoming record for payment

func TrackPayment

func TrackPayment(payId PayId, receipt string, confirmations uint64)

start payment tracking on an receipt

func TryProof

func TryProof(payId PayId, clientNonce []byte) bool

instead of paying, try a proof from the client nonce

Types

type Configuration

type Configuration struct {
	Bitcoin *bitcoin.Configuration
}

configuration for each sub-module

type PayId

type PayId [48]byte

type to represent a payment identifier this is considered as a big endian value for difficulty comparison Note: no reversal is required for this

func NewPayId

func NewPayId(packed []byte) PayId

create a payment identifier from a set of transactions

func (PayId) GoString

func (payid PayId) GoString() string

convert a binary pay id to big endian hex string for use by the fmt package (for %#v)

func (PayId) MarshalText

func (payid PayId) MarshalText() ([]byte, error)

convert pay id to big endian hex text

func (PayId) String

func (payid PayId) String() string

convert a binary pay id to big endian hex string for use by the fmt package (for %s)

func (*PayId) UnmarshalText

func (payid *PayId) UnmarshalText(s []byte) error

convert little endian hex text into a pay id

type PayNonce

type PayNonce [8]byte

type to represent a payment nonce Note: no reversal is required for this

func NewPayNonce

func NewPayNonce() PayNonce

create a random pay nonce

func (PayNonce) GoString

func (paynonce PayNonce) GoString() string

convert a binary pay nonce to big endian hex string for use by the fmt package (for %#v)

func (PayNonce) MarshalText

func (paynonce PayNonce) MarshalText() ([]byte, error)

convert pay nonce to big endian hex text

func (PayNonce) String

func (paynonce PayNonce) String() string

convert a binary pay nonce to big endian hex string for use by the fmt package (for %s)

func (*PayNonce) UnmarshalText

func (paynonce *PayNonce) UnmarshalText(s []byte) error

convert little endian hex text into a pay nonce