com.hedera.node.app.service.token.impl.util.PendingAirdropUpdater Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of app-service-token-impl Show documentation
Default Hedera Token Service Implementation
There is a newer version: 0.57.3
Show newest version
/*
 * Copyright (C) 2024 Hedera Hashgraph, LLC
 *
 * 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.
 */

package com.hedera.node.app.service.token.impl.util;

import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_PENDING_AIRDROP_ID;
import static com.hedera.node.app.spi.workflows.HandleException.validateTrue;

import com.hedera.hapi.node.base.PendingAirdropId;
import com.hedera.node.app.service.token.impl.WritableAccountStore;
import com.hedera.node.app.service.token.impl.WritableAirdropStore;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.List;
import javax.inject.Inject;
import javax.inject.Singleton;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

/**
 * Class that computes the expected results of a pending airdrops removal and then commit the needed changes.
 * This way it will save several state updates of pending airdrop's linked list pointers {@code previousAirdrop()}
 * and {@code nextAirdrop()}, also sender's account updates of {@code headPendingAirdropId()} and
 * {@code numberPendingAirdrops()}
 */
@Singleton
public class PendingAirdropUpdater {
    private static final Logger log = LogManager.getLogger(PendingAirdropUpdater.class);

    @Inject
    public PendingAirdropUpdater() {}

    /**
     * Removes provided pending airdrops from the state.
     * Updates sender accounts ({@code headPendingAirdropId()} and {@code numberPendingAirdrops()}).
     * Update neighbour pending airdrops linked list pointers ({@code previousAirdrop()} and {@code nextAirdrop()}).
     *
     * @param airdropsToRemove list of PendingAirdropId to be removed
     */
    public void removePendingAirdrops(
            @NonNull final List airdropsToRemove,
            @NonNull final WritableAirdropStore pendingAirdropStore,
            @NonNull final WritableAccountStore accountStore) {
        for (final var id : airdropsToRemove) {
            removePendingAirdrops(id, pendingAirdropStore, accountStore);
        }
    }

    /**
     * Removes the given airdrop from the given stores, including updating the prev/next pointers.
     *
     * @param airdropId pending airdrop to remove
     * @param pendingAirdropStore store containing the pending airdrop
     * @param accountStore store containing the account
     */
    private void removePendingAirdrops(
            @NonNull final PendingAirdropId airdropId,
            @NonNull final WritableAirdropStore pendingAirdropStore,
            @NonNull final WritableAccountStore accountStore) {
        final var airdrop = pendingAirdropStore.getForModify(airdropId);
        validateTrue(airdrop != null, INVALID_PENDING_AIRDROP_ID);

        // update pending airdrops links
        final var prevAirdropId = airdrop.previousAirdrop();
        final var nextAirdropId = airdrop.nextAirdrop();
        if (prevAirdropId != null) {
            final var prevAirdrop = pendingAirdropStore.getForModify(prevAirdropId);
            if (prevAirdrop == null) {
                log.error("Failed to find pending airdrop with id {}", prevAirdropId);
            } else {
                final var updatedAirdrop =
                        prevAirdrop.copyBuilder().nextAirdrop(nextAirdropId).build();
                pendingAirdropStore.put(prevAirdropId, updatedAirdrop);
            }
        }
        if (nextAirdropId != null) {
            final var nextAirdrop = pendingAirdropStore.getForModify(nextAirdropId);
            if (nextAirdrop == null) {
                log.error("Failed to find pending airdrop with id {}", nextAirdropId);
            } else {
                final var updatedAirdrop =
                        nextAirdrop.copyBuilder().previousAirdrop(prevAirdropId).build();
                pendingAirdropStore.put(nextAirdropId, updatedAirdrop);
            }
        }
        final var senderAccount = accountStore.getAccountById(airdropId.senderIdOrThrow());
        if (senderAccount == null) {
            log.error("Failed to find sender account with id {}", airdropId.senderIdOrThrow());
        } else {
            final var updatedSender =
                    senderAccount.copyBuilder().numberPendingAirdrops(senderAccount.numberPendingAirdrops() - 1);
            if (airdropId.equals(senderAccount.headPendingAirdropId())) {
                updatedSender.headPendingAirdropId(airdrop.nextAirdrop());
            }
            accountStore.put(updatedSender.build());
        }
        pendingAirdropStore.remove(airdropId);
    }
}