Merge pull request #1556 from nspcc-dev/allow-null-oracle-filters

Allow null oracle filters

go.sum

@@ -165,8 +165,6 @@ github.com/nspcc-dev/dbft v0.0.0-20200117124306-478e5cfbf03a h1:ajvxgEe9qY4vvoSm
 github.com/nspcc-dev/dbft v0.0.0-20200117124306-478e5cfbf03a/go.mod h1:/YFK+XOxxg0Bfm6P92lY5eDSLYfp06XOdL8KAVgXjVk=
 github.com/nspcc-dev/dbft v0.0.0-20200219114139-199d286ed6c1 h1:yEx9WznS+rjE0jl0dLujCxuZSIb+UTjF+005TJu/nNI=
 github.com/nspcc-dev/dbft v0.0.0-20200219114139-199d286ed6c1/go.mod h1:O0qtn62prQSqizzoagHmuuKoz8QMkU3SzBoKdEvm3aQ=
-github.com/nspcc-dev/dbft v0.0.0-20200925163137-8f3b9ab3b720 h1:e/lFQUIPnWErf2yiHjp2HyPhf0nyo3lp4hMm8IlQX1U=
-github.com/nspcc-dev/dbft v0.0.0-20200925163137-8f3b9ab3b720/go.mod h1:I5D0W3tu3epdt2RMCTxS//HDr4S+OHRqajouQTOAHI8=
 github.com/nspcc-dev/dbft v0.0.0-20201109143252-cd27d76617ed h1:T4qjutPMqjnYDQFyrbCew3lGeJt6MIbNyNn7gRx0o/g=
 github.com/nspcc-dev/dbft v0.0.0-20201109143252-cd27d76617ed/go.mod h1:I5D0W3tu3epdt2RMCTxS//HDr4S+OHRqajouQTOAHI8=
 github.com/nspcc-dev/neo-go v0.73.1-pre.0.20200303142215-f5a1b928ce09/go.mod h1:pPYwPZ2ks+uMnlRLUyXOpLieaDQSEaf4NM3zHVbRjmg=

pkg/core/native/oracle.go

@@ -265,10 +265,16 @@ func (o *Oracle) request(ic *interop.Context, args []stackitem.Item) stackitem.I
 	if err != nil {
 		panic(err)
 	}
-	filter, err := stackitem.ToString(args[1])
+	var filter *string
+	_, ok := args[1].(stackitem.Null)
+	if !ok {
+		// Check UTF-8 validity.
+		str, err := stackitem.ToString(args[1])
 		if err != nil {
 			panic(err)
 		}
+		filter = &str
+	}
 	cb, err := stackitem.ToString(args[2])
 	if err != nil {
 		panic(err)
@@ -285,8 +291,8 @@ func (o *Oracle) request(ic *interop.Context, args []stackitem.Item) stackitem.I
 }
 
 // RequestInternal processes oracle request.
-func (o *Oracle) RequestInternal(ic *interop.Context, url, filter, cb string, userData stackitem.Item, gas *big.Int) error {
+func (o *Oracle) RequestInternal(ic *interop.Context, url string, filter *string, cb string, userData stackitem.Item, gas *big.Int) error {
-	if len(url) > maxURLLength || len(filter) > maxFilterLength || len(cb) > maxCallbackLength || gas.Uint64() < 1000_0000 {
+	if len(url) > maxURLLength || (filter != nil && len(*filter) > maxFilterLength) || len(cb) > maxCallbackLength || gas.Uint64() < 1000_0000 {
 		return ErrBigArgument
 	}
 
@@ -317,6 +323,12 @@ func (o *Oracle) RequestInternal(ic *interop.Context, url, filter, cb string, us
 		return ErrBigArgument
 	}
 
+	var filterNotif stackitem.Item
+	if filter != nil {
+		filterNotif = stackitem.Make(*filter)
+	} else {
+		filterNotif = stackitem.Null{}
+	}
 	ic.Notifications = append(ic.Notifications, state.NotificationEvent{
 		ScriptHash: o.Hash,
 		Name:       "OracleRequest",
@@ -324,14 +336,14 @@ func (o *Oracle) RequestInternal(ic *interop.Context, url, filter, cb string, us
 			stackitem.Make(id),
 			stackitem.Make(ic.VM.GetCallingScriptHash().BytesBE()),
 			stackitem.Make(url),
-			stackitem.Make(filter),
+			filterNotif,
 		}),
 	})
 	req := &state.OracleRequest{
 		OriginalTxID:     o.getOriginalTxID(ic.DAO, ic.Tx),
 		GasForResponse:   gas.Uint64(),
 		URL:              url,
-		Filter:           &filter,
+		Filter:           filter,
 		CallbackContract: ic.VM.GetCallingScriptHash(),
 		CallbackMethod:   cb,
 		UserData:         data,

pkg/core/native_oracle_test.go

@@ -18,6 +18,7 @@ import (
 	"github.com/nspcc-dev/neo-go/pkg/smartcontract/manifest"
 	"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/emit"
 	"github.com/nspcc-dev/neo-go/pkg/vm/opcode"
 	"github.com/nspcc-dev/neo-go/pkg/vm/stackitem"
@@ -88,10 +89,14 @@ func getOracleContractState(h util.Uint160) *state.Contract {
 }
 
 func putOracleRequest(t *testing.T, h util.Uint160, bc *Blockchain,
-	url, filter string, userData []byte, gas int64) util.Uint256 {
+	url string, filter *string, userData []byte, gas int64) util.Uint256 {
 	w := io.NewBufBinWriter()
+	var filtItem interface{}
+	if filter != nil {
+		filtItem = *filter
+	}
 	emit.AppCallWithOperationAndArgs(w.BinWriter, h, "requestURL",
-		url, filter, "handle", userData, gas)
+		url, filtItem, "handle", userData, gas)
 	require.NoError(t, w.Err)
 
 	gas += 50_000_000 + 5_000_000 // request + contract call with args
@@ -113,15 +118,16 @@ func TestOracle_Request(t *testing.T) {
 	require.NoError(t, bc.dao.PutContractState(cs))
 
 	gasForResponse := int64(2000_1234)
+	var filter = "flt"
 	userData := []byte("custom info")
-	txHash := putOracleRequest(t, cs.ScriptHash(), bc, "url", "flt", userData, gasForResponse)
+	txHash := putOracleRequest(t, cs.ScriptHash(), bc, "url", &filter, userData, gasForResponse)
 
 	req, err := orc.GetRequestInternal(bc.dao, 1)
 	require.NotNil(t, req)
 	require.NoError(t, err)
 	require.Equal(t, txHash, req.OriginalTxID)
 	require.Equal(t, "url", req.URL)
-	require.Equal(t, "flt", *req.Filter)
+	require.Equal(t, filter, *req.Filter)
 	require.Equal(t, cs.ScriptHash(), req.CallbackContract)
 	require.Equal(t, "handle", req.CallbackMethod)
 	require.Equal(t, uint64(gasForResponse), req.GasForResponse)
@@ -192,7 +198,7 @@ func TestOracle_Request(t *testing.T) {
 	t.Run("ErrorOnFinish", func(t *testing.T) {
 		const reqID = 2
 
-		putOracleRequest(t, cs.ScriptHash(), bc, "url", "flt", []byte{1, 2}, gasForResponse)
+		putOracleRequest(t, cs.ScriptHash(), bc, "url", nil, []byte{1, 2}, gasForResponse)
 		_, err := orc.GetRequestInternal(bc.dao, reqID) // ensure ID is 2
 		require.NoError(t, err)
 
@@ -215,4 +221,23 @@ func TestOracle_Request(t *testing.T) {
 		_, err = orc.GetRequestInternal(ic.DAO, reqID)
 		require.Error(t, err)
 	})
+	t.Run("BadRequest", func(t *testing.T) {
+		var doBadRequest = func(t *testing.T, h util.Uint160, url string, filter *string, userData []byte, gas int64) {
+			txHash := putOracleRequest(t, h, bc, url, filter, userData, gas)
+			aer, err := bc.GetAppExecResults(txHash, trigger.Application)
+			require.NoError(t, err)
+			require.Equal(t, 1, len(aer))
+			require.Equal(t, vm.FaultState, aer[0].VMState)
+		}
+		t.Run("non-UTF8 url", func(t *testing.T) {
+			doBadRequest(t, cs.ScriptHash(), "\xff", nil, []byte{1, 2}, gasForResponse)
+		})
+		t.Run("non-UTF8 filter", func(t *testing.T) {
+			var f = "\xff"
+			doBadRequest(t, cs.ScriptHash(), "url", &f, []byte{1, 2}, gasForResponse)
+		})
+		t.Run("not enough gas", func(t *testing.T) {
+			doBadRequest(t, cs.ScriptHash(), "url", nil, nil, 1000)
+		})
+	})
 }