@tetherto/mdk-app-runtime 0.0.0 → 0.12.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Tether
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,106 @@
+# @tetherto/mdk-app-runtime
+
+## Overview
+
+Runs one app in its own process and serves its route handlers over **HRPC**. An app is a directory with an
+`mdk-app.yaml` manifest and a route table (`mdk-plugin.json`, in `plugin/` or the app root) whose handlers are ordinary
+Gateway-plugin controllers, loaded through this package's [plugin loader](./lib/plugin-loader.js). The
+[Gateway](../gateway/README.md) reads only the route table, with the same loader, and forwards each request to the app's
+runtime; it runs no app code.
+
+- **Own Kernel identity**: a per-app keypair, persisted under `storeDir`, is exposed to controllers as `config.kernelKeyPair`, so
+  `createMdkClient(config)` connects with the app's own key. The config is frozen and `secretKey` is non-enumerable.
+- **Closed front door**: the HRPC server accepts only the keys in `allowedKeys` and `allowedKeyFiles`. An empty allow set denies
+  everyone, unlike the Kernel listener, where an empty whitelist is open.
+
+Controllers `require('@tetherto/mdk-gateway/plugin')` and get a frozen `{ config, logger, onReady }` context. The loader
+answers that specifier itself, so the app runtime and its apps don't need `@tetherto/mdk-gateway` installed.
+
+## Options
+
+`createAppRuntime(opts)` returns `{ name, manifest, routes, start(), stop(), getPublicKey(), getKernelPublicKey() }`. `start()`
+resolves `{ publicKey }`; `start()` and `stop()` are idempotent.
+
+| Option | Status | Type | Default | Description |
+|--------|--------|------|---------|-------------|
+| `name` | Required | `string` | None | Operator-owned handle; also the log namespace `mdk:app:<name>` |
+| `appDir` | Required | `string` | None | App directory holding `mdk-app.yaml` and the route table |
+| `config` | Optional | `object` | `{}` | Operator overrides; wins over the manifest's `config` defaults |
+| `kernelKey` | Optional | `string` | None | Kernel listener public key, exposed as `config.kernelKey` |
+| `kernelBootstrap` | Optional | `object` | None | Exposed as `config.kernelBootstrap` |
+| `bootstrap` | Optional | `array` | HyperDHT default | DHT bootstrap nodes for the runtime's server (testnets) |
+| `storeDir` | Optional | `string` | None | Persists the RPC and Kernel seeds (`0o600`) so both keys survive restarts; without it they are random per start. Its `data/` subdirectory is the app's own writable directory, passed as `config.dataDir` (`null` without a `storeDir`) |
+| `allowedKeys` | Optional | `string[]` | `[]` | Hex public keys allowed to call the runtime |
+| `allowedKeyFiles` | Optional | `string[]` | `[]` | Files holding hex keys (64 hex characters, whitespace-separated), re-read on every connection so start order does not matter. A file is skipped, with one warning, unless it is a regular file (not a symlink) owned by the runtime's user and not group/world-writable; `0644` is fine |
+| `keyFile` | Optional | `string` | None | Where the runtime writes its public key once listening (the Gateway's `apps[].keyFile`) |
+| `kernelKeyFile` | Optional | `string` | None | Where the runtime writes its Kernel public key on `start()`, for the Kernel's `auth.whitelist` |
+| `logger` | Optional | `object` | `debug`-based | Overrides the default logger |
+
+`getPublicKey()` is the HRPC server key while serving, otherwise `null`. `getKernelPublicKey()` is the public half of
+`config.kernelKeyPair`, available before `start()`.
+
+`bin/run-app.js` (`mdk-app-runtime`) is what `mdk run` spawns for each app: it reads the options as JSON from
+`MDK_APP_RUNTIME_OPTIONS`, reports `{ type: 'ready', publicKey }` or `{ type: 'error', message }` over IPC, and stops on
+`SIGTERM`, `SIGINT` or IPC disconnect. `mdk-app-runtime --help` prints usage.
+
+A caller whose key is allowed is fully trusted: it reaches every route without the Gateway's auth, schema checks or rate limit,
+and the `identity` it sends arrives as the controller's `req._info` as is. Allow only the Gateway's key, and keep its key file
+writable by the runtime's user alone. On Linux, `MDK_APP_RUNTIME_OPTIONS` stays readable in `/proc/<pid>/environ` (to the same
+user and root) after the runtime deletes it from `process.env`.
+
+## Client API
+
+`createRuntimeClient({ seed, bootstrap, dht, rpc, poolLingerMs, maxStreamBufferBytes })` is the caller side, used by the Gateway:
+one key (derived from `seed`, or the injected `rpc`'s) for every runtime it calls.
+
+| Member | Description |
+|--------|-------------|
+| `publicKey` | `Buffer`: the key every runtime sees; list it in their `allowedKeyFiles` |
+| `connect()` | Opens the transport |
+| `invoke(runtimeKey, routeId, req, { identity, timeoutMs, signal })` | Unary call; `req` is `{ params, query, body, headers }`. Rejects with an error carrying `.statusCode`. Aborting `signal` while the connection is still opening drops the request before it is sent |
+| `stream(runtimeKey, routeId, req, { identity, timeoutMs, signal })` | For `stream: true` routes; resolves `{ statusCode, headers, stream }`. Aborting `signal` before the head closes the channel. See [Stream backpressure](#stream-backpressure) |
+| `close()` | Closes the transport it owns (an injected `rpc` / `dht` is left open) |
+
+`pipeToResponse(result, rawResponse)` writes a stream result to a Node `ServerResponse`. `resolvePluginDir(appDir)` returns the
+directory holding `mdk-plugin.json` (`<appDir>/plugin`, then `<appDir>`). The wire protocol is described at the top of
+[`lib/protocol.js`](./lib/protocol.js).
+
+### Stream backpressure
+
+The stream protocol has no flow control, and the transport does not slow the runtime down when the caller stops reading. So
+each stream's unread body is capped at `maxStreamBufferBytes` (default 16 MiB): past it the client destroys the stream with
+`ERR_APP_STREAM_OVERFLOW` and closes the channel, the runtime stops sending, and the handler's `raw` emits `'close'`. Behind
+the Gateway, an HTTP client that reads too slowly gets a truncated response. On the runtime side, `raw.write()` returns
+`false` while the connection's send buffer is full and `raw` emits `'drain'` when it empties, so a handler that respects
+`write()`'s return value (or pipes with `stream.pipeline`) does not pile data up in the runtime.
+
+## Manifest
+
+`loadAppManifest(appDir)` / `validateAppManifest(obj, label)` read and validate `mdk-app.yaml`; other keys pass through.
+
+| Field | Status | Description |
+|-------|--------|-------------|
+| `id` | Required | Reverse-DNS id, e.g. `io.tether.example` |
+| `version` | Required | Semver |
+| `displayName` | Required | Human name |
+| `description` | Optional | One-line summary |
+| `permissions` | Optional | Rules `{ resources, verbs, resourceNames? }`, declared for operator review. The Kernel does not enforce them yet: the runtime's Kernel key is admitted with full access. |
+| `config` | Optional | Default config handed to the controllers |
+| `main` | Optional | The app's background logic, `<file>[#export]` beside the route table. The export is called as `main(config, context)` and awaited before the runtime first serves, in the same module registry as the controllers, so state it sets up is theirs too. A rejection fails `start()` |
+
+## Errors
+
+| Code | Meaning |
+|------|---------|
+| `ERR_APP_MANIFEST_MISSING` / `ERR_APP_MANIFEST_INVALID` | `mdk-app.yaml` absent or invalid |
+| `ERR_PLUGIN_MANIFEST_MISSING` | No `mdk-plugin.json` in `<appDir>/plugin` or `<appDir>` |
+| `ERR_PLUGIN_*` | Other route table or handler problems, thrown by [`loadPlugin()`](./lib/plugin-loader.js) |
+| `ERR_APP_RUNTIME_SEED_INVALID` | A persisted seed file is not 32 bytes |
+| `ERR_APP_ROUTE_NOT_FOUND` | Unknown route id (404) |
+| `ERR_APP_PROTOCOL_VERSION` | Caller and runtime disagree on the protocol version |
+| `ERR_APP_RUNTIME_UNAVAILABLE` | Runtime unreachable, or it does not allow the caller's key (502) |
+| `ERR_APP_RUNTIME_TIMEOUT` | No answer (or stream head) within `timeoutMs` (504) |
+| `ERR_APP_REQUEST_ABORTED` | The caller's `signal` aborted the call |
+| `ERR_APP_STREAM_OVERFLOW` | A stream's reader fell more than `maxStreamBufferBytes` behind; the stream was torn down |
+| `ERR_APP_MAIN_NOT_FUNCTION` | `main` in `mdk-app.yaml` does not name a function |
+| `ERR_APP_RUNTIME_CLIENT_NOT_CONNECTED` | A client call before `connect()` |

package/bin/run-app.js

@@ -0,0 +1,118 @@
+#!/usr/bin/env node
+'use strict'
+
+// Entry point for a supervised app-runtime child process. The supervisor (the
+// CLI) passes createAppRuntime's options as JSON in MDK_APP_RUNTIME_OPTIONS
+// (kernelKey / allowedKeys as hex strings) and listens for IPC messages:
+//   { type: 'ready', publicKey: <hex> }   serving
+//   { type: 'error', message }            start failed (process exits 1)
+// SIGTERM, SIGINT or IPC disconnect stop the runtime and exit 0.
+// `--help` / `-h` prints usage and exits 0.
+
+const ENV_OPTIONS = 'MDK_APP_RUNTIME_OPTIONS'
+
+const USAGE = `Usage: ${ENV_OPTIONS}='<json>' mdk-app-runtime
+
+Runs one MDK app runtime: loads the app at options.appDir and serves its
+routes over HRPC until SIGTERM, SIGINT or IPC disconnect.
+
+${ENV_OPTIONS} holds the createAppRuntime() options as a JSON object
+(name, appDir, storeDir, kernelKey, allowedKeys, allowedKeyFiles, keyFile, ...;
+keys as hex strings). It is removed from the environment before the app loads.
+Normally started by \`mdk run\`, which sets it.
+
+Options:
+  -h, --help  Print this help and exit
+`
+
+function _defaultIo () {
+  return {
+    send: typeof process.send === 'function' ? (msg) => process.send(msg) : null,
+    stdout: (text) => process.stdout.write(text),
+    stderr: (line) => process.stderr.write(line + '\n'),
+    exit: (code) => process.exit(code),
+    on: (event, fn) => process.on(event, fn)
+  }
+}
+
+async function main (env, io, argv) {
+  env = env || process.env
+  io = { ..._defaultIo(), ...io }
+
+  if ((argv || []).some((arg) => arg === '--help' || arg === '-h')) {
+    io.stdout(USAGE)
+    io.exit(0)
+    return null
+  }
+
+  let runtime = null
+  const fail = (err) => {
+    const message = (err && err.message) || String(err)
+    if (io.send) {
+      try { io.send({ type: 'error', message }) } catch {}
+    }
+    io.stderr(`mdk-app-runtime: ${message}`)
+    io.exit(1)
+    return null
+  }
+
+  let options
+  try {
+    if (!env[ENV_OPTIONS]) throw new Error(`ERR_APP_RUNTIME_OPTIONS_REQUIRED: set ${ENV_OPTIONS}`)
+    try {
+      options = JSON.parse(env[ENV_OPTIONS])
+    } catch (err) {
+      throw new Error(`ERR_APP_RUNTIME_OPTIONS_INVALID: ${ENV_OPTIONS} is not valid JSON`)
+    }
+    if (!options || typeof options !== 'object' || Array.isArray(options)) {
+      throw new Error(`ERR_APP_RUNTIME_OPTIONS_INVALID: ${ENV_OPTIONS} must be a JSON object`)
+    }
+    // The options carry the app's config: keep it out of anything the app spawns.
+    delete env[ENV_OPTIONS]
+  } catch (err) {
+    return fail(err)
+  }
+
+  let publicKey
+  try {
+    const { createAppRuntime } = require('../lib/runtime')
+    runtime = createAppRuntime(options)
+    publicKey = (await runtime.start()).publicKey
+  } catch (err) {
+    if (runtime) await runtime.stop().catch(() => {})
+    return fail(err)
+  }
+
+  let stopping = null
+  const shutdown = () => {
+    if (!stopping) {
+      stopping = runtime.stop().then(() => io.exit(0), (err) => {
+        io.stderr(`mdk-app-runtime: stop failed: ${err && err.message}`)
+        io.exit(1)
+      })
+    }
+    return stopping
+  }
+  io.on('SIGTERM', shutdown)
+  io.on('SIGINT', shutdown)
+  io.on('disconnect', shutdown)
+
+  if (io.send) {
+    try {
+      io.send({ type: 'ready', publicKey: publicKey.toString('hex') })
+    } catch {
+      // The supervisor's IPC channel is gone; nobody is waiting for this runtime.
+      shutdown()
+    }
+  }
+  return { runtime, shutdown }
+}
+
+module.exports = { main, ENV_OPTIONS, USAGE }
+
+if (require.main === module) {
+  main(process.env, undefined, process.argv.slice(2)).catch((err) => {
+    process.stderr.write(`mdk-app-runtime: ${err && err.message}\n`)
+    process.exit(1)
+  })
+}

package/index.js

@@ -0,0 +1,14 @@
+'use strict'
+
+// Modules are required lazily so a consumer that only needs the manifest
+// helpers does not pull hyperswarm into its process.
+
+module.exports = {
+  get createAppRuntime () { return require('./lib/runtime').createAppRuntime },
+  get getOrCreateSeed () { return require('./lib/runtime').getOrCreateSeed },
+  get createRuntimeClient () { return require('./lib/client').createRuntimeClient },
+  get pipeToResponse () { return require('./lib/client').pipeToResponse },
+  get loadAppManifest () { return require('./lib/manifest').loadAppManifest },
+  get validateAppManifest () { return require('./lib/manifest').validateAppManifest },
+  get resolvePluginDir () { return require('./lib/manifest').resolvePluginDir }
+}