chore(schema): add description to schema (#84)

.github/dependabot.yml

@@ -13,3 +13,12 @@ updates:
         patterns:
           - 'eslint'
           - '@eslint/*'
+
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    groups:
+      chainfile-definitions:
+        patterns:
+          - 'chainfile-*'

packages/chainfile-schema/schema.json

@@ -12,6 +12,11 @@
         "$schema": {
           "type": "string"
         },
+        "description": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024
+        },
         "caip2": {
           "type": "string",
           "pattern": "^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$",
@@ -85,6 +90,11 @@
           },
           "required": ["length", "encoding"],
           "additionalProperties": false
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024
         }
       },
       "allOf": [
@@ -128,7 +138,14 @@
         "source": {
           "type": "string",
           "description": "Source of the container image.",
-          "format": "uri"
+          "format": "uri",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024
         },
         "endpoints": {
           "type": "object",
@@ -203,6 +220,13 @@
     "Endpoint": {
       "type": "object",
       "description": "Extension to ports, endpoints are used to expose the container to the outside world with a specific protocol for interfacing.",
+      "properties": {
+        "description": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024
+        }
+      },
       "oneOf": [
         {
           "$ref": "#/definitions/EndpointPort"

packages/chainfile-testcontainers/src/container.ts

@@ -3,7 +3,6 @@ import { randomInt } from 'node:crypto';
 
 import {
   Container,
-  Endpoint,
   EndpointHttpAuthorization,
   EndpointHttpJsonRpc,
   EndpointHttpRest,
@@ -34,7 +33,7 @@ export class ChainfileContainer extends AbstractStartedContainer {
     return this.getMappedPort(endpoint.port);
   }
 
-  private getEndpoint<E extends Endpoint>(name: string): E {
+  private getEndpoint<E>(name: string): E {
     const endpoint = this.container.endpoints?.[name];
     if (endpoint === undefined) {
       throw new Error(`Endpoint: '${name}' not found.`);

website/components/ChainfileDefinition.mdx

@@ -0,0 +1,69 @@
+### Values
+
+These values have reasonable defaults or are randomly generated values for secured fields
+which will determine how the Chainfile is run.
+You may override these values to customize the Chainfile for your specific needs.
+
+{Object.entries(props.schema.values).map(([key, value]) => {
+const defaultValue = typeof value === 'string' ? value : value.default;
+
+return (
+
+<>
+<h5>{key} {value.required && <code className="nx-text-xs nx-font-normal">required</code>}</h5>
+
+{value.description && <p>{value.description}</p>}
+{defaultValue && <p>Default: <code>{defaultValue}</code></p>}
+
+{value.random?.type === 'bytes' && <p>Random: <code>randomBytes({value.random.length}).toString({value.random.encoding})</code></p>}
+
+</>
+)})}
+
+### Containers
+
+{Object.entries(props.schema.containers).map(([key, container]) => {
+return (
+
+<>
+<h4>{key}</h4>
+
+{container.description && <p>{container.description}</p>}
+
+{Object.entries(container.endpoints).map(([key, endpoint]) => {
+
+return (
+
+<>
+
+<h5>
+  endpoint: <code>{key}</code>
+</h5>
+
+{endpoint.description && <p>{endpoint.description}</p>}
+
+<ul>
+  {endpoint.port && (
+    <li>
+      Port: <code>{endpoint.port}</code>
+    </li>
+  )}
+  {endpoint.protocol && (
+    <li>
+      Protocol: <code>{endpoint.protocol}</code>
+    </li>
+  )}
+  {endpoint.path && (
+    <li>
+      Path: <code>{endpoint.path}</code>
+    </li>
+  )}
+  {endpoint.probes && <li>Probes: {Object.keys(endpoint.probes).join(', ')}</li>}
+  {endpoint.authorization && <li>Authorization: required</li>}
+</ul>
+
+</>
+)})}
+
+</>
+)})}

website/package.json

@@ -32,6 +32,9 @@
     "@types/react": "^18.3.3",
     "@workspace/eslint-config-next": "workspace:*",
     "autoprefixer": "^10.4.19",
+    "chainfile-ganache": "^0.1.0",
+    "chainfile-hardhat": "^0.4.3",
+    "chainfile-solana": "^0.2.1",
     "postcss": "^8.4.38",
     "tailwindcss": "^3.4.4"
   }

website/pages/definitions/bitcoin.mdx

@@ -1 +1,3 @@
 # Bitcoin
+
+Definition(s) is maintained by the Chainfile maintainers.

website/pages/definitions/defichain.mdx

@@ -0,0 +1,3 @@
+# Defichain
+
+Definition(s) is maintained by the Chainfile maintainers.

website/pages/definitions/ethereum.mdx

@@ -1 +1,3 @@
 # Ethereum
+
+Definition(s) is maintained by the Chainfile maintainers.

website/pages/definitions/ganache.mdx

@@ -1,14 +1,18 @@
+import { Callout } from 'nextra/components';
+import ChainfileDefinition from '../../components/ChainfileDefinition.mdx';
+import ganache from 'chainfile-ganache/ganache.json';
+
 # Ganache
 
-import { Callout } from 'nextra/components';
+Definition(s) is maintained by the Chainfile maintainers.
 
 <Callout type="warning">
-  The Truffle Suite has deprecated Ganache in favor of [Hardhat](hardhat). This Chainfile definition is created for
-  legacy compatibility only.
+
+The Truffle Suite has deprecated Ganache in favor of [Hardhat](hardhat).
+This Chainfile definition is created for legacy compatibility only.
+
 </Callout>
 
 ## ganache.json
 
-```txt filename="Location" copy
-chainfile-ganache/ganache.json
-```
+<ChainfileDefinition schema={ganache} />

website/pages/definitions/hardhat.mdx

@@ -1,5 +1,10 @@
+import ChainfileDefinition from '../../components/ChainfileDefinition.mdx';
+import hardhat from 'chainfile-hardhat/hardhat.json';
+
 # Hardhat
 
+Definition(s) is maintained by the Chainfile maintainers.
+
 Hardhat is a development environment to compile, deploy, test, and debug your Ethereum software.
 You can use Hardhat directly within your Node.js.
 This definition provides a containerized version of Hardhat for local toolchain isolation,
@@ -12,41 +17,4 @@ You should not use this definition for any production purposes.
 
 ## hardhat.json
 
-```txt filename="Location" copy
-chainfile-hardhat/hardhat.json
-```
-
-### Values
-
-- `version`: the version of Hardhat to use see [vetumorg/chainfile-hardhat/pkgs](https://github.com/vetumorg/chainfile-hardhat/pkgs/container/hardhat)
-
-## Using `hardhat-testcontainers` with `viem`
-
-If you're using Node.js and want to take advantage of `viem` for type-safe JSON-RPC.
-We provide a NPM only package for `hardhat-testcontainers`:
-
-```shell filename="Installation" copy
-npm i -D hardhat-testcontainers viem
-```
-
-```typescript filename="hardhat.test.ts" {9} copy
-import { afterAll, beforeAll, expect, it } from '@jest/globals';
-import { HardClient, HardhatContainer, StartedHardhatContainer } from 'hardhat-testcontainers';
-
-let container: StartedHardhatContainer;
-let client: HardClient;
-
-beforeAll(async () => {
-  container = await new HardhatContainer().start();
-  client = container.client;
-});
-
-afterAll(async () => {
-  await container.stop();
-});
-
-it('should rpc(eth_blockNumber) via viem using container.client', async () => {
-  const blockNumber = await client.getBlockNumber();
-  expect(blockNumber).toStrictEqual(BigInt(0));
-});
-```
+<ChainfileDefinition schema={hardhat} />

website/pages/definitions/solana.mdx

@@ -1,7 +1,10 @@
+import ChainfileDefinition from '../../components/ChainfileDefinition.mdx';
+import test_validator from 'chainfile-solana/test-validator.json';
+
 # Solana
 
+Definition(s) is maintained by the Chainfile maintainers.
+
 ## test-validator.json
 
-```txt filename="Location" copy
-chainfile-solana/test-validator.json
-```
+<ChainfileDefinition schema={test_validator} />