add address utils endpoints

Author: n8mgr

api/server.go

@@ -59,6 +59,8 @@ type (
 		V2Transactions(ids []types.TransactionID) ([]explorer.V2Transaction, error)
 		V2TransactionChainIndices(id types.TransactionID, offset, limit uint64) ([]types.ChainIndex, error)
 		Balance(address types.Address) (sc types.Currency, immatureSC types.Currency, sf uint64, err error)
+		TopSiacoinAddresses(limit, offset int) (result []explorer.TopSiacoin, err error)
+		TopSiafundAddresses(limit, offset int) (result []explorer.TopSiafund, err error)
 		SiacoinElements(ids []types.SiacoinOutputID) (result []explorer.SiacoinOutput, err error)
 		SiafundElements(ids []types.SiafundOutputID) (result []explorer.SiafundOutput, err error)
 		UnspentSiacoinOutputs(address types.Address, offset, limit uint64) ([]explorer.SiacoinOutput, error)
@@ -838,6 +840,39 @@ func (s *server) healthHandler(jc jape.Context) {
 	jc.Encode(nil)
 }
 
+func (s *server) topAddressesSiacoinsHandler(jc jape.Context) {
+	limit := defaultLimit
+	offset := uint64(0)
+	if jc.DecodeForm("limit", &limit) != nil || jc.DecodeForm("offset", &offset) != nil {
+		return
+	}
+	if limit > maxLimit {
+		limit = maxLimit
+	}
+
+	topAddresses, err := s.e.TopSiacoinAddresses(int(limit), int(offset))
+	if jc.Check("failed to get top siacoin addresses", err) != nil {
+		return
+	}
+	jc.Encode(topAddresses)
+}
+func (s *server) topAddressesSiafundsHandler(jc jape.Context) {
+	limit := defaultLimit
+	offset := uint64(0)
+	if jc.DecodeForm("limit", &limit) != nil || jc.DecodeForm("offset", &offset) != nil {
+		return
+	}
+	if limit > maxLimit {
+		limit = maxLimit
+	}
+
+	topAddresses, err := s.e.TopSiafundAddresses(int(limit), int(offset))
+	if jc.Check("failed to get top siacoin addresses", err) != nil {
+		return
+	}
+	jc.Encode(topAddresses)
+}
+
 // NewServer returns an HTTP handler that serves the explored API.
 func NewServer(e Explorer, cm ChainManager, s Syncer, ex exchangerates.Source, apiPassword string) http.Handler {
 	srv := server{
@@ -883,6 +918,9 @@ func NewServer(e Explorer, cm ChainManager, s Syncer, ex exchangerates.Source, a
 		"GET    /addresses/:address/events/unconfirmed": srv.addressessAddressEventsUnconfirmedHandler,
 		"GET    /addresses/:address/balance":            srv.addressessAddressBalanceHandler,
 
+		"GET /top/addresses/siacoins": srv.topAddressesSiacoinsHandler,
+		"GET /top/addresses/siafunds": srv.topAddressesSiafundsHandler,
+
 		"GET    /events/:id": srv.eventsIDHandler,
 
 		"GET    /outputs/siacoin/:id": srv.outputsSiacoinHandler,

explorer/explorer.go

@@ -113,6 +113,9 @@ type Store interface {
 
 	QueryHosts(params HostQuery, sortBy HostSortColumn, dir HostSortDir, offset, limit uint64) ([]Host, error)
 	HostsForScanning(minLastAnnouncement time.Time, limit uint64) ([]UnscannedHost, error)
+
+	TopSiacoinAddresses(limit, offset int) ([]TopSiacoin, error)
+	TopSiafundAddresses(limit, offset int) ([]TopSiafund, error)
 }
 
 // Explorer implements a Sia explorer.
@@ -162,6 +165,18 @@ func (e *Explorer) syncStore(index types.ChainIndex, batchSize int) error {
 	return nil
 }
 
+// TopSiacoinAddresses returns a paginated list of Siacoin addresses ordered
+// by balance.
+func (e *Explorer) TopSiacoinAddresses(limit, offset int) ([]TopSiacoin, error) {
+	return e.s.TopSiacoinAddresses(limit, offset)
+}
+
+// TopSiafundAddresses returns a paginated list of Siafund addresses ordered
+// by balance.
+func (e *Explorer) TopSiafundAddresses(limit, offset int) ([]TopSiafund, error) {
+	return e.s.TopSiafundAddresses(limit, offset)
+}
+
 // NewExplorer returns a Sia explorer.
 func NewExplorer(cm ChainManager, store Store, indexCfg config.Index, scanCfg config.Scanner, log *zap.Logger) (*Explorer, error) {
 	e := &Explorer{

explorer/types.go

@@ -619,3 +619,15 @@ type DifficultyMetrics struct {
 	Difficulties  []consensus.Work `json:"difficulties"`
 	BlockTimes    []time.Duration  `json:"blockTimes"`
 }
+
+// TopSiacoin pairs an address with its Siacoin balance
+type TopSiacoin struct {
+	Address types.Address  `json:"address"`
+	Amount  types.Currency `json:"amount"`
+}
+
+// TopSiafund pairs an address with its Siafund balance
+type TopSiafund struct {
+	Address types.Address `json:"address"`
+	Amount  uint64        `json:"amount"`
+}

persist/sqlite/addresses.go

@@ -271,3 +271,53 @@ func (s *Store) Balance(address types.Address) (sc types.Currency, immatureSC ty
 	})
 	return
 }
+
+// TopSiacoinAddresses returns a paginated list of Siacoin addresses ordered
+// by balance.
+func (s *Store) TopSiacoinAddresses(limit, offset int) (result []explorer.TopSiacoin, err error) {
+	err = s.transaction(func(tx *txn) error {
+		rows, err := tx.Query(`SELECT address, siacoin_balance FROM address_balance ORDER BY siacoin_balance DESC LIMIT $1 OFFSET $2`, limit, offset)
+		if err != nil {
+			return fmt.Errorf("failed to query top siacoin addresses: %w", err)
+		}
+		defer rows.Close()
+
+		for rows.Next() {
+			var address explorer.TopSiacoin
+			if err := rows.Scan(decode(&address.Address), decode(&address.Amount)); err != nil {
+				return fmt.Errorf("failed to scan top siacoin address: %w", err)
+			}
+			result = append(result, address)
+		}
+		if err := rows.Err(); err != nil {
+			return fmt.Errorf("failed to retrieve top siacoin address rows: %w", err)
+		}
+		return nil
+	})
+	return
+}
+
+// TopSiafundAddresses returns a paginated list of Siafund addresses ordered
+// by balance.
+func (s *Store) TopSiafundAddresses(limit, offset int) (result []explorer.TopSiafund, err error) {
+	err = s.transaction(func(tx *txn) error {
+		rows, err := tx.Query(`SELECT address, siafund_balance FROM address_balance ORDER BY siafund_balance DESC LIMIT $1 OFFSET $2`, limit, offset)
+		if err != nil {
+			return fmt.Errorf("failed to query top siafund addresses: %w", err)
+		}
+		defer rows.Close()
+
+		for rows.Next() {
+			var address explorer.TopSiafund
+			if err := rows.Scan(decode(&address.Address), decode(&address.Amount)); err != nil {
+				return fmt.Errorf("failed to scan top siafund address: %w", err)
+			}
+			result = append(result, address)
+		}
+		if err := rows.Err(); err != nil {
+			return fmt.Errorf("failed to retrieve top siafund address rows: %w", err)
+		}
+		return nil
+	})
+	return
+}