/** * # Contract Message Types * Message types used in contract transactions. * * ### Keywords * The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", * "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this * document are to be interpreted as described in * [RFC2119](https://www.ietf.org/rfc/rfc2119) and clarified in * [RFC8174](https://www.ietf.org/rfc/rfc8174). */ syntax = "proto3"; package proto; // SPDX-License-Identifier: Apache-2.0 option java_package = "com.hederahashgraph.api.proto.java"; // <<>> This comment is special code for setting PBJ Compiler java package option java_multiple_files = true; import "services_basic_types.proto"; import "google/protobuf/wrappers.proto"; /** * Context of an internal call in an EVM transaction that is not otherwise externalized.
* This message does not say anything about whether an EVM transaction is itself a logical * transaction in a Hiero transactional unit. It simply provides context on an internal * message call within an EVM transaction. */ message InternalCallContext { /** * The gas available for the call.
*/ uint64 gas = 1; /** * The value sent with the call.
*/ uint64 value = 2; /** * The call data for the call.
*/ bytes call_data = 3; } /** * Results of executing a EVM transaction.
*/ message EvmTransactionResult { /** * The Hedera id of the caller.
*/ AccountID sender_id = 1; /** * The Hedera id of the contract receiving the call.
*/ ContractID contract_id = 2; /** * Result data from the function call. */ bytes result_data = 3; /** * Any error message produced by the contract call. Max size of 100 bytes. *

* This SHALL be unset if the contract call succeeded. */ string error_message = 4; /** * EVM gas used. */ uint64 gas_used = 5; /** * If not already externalized in a transaction body, the context of the * internal call producing this result. */ InternalCallContext internal_call_context = 6; /** * If set, the id of the executed hook. */ proto.HookId executed_hook_id = 7; } /** * A contract "nonce" reference.
* This connects a contract and its "nonce" value, and is primarily for use in * query responses. A "nonce" is short for "nonsense" and is usually a value * with no particular meaning. * * The nonce of a contract SHALL be incremented when that contract creates * another contract. */ message ContractNonceInfo { /** * A contract identifier.
* This refers to the contract that holds this nonce value. */ ContractID contract_id = 1; /** * A "nonce" value. * The current value of the nonce associated with the identified contract. */ int64 nonce = 2; } /** * EVM log data for a contract call.
* The EVM log information produced by a smart contract function call. * * Each contract function call MAY return zero or more log events. */ message ContractLoginfo { /** * A contract identifier.
* This refers to the contract that generated this log entry. */ ContractID contractID = 1; /** * A bloom filter.
* This filter applies to this log entry and indexes the contract log data * in the full data of the Ethereum block.
* EIP-7668 proposes to remove bloom filters as they are quite low value * in practice and separate indexing services are more effective. */ bytes bloom = 2; /** * A list of the "topics" in this log entry.
* The EVM permits up to 4 topics, each of which is 32 bytes (one EVM word). *

* The first "topic" is special, and MUST contain the keccak256 hash of the * event signature, if the event is not anonymous. */ repeated bytes topic = 3; /** * Event data for this log entry.
* This is binary data consisting of an arbitrary number of 256 bit * (32 byte) words. The content of that data is determined by the smart * contract code.
*/ bytes data = 4; } /** * A contract function result.
* The result returned by a call to a smart contract function. This is part of * the response to a ContractCallLocal query, and is in the record for a * ContractCall. The ContractCreateInstance transaction record also carries a * function result, which is the results of the call to the constructor. */ message ContractFunctionResult { // No comments here: PBJ issue #217 reserved 8; // Removed Field. /** * A contract identifier.
* This identifies the smart contract that defines the function called. */ ContractID contractID = 1; /** * Result data from the function call. *

* This SHALL be encoded in RLP bytecode format. */ bytes contractCallResult = 2; /** * Any error message produced by the contract call. *

* This SHALL be unset if the contract call succeeded. */ string errorMessage = 3; /** * A bloom filter produced by this contract call.
* Ethereum uses this bloom filter to search for call results in the * Ethereum block history. High false positive rates make the bloom * filters quite limited value. */ bytes bloom = 4; /** * A quantity of "gas" used.
* This represents the resource units expended to execute this * contract call, and correlates to transaction costs. */ uint64 gasUsed = 5; /** * Any Log events produced by this contract call. */ repeated ContractLoginfo logInfo = 6; /** * Replaced by values in transaction records to support * `CREATE2` calls.
*

* The list of smart contracts that were created by the function call.
* The created ids will now _also_ be externalized through internal * transaction records, where each record has its alias field populated * with the new contract's EVM address.
* This is needed for contracts created with CREATE2, which removes the * trivial relationship between a new contract's Identifier and its * Solidity address. */ repeated ContractID createdContractIDs = 7 [deprecated = true]; /** * A created contract address.
* If the function created a new contract (e.g. `CREATE2`), * this is the primary 20-byte EVM address for that contract. *

* Every contract SHALL have a "base" EVM address that is determined by its * `shard.realm.num` contract ID.
* This address is constructed as follows *

    *
  1. The first 4 bytes are the big-endian * representation of the shard.
    2. *
  2. The next 8 bytes are the big-endian * representation of the realm.
    3. *
  3. The final 8 bytes are the big-endian * representation of the number.
    4. *
*

* Contracts created via `CREATE2` SHALL have an _additional_, primary, * address that is derived from the * EIP-1014 * specification. This additional address SHALL NOT be directly related to * the `shard.realm.num` contract ID.
* It should be emphasized that Contracts created via a `CREATE2` call can * also be referenced via the same "base" EVM address as described above. */ google.protobuf.BytesValue evm_address = 9; /** * The amount of gas available for this call, sometimes referred to as the * gasLimit.
* This field SHALL NOT be populated when the associated `TransactionBody` * in the block stream is a `ContractCreateTransactionBody` or * a `ContractCallTransactionBody`. */ int64 gas = 10; /** * An amount, in tinybar, sent by this function call.
* This SHALL be zero(0) if the function called is not `payable`.
* This field SHALL NOT be populated when the associated `TransactionBody` * in the block stream is a `ContractCreateTransactionBody` or * a `ContractCallTransactionBody`. */ int64 amount = 11; /** * The smart contract function to call, and the parameters to pass to that * function.
* These SHALL be presented in EVM bytecode function call format.
* This field SHALL NOT be populated when the associated `TransactionBody` * in the block stream is a `ContractCreateTransactionBody` or * a `ContractCallTransactionBody`. */ bytes functionParameters = 12; /** * The account that was the "sender" for this contract call.
* If this is not set it SHALL be read from the accountId in the * transactionId for the contract call.
* This field SHALL NOT be populated when the associated `TransactionBody` * in the block stream is a `ContractCreateTransactionBody` or * a `ContractCallTransactionBody`. */ AccountID sender_id = 13; /** * A list of contract account nonce values.
* This list SHALL contain a nonce value for each contract account modified * as a result of this contract call. These nonce values SHALL be the value * after the contract call is completed. */ repeated ContractNonceInfo contract_nonces = 14; /** * A nonce value for the "signer account".
* If the contract call updated the signer nonce for the signer account * (i.e. by creating another contract), this field SHALL contain the * updated value.
* If the signer account nonce was not updated, this field SHALL be `null`. */ google.protobuf.Int64Value signer_nonce = 15; }