feat: add core module API

core/appmodule/handler.go

@@ -0,0 +1,53 @@
+package appmodule
+
+import (
+	"context"
+
+	"google.golang.org/grpc"
+
+	"github.com/cosmos/cosmos-sdk/depinject"
+)
+
+// Handler describes an ABCI app module handler. It can be injected into a
+// depinject container as a one-per-module type (in the pointer variant).
+type Handler struct {
+	// Services are the msg and query services for the module. Msg services
+	// must be annotated with the option cosmos.msg.v1.service = true.
+	Services []ServiceImpl
+
+	// BeginBlocker doesn't take or return any special arguments as this
+	// is the most stable across Tendermint versions and most common need
+	// for modules. Special parameters can be inspected and/or returned
+	// using custom hooks that the app will provide which may vary from
+	// one Tendermint release to another.
+	BeginBlocker func(context.Context) error
+
+	// EndBlocker doesn't take or return any special arguments as this
+	// is the most stable across Tendermint versions and most common need
+	// for modules. Special parameters can be inspected and/or returned
+	// using custom hooks that the app will provide which may vary from
+	// one Tendermint release to another.
+	EndBlocker func(context.Context) error
+}
+
+// RegisterService registers a msg or query service. If the cosmos.msg.v1.service
+// option is set true on the service, then it is registered as a msg service,
+// otherwise it is registered as a query service.
+func (h *Handler) RegisterService(desc *grpc.ServiceDesc, impl interface{}) {
+	h.Services = append(h.Services, ServiceImpl{
+		Desc: desc,
+		Impl: impl,
+	})
+}
+
+// ServiceImpl describes a gRPC service implementation to be registered with
+// grpc.ServiceRegistrar.
+type ServiceImpl struct {
+	Desc *grpc.ServiceDesc
+	Impl interface{}
+}
+
+func (h *Handler) IsOnePerModuleType() {}
+
+var _ depinject.OnePerModuleType = &Handler{}
+var _ grpc.ServiceRegistrar = &Handler{}

core/blockinfo/service.go

@@ -0,0 +1,37 @@
+// Package blockinfo provides an API for app modules to get basic
+// information about blocks that is available against any underlying Tendermint
+// core version (or other consensus layer that could be used in the future).
+package blockinfo
+
+import (
+	"context"
+
+	"google.golang.org/protobuf/types/known/timestamppb"
+)
+
+// Service is a type which retrieves basic block info from a context independent
+// of any specific Tendermint core version. Modules which need a specific
+// Tendermint header should use a different service and should expect to need
+// to update whenever Tendermint makes any changes. blockinfo.Service is a
+// core API type that should be provided by the runtime module being used to
+// build an app via depinject.
+type Service interface {
+	// GetBlockInfo returns the current block info for the context.
+	GetBlockInfo(ctx context.Context) BlockInfo
+}
+
+// BlockInfo represents basic block info independent of any specific Tendermint
+// core version.
+type BlockInfo interface {
+	// ChainID returns the chain ID.
+	ChainID() string
+
+	// Height returns the current block height.
+	Height() int64
+
+	// Time returns the current block timestamp.
+	Time() *timestamppb.Timestamp
+
+	// Hash returns the current block hash.
+	Hash() []byte
+}

core/compat.go

@@ -0,0 +1,8 @@
+package core
+
+// RuntimeCompatibilityVersion indicates what semantic version of the runtime
+// module is required to support the full API exposed in this version of core.
+// The runtime module that is loaded can emit an error or warning if the version
+// specified here is greater than what that runtime can support and some
+// features may not work as expected.
+const RuntimeCompatibilityVersion = 1

core/event/manager.go

@@ -0,0 +1,34 @@
+// Package event provides a basic API for app modules to emit events.
+package event
+
+import (
+	"context"
+
+	"google.golang.org/protobuf/proto"
+)
+
+// Service represents an event service which can retrieve and set an event manager in a context.
+// event.Service is a core API type that should be provided by the runtime module being used to
+// build an app via depinject.
+type Service interface {
+	// GetManager returns the event manager for the context or a no-op event manager if one isn't attached.
+	GetManager(context.Context) Manager
+
+	// WithManager returns a new context with the provided event manager attached.
+	WithManager(context.Context, Manager) context.Context
+}
+
+// Manager represents an event manager.
+type Manager interface {
+
+	// Emit emits a typed protobuf event.
+	Emit(proto.Message) error
+
+	// EmitLegacy emits a legacy (untyped) tendermint event.
+	EmitLegacy(eventType string, attrs ...LegacyEventAttribute) error
+}
+
+// LegacyEventAttribute is a legacy (untyped) event attribute.
+type LegacyEventAttribute struct {
+	Key, Value string
+}

core/gas/meter.go

@@ -0,0 +1,40 @@
+// Package gas provides a basic API for app modules to track gas usage.
+package gas
+
+import "context"
+
+type Gas = uint64
+
+// Service represents a gas service which can retrieve and set a gas meter in a context.
+// gas.Service is a core API type that should be provided by the runtime module being used to
+// build an app via depinject.
+type Service interface {
+	// GetMeter returns the current transaction-level gas meter. A non-nil meter
+	// is always returned. When one is unavailable in the context an infinite gas meter
+	// will be returned.
+	GetMeter(context.Context)
+
+	// GetBlockMeter returns the current block-level gas meter. A non-nil meter
+	// is always returned. When one is unavailable in the context an infinite gas meter
+	// will be returned.
+	GetBlockMeter(context.Context)
+
+	// WithMeter returns a new context with the provided transaction-level gas meter.
+	WithMeter(ctx context.Context, meter Meter) context.Context
+
+	// WithMeter returns a new context with the provided block-level gas meter.
+	WithBlockMeter(ctx context.Context, meter Meter) context.Context
+}
+
+// Meter represents a gas meter.
+type Meter interface {
+	GasConsumed() Gas
+	GasConsumedToLimit() Gas
+	GasRemaining() Gas
+	Limit() Gas
+	ConsumeGas(amount Gas, descriptor string)
+	RefundGas(amount Gas, descriptor string)
+	IsPastLimit() bool
+	IsOutOfGas() bool
+	String() string
+}

core/go.mod

@@ -6,23 +6,35 @@ require (
 	cosmossdk.io/api v0.1.0-alpha8
 	github.com/cosmos/cosmos-proto v1.0.0-alpha7
 	github.com/cosmos/cosmos-sdk/depinject v1.0.0-alpha.4
+	github.com/gogo/protobuf v1.3.2
+	github.com/tendermint/tm-db v0.6.7
+	google.golang.org/grpc v1.46.2
 	google.golang.org/protobuf v1.28.0
 	gotest.tools/v3 v3.2.0
 	sigs.k8s.io/yaml v1.3.0
 )
 
 require (
+	github.com/DataDog/zstd v1.4.1 // indirect
+	github.com/cespare/xxhash v1.1.0 // indirect
+	github.com/cosmos/gorocksdb v1.2.0 // indirect
+	github.com/dgraph-io/badger/v2 v2.2007.2 // indirect
+	github.com/dgraph-io/ristretto v0.0.3-0.20200630154024-f66de99634de // indirect
+	github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2 // indirect
+	github.com/dustin/go-humanize v1.0.0 // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/golang/snappy v0.0.1 // indirect
+	github.com/google/btree v1.0.0 // indirect
 	github.com/google/go-cmp v0.5.6 // indirect
-	github.com/kr/pretty v0.1.0 // indirect
+	github.com/jmhodges/levigo v1.0.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/syndtr/goleveldb v1.0.1-0.20200815110645-5c35d600f0ca // indirect
+	go.etcd.io/bbolt v1.3.6 // indirect
 	golang.org/x/exp v0.0.0-20220428152302-39d4317da171 // indirect
 	golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 // indirect
 	golang.org/x/sys v0.0.0-20211019181941-9d821ace8654 // indirect
 	golang.org/x/text v0.3.5 // indirect
 	google.golang.org/genproto v0.0.0-20211223182754-3ac035c7e7cb // indirect
-	google.golang.org/grpc v1.46.2 // indirect
-	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 )