types

package
v1.7.4 Latest Latest
Warning

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

 Go to latest Published: Apr 15, 2023 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Overview

Package types is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	EventTypeCreateRecord = "create_record"

	AttributeValueCategory = ModuleName

	AttributeKeyRecordID = "record_id"
	AttributeKeyCreator  = "creator"
)

record module event types

View Source 
const (
	// module name
	ModuleName = "record"

	// StoreKey is the default store key for record
	StoreKey = ModuleName

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

	// QuerierRoute is the querier route for the record store.
	QuerierRoute = StoreKey

	// Query endpoints supported by the record querier
	QueryRecord = "record"
)

nolint

View Source 
const (
	TypeMsgCreateRecord = "create_record" // type for MsgCreateRecord
)

Variables

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 (
	RecordKey         = []byte{0x01} // record key
	IntraTxCounterKey = []byte{0x02} // key for intra-block tx index
)
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")
)
View Source 
var (
	ErrInvalidLengthRecord        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowRecord          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupRecord = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	ErrInvalidLengthTx        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTx          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupTx = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	ErrUnknownRecord = sdkerrors.Register(ModuleName, 2, "unknown record")
)

record module sentinel errors

View Source 
var (
	ModuleCdc = codec.NewAminoCodec(amino)
)

Functions

func GetRecordKey 

func GetRecordKey(recordID []byte) []byte

GetRecordKey returns the record key

func RegisterInterfaces 

func RegisterInterfaces(registry types.InterfaceRegistry)

RegisterInterfaces registers the interface

func RegisterLegacyAminoCodec 

func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

func RegisterMsgServer 

func RegisterMsgServer(s grpc1.Server, srv MsgServer)

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)

func ValidateContents 

func ValidateContents(contents ...Content) error

ValidateContents verifies whether the given contents are legal

func ValidateGenesis 

func ValidateGenesis(data GenesisState) error

ValidateGenesis validates the provided record genesis state to ensure the expected invariants holds.

Types

type AccountKeeper 

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

AccountKeeper defines the expected account keeper for query account

type BankKeeper 

type BankKeeper interface {
	GetAllBalances(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
	GetBalance(ctx sdk.Context, addr sdk.AccAddress, denom string) sdk.Coin
	LockedCoins(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
	SpendableCoins(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
}

BankKeeper defines the expected bank keeper.

type Content 

type Content struct {
	Digest     string `protobuf:"bytes,1,opt,name=digest,proto3" json:"digest,omitempty"`
	DigestAlgo string `protobuf:"bytes,2,opt,name=digest_algo,json=digestAlgo,proto3" json:"digest_algo,omitempty" yaml:"digest_algo"`
	URI        string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
	Meta       string `protobuf:"bytes,4,opt,name=meta,proto3" json:"meta,omitempty"`
}

Content defines the detailed information for a record

func (*Content) Descriptor 

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

func (*Content) Equal 

func (this *Content) Equal(that interface{}) bool

func (*Content) Marshal 

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

func (*Content) MarshalTo 

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

func (*Content) MarshalToSizedBuffer 

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

func (*Content) ProtoMessage 

func (*Content) ProtoMessage()

func (*Content) Reset 

func (m *Content) Reset()

func (*Content) Size 

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

func (*Content) String 

func (m *Content) String() string

func (*Content) Unmarshal 

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

func (*Content) XXX_DiscardUnknown 

func (m *Content) XXX_DiscardUnknown()

func (*Content) XXX_Marshal 

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

func (*Content) XXX_Merge 

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

func (*Content) XXX_Size 

func (m *Content) XXX_Size() int

func (*Content) XXX_Unmarshal 

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

type GenesisState 

type GenesisState struct {
	Records []Record `protobuf:"bytes,1,rep,name=records,proto3" json:"records"`
}

GenesisState defines the record module's genesis state

func DefaultGenesisState 

func DefaultGenesisState() *GenesisState

DefaultGenesisState gets the default genesis state for testing

func NewGenesisState 

func NewGenesisState(records []Record) *GenesisState

NewGenesisState constructs a new GenesisState instance

func (*GenesisState) Descriptor 

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

func (*GenesisState) GetRecords 

func (m *GenesisState) GetRecords() []Record

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) 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 MsgClient 

type MsgClient interface {
	// CreateRecord defines a method for creating a new record
	CreateRecord(ctx context.Context, in *MsgCreateRecord, opts ...grpc.CallOption) (*MsgCreateRecordResponse, error)
}

MsgClient is the client API for Msg service.

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

func NewMsgClient 

func NewMsgClient(cc grpc1.ClientConn) MsgClient

type MsgCreateRecord 

type MsgCreateRecord struct {
	Contents []Content `protobuf:"bytes,1,rep,name=contents,proto3" json:"contents"`
	Creator  string    `protobuf:"bytes,2,opt,name=creator,proto3" json:"creator,omitempty"`
}

MsgCreateRecord defines an SDK message for creating a new record

func NewMsgCreateRecord 

func NewMsgCreateRecord(contents []Content, Creator string) *MsgCreateRecord

NewMsgCreateRecord constructs a new MsgCreateRecord instance

func (*MsgCreateRecord) Descriptor 

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

func (*MsgCreateRecord) Equal 

func (this *MsgCreateRecord) Equal(that interface{}) bool

func (MsgCreateRecord) GetSignBytes 

func (msg MsgCreateRecord) GetSignBytes() []byte

GetSignBytes implements Msg.

func (MsgCreateRecord) GetSigners 

func (msg MsgCreateRecord) GetSigners() []sdk.AccAddress

GetSigners implements Msg.

func (*MsgCreateRecord) Marshal 

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

func (*MsgCreateRecord) MarshalTo 

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

func (*MsgCreateRecord) MarshalToSizedBuffer 

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

func (*MsgCreateRecord) ProtoMessage 

func (*MsgCreateRecord) ProtoMessage()

func (*MsgCreateRecord) Reset 

func (m *MsgCreateRecord) Reset()

func (MsgCreateRecord) Route 

func (msg MsgCreateRecord) Route() string

Route implements Msg.

func (*MsgCreateRecord) Size 

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

func (*MsgCreateRecord) String 

func (m *MsgCreateRecord) String() string

func (MsgCreateRecord) Type 

func (msg MsgCreateRecord) Type() string

Type implements Msg.

func (*MsgCreateRecord) Unmarshal 

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

func (MsgCreateRecord) ValidateBasic 

func (msg MsgCreateRecord) ValidateBasic() error

ValidateBasic implements Msg.

func (*MsgCreateRecord) XXX_DiscardUnknown 

func (m *MsgCreateRecord) XXX_DiscardUnknown()

func (*MsgCreateRecord) XXX_Marshal 

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

func (*MsgCreateRecord) XXX_Merge 

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

func (*MsgCreateRecord) XXX_Size 

func (m *MsgCreateRecord) XXX_Size() int

func (*MsgCreateRecord) XXX_Unmarshal 

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

type MsgCreateRecordResponse 

type MsgCreateRecordResponse struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
}

MsgCreateRecordResponse defines the Msg/CreateRecord response type

func (*MsgCreateRecordResponse) Descriptor 

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

func (*MsgCreateRecordResponse) Marshal 

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

func (*MsgCreateRecordResponse) MarshalTo 

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

func (*MsgCreateRecordResponse) MarshalToSizedBuffer 

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

func (*MsgCreateRecordResponse) ProtoMessage 

func (*MsgCreateRecordResponse) ProtoMessage()

func (*MsgCreateRecordResponse) Reset 

func (m *MsgCreateRecordResponse) Reset()

func (*MsgCreateRecordResponse) Size 

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

func (*MsgCreateRecordResponse) String 

func (m *MsgCreateRecordResponse) String() string

func (*MsgCreateRecordResponse) Unmarshal 

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

func (*MsgCreateRecordResponse) XXX_DiscardUnknown 

func (m *MsgCreateRecordResponse) XXX_DiscardUnknown()

func (*MsgCreateRecordResponse) XXX_Marshal 

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

func (*MsgCreateRecordResponse) XXX_Merge 

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

func (*MsgCreateRecordResponse) XXX_Size 

func (m *MsgCreateRecordResponse) XXX_Size() int

func (*MsgCreateRecordResponse) XXX_Unmarshal 

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

type MsgServer 

type MsgServer interface {
	// CreateRecord defines a method for creating a new record
	CreateRecord(context.Context, *MsgCreateRecord) (*MsgCreateRecordResponse, error)
}

MsgServer is the server API for Msg service.

type QueryClient 

type QueryClient interface {
	// Record queries the record by the given record ID
	Record(ctx context.Context, in *QueryRecordRequest, opts ...grpc.CallOption) (*QueryRecordResponse, 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 QueryRecordParams 

type QueryRecordParams struct {
	RecordID []byte `json:"record_id"`
}

QueryRecordParams defines params to query a record

type QueryRecordRequest 

type QueryRecordRequest struct {
	RecordId string `protobuf:"bytes,1,opt,name=record_id,json=recordId,proto3" json:"record_id,omitempty"`
}

QueryRecordRequest is the request type for the Query/Record RPC method

func (*QueryRecordRequest) Descriptor 

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

func (*QueryRecordRequest) GetRecordId 

func (m *QueryRecordRequest) GetRecordId() string

func (*QueryRecordRequest) Marshal 

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

func (*QueryRecordRequest) MarshalTo 

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

func (*QueryRecordRequest) MarshalToSizedBuffer 

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

func (*QueryRecordRequest) ProtoMessage 

func (*QueryRecordRequest) ProtoMessage()

func (*QueryRecordRequest) Reset 

func (m *QueryRecordRequest) Reset()

func (*QueryRecordRequest) Size 

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

func (*QueryRecordRequest) String 

func (m *QueryRecordRequest) String() string

func (*QueryRecordRequest) Unmarshal 

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

func (*QueryRecordRequest) XXX_DiscardUnknown 

func (m *QueryRecordRequest) XXX_DiscardUnknown()

func (*QueryRecordRequest) XXX_Marshal 

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

func (*QueryRecordRequest) XXX_Merge 

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

func (*QueryRecordRequest) XXX_Size 

func (m *QueryRecordRequest) XXX_Size() int

func (*QueryRecordRequest) XXX_Unmarshal 

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

type QueryRecordResponse 

type QueryRecordResponse struct {
	Record *Record `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"`
}

QueryRecordResponse is the response type for the Query/Record RPC method

func (*QueryRecordResponse) Descriptor 

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

func (*QueryRecordResponse) GetRecord 

func (m *QueryRecordResponse) GetRecord() *Record

func (*QueryRecordResponse) Marshal 

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

func (*QueryRecordResponse) MarshalTo 

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

func (*QueryRecordResponse) MarshalToSizedBuffer 

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

func (*QueryRecordResponse) ProtoMessage 

func (*QueryRecordResponse) ProtoMessage()

func (*QueryRecordResponse) Reset 

func (m *QueryRecordResponse) Reset()

func (*QueryRecordResponse) Size 

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

func (*QueryRecordResponse) String 

func (m *QueryRecordResponse) String() string

func (*QueryRecordResponse) Unmarshal 

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

func (*QueryRecordResponse) XXX_DiscardUnknown 

func (m *QueryRecordResponse) XXX_DiscardUnknown()

func (*QueryRecordResponse) XXX_Marshal 

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

func (*QueryRecordResponse) XXX_Merge 

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

func (*QueryRecordResponse) XXX_Size 

func (m *QueryRecordResponse) XXX_Size() int

func (*QueryRecordResponse) XXX_Unmarshal 

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

type QueryServer 

type QueryServer interface {
	// Record queries the record by the given record ID
	Record(context.Context, *QueryRecordRequest) (*QueryRecordResponse, error)
}

QueryServer is the server API for Query service.

type Record 

type Record struct {
	TxHash   string    `protobuf:"bytes,1,opt,name=tx_hash,json=txHash,proto3" json:"tx_hash,omitempty" yaml:"tx_hash"`
	Contents []Content `protobuf:"bytes,2,rep,name=contents,proto3" json:"contents"`
	Creator  string    `protobuf:"bytes,3,opt,name=creator,proto3" json:"creator,omitempty"`
}

Record defines the record standard

func NewRecord 

func NewRecord(txHash bytes.HexBytes, contents []Content, creator sdk.AccAddress) Record

NewRecord constructs a new Record instance

func (*Record) Descriptor 

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

func (*Record) Equal 

func (this *Record) Equal(that interface{}) bool

func (*Record) Marshal 

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

func (*Record) MarshalTo 

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

func (*Record) MarshalToSizedBuffer 

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

func (*Record) ProtoMessage 

func (*Record) ProtoMessage()

func (*Record) Reset 

func (m *Record) Reset()

func (*Record) Size 

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

func (*Record) String 

func (m *Record) String() string

func (*Record) Unmarshal 

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

func (*Record) XXX_DiscardUnknown 

func (m *Record) XXX_DiscardUnknown()

func (*Record) XXX_Marshal 

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

func (*Record) XXX_Merge 

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

func (*Record) XXX_Size 

func (m *Record) XXX_Size() int

func (*Record) XXX_Unmarshal 

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

type RecordOutput 

type RecordOutput struct {
	TxHash   string    `json:"tx_hash" yaml:"tx_hash"`
	Contents []Content `json:"contents" yaml:"contents"`
	Creator  string    `json:"creator" yaml:"creator"`
}

type UnimplementedMsgServer 

type UnimplementedMsgServer struct {
}

UnimplementedMsgServer can be embedded to have forward compatible implementations.

func (*UnimplementedMsgServer) CreateRecord 

func (*UnimplementedMsgServer) CreateRecord(ctx context.Context, req *MsgCreateRecord) (*MsgCreateRecordResponse, error)

type UnimplementedQueryServer 

type UnimplementedQueryServer struct {
}

UnimplementedQueryServer can be embedded to have forward compatible implementations.

func (*UnimplementedQueryServer) Record 

func (*UnimplementedQueryServer) Record(ctx context.Context, req *QueryRecordRequest) (*QueryRecordResponse, error)

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.