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 ContractUpdateSuite and address ContractUpdateHandle comments #9847

Merged
Merged
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_AUTORENEW_ACCOUNT;
import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_CONTRACT_ID;
import static com.hedera.hapi.node.base.ResponseCodeEnum.MODIFYING_IMMUTABLE_CONTRACT;
import static com.hedera.hapi.node.base.ResponseCodeEnum.NOT_SUPPORTED;
import static com.hedera.hapi.node.base.ResponseCodeEnum.REQUESTED_NUM_AUTOMATIC_ASSOCIATIONS_EXCEEDS_ASSOCIATION_LIMIT;
import static com.hedera.node.app.service.token.api.AccountSummariesApi.SENTINEL_ACCOUNT_ID;
import static com.hedera.node.app.spi.HapiUtils.EMPTY_KEY_LIST;
Expand All @@ -34,7 +35,7 @@
import com.hedera.hapi.node.base.AccountID;
import com.hedera.hapi.node.base.ContractID;
import com.hedera.hapi.node.base.HederaFunctionality;
import com.hedera.hapi.node.base.Key.KeyOneOfType;
import com.hedera.hapi.node.base.Key;
import com.hedera.hapi.node.contract.ContractUpdateTransactionBody;
import com.hedera.hapi.node.state.token.Account;
import com.hedera.node.app.service.token.ReadableAccountStore;
Expand All @@ -46,8 +47,10 @@
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 com.hedera.node.config.data.ContractsConfig;
import com.hedera.node.config.data.EntitiesConfig;
import com.hedera.node.config.data.LedgerConfig;
import com.hedera.node.config.data.StakingConfig;
import com.hedera.node.config.data.TokensConfig;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Optional;
Expand Down Expand Up @@ -102,12 +105,112 @@ public void handle(@NonNull final HandleContext context) throws HandleException

final var accountStore = context.readableStore(ReadableAccountStore.class);
final var toBeUpdated = accountStore.getContractById(target);
validateSemantics(toBeUpdated, context, op);
validateSemantics(toBeUpdated, context, op, accountStore);
final var changed = update(toBeUpdated, context, op);

context.serviceApi(TokenServiceApi.class).updateContract(changed);
}

private void validateSemantics(
Account contract,
HandleContext context,
ContractUpdateTransactionBody op,
ReadableAccountStore accountStore) {
validateTrue(contract != null, INVALID_CONTRACT_ID);

if (op.hasAdminKey() && processAdminKey(op)) {
throw new HandleException(INVALID_ADMIN_KEY);
}

if (op.hasExpirationTime()) {
try {
context.attributeValidator().validateExpiry(op.expirationTime().seconds());
} catch (HandleException e) {
validateFalse(contract.expiredAndPendingRemoval(), CONTRACT_EXPIRED_AND_PENDING_REMOVAL);
throw e;
}
}

validateFalse(!onlyAffectsExpiry(op) && !isMutable(contract), MODIFYING_IMMUTABLE_CONTRACT);
validateFalse(reducesExpiry(op, contract.expirationSecond()), EXPIRATION_REDUCTION_NOT_ALLOWED);

if (op.hasMaxAutomaticTokenAssociations()) {
final var ledgerConfig = context.configuration().getConfigData(LedgerConfig.class);
final var entitiesConfig = context.configuration().getConfigData(EntitiesConfig.class);
final var tokensConfig = context.configuration().getConfigData(TokensConfig.class);
final var contractsConfig = context.configuration().getConfigData(ContractsConfig.class);

final long newMax = op.maxAutomaticTokenAssociations();

validateFalse(
newMax > ledgerConfig.maxAutoAssociations(),
REQUESTED_NUM_AUTOMATIC_ASSOCIATIONS_EXCEEDS_ASSOCIATION_LIMIT);

validateFalse(newMax < contract.maxAutoAssociations(), EXISTING_AUTOMATIC_ASSOCIATIONS_EXCEED_GIVEN_LIMIT);
validateFalse(
entitiesConfig.limitTokenAssociations() && newMax > tokensConfig.maxPerAccount(),
REQUESTED_NUM_AUTOMATIC_ASSOCIATIONS_EXCEEDS_ASSOCIATION_LIMIT);

validateTrue(contractsConfig.allowAutoAssociations(), NOT_SUPPORTED);
tinker-michaelj marked this conversation as resolved.
Show resolved Hide resolved
}

// validate expiry metadata
final var currentMetadata =
new ExpiryMeta(contract.expirationSecond(), contract.autoRenewSeconds(), contract.autoRenewAccountId());
final var updateMeta = new ExpiryMeta(
op.hasExpirationTime() ? op.expirationTime().seconds() : NA,
op.hasAutoRenewPeriod() ? op.autoRenewPeriod().seconds() : NA,
null);
context.expiryValidator().resolveUpdateAttempt(currentMetadata, updateMeta, false);

context.serviceApi(TokenServiceApi.class)
.assertValidStakingElectionForUpdate(
tinker-michaelj marked this conversation as resolved.
Show resolved Hide resolved
context.configuration()
.getConfigData(StakingConfig.class)
.isEnabled(),
contract.declineReward(),
contract.stakedId().kind().name(),
contract.stakedAccountId(),
contract.stakedNodeId(),
accountStore,
context.networkInfo());
tinker-michaelj marked this conversation as resolved.
Show resolved Hide resolved
}

private boolean processAdminKey(ContractUpdateTransactionBody op) {
if (EMPTY_KEY_LIST.equals(op.adminKey())) {
return false;
}
return keyIfAcceptable(op.adminKey());
}

private boolean keyIfAcceptable(Key candidate) {
boolean keyIsNotValid = !KeyUtils.isValid(candidate);
return keyIsNotValid || candidate.contractID() != null;
}

private boolean onlyAffectsExpiry(ContractUpdateTransactionBody op) {
return !(op.hasProxyAccountID()
|| op.hasFileID()
|| affectsMemo(op)
|| op.hasAutoRenewPeriod()
|| op.hasAdminKey())
|| op.hasMaxAutomaticTokenAssociations();
tinker-michaelj marked this conversation as resolved.
Show resolved Hide resolved
}

private boolean affectsMemo(ContractUpdateTransactionBody op) {
return op.hasMemoWrapper() || (op.memo() != null && op.memo().length() > 0);
}

private boolean isMutable(final Account contract) {
return Optional.ofNullable(contract.key())
.map(key -> !key.hasContractID())
.orElse(false);
}

private boolean reducesExpiry(ContractUpdateTransactionBody op, long curExpiry) {
return op.hasExpirationTime() && op.expirationTime().seconds() < curExpiry;
}

public Account update(
@NonNull final Account contract,
@NonNull final HandleContext context,
Expand Down Expand Up @@ -150,76 +253,8 @@ public Account update(
builder.autoRenewAccountId(op.autoRenewAccountId());
}
if (op.hasMaxAutomaticTokenAssociations()) {
final var ledgerConfig = context.configuration().getConfigData(LedgerConfig.class);
final var entitiesConfig = context.configuration().getConfigData(EntitiesConfig.class);
final var tokensConfig = context.configuration().getConfigData(TokensConfig.class);

validateFalse(
op.maxAutomaticTokenAssociations() > ledgerConfig.maxAutoAssociations(),
REQUESTED_NUM_AUTOMATIC_ASSOCIATIONS_EXCEEDS_ASSOCIATION_LIMIT);

final long newMax = op.maxAutomaticTokenAssociations();
validateFalse(newMax < contract.maxAutoAssociations(), EXISTING_AUTOMATIC_ASSOCIATIONS_EXCEED_GIVEN_LIMIT);
validateFalse(
entitiesConfig.limitTokenAssociations() && newMax > tokensConfig.maxPerAccount(),
REQUESTED_NUM_AUTOMATIC_ASSOCIATIONS_EXCEEDS_ASSOCIATION_LIMIT);

builder.maxAutoAssociations(op.maxAutomaticTokenAssociations());
}
return builder.build();
}

private void validateSemantics(Account contract, HandleContext context, ContractUpdateTransactionBody op) {
validateTrue(contract != null, INVALID_CONTRACT_ID);

if (op.hasAdminKey()) {
boolean keyNotSentinel = !EMPTY_KEY_LIST.equals(op.adminKey());
boolean keyIsUnset = op.adminKey().key().kind() == KeyOneOfType.UNSET;
boolean keyIsNotValid = !KeyUtils.isValid(op.adminKey());
validateFalse(keyNotSentinel && (keyIsUnset || keyIsNotValid), INVALID_ADMIN_KEY);
}

if (op.hasExpirationTime()) {
try {
context.attributeValidator().validateExpiry(op.expirationTime().seconds());
} catch (HandleException e) {
validateFalse(contract.expiredAndPendingRemoval(), CONTRACT_EXPIRED_AND_PENDING_REMOVAL);
throw e;
}
}

validateFalse(!onlyAffectsExpiry(op) && !isMutable(contract), MODIFYING_IMMUTABLE_CONTRACT);
validateFalse(reducesExpiry(op, contract.expirationSecond()), EXPIRATION_REDUCTION_NOT_ALLOWED);

// validate expiry metadata
final var currentMetadata =
new ExpiryMeta(contract.expirationSecond(), contract.autoRenewSeconds(), contract.autoRenewAccountId());
final var updateMeta = new ExpiryMeta(
op.hasExpirationTime() ? op.expirationTime().seconds() : NA,
op.hasAutoRenewPeriod() ? op.autoRenewPeriod().seconds() : NA,
null);
context.expiryValidator().resolveUpdateAttempt(currentMetadata, updateMeta, false);
}

boolean onlyAffectsExpiry(ContractUpdateTransactionBody op) {
return !(op.hasProxyAccountID()
|| op.hasFileID()
|| affectsMemo(op)
|| op.hasAutoRenewPeriod()
|| op.hasAdminKey());
}

boolean affectsMemo(ContractUpdateTransactionBody op) {
return op.hasMemoWrapper() || (op.memo() != null && op.memo().length() > 0);
}

boolean isMutable(final Account contract) {
return Optional.ofNullable(contract.key())
.map(key -> !key.hasContractID())
.orElse(false);
}

private boolean reducesExpiry(ContractUpdateTransactionBody op, long curExpiry) {
return op.hasExpirationTime() && op.expirationTime().seconds() < curExpiry;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ private void assertValidCreation(@NonNull final ContractCreateTransactionBody bo
REQUESTED_NUM_AUTOMATIC_ASSOCIATIONS_EXCEEDS_ASSOCIATION_LIMIT);
final var usesNonDefaultProxyId = body.hasProxyAccountID() && !AccountID.DEFAULT.equals(body.proxyAccountID());
validateFalse(usesNonDefaultProxyId, PROXY_ACCOUNT_ID_FIELD_IS_DEPRECATED);
tokenServiceApi.assertValidStakingElection(
tokenServiceApi.assertValidStakingElectionForCreation(
stakingConfig.isEnabled(),
body.declineReward(),
body.stakedId().kind().name(),
Expand Down