Documentation
¶
Index ¶
Examples ¶
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
Functions ¶
This section is empty.
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 ¶
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)
}
type ClientInterface ¶
type MockClient ¶
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 ¶
GetStellarToml returns stellar.toml file for a given domain
func GetStellarTomlByAddress ¶
GetStellarTomlByAddress returns stellar.toml file of a domain fetched from a given address
Source Files