Documentation
¶
Overview ¶
Code generated by protoc-gen-go-pulsar. DO NOT EDIT.
Code generated by protoc-gen-go-pulsar. DO NOT EDIT.
Code generated by protoc-gen-go-pulsar. DO NOT EDIT.
Code generated by protoc-gen-go-pulsar. DO NOT EDIT.
DO NOT DELETE this file. It is intentionally added and kept empty to ensure an empty package exists and can be referenced to prevent the ignite CLI from throwing errors during proto generation.
Code generated by protoc-gen-go-pulsar. DO NOT EDIT.
Code generated by protoc-gen-go-pulsar. DO NOT EDIT.
Code generated by protoc-gen-go-pulsar. DO NOT EDIT.
Index ¶
- Constants
- Variables
- func RegisterMsgServer(s grpc.ServiceRegistrar, srv MsgServer)
- func RegisterQueryServer(s grpc.ServiceRegistrar, srv QueryServer)
- type ApplicationServiceConfig
- func (*ApplicationServiceConfig) Descriptor() ([]byte, []int)deprecated
- func (x *ApplicationServiceConfig) GetServiceId() string
- func (*ApplicationServiceConfig) ProtoMessage()
- func (x *ApplicationServiceConfig) ProtoReflect() protoreflect.Message
- func (x *ApplicationServiceConfig) Reset()
- func (x *ApplicationServiceConfig) String() string
- type ConfigOption
- func (*ConfigOption) Descriptor() ([]byte, []int)deprecated
- func (x *ConfigOption) GetKey() ConfigOptions
- func (x *ConfigOption) GetValue() string
- func (*ConfigOption) ProtoMessage()
- func (x *ConfigOption) ProtoReflect() protoreflect.Message
- func (x *ConfigOption) Reset()
- func (x *ConfigOption) String() string
- type ConfigOptions
- func (ConfigOptions) Descriptor() protoreflect.EnumDescriptor
- func (x ConfigOptions) Enum() *ConfigOptions
- func (ConfigOptions) EnumDescriptor() ([]byte, []int)deprecated
- func (x ConfigOptions) Number() protoreflect.EnumNumber
- func (x ConfigOptions) String() string
- func (ConfigOptions) Type() protoreflect.EnumType
- type GenesisState
- type MsgClient
- type MsgServer
- type MsgUpdateParam
- func (*MsgUpdateParam) Descriptor() ([]byte, []int)deprecated
- func (x *MsgUpdateParam) GetAsBytes() []byte
- func (x *MsgUpdateParam) GetAsString() string
- func (x *MsgUpdateParam) GetAsType() isMsgUpdateParam_AsType
- func (x *MsgUpdateParam) GetAsUint64() uint64
- func (x *MsgUpdateParam) GetAuthority() string
- func (x *MsgUpdateParam) GetName() string
- func (*MsgUpdateParam) ProtoMessage()
- func (x *MsgUpdateParam) ProtoReflect() protoreflect.Message
- func (x *MsgUpdateParam) Reset()
- func (x *MsgUpdateParam) String() string
- type MsgUpdateParamResponse
- func (*MsgUpdateParamResponse) Descriptor() ([]byte, []int)deprecated
- func (x *MsgUpdateParamResponse) GetParams() *Params
- func (*MsgUpdateParamResponse) ProtoMessage()
- func (x *MsgUpdateParamResponse) ProtoReflect() protoreflect.Message
- func (x *MsgUpdateParamResponse) Reset()
- func (x *MsgUpdateParamResponse) String() string
- type MsgUpdateParam_AsBytes
- type MsgUpdateParam_AsString
- type MsgUpdateParam_AsUint64
- type MsgUpdateParams
- func (*MsgUpdateParams) Descriptor() ([]byte, []int)deprecated
- func (x *MsgUpdateParams) GetAuthority() string
- func (x *MsgUpdateParams) GetParams() *Params
- func (*MsgUpdateParams) ProtoMessage()
- func (x *MsgUpdateParams) ProtoReflect() protoreflect.Message
- func (x *MsgUpdateParams) Reset()
- func (x *MsgUpdateParams) String() string
- type MsgUpdateParamsResponse
- type Params
- func (*Params) Descriptor() ([]byte, []int)deprecated
- func (x *Params) GetApplicationUnbondingPeriodSessions() uint64
- func (x *Params) GetClaimWindowCloseOffsetBlocks() uint64
- func (x *Params) GetClaimWindowOpenOffsetBlocks() uint64
- func (x *Params) GetComputeUnitsToTokensMultiplier() uint64
- func (x *Params) GetGatewayUnbondingPeriodSessions() uint64
- func (x *Params) GetGracePeriodEndOffsetBlocks() uint64
- func (x *Params) GetNumBlocksPerSession() uint64
- func (x *Params) GetProofWindowCloseOffsetBlocks() uint64
- func (x *Params) GetProofWindowOpenOffsetBlocks() uint64
- func (x *Params) GetSupplierUnbondingPeriodSessions() uint64
- func (*Params) ProtoMessage()
- func (x *Params) ProtoReflect() protoreflect.Message
- func (x *Params) Reset()
- func (x *Params) String() string
- type QueryClient
- type QueryParamsRequest
- type QueryParamsResponse
- func (*QueryParamsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *QueryParamsResponse) GetParams() *Params
- func (*QueryParamsResponse) ProtoMessage()
- func (x *QueryParamsResponse) ProtoReflect() protoreflect.Message
- func (x *QueryParamsResponse) Reset()
- func (x *QueryParamsResponse) String() string
- type QueryServer
- type RPCType
- type Service
- func (*Service) Descriptor() ([]byte, []int)deprecated
- func (x *Service) GetComputeUnitsPerRelay() uint64
- func (x *Service) GetId() string
- func (x *Service) GetName() string
- func (x *Service) GetOwnerAddress() string
- func (*Service) ProtoMessage()
- func (x *Service) ProtoReflect() protoreflect.Message
- func (x *Service) Reset()
- func (x *Service) String() string
- type ServiceConfigUpdate
- func (*ServiceConfigUpdate) Descriptor() ([]byte, []int)deprecated
- func (x *ServiceConfigUpdate) GetActivationHeight() int64
- func (x *ServiceConfigUpdate) GetDeactivationHeight() int64
- func (x *ServiceConfigUpdate) GetOperatorAddress() string
- func (x *ServiceConfigUpdate) GetService() *SupplierServiceConfig
- func (*ServiceConfigUpdate) ProtoMessage()
- func (x *ServiceConfigUpdate) ProtoReflect() protoreflect.Message
- func (x *ServiceConfigUpdate) Reset()
- func (x *ServiceConfigUpdate) String() string
- type ServiceConfigUpdateDeprecated
- func (*ServiceConfigUpdateDeprecated) Descriptor() ([]byte, []int)deprecated
- func (x *ServiceConfigUpdateDeprecated) GetEffectiveBlockHeight() uint64
- func (x *ServiceConfigUpdateDeprecated) GetServices() []*SupplierServiceConfig
- func (*ServiceConfigUpdateDeprecated) ProtoMessage()
- func (x *ServiceConfigUpdateDeprecated) ProtoReflect() protoreflect.Message
- func (x *ServiceConfigUpdateDeprecated) Reset()
- func (x *ServiceConfigUpdateDeprecated) String() string
- type ServiceRevenueShare
- func (*ServiceRevenueShare) Descriptor() ([]byte, []int)deprecated
- func (x *ServiceRevenueShare) GetAddress() string
- func (x *ServiceRevenueShare) GetRevSharePercentage() uint64
- func (*ServiceRevenueShare) ProtoMessage()
- func (x *ServiceRevenueShare) ProtoReflect() protoreflect.Message
- func (x *ServiceRevenueShare) Reset()
- func (x *ServiceRevenueShare) String() string
- type Supplier
- func (*Supplier) Descriptor() ([]byte, []int)deprecated
- func (x *Supplier) GetOperatorAddress() string
- func (x *Supplier) GetOwnerAddress() string
- func (x *Supplier) GetServiceConfigHistory() []*ServiceConfigUpdate
- func (x *Supplier) GetServices() []*SupplierServiceConfig
- func (x *Supplier) GetStake() *v1beta1.Coin
- func (x *Supplier) GetUnstakeSessionEndHeight() uint64
- func (*Supplier) ProtoMessage()
- func (x *Supplier) ProtoReflect() protoreflect.Message
- func (x *Supplier) Reset()
- func (x *Supplier) String() string
- type SupplierDeprecated
- func (*SupplierDeprecated) Descriptor() ([]byte, []int)deprecated
- func (x *SupplierDeprecated) GetOperatorAddress() string
- func (x *SupplierDeprecated) GetOwnerAddress() string
- func (x *SupplierDeprecated) GetServiceConfigHistory() []*ServiceConfigUpdateDeprecated
- func (x *SupplierDeprecated) GetServices() []*SupplierServiceConfig
- func (x *SupplierDeprecated) GetStake() *v1beta1.Coin
- func (x *SupplierDeprecated) GetUnstakeSessionEndHeight() uint64
- func (*SupplierDeprecated) ProtoMessage()
- func (x *SupplierDeprecated) ProtoReflect() protoreflect.Message
- func (x *SupplierDeprecated) Reset()
- func (x *SupplierDeprecated) String() string
- type SupplierEndpoint
- func (*SupplierEndpoint) Descriptor() ([]byte, []int)deprecated
- func (x *SupplierEndpoint) GetConfigs() []*ConfigOption
- func (x *SupplierEndpoint) GetRpcType() RPCType
- func (x *SupplierEndpoint) GetUrl() string
- func (*SupplierEndpoint) ProtoMessage()
- func (x *SupplierEndpoint) ProtoReflect() protoreflect.Message
- func (x *SupplierEndpoint) Reset()
- func (x *SupplierEndpoint) String() string
- type SupplierServiceConfig
- func (*SupplierServiceConfig) Descriptor() ([]byte, []int)deprecated
- func (x *SupplierServiceConfig) GetEndpoints() []*SupplierEndpoint
- func (x *SupplierServiceConfig) GetRevShare() []*ServiceRevenueShare
- func (x *SupplierServiceConfig) GetServiceId() string
- func (*SupplierServiceConfig) ProtoMessage()
- func (x *SupplierServiceConfig) ProtoReflect() protoreflect.Message
- func (x *SupplierServiceConfig) Reset()
- func (x *SupplierServiceConfig) String() string
- type UnimplementedMsgServer
- type UnimplementedQueryServer
- type UnsafeMsgServer
- type UnsafeQueryServer
Constants ¶
const ( Msg_UpdateParams_FullMethodName = "/pocket.shared.Msg/UpdateParams" Msg_UpdateParam_FullMethodName = "/pocket.shared.Msg/UpdateParam" )
const (
Query_Params_FullMethodName = "/pocket.shared.Query/Params"
)
Variables ¶
var ( RPCType_name = map[int32]string{ 0: "UNKNOWN_RPC", 1: "GRPC", 2: "WEBSOCKET", 3: "JSON_RPC", 4: "REST", } RPCType_value = map[string]int32{ "UNKNOWN_RPC": 0, "GRPC": 1, "WEBSOCKET": 2, "JSON_RPC": 3, "REST": 4, } )
Enum value maps for RPCType.
var ( ConfigOptions_name = map[int32]string{ 0: "UNKNOWN_CONFIG", 1: "TIMEOUT", } ConfigOptions_value = map[string]int32{ "UNKNOWN_CONFIG": 0, "TIMEOUT": 1, } )
Enum value maps for ConfigOptions.
var Msg_ServiceDesc = grpc.ServiceDesc{ ServiceName: "pocket.shared.Msg", HandlerType: (*MsgServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "UpdateParams", Handler: _Msg_UpdateParams_Handler, }, { MethodName: "UpdateParam", Handler: _Msg_UpdateParam_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "pocket/shared/tx.proto", }
Msg_ServiceDesc is the grpc.ServiceDesc for Msg service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var Query_ServiceDesc = grpc.ServiceDesc{ ServiceName: "pocket.shared.Query", HandlerType: (*QueryServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Params", Handler: _Query_Params_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "pocket/shared/query.proto", }
Query_ServiceDesc is the grpc.ServiceDesc for Query service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterMsgServer ¶
func RegisterMsgServer(s grpc.ServiceRegistrar, srv MsgServer)
func RegisterQueryServer ¶
func RegisterQueryServer(s grpc.ServiceRegistrar, srv QueryServer)
Types ¶
type ApplicationServiceConfig ¶
type ApplicationServiceConfig struct {
ServiceId string `protobuf:"bytes,1,opt,name=service_id,json=serviceId,proto3" json:"service_id,omitempty"` // The Service ID for which the application is configured
// contains filtered or unexported fields
}
ApplicationServiceConfig holds the service configuration the application stakes for
func (*ApplicationServiceConfig) Descriptor
deprecated
func (*ApplicationServiceConfig) Descriptor() ([]byte, []int)
Deprecated: Use ApplicationServiceConfig.ProtoReflect.Descriptor instead.
func (*ApplicationServiceConfig) GetServiceId ¶
func (x *ApplicationServiceConfig) GetServiceId() string
func (*ApplicationServiceConfig) ProtoMessage ¶
func (*ApplicationServiceConfig) ProtoMessage()
func (*ApplicationServiceConfig) ProtoReflect ¶
func (x *ApplicationServiceConfig) ProtoReflect() protoreflect.Message
func (*ApplicationServiceConfig) Reset ¶
func (x *ApplicationServiceConfig) Reset()
func (*ApplicationServiceConfig) String ¶
func (x *ApplicationServiceConfig) String() string
type ConfigOption ¶
type ConfigOption struct {
Key ConfigOptions `protobuf:"varint,1,opt,name=key,proto3,enum=pocket.shared.ConfigOptions" json:"key,omitempty"` // Config option key
Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // Config option value
// contains filtered or unexported fields
}
Key-value wrapper for config options, as proto maps can't be keyed by enums
func (*ConfigOption) Descriptor
deprecated
func (*ConfigOption) Descriptor() ([]byte, []int)
Deprecated: Use ConfigOption.ProtoReflect.Descriptor instead.
func (*ConfigOption) GetKey ¶
func (x *ConfigOption) GetKey() ConfigOptions
func (*ConfigOption) GetValue ¶
func (x *ConfigOption) GetValue() string
func (*ConfigOption) ProtoMessage ¶
func (*ConfigOption) ProtoMessage()
func (*ConfigOption) ProtoReflect ¶
func (x *ConfigOption) ProtoReflect() protoreflect.Message
func (*ConfigOption) Reset ¶
func (x *ConfigOption) Reset()
func (*ConfigOption) String ¶
func (x *ConfigOption) String() string
type ConfigOptions ¶
type ConfigOptions int32
Enum to define configuration options TODO_RESEARCH: Should these be configs, SLAs or something else? There will be more discussion once we get closer to implementing onchain QoS.
const ( ConfigOptions_UNKNOWN_CONFIG ConfigOptions = 0 // Undefined config option ConfigOptions_TIMEOUT ConfigOptions = 1 // Timeout setting )
func (ConfigOptions) Descriptor ¶
func (ConfigOptions) Descriptor() protoreflect.EnumDescriptor
func (ConfigOptions) Enum ¶
func (x ConfigOptions) Enum() *ConfigOptions
func (ConfigOptions) EnumDescriptor
deprecated
func (ConfigOptions) EnumDescriptor() ([]byte, []int)
Deprecated: Use ConfigOptions.Descriptor instead.
func (ConfigOptions) Number ¶
func (x ConfigOptions) Number() protoreflect.EnumNumber
func (ConfigOptions) String ¶
func (x ConfigOptions) String() string
func (ConfigOptions) Type ¶
func (ConfigOptions) Type() protoreflect.EnumType
type GenesisState ¶
type GenesisState struct {
// params defines all the parameters of the module.
Params *Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params,omitempty"`
// contains filtered or unexported fields
}
GenesisState defines the shared module's genesis state.
func (*GenesisState) Descriptor
deprecated
func (*GenesisState) Descriptor() ([]byte, []int)
Deprecated: Use GenesisState.ProtoReflect.Descriptor instead.
func (*GenesisState) GetParams ¶
func (x *GenesisState) GetParams() *Params
func (*GenesisState) ProtoMessage ¶
func (*GenesisState) ProtoMessage()
func (*GenesisState) ProtoReflect ¶
func (x *GenesisState) ProtoReflect() protoreflect.Message
func (*GenesisState) Reset ¶
func (x *GenesisState) Reset()
func (*GenesisState) String ¶
func (x *GenesisState) String() string
type MsgClient ¶
type MsgClient interface {
// UpdateParams defines a (governance) operation for updating the module
// parameters. The authority defaults to the x/gov module account.
UpdateParams(ctx context.Context, in *MsgUpdateParams, opts ...grpc.CallOption) (*MsgUpdateParamsResponse, error)
UpdateParam(ctx context.Context, in *MsgUpdateParam, opts ...grpc.CallOption) (*MsgUpdateParamResponse, error)
}
MsgClient is the client API for Msg service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
Msg defines the Msg service.
func NewMsgClient ¶
func NewMsgClient(cc grpc.ClientConnInterface) MsgClient
type MsgServer ¶
type MsgServer interface {
// UpdateParams defines a (governance) operation for updating the module
// parameters. The authority defaults to the x/gov module account.
UpdateParams(context.Context, *MsgUpdateParams) (*MsgUpdateParamsResponse, error)
UpdateParam(context.Context, *MsgUpdateParam) (*MsgUpdateParamResponse, error)
// contains filtered or unexported methods
}
MsgServer is the server API for Msg service. All implementations must embed UnimplementedMsgServer for forward compatibility
Msg defines the Msg service.
type MsgUpdateParam ¶
type MsgUpdateParam struct {
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Types that are assignable to AsType:
//
// *MsgUpdateParam_AsString
// *MsgUpdateParam_AsUint64
// *MsgUpdateParam_AsBytes
AsType isMsgUpdateParam_AsType `protobuf_oneof:"as_type"`
// contains filtered or unexported fields
}
MsgUpdateParam is the Msg/UpdateParam request type to update a single param.
func (*MsgUpdateParam) Descriptor
deprecated
func (*MsgUpdateParam) Descriptor() ([]byte, []int)
Deprecated: Use MsgUpdateParam.ProtoReflect.Descriptor instead.
func (*MsgUpdateParam) GetAsBytes ¶
func (x *MsgUpdateParam) GetAsBytes() []byte
func (*MsgUpdateParam) GetAsString ¶
func (x *MsgUpdateParam) GetAsString() string
func (*MsgUpdateParam) GetAsType ¶
func (x *MsgUpdateParam) GetAsType() isMsgUpdateParam_AsType
func (*MsgUpdateParam) GetAsUint64 ¶
func (x *MsgUpdateParam) GetAsUint64() uint64
func (*MsgUpdateParam) GetAuthority ¶
func (x *MsgUpdateParam) GetAuthority() string
func (*MsgUpdateParam) GetName ¶
func (x *MsgUpdateParam) GetName() string
func (*MsgUpdateParam) ProtoMessage ¶
func (*MsgUpdateParam) ProtoMessage()
func (*MsgUpdateParam) ProtoReflect ¶
func (x *MsgUpdateParam) ProtoReflect() protoreflect.Message
func (*MsgUpdateParam) Reset ¶
func (x *MsgUpdateParam) Reset()
func (*MsgUpdateParam) String ¶
func (x *MsgUpdateParam) String() string
type MsgUpdateParamResponse ¶
type MsgUpdateParamResponse struct {
Params *Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params,omitempty"`
// contains filtered or unexported fields
}
MsgUpdateParamResponse defines the response structure for executing a MsgUpdateParam message after a single param update.
func (*MsgUpdateParamResponse) Descriptor
deprecated
func (*MsgUpdateParamResponse) Descriptor() ([]byte, []int)
Deprecated: Use MsgUpdateParamResponse.ProtoReflect.Descriptor instead.
func (*MsgUpdateParamResponse) GetParams ¶
func (x *MsgUpdateParamResponse) GetParams() *Params
func (*MsgUpdateParamResponse) ProtoMessage ¶
func (*MsgUpdateParamResponse) ProtoMessage()
func (*MsgUpdateParamResponse) ProtoReflect ¶
func (x *MsgUpdateParamResponse) ProtoReflect() protoreflect.Message
func (*MsgUpdateParamResponse) Reset ¶
func (x *MsgUpdateParamResponse) Reset()
func (*MsgUpdateParamResponse) String ¶
func (x *MsgUpdateParamResponse) String() string
type MsgUpdateParam_AsBytes ¶
type MsgUpdateParam_AsBytes struct {
AsBytes []byte `protobuf:"bytes,7,opt,name=as_bytes,json=asBytes,proto3,oneof"`
}
type MsgUpdateParam_AsString ¶
type MsgUpdateParam_AsString struct {
AsString string `protobuf:"bytes,3,opt,name=as_string,json=asString,proto3,oneof"`
}
type MsgUpdateParam_AsUint64 ¶
type MsgUpdateParam_AsUint64 struct {
AsUint64 uint64 `protobuf:"varint,6,opt,name=as_uint64,json=asUint64,proto3,oneof"`
}
type MsgUpdateParams ¶
type MsgUpdateParams struct {
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// NOTE: All parameters must be supplied.
Params *Params `protobuf:"bytes,2,opt,name=params,proto3" json:"params,omitempty"`
// contains filtered or unexported fields
}
MsgUpdateParams is the Msg/UpdateParams request type.
func (*MsgUpdateParams) Descriptor
deprecated
func (*MsgUpdateParams) Descriptor() ([]byte, []int)
Deprecated: Use MsgUpdateParams.ProtoReflect.Descriptor instead.
func (*MsgUpdateParams) GetAuthority ¶
func (x *MsgUpdateParams) GetAuthority() string
func (*MsgUpdateParams) GetParams ¶
func (x *MsgUpdateParams) GetParams() *Params
func (*MsgUpdateParams) ProtoMessage ¶
func (*MsgUpdateParams) ProtoMessage()
func (*MsgUpdateParams) ProtoReflect ¶
func (x *MsgUpdateParams) ProtoReflect() protoreflect.Message
func (*MsgUpdateParams) Reset ¶
func (x *MsgUpdateParams) Reset()
func (*MsgUpdateParams) String ¶
func (x *MsgUpdateParams) String() string
type MsgUpdateParamsResponse ¶
type MsgUpdateParamsResponse struct {
// contains filtered or unexported fields
}
MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.
func (*MsgUpdateParamsResponse) Descriptor
deprecated
func (*MsgUpdateParamsResponse) Descriptor() ([]byte, []int)
Deprecated: Use MsgUpdateParamsResponse.ProtoReflect.Descriptor instead.
func (*MsgUpdateParamsResponse) ProtoMessage ¶
func (*MsgUpdateParamsResponse) ProtoMessage()
func (*MsgUpdateParamsResponse) ProtoReflect ¶
func (x *MsgUpdateParamsResponse) ProtoReflect() protoreflect.Message
func (*MsgUpdateParamsResponse) Reset ¶
func (x *MsgUpdateParamsResponse) Reset()
func (*MsgUpdateParamsResponse) String ¶
func (x *MsgUpdateParamsResponse) String() string
type Params ¶
type Params struct {
// num_blocks_per_session is the number of blocks between the session start & end heights.
NumBlocksPerSession uint64 `protobuf:"varint,1,opt,name=num_blocks_per_session,json=numBlocksPerSession,proto3" json:"num_blocks_per_session,omitempty"`
// grace_period_end_offset_blocks is the number of blocks, after the session end height,
// during which the supplier can still service payable relays.
// Suppliers will need to recreate a claim for the previous session (if already created) to
// get paid for the additional relays.
GracePeriodEndOffsetBlocks uint64 `` /* 146-byte string literal not displayed */
// claim_window_open_offset_blocks is the number of blocks after the session grace
// period height, at which the claim window opens.
ClaimWindowOpenOffsetBlocks uint64 `` /* 149-byte string literal not displayed */
// claim_window_close_offset_blocks is the number of blocks after the claim window
// open height, at which the claim window closes.
ClaimWindowCloseOffsetBlocks uint64 `` /* 152-byte string literal not displayed */
// proof_window_open_offset_blocks is the number of blocks after the claim window
// close height, at which the proof window opens.
ProofWindowOpenOffsetBlocks uint64 `` /* 149-byte string literal not displayed */
// proof_window_close_offset_blocks is the number of blocks after the proof window
// open height, at which the proof window closes.
ProofWindowCloseOffsetBlocks uint64 `` /* 152-byte string literal not displayed */
// supplier_unbonding_period_sessions is the number of sessions that a supplier must wait after
// unstaking before their staked assets are moved to their account balance.
// Onchain business logic requires, and ensures, that the corresponding block count of the unbonding
// period will exceed the end of any active claim & proof lifecycles.
SupplierUnbondingPeriodSessions uint64 `` /* 159-byte string literal not displayed */
// application_unbonding_period_sessions is the number of sessions that an application must wait after
// unstaking before their staked assets are moved to their account balance.
// Onchain business logic requires, and ensures, that the corresponding block count of the
// application unbonding period will exceed the end of its corresponding proof window close height.
ApplicationUnbondingPeriodSessions uint64 `` /* 168-byte string literal not displayed */
// The amount of upokt that a compute unit should translate to when settling a session.
// DEV_NOTE: This used to be under x/tokenomics but has been moved here to avoid cyclic dependencies.
ComputeUnitsToTokensMultiplier uint64 `` /* 158-byte string literal not displayed */
// gateway_unbonding_period_sessions is the number of sessions that a gateway must wait after
// unstaking before their staked assets are moved to its account balance.
GatewayUnbondingPeriodSessions uint64 `` /* 157-byte string literal not displayed */
// contains filtered or unexported fields
}
Params defines the parameters for the module.
func (*Params) Descriptor
deprecated
func (*Params) GetApplicationUnbondingPeriodSessions ¶
func (*Params) GetClaimWindowCloseOffsetBlocks ¶
func (*Params) GetClaimWindowOpenOffsetBlocks ¶
func (*Params) GetComputeUnitsToTokensMultiplier ¶
func (*Params) GetGatewayUnbondingPeriodSessions ¶
func (*Params) GetGracePeriodEndOffsetBlocks ¶
func (*Params) GetNumBlocksPerSession ¶
func (*Params) GetProofWindowCloseOffsetBlocks ¶
func (*Params) GetProofWindowOpenOffsetBlocks ¶
func (*Params) GetSupplierUnbondingPeriodSessions ¶
func (*Params) ProtoMessage ¶
func (*Params) ProtoMessage()
func (*Params) ProtoReflect ¶
func (x *Params) ProtoReflect() protoreflect.Message
type QueryClient ¶
type QueryClient interface {
// Parameters 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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
Query defines the gRPC querier service.
func NewQueryClient ¶
func NewQueryClient(cc grpc.ClientConnInterface) QueryClient
type QueryParamsRequest ¶
type QueryParamsRequest struct {
// contains filtered or unexported fields
}
QueryParamsRequest is request type for the Query/Params RPC method.
func (*QueryParamsRequest) Descriptor
deprecated
func (*QueryParamsRequest) Descriptor() ([]byte, []int)
Deprecated: Use QueryParamsRequest.ProtoReflect.Descriptor instead.
func (*QueryParamsRequest) ProtoMessage ¶
func (*QueryParamsRequest) ProtoMessage()
func (*QueryParamsRequest) ProtoReflect ¶
func (x *QueryParamsRequest) ProtoReflect() protoreflect.Message
func (*QueryParamsRequest) Reset ¶
func (x *QueryParamsRequest) Reset()
func (*QueryParamsRequest) String ¶
func (x *QueryParamsRequest) String() string
type QueryParamsResponse ¶
type QueryParamsResponse struct {
// params holds all the parameters of this module.
Params *Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params,omitempty"`
// contains filtered or unexported fields
}
QueryParamsResponse is response type for the Query/Params RPC method.
func (*QueryParamsResponse) Descriptor
deprecated
func (*QueryParamsResponse) Descriptor() ([]byte, []int)
Deprecated: Use QueryParamsResponse.ProtoReflect.Descriptor instead.
func (*QueryParamsResponse) GetParams ¶
func (x *QueryParamsResponse) GetParams() *Params
func (*QueryParamsResponse) ProtoMessage ¶
func (*QueryParamsResponse) ProtoMessage()
func (*QueryParamsResponse) ProtoReflect ¶
func (x *QueryParamsResponse) ProtoReflect() protoreflect.Message
func (*QueryParamsResponse) Reset ¶
func (x *QueryParamsResponse) Reset()
func (*QueryParamsResponse) String ¶
func (x *QueryParamsResponse) String() string
type QueryServer ¶
type QueryServer interface {
// Parameters queries the parameters of the module.
Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, error)
// contains filtered or unexported methods
}
QueryServer is the server API for Query service. All implementations must embed UnimplementedQueryServer for forward compatibility
Query defines the gRPC querier service.
type RPCType ¶
type RPCType int32
Enum to define RPC types
func (RPCType) Descriptor ¶
func (RPCType) Descriptor() protoreflect.EnumDescriptor
func (RPCType) EnumDescriptor
deprecated
func (RPCType) Number ¶
func (x RPCType) Number() protoreflect.EnumNumber
func (RPCType) Type ¶
func (RPCType) Type() protoreflect.EnumType
type Service ¶
type Service struct {
// For example, what if we want to request a session for a certain service but with some additional configs that identify it?
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Unique identifier for the service
// TODO_POST_MAINNET: Rename service.name to service.description
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // (Optional) Human readable description of the service
// The cost of a single relay for this service in terms of compute units.
// Must be used alongside the global 'compute_units_to_tokens_multiplier' to calculate the cost of a relay for this service.
// cost_per_relay_for_specific_service = compute_units_per_relay_for_specific_service * compute_units_to_tokens_multiplier_global_value
ComputeUnitsPerRelay uint64 `` // Compute units required per relay for this service
/* 126-byte string literal not displayed */
// The owner address that created the service.
// It is the address that receives rewards based on the Service's onchain usage
// It is the only address that can update the service configuration (e.g. compute_units_per_relay),
// or make other updates to it.
OwnerAddress string `protobuf:"bytes,4,opt,name=owner_address,json=ownerAddress,proto3" json:"owner_address,omitempty"` // The Bech32 address of the service owner / creator
// contains filtered or unexported fields
}
Service message to encapsulate unique and semantic identifiers for a service on the network
func (*Service) Descriptor
deprecated
func (*Service) GetComputeUnitsPerRelay ¶
func (*Service) GetOwnerAddress ¶
func (*Service) ProtoMessage ¶
func (*Service) ProtoMessage()
func (*Service) ProtoReflect ¶
func (x *Service) ProtoReflect() protoreflect.Message
type ServiceConfigUpdate ¶
type ServiceConfigUpdate struct {
// Operator address of the supplier corresponding to the service configuration change
OperatorAddress string `protobuf:"bytes,1,opt,name=operator_address,json=operatorAddress,proto3" json:"operator_address,omitempty"`
// The specific service configuration that was added, modified or scheduled for removal
Service *SupplierServiceConfig `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"`
// Block height at which this service configuration became active in the network
ActivationHeight int64 `protobuf:"varint,3,opt,name=activation_height,json=activationHeight,proto3" json:"activation_height,omitempty"`
// Block height at which this service configuration was deactivated (0 if still active)
// For service configs scheduled for deactivation:
// - This field stores the block height when deactivation will occur
// - After deactivation, the config remains in history only as needed for claim settlement
// - Once no longer required for settlement, the config is automatically removed by
// the EndBlockerPruneSupplierServiceConfigHistory process
DeactivationHeight int64 `protobuf:"varint,4,opt,name=deactivation_height,json=deactivationHeight,proto3" json:"deactivation_height,omitempty"`
// contains filtered or unexported fields
}
ServiceConfigUpdate tracks a change in a supplier's service configurations at a specific block height, enabling tracking of configuration changes over time. This record helps maintain a complete history of service configs and their availability periods.
func (*ServiceConfigUpdate) Descriptor
deprecated
func (*ServiceConfigUpdate) Descriptor() ([]byte, []int)
Deprecated: Use ServiceConfigUpdate.ProtoReflect.Descriptor instead.
func (*ServiceConfigUpdate) GetActivationHeight ¶ added in v0.1.8
func (x *ServiceConfigUpdate) GetActivationHeight() int64
func (*ServiceConfigUpdate) GetDeactivationHeight ¶ added in v0.1.8
func (x *ServiceConfigUpdate) GetDeactivationHeight() int64
func (*ServiceConfigUpdate) GetOperatorAddress ¶ added in v0.1.8
func (x *ServiceConfigUpdate) GetOperatorAddress() string
func (*ServiceConfigUpdate) GetService ¶ added in v0.1.8
func (x *ServiceConfigUpdate) GetService() *SupplierServiceConfig
func (*ServiceConfigUpdate) ProtoMessage ¶
func (*ServiceConfigUpdate) ProtoMessage()
func (*ServiceConfigUpdate) ProtoReflect ¶
func (x *ServiceConfigUpdate) ProtoReflect() protoreflect.Message
func (*ServiceConfigUpdate) Reset ¶
func (x *ServiceConfigUpdate) Reset()
func (*ServiceConfigUpdate) String ¶
func (x *ServiceConfigUpdate) String() string
type ServiceConfigUpdateDeprecated ¶ added in v0.1.8
type ServiceConfigUpdateDeprecated struct {
Services []*SupplierServiceConfig `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
EffectiveBlockHeight uint64 `protobuf:"varint,2,opt,name=effective_block_height,json=effectiveBlockHeight,proto3" json:"effective_block_height,omitempty"`
// contains filtered or unexported fields
}
func (*ServiceConfigUpdateDeprecated) Descriptor
deprecated
added in
v0.1.8
func (*ServiceConfigUpdateDeprecated) Descriptor() ([]byte, []int)
Deprecated: Use ServiceConfigUpdateDeprecated.ProtoReflect.Descriptor instead.
func (*ServiceConfigUpdateDeprecated) GetEffectiveBlockHeight ¶ added in v0.1.8
func (x *ServiceConfigUpdateDeprecated) GetEffectiveBlockHeight() uint64
func (*ServiceConfigUpdateDeprecated) GetServices ¶ added in v0.1.8
func (x *ServiceConfigUpdateDeprecated) GetServices() []*SupplierServiceConfig
func (*ServiceConfigUpdateDeprecated) ProtoMessage ¶ added in v0.1.8
func (*ServiceConfigUpdateDeprecated) ProtoMessage()
func (*ServiceConfigUpdateDeprecated) ProtoReflect ¶ added in v0.1.8
func (x *ServiceConfigUpdateDeprecated) ProtoReflect() protoreflect.Message
func (*ServiceConfigUpdateDeprecated) Reset ¶ added in v0.1.8
func (x *ServiceConfigUpdateDeprecated) Reset()
func (*ServiceConfigUpdateDeprecated) String ¶ added in v0.1.8
func (x *ServiceConfigUpdateDeprecated) String() string
type ServiceRevenueShare ¶
type ServiceRevenueShare struct {
// contains filtered or unexported fields
}
ServiceRevenueShare message to hold revenue share configuration details
func (*ServiceRevenueShare) Descriptor
deprecated
func (*ServiceRevenueShare) Descriptor() ([]byte, []int)
Deprecated: Use ServiceRevenueShare.ProtoReflect.Descriptor instead.
func (*ServiceRevenueShare) GetAddress ¶
func (x *ServiceRevenueShare) GetAddress() string
func (*ServiceRevenueShare) GetRevSharePercentage ¶
func (x *ServiceRevenueShare) GetRevSharePercentage() uint64
func (*ServiceRevenueShare) ProtoMessage ¶
func (*ServiceRevenueShare) ProtoMessage()
func (*ServiceRevenueShare) ProtoReflect ¶
func (x *ServiceRevenueShare) ProtoReflect() protoreflect.Message
func (*ServiceRevenueShare) Reset ¶
func (x *ServiceRevenueShare) Reset()
func (*ServiceRevenueShare) String ¶
func (x *ServiceRevenueShare) String() string
type Supplier ¶
type Supplier struct {
// Owner address that controls the staked funds and receives rewards by default
// Cannot be updated by the operator
OwnerAddress string `protobuf:"bytes,1,opt,name=owner_address,json=ownerAddress,proto3" json:"owner_address,omitempty"`
// Operator address managing the offchain server
// Immutable for supplier's lifespan - requires unstake/re-stake to change.
// Can update supplier configs except for owner address.
OperatorAddress string `protobuf:"bytes,2,opt,name=operator_address,json=operatorAddress,proto3" json:"operator_address,omitempty"`
// Total amount of staked uPOKT
Stake *v1beta1.Coin `protobuf:"bytes,3,opt,name=stake,proto3" json:"stake,omitempty"`
// List of service configurations supported by this supplier
Services []*SupplierServiceConfig `protobuf:"bytes,4,rep,name=services,proto3" json:"services,omitempty"`
// Session end height when supplier initiated unstaking (0 if not unstaking)
UnstakeSessionEndHeight uint64 `` /* 135-byte string literal not displayed */
// List of historical service configuration updates, tracking the suppliers
// services update and corresponding activation heights.
ServiceConfigHistory []*ServiceConfigUpdate `protobuf:"bytes,6,rep,name=service_config_history,json=serviceConfigHistory,proto3" json:"service_config_history,omitempty"`
// contains filtered or unexported fields
}
Supplier represents an actor in Pocket Network that provides RPC services
func (*Supplier) Descriptor
deprecated
func (*Supplier) GetOperatorAddress ¶
func (*Supplier) GetOwnerAddress ¶
func (*Supplier) GetServiceConfigHistory ¶
func (x *Supplier) GetServiceConfigHistory() []*ServiceConfigUpdate
func (*Supplier) GetServices ¶
func (x *Supplier) GetServices() []*SupplierServiceConfig
func (*Supplier) GetUnstakeSessionEndHeight ¶
func (*Supplier) ProtoMessage ¶
func (*Supplier) ProtoMessage()
func (*Supplier) ProtoReflect ¶
func (x *Supplier) ProtoReflect() protoreflect.Message
type SupplierDeprecated ¶ added in v0.1.8
type SupplierDeprecated struct {
OwnerAddress string `protobuf:"bytes,1,opt,name=owner_address,json=ownerAddress,proto3" json:"owner_address,omitempty"`
OperatorAddress string `protobuf:"bytes,2,opt,name=operator_address,json=operatorAddress,proto3" json:"operator_address,omitempty"`
Stake *v1beta1.Coin `protobuf:"bytes,3,opt,name=stake,proto3" json:"stake,omitempty"`
Services []*SupplierServiceConfig `protobuf:"bytes,4,rep,name=services,proto3" json:"services,omitempty"`
UnstakeSessionEndHeight uint64 `` /* 135-byte string literal not displayed */
ServiceConfigHistory []*ServiceConfigUpdateDeprecated `protobuf:"bytes,6,rep,name=service_config_history,json=serviceConfigHistory,proto3" json:"service_config_history,omitempty"`
// contains filtered or unexported fields
}
func (*SupplierDeprecated) Descriptor
deprecated
added in
v0.1.8
func (*SupplierDeprecated) Descriptor() ([]byte, []int)
Deprecated: Use SupplierDeprecated.ProtoReflect.Descriptor instead.
func (*SupplierDeprecated) GetOperatorAddress ¶ added in v0.1.8
func (x *SupplierDeprecated) GetOperatorAddress() string
func (*SupplierDeprecated) GetOwnerAddress ¶ added in v0.1.8
func (x *SupplierDeprecated) GetOwnerAddress() string
func (*SupplierDeprecated) GetServiceConfigHistory ¶ added in v0.1.8
func (x *SupplierDeprecated) GetServiceConfigHistory() []*ServiceConfigUpdateDeprecated
func (*SupplierDeprecated) GetServices ¶ added in v0.1.8
func (x *SupplierDeprecated) GetServices() []*SupplierServiceConfig
func (*SupplierDeprecated) GetStake ¶ added in v0.1.8
func (x *SupplierDeprecated) GetStake() *v1beta1.Coin
func (*SupplierDeprecated) GetUnstakeSessionEndHeight ¶ added in v0.1.8
func (x *SupplierDeprecated) GetUnstakeSessionEndHeight() uint64
func (*SupplierDeprecated) ProtoMessage ¶ added in v0.1.8
func (*SupplierDeprecated) ProtoMessage()
func (*SupplierDeprecated) ProtoReflect ¶ added in v0.1.8
func (x *SupplierDeprecated) ProtoReflect() protoreflect.Message
func (*SupplierDeprecated) Reset ¶ added in v0.1.8
func (x *SupplierDeprecated) Reset()
func (*SupplierDeprecated) String ¶ added in v0.1.8
func (x *SupplierDeprecated) String() string
type SupplierEndpoint ¶
type SupplierEndpoint struct {
Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` // URL of the endpoint
RpcType RPCType `protobuf:"varint,2,opt,name=rpc_type,json=rpcType,proto3,enum=pocket.shared.RPCType" json:"rpc_type,omitempty"` // Type of RPC exposed on the url above
Configs []*ConfigOption `protobuf:"bytes,3,rep,name=configs,proto3" json:"configs,omitempty"` // Additional configuration options for the endpoint
// contains filtered or unexported fields
}
SupplierEndpoint message to hold service configuration details
func (*SupplierEndpoint) Descriptor
deprecated
func (*SupplierEndpoint) Descriptor() ([]byte, []int)
Deprecated: Use SupplierEndpoint.ProtoReflect.Descriptor instead.
func (*SupplierEndpoint) GetConfigs ¶
func (x *SupplierEndpoint) GetConfigs() []*ConfigOption
func (*SupplierEndpoint) GetRpcType ¶
func (x *SupplierEndpoint) GetRpcType() RPCType
func (*SupplierEndpoint) GetUrl ¶
func (x *SupplierEndpoint) GetUrl() string
func (*SupplierEndpoint) ProtoMessage ¶
func (*SupplierEndpoint) ProtoMessage()
func (*SupplierEndpoint) ProtoReflect ¶
func (x *SupplierEndpoint) ProtoReflect() protoreflect.Message
func (*SupplierEndpoint) Reset ¶
func (x *SupplierEndpoint) Reset()
func (*SupplierEndpoint) String ¶
func (x *SupplierEndpoint) String() string
type SupplierServiceConfig ¶
type SupplierServiceConfig struct {
ServiceId string `protobuf:"bytes,1,opt,name=service_id,json=serviceId,proto3" json:"service_id,omitempty"` // The Service ID for which the supplier is configured
Endpoints []*SupplierEndpoint `protobuf:"bytes,2,rep,name=endpoints,proto3" json:"endpoints,omitempty"` // List of endpoints for the service
// contains filtered or unexported fields
}
SupplierServiceConfig holds the service configuration the supplier stakes for
func (*SupplierServiceConfig) Descriptor
deprecated
func (*SupplierServiceConfig) Descriptor() ([]byte, []int)
Deprecated: Use SupplierServiceConfig.ProtoReflect.Descriptor instead.
func (*SupplierServiceConfig) GetEndpoints ¶
func (x *SupplierServiceConfig) GetEndpoints() []*SupplierEndpoint
func (*SupplierServiceConfig) GetRevShare ¶
func (x *SupplierServiceConfig) GetRevShare() []*ServiceRevenueShare
func (*SupplierServiceConfig) GetServiceId ¶
func (x *SupplierServiceConfig) GetServiceId() string
func (*SupplierServiceConfig) ProtoMessage ¶
func (*SupplierServiceConfig) ProtoMessage()
func (*SupplierServiceConfig) ProtoReflect ¶
func (x *SupplierServiceConfig) ProtoReflect() protoreflect.Message
func (*SupplierServiceConfig) Reset ¶
func (x *SupplierServiceConfig) Reset()
func (*SupplierServiceConfig) String ¶
func (x *SupplierServiceConfig) String() string
type UnimplementedMsgServer ¶
type UnimplementedMsgServer struct {
}
UnimplementedMsgServer must be embedded to have forward compatible implementations.
func (UnimplementedMsgServer) UpdateParam ¶
func (UnimplementedMsgServer) UpdateParam(context.Context, *MsgUpdateParam) (*MsgUpdateParamResponse, error)
func (UnimplementedMsgServer) UpdateParams ¶
func (UnimplementedMsgServer) UpdateParams(context.Context, *MsgUpdateParams) (*MsgUpdateParamsResponse, error)
type UnimplementedQueryServer ¶
type UnimplementedQueryServer struct {
}
UnimplementedQueryServer must be embedded to have forward compatible implementations.
func (UnimplementedQueryServer) Params ¶
func (UnimplementedQueryServer) Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, error)
type UnsafeMsgServer ¶
type UnsafeMsgServer interface {
// contains filtered or unexported methods
}
UnsafeMsgServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MsgServer will result in compilation errors.
type UnsafeQueryServer ¶
type UnsafeQueryServer interface {
// contains filtered or unexported methods
}
UnsafeQueryServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to QueryServer will result in compilation errors.