Documentation
¶
Index ¶
- type AddressHandler
- func (handler *AddressHandler) Blobs(c echo.Context) error
- func (handler *AddressHandler) Celestials(c echo.Context) error
- func (handler *AddressHandler) Count(c echo.Context) error
- func (handler *AddressHandler) Delegations(c echo.Context) error
- func (handler *AddressHandler) Get(c echo.Context) error
- func (handler *AddressHandler) Grantee(c echo.Context) error
- func (handler *AddressHandler) Grants(c echo.Context) error
- func (handler *AddressHandler) List(c echo.Context) error
- func (handler *AddressHandler) Messages(c echo.Context) error
- func (handler *AddressHandler) Redelegations(c echo.Context) error
- func (handler *AddressHandler) Stats(c echo.Context) error
- func (handler *AddressHandler) Transactions(c echo.Context) error
- func (handler *AddressHandler) Undelegations(c echo.Context) error
- func (handler *AddressHandler) Vestings(c echo.Context) error
- func (handler *AddressHandler) Votes(c echo.Context) error
- type BlockHandler
- func (handler *BlockHandler) Blobs(c echo.Context) error
- func (handler *BlockHandler) BlobsCount(c echo.Context) error
- func (handler *BlockHandler) BlockODS(c echo.Context) error
- func (handler *BlockHandler) Count(c echo.Context) error
- func (handler *BlockHandler) Get(c echo.Context) error
- func (handler *BlockHandler) GetEvents(c echo.Context) error
- func (handler *BlockHandler) GetMessages(c echo.Context) error
- func (handler *BlockHandler) GetStats(c echo.Context) error
- func (handler *BlockHandler) List(c echo.Context) error
- type CelestiaApiValidator
- type ConstantHandler
- type Error
- type ForwardingsHandler
- type GasHandler
- type HyperlaneHandler
- func (handler *HyperlaneHandler) GetIgp(c echo.Context) error
- func (handler *HyperlaneHandler) GetMailbox(c echo.Context) error
- func (handler *HyperlaneHandler) GetToken(c echo.Context) error
- func (handler *HyperlaneHandler) GetTransfer(c echo.Context) error
- func (handler *HyperlaneHandler) ListDomains(c echo.Context) error
- func (handler *HyperlaneHandler) ListIgps(c echo.Context) error
- func (handler *HyperlaneHandler) ListMailboxes(c echo.Context) error
- func (handler *HyperlaneHandler) ListTokens(c echo.Context) error
- func (handler *HyperlaneHandler) ListTransfers(c echo.Context) error
- type IbcHandler
- func (handler *IbcHandler) Get(c echo.Context) error
- func (handler *IbcHandler) GetChannel(c echo.Context) error
- func (handler *IbcHandler) GetConnection(c echo.Context) error
- func (handler *IbcHandler) GetIbcTransfer(c echo.Context) error
- func (handler *IbcHandler) IbcRelayers(c echo.Context) error
- func (handler *IbcHandler) List(c echo.Context) error
- func (handler *IbcHandler) ListChannels(c echo.Context) error
- func (handler *IbcHandler) ListConnections(c echo.Context) error
- func (handler *IbcHandler) ListTransfers(c echo.Context) error
- type MsgTypeArray
- type NamespaceHandler
- func (handler *NamespaceHandler) Blob(c echo.Context) error
- func (handler *NamespaceHandler) BlobMetadata(c echo.Context) error
- func (handler *NamespaceHandler) BlobProofs(c echo.Context) error
- func (handler *NamespaceHandler) Blobs(c echo.Context) error
- func (handler *NamespaceHandler) Get(c echo.Context) error
- func (handler *NamespaceHandler) GetBlobLogs(c echo.Context) error
- func (handler *NamespaceHandler) GetBlobs(c echo.Context) error
- func (handler *NamespaceHandler) GetByHash(c echo.Context) error
- func (handler *NamespaceHandler) GetMessages(c echo.Context) error
- func (handler *NamespaceHandler) GetWithVersion(c echo.Context) error
- func (handler *NamespaceHandler) List(c echo.Context) error
- func (handler *NamespaceHandler) Rollups(c echo.Context) error
- type NoRows
- type ProposalsHandler
- type RollupHandler
- func (handler RollupHandler) AllSeries(c echo.Context) error
- func (handler RollupHandler) BySlug(c echo.Context) error
- func (handler RollupHandler) Count(c echo.Context) error
- func (handler RollupHandler) Distribution(c echo.Context) error
- func (handler RollupHandler) ExportBlobs(c echo.Context) error
- func (handler RollupHandler) Get(c echo.Context) error
- func (handler RollupHandler) GetBlobs(c echo.Context) error
- func (handler RollupHandler) GetNamespaces(c echo.Context) error
- func (handler RollupHandler) GetProviders(c echo.Context) error
- func (handler RollupHandler) Leaderboard(c echo.Context) error
- func (handler RollupHandler) LeaderboardDay(c echo.Context) error
- func (handler RollupHandler) RollupGroupedStats(c echo.Context) error
- func (handler RollupHandler) Stats(c echo.Context) error
- type SearchHandler
- type SignalHandler
- type StateHandler
- type StatsHandler
- func (sh StatsHandler) Change24hBlockStats(c echo.Context) error
- func (sh StatsHandler) HlByDomain(c echo.Context) error
- func (sh StatsHandler) HlSeries(c echo.Context) error
- func (sh StatsHandler) HlTotalSeries(c echo.Context) error
- func (sh StatsHandler) IbcByChains(c echo.Context) error
- func (sh StatsHandler) IbcSeries(c echo.Context) error
- func (sh StatsHandler) IbcSummary(c echo.Context) error
- func (sh StatsHandler) MessagesCount24h(c echo.Context) error
- func (sh StatsHandler) NamespaceSeries(c echo.Context) error
- func (sh StatsHandler) NamespaceUsage(c echo.Context) error
- func (sh StatsHandler) RollupStats24h(c echo.Context) error
- func (sh StatsHandler) Series(c echo.Context) error
- func (sh StatsHandler) SeriesCumulative(c echo.Context) error
- func (sh StatsHandler) SizeGroups(c echo.Context) error
- func (sh StatsHandler) SquareSize(c echo.Context) error
- func (sh StatsHandler) StakingDistribution(c echo.Context) error
- func (sh StatsHandler) StakingSeries(c echo.Context) error
- func (sh StatsHandler) Summary(c echo.Context) error
- func (sh StatsHandler) TPS(c echo.Context) error
- type StatusArray
- type StringArray
- type TxHandler
- func (handler *TxHandler) Blobs(c echo.Context) error
- func (handler *TxHandler) BlobsCount(c echo.Context) error
- func (handler *TxHandler) Count(c echo.Context) error
- func (handler *TxHandler) Genesis(c echo.Context) error
- func (handler *TxHandler) Get(c echo.Context) error
- func (handler *TxHandler) GetEvents(c echo.Context) error
- func (handler *TxHandler) GetMessages(c echo.Context) error
- func (handler *TxHandler) List(c echo.Context) error
- type ValidatorHandler
- func (handler *ValidatorHandler) Blocks(c echo.Context) error
- func (handler *ValidatorHandler) Count(c echo.Context) error
- func (handler *ValidatorHandler) Delegators(c echo.Context) error
- func (handler *ValidatorHandler) Get(c echo.Context) error
- func (handler *ValidatorHandler) Jails(c echo.Context) error
- func (handler *ValidatorHandler) List(c echo.Context) error
- func (handler *ValidatorHandler) Messages(c echo.Context) error
- func (handler *ValidatorHandler) Metrics(c echo.Context) error
- func (handler *ValidatorHandler) TopNMetrics(c echo.Context) error
- func (handler *ValidatorHandler) Uptime(c echo.Context) error
- func (handler *ValidatorHandler) Votes(c echo.Context) error
- type VestingHandler
- type ZkISMHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddressHandler ¶
type AddressHandler struct {
// contains filtered or unexported fields
}
func NewAddressHandler ¶
func NewAddressHandler( address storage.IAddress, txs storage.ITx, blobLogs storage.IBlobLog, messages storage.IMessage, delegations storage.IDelegation, undelegations storage.IUndelegation, redelegations storage.IRedelegation, vestings storage.IVestingAccount, grants storage.IGrant, celestial celestials.ICelestial, votes storage.IVote, state storage.IState, indexerName string, ) *AddressHandler
func (*AddressHandler) Blobs ¶ added in v1.2.0
func (handler *AddressHandler) Blobs(c echo.Context) error
Blobs godoc
@Summary Get blobs pushed by address
@Description Returns a paginated list of blobs submitted via PayForBlobs transactions from the given address. Supports sorting by time or size, and optional join of transaction and namespace entities.
@Tags address
@ID address-blobs
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param sort_by query string false "Sort field. If it's empty internal id is used" Enums(time, size)
@Param joins query boolean false "Flag indicating whether entities of transaction and namespace should be attached or not. Default: true"
@Produce json
@Success 200 {array} responses.BlobLog
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/blobs [get]
func (*AddressHandler) Celestials ¶ added in v1.10.17
func (handler *AddressHandler) Celestials(c echo.Context) error
Celestials godoc
@Summary Get list of celestial id for address
@Description Returns a paginated list of Celestials NFT identities linked to the given address, including image URLs and associated metadata.
@Tags address
@ID address-celestials
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Celestial
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/celestials [get]
func (*AddressHandler) Count ¶
func (handler *AddressHandler) Count(c echo.Context) error
Count godoc
@Summary Get count of addresses in network
@Description Returns the total number of unique addresses that have ever appeared on the Celestia network, sourced from the indexer state.
@Tags address
@ID get-address-count
@Produce json
@Success 200 {integer} uint64
@Failure 500 {object} Error
@Router /address/count [get]
func (*AddressHandler) Delegations ¶ added in v1.6.0
func (handler *AddressHandler) Delegations(c echo.Context) error
Delegations godoc
@Summary Get delegations made by address
@Description Returns a paginated list of active staking delegations from the given address to validators. Use show_zero=true to include delegations with zero amount.
@Tags address
@ID address-delegations
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param show_zero query boolean false "Show zero delegations"
@Produce json
@Success 200 {array} responses.Delegation
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/delegations [get]
func (*AddressHandler) Get ¶
func (handler *AddressHandler) Get(c echo.Context) error
Get godoc
@Summary Get address info
@Description Returns detailed information about a Celestia address including balances, delegation amounts, and linked Celestial identity. Returns 204 if the address is not found.
@Tags address
@ID get-address
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Produce json
@Success 200 {object} responses.Address
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash} [get]
func (*AddressHandler) Grantee ¶ added in v1.7.0
func (handler *AddressHandler) Grantee(c echo.Context) error
Grantee godoc
@Summary Get grants where address is grantee
@Description Returns a paginated list of authz grants where the given address is the grantee — i.e., grants that other accounts have authorized to this address.
@Tags address
@ID address-grantee
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Grant
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/granters [get]
func (*AddressHandler) Grants ¶ added in v1.7.0
func (handler *AddressHandler) Grants(c echo.Context) error
Grants godoc
@Summary Get grants made by address
@Description Returns a paginated list of authz grants where the given address is the granter — i.e., grants that this address has authorized to other accounts.
@Tags address
@ID address-grants
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Grant
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/grants [get]
func (*AddressHandler) List ¶
func (handler *AddressHandler) List(c echo.Context) error
List godoc
@Summary List addresses
@Description Returns a paginated list of Celestia addresses with their balances. Supports sorting by balance fields, delegation amounts, and block activity.
@Tags address
@ID list-address
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order" Enums(asc, desc)
@Param sort_by query string false "Sort field" Enums(id, delegated, spendable, unbonding, first_height, last_height)
@Produce json
@Success 200 {array} responses.Address
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address [get]
func (*AddressHandler) Messages ¶
func (handler *AddressHandler) Messages(c echo.Context) error
Messages godoc
@Summary Get address messages
@Description Returns a paginated list of Cosmos SDK messages associated with the given address. Supports filtering by message type.
@Tags address
@ID address-messages
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order" Enums(asc, desc)
@Param msg_type query storageTypes.MsgType false "Comma-separated message types list"
@Produce json
@Success 200 {array} responses.MessageForAddress
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/messages [get]
func (*AddressHandler) Redelegations ¶ added in v1.6.0
func (handler *AddressHandler) Redelegations(c echo.Context) error
Redelegations godoc
@Summary Get redelegations made by address
@Description Returns a paginated list of redelegation records where the given address moved stake from one validator to another.
@Tags address
@ID address-redelegations
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Redelegation
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/redelegations [get]
func (*AddressHandler) Stats ¶ added in v1.7.4
func (handler *AddressHandler) Stats(c echo.Context) error
Stats godoc
@Summary Get address stats
@Description Returns a time-series histogram of per-address statistics for the selected metric (gas_used, gas_wanted, fee, or tx_count) aggregated by the given timeframe.
@Tags address
@ID address-stats
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param name path string true "Series name" Enums(gas_used, gas_wanted, fee, tx_count)
@Param timeframe path string true "Timeframe" Enums(hour, day, month)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.HistogramItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/stats/{name}/{timeframe} [get]
func (*AddressHandler) Transactions ¶
func (handler *AddressHandler) Transactions(c echo.Context) error
Transactions godoc
@Summary Get address transactions
@Description Returns a paginated list of transactions sent or signed by the given address. Supports filtering by status, message type, time range, and block height.
@Tags address
@ID address-transactions
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order" Enums(asc, desc)
@Param status query storageTypes.Status false "Comma-separated status list"
@Param msg_type query storageTypes.MsgType false "Comma-separated message types list"
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Param height query integer false "Block number" minimum(1)
@Produce json
@Success 200 {array} responses.Tx
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/txs [get]
func (*AddressHandler) Undelegations ¶ added in v1.6.0
func (handler *AddressHandler) Undelegations(c echo.Context) error
Undelegations godoc
@Summary Get undelegations made by address
@Description Returns a paginated list of pending unbonding (undelegation) records for the given address. Tokens are locked during the unbonding period before they become available.
@Tags address
@ID address-undelegations
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Undelegation
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/undelegations [get]
func (*AddressHandler) Vestings ¶ added in v1.7.0
func (handler *AddressHandler) Vestings(c echo.Context) error
Vestings godoc
@Summary Get vesting for address
@Description Returns a paginated list of vesting accounts associated with the given address. Use show_ended=true to also include vestings whose end time has already passed.
@Tags address
@ID address-vesting
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param show_ended query boolean false "Show finished vestings delegations"
@Produce json
@Success 200 {array} responses.Vesting
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/vestings [get]
func (*AddressHandler) Votes ¶ added in v1.12.0
func (handler *AddressHandler) Votes(c echo.Context) error
Votes godoc
@Summary Get list of votes for address
@Description Returns a paginated list of governance votes cast by the given address on on-chain proposals.
@Tags address
@ID address-votes
@Param hash path string true "Hash" minlength(47) maxlength(128)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Vote
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /address/{hash}/votes [get]
type BlockHandler ¶
type BlockHandler struct {
// contains filtered or unexported fields
}
func NewBlockHandler ¶
func (*BlockHandler) Blobs ¶ added in v1.3.2
func (handler *BlockHandler) Blobs(c echo.Context) error
Blobs godoc
@Summary List blobs which was pushed in the block
@Description Returns a paginated list of blobs submitted via PayForBlobs transactions included in the block at the given height. Supports sorting by time or size.
@Tags block
@ID get-block-blobs
@Param height path integer true "Block height" minimum(1)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param sort_by query string false "Sort field. If it's empty internal id is used" Enums(time, size)
@Produce json
@Success 200 {array} responses.BlobLog
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /block/{height}/blobs [get]
func (*BlockHandler) BlobsCount ¶ added in v1.3.2
func (handler *BlockHandler) BlobsCount(c echo.Context) error
BlobsCount godoc
@Summary Count of blobs which was pushed in the block
@Description Returns the total number of blobs included in the block at the given height
@Tags block
@ID block-blobs-count
@Param height path integer true "Block height" minimum(1)
@Produce json
@Success 200 {integer} uint64
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /block/{height}/blobs/count [get]
func (*BlockHandler) BlockODS ¶ added in v1.7.4
func (handler *BlockHandler) BlockODS(c echo.Context) error
BlockODS godoc
@Summary ODS for block
@Description Returns the Original Data Square (ODS) structure for the block at the given height, representing the raw data availability square layout used for blob verification.
@Tags block
@ID block-ods
@Param height path integer true "Block height" minimum(1)
@Produce json
@x-internal true
@Success 200 {object} responses.ODS
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /block/{height}/ods [get]
func (*BlockHandler) Count ¶
func (handler *BlockHandler) Count(c echo.Context) error
Count godoc
@Summary Get count of blocks in network
@Description Returns the total number of blocks indexed, including the genesis block.
@Tags block
@ID get-block-count
@Produce json
@Success 200 {integer} uint64
@Failure 500 {object} Error
@Router /block/count [get]
func (*BlockHandler) Get ¶
func (handler *BlockHandler) Get(c echo.Context) error
Get godoc
@Summary Get block info
@Description Returns detailed information about the block at the given height, including proposer, hash, time, and transaction count. Pass stats=true to also include aggregated block statistics.
@Tags block
@ID get-block
@Param height path integer true "Block height" minimum(1)
@Param stats query boolean false "Need join stats for block"
@Produce json
@Success 200 {object} responses.Block
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /block/{height} [get]
func (*BlockHandler) GetEvents ¶
func (handler *BlockHandler) GetEvents(c echo.Context) error
GetEvents godoc
@Summary Get events from begin and end of block
@Description Returns begin-block and end-block ABCI events for the block at the given height. These events are emitted by the Cosmos SDK before and after transaction execution.
@Tags block
@ID get-block-events
@Param height path integer true "Block height" minimum(1)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Event
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /block/{height}/events [get]
func (*BlockHandler) GetMessages ¶ added in v1.0.4
func (handler *BlockHandler) GetMessages(c echo.Context) error
GetMessages godoc
@Summary Get messages contained in the block
@Description Returns a paginated list of Cosmos SDK messages included in transactions within the given block. Supports filtering by message type and exclusion list.
@Tags block
@ID get-block-messages
@Param height path integer true "Block height" minimum(1)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param msg_type query types.MsgType false "Comma-separated message types list"
@Param excluded_msg_type query types.MsgType false "Comma-separated message types which should be excluded from list"
@Produce json
@Success 200 {array} responses.Message
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /block/{height}/messages [get]
func (*BlockHandler) GetStats ¶
func (handler *BlockHandler) GetStats(c echo.Context) error
GetStats godoc
@Summary Get block stats by height
@Description Returns aggregated statistics for the block at the given height: blob count, total blob size, total fee, gas used/limit, transactions count, and more.
@Tags block
@ID get-block-stats
@Param height path integer true "Block height" minimum(1)
@Produce json
@Success 200 {object} responses.BlockStats
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /block/{height}/stats [get]
func (*BlockHandler) List ¶
func (handler *BlockHandler) List(c echo.Context) error
List godoc
@Summary List blocks info
@Description Returns a paginated list of blocks. Supports ascending or descending sort by height. Pass stats=true to include aggregated statistics for each block.
@Tags block
@ID list-block
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order" Enums(asc, desc)
@Param stats query boolean false "Need join stats for block"
@Produce json
@Success 200 {array} responses.Block
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /block [get]
type CelestiaApiValidator ¶
type CelestiaApiValidator struct {
// contains filtered or unexported fields
}
func NewCelestiaApiValidator ¶
func NewCelestiaApiValidator() *CelestiaApiValidator
func (*CelestiaApiValidator) Validate ¶
func (v *CelestiaApiValidator) Validate(i interface{}) error
type ConstantHandler ¶
type ConstantHandler struct {
// contains filtered or unexported fields
}
func NewConstantHandler ¶
func NewConstantHandler( constants storage.IConstant, denomMetadata storage.IDenomMetadata, rollup storage.IRollup, ) *ConstantHandler
func (*ConstantHandler) Enums ¶ added in v1.1.3
func (handler *ConstantHandler) Enums(c echo.Context) error
Enums godoc
@Summary Get celenium enumerators
@Description Returns all enumeration values used across the API, including rollup tags, categories, stacks, providers, message types, and other typed string constants.
@Tags general
@ID get-enums
@Produce json
@Success 200 {object} responses.Enums
@Router /enums [get]
func (*ConstantHandler) Get ¶
func (handler *ConstantHandler) Get(c echo.Context) error
Get godoc
@Summary Get network constants
@Description Returns all on-chain governance and module parameters for the Celestia network, including staking, slashing, blob, and other module constants, along with denomination metadata.
@Tags general
@ID get-constants
@Produce json
@Success 200 {object} responses.Constants
@Success 204
@Failure 500 {object} Error
@Router /constants [get]
type ForwardingsHandler ¶ added in v1.18.13
type ForwardingsHandler struct {
// contains filtered or unexported fields
}
ForwardingsHandler -
func NewForwardingsHandler ¶ added in v1.18.13
func NewForwardingsHandler( forwardings storage.IForwarding, address storage.IAddress, txs storage.ITx, chainStore hyperlane.IChainStore, ) ForwardingsHandler
func (*ForwardingsHandler) Get ¶ added in v1.18.13
func (handler *ForwardingsHandler) Get(c echo.Context) error
Get godoc
@Summary Get forwarding event by ID
@Description Returns a single forwarding event by its internal ID. The response includes details about
@Description the cross-domain token transfer such as destination domain, destination address,
@Description forwarding address, success/failed counts, and the list of individual transfers.
@Tags forwarding
@ID get-forwarding
@Param id path integer true "Internal forwarding event ID" minimum(1)
@Produce json
@Success 200 {object} responses.Forwarding
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /forwarding/{id} [get]
func (*ForwardingsHandler) List ¶ added in v1.18.13
func (handler *ForwardingsHandler) List(c echo.Context) error
List godoc
@Summary List forwarding events
@Description Returns a paginated list of forwarding events. Forwarding events represent cross-domain token transfers
@Description where tokens are forwarded from a Celestia address to a destination address on another domain.
@Description Results can be filtered by transaction hash, address, or block height.
@Tags forwarding
@ID list-forwarding
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset for pagination" minimum(0)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param tx_hash query string false "Filter by transaction hash (hex)" minlength(64) maxlength(64)
@Param address query string false "Filter by Celestia address" minlength(47) maxlength(47)
@Param height query integer false "Filter by block height" minimum(1)
@Param from query integer false "Filter by start time (Unix timestamp)" minimum(1)
@Param to query integer false "Filter by end time (Unix timestamp)" minimum(1)
@Produce json
@Success 200 {array} responses.Forwarding
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /forwarding [get]
type GasHandler ¶ added in v1.1.0
type GasHandler struct {
// contains filtered or unexported fields
}
GasHandler -
func NewGasHandler ¶ added in v1.1.0
func (GasHandler) EstimateForPfb ¶ added in v1.1.0
func (handler GasHandler) EstimateForPfb(c echo.Context) error
EstimateForPfb godoc
@Summary Get estimated gas for pay for blob
@Description Returns the estimated gas required to submit a MsgPayForBlobs transaction for the given blob sizes and share versions, using current on-chain gas parameters.
@Tags gas
@ID gas-estimate-for-pfb
@Param sizes query string true "Comma-separated array of blob sizes"
@Param versions query string false "Comma-separated array of share versions. Default is 0"
@Produce json
@Success 200 {object} uint64
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /gas/estimate_for_pfb [get]
func (GasHandler) EstimatePrice ¶ added in v1.1.0
func (handler GasHandler) EstimatePrice(c echo.Context) error
EstimatePrice godoc
@Summary Get estimated gas price
@Description Returns estimated gas prices (slow, median, fast) derived from recent transaction history. Useful for setting the gas price when submitting new transactions.
@Tags gas
@ID gas-price
@Produce json
@Success 200 {object} responses.GasPrice
@Router /gas/price [get]
func (GasHandler) EstimatePricePriority ¶ added in v1.11.0
func (handler GasHandler) EstimatePricePriority(c echo.Context) error
EstimatePricePriority godoc
@Summary Get estimated gas price with priority filter
@Description Returns a single estimated gas price string for the selected priority level (slow, median, or fast) based on recent transaction history.
@Tags gas
@ID gas-price-priority
@Param priority path string true "Priority" Enums(slow, median, fast)
@Produce json
@Success 200 {string} string
@Router /gas/price/{priority} [get]
type HyperlaneHandler ¶ added in v1.15.0
type HyperlaneHandler struct {
// contains filtered or unexported fields
}
func NewHyperlaneHandler ¶ added in v1.15.0
func NewHyperlaneHandler( mailbox storage.IHLMailbox, tokens storage.IHLToken, transfers storage.IHLTransfer, txs storage.ITx, address storage.IAddress, igp storage.IHLIGP, chainStore hyperlane.IChainStore, ) *HyperlaneHandler
func (*HyperlaneHandler) GetIgp ¶ added in v1.17.0
func (handler *HyperlaneHandler) GetIgp(c echo.Context) error
GetIgp godoc
@Summary Get IGP by id
@Description Returns a single Hyperlane Interchain Gas Paymaster (IGP) by its hexadecimal identity, including its owner and destination gas configs.
@Tags hyperlane
@ID get-hyperlane-igp
@Param id path integer true "Internal identity" minimum(1)
@Produce json
@Success 200 {object} responses.HyperlaneIgp
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/igp/{id} [get]
func (*HyperlaneHandler) GetMailbox ¶ added in v1.15.0
func (handler *HyperlaneHandler) GetMailbox(c echo.Context) error
GetMailbox godoc
@Summary Get hyperlane mailbox info
@Description Returns detailed information about a Hyperlane mailbox identified by its hexadecimal identity, including its domain, owner, and linked token/ISM counts.
@Tags hyperlane
@ID get-hyperlane-mailbox
@Param id path string true "Hyperlane mailbox id"
@Produce json
@Success 200 {object} responses.HyperlaneMailbox
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/mailbox/{id} [get]
func (*HyperlaneHandler) GetToken ¶ added in v1.15.0
func (handler *HyperlaneHandler) GetToken(c echo.Context) error
GetToken godoc
@Summary Get hyperlane token info
@Description Returns detailed information about a Hyperlane token (synthetic or collateral) identified by its hexadecimal identity, including owner, mailbox, and token type.
@Tags hyperlane
@ID get-hyperlane-token
@Param id path string true "Hyperlane token id"
@Produce json
@Success 200 {object} responses.HyperlaneToken
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/token/{id} [get]
func (*HyperlaneHandler) GetTransfer ¶ added in v1.15.22
func (handler *HyperlaneHandler) GetTransfer(c echo.Context) error
GetTransfer godoc
@Summary Get transfer by id
@Description Returns a single Hyperlane cross-chain token transfer by its internal id, including source/destination domain, amount, and associated transaction.
@Tags hyperlane
@ID get-hyperlane-transfer
@Param id path integer true "Internal identity" minimum(1)
@Produce json
@Success 200 {object} responses.HyperlaneTransfer
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/transfer/{id} [get]
func (*HyperlaneHandler) ListDomains ¶ added in v1.15.23
func (handler *HyperlaneHandler) ListDomains(c echo.Context) error
ListDomains godoc
@Summary List hyperlane domains info
@Description Returns metadata for all known Hyperlane domains (counterparty chains), keyed by domain ID. Each entry contains the chain name, logo, and domain identifier.
@Tags hyperlane
@ID list-hyperlane-domains
@Produce json
@Success 200 {array} responses.DomainMetadata
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/domains [get]
func (*HyperlaneHandler) ListIgps ¶ added in v1.17.0
func (handler *HyperlaneHandler) ListIgps(c echo.Context) error
ListIgps godoc
@Summary List hyperlane Interchain Gas Paymaster (IGP)
@Description Returns a paginated list of Hyperlane Interchain Gas Paymasters (IGPs) indexed on Celestia. IGPs allow message senders to pay for destination chain gas fees from the origin chain.
@Tags hyperlane
@ID list-hyperlane-igps
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Produce json
@Success 200 {array} responses.HyperlaneIgp
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/igp [get]
func (*HyperlaneHandler) ListMailboxes ¶ added in v1.15.0
func (handler *HyperlaneHandler) ListMailboxes(c echo.Context) error
ListMailboxes godoc
@Summary List hyperlane mailboxes info
@Description Returns a paginated list of all Hyperlane mailboxes indexed on Celestia, each identified by a hexadecimal identity.
@Tags hyperlane
@ID list-hyperlane-mailbox
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.HyperlaneMailbox
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/mailbox [get]
func (*HyperlaneHandler) ListTokens ¶ added in v1.15.0
func (handler *HyperlaneHandler) ListTokens(c echo.Context) error
ListTokens godoc
@Summary List hyperlane tokens info
@Description Returns a paginated list of Hyperlane tokens indexed on Celestia. Supports filtering by owner address, mailbox identity, and token type (synthetic or collateral).
@Tags hyperlane
@ID list-hyperlane-tokens
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param owner query string false "Owner celestia address" minlength(47) maxlength(47)
@Param mailbox query string false "Mailbox hexademical identity"
@Param type query string false "Comma-separated string of tokens type" Enums(synthetic, collateral)
@Produce json
@Success 200 {array} responses.HyperlaneToken
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/token [get]
func (*HyperlaneHandler) ListTransfers ¶ added in v1.15.0
func (handler *HyperlaneHandler) ListTransfers(c echo.Context) error
ListTransfers godoc
@Summary List hyperlane transfers info
@Description Returns a paginated list of Hyperlane cross-chain token transfers. Supports filtering by sender/receiver address, relayer, mailbox, token, transfer type (send/receive), domain, and transaction hash.
@Tags hyperlane
@ID list-hyperlane-transfers
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param address query string false "Celestia address" minlength(47) maxlength(47)
@Param relayer query string false "Celestia address of relayer" minlength(47) maxlength(47)
@Param mailbox query string false "Mailbox hexademical identity"
@Param token query string false "Token hexademical identity"
@Param type query string false "Comma-separated string of transfer type" Enums(send, receive)
@Param domain query integer false "Domain of counterparty chain" minimum(1)
@Param hash query string false "Transaction hash in hexadecimal" minlength(64) maxlength(64)
@Produce json
@Success 200 {array} responses.HyperlaneTransfer
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/transfer [get]
type IbcHandler ¶ added in v1.13.0
type IbcHandler struct {
// contains filtered or unexported fields
}
func NewIbcHandler ¶ added in v1.13.0
func NewIbcHandler( clients storage.IIbcClient, conns storage.IIbcConnection, channels storage.IIbcChannel, transfers storage.IIbcTransfer, address storage.IAddress, txs storage.ITx, store ibc_relayer.IRelayerStore, ) *IbcHandler
func (*IbcHandler) Get ¶ added in v1.13.0
func (handler *IbcHandler) Get(c echo.Context) error
Get godoc
@Summary Get ibc client info
@Description Returns information about an IBC light client identified by its client ID, including the counterparty chain ID, client state type, and trusting period.
@Tags ibc
@ID get-ibc-client
@Param id path string true "IBC client id"
@Produce json
@Success 200 {object} responses.IbcClient
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /ibc/client/{id} [get]
func (*IbcHandler) GetChannel ¶ added in v1.13.0
func (handler *IbcHandler) GetChannel(c echo.Context) error
GetChannel godoc
@Summary Get ibc channel info
@Description Returns information about an IBC channel by its channel ID, including ordering, state, connection, and counterparty port/channel.
@Tags ibc
@ID get-ibc-channel
@Param id path string true "IBC channel id"
@Produce json
@Success 200 {object} responses.IbcChannel
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /ibc/channel/{id} [get]
func (*IbcHandler) GetConnection ¶ added in v1.13.0
func (handler *IbcHandler) GetConnection(c echo.Context) error
GetConnection godoc
@Summary Get ibc connection info
@Description Returns information about an IBC connection identified by its connection ID, including linked client ID and counterparty connection details.
@Tags ibc
@ID get-ibc-conn
@Param id path string true "IBC connection id"
@Produce json
@Success 200 {object} responses.IbcConnection
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /ibc/connection/{id} [get]
func (*IbcHandler) GetIbcTransfer ¶ added in v1.15.22
func (handler *IbcHandler) GetIbcTransfer(c echo.Context) error
GetIbcTransfer godoc
@Summary Get transfer by id
@Description Returns a single IBC token transfer by its internal id, including sender, receiver, amount, denom, and transaction reference.
@Tags ibc
@ID get-ibc-transfer
@Param id path integer true "Internal identity" minimum(1)
@Produce json
@Success 200 {object} responses.IbcTransfer
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /ibc/transfer/{id} [get]
func (*IbcHandler) IbcRelayers ¶ added in v1.15.28
func (handler *IbcHandler) IbcRelayers(c echo.Context) error
IbcRelayers godoc
@Summary List ibc relayers
@Description Returns the list of known IBC relayers with their Celestia address and associated chain metadata, sourced from the static relayer registry.
@Tags ibc
@ID get-ibc-relayers
@Produce json
@Success 200 {array} responses.Relayer
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /ibc/relayers [get]
func (*IbcHandler) List ¶ added in v1.13.0
func (handler *IbcHandler) List(c echo.Context) error
List godoc
@Summary Get ibc clients info
@Description Returns a paginated list of IBC light clients. Supports filtering by chain ID and creator address.
@Tags ibc
@ID get-ibc-clients
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param chain_id query string false "Chain id"
@Param creator query string false "Creator address" minlength(47) maxlength(47)
@Produce json
@Success 200 {array} responses.IbcClient
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /ibc/client [get]
func (*IbcHandler) ListChannels ¶ added in v1.13.0
func (handler *IbcHandler) ListChannels(c echo.Context) error
ListChannels godoc
@Summary Get ibc channels info
@Description Returns a paginated list of IBC channels. Supports filtering by client ID, connection ID, and channel status (initialization, opened, closed).
@Tags ibc
@ID get-ibc-channels
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param client_id query string false "Client id"
@Param connection_id query string false "Connection id"
@Param status query string false "Channel status" Enums(initialization, opened, closed)
@Produce json
@Success 200 {array} responses.IbcChannel
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /ibc/channel [get]
func (*IbcHandler) ListConnections ¶ added in v1.13.0
func (handler *IbcHandler) ListConnections(c echo.Context) error
ListConnections godoc
@Summary Get ibc connections info
@Description Returns a paginated list of IBC connections. Supports filtering by client ID.
@Tags ibc
@ID get-ibc-conns
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param client_id query string false "Client id"
@Produce json
@Success 200 {array} responses.IbcConnection
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /ibc/connection [get]
func (*IbcHandler) ListTransfers ¶ added in v1.13.0
func (handler *IbcHandler) ListTransfers(c echo.Context) error
ListTransfers godoc
@Summary Get ibc transfers info
@Description Returns a paginated list of IBC token transfers. Supports filtering by channel, chain ID, sender, receiver, either-party address, and transaction hash.
@Tags ibc
@ID get-ibc-transfers
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param channel_id query string false "Channel id"
@Param chain_id query string false "Chain id"
@Param receiver query string false "Receiver address" minlength(47) maxlength(47)
@Param sender query string false "Sender address" minlength(47) maxlength(47)
@Param address query string false "Address: receiver or sender" minlength(47) maxlength(47)
@Param hash query string false "Transaction hash in hexadecimal" minlength(64) maxlength(64)
@Produce json
@Success 200 {array} responses.IbcTransfer
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /ibc/transfer [get]
type MsgTypeArray ¶
type MsgTypeArray StringArray
type NamespaceHandler ¶
type NamespaceHandler struct {
// contains filtered or unexported fields
}
func NewNamespaceHandler ¶
func (*NamespaceHandler) Blob ¶ added in v1.1.2
func (handler *NamespaceHandler) Blob(c echo.Context) error
Blob godoc
@Summary Get namespace blob by commitment on height
@Description Returns the raw blob data from the Celestia DA layer for the given block height, namespace hash, and commitment. Requires API key authorization.
@Tags namespace
@ID get-blob
@Param request body postBlobRequest true "Request body containing height, commitment and namespace hash"
@Accept json
@Produce json
@Success 200 {object} responses.Blob
@Failure 400 {object} Error
@Router /blob [post]
@securityDefinitions.apikey ApiKeyAuth
@in header
@name apikey
@description To authorize your requests you have to select the required tariff on our site. Then you receive api key to authorize. Api key should be passed via request header `apikey`.
func (*NamespaceHandler) BlobMetadata ¶ added in v1.8.1
func (handler *NamespaceHandler) BlobMetadata(c echo.Context) error
BlobMetadata godoc
@Summary Get blob metadata by commitment on height
@Description Returns indexed metadata for a blob (namespace, size, signer, share version, etc.) identified by block height, namespace hash, and commitment. Does not return raw blob data.
@Tags namespace
@ID get-blob-metadata
@Param request body postBlobRequest true "Request body containing height, commitment and namespace hash"
@Accept json
@Produce json
@Success 200 {object} responses.BlobLog
@Failure 400 {object} Error
@Router /blob/metadata [post]
@securityDefinitions.apikey ApiKeyAuth
@in header
@name apikey
@description To authorize your requests you have to select the required tariff on our site. Then you receive api key to authorize. Api key should be passed via request header `apikey`.
func (*NamespaceHandler) BlobProofs ¶ added in v1.10.10
func (handler *NamespaceHandler) BlobProofs(c echo.Context) error
BlobProofs godoc
@Summary Get blob inclusion proofs
@Description Returns NMT inclusion proofs for a blob identified by block height, namespace hash, and commitment. Proofs can be used to verify that the blob is included in the block's data square.
@Tags namespace
@ID get-blob-proof
@Param request body postBlobRequest true "Request body containing height, commitment and namespace hash"
@Accept json
@Produce json
@Success 200 {object} responses.BlobLog
@Failure 400 {object} Error
@Router /blob/proofs [post]
func (*NamespaceHandler) Blobs ¶ added in v1.10.0
func (handler *NamespaceHandler) Blobs(c echo.Context) error
Blobs godoc
@Summary List all blobs with filters
@Description Returns a paginated list of blob log entries across all namespaces. Supports filtering by commitment, time range, signer addresses, and namespace identifiers. Cursor-based pagination is available via the cursor parameter.
@Tags namespace
@ID get-blobs
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param sort_by query string false "Sort field. If it's empty internal id is used" Enums(time, size)
@Param commitment query string false "Commitment value in URLbase64 format"
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Param signers query string false "Comma-separated celestia addresses"
@Param namespaces query string false "Comma-separated celestia namespaces"
@Param cursor query integer false "Last entity id which is used for cursor pagination" minimum(1)
@Accept json
@Produce json
@Success 200 {array} responses.LightBlobLog
@Failure 400 {object} Error
@Router /blob [get]
func (*NamespaceHandler) Get ¶
func (handler *NamespaceHandler) Get(c echo.Context) error
Get godoc
@Summary Get namespace info
@Description Returns all versions of the namespace identified by the given 28-byte hex namespace id. Each namespace version is returned as a separate entry.
@Tags namespace
@ID get-namespace
@Param id path string true "Namespace id in hexadecimal" minlength(56) maxlength(56)
@Produce json
@Success 200 {array} responses.Namespace
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /namespace/{id} [get]
func (*NamespaceHandler) GetBlobLogs ¶ added in v1.2.0
func (handler *NamespaceHandler) GetBlobLogs(c echo.Context) error
GetBlobLogs godoc
@Summary Get blob changes for namespace
@Description Returns a paginated list of blob log entries for the specified namespace version. Supports filtering by commitment, time range, signer addresses, and cursor-based pagination.
@Tags namespace
@ID get-blob-logs
@Param id path string true "Namespace id in hexadecimal" minlength(56) maxlength(56)
@Param version path integer true "Version of namespace"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param sort_by query string false "Sort field. If it's empty internal id is used" Enums(time, size)
@Param commitment query string false "Commitment value in URLbase64 format"
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Param joins query boolean false "Flag indicating whether entities of rollup, transaction and signer should be attached or not. Default: true"
@Param signers query string false "Comma-separated celestia addresses"
@Param cursor query integer false "Last entity id which is used for cursor pagination" minimum(1)
@Produce json
@Success 200 {array} responses.BlobLog
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /namespace/{id}/{version}/blobs [get]
func (*NamespaceHandler) GetBlobs ¶
func (handler *NamespaceHandler) GetBlobs(c echo.Context) error
GetBlobs godoc
@Summary Get namespace blobs on height
@Description Returns all blobs submitted to the given namespace (identified by base64-encoded hash) at the specified block height, fetched directly from the DA node.
@Tags namespace
@ID get-namespace-blobs
@Param hash path string true "Base64-encoded namespace id and version"
@Param height path integer true "Block height" minimum(1)
@Produce json
@Success 200 {array} responses.Blob
@Failure 400 {object} Error
@Router /namespace_by_hash/{hash}/{height} [get]
func (*NamespaceHandler) GetByHash ¶
func (handler *NamespaceHandler) GetByHash(c echo.Context) error
GetByHash godoc
@Summary Get namespace info by base64
@Description Returns namespace details for the given base64-encoded namespace identity (version byte + namespace id). Returns 204 if the namespace is not found.
@Tags namespace
@ID get-namespace-base64
@Param hash path string true "Base64-encoded namespace id and version"
@Produce json
@Success 200 {object} responses.Namespace
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /namespace_by_hash/{hash} [get]
func (*NamespaceHandler) GetMessages ¶
func (handler *NamespaceHandler) GetMessages(c echo.Context) error
GetMessages godoc
@Summary Get namespace messages by id and version
@Description Returns a paginated list of Cosmos SDK messages (e.g. MsgPayForBlobs) that referenced this namespace, identified by version byte and namespace id.
@Tags namespace
@ID get-namespace-messages
@Param id path string true "Namespace id in hexadecimal" minlength(56) maxlength(56)
@Param version path integer true "Version of namespace"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.NamespaceMessage
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /namespace/{id}/{version}/messages [get]
func (*NamespaceHandler) GetWithVersion ¶
func (handler *NamespaceHandler) GetWithVersion(c echo.Context) error
GetWithVersion godoc
@Summary Get namespace info by id and version
@Description Returns namespace details for the specific combination of namespace id (28 hex bytes) and version byte. Returns 204 if the namespace is not found.
@Tags namespace
@ID get-namespace-by-version-and-id
@Param id path string true "Namespace id in hexadecimal" minlength(56) maxlength(56)
@Param version path integer true "Version of namespace"
@Produce json
@Success 200 {object} responses.Namespace
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /namespace/{id}/{version} [get]
func (*NamespaceHandler) List ¶
func (handler *NamespaceHandler) List(c echo.Context) error
List godoc
@Summary List namespace info
@Description Returns a paginated list of namespaces. Supports sorting by creation time, PayForBlobs count, or total blob size.
@Tags namespace
@ID list-namespace
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param sort_by query string false "Sort field. If it's empty internal id is used" Enums(time, pfb_count, size)
@Produce json
@Success 200 {array} responses.Namespace
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /namespace [get]
func (*NamespaceHandler) Rollups ¶ added in v1.5.0
func (handler *NamespaceHandler) Rollups(c echo.Context) error
Rollups godoc
@Summary List rollups using the namespace
@Description Returns a paginated list of rollups that have submitted blobs to the given namespace (identified by hex id and version).
@Tags namespace
@ID get-namespace-rollups
@Param id path string true "Namespace id in hexadecimal" minlength(56) maxlength(56)
@Param version path integer true "Version of namespace"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Rollup
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /namespace/{id}/{version}/rollups [get]
type ProposalsHandler ¶ added in v1.12.0
type ProposalsHandler struct {
// contains filtered or unexported fields
}
ProposalsHandler -
func NewProposalsHandler ¶ added in v1.12.0
func NewProposalsHandler( proposals storage.IProposal, votes storage.IVote, address storage.IAddress, validators storage.IValidator, ) ProposalsHandler
func (*ProposalsHandler) Get ¶ added in v1.12.0
func (handler *ProposalsHandler) Get(c echo.Context) error
Get godoc
@Summary Get proposal info
@Description Returns detailed information about a single governance proposal by its internal ID, including proposer, status, votes summary, and deposit information.
@Tags proposal
@ID get-proposal
@Param id path integer true "Internal identity" minimum(1)
@Produce json
@Success 200 {object} responses.Proposal
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /proposal/{id} [get]
func (*ProposalsHandler) List ¶ added in v1.12.0
func (handler *ProposalsHandler) List(c echo.Context) error
List godoc
@Summary List proposal info
@Description Returns a paginated list of governance proposals. Supports filtering by proposer address, status, and type.
@Tags proposal
@ID list-proposal
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param proposer query string false "Proposer celestia address" minlength(47) maxlength(47)
@Param status query string false "Comma-separated proposal status list"
@Param type query string false "Comma-separated proposal type list"
@Produce json
@Success 200 {array} responses.Proposal
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /proposal [get]
func (*ProposalsHandler) Votes ¶ added in v1.12.0
func (handler *ProposalsHandler) Votes(c echo.Context) error
Votes godoc
@Summary Get proposal's votes @Description Returns a paginated list of governance votes for the given proposal. Can be filtered by vote option (yes/no/no_with_veto/abstain), voter type (address or validator), and specific voter address. @Tags proposal @ID proposal-votes @Param id path integer true "Internal identity" minimum(1) @Param limit query integer false "Count of requested entities" minimum(1) maximum(100) @Param offset query integer false "Offset" minimum(1)
@Param option query string false "Option" Enums(yes, no, no_with_veto, abstain) @Param voter query string false "Voter type" Enums(address, validator) @Param address query string false "Voter address" minlength(47) maxlength(47) @Param validator query string false "Voter address" minlength(54) maxlength(54)
@Produce json
@Success 200 {array} responses.Vote
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /proposal/{id}/votes [get]
type RollupHandler ¶ added in v1.2.0
type RollupHandler struct {
// contains filtered or unexported fields
}
func NewRollupHandler ¶ added in v1.2.0
func NewRollupHandler( rollups storage.IRollup, providers storage.IRollupProvider, namespace storage.INamespace, blobs storage.IBlobLog, ) RollupHandler
func (RollupHandler) AllSeries ¶ added in v1.9.10
func (handler RollupHandler) AllSeries(c echo.Context) error
AllSeries godoc
@Summary Get series for all rollups
@Description Returns time-series data for all rollups combined, grouped by the selected timeframe. Useful for rendering aggregate charts showing total DA usage across all indexed rollups.
@Tags rollup
@ID get-rollup-all-series
@Param timeframe path string true "Timeframe" Enums(hour, day, month)
@Produce json
@Success 200 {array} responses.RollupAllSeriesResponse
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/stats/series/{timeframe} [get]
func (RollupHandler) BySlug ¶ added in v1.4.0
func (handler RollupHandler) BySlug(c echo.Context) error
BySlug godoc
@Summary Get rollup by slug
@Description Returns rollup information by its human-readable slug identifier (e.g. "eclipse"). Returns 204 if no rollup with the given slug is found.
@Tags rollup
@ID get-rollup-by-slug
@Param slug path string true "Slug"
@Produce json
@Success 200 {object} responses.Rollup
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/slug/{slug} [get]
func (RollupHandler) Count ¶ added in v1.3.2
func (handler RollupHandler) Count(c echo.Context) error
Count godoc
@Summary Get count of rollups in network
@Description Returns the total number of rollups indexed in the Celenium database.
@Tags rollup
@ID get-rollups-count
@Produce json
@Success 200 {integer} uint64
@Failure 500 {object} Error
@Router /rollup/count [get]
func (RollupHandler) Distribution ¶ added in v1.6.1
func (handler RollupHandler) Distribution(c echo.Context) error
Distribution godoc
@Summary Get rollup distribution
@Description Returns the intra-timeframe distribution (e.g. by hour-of-day) for the selected rollup metric, useful for identifying activity patterns.
@Tags rollup
@ID get-rollup-distribution
@Param id path integer true "Internal identity" minimum(1)
@Param name path string true "Series name" Enums(blobs_count, size, size_per_blob, fee_per_blob)
@Param timeframe path string true "Timeframe" Enums(hour, day)
@Produce json
@Success 200 {array} responses.DistributionItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/{id}/distribution/{name}/{timeframe} [get]
func (RollupHandler) ExportBlobs ¶ added in v1.7.0
func (handler RollupHandler) ExportBlobs(c echo.Context) error
ExportBlobs godoc
@Summary Export rollup blobs
@Description Streams a plain-text export of blob metadata submitted by the rollup, optionally filtered by a time range. The response is streamed line by line.
@Tags rollup
@ID rollup-export
@Param id path integer true "Internal identity" minimum(1)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Success 200
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/{id}/export [get]
func (RollupHandler) Get ¶ added in v1.2.0
func (handler RollupHandler) Get(c echo.Context) error
Get godoc
@Summary Get rollup info
@Description Returns detailed information and cumulative statistics for the rollup identified by its internal id, including name, description, social links, namespaces, and providers.
@Tags rollup
@ID get-rollup
@Param id path integer true "Internal identity" minimum(1)
@Produce json
@Success 200 {object} responses.Rollup
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/{id} [get]
func (RollupHandler) GetBlobs ¶ added in v1.2.0
func (handler RollupHandler) GetBlobs(c echo.Context) error
GetBlobs godoc
@Summary Get rollup blobs
@Description Returns a paginated list of blobs submitted by the rollup. Supports sorting by time or size and optionally joining transaction and signer entities.
@Tags rollup
@ID get-rollup-blobs
@Param id path integer true "Internal identity" minimum(1)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param sort_by query string false "Sort field. If it's empty internal id is used" Enums(time, size)
@Param joins query boolean false "Flag indicating whether entities of transaction and signer should be attached or not. Default: true"
@Produce json
@Success 200 {array} responses.BlobLog
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/{id}/blobs [get]
func (RollupHandler) GetNamespaces ¶ added in v1.2.0
func (handler RollupHandler) GetNamespaces(c echo.Context) error
GetNamespaces godoc
@Summary Get rollup namespaces info
@Description Returns a paginated list of namespaces that the rollup has submitted blobs to.
@Tags rollup
@ID get-rollup-namespaces
@Param id path integer true "Internal identity" minimum(1)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Namespace
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/{id}/namespaces [get]
func (RollupHandler) GetProviders ¶ added in v1.17.1
func (handler RollupHandler) GetProviders(c echo.Context) error
GetProviders godoc
@Summary Get rollup providers info
@Description Returns a list of data availability providers associated with the rollup (e.g. Celestia addresses used for blob submission).
@Tags rollup
@ID get-rollup-providers
@Param id path integer true "Internal identity" minimum(1)
@Produce json
@Success 200 {array} responses.RollupProvider
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/{id}/providers [get]
func (RollupHandler) Leaderboard ¶ added in v1.2.0
func (handler RollupHandler) Leaderboard(c echo.Context) error
Leaderboard godoc
@Summary List rollups info
@Description Returns a paginated leaderboard of rollups with their cumulative statistics. Supports filtering by category, tags, stack, and provider. Sorting by blob count, total size, or fee.
@Tags rollup
@ID list-rollup
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param sort_by query string false "Sort field. Default: size" Enums(time, blobs_count, size, fee)
@Param category query string false "Comma-separated rollup category list"
@Param tags query string false "Comma-separated rollup tags list"
@Param stack query string false "Comma-separated rollup stack list"
@Param provider query string false "Comma-separated rollup provider list"
@Param is_active query boolean false "If true, shows rollups with activity over the last month"
@Produce json
@Success 200 {array} responses.RollupWithStats
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup [get]
func (RollupHandler) LeaderboardDay ¶ added in v1.9.10
func (handler RollupHandler) LeaderboardDay(c echo.Context) error
LeaderboardDay godoc
@Summary List rollups info with stats by previous 24 hours
@Description Returns a paginated leaderboard of rollups with statistics aggregated over the previous 24 hours. Useful for ranking rollups by recent activity such as throughput, blob count, or fee.
@Tags rollup
@ID list-rollup-24h
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param sort_by query string false "Sort field. Default: mb_price" Enums(avg_size, blobs_count, total_size, total_fee, throughput, namespace_count, pfb_count, mb_price)
@Param category query string false "Comma-separated rollup category list"
@Param tags query string false "Comma-separated rollup tags list"
@Param stack query string false "Comma-separated rollup stack list"
@Param provider query string false "Comma-separated rollup provider list"
@Produce json
@Success 200 {array} responses.RollupWithDayStats
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/day [get]
func (RollupHandler) RollupGroupedStats ¶ added in v1.10.8
func (handler RollupHandler) RollupGroupedStats(c echo.Context) error
RollupGroupedStats godoc
@Summary Rollup Grouped Statistics
@Description Returns rollup statistics aggregated by the selected column (stack, type, category, vm, or provider), using the chosen aggregate function (sum or avg).
@Tags rollup
@ID rollup-grouped-statistics
@Param func query string false "Aggregate function" Enums(sum, avg)
@Param column query string false "Group column" Enums(stack, type, category, vm, provider)
@Produce json
@Success 200 {array} responses.RollupGroupedStats
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/group [get]
func (RollupHandler) Stats ¶ added in v1.2.0
func (handler RollupHandler) Stats(c echo.Context) error
Stats godoc
@Summary Get rollup stats
@Description Returns a time-series histogram for the rollup with the selected metric (blobs_count, size, size_per_blob, or fee) aggregated by the given timeframe.
@Tags rollup
@ID get-rollup-stats
@Param id path integer true "Internal identity" minimum(1)
@Param name path string true "Series name" Enums(blobs_count, size, size_per_blob, fee)
@Param timeframe path string true "Timeframe" Enums(hour, day, month)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.HistogramItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /rollup/{id}/stats/{name}/{timeframe} [get]
type SearchHandler ¶
type SearchHandler struct {
// contains filtered or unexported fields
}
func NewSearchHandler ¶
func NewSearchHandler( search storage.ISearch, address storage.IAddress, block storage.IBlock, tx storage.ITx, namespace storage.INamespace, validator storage.IValidator, rollup storage.IRollup, celestials celestials.ICelestial, ) SearchHandler
func (SearchHandler) Search ¶
func (handler SearchHandler) Search(c echo.Context) error
Search godoc
@Summary Search by hash
@Description.markdown search
@Tags search
@ID search
@Param query query string true "Search string"
@Produce json
@Success 200 {array} responses.SearchItem
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /search [get]
type SignalHandler ¶ added in v1.15.28
type SignalHandler struct {
// contains filtered or unexported fields
}
func NewSignalHandler ¶ added in v1.15.28
func NewSignalHandler( signals storage.ISignalVersion, upgrades storage.IUpgrade, validator storage.IValidator, tx storage.ITx, address storage.IAddress, ) *SignalHandler
func (*SignalHandler) List ¶ added in v1.15.28
func (handler *SignalHandler) List(c echo.Context) error
List godoc
@Summary List signals
@Description Returns a paginated list of validator upgrade signals (MsgSignalVersion messages) indicating readiness to upgrade to a new software version. Supports filtering by version, validator, transaction hash, and time range.
@Tags signal
@ID list-signal
@Param version query integer false "Version"
@Param validator_id query integer false "Validator internal id"
@Param tx_hash query string false "Transaction hash"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Produce json
@Success 200 {array} responses.SignalVersion
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /signal [get]
func (*SignalHandler) Upgrade ¶ added in v1.17.2
func (handler *SignalHandler) Upgrade(c echo.Context) error
Upgrade godoc
@Summary Get upgrade by version
@Description Returns details of the on-chain network upgrade for the given software version number, including the activation block height and quorum of signals received.
@Tags signal
@ID get-upgrade
@Param version path integer true "Upgrade version"
@Produce json
@Success 200 {object} responses.Upgrade
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /signal/upgrade/{version} [get]
func (*SignalHandler) Upgrades ¶ added in v1.15.28
func (handler *SignalHandler) Upgrades(c echo.Context) error
Upgrades godoc
@Summary List upgrades
@Description Returns a paginated list of on-chain network upgrades that were activated. Supports filtering by block height, transaction hash, and signer address.
@Tags signal
@ID list-upgrades
@Param height query integer false "Number of block"
@Param tx_hash query string false "Transaction hash"
@Param signer query string false "Signer address"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Produce json
@Success 200 {array} responses.Upgrade
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /signal/upgrade [get]
type StateHandler ¶
type StateHandler struct {
// contains filtered or unexported fields
}
func NewStateHandler ¶
func NewStateHandler(state storage.IState, validator storage.IValidator, constants storage.IConstant, indexerName string) *StateHandler
func (*StateHandler) Head ¶
func (sh *StateHandler) Head(c echo.Context) error
Head godoc
@Summary Get current indexer head
@Description Returns the current indexer state: the last indexed block height, total accounts, total blobs size, total voting power, and other network-wide counters.
@Tags general
@ID head
@Produce json
@Success 200 {object} responses.State
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /head [get]
type StatsHandler ¶
type StatsHandler struct {
// contains filtered or unexported fields
}
func NewStatsHandler ¶
func NewStatsHandler( repo storage.IStats, nsRepo storage.INamespace, ibc storage.IIbcTransfer, ibcChannels storage.IIbcChannel, hyperlane storage.IHLTransfer, chainStore hyperlane.IChainStore, state storage.IState, ) StatsHandler
func (StatsHandler) Change24hBlockStats ¶ added in v1.9.7
func (sh StatsHandler) Change24hBlockStats(c echo.Context) error
Change24hBlockStats godoc
@Summary Get changes for 24 hours
@Description Returns comparative statistics showing how key block metrics (blob size, tx count, fee, block time) changed over the last 24 hours versus the prior 24 hours.
@Tags stats
@ID stats-24h-changes
@Produce json
@Success 200 {array} responses.Change24hBlockStats
@Failure 500 {object} Error
@Router /stats/changes_24h [get]
func (StatsHandler) HlByDomain ¶ added in v1.15.23
func (sh StatsHandler) HlByDomain(c echo.Context) error
HlByDomain godoc
@Summary Get stats for hyperlane transfers splitted by domain
@Description Returns a paginated list of Hyperlane transfer statistics grouped by counterparty domain (chain), including transfer count and total volume.
@Tags stats
@ID stats-hl-domains
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.HlDomainStats
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/hyperlane/chains [get]
func (StatsHandler) HlSeries ¶ added in v1.15.23
func (sh StatsHandler) HlSeries(c echo.Context) error
HlSeries godoc
@Summary Get histogram for hyperlane domains with precomputed stats
@Description Returns a time-series histogram of Hyperlane transfer statistics (count or amount) for the specified domain, filtered by timeframe and optional time range.
@Tags stats
@ID stats-hl-series
@Param id path integer true "Domain id"
@Param timeframe path string true "Timeframe" Enums(hour, day, month)
@Param name path string true "Series name" Enums(count, amount)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.HistogramItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/hyperlane/series/{id}/{name}/{timeframe} [get]
func (StatsHandler) HlTotalSeries ¶ added in v1.15.25
func (sh StatsHandler) HlTotalSeries(c echo.Context) error
HlTotalSeries godoc
@Summary Get histogram for aggregated hyperlane domains with precomputed stats
@Description Returns a time-series histogram of aggregated Hyperlane transfer statistics (count or amount) across all domains, filtered by timeframe and optional time range.
@Tags stats
@ID stats-hl-total-series
@Param timeframe path string true "Timeframe" Enums(hour, day, month)
@Param name path string true "Series name" Enums(count, amount)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.HistogramItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/hyperlane/chains/{name}/{timeframe} [get]
func (StatsHandler) IbcByChains ¶ added in v1.13.0
func (sh StatsHandler) IbcByChains(c echo.Context) error
IbcByChains godoc
@Summary Get stats for ibc channels splitted by chains
@Description Returns a paginated list of IBC transfer statistics grouped by counterparty chain, including total transfer count, volume, and active channels.
@Tags stats
@ID stats-ibc-chains
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.IbcChainStats
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/ibc/chains [get]
func (StatsHandler) IbcSeries ¶ added in v1.13.0
func (sh StatsHandler) IbcSeries(c echo.Context) error
IbcSeries godoc
@Summary Get histogram for ibc channels with precomputed stats
@Description Returns a time-series histogram of IBC transfer statistics (count or amount) for the specified channel, filtered by timeframe and optional time range.
@Tags stats
@ID stats-ibc-series
@Param id path string true "Channel id"
@Param timeframe path string true "Timeframe" Enums(hour, day, month)
@Param name path string true "Series name" Enums(count, amount)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.HistogramItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/ibc/series/{id}/{name}/{timeframe} [get]
func (StatsHandler) IbcSummary ¶ added in v1.15.21
func (sh StatsHandler) IbcSummary(c echo.Context) error
IbcSummary godoc
@Summary Get stats for ibc the largest transfer and busiest channel per day
@Description Returns a summary of IBC activity over the last 24 hours: the single largest token transfer and the most active (busiest) IBC channel by transfer count.
@Tags stats
@ID stats-ibc-summary
@Produce json
@Success 200 {array} responses.IbcSummaryStats
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/ibc/summary [get]
func (StatsHandler) MessagesCount24h ¶ added in v1.9.7
func (sh StatsHandler) MessagesCount24h(c echo.Context) error
MessagesCount24h godoc
@Summary Get messages distribution for the last 24 hours
@Description Returns the count of each Cosmos SDK message type observed in the last 24 hours, useful for understanding network activity composition.
@Tags stats
@ID stats-messages-count-24h
@Produce json
@Success 200 {array} responses.CountItem
@Failure 500 {object} Error
@Router /stats/messages_count_24h [get]
func (StatsHandler) NamespaceSeries ¶ added in v1.1.0
func (sh StatsHandler) NamespaceSeries(c echo.Context) error
NamespaceSeries godoc
@Summary Get histogram for namespace with precomputed stats
@Description Returns a time-series histogram of precomputed blob statistics (pfb_count or size) for the specified namespace, filtered by timeframe and optional time range.
@Tags stats
@ID stats-ns-series
@Param id path string true "Namespace id in hexadecimal" minlength(56) maxlength(56)
@Param timeframe path string true "Timeframe" Enums(hour, day, week, month, year)
@Param name path string true "Series name" Enums(pfb_count, size)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.SeriesItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/namespace/series/{id}/{name}/{timeframe} [get]
func (StatsHandler) NamespaceUsage ¶ added in v1.1.0
func (sh StatsHandler) NamespaceUsage(c echo.Context) error
NamespaceUsage godoc
@Summary Get namespaces with sorting by size.
@Description Returns the top N namespaces sorted by total blob size in descending order. Namespaces outside the top N are aggregated into a single 'others' entry showing the remaining total size.
@Tags stats
@ID stats-namespace-usage
@Param top query integer false "Count of entities" minimum(1) maximum(100)
@Produce json
@Success 200 {array} responses.NamespaceUsage
@Failure 500 {object} Error
@Router /stats/namespace/usage [get]
func (StatsHandler) RollupStats24h ¶ added in v1.9.7
func (sh StatsHandler) RollupStats24h(c echo.Context) error
RollupStats24h godoc
@Summary Get rollups stats for last 24 hours
@Description Returns aggregated rollup statistics for the previous 24 hours: total blobs, total size, total fee, and throughput across all indexed rollups.
@Tags stats
@ID stats-rollup-24h
@Produce json
@Success 200 {array} responses.RollupStats24h
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/rollup_stats_24h [get]
func (StatsHandler) Series ¶ added in v1.1.0
func (sh StatsHandler) Series(c echo.Context) error
Series godoc
@Summary Get histogram with precomputed stats
@Description Returns a time-series histogram of precomputed network statistics for the selected metric and timeframe. Supports filtering by time range.
@Tags stats
@ID stats-series
@Param timeframe path string true "Timeframe" Enums(hour, day, week, month, year)
@Param name path string true "Series name" Enums(blobs_size, blobs_count, tps, bps, fee, supply_change, block_time, tx_count, events_count, gas_price, gas_efficiency, gas_used, gas_limit, bytes_in_block, rewards, commissions)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.SeriesItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/series/{name}/{timeframe} [get]
func (StatsHandler) SeriesCumulative ¶ added in v1.9.1
func (sh StatsHandler) SeriesCumulative(c echo.Context) error
SeriesCumulative godoc
@Summary Get cumulative histogram with precomputed stats
@Description Returns a running total (cumulative sum) time-series of the selected network metric for the given timeframe. Useful for tracking all-time growth trends.
@Tags stats
@ID stats-series-cumulative
@Param timeframe path string true "Timeframe" Enums(hour, day, week, month, year)
@Param name path string true "Series name" Enums(blobs_size, blobs_count, fee, tx_count, gas_used, gas_limit, bytes_in_block, supply_change)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.SeriesItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/series/{name}/{timeframe}/cumulative [get]
func (StatsHandler) SizeGroups ¶ added in v1.11.3
func (sh StatsHandler) SizeGroups(c echo.Context) error
SizeGroups godoc
@Summary Get blobs count grouped by size
@Description Returns the distribution of blobs across predefined size buckets (e.g. <1KB, 1-16KB, 16-256KB, etc.), showing how many blobs fall into each size group.
@Tags stats
@ID stats-size-groups
@Produce json
@Success 200 {array} responses.SizeGroup
@Failure 500 {object} Error
@Router /stats/size_groups [get]
func (StatsHandler) SquareSize ¶ added in v1.9.6
func (sh StatsHandler) SquareSize(c echo.Context) error
SquareSize godoc
@Summary Get histogram for square size distribution
@Description Returns the frequency distribution of data availability square sizes (number of rows/columns) used across blocks in the selected time range.
@Tags stats
@ID stats-square-size
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.SquareSizeResponse
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/square_size [get]
func (StatsHandler) StakingDistribution ¶ added in v1.17.0
func (sh StatsHandler) StakingDistribution(c echo.Context) error
StakingDistribution godoc
@Summary Get histogram for staking
@Description Returns the distribution of delegated stake across validators grouped by delegation size buckets, useful for understanding stake concentration over the selected time range.
@Tags stats
@ID stats-staking-distribution
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {object} responses.StakingDistribution
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/staking/distribution [get]
func (StatsHandler) StakingSeries ¶ added in v1.6.0
func (sh StatsHandler) StakingSeries(c echo.Context) error
StakingSeries godoc
@Summary Get histogram for staking with precomputed stats
@Description Returns a time-series histogram of staking metrics (rewards, commissions, delegation flows, etc.) for the specified validator and timeframe.
@Tags stats
@ID stats-staking-series
@Param id path string true "Validator id" minlength(56) maxlength(56)
@Param timeframe path string true "Timeframe" Enums(hour, day, month)
@Param name path string true "Series name" Enums(rewards, commissions, flow, delegations, unbondings, delegations_count, unbondings_count, cumulative_flow)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.SeriesItem
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/staking/series/{id}/{name}/{timeframe} [get]
func (StatsHandler) Summary ¶
func (sh StatsHandler) Summary(c echo.Context) error
Summary godoc
@Summary Get value by table and function
@Description.markdown summary
@Tags stats
@ID stats-summary
@Param table path string true "Table name" Enums(block, block_stats, tx, event, message, validator)
@Param function path string true "Function name" Enums(min, max, avg, sum, count)
@Param column query string false "Column name which will be used for computation. Optional for count."
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {object} string
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /stats/summary/{table}/{function} [get]
func (StatsHandler) TPS ¶ added in v1.1.0
func (sh StatsHandler) TPS(c echo.Context) error
TPS godoc
@Summary Get tps
@Description Returns transaction per seconds statistics
@Tags stats
@ID stats-tps
@x-internal true
@Produce json
@Success 200 {object} responses.TPS
@Failure 500 {object} Error
@Router /stats/tps [get]
type StatusArray ¶
type StatusArray StringArray
type StringArray ¶
type StringArray []string
func (*StringArray) UnmarshalParam ¶
func (s *StringArray) UnmarshalParam(param string) error
type TxHandler ¶
type TxHandler struct {
// contains filtered or unexported fields
}
func NewTxHandler ¶
func (*TxHandler) Blobs ¶ added in v1.3.2
Blobs godoc
@Summary List blobs which was pushed by transaction
@Description Returns a paginated list of blobs submitted via the PayForBlobs message in the given transaction. Supports sorting by time or blob size.
@Tags transactions
@ID list-transaction-blobs
@Param hash path string true "Transaction hash in hexadecimal" minlength(64) maxlength(64)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param sort_by query string false "Sort field. If it's empty internal id is used" Enums(time, size)
@Produce json
@Success 200 {array} responses.BlobLog
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /tx/{hash}/blobs [get]
func (*TxHandler) BlobsCount ¶ added in v1.3.2
BlobsCount godoc
@Summary Count of blobs which was pushed by transaction
@Description Returns the total number of blobs submitted via the PayForBlobs message in the given transaction.
@Tags transactions
@ID transaction-blobs-count
@Param hash path string true "Transaction hash in hexadecimal" minlength(64) maxlength(64)
@Produce json
@Success 200 {integer} uint64
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /tx/{hash}/blobs/count [get]
func (*TxHandler) Count ¶
Count godoc
@Summary Get count of transactions in network
@Description Returns the total number of transactions indexed, sourced from the current indexer state.
@Tags transactions
@ID get-transactions-count
@Produce json
@Success 200 {integer} uint64
@Failure 500 {object} Error
@Router /tx/count [get]
func (*TxHandler) Genesis ¶
Genesis godoc
@Summary List genesis transactions info
@Description Returns a paginated list of transactions included in the genesis block (block 0). These are the initial state transactions that bootstrapped the chain.
@Tags transactions
@ID list-genesis-transactions
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order" Enums(asc, desc)
@Produce json
@Success 200 {array} responses.Tx
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /tx/genesis [get]
func (*TxHandler) Get ¶
Get godoc
@Summary Get transaction by hash
@Description Returns detailed information about a transaction identified by its hexadecimal hash, including status, gas, fees, and signer. Returns 204 if the transaction is not found.
@Tags transactions
@ID get-transaction
@Param hash path string true "Transaction hash in hexadecimal" minlength(64) maxlength(64)
@Produce json
@Success 200 {object} responses.Tx
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /tx/{hash} [get]
func (*TxHandler) GetEvents ¶
GetEvents godoc
@Summary Get transaction events
@Description Returns a paginated list of ABCI events emitted during transaction execution for the given transaction hash.
@Tags transactions
@ID get-transaction-events
@Param hash path string true "Transaction hash in hexadecimal" minlength(64) maxlength(64)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Event
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /tx/{hash}/events [get]
func (*TxHandler) GetMessages ¶
GetMessages godoc
@Summary Get transaction messages
@Description Returns a paginated list of Cosmos SDK messages contained in the transaction identified by the given hash.
@Tags transactions
@ID get-transaction-messages
@Param hash path string true "Transaction hash in hexadecimal" minlength(64) maxlength(64)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Message
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /tx/{hash}/messages [get]
func (*TxHandler) List ¶
List godoc
@Summary List transactions info
@Description Returns a paginated list of transactions. Supports filtering by status, message type, time range, and block height. Pass messages=true to include message details in each result.
@Tags transactions
@ID list-transactions
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order" Enums(asc, desc)
@Param status query types.Status false "Comma-separated status list"
@Param msg_type query types.MsgType false "Comma-separated message types list"
@Param excluded_msg_type query types.MsgType false "Comma-separated message types list which should be excluded"
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Param height query integer false "Block number" minimum(1)
@Param messages query boolean false "If true join messages"
@Produce json
@Success 200 {array} responses.Tx
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /tx [get]
type ValidatorHandler ¶ added in v1.1.0
type ValidatorHandler struct {
// contains filtered or unexported fields
}
func NewValidatorHandler ¶ added in v1.1.0
func NewValidatorHandler( validators storage.IValidator, blocks storage.IBlock, blockSignatures storage.IBlockSignature, delegations storage.IDelegation, constants storage.IConstant, jails storage.IJail, votes storage.IVote, state storage.IState, indexerName string, ) *ValidatorHandler
func (*ValidatorHandler) Blocks ¶ added in v1.4.0
func (handler *ValidatorHandler) Blocks(c echo.Context) error
Blocks godoc
@Summary Get blocks which was proposed by validator
@Description Returns a paginated list of blocks proposed by the given validator.
@Tags validator
@ID get-validator-blocks
@Param id path integer true "Internal validator id"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Block
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/{id}/blocks [get]
func (*ValidatorHandler) Count ¶ added in v1.6.0
func (handler *ValidatorHandler) Count(c echo.Context) error
Count godoc
@Summary Get validator's count by status
@Description Returns the total validator count broken down by status: total, active, jailed, and inactive.
@Tags validator
@ID validator-count
@Produce json
@Success 200 {object} responses.ValidatorCount
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/count [get]
func (*ValidatorHandler) Delegators ¶ added in v1.6.0
func (handler *ValidatorHandler) Delegators(c echo.Context) error
Delegators godoc
@Summary Get validator's delegators
@Description Returns a paginated list of delegators staking with this validator, including their delegated amounts. Pass show_zero=true to include delegators with zero balance.
@Tags validator
@ID validator-delegators
@Param id path integer true "Internal validator id"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param show_zero query boolean false "Show zero delegations"
@Produce json
@Success 200 {array} responses.Delegation
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/{id}/delegators [get]
func (*ValidatorHandler) Get ¶ added in v1.1.0
func (handler *ValidatorHandler) Get(c echo.Context) error
Get godoc
@Summary Get validator info
@Description Returns detailed information about a validator by internal id, including moniker, consensus address, voting power, commission rates, and current status.
@Tags validator
@ID get-validator
@Param id path integer true "Internal validator id"
@Produce json
@Success 200 {object} responses.Validator
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/{id} [get]
func (*ValidatorHandler) Jails ¶ added in v1.6.0
func (handler *ValidatorHandler) Jails(c echo.Context) error
Jails godoc
@Summary Get validator's jails
@Description Returns a paginated list of jail events for this validator, including the jail reason and block height at which each jail occurred.
@Tags validator
@ID validator-jails
@Param id path integer true "Internal validator id"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Jail
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/{id}/jails [get]
func (*ValidatorHandler) List ¶ added in v1.1.0
func (handler *ValidatorHandler) List(c echo.Context) error
List godoc
@Summary List validators
@Description Returns a paginated list of validators ordered by voting power. Supports filtering by jailed status and app version.
@Tags validator
@ID list-validator
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(0)
@Param jailed query boolean false "Return only jailed validators"
@Param version query integer false "Current validator app version" minimum(0)
@Produce json
@Success 200 {array} responses.Validator
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators [get]
func (*ValidatorHandler) Messages ¶ added in v1.16.0
func (handler *ValidatorHandler) Messages(c echo.Context) error
Messages godoc
@Summary Get validator messages
@Description Returns a paginated list of messages submitted by the validator's operator address, filterable by time range.
@Tags validator
@ID validator-messages
@Param id path integer true "Internal validator id"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Param sort query string false "Sort order" Enums(asc, desc)
@Param from query integer false "Time from in unix timestamp" minimum(1)
@Param to query integer false "Time to in unix timestamp" minimum(1)
@Produce json
@Success 200 {array} responses.Message
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/{id}/messages [get]
func (*ValidatorHandler) Metrics ¶ added in v1.17.1
func (handler *ValidatorHandler) Metrics(c echo.Context) error
Metrics godoc
@Summary Get validator's metrics
@Description Returns performance metrics for a single validator including uptime, missed blocks, and block signing efficiency.
@Tags validator
@ID validator-metrics
@Param id path integer true "Internal validator id"
@Produce json
@Success 200 {object} responses.Metrics
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/{id}/metrics [get]
func (*ValidatorHandler) TopNMetrics ¶ added in v1.17.1
func (handler *ValidatorHandler) TopNMetrics(c echo.Context) error
TopNMetrics godoc
@Summary Get validators metrics
@Description Returns aggregated performance metrics for the top N validators by voting power, useful for comparing signing efficiency across the active set.
@Tags validator
@ID validators-metrics
@Param count query integer false "Count of aggregated entities"
@Produce json
@Success 200 {object} responses.TopNMetrics
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/metrics [get]
func (*ValidatorHandler) Uptime ¶ added in v1.4.0
func (handler *ValidatorHandler) Uptime(c echo.Context) error
Uptime godoc
@Summary Get validator's uptime and history of signed block
@Description Returns the validator's uptime percentage and a history of the last N blocks indicating whether each was signed.
@Tags validator
@ID get-validator-uptime
@Param id path integer true "Internal validator id"
@Param limit query integer false "Count of requested blocks" minimum(1) maximum(100)
@Produce json
@Success 200 {object} responses.ValidatorUptime
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/{id}/uptime [get]
func (*ValidatorHandler) Votes ¶ added in v1.12.0
func (handler *ValidatorHandler) Votes(c echo.Context) error
Votes godoc
@Summary Get list of votes for validator
@Description Returns a paginated list of governance votes cast by this validator on on-chain proposals.
@Tags validator
@ID validator-votes
@Param id path integer true "Internal validator id"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {array} responses.Vote
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /validators/{id}/votes [get]
type VestingHandler ¶ added in v1.7.0
type VestingHandler struct {
// contains filtered or unexported fields
}
func NewVestingHandler ¶ added in v1.7.0
func NewVestingHandler(vestings storage.IVestingPeriod) *VestingHandler
func (*VestingHandler) Periods ¶ added in v1.7.0
func (handler *VestingHandler) Periods(c echo.Context) error
Periods godoc
@Summary Get vesting periods by id
@Description Returns vesting periods by vesting id. Returns a non-empty array only for periodic vestings.
@Tags vesting
@ID get-vesting-periods
@Param id path integer true "Internal identity"
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset" minimum(1)
@Produce json
@Success 200 {object} responses.VestingPeriod
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /vesting/{id}/periods [get]
type ZkISMHandler ¶ added in v1.18.13
type ZkISMHandler struct {
// contains filtered or unexported fields
}
func NewZkISMHandler ¶ added in v1.18.13
func (*ZkISMHandler) Get ¶ added in v1.18.13
func (h *ZkISMHandler) Get(c echo.Context) error
Get godoc
@Summary Get ZK ISM by id
@Description Returns a single ZK Interchain Security Module by its internal id. The response includes
@Description the current trusted state, state root, merkle tree address, and verifier key commitments
@Description used for ZK proof verification.
@Tags hyperlane
@ID get-zkism
@Param id path integer true "Internal ZK ISM identity" minimum(1)
@Produce json
@Success 200 {object} responses.ZkISM
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/zkism/{id} [get]
func (*ZkISMHandler) GetMessages ¶ added in v1.18.13
func (h *ZkISMHandler) GetMessages(c echo.Context) error
GetMessages godoc
@Summary Get ZK ISM authorized messages
@Description Returns the list of Hyperlane messages that were authorized via a given ZK ISM through
@Description MsgSubmitMessages transactions. Each entry contains the message id, state root used for
@Description the membership proof, and the signer who submitted the authorization. Results can be
@Description filtered by signer address, transaction hash, or time range.
@Tags hyperlane
@ID get-zkism-messages
@Param id path integer true "Internal ZK ISM identity" minimum(1)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset for pagination" minimum(0)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param tx_hash query string false "Filter by transaction hash (hex)" minlength(64) maxlength(64)
@Param address query string false "Filter by signer Celestia address" minlength(47) maxlength(47)
@Param from query integer false "Filter by start time (Unix timestamp)" minimum(1)
@Param to query integer false "Filter by end time (Unix timestamp)" minimum(1)
@Produce json
@Success 200 {array} responses.ZkISMMessage
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/zkism/{id}/messages [get]
func (*ZkISMHandler) GetUpdates ¶ added in v1.18.13
func (h *ZkISMHandler) GetUpdates(c echo.Context) error
GetUpdates godoc
@Summary Get ZK ISM state update history
@Description Returns the history of state updates for a given ZK ISM. Each update corresponds to a
@Description MsgUpdateInterchainSecurityModule transaction that advanced the trusted state of the ISM
@Description via a Groth16 state-transition ZK proof. Results can be filtered by signer address,
@Description transaction hash, or time range.
@Tags hyperlane
@ID get-zkism-updates
@Param id path integer true "Internal ZK ISM identity" minimum(1)
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset for pagination" minimum(0)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param tx_hash query string false "Filter by transaction hash (hex)" minlength(64) maxlength(64)
@Param address query string false "Filter by signer Celestia address" minlength(47) maxlength(47)
@Param from query integer false "Filter by start time (Unix timestamp)" minimum(1)
@Param to query integer false "Filter by end time (Unix timestamp)" minimum(1)
@Produce json
@Success 200 {array} responses.ZkISMUpdate
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/zkism/{id}/updates [get]
func (*ZkISMHandler) List ¶ added in v1.18.13
func (h *ZkISMHandler) List(c echo.Context) error
List godoc
@Summary List ZK Interchain Security Modules
@Description Returns a paginated list of ZK Interchain Security Modules (ZK ISMs). ZK ISMs use
@Description Groth16 zero-knowledge proofs to trustlessly verify cross-chain messages from external
@Description chains. Results can be filtered by transaction hash or creator address.
@Tags hyperlane
@ID list-zkism
@Param limit query integer false "Count of requested entities" minimum(1) maximum(100)
@Param offset query integer false "Offset for pagination" minimum(0)
@Param sort query string false "Sort order. Default: desc" Enums(asc, desc)
@Param tx_hash query string false "Filter by transaction hash (hex)" minlength(64) maxlength(64)
@Param address query string false "Filter by creator Celestia address" minlength(47) maxlength(47)
@Produce json
@Success 200 {array} responses.ZkISM
@Success 204
@Failure 400 {object} Error
@Failure 500 {object} Error
@Router /hyperlane/zkism [get]