package manifest import ( "encoding/json" "math/big" "testing" "github.com/nspcc-dev/neo-go/pkg/crypto/keys" "github.com/nspcc-dev/neo-go/pkg/smartcontract" "github.com/nspcc-dev/neo-go/pkg/util" "github.com/nspcc-dev/neo-go/pkg/vm/stackitem" "github.com/stretchr/testify/require" ) // Test vectors are taken from the main NEO repo // https://github.com/neo-project/neo/blob/master/tests/neo.UnitTests/SmartContract/Manifest/UT_ContractManifest.cs#L10 func TestManifest_MarshalJSON(t *testing.T) { t.Run("default", func(t *testing.T) { s := `{"groups":[],"supportedstandards":[],"name":"Test","abi":{"methods":[],"events":[]},"permissions":[{"contract":"*","methods":"*"}],"trusts":[],"extra":null}` m := testUnmarshalMarshalManifest(t, s) require.Equal(t, DefaultManifest("Test"), m) }) t.Run("permissions", func(t *testing.T) { s := `{"groups":[],"supportedstandards":[],"name":"Test","abi":{"methods":[],"events":[]},"permissions":[{"contract":"0x0000000000000000000000000000000000000000","methods":["method1","method2"]}],"trusts":[],"extra":null}` testUnmarshalMarshalManifest(t, s) }) t.Run("safe methods", func(t *testing.T) { s := `{"groups":[],"supportedstandards":[],"name":"Test","abi":{"methods":[{"name":"safeMet","offset":123,"parameters":[],"returntype":"Integer","safe":true}],"events":[]},"permissions":[{"contract":"*","methods":"*"}],"trusts":[],"extra":null}` testUnmarshalMarshalManifest(t, s) }) t.Run("trust", func(t *testing.T) { s := `{"groups":[],"supportedstandards":[],"name":"Test","abi":{"methods":[],"events":[]},"permissions":[{"contract":"*","methods":"*"}],"trusts":["0x0000000000000000000000000000000000000001"],"extra":null}` testUnmarshalMarshalManifest(t, s) }) t.Run("groups", func(t *testing.T) { s := `{"groups":[{"pubkey":"03b209fd4f53a7170ea4444e0cb0a6bb6a53c2bd016926989cf85f9b0fba17a70c","signature":"QUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQQ=="}],"supportedstandards":[],"name":"Test","abi":{"methods":[],"events":[]},"permissions":[{"contract":"*","methods":"*"}],"trusts":[],"extra":null}` testUnmarshalMarshalManifest(t, s) }) t.Run("extra", func(t *testing.T) { s := `{"groups":[],"supportedstandards":[],"name":"Test","abi":{"methods":[],"events":[]},"permissions":[{"contract":"*","methods":"*"}],"trusts":[],"extra":{"key":"value"}}` testUnmarshalMarshalManifest(t, s) }) } func testUnmarshalMarshalManifest(t *testing.T, s string) *Manifest { js := []byte(s) c := NewManifest("Test") require.NoError(t, json.Unmarshal(js, c)) data, err := json.Marshal(c) require.NoError(t, err) require.JSONEq(t, s, string(data)) return c } func TestManifest_CanCall(t *testing.T) { man1 := DefaultManifest("Test1") man2 := DefaultManifest("Test2") require.True(t, man1.CanCall(util.Uint160{}, man2, "method1")) } func TestPermission_IsAllowed(t *testing.T) { manifest := DefaultManifest("Test") t.Run("wildcard", func(t *testing.T) { perm := NewPermission(PermissionWildcard) require.True(t, perm.IsAllowed(util.Uint160{}, manifest, "AAA")) }) t.Run("hash", func(t *testing.T) { perm := NewPermission(PermissionHash, util.Uint160{}) require.True(t, perm.IsAllowed(util.Uint160{}, manifest, "AAA")) t.Run("restrict methods", func(t *testing.T) { perm.Methods.Restrict() require.False(t, perm.IsAllowed(util.Uint160{}, manifest, "AAA")) perm.Methods.Add("AAA") require.True(t, perm.IsAllowed(util.Uint160{}, manifest, "AAA")) }) }) t.Run("invalid hash", func(t *testing.T) { perm := NewPermission(PermissionHash, util.Uint160{1}) require.False(t, perm.IsAllowed(util.Uint160{}, manifest, "AAA")) }) priv, err := keys.NewPrivateKey() require.NoError(t, err) manifest.Groups = []Group{{PublicKey: priv.PublicKey()}} t.Run("group", func(t *testing.T) { perm := NewPermission(PermissionGroup, priv.PublicKey()) require.True(t, perm.IsAllowed(util.Uint160{}, manifest, "AAA")) }) t.Run("invalid group", func(t *testing.T) { priv2, err := keys.NewPrivateKey() require.NoError(t, err) perm := NewPermission(PermissionGroup, priv2.PublicKey()) require.False(t, perm.IsAllowed(util.Uint160{}, manifest, "AAA")) }) } func TestIsValid(t *testing.T) { contractHash := util.Uint160{1, 2, 3} m := &Manifest{} t.Run("invalid, no name", func(t *testing.T) { require.Error(t, m.IsValid(contractHash)) }) m = NewManifest("Test") t.Run("invalid, no ABI methods", func(t *testing.T) { require.Error(t, m.IsValid(contractHash)) }) m.ABI.Methods = append(m.ABI.Methods, Method{ Name: "dummy", ReturnType: smartcontract.VoidType, Parameters: []Parameter{}, }) t.Run("valid, no groups/events", func(t *testing.T) { require.NoError(t, m.IsValid(contractHash)) }) m.ABI.Events = append(m.ABI.Events, Event{ Name: "itHappened", Parameters: []Parameter{}, }) t.Run("valid, with events", func(t *testing.T) { require.NoError(t, m.IsValid(contractHash)) }) m.ABI.Events = append(m.ABI.Events, Event{ Name: "itHappened", Parameters: []Parameter{ NewParameter("qwerty", smartcontract.IntegerType), NewParameter("qwerty", smartcontract.IntegerType), }, }) t.Run("invalid, bad event", func(t *testing.T) { require.Error(t, m.IsValid(contractHash)) }) m.ABI.Events = m.ABI.Events[:1] m.Permissions = append(m.Permissions, *NewPermission(PermissionHash, util.Uint160{1, 2, 3})) t.Run("valid, with permissions", func(t *testing.T) { require.NoError(t, m.IsValid(contractHash)) }) m.Permissions = append(m.Permissions, *NewPermission(PermissionHash, util.Uint160{1, 2, 3})) t.Run("invalid, with permissions", func(t *testing.T) { require.Error(t, m.IsValid(contractHash)) }) m.Permissions = m.Permissions[:1] m.SupportedStandards = append(m.SupportedStandards, "NEP-17") t.Run("valid, with standards", func(t *testing.T) { require.NoError(t, m.IsValid(contractHash)) }) m.SupportedStandards = append(m.SupportedStandards, "") t.Run("invalid, with nameless standard", func(t *testing.T) { require.Error(t, m.IsValid(contractHash)) }) m.SupportedStandards = m.SupportedStandards[:1] m.SupportedStandards = append(m.SupportedStandards, "NEP-17") t.Run("invalid, with duplicate standards", func(t *testing.T) { require.Error(t, m.IsValid(contractHash)) }) m.SupportedStandards = m.SupportedStandards[:1] m.Trusts.Add(util.Uint160{1, 2, 3}) t.Run("valid, with trust", func(t *testing.T) { require.NoError(t, m.IsValid(contractHash)) }) m.Trusts.Add(util.Uint160{3, 2, 1}) t.Run("valid, with trusts", func(t *testing.T) { require.NoError(t, m.IsValid(contractHash)) }) m.Trusts.Add(util.Uint160{1, 2, 3}) t.Run("invalid, with trusts", func(t *testing.T) { require.Error(t, m.IsValid(contractHash)) }) m.Trusts.Restrict() t.Run("with groups", func(t *testing.T) { m.Groups = make([]Group, 3) pks := make([]*keys.PrivateKey, 3) for i := range pks { pk, err := keys.NewPrivateKey() require.NoError(t, err) pks[i] = pk m.Groups[i] = Group{ PublicKey: pk.PublicKey(), Signature: pk.Sign(contractHash.BytesBE()), } } t.Run("valid", func(t *testing.T) { require.NoError(t, m.IsValid(contractHash)) }) t.Run("invalid, wrong contract hash", func(t *testing.T) { require.Error(t, m.IsValid(util.Uint160{4, 5, 6})) }) t.Run("invalid, wrong group signature", func(t *testing.T) { pk, err := keys.NewPrivateKey() require.NoError(t, err) m.Groups = append(m.Groups, Group{ PublicKey: pk.PublicKey(), // actually, there shouldn't be such situation, as Signature is always the signature // of the contract hash. Signature: pk.Sign([]byte{1, 2, 3}), }) require.Error(t, m.IsValid(contractHash)) }) }) } func TestManifestToStackItem(t *testing.T) { check := func(t *testing.T, expected *Manifest) { item, err := expected.ToStackItem() require.NoError(t, err) actual := new(Manifest) require.NoError(t, actual.FromStackItem(item)) require.Equal(t, expected, actual) } t.Run("default", func(t *testing.T) { expected := DefaultManifest("manifest") check(t, expected) }) t.Run("full", func(t *testing.T) { pk, _ := keys.NewPrivateKey() expected := &Manifest{ Name: "manifest", ABI: ABI{ Methods: []Method{{ Name: "method", Offset: 15, Parameters: []Parameter{{ Name: "param", Type: smartcontract.StringType, }}, ReturnType: smartcontract.BoolType, Safe: true, }}, Events: []Event{{ Name: "event", Parameters: []Parameter{{ Name: "param", Type: smartcontract.BoolType, }}, }}, }, Groups: []Group{{ PublicKey: pk.PublicKey(), Signature: make([]byte, keys.SignatureLen), }}, Permissions: []Permission{*NewPermission(PermissionWildcard)}, SupportedStandards: []string{"NEP-17"}, Trusts: WildUint160s{ Value: []util.Uint160{{1, 2, 3}}, }, Extra: "some extra data", } check(t, expected) }) } func TestManifest_FromStackItemErrors(t *testing.T) { errCases := map[string]stackitem.Item{ "not a struct": stackitem.NewArray([]stackitem.Item{}), "invalid length": stackitem.NewStruct([]stackitem.Item{}), "invalid name type": stackitem.NewStruct([]stackitem.Item{stackitem.NewInterop(nil), stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}}), "invalid groups type": stackitem.NewStruct([]stackitem.Item{stackitem.NewByteArray([]byte{}), stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}}), "invalid group": stackitem.NewStruct([]stackitem.Item{stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{stackitem.Null{}}), stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}}), "invalid supported standards type": stackitem.NewStruct([]stackitem.Item{stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}}), "invalid supported standard": stackitem.NewStruct([]stackitem.Item{stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{stackitem.Null{}}), stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}}), "invalid ABI": stackitem.NewStruct([]stackitem.Item{stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.Null{}, stackitem.Null{}, stackitem.Null{}, stackitem.Null{}}), "invalid Permissions type": stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{})}), stackitem.Null{}, stackitem.Null{}, stackitem.Null{}}), "invalid permission": stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{})}), stackitem.NewArray([]stackitem.Item{stackitem.Null{}}), stackitem.Null{}, stackitem.Null{}}), "invalid Trusts type": stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{})}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewInterop(nil), stackitem.Null{}}), "invalid trust": stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{})}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{stackitem.Null{}}), stackitem.Null{}}), "invalid Uint160 trust": stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{})}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{stackitem.NewByteArray([]byte{1, 2, 3})}), stackitem.Null{}}), "invalid extra type": stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{})}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.Null{}}), "invalid extra": stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{})}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{}), stackitem.NewByteArray([]byte("not a json"))}), } for name, errCase := range errCases { t.Run(name, func(t *testing.T) { p := new(Manifest) require.Error(t, p.FromStackItem(errCase)) }) } } func TestABI_ToStackItemFromStackItem(t *testing.T) { a := &ABI{ Methods: []Method{{ Name: "mur", Offset: 5, Parameters: []Parameter{{Name: "p1", Type: smartcontract.BoolType}}, ReturnType: smartcontract.StringType, Safe: true, }}, Events: []Event{{ Name: "mur", Parameters: []Parameter{{Name: "p1", Type: smartcontract.BoolType}}, }}, } expected := stackitem.NewStruct([]stackitem.Item{ stackitem.NewArray([]stackitem.Item{ stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte("mur")), stackitem.NewArray([]stackitem.Item{ stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte("p1")), stackitem.NewBigInteger(big.NewInt(int64(smartcontract.BoolType))), }), }), stackitem.NewBigInteger(big.NewInt(int64(smartcontract.StringType))), stackitem.NewBigInteger(big.NewInt(int64(5))), stackitem.NewBool(true), }), }), stackitem.NewArray([]stackitem.Item{ stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte("mur")), stackitem.NewArray([]stackitem.Item{ stackitem.NewStruct([]stackitem.Item{ stackitem.NewByteArray([]byte("p1")), stackitem.NewBigInteger(big.NewInt(int64(smartcontract.BoolType))), }), }), }), }), }) CheckToFromStackItem(t, a, expected) } func TestABI_FromStackItemErrors(t *testing.T) { errCases := map[string]stackitem.Item{ "not a struct": stackitem.NewArray([]stackitem.Item{}), "invalid length": stackitem.NewStruct([]stackitem.Item{}), "invalid methods type": stackitem.NewStruct([]stackitem.Item{stackitem.NewInterop(nil), stackitem.Null{}}), "invalid method": stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{stackitem.Null{}}), stackitem.Null{}}), "invalid events type": stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{}), stackitem.Null{}}), "invalid event": stackitem.NewStruct([]stackitem.Item{stackitem.NewArray([]stackitem.Item{}), stackitem.NewArray([]stackitem.Item{stackitem.Null{}})}), } for name, errCase := range errCases { t.Run(name, func(t *testing.T) { p := new(ABI) require.Error(t, p.FromStackItem(errCase)) }) } }