-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Wrap modularized code in transactionExecutionService (#9943)
* feat: Wrap modularized code in transactionExecutionService and add opcodeTracer Signed-off-by: Kristiyan Selveliev <kristiyan.selveliev@limechain.tech>
- Loading branch information
1 parent
6da07a8
commit fb69f19
Showing
8 changed files
with
590 additions
and
267 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
244 changes: 12 additions & 232 deletions
244
hedera-mirror-web3/src/main/java/com/hedera/mirror/web3/service/ContractCallService.java
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
279 changes: 279 additions & 0 deletions
279
...mirror-web3/src/main/java/com/hedera/mirror/web3/service/TransactionExecutionService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,279 @@ | ||
| /* | ||
| * Copyright (C) 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.mirror.web3.service; | ||
|
|
||
| import static com.hedera.mirror.web3.state.Utils.isMirror; | ||
|
|
||
| import com.hedera.hapi.node.base.AccountID; | ||
| import com.hedera.hapi.node.base.ContractID; | ||
| import com.hedera.hapi.node.base.Duration; | ||
| import com.hedera.hapi.node.base.FileID; | ||
| import com.hedera.hapi.node.base.ResponseCodeEnum; | ||
| import com.hedera.hapi.node.base.Timestamp; | ||
| import com.hedera.hapi.node.base.TransactionID; | ||
| import com.hedera.hapi.node.contract.ContractCallTransactionBody; | ||
| import com.hedera.hapi.node.contract.ContractCreateTransactionBody; | ||
| import com.hedera.hapi.node.contract.ContractFunctionResult; | ||
| import com.hedera.hapi.node.file.FileCreateTransactionBody; | ||
| import com.hedera.hapi.node.state.file.File; | ||
| import com.hedera.hapi.node.state.primitives.ProtoBytes; | ||
| import com.hedera.hapi.node.transaction.TransactionBody; | ||
| import com.hedera.mirror.web3.common.ContractCallContext; | ||
| import com.hedera.mirror.web3.evm.contracts.execution.traceability.OpcodeTracer; | ||
| import com.hedera.mirror.web3.evm.properties.MirrorNodeEvmProperties; | ||
| import com.hedera.mirror.web3.service.model.CallServiceParameters; | ||
| import com.hedera.node.app.config.ConfigProviderImpl; | ||
| import com.hedera.node.app.service.evm.contracts.execution.HederaEvmTransactionProcessingResult; | ||
| import com.hedera.node.app.service.token.TokenService; | ||
| import com.hedera.node.app.state.SingleTransactionRecord; | ||
| import com.hedera.node.app.workflows.standalone.TransactionExecutor; | ||
| import com.hedera.node.app.workflows.standalone.TransactionExecutors; | ||
| import com.hedera.node.app.workflows.standalone.TransactionExecutors.TracerBinding; | ||
| import com.hedera.node.config.data.EntitiesConfig; | ||
| import com.swirlds.config.api.Configuration; | ||
| import com.swirlds.state.State; | ||
| import jakarta.annotation.Nullable; | ||
| import jakarta.inject.Named; | ||
| import java.time.Instant; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import lombok.CustomLog; | ||
| import org.apache.tuweni.bytes.Bytes; | ||
| import org.hyperledger.besu.datatypes.Address; | ||
| import org.hyperledger.besu.evm.tracing.OperationTracer; | ||
|
|
||
| @Named | ||
| @CustomLog | ||
| public class TransactionExecutionService { | ||
|
|
||
| private static final AccountID NODE_ACCOUNT_ID = | ||
| AccountID.newBuilder().accountNum(3).build(); | ||
| private static final Configuration DEFAULT_CONFIG = new ConfigProviderImpl().getConfiguration(); | ||
| private static final AccountID TREASURY_ACCOUNT_ID = | ||
| AccountID.newBuilder().accountNum(2).build(); | ||
| private static final Duration TRANSACTION_DURATION = new Duration(15); | ||
| private static final Timestamp TRANSACTION_START = new Timestamp(0, 0); | ||
| private static final int INITCODE_SIZE_KB = 6 * 1024; | ||
| private final State mirrorNodeState; | ||
| private final MirrorNodeEvmProperties mirrorNodeEvmProperties; | ||
| private final OpcodeTracer opcodeTracer; | ||
| private Map<String, String> transactionProperties; | ||
|
|
||
| protected TransactionExecutionService( | ||
| State mirrorNodeState, MirrorNodeEvmProperties mirrorNodeEvmProperties, OpcodeTracer opcodeTracer) { | ||
| this.mirrorNodeState = mirrorNodeState; | ||
| this.mirrorNodeEvmProperties = mirrorNodeEvmProperties; | ||
| this.opcodeTracer = opcodeTracer; | ||
| } | ||
|
|
||
| public HederaEvmTransactionProcessingResult execute(final CallServiceParameters params, final long estimatedGas) { | ||
| final var isContractCreate = params.getReceiver().isZero(); | ||
| final var maxLifetime = | ||
| DEFAULT_CONFIG.getConfigData(EntitiesConfig.class).maxLifetime(); | ||
| var executor = ExecutorFactory.newExecutor(mirrorNodeState, getTransactionProperties(), null); | ||
|
|
||
| TransactionBody transactionBody; | ||
| HederaEvmTransactionProcessingResult result; | ||
| if (isContractCreate) { | ||
| if (params.getCallData().size() < INITCODE_SIZE_KB) { | ||
| transactionBody = buildContractCreateTransactionBodyWithInitBytecode(params, estimatedGas, maxLifetime); | ||
| } else { | ||
| // Upload the init bytecode | ||
| transactionBody = buildFileCreateTransactionBody(params, maxLifetime); | ||
| var uploadReceipt = executor.execute(transactionBody, Instant.EPOCH); | ||
| final var fileID = uploadReceipt | ||
| .getFirst() | ||
| .transactionRecord() | ||
| .receiptOrThrow() | ||
| .fileIDOrThrow(); | ||
| final var file = File.newBuilder() | ||
| .fileId(fileID) | ||
| .contents(com.hedera.pbj.runtime.io.buffer.Bytes.wrap( | ||
| params.getCallData().toFastHex(false).getBytes())) | ||
| .build(); | ||
| // Set the context variables for the uploaded contract. | ||
| ContractCallContext.get().setFile(Optional.of(file)); | ||
|
|
||
| // Create the contract with the init bytecode | ||
| transactionBody = | ||
| buildContractCreateTransactionBodyWithFileID(params, fileID, estimatedGas, maxLifetime); | ||
| } | ||
| } else { | ||
| transactionBody = buildContractCallTransactionBody(params, estimatedGas); | ||
| } | ||
| List<OperationTracer> operationTracers = new ArrayList<>(); | ||
| if (ContractCallContext.get().getOpcodeTracerOptions() != null) { | ||
| operationTracers.add(opcodeTracer); | ||
| } | ||
|
|
||
| var receipt = | ||
| executor.execute(transactionBody, Instant.EPOCH, operationTracers.toArray(OperationTracer[]::new)); | ||
| if (receipt.getFirst().transactionRecord().receiptOrThrow().status() == ResponseCodeEnum.SUCCESS) { | ||
| result = buildSuccessResult(isContractCreate, receipt, params); | ||
| } else { | ||
| result = buildFailedResult(receipt, isContractCreate); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| private Map<String, String> getTransactionProperties() { | ||
| if (transactionProperties == null) { | ||
| final var mirrorNodeProperties = mirrorNodeEvmProperties.getProperties(); | ||
| mirrorNodeProperties.put( | ||
| "contracts.evm.version", | ||
| "v" | ||
| + mirrorNodeEvmProperties.getSemanticEvmVersion().major() + "." | ||
| + mirrorNodeEvmProperties.getSemanticEvmVersion().minor()); | ||
| mirrorNodeProperties.put( | ||
| "ledger.id", | ||
| Bytes.wrap(mirrorNodeEvmProperties.getNetwork().getLedgerId()) | ||
| .toHexString()); | ||
| this.transactionProperties = mirrorNodeProperties; | ||
| } | ||
| return transactionProperties; | ||
| } | ||
|
|
||
| private ContractFunctionResult getTransactionResult( | ||
| final List<SingleTransactionRecord> receipt, boolean isContractCreate) { | ||
| return isContractCreate | ||
| ? receipt.getFirst().transactionRecord().contractCreateResultOrThrow() | ||
| : receipt.getFirst().transactionRecord().contractCallResultOrThrow(); | ||
| } | ||
|
|
||
| private HederaEvmTransactionProcessingResult buildSuccessResult( | ||
| final boolean isContractCreate, | ||
| final List<SingleTransactionRecord> receipt, | ||
| final CallServiceParameters params) { | ||
| var result = getTransactionResult(receipt, isContractCreate); | ||
|
|
||
| return HederaEvmTransactionProcessingResult.successful( | ||
| List.of(), | ||
| result.gasUsed(), | ||
| 0L, | ||
| 0L, | ||
| Bytes.wrap(result.contractCallResult().toByteArray()), | ||
| params.getReceiver()); | ||
| } | ||
|
|
||
| private HederaEvmTransactionProcessingResult buildFailedResult( | ||
| final List<SingleTransactionRecord> receipt, final boolean isContractCreate) { | ||
| var result = getTransactionResult(receipt, isContractCreate); | ||
| var status = receipt.getFirst().transactionRecord().receipt().status(); | ||
|
|
||
| return HederaEvmTransactionProcessingResult.failed( | ||
| result.gasUsed(), | ||
| 0L, | ||
| 0L, | ||
| Optional.of(Bytes.wrap(status.protoName().getBytes())), | ||
| Optional.empty()); | ||
| } | ||
|
|
||
|
|
||
| private TransactionBody.Builder defaultTransactionBodyBuilder(final CallServiceParameters params) { | ||
| return TransactionBody.newBuilder() | ||
| .transactionID(TransactionID.newBuilder() | ||
| .transactionValidStart(TRANSACTION_START) | ||
| .accountID(getSenderAccountID(params)) | ||
| .build()) | ||
| .nodeAccountID(NODE_ACCOUNT_ID) | ||
| .transactionValidDuration(TRANSACTION_DURATION); | ||
| } | ||
|
|
||
| private TransactionBody buildFileCreateTransactionBody(final CallServiceParameters params, long maxLifetime) { | ||
| return defaultTransactionBodyBuilder(params) | ||
| .fileCreate(FileCreateTransactionBody.newBuilder() | ||
| .contents(com.hedera.pbj.runtime.io.buffer.Bytes.wrap( | ||
| params.getCallData().toArray())) | ||
| .expirationTime(new Timestamp(maxLifetime, 0)) | ||
| .build()) | ||
| .build(); | ||
| } | ||
|
|
||
| private TransactionBody buildContractCreateTransactionBodyWithInitBytecode( | ||
| final CallServiceParameters params, long estimatedGas, long maxLifetime) { | ||
| return defaultTransactionBodyBuilder(params) | ||
| .contractCreateInstance(ContractCreateTransactionBody.newBuilder() | ||
| .initcode(com.hedera.pbj.runtime.io.buffer.Bytes.wrap( | ||
| params.getCallData().toArrayUnsafe())) | ||
| .gas(estimatedGas) | ||
| .autoRenewPeriod(new Duration(maxLifetime)) | ||
| .build()) | ||
| .build(); | ||
| } | ||
|
|
||
| private TransactionBody buildContractCreateTransactionBodyWithFileID( | ||
| final CallServiceParameters params, final FileID fileID, long estimatedGas, long maxLifetime) { | ||
| return defaultTransactionBodyBuilder(params) | ||
| .contractCreateInstance(ContractCreateTransactionBody.newBuilder() | ||
| .fileID(fileID) | ||
| .gas(estimatedGas) | ||
| .autoRenewPeriod(new Duration(maxLifetime)) | ||
| .build()) | ||
| .build(); | ||
| } | ||
|
|
||
| private TransactionBody buildContractCallTransactionBody( | ||
| final CallServiceParameters params, final long estimatedGas) { | ||
| return defaultTransactionBodyBuilder(params) | ||
| .contractCall(ContractCallTransactionBody.newBuilder() | ||
| .contractID(ContractID.newBuilder() | ||
| .evmAddress(com.hedera.pbj.runtime.io.buffer.Bytes.wrap( | ||
| params.getReceiver().toArrayUnsafe())) | ||
| .build()) | ||
| .functionParameters(com.hedera.pbj.runtime.io.buffer.Bytes.wrap( | ||
| params.getCallData().toArray())) | ||
| .gas(estimatedGas) | ||
| .build()) | ||
| .build(); | ||
| } | ||
|
|
||
| private ProtoBytes convertAddressToProtoBytes(final Address address) { | ||
| return ProtoBytes.newBuilder() | ||
| .value(com.hedera.pbj.runtime.io.buffer.Bytes.wrap(address.toArrayUnsafe())) | ||
| .build(); | ||
| } | ||
|
|
||
| private AccountID getSenderAccountID(final CallServiceParameters params) { | ||
| if (params.getSender().canonicalAddress().isZero() && params.getValue() == 0L) { | ||
| // Set a default account to keep the sender parameter optional. | ||
| return TREASURY_ACCOUNT_ID; | ||
| } | ||
|
|
||
| final var senderAddress = params.getSender().canonicalAddress(); | ||
| if (isMirror(senderAddress)) { | ||
| return AccountID.newBuilder() | ||
| .accountNum(senderAddress.trimLeadingZeros().toLong()) | ||
| .build(); | ||
| } | ||
| return (AccountID) mirrorNodeState | ||
| .getReadableStates(TokenService.NAME) | ||
| .get("ALIASES") | ||
| .get(convertAddressToProtoBytes(senderAddress)); | ||
| } | ||
|
|
||
| public static class ExecutorFactory { | ||
| public static TransactionExecutor newExecutor( | ||
| State mirrorNodeState, | ||
| Map<String, String> properties, | ||
| @Nullable final TracerBinding customTracerBinding) { | ||
| return TransactionExecutors.TRANSACTION_EXECUTORS.newExecutor( | ||
| mirrorNodeState, properties, customTracerBinding); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.