Go library for working with BOB formatted transactions

go-bob

Go library for working with BOB formatted transactions.

Installation

go-bob requires a supported release of Go.

go get -u github.com/bitcoinschema/go-bob

Documentation

View the generated documentation

Features

Package Dependencies

• bitcoinschema/go-bitcoin
• libsv/go-bt

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 multiple 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 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 vet, 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-short           Runs vet, lint and tests (excludes integration tests)
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.15.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

Checkout all the examples!

// Split BOB formatted NDJSON stream from Bitbus by line
line, err := reader.ReadBytes('\n')
if err == io.EOF {
  break
}

bobTx, err = bobData.NewFromBytes(line)
if err != nil {
  return err
}

BOB Tx will be of this type:

type Tx struct {
    In   []Input  `json:"in"`
    Out  []Output `json:"out"`
    ID   string   `json:"_id"`
    Tx   TxInfo   `json:"tx"`
    Blk  Blk      `json:"blk"`
    Lock uint32   `json:"lock"`
}

BOB Helpers

BOB from bytes (bitbus)

bobTx, err = NewFromBytes(tx)

BOB from bt.Tx

bobTx, err = NewFromTx(line)

BOB from raw tx string

bobTx, err := bob.NewFromRawTxString(rawTxString)

BOB to libsv.Transaction

tx, err = bobTx.ToTx()

BOB to string

tx, err = bobTx.ToString()

BOB to raw tx string

tx, err = bobTx.ToRawTxString()

Maintainers

Satchmo	MrZ

GitHub