types

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 26, 2023 License: Apache-2.0 Imports: 23 Imported by: 2

Documentation

Overview

Package types is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	// ModuleName defines the module name
	ModuleName = "monitor"

	// StoreKey defines the primary module store key
	StoreKey = ModuleName

	// RouterKey is the message route for slashing
	RouterKey = ModuleName

	// QuerierRoute defines the module's query routing key
	QuerierRoute = ModuleName

	// MemStoreKey defines the in-memory store key
	MemStoreKey = "mem_monitor"
)
View Source
const DefaultIndex uint64 = 1

DefaultIndex is the default capability global index

Variables

View Source
var (
	ErrEpochNotEnded         = errorsmod.Register(ModuleName, 1100, "Epoch not ended yet")
	ErrCheckpointNotReported = errorsmod.Register(ModuleName, 1101, "Checkpoint not reported yet")
)

x/monitor module sentinel errors

View Source
var (
	ErrInvalidLengthGenesis        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenesis          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupGenesis = fmt.Errorf("proto: unexpected end of group")
)
View Source
var (
	EpochEndLightClientHeightPrefix           = []byte{1}
	CheckpointReportedLightClientHeightPrefix = []byte{2}
)
View Source
var (
	ErrInvalidLengthQuery        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowQuery          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupQuery = fmt.Errorf("proto: unexpected end of group")
)

Functions

func GetCheckpointReportedLightClientHeightKey

func GetCheckpointReportedLightClientHeightKey(hashString string) ([]byte, error)

func GetEpochEndLightClientHeightKey

func GetEpochEndLightClientHeightKey(e uint64) []byte

func KeyPrefix

func KeyPrefix(p string) []byte

func RegisterQueryHandler

func RegisterQueryHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterQueryHandler registers the http handlers for service Query to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterQueryHandlerClient

func RegisterQueryHandlerClient(ctx context.Context, mux *runtime.ServeMux, client QueryClient) error

RegisterQueryHandlerClient registers the http handlers for service Query to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "QueryClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "QueryClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "QueryClient" to call the correct interceptors.

func RegisterQueryHandlerFromEndpoint

func RegisterQueryHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterQueryHandlerServer

func RegisterQueryHandlerServer(ctx context.Context, mux *runtime.ServeMux, server QueryServer) error

RegisterQueryHandlerServer registers the http handlers for service Query to "mux". UnaryRPC :call QueryServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterQueryHandlerFromEndpoint instead.

func RegisterQueryServer

func RegisterQueryServer(s grpc1.Server, srv QueryServer)

Types

type AccountKeeper

type AccountKeeper interface {
	GetAccount(ctx sdk.Context, addr sdk.AccAddress) types.AccountI
}

AccountKeeper defines the expected account keeper used for simulations (noalias)

type BTCLightClientKeeper

type BTCLightClientKeeper interface {
	GetTipInfo(ctx sdk.Context) *lc.BTCHeaderInfo
	GetBaseBTCHeader(ctx sdk.Context) *lc.BTCHeaderInfo
}

type BankKeeper

type BankKeeper interface {
	SpendableCoins(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
}

BankKeeper defines the expected interface needed to retrieve account balances.

type GenesisState

type GenesisState struct {
}

GenesisState defines the monitor module's genesis state.

func DefaultGenesis

func DefaultGenesis() *GenesisState

DefaultGenesis returns the default Capability genesis state

func (*GenesisState) Descriptor

func (*GenesisState) Descriptor() ([]byte, []int)

func (*GenesisState) Marshal

func (m *GenesisState) Marshal() (dAtA []byte, err error)

func (*GenesisState) MarshalTo

func (m *GenesisState) MarshalTo(dAtA []byte) (int, error)

func (*GenesisState) MarshalToSizedBuffer

func (m *GenesisState) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GenesisState) ProtoMessage

func (*GenesisState) ProtoMessage()

func (*GenesisState) Reset

func (m *GenesisState) Reset()

func (*GenesisState) Size

func (m *GenesisState) Size() (n int)

func (*GenesisState) String

func (m *GenesisState) String() string

func (*GenesisState) Unmarshal

func (m *GenesisState) Unmarshal(dAtA []byte) error

func (GenesisState) Validate

func (gs GenesisState) Validate() error

Validate performs basic genesis state validation returning an error upon any failure.

func (*GenesisState) XXX_DiscardUnknown

func (m *GenesisState) XXX_DiscardUnknown()

func (*GenesisState) XXX_Marshal

func (m *GenesisState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GenesisState) XXX_Merge

func (m *GenesisState) XXX_Merge(src proto.Message)

func (*GenesisState) XXX_Size

func (m *GenesisState) XXX_Size() int

func (*GenesisState) XXX_Unmarshal

func (m *GenesisState) XXX_Unmarshal(b []byte) error

type QueryClient

type QueryClient interface {
	// EndedEpochBtcHeight returns the BTC light client height at provided epoch
	// finish
	EndedEpochBtcHeight(ctx context.Context, in *QueryEndedEpochBtcHeightRequest, opts ...grpc.CallOption) (*QueryEndedEpochBtcHeightResponse, error)
	// ReportedCheckpointBtcHeight returns the BTC light client height at which
	// the checkpoint with the given hash is reported back to Babylon
	ReportedCheckpointBtcHeight(ctx context.Context, in *QueryReportedCheckpointBtcHeightRequest, opts ...grpc.CallOption) (*QueryReportedCheckpointBtcHeightResponse, error)
}

QueryClient is the client API for Query service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewQueryClient

func NewQueryClient(cc grpc1.ClientConn) QueryClient

type QueryEndedEpochBtcHeightRequest

type QueryEndedEpochBtcHeightRequest struct {
	EpochNum uint64 `protobuf:"varint,1,opt,name=epoch_num,json=epochNum,proto3" json:"epoch_num,omitempty"`
}

QueryEndedEpochBtcHeightRequest defines a query type for EndedEpochBtcHeight RPC method

func (*QueryEndedEpochBtcHeightRequest) Descriptor

func (*QueryEndedEpochBtcHeightRequest) Descriptor() ([]byte, []int)

func (*QueryEndedEpochBtcHeightRequest) GetEpochNum

func (m *QueryEndedEpochBtcHeightRequest) GetEpochNum() uint64

func (*QueryEndedEpochBtcHeightRequest) Marshal

func (m *QueryEndedEpochBtcHeightRequest) Marshal() (dAtA []byte, err error)

func (*QueryEndedEpochBtcHeightRequest) MarshalTo

func (m *QueryEndedEpochBtcHeightRequest) MarshalTo(dAtA []byte) (int, error)

func (*QueryEndedEpochBtcHeightRequest) MarshalToSizedBuffer

func (m *QueryEndedEpochBtcHeightRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryEndedEpochBtcHeightRequest) ProtoMessage

func (*QueryEndedEpochBtcHeightRequest) ProtoMessage()

func (*QueryEndedEpochBtcHeightRequest) Reset

func (*QueryEndedEpochBtcHeightRequest) Size

func (m *QueryEndedEpochBtcHeightRequest) Size() (n int)

func (*QueryEndedEpochBtcHeightRequest) String

func (*QueryEndedEpochBtcHeightRequest) Unmarshal

func (m *QueryEndedEpochBtcHeightRequest) Unmarshal(dAtA []byte) error

func (*QueryEndedEpochBtcHeightRequest) XXX_DiscardUnknown

func (m *QueryEndedEpochBtcHeightRequest) XXX_DiscardUnknown()

func (*QueryEndedEpochBtcHeightRequest) XXX_Marshal

func (m *QueryEndedEpochBtcHeightRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryEndedEpochBtcHeightRequest) XXX_Merge

func (m *QueryEndedEpochBtcHeightRequest) XXX_Merge(src proto.Message)

func (*QueryEndedEpochBtcHeightRequest) XXX_Size

func (m *QueryEndedEpochBtcHeightRequest) XXX_Size() int

func (*QueryEndedEpochBtcHeightRequest) XXX_Unmarshal

func (m *QueryEndedEpochBtcHeightRequest) XXX_Unmarshal(b []byte) error

type QueryEndedEpochBtcHeightResponse

type QueryEndedEpochBtcHeightResponse struct {
	// height of btc light client when epoch ended
	BtcLightClientHeight uint64 `` /* 126-byte string literal not displayed */
}

QueryEndedEpochBtcHeightResponse defines a response type for EndedEpochBtcHeight RPC method

func (*QueryEndedEpochBtcHeightResponse) Descriptor

func (*QueryEndedEpochBtcHeightResponse) Descriptor() ([]byte, []int)

func (*QueryEndedEpochBtcHeightResponse) GetBtcLightClientHeight

func (m *QueryEndedEpochBtcHeightResponse) GetBtcLightClientHeight() uint64

func (*QueryEndedEpochBtcHeightResponse) Marshal

func (m *QueryEndedEpochBtcHeightResponse) Marshal() (dAtA []byte, err error)

func (*QueryEndedEpochBtcHeightResponse) MarshalTo

func (m *QueryEndedEpochBtcHeightResponse) MarshalTo(dAtA []byte) (int, error)

func (*QueryEndedEpochBtcHeightResponse) MarshalToSizedBuffer

func (m *QueryEndedEpochBtcHeightResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryEndedEpochBtcHeightResponse) ProtoMessage

func (*QueryEndedEpochBtcHeightResponse) ProtoMessage()

func (*QueryEndedEpochBtcHeightResponse) Reset

func (*QueryEndedEpochBtcHeightResponse) Size

func (m *QueryEndedEpochBtcHeightResponse) Size() (n int)

func (*QueryEndedEpochBtcHeightResponse) String

func (*QueryEndedEpochBtcHeightResponse) Unmarshal

func (m *QueryEndedEpochBtcHeightResponse) Unmarshal(dAtA []byte) error

func (*QueryEndedEpochBtcHeightResponse) XXX_DiscardUnknown

func (m *QueryEndedEpochBtcHeightResponse) XXX_DiscardUnknown()

func (*QueryEndedEpochBtcHeightResponse) XXX_Marshal

func (m *QueryEndedEpochBtcHeightResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryEndedEpochBtcHeightResponse) XXX_Merge

func (*QueryEndedEpochBtcHeightResponse) XXX_Size

func (m *QueryEndedEpochBtcHeightResponse) XXX_Size() int

func (*QueryEndedEpochBtcHeightResponse) XXX_Unmarshal

func (m *QueryEndedEpochBtcHeightResponse) XXX_Unmarshal(b []byte) error

type QueryReportedCheckpointBtcHeightRequest

type QueryReportedCheckpointBtcHeightRequest struct {
	// ckpt_hash is hex encoded byte string of the hash of the checkpoint
	CkptHash string `protobuf:"bytes,1,opt,name=ckpt_hash,json=ckptHash,proto3" json:"ckpt_hash,omitempty"`
}

QueryReportedCheckpointBtcHeightRequest defines a query type for ReportedCheckpointBtcHeight RPC method

func (*QueryReportedCheckpointBtcHeightRequest) Descriptor

func (*QueryReportedCheckpointBtcHeightRequest) Descriptor() ([]byte, []int)

func (*QueryReportedCheckpointBtcHeightRequest) GetCkptHash

func (*QueryReportedCheckpointBtcHeightRequest) Marshal

func (m *QueryReportedCheckpointBtcHeightRequest) Marshal() (dAtA []byte, err error)

func (*QueryReportedCheckpointBtcHeightRequest) MarshalTo

func (m *QueryReportedCheckpointBtcHeightRequest) MarshalTo(dAtA []byte) (int, error)

func (*QueryReportedCheckpointBtcHeightRequest) MarshalToSizedBuffer

func (m *QueryReportedCheckpointBtcHeightRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryReportedCheckpointBtcHeightRequest) ProtoMessage

func (*QueryReportedCheckpointBtcHeightRequest) Reset

func (*QueryReportedCheckpointBtcHeightRequest) Size

func (*QueryReportedCheckpointBtcHeightRequest) String

func (*QueryReportedCheckpointBtcHeightRequest) Unmarshal

func (m *QueryReportedCheckpointBtcHeightRequest) Unmarshal(dAtA []byte) error

func (*QueryReportedCheckpointBtcHeightRequest) XXX_DiscardUnknown

func (m *QueryReportedCheckpointBtcHeightRequest) XXX_DiscardUnknown()

func (*QueryReportedCheckpointBtcHeightRequest) XXX_Marshal

func (m *QueryReportedCheckpointBtcHeightRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryReportedCheckpointBtcHeightRequest) XXX_Merge

func (*QueryReportedCheckpointBtcHeightRequest) XXX_Size

func (*QueryReportedCheckpointBtcHeightRequest) XXX_Unmarshal

func (m *QueryReportedCheckpointBtcHeightRequest) XXX_Unmarshal(b []byte) error

type QueryReportedCheckpointBtcHeightResponse

type QueryReportedCheckpointBtcHeightResponse struct {
	// height of btc light client when checkpoint is reported
	BtcLightClientHeight uint64 `` /* 126-byte string literal not displayed */
}

QueryReportedCheckpointBtcHeightResponse defines a response type for ReportedCheckpointBtcHeight RPC method

func (*QueryReportedCheckpointBtcHeightResponse) Descriptor

func (*QueryReportedCheckpointBtcHeightResponse) Descriptor() ([]byte, []int)

func (*QueryReportedCheckpointBtcHeightResponse) GetBtcLightClientHeight

func (m *QueryReportedCheckpointBtcHeightResponse) GetBtcLightClientHeight() uint64

func (*QueryReportedCheckpointBtcHeightResponse) Marshal

func (m *QueryReportedCheckpointBtcHeightResponse) Marshal() (dAtA []byte, err error)

func (*QueryReportedCheckpointBtcHeightResponse) MarshalTo

func (m *QueryReportedCheckpointBtcHeightResponse) MarshalTo(dAtA []byte) (int, error)

func (*QueryReportedCheckpointBtcHeightResponse) MarshalToSizedBuffer

func (m *QueryReportedCheckpointBtcHeightResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryReportedCheckpointBtcHeightResponse) ProtoMessage

func (*QueryReportedCheckpointBtcHeightResponse) Reset

func (*QueryReportedCheckpointBtcHeightResponse) Size

func (*QueryReportedCheckpointBtcHeightResponse) String

func (*QueryReportedCheckpointBtcHeightResponse) Unmarshal

func (*QueryReportedCheckpointBtcHeightResponse) XXX_DiscardUnknown

func (m *QueryReportedCheckpointBtcHeightResponse) XXX_DiscardUnknown()

func (*QueryReportedCheckpointBtcHeightResponse) XXX_Marshal

func (m *QueryReportedCheckpointBtcHeightResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryReportedCheckpointBtcHeightResponse) XXX_Merge

func (*QueryReportedCheckpointBtcHeightResponse) XXX_Size

func (*QueryReportedCheckpointBtcHeightResponse) XXX_Unmarshal

func (m *QueryReportedCheckpointBtcHeightResponse) XXX_Unmarshal(b []byte) error

type QueryServer

type QueryServer interface {
	// EndedEpochBtcHeight returns the BTC light client height at provided epoch
	// finish
	EndedEpochBtcHeight(context.Context, *QueryEndedEpochBtcHeightRequest) (*QueryEndedEpochBtcHeightResponse, error)
	// ReportedCheckpointBtcHeight returns the BTC light client height at which
	// the checkpoint with the given hash is reported back to Babylon
	ReportedCheckpointBtcHeight(context.Context, *QueryReportedCheckpointBtcHeightRequest) (*QueryReportedCheckpointBtcHeightResponse, error)
}

QueryServer is the server API for Query service.

type UnimplementedQueryServer

type UnimplementedQueryServer struct {
}

UnimplementedQueryServer can be embedded to have forward compatible implementations.

func (*UnimplementedQueryServer) EndedEpochBtcHeight

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL