Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 2.22 KB

readme.md

File metadata and controls

18 lines (12 loc) · 2.22 KB
Raw
title
Overview

The Go SDK is a set of packages for interacting with most aspects of the Diamcircle ecosystem. The primary component is the Aurora SDK, which provides convenient access to Aurora services. There are also packages for other Diamcircle services such as TOML support and federation.

Aurora SDK

The Aurora SDK is composed of two complementary libraries: txnbuild + auroraclient. The txnbuild (source, docs) package enables the construction, signing and encoding of Diamcircle transactions and operations in Go. The auroraclient (source, docs) package provides a web client for interfacing with Aurora server REST endpoints to retrieve ledger information, and to submit transactions built with txnbuild.

List of major SDK packages

  • auroraclient (source, docs) - programmatic client access to Aurora
  • txnbuild (source, docs) - construction, signing and encoding of Diamcircle transactions and operations
  • diamcircletoml (source, docs) - parse Diamcircle.toml files from the internet
  • federation (source) - resolve federation addresses into diamcircle account IDs, suitable for use within a transaction