blocks.go

package whatsonchain

import (
	"context"
	"encoding/json"
	"fmt"
	"net/http"
)

// GetBlockByHash this endpoint retrieves block details with given hash.
//
// For more information: https://developers.whatsonchain.com/#get-by-hash
func (c *Client) GetBlockByHash(ctx context.Context, hash string) (blockInfo *BlockInfo, err error) {

	var resp string
	// https://api.whatsonchain.com/v1/bsv/<network>/block/hash/<hash>
	if resp, err = c.request(
		ctx,
		fmt.Sprintf("%s%s/block/hash/%s", apiEndpoint, c.Network(), hash),
		http.MethodGet, nil,
	); err != nil {
		return
	}
	if len(resp) == 0 {
		return nil, ErrBlockNotFound
	}
	err = json.Unmarshal([]byte(resp), &blockInfo)
	return
}

// GetBlockByHeight this endpoint retrieves block details with given block height.
//
// For more information: https://developers.whatsonchain.com/#get-by-height
func (c *Client) GetBlockByHeight(ctx context.Context, height int64) (blockInfo *BlockInfo, err error) {

	var resp string
	// https://api.whatsonchain.com/v1/bsv/<network>/block/height/<height>
	if resp, err = c.request(
		ctx,
		fmt.Sprintf("%s%s/block/height/%d", apiEndpoint, c.Network(), height),
		http.MethodGet, nil,
	); err != nil {
		return
	}
	if len(resp) == 0 {
		return nil, ErrBlockNotFound
	}
	err = json.Unmarshal([]byte(resp), &blockInfo)
	return
}

// GetBlockPages if the block has more than 1000 transactions the page URIs will
// be provided in the "pages element" when getting a block by hash or height.
//
// For more information: https://developers.whatsonchain.com/#get-block-pages
func (c *Client) GetBlockPages(ctx context.Context, hash string, page int) (txList BlockPagesInfo, err error) {

	var resp string
	// https://api.whatsonchain.com/v1/bsv/<network>/block/hash/<hash>/page/1
	if resp, err = c.request(
		ctx,
		fmt.Sprintf("%s%s/block/hash/%s/page/%d", apiEndpoint, c.Network(), hash, page),
		http.MethodGet, nil,
	); err != nil {
		return
	}
	if len(resp) == 0 {
		return nil, ErrBlockNotFound
	}
	err = json.Unmarshal([]byte(resp), &txList)
	return
}

// GetHeaderByHash this endpoint retrieves block header details with given hash.
//
// For more information: https://developers.whatsonchain.com/#get-header-by-hash
func (c *Client) GetHeaderByHash(ctx context.Context, hash string) (headerInfo *BlockInfo, err error) {

	var resp string
	// https://api.whatsonchain.com/v1/bsv/<network>/block/<hash>/header
	if resp, err = c.request(
		ctx,
		fmt.Sprintf("%s%s/block/%s/header", apiEndpoint, c.Network(), hash),
		http.MethodGet, nil,
	); err != nil {
		return
	}
	if len(resp) == 0 {
		return nil, ErrBlockNotFound
	}
	err = json.Unmarshal([]byte(resp), &headerInfo)
	return
}

// GetHeaders this endpoint retrieves last 10 block headers.
//
// For more information: https://developers.whatsonchain.com/#get-headers
func (c *Client) GetHeaders(ctx context.Context) (blockHeaders []*BlockInfo, err error) {

	var resp string
	// https://api.whatsonchain.com/v1/bsv/<network>/block/headers
	if resp, err = c.request(
		ctx,
		fmt.Sprintf("%s%s/block/headers", apiEndpoint, c.Network()),
		http.MethodGet, nil,
	); err != nil {
		return
	}
	if len(resp) == 0 {
		return nil, ErrHeadersNotFound
	}
	err = json.Unmarshal([]byte(resp), &blockHeaders)
	return
}