Signchain Docs

Home>Developer Tools>Client Libraries>Golang Client Library

Golang Client Library

The Golang Client Library for Signchain allows developers to securely interact with Signchain’s APIs, manage wallets, sign transactions, and monitor vaults. Designed for backend systems, the library makes it easy to incorporate Signchain’s self-hosted or hosted vaults into your Go applications.

Key Features

  • Transaction Signing
    Signchain’s secure API enables transaction signing directly from your self-hosted or hosted vault, ensuring your private key data remains within your control.

  • Wallet Management
    Easily create, retrieve, list, update, and manage wallets, with data stored securely in Signchain’s vault.

  • Vault Monitoring
    The library includes methods for checking vault status, such as online status and active key count, so you can ensure uninterrupted operations.

Installation

To install the Golang Client Library, add the following import to your project:

go get github.com/grexie/signchain-go/v2

Add the import:

import "github.com/grexie/signchain-go/v2"

Example Usage

Below are some typical use cases for the library. For full examples and detailed guidance, see the Getting Started and Usage Examples sections.

Transaction Signing

The Sign method allows you to submit transaction data to the vault, receiving a secure signature in return. This signature can then be verified or broadcasted on-chain by your application.

Wallet Management

With methods like CreateWallet, GetWallet, ListWallets, UpdateWallet, ExpireWallet, and UnexpireWallet, you can handle wallet lifecycle events and retrieve metadata for all wallets within your Signchain Vault.

Vault Status

Monitor your vault’s status with VaultStatus to retrieve insights on vault availability, number of active keys, and other operational data.

Additional Resources

Explore the following sections to dive deeper into specific aspects of the Golang Client Library:

  1. Getting Started
    An initial setup guide and a breakdown of authentication and configuration steps for new users.

  2. Usage Examples
    Practical examples demonstrating how to interact with various endpoints in the Signchain API.

With these features and guides, the Golang Client Library provides a comprehensive solution for integrating secure blockchain functionality into Go applications.