https://github.com/bsv-blockchain/go-safe-conversion
A Go library for safe type conversions, ensuring type safety and preventing panics.
https://github.com/bsv-blockchain/go-safe-conversion
bitcoin bsv golang teranode
Last synced: 6 months ago
JSON representation
A Go library for safe type conversions, ensuring type safety and preventing panics.
- Host: GitHub
- URL: https://github.com/bsv-blockchain/go-safe-conversion
- Owner: bsv-blockchain
- License: other
- Created: 2025-07-01T02:59:59.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2026-01-30T18:27:18.000Z (6 months ago)
- Last Synced: 2026-01-31T11:24:49.328Z (6 months ago)
- Topics: bitcoin, bsv, golang, teranode
- Language: Go
- Homepage:
- Size: 1.06 MB
- Stars: 4
- Watchers: 0
- Forks: 0
- 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
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
- Agents: .github/AGENTS.md
Awesome Lists containing this project
README
# 🛡 go-safe-conversion
**Lightweight Go library for safe type conversions, ensuring type safety and preventing panics.**
CI / CD
Quality
Security
Community
### Project Navigation
📦 Installation
🧪 Examples & Tests
📚 Documentation
🤝 Contributing
🛠️ Code Standards
⚡ Benchmarks
🤖 AI Usage
📝 License
👥 Maintainers
## 📦 Installation
**go-safe-conversion** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/bsv-blockchain/go-safe-conversion
```
## 📚 Documentation
- **API Reference** – Dive into the godocs at [pkg.go.dev/github.com/bsv-blockchain/go-safe-conversion](https://pkg.go.dev/github.com/bsv-blockchain/go-safe-conversion)
- **Usage Examples** – Browse practical patterns either the [examples directory](examples) or the [example tests](safe_conversion_examples_test.go)
- **Benchmarks** – Check the latest numbers in the [benchmark results](#benchmark-results)
- **Test Suite** – Review both the [unit tests](safe_conversion_test.go) and [fuzz tests](safe_conversion_fuzz_test.go) (powered by [`testify`](https://github.com/stretchr/testify))
> **Good to know:** `go-safe-conversion` ships with *zero* runtime dependencies.
> The only external package we use is `testify`—and that's strictly for tests.
Development Build Commands
Get the [MAGE-X](https://github.com/mrz1836/mage-x) build tool for development:
```shell script
go install github.com/mrz1836/mage-x/cmd/magex@latest
```
View all build commands
```bash script
magex help
```
Repository Features
This repository includes 25+ built-in features covering CI/CD, security, code quality, developer experience, and community tooling.
**[View the full Repository Features list →](.github/docs/repository-features.md)**
Library Deployment
This project uses [goreleaser](https://github.com/goreleaser/goreleaser) for streamlined binary and library deployment to GitHub. To get started, install it via:
```bash
brew install goreleaser
```
The release process is defined in the [.goreleaser.yml](.goreleaser.yml) configuration file.
Then create and push a new Git tag using:
```bash
magex version:bump push=true bump=patch branch=master
```
This 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](.github/AGENTS.md) before every commit:
```bash
go install github.com/mrz1836/go-pre-commit/cmd/go-pre-commit@latest
go-pre-commit install
```
The system is configured via modular env files in [`.github/env/`](.github/env/README.md) and provides 17x faster execution than traditional Python-based pre-commit hooks. See the [complete documentation](http://github.com/mrz1836/go-pre-commit) for details.
GitHub Workflows
All workflows are driven by modular configuration in [`.github/env/`](.github/env/README.md) — no YAML editing required.
**[View all workflows and the control center →](.github/docs/workflows.md)**
Updating Dependencies
To update all dependencies (Go modules, linters, and related tools), run:
```bash
magex deps:update
```
This command ensures all dependencies are brought up to date in a single step, including Go modules and any tools managed by [MAGE-X](https://github.com/mrz1836/mage-x). It is the recommended way to keep your development environment and CI in sync with the latest versions.
## 🧪 Examples & Tests
All unit tests and [examples](examples) run via [GitHub Actions](https://github.com/bsv-blockchain/go-safe-conversion/actions) and use [Go version 1.24.x](https://go.dev/doc/go1.24). View the [configuration file](.github/workflows/fortress.yml).
Run all tests (fast):
```bash script
magex test
```
Run all tests with race detector (slower):
```bash script
magex test:race
```
## ⚡ Benchmarks
Run the Go [benchmarks](safe_conversion_benchmark_test.go):
```bash script
magex bench
```
### Benchmark Results
| Benchmark | Iterations | ns/op | B/op | allocs/op |
|------------------------------------------------------|------------|--------|------|-----------|
| [BigWordToUint32](safe_conversion_benchmark_test.go) | 554149441 | 2.052 | 0 | 0 |
| [Int32ToUint32](safe_conversion_benchmark_test.go) | 1000000000 | 0.3149 | 0 | 0 |
| [Int64ToInt32](safe_conversion_benchmark_test.go) | 1000000000 | 0.3136 | 0 | 0 |
| [Int64ToUint32](safe_conversion_benchmark_test.go) | 573749866 | 2.078 | 0 | 0 |
| [Int64ToUint64](safe_conversion_benchmark_test.go) | 1000000000 | 0.3125 | 0 | 0 |
| [IntToInt16](safe_conversion_benchmark_test.go) | 1000000000 | 0.3113 | 0 | 0 |
| [IntToInt32](safe_conversion_benchmark_test.go) | 1000000000 | 0.3112 | 0 | 0 |
| [IntToUint16](safe_conversion_benchmark_test.go) | 575023266 | 2.080 | 0 | 0 |
| [IntToUint32](safe_conversion_benchmark_test.go) | 1000000000 | 0.3112 | 0 | 0 |
| [IntToUint64](safe_conversion_benchmark_test.go) | 1000000000 | 0.3113 | 0 | 0 |
| [TimeToUint32](safe_conversion_benchmark_test.go) | 580299204 | 2.068 | 0 | 0 |
| [Uint32ToInt32](safe_conversion_benchmark_test.go) | 1000000000 | 0.3113 | 0 | 0 |
| [Uint32ToInt64](safe_conversion_benchmark_test.go) | 1000000000 | 0.3111 | 0 | 0 |
| [Uint32ToUint64](safe_conversion_benchmark_test.go) | 1000000000 | 0.3112 | 0 | 0 |
| [Uint32ToUint8](safe_conversion_benchmark_test.go) | 1000000000 | 0.3113 | 0 | 0 |
| [Uint64ToInt](safe_conversion_benchmark_test.go) | 1000000000 | 0.3114 | 0 | 0 |
| [Uint64ToInt32](safe_conversion_benchmark_test.go) | 1000000000 | 0.3112 | 0 | 0 |
| [Uint64ToInt64](safe_conversion_benchmark_test.go) | 1000000000 | 0.3113 | 0 | 0 |
| [Uint64ToUint16](safe_conversion_benchmark_test.go) | 1000000000 | 0.3113 | 0 | 0 |
| [Uint64ToUint32](safe_conversion_benchmark_test.go) | 1000000000 | 0.3114 | 0 | 0 |
| [UintptrToInt](safe_conversion_benchmark_test.go) | 1000000000 | 0.3114 | 0 | 0 |
| [UintToUint32](safe_conversion_benchmark_test.go) | 1000000000 | 0.3191 | 0 | 0 |
> 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).
## 🛠️ Code Standards
Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
## 🤖 AI Usage & Assistant Guidelines
Read the [AI Usage & Assistant Guidelines](.github/tech-conventions/ai-compliance.md) for details on how AI is used in this project and how to interact with AI assistants.
## 👥 Maintainers
| [
](https://github.com/icellan) | [
](https://github.com/galt-tr) | [
](https://github.com/mrz1836) |
|:--------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------:|
| [Siggi](https://github.com/icellan) | [Dylan](https://github.com/galt-tr) | [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:.
[](https://github.com/bsv-blockchain/go-safe-conversion/stargazers)
## 📝 License
[](LICENSE)