explorer

Documentation

Overview

Copyright (c) 2017, The dcrdata developers See LICENSE for details.

Index

• func DisableLog()
• func New(dataSource explorerDataSourceLite, primaryDataSource explorerDataSource, ...) *explorerUI
• func UseLogger(logger btclog.Logger)
• type AddressBalance
• type AddressInfo
  • func ReduceAddressHistory(addrHist []*dbtypes.AddressRow) *AddressInfo
• type AddressTx
• type BlockBasic
• type BlockInfo
• type BlockValidation
• type TxBasic
• type TxInID
• type TxInfo
• type Vin
• type VoteInfo
• type Vout

Functions

func DisableLog

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until UseLogger is called.

func New

func New(dataSource explorerDataSourceLite, primaryDataSource explorerDataSource,
	useRealIP bool) *explorerUI

New returns an initialized instance of explorerUI

func UseLogger

func UseLogger(logger btclog.Logger)

UseLogger uses a specified Logger to output package logging info.

Types

type AddressBalance

type AddressBalance struct {
	Address      string
	NumSpent     int64
	NumUnspent   int64
	TotalSpent   int64
	TotalUnspent int64
}

AddressBalance represents the number and value of spent and unspent outputs for an address.

type AddressInfo

type AddressInfo struct {
	Address          string
	Limit            int64
	Offset           int64
	Transactions     []*AddressTx
	NumFundingTxns   int64
	NumSpendingTxns  int64
	KnownFundingTxns int64
	NumUnconfirmed   int64
	TotalReceived    dcrutil.Amount
	TotalSent        dcrutil.Amount
	Unspent          dcrutil.Amount
	Balance          *AddressBalance
	Path             string
}

AddressInfo models data for display on the address page

func ReduceAddressHistory

func ReduceAddressHistory(addrHist []*dbtypes.AddressRow) *AddressInfo

ReduceAddressHistory generates a template AddressInfo from a slice of dbtypes.AddressRow. All fields except NumUnconfirmed and Transactions are set completely. Transactions is partially set, with each transaction having only the TxID and ReceivedTotal set. The rest of the data should be filled in by other means, such as RPC calls or database queries.

type AddressTx

type AddressTx struct {
	TxID          string
	FormattedSize string
	Total         float64
	Confirmations uint64
	Time          int64
	FormattedTime string
	RecievedTotal float64
	SentTotal     float64
}

AddressTx models data for transactions on the address page

type BlockBasic

type BlockBasic struct {
	Height         int64
	Size           int32
	Valid          bool
	Voters         uint16
	Transactions   uint32
	FreshStake     uint8
	Revocations    uint32
	BlockTime      int64
	FormattedTime  string
	FormattedBytes string
}

BlockBasic models data for the explorer's explorer page

type BlockInfo

type BlockInfo struct {
	*BlockBasic
	Hash          string
	Version       int32
	Confirmations int64
	StakeRoot     string
	MerkleRoot    string
	Tx            []*TxBasic
	Tickets       []*TxBasic
	Revs          []*TxBasic
	Votes         []*TxBasic
	Nonce         uint32
	VoteBits      uint16
	FinalState    string
	PoolSize      uint32
	Bits          string
	SBits         float64
	Difficulty    float64
	ExtraData     string
	StakeVersion  uint32
	PreviousHash  string
	NextHash      string
	TotalSent     float64
	MiningFee     dcrutil.Amount
}

BlockInfo models data for display on the block page

type BlockValidation

type BlockValidation struct {
	Hash     string `json:"hash"`
	Height   int64  `json:"height"`
	Validity bool   `json:"validity"`
}

BlockValidation models data about a vote's decision on a block

type TxBasic

type TxBasic struct {
	TxID          string
	FormattedSize string
	Total         float64
	Fee           dcrutil.Amount
	FeeRate       dcrutil.Amount
	VoteInfo      *VoteInfo
}

TxBasic models data for transactions on the block page

type TxInID

type TxInID struct {
	Hash  string
	Index uint32
}

TxInID models the identity of a spending transaction input

type TxInfo

type TxInfo struct {
	*TxBasic
	SpendingTxns    []TxInID
	Type            string
	Vin             []Vin
	Vout            []Vout
	BlockHeight     int64
	BlockIndex      uint32
	Confirmations   int64
	Time            int64
	FormattedTime   string
	Mature          string
	VoteFundsLocked string
	TicketMaturity  int64
}

TxInfo models data needed for display on the tx page

type Vin

type Vin struct {
	*dcrjson.Vin
	Addresses       []string
	FormattedAmount string
}

Vin models basic data about a tx input for display

type VoteInfo

type VoteInfo struct {
	Validation BlockValidation         `json:"block_validation"`
	Version    uint32                  `json:"vote_version"`
	Bits       uint16                  `json:"vote_bits"`
	Choices    []*txhelpers.VoteChoice `json:"vote_choices"`
}

VoteInfo models data about a SSGen transaction (vote)

type Vout

type Vout struct {
	Addresses       []string
	Amount          float64
	FormattedAmount string
	Type            string
	Spent           bool
	OP_RETURN       string
}

Vout models basic data about a tx output for display