/** * # Scheduled Transaction * Information regarding Scheduled 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 import "services_basic_types.proto"; import "services_timestamp.proto"; import "services_schedulable_transaction_body.proto"; import "services_transaction.proto"; option java_package = "com.hederahashgraph.api.proto.java"; // <<>> This comment is special code for setting PBJ Compiler java package option java_multiple_files = true; /** * Representation of a Hedera Schedule entry in the network Merkle tree.
* A Schedule represents a request to run a transaction _at some future time_ * either when the `Schedule` expires (if long term schedules are enabled and * `wait_for_expiry` is true) or as soon as the `Schedule` has gathered * enough signatures via any combination of the `scheduleCreate` and 0 or more * subsequent `scheduleSign` transactions. */ message Schedule { /** * This schedule's ID within the global network state. *

* This value SHALL be unique within the network. */ ScheduleID schedule_id = 1; /** * A flag indicating this schedule is deleted. *

* A schedule SHALL either be executed or deleted, but never both. */ bool deleted = 2; /** * A flag indicating this schedule has executed. *

* A schedule SHALL either be executed or deleted, but never both. */ bool executed = 3; /** * A schedule flag to wait for expiration before executing. *

* A schedule SHALL be executed immediately when all necessary signatures * are gathered, unless this flag is set.
* If this flag is set, the schedule SHALL wait until the consensus time * reaches `expiration_time_provided`, when signatures MUST again be * verified. If all required signatures are present at that time, the * schedule SHALL be executed. Otherwise the schedule SHALL expire without * execution. *

* Note that a schedule is always removed from state after it expires, * regardless of whether it was executed or not. */ bool wait_for_expiry = 4; /** * A short description for this schedule. *

* This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` * (default 100) bytes when encoded as UTF-8. */ string memo = 5; /** * The scheduler account for this schedule. *

* This SHALL be the account that submitted the original * ScheduleCreate transaction. */ AccountID scheduler_account_id = 6; /** * The explicit payer account for the scheduled transaction. *

* If set, this account SHALL be added to the accounts that MUST sign the * schedule before it may execute. */ AccountID payer_account_id = 7; /** * The admin key for this schedule. *

* This key, if set, MUST sign any `schedule_delete` transaction.
* If not set, then this schedule SHALL NOT be deleted, and any * `schedule_delete` transaction for this schedule SHALL fail. */ Key admin_key = 8; /** * The transaction valid start value for this schedule. *

* This MUST be set, and SHALL be copied from the `TransactionID` of * the original `schedule_create` transaction. */ Timestamp schedule_valid_start = 9; /** * The requested expiration time of the schedule if provided by the user. *

* If not provided in the `schedule_create` transaction, this SHALL be set * to a default value equal to the current consensus time, forward offset by * the maximum schedule expiration time in the current dynamic network * configuration (typically 62 days).
* The actual `calculated_expiration_second` MAY be "earlier" than this, * but MUST NOT be later. */ int64 provided_expiration_second = 10; /** * The calculated expiration time of the schedule. *

* This SHALL be calculated from the requested expiration time in the * `schedule_create` transaction, and limited by the maximum expiration time * in the current dynamic network configuration (typically 62 days). *

* The schedule SHALL be removed from global network state after the network * reaches a consensus time greater than or equal to this value. */ int64 calculated_expiration_second = 11; /** * The consensus timestamp of the transaction that executed or deleted this schedule. *

* This value SHALL be set to the `current_consensus_time` when a * `schedule_delete` transaction is completed.
* This value SHALL be set to the `current_consensus_time` when the * scheduled transaction is executed, either as a result of gathering the * final required signature, or, if long-term schedule execution is enabled, * at the requested execution time. */ Timestamp resolution_time = 12; /** * The scheduled transaction to execute. *

* This MUST be one of the transaction types permitted in the current value * of the `schedule.whitelist` in the dynamic network configuration. */ SchedulableTransactionBody scheduled_transaction = 13; /** * The full transaction that created this schedule. *

* This is primarily used for duplicate schedule create detection. This is * also the source of the parent transaction ID, from which the child * transaction ID is derived when the `scheduled_transaction` is executed. */ TransactionBody original_create_transaction = 14; /** * All of the "primitive" keys that have already signed this schedule. *

* The scheduled transaction SHALL NOT be executed before this list is * sufficient to "activate" the required keys for the scheduled transaction.
* A Key SHALL NOT be stored in this list unless the corresponding private * key has signed either the original `schedule_create` transaction or a * subsequent `schedule_sign` transaction intended for, and referencing to, * this specific schedule. *

* The only keys stored are "primitive" keys (ED25519 or ECDSA_SECP256K1) in * order to ensure that any key list or threshold keys are correctly handled, * regardless of signing order, intervening changes, or other situations. * The `scheduled_transaction` SHALL execute only if, at the time of * execution, this list contains sufficient public keys to satisfy the * full requirements for signature on that transaction. */ repeated Key signatories = 15; } /** * A message for storing a list of schedules in state.
* This is used to store lists of `Schedule` values. * One example is all schedules that expire at a particular time. */ message ScheduleList { /** * a list of schedules, in no particular order. *

* While the order is not _specified_, it MUST be deterministic. */ repeated Schedule schedules = 1; } /** * A message for storing a list of schedule identifiers in state.
* This is used to store lists of `ScheduleID` values. * One example is all schedules that expire at a particular time. */ message ScheduleIdList { /** * A list of schedule identifiers, in no particular order. *

* While the order is not _specified_, it MUST be deterministic. */ repeated ScheduleID schedule_ids = 1; } /** * A count of schedules scheduled and processed. * This value summarizes the counts of scheduled and processed transactions * within a particular consensus second. */ message ScheduledCounts { /** * A number of transactions scheduled to expire at a consensus second. */ uint32 number_scheduled = 1; /** * A number of scheduled transactions that have been processed at * a consensus second. */ uint32 number_processed = 2; } /** * An ordering for a scheduled transaction.
* This establishes the order in which scheduled transactions intended to * execute at a particular consensus second will be executed. * * Scheduled transactions that have the same `expiry_second` SHALL execute * in ascending order of `order_number`. */ message ScheduledOrder { /** * A consensus second in which the transaction is to be executed. * This is _also_ the consensus time when the transaction will expire * if it has not gathered enough signatures in time. */ uint64 expiry_second = 1; /* * An ordered position within a conceptual list.
* This is the ordered position within the consensus second when * the associated transaction will be executed. */ uint32 order_number = 2; }