@attestate/crawler/src/schemata/configuration.mjs

@attestate/crawler is a tool chain to retrieve on-chain data from Ethereum.

//@format
const path = {
  type: "array",
  minItems: 1,
  items: {
    type: "object",
    properties: {
      name: {
        type: "string",
        // PROBLEM: The message router expects a globally unique strategy name
        $comment: "strategy names for now must be globally unique",
      },
      coordinator: {
        type: "object",
        $comment:
          "Coordinates the state of the application by e.g. re-running jobs after a period.",
        additionalProperties: false,
        required: ["module", "interval"],
        properties: {
          archive: {
            type: "boolean",
            default: false,
            $comment:
              "If false, then extraction and transformation files in the data dir will be deleted. Otherwise they'll be prefixed with a timestamp to be archived (default: false).",
          },
          module: {
            type: "object",
          },
          interval: {
            type: "integer",
            $comment:
              "The time in milliseconds after which a task is re-run automatically.",
          },
        },
      },
      extractor: {
        type: "object",
        properties: {
          module: {
            type: "object",
          },
          args: {
            type: "object",
          },
          input: {
            type: "object",
            properties: {
              name: {
                type: "string",
              },
            },
            required: ["name"],
          },
          output: {
            type: "object",
            properties: {
              name: {
                type: "string",
              },
            },
            required: ["name"],
          },
        },
        required: ["output", "module", "args"],
        additionalProperties: true,
      },
      transformer: {
        type: "object",
        properties: {
          module: {
            type: "object",
          },
          args: {
            type: "object",
          },
          input: {
            type: "object",
            properties: {
              name: {
                type: "string",
              },
            },
            required: ["name"],
          },
          output: {
            type: "object",
            properties: {
              name: {
                type: "string",
              },
            },
            required: ["name"],
          },
        },
        required: ["input", "output", "module", "args"],
        additionalProperties: true,
      },
      loader: {
        type: "object",
        properties: {
          module: {
            type: "object",
          },
          input: {
            type: "object",
            properties: {
              name: {
                type: "string",
              },
            },
            required: ["name"],
          },
          output: {
            type: "object",
            properties: {
              name: {
                type: "string",
              },
            },
            required: ["name"],
          },
        },
        required: ["input", "output", "module"],
        additionalProperties: true,
      },
    },
    required: ["name"],
  },
};

const environment = {
  type: "object",
  additionalProperties: false,
  required: [
    "rpcHttpHost",
    "dataDir",
    "ipfsHttpsGateway",
    "arweaveHttpsGateway",
  ],
  properties: {
    rpcHttpHost: {
      type: "string",
      format: "uri",
      pattern: "^https?://",
    },
    rpcApiKey: {
      type: "string",
    },
    dataDir: {
      type: "string",
    },
    ipfsHttpsGateway: {
      type: "string",
      format: "uri",
      pattern: "^https?://",
    },
    ipfsHttpsGatewayKey: {
      type: "string",
    },
    arweaveHttpsGateway: {
      type: "string",
      format: "uri",
      pattern: "^https?://",
    },
  },
};

const config = {
  type: "object",
  required: ["queue"],
  properties: {
    environment,
    path: { ...path },
    queue: {
      type: "object",
      required: ["options"],
      properties: {
        options: {
          type: "object",
          required: ["concurrent"],
          properties: {
            concurrent: { type: "integer" },
          },
        },
      },
    },
    endpoints: {
      type: "object",
      propertyNames: {
        format: "uri",
      },
      patternProperties: {
        "^.*$": {
          type: "object",
          properties: {
            requestsPerUnit: {
              type: "number",
            },
            unit: {
              enum: ["second", "minute", "hour", "day"],
            },
            timeout: {
              type: "number",
            },
          },
          dependencies: {
            requestsPerUnit: ["unit"],
            unit: ["requestsPerUnit"],
          },
          additionalProperties: false,
        },
      },
    },
  },
};

export default config;