types

Documentation

Overview

Package types is the package holding all types needed for the indexer library

Index

• type Account
• type App
• type Block
• type GetAccountsQuantityOptions
• type GetAppsQuantityOptions
• type GetNodesQuantityOptions
• type Node
• type Order
• type ReadAccountByAddressOptions
• type ReadAccountsOptions
• type ReadAppByAddressOptions
• type ReadAppsOptions
• type ReadBlocksOptions
• type ReadNodeByAddressOptions
• type ReadNodesOptions
• type ReadTransactionsByAddressOptions
• type ReadTransactionsByHeightOptions
• type ReadTransactionsOptions
• type Transaction

Types

type Account

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

Account struct handler of all account fields to be indexed

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
	TXTotal          int
	AccountsQuantity int
	AppsQuantity     int
	NodesQuantity    int
	Took             time.Duration
}

Block struct handler of all block fields to be indexed

type GetAccountsQuantityOptions

type GetAccountsQuantityOptions struct {
	Height int
}

GetAccountsQuantityOptions optional parameters for GetAccountsQuantity

type GetAppsQuantityOptions

type GetAppsQuantityOptions struct {
	Height int
}

GetAppsQuantityOptions optinal params for GetAppsQuantity

type GetNodesQuantityOptions

type GetNodesQuantityOptions struct {
	Height int
}

GetNodesQuantityOptions optinal params for GetNodesQuantity

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 Order

type Order string

Order enum allows user to select order of returned results - desc or asc

const (
	// DescendantOrder represents greater to lower order
	DescendantOrder Order = "desc"
	// AscendantOrder represents lower to greater order
	AscendantOrder Order = "asc"
)

type ReadAccountByAddressOptions

type ReadAccountByAddressOptions struct {
	Height int
}

ReadAccountByAddressOptions optional parameters for ReadAccountByAddress

type ReadAccountsOptions

type ReadAccountsOptions struct {
	PerPage int
	Page    int
	Height  int
}

ReadAccountsOptions optional parameters for ReadAccounts

type ReadAppByAddressOptions

type ReadAppByAddressOptions struct {
	Height int
}

ReadAppByAddressOptions optional parameters for ReadAppByAddress

type ReadAppsOptions

type ReadAppsOptions struct {
	PerPage int
	Page    int
	Height  int
}

ReadAppsOptions optional parameters for ReadApps

type ReadBlocksOptions

type ReadBlocksOptions struct {
	PerPage int
	Page    int
	Order   Order
}

ReadBlocksOptions optional parameters for ReadBlocks

type ReadNodeByAddressOptions

type ReadNodeByAddressOptions struct {
	Height int
}

ReadNodeByAddressOptions optional parameters for ReadNodeByAddress

type ReadNodesOptions

type ReadNodesOptions struct {
	PerPage int
	Page    int
	Height  int
}

ReadNodesOptions optional parameters for ReadNodes

type ReadTransactionsByAddressOptions

type ReadTransactionsByAddressOptions struct {
	PerPage int
	Page    int
}

ReadTransactionsByAddressOptions optional parameters for ReadTransactionsByAddress

type ReadTransactionsByHeightOptions

type ReadTransactionsByHeightOptions struct {
	PerPage int
	Page    int
}

ReadTransactionsByHeightOptions optional parameters for ReadTransactionsByHeight

type ReadTransactionsOptions

type ReadTransactionsOptions struct {
	PerPage int
	Page    int
	Order   Order
}

ReadTransactionsOptions optional parameters for ReadTransactions

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