Interface IBootstrapOptions

Options class

interface IBootstrapOptions {
    mode: BootstrapMode;
    id?: number;
    sat?: number;
    index?: number;
    data?: any;
    res?: {
        [_: string]: IBootstrapResource;
    };
    oo?: IBootstrapOpenOrdinalModules;
    dev?: string;
}

Properties

The mode for bootstrapping

id?: number

Optional: The inscription Id to bootstrap

sat?: number

Optional: The sat Id to bootstrap

index?: number

Optional: Index on sat to bootstrap

data?: any

Optional: Data to pass into the bootstrap

res?: {
    [_: string]: IBootstrapResource;
}

Optional: Additional inscriptions to load and pass into bootstrap()

Optional: Additional Open Ordinal modules to load

dev?: string

Optional: Relative path to module to boot. This is used during development and should never be present in actual inscribed ordinal.