js-moi-manifest/types/manifest.d.ts

Module to encode and decode MOI Logic Engine input and output.

export declare module LogicManifest {
  export interface EngineConfig {
    kind: string;
    flags: string[];
  }

  export enum ManifestKind {
    LOGIC = "logic",
    ASSET = "asset",
  }

  export interface TypeField {
    slot: number;
    label: string;
    type: string;
  }

  export interface MethodField {
    ptr: number | bigint;
    code: number | bigint;
  }

  export interface Class {
    name: string;
    fields?: TypeField[] | null;
    methods?: MethodField[] | null;
  }

  export enum RoutineMode {
    STATIC = "static",
    DYNAMIC = "dynamic",
  }

  export enum StateMode {
    STATIC = "logic",
    DYNAMIC = "actor",
  }

  export interface State {
    mode: StateMode;
    fields: TypeField[];
  }

  export interface Literal {
    type: string;
    value: string;
  }

  export interface Instructions {
    bin?: number[] | null;
    hex?: string;
    asm?: string[] | null;
  }

  export interface Routine {
    name: string;
    kind: string;
    mode: RoutineMode;
    accepts?: TypeField[] | null;
    returns?: TypeField[] | null;
    executes: Instructions;
    catches?: string[] | null;
  }

  export interface Method {
    name: string;
    class: string;
    mutable: boolean;
    accepts?: TypeField[] | null;
    returns?: TypeField[] | null;
    executes: Instructions;
    catches?: string[] | null;
  }

  export interface ExternalRoutine {
    name: string;
    accepts?: TypeField[] | null;
    returns?: TypeField[] | null;
  }

  export interface Extern {
    name: string;
    logic: State;
    actor: State;
    endpoint: ExternalRoutine[];
  }

  export interface Event {
    name: string;
    topics: number;
    fields: TypeField[];
  }

  export type TypeDef = string;

  export type ElementKind =
    | State
    | Literal
    | TypeDef
    | Routine
    | Class
    | Method
    | Event;

  export interface Element<TElementKind = ElementKind> {
    ptr: number;
    kind: string;
    deps?: number[] | null;
    data: TElementKind;
  }

  export interface Manifest {
    syntax: number;
    engine: EngineConfig;
    kind: ManifestKind;
    elements: Element[];
  }

  export interface EventDef {
    ptr: number;
    topics: number;
  }

  export interface MethodDef {
    ptr: number;
    class: string;
  }

  export interface CallSite {
    ptr: number;
    kind: string;
  }
  
  export interface EventDef {
    ptr: number;
    topics: number;
  }

  export interface MethodDef {
    ptr: number;
    class: string;
  }

  export interface CallSite {
    ptr: number;
    kind: string;
  }
}