address.go

// Copyright 2018 Vasiliy Vasilyuk. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package blockchair

import (
	"encoding/json"
	"errors"
)

// AddressResponse includes full server response to address request.
type AddressResponse struct {
	Data   []Address `json:"data"`
	Rows   uint      `json:"rows"`
	Limit  int64     `json:"limit"`
	Time   float64   `json:"time"`
	Cache  int       `json:"cache"`
	Source string    `json:"source"`
}

// Address describes the structure of the address.
type Address struct {
	SumValue            json.Number `json:"sum_value"`
	SumValueUsd         json.Number `json:"sum_value_usd"`
	SumSpendingValueUsd json.Number `json:"sum_spending_value_usd"`
	MaxTimeReceiving    string      `json:"max_time_receiving"`
	MaxTimeSpending     string      `json:"max_time_spending"`
	MinTimeReceiving    string      `json:"min_time_receiving"`
	CountTotal          json.Number `json:"count_total"`
	Rate                json.Number `json:"rate"`
	SumValueUnspent     json.Number `json:"sum_value_unspent"`
	SumValueUnspentUsd  json.Number `json:"sum_value_unspent_usd"`
	CountUnspent        json.Number `json:"count_unspent"`
	PluUsd              json.Number `json:"plu_usd"`
	MinTimeSpending     string      `json:"min_time_spending"`
	PlUsd               json.Number `json:"pl_usd"`
	ReceivingActivity   []Activity  `json:"receiving_activity"`
	SpendingActivity    []Activity  `json:"spending_activity"`
}

// Activity describes the structure of the activity.
type Activity struct {
	Year  int    `json:"year"`
	Month int    `json:"month"`
	Value string `json:"value"`
}

// GetAddress get address.
//
// https://api.blockchair.com/bitcoin/dashboards/address/{address}
func (c *Client) GetAddress(address string) (a *Address, e error) {
	if e = c.checkAddress(address); e != nil {
		return
	}

	response, e := c.GetAddressRaw(address)

	if len(response.Data) == 1 {
		a = &response.Data[0]
	} else if len(response.Data) > 1 {
		e = errors.New("unexpected response from the server")
	}

	return
}

// GetAddressRaw get full address response.
//
// https://api.blockchair.com/bitcoin/dashboards/address/{address}
func (c *Client) GetAddressRaw(address string) (response *AddressResponse, e error) {
	if e = c.checkAddress(address); e != nil {
		return
	}

	response = &AddressResponse{}
	e = c.Do("/dashboards/address/"+address, response)

	return
}

// ValidateBitcoinAddress bitcoin address validator.
func ValidateBitcoinAddress(address string) bool {
	return validateBitcoinAddress(address) != -1
}

func (c *Client) checkAddress(address string) error {
	if !ValidateBitcoinAddress(address) {
		return c.err4(ErrAIW, address)
	}

	return nil
}