boost

README

go-boost

A transaction parser for boost (Bitcoin protocol)

Installation

go-boost requires a supported release of Go.

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

Documentation

View the generated documentation

Boost Object

It takes a BOB formatted transaction and produces an easy-to-use BOOST struct with all protocol fields populated.

type Boost struct {
	Redeem Redeem `json:"redeem" bson:"redeem"`
	Spend  Spend  `json:"spend" bson:"spend"`
}

Coverage

• V1 Bounty Spend
• V1 Bounty Redeem
• V2 Contract Spend
• V2 Contract Redeem

Usage

Get the package

go get github.com/bitcoinschema/go-boost

Import the package

import (
  github.com/bitcoinschema/go-boost
)

Use to transform BOB formatted transactions.

var b *boost.Boost
b, err = boostNewFromTape(&bobData.In[0].Tape[0])

V1 Contract Spend Example

	// Get BOB data from string
	bobData, err := bob.NewFromRawTxString(boostTx)
	if err != nil {
		t.Fatalf("error occurred: %s", err.Error())
	}

	var b *Boost
	b, err = boost.NewFromTape(&bobData.Out[0].Tape[0])thing": "else"
}

boost.BoostSpend Result:

{
  "Content": "7332808b5283f8acedcc6240a42f669cc3d305413201527852061fd5b283d0d8",
  "MinerAddress": "16nhPWCkbkR1bNACwPYULBWyvxQ5MCDZBo",
  "Category": 1111,
  "Difficulty": 0.01,
  "Topic": "theory",
  "AdditionalData": "this is the Boost whitepaper",
  "Nonce": 137,
  "Version": 1
}

More examples can be found in tests.

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 boost provides a way to parse boostpow data from a bpu.Tape

Index

• Constants
• func PubkeyHashToAddress(pubkeyHash []byte) string
• func RemoveLBR(text string) string
• func Reverse(input []byte) []byte
• type Boost
  • func NewFromTape(tape *bpu.Tape) (b *Boost, err error)
  • func (b *Boost) FromTape(tape *bpu.Tape) (err error)
• type Redeem
• type Spend

Constants

const Prefix = "boostpow"

Prefix is the protocol prefix for Boost Pow

Functions

func PubkeyHashToAddress

func PubkeyHashToAddress(pubkeyHash []byte) string

PubkeyHashToAddress converts a pubkey hash to a base58check encoded address

func RemoveLBR

func RemoveLBR(text string) string

RemoveLBR removes linebreaks

func Reverse

func Reverse(input []byte) []byte

Reverse a byte array

Types

type Boost

type Boost struct {
	Redeem Redeem `json:"redeem" bson:"redeem"`
	Spend  Spend  `json:"spend" bson:"spend"`
}

Boost is Boost Pow data object

func NewFromTape

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

NewFromTape takes a bob.Tape and returns a BAP data structure

func (*Boost) FromTape

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

FromTape builds a boost object from a *bpu.Tape

type Redeem

type Redeem struct {
	Signature       string `json:"signature" bson:"signature"`                 // 3044022100ac4003d62ddadbf0bff9cbe63d0f6ad740494ee7fcf5f296cfc056f52f087c7c021f2f9e2db03b141ce88edc1c10850a0831dea63edd6c6a8040d80e24737e6d4a41
	PubKey          string `json:"pubkey" bson:"pubkey"`                       // pubkey: 03097e9768554d40c0b5b18e44db2a15bbd137a373c39af46033049477bcbb79a4
	Nonce           uint32 `json:"nonce" bson:"nonce"`                         // nonce : 31497
	Timestamp       uint32 `json:"timestamp" bson:"timestamp"`                 // timestamp : 1677268580
	ExtraNonce2     string `json:"extra_nonce_2" bson:"extra_nonce_2"`         // extra_nonce_2 : "0f0445b186e64adc"
	ExtraNonce1     uint32 `json:"extra_nonce_1" bson:"extra_nonce_1"`         // extra_nonce_1 : 909479219
	MinerPubKeyHash string `json:"miner_pubkey_hash" bson:"miner_pubkey_hash"` // miner_pubkey_hash: 0xa3c10ac097a7da0009a786cc17edc1391a3bddf6
	Version         int32  `json:"version" bson:"version"`
}

Redeem is the parsed redeem data

type Spend

type Spend struct {
	Hash           string  `json:"hash,omitempty" bson:"hash,omitempty"`
	Content        string  `json:"content,omitempty" bson:"content,omitempty"`
	Difficulty     float64 `json:"difficulty,omitempty" bson:"difficulty,omitempty"`
	Topic          *string `json:"topic,omitempty" bson:"topic,omitempty"`
	AdditionalData *string `json:"additional_data,omitempty" bson:"additional_data,omitempty"`
	Bits           uint64  `json:"bits" bson:"bits"`
	MetadataHash   string  `json:"metadata_hash,omitempty" bson:"metadata_hash,omitempty"`
	Time           uint64  `json:"time,omitempty" bson:"time,omitempty"`
	Nonce          uint32  `json:"nonce,omitempty" bson:"nonce,omitempty"`
	Category       uint32  `json:"category" bson:"category,omitempty"`
	MinerAddress   *string `json:"miner_address,omitempty" bson:"miner_address,omitempty"`
	Version        int32   `json:"version" bson:"version"`
}

Spend is the parsed spend data. Version unknown when 0.