go-bitcoin

A library for working with Bitcoin (BSV) transactions, addresses, keys, encryption, and more.

Table of Contents

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

Installation

go-bitcoin requires a supported release of Go.

go get -u github.com/bitcoinschema/go-bitcoin/v2

If you want to install the deprecated V1:

go get -u github.com/bitcoinschema/go-bitcoin@v1

Documentation

View the generated documentation

Features

• Addresses
  • Address from PrivateKey (bec.PrivateKey)
  • Address from Script
• Encryption
  • Encrypt With Private Key
  • Decrypt With Private Key
  • Encrypt Shared
• HD Keys (Master / xPub)
  • Generate HD Keys
  • Generate HD Key from string
  • Get HD Key by Path
  • Get PrivateKey by Path
  • Get HD Child Key
  • Get Addresses from HD Key
  • Get XPub from HD Key
  • Get HD Key from XPub
  • Get PublicKeys for Path
  • Get Addresses for Path
• PubKeys
  • Create PubKey from PrivateKey
  • PubKey from String
• Private Keys
  • Create PrivateKey
  • Create WIF
  • PrivateKey (string) to Address (string)
  • PrivateKey from string
  • Generate Shared Keypair
  • Get Private and Public keys
  • WIF to PrivateKey
  • PrivateKey to WIF
• Scripts
  • Script from Address
• Signatures
  • Sign & Verify a Bitcoin Message
  • Verify a DER Signature
• Transactions
  • Calculate Fee
  • Create Tx
  • Create Tx using WIF
  • Create Tx with Change
  • Tx from Hex

Package Dependencies

• bitcoinsv/bsvd
• libsv/go-bk
• 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
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.18.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

MrZ	Satchmo

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