types

Documentation

Index

• type Cache
• type Counters
• type ETL
• type ETLSource
• type Ledger
• type LedgerInfo
• type NFToken
• type RPC
• type Subscriptions

Types

type Cache

type Cache struct {
	Size            int  `json:"size"`
	IsFull          bool `json:"is_full"`
	LatestLedgerSeq int  `json:"latest_ledger_seq"`
}

type Counters

type Counters struct {
	RPC           map[string]RPC `json:"rpc"`
	Subscriptions Subscriptions  `json:"subscriptions"`
}

type ETL

type ETL struct {
	ETLSources            []ETLSource `json:"etl_sources"`
	IsWriter              bool        `json:"is_writer"`
	ReadOnly              bool        `json:"read_only"`
	LastPublishAgeSeconds string      `json:"last_publish_age_seconds"`
}

type ETLSource

type ETLSource struct {
	ValidatedRange    string `json:"validated_range"`
	IsConnected       string `json:"is_connected"`
	IP                string `json:"ip"`
	WSPort            string `json:"ws_port"`
	GRPCPort          string `json:"grpc_port"`
	LastMsgAgeSeconds string `json:"last_msg_age_seconds"`
}

type Ledger

type Ledger struct {
	AccountHash         string                        `json:"account_hash"`
	AccountState        []ledger.FlatLedgerObject     `json:"accountState,omitempty"`
	CloseFlags          int                           `json:"close_flags"`
	CloseTime           uint                          `json:"close_time"`
	CloseTimeHuman      string                        `json:"close_time_human"`
	CloseTimeResolution int                           `json:"close_time_resolution"`
	Closed              bool                          `json:"closed"`
	LedgerHash          common.LedgerHash             `json:"ledger_hash"`
	LedgerIndex         string                        `json:"ledger_index"`
	ParentCloseTime     uint                          `json:"parent_close_time"`
	ParentHash          string                        `json:"parent_hash"`
	TotalCoins          types.XRPCurrencyAmount       `json:"total_coins"`
	TransactionHash     string                        `json:"transaction_hash"`
	Transactions        []transaction.FlatTransaction `json:"transactions,omitempty"`
}

Ledger is a struct that represents the ledger information.

type LedgerInfo

type LedgerInfo struct {
	Age            uint          `json:"age"`
	BaseFeeXRP     float32       `json:"base_fee_xrp"`
	Hash           types.Hash256 `json:"hash"`
	ReserveBaseXRP float32       `json:"reserve_base_xrp"`
	ReserveIncXRP  float32       `json:"reserve_inc_xrp"`
	Seq            uint          `json:"seq"`
}

type NFToken

type NFToken struct {
	NFTokenID       types.NFTokenID    `json:"nft_id"`
	LedgerIndex     common.LedgerIndex `json:"ledger_index"`
	Owner           types.Address      `json:"owner"`
	IsBurned        bool               `json:"is_burned"`
	Flags           uint               `json:"flags"`
	TransferFee     uint               `json:"transfer_fee"`
	Issuer          types.Address      `json:"issuer"`
	NFTokenTaxon    uint               `json:"nft_taxon"`
	NFTokenSequence uint               `json:"nft_sequence"`
	URI             types.NFTokenURI   `json:"uri,omitempty"`
}

NFToken is a struct that represents an NFToken. It contains the information about the NFToken, such as the ID, the ledger index, the owner, if it is burned, the flags, the transfer fee, the issuer, the taxon, the sequence, the URI, and the URI JSON.

type RPC

type RPC struct {
	Started    string `json:"started,omitempty"`
	Finished   string `json:"finished,omitempty"`
	Errored    string `json:"errored,omitempty"`
	Forwarded  string `json:"forwarded,omitempty"`
	DurationUS string `json:"duration_us,omitempty"`
}

type Subscriptions

type Subscriptions struct {
	Ledger               int `json:"ledger"`
	Transactions         int `json:"transactions"`
	TransactionsProposed int `json:"transactions_proposed"`
	Manifests            int `json:"manifests"`
	Validations          int `json:"validations"`
	Account              int `json:"account"`
	AccountsProposed     int `json:"accounts_proposed"`
	Books                int `json:"books"`
}