GetTrieNodeFromPeerTask.java

/*
 * Copyright contributors to Hyperledger Besu
 *
 * 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.ethereum.eth.manager.snap;

import static java.util.Collections.emptyMap;
import static org.slf4j.LoggerFactory.getLogger;

import org.hyperledger.besu.ethereum.core.BlockHeader;
import org.hyperledger.besu.ethereum.eth.manager.EthContext;
import org.hyperledger.besu.ethereum.eth.manager.EthPeer;
import org.hyperledger.besu.ethereum.eth.manager.PendingPeerRequest;
import org.hyperledger.besu.ethereum.eth.manager.task.AbstractPeerRequestTask;
import org.hyperledger.besu.ethereum.eth.messages.snap.SnapV1;
import org.hyperledger.besu.ethereum.eth.messages.snap.TrieNodesMessage;
import org.hyperledger.besu.ethereum.p2p.rlpx.wire.MessageData;
import org.hyperledger.besu.plugin.services.MetricsSystem;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;

import com.google.common.collect.Lists;
import kotlin.collections.ArrayDeque;
import org.apache.tuweni.bytes.Bytes;
import org.slf4j.Logger;

public class GetTrieNodeFromPeerTask extends AbstractPeerRequestTask<Map<Bytes, Bytes>> {

  private static final Logger LOG = getLogger(GetTrieNodeFromPeerTask.class);

  private final List<List<Bytes>> paths;
  private final BlockHeader blockHeader;

  private GetTrieNodeFromPeerTask(
      final EthContext ethContext,
      final List<List<Bytes>> paths,
      final BlockHeader blockHeader,
      final MetricsSystem metricsSystem) {
    super(ethContext, SnapV1.TRIE_NODES, metricsSystem);
    this.paths = paths;
    this.blockHeader = blockHeader;
  }

  public static GetTrieNodeFromPeerTask forTrieNodes(
      final EthContext ethContext,
      final Map<Bytes, List<Bytes>> paths,
      final BlockHeader blockHeader,
      final MetricsSystem metricsSystem) {
    return new GetTrieNodeFromPeerTask(
        ethContext,
        paths.entrySet().stream()
            .map(entry -> Lists.asList(entry.getKey(), entry.getValue().toArray(new Bytes[0])))
            .collect(Collectors.toList()),
        blockHeader,
        metricsSystem);
  }

  @Override
  protected PendingPeerRequest sendRequest() {
    return sendRequestToPeer(
        peer -> {
          LOG.trace("Requesting {} trie nodes from peer {}", paths.size(), peer);
          return peer.getSnapTrieNode(blockHeader.getStateRoot(), paths);
        },
        blockHeader.getNumber());
  }

  @Override
  protected Optional<Map<Bytes, Bytes>> processResponse(
      final boolean streamClosed, final MessageData message, final EthPeer peer) {
    if (streamClosed) {
      // We don't record this as a useless response because it's impossible to know if a peer has
      // the data we're requesting.
      return Optional.of(emptyMap());
    }
    final TrieNodesMessage trieNodes = TrieNodesMessage.readFrom(message);
    final ArrayDeque<Bytes> nodes = trieNodes.nodes(true);
    return mapNodeDataByPath(nodes);
  }

  private Optional<Map<Bytes, Bytes>> mapNodeDataByPath(final ArrayDeque<Bytes> nodeData) {
    final Map<Bytes, Bytes> nodeDataByPath = new HashMap<>();
    paths.forEach(
        list -> {
          int i = 1;
          if (!nodeData.isEmpty() && i == list.size()) {
            Bytes bytes = nodeData.removeFirst();
            nodeDataByPath.put(list.get(0), bytes);
          } else {
            while (!nodeData.isEmpty() && i < list.size()) {
              Bytes bytes = nodeData.removeFirst();
              nodeDataByPath.put(Bytes.concatenate(list.get(0), list.get(i)), bytes);
              i++;
            }
          }
        });
    return Optional.of(nodeDataByPath);
  }
}