Documentation
¶
Overview ¶
Package stellarcore is a client library for communicating with an instance of stellar-core using through the server's HTTP port.
Index ¶
- Constants
- type Client
- func (c *Client) Info(ctx context.Context) (resp *proto.InfoResponse, err error)
- func (c *Client) SetCursor(ctx context.Context, id string, cursor int32) error
- func (c *Client) SubmitTransaction(ctx context.Context, envelope string) (resp *proto.TXResponse, err error)
- func (c *Client) WaitForNetworkSync(ctx context.Context) error
- type HTTP
Examples ¶
Constants ¶
View Source
const SetCursorDone = "Done"
SetCursorDone is the success message returned by stellar-core when a cursor update succeeds.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// HTTP is the client to use when communicating with stellar-core. If nil,
// http.DefaultClient will be used.
HTTP HTTP
// URL of Stellar Core server to connect.
URL string
}
Client represents a client that is capable of communicating with a stellar-core server using HTTP
func (*Client) Info ¶
Info calls the `info` command on the connected stellar core and returns the provided response
Example ¶
client := &Client{URL: "http://localhost:11626"}
info, err := client.Info(context.Background())
if err != nil {
panic(err)
}
fmt.Printf("synced: %v", info.IsSynced())
func (*Client) SubmitTransaction ¶
func (c *Client) SubmitTransaction(ctx context.Context, envelope string) (resp *proto.TXResponse, err error)
SubmitTransaction calls the `tx` command on the connected stellar core with the provided envelope
Source Files
Click to show internal directories.
Click to hide internal directories.