Create a scheduled transaction

CryptoTransfer, ConsensusSubmitMessage, TokenMint and TokenBurn transactions are the transaction types that can be scheduled. Additional schedulable transactions will be added in future releases.

A transaction that creates a schedule entity on a Hedera network. The entity ID for a schedule transaction is referred to as the ScheduleID. After successfully executing a schedule create transaction, you can obtain the ScheduleID by requesting the receipt of the transaction immediately after the transaction was executed. The receipt also contains the scheduled transaction ID. The scheduled transaction ID is used to to request the record of the scheduled transaction if it is successfully executed.

When creating a transaction to schedule you do not need to use .freezeWith(client) method.

Example:

TransferTransaction transactionToSchedule = new TransferTransaction()
.addHbarTransfer(newAccountId, Hbar.fromTinybars(-1))
.addHbarTransfer(myAccountId, Hbar.fromTinybars(1));

Schedule Transaction Duplicate

If two users submit the same schedule create transaction, the first one to reach consensus will create the schedule ID and the second one will have the schedule ID returned in the receipt of the transaction. The receipt status of the second identical schedule transaction will return a "IDENTICAL_SCHEDULE_ALREADY_CREATED" response from the network. The user who submits the second transaction would need to submit a ScheduleSign transaction to add their signature to the schedule transaction.

Schedule Transaction Deletion

To retain the ability to delete a schedule transaction, you will need to populate the admin key field when creating a schedule transaction. The admin key will be required to sign the ScheduleDelete transaction to delete the scheduled transaction from the network. If you do not assign an admin key during the creation of the schedule transaction, you will have an immutable schedule transaction.

Transaction Signing Requirements

  • The key of the account paying for the creation of the schedule transaction

  • The key of the payer account ID paying for the execution of the scheduled transaction. If the payer account is not specified, the operator account will be used to pay for the execution by default.

  • The admin key if set

  • You can optionally sign with any of the required signatures for the scheduled (inner) transaction. Freeze the schedule transaction and call the .sign() method to add signatures.

Transaction Properties

Note: If you do not set the payer account ID the schedule transaction is immutable.

Field

Description

Schedulable Transaction Body

The transaction body of the transaction that is being scheduled

Admin Key

A key that can delete the schedule transaction prior to execution or expiration

Payer Account ID

The account which is going to pay for the execution of the scheduled transaction. If not populated, the scheduling account is charged (optional).

Memo

Publicly visible information about the schedule entity, up to 100 bytes. No guarantee of uniqueness (optional).

Constructor

Description

new ScheduleCreateTransaction()

Initializes the ScheduleCreateTransaction object

new ScheduleCreateTransaction()

Methods

V2
V2

Method

Type

Requirement

setScheduledTransaction(<transaction>)

Transaction<?>

Required

setAdminKey(<key>)

Key

Optional

setPayerAccountId(<id>)

AccountId

Optional

setScheduleMemo(<memo>)

String

Optional

getAdminKey()

Key

Optional

getPayerAccountId()

AccountId

Optional

getScheduleMemo()

String

Optional

Java
//Create a schedule transaction
ScheduleCreateTransaction transaction = new ScheduleCreateTransaction()
.setScheduledTransaction(transactionToSchedule);
//Sign with the client operator key and submit the transaction to a Hedera network
TransactionResponse txResponse = transaction.execute(client);
//Request the receipt of the transaction
TransactionReceipt receipt = txResponse.getReceipt(client);
//Get the schedule ID
ScheduleId scheduleId = receipt.scheduleId;
System.out.println("The schedule ID of the schedule transaction is " +scheduleId);
JavaScript
//Create a schedule transaction
const transaction = new ScheduleCreateTransaction()
.setScheduledTransaction(transactionToSchedule);
//Sign with the client operator key and submit the transaction to a Hedera network
const txResponse = await transaction.execute(client);
//Request the receipt of the transaction
const receipt = await txResponse.getReceipt(client);
//Get the schedule ID
const scheduleId = receipt.scheduleId;
console.log("The schedule ID of the schedule transaction is " +scheduleId);
Go
//Create a schedule transaction
transaction, err := transactionToSchedule.Schedule()
if err != nil {
panic(err)
}
//Sign with the client operator key and submit the transaction to a Hedera network
txResponse, err := transaction.Execute(client)
if err != nil {
panic(err)
}
//Request the receipt of the transaction
receipt, err := txResponse.GetReceipt(client)
if err != nil {
panic(err)
}
//Get the schedule ID from the receipt
scheduleId := *receipt.ScheduleID
fmt.Printf("The new token ID is %v\n", scheduleId)