docs: subnets list (#241)

peterpeterparker · web-flow · commit 7c09ba5884b2 · 2024-12-05T09:34:20.000+01:00
Signed-off-by: David Dal Busco &lt;david.dalbusco@outlook.com&gt;
diff --git a/docs/components/subnets.md b/docs/components/subnets.md
@@ -0,0 +1,20 @@
+| Subnet ID | Type | Canisters (Running/Stopped) | Nodes (Up/Total) |
+|-----------|----------------|---------------------|------------------|
+| 6pbhf-qzpdk-kuqbr-pklfa-5ehhf-jfjps-zsj6q-57nrl-kzhpd-mu7hc-vae | Juno's Subnet | 34688/71 | 12/13 |
+| pzp6e-ekpqk-3c5x7-2h6so-njoeq-mt45d-h3h6c-q3mxf-vpeq5-fk5o7-yae | Fiduciary | 716/7 | 34/34 |
+| bkfrj-6k62g-dycql-7h53p-atvkj-zg4to-gaogh-netha-ptybj-ntsgw-rqe | European | 22789/6 | 13/13 |
+| 4ecnw-byqwz-dtgss-ua2mh-pfvs7-c3lct-gtf4e-hnu75-j7eek-iifqm-sqe |  | 6717/112 | 13/13 |
+| 4zbus-z2bmt-ilreg-xakz4-6tyre-hsqj4-slb4g-zjwqo-snjcc-iqphi-3qe |  | 111/1 | 13/13 |
+| brlsh-zidhj-3yy3e-6vqbz-7xnih-xeq2l-as5oc-g32c4-i5pdn-2wwof-oae |  | 32822/28 | 13/13 |
+| cv73p-6v7zi-u67oy-7jc3h-qspsz-g5lrj-4fn7k-xrax3-thek2-sl46v-jae |  | 50860/176 | 13/13 |
+| e66qm-3cydn-nkf4i-ml4rb-4ro6o-srm5s-x5hwq-hnprz-3meqp-s7vks-5qe |  | 35335/83 | 13/13 |
+| fuqsr-in2lc-zbcjj-ydmcw-pzq7h-4xm2z-pto4i-dcyee-5z4rz-x63ji-nae |  | 19857/0 | 13/13 |
+| gmq5v-hbozq-uui6y-o55wc-ihop3-562wb-3qspg-nnijg-npqp5-he3cj-3ae |  | 33539/49 | 13/13 |
+| jtdsg-3h6gi-hs7o5-z2soi-43w3z-soyl3-ajnp3-ekni5-sw553-5kw67-nqe |  | 26775/3 | 13/13 |
+| lspz2-jx4pu-k3e7p-znm7j-q4yum-ork6e-6w4q6-pijwq-znehu-4jabe-kqe |  | 39354/86 | 13/13 |
+| mpubz-g52jc-grhjo-5oze5-qcj74-sex34-omprz-ivnsm-qvvhr-rfzpv-vae |  | 54876/88 | 13/13 |
+| nl6hn-ja4yw-wvmpy-3z2jx-ymc34-pisx3-3cp5z-3oj4a-qzzny-jbsv3-4qe |  | 31138/33 | 13/13 |
+| o3ow2-2ipam-6fcjo-3j5vt-fzbge-2g7my-5fz2m-p4o2t-dwlc4-gt2q7-5ae |  | 56166/55 | 13/13 |
+| opn46-zyspe-hhmyp-4zu6u-7sbrh-dok77-m7dch-im62f-vyimr-a3n2c-4ae |  | 39369/44 | 13/13 |
+| pjljw-kztyl-46ud4-ofrj6-nzkhm-3n4nt-wi3jt-ypmav-ijqkt-gjf66-uae |  | 31676/63 | 13/13 |
+| qdvhd-os4o2-zzrdw-xrcv4-gljou-eztdp-bj326-e6jgr-tkhuc-ql6v2-yqe |  | 52409/15 | 13/13 |
diff --git a/docs/create-a-satellite.mdx b/docs/create-a-satellite.mdx
@@ -34,6 +34,20 @@ In the creation wizard, there are advanced options available for more experience
 
 If you wish to have more control over where your satellite is deployed, you can select the [subnet] for deployment during the creation process.
 
+Below is a list of available subnets with relevant metadata to help you choose the most appropriate one:
+
+:::note
+
+Satellites operating on larger subnets with more nodes will incur higher cycle costs compared to those running on the standard 13-node subnets. However, this increased cost comes with the benefit of enhanced security due to the greater size of the subnet.
+
+For standard applications, we generally recommend using the standard subnets and staying on the same subnets as Juno.
+
+:::
+
+import Subnets from "./components/subnets.md";
+
+<Subnets />
+
 [satellite]: terminology.md#satellite
 [Internet Identity]: terminology.md#internet-identity
 [subnet]: terminology.md#subnet
diff --git a/docs/guides/angular.mdx b/docs/guides/angular.mdx
@@ -60,7 +60,7 @@ npm i @junobuild/core
 
 To use production, set up a satellite and new collection:
 
-- [Create a new satellite](../create-a-satellite.md) in the Juno's console.
+- [Create a new satellite](../create-a-satellite.mdx) in the Juno's console.
 - After your project is ready, create a collection in your datastore, which we'll call `demo`, using the [console](https://console.juno.build).
 
 ##### Local Development Path
diff --git a/docs/guides/astro.mdx b/docs/guides/astro.mdx
@@ -53,7 +53,7 @@ npm i @junobuild/core
 
 To use production, set up a satellite and new collection:
 
-- [Create a new satellite](../create-a-satellite.md) in the Juno's console.
+- [Create a new satellite](../create-a-satellite.mdx) in the Juno's console.
 - After your project is ready, create a collection in your datastore, which we'll call `demo`, using the [console](https://console.juno.build).
 
 #### Local Development Path
diff --git a/docs/guides/components/deploy.mdx b/docs/guides/components/deploy.mdx
@@ -4,7 +4,7 @@ export const index = 1;
 
 ### {props.index}. Set up a satellite
 
-If you haven't created a satellite yet, go ahead and [create](../../create-a-satellite.md) a new one in the Juno's console.
+If you haven't created a satellite yet, go ahead and [create](../../create-a-satellite.mdx) a new one in the Juno's console.
 
 ### {props.index + 1}. Deploy
 
diff --git a/docs/guides/nextjs.mdx b/docs/guides/nextjs.mdx
@@ -61,7 +61,7 @@ npm i @junobuild/core-peer
 
 To use production, set up a satellite and new collection:
 
-- [Create a new satellite](../create-a-satellite.md) in the Juno's console.
+- [Create a new satellite](../create-a-satellite.mdx) in the Juno's console.
 - After your project is ready, create a collection in your datastore, which we'll call `demo`, using the [console](https://console.juno.build).
 
 ##### Local Development Path
diff --git a/docs/guides/react.mdx b/docs/guides/react.mdx
@@ -60,7 +60,7 @@ npm i @junobuild/core
 
 To use production, set up a satellite and new collection:
 
-- [Create a new satellite](../create-a-satellite.md) in the Juno's console.
+- [Create a new satellite](../create-a-satellite.mdx) in the Juno's console.
 - After your project is ready, create a collection in your datastore, which we'll call `demo`, using the [console](https://console.juno.build).
 
 ##### Local Development Path
diff --git a/docs/guides/sveltekit.mdx b/docs/guides/sveltekit.mdx
@@ -60,7 +60,7 @@ npm i @junobuild/core-peer
 
 To use production, set up a satellite and new collection:
 
-- [Create a new satellite](../create-a-satellite.md) in the Juno's console.
+- [Create a new satellite](../create-a-satellite.mdx) in the Juno's console.
 - After your project is ready, create a collection in your datastore, which we'll call `demo`, using the [console](https://console.juno.build).
 
 ##### Local Development Path
diff --git a/docs/guides/vue.mdx b/docs/guides/vue.mdx
@@ -60,7 +60,7 @@ npm i @junobuild/core
 
 To use production, set up a satellite and new collection:
 
-- [Create a new satellite](../create-a-satellite.md) in the Juno's console.
+- [Create a new satellite](../create-a-satellite.mdx) in the Juno's console.
 - After your project is ready, create a collection in your datastore, which we'll call `demo`, using the [console](https://console.juno.build).
 
 ##### Local Development Path
diff --git a/docs/intro.md b/docs/intro.md
@@ -4,7 +4,7 @@ description: Explore Juno's smart contracts, serverless functions, and hosting c
 
 # Getting Started
 
-Start your Juno journey by launching your first **[Satellite](./create-a-satellite.md)** – a feature-packed smart contract designed for your project.
+Start your Juno journey by launching your first **[Satellite](./create-a-satellite.mdx)** – a feature-packed smart contract designed for your project.
 
 A Satellite is your project’s all-in-one container, **giving you full control 🔐** over authentication, a key-pair datastore (akin to a simple "database"), file storage, serverless functions, and hosting.
 
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -66,12 +66,7 @@ const config: Config = {
         docs: {
           sidebarPath: "sidebars.ts",
           editUrl: "https://github.com/junobuild/docs/edit/main/",
-          exclude: [
-            "**/miscellaneous/cli/**",
-            "**/miscellaneous/components/**",
-            "**/guides/components/**",
-            "**/build/components/**"
-          ]
+          exclude: ["**/miscellaneous/cli/**", "**/components/**"]
         },
         blog: {
           showReadingTime: true,
diff --git a/package.json b/package.json
@@ -18,6 +18,7 @@
     "start": "docusaurus start",
     "build": "docusaurus build",
     "docs:cli": "./cli-to-md.sh",
+    "docs:subnets": "./scripts/subnets.mjs",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",
diff --git a/scripts/subnets.mjs b/scripts/subnets.mjs
@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+import { writeFileSync } from "node:fs";
+import { join } from "node:path";
+
+const JUNO_SUBNET_ID =
+  "6pbhf-qzpdk-kuqbr-pklfa-5ehhf-jfjps-zsj6q-57nrl-kzhpd-mu7hc-vae";
+
+const getJunoSubnet = async () => {
+  const response = await fetch(
+    "https://ic-api.internetcomputer.org/api/v3/subnets/6pbhf-qzpdk-kuqbr-pklfa-5ehhf-jfjps-zsj6q-57nrl-kzhpd-mu7hc-vae"
+  );
+
+  if (!response.ok) {
+    throw new Error("Fetching the Dashboard API failed!");
+  }
+
+  const metadata = await response.json();
+
+  return {
+    subnetId: JUNO_SUBNET_ID,
+    specialization: "Juno's Subnet",
+    ...(metadata !== undefined && {
+      // The dashboard was instructed long ago to display verified_application as application
+      type:
+        metadata.subnet_type === "verified_application"
+          ? "application"
+          : metadata.subnet_type,
+      canisters: {
+        stopped: metadata.stopped_canisters,
+        running: metadata.running_canisters
+      },
+      nodes: {
+        up: metadata.up_nodes,
+        total: metadata.total_nodes
+      }
+    })
+  };
+};
+
+const listSubnets = async () => {
+  const response = await fetch(
+    "https://raw.githubusercontent.com/junobuild/juno/refs/heads/main/src/frontend/src/lib/env/subnets.json"
+  );
+
+  if (!response.ok) {
+    throw new Error("Fetching the Dashboard API failed!");
+  }
+
+  return await response.json();
+};
+
+const capitalize = (text) => {
+  const [firstLetter, ...rest] = text;
+  return `${firstLetter.toUpperCase()}${rest.join("")}`;
+};
+
+const generateMarkdown = (subnets) => {
+  let markdown =
+    "| Subnet ID | Type | Canisters (Running/Stopped) | Nodes (Up/Total) |\n";
+  markdown +=
+    "|-----------|----------------|---------------------|------------------|\n";
+
+  subnets.forEach(({ subnetId, specialization, canisters, nodes }) => {
+    markdown += `| ${subnetId} | ${specialization !== undefined ? capitalize(specialization) : ""} | ${canisters !== undefined ? `${canisters.running}/${canisters.stopped}` : ""} | ${nodes !== undefined ? `${nodes.up}/${nodes.total}` : ""} |\n`;
+  });
+
+  return markdown;
+};
+
+const junoSubnet = await getJunoSubnet();
+const subnets = await listSubnets();
+
+subnets.sort(({ specialization: a }, { specialization: b }) =>
+  (b ?? "").localeCompare(a ?? "")
+);
+
+const markdown = generateMarkdown([
+  junoSubnet,
+  ...subnets.filter(({ subnetId }) => subnetId !== JUNO_SUBNET_ID)
+]);
+
+const SUBNETS_FILE = join(process.cwd(), "docs", "components", "subnets.md");
+
+writeFileSync(SUBNETS_FILE, markdown, "utf8");
