The implementation enforces separation of concerns by isolating admin and non-admin APIs, requiring separate initialization for their respective clients. This ensures clarity and modularity when utilizing the exposed functionality.

• Description: Initializes a UserAPI instance using an access key for authentication.
• Note: Requests made with this instance will be securely signed, ensuring integrity and authenticity.

• Description: Initializes a UserAPI instance using an extended private key (xPriv) for authentication.
• Note: Requests made with this instance will also be securely signed.
• Recommendation: This option offers a high level of security, making it a preferred choice alongside the access key option.

• Description: Initializes a UserAPI instance using an extended public key (xPub).
• Note: Requests made with this instance will not be signed.
• Security Advisory: For enhanced security, it is strongly recommended to use either NewUserAPIWithAccessKey or NewUserAPIWithXPriv instead, as unsigned requests may be less secure.

• Description: Initializes a AdminAPI instance using an extended private key (xPriv) for authentication.
• Note: Requests made with this instance will be securely signed, ensuring integrity and authenticity.

• Description: Initializes a AdminAPI instance using an extended public key (xPub).
• Note: Requests made with this instance will not be signed.
• Security Advisory: For enhanced security, it is strongly recommended to use either NewAdminAPIWithXPrivinstead, as unsigned requests may be less secure.

Code snippets:

• AdminAPI example
• UserAPI example

The client does not support the following:

• Admin and non-admin old endpoints of the SPV Wallet API based on the /v1/ prefix.
• Deprecated methods for building query parameters for HTTP requests.

The client is designed for full compatibility with the newer /api/v1/ endpoints exposed by the SPV Wallet API. It focuses on aligning with the latest standards and structure provided by the API.

Get the MAGE-X build tool for development:

go install github.com/mrz1836/mage-x/cmd/magex@latest

View all build commands

magex help

This repository includes 25+ built-in features covering CI/CD, security, code quality, developer experience, and community tooling.

View the full Repository Features list →

This project uses goreleaser for streamlined binary and library deployment to GitHub. To get started, install it via:

brew install goreleaser

The 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=main

This process ensures consistent, repeatable releases with properly versioned artifacts and citation metadata.

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 install

The 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.

All workflows are driven by modular configuration in .github/env/ — no YAML editing required.

View all workflows and the control center →

To update all dependencies (Go modules, linters, and related tools), run:

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. It is the recommended way to keep your development environment and CI in sync with the latest versions.