indexdb

Documentation

Overview

Package indexdb provides a Rosetta-specific index of the Flow chain data.

Index

• Variables
• type AccountInfo
• type BalanceData
• type BlockData
• type Store
  • func New(dir string) *Store
  • func (s *Store) Accounts() (map[[8]byte]bool, error)
  • func (s *Store) AccountsInfo() (map[string]*AccountInfo, error)
  • func (s *Store) BalanceByHash(acct []byte, hash []byte) (*BalanceData, error)
  • func (s *Store) BalanceByHeight(acct []byte, height uint64) (*BalanceData, error)
  • func (s *Store) BlockByHash(hash []byte) (*BlockData, error)
  • func (s *Store) BlockByHeight(height uint64) (*BlockData, error)
  • func (s *Store) ExportAccounts(filename string)
  • func (s *Store) Genesis() *model.BlockMeta
  • func (s *Store) HasBalance(acct []byte, height uint64) (bool, error)
  • func (s *Store) HashForHeight(height uint64) ([]byte, error)
  • func (s *Store) HeightForHash(hash []byte) (uint64, error)
  • func (s *Store) Index(ctx context.Context, height uint64, hash []byte, block *model.IndexedBlock) error
  • func (s *Store) Latest() *model.BlockMeta
  • func (s *Store) PurgeProxyAccounts()
  • func (s *Store) ResetTo(base uint64) error
  • func (s *Store) SetGenesis(val *model.BlockMeta) error

Variables

var (
	ErrBlockNotIndexed = errors.New("indexdb: block not indexed")
)

Types

type AccountInfo

type AccountInfo struct {
	Changes [][2]uint64 `json:"changes"`
	Proxy   bool        `json:"proxy,omitempty"`
}

AccountInfo represents all the balance changes (block height, balance) for an account and whether it's a proxy account or not.

type BalanceData

type BalanceData struct {
	Balance uint64
	Hash    []byte
	Height  uint64
}

BalanceData represents the indexed balance of an account.

type BlockData

type BlockData struct {
	Block        *model.IndexedBlock
	Hash         []byte
	Height       uint64
	ParentHash   []byte
	ParentHeight uint64
}

BlockData represents the indexed data for a block.

type Store

type Store struct {
	// contains filtered or unexported fields
}

Store aggregates the blockchain data for Rosetta API calls.

func New

func New(dir string) *Store

New opens the database at the given directory and returns the corresponding Store.

func (*Store) Accounts

func (s *Store) Accounts() (map[[8]byte]bool, error)

Accounts returns the addresses of all our indexed accounts, and whether the account is a proxy account or not.

func (*Store) AccountsInfo

func (s *Store) AccountsInfo() (map[string]*AccountInfo, error)

AccountsInfo will return a map of the indexed accounts and their corresponding account info.

func (*Store) BalanceByHash

func (s *Store) BalanceByHash(acct []byte, hash []byte) (*BalanceData, error)

BalanceByHash returns the account balance at the given hash.

func (*Store) BalanceByHeight

func (s *Store) BalanceByHeight(acct []byte, height uint64) (*BalanceData, error)

BalanceByHeight returns the account balance at the given height.

func (*Store) BlockByHash

func (s *Store) BlockByHash(hash []byte) (*BlockData, error)

BlockByHash returns the block data for the given hash.

func (*Store) BlockByHeight

func (s *Store) BlockByHeight(height uint64) (*BlockData, error)

BlockByHeight returns the block data for the given height.

func (*Store) ExportAccounts

func (s *Store) ExportAccounts(filename string)

ExportAccounts will export a map of the indexed accounts and their corresponding account info.

func (*Store) Genesis

func (s *Store) Genesis() *model.BlockMeta

Genesis returns the stored genesis block metadata.

func (*Store) HasBalance

func (s *Store) HasBalance(acct []byte, height uint64) (bool, error)

HasBalance returns whether the given account has an indexed balance at the given height.

func (*Store) HashForHeight

func (s *Store) HashForHeight(height uint64) ([]byte, error)

HashForHeight returns the block hash at the given height.

func (*Store) HeightForHash

func (s *Store) HeightForHash(hash []byte) (uint64, error)

HeightForHash returns the block height for the given hash.

func (*Store) Index

func (s *Store) Index(ctx context.Context, height uint64, hash []byte, block *model.IndexedBlock) error

Index indexes the given block data.

func (*Store) Latest

func (s *Store) Latest() *model.BlockMeta

Latest returns the most recently indexed block.

func (*Store) PurgeProxyAccounts

func (s *Store) PurgeProxyAccounts()

PurgeProxyAccounts removes any indexed account balances or proxy account creation heights from the index database.

func (*Store) ResetTo

func (s *Store) ResetTo(base uint64) error

ResetTo drops all indexed data after the given height.

func (*Store) SetGenesis

func (s *Store) SetGenesis(val *model.BlockMeta) error

SetGenesis sets the genesis block metadata and the initial latest block.