storage

Documentation

Index

• func FormatIntToKey(i uint64) string
• func GetHoldersPage(s Storage, from, count uint64) (ret []models.Account, pagination *models.PaginatedResponse)
• func GetObjectsPage[T Paginated](s Storage, address string, from, count uint64) (ret []T, pagination *models.PaginatedResponse)
• func GetTotal[T Paginated](s Storage, address string) (r uint64)
• func GetTypeName[T any]() string
• func GetUIntKey(key uint64) string
• func ProcessIntervalData[T Yields](s Storage, start uint64, fn func([]byte, T) (stop bool))
• type Account
  • func (a *Account) ToModel() models.Account
• type AddressStats
  • func MakeEmptyAddressStats(addr string) *AddressStats
  • func (a *AddressStats) AddDag(timestamp models.Timestamp) uint64
  • func (a *AddressStats) AddPbft(timestamp models.Timestamp) uint64
  • func (a *AddressStats) AddTransaction(timestamp models.Timestamp) uint64
  • func (a *AddressStats) IsEqual(b *AddressStats) bool
  • func (a *AddressStats) RegisterValidatorBlock(blockHeight uint64) uint64
• type Balances
  • func (a *Balances) AddToBalance(address string, value *big.Int)
  • func (a *Balances) FindBalance(address string) *Account
  • func (a *Balances) RegisterBalance(address string) *Account
  • func (a *Balances) RemoveBalance(address string)
  • func (a *Balances) SortByBalanceDescending()
  • func (a *Balances) UpdateBalances(from, to, value_str string)
  • func (a *Balances) UpdateEvents(logs []models.EventLog) error
• type Batch
• type FinalizationData
  • func (local *FinalizationData) Check(remote FinalizationData)
• type GenesisHash
• type MultipliedYield
• type Paginated
• type PeriodRewards
• type Storage
• type TotalSupply
• type ValidatorReward
• type ValidatorYield
• type ValidatorsYield
• type WeekStats
  • func MakeEmptyWeekStats() *WeekStats
  • func (w *WeekStats) AddPbftBlock(block *models.Pbft)
  • func (w *WeekStats) GetPaginated(from, count uint64) ([]models.Validator, *models.PaginatedResponse)
  • func (w *WeekStats) Sort()
• type Yield
• type Yields

Functions

func FormatIntToKey

func FormatIntToKey(i uint64) string

func GetHoldersPage

func GetHoldersPage(s Storage, from, count uint64) (ret []models.Account, pagination *models.PaginatedResponse)

func GetObjectsPage

func GetObjectsPage[T Paginated](s Storage, address string, from, count uint64) (ret []T, pagination *models.PaginatedResponse)

func GetTotal

func GetTotal[T Paginated](s Storage, address string) (r uint64)

func GetTypeName

func GetTypeName[T any]() string

func GetUIntKey

func GetUIntKey(key uint64) string

func ProcessIntervalData

func ProcessIntervalData[T Yields](s Storage, start uint64, fn func([]byte, T) (stop bool))

Types

type Account

type Account struct {
	Address string   `json:"address"`
	Balance *big.Int `json:"balance"`
}

func (*Account) ToModel

func (a *Account) ToModel() models.Account

type AddressStats

type AddressStats struct {
	models.StatsResponse
	Address string `json:"address"`
	// contains filtered or unexported fields
}

AddressStats defines the model for an address aggregate.

func MakeEmptyAddressStats

func MakeEmptyAddressStats(addr string) *AddressStats

func (*AddressStats) AddDag

func (a *AddressStats) AddDag(timestamp models.Timestamp) uint64

func (*AddressStats) AddPbft

func (a *AddressStats) AddPbft(timestamp models.Timestamp) uint64

func (*AddressStats) AddTransaction

func (a *AddressStats) AddTransaction(timestamp models.Timestamp) uint64

func (*AddressStats) IsEqual

func (a *AddressStats) IsEqual(b *AddressStats) bool

func (*AddressStats) RegisterValidatorBlock

func (a *AddressStats) RegisterValidatorBlock(blockHeight uint64) uint64

type Balances

type Balances struct {
	Accounts []Account `json:"accounts"`
}

func (*Balances) AddToBalance

func (a *Balances) AddToBalance(address string, value *big.Int)

func (*Balances) FindBalance

func (a *Balances) FindBalance(address string) *Account

func (*Balances) RegisterBalance

func (a *Balances) RegisterBalance(address string) *Account

func (*Balances) RemoveBalance

func (a *Balances) RemoveBalance(address string)

func (*Balances) SortByBalanceDescending

func (a *Balances) SortByBalanceDescending()

func (*Balances) UpdateBalances

func (a *Balances) UpdateBalances(from, to, value_str string)

func (*Balances) UpdateEvents

func (a *Balances) UpdateEvents(logs []models.EventLog) error

type Batch

type Batch interface {
	CommitBatch()
	SetTotalSupply(s *TotalSupply)
	SetFinalizationData(f *FinalizationData)
	SetGenesisHash(h GenesisHash)
	UpdateWeekStats(w WeekStats)
	SaveAccounts(a *Balances)
	AddToBatchFullKey(o interface{}, key []byte) error
	AddToBatch(o interface{}, key1 string, key2 uint64)
	AddToBatchSingleKey(o interface{}, key string)
	Remove(key []byte)
}

type FinalizationData

type FinalizationData struct {
	DagCount  uint64 `json:"dag_blocks_executed"`
	TrxCount  uint64 `json:"transactions_executed"`
	PbftCount uint64 `json:"pbft_period"`
}

func (*FinalizationData) Check

func (local *FinalizationData) Check(remote FinalizationData)

type GenesisHash

type GenesisHash string

type MultipliedYield

type MultipliedYield struct {
	Yield *big.Int `json:"yield"`
}

type Paginated

type Paginated interface {
	models.Transaction | models.Dag | models.Pbft
}

type PeriodRewards

type PeriodRewards struct {
	ValidatorRewards []ValidatorReward
	TotalReward      *big.Int
	BlockFee         *big.Int
}

map can't be serialized to rlp, so we need to use slice of structs

type Storage

type Storage interface {
	Clean() error
	Close() error
	ForEach(o interface{}, key_prefix string, start *uint64, fn func(key, res []byte) (stop bool))
	ForEachBackwards(o interface{}, key_prefix string, start *uint64, fn func(key, res []byte) (stop bool))
	ForEachFromKey(prefix, start_key []byte, fn func(key, res []byte) (stop bool))
	NewBatch() Batch
	GetTotalSupply() *TotalSupply
	GetAccounts() []Account
	GetWeekStats(year, week int32) WeekStats
	GetFinalizationData() *FinalizationData
	GetAddressStats(addr string) *AddressStats
	GenesisHashExist() bool
	GetGenesisHash() GenesisHash
	GetTransactionByHash(hash string) models.Transaction
	GetInternalTransactions(hash string) models.InternalTransactionsResponse
	GetTransactionLogs(hash string) models.TransactionLogsResponse
	GetValidatorYield(validator string, block uint64) (res Yield)
	GetTotalYield(block uint64) (res Yield)
}

type TotalSupply

type TotalSupply = big.Int

type ValidatorReward

type ValidatorReward struct {
	Validator string   `json:"validator"`
	Reward    *big.Int `json:"reward"`
}

type ValidatorYield

type ValidatorYield struct {
	Validator string   `json:"validator"`
	Yield     *big.Int `json:"yield"`
}

type ValidatorsYield

type ValidatorsYield struct {
	Yields []ValidatorYield `json:"yields"`
}

type WeekStats

type WeekStats struct {
	Validators []models.Validator
	Total      uint32
	Key        []byte `rlp:"-"`
}

func MakeEmptyWeekStats

func MakeEmptyWeekStats() *WeekStats

func (*WeekStats) AddPbftBlock

func (w *WeekStats) AddPbftBlock(block *models.Pbft)

func (*WeekStats) GetPaginated

func (w *WeekStats) GetPaginated(from, count uint64) ([]models.Validator, *models.PaginatedResponse)

func (*WeekStats) Sort

func (w *WeekStats) Sort()

type Yield

type Yield struct {
	Yield string `json:"yield"`
}

type Yields

type Yields interface {
	ValidatorsYield | MultipliedYield
}