clients

package
v0.0.0-...-798156f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 3, 2018 License: Apache-2.0 Imports: 0 Imported by: 0

README

Clients package

Packages contained by this package provide client libraries for accessing the ecosystem of DigitalBits services. At present, it only contains a simple frontier client library, but in the future it will contain clients to interact with digitalbits-core, federation, the bridge server and more.

See godoc for details about each package.

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 digitalbits services.

Directories

Path Synopsis
Package digitalbitscore is a client library for communicating with an instance of digitalbits-core using through the server's HTTP port.
Package digitalbitscore is a client library for communicating with an instance of digitalbits-core using through the server's HTTP port.
Package frontier provides client access to a frontier server, allowing an application to post transactions and lookup ledger information.
Package frontier provides client access to a frontier server, allowing an application to post transactions and lookup ledger information.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL