Paymail toolkit for Go with full‑stack client and server support.
CI / CD
|
|
Quality
|
|
Security
|
|
Community
|
|
📦 Installation
|
🧪 Examples & Tests
|
📚 Documentation
|
🤝 Contributing
|
🛠️ Code Standards
|
⚡ Benchmarks
|
🤖 AI Usage
|
📝 License
|
👥 Maintainers
|
go-paymail requires a supported release of Go.
go get -u github.com/bsv-blockchain/go-paymail- API Reference – Dive into the godocs at pkg.go.dev/github.com/bsv-blockchain/go-paymail
- Usage Examples – Browse practical patterns either the examples directory or the example tests
- Benchmarks – Check the latest numbers in the benchmark results
- 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)
- Paymail Utilities (handy methods)
Development Build Commands
Get the MAGE-X build tool for development:
go install github.com/mrz1836/mage-x/cmd/magex@latestView all build commands
magex helpRepository Features
This repository includes 25+ built-in features covering CI/CD, security, code quality, developer experience, and community tooling.
Library Deployment
This project uses goreleaser for streamlined binary and library deployment to GitHub. To get started, install it via:
brew install goreleaserThe release process is defined in the .goreleaser.yml configuration file.
Then create and push a new Git tag using:
magex version:bump push=true bump=patch branch=mainThis process ensures consistent, repeatable releases with properly versioned artifacts and citation metadata.
Pre-commit Hooks
Set up the Go-Pre-commit System to run the same formatting, linting, and tests defined in AGENTS.md before every commit:
go install github.com/mrz1836/go-pre-commit/cmd/go-pre-commit@latest
go-pre-commit installThe system is configured via the environment configuration and provides 17x faster execution than traditional Python-based pre-commit hooks. See the complete documentation for details.
GitHub Workflows
All workflows are driven by modular configuration in .github/env/ — no YAML editing required.
Updating Dependencies
To update all dependencies (Go modules, linters, and related tools), run:
magex deps:updateThis command ensures all dependencies are brought up to date in a single step, including Go modules and any tools managed by MAGE-X. It is the recommended way to keep your development environment and CI in sync with the latest versions.
All unit tests and examples run via GitHub Actions and use Go version 1.24.x. View the configuration file.
Run all tests (fast):
magex testRun all tests with race detector (slower):
magex test:raceRun the Go benchmarks:
magex bench| Benchmark | Iterations | ns/op | B/op | allocs/op |
|---|---|---|---|---|
| Validate SRV Record | 4,516,506 | 26.49 | 24 | 1 |
| Capabilities Has | 3,920,778 | 30.30 | 0 | 0 |
| Capabilities Get Bool | 3,938,580 | 30.27 | 0 | 0 |
| Capabilities Get String | 3,416,118 | 34.53 | 0 | 0 |
| Convert Handle | 1,938,082 | 61.95 | 24 | 2 |
| Validate Timestamp | 984,312 | 118.1 | 0 | 0 |
| BRFC Spec Generate | 568,420 | 196.9 | 144 | 4 |
| BRFC Spec Validate | 615,147 | 200.6 | 144 | 4 |
| Get SRV Record | 405,182 | 286.4 | 144 | 8 |
| Validate Paymail | 394,790 | 306.2 | 0 | 0 |
| Validate Domain | 375,542 | 307.7 | 113 | 3 |
| Sanitize Paymail | 157,504 | 703.0 | 317 | 9 |
| Validate And Sanitize Paymail | 121,256 | 1,001 | 346 | 10 |
| Get Public Profile | 26,770 | 4,378 | 4,944 | 54 |
| Get PKI | 27,373 | 4,487 | 4,928 | 55 |
| Add Invite Request | 24,337 | 4,772 | 5,091 | 54 |
| Resolve Address | 22,069 | 5,352 | 4,922 | 64 |
| Get Outputs Template | 21,830 | 5,367 | 4,971 | 63 |
| Get Capabilities | 22,478 | 5,414 | 5,421 | 70 |
| Verify Pub Key | 21,445 | 5,646 | 5,281 | 56 |
| Send P2P Transaction | 20,475 | 5,657 | 5,726 | 62 |
| Get P2P Payment Destination | 13,077 | 7,855 | 6,391 | 115 |
| Default Client Options | 3,102 | 39,799 | 13,976 | 152 |
| New Client | 2,960 | 41,008 | 15,840 | 174 |
| Load BRFCs | 2,949 | 41,832 | 14,704 | 169 |
| Sender Request Verify | 518 | 230,894 | 4,388 | 115 |
| Sender Request Sign | 356 | 337,052 | 9,757 | 171 |
| Check DNSSEC | 1 | 266,799,625 | 55,840 | 539 |
| Check SSL | 1 | 388,776,125 | 856,032 | 8,190 |
These benchmarks reflect fast, allocation-free lookups for most retrieval functions, ensuring optimal performance in production environments. Performance benchmarks for the core functions in this library, executed on an Apple M1 Max (ARM64).
Read more about this Go project's code standards.
Read the AI Usage & Assistant Guidelines for details on how AI is used in this project and how to interact with AI assistants.
 |
 |
 |
|---|---|---|
| Siggi | Dylan | MrZ |
View the contributing guidelines and please 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 💬.
