@cef-ebsi/vcdm1.1-trusted-nodes-list-schema

EBSI Trusted Nodes List

Schema of an EBSI Trusted Nodes List

The schema is published to the Trusted Schemas Registry with the IDs:

• 0xbd2f371da8965fb6adecdd57b7ed2a899728fec9666fde76ec017765e2b9a077 (hexadecimal)
• zDjVp7fDTKbhqFUuCSQ7tvxGMPjns8KeyqfMSFUREuyq8 (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EBSI Trusted Nodes List",
  "description": "Schema of an EBSI Trusted Nodes List",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
    },
    {
      "properties": {
        "type": {
          "description": "Full type chain, used to identify the credential base types",
          "type": "array",
          "items": {
            "type": "string"
          },
          "contains": {
            "type": "string",
            "const": "TrustedNodesList"
          },
          "uniqueItems": true
        },
        "credentialSubject": {
          "description": "Defines additional information about the Trusted Nodes List",
          "type": "object",
          "properties": {
            "id": {
              "description": "DID of Service Ops Manager who approved the Trusted Nodes List",
              "type": "string",
              "format": "uri"
            },
            "environment": {
              "description": "Defines the environment for which the Trusted Nodes List is valid",
              "type": "string",
              "enum": ["test", "pilot", "conformance", "preprod", "prod"]
            },
            "chainId": {
              "description": "Defines the chain ID, which is part of the transaction signing process to protect against transaction replay attacks",
              "type": "number"
            },
            "version": {
              "description": "Defines the version of the Trusted Nodes List. First version MUST be 1",
              "type": "number"
            },
            "nodesTotal": {
              "description": "Defines the total number of nodes in the list",
              "type": "number"
            },
            "nodes": {
              "description": "Defines the list of nodes",
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "apis": {
                    "description": "MUST be a valid domain name starting with https://api-{environment}.ebsi. On production, \"-{environment}\" is skipped. The URL will therefore start with \"https://api.ebsi.\"",
                    "type": "string",
                    "format": "uri"
                  },
                  "apps": {
                    "description": "MUST be a valid domain name starting with https://app-{environment}.ebsi. On production, \"-{environment}\" is skipped. The URL will therefore start with \"https://app.ebsi.\"",
                    "type": "string",
                    "format": "uri"
                  },
                  "explorer": {
                    "description": "MUST be a valid domain name starting with https://blockexplorer-{environment}.ebsi. On production, \"-{environment}\" is skipped. The URL will therefore start with \"https://blockexplorer.ebsi.\"",
                    "type": "string",
                    "format": "uri"
                  },
                  "country": {
                    "description": "MUST be a three-letter country code as per ISO 3166-1 alpha-3",
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 3
                  }
                },
                "required": ["apis", "apps", "country"]
              }
            }
          },
          "required": [
            "id",
            "environment",
            "chainId",
            "version",
            "nodesTotal",
            "nodes"
          ]
        }
      },
      "required": ["credentialSubject", "termsOfUse"]
    }
  ]
}

Installation

# with npm
npm add @cef-ebsi/[email protected]

# with Yarn
yarn add @cef-ebsi/[email protected]

# with pnpm
pnpm add @cef-ebsi/[email protected]

Usage

The package exports the schema and its metadata as JavaScript objects:

import { schema, metadata } from "@cef-ebsi/vcdm1.1-trusted-nodes-list-schema";

// you can now use the schema and metadata

In addition, the package exports a TypeScript type corresponding to the schema:

import type { EBSITrustedNodesList } from "@cef-ebsi/vcdm1.1-trusted-nodes-list-schema";

License

Copyright (C) 2024 European Union

This program is free software: you can redistribute it and/or modify it under the terms of the EUROPEAN UNION PUBLIC LICENCE v. 1.2 as published by the European Union.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the EUROPEAN UNION PUBLIC LICENCE v. 1.2 for further details.

You should have received a copy of the EUROPEAN UNION PUBLIC LICENCE v. 1.2. along with this program. If not, see https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12.