The unofficial Go implementation for the Polynym API
- Installation
- Documentation
- Examples & Tests
- Benchmarks
- Code Standards
- Usage
- Maintainers
- Contributing
- License
go-polynym requires a supported release of Go.
go get -u github.com/mrz1836/go-polynymView the generated documentation
- Resolves all the following:
- RelayX Handles
- $handcash handles
- Paymails
- Twetch UserIDs
- BitcoinSV addresses
- Client is completely configurable
- Using heimdall http client with exponential backoff & more http options
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 helpList 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)
run-examples Runs all the examples
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
All unit tests and examples run via Github Actions and uses Go version 1.16.x. View the configuration file.
Run all tests (including integration tests)
make testRun tests (excluding integration tests)
make test-shortRun the Go benchmarks:
make benchRead more about this Go project's code standards.
View the polynym examples above
Basic implementation:
package main
import (
"log"
"github.com/mrz1836/go-polynym"
)
func main() {
client := polynym.NewClient(nil)
resp, _ := polynym.GetAddress(client, "[email protected]")
log.Println("address: ", resp.Address)
} |
|---|
| MrZ |
View the contributing guidelines and follow the code of conduct.
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! 🚀
@Dean & BitPing for their hard work on the Polynym project
Looking for a Javascript version? Check out the Polynym npm package.
