go-paymail

Paymail client & server library for Golang

Table of Contents

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

Installation

go-paymail requires a supported release of Go.

go get -u github.com/tonicpow/go-paymail

Documentation

View the generated documentation

Features

• Paymail Client (outgoing requests to other providers)
  • Use your own custom Resty HTTP client
  • Customize the client options
  • Use your own custom net.Resolver
  • Full network support: mainnet, testnet, STN
  • Get & Validate SRV records
  • Check SSL Certificates
  • Check & Validate DNSSEC
  • Generate, Validate & Load Additional BRFC Specifications
  • Fetch, Get and Has Capabilities
  • Get Public Key Information - PKI
  • Basic Address Resolution
  • Verify PubKey & Handle
  • Get Public Profile
  • P2P Payment Destination
  • P2P Send Transaction
• Paymail Server (basic example for hosting your own paymail server)
  • Example Showing Capabilities
  • Example Showing PKI
  • Example Verifying a PubKey
  • Example Address Resolution
  • Example Getting a P2P Payment Destination
  • Example Receiving a P2P Transaction
• Paymail Utilities (handy methods)
  • Sanitize & Validate Paymail Addresses
  • Sign & Verify Sender Request

Package Dependencies

Client Packages:

• BitcoinSchema/go-bitcoin
• go-resty/resty
• jarcoal/httpmock
• libsv/go-bk
• libsv/go-bt
• miekg/dns
• mrz1836/go-sanitize
• mrz1836/go-validate

Server Packages:

• julienschmidt/httprouter
• mrz1836/go-api-router
• mrz1836/go-logger

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.19.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 client examples or server examples!

Maintainers

MrZ

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