clients

README

Clients package

Packages here provide client libraries for accessing the ecosystem of DiamNet services.

• auroraclient - programmatic client access to Aurora (use in conjunction with txnbuild)
• diamnettoml - parse DiamNet.toml files from the internet
• federation - resolve federation addresses into diamnet account IDs, suitable for use within a transaction
• aurora (DEPRECATED) - the original Aurora client, now superceded by auroraclient

See GoDoc for more details.

For developers: Adding new client packages

Ideally, each one of our client packages will have commonalities in their API to ease the cost of learning each. It's recommended that we follow a pattern similar to the net/http package's client shape:

A type, Client, is the central type of any client package, and its methods should provide the bulk of the functionality for the package. A DefaultClient var is provided for consumers that don't need client-level customization of behavior. Each method on the Client type should have a corresponding func at the package level that proxies a call through to the default client. For example, http.Get() is the equivalent of http.DefaultClient.Get().

Documentation

Overview

Package clients contains sub-packages that provide client access to the various diamnet services.