Step 11: kernel integration (put / delete split in contract details)

modAion/src/org/aion/zero/db/AionContractDetailsImpl.java

@@ -6,9 +6,7 @@
 import static org.aion.crypto.HashUtil.h256;
 
 import java.util.Arrays;
-import java.util.Collection;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Objects;
@@ -19,7 +17,6 @@
 import org.aion.mcf.db.AbstractContractDetails;
 import org.aion.mcf.ds.XorDataSource;
 import org.aion.mcf.trie.SecureTrie;
-import org.aion.mcf.vm.types.DataWord;
 import org.aion.rlp.RLP;
 import org.aion.rlp.RLPElement;
 import org.aion.rlp.RLPItem;
@@ -70,15 +67,25 @@ public AionContractDetailsImpl(byte[] code) throws Exception {
      */
     @Override
     public void put(ByteArrayWrapper key, ByteArrayWrapper value) {
+        Objects.requireNonNull(key);
+        Objects.requireNonNull(value);
+
+        // The following must be done before making this call:
         // We strip leading zeros of a DataWord but not a DoubleDataWord so that when we call get
         // we can differentiate between the two.
 
-        if (value.isZero()) {
-            storageTrie.delete(key.getData());
-        } else {
-            byte[] data = RLP.encodeElement(value.getData());
-            storageTrie.update(key.getData(), data);
-        }
+        byte[] data = RLP.encodeElement(value.getData());
+        storageTrie.update(key.getData(), data);
+
+        this.setDirty(true);
+        this.rlpEncoded = null;
+    }
+
+    @Override
+    public void delete(ByteArrayWrapper key) {
+        Objects.requireNonNull(key);
+
+        storageTrie.delete(key.getData());
 
         this.setDirty(true);
         this.rlpEncoded = null;
@@ -95,7 +102,7 @@ public void put(ByteArrayWrapper key, ByteArrayWrapper value) {
     public ByteArrayWrapper get(ByteArrayWrapper key) {
         byte[] data = storageTrie.get(key.getData());
         return (data == null || data.length == 0)
-                ? DataWord.ZERO.toWrapper()
+                ? null
                 : new ByteArrayWrapper(RLP.decode2(data).get(0).getRLPData());
     }
 
@@ -207,60 +214,6 @@ public byte[] getEncoded() {
         return rlpEncoded;
     }
 
-    /**
-     * Returns a mapping of all the key-value pairs who have keys in the collection keys.
-     *
-     * @param keys The keys to query for.
-     * @return The associated mappings.
-     */
-    @Override
-    public Map<ByteArrayWrapper, ByteArrayWrapper> getStorage(Collection<ByteArrayWrapper> keys) {
-        Map<ByteArrayWrapper, ByteArrayWrapper> storage = new HashMap<>();
-        if (keys == null) {
-            throw new IllegalArgumentException("Input keys can't be null");
-        } else {
-            for (ByteArrayWrapper key : keys) {
-                ByteArrayWrapper value = get(key);
-
-                // we check if the value is not null,
-                // cause we keep all historical keys
-                if ((value != null) && (!value.isZero())) {
-                    storage.put(key, value);
-                }
-            }
-        }
-
-        return storage;
-    }
-
-    /**
-     * Sets the storage to contain the specified keys and values. This method creates pairings of
-     * the keys and values by mapping the i'th key in storageKeys to the i'th value in
-     * storageValues.
-     *
-     * @param storageKeys The keys.
-     * @param storageValues The values.
-     */
-    @Override
-    public void setStorage(
-            List<ByteArrayWrapper> storageKeys, List<ByteArrayWrapper> storageValues) {
-        for (int i = 0; i < storageKeys.size(); ++i) {
-            put(storageKeys.get(i), storageValues.get(i));
-        }
-    }
-
-    /**
-     * Sets the storage to contain the specified key-value mappings.
-     *
-     * @param storage The specified mappings.
-     */
-    @Override
-    public void setStorage(Map<ByteArrayWrapper, ByteArrayWrapper> storage) {
-        for (ByteArrayWrapper key : storage.keySet()) {
-            put(key, storage.get(key));
-        }
-    }
-
     /**
      * Get the address associated with this AionContractDetailsImpl.
      *

modAionBase/src/org/aion/base/db/IContractDetails.java

@@ -1,23 +1,27 @@
 package org.aion.base.db;
 
 import java.util.Collection;
-import java.util.List;
 import java.util.Map;
 import org.aion.base.util.ByteArrayWrapper;
 import org.aion.vm.api.interfaces.Address;
 
 public interface IContractDetails {
 
     /**
-     * Inserts key and value as a key-value pair. If the underlying byte array of value consists
-     * only of zero bytes then ay existing key-value pair that has the same key as key will be
-     * deleted.
+     * Inserts a key-value pair containing the given key and the given value.
      *
-     * @param key The key.
-     * @param value The value.
+     * @param key the key to be inserted
+     * @param value the value to be inserted
      */
     void put(ByteArrayWrapper key, ByteArrayWrapper value);
 
+    /**
+     * Deletes any key-value pair that matches the given key.
+     *
+     * @param key the key to be deleted
+     */
+    void delete(ByteArrayWrapper key);
+
     /**
      * Returns the value associated with key.
      *
@@ -113,27 +117,19 @@ public interface IContractDetails {
     byte[] getEncoded();
 
     /**
-     * Returns a mapping of all the key-value pairs who have keys in the collection keys.
+     * Returns a mapping of all the key-value pairs that have keys in the given collection keys.
      *
-     * @param keys The keys to query for.
-     * @return The associated mappings.
+     * @param keys the keys to query for
+     * @return the associated mappings
      */
     Map<ByteArrayWrapper, ByteArrayWrapper> getStorage(Collection<ByteArrayWrapper> keys);
 
-    /**
-     * Sets the storage to contain the specified keys and values. This method creates pairings of
-     * the keys and values by mapping the i'th key in storageKeys to the i'th value in
-     * storageValues.
-     *
-     * @param storageKeys The keys.
-     * @param storageValues The values.
-     */
-    void setStorage(List<ByteArrayWrapper> storageKeys, List<ByteArrayWrapper> storageValues);
-
     /**
      * Sets the storage to contain the specified key-value mappings.
      *
-     * @param storage The specified mappings.
+     * @param storage the specified mappings
+     * @apiNote Used for testing.
+     * @implNote A {@code null} value is interpreted as deletion.
      */
     void setStorage(Map<ByteArrayWrapper, ByteArrayWrapper> storage);
 

modAionBase/src/org/aion/base/db/IRepositoryCache.java

@@ -76,10 +76,18 @@ public interface IRepositoryCache<AS, BSB> extends IRepository<AS, BSB> {
      * Store the given data at the given key in the account associated with the given address.
      *
      * @param address the address of the account of interest
-     * @param key the key at which the date will be stored
+     * @param key the key at which the data will be stored
      * @param value the data to be stored
      */
     void addStorageRow(Address address, ByteArrayWrapper key, ByteArrayWrapper value);
 
+    /**
+     * Remove the given storage key from the account associated with the given address.
+     *
+     * @param address the address of the account of interest
+     * @param key the key for which the data will be removed
+     */
+    void removeStorageRow(Address address, ByteArrayWrapper key);
+
     void flushTo(IRepository repo, boolean clearStateAfterFlush);
 }

modAionBase/src/org/aion/base/util/ByteArrayWrapper.java

@@ -75,6 +75,15 @@ public boolean isZero() {
         return true;
     }
 
+    /**
+     * Checks if the stored byte array is empty.
+     *
+     * @return {@code true} if empty, {@code false} otherwise
+     */
+    public boolean isEmpty() {
+        return data.length == 0;
+    }
+
     public ByteArrayWrapper copy() {
         int length = data.length;
         byte[] bs = new byte[length];

modAionImpl/src/org/aion/zero/impl/AionGenesis.java

@@ -349,6 +349,7 @@ protected byte[] generateRootHash() {
             AionContractDetailsImpl networkBalanceStorage = new AionContractDetailsImpl();
 
             for (Map.Entry<Integer, BigInteger> entry : this.networkBalance.entrySet()) {
+                // we assume there are no deletions in the genesis
                 networkBalanceStorage.put(
                         new DataWord(entry.getKey()).toWrapper(),
                         wrapValueForPut(new DataWord(entry.getValue())));
@@ -370,7 +371,9 @@ protected byte[] generateRootHash() {
         }
 
         private static ByteArrayWrapper wrapValueForPut(DataWord value) {
-            return (value.isZero()) ? DataWord.ZERO.toWrapper() : new ByteArrayWrapper(value.getNoLeadZeroesData());
+            return (value.isZero())
+                    ? DataWord.ZERO.toWrapper()
+                    : new ByteArrayWrapper(value.getNoLeadZeroesData());
         }
 
         private static byte[] generateExtraData(int chainId) {

modAionImpl/src/org/aion/zero/impl/AionHubUtils.java

@@ -20,6 +20,7 @@ public static void buildGenesis(AionGenesis genesis, AionRepositoryImpl reposito
         track.createAccount(networkBalanceAddress);
 
         for (Map.Entry<Integer, BigInteger> addr : genesis.getNetworkBalances().entrySet()) {
+            // assumes only additions are performed in the genesis
             track.addStorageRow(
                     networkBalanceAddress,
                     new DataWord(addr.getKey()).toWrapper(),
@@ -37,6 +38,8 @@ public static void buildGenesis(AionGenesis genesis, AionRepositoryImpl reposito
     }
 
     private static ByteArrayWrapper wrapValueForPut(DataWord value) {
-        return (value.isZero()) ? value.toWrapper() : new ByteArrayWrapper(value.getNoLeadZeroesData());
+        return (value.isZero())
+                ? value.toWrapper()
+                : new ByteArrayWrapper(value.getNoLeadZeroesData());
     }
 }

modAionImpl/src/org/aion/zero/impl/StandaloneBlockchain.java

@@ -324,6 +324,7 @@ public boolean isAvmEnabled() {
             track.createAccount(ContractFactory.getTotalCurrencyContractAddress());
 
             for (Map.Entry<Integer, BigInteger> key : genesis.getNetworkBalances().entrySet()) {
+                // assumes only additions can be made in the genesis
                 track.addStorageRow(
                         ContractFactory.getTotalCurrencyContractAddress(),
                         new DataWord(key.getKey()).toWrapper(),

modAionImpl/src/org/aion/zero/impl/db/AionRepositoryDummy.java

@@ -139,24 +139,33 @@ public BigInteger getBalance(Address addr) {
     public ByteArrayWrapper getStorageValue(Address addr, ByteArrayWrapper key) {
         IContractDetails details = getContractDetails(addr);
         ByteArrayWrapper value = (details == null) ? null : details.get(key);
-        if (value == null) {
-            return null;
-        }
-        return (value.isZero()) ? null : value;
-    }
-
-    public void addStorageRow(Address addr, ByteArrayWrapper key, ByteArrayWrapper value) {
-        IContractDetails details = getContractDetails(addr);
 
-        if (details == null) {
-            createAccount(addr);
-            details = getContractDetails(addr);
+        if (value != null && value.isZero()) {
+            // TODO: remove when integrating the AVM
+            // used to ensure FVM correctness
+            throw new IllegalStateException(
+                    "The contract address "
+                            + addr.toString()
+                            + " returned a zero value for the key "
+                            + key.toString()
+                            + " which is not a valid stored value for the FVM. ");
         }
 
-        details.put(key, value);
-        detailsDB.put(ByteArrayWrapper.wrap(addr.toBytes()), details);
+        return value;
     }
 
+    // never used
+    //    public void addStorageRow(Address addr, ByteArrayWrapper key, ByteArrayWrapper value) {
+    //        IContractDetails details = getContractDetails(addr);
+    //
+    //        if (details == null) {
+    //            createAccount(addr);
+    //            details = getContractDetails(addr);
+    //        }
+    //        details.put(key, value);
+    //        detailsDB.put(ByteArrayWrapper.wrap(addr.toBytes()), details);
+    //    }
+
     public byte[] getCode(Address addr) {
         IContractDetails details = getContractDetails(addr);
 

modAionImpl/src/org/aion/zero/impl/db/AionRepositoryImpl.java

@@ -314,11 +314,7 @@ public BigInteger getBalance(Address address) {
     @Override
     public ByteArrayWrapper getStorageValue(Address address, ByteArrayWrapper key) {
         IContractDetails details = getContractDetails(address);
-        ByteArrayWrapper value = (details == null) ? null : details.get(key);
-        if (value == null) {
-            return null;
-        }
-        return (value.isZero()) ? null : value;
+        return (details == null) ? null : details.get(key);
     }
 
     @Override