stellartoml

Documentation

Index

• Constants
• Variables
• type Client
  • func (c *Client) GetStellarToml(domain string) (resp *Response, err error)
  • func (c *Client) GetStellarTomlByAddress(addy string) (*Response, error)
• type HTTP
• type MockClient
  • func (m *MockClient) GetStellarToml(domain string) (*Response, error)
  • func (m *MockClient) GetStellarTomlByAddress(address string) (*Response, error)
• type Response
  • func GetStellarToml(domain string) (*Response, error)
  • func GetStellarTomlByAddress(addy string) (*Response, error)

Examples

• Client.GetStellarToml

Constants

const StellarTomlMaxSize = 5 * 1024

StellarTomlMaxSize is the maximum size of stellar.toml file

const WellKnownPath = "/.well-known/stellar.toml"

WellKnownPath represents the url path at which the stellar.toml file should exist to conform to the federation protocol.

Variables

var DefaultClient = &Client{HTTP: http.DefaultClient}

DefaultClient is a default client using the default parameters

Types

type Client

type Client struct {
	// HTTP is the http client used when resolving a Stellar.toml file
	HTTP HTTP

	// UseHTTP forces the client to resolve against servers using plain HTTP.
	// Useful for debugging.
	UseHTTP bool
}

Client represents a client that is capable of resolving a Stellar.toml file using the internet.

func (*Client) GetStellarToml

func (c *Client) GetStellarToml(domain string) (resp *Response, err error)

GetStellarToml returns stellar.toml file for a given domain

Example

ExampleGetTOML gets the stellar.toml file for coins.asia

_, err := DefaultClient.GetStellarToml("coins.asia")
if err != nil {
	log.Fatal(err)
}

func (*Client) GetStellarTomlByAddress

func (c *Client) GetStellarTomlByAddress(addy string) (*Response, error)

GetStellarTomlByAddress returns stellar.toml file of a domain fetched from a given address

type HTTP

type HTTP interface {
	Get(url string) (*http.Response, error)
}

HTTP represents the http client that a stellertoml resolver uses to make http requests.

type MockClient

type MockClient struct {
	mock.Mock
}

MockClient is a mockable stellartoml client.

func (*MockClient) GetStellarToml

func (m *MockClient) GetStellarToml(domain string) (*Response, error)

GetStellarToml is a mocking a method

func (*MockClient) GetStellarTomlByAddress

func (m *MockClient) GetStellarTomlByAddress(address string) (*Response, error)

GetStellarTomlByAddress is a mocking a method

type Response

type Response struct {
	AuthServer       string `toml:"AUTH_SERVER"`
	FederationServer string `toml:"FEDERATION_SERVER"`
	EncryptionKey    string `toml:"ENCRYPTION_KEY"`
	SigningKey       string `toml:"SIGNING_KEY"`
}

Response represents the results of successfully resolving a stellar.toml file

func GetStellarToml

func GetStellarToml(domain string) (*Response, error)

GetStellarToml returns stellar.toml file for a given domain

func GetStellarTomlByAddress

func GetStellarTomlByAddress(addy string) (*Response, error)

GetStellarTomlByAddress returns stellar.toml file of a domain fetched from a given address