go: github.com/stellar/go/protocols/horizon Index | Files | Directories

package horizon

import "github.com/stellar/go/protocols/horizon"

Package horizon contains the type definitions for all of horizon's response resources.


Package Files



var KeyTypeNames = map[strkey.VersionByte]string{
    strkey.VersionByteAccountID: "ed25519_public_key",
    strkey.VersionByteSeed:      "ed25519_secret_seed",
    strkey.VersionByteHashX:     "sha256_hash",
    strkey.VersionByteHashTx:    "preauth_tx",

KeyTypeNames maps from strkey version bytes into json string values to use in horizon responses.

func KeyTypeFromAddress Uses

func KeyTypeFromAddress(address string) (string, error)

KeyTypeFromAddress converts the version byte of the provided strkey encoded value (for example an account id or a signer key) and returns the appropriate horizon-specific type name.

func MustKeyTypeFromAddress Uses

func MustKeyTypeFromAddress(address string) string

MustKeyTypeFromAddress is the panicking variant of KeyTypeFromAddress.

type Account Uses

type Account struct {
    Links struct {
        Self         hal.Link `json:"self"`
        Transactions hal.Link `json:"transactions"`
        Operations   hal.Link `json:"operations"`
        Payments     hal.Link `json:"payments"`
        Effects      hal.Link `json:"effects"`
        Offers       hal.Link `json:"offers"`
        Trades       hal.Link `json:"trades"`
        Data         hal.Link `json:"data"`
    }   `json:"_links"`

    ID                   string            `json:"id"`
    AccountID            string            `json:"account_id"`
    Sequence             string            `json:"sequence"`
    SubentryCount        int32             `json:"subentry_count"`
    InflationDestination string            `json:"inflation_destination,omitempty"`
    HomeDomain           string            `json:"home_domain,omitempty"`
    LastModifiedLedger   uint32            `json:"last_modified_ledger"`
    Thresholds           AccountThresholds `json:"thresholds"`
    Flags                AccountFlags      `json:"flags"`
    Balances             []Balance         `json:"balances"`
    Signers              []Signer          `json:"signers"`
    Data                 map[string]string `json:"data"`
    PT                   string            `json:"paging_token"`

Account is the summary of an account

func (Account) GetAccountID Uses

func (a Account) GetAccountID() string

GetAccountID returns the Stellar account ID. This is to satisfy the Account interface of txnbuild.

func (Account) GetCreditBalance Uses

func (a Account) GetCreditBalance(code string, issuer string) string

GetCreditBalance returns the balance for given code and issuer

func (*Account) GetData Uses

func (a *Account) GetData(key string) ([]byte, error)

GetData returns decoded value for a given key. If the key does not exist, empty slice will be returned.

func (Account) GetNativeBalance Uses

func (a Account) GetNativeBalance() (string, error)

GetNativeBalance returns the native balance of the account

func (Account) GetSequenceNumber Uses

func (a Account) GetSequenceNumber() (xdr.SequenceNumber, error)

GetSequenceNumber returns the sequence number of the account, and returns it as a 64-bit integer.

func (*Account) IncrementSequenceNumber Uses

func (a *Account) IncrementSequenceNumber() (xdr.SequenceNumber, error)

IncrementSequenceNumber increments the internal record of the account's sequence number by 1. This is typically used after a transaction build so that the next transaction to be built will be valid.

func (*Account) MustGetData Uses

func (a *Account) MustGetData(key string) []byte

MustGetData returns decoded value for a given key. If the key does not exist, empty slice will be returned. If there is an error decoding a value, it will panic.

func (Account) PagingToken Uses

func (res Account) PagingToken() string

PagingToken implementation for hal.Pageable

type AccountData Uses

type AccountData struct {
    Value string `json:"value"`

AccountData represents a single data object stored on by an account

type AccountFlags Uses

type AccountFlags struct {
    AuthRequired  bool `json:"auth_required"`
    AuthRevocable bool `json:"auth_revocable"`
    AuthImmutable bool `json:"auth_immutable"`

AccountFlags represents the state of an account's flags

type AccountSigner Uses

type AccountSigner struct {
    Links struct {
        Account hal.Link `json:"account"`
    }   `json:"_links"`

    ID        string `json:"id"`
    AccountID string `json:"account_id"`
    PT        string `json:"paging_token"`
    Signer    `json:"signer"`

AccountSigner is the account signer information.

func (AccountSigner) PagingToken Uses

func (res AccountSigner) PagingToken() string

PagingToken implementation for hal.Pageable

type AccountThresholds Uses

type AccountThresholds struct {
    LowThreshold  byte `json:"low_threshold"`
    MedThreshold  byte `json:"med_threshold"`
    HighThreshold byte `json:"high_threshold"`

AccountThresholds represents an accounts "thresholds", the numerical values needed to satisfy the authorization of a given operation.

type Asset Uses

type Asset base.Asset

Asset represents a single asset

type AssetStat Uses

type AssetStat struct {
    Links struct {
        Toml hal.Link `json:"toml"`
    }   `json:"_links"`

    PT          string       `json:"paging_token"`
    Amount      string       `json:"amount"`
    NumAccounts int32        `json:"num_accounts"`
    Flags       AccountFlags `json:"flags"`

AssetStat represents the statistics for a single Asset

func (AssetStat) PagingToken Uses

func (res AssetStat) PagingToken() string

PagingToken implementation for hal.Pageable

type AssetsPage Uses

type AssetsPage struct {
    Links    hal.Links `json:"_links"`
    Embedded struct {
        Records []AssetStat
    }   `json:"_embedded"`

AssetsPage contains page of assets returned by Horizon.

type Balance Uses

type Balance struct {
    Balance            string `json:"balance"`
    Limit              string `json:"limit,omitempty"`
    BuyingLiabilities  string `json:"buying_liabilities"`
    SellingLiabilities string `json:"selling_liabilities"`
    LastModifiedLedger uint32 `json:"last_modified_ledger,omitempty"`
    IsAuthorized       *bool  `json:"is_authorized,omitempty"`

Balance represents an account's holdings for a single currency type

type FeeStats Uses

type FeeStats struct {
    LastLedger          int     `json:"last_ledger,string"`
    LastLedgerBaseFee   int     `json:"last_ledger_base_fee,string"`
    LedgerCapacityUsage float64 `json:"ledger_capacity_usage,string"`
    MinAcceptedFee      int     `json:"min_accepted_fee,string"`
    ModeAcceptedFee     int     `json:"mode_accepted_fee,string"`
    P10AcceptedFee      int     `json:"p10_accepted_fee,string"`
    P20AcceptedFee      int     `json:"p20_accepted_fee,string"`
    P30AcceptedFee      int     `json:"p30_accepted_fee,string"`
    P40AcceptedFee      int     `json:"p40_accepted_fee,string"`
    P50AcceptedFee      int     `json:"p50_accepted_fee,string"`
    P60AcceptedFee      int     `json:"p60_accepted_fee,string"`
    P70AcceptedFee      int     `json:"p70_accepted_fee,string"`
    P80AcceptedFee      int     `json:"p80_accepted_fee,string"`
    P90AcceptedFee      int     `json:"p90_accepted_fee,string"`
    P95AcceptedFee      int     `json:"p95_accepted_fee,string"`
    P99AcceptedFee      int     `json:"p99_accepted_fee,string"`

FeeStats represents a response of fees from horizon To do: implement fee suggestions if agreement is reached in https://github.com/stellar/go/issues/926

type Ledger Uses

type Ledger struct {
    Links struct {
        Self         hal.Link `json:"self"`
        Transactions hal.Link `json:"transactions"`
        Operations   hal.Link `json:"operations"`
        Payments     hal.Link `json:"payments"`
        Effects      hal.Link `json:"effects"`
    }   `json:"_links"`
    ID                         string    `json:"id"`
    PT                         string    `json:"paging_token"`
    Hash                       string    `json:"hash"`
    PrevHash                   string    `json:"prev_hash,omitempty"`
    Sequence                   int32     `json:"sequence"`
    SuccessfulTransactionCount int32     `json:"successful_transaction_count"`
    FailedTransactionCount     *int32    `json:"failed_transaction_count"`
    OperationCount             int32     `json:"operation_count"`
    ClosedAt                   time.Time `json:"closed_at"`
    TotalCoins                 string    `json:"total_coins"`
    FeePool                    string    `json:"fee_pool"`
    BaseFee                    int32     `json:"base_fee_in_stroops"`
    BaseReserve                int32     `json:"base_reserve_in_stroops"`
    MaxTxSetSize               int32     `json:"max_tx_set_size"`
    ProtocolVersion            int32     `json:"protocol_version"`
    HeaderXDR                  string    `json:"header_xdr"`

Ledger represents a single closed ledger

func (Ledger) PagingToken Uses

func (l Ledger) PagingToken() string

type LedgersPage Uses

type LedgersPage struct {
    Links    hal.Links `json:"_links"`
    Embedded struct {
        Records []Ledger
    }   `json:"_embedded"`

LedgersPage contains page of ledger information returned by Horizon

type LogMetric Uses

type LogMetric struct {
    Rate15m  float64 `json:"15m.rate"`
    Rate1m   float64 `json:"1m.rate"`
    Rate5m   float64 `json:"5m.rate"`
    Count    int     `json:"count"`
    MeanRate float64 `json:"mean.rate"`

LogMetric represents metrics that are logged by horizon for each log level

type LogTotalMetric Uses

type LogTotalMetric struct {
    Percent75   float64 `json:"75%"`
    Percent95   float64 `json:"95%"`
    Percent99   float64 `json:"99%"`
    Percent99_9 float64 `json:"99.9%"`
    Max         float64 `json:"max"`
    Mean        float64 `json:"mean"`
    Median      float64 `json:"median"`
    Min         float64 `json:"min"`
    StdDev      float64 `json:"stddev"`

LogTotalMetric represents total metrics logged for ingester, requests and submitted transactions

type Metrics Uses

type Metrics struct {
    Links                  hal.Links      `json:"_links"`
    GoRoutines             SingleMetric   `json:"goroutines"`
    HistoryElderLedger     SingleMetric   `json:"history.elder_ledger"`
    HistoryLatestLedger    SingleMetric   `json:"history.latest_ledger"`
    HistoryOpenConnections SingleMetric   `json:"history.open_connections"`
    IngesterIngestLedger   LogTotalMetric `json:"ingester.ingest_ledger"`
    IngesterClearLedger    LogTotalMetric `json:"ingester.clear_ledger"`
    LoggingDebug           LogMetric      `json:"logging.debug"`
    LoggingError           LogMetric      `json:"logging.error"`
    LoggingInfo            LogMetric      `json:"logging.info"`
    LoggingPanic           LogMetric      `json:"logging.panic"`
    LoggingWarning         LogMetric      `json:"logging.warning"`
    RequestsFailed         LogMetric      `json:"requests.failed"`
    RequestsSucceeded      LogMetric      `json:"requests.succeeded"`
    RequestsTotal          LogTotalMetric `json:"requests.total"`
    CoreLatestLedger       SingleMetric   `json:"stellar_core.latest_ledger"`
    CoreOpenConnections    SingleMetric   `json:"stellar_core.open_connections"`
    TxsubBuffered          SingleMetric   `json:"txsub.buffered"`
    TxsubFailed            LogMetric      `json:"txsub.failed"`
    TxsubOpen              SingleMetric   `json:"txsub.open"`
    TxsubSucceeded         LogMetric      `json:"txsub.succeeded"`
    TxsubTotal             LogTotalMetric `json:"txsub.total"`

Metrics represents a response of metrics from horizon

type Offer Uses

type Offer struct {
    Links struct {
        Self       hal.Link `json:"self"`
        OfferMaker hal.Link `json:"offer_maker"`
    }   `json:"_links"`

    // Action needed in release: horizon-v0.25.0
    ID                 int64      `json:"id"`
    PT                 string     `json:"paging_token"`
    Seller             string     `json:"seller"`
    Selling            Asset      `json:"selling"`
    Buying             Asset      `json:"buying"`
    Amount             string     `json:"amount"`
    PriceR             Price      `json:"price_r"`
    Price              string     `json:"price"`
    LastModifiedLedger int32      `json:"last_modified_ledger"`
    LastModifiedTime   *time.Time `json:"last_modified_time"`

Offer is the display form of an offer to trade currency.

func (Offer) PagingToken Uses

func (o Offer) PagingToken() string

type OffersPage Uses

type OffersPage struct {
    Links    hal.Links `json:"_links"`
    Embedded struct {
        Records []Offer `json:"records"`
    }   `json:"_embedded"`

OffersPage returns a list of offers

type OrderBookSummary Uses

type OrderBookSummary struct {
    Bids    []PriceLevel `json:"bids"`
    Asks    []PriceLevel `json:"asks"`
    Selling Asset        `json:"base"`
    Buying  Asset        `json:"counter"`

OrderBookSummary represents a snapshot summary of a given order book

type Path Uses

type Path struct {
    SourceAssetType        string  `json:"source_asset_type"`
    SourceAssetCode        string  `json:"source_asset_code,omitempty"`
    SourceAssetIssuer      string  `json:"source_asset_issuer,omitempty"`
    SourceAmount           string  `json:"source_amount"`
    DestinationAssetType   string  `json:"destination_asset_type"`
    DestinationAssetCode   string  `json:"destination_asset_code,omitempty"`
    DestinationAssetIssuer string  `json:"destination_asset_issuer,omitempty"`
    DestinationAmount      string  `json:"destination_amount"`
    Path                   []Asset `json:"path"`

Path represents a single payment path.

func (Path) PagingToken Uses

func (p Path) PagingToken() string

stub implementation to satisfy pageable interface

type PathsPage Uses

type PathsPage struct {
    Links    hal.Links `json:"_links"`
    Embedded struct {
        Records []Path
    }   `json:"_embedded"`

PathsPage contains records of payment paths found by horizon

type Price Uses

type Price base.Price

Price represents a price

type PriceLevel Uses

type PriceLevel struct {
    PriceR Price  `json:"price_r"`
    Price  string `json:"price"`
    Amount string `json:"amount"`

PriceLevel represents an aggregation of offers that share a given price

type Root Uses

type Root struct {
    Links struct {
        Account             hal.Link  `json:"account"`
        Accounts            *hal.Link `json:"accounts,omitempty"`
        AccountTransactions hal.Link  `json:"account_transactions"`
        Assets              hal.Link  `json:"assets"`
        Friendbot           *hal.Link `json:"friendbot,omitempty"`
        Metrics             hal.Link  `json:"metrics"`
        Offer               *hal.Link `json:"offer,omitempty"`
        Offers              *hal.Link `json:"offers,omitempty"`
        OrderBook           hal.Link  `json:"order_book"`
        Self                hal.Link  `json:"self"`
        StrictReceivePaths  *hal.Link `json:"strict_receive_paths"`
        StrictSendPaths     *hal.Link `json:"strict_send_paths"`
        Transaction         hal.Link  `json:"transaction"`
        Transactions        hal.Link  `json:"transactions"`
    }   `json:"_links"`

    HorizonVersion               string `json:"horizon_version"`
    StellarCoreVersion           string `json:"core_version"`
    ExpHorizonSequence           uint32 `json:"exp_history_latest_ledger,omitempty"`
    HorizonSequence              int32  `json:"history_latest_ledger"`
    HistoryElderSequence         int32  `json:"history_elder_ledger"`
    CoreSequence                 int32  `json:"core_latest_ledger"`
    NetworkPassphrase            string `json:"network_passphrase"`
    CurrentProtocolVersion       int32  `json:"current_protocol_version"`
    CoreSupportedProtocolVersion int32  `json:"core_supported_protocol_version"`

Root is the initial map of links into the api.

type Signer Uses

type Signer struct {
    Weight int32  `json:"weight"`
    Key    string `json:"key"`
    Type   string `json:"type"`

Signer represents one of an account's signers.

type SingleMetric Uses

type SingleMetric struct {
    Value int `json:"value"`

SingleMetric represents a metric with a single value

type Trade Uses

type Trade struct {
    Links struct {
        Self      hal.Link `json:"self"`
        Base      hal.Link `json:"base"`
        Counter   hal.Link `json:"counter"`
        Operation hal.Link `json:"operation"`
    }   `json:"_links"`

    ID                 string    `json:"id"`
    PT                 string    `json:"paging_token"`
    LedgerCloseTime    time.Time `json:"ledger_close_time"`
    OfferID            string    `json:"offer_id"`
    BaseOfferID        string    `json:"base_offer_id"`
    BaseAccount        string    `json:"base_account"`
    BaseAmount         string    `json:"base_amount"`
    BaseAssetType      string    `json:"base_asset_type"`
    BaseAssetCode      string    `json:"base_asset_code,omitempty"`
    BaseAssetIssuer    string    `json:"base_asset_issuer,omitempty"`
    CounterOfferID     string    `json:"counter_offer_id"`
    CounterAccount     string    `json:"counter_account"`
    CounterAmount      string    `json:"counter_amount"`
    CounterAssetType   string    `json:"counter_asset_type"`
    CounterAssetCode   string    `json:"counter_asset_code,omitempty"`
    CounterAssetIssuer string    `json:"counter_asset_issuer,omitempty"`
    BaseIsSeller       bool      `json:"base_is_seller"`
    Price              *Price    `json:"price"`

Trade represents a horizon digested trade

func (Trade) PagingToken Uses

func (res Trade) PagingToken() string

PagingToken implementation for hal.Pageable

type TradeAggregation Uses

type TradeAggregation struct {
    // Action needed in release: horizon-v0.22.0
    Timestamp int64 `json:"timestamp"`
    // Action needed in release: horizon-v0.22.0
    TradeCount    int64     `json:"trade_count"`
    BaseVolume    string    `json:"base_volume"`
    CounterVolume string    `json:"counter_volume"`
    Average       string    `json:"avg"`
    High          string    `json:"high"`
    HighR         xdr.Price `json:"high_r"`
    Low           string    `json:"low"`
    LowR          xdr.Price `json:"low_r"`
    Open          string    `json:"open"`
    OpenR         xdr.Price `json:"open_r"`
    Close         string    `json:"close"`
    CloseR        xdr.Price `json:"close_r"`

TradeAggregation represents trade data aggregation over a period of time

func (TradeAggregation) PagingToken Uses

func (res TradeAggregation) PagingToken() string

PagingToken implementation for hal.Pageable. Not actually used

type TradeAggregationsPage Uses

type TradeAggregationsPage struct {
    Links    hal.Links `json:"_links"`
    Embedded struct {
        Records []TradeAggregation `json:"records"`
    }   `json:"_embedded"`

TradeAggregationsPage returns a list of aggregated trade records, aggregated by resolution

type TradeEffect Uses

type TradeEffect struct {
    Links struct {
        Self      hal.Link `json:"self"`
        Seller    hal.Link `json:"seller"`
        Buyer     hal.Link `json:"buyer"`
        Operation hal.Link `json:"operation"`
    }   `json:"_links"`

    ID                string    `json:"id"`
    PT                string    `json:"paging_token"`
    OfferID           string    `json:"offer_id"`
    Seller            string    `json:"seller"`
    SoldAmount        string    `json:"sold_amount"`
    SoldAssetType     string    `json:"sold_asset_type"`
    SoldAssetCode     string    `json:"sold_asset_code,omitempty"`
    SoldAssetIssuer   string    `json:"sold_asset_issuer,omitempty"`
    Buyer             string    `json:"buyer"`
    BoughtAmount      string    `json:"bought_amount"`
    BoughtAssetType   string    `json:"bought_asset_type"`
    BoughtAssetCode   string    `json:"bought_asset_code,omitempty"`
    BoughtAssetIssuer string    `json:"bought_asset_issuer,omitempty"`
    LedgerCloseTime   time.Time `json:"created_at"`

TradeEffect represents a trade effect resource. NOTE (scott, 2017-12-08): this resource is being added back in temporarily to deal with a deploy snafu. I didn't properly message the community that we were changing the response format, and so we're adding this back in to allow transition.

type TradesPage Uses

type TradesPage struct {
    Links    hal.Links `json:"_links"`
    Embedded struct {
        Records []Trade `json:"records"`
    }   `json:"_embedded"`

TradesPage returns a list of trade records

type Transaction Uses

type Transaction struct {
    Links struct {
        Self       hal.Link `json:"self"`
        Account    hal.Link `json:"account"`
        Ledger     hal.Link `json:"ledger"`
        Operations hal.Link `json:"operations"`
        Effects    hal.Link `json:"effects"`
        Precedes   hal.Link `json:"precedes"`
        Succeeds   hal.Link `json:"succeeds"`
    }   `json:"_links"`
    ID              string    `json:"id"`
    PT              string    `json:"paging_token"`
    Successful      bool      `json:"successful"`
    Hash            string    `json:"hash"`
    Ledger          int32     `json:"ledger"`
    LedgerCloseTime time.Time `json:"created_at"`
    Account         string    `json:"source_account"`
    AccountSequence string    `json:"source_account_sequence"`
    // Action needed in release: horizon-v0.25.0
    // Action needed in release: horizonclient-v2.0.0
    // Remove this field.
    FeePaid        int32    `json:"fee_paid"`
    FeeCharged     int32    `json:"fee_charged"`
    MaxFee         int32    `json:"max_fee"`
    OperationCount int32    `json:"operation_count"`
    EnvelopeXdr    string   `json:"envelope_xdr"`
    ResultXdr      string   `json:"result_xdr"`
    ResultMetaXdr  string   `json:"result_meta_xdr"`
    FeeMetaXdr     string   `json:"fee_meta_xdr"`
    MemoType       string   `json:"memo_type"`
    Memo           string   `json:"memo,omitempty"`
    Signatures     []string `json:"signatures"`
    ValidAfter     string   `json:"valid_after,omitempty"`
    ValidBefore    string   `json:"valid_before,omitempty"`

Transaction represents a single, successful transaction

func (Transaction) MarshalJSON Uses

func (t Transaction) MarshalJSON() ([]byte, error)

MarshalJSON implements a custom marshaler for Transaction. The memo field should be omitted if and only if the memo_type is "none".

func (Transaction) PagingToken Uses

func (res Transaction) PagingToken() string

PagingToken implementation for hal.Pageable

type TransactionResultCodes Uses

type TransactionResultCodes struct {
    TransactionCode string   `json:"transaction"`
    OperationCodes  []string `json:"operations,omitempty"`

TransactionResultCodes represent a summary of result codes returned from a single xdr TransactionResult

type TransactionSuccess Uses

type TransactionSuccess struct {
    Links struct {
        Transaction hal.Link `json:"transaction"`
    }   `json:"_links"`
    Hash   string `json:"hash"`
    Ledger int32  `json:"ledger"`
    Env    string `json:"envelope_xdr"`
    Result string `json:"result_xdr"`
    Meta   string `json:"result_meta_xdr"`

TransactionSuccess represents the result of a successful transaction submission.

func (TransactionSuccess) TransactionSuccessToString Uses

func (resp TransactionSuccess) TransactionSuccessToString() (s string)

PrintTransactionSuccess prints the fields of a Horizon response.

type TransactionsPage Uses

type TransactionsPage struct {
    Links    hal.Links `json:"_links"`
    Embedded struct {
        Records []Transaction
    }   `json:"_embedded"`

TransactionsPage contains records of transaction information returned by Horizon



Package horizon imports 10 packages (graph) and is imported by 71 packages. Updated 2019-11-18. Refresh now. Tools for package owners.