[Framework Add] implement payable

src/Neo.Compiler.CSharp/ContractManifestExtension.cs

@@ -163,6 +163,44 @@ private static void CheckNep17Compliant(this ContractManifest manifest)
             }
         }
 
+        private static void CheckNep11PayableCompliant(this ContractManifest manifest)
+        {
+            try
+            {
+                var onNEP11PaymentMethod = manifest.Abi.GetMethod("onNEP11Payment", 3);
+                var onNEP11PaymentValid = onNEP11PaymentMethod is { Safe: false, ReturnType: ContractParameterType.Void } &&
+                                          onNEP11PaymentMethod.Parameters[0].Type == ContractParameterType.Hash160 &&
+                                          onNEP11PaymentMethod.Parameters[1].Type == ContractParameterType.Integer &&
+                                          onNEP11PaymentMethod.Parameters[2].Type == ContractParameterType.Any;
+
+                if (!onNEP11PaymentValid) throw new CompilationException(DiagnosticId.IncorrectNEPStandard,
+                    $"Incomplete NEP standard {NepStandard.Nep11Payable.ToStandard()} implementation: onNEP11Payment");
+            }
+            catch (Exception ex) when (ex is not CompilationException)
+            {
+                throw new CompilationException(DiagnosticId.IncorrectNEPStandard, $"Incomplete NEP standard {NepStandard.Nep11Payable.ToStandard()} implementation: Unidentified issue.");
+            }
+        }
+
+        private static void CheckNep17PayableCompliant(this ContractManifest manifest)
+        {
+            try
+            {
+                var onNEP17PaymentMethod = manifest.Abi.GetMethod("onNEP17Payment", 3);
+                var onNEP17PaymentValid = onNEP17PaymentMethod is { Safe: false, ReturnType: ContractParameterType.Void } &&
+                                          onNEP17PaymentMethod.Parameters[0].Type == ContractParameterType.Hash160 &&
+                                          onNEP17PaymentMethod.Parameters[1].Type == ContractParameterType.Integer &&
+                                          onNEP17PaymentMethod.Parameters[2].Type == ContractParameterType.Any;
+
+                if (!onNEP17PaymentValid) throw new CompilationException(DiagnosticId.IncorrectNEPStandard,
+                    $"Incomplete NEP standard {NepStandard.Nep17Payable.ToStandard()} implementation: onNEP17Payment");
+            }
+            catch (Exception ex) when (ex is not CompilationException)
+            {
+                throw new CompilationException(DiagnosticId.IncorrectNEPStandard, $"Incomplete NEP standard {NepStandard.Nep17Payable.ToStandard()} implementation: Unidentified issue.");
+            }
+        }
+
         internal static ContractManifest CheckStandards(this ContractManifest manifest)
         {
             if (manifest.SupportedStandards.Contains(NepStandard.Nep11.ToStandard()))
@@ -175,6 +213,16 @@ internal static ContractManifest CheckStandards(this ContractManifest manifest)
                 manifest.CheckNep17Compliant();
             }
 
+            if (manifest.SupportedStandards.Contains(NepStandard.Nep11Payable.ToStandard()))
+            {
+                manifest.CheckNep11PayableCompliant();
+            }
+
+            if (manifest.SupportedStandards.Contains(NepStandard.Nep17Payable.ToStandard()))
+            {
+                manifest.CheckNep17PayableCompliant();
+            }
+
             return manifest;
         }
     }

src/Neo.SmartContract.Framework/NEPStandard.cs

@@ -19,6 +19,18 @@ public enum NepStandard
         // The NEP-17 standard is used for fungible tokens.
         // Defined at https://github.com/neo-project/proposals/blob/master/nep-17.mediawiki
         Nep17,
+        // Smart contract transfer callback for non-fungible tokens (NFTs).
+        // This is an extension standard of NEP-11.
+        // Defined at https://github.com/neo-project/proposals/pull/169/files#diff-2b5f7c12a23f7dbe4cb46bbf4be6936882f8e0f0b3a4db9d8c58eb294b02e6ed
+        Nep11_Y,
+        // This is the nick name of NEP-11-Y.
+        Nep11Payable,
+        // Smart contract transfer callback for fungible tokens.
+        // This is an extension standard of NEP-17.
+        // Defined at https://github.com/neo-project/proposals/pull/169/files#diff-70768f307c9aa84f8c94e790495a76d47fffeca2331444592ebba6f13b1e6460
+        Nep17_Z,
+        // This is the nick name of NEP-17-Z.
+        Nep17Payable,
         // This NEP defines a global standard to get royalty payment information for Non-Fungible Tokens (NFTs)
         // in order to enable support for royalty payments across all NFT marketplaces in the NEO Smart Economy.
         // This NEP requires NEP-11.
@@ -34,6 +46,8 @@ public static string ToStandard(this NepStandard standard)
             {
                 NepStandard.Nep11 => "NEP-11",
                 NepStandard.Nep17 => "NEP-17",
+                NepStandard.Nep11Payable or NepStandard.Nep11_Y => "NEP-11-Y",
+                NepStandard.Nep17Payable or NepStandard.Nep17_Z => "NEP-17-Z",
                 NepStandard.Nep24 => "NEP-24",
                 _ => standard.ToString()
             };

tests/Neo.SmartContract.Framework.TestContracts/Contract_SupportedStandard11Payable.cs

@@ -0,0 +1,20 @@
+using Neo.SmartContract.Framework.Attributes;
+using System.ComponentModel;
+using System.Numerics;
+using Neo.SmartContract.Framework.Interfaces;
+
+namespace Neo.SmartContract.Framework.TestContracts
+{
+    [DisplayName(nameof(Contract_SupportedStandard11Payable))]
+    [ContractDescription("<Description Here>")]
+    [ContractAuthor("<Your Name Or Company Here>", "<Your Public Email Here>")]
+    [ContractVersion("<Version String Here>")]
+    [ContractPermission(Permission.WildCard, Method.WildCard)]
+    [SupportedStandards(NepStandard.Nep11Payable)]
+    public class Contract_SupportedStandard11Payable : SmartContract, INep11Payable
+    {
+        public void OnNEP11Payment(UInt160 from, BigInteger amount, object? data = null)
+        {
+        }
+    }
+}

tests/Neo.SmartContract.Framework.TestContracts/Contract_SupportedStandard17Payable.cs

@@ -0,0 +1,20 @@
+using Neo.SmartContract.Framework.Attributes;
+using System.ComponentModel;
+using System.Numerics;
+using Neo.SmartContract.Framework.Interfaces;
+
+namespace Neo.SmartContract.Framework.TestContracts
+{
+    [DisplayName(nameof(Contract_SupportedStandard17Payable))]
+    [ContractDescription("<Description Here>")]
+    [ContractAuthor("<Your Name Or Company Here>", "<Your Public Email Here>")]
+    [ContractVersion("<Version String Here>")]
+    [ContractPermission(Permission.WildCard, Method.WildCard)]
+    [SupportedStandards(NepStandard.Nep17Payable)]
+    public class Contract_SupportedStandard17Payable : SmartContract, INep17Payable
+    {
+        public void OnNEP17Payment(UInt160 from, BigInteger amount, object? data = null)
+        {
+        }
+    }
+}

tests/Neo.SmartContract.Framework.UnitTests/SupportedStandardsTest.cs

@@ -23,5 +23,17 @@ public void TestStandardNEP17AttributeEnum()
         {
             CollectionAssert.AreEqual(Contract_SupportedStandard17Enum.Manifest.SupportedStandards, new string[] { "NEP-17" });
         }
+
+        [TestMethod]
+        public void TestStandardNEP11PayableAttribute()
+        {
+            CollectionAssert.AreEqual(Contract_SupportedStandard11Payable.Manifest.SupportedStandards, new string[] { "NEP-11-Y" });
+        }
+
+        [TestMethod]
+        public void TestStandardNEP17PayableAttribute()
+        {
+            CollectionAssert.AreEqual(Contract_SupportedStandard17Payable.Manifest.SupportedStandards, new string[] { "NEP-17-Z" });
+        }
     }
 }

tests/Neo.SmartContract.Framework.UnitTests/TestingArtifacts/Contract_SupportedStandard11Payable.cs

@@ -0,0 +1,34 @@
+using Neo.Cryptography.ECC;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Numerics;
+
+namespace Neo.SmartContract.Testing;
+
+public abstract class Contract_SupportedStandard11Payable : Neo.SmartContract.Testing.SmartContract
+{
+    #region Compiled data
+
+    public static readonly Neo.SmartContract.Manifest.ContractManifest Manifest = Neo.SmartContract.Manifest.ContractManifest.Parse(@"{""name"":""Contract_SupportedStandard11Payable"",""groups"":[],""features"":{},""supportedstandards"":[""NEP-11-Y""],""abi"":{""methods"":[{""name"":""onNEP11Payment"",""parameters"":[{""name"":""from"",""type"":""Hash160""},{""name"":""amount"",""type"":""Integer""},{""name"":""data"",""type"":""Any""}],""returntype"":""Void"",""offset"":15,""safe"":false}],""events"":[]},""permissions"":[{""contract"":""*"",""methods"":""*""}],""trusts"":[],""extra"":{""Description"":""\u003CDescription Here\u003E"",""Author"":""\u003CYour Name Or Company Here\u003E"",""Version"":""\u003CVersion String Here\u003E""}}");
+
+    public static readonly Neo.SmartContract.NefFile Nef = Neo.IO.Helper.AsSerializable<Neo.SmartContract.NefFile>(Convert.FromBase64String(@"TkVGM1Rlc3RpbmdFbmdpbmUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABVXAARAVwABeDQDQFcAAUDCSjTzIu3rbva0"));
+
+    #endregion
+
+    #region Unsafe methods
+
+    /// <summary>
+    /// Unsafe method
+    /// </summary>
+    [DisplayName("onNEP11Payment")]
+    public abstract void OnNEP11Payment(UInt160? from, BigInteger? amount, object? data = null);
+
+    #endregion
+
+    #region Constructor for internal use only
+
+    protected Contract_SupportedStandard11Payable(Neo.SmartContract.Testing.SmartContractInitialize initialize) : base(initialize) { }
+
+    #endregion
+}

tests/Neo.SmartContract.Framework.UnitTests/TestingArtifacts/Contract_SupportedStandard17Payable.cs

@@ -0,0 +1,34 @@
+using Neo.Cryptography.ECC;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Numerics;
+
+namespace Neo.SmartContract.Testing;
+
+public abstract class Contract_SupportedStandard17Payable : Neo.SmartContract.Testing.SmartContract
+{
+    #region Compiled data
+
+    public static readonly Neo.SmartContract.Manifest.ContractManifest Manifest = Neo.SmartContract.Manifest.ContractManifest.Parse(@"{""name"":""Contract_SupportedStandard17Payable"",""groups"":[],""features"":{},""supportedstandards"":[""NEP-17-Z""],""abi"":{""methods"":[{""name"":""onNEP17Payment"",""parameters"":[{""name"":""from"",""type"":""Hash160""},{""name"":""amount"",""type"":""Integer""},{""name"":""data"",""type"":""Any""}],""returntype"":""Void"",""offset"":15,""safe"":false}],""events"":[]},""permissions"":[{""contract"":""*"",""methods"":""*""}],""trusts"":[],""extra"":{""Description"":""\u003CDescription Here\u003E"",""Author"":""\u003CYour Name Or Company Here\u003E"",""Version"":""\u003CVersion String Here\u003E""}}");
+
+    public static readonly Neo.SmartContract.NefFile Nef = Neo.IO.Helper.AsSerializable<Neo.SmartContract.NefFile>(Convert.FromBase64String(@"TkVGM1Rlc3RpbmdFbmdpbmUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABVXAARAVwABeDQDQFcAAUDCSjTzIu3rbva0"));
+
+    #endregion
+
+    #region Unsafe methods
+
+    /// <summary>
+    /// Unsafe method
+    /// </summary>
+    [DisplayName("onNEP17Payment")]
+    public abstract void OnNEP17Payment(UInt160? from, BigInteger? amount, object? data = null);
+
+    #endregion
+
+    #region Constructor for internal use only
+
+    protected Contract_SupportedStandard17Payable(Neo.SmartContract.Testing.SmartContractInitialize initialize) : base(initialize) { }
+
+    #endregion
+}