Merge pull request #5662 from oasisprotocol/kostko/feature/vault

go/vault: Add simple consensus layer vault

.changelog/5662.breaking.md

@@ -0,0 +1,5 @@
+go/vault: Add simple consensus layer vault
+
+The vault service is a simple multi-sig where multiple parties vote to
+perform actions on behalf of the vault account. This feature is disabled
+by default and needs to be enabled via a governance vote.

go/consensus/api/api.go

@@ -31,6 +31,7 @@ import (
 	"github.com/oasisprotocol/oasis-core/go/storage/mkvs/checkpoint"
 	mkvsNode "github.com/oasisprotocol/oasis-core/go/storage/mkvs/node"
 	"github.com/oasisprotocol/oasis-core/go/storage/mkvs/syncer"
+	vault "github.com/oasisprotocol/oasis-core/go/vault/api"
 )
 
 const (
@@ -202,6 +203,9 @@ type ClientBackend interface {
 
 	// RootHash returns the roothash backend.
 	RootHash() roothash.Backend
+
+	// Vault returns the vault backend.
+	Vault() vault.Backend
 }
 
 // Block is a consensus block.

go/consensus/api/grpc.go

@@ -17,6 +17,7 @@ import (
 	scheduler "github.com/oasisprotocol/oasis-core/go/scheduler/api"
 	staking "github.com/oasisprotocol/oasis-core/go/staking/api"
 	"github.com/oasisprotocol/oasis-core/go/storage/mkvs/syncer"
+	vault "github.com/oasisprotocol/oasis-core/go/vault/api"
 )
 
 var (
@@ -928,6 +929,10 @@ func (c *consensusClient) RootHash() roothash.Backend {
 	return roothash.NewRootHashClient(c.conn)
 }
 
+func (c *consensusClient) Vault() vault.Backend {
+	return vault.NewVaultClient(c.conn)
+}
+
 // NewConsensusClient creates a new gRPC consensus client service.
 func NewConsensusClient(c *grpc.ClientConn) ClientBackend {
 	return &consensusClient{

go/consensus/cometbft/abci/messages.go

@@ -23,14 +23,27 @@ func (md *messageDispatcher) Subscribe(kind interface{}, ms api.MessageSubscribe
 
 // Implements api.MessageDispatcher.
 func (md *messageDispatcher) Publish(ctx *api.Context, kind, msg interface{}) (interface{}, error) {
-	nSubs := len(md.subscriptions[kind])
-	if nSubs == 0 {
-		return nil, api.ErrNoSubscribers
-	}
-
-	var result interface{}
-	var errs error
+	var (
+		result         interface{}
+		errs           error
+		numSubscribers int
+	)
 	for _, ms := range md.subscriptions[kind] {
+		// Check whether the subscriber can be toggled.
+		if togMs, ok := ms.(api.TogglableMessageSubscriber); ok {
+			enabled, err := togMs.Enabled(ctx)
+			if err != nil {
+				errs = errors.Join(errs, err)
+				continue
+			}
+			if !enabled {
+				// If a subscriber is not enabled, skip it during dispatch.
+				continue
+			}
+		}
+		numSubscribers++
+
+		// Deliver the message.
 		if resp, err := ms.ExecuteMessage(ctx, kind, msg); err != nil {
 			errs = errors.Join(errs, err)
 		} else {
@@ -45,6 +58,9 @@ func (md *messageDispatcher) Publish(ctx *api.Context, kind, msg interface{}) (i
 			}
 		}
 	}
+	if numSubscribers == 0 {
+		return nil, api.ErrNoSubscribers
+	}
 	if errs != nil {
 		return nil, errs
 	}

go/consensus/cometbft/abci/messages_test.go

@@ -27,6 +27,7 @@ var errTest = fmt.Errorf("error")
 
 type testSubscriber struct {
 	msgs     []int32
+	enabled  bool
 	fail     bool
 	noResult bool
 }
@@ -50,6 +51,11 @@ func (s *testSubscriber) ExecuteMessage(_ *api.Context, _, msg interface{}) (int
 	}
 }
 
+// Implements api.TogglableMessageSubscriber.
+func (s *testSubscriber) Enabled(_ *api.Context) (bool, error) {
+	return s.enabled, nil
+}
+
 func TestMessageDispatcher(t *testing.T) {
 	require := require.New(t)
 
@@ -65,10 +71,18 @@ func TestMessageDispatcher(t *testing.T) {
 	require.Equal(api.ErrNoSubscribers, err)
 	require.Nil(res, "Publish results should be empty")
 
-	// With a subscriber.
+	// With a disabled subscriber should behave same as with no subscribers.
 	var ms testSubscriber
 	md.Subscribe(testMessageA, &ms)
 	res, err = md.Publish(ctx, testMessageA, &testMessage{foo: 42})
+	require.Error(err, "Publish")
+	require.Equal(api.ErrNoSubscribers, err)
+	require.Nil(res, "Publish results should be empty")
+	require.Empty(ms.msgs, "no messages should be delivered when subscriber is disabled")
+
+	// With an enabled subscriber.
+	ms.enabled = true
+	res, err = md.Publish(ctx, testMessageA, &testMessage{foo: 42})
 	require.NoError(err, "Publish")
 	require.EqualValues(int32(42), res, "correct publish message result")
 	require.EqualValues([]int32{42}, ms.msgs, "correct messages should be delivered")
@@ -92,6 +106,7 @@ func TestMessageDispatcher(t *testing.T) {
 
 	// Multiple subscribers. Multiple subscribers returning results on the same message is an invariant violation.
 	ms2 := testSubscriber{
+		enabled:  true,
 		noResult: true,
 	}
 	md.Subscribe(testMessageA, &ms2)

go/consensus/cometbft/abci/mux.go

@@ -877,6 +877,30 @@ func (mux *abciMux) doRegister(app api.Application) error {
 	return nil
 }
 
+// resolveAppForMethod resolves an application that should handle the given method.
+func (mux *abciMux) resolveAppForMethod(ctx *api.Context, method transaction.MethodName) (api.Application, error) {
+	app, ok := mux.appsByMethod[method]
+	if !ok {
+		ctx.Logger().Debug("unknown method",
+			"method", method,
+		)
+		return nil, fmt.Errorf("mux: unknown method: %s", method)
+	}
+
+	// Check whether an application can be toggled.
+	if togApp, ok := app.(api.TogglableApplication); ok {
+		enabled, err := togApp.Enabled(ctx)
+		if err != nil {
+			return nil, err
+		}
+		if !enabled {
+			// If an application is not enabled, treat it as if the method does not exist.
+			return nil, fmt.Errorf("mux: unknown method: %s", method)
+		}
+	}
+	return app, nil
+}
+
 func (mux *abciMux) rebuildAppLexOrdering() {
 	numApps := len(mux.appsByName)
 	appOrder := make([]string, 0, numApps)
@@ -962,6 +986,9 @@ func newABCIMux(ctx context.Context, upgrader upgrade.Backend, cfg *ApplicationC
 		appsByMethod: make(map[transaction.MethodName]api.Application),
 	}
 
+	// Subscribe message handlers.
+	mux.md.Subscribe(api.MessageExecuteSubcall, mux)
+
 	mux.logger.Debug("ABCI multiplexer initialized",
 		"block_height", state.BlockHeight(),
 		"state_root_hash", hex.EncodeToString(state.StateRootHash()),

go/consensus/cometbft/abci/subcall.go

@@ -0,0 +1,56 @@
+package abci
+
+import (
+	"fmt"
+
+	"github.com/oasisprotocol/oasis-core/go/consensus/api/transaction"
+	"github.com/oasisprotocol/oasis-core/go/consensus/cometbft/api"
+)
+
+// maxSubcallDepth is the maximum subcall depth.
+const maxSubcallDepth = 8
+
+// ExecuteMessage implements api.MessageSubscriber.
+func (mux *abciMux) ExecuteMessage(ctx *api.Context, kind, msg interface{}) (interface{}, error) {
+	switch kind {
+	case api.MessageExecuteSubcall:
+		// Subcall execution request.
+		info, ok := msg.(*api.SubcallInfo)
+		if !ok {
+			return nil, fmt.Errorf("invalid subcall info")
+		}
+		return struct{}{}, mux.executeSubcall(ctx, info)
+	default:
+		return nil, nil
+	}
+}
+
+// executeSubcall executes a subcall.
+func (mux *abciMux) executeSubcall(ctx *api.Context, info *api.SubcallInfo) error {
+	if ctx.CallDepth() > maxSubcallDepth {
+		return fmt.Errorf("call depth exceeded")
+	}
+
+	ctx = ctx.WithCallerAddress(info.Caller)
+	defer ctx.Close()
+	ctx = ctx.NewTransaction()
+	defer ctx.Close()
+
+	// Lookup method handler.
+	app, err := mux.resolveAppForMethod(ctx, info.Method)
+	if err != nil {
+		return err
+	}
+
+	tx := &transaction.Transaction{
+		Method: info.Method,
+		Body:   info.Body,
+	}
+	if err = app.ExecuteTx(ctx, tx); err != nil {
+		return err
+	}
+
+	ctx.Commit()
+
+	return nil
+}

go/consensus/cometbft/abci/transaction.go

@@ -62,13 +62,9 @@ func (mux *abciMux) processTx(ctx *api.Context, tx *transaction.Transaction, txS
 	}
 
 	// Lookup method handler.
-	app := mux.appsByMethod[tx.Method]
-	if app == nil {
-		ctx.Logger().Debug("unknown method",
-			"tx", tx,
-			"method", tx.Method,
-		)
-		return fmt.Errorf("mux: unknown method: %s", tx.Method)
+	app, err := mux.resolveAppForMethod(ctx, tx.Method)
+	if err != nil {
+		return err
 	}
 
 	// Pass the transaction through the fee handler if configured.

go/consensus/cometbft/api/api.go

@@ -374,9 +374,15 @@ func (bsc *BaseServiceClient) DeliverCommand(context.Context, int64, interface{}
 
 type messageKind uint8
 
-// MessageStateSyncCompleted is the message kind for when the node successfully performs a state
-// sync. The message itself is nil.
-var MessageStateSyncCompleted = messageKind(0)
+var (
+	// MessageStateSyncCompleted is the message kind for when the node successfully performs a state
+	// sync. The message itself is nil.
+	MessageStateSyncCompleted = messageKind(0)
+
+	// MessageExecuteSubcall is the message kind for requesting subcall execution. The message is
+	// handled by the multiplexer and should be an instance of SubcallInfo.
+	MessageExecuteSubcall = messageKind(1)
+)
 
 // CometBFTChainID returns the CometBFT chain ID computed from chain context.
 func CometBFTChainID(chainContext string) string {

go/consensus/cometbft/api/app.go

@@ -18,6 +18,12 @@ type MessageSubscriber interface {
 	ExecuteMessage(ctx *Context, kind, msg interface{}) (interface{}, error)
 }
 
+// TogglableMessageSubscriber is a message subscriber that can be disabled.
+type TogglableMessageSubscriber interface {
+	// Enabled checks whether the message subscriber is enabled.
+	Enabled(ctx *Context) (bool, error)
+}
+
 // MessageDispatcher is a message dispatcher interface.
 type MessageDispatcher interface {
 	// Subscribe subscribes a given message subscriber to messages of a specific kind.
@@ -134,3 +140,9 @@ type Extension interface {
 	// Note: Errors are irrecoverable and will result in a panic.
 	EndBlock(*Context) error
 }
+
+// TogglableApplication is an application that can be disabled.
+type TogglableApplication interface {
+	// Enabled checks whether the application is enabled.
+	Enabled(*Context) (bool, error)
+}

go/consensus/cometbft/api/context.go

@@ -207,6 +207,14 @@ func (c *Context) CallerAddress() staking.Address {
 	return c.callerAddress
 }
 
+// CallDepth returns the call depth.
+func (c *Context) CallDepth() int {
+	if c.parent == nil {
+		return 0
+	}
+	return c.parent.CallDepth() + 1
+}
+
 // NewChild creates a new child context that shares state with the current context.
 //
 // If you want isolated state and events use NewTransaction instad.

go/consensus/cometbft/api/context_test.go

@@ -51,6 +51,7 @@ func TestChildContext(t *testing.T) {
 
 	ctx.SetTxSigner(pk1)
 	require.Equal(addr1, ctx.CallerAddress(), "CallerAddress should correspond to TxSigner")
+	require.EqualValues(0, ctx.CallDepth(), "CallDepth should be zero for top-level context")
 
 	pk2 := signature.NewPublicKey("1234567890000000000000000000000000000000000000000000000000000000")
 	addr2 := staking.NewAddress(pk2)
@@ -64,6 +65,7 @@ func TestChildContext(t *testing.T) {
 	require.EqualValues(ctx.InitialHeight(), child.InitialHeight(), "child.InitialHeight should correspond to parent.InitialHeight")
 	require.EqualValues(ctx.BlockHeight(), child.BlockHeight(), "child.BlockHeight should correspond to parent.BlockHeight")
 	require.EqualValues(ctx.BlockContext(), child.BlockContext(), "child.BlockContext should correspond to parent.BlockContext")
+	require.EqualValues(1, child.CallDepth(), "child.CallDepth should be correct")
 
 	// Emitting an event should not propagate to the parent immediately.
 	child.EmitEvent(NewEventBuilder("test").TypedAttribute(&FooEvent{Bar: []byte("bar")}))
@@ -144,6 +146,8 @@ func TestNestedTransactionContext(t *testing.T) {
 	require := require.New(t)
 
 	doChild2 := func(ctx *Context) {
+		require.EqualValues(2, ctx.CallDepth(), "CallDepth should be correct")
+
 		tree := ctx.State()
 
 		err := tree.Insert(ctx, []byte("child2"), []byte("value2"))
@@ -163,6 +167,8 @@ func TestNestedTransactionContext(t *testing.T) {
 	}
 
 	doChild1 := func(ctx *Context) {
+		require.EqualValues(1, ctx.CallDepth(), "CallDepth should be correct")
+
 		tree := ctx.State()
 
 		err := tree.Insert(ctx, []byte("child1"), []byte("value1"))

go/consensus/cometbft/api/subcall.go

@@ -0,0 +1,17 @@
+package api
+
+import (
+	"github.com/oasisprotocol/oasis-core/go/common/cbor"
+	"github.com/oasisprotocol/oasis-core/go/consensus/api/transaction"
+	staking "github.com/oasisprotocol/oasis-core/go/staking/api"
+)
+
+// SubcallInfo is the information about a subcall that should be executed.
+type SubcallInfo struct {
+	// Caller is the address of the caller.
+	Caller staking.Address
+	// Method is the name of the method that should be invoked.
+	Method transaction.MethodName
+	// Body is the subcall body.
+	Body cbor.RawMessage
+}

go/consensus/cometbft/apps/governance/transactions.go

@@ -60,7 +60,7 @@ func (app *governanceApplication) submitProposal(
 	}
 
 	// Load submitter account.
-	submitterAddr := stakingAPI.NewAddress(ctx.TxSigner())
+	submitterAddr := ctx.CallerAddress()
 	if !submitterAddr.IsValid() {
 		return nil, stakingAPI.ErrForbidden
 	}
@@ -239,7 +239,7 @@ func (app *governanceApplication) castVote(
 		return nil
 	}
 
-	submitterAddr := stakingAPI.NewAddress(ctx.TxSigner())
+	submitterAddr := ctx.CallerAddress()
 	if !submitterAddr.IsValid() {
 		return stakingAPI.ErrForbidden
 	}
@@ -304,7 +304,7 @@ func (app *governanceApplication) castVote(
 
 	if !eligible {
 		ctx.Logger().Debug("governance: submitter not eligible to vote",
-			"submitter", ctx.TxSigner(),
+			"submitter", ctx.CallerAddress(),
 		)
 		return governance.ErrNotEligible
 	}