nullable Storage.Get; refactor TokenContract

src/Neo.SmartContract.Framework/ByteString.Extension.cs

@@ -93,7 +93,7 @@ public static int IndexOf(this ByteString byteString, ByteString byteToFind)
     /// <returns>True if start with</returns>
     public static bool StartWith(this ByteString byteString, ByteString byteToFind)
     {
-        return StdLib.MemorySearch(byteString, byteToFind) == 0;
+        return Helper.NumEqual(StdLib.MemorySearch(byteString, byteToFind), 0);
     }
 
     /// <summary>
@@ -104,7 +104,7 @@ public static bool StartWith(this ByteString byteString, ByteString byteToFind)
     /// <returns>True if ends with</returns>
     public static bool EndsWith(this ByteString byteString, ByteString byteToFind)
     {
-        return StdLib.MemorySearch(byteString, byteToFind) + byteToFind.Length == byteString.Length;
+        return Helper.NumEqual(StdLib.MemorySearch(byteString, byteToFind) + byteToFind.Length, byteString.Length);
     }
 
     /// <summary>

src/Neo.SmartContract.Framework/Linq/LinqExtensions.cs

@@ -130,7 +130,7 @@ public static int Average(this IEnumerable<int> source)
                 count++;
                 sum += item;
             }
-            if (count == 0) throw new Exception("source is empty");
+            if (Helper.NumEqual(count, 0)) throw new Exception("source is empty");
             return sum / count;
         }
 
@@ -153,7 +153,7 @@ public static int Average<T>(this IEnumerable<T> source, Func<T, int> selector)
                 count++;
                 sum += selector(item);
             }
-            if (count == 0) throw new Exception("source is empty");
+            if (Helper.NumEqual(count, 0)) throw new Exception("source is empty");
             return sum / count;
         }
 
@@ -173,7 +173,7 @@ public static long Average(this IEnumerable<long> source)
                 count++;
                 sum += item;
             }
-            if (count == 0) throw new Exception("source is empty");
+            if (Helper.NumEqual(count, 0)) throw new Exception("source is empty");
             return sum / count;
         }
 
@@ -196,7 +196,7 @@ public static long Average<T>(this IEnumerable<T> source, Func<T, long> selector
                 count++;
                 sum += selector(item);
             }
-            if (count == 0) throw new Exception("source is empty");
+            if (Helper.NumEqual(count, 0)) throw new Exception("source is empty");
             return sum / count;
         }
 
@@ -216,7 +216,7 @@ public static BigInteger Average(this IEnumerable<BigInteger> source)
                 count++;
                 sum += item;
             }
-            if (count == 0) throw new Exception("source is empty");
+            if (Helper.NumEqual(count, 0)) throw new Exception("source is empty");
             return sum / count;
         }
 
@@ -239,7 +239,7 @@ public static BigInteger Average<T>(this IEnumerable<T> source, Func<T, BigInteg
                 count++;
                 sum += selector(item);
             }
-            if (count == 0) throw new Exception("source is empty");
+            if (Helper.NumEqual(count, 0)) throw new Exception("source is empty");
             return sum / count;
         }
 

src/Neo.SmartContract.Framework/Neo.SmartContract.Framework.csproj

@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
+    <Nullable>enable</Nullable>
     <TargetFramework>net8.0</TargetFramework>
     <AssemblyTitle>Neo.SmartContract.Framework</AssemblyTitle>
     <AssemblyName>Neo.SmartContract.Framework</AssemblyName>

src/Neo.SmartContract.Framework/Nep11Token.cs

@@ -68,15 +68,15 @@ public static Iterator Tokens()
         [Safe]
         public static Iterator TokensOf(UInt160 owner)
         {
-            if (owner is null || !owner.IsValid)
+            if (!owner.IsValid)
                 throw new Exception("The argument \"owner\" is invalid");
             var accountMap = new StorageMap(Prefix_AccountToken);
             return accountMap.Find(owner, FindOptions.KeysOnly | FindOptions.RemovePrefix);
         }
 
         public static bool Transfer(UInt160 to, ByteString tokenId, object data)
         {
-            if (to is null || !to.IsValid)
+            if (!to.IsValid)
                 throw new Exception("The argument \"to\" is invalid.");
             var tokenMap = new StorageMap(Prefix_Token);
             TokenState token = (TokenState)StdLib.Deserialize(tokenMap[tokenId]);

src/Neo.SmartContract.Framework/Nep17Token.cs

@@ -21,16 +21,16 @@ namespace Neo.SmartContract.Framework
     [ContractPermission(Permission.Any, Method.OnNEP17Payment)]
     public abstract class Nep17Token : TokenContract
     {
-        public delegate void OnTransferDelegate(UInt160 from, UInt160 to, BigInteger amount);
+        public delegate void OnTransferDelegate(UInt160? from, UInt160? to, BigInteger amount);
 
         [DisplayName("Transfer")]
         public static event OnTransferDelegate OnTransfer;
 
         public static bool Transfer(UInt160 from, UInt160 to, BigInteger amount, object data)
         {
-            if (from is null || !from.IsValid)
+            if (!from.IsValid)
                 throw new Exception("The argument \"from\" is invalid.");
-            if (to is null || !to.IsValid)
+            if (!to.IsValid)
                 throw new Exception("The argument \"to\" is invalid.");
             if (amount < 0)
                 throw new Exception("The amount must be a positive number.");
@@ -64,7 +64,7 @@ protected static void Burn(UInt160 account, BigInteger amount)
             PostTransfer(account, null, amount, null);
         }
 
-        protected static void PostTransfer(UInt160 from, UInt160 to, BigInteger amount, object data)
+        protected static void PostTransfer(UInt160? from, UInt160? to, BigInteger amount, object? data)
         {
             OnTransfer(from, to, amount);
             if (to is not null && ContractManagement.GetContract(to) is not null)

src/Neo.SmartContract.Framework/Services/Contract.cs

@@ -40,7 +40,7 @@ public class Contract
         public readonly ContractManifest Manifest;
 
         [Syscall("System.Contract.Call")]
-        public static extern object Call(UInt160 scriptHash, string method, CallFlags flags, params object[] args);
+        public static extern object Call(UInt160 scriptHash, string method, CallFlags flags, params object[]? args);
 
         [Syscall("System.Contract.GetCallFlags")]
         public static extern CallFlags GetCallFlags();

src/Neo.SmartContract.Framework/Services/Storage.cs

@@ -37,13 +37,13 @@ public static extern StorageContext CurrentReadOnlyContext
         /// Returns the value corresponding to the given key for Storage context (faster: generates opcode directly)
         /// </summary>
         [Syscall("System.Storage.Get")]
-        public static extern ByteString Get(StorageContext context, ByteString key);
+        public static extern ByteString? Get(StorageContext context, ByteString key);
 
         /// <summary>
         /// Returns the value corresponding to the given key for Storage context (faster: generates opcode directly)
         /// </summary>
         [Syscall("System.Storage.Get")]
-        public static extern ByteString Get(StorageContext context, byte[] key);
+        public static extern ByteString? Get(StorageContext context, byte[] key);
 
         /// <summary>
         /// Writes the key/value pair for the given Storage context (faster: generates opcode directly)
@@ -100,8 +100,8 @@ public static extern StorageContext CurrentReadOnlyContext
         public static extern Iterator Find(StorageContext context, byte[] prefix, FindOptions options = FindOptions.None);
 
         #region Interface with default Context
-        public static ByteString Get(ByteString key) => Get(CurrentReadOnlyContext, key);
-        public static ByteString Get(byte[] key) => Get(CurrentReadOnlyContext, key);
+        public static ByteString? Get(ByteString key) => Get(CurrentReadOnlyContext, key);
+        public static ByteString? Get(byte[] key) => Get(CurrentReadOnlyContext, key);
         public static void Put(ByteString key, ByteString value) => Put(CurrentContext, key, value);
         public static void Put(byte[] key, ByteString value) => Put(CurrentContext, key, value);
         public static void Put(byte[] key, byte[] value) => Put(CurrentContext, key, value);

src/Neo.SmartContract.Framework/Services/StorageMap.cs

@@ -23,7 +23,7 @@ public class StorageMap
         private readonly StorageContext context;
         private readonly byte[] prefix;
 
-        public extern ByteString this[ByteString key]
+        public extern ByteString? this[ByteString key]
         {
             [CallingConvention(CallingConvention.Cdecl)]
             [OpCode(OpCode.UNPACK)]
@@ -43,7 +43,7 @@ public extern ByteString this[ByteString key]
             set;
         }
 
-        public extern ByteString this[byte[] key]
+        public extern ByteString? this[byte[] key]
         {
             [CallingConvention(CallingConvention.Cdecl)]
             [OpCode(OpCode.UNPACK)]
@@ -112,7 +112,7 @@ public extern ByteString this[byte[] key]
         [OpCode(OpCode.CAT)]
         [OpCode(OpCode.SWAP)]
         [Syscall("System.Storage.Get")]
-        public extern ByteString Get(ByteString key);
+        public extern ByteString? Get(ByteString key);
 
         [CallingConvention(CallingConvention.Cdecl)]
         [OpCode(OpCode.UNPACK)]
@@ -204,7 +204,7 @@ public extern ByteString this[byte[] key]
         [OpCode(OpCode.CAT)]
         [OpCode(OpCode.SWAP)]
         [Syscall("System.Storage.Get")]
-        public extern ByteString Get(byte[] key);
+        public extern ByteString? Get(byte[] key);
 
         [CallingConvention(CallingConvention.Cdecl)]
         [OpCode(OpCode.UNPACK)]
@@ -289,16 +289,16 @@ public extern ByteString this[byte[] key]
         [OpCode(OpCode.CONVERT, StackItemType.Integer)]
         public extern BigInteger GetIntegerOrZero(byte[] key);
 
-        public object GetObject(ByteString key)
+        public object? GetObject(ByteString key)
         {
-            ByteString value = Get(key);
+            ByteString? value = Get(key);
             if (value is null) return null;
             return StdLib.Deserialize(value);
         }
 
-        public object GetObject(byte[] key)
+        public object? GetObject(byte[] key)
         {
-            ByteString value = Get(key);
+            ByteString? value = Get(key);
             if (value is null) return null;
             return StdLib.Deserialize(value);
         }

src/Neo.SmartContract.Framework/TokenContract.cs

@@ -17,35 +17,49 @@ namespace Neo.SmartContract.Framework
 {
     public abstract class TokenContract : SmartContract
     {
-        protected const byte Prefix_TotalSupply = 0x00;
-        protected const byte Prefix_Balance = 0x01;
+        protected static readonly ByteString Prefix_TotalSupply = "\x00";
+        protected static readonly ByteString Prefix_Balance = "\x01";
 
         public abstract string Symbol { [Safe] get; }
 
         public abstract byte Decimals { [Safe] get; }
 
-        [Stored(Prefix_TotalSupply)]
-        public static BigInteger TotalSupply { [Safe] get; protected set; }
+        public static BigInteger TotalSupply
+        {
+            [Safe]
+            get
+            {
+                ByteString? stored = Storage.Get(Prefix_TotalSupply);
+                return (BigInteger)stored!;
+            }
+            protected set
+            {
+                Storage.Put(Prefix_TotalSupply, value);
+            }
+        }
 
         [Safe]
         public static BigInteger BalanceOf(UInt160 owner)
         {
-            if (owner is null || !owner.IsValid)
+            if (!owner.IsValid)
                 throw new Exception("The argument \"owner\" is invalid.");
-            StorageMap balanceMap = new(Storage.CurrentContext, Prefix_Balance);
-            return (BigInteger)balanceMap[owner];
+            ByteString? balanceStored = Storage.Get(Prefix_Balance + owner);
+            return (BigInteger)balanceStored!;
         }
 
         protected static bool UpdateBalance(UInt160 owner, BigInteger increment)
         {
-            StorageMap balanceMap = new(Storage.CurrentContext, Prefix_Balance);
-            BigInteger balance = (BigInteger)balanceMap[owner];
+            StorageContext currentContext = Storage.CurrentContext;
+            ByteString ownerKey = Prefix_Balance + owner;
+            ByteString? balanceStored = Storage.Get(currentContext, ownerKey);
+            BigInteger balance = (BigInteger)balanceStored!;
             balance += increment;
-            if (balance < 0) return false;
-            if (balance.IsZero)
-                balanceMap.Delete(owner);
+            if (balance < 0)
+                return false;
+            if (Helper.NumEqual(balance, 0))
+                Storage.Delete(currentContext, ownerKey);
             else
-                balanceMap.Put(owner, balance);
+                Storage.Put(currentContext, ownerKey, balance);
             return true;
         }
     }

src/Neo.SmartContract.Framework/UInt160.cs

@@ -29,11 +29,13 @@ public extern bool IsValid
         {
             [OpCode(OpCode.DUP)]
             [OpCode(OpCode.ISTYPE, "0x28")] //ByteString
-            [OpCode(OpCode.SWAP)]
+            [OpCode(OpCode.JMPIF, "06")]  // to SIZE
+            [OpCode(OpCode.DROP)]
+            [OpCode(OpCode.PUSHF)]
+            [OpCode(OpCode.JMP, "06")]    // to the end
             [OpCode(OpCode.SIZE)]
             [OpCode(OpCode.PUSHINT8, "14")] // 0x14 == 20 bytes expected array size
             [OpCode(OpCode.NUMEQUAL)]
-            [OpCode(OpCode.BOOLAND)]
             get;
         }
 

src/Neo.SmartContract.Framework/UInt256.cs

@@ -27,11 +27,13 @@ public extern bool IsValid
         {
             [OpCode(OpCode.DUP)]
             [OpCode(OpCode.ISTYPE, "0x28")] //ByteString
-            [OpCode(OpCode.SWAP)]
+            [OpCode(OpCode.JMPIF, "06")]  // to SIZE
+            [OpCode(OpCode.DROP)]
+            [OpCode(OpCode.PUSHF)]
+            [OpCode(OpCode.JMP, "06")]    // to the end
             [OpCode(OpCode.SIZE)]
             [OpCode(OpCode.PUSHINT8, "20")] // 0x20 == 32 bytes expected array size
             [OpCode(OpCode.NUMEQUAL)]
-            [OpCode(OpCode.BOOLAND)]
             get;
         }
 

src/Neo.SmartContract.Template/templates/neocontractnep17/Nep17Contract.cs

@@ -38,7 +38,7 @@ private static bool IsOwner() =>
 
         public static void SetOwner(UInt160 newOwner)
         {
-            if (IsOwner() == false)
+            if (!IsOwner())
                 throw new InvalidOperationException("No Authorization!");
 
             ExecutionEngine.Assert(newOwner.IsValid && !newOwner.IsZero, "owner must be valid");
@@ -60,14 +60,14 @@ public static void SetOwner(UInt160 newOwner)
 
         public static new void Burn(UInt160 account, BigInteger amount)
         {
-            if (IsOwner() == false)
+            if (!IsOwner())
                 throw new InvalidOperationException("No Authorization!");
             Nep17Token.Burn(account, amount);
         }
 
         public static new void Mint(UInt160 to, BigInteger amount)
         {
-            if (IsOwner() == false)
+            if (!IsOwner())
                 throw new InvalidOperationException("No Authorization!");
             Nep17Token.Mint(to, amount);
         }
@@ -109,7 +109,7 @@ public static void _deploy(object data, bool update)
 
         public static void Update(ByteString nefFile, string manifest, object? data = null)
         {
-            if (IsOwner() == false)
+            if (!IsOwner())
                 throw new InvalidOperationException("No authorization.");
             ContractManagement.Update(nefFile, manifest, data);
         }

src/Neo.SmartContract.Template/templates/neocontractowner/Ownable.cs

@@ -37,7 +37,7 @@ private static bool IsOwner() =>
 
         public static void SetOwner(UInt160 newOwner)
         {
-            if (IsOwner() == false)
+            if (!IsOwner())
                 throw new InvalidOperationException("No Authorization!");
 
             ExecutionEngine.Assert(newOwner.IsValid && !newOwner.IsZero, "owner must be valid");
@@ -78,7 +78,7 @@ public static void _deploy(object data, bool update)
 
         public static void Update(ByteString nefFile, string manifest, object? data = null)
         {
-            if (IsOwner() == false)
+            if (!IsOwner())
                 throw new InvalidOperationException("No authorization.");
             ContractManagement.Update(nefFile, manifest, data);
         }

src/Neo.SmartContract.Testing/TestingStandards/OwnableTests.cs

@@ -120,7 +120,8 @@ public virtual void TestSetGetOwner()
         Engine.SetTransactionSigners(Alice);
         Assert.ThrowsException<TestException>(() => Contract.Owner = UInt160.Zero);
         var exception = Assert.ThrowsException<TestException>(() => Contract.Owner = InvalidUInt160.Null);
-        Assert.IsInstanceOfType<InvalidOperationException>(exception.InnerException);
+        // not InvalidOperationExcpetion, because no SIZE operation on null
+        Assert.IsInstanceOfType<Exception>(exception.InnerException);
         Assert.ThrowsException<TestException>(() => Contract.Owner = InvalidUInt160.InvalidLength);
         Assert.ThrowsException<TestException>(() => Contract.Owner = InvalidUInt160.InvalidType);