feat(gnovm, tm2): implement event emission with std.Emit

gno.land/cmd/gnoland/testdata/event.txtar

@@ -0,0 +1,26 @@
+loadpkg gno.land/p/demo/ufmt
+
+# start a new node
+gnoland start
+
+gnokey maketx addpkg -pkgdir $WORK -pkgpath gno.land/r/demo/ee -gas-fee 1000000ugnot -gas-wanted 2000000 -broadcast -chainid=tendermint_test test1
+stdout OK!
+
+gnokey maketx call -pkgpath gno.land/r/demo/ee -func Hello -gas-fee 1000000ugnot -gas-wanted 2000000 -broadcast -chainid=tendermint_test test1
+
+
+-- ee.gno --
+package ee
+
+import (
+	"std"
+)
+
+const EventAttrKeySender = "sender"
+
+func Hello() {
+	std.EmitEvent(
+		EventAttrKeySender,
+		[]string{"value1", "value2"},
+	)
+}

gno.land/pkg/sdk/vm/keeper.go

@@ -186,6 +186,7 @@
 		OrigSendSpent: new(std.Coins),
 		OrigPkgAddr:   pkgAddr.Bech32(),
 		Banker:        NewSDKBanker(vm, ctx),
+		EventLogger:   ctx.EventLogger(),
 	}
 	// Parse and run the files, construct *PV.
 	m2 := gno.NewMachineWithOptions(
@@ -264,6 +265,7 @@
 		OrigSendSpent: new(std.Coins),
 		OrigPkgAddr:   pkgAddr.Bech32(),
 		Banker:        NewSDKBanker(vm, ctx),
+		EventLogger:   ctx.EventLogger(),
 	}
 	// Construct machine and evaluate.
 	m := gno.NewMachineWithOptions(
@@ -335,6 +337,7 @@
 		OrigSendSpent: new(std.Coins),
 		OrigPkgAddr:   pkgAddr.Bech32(),
 		Banker:        NewSDKBanker(vm, ctx),
+		EventLogger:   ctx.EventLogger(),
 	}
 	// Parse and run the files, construct *PV.
 	buf := new(bytes.Buffer)
@@ -467,6 +470,7 @@
 		// OrigSendSpent: nil,
 		OrigPkgAddr: pkgAddr.Bech32(),
 		Banker:      NewSDKBanker(vm, ctx), // safe as long as ctx is a fork to be discarded.
+		EventLogger: ctx.EventLogger(),
 	}
 	m := gno.NewMachineWithOptions(
 		gno.MachineOptions{
@@ -527,6 +531,7 @@
 		// OrigSendSpent: nil,
 		OrigPkgAddr: pkgAddr.Bech32(),
 		Banker:      NewSDKBanker(vm, ctx), // safe as long as ctx is a fork to be discarded.
+		EventLogger: ctx.EventLogger(),
 	}
 	m := gno.NewMachineWithOptions(
 		gno.MachineOptions{

gnovm/stdlibs/std/context.go

@@ -17,4 +17,5 @@ type ExecContext struct {
 	OrigSend      std.Coins
 	OrigSendSpent *std.Coins // mutable
 	Banker        BankerInterface
+	EventLogger   *sdk.EventLogger
 }

gnovm/stdlibs/std/emit_event.gno

@@ -0,0 +1,4 @@
+package std
+
+func EmitEvent(typ string, attrs []string) { emitEvent(typ, attrs) }
+func emitEvent(typ string, attrs []string)

gnovm/stdlibs/std/emit_event.go

@@ -0,0 +1,35 @@
+package std
+
+// ref: https://github.com/gnolang/gno/pull/853
+
+import (
+	"fmt"
+
+	gno "github.com/gnolang/gno/gnovm/pkg/gnolang"
+	"github.com/gnolang/gno/tm2/pkg/sdk"
+)
+
+func X_emitEvent(m *gno.Machine, typ string, attrs []string) {
+	eventAttrs := make([]sdk.EventAttribute, len(attrs)/2)
+	pkgPath := CurrentRealmPath(m)
+
+	attrLen := len(attrs)
+	if attrLen%2 != 0 {
+		panic(fmt.Sprintf("attributes has an odd number of elements. current length: %d", attrLen))
+	}
+
+	for i := 0; i < attrLen; i += 2 {
+		eventAttrs[i/2] = sdk.EventAttribute{
+			Key:   attrs[i],
+			Value: attrs[i+1],
+		}
+	}
+
+	timestamp := GetTimestamp(m)
+	height := GetHeight(m)
+
+	event := sdk.NewEvent(typ, pkgPath, height, timestamp, eventAttrs...)
+
+	ctx := m.Context.(ExecContext)
+	ctx.EventLogger.EmitEvent(event)
+}

gnovm/stdlibs/std/native.go

@@ -32,6 +32,10 @@ func GetHeight(m *gno.Machine) int64 {
 	return m.Context.(ExecContext).Height
 }
 
+func GetTimestamp(m *gno.Machine) int64 {
+	return m.Context.(ExecContext).Timestamp
+}
+
 func X_origSend(m *gno.Machine) (denoms []string, amounts []int64) {
 	os := m.Context.(ExecContext).OrigSend
 	return ExpandCoins(os)

gnovm/tests/file.go

@@ -13,6 +13,8 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/gnolang/gno/tm2/pkg/sdk"
+
 	gno "github.com/gnolang/gno/gnovm/pkg/gnolang"
 	"github.com/gnolang/gno/gnovm/stdlibs"
 	"github.com/gnolang/gno/tm2/pkg/crypto"
@@ -50,6 +52,7 @@ func testMachineCustom(store gno.Store, pkgPath string, stdout io.Writer, maxAll
 		OrigSend:      send,
 		OrigSendSpent: new(std.Coins),
 		Banker:        banker,
+		EventLogger:   sdk.NewEventLogger(),
 	}
 	m := gno.NewMachineWithOptions(gno.MachineOptions{
 		PkgPath:       "", // set later.

gnovm/tests/files/zrealm_natbind0.gno

@@ -141,7 +141,7 @@ func main() {
 //                 "Closure": {
 //                     "@type": "/gno.RefValue",
 //                     "Escaped": true,
-//                     "ObjectID": "a7f5397443359ea76c50be82c77f1f893a060925:6"
+//                     "ObjectID": "a7f5397443359ea76c50be82c77f1f893a060925:7"
 //                 },
 //                 "FileName": "native.gno",
 //                 "IsMethod": false,

tm2/pkg/crypto/keys/client/maketx.go

@@ -181,6 +181,7 @@ func ExecSignAndBroadcast(
 	io.Println("OK!")
 	io.Println("GAS WANTED:", bres.DeliverTx.GasWanted)
 	io.Println("GAS USED:  ", bres.DeliverTx.GasUsed)
+	io.Println("EVENTS:	", bres.DeliverTx.Events)
 
 	return nil
 }

tm2/pkg/sdk/baseapp.go

@@ -653,6 +653,7 @@ func (app *BaseApp) runMsgs(ctx Context, msgs []Msg, mode RunTxMode) (result Res
 		// each result.
 		data = append(data, msgResult.Data...)
 		events = append(events, msgResult.Events...)
+		events = append(events, ctx.EventLogger().Events()...)
 		// TODO append msgevent from ctx. XXX XXX
 
 		// stop execution and return on first failed message

tm2/pkg/sdk/events.go

@@ -1,6 +1,8 @@
 package sdk
 
 import (
+	"fmt"
+
 	abci "github.com/gnolang/gno/tm2/pkg/bft/abci/types"
 )
 
@@ -35,3 +37,46 @@ func (em *EventLogger) EmitEvents(events []Event) {
 // ----------------------------------------------------------------------------
 
 type Event = abci.Event
+
+func NewEvent(eventType string, pkgPath string, height, timestamp int64, attrs ...EventAttribute) Event {
+	return AttributedEvent{
+		Type:       eventType,
+		PkgPath:    pkgPath,
+		Attributes: attrs,
+		Height:     height,
+		Timestamp:  timestamp,
+	}
+}
+
+type AttributedEvent struct {
+	Type       string
+	PkgPath    string
+	Height     int64
+	Timestamp  int64
+	Attributes []EventAttribute
+}
+
+func (e AttributedEvent) AssertABCIEvent() {}
+
+func (e AttributedEvent) String() string {
+	return fmt.Sprintf(
+		"type: %s, pkgPath: %s, height: %d, timestamp: %d, attributes: %s",
+		e.Type, e.PkgPath, e.Height, e.Timestamp, e.Attributes,
+	)
+}
+
+type EventAttribute struct {
+	Key   string
+	Value string
+}
+
+func NewEventAttribute(key, value string) EventAttribute {
+	return EventAttribute{
+		Key:   key,
+		Value: value,
+	}
+}
+
+func (ea EventAttribute) String() string {
+	return fmt.Sprintf("%s: %s", ea.Key, ea.Value)
+}

tm2/pkg/sdk/package.go

@@ -15,4 +15,6 @@ var Package = amino.RegisterPackage(amino.NewPackage(
 	).
 	WithTypes(
 		Result{},
+		AttributedEvent{},
+		EventAttribute{},
 	))

tm2/pkg/sdk/sdk.proto

@@ -12,4 +12,4 @@ message Result {
 	abci.ResponseBase response_base = 1 [json_name = "ResponseBase"];
 	sint64 gas_wanted = 2 [json_name = "GasWanted"];
 	sint64 gas_used = 3 [json_name = "GasUsed"];
-}
+}