PendingTransactionsForSender.java

/*
 * Copyright 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.ethereum.eth.transactions.sorter;

import org.hyperledger.besu.ethereum.eth.transactions.PendingTransaction;
import org.hyperledger.besu.evm.account.Account;

import java.util.List;
import java.util.Map;
import java.util.NavigableMap;
import java.util.Optional;
import java.util.OptionalLong;
import java.util.TreeMap;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public class PendingTransactionsForSender {
  private final NavigableMap<Long, PendingTransaction> pendingTransactions;
  private OptionalLong nextGap = OptionalLong.empty();

  private Optional<Account> maybeSenderAccount;

  public PendingTransactionsForSender(final Optional<Account> maybeSenderAccount) {
    this.pendingTransactions = new TreeMap<>();
    this.maybeSenderAccount = maybeSenderAccount;
  }

  public void trackPendingTransaction(final PendingTransaction pendingTransaction) {
    final long nonce = pendingTransaction.getNonce();
    synchronized (pendingTransactions) {
      if (!pendingTransactions.isEmpty()) {
        final long expectedNext = pendingTransactions.lastKey() + 1;
        if (Long.compareUnsigned(nonce, expectedNext) > 0 && nextGap.isEmpty()) {
          nextGap = OptionalLong.of(expectedNext);
        }
      }
      pendingTransactions.put(nonce, pendingTransaction);
      if (nonce == nextGap.orElse(-1)) {
        findGap();
      }
    }
  }

  public void removeTrackedPendingTransaction(final PendingTransaction pendingTransaction) {
    // check the value when removing, because it could have been replaced
    if (pendingTransactions.remove(pendingTransaction.getNonce(), pendingTransaction)) {
      synchronized (pendingTransactions) {
        if (!pendingTransactions.isEmpty()
            && pendingTransaction.getNonce() != pendingTransactions.firstKey()) {
          findGap();
        }
      }
    }
  }

  public void updateSenderAccount(final Optional<Account> maybeSenderAccount) {
    this.maybeSenderAccount = maybeSenderAccount;
  }

  public long getSenderAccountNonce() {
    return maybeSenderAccount.map(Account::getNonce).orElse(0L);
  }

  public Optional<Account> getSenderAccount() {
    return maybeSenderAccount;
  }

  private void findGap() {
    // find first gap
    long expectedValue = pendingTransactions.firstKey();
    for (final Long nonce : pendingTransactions.keySet()) {
      if (expectedValue == nonce) {
        // no gap, keep moving
        expectedValue++;
      } else {
        nextGap = OptionalLong.of(expectedValue);
        return;
      }
    }
    nextGap = OptionalLong.empty();
  }

  public OptionalLong maybeNextNonce() {
    if (pendingTransactions.isEmpty()) {
      return OptionalLong.empty();
    } else {
      return nextGap.isEmpty() ? OptionalLong.of(pendingTransactions.lastKey() + 1) : nextGap;
    }
  }

  public Optional<PendingTransaction> maybeLastPendingTransaction() {
    return Optional.ofNullable(pendingTransactions.lastEntry()).map(Map.Entry::getValue);
  }

  public int transactionCount() {
    return pendingTransactions.size();
  }

  public List<PendingTransaction> getPendingTransactions(final long startingNonce) {
    return List.copyOf(pendingTransactions.tailMap(startingNonce).values());
  }

  public Stream<PendingTransaction> streamPendingTransactions() {
    return pendingTransactions.values().stream();
  }

  public PendingTransaction getPendingTransactionForNonce(final long nonce) {
    return pendingTransactions.get(nonce);
  }

  public String toTraceLog() {
    return "{"
        + "senderAccount "
        + maybeSenderAccount
        + ", pendingTransactions "
        + pendingTransactions.entrySet().stream()
            .map(e -> "(" + e.getKey() + ")" + e.getValue().toTraceLog())
            .collect(Collectors.joining("; "))
        + ", nextGap "
        + nextGap
        + '}';
  }
}