module.yaml.json

{
  "type": "object",
  "$id": "https://fluence.dev/schemas/module.yaml",
  "title": "module.yaml",
  "description": "Defines [Marine Module](https://fluence.dev/docs/build/concepts/#modules). You can use 'fluence module new' command to generate a template for new module",
  "properties": {
    "name": {
      "type": "string",
      "description": "\"name\" property from the Cargo.toml (for module type \"rust\") or name of the precompiled .wasm file (for module type \"compiled\")"
    },
    "type": {
      "type": "string",
      "enum": [
        "rust",
        "compiled"
      ],
      "nullable": true,
      "default": "compiled",
      "description": "Module type \"compiled\" is for the precompiled modules. Module type \"rust\" is for the source code written in rust which can be compiled into a Marine module"
    },
    "maxHeapSize": {
      "type": "string",
      "nullable": true,
      "description": "Max size of the heap that a module can allocate in format: [number][whitespace?][specificator?] where ? is an optional field and specificator is one from the following (case-insensitive):\nK, Kb - kilobyte\nKi, KiB - kibibyte\nM, Mb - megabyte\nMi, MiB - mebibyte\nG, Gb - gigabyte\nGi, GiB - gibibyte\nCurrent limit is 4 GiB"
    },
    "loggerEnabled": {
      "type": "boolean",
      "nullable": true,
      "description": "Set true to allow module to use the Marine SDK logger"
    },
    "loggingMask": {
      "type": "number",
      "nullable": true,
      "description": "manages the logging targets, described in detail: https://fluence.dev/docs/marine-book/marine-rust-sdk/developing/logging#using-target-map"
    },
    "volumes": {
      "type": "object",
      "nullable": true,
      "required": [],
      "title": "Volumes",
      "additionalProperties": {
        "type": "string"
      },
      "properties": {
        "Alias": {
          "type": "string",
          "description": "path"
        }
      },
      "description": "A map of accessible files and their aliases. Aliases should be used in Marine module development because it's hard to know the full path to a file"
    },
    "envs": {
      "type": "object",
      "title": "Environment variables",
      "nullable": true,
      "required": [],
      "additionalProperties": {
        "type": "string"
      },
      "properties": {
        "Environment_variable_name": {
          "type": "string",
          "description": "Environment variable value"
        }
      },
      "description": "environment variables accessible by a particular module with standard Rust env API like this: std::env::var(IPFS_ADDR_ENV_NAME). Please note that Marine adds three additional environment variables. Module environment variables could be examined with repl"
    },
    "mountedBinaries": {
      "title": "Mounted binaries",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "properties": {
        "Mounted_binary_name": {
          "type": "string",
          "description": "Path to a mounted binary"
        }
      },
      "nullable": true,
      "required": [],
      "description": "A map of binary executable files that module is allowed to call. Example: curl: /usr/bin/curl"
    },
    "version": {
      "type": "number",
      "const": 0
    }
  },
  "required": [
    "version",
    "name"
  ]
}