client

type AccountQueryClient interface {
	// GetAccount queries the chain for the details of the account provided
	GetAccount(ctx context.Context, address string) (cosmostypes.AccountI, error)

	// GetPubKeyFromAddress returns the public key of the given address.
	GetPubKeyFromAddress(ctx context.Context, address string) (cryptotypes.PubKey, error)
}

type ApplicationQueryClient interface {
	// GetApplication queries the chain for the details of the application provided
	GetApplication(ctx context.Context, appAddress string) (apptypes.Application, error)

	// GetAllApplications queries all onchain applications
	GetAllApplications(ctx context.Context) ([]apptypes.Application, error)

	// GetParams queries the chain for the application module parameters.
	GetParams(ctx context.Context) (*apptypes.Params, error)
}

type BankGRPCQueryClient interface {
	AllBalances(ctx context.Context, in *banktypes.QueryAllBalancesRequest, opts ...grpc.CallOption) (*banktypes.QueryAllBalancesResponse, error)
}

type BankQueryClient interface {
	// GetBalance queries the chain for the uPOKT balance of the account provided
	GetBalance(ctx context.Context, address string) (*cosmostypes.Coin, error)
}

type Block interface {
	Height() int64
	Hash() []byte
}

type BlockClient interface {
	// CommittedBlocksSequence returns a BlockObservable that emits the
	// latest blocks that have been committed to the chain.
	CommittedBlocksSequence(context.Context) BlockReplayObservable

	// LastBlock returns the latest block that has been committed onchain.
	LastBlock(context.Context) Block

	// Close unsubscribes all observers of the committed block sequence
	// observable and closes the events query client.
	Close()

	// GetChainVersion returns the current chain version.
	GetChainVersion() *version.Version
}

type BlockQueryClient interface {
	Block(ctx context.Context, height *int64) (*cometrpctypes.ResultBlock, error)
}

type BlockReplayObservable EventsObservable[Block]

type Claim interface {
	GetSupplierOperatorAddress() string
	GetSessionHeader() *sessiontypes.SessionHeader
	GetRootHash() []byte
}

type EventsObservable[T any] observable.ReplayObservable[T]

type EventsReplayClient[T any] interface {
	// EventsSequence returns an observable which emits new events.
	EventsSequence(context.Context) observable.ReplayObservable[T]
	// LastNEvents returns the latest N events that has been received.
	LastNEvents(ctx context.Context, n int) []T
}

type MsgCreateClaim interface {
	cosmostypes.Msg
	GetRootHash() []byte
	GetSessionHeader() *sessiontypes.SessionHeader
	GetSupplierOperatorAddress() string
}

type MsgSubmitProof interface {
	cosmostypes.Msg
	GetProof() []byte
	GetSessionHeader() *sessiontypes.SessionHeader
	GetSupplierOperatorAddress() string
}

type ParamsCache[T any] interface {
	Get() (T, bool)
	Set(T)
	Clear()
}

type ProofParams interface {
	GetProofRequestProbability() float64
	GetProofRequirementThreshold() *cosmostypes.Coin
	GetProofMissingPenalty() *cosmostypes.Coin
	GetProofSubmissionFee() *cosmostypes.Coin
}

type ProofQueryClient interface {
	// GetParams queries the chain for the current proof module parameters.
	GetParams(ctx context.Context) (ProofParams, error)

	// GetClaim queries the chain for the full claim associated with the (supplier, sessionId).
	GetClaim(ctx context.Context, supplierOperatorAddress string, sessionId string) (Claim, error)
}

type ServiceQueryClient interface {
	// GetService queries the chain for the details of the service provided
	GetService(ctx context.Context, serviceId string) (sharedtypes.Service, error)
	// GetServiceRelayDifficulty queries the chain for the relay difficulty of the service provided
	GetServiceRelayDifficulty(ctx context.Context, serviceId string) (servicetypes.RelayMiningDifficulty, error)
	// GetParams queries the chain for the current proof module parameters.
	GetParams(ctx context.Context) (*servicetypes.Params, error)
}

type SessionQueryClient interface {
	// GetSession queries the chain for the details of the session provided
	GetSession(
		ctx context.Context,
		appAddress string,
		serviceId string,
		blockHeight int64,
	) (*sessiontypes.Session, error)

	// GetParams queries the chain for the session module parameters.
	GetParams(ctx context.Context) (*sessiontypes.Params, error)
}

type SharedQueryClient interface {
	// GetParams queries the chain for the current shared module parameters.
	GetParams(ctx context.Context) (*sharedtypes.Params, error)
	// GetSessionGracePeriodEndHeight returns the block height at which the grace period
	// for the session that includes queryHeight elapses.
	// 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.
	GetSessionGracePeriodEndHeight(ctx context.Context, queryHeight int64) (int64, error)
	// GetClaimWindowOpenHeight returns the block height at which the claim window of
	// the session that includes queryHeight opens.
	GetClaimWindowOpenHeight(ctx context.Context, queryHeight int64) (int64, error)
	// GetEarliestSupplierClaimCommitHeight returns the earliest block height at which a claim
	// for the session that includes queryHeight can be committed for a given supplier.
	GetEarliestSupplierClaimCommitHeight(ctx context.Context, queryHeight int64, supplierOperatorAddr string) (int64, error)
	// GetProofWindowOpenHeight returns the block height at which the proof window of
	// the session that includes queryHeight opens.
	GetProofWindowOpenHeight(ctx context.Context, queryHeight int64) (int64, error)
	// GetEarliestSupplierProofCommitHeight returns the earliest block height at which a proof
	// for the session that includes queryHeight can be committed for a given supplier.
	GetEarliestSupplierProofCommitHeight(ctx context.Context, queryHeight int64, supplierOperatorAddr string) (int64, error)
}

type SupplierClient interface {
	// CreateClaims sends claim messages which creates an onchain commitment by calling supplier
	// to the given smt.SparseMerkleSumTree root hash of the given session's mined relays.
	//
	// A timeoutHeight is provided to ensure that the claim is not created after the claim
	// window has closed.
	CreateClaims(
		ctx context.Context,
		timeoutHeight int64,
		claimMsgs ...MsgCreateClaim,
	) error

	// SubmitProof sends proof messages which contain the smt.SparseCompactMerkleClosestProof,
	// corresponding to some previously created claim for the same session.
	// The proof is validated onchain as part of the pocket protocol.
	//
	// A timeoutHeight is provided to ensure that the proof is not submitted after
	// the proof window has closed.
	SubmitProofs(
		ctx context.Context,
		timeoutHeight int64,
		sessionProofs ...MsgSubmitProof,
	) error
	// OperatorAddress returns the bech32 string representation of the supplier operator address.
	OperatorAddress() string
}

type SupplierClientOption func(SupplierClient)

type SupplierQueryClient interface {
	// GetSupplier queries the chain for the details of the supplier provided
	GetSupplier(ctx context.Context, supplierOperatorAddress string) (sharedtypes.Supplier, error)

	// GetParams queries the chain for the supplier module parameters.
	GetParams(ctx context.Context) (*suppliertypes.Params, error)
}

type TxClient interface {
	SignAndBroadcastWithTimeoutHeight(
		ctx context.Context,
		timeoutHeight int64,
		msgs ...cosmostypes.Msg,
	) (txResponse *cosmostypes.TxResponse, eitherErr either.AsyncError)

	SignAndBroadcast(
		ctx context.Context,
		msgs ...cosmostypes.Msg,
	) (txResponse *cosmostypes.TxResponse, eitherErr either.AsyncError)
}

type TxClientOption func(TxClient)

type TxContext interface {
	// GetKeyring returns the associated key management mechanism for the transaction context.
	GetKeyring() cosmoskeyring.Keyring

	// NewTxBuilder creates and returns a new transaction builder instance.
	NewTxBuilder() cosmosclient.TxBuilder

	// SignTx signs a transaction using the specified key name. It can operate in offline mode,
	// and can overwrite any existing signatures based on the provided flags.
	SignTx(
		keyName string,
		txBuilder cosmosclient.TxBuilder,
		offline, overwriteSig, unordered bool,
	) error

	// EncodeTx takes a transaction builder and encodes it, returning its byte representation.
	EncodeTx(txBuilder cosmosclient.TxBuilder) ([]byte, error)

	// BroadcastTx broadcasts the given transaction to the network.
	BroadcastTx(txBytes []byte) (*cosmostypes.TxResponse, error)

	// QueryTx retrieves a transaction status based on its hash and optionally provides
	// proof of the transaction.
	QueryTx(
		ctx context.Context,
		txHash []byte,
		prove bool,
	) (*cometrpctypes.ResultTx, error)

	// GetClientCtx returns the cosmos-sdk client context associated with the transaction context.
	GetClientCtx() cosmosclient.Context

	// GetSimulatedTxGas returns the estimated gas for the given messages.
	GetSimulatedTxGas(
		ctx context.Context,
		signingKeyName string,
		msgs ...cosmostypes.Msg,
	) (uint64, error)

	// WithUnordered returns a copy of the transaction context with the unordered flag set.
	WithUnordered(bool) TxContext
}