balance

Documentation

Index

• Variables
• type Record
  • func (r *Record) Clone() Record
  • func (r *Record) CopyTo(dst *Record)
  • func (r *Record) Validate() error
• type Store

Variables

var (
	ErrCheckpointNotFound = errors.New("checkpoint not found")

	ErrStaleCheckpoint = errors.New("checkpoint is stale")
)

Types

type Record

type Record struct {
	Id uint64

	TokenAccount   string
	Quarks         uint64
	SlotCheckpoint uint64

	LastUpdatedAt time.Time
}

Note: Only supports external balances

func (*Record) Clone

func (r *Record) Clone() Record

func (*Record) CopyTo

func (r *Record) CopyTo(dst *Record)

func (*Record) Validate

func (r *Record) Validate() error

type Store

type Store interface {
	// SaveCheckpoint saves a balance at a checkpoint. ErrStaleCheckpoint is returned
	// if the checkpoint is outdated
	SaveCheckpoint(ctx context.Context, record *Record) error

	// GetCheckpoint gets a balance checkpoint for a given account. ErrCheckpointNotFound
	// is returend if no DB record exists.
	GetCheckpoint(ctx context.Context, account string) (*Record, error)
}