Merge pull request #6148 from oasisprotocol/peternose/trivial/decouple-apps-client-services

go/consensus/cometbft/full: Decouple apps from client services

Author: peternose

.changelog/6148.trivial.md

@@ -0,0 +1,49 @@
+package abci
+
+import (
+	"context"
+
+	consensusState "github.com/oasisprotocol/oasis-core/go/consensus/cometbft/abci/state"
+	abciAPI "github.com/oasisprotocol/oasis-core/go/consensus/cometbft/api"
+	consensusGenesis "github.com/oasisprotocol/oasis-core/go/consensus/genesis"
+)
+
+// Query is the consensus backend query interface.
+type Query interface {
+	ChainContext(ctx context.Context) (string, error)
+	ConsensusParameters(ctx context.Context) (*consensusGenesis.Parameters, error)
+}
+
+// QueryFactory is the consensus backend query factory.
+type QueryFactory struct {
+	state abciAPI.ApplicationQueryState
+}
+
+// NewQueryFactory returns a new QueryFactory backed by the given state
+// instance.
+func NewQueryFactory(state abciAPI.ApplicationQueryState) *QueryFactory {
+	return &QueryFactory{state}
+}
+
+// QueryAt returns the consensus backend query interface for a specific height.
+func (f *QueryFactory) QueryAt(ctx context.Context, height int64) (Query, error) {
+	state, err := abciAPI.NewImmutableStateAt(ctx, f.state, height)
+	if err != nil {
+		return nil, err
+	}
+	return &consensusQuerier{
+		state: consensusState.NewImmutableState(state),
+	}, nil
+}
+
+type consensusQuerier struct {
+	state *consensusState.ImmutableState
+}
+
+func (q *consensusQuerier) ChainContext(ctx context.Context) (string, error) {
+	return q.state.ChainContext(ctx)
+}
+
+func (q *consensusQuerier) ConsensusParameters(ctx context.Context) (*consensusGenesis.Parameters, error) {
+	return q.state.ConsensusParameters(ctx)
+}

go/consensus/cometbft/abci/query.go

@@ -34,17 +34,6 @@ func NewImmutableState(tree mkvs.ImmutableKeyValueTree) *ImmutableState {
 	}
 }
 
-// NewImmutableStateAt creates a new immutable consensus backend state wrapper
-// using the provided application query state and version.
-func NewImmutableStateAt(ctx context.Context, state api.ApplicationQueryState, version int64) (*ImmutableState, error) {
-	is, err := api.NewImmutableStateAt(ctx, state, version)
-	if err != nil {
-		return nil, err
-	}
-
-	return &ImmutableState{is}, nil
-}
-
 // ChainContext returns the stored chain context.
 func (s *ImmutableState) ChainContext(ctx context.Context) (string, error) {
 	chainContext, err := s.state.Get(ctx, chainContextKeyFmt.Encode())

go/consensus/cometbft/abci/state/state.go

@@ -202,11 +202,6 @@ func NewBlock(blk *cmttypes.Block) *consensus.Block {
 type Backend interface {
 	consensus.Backend
 
-	// RegisterApplication registers an ABCI multiplexer application
-	// with this service instance and check that its dependencies are
-	// registered.
-	RegisterApplication(Application) error
-
 	// SetTransactionAuthHandler configures the transaction fee handler for the
 	// ABCI multiplexer.
 	SetTransactionAuthHandler(TransactionAuthHandler) error

go/consensus/cometbft/api/api.go

@@ -13,7 +13,7 @@ import (
 )
 
 type backendInsecure struct {
-	app *beaconApplication
+	app *Application
 }
 
 func (impl *backendInsecure) OnInitChain(

go/consensus/cometbft/apps/beacon/backend_insecure.go

@@ -22,7 +22,7 @@ import (
 var vrfAlphaDomainsep = []byte("oasis-core:vrf/alpha")
 
 type backendVRF struct {
-	app *beaconApplication
+	app *Application
 }
 
 func (impl *backendVRF) OnInitChain(

go/consensus/cometbft/apps/beacon/backend_vrf.go

@@ -16,46 +16,42 @@ import (
 	beaconState "github.com/oasisprotocol/oasis-core/go/consensus/cometbft/apps/beacon/state"
 )
 
-var (
-	prodEntropyCtx = []byte("EkB-tmnt")
+var prodEntropyCtx = []byte("EkB-tmnt")
 
-	_ api.Application = (*beaconApplication)(nil)
-)
-
-type beaconApplication struct {
+type Application struct {
 	state api.ApplicationState
 
 	backend internalBackend
 }
 
-func (app *beaconApplication) Name() string {
+func (app *Application) Name() string {
 	return AppName
 }
 
-func (app *beaconApplication) ID() uint8 {
+func (app *Application) ID() uint8 {
 	return AppID
 }
 
-func (app *beaconApplication) Methods() []transaction.MethodName {
+func (app *Application) Methods() []transaction.MethodName {
 	return Methods
 }
 
-func (app *beaconApplication) Blessed() bool {
+func (app *Application) Blessed() bool {
 	return false
 }
 
-func (app *beaconApplication) Dependencies() []string {
+func (app *Application) Dependencies() []string {
 	return nil
 }
 
-func (app *beaconApplication) OnRegister(state api.ApplicationState, _ api.MessageDispatcher) {
+func (app *Application) OnRegister(state api.ApplicationState, _ api.MessageDispatcher) {
 	app.state = state
 }
 
-func (app *beaconApplication) OnCleanup() {
+func (app *Application) OnCleanup() {
 }
 
-func (app *beaconApplication) BeginBlock(ctx *api.Context) error {
+func (app *Application) BeginBlock(ctx *api.Context) error {
 	state := beaconState.NewMutableState(ctx.State())
 
 	params, err := state.ConsensusParameters(ctx)
@@ -70,11 +66,11 @@ func (app *beaconApplication) BeginBlock(ctx *api.Context) error {
 	return app.backend.OnBeginBlock(ctx, state, params)
 }
 
-func (app *beaconApplication) ExecuteMessage(*api.Context, any, any) (any, error) {
+func (app *Application) ExecuteMessage(*api.Context, any, any) (any, error) {
 	return nil, fmt.Errorf("beacon: unexpected message")
 }
 
-func (app *beaconApplication) ExecuteTx(ctx *api.Context, tx *transaction.Transaction) error {
+func (app *Application) ExecuteTx(ctx *api.Context, tx *transaction.Transaction) error {
 	if app.backend == nil {
 		// Executing a transaction before BeginBlock -- likely during transaction simulation or
 		// checks. Fail the transaction, it may be retried.
@@ -93,15 +89,15 @@ func (app *beaconApplication) ExecuteTx(ctx *api.Context, tx *transaction.Transa
 	return app.backend.ExecuteTx(ctx, state, params, tx)
 }
 
-func (app *beaconApplication) EndBlock(*api.Context) (types.ResponseEndBlock, error) {
+func (app *Application) EndBlock(*api.Context) (types.ResponseEndBlock, error) {
 	return types.ResponseEndBlock{}, nil
 }
 
-func (app *beaconApplication) doEmitEpochEvent(ctx *api.Context, epoch beacon.EpochTime) {
+func (app *Application) doEmitEpochEvent(ctx *api.Context, epoch beacon.EpochTime) {
 	ctx.EmitEvent(api.NewEventBuilder(app.Name()).TypedAttribute(&beacon.EpochEvent{Epoch: epoch}))
 }
 
-func (app *beaconApplication) scheduleEpochTransitionBlock(
+func (app *Application) scheduleEpochTransitionBlock(
 	ctx *api.Context,
 	state *beaconState.MutableState,
 	nextEpoch beacon.EpochTime,
@@ -119,7 +115,7 @@ func (app *beaconApplication) scheduleEpochTransitionBlock(
 	return nil
 }
 
-func (app *beaconApplication) onNewBeacon(ctx *api.Context, value []byte) error {
+func (app *Application) onNewBeacon(ctx *api.Context, value []byte) error {
 	state := beaconState.NewMutableState(ctx.State())
 
 	if err := state.SetBeacon(ctx, value); err != nil {
@@ -135,8 +131,8 @@ func (app *beaconApplication) onNewBeacon(ctx *api.Context, value []byte) error
 }
 
 // New constructs a new beacon application instance.
-func New() api.Application {
-	return &beaconApplication{}
+func New() *Application {
+	return &Application{}
 }
 
 // insecureBlockEntropy returns insecure entropy based on deterministic block data.

go/consensus/cometbft/apps/beacon/beacon.go

@@ -12,7 +12,7 @@ import (
 	genesis "github.com/oasisprotocol/oasis-core/go/genesis/api"
 )
 
-func (app *beaconApplication) InitChain(ctx *api.Context, _ types.RequestInitChain, doc *genesis.Document) error {
+func (app *Application) InitChain(ctx *api.Context, _ types.RequestInitChain, doc *genesis.Document) error {
 	params := &doc.Beacon.Parameters
 
 	// Note: If we ever decide that we need a beacon for the 0th epoch
@@ -38,7 +38,7 @@ func (app *beaconApplication) InitChain(ctx *api.Context, _ types.RequestInitCha
 	return nil
 }
 
-func (app *beaconApplication) doInitBackend(params *beacon.ConsensusParameters) error {
+func (app *Application) doInitBackend(params *beacon.ConsensusParameters) error {
 	if app.backend != nil {
 		return nil
 	}

go/consensus/cometbft/apps/beacon/genesis.go

@@ -24,39 +24,41 @@ type QueryFactory struct {
 }
 
 // QueryAt returns the beacon query interface for a specific height.
-func (sf *QueryFactory) QueryAt(ctx context.Context, height int64) (Query, error) {
-	state, err := beaconState.NewImmutableStateAt(ctx, sf.state, height)
+func (f *QueryFactory) QueryAt(ctx context.Context, height int64) (Query, error) {
+	state, err := abciAPI.NewImmutableStateAt(ctx, f.state, height)
 	if err != nil {
 		return nil, err
 	}
-	return &beaconQuerier{state}, nil
+	return &beaconQuerier{
+		state: beaconState.NewImmutableState(state),
+	}, nil
 }
 
 type beaconQuerier struct {
 	state *beaconState.ImmutableState
 }
 
-func (bq *beaconQuerier) Beacon(ctx context.Context) ([]byte, error) {
-	return bq.state.Beacon(ctx)
+func (q *beaconQuerier) Beacon(ctx context.Context) ([]byte, error) {
+	return q.state.Beacon(ctx)
 }
 
-func (bq *beaconQuerier) Epoch(ctx context.Context) (beacon.EpochTime, int64, error) {
-	return bq.state.GetEpoch(ctx)
+func (q *beaconQuerier) Epoch(ctx context.Context) (beacon.EpochTime, int64, error) {
+	return q.state.GetEpoch(ctx)
 }
 
-func (bq *beaconQuerier) FutureEpoch(ctx context.Context) (*beacon.EpochTimeState, error) {
-	return bq.state.GetFutureEpoch(ctx)
+func (q *beaconQuerier) FutureEpoch(ctx context.Context) (*beacon.EpochTimeState, error) {
+	return q.state.GetFutureEpoch(ctx)
 }
 
-func (bq *beaconQuerier) ConsensusParameters(ctx context.Context) (*beacon.ConsensusParameters, error) {
-	return bq.state.ConsensusParameters(ctx)
+func (q *beaconQuerier) ConsensusParameters(ctx context.Context) (*beacon.ConsensusParameters, error) {
+	return q.state.ConsensusParameters(ctx)
 }
 
-func (bq *beaconQuerier) VRFState(ctx context.Context) (*beacon.VRFState, error) {
-	return bq.state.VRFState(ctx)
+func (q *beaconQuerier) VRFState(ctx context.Context) (*beacon.VRFState, error) {
+	return q.state.VRFState(ctx)
 }
 
-func (app *beaconApplication) QueryFactory() any {
+func (app *Application) QueryFactory() any {
 	return &QueryFactory{app.state}
 }
 

go/consensus/cometbft/apps/beacon/query.go

@@ -48,17 +48,6 @@ func NewImmutableState(tree mkvs.ImmutableKeyValueTree) *ImmutableState {
 	}
 }
 
-// NewImmutableStateAt creates a new immutable beacon state wrapper
-// using the provided application query state and version.
-func NewImmutableStateAt(ctx context.Context, state abciAPI.ApplicationQueryState, version int64) (*ImmutableState, error) {
-	is, err := abciAPI.NewImmutableStateAt(ctx, state, version)
-	if err != nil {
-		return nil, err
-	}
-
-	return &ImmutableState{is}, nil
-}
-
 // Beacon gets the current random beacon value.
 func (s *ImmutableState) Beacon(ctx context.Context) ([]byte, error) {
 	data, err := s.state.Get(ctx, beaconKeyFmt.Encode())