added check on veichle identification number uniqueness #4
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,85 @@ | ||
| package io.horizen.lambo; | ||
|
|
||
| import com.google.inject.Inject; | ||
| import com.horizen.block.SidechainBlock; | ||
| import com.horizen.box.Box; | ||
| import com.horizen.proposition.Proposition; | ||
| import com.horizen.state.ApplicationState; | ||
| import com.horizen.state.SidechainStateReader; | ||
| import com.horizen.transaction.BoxTransaction; | ||
| import io.horizen.lambo.car.box.CarBox; | ||
| import io.horizen.lambo.car.box.CarSellOrderBox; | ||
| import io.horizen.lambo.car.services.CarInfoDBService; | ||
| import io.horizen.lambo.car.transaction.CarDeclarationTransaction; | ||
| import scala.util.Success; | ||
| import scala.util.Try; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
|
|
||
|
|
||
| public class CarRegistryApplicationState implements ApplicationState { | ||
|
|
||
| private CarInfoDBService carInfoDbService; | ||
|
|
||
| @Inject | ||
| public CarRegistryApplicationState(CarInfoDBService carInfoDbService) { | ||
| this.carInfoDbService = carInfoDbService; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean validate(SidechainStateReader stateReader, SidechainBlock block) { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean validate(SidechainStateReader stateReader, BoxTransaction<Proposition, Box<Proposition>> transaction) { | ||
| // we go though all CarDeclarationTransactions and verify that each CarBox reflects to unique Car. | ||
| if (CarDeclarationTransaction.class.isAssignableFrom(transaction.getClass())){ | ||
|
There was a problem hiding this comment. why not There was a problem hiding this comment. I tried it but it gives this compilation error: (to be honest I don't understand what is the problem because the hierachy seems compatible!) There was a problem hiding this comment. I got it work by adding explicitly this generic signature to CarDeclarationTransaction > |
||
| Set<String> vinList = carInfoDbService.extractVinFromBoxes(transaction.newBoxes()); | ||
| for (String vin : vinList) { | ||
| if (! carInfoDbService.validateVin(vin, null)){ | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public Try<ApplicationState> onApplyChanges(SidechainStateReader stateReader, | ||
| byte[] version, | ||
| List<Box<Proposition>> newBoxes, List<byte[]> boxIdsToRemove) { | ||
| //we update the Car info database. The data from it will be used during validation. | ||
|
|
||
| //collect the vin to be added: the ones declared in new boxes | ||
| Set<String> vinToAdd = carInfoDbService.extractVinFromBoxes(newBoxes); | ||
| //collect the vin to be removed: the ones contained in the removed boxes that are not present in the prevoius list | ||
| Set<String> vinToRemove = new HashSet<>(); | ||
| for (byte[] boxId : boxIdsToRemove) { | ||
| stateReader.getClosedBox(boxId).ifPresent( box -> { | ||
| if (box instanceof CarBox){ | ||
| String vin = ((CarBox)box).getVin(); | ||
| if (!vinToAdd.contains(vin)){ | ||
| vinToRemove.add(vin); | ||
| } | ||
| } else if (box instanceof CarSellOrderBox){ | ||
| String vin = ((CarSellOrderBox)box).getVin(); | ||
| if (!vinToAdd.contains(vin)){ | ||
| vinToRemove.add(vin); | ||
| } | ||
| } | ||
| } | ||
| ); | ||
| } | ||
| carInfoDbService.updateVin(version, vinToAdd, vinToRemove); | ||
| return new Success<>(this); | ||
| } | ||
|
|
||
|
|
||
| @Override | ||
| public Try<ApplicationState> onRollback(byte[] version) { | ||
| carInfoDbService.rollback(version); | ||
| return new Success<>(this); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| package io.horizen.lambo.car.services; | ||
|
|
||
| import com.google.inject.Inject; | ||
| import com.google.inject.name.Named; | ||
| import com.horizen.box.Box; | ||
| import com.horizen.node.NodeMemoryPool; | ||
| import com.horizen.proposition.Proposition; | ||
| import com.horizen.storage.Storage; | ||
| import com.horizen.transaction.BoxTransaction; | ||
| import com.horizen.utils.ByteArrayWrapper; | ||
| import com.horizen.utils.Pair; | ||
| import io.horizen.lambo.car.box.CarBox; | ||
| import io.horizen.lambo.car.box.CarSellOrderBox; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.nio.ByteBuffer; | ||
| import java.util.Set; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.ArrayList; | ||
|
|
||
| /** | ||
| * This service manages a local db with the list of all veichle identification numbers (vin) declared on the chain. | ||
| * The vin could be present inside two type of boxes: CarBox and CarSellOrderBox. | ||
| */ | ||
| public class CarInfoDBService { | ||
|
|
||
| private Storage carInfoStorage; | ||
| protected Logger log = LoggerFactory.getLogger(CarInfoDBService.class.getName()); | ||
|
|
||
| @Inject | ||
| public CarInfoDBService(@Named("CarInfoStorage") Storage carInfoStorage){ | ||
| this.carInfoStorage = carInfoStorage; | ||
| } | ||
|
|
||
| public void updateVin(byte[] version, Set<String> vinToAdd, Set<String> vinToRemove){ | ||
| log.debug("carInfoStorage updateVin"); | ||
| log.debug(" vinToAdd "+vinToAdd.size()); | ||
| log.debug(" vinToRemove "+vinToRemove.size()); | ||
| List<Pair<ByteArrayWrapper, ByteArrayWrapper>> toUpdate = new ArrayList<>(vinToAdd.size()); | ||
| List<ByteArrayWrapper> toRemove = new ArrayList<>(vinToRemove.size()); | ||
| vinToAdd.forEach(ele -> { | ||
| toUpdate.add(buildDBElement(ele)); | ||
| }); | ||
| vinToRemove.forEach(ele -> { | ||
| toRemove.add(buildDBElement(ele).getKey()); | ||
| }); | ||
| carInfoStorage.update(new ByteArrayWrapper(version), toUpdate, toRemove); | ||
| log.debug("carInfoStorage now contains: "+carInfoStorage.getAll().size()+" elements"); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Validate the given vehicle identification number against the db list and (optionally) the mempool transactions. | ||
| * @param vin the vehicle identification number to check | ||
| * @param memoryPool if not null, the vin is checked also against the mempool transactions | ||
| * @return true if the vin is valid (not already declared) | ||
| */ | ||
| public boolean validateVin(String vin, NodeMemoryPool memoryPool){ | ||
|
There was a problem hiding this comment. Inside the SDK we try to use Option/Optional wrappers to avoid passing PS: not mandatory. |
||
| if (carInfoStorage.get(buildDBElement(vin).getKey()).isPresent()){ | ||
| return false; | ||
| } | ||
| //in the vin is not found, and the mempool was provided, we check also there | ||
| if (memoryPool != null) { | ||
| for (BoxTransaction<Proposition, Box<Proposition>> transaction : memoryPool.getTransactions()) { | ||
| Set<String> vinInMempool = extractVinFromBoxes(transaction.newBoxes()); | ||
| if (vinInMempool.contains(vin)){ | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
| //if we arrive here, the vin is valid | ||
| return true; | ||
| } | ||
|
|
||
| public void rollback(byte[] version) { | ||
| carInfoStorage.rollback(new ByteArrayWrapper(version)); | ||
| } | ||
|
|
||
| /** | ||
| * Extracts the list of vehicle identification numbers (vin) declared in the given box list. | ||
| * The vin could be present inside two type of boxes: CarBox and CarSellOrderBox | ||
| */ | ||
| public Set<String> extractVinFromBoxes(List<Box<Proposition>> boxes){ | ||
| Set<String> vinList = new HashSet<String>(); | ||
| for (Box<Proposition> currentBox : boxes) { | ||
| if (CarBox.class.isAssignableFrom(currentBox.getClass())){ | ||
| String vin = CarBox.parseBytes(currentBox.bytes()).getVin(); | ||
| vinList.add(vin); | ||
| } else if (CarSellOrderBox.class.isAssignableFrom(currentBox.getClass())){ | ||
| String vin = CarSellOrderBox.parseBytes(currentBox.bytes()).getVin(); | ||
| vinList.add(vin); | ||
| } | ||
| } | ||
| return vinList; | ||
| } | ||
|
|
||
|
|
||
|
|
||
| private Pair<ByteArrayWrapper, ByteArrayWrapper> buildDBElement(String vin){ | ||
| //we use a fixed key size of 32, which is the default of iohk.iodb used as underline storage | ||
| ByteBuffer keyBuffer = ByteBuffer.allocate(32).put(vin.getBytes()); | ||
|
There was a problem hiding this comment. Instead of truncating the part of the string (in case if for some reason its byte representation is longer than 32) just use |
||
| ByteArrayWrapper keyWrapper = new ByteArrayWrapper(keyBuffer.array()); | ||
| //the value is not important (we need just a key set, each key is a vin) | ||
| ByteArrayWrapper valueWrapper = new ByteArrayWrapper(new byte[1]); | ||
| return new Pair<>(keyWrapper, valueWrapper); | ||
| } | ||
|
|
||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also check that there are no multiple transactions declaring the same
VINinside the block.In the
validatemethod below we only check the uniqueness against state.