Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tonicpow/go-bsvrates
Real-time exchange rates for BitcoinSV using multiple providers with failover support
https://github.com/tonicpow/go-bsvrates
bitcoin bsv coinpaprika currency-converter exchange-rates preev rates whatsonchain
Last synced: about 1 month ago
JSON representation
Real-time exchange rates for BitcoinSV using multiple providers with failover support
- Host: GitHub
- URL: https://github.com/tonicpow/go-bsvrates
- Owner: tonicpow
- License: mit
- Created: 2020-06-25T13:37:15.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T11:22:38.000Z (7 months ago)
- Last Synced: 2024-05-21T11:50:00.490Z (7 months ago)
- Topics: bitcoin, bsv, coinpaprika, currency-converter, exchange-rates, preev, rates, whatsonchain
- Language: Go
- Homepage:
- Size: 543 KB
- Stars: 9
- Watchers: 4
- Forks: 3
- 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-bsvrates
> Real-time exchange rates for BitcoinSV using multiple providers with fail-over support
[](https://github.com/tonicpow/go-bsvrates/releases)
[](https://github.com/tonicpow/go-bsvrates/actions)
[](https://goreportcard.com/report/github.com/tonicpow/go-bsvrates)
[](https://codecov.io/gh/tonicpow/go-bsvrates)
[](https://golang.org/)
[](https://mergify.io)
[](https://gitpod.io/#https://github.com/tonicpow/go-bsvrates)
## Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Examples & Tests](#examples--tests)
- [Benchmarks](#benchmarks)
- [Code Standards](#code-standards)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Installation
**go-bsvrates** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/tonicpow/go-bsvrates
```
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/tonicpow/go-bsvrates)
[](https://pkg.go.dev/github.com/tonicpow/go-bsvrates)
### Features
- [BSV Rates Client](client.go) is completely configurable
- Using default [heimdall http client](https://github.com/gojek/heimdall) with exponential backoff & more
- Use your own [HTTP client](client.go)
- Helpful currency conversion and formatting methods:
- [ConvertFloatToIntBSV()](currency.go)
- [ConvertIntToFloatUSD()](currency.go)
- [ConvertPriceToSatoshis()](currency.go)
- [ConvertSatsToBSV()](currency.go)
- [FormatCentsToDollars()](currency.go)
- [GetCentsFromSatoshis()](currency.go)
- [GetDollarsFromSatoshis()](currency.go)
- [TransformCurrencyToInt()](currency.go)
- [TransformIntToCurrency()](currency.go)
- Supported Fiat Currencies:
- USD
- Supported Providers:
- **[Coin Paprika](https://api.coinpaprika.com/)**
- [GetBaseAmountAndCurrencyID()](coinpaprika.go)
- [GetMarketPrice()](coinpaprika.go)
- [GetPriceConversion()](coinpaprika.go)
- [IsAcceptedCurrency()](coinpaprika.go)
- [GetHistoricalTickers()](coinpaprika.go)
- **[What's On Chain](https://developers.whatsonchain.com/)**
- [GetExchangeRate()](https://github.com/mrz1836/go-whatsonchain)
Library Deployment
[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to GitHub and can be installed via: `brew install goreleaser`.
The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/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
```shell script
make help
```
List of all current commands:
```text
all Runs lint, test and vet
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)
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 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](examples) run via [GitHub Actions](https://github.com/tonicpow/go-bsvrates/actions) and
uses [Go version 1.18.x](https://golang.org/doc/go1.18). View the [configuration file](.github/workflows/run-tests.yml).
Run all tests (including integration tests)
```shell script
make test
```
Run tests (excluding integration tests)
```shell script
make test-short
```
## Benchmarks
Run the Go [benchmarks](client.go):
```shell script
make bench
```
## Code Standards
Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
## Usage
View the [examples](examples)
Basic exchange rate implementation:
```go
package main
import (
"context"
"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(context.Background(), bsvrates.CurrencyDollars)
log.Printf("found rate: %v %s from provider: %s", rate, bsvrates.CurrencyToName(bsvrates.CurrencyDollars), provider.Name())
}
```
Basic price conversion implementation:
```go
package main
import (
"context"
"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(context.Background(),bsvrates.CurrencyDollars, 0.01)
log.Printf("0.01 USD = satoshis: %d from provider: %s", satoshis, provider.Name())
}
```
## Maintainers
| [
](https://github.com/mrz1836) |
|:------------------------------------------------------------------------------------------------:|
| [MrZ](https://github.com/mrz1836) |
## Contributing
View the [contributing guidelines](.github/CONTRIBUTING.md) and please 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/tonicpow) :clap:
or by making a [**bitcoin donation**](https://tonicpow.com/?utm_source=github&utm_medium=sponsor-link&utm_campaign=go-bsvrates&utm_term=go-bsvrates&utm_content=go-bsvrates) to ensure this journey continues indefinitely! :rocket:
[](https://github.com/tonicpow/go-bsvrates/stargazers)
### Credits
[Coin Paprika](https://tncpw.co/7c2cae76) and [What's On Chain](https://tncpw.co/638d8e8a) for their hard work on their public API
[Jad](https://github.com/jadwahab) for his contributions to the package!
## License
[](LICENSE)