Merge pull request #1515 from nspcc-dev/new-system-triggers

New system triggers

pkg/core/blockchain.go

@@ -565,7 +565,7 @@ func (bc *Blockchain) storeBlock(block *block.Block, txpool *mempool.Pool) error
 	writeBuf.Reset()
 
 	if block.Index > 0 {
-		aer, err := bc.runPersist(bc.contracts.GetPersistScript(), block, cache)
+		aer, err := bc.runPersist(bc.contracts.GetPersistScript(), block, cache, trigger.OnPersist)
 		if err != nil {
 			return fmt.Errorf("onPersist failed: %w", err)
 		}
@@ -635,7 +635,7 @@ func (bc *Blockchain) storeBlock(block *block.Block, txpool *mempool.Pool) error
 		}
 	}
 
-	aer, err := bc.runPersist(bc.contracts.GetPostPersistScript(), block, cache)
+	aer, err := bc.runPersist(bc.contracts.GetPostPersistScript(), block, cache, trigger.PostPersist)
 	if err != nil {
 		return fmt.Errorf("postPersist failed: %w", err)
 	}
@@ -704,8 +704,8 @@ func (bc *Blockchain) storeBlock(block *block.Block, txpool *mempool.Pool) error
 	return nil
 }
 
-func (bc *Blockchain) runPersist(script []byte, block *block.Block, cache *dao.Cached) (*state.AppExecResult, error) {
+func (bc *Blockchain) runPersist(script []byte, block *block.Block, cache *dao.Cached, trig trigger.Type) (*state.AppExecResult, error) {
-	systemInterop := bc.newInteropContext(trigger.System, cache, block, nil)
+	systemInterop := bc.newInteropContext(trig, cache, block, nil)
 	v := systemInterop.SpawnVM()
 	v.LoadScriptWithFlags(script, smartcontract.AllowModifyStates|smartcontract.AllowCall)
 	v.SetPriceGetter(getPrice)
@@ -719,7 +719,7 @@ func (bc *Blockchain) runPersist(script []byte, block *block.Block, cache *dao.C
 	}
 	return &state.AppExecResult{
 		TxHash:      block.Hash(), // application logs can be retrieved by block hash
-		Trigger:     trigger.System,
+		Trigger:     trig,
 		VMState:     v.State(),
 		GasConsumed: v.GasConsumed(),
 		Stack:       v.Estack().ToArray(),
@@ -1143,7 +1143,7 @@ func (bc *Blockchain) UnsubscribeFromExecutions(ch chan<- *state.AppExecResult)
 // CalculateClaimable calculates the amount of GAS generated by owning specified
 // amount of NEO between specified blocks.
 func (bc *Blockchain) CalculateClaimable(value *big.Int, startHeight, endHeight uint32) *big.Int {
-	ic := bc.newInteropContext(trigger.System, bc.dao, nil, nil)
+	ic := bc.newInteropContext(trigger.Application, bc.dao, nil, nil)
 	res, _ := bc.contracts.NEO.CalculateBonus(ic, value, startHeight, endHeight)
 	return res
 }

pkg/core/interop_neo_test.go

@@ -147,10 +147,9 @@ func TestECDSAVerify(t *testing.T) {
 
 	ic := chain.newInteropContext(trigger.Application, dao.NewSimple(storage.NewMemoryStore(), netmode.UnitTestNet), nil, nil)
 	runCase := func(t *testing.T, isErr bool, result interface{}, args ...interface{}) {
-		v := vm.New()
+		ic.SpawnVM()
-		ic.VM = v
 		for i := range args {
-			v.Estack().PushVal(args[i])
+			ic.VM.Estack().PushVal(args[i])
 		}
 
 		var err error
@@ -168,8 +167,8 @@ func TestECDSAVerify(t *testing.T) {
 			return
 		}
 		require.NoError(t, err)
-		require.Equal(t, 1, v.Estack().Len())
+		require.Equal(t, 1, ic.VM.Estack().Len())
-		require.Equal(t, result, v.Estack().Pop().Value().(bool))
+		require.Equal(t, result, ic.VM.Estack().Pop().Value().(bool))
 	}
 
 	msg := []byte("test message")

pkg/core/interop_system_test.go

@@ -506,23 +506,21 @@ func getTestContractState() (*state.Contract, *state.Contract) {
 }
 
 func loadScript(ic *interop.Context, script []byte, args ...interface{}) {
-	v := vm.New()
+	ic.SpawnVM()
-	v.LoadScriptWithFlags(script, smartcontract.AllowCall)
+	ic.VM.LoadScriptWithFlags(script, smartcontract.AllowCall)
 	for i := range args {
-		v.Estack().PushVal(args[i])
+		ic.VM.Estack().PushVal(args[i])
 	}
-	v.GasLimit = -1
+	ic.VM.GasLimit = -1
-	ic.VM = v
 }
 
 func loadScriptWithHashAndFlags(ic *interop.Context, script []byte, hash util.Uint160, f smartcontract.CallFlag, args ...interface{}) {
-	v := vm.New()
+	ic.SpawnVM()
-	v.LoadScriptWithHash(script, hash, f)
+	ic.VM.LoadScriptWithHash(script, hash, f)
 	for i := range args {
-		v.Estack().PushVal(args[i])
+		ic.VM.Estack().PushVal(args[i])
 	}
-	v.GasLimit = -1
+	ic.VM.GasLimit = -1
-	ic.VM = v
 }
 
 func TestContractCall(t *testing.T) {
@@ -1029,15 +1027,14 @@ func TestMethodCallback(t *testing.T) {
 			require.Error(t, callback.Invoke(ic))
 		})
 		t.Run("CallIsNotAllowed", func(t *testing.T) {
-			v := vm.New()
+			ic.SpawnVM()
-			ic.VM = v
+			ic.VM.Load(currCs.Script)
-			v.Load(currCs.Script)
+			ic.VM.Estack().PushVal("add")
-			v.Estack().PushVal("add")
+			ic.VM.Estack().PushVal(rawHash)
-			v.Estack().PushVal(rawHash)
 			require.NoError(t, callback.CreateFromMethod(ic))
 
 			args := stackitem.NewArray([]stackitem.Item{stackitem.Make(1), stackitem.Make(5)})
-			v.Estack().InsertAt(vm.NewElement(args), 1)
+			ic.VM.Estack().InsertAt(vm.NewElement(args), 1)
 			require.Error(t, callback.Invoke(ic))
 		})
 	})

pkg/core/native/contract.go

@@ -116,8 +116,8 @@ func (cs *Contracts) GetPostPersistScript() []byte {
 }
 
 func postPersistBase(ic *interop.Context) error {
-	if ic.Trigger != trigger.System {
+	if ic.Trigger != trigger.PostPersist {
-		return errors.New("'postPersist' should be trigered by system")
+		return errors.New("postPersist must be trigered by system")
 	}
 	return nil
 }

pkg/core/native/native_nep5.go

@@ -261,8 +261,8 @@ func (c *nep5TokenNative) addTokens(ic *interop.Context, h util.Uint160, amount
 }
 
 func (c *nep5TokenNative) OnPersist(ic *interop.Context) error {
-	if ic.Trigger != trigger.System {
+	if ic.Trigger != trigger.OnPersist {
-		return errors.New("onPersist should be triggerred by system")
+		return errors.New("onPersist must be triggerred by system")
 	}
 	return nil
 }

pkg/core/native_contract_test.go

@@ -39,7 +39,7 @@ func (tn *testNative) Metadata() *interop.ContractMD {
 }
 
 func (tn *testNative) OnPersist(ic *interop.Context, _ []stackitem.Item) stackitem.Item {
-	if ic.Trigger != trigger.System {
+	if ic.Trigger != trigger.OnPersist {
 		panic("invalid trigger")
 	}
 	select {

pkg/core/native_designate_test.go

@@ -78,8 +78,8 @@ func TestDesignate_DesignateAsRole(t *testing.T) {
 
 	des := bc.contracts.Designate
 	tx := transaction.New(netmode.UnitTestNet, []byte{}, 0)
-	ic := bc.newInteropContext(trigger.System, bc.dao, nil, tx)
+	ic := bc.newInteropContext(trigger.OnPersist, bc.dao, nil, tx)
-	ic.VM = vm.New()
+	ic.SpawnVM()
 	ic.VM.LoadScript([]byte{byte(opcode.RET)})
 
 	pubs, err := des.GetDesignatedByRole(bc.dao, 0xFF)

pkg/core/native_neo_test.go

@@ -13,7 +13,6 @@ import (
 	"github.com/nspcc-dev/neo-go/pkg/smartcontract"
 	"github.com/nspcc-dev/neo-go/pkg/smartcontract/trigger"
 	"github.com/nspcc-dev/neo-go/pkg/util"
-	"github.com/nspcc-dev/neo-go/pkg/vm"
 	"github.com/nspcc-dev/neo-go/pkg/vm/opcode"
 	"github.com/stretchr/testify/require"
 )
@@ -31,8 +30,8 @@ func TestNEO_Vote(t *testing.T) {
 
 	neo := bc.contracts.NEO
 	tx := transaction.New(netmode.UnitTestNet, []byte{byte(opcode.PUSH1)}, 0)
-	ic := bc.newInteropContext(trigger.System, bc.dao, nil, tx)
+	ic := bc.newInteropContext(trigger.Application, bc.dao, nil, tx)
-	ic.VM = vm.New()
+	ic.SpawnVM()
 	ic.Block = bc.newBlock(tx)
 
 	freq := testchain.ValidatorsCount + testchain.CommitteeSize()
@@ -125,8 +124,8 @@ func TestNEO_SetGasPerBlock(t *testing.T) {
 
 	neo := bc.contracts.NEO
 	tx := transaction.New(netmode.UnitTestNet, []byte{}, 0)
-	ic := bc.newInteropContext(trigger.System, bc.dao, nil, tx)
+	ic := bc.newInteropContext(trigger.Application, bc.dao, nil, tx)
-	ic.VM = vm.New()
+	ic.SpawnVM()
 	ic.VM.LoadScript([]byte{byte(opcode.RET)})
 
 	h := neo.GetCommitteeAddress()
@@ -184,7 +183,7 @@ func TestNEO_CalculateBonus(t *testing.T) {
 
 	neo := bc.contracts.NEO
 	tx := transaction.New(netmode.UnitTestNet, []byte{}, 0)
-	ic := bc.newInteropContext(trigger.System, bc.dao, nil, tx)
+	ic := bc.newInteropContext(trigger.Application, bc.dao, nil, tx)
 	ic.SpawnVM()
 	ic.VM.LoadScript([]byte{byte(opcode.RET)})
 	t.Run("Invalid", func(t *testing.T) {

pkg/core/state/notification_event_test.go

@@ -116,7 +116,7 @@ func TestMarshalUnmarshalJSONAppExecResult(t *testing.T) {
 	t.Run("positive, block", func(t *testing.T) {
 		appExecResult := &AppExecResult{
 			TxHash:      random.Uint256(),
-			Trigger:     trigger.System,
+			Trigger:     trigger.OnPersist,
 			VMState:     vm.HaltState,
 			GasConsumed: 10,
 			Stack:       []stackitem.Item{},

pkg/interop/runtime/runtime.go

@@ -8,7 +8,8 @@ import "github.com/nspcc-dev/neo-go/pkg/interop"
 
 // Trigger values to compare with GetTrigger result.
 const (
-	System       byte = 0x01
+	OnPersist    byte = 0x01
+	PostPersist  byte = 0x02
 	Application  byte = 0x40
 	Verification byte = 0x20
 )

pkg/rpc/server/server_test.go

@@ -770,7 +770,7 @@ func testRPCProtocol(t *testing.T, doRPCCall func(string, string, *testing.T) []
 		data := checkErrGetResult(t, body, false)
 		var res state.AppExecResult
 		require.NoError(t, json.Unmarshal(data, &res))
-		require.Equal(t, trigger.System, res.Trigger)
+		require.Equal(t, trigger.PostPersist, res.Trigger)
 		require.Equal(t, vm.HaltState, res.VMState)
 	})
 

pkg/smartcontract/trigger/trigger_type.go

@@ -9,8 +9,15 @@ type Type byte
 
 // Viable list of supported trigger type constants.
 const (
-	// System is trigger type that indicates that script is being invoke internally by the system.
+	// OnPersist is a trigger type that indicates that script is being invoked
-	System Type = 0x01
+	// internally by the system during block persistence (before transaction
+	// processing).
+	OnPersist Type = 0x01
+
+	// PostPersist is a trigger type that indicates that script is being invoked
+	// by the system after block persistence (transcation processing) has
+	// finished.
+	PostPersist Type = 0x02
 
 	// The verification trigger indicates that the contract is being invoked as a verification function.
 	// The verification function can accept multiple parameters, and should return a boolean value that indicates the validity of the transaction or block.
@@ -27,12 +34,12 @@ const (
 	Application Type = 0x40
 
 	// All represents any trigger type.
-	All Type = System | Verification | Application
+	All Type = OnPersist | PostPersist | Verification | Application
 )
 
 // FromString converts string to trigger Type
 func FromString(str string) (Type, error) {
-	triggers := []Type{System, Verification, Application, All}
+	triggers := []Type{OnPersist, PostPersist, Verification, Application, All}
 	for _, t := range triggers {
 		if t.String() == str {
 			return t, nil

pkg/smartcontract/trigger/trigger_type_string.go

@@ -8,28 +8,34 @@ func _() {
 	// An "invalid array index" compiler error signifies that the constant values have changed.
 	// Re-run the stringer command to generate them again.
 	var x [1]struct{}
-	_ = x[System-1]
+	_ = x[OnPersist-1]
+	_ = x[PostPersist-2]
 	_ = x[Verification-32]
 	_ = x[Application-64]
-	_ = x[All-97]
+	_ = x[All-99]
 }
 
 const (
-	_Type_name_0 = "System"
+	_Type_name_0 = "OnPersistPostPersist"
 	_Type_name_1 = "Verification"
 	_Type_name_2 = "Application"
 	_Type_name_3 = "All"
 )
 
+var (
+	_Type_index_0 = [...]uint8{0, 9, 20}
+)
+
 func (i Type) String() string {
 	switch {
-	case i == 1:
+	case 1 <= i && i <= 2:
-		return _Type_name_0
+		i -= 1
+		return _Type_name_0[_Type_index_0[i]:_Type_index_0[i+1]]
 	case i == 32:
 		return _Type_name_1
 	case i == 64:
 		return _Type_name_2
-	case i == 97:
+	case i == 99:
 		return _Type_name_3
 	default:
 		return "Type(" + strconv.FormatInt(int64(i), 10) + ")"

pkg/smartcontract/trigger/trigger_type_test.go

@@ -9,7 +9,8 @@ import (
 
 func TestStringer(t *testing.T) {
 	tests := map[Type]string{
-		System:       "System",
+		OnPersist:    "OnPersist",
+		PostPersist:  "PostPersist",
 		Application:  "Application",
 		Verification: "Verification",
 	}
@@ -20,7 +21,8 @@ func TestStringer(t *testing.T) {
 
 func TestEncodeBynary(t *testing.T) {
 	tests := map[Type]byte{
-		System:       0x01,
+		OnPersist:    0x01,
+		PostPersist:  0x02,
 		Verification: 0x20,
 		Application:  0x40,
 	}
@@ -31,7 +33,8 @@ func TestEncodeBynary(t *testing.T) {
 
 func TestDecodeBynary(t *testing.T) {
 	tests := map[Type]byte{
-		System:       0x01,
+		OnPersist:    0x01,
+		PostPersist:  0x02,
 		Verification: 0x20,
 		Application:  0x40,
 	}
@@ -42,7 +45,8 @@ func TestDecodeBynary(t *testing.T) {
 
 func TestFromString(t *testing.T) {
 	testCases := map[string]Type{
-		"System":       System,
+		"OnPersist":    OnPersist,
+		"PostPersist":  PostPersist,
 		"Application":  Application,
 		"Verification": Verification,
 		"All":          All,

pkg/vm/vm.go

@@ -87,7 +87,7 @@ type VM struct {
 
 // New returns a new VM object ready to load AVM bytecode scripts.
 func New() *VM {
-	return NewWithTrigger(trigger.System)
+	return NewWithTrigger(trigger.Application)
 }
 
 // NewWithTrigger returns a new VM for executions triggered by t.