reservoir

Documentation

Overview

Cache for transactions that have been verified

Index

• func DeleteByLink(link merkle.Digest)
• func DeleteByTxId(txId merkle.Digest)
• func Disable()
• func Enable()
• func FetchVerified(count int) ([]merkle.Digest, []transactionrecord.Packed, int, error)
• func Finalise()
• func Initialise() error
• func ReadCounters() (int, int, []int)
• func ScaledDifficulty(count int) *difficulty.Difficulty
• func SetTransferVerified(payId pay.PayId, detail *PaymentDetail)
• type IssueInfo
  • func StoreIssues(issues []*transactionrecord.BitmarkIssue, isVerified bool) (*IssueInfo, bool, 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
• type PaymentDetail
• type PaymentSegment
• type TrackingStatus
  • func TryProof(payId pay.PayId, clientNonce []byte) TrackingStatus
  • func (ts TrackingStatus) MarshalText() ([]byte, error)
  • func (ts TrackingStatus) String() string
  • func (ts *TrackingStatus) UnmarshalText(s []byte) error
• type TransactionState
  • func TransactionStatus(txId merkle.Digest) TransactionState
  • func (state TransactionState) String() string
• 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 Disable

func Disable()

lock down to prevent proofer from getting data

func Enable

func Enable()

allow proofer to run again

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 ReadCounters

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

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 SetTransferVerified

func SetTransferVerified(payId pay.PayId, detail *PaymentDetail)

Types

type IssueInfo

type IssueInfo struct {
	Id         pay.PayId
	Nonce      PayNonce
	Difficulty *difficulty.Difficulty
	TxIds      []merkle.Digest
	Packed     []byte
}

result returned by store issues

func StoreIssues

func StoreIssues(issues []*transactionrecord.BitmarkIssue, isVerified bool) (*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 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

type PaymentDetail

type PaymentDetail struct {
	Currency currency.Currency
	TxID     string
	Amounts  map[string]uint64
}

type PaymentSegment

type PaymentSegment [currency.Count]*transactionrecord.Payment

a single segment of a payment e.g. for an issue or transfer block owner

type TrackingStatus

type TrackingStatus int

result of track payment/try proof

const (
	TrackingNotFound  TrackingStatus = iota
	TrackingAccepted  TrackingStatus = iota
	TrackingProcessed TrackingStatus = iota
	TrackingInvalid   TrackingStatus = iota
)

possible status values

func TryProof

func TryProof(payId pay.PayId, clientNonce []byte) TrackingStatus

instead of paying, try a proof from the client nonce

func (TrackingStatus) MarshalText

func (ts TrackingStatus) MarshalText() ([]byte, error)

convert the tracking value for JSON

func (TrackingStatus) String

func (ts TrackingStatus) String() string

convert the tracking value for printf

func (*TrackingStatus) UnmarshalText

func (ts *TrackingStatus) UnmarshalText(s []byte) error

convert the tracking value from JSON to enumeration

type TransactionState

type TransactionState int

status

const (
	StateUnknown   TransactionState = iota
	StatePending   TransactionState = iota
	StateVerified  TransactionState = iota
	StateConfirmed TransactionState = iota
)

func TransactionStatus

func TransactionStatus(txId merkle.Digest) TransactionState

get status of a transaction

func (TransactionState) String

func (state TransactionState) String() string

type TransferInfo

type TransferInfo struct {
	Id       pay.PayId
	TxId     merkle.Digest
	Packed   []byte
	Payments []transactionrecord.PaymentAlternative
}

result returned by store transfer

func StoreTransfer

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