@xo-cash/types
    Preparing search index...

    Type Alias XOTemplate

    XOTemplate: XOTemplateViewProperties & {
        $schema: string;
        actions: Record<(...), (...)>;
        constants?: Record<(...), (...)>;
        data?: Record<(...), (...)>;
        defaults?: XOTemplateDefaults;
        icons?: (...)[];
        inputs: Record<(...), (...)>;
        lockingScripts: Record<(...), (...)>;
        outputs: Record<(...), (...)>;
        resources?: (...)[];
        roles: Record<(...), (...)>;
        scenarios?: unknown;
        scripts: Record<(...), (...)>;
        start: (...)[];
        supported: (...)[];
        transactions?: Record<(...), (...)>;
        variables?: Record<(...), (...)>;
        version?: string;
    }

    The XO Template.

    Type Declaration

    • $schema: string

      The URI that identifies the JSON Schema used by this template. This enables documentation, autocompletion, and validation in JSON documents.

    • actions: Record<(...), (...)>

      The actions defined in this template.

    • Optionalconstants?: Record<(...), (...)>

      The constants defined in this template.

    • Optionaldata?: Record<(...), (...)>

      The data fields defined in this template.

    • Optionaldefaults?: XOTemplateDefaults

      Optional default settings used in this template.

    • Optionalicons?: (...)[]

      The icons available for use throughout the template.

    • inputs: Record<(...), (...)>

      The inputs defined in this template.

    • lockingScripts: Record<(...), (...)>

      The locking script templates defined in this template.

    • outputs: Record<(...), (...)>

      The outputs defined in this template.

    • Optionalresources?: (...)[]

      Resource references providing external documentation or tooling links.

    • roles: Record<(...), (...)>

      The roles defined in this template.

    • Optionalscenarios?: unknown

      The scenarios defined in this template.

    • scripts: Record<(...), (...)>

      The scripts used in this template, The keys are identifiers of the scripts and the values are the bytecode or cashASM expressions.

    • start: (...)[]

      A list of entry points defining which actions are available at the start.

    • supported: (...)[]

      The BCH VM versions that this template supports. At least one version is required.

    • Optionaltransactions?: Record<(...), (...)>

      The transaction templates defined in this template.

    • Optionalvariables?: Record<(...), (...)>

      The variables that must be provided for use in the template's scripts.

    • Optionalversion?: string

      A string identifying the version of this template.

    Settings

    Member Visibility