Function diem_transaction_builder::stdlib::encode_force_expire_script_function

source ·

pub fn encode_force_expire_script_function(
    shift_amount: u64
) -> TransactionPayload

Expand description

Summary

Shifts the window held by the CRSN resource published under account by shift_amount. This will expire all unused slots in the CRSN at the time of processing that are less than shift_amount. The exact semantics are defined in DIP-168.

Technical Description

This shifts the slots in the published CRSN::CRSN resource under account by shift_amount, and increments the CRSN’s min_nonce field by shift_amount as well. After this, it will shift the window over any set bits. It is important to note that the sequence nonce of the sending transaction must still lie within the range of the window in order for this transaction to be processed successfully.

Parameters

Name	Type	Description
`account`	`signer`	The signer of the sending account of the transaction.
`shift_amount`	`u64`	The amount to shift the window in the CRSN under `account`.

Common Abort Conditions

Error Category	Error Reason	Description
`Errors::INVALID_STATE`	`CRSN::ENO_CRSN`	A `CRSN::CRSN` resource is not published under `account`.