go-bsvrates
Get the current exchange rate of BSV and other helpful currency conversions
Table of Contents
- Installation
- Documentation
- Examples & Tests
- Benchmarks
- Code Standards
- Usage
- Maintainers
- Contributing
- License
Installation
go-bsvrates requires a supported release of Go.
go get -u github.com/tonicpow/go-bsvrates
Documentation
View the generated documentation
Features
- Client is completely configurable
- Using default heimdall http client with exponential backoff & more
- Use your own HTTP client
- Helpful currency conversion and formatting methods:
- Supported Currencies:
- USD
- Supported Providers:
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:
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 Go lint application
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)
run-examples Runs the basic example
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-short Runs vet, lint and tests (excludes integration tests)
test-travis Runs all tests via Travis (also exports coverage)
test-travis-short Runs unit tests via Travis (also exports coverage)
uninstall Uninstall the application (and remove files)
vet Run the Go vet application
Examples & Tests
All unit tests and examples run via Travis CI and uses Go version 1.15.x. View the deployment 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
View the examples
Basic exchange rate implementation:
package main
import (
"log"
"github.com/tonicpow/go-bsvrates"
)
func main() {
// Create a new client (all default providers)
client := bsvrates.NewClient(nil, nil)
// Get rates
rate, provider, _ := client.GetRate(bsvrates.CurrencyDollars)
log.Printf("found rate: %v %s from provider: %s", rate, bsvrates.CurrencyToName(bsvrates.CurrencyDollars), provider.Names())
}
Basic price conversion implementation:
package main
import (
"log"
"github.com/tonicpow/go-bsvrates"
)
func main() {
// Create a new client (all default providers)
client := bsvrates.NewClient(nil, nil)
// Get a conversion from $ to Sats
satoshis, provider, _ := client.GetConversion(bsvrates.CurrencyDollars, 0.01)
log.Printf("0.01 USD = satoshis: %d from provider: %s", satoshis, provider.Names())
}
Maintainers
MrZ |
Contributing
View the contributing guidelines and please 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! 🚀
Credits
Coin Paprika, What's On Chain and Preev for their hard work on their public API
Jad for his contributions to the package!