Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Add a feature flag for token balances and token relationships and enable them #10638

Merged
merged 4 commits into from
Dec 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion hedera-node/configuration/dev/bootstrap.properties
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ tokens.nfts.useVirtualMerkle=true
accounts.blocklist.enabled=false
accounts.blocklist.path=

contracts.knownBlockHash=
contracts.knownBlockHash=
1 change: 1 addition & 0 deletions hedera-node/data/config/bootstrap.properties
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ tokens.nfts.useVirtualMerkle=true
records.useConsolidatedFcq=true
cache.cryptoTransfer.warmThreads=30
contracts.maxNumWithHapiSigsAccess=0
tokens.balancesInQueries.enabled=true
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,6 @@ public record TokensConfig(
@ConfigProperty(value = "nfts.useVirtualMerkle", defaultValue = "true") @NetworkProperty
boolean nftsUseVirtualMerkle,
@ConfigProperty(value = "autoCreations.isEnabled", defaultValue = "true") @NetworkProperty
boolean autoCreationsIsEnabled) {}
boolean autoCreationsIsEnabled,
@ConfigProperty(value = "balancesInQueries.enabled", defaultValue = "true") @NetworkProperty
boolean balancesInQueriesEnabled) {}
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,11 @@ private Optional<FileGetInfoResponse.FileInfo> getFileInfo(final FileID id) {
}

public Optional<CryptoGetInfoResponse.AccountInfo> infoForAccount(
final AccountID id, final AliasManager aliasManager, final RewardCalculator rewardCalculator) {
final AccountID id,
final AliasManager aliasManager,
final int maxTokensForAccountInfo,
final RewardCalculator rewardCalculator,
final boolean areTokenBalancesEnabledInQueries) {
final var accountNum = id.getAlias().isEmpty() ? fromAccountId(id) : aliasManager.lookupIdBy(id.getAlias());
final var account = accounts().get(accountNum);
if (account == null) {
Expand All @@ -418,6 +422,12 @@ public Optional<CryptoGetInfoResponse.AccountInfo> infoForAccount(
if (!isOfEvmAddressSize(account.getAlias())) {
info.setAlias(account.getAlias());
}
if (areTokenBalancesEnabledInQueries) {
final var tokenRels = tokenRels(this, account, maxTokensForAccountInfo);
if (!tokenRels.isEmpty()) {
info.addAllTokenRelationships(tokenRels);
}
}
info.setStakingInfo(stakingInfo(account, rewardCalculator));

return Optional.of(info.build());
Expand Down Expand Up @@ -539,7 +549,11 @@ public long numNftsOwnedBy(AccountID target) {
}

public Optional<ContractGetInfoResponse.ContractInfo> infoForContract(
final ContractID id, final AliasManager aliasManager, final RewardCalculator rewardCalculator) {
final ContractID id,
final AliasManager aliasManager,
final int maxTokensForAccountInfo,
final RewardCalculator rewardCalculator,
final boolean areTokenBalancesEnabledInQueries) {
final var contractId = EntityIdUtils.unaliased(id, aliasManager);
final var contract = contracts().get(contractId);
if (contract == null) {
Expand Down Expand Up @@ -568,6 +582,12 @@ public Optional<ContractGetInfoResponse.ContractInfo> infoForContract(
} else {
info.setContractAccountID(asHexedEvmAddress(mirrorId));
}
if (areTokenBalancesEnabledInQueries) {
final var tokenRels = tokenRels(this, contract, maxTokensForAccountInfo);
if (!tokenRels.isEmpty()) {
info.addAllTokenRelationships(tokenRels);
}
}
info.setStakingInfo(stakingInfo(contract, rewardCalculator));

try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,7 @@
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOKENS_NFTS_USE_TREASURY_WILD_CARDS;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOKENS_NFTS_USE_VIRTUAL_MERKLE;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOKENS_STORE_RELS_ON_DISK;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOKEN_BALANCES_ENABLED_IN_QUERIES;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOPICS_MAX_NUM;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TRACEABILITY_MAX_EXPORTS_PER_CONS_SEC;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TRACEABILITY_MIN_FREE_TO_USED_GAS_THROTTLE_RATIO;
Expand Down Expand Up @@ -569,7 +570,8 @@ public String getRawValue(final String name) {
TOKENS_AUTO_CREATIONS_ENABLED,
ACCOUNTS_BLOCKLIST_ENABLED,
ACCOUNTS_BLOCKLIST_PATH,
CACHE_CRYPTO_TRANSFER_WARM_THREADS);
CACHE_CRYPTO_TRANSFER_WARM_THREADS,
TOKEN_BALANCES_ENABLED_IN_QUERIES);

static final Set<String> NODE_PROPS = Set.of(
DEV_ONLY_DEFAULT_NODE_LISTENS,
Expand Down Expand Up @@ -826,5 +828,6 @@ public static Function<String, Object> transformFor(final String prop) {
entry(ACCOUNTS_BLOCKLIST_ENABLED, AS_BOOLEAN),
entry(ACCOUNTS_BLOCKLIST_PATH, AS_STRING),
entry(CACHE_CRYPTO_TRANSFER_WARM_THREADS, AS_INT),
entry(CONFIG_VERSION, AS_INT));
entry(CONFIG_VERSION, AS_INT),
entry(TOKEN_BALANCES_ENABLED_IN_QUERIES, AS_BOOLEAN));
}
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOKENS_NFTS_MAX_QUERY_RANGE;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOKENS_NFTS_MINT_THORTTLE_SCALE_FACTOR;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOKENS_NFTS_USE_TREASURY_WILDCARDS;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOKEN_BALANCES_ENABLED_IN_QUERIES;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TOPICS_MAX_NUM;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TRACEABILITY_MAX_EXPORTS_PER_CONS_SEC;
import static com.hedera.node.app.service.mono.context.properties.PropertyNames.TRACEABILITY_MIN_FREE_TO_USED_GAS_THROTTLE_RATIO;
Expand Down Expand Up @@ -303,6 +304,7 @@
private int sumOfConsensusWeights;
private int cacheWarmThreads;
private int configVersion;
private boolean tokenBalancesEnabledInQueries;

@Inject
public GlobalDynamicProperties(final HederaNumbers hederaNums, @CompositeProps final PropertySource properties) {
Expand Down Expand Up @@ -457,6 +459,7 @@
maxAutoAssociations = properties.getIntProperty(LEDGER_MAX_AUTO_ASSOCIATIONS);
sumOfConsensusWeights = properties.getIntProperty(STAKING_SUM_OF_CONSENSUS_WEIGHTS);
cacheWarmThreads = properties.getIntProperty(CACHE_CRYPTO_TRANSFER_WARM_THREADS);
tokenBalancesEnabledInQueries = properties.getBooleanProperty(TOKEN_BALANCES_ENABLED_IN_QUERIES);
}

public int sumOfConsensusWeights() {
Expand Down Expand Up @@ -992,4 +995,8 @@
public long stakingRewardBalanceThreshold() {
return stakingRewardBalanceThreshold;
}

public boolean areTokenBalancesEnabledInQueries() {
return tokenBalancesEnabledInQueries;

Check warning on line 1000 in hedera-node/hedera-mono-service/src/main/java/com/hedera/node/app/service/mono/context/properties/GlobalDynamicProperties.java

View check run for this annotation

Codecov / codecov/patch

hedera-node/hedera-mono-service/src/main/java/com/hedera/node/app/service/mono/context/properties/GlobalDynamicProperties.java#L1000

Added line #L1000 was not covered by tests
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ private PropertyNames() {
public static final String HEDERA_RECORD_STREAM_COMPRESS_FILES_ON_CREATION =
"hedera.recordStream.compressFilesOnCreation";
public static final String TOKENS_AUTO_CREATIONS_ENABLED = "tokens.autoCreations.isEnabled";
public static final String TOKEN_BALANCES_ENABLED_IN_QUERIES = "tokens.balancesInQueries.enabled";

/* ---- Node properties ----- */
public static final String DEV_ONLY_DEFAULT_NODE_LISTENS = "dev.onlyDefaultNodeListens";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,12 @@ public boolean applicableTo(final Query query) {
@Override
public FeeData usageGiven(final Query query, final StateView view, @Nullable final Map<String, Object> queryCtx) {
final var op = query.getContractGetInfo();
final var tentativeInfo = view.infoForContract(op.getContractID(), aliasManager, rewardCalculator);
final var tentativeInfo = view.infoForContract(
op.getContractID(),
aliasManager,
dynamicProperties.maxTokensRelsPerInfoQuery(),
rewardCalculator,
dynamicProperties.areTokenBalancesEnabledInQueries());
if (tentativeInfo.isPresent()) {
final var info = tentativeInfo.get();
putIfNotNull(queryCtx, CONTRACT_INFO_CTX_KEY, info);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.hedera.node.app.hapi.fees.usage.crypto.CryptoOpsUsage;
import com.hedera.node.app.hapi.fees.usage.crypto.ExtantCryptoContext;
import com.hedera.node.app.service.mono.context.primitives.StateView;
import com.hedera.node.app.service.mono.context.properties.GlobalDynamicProperties;
import com.hedera.node.app.service.mono.fees.calculation.QueryResourceUsageEstimator;
import com.hedera.node.app.service.mono.ledger.accounts.AliasManager;
import com.hedera.node.app.service.mono.ledger.accounts.staking.RewardCalculator;
Expand All @@ -36,15 +37,18 @@
public final class GetAccountInfoResourceUsage implements QueryResourceUsageEstimator {
private final CryptoOpsUsage cryptoOpsUsage;
private final AliasManager aliasManager;
private final GlobalDynamicProperties dynamicProperties;
private final RewardCalculator rewardCalculator;

@Inject
public GetAccountInfoResourceUsage(
final CryptoOpsUsage cryptoOpsUsage,
final AliasManager aliasManager,
final GlobalDynamicProperties dynamicProperties,
final RewardCalculator rewardCalculator) {
this.cryptoOpsUsage = cryptoOpsUsage;
this.aliasManager = aliasManager;
this.dynamicProperties = dynamicProperties;
this.rewardCalculator = rewardCalculator;
}

Expand All @@ -58,7 +62,12 @@ public FeeData usageGiven(final Query query, final StateView view, final Map<Str
final var op = query.getCryptoGetInfo();

final var account = op.getAccountID();
final var info = view.infoForAccount(account, aliasManager, rewardCalculator);
final var info = view.infoForAccount(
account,
aliasManager,
dynamicProperties.maxTokensRelsPerInfoQuery(),
rewardCalculator,
dynamicProperties.areTokenBalancesEnabledInQueries());
/* Given the test in {@code GetAccountInfoAnswer.checkValidity}, this can only be empty
* under the extraordinary circumstance that the desired account expired during the query
* answer flow (which will now fail downstream with an appropriate status code); so
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import static com.hederahashgraph.api.proto.java.ResponseType.COST_ANSWER;

import com.hedera.node.app.service.mono.context.primitives.StateView;
import com.hedera.node.app.service.mono.context.properties.GlobalDynamicProperties;
import com.hedera.node.app.service.mono.ledger.accounts.AliasManager;
import com.hedera.node.app.service.mono.ledger.accounts.staking.RewardCalculator;
import com.hedera.node.app.service.mono.queries.AnswerService;
Expand Down Expand Up @@ -53,13 +54,18 @@ public class GetContractInfoAnswer implements AnswerService {

private final AliasManager aliasManager;
private final OptionValidator validator;
private final GlobalDynamicProperties dynamicProperties;
private final RewardCalculator rewardCalculator;

@Inject
public GetContractInfoAnswer(
final AliasManager aliasManager, final OptionValidator validator, final RewardCalculator rewardCalculator) {
final AliasManager aliasManager,
final OptionValidator validator,
final GlobalDynamicProperties dynamicProperties,
final RewardCalculator rewardCalculator) {
this.aliasManager = aliasManager;
this.validator = validator;
this.dynamicProperties = dynamicProperties;
this.rewardCalculator = rewardCalculator;
}

Expand Down Expand Up @@ -153,7 +159,12 @@ private void setAnswerOnly(
response.setContractInfo((ContractGetInfoResponse.ContractInfo) ctx.get(CONTRACT_INFO_CTX_KEY));
}
} else {
final var info = view.infoForContract(op.getContractID(), aliasManager, rewardCalculator);
final var info = view.infoForContract(
op.getContractID(),
aliasManager,
dynamicProperties.maxTokensRelsPerInfoQuery(),
rewardCalculator,
dynamicProperties.areTokenBalancesEnabledInQueries());
if (info.isEmpty()) {
response.setHeader(answerOnlyHeader(INVALID_CONTRACT_ID));
} else {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@

package com.hedera.node.app.service.mono.queries.crypto;

import static com.hedera.node.app.service.mono.context.primitives.StateView.doBoundedIteration;
import static com.hedera.node.app.service.mono.utils.EntityIdUtils.asAccount;
import static com.hedera.node.app.service.mono.utils.EntityIdUtils.isAlias;
import static com.hederahashgraph.api.proto.java.HederaFunctionality.CryptoGetAccountBalance;
import static com.hederahashgraph.api.proto.java.ResponseCodeEnum.INVALID_ACCOUNT_ID;
import static com.hederahashgraph.api.proto.java.ResponseCodeEnum.OK;

import com.hedera.node.app.service.mono.context.primitives.StateView;
import com.hedera.node.app.service.mono.context.properties.GlobalDynamicProperties;
import com.hedera.node.app.service.mono.ledger.accounts.AliasManager;
import com.hedera.node.app.service.mono.queries.AnswerService;
import com.hedera.node.app.service.mono.state.migration.AccountStorageAdapter;
Expand All @@ -37,6 +39,7 @@
import com.hederahashgraph.api.proto.java.Query;
import com.hederahashgraph.api.proto.java.Response;
import com.hederahashgraph.api.proto.java.ResponseCodeEnum;
import com.hederahashgraph.api.proto.java.TokenBalance;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.util.Objects;
import java.util.Optional;
Expand All @@ -51,11 +54,16 @@
public class GetAccountBalanceAnswer implements AnswerService {
private final AliasManager aliasManager;
private final OptionValidator optionValidator;
private final GlobalDynamicProperties dynamicProperties;

@Inject
public GetAccountBalanceAnswer(final AliasManager aliasManager, final OptionValidator optionValidator) {
public GetAccountBalanceAnswer(
final AliasManager aliasManager,
final OptionValidator optionValidator,
final GlobalDynamicProperties dynamicProperties) {
this.aliasManager = aliasManager;
this.optionValidator = optionValidator;
this.dynamicProperties = dynamicProperties;
}

@Override
Expand Down Expand Up @@ -90,6 +98,20 @@ public Response responseGiven(
final var key = EntityNum.fromAccountId(id);
final var account = accounts.get(key);
opAnswer.setBalance(account.getBalance());
if (dynamicProperties.areTokenBalancesEnabledInQueries()) {
final var maxRels = dynamicProperties.maxTokensRelsPerInfoQuery();
final var firstRel = account.getLatestAssociation();
doBoundedIteration(
view.tokenAssociations(),
view.tokens(),
firstRel,
maxRels,
(token, rel) -> opAnswer.addTokenBalances(TokenBalance.newBuilder()
.setTokenId(token.grpcId())
.setDecimals(token.decimals())
.setBalance(rel.getBalance())
.build()));
}
}

return Response.newBuilder().setCryptogetAccountBalance(opAnswer).build();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import static com.hederahashgraph.api.proto.java.ResponseType.COST_ANSWER;

import com.hedera.node.app.service.mono.context.primitives.StateView;
import com.hedera.node.app.service.mono.context.properties.GlobalDynamicProperties;
import com.hedera.node.app.service.mono.ledger.accounts.AliasManager;
import com.hedera.node.app.service.mono.ledger.accounts.staking.RewardCalculator;
import com.hedera.node.app.service.mono.queries.AnswerService;
Expand Down Expand Up @@ -52,14 +53,17 @@ public class GetAccountInfoAnswer implements AnswerService {
private final OptionValidator optionValidator;
private final AliasManager aliasManager;
private final RewardCalculator rewardCalculator;
private final GlobalDynamicProperties dynamicProperties;

@Inject
public GetAccountInfoAnswer(
final OptionValidator optionValidator,
final AliasManager aliasManager,
final GlobalDynamicProperties dynamicProperties,
final RewardCalculator rewardCalculator) {
this.optionValidator = optionValidator;
this.aliasManager = aliasManager;
this.dynamicProperties = dynamicProperties;
this.rewardCalculator = rewardCalculator;
}

Expand All @@ -85,8 +89,13 @@ public Response responseGiven(
response.setHeader(costAnswerHeader(OK, cost));
} else {
final AccountID id = op.getAccountID();
final var optionalInfo =
Objects.requireNonNull(view).infoForAccount(id, aliasManager, rewardCalculator);
final var optionalInfo = Objects.requireNonNull(view)
.infoForAccount(
id,
aliasManager,
dynamicProperties.maxTokensRelsPerInfoQuery(),
rewardCalculator,
dynamicProperties.areTokenBalancesEnabledInQueries());
if (optionalInfo.isPresent()) {
response.setHeader(answerOnlyHeader(OK));
response.setAccountInfo(optionalInfo.get());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -229,3 +229,4 @@ accounts.blocklist.path=
staking.sumOfConsensusWeights=500
cache.cryptoTransfer.warmThreads=30
hedera.config.version=0
tokens.balancesInQueries.enabled=true
Loading
Loading