api

Jan 8, 2025

Changes in this version

type Config

+ ReadyDuration time.Duration

type CoreService

+ FeeHistory func(ctx context.Context, blocks, lastBlock uint64, rewardPercentiles []float64) (uint64, [][]*big.Int, []*big.Int, []float64, []*big.Int, []float64, error)

Oct 28, 2024

Changes in this version

type Option

+ func WithSGDIndexer(sgdIndexer blockindex.SGDRegistry) Option

Oct 19, 2024

Changes in this version

+ var DefaultConfig = Config

+ var ErrNotFound = errors.New("not found")

+ func NewChainListener(c int) apitypes.Listener

+ func NewGRPCBlockListener(handler streamHandler, errChan chan error) apitypes.Responder

+ func NewGRPCLogListener(in *logfilter.LogFilter, handler streamHandler, errChan chan error) apitypes.Responder

+ func NewWeb3BlockListener(handler streamHandler) apitypes.Responder

+ func NewWeb3LogListener(filter *logfilter.LogFilter, handler streamHandler) apitypes.Responder

+ func RecoveryInterceptor() grpc_recovery.Option

+ func WithStreamContext(ctx context.Context) context.Context

+ type BroadcastOutbound func(ctx context.Context, chainID uint32, msg proto.Message) error

+ type Config struct

+ BatchRequestLimit int

+ GRPCPort int

+ GasStation gasstation.Config

+ HTTPPort int

+ ListenerLimit int

+ RangeQueryLimit uint64

+ RedisCacheURL string

+ TpsWindow int

+ Tracer tracer.Config

+ UseRDS bool

+ WebSocketPort int

+ WebsocketRateLimit int

+ type CoreService interface

+ Account func(addr address.Address) (*iotextypes.AccountMeta, *iotextypes.BlockIdentifier, error)

+ Action func(actionHash string, checkPending bool) (*iotexapi.ActionInfo, error)

+ ActionByActionHash func(h hash.Hash256) (*action.SealedEnvelope, *block.Block, uint32, error)

+ Actions func(start uint64, count uint64) ([]*iotexapi.ActionInfo, error)

+ ActionsByAddress func(addr address.Address, start uint64, count uint64) ([]*iotexapi.ActionInfo, error)

+ ActionsInActPool func(actHashes []string) ([]*action.SealedEnvelope, error)

+ BlobSidecarsByHeight func(height uint64) ([]*apitypes.BlobSidecarResult, error)

+ BlockByHash func(string) (*apitypes.BlockWithReceipts, error)

+ BlockByHeight func(uint64) (*apitypes.BlockWithReceipts, error)

+ BlockByHeightRange func(uint64, uint64) ([]*apitypes.BlockWithReceipts, error)

+ BlockHashByBlockHeight func(blkHeight uint64) (hash.Hash256, error)

+ ChainID func() uint32

+ ChainListener func() apitypes.Listener

+ ChainMeta func() (*iotextypes.ChainMeta, string, error)

+ EVMNetworkID func() uint32

+ ElectionBuckets func(epochNum uint64) ([]*iotextypes.ElectionBucket, error)

+ EpochMeta func(epochNum uint64) (*iotextypes.EpochData, uint64, []*iotexapi.BlockProducerInfo, error)

+ EstimateExecutionGasConsumption func(ctx context.Context, sc action.Envelope, callerAddr address.Address, ...) (uint64, error)

+ EstimateGasForAction func(ctx context.Context, in *iotextypes.Action) (uint64, error)

+ EstimateGasForNonExecution func(action.Action) (uint64, error)

+ EstimateMigrateStakeGasConsumption func(context.Context, *action.MigrateStake, address.Address) (uint64, error)

+ Genesis func() genesis.Genesis

+ LogsInBlockByHash func(filter *logfilter.LogFilter, blockHash hash.Hash256) ([]*action.Log, error)

+ LogsInRange func(filter *logfilter.LogFilter, start, end, paginationSize uint64) ([]*action.Log, []hash.Hash256, error)

+ PendingActionByActionHash func(h hash.Hash256) (*action.SealedEnvelope, error)

+ PendingNonce func(address.Address) (uint64, error)

+ RawBlocks func(startHeight uint64, count uint64, withReceipts bool, withTransactionLogs bool) ([]*iotexapi.BlockInfo, error)

+ ReadContract func(ctx context.Context, callerAddr address.Address, sc action.Envelope) (string, *iotextypes.Receipt, error)

+ ReadContractStorage func(ctx context.Context, addr address.Address, key []byte) ([]byte, error)

+ ReadState func(protocolID string, height string, methodName []byte, arguments [][]byte) (*iotexapi.ReadStateResponse, error)

+ ReceiptByActionHash func(h hash.Hash256) (*action.Receipt, error)

+ ReceiveBlock func(blk *block.Block) error

+ SendAction func(ctx context.Context, in *iotextypes.Action) (string, error)

+ ServerMeta func() (packageVersion string, packageCommitID string, gitStatus string, ...)

+ SimulateExecution func(context.Context, address.Address, action.Envelope) ([]byte, *action.Receipt, error)

+ Start func(ctx context.Context) error

+ Stop func(ctx context.Context) error

+ SuggestGasPrice func() (uint64, error)

+ SuggestGasTipCap func() (*big.Int, error)

+ SyncingProgress func() (uint64, uint64, uint64)

+ TipHeight func() uint64

+ TraceCall func(ctx context.Context, callerAddr address.Address, blkNumOrHash any, ...) ([]byte, *action.Receipt, any, error)

+ TraceTransaction func(ctx context.Context, actHash string, config *tracers.TraceConfig) ([]byte, *action.Receipt, any, error)

+ Track func(ctx context.Context, start time.Time, method string, size int64, success bool)

+ TransactionLogByActionHash func(actHash string) (*iotextypes.TransactionLog, error)

+ TransactionLogByBlockHeight func(blockHeight uint64) (*iotextypes.BlockIdentifier, *iotextypes.TransactionLogs, error)

+ UnconfirmedActionsByAddress func(address string, start uint64, count uint64) ([]*iotexapi.ActionInfo, error)

+ type GRPCServer struct

+ func NewGRPCServer(core CoreService, grpcPort int) *GRPCServer

+ func (grpc *GRPCServer) Start(_ context.Context) error

+ func (grpc *GRPCServer) Stop(_ context.Context) error

+ type HTTPServer struct

+ func NewHTTPServer(route string, port int, handler http.Handler) *HTTPServer

+ func (hSvr *HTTPServer) Start(_ context.Context) error

+ func (hSvr *HTTPServer) Stop(ctx context.Context) error

+ type Option func(cfg *coreService)

+ func WithAPIStats(stats *nodestats.APILocalStats) Option

+ func WithBroadcastOutbound(broadcastHandler BroadcastOutbound) Option

+ func WithNativeElection(committee committee.Committee) Option

+ type ReadCache struct

+ func NewReadCache() *ReadCache

+ func (rc *ReadCache) Clear()

+ func (rc *ReadCache) Get(key hash.Hash160) ([]byte, bool)

+ func (rc *ReadCache) Put(key hash.Hash160, value []byte)

+ type ReadKey struct

+ Args [][]byte

+ Height string

+ Method []byte

+ Name string

+ func (k *ReadKey) Hash() hash.Hash160

+ type ServerV2 struct

+ func NewServerV2(cfg Config, chain blockchain.Blockchain, bs blocksync.BlockSync, ...) (*ServerV2, error)

+ func (svr *ServerV2) CoreService() CoreService

+ func (svr *ServerV2) ReceiveBlock(blk *block.Block) error

+ func (svr *ServerV2) Start(ctx context.Context) error

+ func (svr *ServerV2) Stop(ctx context.Context) error

+ type StreamBlocksServer interface

+ Send func(*iotexapi.StreamBlocksResponse) error

+ type StreamContext struct

+ func StreamFromContext(ctx context.Context) (*StreamContext, bool)

+ func (sc *StreamContext) AddListener(id string)

+ func (sc *StreamContext) ListenerIDs() []string

+ func (sc *StreamContext) RemoveListener(id string)

+ type Web3Handler interface

+ HandlePOSTReq func(context.Context, io.Reader, apitypes.Web3ResponseWriter) error

+ func NewWeb3Handler(core CoreService, cacheURL string, batchRequestLimit int) Web3Handler

+ type WebsocketHandler struct

+ func NewWebsocketHandler(coreService CoreService, web3Handler Web3Handler, limiter *rate.Limiter) *WebsocketHandler

+ func (wsSvr *WebsocketHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)