@adviser/ovn-fabric 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 meno
+
+   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,131 @@
+# ovn-fabric
+
+A declarative OVN/OVS network topology generator. You describe a network —
+hosts, segments, uplinks, VPN tunnels — as plain TypeScript, and ovn-fabric
+emits **one self-installing shell script per host**. Copy that script to the
+host and run it: it creates the OVS bridges/interfaces, builds the full OVN
+logical topology (routers, switches, NAT), and installs itself as a
+boot-time systemd unit — idempotently, so re-running it (or rebooting) is
+always safe.
+
+No netplan, no hand-written `ovn-nbctl`/`ovs-vsctl` invocations, no
+configuration drift between "what I meant to set up" and "what's actually
+running." The config is the single source of truth; the generated script is
+a disposable, regeneratable artifact.
+
+## Install
+
+**Via npx** (no local Deno install required — the official
+[`deno`](https://www.npmjs.com/package/deno) npm package is pulled in
+automatically as a dependency the first time you run this):
+
+```sh
+npx ovn-fabric generate-ovn path/to/topology.ts > install.sh
+```
+
+**Via Deno**, if you already have it:
+
+```sh
+deno run -A jsr:@adviser/ovn-fabric generate-ovn path/to/topology.ts > install.sh
+```
+
+**As a permanent global command**:
+
+```sh
+deno install -g -A -n ovn-fabric jsr:@adviser/ovn-fabric
+```
+
+## Quickstart
+
+Copy [`examples/minimal-topology.ts`](examples/minimal-topology.ts) as a
+starting point:
+
+```ts
+import { defineNetwork } from "jsr:@adviser/ovn-fabric/define";
+import { segmentPhysical, uplinkPhysical } from "jsr:@adviser/ovn-fabric/factories";
+import { ManualUplink } from "jsr:@adviser/ovn-fabric/types";
+
+export const network = defineNetwork("minimal", (net) => {
+  const host = net.localHost("this-host");
+
+  const wan = net.uplink("wan", uplinkPhysical({
+    id: "1",
+    name: "eth0",
+    nat: { ipv4: [{ kind: "masq" }], ipv6: [{ kind: "masq" }] },
+    host,
+  }));
+
+  net.segment("lan", segmentPhysical({
+    id: "10",
+    name: "eth1",
+    uplink: new ManualUplink(wan),
+    slaac: false,
+    host,
+  }));
+});
+```
+
+Then:
+
+```sh
+npx ovn-fabric generate topology.ts       # sanity-check what it declares
+npx ovn-fabric generate-ovn topology.ts   # emit the install script(s)
+```
+
+`generate-ovn` prints one script per distinct `Host` your config declares.
+For a multi-host config, scripts are separated by a `# ===== host: X =====`
+marker line — never printed before the first script, since each script is
+meant to be saved and run (or `systemctl`-exec'd) as-is, and a leading
+non-shebang line would break that.
+
+## Model
+
+- **Host** — where a segment's or uplink's config actually gets applied
+  (`net.sshHost(name, address, user)` or `net.localHost(name)`). Every
+  segment/uplink declares its own host explicitly, so a multi-chassis
+  topology is a config change, not a redesign.
+- **Uplink** — a real (or eventually-real) path to the outside world:
+  `uplinkVlan`, `uplinkPhysical`, `uplinkDummy` (placeholder, no backing
+  interface yet), `uplinkWireguard` (a real `wg-quick`-managed tunnel).
+- **Segment** — a client-facing network (`segmentPhysical`, `segmentVlan`),
+  joined to the shared backbone and routed out through whichever uplink it
+  points at.
+- **Backdoor** — a second, dedicated transfer-link-shaped connection an
+  uplink can borrow from an *already-real* uplink's own egress. Used for
+  two distinct purposes: as a stand-in real interface while an uplink is
+  still a placeholder (`uplinkDummy`), or as pure bootstrap egress
+  alongside a real interface (e.g. a WireGuard tunnel's own handshake/
+  keepalive traffic needs a mundane path to the internet before the tunnel
+  itself is up).
+- **NAT** — per-uplink and per-segment; currently `{ kind: "masq" }` for
+  IPv4/IPv6 independently.
+
+See the doc comments in `src/types.ts` for the full model — every field has
+an explanation of what it's for and why it's shaped the way it is.
+
+## Design notes worth knowing before you rely on this
+
+- Boot safety: package checks (`dpkg -s`) on the systemd/boot path are
+  `timeout`-capped and warn-only — a missing tool never blocks router
+  startup. Real `apt-get install` only ever runs in the manual/first-run
+  branch, never from `systemctl`.
+- Idempotency throughout: `--may-exist`/`--if-exists` on every
+  `ovs-vsctl`/`ovn-nbctl` call, `ip link show ... || ...` guards, `cmp -s`
+  before overwriting any file (including WireGuard confs — the tunnel only
+  bounces if the content actually changed).
+- WireGuard uplinks use `wg-quick`, not hand-rolled `wg setconf` — this
+  relies on `wg-quick`'s own fwmark + policy-routing so the tunnel's own
+  traffic keeps using whatever path already exists (see Backdoor above)
+  while everything else gets diverted into the tunnel.
+
+## Publishing (maintainers)
+
+Tag a commit `vX.Y.Z` (matching the version in both `package.json` and
+`deno.json`) and push it — CI publishes to npm and JSR automatically via
+OIDC trusted publishing (see `.github/workflows/ci.yaml`; no token secrets
+involved, but it does require a one-time registry-side setup — see the
+comment at the top of that file).
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).

package/bin/ovn-fabric.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+// bin/ovn-fabric.js — the npx/npm entry point.
+//
+// ovn-fabric itself is a Deno/TypeScript CLI (see src/cli.ts) — this
+// shim is the only piece of the npm distribution that runs under Node.
+// It does nothing but locate the `deno` executable (installed
+// automatically as this package's own npm dependency — see
+// https://www.npmjs.com/package/deno, the official, Deno-team-
+// maintained npm distribution of the Deno runtime itself) and hand off
+// to it with the bundled src/cli.ts as the entrypoint. `deno` handles
+// picking the right prebuilt binary for the current OS/arch on its own
+// (via its optionalDependencies + postinstall) — nothing here needs to
+// know or care what platform it's running on.
+"use strict";
+
+const path = require("path");
+const { spawnSync } = require("child_process");
+
+// deno/bin.cjs is itself a small Node launcher (see the `deno` npm
+// package) that locates/spawns the real deno binary and forwards
+// argv — resolved via require.resolve so this works regardless of how
+// npm/pnpm/yarn hoisted node_modules.
+const denoLauncher = require.resolve("deno/bin.cjs");
+const cliEntry = path.join(__dirname, "..", "src", "cli.ts");
+
+const result = spawnSync(
+  process.execPath,
+  [
+    denoLauncher,
+    "run",
+    "--allow-read",
+    "--allow-env",
+    cliEntry,
+    ...process.argv.slice(2),
+  ],
+  { stdio: "inherit" },
+);
+
+if (result.error) {
+  console.error(result.error.message);
+  process.exit(1);
+}
+process.exit(result.status ?? 1);

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@adviser/ovn-fabric",
+  "version": "0.1.0",
+  "description": "Declarative OVN/OVS topology generator — one config, one self-installing shell script per host.",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "ovn-fabric": "bin/ovn-fabric.js"
+  },
+  "files": [
+    "bin",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mabels/ovn-fabric.git"
+  },
+  "homepage": "https://github.com/mabels/ovn-fabric#readme",
+  "bugs": {
+    "url": "https://github.com/mabels/ovn-fabric/issues"
+  },
+  "keywords": [
+    "ovn",
+    "ovs",
+    "sdn",
+    "networking",
+    "topology",
+    "deno",
+    "cli"
+  ],
+  "dependencies": {
+    "deno": "^2.9.1"
+  }
+}

package/src/addressing.ts

@@ -0,0 +1,222 @@
+// src/addressing.ts — the three fold rules, exactly once each, exposed
+// as NetId factories.
+//
+// Fold operation = string construction. Decimal identifiers are placed
+// directly into the address text, so the result stays human-readable
+// and visually corresponds to its IPv4 counterpart (fd00:10:80::128:1
+// reads as "segment 128", the same way 10.80.128.1 does). IPAddress.parse()
+// is called ONLY AFTER the string is fully built — it validates the
+// result and returns a real IPAddress for everything downstream
+// (containment checks, to_string(), comparisons). There is no integer
+// arithmetic on Crunchy here: that produces hex-folded results (segment
+// 128 -> "80") which breaks the human-readability property these rules
+// exist for.
+
+import { IPAddress } from "npm:ipaddress@0.2.6";
+import {
+  type NetId,
+  segmentId,
+  type SegmentId,
+  uplinkId,
+  type UplinkId,
+} from "./types.ts";
+
+function makeNetId(
+  ipv4Str: string,
+  ipv6Str: string,
+  rawId: number,
+  vlan: number | undefined,
+): NetId {
+  const ipv4 = IPAddress.parse(ipv4Str);
+  const ipv6 = IPAddress.parse(ipv6Str);
+  return {
+    ipv4,
+    ipv6,
+    id: () => rawId,
+    vlan: () => vlan,
+  };
+}
+
+// ── backbone: one shared /16, every identifier gets its own /28 block ──
+//
+// IPv4: 10.80.0.0/16, 4096 /28 blocks (same partition scheme as
+// transferNet's 10.99.0.0/16 — see that function's comment for the
+// general approach). block_base = identifier << 4. Within a block,
+// SEGMENTS use the low half (host offsets 1-7) and UPLINKS use the
+// high half (block_base | 0x8, host offsets 1-7 within that half) —
+// so a segment and an uplink that happen to share the same numeric
+// slot can never collide, both halves fit in the same /28 without
+// overlapping.
+//
+// IPv6 has no equivalent scarcity (128 bits is enormous) — it keeps
+// directly folding the real identifier into the network portion, with
+// a literal 0/8 marker group distinguishing segment vs uplink, so the
+// human-readability property (you can read an id straight out of the
+// address) is preserved on the v6 side even though v4 has to use the
+// less-readable shifted-block scheme to fit in 32 bits.
+//
+// No physical VLAN on either — the backbone is OVN-internal transit,
+// not wired to any single segment's or uplink's physical VLAN. vlan()
+// is always undefined.
+
+function backboneBlockAddress(blockBase: number, host: number): string {
+  if (host < 1 || host > 7) {
+    throw new RangeError(`backbone host out of range (1-7): ${host}`);
+  }
+  const third = (blockBase >> 8) & 0xff;
+  const fourth = (blockBase & 0xff) + host;
+  return `10.80.${third}.${fourth}`;
+}
+
+export function segmentBackboneNet(
+  segment: SegmentId | number,
+  host: number,
+): NetId {
+  const id = typeof segment === "number" ? segmentId(segment) : segment;
+  const blockBase = id << 4;
+  return makeNetId(
+    `${backboneBlockAddress(blockBase, host)}/16`,
+    `fd00:10:80::0:${id}:${host}/64`,
+    id,
+    undefined,
+  );
+}
+
+export function uplinkBackboneNet(
+  uplink: UplinkId | number,
+  slot: number,
+  host: number,
+): NetId {
+  // `slot` (not the real uplink id) drives the IPv4 block-shift, same
+  // as transferNet — uplink ids like 1280 are far too large to use
+  // directly in <<4 arithmetic (1280<<4 = 20480, producing a
+  // meaningless-looking but technically-valid address in the wrong
+  // place: 10.80.80.x). `slot` MUST be the same small sequential index
+  // (0,1,2,...) NetworkBuilder already assigns for the transfer link
+  // (see define.ts), so an uplink's backbone leg and transfer leg use
+  // consistent, small, collision-free numbering. The real uplink id is
+  // still used for the IPv6 fold, which has no such size constraint.
+  const id = typeof uplink === "number" ? uplinkId(uplink) : uplink;
+  if (slot < 0 || slot > 4095) {
+    throw new RangeError(`uplinkBackboneNet: slot out of range (0-4095): ${slot}`);
+  }
+  const blockBase = (slot << 4) | 0x8;
+  return makeNetId(
+    `${backboneBlockAddress(blockBase, host)}/16`,
+    `fd00:10:80::8:${id}:${host}/64`,
+    id,
+    undefined,
+  );
+}
+
+// ── client segments: one network PER SEGMENT, identifier folds into the
+//    NETWORK portion ──
+// fd00:192:168:<segment>::<host>/64  <->  192.168.<segment>.<host>/24
+//
+// vlan() returns the segment id itself when the segment's physical VLAN
+// tag matches its numeric id (true for every segment built so far —
+// segment 128 is VLAN 128, etc.). Pass an explicit vlan to override
+// (e.g. segment 128 is untagged on the wire, so its real VLAN concept
+// doesn't apply the same way — see untaggedOnWire on Segment).
+
+export function segmentNet(
+  segment: SegmentId | number,
+  host: number,
+  vlan?: number,
+): NetId {
+  const id = typeof segment === "number" ? segmentId(segment) : segment;
+  return makeNetId(
+    `192.168.${id}.${host}/24`,
+    `fd00:192:168:${id}::${host}/64`,
+    id,
+    vlan ?? id,
+  );
+}
+
+// ── transfer links: one network PER UPLINK, identifier folds into the
+//    NETWORK portion ──
+// fd00:10:99:<uplink>::<host>/124  <->  10.99.<third>.<fourth>/28
+//
+// IPv4: 10.99.0.0/16 holds exactly 4096 /28 blocks (16 addresses each).
+// `slot` (0-4095) selects which block — slot N is the Nth /28 in
+// sequence: slot 0 = 10.99.0.0/28, slot 1 = 10.99.0.16/28, ...,
+// slot 128 = 10.99.8.0/28, etc. `slot` is NOT the uplink's own id
+// (uplink ids like 1280/1281/1282 exceed 4095 and aren't sequential
+// from 0) — it's a small sequential index the caller assigns, one per
+// uplink, distinct from the uplink's real identity. See define.ts,
+// where NetworkBuilder assigns slots automatically in declaration
+// order so config/topology.ts never has to think about this at all.
+//
+// IPv6 still folds the uplink's real id (not slot) into the network
+// portion, since IPv6 has no equivalent address-space scarcity forcing
+// a slot scheme — fd00:10:99:1280::/124 is perfectly fine on its own.
+//
+// No physical VLAN on the OVN side of a transfer link — vlan() is
+// undefined here; the REAL uplink (see uplinkNet below) is what carries
+// the physical VLAN tag.
+
+export function transferNet(
+  uplink: UplinkId | number,
+  slot: number,
+  host: number,
+): NetId {
+  const id = typeof uplink === "number" ? uplinkId(uplink) : uplink;
+  if (slot < 0 || slot > 4095) {
+    throw new RangeError(`transfer slot out of range (0-4095): ${slot}`);
+  }
+  if (host < 1 || host > 14) {
+    throw new RangeError(`transfer host out of range (1-14): ${host}`);
+  }
+  const blockBase = slot * 16; // 0-65520, fits in 16 bits
+  const third = (blockBase >> 8) & 0xff;
+  const fourth = (blockBase & 0xff) + host;
+  return makeNetId(
+    `10.99.${third}.${fourth}/28`,
+    `fd00:10:99:${id}::${host}/124`,
+    id,
+    undefined,
+  );
+}
+
+// ── uplink's real-world physical identity ──────────────────────────
+// The uplink's own VLAN (e.g. 1280 for an uplink named isp-primary) — this is the ONE
+// place vlan() reflects a real physical tag tied 1:1 to the uplink
+// numeric id, since every uplink built so far uses vlanId === id.
+// No IPv4/IPv6 addressing of its own (the uplink's real address is
+// whatever the ISP hands out dynamically) — ipv4/ipv6 here are the
+// transfer link's OVN-side address, reused, so every NetId still
+// satisfies the same shape.
+
+export function uplinkNet(
+  uplink: UplinkId | number,
+  slot: number,
+): NetId {
+  const id = typeof uplink === "number" ? uplinkId(uplink) : uplink;
+  const transfer = transferNet(id, slot, 1);
+  return makeNetId(
+    transfer.ipv4.to_string(),
+    transfer.ipv6.to_string(),
+    id,
+    id,
+  );
+}
+
+// ── MAC address derivation ────────────────────────────────────────
+// Folds an IPv4 address's four octets directly into a MAC, prefixed
+// with 00:00 — the convention already used by hand throughout this
+// project (e.g. 192.168.128.2 -> 00:00:c0:a8:80:02, verified against a
+// live deployment). Locally-administered OUI space
+// (00:00:xx is not a real vendor block) is fine for this use — these
+// MACs only need to be unique within OVN's logical topology, never
+// routed on a real physical LAN segment.
+
+export function macFromV4(ipv4: IPAddress): string {
+  const octets = ipv4.to_s().split("/")[0].split(".").map((s) =>
+    Number.parseInt(s, 10)
+  );
+  if (octets.length !== 4 || octets.some((o) => Number.isNaN(o))) {
+    throw new Error(`macFromV4: not a valid IPv4 address: ${ipv4.to_s()}`);
+  }
+  const hex = octets.map((o) => o.toString(16).padStart(2, "0"));
+  return `00:00:${hex.join(":")}`;
+}