go-bitindex

:minidisc: Unofficial golang implementation for the BitIndex API

Programming language: Go

License: MIT License

Tags: API     Go Tools     Go     Golang     Bitcoin     Bsv     Bitindex    

Latest version: v0.2.4

README

go-bitindex

The unofficial Go implementation for the BitIndex API

Table of Contents

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

Installation

go-bitindex requires a supported release of Go. ```shell script go get -u github.com/mrz1836/go-bitindex

<br/>

## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/mrz1836/go-bitindex)

[![GoDoc](https://godoc.org/github.com/mrz1836/go-bitindex?status.svg&style=flat)](https://pkg.go.dev/github.com/mrz1836/go-bitindex)

You can also view the [BitIndex api](https://www.bitindex.network/developers/api-documentation-v3.html) documentation.

### Features
- Supports >= V3 API requests
- [Client](client.go) is completely configurable
- Customize the network per request (`main`, `test` or `stn`)
- Using [heimdall http client](https://github.com/gojek/heimdall) with exponential backoff & more
- Current (V3) coverage for the [BitIndex](https://developers.bitindex.com/) API
    - [x] Address
    - [x] Block
    - [x] Chain Info
    - [x] Transaction
    - [x] Webhooks
    - [x] Xpub

<details>
<summary><strong><code>Library Deployment</code></strong></summary>
<br/>

[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`.

The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).

Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
</details>

<details>
<summary><strong><code>Makefile Commands</code></strong></summary>
<br/>

View all `makefile` commands
```shell script
make help

List of all current commands:

clean                  Remove previous builds and any test cache data
clean-mods             Remove all the Go mod cache
coverage               Shows the test coverage
godocs                 Sync the latest tag with GoDocs
help                   Show this help message
install                Install the application
install-go             Install the application (Using Native Go)
lint                   Run the Go lint application
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)
run-examples           Runs all the examples
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 vet, lint and ALL tests
test-short             Runs vet, lint and tests (excludes integration tests)
test-travis            Runs all tests via Travis (also exports coverage)
test-travis-short      Runs unit tests via Travis (also exports coverage)
uninstall              Uninstall the application (and remove files)
vet                    Run the Go vet application

Examples & Tests

All unit tests and [examples](bitindex_test.go) run via Travis CI and uses Go version 1.15.x. View the [deployment configuration file](.travis.yml).

Examples & Tests by API section:

• [address](address_test.go)
• [block](block_test.go)
• [chain](chain_test.go)
• [transaction](transaction_test.go)
• [webhook](webhook_test.go)
• [xpub](xpub_test.go)

Run all tests (including integration tests) ```shell script make test

Run tests (excluding integration tests)
```shell script
make test-short

Benchmarks

Run the Go [benchmarks](bitindex_test.go): ```shell script make bench

<br/>

## Code Standards
Read more about this Go project's [code standards](CODE_STANDARDS.md).

<br/>

## Usage
View the [bitindex examples](#examples--tests) above

Basic implementation:
```go
package main

import (
    "log"

    "github.com/mrz1836/go-bitindex"
)

func main() {

    // Create a new client
    client, _ := bitindex.NewClient("your-secret-api-key", bitindex.NetworkMain, nil)

    // Get balance for an address
    info, _ := client.AddressInfo("16ZqP5Tb22KJuvSAbjNkoiZs13mmRmexZA")

    // What's the balance?
    log.Println("address balance:", info.Balance)
}

Maintainers

MrZ

Contributing

View the [contributing guidelines](CONTRIBUTING.md) and follow the [code of conduct](CODE_OF_CONDUCT.md).

How can I help?

All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:. You can also support this project by becoming a sponsor on GitHub :clap: or by making a bitcoin donation to ensure this journey continues indefinitely! :rocket:

Credits

@Attila & BitIndex for their hard work on the BitIndex API

Looking for a Javascript version? Check out the BitIndex JS SDK

Looking for MatterCloud? Checkout the go-mattercloud package.

License