Documentation ¶
Overview ¶
Package explorer handles the block explorer subsystem for generating the explorer pages. Copyright (c) 2017, The dcrdata developers See LICENSE for details.
Index ¶
- Constants
- Variables
- func AddressPathCtx(next http.Handler) http.Handler
- func DisableLog()
- func New(dataSource explorerDataSourceLite, primaryDataSource explorerDataSource, ...) *explorerUI
- func TicketStatusText(s dbtypes.TicketSpendType, p dbtypes.TicketPoolStatus) string
- func TransactionHashCtx(next http.Handler) http.Handler
- func UseLogger(logger slog.Logger)
- type AddrPrefix
- type AddressBalance
- type AddressInfo
- type AddressTransactions
- type AddressTx
- type BlockBasic
- type BlockInfo
- type BlockSubsidy
- type BlockValidation
- type ChainParams
- type ExtendedChainParams
- type HomeInfo
- type MempoolInfo
- type MempoolShort
- type MempoolTx
- type NewMempoolTx
- type TicketInfo
- type TicketPoolInfo
- type TxBasic
- type TxInID
- type TxInfo
- type Vin
- type VoteInfo
- type Vout
- type WebSocketMessage
- type WebsocketBlock
- type WebsocketHub
Constants ¶
const ( MaxAddressRows int64 = 1000 MaxUnconfirmedPossible int64 = 1000 )
const NumLatestMempoolTxns = 5
NumLatestMempoolTxns is the maximum number of mempool transactions that will be stored in MempoolData.LatestTransactions.
Variables ¶
var ErrWsClosed = "use of closed network connection"
Functions ¶
func AddressPathCtx ¶ added in v1.3.0
AddressPathCtx embeds "address" into the request context
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, appVersion string, devPrefetch bool) *explorerUI
New returns an initialized instance of explorerUI
func TicketStatusText ¶
func TicketStatusText(s dbtypes.TicketSpendType, p dbtypes.TicketPoolStatus) string
TicketStatusText generates the text to display on the explorer's transaction page for the "POOL STATUS" field.
func TransactionHashCtx ¶ added in v1.3.0
TransactionHashCtx embeds "txid" into the request context
Types ¶
type AddrPrefix ¶
AddrPrefix represent the address name it's prefix and description
func AddressPrefixes ¶
func AddressPrefixes(params *chaincfg.Params) []AddrPrefix
AddressPrefixes generates an array AddrPrefix by using chaincfg.Params
type AddressBalance ¶ added in v1.0.1
type AddressBalance struct { Address string `json:"address"` NumSpent int64 `json:"num_stxos"` NumUnspent int64 `json:"num_utxos"` TotalSpent int64 `json:"amount_spent"` TotalUnspent int64 `json:"amount_unspent"` }
AddressBalance represents the number and value of spent and unspent outputs for an address.
type AddressInfo ¶
type AddressInfo struct { // Address is the decred address on the current page Address string // Page parameters MaxTxLimit int64 Fullmode bool Path string Limit, Offset int64 // ?n=Limit&start=Offset TxnType string // ?txntype=TxnType // NumUnconfirmed is the number of unconfirmed txns for the address NumUnconfirmed int64 UnconfirmedTxns *AddressTransactions // Transactions on the current page Transactions []*AddressTx TxnsFunding []*AddressTx TxnsSpending []*AddressTx NumTransactions int64 // The number of transactions in the address NumFundingTxns int64 // number paying to the address NumSpendingTxns int64 // number spending outpoints associated with the address AmountReceived dcrutil.Amount AmountSent dcrutil.Amount AmountUnspent dcrutil.Amount // Balance is used in full mode, describing all known transactions Balance *AddressBalance // KnownTransactions refers to the total transaction count in the DB when in // full mode, the sum of funding (crediting) and spending (debiting) txns. KnownTransactions int64 KnownFundingTxns int64 KnownSpendingTxns int64 }
AddressInfo models data for display on the address page
func ReduceAddressHistory ¶ added in v1.0.1
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.
func (*AddressInfo) TxnCount ¶
func (a *AddressInfo) TxnCount() int64
TxnCount returns the number of transaction "rows" available.
type AddressTransactions ¶
type AddressTransactions struct { Transactions []*AddressTx TxnsFunding []*AddressTx TxnsSpending []*AddressTx }
AddressTransactions collects the transactions for an address as AddressTx slices.
type AddressTx ¶
type AddressTx struct { TxID string InOutID uint32 Size uint32 FormattedSize string Total float64 Confirmations uint64 Time int64 FormattedTime string ReceivedTotal float64 SentTotal float64 }
AddressTx models data for transactions on the address page
type BlockBasic ¶
type BlockBasic struct { Height int64 `json:"height"` Size int32 `json:"size"` Valid bool `json:"valid"` Voters uint16 `json:"votes"` Transactions int `json:"tx"` FreshStake uint8 `json:"tickets"` Revocations uint32 `json:"revocations"` BlockTime int64 `json:"time"` FormattedTime string `json:"formatted_time"` FormattedBytes string `json:"formatted_bytes"` }
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 TxAvailable bool Tx []*TxBasic Tickets []*TxBasic Revs []*TxBasic Votes []*TxBasic Misses []string 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 StakeValidationHeight int64 }
BlockInfo models data for display on the block page
type BlockSubsidy ¶ added in v1.3.0
type BlockSubsidy struct { Total int64 `json:"total"` PoW int64 `json:"pow"` PoS int64 `json:"pos"` Dev int64 `json:"dev"` }
BlockSubsidy is an implementation of dcrjson.GetBlockSubsidyResult
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 ChainParams ¶ added in v1.3.0
type ChainParams struct { WindowSize int64 `json:"window_size"` RewardWindowSize int64 `json:"reward_window_size"` TargetPoolSize int64 `json:"target_pool_size"` BlockTime int64 `json:"target_block_time"` MeanVotingBlocks int64 }
ChainParams models simple data about the chain server's parameters used for some info on the front page
type ExtendedChainParams ¶
type ExtendedChainParams struct { Params *chaincfg.Params ActualTicketPoolSize int64 AddressPrefix []AddrPrefix }
ExtendedChainParams represents the data of ChainParams
type HomeInfo ¶ added in v1.3.0
type HomeInfo struct { CoinSupply int64 `json:"coin_supply"` StakeDiff float64 `json:"sdiff"` IdxBlockInWindow int `json:"window_idx"` IdxInRewardWindow int `json:"reward_idx"` Difficulty float64 `json:"difficulty"` DevFund int64 `json:"dev_fund"` DevAddress string `json:"dev_address"` TicketReward float64 `json:"reward"` RewardPeriod string `json:"reward_period"` ASR float64 `json:"ASR"` NBlockSubsidy BlockSubsidy `json:"subsidy"` Params ChainParams `json:"params"` PoolInfo TicketPoolInfo `json:"pool_info"` }
HomeInfo represents data used for the home page
type MempoolInfo ¶ added in v1.3.0
type MempoolInfo struct { sync.RWMutex MempoolShort Transactions []MempoolTx `json:"tx"` Tickets []MempoolTx `json:"tickets"` Votes []MempoolTx `json:"votes"` Revocations []MempoolTx `json:"revs"` }
MempoolInfo models data to update mempool info on the home page
type MempoolShort ¶
type MempoolShort struct { LastBlockHeight int64 `json:"block_height"` LastBlockTime int64 `json:"block_time"` TotalOut float64 `json:"total"` TotalSize int32 `json:"size"` NumTickets int `json:"num_tickets"` NumVotes int `json:"num_votes"` NumRegular int `json:"num_regular"` NumRevokes int `json:"num_revokes"` NumAll int `json:"num_all"` LatestTransactions []MempoolTx `json:"latest"` FormattedTotalSize string `json:"formatted_size"` TicketIndexes map[string]int `json:"ticket_indexes"` }
MempoolShort represents the mempool data sent as the mempool update
type MempoolTx ¶
type MempoolTx struct { Hash string `json:"hash"` Time int64 `json:"time"` Size int32 `json:"size"` TotalOut float64 `json:"total"` Type string `json:"Type"` VoteInfo *VoteInfo `json:"vote_info"` }
MempoolTx models the tx basic data for the mempool page
type NewMempoolTx ¶
NewMempoolTx models data sent from the notification handler
type TicketInfo ¶
type TicketInfo struct { TicketMaturity int64 TimeTillMaturity float64 // Time before a particular ticket reaches maturity, in hours PoolStatus string SpendStatus string TicketPoolSize int64 // Total number of ticket in the pool TicketExpiry int64 // Total number of blocks before a ticket expires TicketExpiryDaysLeft float64 // Approximate days left before the given ticket expires TicketLiveBlocks int64 // Total number of confirms after maturity and up until the point the ticket votes or expires BestLuck int64 // Best possible Luck for voting AvgLuck int64 // Average Luck for voting VoteLuck float64 // Actual Luck for voting on a ticket LuckStatus string // Short discription based on the VoteLuck Probability float64 // Probability of success before ticket expires }
TicketInfo is used to represent data shown for a sstx transaction.
type TicketPoolInfo ¶ added in v1.3.0
type TicketPoolInfo struct { Size uint32 `json:"size"` Value float64 `json:"value"` ValAvg float64 `json:"valavg"` Percentage float64 `json:"percent"` Target uint16 `json:"target"` PercentTarget float64 `json:"percent_target"` }
TicketPoolInfo describes the live ticket pool
type TxBasic ¶
type TxBasic struct { TxID string FormattedSize string Total float64 Fee dcrutil.Amount FeeRate dcrutil.Amount VoteInfo *VoteInfo Coinbase bool }
TxBasic models data for transactions on the block page
type TxInfo ¶
type TxInfo struct { *TxBasic SpendingTxns []TxInID Type string Vin []Vin Vout []Vout BlockHeight int64 BlockIndex uint32 BlockHash string BlockMiningFee int64 Confirmations int64 Time int64 FormattedTime string Mature string VoteFundsLocked string Maturity int64 // Total number of blocks before mature MaturityTimeTill float64 // Time in hours until mature TicketInfo }
TxInfo models data needed for display on the tx page
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"` TicketSpent string `json:"ticket_spent"` MempoolTicketIndex int `json:"mempool_ticket_index"` }
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
type WebSocketMessage ¶ added in v1.1.0
WebSocketMessage represents the JSON object used to send and received typed messages to the web client.
type WebsocketBlock ¶ added in v1.1.0
type WebsocketBlock struct { Block *BlockBasic `json:"block"` Extra *HomeInfo `json:"extra"` }
WebsocketBlock wraps the new block info for use in the websocket
type WebsocketHub ¶ added in v1.1.0
type WebsocketHub struct { Register chan *clientHubSpoke Unregister chan *hubSpoke HubRelay chan hubSignal NewTxChan chan *MempoolTx // contains filtered or unexported fields }
WebsocketHub and its event loop manage all websocket client connections. WebsocketHub is responsible for closing all connections registered with it. If the event loop is running, calling (*WebsocketHub).Stop() will handle it.
func NewWebsocketHub ¶ added in v1.1.0
func NewWebsocketHub() *WebsocketHub
NewWebsocketHub creates a new WebsocketHub
func (*WebsocketHub) MaybeSendTxns ¶
func (wsh *WebsocketHub) MaybeSendTxns(tx *MempoolTx)
MaybeSendTxns adds a mempool transaction to the client broadcast buffer. If the buffer is at capacity, a goroutine is launched to signal for the transactions to be sent to the clients.
func (*WebsocketHub) NumClients ¶ added in v1.1.0
func (wsh *WebsocketHub) NumClients() int
NumClients returns the number of clients connected to the websocket hub
func (*WebsocketHub) RegisterClient ¶ added in v1.1.0
func (wsh *WebsocketHub) RegisterClient(c *hubSpoke) *client
RegisterClient registers a websocket connection with the hub, and returns a pointer to the new client data object.
func (*WebsocketHub) Stop ¶ added in v1.1.0
func (wsh *WebsocketHub) Stop()
Stop kills the run() loop and unregisteres all clients (connections).
func (*WebsocketHub) UnregisterClient ¶ added in v1.1.0
func (wsh *WebsocketHub) UnregisterClient(c *hubSpoke)
UnregisterClient unregisters the input websocket connection via the main run() loop. This call will block if the run() loop is not running.