mrz1836 / go-whatsonchain Goto Github PK

View Code? Open in Web Editor NEW

14.0 5.0 5.0 426 KB

:link: Unofficial golang implementation for the WhatsOnChain API

Home Page: https://developers.whatsonchain.com/

License: MIT License

Go 97.07% Makefile 2.93%

go golang whatsonchain api bsv bitcoin woc gomodule gomod whatsonchain-api

go-whatsonchain's Introduction

go-whatsonchain

The unofficial golang implementation for the whatsonchain.com API

Installation
Documentation
Examples & Tests
Benchmarks
Code Standards
Usage
Maintainers
Contributing
License

Installation

go-whatsonchain requires a supported release of Go.

go get -u github.com/mrz1836/go-whatsonchain

Documentation

View the generated documentation

Features

Client is completely configurable
Customize the network per request (main, test or stn)
Using default heimdall http client with exponential backoff & more
Use your own custom HTTP client and API Key
Current coverage for the whatsonchain.com API
- Health
  - Get API Status
- Chain Info
  - Get Blockchain Info
  - Get Circulating Supply
- Block
  - Get by Hash
  - Get by Height
  - Get Block Pages
  - Get Header by Hash
  - Get Headers
- Transaction
  - Get by TX Hash
  - Broadcast Transaction
  - Bulk Broadcast
  - Bulk Transaction Details
  - Decode Transaction
  - Download Receipt
  - Get Raw Transaction Data
  - Get Raw Transaction Output
  - Get Merkle Proof
  - Get Merkle Proof (TSC)
  - Get Bulk Transaction Details (Custom)
- Mempool
  - Get Mempool Info
  - Get Mempool Transactions
- Address
  - Get Address Info
  - Get Balance
  - Get History
  - Get Unspent Transactions
  - Get Unspent Transaction Details (Custom)
  - Bulk Balance
  - Bulk UTXOs
  - Download Statement
- Script
  - Get Script History
  - Get Script Unspent Transactions
  - Bulk UTXOs
- Exchange Rate
  - Get Exchange Rate
- Search
  - Get Explorer Links
- Web Sockets
  - New block header event
  - Block headers history
  - Block transactions
  - Mempool transactions
  - Confirmed transactions
  - Chain Stats
  - Customized events

Library Deployment

goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

Makefile Commands

View all makefile commands

make help

List of all current commands:

all                   Runs lint, test-short and vet
clean                 Remove previous builds and any test cache data
clean-mods            Remove all the Go mod cache
coverage              Shows the test coverage
diff                  Show the git diff
generate              Runs the go generate command in the base of the repo
godocs                Sync the latest tag with GoDocs
help                  Show this help message
install               Install the application
install-go            Install the application (Using Native Go)
install-releaser      Install the GoReleaser application
lint                  Run the golangci-lint application (install if not found)
release               Full production release (creates release in Github)
release               Runs common.release then runs godocs
release-snap          Test the full release (build binaries)
release-test          Full production test release (everything except deploy)
replace-version       Replaces the version in HTML/JS (pre-deploy)
tag                   Generate a new tag and push (tag version=0.0.0)
tag-remove            Remove a tag if found (tag-remove version=0.0.0)
tag-update            Update an existing tag to current commit (tag-update version=0.0.0)
test                  Runs lint and ALL tests
test-ci               Runs all tests via CI (exports coverage)
test-ci-no-race       Runs all tests via CI (no race) (exports coverage)
test-ci-short         Runs unit tests via CI (exports coverage)
test-no-lint          Runs just tests
test-short            Runs vet, lint and tests (excludes integration tests)
test-unit             Runs tests and outputs coverage
uninstall             Uninstall the application (and remove files)
update-linter         Update the golangci-lint package (macOS only)
vet                   Run the Go vet application

Examples & Tests

All unit tests and examples run via Github Actions and uses Go version 1.18.x. View the configuration file.

Run all tests (including integration tests)

make test

Run tests (excluding integration tests)

make test-short

Benchmarks

Run the Go benchmarks:

make bench

Code Standards

Read more about this Go project's code standards.

Usage

View the whatsonchain examples

Basic implementation:

package main

import (
    "context"
    "fmt"
    
    "github.com/mrz1836/go-whatsonchain"
)

func main() {

    // Create a client
    client := whatsonchain.NewClient(whatsonchain.NetworkMain, nil, nil)

    // Get a balance for an address
    balance, _ := client.AddressBalance(context.Background(),"16ZqP5Tb22KJuvSAbjNkoiZs13mmRmexZA")
    fmt.Println("confirmed balance", balance.Confirmed)
}

Maintainers


MrZ

Contributing

View the contributing guidelines and please follow the code of conduct.

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀