types

package
v0.1.30 Latest Latest
Warning

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

 Go to latest Published: Oct 20, 2025 License: MIT Imports: 34 Imported by: 10

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

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

	// MemStoreKey defines the in-memory store key
	MemStoreKey = "mem_shared"
)
View Source 
const (
	DefaultNumBlocksPerSession                = 10
	ParamNumBlocksPerSession                  = "num_blocks_per_session"
	DefaultGracePeriodEndOffsetBlocks         = 1
	ParamGracePeriodEndOffsetBlocks           = "grace_period_end_offset_blocks"
	DefaultClaimWindowOpenOffsetBlocks        = 1
	ParamClaimWindowOpenOffsetBlocks          = "claim_window_open_offset_blocks"
	DefaultClaimWindowCloseOffsetBlocks       = 4
	ParamClaimWindowCloseOffsetBlocks         = "claim_window_close_offset_blocks"
	DefaultProofWindowOpenOffsetBlocks        = 0
	ParamProofWindowOpenOffsetBlocks          = "proof_window_open_offset_blocks"
	DefaultProofWindowCloseOffsetBlocks       = 4
	ParamProofWindowCloseOffsetBlocks         = "proof_window_close_offset_blocks"
	DefaultSupplierUnbondingPeriodSessions    = 1 // 1 session
	ParamSupplierUnbondingPeriodSessions      = "supplier_unbonding_period_sessions"
	DefaultApplicationUnbondingPeriodSessions = 1 // 1 session
	ParamApplicationUnbondingPeriodSessions   = "application_unbonding_period_sessions"
	DefaultGatewayUnbondingPeriodSessions     = 1 // 1 session
	ParamGatewayUnbondingPeriodSessions       = "gateway_unbonding_period_sessions"

	// TODO_MAINNET_MIGRATION(@olshansk): Determine the default value.
	// The default compute unit cost multiplier in pPOKT (i.e. 1/1e6 uPOKT)
	DefaultComputeUnitsToTokensMultiplier = 42_000_000
	ParamComputeUnitsToTokensMultiplier   = "compute_units_to_tokens_multiplier"

	// The default compute unit cost granularity corresponding to 1pPOKT (i.e. 1/1e6 uPOKT)
	DefaultComputeUnitCostGranularity = 1_000_000
	ParamComputeUnitCostGranularity   = "compute_unit_cost_granularity"
)
View Source 
const (
	// ComputeUnitsPerRelayMax is the maximum allowed compute_units_per_relay value when adding or updating a service.
	ComputeUnitsPerRelayMax uint64 = 2 << 20 // 1_048_576 (2^20)

	// MaxServiceMetadataSizeBytes is the maximum allowed size for the experimental metadata payload.
	// This cap is enforced onchain to prevent excessively large API specifications from bloating state.
	// The experimental metadata bytes cannot exceed this limit.
	// TODO_POST_MAINNET: Consider making this a governance parameter for flexibility.
	MaxServiceMetadataSizeBytes = 256 * 1_024 // 262_144 bytes (256 KiB)

)
View Source 
const DefaultIndex uint64 = 1

DefaultIndex is the default global index

View Source 
const (
	// NoDeactivationHeight represents that a service configuration has no deactivation
	// height and is considered active indefinitely.
	NoDeactivationHeight = iota // 0
)
View Source 
const SupplierNotUnstaking uint64 = iota

SupplierNotUnstaking is the value of `unstake_session_end_height` if the supplier is not actively in the unbonding period.

Variables

View Source 
var (
	ErrSharedInvalidSigner               = sdkerrors.Register(ModuleName, 1100, "expected gov account as only signer for proposal message")
	ErrSharedInvalidAddress              = sdkerrors.Register(ModuleName, 1101, "invalid address")
	ErrSharedParamNameInvalid            = sdkerrors.Register(ModuleName, 1102, "the provided param name is invalid")
	ErrSharedParamInvalid                = sdkerrors.Register(ModuleName, 1103, "the provided param is invalid")
	ErrSharedEmitEvent                   = sdkerrors.Register(ModuleName, 1104, "failed to emit event")
	ErrSharedUnauthorizedSupplierUpdate  = sdkerrors.Register(ModuleName, 1105, "unauthorized supplier update")
	ErrSharedInvalidRevShare             = sdkerrors.Register(ModuleName, 1106, "invalid revenue share configuration")
	ErrSharedInvalidService              = sdkerrors.Register(ModuleName, 1107, "invalid service")
	ErrSharedInvalidServiceId            = sdkerrors.Register(ModuleName, 1108, "invalid service ID")
	ErrSharedInvalidServiceName          = sdkerrors.Register(ModuleName, 1109, "invalid service name")
	ErrSharedInvalidComputeUnitsPerRelay = sdkerrors.Register(ModuleName, 1110, "invalid compute units per relay")
	ErrSharedInvalidServiceMetadata      = sdkerrors.Register(ModuleName, 1111, "invalid service metadata")
)

x/shared 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 (
	ErrInvalidLengthModule        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowModule          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupModule = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	KeyNumBlocksPerSession                = []byte("NumBlocksPerSession")
	KeyGracePeriodEndOffsetBlocks         = []byte("GracePeriodEndOffsetBlocks")
	KeyClaimWindowOpenOffsetBlocks        = []byte("ClaimWindowOpenOffsetBlocks")
	KeyClaimWindowCloseOffsetBlocks       = []byte("ClaimWindowCloseOffsetBlocks")
	KeyProofWindowOpenOffsetBlocks        = []byte("ProofWindowOpenOffsetBlocks")
	KeyProofWindowCloseOffsetBlocks       = []byte("ProofWindowCloseOffsetBlocks")
	KeySupplierUnbondingPeriodSessions    = []byte("SupplierUnbondingPeriodSessions")
	KeyApplicationUnbondingPeriodSessions = []byte("ApplicationUnbondingPeriodSessions")
	KeyGatewayUnbondingPeriodSessions     = []byte("GatewayUnbondingPeriodSessions")
	KeyComputeUnitsToTokensMultiplier     = []byte("ComputeUnitsToTokensMultiplier")
	KeyComputeUnitCostGranularity         = []byte("ComputeUnitCostGranularity")
)
View Source 
var (
	ErrInvalidLengthParams        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowParams          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupParams = fmt.Errorf("proto: unexpected end of group")
)
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 (
	ErrInvalidLengthService        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowService          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupService = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	ErrInvalidLengthSupplier        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowSupplier          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupSupplier = 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 ConfigOptions_name = map[int32]string{
	0: "UNKNOWN_CONFIG",
	1: "TIMEOUT",
}
View Source 
var ConfigOptions_value = map[string]int32{
	"UNKNOWN_CONFIG": 0,
	"TIMEOUT":        1,
}
View Source 
var Msg_serviceDesc = _Msg_serviceDesc
View Source 
var (
	ParamsKey = []byte("p_shared")
)
View Source 
var Query_serviceDesc = _Query_serviceDesc
View Source 
var RPCType_name = map[int32]string{
	0: "UNKNOWN_RPC",
	1: "GRPC",
	2: "WEBSOCKET",
	3: "JSON_RPC",
	4: "REST",
	5: "COMET_BFT",
}
View Source 
var RPCType_value = map[string]int32{
	"UNKNOWN_RPC": 0,
	"GRPC":        1,
	"WEBSOCKET":   2,
	"JSON_RPC":    3,
	"REST":        4,
	"COMET_BFT":   5,
}

Functions

func GetClaimWindowCloseHeight added in v0.0.10 

func GetClaimWindowCloseHeight(sharedParams *Params, queryHeight int64) int64

GetClaimWindowCloseHeight returns the block height at which the claim window of the session that includes queryHeight closes, for the provided sharedParams.

func GetClaimWindowOpenHeight added in v0.0.10 

func GetClaimWindowOpenHeight(sharedParams *Params, queryHeight int64) int64

GetClaimWindowOpenHeight returns the block height at which the claim window of the session that includes queryHeight opens, for the provided sharedParams.

func GetEarliestSupplierClaimCommitHeight added in v0.0.10 

func GetEarliestSupplierClaimCommitHeight(
	sharedParams *Params,
	queryHeight int64,
	claimWindowOpenBlockHash []byte,
	supplierOperatorAddr string,
) int64

GetEarliestSupplierClaimCommitHeight returns the earliest block height at which a claim for the session that includes queryHeight can be committed for a given supplier and the passed sharedParams. TODO_TECHDEBT(@red-0ne): Having claim distribution windows was a requirement that was never determined to be necessary, but implemented regardless. We are keeping around the functions but TBD whether it is deemed necessary. The results of #711 are tangentially related to this requirement, after which the functions, helpers, comments and docs for claim distribution can either be repurposed or deleted.

func GetEarliestSupplierProofCommitHeight added in v0.0.10 

func GetEarliestSupplierProofCommitHeight(
	sharedParams *Params,
	queryHeight int64,
	proofWindowOpenBlockHash []byte,
	supplierOperatorAddr string,
) int64

GetEarliestSupplierProofCommitHeight returns the earliest block height at which a proof for the session that includes queryHeight can be committed for a given supplier and the passed sharedParams. TODO_TECHDEBT(@red-0ne): Having proof distribution windows was a requirement that was never determined to be necessary, but implemented regardless. We are keeping around the functions but TBD whether it is deemed necessary. The results of #711 are tangentially related to this requirement, after which the functions, helpers, comments and docs for claim distribution can either be repurposed or deleted.

func GetNextSessionStartHeight added in v0.0.10 

func GetNextSessionStartHeight(sharedParams *Params, queryHeight int64) int64

GetNextSessionStartHeight returns the start block height of the session following the session that includes queryHeight, given the passed sharedParams.

func GetNumPendingSessions added in v0.0.11 

func GetNumPendingSessions(sharedParams *Params) int64

GetNumPendingSessions returns the number of pending sessions (i.e. that have not yet been settled).

func GetProofWindowCloseHeight added in v0.0.10 

func GetProofWindowCloseHeight(sharedParams *Params, queryHeight int64) int64

GetProofWindowCloseHeight returns the block height at which the proof window of the session that includes queryHeight closes, given the passed sharedParams.

func GetProofWindowOpenHeight added in v0.0.10 

func GetProofWindowOpenHeight(sharedParams *Params, queryHeight int64) int64

GetProofWindowOpenHeight returns the block height at which the claim window of the session that includes queryHeight opens, given the passed sharedParams.

func GetSessionEndHeight added in v0.0.10 

func GetSessionEndHeight(sharedParams *Params, queryHeight int64) int64

GetSessionEndHeight returns the block height at which the session containing queryHeight ends, given the passed shared onchain parameters. Returns 0 if the block height is not a consensus produced block. Example: If NumBlocksPerSession == 4, sessions end at blocks 4, 8, 11, etc.

func GetSessionEndToProofWindowCloseBlocks added in v0.0.6 

func GetSessionEndToProofWindowCloseBlocks(params *Params) int64

GetSessionEndToProofWindowCloseBlocks returns the total number of blocks from the moment a session ends until the proof window closes.

func GetSessionGracePeriodEndHeight added in v0.0.10 

func GetSessionGracePeriodEndHeight(sharedParams *Params, queryHeight int64) int64

GetSessionGracePeriodEndHeight returns the block height at which the grace period for the session that includes queryHeight elapses, given the passed sharedParams. The grace period is the number of blocks after the session ends during which relays SHOULD be included in the session which most recently ended.

func GetSessionNumber added in v0.0.10 

func GetSessionNumber(sharedParams *Params, queryHeight int64) int64

GetSessionNumber returns the session number of the session containing queryHeight, given the passed onchain shared parameters. shared onchain parameters. Returns session number 0 if the block height is not a consensus produced block. Returns session number 1 for block 1 to block NumBlocksPerSession - 1 (inclusive). i.e. If NubBlocksPerSession == 4, session == 1 for [1, 4], session == 2 for [5, 8], etc.

func GetSessionStartHeight added in v0.0.10 

func GetSessionStartHeight(sharedParams *Params, queryHeight int64) int64

GetSessionStartHeight returns the block height at which the session containing queryHeight starts, given the passed shared onchain parameters. Returns 0 if the block height is not a consensus produced block. Example: If NumBlocksPerSession == 4, sessions start at blocks 1, 5, 9, etc.

func GetSettlementSessionEndHeight added in v0.0.10 

func GetSettlementSessionEndHeight(sharedParams *Params, queryHeight int64) int64

GetSettlementSessionEndHeight returns the end height of the session in which the session that includes queryHeight is settled, given the passed shared onchain parameters.

func GetSupplierUnbondingEndHeight added in v0.0.11 

func GetSupplierUnbondingEndHeight(
	sharedParams *Params,
	supplier *Supplier,
) int64

GetSupplierUnbondingEndHeight returns the session end height at which the given supplier finishes unbonding.

This calculates the absolute block height at which the supplier's unbonding period completes by adding the configured unbonding period (in sessions) to the supplier's unstake session end height.

func IsGracePeriodElapsed added in v0.0.10 

func IsGracePeriodElapsed(sharedParams *Params, queryHeight, currentHeight int64) bool

IsGracePeriodElapsed returns true if the grace period for the session ending with sessionEndHeight has elapsed, given currentHeight.

func IsSessionEndHeight added in v0.0.10 

func IsSessionEndHeight(sharedParams *Params, queryHeight int64) bool

IsSessionEndHeight returns true if the queryHeight is the last block of the session.

func IsSessionStartHeight added in v0.0.14 

func IsSessionStartHeight(sharedParams *Params, queryHeight int64) bool

IsSessionStartHeight returns true if the height is the first block of the session.

func IsValidEndpointUrl added in v0.0.8 

func IsValidEndpointUrl(endpoint string) bool

IsValidEndpointUrl checks if the provided string is a valid URL.

func IsValidServiceId added in v0.0.8 

func IsValidServiceId(serviceId string) error

IsValidServiceId checks if the input string is a valid serviceId

func IsValidServiceName added in v0.0.8 

func IsValidServiceName(serviceName string) error

IsValidServiceName checks if the input string is a valid serviceName

func KeyPrefix 

func KeyPrefix(p string) []byte

func NewRecordIterator added in v0.1.5 

func NewRecordIterator[T any](
	storeIter storetypes.Iterator,
	deserializeRecord DataRecordAccessor[T],
) *recordIterator[T]

NewRecordIterator creates a new RecordIterator instance. Parameters: - storeIter: The underlying store iterator - deserializeRecord: Function to convert byte data to typed objects Returns: - A configured recordIterator instance TODO_CONSIDERATION: Add the possibility to configure a filter function such that the iterator can skip certain records based on custom logic. This could be useful to encapsulate logic such as: - Skipping nil records - Filtering by a specific field Refer to the following discussion for more context: https://github.com/pokt-network/poktroll/pull/1226#discussion_r2052961278

func ParamKeyTable 

func ParamKeyTable() paramtypes.KeyTable

ParamKeyTable the param key table for launch module

func RPCTypeIsValid added in v0.1.27 

func RPCTypeIsValid(rpcType RPCType) bool

rpcTypeIsValid checks if the RPC type is valid. It is used to validate the RPC-type service-specific service configs.

func RegisterInterfaces 

func RegisterInterfaces(registry cdctypes.InterfaceRegistry)

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 ValidateAppServiceConfigs added in v0.0.10 

func ValidateAppServiceConfigs(services []*ApplicationServiceConfig) error

ValidateAppServiceConfigs returns an error if any of the application service configs are invalid

func ValidateApplicationUnbondingPeriodSessions added in v0.0.7 

func ValidateApplicationUnbondingPeriodSessions(applicationUnboindingPeriodSessionsAny any) error

ValidateApplicationUnbondingPeriodSessions validates the ApplicationUnbondingPeriodSessions governance parameter. NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidateClaimWindowCloseOffsetBlocks 

func ValidateClaimWindowCloseOffsetBlocks(claimWindowCloseOffsetBlocksAny any) error

ValidateClaimWindowCloseOffsetBlocks validates the ClaimWindowCloseOffsetBlocks param NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidateClaimWindowOpenOffsetBlocks 

func ValidateClaimWindowOpenOffsetBlocks(claimWindowOpenOffsetBlocksAny any) error

ValidateClaimWindowOpenOffsetBlocks validates the ClaimWindowOpenOffsetBlocks param NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidateComputeUnitCostGranularity added in v0.1.13 

func ValidateComputeUnitCostGranularity(computeUnitCostGranularityAny any) error

ValidateComputeUnitCostGranularity validates the ComputeUnitCostGranularity governance parameter. NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidateComputeUnitsPerRelay added in v0.0.8 

func ValidateComputeUnitsPerRelay(computeUnitsPerRelay uint64) error

ValidateComputeUnitsPerRelay makes sure the compute units per relay is a valid value

func ValidateComputeUnitsToTokensMultiplier added in v0.0.10 

func ValidateComputeUnitsToTokensMultiplier(computeUnitsToTokensMultiplierAny any) error

ValidateComputeUnitsToTokensMultiplier validates the ComputeUnitsToTokensMultiplier governance parameter. NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidateGatewayUnbondingPeriodSessions added in v0.0.13 

func ValidateGatewayUnbondingPeriodSessions(gatewayUnboindingPeriodSessionsAny any) error

ValidateGatewayUnbondingPeriodSessions validates the GatewayUnbondingPeriodSessions governance parameter. NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidateGracePeriodEndOffsetBlocks 

func ValidateGracePeriodEndOffsetBlocks(gracePeriodEndOffsetBlocksAny any) error

ValidateGracePeriodEndOffsetBlocks validates the GracePeriodEndOffsetBlocks param NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidateNumBlocksPerSession 

func ValidateNumBlocksPerSession(numBlocksPerSessionAny any) error

ValidateNumBlocksPerSession validates the NumBlocksPerSession param NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidatePositiveuPOKT added in v0.1.30 

func ValidatePositiveuPOKT(coinStr string) error

ValidatePositiveuPOKT performs the following validation steps:

  • Validates the coin string is a valid cosmos coin
  • Validates the coin is positive (amount > 0)
  • Validates the coin denom is upokt

func ValidateProofWindowCloseOffsetBlocks 

func ValidateProofWindowCloseOffsetBlocks(proofWindowCloseOffsetBlocksAny any) error

ValidateProofWindowCloseOffsetBlocks validates the ProofWindowCloseOffsetBlocks param NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidateProofWindowOpenOffsetBlocks 

func ValidateProofWindowOpenOffsetBlocks(proofWindowOpenOffsetBlocksAny any) error

ValidateProofWindowOpenOffsetBlocks validates the ProofWindowOpenOffsetBlocks param NB: The argument is an interface type to satisfy the ParamSetPair function signature.

func ValidateServiceRevShare added in v0.0.10 

func ValidateServiceRevShare(revShareList []*ServiceRevenueShare) error

ValidateServiceRevShare validates the supplier's service revenue share, ensuring that the sum of the revenue share percentages is 100. NB: This function is unit tested via the supplier staking config tests.

func ValidateSupplierServiceConfigs added in v0.0.10 

func ValidateSupplierServiceConfigs(services []*SupplierServiceConfig) error

ValidateSupplierServiceConfigs returns an error if any of the supplier service configs are invalid

func ValidateSupplierUnbondingPeriodSessions added in v0.0.6 

func ValidateSupplierUnbondingPeriodSessions(supplierUnbondingPeriodSessionsAny any) error

ValidateSupplierUnbondingPeriodSessions validates the SupplierUnbondingPeriodSessions governance parameter. NB: The argument is an interface type to satisfy the ParamSetPair function signature.

Types

type AccountKeeper 

type AccountKeeper interface {
	GetAccount(context.Context, sdk.AccAddress) sdk.AccountI // only used for simulation

}

AccountKeeper defines the expected interface for the Account module.

type ApplicationServiceConfig 

type ApplicationServiceConfig struct {
	ServiceId string `protobuf:"bytes,1,opt,name=service_id,json=serviceId,proto3" json:"service_id,omitempty"`
}

ApplicationServiceConfig holds the service configuration the application stakes for

func (*ApplicationServiceConfig) Descriptor 

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

func (*ApplicationServiceConfig) GetServiceId added in v0.0.8 

func (m *ApplicationServiceConfig) GetServiceId() string

func (*ApplicationServiceConfig) Marshal 

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

func (*ApplicationServiceConfig) MarshalTo 

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

func (*ApplicationServiceConfig) MarshalToSizedBuffer 

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

func (*ApplicationServiceConfig) ProtoMessage 

func (*ApplicationServiceConfig) ProtoMessage()

func (*ApplicationServiceConfig) Reset 

func (m *ApplicationServiceConfig) Reset()

func (*ApplicationServiceConfig) Size 

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

func (*ApplicationServiceConfig) String 

func (m *ApplicationServiceConfig) String() string

func (*ApplicationServiceConfig) Unmarshal 

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

func (*ApplicationServiceConfig) XXX_DiscardUnknown 

func (m *ApplicationServiceConfig) XXX_DiscardUnknown()

func (*ApplicationServiceConfig) XXX_Marshal 

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

func (*ApplicationServiceConfig) XXX_Merge 

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

func (*ApplicationServiceConfig) XXX_Size 

func (m *ApplicationServiceConfig) XXX_Size() int

func (*ApplicationServiceConfig) XXX_Unmarshal 

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

type BankKeeper 

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

BankKeeper defines the expected interface for the Bank module.

type ConfigOption 

type ConfigOption struct {
	Key   ConfigOptions `protobuf:"varint,1,opt,name=key,proto3,enum=pocket.shared.ConfigOptions" json:"key,omitempty"`
	Value string        `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
}

Key-value wrapper for config options, as proto maps can't be keyed by enums

func (*ConfigOption) Descriptor 

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

func (*ConfigOption) GetKey 

func (m *ConfigOption) GetKey() ConfigOptions

func (*ConfigOption) GetValue 

func (m *ConfigOption) GetValue() string

func (*ConfigOption) Marshal 

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

func (*ConfigOption) MarshalTo 

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

func (*ConfigOption) MarshalToSizedBuffer 

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

func (*ConfigOption) ProtoMessage 

func (*ConfigOption) ProtoMessage()

func (*ConfigOption) Reset 

func (m *ConfigOption) Reset()

func (*ConfigOption) Size 

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

func (*ConfigOption) String 

func (m *ConfigOption) String() string

func (*ConfigOption) Unmarshal 

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

func (*ConfigOption) XXX_DiscardUnknown 

func (m *ConfigOption) XXX_DiscardUnknown()

func (*ConfigOption) XXX_Marshal 

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

func (*ConfigOption) XXX_Merge 

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

func (*ConfigOption) XXX_Size 

func (m *ConfigOption) XXX_Size() int

func (*ConfigOption) XXX_Unmarshal 

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

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
	ConfigOptions_TIMEOUT        ConfigOptions = 1
)

func (ConfigOptions) EnumDescriptor 

func (ConfigOptions) EnumDescriptor() ([]byte, []int)

func (ConfigOptions) String 

func (x ConfigOptions) String() string

type DataRecordAccessor added in v0.1.5 

type DataRecordAccessor[T any] func(data []byte) (T, error)

DataRecordAccessor is a function that transforms raw byte data into typed records. It takes a byte slice as input and returns a typed object of type T and an error.

type GenesisState 

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

GenesisState defines the shared 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 Metadata added in v0.1.30 

type Metadata struct {
	// EXPERIMENTAL: Serialized API spec limited to 256 KiB when decoded.
	// TODO_FUTURE: support dedicated openapi_ / openrpc_ fields once formats stabilize.
	ExperimentalApiSpecs []byte `protobuf:"bytes,1,opt,name=experimental_api_specs,json=experimentalApiSpecs,proto3" json:"experimental_api_specs,omitempty"`
}

Metadata message to hold additional metadata for a service. The raw bytes are stored on-chain and will be base64 encoded in JSON representations.

Next free index: 2

func (*Metadata) Descriptor added in v0.1.30 

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

func (*Metadata) GetExperimentalApiSpecs added in v0.1.30 

func (m *Metadata) GetExperimentalApiSpecs() []byte

func (*Metadata) Marshal added in v0.1.30 

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

func (*Metadata) MarshalTo added in v0.1.30 

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

func (*Metadata) MarshalToSizedBuffer added in v0.1.30 

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

func (*Metadata) ProtoMessage added in v0.1.30 

func (*Metadata) ProtoMessage()

func (*Metadata) Reset added in v0.1.30 

func (m *Metadata) Reset()

func (*Metadata) Size added in v0.1.30 

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

func (*Metadata) String added in v0.1.30 

func (m *Metadata) String() string

func (*Metadata) Unmarshal added in v0.1.30 

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

func (*Metadata) ValidateBasic added in v0.1.30 

func (metadata *Metadata) ValidateBasic() error

ValidateBasic performs basic validation of the metadata. Nil metadata is allowed.

DEV_NOTE: This validation intentionally does NOT verify the content format (e.g., valid JSON, OpenAPI, etc.) because the metadata is explicitly marked as "experimental" and may contain any serialized API spec format. Future versions may add format-specific validation when dedicated fields are introduced. TODO_IMPROVE: See comments on openapi/openrpc next steps in service.proto.

func (*Metadata) XXX_DiscardUnknown added in v0.1.30 

func (m *Metadata) XXX_DiscardUnknown()

func (*Metadata) XXX_Marshal added in v0.1.30 

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

func (*Metadata) XXX_Merge added in v0.1.30 

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

func (*Metadata) XXX_Size added in v0.1.30 

func (m *Metadata) XXX_Size() int

func (*Metadata) XXX_Unmarshal added in v0.1.30 

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

type Module added in v0.1.27 

type Module struct {
	// authority defines the custom module authority. If not set, defaults to the governance module.
	Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
}

Module is the config object for the module.

func (*Module) Descriptor added in v0.1.27 

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

func (*Module) GetAuthority added in v0.1.27 

func (m *Module) GetAuthority() string

func (*Module) Marshal added in v0.1.27 

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

func (*Module) MarshalTo added in v0.1.27 

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

func (*Module) MarshalToSizedBuffer added in v0.1.27 

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

func (*Module) ProtoMessage added in v0.1.27 

func (*Module) ProtoMessage()

func (*Module) Reset added in v0.1.27 

func (m *Module) Reset()

func (*Module) Size added in v0.1.27 

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

func (*Module) String added in v0.1.27 

func (m *Module) String() string

func (*Module) Unmarshal added in v0.1.27 

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

func (*Module) XXX_DiscardUnknown added in v0.1.27 

func (m *Module) XXX_DiscardUnknown()

func (*Module) XXX_Marshal added in v0.1.27 

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

func (*Module) XXX_Merge added in v0.1.27 

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

func (*Module) XXX_Size added in v0.1.27 

func (m *Module) XXX_Size() int

func (*Module) XXX_Unmarshal added in v0.1.27 

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

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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewMsgClient 

func NewMsgClient(cc grpc1.ClientConn) 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)
}

MsgServer is the server API for 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 valid to be assigned to AsType:
	//	*MsgUpdateParam_AsString
	//	*MsgUpdateParam_AsUint64
	//	*MsgUpdateParam_AsBytes
	AsType isMsgUpdateParam_AsType `protobuf_oneof:"as_type"`
}

MsgUpdateParam is the Msg/UpdateParam request type to update a single param.

func NewMsgUpdateParam 

func NewMsgUpdateParam(authority string, name string, value any) (*MsgUpdateParam, error)

NewMsgUpdateParam creates a new MsgUpdateParam instance for a single governance parameter update.

func (*MsgUpdateParam) Descriptor 

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

func (*MsgUpdateParam) GetAsBytes 

func (m *MsgUpdateParam) GetAsBytes() []byte

func (*MsgUpdateParam) GetAsString 

func (m *MsgUpdateParam) GetAsString() string

func (*MsgUpdateParam) GetAsType 

func (m *MsgUpdateParam) GetAsType() isMsgUpdateParam_AsType

func (*MsgUpdateParam) GetAsUint64 added in v0.0.10 

func (m *MsgUpdateParam) GetAsUint64() uint64

func (*MsgUpdateParam) GetAuthority 

func (m *MsgUpdateParam) GetAuthority() string

func (*MsgUpdateParam) GetName 

func (m *MsgUpdateParam) GetName() string

func (*MsgUpdateParam) Marshal 

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

func (*MsgUpdateParam) MarshalTo 

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

func (*MsgUpdateParam) MarshalToSizedBuffer 

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

func (*MsgUpdateParam) ProtoMessage 

func (*MsgUpdateParam) ProtoMessage()

func (*MsgUpdateParam) Reset 

func (m *MsgUpdateParam) Reset()

func (*MsgUpdateParam) Size 

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

func (*MsgUpdateParam) String 

func (m *MsgUpdateParam) String() string

func (*MsgUpdateParam) Unmarshal 

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

func (*MsgUpdateParam) ValidateBasic 

func (msg *MsgUpdateParam) ValidateBasic() error

ValidateBasic performs a basic validation of the MsgUpdateParam fields. It ensures: 1. The parameter name is supported. 2. The parameter type matches the expected type for a given parameter name. 3. The parameter value is valid (according to its respective validation function).

func (*MsgUpdateParam) XXX_DiscardUnknown 

func (m *MsgUpdateParam) XXX_DiscardUnknown()

func (*MsgUpdateParam) XXX_Marshal 

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

func (*MsgUpdateParam) XXX_Merge 

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

func (*MsgUpdateParam) XXX_OneofWrappers 

func (*MsgUpdateParam) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*MsgUpdateParam) XXX_Size 

func (m *MsgUpdateParam) XXX_Size() int

func (*MsgUpdateParam) XXX_Unmarshal 

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

type MsgUpdateParamResponse 

type MsgUpdateParamResponse struct {
}

MsgUpdateParamResponse defines the response structure for executing a MsgUpdateParam message after a single param update.

func (*MsgUpdateParamResponse) Descriptor 

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

func (*MsgUpdateParamResponse) Marshal 

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

func (*MsgUpdateParamResponse) MarshalTo 

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

func (*MsgUpdateParamResponse) MarshalToSizedBuffer 

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

func (*MsgUpdateParamResponse) ProtoMessage 

func (*MsgUpdateParamResponse) ProtoMessage()

func (*MsgUpdateParamResponse) Reset 

func (m *MsgUpdateParamResponse) Reset()

func (*MsgUpdateParamResponse) Size 

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

func (*MsgUpdateParamResponse) String 

func (m *MsgUpdateParamResponse) String() string

func (*MsgUpdateParamResponse) Unmarshal 

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

func (*MsgUpdateParamResponse) XXX_DiscardUnknown 

func (m *MsgUpdateParamResponse) XXX_DiscardUnknown()

func (*MsgUpdateParamResponse) XXX_Marshal 

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

func (*MsgUpdateParamResponse) XXX_Merge 

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

func (*MsgUpdateParamResponse) XXX_Size 

func (m *MsgUpdateParamResponse) XXX_Size() int

func (*MsgUpdateParamResponse) XXX_Unmarshal 

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

type MsgUpdateParam_AsBytes 

type MsgUpdateParam_AsBytes struct {
	AsBytes []byte `protobuf:"bytes,7,opt,name=as_bytes,json=asBytes,proto3,oneof" json:"as_bytes"`
}

func (*MsgUpdateParam_AsBytes) MarshalTo 

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

func (*MsgUpdateParam_AsBytes) MarshalToSizedBuffer 

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

func (*MsgUpdateParam_AsBytes) Size 

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

type MsgUpdateParam_AsString 

type MsgUpdateParam_AsString struct {
	AsString string `protobuf:"bytes,3,opt,name=as_string,json=asString,proto3,oneof" json:"as_string"`
}

func (*MsgUpdateParam_AsString) MarshalTo 

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

func (*MsgUpdateParam_AsString) MarshalToSizedBuffer 

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

func (*MsgUpdateParam_AsString) Size 

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

type MsgUpdateParam_AsUint64 added in v0.0.10 

type MsgUpdateParam_AsUint64 struct {
	AsUint64 uint64 `protobuf:"varint,6,opt,name=as_uint64,json=asUint64,proto3,oneof" json:"as_uint64"`
}

func (*MsgUpdateParam_AsUint64) MarshalTo added in v0.0.10 

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

func (*MsgUpdateParam_AsUint64) MarshalToSizedBuffer added in v0.0.10 

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

func (*MsgUpdateParam_AsUint64) Size added in v0.0.10 

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

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"`
}

MsgUpdateParams is the Msg/UpdateParams request type.

func (*MsgUpdateParams) Descriptor 

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

func (*MsgUpdateParams) GetAuthority 

func (m *MsgUpdateParams) GetAuthority() string

func (*MsgUpdateParams) GetParams 

func (m *MsgUpdateParams) GetParams() Params

func (*MsgUpdateParams) Marshal 

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

func (*MsgUpdateParams) MarshalTo 

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

func (*MsgUpdateParams) MarshalToSizedBuffer 

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

func (*MsgUpdateParams) ProtoMessage 

func (*MsgUpdateParams) ProtoMessage()

func (*MsgUpdateParams) Reset 

func (m *MsgUpdateParams) Reset()

func (*MsgUpdateParams) Size 

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

func (*MsgUpdateParams) String 

func (m *MsgUpdateParams) String() string

func (*MsgUpdateParams) Unmarshal 

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

func (*MsgUpdateParams) ValidateBasic 

func (m *MsgUpdateParams) ValidateBasic() error

ValidateBasic does a sanity check on the provided data.

func (*MsgUpdateParams) XXX_DiscardUnknown 

func (m *MsgUpdateParams) XXX_DiscardUnknown()

func (*MsgUpdateParams) XXX_Marshal 

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

func (*MsgUpdateParams) XXX_Merge 

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

func (*MsgUpdateParams) XXX_Size 

func (m *MsgUpdateParams) XXX_Size() int

func (*MsgUpdateParams) XXX_Unmarshal 

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

type MsgUpdateParamsResponse 

type MsgUpdateParamsResponse struct {
}

MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.

func (*MsgUpdateParamsResponse) Descriptor 

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

func (*MsgUpdateParamsResponse) Marshal 

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

func (*MsgUpdateParamsResponse) MarshalTo 

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

func (*MsgUpdateParamsResponse) MarshalToSizedBuffer 

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

func (*MsgUpdateParamsResponse) ProtoMessage 

func (*MsgUpdateParamsResponse) ProtoMessage()

func (*MsgUpdateParamsResponse) Reset 

func (m *MsgUpdateParamsResponse) Reset()

func (*MsgUpdateParamsResponse) Size 

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

func (*MsgUpdateParamsResponse) String 

func (m *MsgUpdateParamsResponse) String() string

func (*MsgUpdateParamsResponse) Unmarshal 

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

func (*MsgUpdateParamsResponse) XXX_DiscardUnknown 

func (m *MsgUpdateParamsResponse) XXX_DiscardUnknown()

func (*MsgUpdateParamsResponse) XXX_Marshal 

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

func (*MsgUpdateParamsResponse) XXX_Merge 

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

func (*MsgUpdateParamsResponse) XXX_Size 

func (m *MsgUpdateParamsResponse) XXX_Size() int

func (*MsgUpdateParamsResponse) XXX_Unmarshal 

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

type ParamSubspace 

type ParamSubspace interface {
	Get(context.Context, []byte, interface{})
	Set(context.Context, []byte, interface{})
}

ParamSubspace defines the expected Subspace interface for parameters.

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"`
	// 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 `` /* 136-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 `` /* 139-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 `` /* 142-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 `` /* 139-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 `` /* 142-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 `` /* 149-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 `` /* 158-byte string literal not displayed */
	// The amount of tokens that a compute unit should translate to when settling a session.
	// It is denominated in fractional uPOKT (1/compute_unit_cost_granularity)
	// DEV_NOTE: This used to be under x/tokenomics but has been moved here to avoid cyclic dependencies.
	ComputeUnitsToTokensMultiplier uint64 `` /* 190-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 `` /* 147-byte string literal not displayed */
	// compute_unit_cost_granularity is the fraction of the base unit (uPOKT) used
	// to represent the smallest price of a single compute unit.
	// compute_unit_cost_granularity defines the smallest fraction of uPOKT that can represent
	// the cost of a single compute unit.
	//
	// It acts as a denominator in the formula:
	//
	//	compute_unit_cost_in_uPOKT = compute_units_to_tokens_multiplier / compute_unit_cost_granularity
	//
	// This enables high-precision pricing of compute units using integer math.
	// For example:
	//
	// +-------------------------------+---------------------------------------------+
	// | compute_unit_cost_granularity | compute_units_to_tokens_multiplier unit     |
	// +-------------------------------+---------------------------------------------+
	// | 1                             | uPOKT                                       |
	// | 1_000                         | nPOKT (nanoPOKT, 1e-3 uPOKT)                |
	// | 1_000_000                     | pPOKT (picoPOKT, 1e-6 uPOKT)                |
	// +-------------------------------+---------------------------------------------+
	//
	// ⚠️ Note: This value is a configurable global network parameter (not a constant).
	// It must be a power of 10, allowing precise denomination shifts without affecting
	// ongoing sessions. This prevents sessions from settling using parameters that
	// were not in effect during their creation.
	ComputeUnitCostGranularity uint64 `` /* 172-byte string literal not displayed */
}

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

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

func (*Params) GetApplicationUnbondingPeriodSessions added in v0.0.7 

func (m *Params) GetApplicationUnbondingPeriodSessions() uint64

func (*Params) GetClaimWindowCloseOffsetBlocks 

func (m *Params) GetClaimWindowCloseOffsetBlocks() uint64

func (*Params) GetClaimWindowOpenOffsetBlocks 

func (m *Params) GetClaimWindowOpenOffsetBlocks() uint64

func (*Params) GetComputeUnitCostGranularity added in v0.1.13 

func (m *Params) GetComputeUnitCostGranularity() uint64

func (*Params) GetComputeUnitsToTokensMultiplier added in v0.0.10 

func (m *Params) GetComputeUnitsToTokensMultiplier() uint64

func (*Params) GetGatewayUnbondingPeriodSessions added in v0.0.13 

func (m *Params) GetGatewayUnbondingPeriodSessions() uint64

func (*Params) GetGracePeriodEndOffsetBlocks 

func (m *Params) GetGracePeriodEndOffsetBlocks() uint64

func (*Params) GetNumBlocksPerSession 

func (m *Params) GetNumBlocksPerSession() uint64

func (*Params) GetProofWindowCloseOffsetBlocks 

func (m *Params) GetProofWindowCloseOffsetBlocks() uint64

func (*Params) GetProofWindowOpenOffsetBlocks 

func (m *Params) GetProofWindowOpenOffsetBlocks() uint64

func (*Params) GetSupplierUnbondingPeriodSessions added in v0.0.6 

func (m *Params) GetSupplierUnbondingPeriodSessions() uint64

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

func (params *Params) ParamSetPairs() paramtypes.ParamSetPairs

ParamSetPairs get the params.ParamSet

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 (m *Params) String() string

func (*Params) Unmarshal 

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

func (*Params) ValidateBasic 

func (params *Params) ValidateBasic() 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 {
	// 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://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 {
	// Parameters queries the parameters of the module.
	Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, error)
}

QueryServer is the server API for Query service.

type RPCType 

type RPCType int32

Enum to define RPC types 

const (
	RPCType_UNKNOWN_RPC RPCType = 0
	RPCType_GRPC        RPCType = 1
	RPCType_WEBSOCKET   RPCType = 2
	RPCType_JSON_RPC    RPCType = 3
	RPCType_REST        RPCType = 4
	RPCType_COMET_BFT   RPCType = 5
)

func GetRPCTypeFromConfig added in v0.1.27 

func GetRPCTypeFromConfig(rpcType string) (RPCType, error)

GetRPCTypeFromConfig converts the string RPC type to the types.RPCType enum and performs validation.

eg. "rest" -> types.RPCType_REST

func (RPCType) EnumDescriptor 

func (RPCType) EnumDescriptor() ([]byte, []int)

func (RPCType) String 

func (x RPCType) String() string

type RecordIterator added in v0.1.5 

type RecordIterator[T any] interface {
	// Next advances the iterator to the next record.
	Next()
	// Value retrieves the current record.
	// IT returns the record of type T
	Value() (T, error)
	// Valid checks if the iterator can still be used.
	// Returns false when:
	// - Iterator has been exhausted
	// - Iterator has been closed
	Valid() bool
	// Key retrieves the current byte key.
	Key() []byte
	// Close releases resources held by the iterator.
	Close()
}

RecordIterator is an interface for iterating over generic records.

It provides methods to: - Navigate through records - Access current record data - Check iterator validity - Clean up resources

DEV_NOTE: This was great as a supplement to the native Cosmos SDK Iterator to embed hidden functionality such as unmarshalling records from bytes. Ref: https://docs.cosmos.network/main/learn/advanced/store

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"`
	// TODO_POST_MAINNET: Rename service.name to service.description
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// 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 `` /* 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"`
	// Optional metadata containing an experimental API specification for the service.
	// When exposed via JSON, this field is base64 encoded and MUST be <= 256 KiB when decoded.
	Metadata *Metadata `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"`
}

Service message to encapsulate unique and semantic identifiers for a service on the network

Next free index: 6

func (*Service) Descriptor 

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

func (*Service) GetComputeUnitsPerRelay added in v0.0.5 

func (m *Service) GetComputeUnitsPerRelay() uint64

func (*Service) GetId 

func (m *Service) GetId() string

func (*Service) GetMetadata added in v0.1.30 

func (m *Service) GetMetadata() *Metadata

func (*Service) GetName 

func (m *Service) GetName() string

func (*Service) GetOwnerAddress added in v0.0.5 

func (m *Service) GetOwnerAddress() string

func (*Service) Marshal 

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

func (*Service) MarshalTo 

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

func (*Service) MarshalToSizedBuffer 

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

func (*Service) ProtoMessage 

func (*Service) ProtoMessage()

func (*Service) Reset 

func (m *Service) Reset()

func (*Service) Size 

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

func (*Service) String 

func (m *Service) String() string

func (*Service) Unmarshal 

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

func (*Service) ValidateBasic added in v0.0.8 

func (s *Service) ValidateBasic() error

ValidateBasic performs basic stateless validation of a Service.

func (*Service) XXX_DiscardUnknown 

func (m *Service) XXX_DiscardUnknown()

func (*Service) XXX_Marshal 

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

func (*Service) XXX_Merge 

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

func (*Service) XXX_Size 

func (m *Service) XXX_Size() int

func (*Service) XXX_Unmarshal 

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

type ServiceConfigUpdate added in v0.0.14 

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"`
}

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 added in v0.0.14 

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

func (*ServiceConfigUpdate) GetActivationHeight added in v0.1.8 

func (m *ServiceConfigUpdate) GetActivationHeight() int64

func (*ServiceConfigUpdate) GetDeactivationHeight added in v0.1.8 

func (m *ServiceConfigUpdate) GetDeactivationHeight() int64

func (*ServiceConfigUpdate) GetOperatorAddress added in v0.1.8 

func (m *ServiceConfigUpdate) GetOperatorAddress() string

func (*ServiceConfigUpdate) GetService added in v0.1.8 

func (m *ServiceConfigUpdate) GetService() *SupplierServiceConfig

func (*ServiceConfigUpdate) IsActive added in v0.1.8 

func (s *ServiceConfigUpdate) IsActive(queryHeight int64) bool

IsActive checks if the ServiceConfigUpdate is active at the given block height.

A service configuration is considered active when the following conditions are met: 1. The block height is greater than or equal to the activation height 2. Either:

  • The deactivation height is 0 (indicating no scheduled deactivation), OR
  • The block height is less than the deactivation height

This determines whether a supplier's service configuration should be considered active for session hydration at the specified block height.

func (*ServiceConfigUpdate) Marshal added in v0.0.14 

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

func (*ServiceConfigUpdate) MarshalTo added in v0.0.14 

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

func (*ServiceConfigUpdate) MarshalToSizedBuffer added in v0.0.14 

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

func (*ServiceConfigUpdate) ProtoMessage added in v0.0.14 

func (*ServiceConfigUpdate) ProtoMessage()

func (*ServiceConfigUpdate) Reset added in v0.0.14 

func (m *ServiceConfigUpdate) Reset()

func (*ServiceConfigUpdate) Size added in v0.0.14 

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

func (*ServiceConfigUpdate) String added in v0.0.14 

func (m *ServiceConfigUpdate) String() string

func (*ServiceConfigUpdate) Unmarshal added in v0.0.14 

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

func (*ServiceConfigUpdate) XXX_DiscardUnknown added in v0.0.14 

func (m *ServiceConfigUpdate) XXX_DiscardUnknown()

func (*ServiceConfigUpdate) XXX_Marshal added in v0.0.14 

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

func (*ServiceConfigUpdate) XXX_Merge added in v0.0.14 

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

func (*ServiceConfigUpdate) XXX_Size added in v0.0.14 

func (m *ServiceConfigUpdate) XXX_Size() int

func (*ServiceConfigUpdate) XXX_Unmarshal added in v0.0.14 

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

type ServiceRevenueShare added in v0.0.6 

type ServiceRevenueShare struct {
	Address            string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	RevSharePercentage uint64 `protobuf:"varint,3,opt,name=rev_share_percentage,json=revSharePercentage,proto3" json:"rev_share_percentage,omitempty"`
}

ServiceRevenueShare message to hold revenue share configuration details

func (*ServiceRevenueShare) Descriptor added in v0.0.6 

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

func (*ServiceRevenueShare) GetAddress added in v0.0.6 

func (m *ServiceRevenueShare) GetAddress() string

func (*ServiceRevenueShare) GetRevSharePercentage added in v0.0.6 

func (m *ServiceRevenueShare) GetRevSharePercentage() uint64

func (*ServiceRevenueShare) Marshal added in v0.0.6 

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

func (*ServiceRevenueShare) MarshalTo added in v0.0.6 

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

func (*ServiceRevenueShare) MarshalToSizedBuffer added in v0.0.6 

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

func (*ServiceRevenueShare) ProtoMessage added in v0.0.6 

func (*ServiceRevenueShare) ProtoMessage()

func (*ServiceRevenueShare) Reset added in v0.0.6 

func (m *ServiceRevenueShare) Reset()

func (*ServiceRevenueShare) Size added in v0.0.6 

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

func (*ServiceRevenueShare) String added in v0.0.6 

func (m *ServiceRevenueShare) String() string

func (*ServiceRevenueShare) Unmarshal added in v0.0.6 

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

func (*ServiceRevenueShare) XXX_DiscardUnknown added in v0.0.6 

func (m *ServiceRevenueShare) XXX_DiscardUnknown()

func (*ServiceRevenueShare) XXX_Marshal added in v0.0.6 

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

func (*ServiceRevenueShare) XXX_Merge added in v0.0.6 

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

func (*ServiceRevenueShare) XXX_Size added in v0.0.6 

func (m *ServiceRevenueShare) XXX_Size() int

func (*ServiceRevenueShare) XXX_Unmarshal added in v0.0.6 

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

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 *types.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"`
}

Supplier represents an actor in Pocket Network that provides RPC services

func (*Supplier) Descriptor 

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

func (*Supplier) GetActiveServiceConfigs added in v0.1.8 

func (s *Supplier) GetActiveServiceConfigs(
	queryHeight int64,
) []*SupplierServiceConfig

TODO_TECHDEBT: Consider removing this method and forcing the use of the keeper directly. This requires the supplier to be hydrated, which is not always the case.

GetActiveServiceConfigs returns a list of all service configurations that are active at the specified block height.

This method examines the supplier's service configuration history to collect all service configurations that:

  1. Have an activation height less than or equal to the query height
  2. Either have no deactivation height (0) or a deactivation height greater than the query height

The returned configurations represent all services the supplier is authorized to provide at the given block height, with their corresponding endpoints and revenue share settings.

func (*Supplier) GetOperatorAddress added in v0.0.6 

func (m *Supplier) GetOperatorAddress() string

func (*Supplier) GetOwnerAddress added in v0.0.6 

func (m *Supplier) GetOwnerAddress() string

func (*Supplier) GetServiceConfigHistory added in v0.0.14 

func (m *Supplier) GetServiceConfigHistory() []*ServiceConfigUpdate

func (*Supplier) GetServices 

func (m *Supplier) GetServices() []*SupplierServiceConfig

func (*Supplier) GetStake 

func (m *Supplier) GetStake() *types.Coin

func (*Supplier) GetUnstakeSessionEndHeight added in v0.0.5 

func (m *Supplier) GetUnstakeSessionEndHeight() uint64

func (*Supplier) HasOperator added in v0.0.6 

func (s *Supplier) HasOperator(address string) bool

HasOperator returns whether the given address is the supplier's operator address.

func (*Supplier) HasOwner added in v0.0.6 

func (s *Supplier) HasOwner(address string) bool

HasOwner returns whether the given address is the supplier's owner address.

func (*Supplier) IsActive added in v0.0.5 

func (s *Supplier) IsActive(queryHeight int64, serviceId string) bool

IsActive checks if the supplier is authorized to serve requests for a specific service at the given block height.

This method examines the supplier's service configuration history to determine if they have an active configuration for the requested service ID at the specified block height. A supplier is considered "active" for a service when:

  1. They have a ServiceConfigUpdate for this service ID
  2. That configuration is active at the given block height (activation height <= queryHeight < deactivation height)

func (*Supplier) IsUnbonding added in v0.0.5 

func (s *Supplier) IsUnbonding() bool

IsUnbonding returns true if the supplier is actively unbonding. It determines if the supplier has submitted an unstake message, in which case the supplier has its UnstakeSessionEndHeight set.

func (*Supplier) Marshal 

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

func (*Supplier) MarshalTo 

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

func (*Supplier) MarshalToSizedBuffer 

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

func (*Supplier) ProtoMessage 

func (*Supplier) ProtoMessage()

func (*Supplier) Reset 

func (m *Supplier) Reset()

func (*Supplier) Size 

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

func (*Supplier) String 

func (m *Supplier) String() string

func (*Supplier) Unmarshal 

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

func (*Supplier) XXX_DiscardUnknown 

func (m *Supplier) XXX_DiscardUnknown()

func (*Supplier) XXX_Marshal 

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

func (*Supplier) XXX_Merge 

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

func (*Supplier) XXX_Size 

func (m *Supplier) XXX_Size() int

func (*Supplier) XXX_Unmarshal 

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

type SupplierEndpoint 

type SupplierEndpoint struct {
	Url     string          `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	RpcType RPCType         `protobuf:"varint,2,opt,name=rpc_type,json=rpcType,proto3,enum=pocket.shared.RPCType" json:"rpc_type,omitempty"`
	Configs []*ConfigOption `protobuf:"bytes,3,rep,name=configs,proto3" json:"configs,omitempty"`
}

SupplierEndpoint message to hold service configuration details

func (*SupplierEndpoint) Descriptor 

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

func (*SupplierEndpoint) GetConfigs 

func (m *SupplierEndpoint) GetConfigs() []*ConfigOption

func (*SupplierEndpoint) GetRpcType 

func (m *SupplierEndpoint) GetRpcType() RPCType

func (*SupplierEndpoint) GetUrl 

func (m *SupplierEndpoint) GetUrl() string

func (*SupplierEndpoint) Marshal 

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

func (*SupplierEndpoint) MarshalTo 

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

func (*SupplierEndpoint) MarshalToSizedBuffer 

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

func (*SupplierEndpoint) ProtoMessage 

func (*SupplierEndpoint) ProtoMessage()

func (*SupplierEndpoint) Reset 

func (m *SupplierEndpoint) Reset()

func (*SupplierEndpoint) Size 

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

func (*SupplierEndpoint) String 

func (m *SupplierEndpoint) String() string

func (*SupplierEndpoint) Unmarshal 

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

func (*SupplierEndpoint) XXX_DiscardUnknown 

func (m *SupplierEndpoint) XXX_DiscardUnknown()

func (*SupplierEndpoint) XXX_Marshal 

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

func (*SupplierEndpoint) XXX_Merge 

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

func (*SupplierEndpoint) XXX_Size 

func (m *SupplierEndpoint) XXX_Size() int

func (*SupplierEndpoint) XXX_Unmarshal 

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

type SupplierServiceConfig 

type SupplierServiceConfig struct {
	ServiceId string                 `protobuf:"bytes,1,opt,name=service_id,json=serviceId,proto3" json:"service_id,omitempty"`
	Endpoints []*SupplierEndpoint    `protobuf:"bytes,2,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
	RevShare  []*ServiceRevenueShare `protobuf:"bytes,3,rep,name=rev_share,json=revShare,proto3" json:"rev_share,omitempty"`
}

SupplierServiceConfig holds the service configuration the supplier stakes for

func GetActiveServiceConfigsFromHistory added in v0.1.9 

func GetActiveServiceConfigsFromHistory(
	serviceConfigHistory []*ServiceConfigUpdate,
	queryHeight int64,
) []*SupplierServiceConfig

GetActiveServiceConfigsFromHistory filters the service configuration history to find all configurations that are active at the specified block height.

func (*SupplierServiceConfig) Descriptor 

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

func (*SupplierServiceConfig) GetEndpoints 

func (m *SupplierServiceConfig) GetEndpoints() []*SupplierEndpoint

func (*SupplierServiceConfig) GetRevShare added in v0.0.6 

func (m *SupplierServiceConfig) GetRevShare() []*ServiceRevenueShare

func (*SupplierServiceConfig) GetServiceId added in v0.0.8 

func (m *SupplierServiceConfig) GetServiceId() string

func (*SupplierServiceConfig) Marshal 

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

func (*SupplierServiceConfig) MarshalTo 

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

func (*SupplierServiceConfig) MarshalToSizedBuffer 

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

func (*SupplierServiceConfig) ProtoMessage 

func (*SupplierServiceConfig) ProtoMessage()

func (*SupplierServiceConfig) Reset 

func (m *SupplierServiceConfig) Reset()

func (*SupplierServiceConfig) Size 

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

func (*SupplierServiceConfig) String 

func (m *SupplierServiceConfig) String() string

func (*SupplierServiceConfig) Unmarshal 

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

func (*SupplierServiceConfig) XXX_DiscardUnknown 

func (m *SupplierServiceConfig) XXX_DiscardUnknown()

func (*SupplierServiceConfig) XXX_Marshal 

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

func (*SupplierServiceConfig) XXX_Merge 

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

func (*SupplierServiceConfig) XXX_Size 

func (m *SupplierServiceConfig) XXX_Size() int

func (*SupplierServiceConfig) XXX_Unmarshal 

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

type UnimplementedMsgServer 

type UnimplementedMsgServer struct {
}

UnimplementedMsgServer can be embedded to have forward compatible implementations.

func (*UnimplementedMsgServer) UpdateParam 

func (*UnimplementedMsgServer) UpdateParam(ctx context.Context, req *MsgUpdateParam) (*MsgUpdateParamResponse, error)

func (*UnimplementedMsgServer) UpdateParams 

func (*UnimplementedMsgServer) UpdateParams(ctx context.Context, req *MsgUpdateParams) (*MsgUpdateParamsResponse, error)

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)

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.