indexer

README

Pocket indexer

What it is

TODO

How to install

TODO

More fields

TODO

Documentation

Index

• Variables
• type Account
• type AccountType
• type App
• type Block
• type Indexer
  • func NewIndexer(provider Provider, writer Writer) *Indexer
  • func (i *Indexer) IndexAccount(address string, blockHeight int, accountType AccountType) error
  • func (i *Indexer) IndexBlock(blockHeight int) error
  • func (i *Indexer) IndexBlockApps(blockHeight int) ([]string, error)
  • func (i *Indexer) IndexBlockNodes(blockHeight int) ([]string, error)
  • func (i *Indexer) IndexBlockTransactions(blockHeight int) error
• type Node
• type Provider
• type Transaction
• type Writer

Variables

var (
	// ErrBlockHasNoHash error when block hash no hash
	ErrBlockHasNoHash = errors.New("block to index has no hash")
)

var (
	// ErrNoAppsToIndex error when there are no apps to index
	ErrNoAppsToIndex = errors.New("no apps to index")
)

var (
	// ErrNoNodesToIndex error when there are no nodes to index
	ErrNoNodesToIndex = errors.New("no nodes to index")
)

var (
	// ErrNoTransactionsToIndex error when there are no transactions to index
	ErrNoTransactionsToIndex = errors.New("no transactions to index")
)

Types

type Account

type Account struct {
	Address             string
	Height              int
	AccountType         AccountType
	Balance             *big.Int
	BalanceDenomination string
}

Account struct handler of all account fields to be indexed

type AccountType

type AccountType string

AccountType enum of possible account types

const (
	// AccountTypeNode represents node account type
	AccountTypeNode AccountType = "node"
	// AccountTypeApp represents app account type
	AccountTypeApp AccountType = "app"
)

type App

type App struct {
	Address      string
	Height       int
	Jailed       bool
	PublicKey    string
	StakedTokens *big.Int
}

App struct handler of all app fields to be indexed

type Block

type Block struct {
	Hash            string
	Height          int
	Time            time.Time
	ProposerAddress string
	TXCount         int
}

Block struct handler of all block fields to be indexed

type Indexer

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

Indexer struct handler for Indexer functions

func NewIndexer

func NewIndexer(provider Provider, writer Writer) *Indexer

NewIndexer returns Indexer instance with given input

func (*Indexer) IndexAccount

func (i *Indexer) IndexAccount(address string, blockHeight int, accountType AccountType) error

IndexAccount converts account details to a known structure and saves them

func (*Indexer) IndexBlock

func (i *Indexer) IndexBlock(blockHeight int) error

IndexBlock converts block details to a known structure and saves them

func (*Indexer) IndexBlockApps

func (i *Indexer) IndexBlockApps(blockHeight int) ([]string, error)

IndexBlockApps converts apps details to known structures and saved them returns all addresses indexed

func (*Indexer) IndexBlockNodes

func (i *Indexer) IndexBlockNodes(blockHeight int) ([]string, error)

IndexBlockNodes converts nodes details to known structures and saves them returns all addresses indexed

func (*Indexer) IndexBlockTransactions

func (i *Indexer) IndexBlockTransactions(blockHeight int) error

IndexBlockTransactions converts block transactions to a known structure and saves them

type Node

type Node struct {
	Address    string
	Height     int
	Jailed     bool
	PublicKey  string
	ServiceURL string
	Tokens     *big.Int
}

Node struct handler of all node fields to be indexed

type Provider

type Provider interface {
	GetBlock(blockNumber int) (*provider.GetBlockOutput, error)
	GetBlockTransactions(options *provider.GetBlockTransactionsOptions) (*provider.GetBlockTransactionsOutput, error)
	GetAccount(address string, options *provider.GetAccountOptions) (*provider.GetAccountOutput, error)
	GetNodes(options *provider.GetNodesOptions) (*provider.GetNodesOutput, error)
	GetApps(options *provider.GetAppsOptions) (*provider.GetAppsOutput, error)
}

Provider interface of needed provider functions

type Transaction

type Transaction struct {
	Hash            string
	FromAddress     string
	ToAddress       string
	AppPubKey       string
	Blockchains     []string
	MessageType     string
	Height          int
	Index           int
	StdTx           *provider.StdTx
	TxResult        *provider.TxResult
	Tx              string
	Entropy         int
	Fee             int
	FeeDenomination string
	Amount          *big.Int
}

Transaction struct handler of all transaction fields to be indexed

type Writer

type Writer interface {
	WriteBlock(block *Block) error
	WriteTransactions(txs []*Transaction) error
	WriteAccount(account *Account) error
	WriteNodes(nodes []*Node) error
	WriteApps(apps []*App) error
}

Writer interface for write methods to index