# README

Client

GoDoc

The Client package reduces the work required to communicate with a Rosetta server.

If you want a higher-level interface that automatically asserts that server responses are correct, check out the Fetcher.

Installation

go get github.com/HelloKashif/rosetta-sdk-go/client

Examples

Check out the examples to see how easy it is to connect to a Rosetta server.

# Functions

NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ErrRetriable is returned when a 502, 503, or 504 HTTP code is encountered.

# Structs

APIClient manages communication with the Rosetta API v1.4.8 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.

# Type aliases

AccountAPIService AccountAPI service.
BlockAPIService BlockAPI service.
CallAPIService CallAPI service.
ConstructionAPIService ConstructionAPI service.
EventsAPIService EventsAPI service.
MempoolAPIService MempoolAPI service.
NetworkAPIService NetworkAPI service.
SearchAPIService SearchAPI service.