README
¶
covalent-indexer-go
Covalent indexer acts as an extra proxy layer over Multiversx' Proxy by providing avro encoded hyper blocks.
How it works
- Covalent proxy hyperBlock request is triggered(e.g.:
http://127.0.0.1:7952/hyperblock/by-nonce/37). - Covalent proxy will interrogate the backing Multiversx proxy via REST API to fetch requested hyperBlock using query
parameters defined in the config(
cmd/proxy/config.toml). - Received data from Multiversx proxy will be converted to defined avro schema (
schema/block.multiversx.avsc) - Covalent proxy response will have the following format (compatible with Multiversx proxy API responses):
{
"data": {},
"error": "",
"code": "successful"
}
Data field contains a byte array corresponding to the encoded avro schema.
How to use
- Go to
cmd/proxy - Build
go build - Run
./proxy
In cmd/proxy/config.toml one can find:
- Multiversx & Covalent proxy configuration(e.g.
port,multiversxProxyUrl, etc.) hyperBlockQueryOptionsused to format hyperblock queries for Multiversx proxy. E.g.: following Covalent request:localhost:port/hyperblock/by-nonce/4, havingwithAlteredAccounts = trueandtokens = allwill trigger the following request :multiversxProxy:port/hyperblock/by-nonce/4?withAlteredAccounts=true&tokens=all
Please note that altered-accounts endpoints will only work if the backing observers of the Multiversx Proxy have support for historical balances (--operation-mode historical-balances when starting the node)
Endpoints
/hyperblock/by-nonce/:nonce(GET) --> returns a hyperblock by nonce, with transactions included/hyperblock/by-hash/:hash(GET) --> returns a hyperblock by hash, with transactions included/hyperblocks?startNonce=4&endNonce=8(GET) --> returns an array of encoded hyperblocks in[startNonce, endNonce]interval
Avro schema update
In case you want to modify the existing avro schema, after finishing your changes, you need to re-generate the corresponding code, by:
- Running
go generatefromschema/codegen.go
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrBlockBodyAssertion = errors.New("error asserting BodyHandler interface of type block body")
ErrBlockBodyAssertion signals that an error occurred when trying to assert BodyHandler interface of type block body
var ErrCannotCastAccountHandlerToUserAccount = errors.New("cannot cast AccountHandler to UserAccountHandler")
ErrCannotCastAccountHandlerToUserAccount signals an error when trying to cast from AccountHandler to UserAccountHandler
var ErrNilAccountsAdapter = errors.New("received nil input value: accounts adapter")
ErrNilAccountsAdapter signals that an accounts adapter input parameter is nil
var ErrNilHasher = errors.New("received nil input value: hasher")
ErrNilHasher signals that a nil hasher has been provided
var ErrNilMarshaller = errors.New("received nil input value: marshaller")
ErrNilMarshaller signals that a nil marshaller has been provided
var ErrNilMiniBlockHandler = errors.New("received nil input value: mini block handler")
ErrNilMiniBlockHandler signals that a nil mini block handler has been provided
var ErrNilPubKeyConverter = errors.New("received nil input value: pub key converter")
ErrNilPubKeyConverter signals that a pub key converter input parameter is nil
var ErrNilShardCoordinator = errors.New("received nil input value: shard coordinator")
ErrNilShardCoordinator signals that a shard coordinator input parameter is nil
Functions ¶
This section is empty.
Types ¶
type AvroMarshaller ¶
type AvroMarshaller interface {
Encode(record avro.AvroRecord) ([]byte, error)
Decode(record avro.AvroRecord, buffer []byte) error
}
AvroMarshaller defines what an avro marshaller should do
type HyperBlockProcessor ¶
type HyperBlockProcessor interface {
Process(hyperBlock *hyperBlock.HyperBlock) (*schema.HyperBlock, error)
}
HyperBlockProcessor shall handle hyper block processing into avro schema blocks
Source Files
Directories