forked from hyperledger/besu
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce variables storage (hyperledger#5471)
Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>
- Loading branch information
Showing
31 changed files
with
1,177 additions
and
169 deletions.
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
172 changes: 172 additions & 0 deletions
172
besu/src/main/java/org/hyperledger/besu/cli/subcommands/storage/StorageSubCommand.java
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,172 @@ | ||
| /* | ||
| * Copyright Hyperledger Besu Contributors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| package org.hyperledger.besu.cli.subcommands.storage; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkNotNull; | ||
| import static org.hyperledger.besu.cli.subcommands.storage.StorageSubCommand.COMMAND_NAME; | ||
| import static org.hyperledger.besu.ethereum.chain.VariablesStorage.Keys.CHAIN_HEAD_HASH; | ||
| import static org.hyperledger.besu.ethereum.chain.VariablesStorage.Keys.FINALIZED_BLOCK_HASH; | ||
| import static org.hyperledger.besu.ethereum.chain.VariablesStorage.Keys.FORK_HEADS; | ||
| import static org.hyperledger.besu.ethereum.chain.VariablesStorage.Keys.SAFE_BLOCK_HASH; | ||
| import static org.hyperledger.besu.ethereum.chain.VariablesStorage.Keys.SEQ_NO_STORE; | ||
|
|
||
| import org.hyperledger.besu.cli.BesuCommand; | ||
| import org.hyperledger.besu.cli.util.VersionProvider; | ||
| import org.hyperledger.besu.ethereum.rlp.RLP; | ||
| import org.hyperledger.besu.ethereum.storage.StorageProvider; | ||
| import org.hyperledger.besu.ethereum.storage.keyvalue.KeyValueSegmentIdentifier; | ||
| import org.hyperledger.besu.plugin.services.storage.KeyValueStorageTransaction; | ||
|
|
||
| import java.io.PrintWriter; | ||
|
|
||
| import org.apache.tuweni.bytes.Bytes; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import picocli.CommandLine.Command; | ||
| import picocli.CommandLine.Model.CommandSpec; | ||
| import picocli.CommandLine.ParentCommand; | ||
| import picocli.CommandLine.Spec; | ||
|
|
||
| /** The Storage sub command. */ | ||
| @Command( | ||
| name = COMMAND_NAME, | ||
| description = "This command provides storage related actions.", | ||
| mixinStandardHelpOptions = true, | ||
| versionProvider = VersionProvider.class, | ||
| subcommands = {StorageSubCommand.RevertVariablesStorage.class}) | ||
| public class StorageSubCommand implements Runnable { | ||
|
|
||
| /** The constant COMMAND_NAME. */ | ||
| public static final String COMMAND_NAME = "storage"; | ||
|
|
||
| @SuppressWarnings("unused") | ||
| @ParentCommand | ||
| private BesuCommand parentCommand; | ||
|
|
||
| @SuppressWarnings("unused") | ||
| @Spec | ||
| private CommandSpec spec; | ||
|
|
||
| private final PrintWriter out; | ||
|
|
||
| /** | ||
| * Instantiates a new Storage sub command. | ||
| * | ||
| * @param out The PrintWriter where the usage will be reported. | ||
| */ | ||
| public StorageSubCommand(final PrintWriter out) { | ||
| this.out = out; | ||
| } | ||
|
|
||
| @Override | ||
| public void run() { | ||
| spec.commandLine().usage(out); | ||
| } | ||
|
|
||
| /** The Hash sub command for password. */ | ||
| @Command( | ||
| name = "revert-variables", | ||
| description = "This command revert the modifications done by the variables storage feature.", | ||
| mixinStandardHelpOptions = true, | ||
| versionProvider = VersionProvider.class) | ||
| static class RevertVariablesStorage implements Runnable { | ||
| private static final Logger LOG = LoggerFactory.getLogger(RevertVariablesStorage.class); | ||
| private static final Bytes VARIABLES_PREFIX = Bytes.of(1); | ||
|
|
||
| @SuppressWarnings("unused") | ||
| @ParentCommand | ||
| private StorageSubCommand parentCommand; | ||
|
|
||
| @Override | ||
| public void run() { | ||
| checkNotNull(parentCommand); | ||
|
|
||
| final var storageProvider = getStorageProvider(); | ||
|
|
||
| revert(storageProvider); | ||
| } | ||
|
|
||
| private StorageProvider getStorageProvider() { | ||
| return parentCommand.parentCommand.getStorageProvider(); | ||
| } | ||
|
|
||
| private void revert(final StorageProvider storageProvider) { | ||
| final var variablesStorage = storageProvider.createVariablesStorage(); | ||
| final var blockchainStorage = | ||
| getStorageProvider().getStorageBySegmentIdentifier(KeyValueSegmentIdentifier.BLOCKCHAIN); | ||
| final var blockchainUpdater = blockchainStorage.startTransaction(); | ||
| final var variablesUpdater = variablesStorage.updater(); | ||
|
|
||
| variablesStorage | ||
| .getChainHead() | ||
| .ifPresent( | ||
| v -> { | ||
| setBlockchainVariable( | ||
| blockchainUpdater, VARIABLES_PREFIX, CHAIN_HEAD_HASH.getBytes(), v); | ||
| LOG.info("Reverted variable storage for key {}", CHAIN_HEAD_HASH); | ||
| }); | ||
|
|
||
| variablesStorage | ||
| .getFinalized() | ||
| .ifPresent( | ||
| v -> { | ||
| setBlockchainVariable( | ||
| blockchainUpdater, VARIABLES_PREFIX, FINALIZED_BLOCK_HASH.getBytes(), v); | ||
| LOG.info("Reverted variable storage for key {}", FINALIZED_BLOCK_HASH); | ||
| }); | ||
|
|
||
| variablesStorage | ||
| .getSafeBlock() | ||
| .ifPresent( | ||
| v -> { | ||
| setBlockchainVariable( | ||
| blockchainUpdater, VARIABLES_PREFIX, SAFE_BLOCK_HASH.getBytes(), v); | ||
| LOG.info("Reverted variable storage for key {}", SAFE_BLOCK_HASH); | ||
| }); | ||
|
|
||
| final var forkHeads = variablesStorage.getForkHeads(); | ||
| if (!forkHeads.isEmpty()) { | ||
| setBlockchainVariable( | ||
| blockchainUpdater, | ||
| VARIABLES_PREFIX, | ||
| FORK_HEADS.getBytes(), | ||
| RLP.encode(o -> o.writeList(forkHeads, (val, out) -> out.writeBytes(val)))); | ||
| LOG.info("Reverted variable storage for key {}", FORK_HEADS); | ||
| } | ||
|
|
||
| variablesStorage | ||
| .getLocalEnrSeqno() | ||
| .ifPresent( | ||
| v -> { | ||
| setBlockchainVariable(blockchainUpdater, Bytes.EMPTY, SEQ_NO_STORE.getBytes(), v); | ||
| LOG.info("Reverted variable storage for key {}", SEQ_NO_STORE); | ||
| }); | ||
|
|
||
| variablesUpdater.removeAll(); | ||
|
|
||
| variablesUpdater.commit(); | ||
| blockchainUpdater.commit(); | ||
| } | ||
|
|
||
| private void setBlockchainVariable( | ||
| final KeyValueStorageTransaction blockchainTransaction, | ||
| final Bytes prefix, | ||
| final Bytes key, | ||
| final Bytes value) { | ||
| blockchainTransaction.put( | ||
| Bytes.concatenate(prefix, key).toArrayUnsafe(), value.toArrayUnsafe()); | ||
| } | ||
| } | ||
| } |
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
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
Oops, something went wrong.