com.hedera.node.app.service.token.impl.ReadableTokenRelationStoreImpl 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.56.6

Show newest version

/*
 * Copyright (C) 2022-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;

import static java.util.Objects.requireNonNull;

import com.hedera.hapi.node.base.AccountID;
import com.hedera.hapi.node.base.TokenID;
import com.hedera.hapi.node.state.common.EntityIDPair;
import com.hedera.hapi.node.state.token.TokenRelation;
import com.hedera.node.app.service.token.ReadableTokenRelationStore;
import com.hedera.node.app.service.token.impl.schemas.V0490TokenSchema;
import com.swirlds.state.spi.ReadableKVState;
import com.swirlds.state.spi.ReadableStates;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

/**
 * Provides read-only methods for getting underlying data for working with TokenRelations.
 *
 * This class is not exported from the module. It is an internal implementation detail.
 */
public class ReadableTokenRelationStoreImpl implements ReadableTokenRelationStore {
    /** The underlying data storage class that holds the token data. */
    private final ReadableKVState readableTokenRelState;

    /**
     * Create a new {@link ReadableTokenRelationStoreImpl} instance.
     *
     * @param states The state to use.
     */
    public ReadableTokenRelationStoreImpl(@NonNull final ReadableStates states) {
        this.readableTokenRelState = requireNonNull(states).get(V0490TokenSchema.TOKEN_RELS_KEY);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    @Nullable
    public TokenRelation get(@NonNull final AccountID accountId, @NonNull final TokenID tokenId) {
        requireNonNull(accountId);
        requireNonNull(tokenId);

        if (AccountID.DEFAULT.equals(accountId) || TokenID.DEFAULT.equals(tokenId)) return null;

        return readableTokenRelState.get(
                EntityIDPair.newBuilder().accountId(accountId).tokenId(tokenId).build());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public long sizeOfState() {
        return readableTokenRelState.size();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void warm(@NonNull final AccountID accountID, @NonNull final TokenID tokenId) {
        final EntityIDPair key =
                EntityIDPair.newBuilder().accountId(accountID).tokenId(tokenId).build();
        readableTokenRelState.warm(key);
    }
}