Documentation ¶
Index ¶
- Constants
- type Account
- type AccountDetails
- type BalanceSummary
- type Block
- type BlockWithMeta
- type EventTransfer
- type GetAccountBalanceResponse
- type GetRewardResponse
- type HeightAccount
- type HeightHash
- type HeightRange
- type LatestDataRequest
- type LatestDataResponse
- type RewardSummary
- type SubsetEvent
- type SubsetEventError
- type Transaction
- type TransactionAmount
- type TransactionEvent
- type TransactionEvents
- type TransactionSearch
- type TransactionWithMeta
Constants ¶
View Source
const ( ReqIDGetTransactions = "GetTransactions" ReqIDLatestData = "GetLatest" ReqIDGetReward = "GetReward" ReqIDAccountBalance = "GetAccountBalance" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct { // Unique account identifier ID string `json:"id"` // External optional account details (if applies) Details *AccountDetails `json:"detail,omitempty"` }
Account - Extended Account information swagger:model
type AccountDetails ¶
type AccountDetails struct { Description string `json:"description,omitempty"` Contact string `json:"contact,omitempty"` Name string `json:"name,omitempty"` Website string `json:"website,omitempty"` }
AccountDetails External optional account details (if applies) swagger:model
type BalanceSummary ¶ added in v0.1.0
type BalanceSummary struct { Height uint64 `json:"height"` Time time.Time `json:"time"` Amount []TransactionAmount `json:"balances"` }
type Block ¶
type Block struct { ID uuid.UUID `json:"id,omitempty"` CreatedAt *time.Time `json:"created_at,omitempty"` UpdatedAt *time.Time `json:"updated_at,omitempty"` Hash string `json:"hash,omitempty"` Height uint64 `json:"height,omitempty"` Time time.Time `json:"time,omitempty"` Epoch string `json:"epoch,omitempty"` ChainID string `json:"chain_id,omitempty"` NumberOfTransactions uint64 `json:"num_txs,omitempty"` }
Block
type BlockWithMeta ¶
type EventTransfer ¶
type EventTransfer struct { Account Account `json:"account,omitempty"` Amounts []TransactionAmount `json:"amounts,omitempty"` }
EventTransfer - Account and Amounts pair swagger:model
type GetAccountBalanceResponse ¶ added in v0.1.0
type GetAccountBalanceResponse struct { Height uint64 `json:"height"` Balances []TransactionAmount `json:"balances"` }
type GetRewardResponse ¶ added in v0.0.9
type GetRewardResponse struct { Height uint64 `json:"height"` Rewards []TransactionAmount `json:"rewards"` }
type HeightAccount ¶ added in v0.0.9
type HeightHash ¶
type HeightRange ¶
type LatestDataRequest ¶
type LatestDataRequest struct { Network string `json:"network"` ChainID string `json:"chain_id"` Version string `json:"version"` LastHash string `json:"lastHash"` LastEpoch string `json:"lastEpoch"` LastHeight uint64 `json:"lastHeight"` LastTime time.Time `json:"lastTime"` Nonce []byte `json:"nonce"` SelfCheck bool `json:"selfCheck"` }
type LatestDataResponse ¶
type RewardSummary ¶ added in v0.0.9
type RewardSummary struct { Start uint64 `json:"start"` End uint64 `json:"end"` Time time.Time `json:"time"` Amount []TransactionAmount `json:"rewards"` }
type SubsetEvent ¶
type SubsetEvent struct { // ID UniqueID of subsetevent ID string `json:"id,omitempty"` // Type of transaction Type []string `json:"type,omitempty"` Action string `json:"action,omitempty"` // Collection from where transaction came from Module string `json:"module,omitempty"` // List of sender accounts with optional amounts Sender []EventTransfer `json:"sender,omitempty"` // List of recipient accounts with optional amounts Recipient []EventTransfer `json:"recipient,omitempty"` // The list of all accounts that took part in the subsetevent Node map[string][]Account `json:"node,omitempty"` // Transaction nonce Nonce string `json:"nonce,omitempty"` // Completion time Completion *time.Time `json:"completion,omitempty"` // List of Amounts Amount map[string]TransactionAmount `json:"amount,omitempty"` // List of Transfers with amounts and optional recipients Transfers map[string][]EventTransfer `json:"transfers,omitempty"` // Optional error if occurred Error *SubsetEventError `json:"error,omitempty"` // Set of additional parameters attached to transaction (used as last resort) Additional map[string][]string `json:"additional,omitempty"` // SubEvents because some messages are in fact carying another messages inside Sub []SubsetEvent `json:"sub,omitempty"` }
SubsetEvent - structure storing main contents of transacion swagger:model
type SubsetEventError ¶
type SubsetEventError struct {
Message string `json:"message,omitempty"`
}
SubsetEventError error structure for event swagger:model
type Transaction ¶
type Transaction struct { // ID of transaction assigned on database write ID uuid.UUID `json:"id,omitempty"` // Created at CreatedAt *time.Time `json:"created_at,omitempty"` // Updated at UpdatedAt *time.Time `json:"updated_at,omitempty"` // Hash of the transaction Hash string `json:"hash,omitempty"` // BlockHash - hash of the block of transaction BlockHash string `json:"block_hash,omitempty"` // Height - height of the block of transaction Height uint64 `json:"height,omitempty"` Epoch string `json:"epoch,omitempty"` // ChainID - chain id of transacion ChainID string `json:"chain_id,omitempty"` // Time - time of transaction Time time.Time `json:"time,omitempty"` // Fee - Fees for transaction (if applies) Fee []TransactionAmount `json:"transaction_fee,omitempty"` // GasWanted GasWanted uint64 `json:"gas_wanted,omitempty"` // GasUsed GasUsed uint64 `json:"gas_used,omitempty"` // Memo - the description attached to transactions Memo string `json:"memo,omitempty"` // Version - Version of transaction record Version string `json:"version"` // Events - Transaction contents Events TransactionEvents `json:"events,omitempty"` // Raw - Raw transaction bytes Raw []byte `json:"raw,omitempty"` // RawLog - RawLog transaction's log bytes RawLog []byte `json:"raw_log,omitempty"` // HasErrors - indicates if Transaction has any errors inside HasErrors bool `json:"has_errors"` }
Transaction contains the blockchain transaction details swagger:model
type TransactionAmount ¶
type TransactionAmount struct { // Textual representation of Amount Text string `json:"text,omitempty"` // The currency in what amount is returned (if applies) Currency string `json:"currency,omitempty"` // Numeric part of the amount Numeric *big.Int `json:"numeric,omitempty"` // Exponential part of amount obviously 0 by default Exp int32 `json:"exp,omitempty"` }
TransactionAmount structure holding amount information with decimal implementation (numeric * 10 ^ exp) swagger:model
func (*TransactionAmount) Add ¶ added in v0.0.9
func (t *TransactionAmount) Add(o TransactionAmount) error
func (*TransactionAmount) Clone ¶ added in v0.0.9
func (t *TransactionAmount) Clone() TransactionAmount
func (*TransactionAmount) Sub ¶ added in v0.0.9
func (t *TransactionAmount) Sub(o TransactionAmount) error
type TransactionEvent ¶
type TransactionEvent struct { // ID UniqueID of event ID string `json:"id,omitempty"` // The Kind of event Kind string `json:"kind,omitempty"` // Type of transaction Type []string `json:"type,omitempty"` // Collection from where transaction came from Module string `json:"module,omitempty"` // List of sender accounts with optional amounts // Subcontents of event Sub []SubsetEvent `json:"sub,omitempty"` }
TransactionEvent part of transaction contents swagger:model
type TransactionEvents ¶
type TransactionEvents []TransactionEvent
TransactionEvents - a set of TransactionEvent swagger:model
func (*TransactionEvents) Scan ¶
func (te *TransactionEvents) Scan(value interface{}) error
type TransactionSearch ¶
type TransactionSearch struct { Network string `json:"network"` ChainIDs []string `json:"chain_ids"` Epoch string `json:"epoch"` Height uint64 `json:"height"` Type []string `json:"type"` BlockHash string `json:"block_hash"` Hash string `json:"hash"` Account []string `json:"account"` Sender []string `json:"sender"` Receiver []string `json:"receiver"` Memo string `json:"memo"` BeforeTime time.Time `json:"before_time"` AfterTime time.Time `json:"after_time"` Limit uint64 `json:"limit"` Offset uint64 `json:"offset"` AfterHeight uint64 `form:"after_id"` BeforeHeight uint64 `form:"before_id"` WithRaw bool `json:"with_raw"` WithRawLog bool `json:"with_raw_log"` }
type TransactionWithMeta ¶
type TransactionWithMeta struct { Network string `json:"network,omitempty"` Version string `json:"version,omitempty"` ChainID string `json:"chain_id,omitempty"` Transaction Transaction `json:"transaction,omitempty"` }
Click to show internal directories.
Click to hide internal directories.