b

README

go-b

Library for working with B transactions (Bitcoin OP_RETURN protocol) in Go

Table of Contents

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

Installation

go-b requires a supported release of Go.

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

Documentation

View the generated documentation

Features

• FromTape()
• DataURI()
• BitFsURL()

Package Dependencies

• bitcoinschema/go-bob
• bitcoinschema/go-bpu

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
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.19.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!

Maintainers

Satchmo	MrZ

Contributing

View the contributing guidelines and 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! 🚀

License

Documentation

Overview

Package b is a library for working with B transactions (Bitcoin OP_RETURN protocol) in Go

If you have any suggestions or comments, please feel free to open an issue on this GitHub repository!

By BitcoinSchema Organization (https://bitcoinschema.org)

Index

• Constants
• func BitFsURL(txID string, outIndex, scriptChunk int) string
• type B
  • func NewFromTape(tape bpu.Tape) (b *B, err error)
  • func NewFromTapes(tapes []bpu.Tape) (b *B, err error)
  • func (b *B) DataURI() string
  • func (b *B) FromTape(tape bpu.Tape) (err error)
• type Data
• type EncodingType

Examples

• B.DataURI
• BitFsURL

Constants

const Prefix = "19HxigV4QyBv3tHpQVcUEQyq1pzZVdoAut"

Prefix is the Bitcom prefix used by B

Functions

func BitFsURL

func BitFsURL(txID string, outIndex, scriptChunk int) string

BitFsURL is a helper to create a bitfs url to fetch the content over HTTP

Example

ExampleBitFsURL example using BitFsURL()

bitURL := BitFsURL(exampleTxKong, 0, 3)
fmt.Printf("url: %s", bitURL)

Output:

url: https://x.bitfs.network/6ce94f75b88a6c24815d480437f4f06ae895afdab8039ddec10748660c29f910.out.0.3

Types

type B

type B struct {
	Data      Data
	MediaType string `json:"media_type"`
	Encoding  string `json:"encoding"`
	Filename  string `json:"filename,omitempty"`
}

B is B protocol

func NewFromTape

func NewFromTape(tape bpu.Tape) (b *B, err error)

NewFromTape will create a new AIP object from a bob.Tape Using the FromTape() alone will prevent validation (data is needed via SetData to enable)

func NewFromTapes

func NewFromTapes(tapes []bpu.Tape) (b *B, err error)

NewFromTapes will create a new B object from a []bob.Tape Using the FromTapes() alone will prevent validation (data is needed via SetData to enable)

func (*B) DataURI

func (b *B) DataURI() string

DataURI returns a b64 encoded image that can be set directly. Ex: <img src="b64data" />

Example

ExampleB_DataURI example using DataURI()

// Convert from string
bobData, _ := bob.NewFromString(exampleBobTx)
bData, _ := NewFromTape(bobData.Out[0].Tape[1])

// NOTE: The above data does not contain the actual B information from the tx it has been stripped out

fmt.Printf("data URI: %s", bData.DataURI())

Output:

data URI: data:binary;base64,

func (*B) FromTape

func (b *B) FromTape(tape bpu.Tape) (err error)

FromTape takes a BOB Tape and returns a B data structure

type Data

type Data struct {
	Bytes []byte `json:"data,omitempty"`
	UTF8  string `json:"utf8,omitempty"`
}

Data is the content portion of the B data

type EncodingType

type EncodingType string

EncodingType is an enum for the possible types of data encoding

const (
	EncodingBinary  EncodingType = "binary"
	EncodingGzip    EncodingType = "gzip"
	EncodingUtf8    EncodingType = "utf8"
	EncodingUtf8Alt EncodingType = "utf-8"
)

Various encoding types