txrecords

Documentation

Index

• func Decode(b *bytes.Buffer, t *TxRecord) error
• func Encode(b *bytes.Buffer, t *TxRecord) error
• type Direction
• type TxMeta
• type TxRecord
  • func New(call transactions.ContractCall, height uint64, direction Direction) *TxRecord
  • func (t TxRecord) View() TxView
• type TxView

Functions

func Decode

func Decode(b *bytes.Buffer, t *TxRecord) error

Decode a TxRecord from a buffer.

func Encode

func Encode(b *bytes.Buffer, t *TxRecord) error

Encode the TxRecord into a buffer.

Types

type Direction

type Direction uint8

Direction is an enum which tells us whether a transaction is incoming or outgoing.

const (
	// In identifies incoming transaction.
	In Direction = iota
	// Out identifies outgoing transaction.
	Out
)

type TxMeta

type TxMeta struct {
	Height    uint64
	Direction Direction
	Timestamp int64
}

TxMeta is a convenience structure which groups fields common to the TxView and the TxRecord.

type TxRecord

type TxRecord struct {
	TxMeta
	Transaction transactions.ContractCall
}

TxRecord encapsulates the data stored on the DB related to a transaction such as block height, direction, etc. The fields related to the ContractCall are embedded inside the Transaction carrying the information about the `Fee` (gas) and the `Amount` (which can be zero for smart contract calls not related to transfer o value).

func New

func New(call transactions.ContractCall, height uint64, direction Direction) *TxRecord

New creates a TxRecord.

func (TxRecord) View

func (t TxRecord) View() TxView

View returns a UI consumable representation of a TXRecord.

type TxView

type TxView struct {
	TxMeta
	Type       transactions.TxType
	Amount     uint64
	Fee        uint64
	Timelock   uint64
	Hash       []byte
	Data       []byte
	Obfuscated bool
}

TxView is the UX-friendly structure to be served to the UI requesting them.