Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitcoinschema/go-boost
A transaction parser for boost (Bitcoin protocol)
https://github.com/bitcoinschema/go-boost
bitcoin bitcoinsv bob boost bsv golang
Last synced: about 1 month ago
JSON representation
A transaction parser for boost (Bitcoin protocol)
- Host: GitHub
- URL: https://github.com/bitcoinschema/go-boost
- Owner: BitcoinSchema
- License: mit
- Created: 2023-02-22T14:28:55.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-11T21:29:57.000Z (about 1 month ago)
- Last Synced: 2024-11-11T22:28:19.524Z (about 1 month ago)
- Topics: bitcoin, bitcoinsv, bob, boost, bsv, golang
- Language: Go
- Homepage:
- Size: 130 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# go-boost
> A transaction parser for boost (Bitcoin protocol)
[](https://github.com/BitcoinSchema/go-boost/releases)
[](https://github.com/BitcoinSchema/go-boost/actions)
[](https://golang.org/)
[](https://mergify.io)
[](https://github.com/sponsors/BitcoinSchema)
[](https://gobitcoinsv.com/#sponsor?utm_source=github&utm_medium=sponsor-link&utm_campaign=go-boost&utm_term=go-boost&utm_content=go-boost)
## Installation
**go-boost** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/bitcoinschema/go-boost
```
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/bitcoinschema/go-boost)
[](https://pkg.go.dev/github.com/bitcoinschema/go-boost)
## Boost Object
It takes a BOB formatted transaction and produces an easy-to-use BOOST struct with all protocol fields populated.
```go
type Boost struct {
Redeem Redeem `json:"redeem" bson:"redeem"`
Spend Spend `json:"spend" bson:"spend"`
}
```
## Coverage
- [x] V1 Bounty Spend
- [x] V1 Bounty Redeem
- [x] V2 Contract Spend
- [x] V2 Contract Redeem
## Usage
Get the package
```bash
go get github.com/bitcoinschema/go-boost
```
Import the package
```
import (
github.com/bitcoinschema/go-boost
)
```
Use to transform [BOB](https://github.com/bitcoinschema/go-bob) formatted transactions.
```
var b *boost.Boost
b, err = boostNewFromTape(&bobData.In[0].Tape[0])
```
V1 Contract Spend Example
```go
// 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:
```json
{
"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](.github/CONTRIBUTING.md) and follow the [code of conduct](.github/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](https://github.com/sponsors/BitcoinSchema) :clap:
or by making a [**bitcoin donation**](https://gobitcoinsv.com/#sponsor?utm_source=github&utm_medium=sponsor-link&utm_campaign=go-boost&utm_term=go-boost&utm_content=go-boost) to ensure this journey continues indefinitely! :rocket:
[](https://github.com/BitcoinSchema/go-boost/stargazers)
## License
[](LICENSE)