Plan specifies information about a planned upgrade and when it should occur.

interface Plan {
    height: bigint;
    info: string;
    name: string;
    time: undefined | Date;
    upgradedClientState?: Any;
}

Properties

height: bigint

The height at which the upgrade must be performed. Only used if Time is not set.

info: string

Any application specific upgrade info to be included on-chain such as a git commit that validators could automatically upgrade to

name: string

Sets the name for the upgrade. This name will be used by the upgraded version of the software to apply any special "on-upgrade" commands during the first BeginBlock method after the upgrade is applied. It is also used to detect whether a software version can handle a given upgrade. If no upgrade handler with this name has been set in the software, it will be assumed that the software is out-of-date when the upgrade Time or Height is reached and the software will exit.

time: undefined | Date
upgradedClientState?: Any