reservoir

Documentation

Overview

Cache for transactions that have been verified

Index

• func DeleteByLink(link merkle.Digest)
• func DeleteByTxId(txId merkle.Digest)
• func FetchVerified(count int) ([]merkle.Digest, []transactionrecord.Packed, int, error)
• func Finalise()
• func Initialise() error
• func Lock()
• func ReadCounters() (int, int, []int)
• func SetVerified(payId PayId)
• func Unlock()
• type IssueInfo
  • func StoreIssues(issues []*transactionrecord.BitmarkIssue) (*IssueInfo, bool, error)
• 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 TransferInfo
  • func StoreTransfer(transfer *transactionrecord.BitmarkTransfer) (*TransferInfo, bool, error)

Functions

func DeleteByLink

func DeleteByLink(link merkle.Digest)

remove a record using a link id

func DeleteByTxId

func DeleteByTxId(txId merkle.Digest)

remove a record using a transaction id

func FetchVerified

func FetchVerified(count int) ([]merkle.Digest, []transactionrecord.Packed, int, error)

fetch a series of verified transactions

func Finalise

func Finalise()

stop all

func Initialise

func Initialise() error

create the cache

func Lock

func Lock()

lock down to prevent proofer from getting data

func ReadCounters

func ReadCounters() (int, int, []int)

read counter

func SetVerified

func SetVerified(payId PayId)

move transaction(s) to verified cache

func Unlock

func Unlock()

allow proofer to run again

Types

type IssueInfo

type IssueInfo struct {
	Id     PayId
	TxIds  []merkle.Digest
	Packed []byte
}

result returned by store issues

func StoreIssues

func StoreIssues(issues []*transactionrecord.BitmarkIssue) (*IssueInfo, bool, error)

store packed record(s) in the Unverified table

return payment id and a duplicate flag

for duplicate to be true all transactions must all match exactly to a previous set - this is to allow for multiple submission from client without receiving a duplicate transaction error

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 TransferInfo

type TransferInfo struct {
	Id               PayId
	TxId             merkle.Digest
	Packed           []byte
	PreviousTransfer *transactionrecord.BitmarkTransfer
	OwnerData        []byte
}

result returned by store transfer

func StoreTransfer

func StoreTransfer(transfer *transactionrecord.BitmarkTransfer) (*TransferInfo, bool, error)

store a single transfer