com.hedera.node.app.service.token.impl.handlers.TokenRevokeKycFromAccountHandler 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
Show all versions of app-service-token-impl Show documentation
Default Hedera Token Service Implementation
/*
* 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.handlers;
import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_ACCOUNT_ID;
import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_TOKEN_ID;
import static com.hedera.hapi.node.base.ResponseCodeEnum.TOKEN_HAS_NO_KYC_KEY;
import static com.hedera.node.app.hapi.fees.usage.crypto.CryptoOpsUsage.txnEstimateFactory;
import static com.hedera.node.app.service.mono.pbj.PbjConverter.fromPbj;
import static java.util.Objects.requireNonNull;
import com.hedera.hapi.node.base.AccountID;
import com.hedera.hapi.node.base.HederaFunctionality;
import com.hedera.hapi.node.base.ResponseCodeEnum;
import com.hedera.hapi.node.base.SubType;
import com.hedera.hapi.node.base.TokenID;
import com.hedera.hapi.node.state.token.TokenRelation;
import com.hedera.hapi.node.transaction.TransactionBody;
import com.hedera.node.app.service.mono.fees.calculation.token.txns.TokenRevokeKycResourceUsage;
import com.hedera.node.app.service.token.ReadableAccountStore;
import com.hedera.node.app.service.token.ReadableTokenStore;
import com.hedera.node.app.service.token.impl.WritableTokenRelationStore;
import com.hedera.node.app.service.token.impl.util.TokenHandlerHelper;
import com.hedera.node.app.spi.fees.FeeContext;
import com.hedera.node.app.spi.fees.Fees;
import com.hedera.node.app.spi.validation.ExpiryValidator;
import com.hedera.node.app.spi.workflows.HandleContext;
import com.hedera.node.app.spi.workflows.HandleException;
import com.hedera.node.app.spi.workflows.PreCheckException;
import com.hedera.node.app.spi.workflows.PreHandleContext;
import com.hedera.node.app.spi.workflows.TransactionHandler;
import edu.umd.cs.findbugs.annotations.NonNull;
import javax.inject.Inject;
import javax.inject.Singleton;
/**
* This class contains all workflow-related functionality regarding {@link
* HederaFunctionality#TOKEN_REVOKE_KYC_FROM_ACCOUNT}.
*/
@Singleton
public class TokenRevokeKycFromAccountHandler implements TransactionHandler {
/**
* Default constructor for injection.
*/
@Inject
public TokenRevokeKycFromAccountHandler() {
// No-op
}
/**
* This method is called during the pre-handle workflow.
*
* @param context the {@link PreHandleContext} which collects all information
* @throws PreCheckException for invalid tokens or if the token has no KYC key
* @throws NullPointerException if one of the arguments is {@code null}
*/
@Override
public void preHandle(@NonNull final PreHandleContext context) throws PreCheckException {
requireNonNull(context);
pureChecks(context.body());
final var op = context.body().tokenRevokeKycOrThrow();
final var tokenStore = context.createStore(ReadableTokenStore.class);
final var tokenMeta = tokenStore.getTokenMeta(op.tokenOrElse(TokenID.DEFAULT));
if (tokenMeta == null) throw new PreCheckException(INVALID_TOKEN_ID);
if (tokenMeta.hasKycKey()) {
context.requireKey(tokenMeta.kycKey());
} else {
throw new PreCheckException(TOKEN_HAS_NO_KYC_KEY);
}
}
/**
* This method is called during the handle workflow. It executes the actual transaction.
*
* @param handleContext the {@link HandleContext} of the transaction
* @throws NullPointerException if one of the arguments is {@code null}
*/
public void handle(@NonNull final HandleContext handleContext) {
requireNonNull(handleContext);
final var op = handleContext.body().tokenRevokeKycOrThrow();
final var tokenId = op.tokenOrThrow();
final var accountId = op.accountOrElse(AccountID.DEFAULT);
final var tokenRelStore = handleContext.writableStore(WritableTokenRelationStore.class);
final var accountStore = handleContext.readableStore(ReadableAccountStore.class);
final var expiryValidator = handleContext.expiryValidator();
final var tokenStore = handleContext.readableStore(ReadableTokenStore.class);
final var tokenRel =
validateSemantics(accountId, tokenId, tokenRelStore, accountStore, expiryValidator, tokenStore);
final var tokenRelBuilder = tokenRel.copyBuilder();
tokenRelBuilder.kycGranted(false);
tokenRelStore.put(tokenRelBuilder.build());
}
/**
* Performs checks independent of state or context
*/
@Override
public void pureChecks(@NonNull final TransactionBody txn) throws PreCheckException {
final var op = txn.tokenRevokeKycOrThrow();
if (!op.hasToken()) {
throw new PreCheckException(INVALID_TOKEN_ID);
}
if (!op.hasAccount()) {
throw new PreCheckException(ResponseCodeEnum.INVALID_ACCOUNT_ID);
}
}
/**
* Performs checks that the entities related to this transaction exist and are valid
*
* @return the token relation for the given token and account
*/
@NonNull
private TokenRelation validateSemantics(
@NonNull final AccountID accountId,
@NonNull final TokenID tokenId,
@NonNull final WritableTokenRelationStore tokenRelStore,
@NonNull final ReadableAccountStore accountStore,
@NonNull final ExpiryValidator expiryValidator,
@NonNull final ReadableTokenStore tokenStore)
throws HandleException {
final var account =
TokenHandlerHelper.getIfUsable(accountId, accountStore, expiryValidator, INVALID_ACCOUNT_ID);
final var token = TokenHandlerHelper.getIfUsable(tokenId, tokenStore);
final var tokenRel = TokenHandlerHelper.getIfUsable(accountId, tokenId, tokenRelStore);
// Validate token is not paused or deleted
TokenHandlerHelper.getIfUsable(tokenId, tokenStore);
return tokenRel;
}
@NonNull
@Override
public Fees calculateFees(@NonNull final FeeContext feeContext) {
requireNonNull(feeContext);
final var op = feeContext.body();
return feeContext.feeCalculator(SubType.DEFAULT).legacyCalculate(sigValueObj -> new TokenRevokeKycResourceUsage(
txnEstimateFactory)
.usageGiven(fromPbj(op), sigValueObj, null));
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy