forked from stellar/go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
client.go
833 lines (709 loc) · 30.8 KB
/
client.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
package horizonclient
import (
"bufio"
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
"time"
"github.com/stellar/go/txnbuild"
"github.com/stellar/go/xdr"
"github.com/manucorporat/sse"
hProtocol "github.com/stellar/go/protocols/horizon"
"github.com/stellar/go/protocols/horizon/effects"
"github.com/stellar/go/protocols/horizon/operations"
"github.com/stellar/go/support/errors"
)
// sendRequest builds the URL for the given horizon request and sends the url to a horizon server
func (c *Client) sendRequest(hr HorizonRequest, resp interface{}) (err error) {
endpoint, err := hr.BuildURL()
if err != nil {
return
}
c.HorizonURL = c.fixHorizonURL()
_, ok := hr.(submitRequest)
if ok {
return c.sendRequestURL(c.HorizonURL+endpoint, "post", resp)
}
return c.sendRequestURL(c.HorizonURL+endpoint, "get", resp)
}
// checkMemoRequired implements a memo required check as defined in
// https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0029.md
func (c *Client) checkMemoRequired(transaction *txnbuild.Transaction) error {
destinations := map[string]bool{}
for i, op := range transaction.Operations() {
var destination string
if err := op.Validate(true); err != nil {
return err
}
switch p := op.(type) {
case *txnbuild.Payment:
destination = p.Destination
case *txnbuild.PathPaymentStrictReceive:
destination = p.Destination
case *txnbuild.PathPaymentStrictSend:
destination = p.Destination
case *txnbuild.AccountMerge:
destination = p.Destination
default:
continue
}
muxed, err := xdr.AddressToMuxedAccount(destination)
if err != nil {
return errors.Wrapf(err, "destination %v is not a valid address", destination)
}
// Skip destination addresses with a memo id because the address has a memo
// encoded within it
destinationHasMemoID := muxed.Type == xdr.CryptoKeyTypeKeyTypeMuxedEd25519
if destinations[destination] || destinationHasMemoID {
continue
}
destinations[destination] = true
request := AccountRequest{
AccountID: destination,
DataKey: "config.memo_required",
}
data, err := c.AccountData(request)
if err != nil {
horizonError := GetError(err)
if horizonError == nil || horizonError.Response.StatusCode != 404 {
return err
}
continue
}
if data.Value == accountRequiresMemo {
return errors.Wrap(
ErrAccountRequiresMemo,
fmt.Sprintf("operation[%d]", i),
)
}
}
return nil
}
// sendRequestURL sends a url to a horizon server.
// It can be used for requests that do not implement the HorizonRequest interface.
func (c *Client) sendRequestURL(requestURL string, method string, a interface{}) (err error) {
var req *http.Request
if method == "post" || method == "POST" {
req, err = http.NewRequest("POST", requestURL, nil)
req.Header.Set("Content-Type", "application/x-www-form-urlencoded; param=value")
} else {
req, err = http.NewRequest("GET", requestURL, nil)
}
if err != nil {
return errors.Wrap(err, "error creating HTTP request")
}
c.setClientAppHeaders(req)
c.setDefaultClient()
if c.horizonTimeout == 0 {
c.horizonTimeout = HorizonTimeout
}
ctx, cancel := context.WithTimeout(context.Background(), c.horizonTimeout)
resp, err := c.HTTP.Do(req.WithContext(ctx))
if err != nil {
cancel()
return
}
err = decodeResponse(resp, &a, c)
cancel()
return
}
// stream handles connections to endpoints that support streaming on a horizon server
func (c *Client) stream(
ctx context.Context,
streamURL string,
handler func(data []byte) error,
) error {
su, err := url.Parse(streamURL)
if err != nil {
return errors.Wrap(err, "error parsing stream url")
}
query := su.Query()
if query.Get("cursor") == "" {
query.Set("cursor", "now")
}
for {
// updates the url with new cursor
su.RawQuery = query.Encode()
req, err := http.NewRequest("GET", su.String(), nil)
if err != nil {
return errors.Wrap(err, "error creating HTTP request")
}
req.Header.Set("Accept", "text/event-stream")
c.setDefaultClient()
c.setClientAppHeaders(req)
// We can use c.HTTP here because we set Timeout per request not on the client. See sendRequest()
resp, err := c.HTTP.Do(req)
if err != nil {
return errors.Wrap(err, "error sending HTTP request")
}
// Expected statusCode are 200-299
if !(resp.StatusCode >= 200 && resp.StatusCode < 300) {
return fmt.Errorf("got bad HTTP status code %d", resp.StatusCode)
}
defer resp.Body.Close()
reader := bufio.NewReader(resp.Body)
// Read events one by one. Break this loop when there is no more data to be
// read from resp.Body (io.EOF).
Events:
for {
// Read until empty line = event delimiter. The perfect solution would be to read
// as many bytes as possible and forward them to sse.Decode. However this
// requires much more complicated code.
// We could also write our own `sse` package that works fine with streams directly
// (github.com/manucorporat/sse is just using io/ioutils.ReadAll).
var buffer bytes.Buffer
nonEmptylinesRead := 0
for {
// Check if ctx is not cancelled
select {
case <-ctx.Done():
return nil
default:
// Continue
}
line, err := reader.ReadString('\n')
if err != nil {
if err == io.EOF || err == io.ErrUnexpectedEOF {
// We catch EOF errors to handle two possible situations:
// - The last line before closing the stream was not empty. This should never
// happen in Horizon as it always sends an empty line after each event.
// - The stream was closed by the server/proxy because the connection was idle.
//
// In the former case, that (again) should never happen in Horizon, we need to
// check if there are any events we need to decode. We do this in the `if`
// statement below just in case if Horizon behaviour changes in a future.
//
// From spec:
// > Once the end of the file is reached, the user agent must dispatch the
// > event one final time, as defined below.
if nonEmptylinesRead == 0 {
break Events
}
} else {
return errors.Wrap(err, "error reading line")
}
}
buffer.WriteString(line)
if strings.TrimRight(line, "\n\r") == "" {
break
}
nonEmptylinesRead++
}
events, err := sse.Decode(strings.NewReader(buffer.String()))
if err != nil {
return errors.Wrap(err, "error decoding event")
}
// Right now len(events) should always be 1. This loop will be helpful after writing
// new SSE decoder that can handle io.Reader without using ioutils.ReadAll().
for _, event := range events {
if event.Event != "message" {
continue
}
// Update cursor with event ID
if event.Id != "" {
query.Set("cursor", event.Id)
}
switch data := event.Data.(type) {
case string:
err = handler([]byte(data))
err = errors.Wrap(err, "handler error")
case []byte:
err = handler(data)
err = errors.Wrap(err, "handler error")
default:
err = errors.New("invalid event.Data type")
}
if err != nil {
return err
}
}
}
}
}
func (c *Client) setClientAppHeaders(req *http.Request) {
req.Header.Set("X-Client-Name", "go-stellar-sdk")
req.Header.Set("X-Client-Version", c.Version())
req.Header.Set("X-App-Name", c.AppName)
req.Header.Set("X-App-Version", c.AppVersion)
}
// setDefaultClient sets the default HTTP client when none is provided.
func (c *Client) setDefaultClient() {
if c.HTTP == nil {
c.HTTP = http.DefaultClient
}
}
// fixHorizonURL strips all slashes(/) at the end of HorizonURL if any, then adds a single slash
func (c *Client) fixHorizonURL() string {
return strings.TrimRight(c.HorizonURL, "/") + "/"
}
// SetHorizonTimeout allows users to set the timeout before a horizon request is cancelled.
// The timeout is specified as a time.Duration which is in nanoseconds.
func (c *Client) SetHorizonTimeout(t time.Duration) *Client {
c.horizonTimeout = t
return c
}
// HorizonTimeout returns the current timeout for a horizon client
func (c *Client) HorizonTimeout() time.Duration {
return c.horizonTimeout
}
// Accounts returns accounts who have a given signer or
// have a trustline to an asset.
// See https://www.stellar.org/developers/horizon/reference/endpoints/accounts.html
func (c *Client) Accounts(request AccountsRequest) (accounts hProtocol.AccountsPage, err error) {
err = c.sendRequest(request, &accounts)
return
}
// AccountDetail returns information for a single account.
// See https://www.stellar.org/developers/horizon/reference/endpoints/accounts-single.html
func (c *Client) AccountDetail(request AccountRequest) (account hProtocol.Account, err error) {
if request.AccountID == "" {
err = errors.New("no account ID provided")
}
if err != nil {
return
}
err = c.sendRequest(request, &account)
return
}
// AccountData returns a single data associated with a given account
// See https://www.stellar.org/developers/horizon/reference/endpoints/data-for-account.html
func (c *Client) AccountData(request AccountRequest) (accountData hProtocol.AccountData, err error) {
if request.AccountID == "" || request.DataKey == "" {
err = errors.New("too few parameters")
}
if err != nil {
return
}
err = c.sendRequest(request, &accountData)
return
}
// Effects returns effects(https://www.stellar.org/developers/horizon/reference/resources/effect.html)
// It can be used to return effects for an account, a ledger, an operation, a transaction and all effects on the network.
func (c *Client) Effects(request EffectRequest) (effects effects.EffectsPage, err error) {
err = c.sendRequest(request, &effects)
return
}
// Assets returns asset information.
// See https://www.stellar.org/developers/horizon/reference/endpoints/assets-all.html
func (c *Client) Assets(request AssetRequest) (assets hProtocol.AssetsPage, err error) {
err = c.sendRequest(request, &assets)
return
}
// Ledgers returns information about all ledgers.
// See https://www.stellar.org/developers/horizon/reference/endpoints/ledgers-all.html
func (c *Client) Ledgers(request LedgerRequest) (ledgers hProtocol.LedgersPage, err error) {
err = c.sendRequest(request, &ledgers)
return
}
// LedgerDetail returns information about a particular ledger for a given sequence number
// See https://www.stellar.org/developers/horizon/reference/endpoints/ledgers-single.html
func (c *Client) LedgerDetail(sequence uint32) (ledger hProtocol.Ledger, err error) {
if sequence == 0 {
err = errors.New("invalid sequence number provided")
}
if err != nil {
return
}
request := LedgerRequest{forSequence: sequence}
err = c.sendRequest(request, &ledger)
return
}
// FeeStats returns information about fees in the last 5 ledgers.
// See https://www.stellar.org/developers/horizon/reference/endpoints/fee-stats.html
func (c *Client) FeeStats() (feestats hProtocol.FeeStats, err error) {
request := feeStatsRequest{endpoint: "fee_stats"}
err = c.sendRequest(request, &feestats)
return
}
// Offers returns information about offers made on the SDEX.
// See https://www.stellar.org/developers/horizon/reference/endpoints/offers-for-account.html
func (c *Client) Offers(request OfferRequest) (offers hProtocol.OffersPage, err error) {
err = c.sendRequest(request, &offers)
return
}
// OfferDetails returns information for a single offer.
// See https://www.stellar.org/developers/horizon/reference/endpoints/offer-details.html
func (c *Client) OfferDetails(offerID string) (offer hProtocol.Offer, err error) {
if len(offerID) == 0 {
err = errors.New("no offer ID provided")
return
}
if _, err = strconv.ParseInt(offerID, 10, 64); err != nil {
err = errors.New("invalid offer ID provided")
return
}
err = c.sendRequest(OfferRequest{OfferID: offerID}, &offer)
return
}
// Operations returns stellar operations (https://www.stellar.org/developers/horizon/reference/resources/operation.html)
// It can be used to return operations for an account, a ledger, a transaction and all operations on the network.
func (c *Client) Operations(request OperationRequest) (ops operations.OperationsPage, err error) {
err = c.sendRequest(request.SetOperationsEndpoint(), &ops)
return
}
// OperationDetail returns a single stellar operation for a given operation id
// See https://www.stellar.org/developers/horizon/reference/resources/operation.html
func (c *Client) OperationDetail(id string) (ops operations.Operation, err error) {
if id == "" {
return ops, errors.New("invalid operation id provided")
}
request := OperationRequest{forOperationID: id, endpoint: "operations"}
var record interface{}
err = c.sendRequest(request, &record)
if err != nil {
return ops, errors.Wrap(err, "sending request to horizon")
}
var baseRecord operations.Base
dataString, err := json.Marshal(record)
if err != nil {
return ops, errors.Wrap(err, "marshaling json")
}
if err = json.Unmarshal(dataString, &baseRecord); err != nil {
return ops, errors.Wrap(err, "unmarshaling json")
}
ops, err = operations.UnmarshalOperation(baseRecord.GetTypeI(), dataString)
if err != nil {
return ops, errors.Wrap(err, "unmarshaling to the correct operation type")
}
return ops, nil
}
// SubmitTransactionXDR submits a transaction represented as a base64 XDR string to the network. err can be either error object or horizon.Error object.
// See https://www.stellar.org/developers/horizon/reference/endpoints/transactions-create.html
func (c *Client) SubmitTransactionXDR(transactionXdr string) (tx hProtocol.Transaction,
err error) {
request := submitRequest{endpoint: "transactions", transactionXdr: transactionXdr}
err = c.sendRequest(request, &tx)
return
}
// SubmitFeeBumpTransaction submits a fee bump transaction to the network. err can be either an
// error object or a horizon.Error object.
//
// This function will always check if the destination account requires a memo in the transaction as
// defined in SEP0029: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0029.md
//
// If you want to skip this check, use SubmitTransactionWithOptions.
//
// See https://www.stellar.org/developers/horizon/reference/endpoints/transactions-create.html
func (c *Client) SubmitFeeBumpTransaction(transaction *txnbuild.FeeBumpTransaction) (tx hProtocol.Transaction, err error) {
return c.SubmitFeeBumpTransactionWithOptions(transaction, SubmitTxOpts{})
}
// SubmitFeeBumpTransactionWithOptions submits a fee bump transaction to the network, allowing
// you to pass SubmitTxOpts. err can be either an error object or a horizon.Error object.
//
// See https://www.stellar.org/developers/horizon/reference/endpoints/transactions-create.html
func (c *Client) SubmitFeeBumpTransactionWithOptions(transaction *txnbuild.FeeBumpTransaction, opts SubmitTxOpts) (tx hProtocol.Transaction, err error) {
// only check if memo is required if skip is false and the inner transaction
// doesn't have a memo.
if inner := transaction.InnerTransaction(); !opts.SkipMemoRequiredCheck && inner.Memo() == nil {
err = c.checkMemoRequired(inner)
if err != nil {
return
}
}
txeBase64, err := transaction.Base64()
if err != nil {
err = errors.Wrap(err, "Unable to convert transaction object to base64 string")
return
}
return c.SubmitTransactionXDR(txeBase64)
}
// SubmitTransaction submits a transaction to the network. err can be either an
// error object or a horizon.Error object.
//
// This function will always check if the destination account requires a memo in the transaction as
// defined in SEP0029: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0029.md
//
// If you want to skip this check, use SubmitTransactionWithOptions.
//
// See https://www.stellar.org/developers/horizon/reference/endpoints/transactions-create.html
func (c *Client) SubmitTransaction(transaction *txnbuild.Transaction) (tx hProtocol.Transaction, err error) {
return c.SubmitTransactionWithOptions(transaction, SubmitTxOpts{})
}
// SubmitTransactionWithOptions submits a transaction to the network, allowing
// you to pass SubmitTxOpts. err can be either an error object or a horizon.Error object.
//
// See https://www.stellar.org/developers/horizon/reference/endpoints/transactions-create.html
func (c *Client) SubmitTransactionWithOptions(transaction *txnbuild.Transaction, opts SubmitTxOpts) (tx hProtocol.Transaction, err error) {
// only check if memo is required if skip is false and the transaction
// doesn't have a memo.
if !opts.SkipMemoRequiredCheck && transaction.Memo() == nil {
err = c.checkMemoRequired(transaction)
if err != nil {
return
}
}
txeBase64, err := transaction.Base64()
if err != nil {
err = errors.Wrap(err, "Unable to convert transaction object to base64 string")
return
}
return c.SubmitTransactionXDR(txeBase64)
}
// Transactions returns stellar transactions (https://www.stellar.org/developers/horizon/reference/resources/transaction.html)
// It can be used to return transactions for an account, a ledger,and all transactions on the network.
func (c *Client) Transactions(request TransactionRequest) (txs hProtocol.TransactionsPage, err error) {
err = c.sendRequest(request, &txs)
return
}
// TransactionDetail returns information about a particular transaction for a given transaction hash
// See https://www.stellar.org/developers/horizon/reference/endpoints/transactions-single.html
func (c *Client) TransactionDetail(txHash string) (tx hProtocol.Transaction, err error) {
if txHash == "" {
return tx, errors.New("no transaction hash provided")
}
request := TransactionRequest{forTransactionHash: txHash}
err = c.sendRequest(request, &tx)
return
}
// OrderBook returns the orderbook for an asset pair (https://www.stellar.org/developers/horizon/reference/resources/orderbook.html)
func (c *Client) OrderBook(request OrderBookRequest) (obs hProtocol.OrderBookSummary, err error) {
err = c.sendRequest(request, &obs)
return
}
// Paths returns the available paths to make a strict receive path payment. See https://www.stellar.org/developers/horizon/reference/endpoints/path-finding-strict-receive.html
// This function is an alias for `client.StrictReceivePaths` and will be deprecated, use `client.StrictReceivePaths` instead.
func (c *Client) Paths(request PathsRequest) (paths hProtocol.PathsPage, err error) {
paths, err = c.StrictReceivePaths(request)
return
}
// StrictReceivePaths returns the available paths to make a strict receive path payment. See https://www.stellar.org/developers/horizon/reference/endpoints/path-finding-strict-receive.html
func (c *Client) StrictReceivePaths(request PathsRequest) (paths hProtocol.PathsPage, err error) {
err = c.sendRequest(request, &paths)
return
}
// StrictSendPaths returns the available paths to make a strict send path payment. See https://www.stellar.org/developers/horizon/reference/endpoints/path-finding-strict-send.html
func (c *Client) StrictSendPaths(request StrictSendPathsRequest) (paths hProtocol.PathsPage, err error) {
err = c.sendRequest(request, &paths)
return
}
// Payments returns stellar account_merge, create_account, path payment and payment operations.
// It can be used to return payments for an account, a ledger, a transaction and all payments on the network.
func (c *Client) Payments(request OperationRequest) (ops operations.OperationsPage, err error) {
err = c.sendRequest(request.SetPaymentsEndpoint(), &ops)
return
}
// Trades returns stellar trades (https://www.stellar.org/developers/horizon/reference/resources/trade.html)
// It can be used to return trades for an account, an offer and all trades on the network.
func (c *Client) Trades(request TradeRequest) (tds hProtocol.TradesPage, err error) {
err = c.sendRequest(request, &tds)
return
}
// Fund creates a new account funded from friendbot. It only works on test networks. See
// https://www.stellar.org/developers/guides/get-started/create-account.html for more information.
func (c *Client) Fund(addr string) (tx hProtocol.Transaction, err error) {
if !c.isTestNet {
return tx, errors.New("can't fund account from friendbot on production network")
}
friendbotURL := fmt.Sprintf("%sfriendbot?addr=%s", c.fixHorizonURL(), addr)
err = c.sendRequestURL(friendbotURL, "get", &tx)
return
}
// StreamTrades streams executed trades. It can be used to stream all trades, trades for an account and
// trades for an offer. Use context.WithCancel to stop streaming or context.Background() if you want
// to stream indefinitely. TradeHandler is a user-supplied function that is executed for each streamed trade received.
func (c *Client) StreamTrades(ctx context.Context, request TradeRequest, handler TradeHandler) (err error) {
err = request.StreamTrades(ctx, c, handler)
return
}
// TradeAggregations returns stellar trade aggregations (https://www.stellar.org/developers/horizon/reference/resources/trade_aggregation.html)
func (c *Client) TradeAggregations(request TradeAggregationRequest) (tds hProtocol.TradeAggregationsPage, err error) {
err = c.sendRequest(request, &tds)
return
}
// StreamTransactions streams processed transactions. It can be used to stream all transactions and
// transactions for an account. Use context.WithCancel to stop streaming or context.Background()
// if you want to stream indefinitely. TransactionHandler is a user-supplied function that is executed for each streamed transaction received.
func (c *Client) StreamTransactions(ctx context.Context, request TransactionRequest, handler TransactionHandler) error {
return request.StreamTransactions(ctx, c, handler)
}
// StreamEffects streams horizon effects. It can be used to stream all effects or account specific effects.
// Use context.WithCancel to stop streaming or context.Background() if you want to stream indefinitely.
// EffectHandler is a user-supplied function that is executed for each streamed transaction received.
func (c *Client) StreamEffects(ctx context.Context, request EffectRequest, handler EffectHandler) error {
return request.StreamEffects(ctx, c, handler)
}
// StreamOperations streams stellar operations. It can be used to stream all operations or operations
// for an account. Use context.WithCancel to stop streaming or context.Background() if you want to
// stream indefinitely. OperationHandler is a user-supplied function that is executed for each streamed
// operation received.
func (c *Client) StreamOperations(ctx context.Context, request OperationRequest, handler OperationHandler) error {
return request.SetOperationsEndpoint().StreamOperations(ctx, c, handler)
}
// StreamPayments streams stellar payments. It can be used to stream all payments or payments
// for an account. Payments include create_account, payment, path_payment and account_merge operations.
// Use context.WithCancel to stop streaming or context.Background() if you want to
// stream indefinitely. OperationHandler is a user-supplied function that is executed for each streamed
// operation received.
func (c *Client) StreamPayments(ctx context.Context, request OperationRequest, handler OperationHandler) error {
return request.SetPaymentsEndpoint().StreamOperations(ctx, c, handler)
}
// StreamOffers streams offers processed by the Stellar network for an account. Use context.WithCancel
// to stop streaming or context.Background() if you want to stream indefinitely.
// OfferHandler is a user-supplied function that is executed for each streamed offer received.
func (c *Client) StreamOffers(ctx context.Context, request OfferRequest, handler OfferHandler) error {
return request.StreamOffers(ctx, c, handler)
}
// StreamLedgers streams stellar ledgers. It can be used to stream all ledgers. Use context.WithCancel
// to stop streaming or context.Background() if you want to stream indefinitely.
// LedgerHandler is a user-supplied function that is executed for each streamed ledger received.
func (c *Client) StreamLedgers(ctx context.Context, request LedgerRequest, handler LedgerHandler) error {
return request.StreamLedgers(ctx, c, handler)
}
// StreamOrderBooks streams the orderbook for a given asset pair. Use context.WithCancel
// to stop streaming or context.Background() if you want to stream indefinitely.
// OrderBookHandler is a user-supplied function that is executed for each streamed order received.
func (c *Client) StreamOrderBooks(ctx context.Context, request OrderBookRequest, handler OrderBookHandler) error {
return request.StreamOrderBooks(ctx, c, handler)
}
// FetchTimebounds provides timebounds for N seconds from now using the server time of the horizon instance.
// It defaults to localtime when the server time is not available.
// Note that this will generate your timebounds when you init the transaction, not when you build or submit
// the transaction! So give yourself enough time to get the transaction built and signed before submitting.
func (c *Client) FetchTimebounds(seconds int64) (txnbuild.Timebounds, error) {
serverURL, err := url.Parse(c.HorizonURL)
if err != nil {
return txnbuild.Timebounds{}, errors.Wrap(err, "unable to parse horizon url")
}
currentTime := currentServerTime(serverURL.Hostname(), c.clock.Now().UTC().Unix())
if currentTime != 0 {
return txnbuild.NewTimebounds(0, currentTime+seconds), nil
}
// return a timebounds based on local time if no server time has been recorded
// to do: query an endpoint to get the most current time. Implement this after we add retry logic to client.
return txnbuild.NewTimeout(seconds), nil
}
// Root loads the root endpoint of horizon
func (c *Client) Root() (root hProtocol.Root, err error) {
err = c.sendRequestURL(c.fixHorizonURL(), "get", &root)
return
}
// Version returns the current version.
func (c *Client) Version() string {
return version
}
// NextAccountsPage returns the next page of accounts.
func (c *Client) NextAccountsPage(page hProtocol.AccountsPage) (accounts hProtocol.AccountsPage, err error) {
err = c.sendRequestURL(page.Links.Next.Href, "get", &accounts)
return
}
// NextAssetsPage returns the next page of assets.
func (c *Client) NextAssetsPage(page hProtocol.AssetsPage) (assets hProtocol.AssetsPage, err error) {
err = c.sendRequestURL(page.Links.Next.Href, "get", &assets)
return
}
// PrevAssetsPage returns the previous page of assets.
func (c *Client) PrevAssetsPage(page hProtocol.AssetsPage) (assets hProtocol.AssetsPage, err error) {
err = c.sendRequestURL(page.Links.Prev.Href, "get", &assets)
return
}
// NextLedgersPage returns the next page of ledgers.
func (c *Client) NextLedgersPage(page hProtocol.LedgersPage) (ledgers hProtocol.LedgersPage, err error) {
err = c.sendRequestURL(page.Links.Next.Href, "get", &ledgers)
return
}
// PrevLedgersPage returns the previous page of ledgers.
func (c *Client) PrevLedgersPage(page hProtocol.LedgersPage) (ledgers hProtocol.LedgersPage, err error) {
err = c.sendRequestURL(page.Links.Prev.Href, "get", &ledgers)
return
}
// NextEffectsPage returns the next page of effects.
func (c *Client) NextEffectsPage(page effects.EffectsPage) (efp effects.EffectsPage, err error) {
err = c.sendRequestURL(page.Links.Next.Href, "get", &efp)
return
}
// PrevEffectsPage returns the previous page of effects.
func (c *Client) PrevEffectsPage(page effects.EffectsPage) (efp effects.EffectsPage, err error) {
err = c.sendRequestURL(page.Links.Prev.Href, "get", &efp)
return
}
// NextTransactionsPage returns the next page of transactions.
func (c *Client) NextTransactionsPage(page hProtocol.TransactionsPage) (transactions hProtocol.TransactionsPage, err error) {
err = c.sendRequestURL(page.Links.Next.Href, "get", &transactions)
return
}
// PrevTransactionsPage returns the previous page of transactions.
func (c *Client) PrevTransactionsPage(page hProtocol.TransactionsPage) (transactions hProtocol.TransactionsPage, err error) {
err = c.sendRequestURL(page.Links.Prev.Href, "get", &transactions)
return
}
// NextOperationsPage returns the next page of operations.
func (c *Client) NextOperationsPage(page operations.OperationsPage) (operations operations.OperationsPage, err error) {
err = c.sendRequestURL(page.Links.Next.Href, "get", &operations)
return
}
// PrevOperationsPage returns the previous page of operations.
func (c *Client) PrevOperationsPage(page operations.OperationsPage) (operations operations.OperationsPage, err error) {
err = c.sendRequestURL(page.Links.Prev.Href, "get", &operations)
return
}
// NextPaymentsPage returns the next page of payments.
func (c *Client) NextPaymentsPage(page operations.OperationsPage) (operations.OperationsPage, error) {
return c.NextOperationsPage(page)
}
// PrevPaymentsPage returns the previous page of payments.
func (c *Client) PrevPaymentsPage(page operations.OperationsPage) (operations.OperationsPage, error) {
return c.PrevOperationsPage(page)
}
// NextOffersPage returns the next page of offers.
func (c *Client) NextOffersPage(page hProtocol.OffersPage) (offers hProtocol.OffersPage, err error) {
err = c.sendRequestURL(page.Links.Next.Href, "get", &offers)
return
}
// PrevOffersPage returns the previous page of offers.
func (c *Client) PrevOffersPage(page hProtocol.OffersPage) (offers hProtocol.OffersPage, err error) {
err = c.sendRequestURL(page.Links.Prev.Href, "get", &offers)
return
}
// NextTradesPage returns the next page of trades.
func (c *Client) NextTradesPage(page hProtocol.TradesPage) (trades hProtocol.TradesPage, err error) {
err = c.sendRequestURL(page.Links.Next.Href, "get", &trades)
return
}
// PrevTradesPage returns the previous page of trades.
func (c *Client) PrevTradesPage(page hProtocol.TradesPage) (trades hProtocol.TradesPage, err error) {
err = c.sendRequestURL(page.Links.Prev.Href, "get", &trades)
return
}
// HomeDomainForAccount returns the home domain for a single account.
func (c *Client) HomeDomainForAccount(aid string) (string, error) {
if aid == "" {
return "", errors.New("no account ID provided")
}
accountDetail, err := c.AccountDetail(AccountRequest{AccountID: aid})
if err != nil {
return "", errors.Wrap(err, "get account detail failed")
}
return accountDetail.HomeDomain, nil
}
// NextTradeAggregationsPage returns the next page of trade aggregations from the current
// trade aggregations response.
func (c *Client) NextTradeAggregationsPage(page hProtocol.TradeAggregationsPage) (ta hProtocol.TradeAggregationsPage, err error) {
err = c.sendRequestURL(page.Links.Next.Href, "get", &ta)
return
}
// PrevTradeAggregationsPage returns the previous page of trade aggregations from the current
// trade aggregations response.
func (c *Client) PrevTradeAggregationsPage(page hProtocol.TradeAggregationsPage) (ta hProtocol.TradeAggregationsPage, err error) {
err = c.sendRequestURL(page.Links.Prev.Href, "get", &ta)
return
}
// ClaimableBalances returns details about available claimable balances,
// possibly filtered to a specific sponsor or other parameters.
func (c *Client) ClaimableBalances(cbr ClaimableBalanceRequest) (cb hProtocol.ClaimableBalances, err error) {
err = c.sendRequest(cbr, &cb)
return
}
// ClaimableBalance returns details about a *specific*, unique claimable balance.
func (c *Client) ClaimableBalance(id string) (cb hProtocol.ClaimableBalance, err error) {
cbr := ClaimableBalanceRequest{ID: id}
err = c.sendRequest(cbr, &cb)
return
}
// ensure that the horizon client implements ClientInterface
var _ ClientInterface = &Client{}