com.hedera.node.app.spi.fees.FeeContext Maven / Gradle / Ivy
/*
* Copyright (C) 2023-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.spi.fees;
import com.hedera.hapi.node.base.AccountID;
import com.hedera.hapi.node.base.SubType;
import com.hedera.hapi.node.transaction.TransactionBody;
import com.hedera.node.app.spi.authorization.Authorizer;
import com.swirlds.config.api.Configuration;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
public interface FeeContext {
/**
* Gets the payer {@link AccountID} whose expiration time will be "inherited"
* by account-scoped properties like allowances.
*
* @return the {@link AccountID} of the payer in this context
*/
@NonNull
AccountID payer();
/**
* Returns the {@link TransactionBody}
*
* @return the {@code TransactionBody}
*/
@NonNull
TransactionBody body();
/**
* Get a calculator for calculating fees for the current transaction, and its {@link SubType}. Most transactions
* just use {@link SubType#DEFAULT}, but some (such as crypto transfer) need to be more specific.
*
* @param subType The {@link SubType} of the transaction.
* @return The {@link FeeCalculator} to use.
*/
@NonNull
FeeCalculator feeCalculator(@NonNull final SubType subType);
/**
* Get a readable store given the store's interface. This gives read-only access to the store.
*
* @param storeInterface The store interface to find and create a store for
* @param Interface class for a Store
* @return An implementation of the provided store interface
* @throws IllegalArgumentException if the storeInterface class provided is unknown to the app
* @throws NullPointerException if {@code storeInterface} is {@code null}
*/
@NonNull
T readableStore(@NonNull Class storeInterface);
/**
* Returns the current {@link Configuration} for the node.
*
* @return the {@code Configuration}
*/
@Nullable
Configuration configuration();
/**
* @return the {@code Authorizer}
*/
@Nullable
Authorizer authorizer();
/**
* Returns the number of signatures provided for the transaction.
* NOTE: this property should not be used for queries
* @return the number of signatures
*/
int numTxnSignatures();
}