📦 Installation
|
🧪 Examples & Tests
|
📚 Documentation
|
⚡ Benchmarks
|
🛠️ Code Standards
|
🤖 AI Usage
|
🤝 Contributing
|
👥 Maintainers
|
⚖️ License
|
The goal of this repository is to provide a place where developers from around the ecosystem can publish all manner of script templates, without needing to update the core library. We're generally neutral and unbiased about what people contribute, so feel free to contribute and see what people do with your cool idea!
| Template | Description |
|---|---|
| BitCom | BitCom protocol utilities (B, MAP, AIP) for structured data |
| BSocial | Social media actions using BitcoinSchema.org standards |
| BSV20 | BSV20 token standard implementation |
| BSV21 | BSV21 token standard implementation including LTM and POW20 |
| Cosign | Co-signing transactions with multiple parties |
| Inscription | On-chain NFT-like inscriptions |
| Lockup | Time-locked transactions |
| OrdLock | Locking and unlocking functionality for ordinals |
| OrdP2PKH | Ordinal-aware P2PKH transactions |
| P2PKH | Standard Pay-to-Public-Key-Hash transactions |
| Shrug | Experimental template for demo purposes |
Each template folder contains its own README with detailed usage examples.
go-script-templates requires a supported release of Go.
go get -u github.com/bsv-blockchain/go-script-templatesDevelopment 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=masterThis 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 modular env files in .github/env/ 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 benchRead 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 💬.
