clients

package
v0.0.0-...-18d85b2 Latest Latest
Warning

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

Go to latest
Published: Dec 6, 2023 License: Apache-2.0, Apache-2.0 Imports: 0 Imported by: 0

README

Clients package

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

  • horizonclient - programmatic client access to Horizon (use in conjunction with txnbuild)
  • stellartoml - parse Stellar.toml files from the internet
  • federation - resolve federation addresses into stellar account IDs, suitable for use within a transaction
  • horizon (DEPRECATED) - the original Horizon client, now superceded by horizonclient

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

Directories

Path Synopsis
Package horizonclient provides client access to a Horizon server, allowing an application to post transactions and look up ledger information.
Package horizonclient provides client access to a Horizon server, allowing an application to post transactions and look up ledger information.
Package stellarcore is a client library for communicating with an instance of stellar-core using through the server's HTTP port.
Package stellarcore is a client library for communicating with an instance of stellar-core using through the server's HTTP port.

Jump to

Keyboard shortcuts

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