bmap

package module
Version: v0.0.27 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 18, 2021 License: MIT Imports: 5 Imported by: 0

README

go-bmap

Go version of the bmap js library for working with OP_RETURN protocols

Release Build Status Report codecov Go
Mergify Status Sponsor Donate


Table of Contents


Installation

go-bmap requires a supported release of Go.

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

Documentation

View the generated documentation

GoDoc

Features
Package Dependencies
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!

Mongo Insert Example:

bmapData, err := bmap.NewFromString(bobData)

bsonData := bson.M{
  "tx":  bobData.Tx,
  "in":  bobData.In,
  "out": bobData.Out,
  "blk": bobData.Blk,
}

if bmapData.AIP != nil {
  bsonData["AIP"] = bmapData.AIP
}

if bmapData.BAP != nil {
  bsonData["BAP"] = bmapData.BAP
}

if bmapData.MAP != nil {
  bsonData["MAP"] = bmapData.MAP
}

_, err := conn.InsertOne(collectionName, bsonData)

Maintainers

MrZ MrZ
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

License

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Tx

type Tx struct {
	AIP *aip.Aip     `json:"AIP,omitempty" bson:"AIP,omitempty"`
	B   *b.B         `json:"B,omitempty" bson:"B,omitempty"`
	BAP *bap.Bap     `json:"BAP,omitempty" bson:"BAP,omitempty"`
	Blk bob.Blk      `json:"blk,omitempty" bson:"blk,omitempty"`
	In  []bob.Input  `json:"in,omitempty" bson:"in,omitempty"`
	MAP magic.MAP    `json:"MAP,omitempty" bson:"MAP,omitempty"`
	Out []bob.Output `json:"out,omitempty" bson:"out,omitempty"`
	Tx  bob.TxInfo   `json:"tx,omitempty" bson:"tx,omitempty"`
}

Tx is a Bmap formatted tx

func NewFromBob

func NewFromBob(bobTx *bob.Tx) (bmapTx *Tx, err error)

NewFromBob returns a new BmapTx from a BobTx

func (*Tx) FromBob

func (t *Tx) FromBob(bobTx *bob.Tx) (err error)

FromBob returns a BmapTx from a BobTx

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL