payment

Documentation

Overview

Package payment - control of payment verification

Index

• Constants
• func Finalise() error
• func Initialise(configuration *Configuration) error
• type Configuration
• type PeerMap
  • func NewPeerMap() *PeerMap
  • func (m *PeerMap) Add(addr string, p *peer.Peer)
  • func (m *PeerMap) Delete(addr string)
  • func (m *PeerMap) Exist(addr string) bool
  • func (m *PeerMap) First() (p *peer.Peer)
  • func (m *PeerMap) Get(addr string) (p *peer.Peer)
  • func (m *PeerMap) Len() int
  • func (m *PeerMap) Range(callback func(key string, value *peer.Peer))

Constants

const (
	// MinimumNonceLength - least number of bytes in NONCE
	MinimumNonceLength = 8
	// MaximumNonceLength - most number of bytes in NONCE
	MaximumNonceLength = 64
)

const HeaderSyncTimeout = time.Minute

const MaximumOutboundPeers = 32

const PaymentExpiry = 12 * time.Hour

Functions

func Finalise

func Finalise() error

Finalise - stop all background tasks

func Initialise

func Initialise(configuration *Configuration) error

Initialise - setup the payment system

Types

type Configuration

type Configuration struct {
	Mode      string                  `gluamapper:"mode" hcl:"mode" json:"mode"`
	Discovery *discoveryConfiguration `gluamapper:"discovery" hcl:"discovery" json:"discovery"`
	Bitcoin   *currencyConfiguration  `gluamapper:"bitcoin" hcl:"bitcoin" json:"bitcoin"`
	Litecoin  *currencyConfiguration  `gluamapper:"litecoin" hcl:"litecoin" json:"litecoin"`
}

Configuration - structure for configuration file

type PeerMap

type PeerMap struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

PeerMap is a map that maintains the pair between addresses and bitcoin peers in a thread-safe way.

func NewPeerMap

func NewPeerMap() *PeerMap

func (*PeerMap) Add

func (m *PeerMap) Add(addr string, p *peer.Peer)

Add will add a new peer into the map.

func (*PeerMap) Delete

func (m *PeerMap) Delete(addr string)

Delete will remove a peer by its address.

func (*PeerMap) Exist

func (m *PeerMap) Exist(addr string) bool

Exist validate whether an address is in the map.

func (*PeerMap) First

func (m *PeerMap) First() (p *peer.Peer)

First will return the first peer get from the map iteration. Due to the nature of map in golang, the item is random without fixed order.

func (*PeerMap) Get

func (m *PeerMap) Get(addr string) (p *peer.Peer)

Get will return a specific peer from the map.

func (*PeerMap) Len

func (m *PeerMap) Len() int

Len returns the len of current map.

func (*PeerMap) Range

func (m *PeerMap) Range(callback func(key string, value *peer.Peer))

Range is a wrapper function of the map iteration.