types

package
v0.4.0-rc0 Latest Latest
Warning

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

 Go to latest Published: Jan 10, 2025 License: LGPL-3.0 Imports: 23 Imported by: 0

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 = "bridge"

	// StoreKey defines the primary module store key
	StoreKey = ModuleName
)
View Source 
const ValidatorPrivilege = "bridge"

ValidatorPrivilege represents the privilege of bridge validators that have authority to attest bridging. The non-bridge validators validate what bridge validators attested.

Variables

View Source 
var (
	ErrInvalidLengthBridge        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowBridge          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupBridge = fmt.Errorf("proto: unexpected end of group")
)
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 (
	ParamsKey = []byte{0x10} // standalone key for module params

	AssetsLockedSequenceTipKey = []byte{0x20} // standalone key for the assets locked sequence tip
)
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 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 AssetsLockedEvent 

type AssetsLockedEvent struct {
	// sequence is the unique identifier of the event.
	Sequence cosmossdk_io_math.Int `protobuf:"bytes,1,opt,name=sequence,proto3,customtype=cosmossdk.io/math.Int" json:"sequence"`
	// recipient is the account address to receive the locked assets on Mezo,
	// in Bech32 format.
	Recipient string `protobuf:"bytes,2,opt,name=recipient,proto3" json:"recipient,omitempty"`
	// amount of assets locked, in 1e18 precision.
	Amount cosmossdk_io_math.Int `protobuf:"bytes,3,opt,name=amount,proto3,customtype=cosmossdk.io/math.Int" json:"amount"`
}

AssetsLockedEvent represents the event where inbound assets are locked in the Bitcoin bridge.

func (*AssetsLockedEvent) Descriptor 

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

func (AssetsLockedEvent) Equal 

func (ale AssetsLockedEvent) Equal(other AssetsLockedEvent) bool

Equal returns true if this AssetsLockedEvents is equal to the other event. Two events are considered equal if their sequence numbers, recipient addresses, and amounts of locked assets are equal.

DEV NOTE: THIS FUNCTION PLAYS A CRUCIAL ROLE IN `assetsLockedExtractor` WHERE WE DETERMINE CANONICAL EVENTS BASED ON VALIDATORS' VOTES. NOTHING PREVENTS A MALICIOUS VALIDATOR FROM VOTING ON AN EVENT WITH THE GIVEN SEQUENCE BUT WITH A DIFFERENT AMOUNT/RECIPIENT. THIS IS WHY WE NEED A WAY TO COMPARE ALL FIELDS OF `AssetsLockedEvent`.

func (*AssetsLockedEvent) GetRecipient 

func (m *AssetsLockedEvent) GetRecipient() string

func (AssetsLockedEvent) IsValid 

func (ale AssetsLockedEvent) IsValid() bool

IsValid returns true if the event is valid. An event is considered valid if its sequence number is positive, its recipient address is a valid Bech32 account address, and the amount of locked assets is positive.

func (*AssetsLockedEvent) Marshal 

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

func (*AssetsLockedEvent) MarshalTo 

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

func (*AssetsLockedEvent) MarshalToSizedBuffer 

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

func (*AssetsLockedEvent) ProtoMessage 

func (*AssetsLockedEvent) ProtoMessage()

func (*AssetsLockedEvent) Reset 

func (m *AssetsLockedEvent) Reset()

func (*AssetsLockedEvent) Size 

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

func (*AssetsLockedEvent) String 

func (m *AssetsLockedEvent) String() string

func (*AssetsLockedEvent) Unmarshal 

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

func (*AssetsLockedEvent) XXX_DiscardUnknown 

func (m *AssetsLockedEvent) XXX_DiscardUnknown()

func (*AssetsLockedEvent) XXX_Marshal 

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

func (*AssetsLockedEvent) XXX_Merge 

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

func (*AssetsLockedEvent) XXX_Size 

func (m *AssetsLockedEvent) XXX_Size() int

func (*AssetsLockedEvent) XXX_Unmarshal 

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

type AssetsLockedEvents 

type AssetsLockedEvents []AssetsLockedEvent

AssetsLockedEvents is a slice of AssetsLockedEvent.

func (AssetsLockedEvents) Equal 

func (ale AssetsLockedEvents) Equal(other AssetsLockedEvents) bool

Equal returns true if this AssetsLockedEvent slice is equal to the other slice. Two slices are considered equal if they have the same length and all their elements are equal. See AssetsLockedEvent.Equal for more details.

func (AssetsLockedEvents) IsStrictlyIncreasingSequence 

func (ale AssetsLockedEvents) IsStrictlyIncreasingSequence() bool

IsStrictlyIncreasingSequence returns true if the sequence numbers of the events in the slice form a sequence strictly increasing by 1. Such a sequence guarantees that there are no gaps between the sequence numbers of the events and that each event is unique by its sequence number. Returns true for empty and single-element slices.

func (AssetsLockedEvents) IsValid 

func (ale AssetsLockedEvents) IsValid() bool

IsValid returns true if all events in the slice are valid and their sequence numbers form a sequence strictly increasing by 1. See AssetsLockedEvent.IsValid and AssetsLockedEvents.IsStrictlyIncreasingSequence for more details.

type BankKeeper 

type BankKeeper interface {
	// MintCoins creates new coins and adds them to the module account.
	MintCoins(ctx context.Context, moduleName string, amt sdk.Coins) error

	// SendCoinsFromModuleToAccount sends coins from the module account to the
	// recipient account.
	SendCoinsFromModuleToAccount(
		ctx context.Context,
		senderModule string,
		recipientAddr sdk.AccAddress,
		amt sdk.Coins,
	) error
}

BankKeeper is an interface to the x/bank module keeper.

type GenesisState 

type GenesisState struct {
	// params defines all the parameters of related to bridge.
	Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params"`
}

GenesisState defines the bridge module's genesis state.

func DefaultGenesis 

func DefaultGenesis() *GenesisState

DefaultGenesis returns the default genesis state

func (*GenesisState) Descriptor 

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

func (*GenesisState) GetParams 

func (m *GenesisState) GetParams() Params

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 Params 

type Params struct {
}

Params defines the parameters for the module.

func DefaultParams 

func DefaultParams() Params

DefaultParams returns a default set of parameters.

func NewParams 

func NewParams() Params

NewParams creates a new Params instance.

func (*Params) Descriptor 

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

func (*Params) Marshal 

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

func (*Params) MarshalTo 

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

func (*Params) MarshalToSizedBuffer 

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

func (*Params) ProtoMessage 

func (*Params) ProtoMessage()

func (*Params) Reset 

func (m *Params) Reset()

func (*Params) Size 

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

func (Params) String 

func (p Params) String() string

String implements the Stringer interface.

func (*Params) Unmarshal 

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

func (Params) Validate 

func (p Params) Validate() error

Validate validates the set of params.

func (*Params) XXX_DiscardUnknown 

func (m *Params) XXX_DiscardUnknown()

func (*Params) XXX_Marshal 

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

func (*Params) XXX_Merge 

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

func (*Params) XXX_Size 

func (m *Params) XXX_Size() int

func (*Params) XXX_Unmarshal 

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

type QueryClient 

type QueryClient interface {
	// Params queries the parameters of the module.
	Params(ctx context.Context, in *QueryParamsRequest, opts ...grpc.CallOption) (*QueryParamsResponse, 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 QueryParamsRequest 

type QueryParamsRequest struct {
}

QueryParamsRequest is request type for the Query/Params RPC method.

func (*QueryParamsRequest) Descriptor 

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

func (*QueryParamsRequest) Marshal 

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

func (*QueryParamsRequest) MarshalTo 

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

func (*QueryParamsRequest) MarshalToSizedBuffer 

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

func (*QueryParamsRequest) ProtoMessage 

func (*QueryParamsRequest) ProtoMessage()

func (*QueryParamsRequest) Reset 

func (m *QueryParamsRequest) Reset()

func (*QueryParamsRequest) Size 

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

func (*QueryParamsRequest) String 

func (m *QueryParamsRequest) String() string

func (*QueryParamsRequest) Unmarshal 

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

func (*QueryParamsRequest) XXX_DiscardUnknown 

func (m *QueryParamsRequest) XXX_DiscardUnknown()

func (*QueryParamsRequest) XXX_Marshal 

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

func (*QueryParamsRequest) XXX_Merge 

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

func (*QueryParamsRequest) XXX_Size 

func (m *QueryParamsRequest) XXX_Size() int

func (*QueryParamsRequest) XXX_Unmarshal 

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

type QueryParamsResponse 

type QueryParamsResponse struct {
	// params holds all the parameters of this module.
	Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params"`
}

QueryParamsResponse is response type for the Query/Params RPC method.

func (*QueryParamsResponse) Descriptor 

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

func (*QueryParamsResponse) GetParams 

func (m *QueryParamsResponse) GetParams() Params

func (*QueryParamsResponse) Marshal 

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

func (*QueryParamsResponse) MarshalTo 

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

func (*QueryParamsResponse) MarshalToSizedBuffer 

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

func (*QueryParamsResponse) ProtoMessage 

func (*QueryParamsResponse) ProtoMessage()

func (*QueryParamsResponse) Reset 

func (m *QueryParamsResponse) Reset()

func (*QueryParamsResponse) Size 

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

func (*QueryParamsResponse) String 

func (m *QueryParamsResponse) String() string

func (*QueryParamsResponse) Unmarshal 

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

func (*QueryParamsResponse) XXX_DiscardUnknown 

func (m *QueryParamsResponse) XXX_DiscardUnknown()

func (*QueryParamsResponse) XXX_Marshal 

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

func (*QueryParamsResponse) XXX_Merge 

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

func (*QueryParamsResponse) XXX_Size 

func (m *QueryParamsResponse) XXX_Size() int

func (*QueryParamsResponse) XXX_Unmarshal 

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

type QueryServer 

type QueryServer interface {
	// Params queries the parameters of the module.
	Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, 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) Params 

func (*UnimplementedQueryServer) Params(ctx context.Context, req *QueryParamsRequest) (*QueryParamsResponse, error)

type ValidatorStore 

type ValidatorStore interface {
	baseapp.ValidatorStore

	// GetValidatorsConsAddrsByPrivilege returns the consensus addresses of
	// all validators that are currently present in the store and have the
	// given privilege. There is no guarantee that the returned validators
	// are currently part of the CometBFT validator set.
	GetValidatorsConsAddrsByPrivilege(
		ctx sdk.Context,
		privilege string,
	) []sdk.ConsAddress
}

ValidatorStore is an interface to the validator store.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.