feat: adding Namada specs documentation

Dockerfile

@@ -0,0 +1,56 @@
+FROM node:18-alpine AS base
+
+# Install dependencies only when needed
+FROM base AS deps
+# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
+RUN apk add --no-cache libc6-compat
+WORKDIR /app
+
+# Install dependencies based on the preferred package manager
+COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
+RUN \
+  if [ -f yarn.lock ]; then yarn --frozen-lockfile; \
+  elif [ -f package-lock.json ]; then npm ci; \
+  elif [ -f pnpm-lock.yaml ]; then yarn global add pnpm && pnpm i --frozen-lockfile; \
+  else echo "Lockfile not found." && exit 1; \
+  fi
+
+
+# Rebuild the source code only when needed
+FROM base AS builder
+WORKDIR /app
+COPY --from=deps /app/node_modules ./node_modules
+COPY . .
+
+# Next.js collects completely anonymous telemetry data about general usage.
+# Learn more here: https://nextjs.org/telemetry
+# Uncomment the following line in case you want to disable telemetry during the build.
+# ENV NEXT_TELEMETRY_DISABLED 1
+
+RUN pnpm build
+
+# Production image, copy all the files and run next
+FROM base AS runner
+WORKDIR /app
+
+ENV NODE_ENV production
+# Uncomment the following line in case you want to disable telemetry during runtime.
+# ENV NEXT_TELEMETRY_DISABLED 1
+
+RUN addgroup --system --gid 1001 nodejs
+RUN adduser --system --uid 1001 nextjs
+
+COPY --from=builder /app/public ./public
+
+# Automatically leverage output traces to reduce image size
+# https://nextjs.org/docs/advanced-features/output-file-tracing
+COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
+COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static
+
+USER nextjs
+
+EXPOSE 3000
+
+ENV PORT 3000
+
+CMD ["node", "server.js"]

next.config.js → apps/docs/next.config.js

@@ -5,7 +5,6 @@ const withNextra = require("nextra")({
 
 module.exports = {
   ...withNextra(),
-  output: "export",
   images: {
     unoptimized: true,
   },

apps/docs/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "nextra-docs-template",
+  "version": "0.0.1",
+  "description": "Namada Docs",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build && next export",
+    "start": "next start"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shuding/nextra-docs-template.git"
+  },
+  "author": "Shu Ding <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/shuding/nextra-docs-template/issues"
+  },
+  "homepage": "https://github.com/shuding/nextra-docs-template#readme",
+  "dependencies": {
+    "next": "^13.0.6",
+    "nextra": "latest",
+    "nextra-theme-docs": "latest",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "18.11.10",
+    "typescript": "^4.9.3"
+  }
+}

apps/docs/pages/_meta.json

@@ -0,0 +1,16 @@
+{
+  "index": "Namada",
+  "introduction": "Introduction",
+  "running-a-full-node": "Full nodes",
+  "ledger": "Running the ledger",
+  "validators": "Validators",
+  "delegators": "Delegators",
+  "users": "(Power) Users",
+  "public-goods-stewards": "Public goods stewards",
+  "proof-of-stake": "Cubic Proof-of-stake",
+  "governance": "Governance",
+  "wallet": "Wallet guide",
+  "experimental": "Experimenting with namada",
+  "troubleshooting": "Troubleshooting",
+  "faq": "FAQ"
+}

apps/docs/pages/governance/_meta.json

@@ -0,0 +1,4 @@
+{
+  "on-chain-governance": "On-chain proposals",
+  "off-chain-governance": "Off-chain proposals"
+}

pages/introduction/_meta.json → apps/docs/pages/introduction/_meta.json

@@ -1,7 +1,7 @@
 {
-  "quick-start": "Quick Start",
+  "quick-start": "Quick start",
   "install": "Install Namada",
   "installing-tendermint": "Install Tendermint",
   "testnets": "Testnets",
-  "base-directory": "Base Directory"
+  "base-directory": "Base directory"
 }

apps/docs/pages/introduction/testnets/_meta.json

@@ -0,0 +1,10 @@
+{
+  "environment-setup": "Environment setup",
+  "migrating-testnets": "Migrating Testnets",
+  "pre-genesis": "Pre-genesis",
+  "genesis-validator-apply": "Applying as a genesis validator",
+  "joining-the-testnet": "Joining the latest Testnet",
+  "post-genesis-validator": "Joining the latest Testnet",
+  "upgrades": "Testnet upgrades",
+  "pow": "Proof-of-work on Namada"
+}

apps/docs/pages/public-goods-stewards/_meta.json

@@ -0,0 +1,5 @@
+{
+  "electing": "Becoming a Steward",
+  "voting": "Voting for Stewards and PGF proposals",
+  "proposing": "PGF proposals (Stewards only)"
+}

apps/docs/pages/users/_meta.json

@@ -0,0 +1,7 @@
+{
+  "an-introduction-to-namada-addresses": "Namada addresses",
+  "send-and-receive-nam-tokens": "Sending and receiving NAM",
+  "shielded-transfers": "Shielded transfers",
+  "shielded-rewards": "Shield rewards",
+  "privacy": "Proper Opsec for proper privacy"
+}

apps/docs/pages/validators/_meta.json

@@ -0,0 +1,7 @@
+{
+  "hardware": "Hardware requirements",
+  "genesis-validator-setup": "Genesis validator setup",
+  "run-your-genesis-validator": "Running a genesis validator",
+  "post-genesis-validator-setup": "Initialising a validator account",
+  "staking": "Staking"
+}

apps/docs/pages/wallet/_meta.json

@@ -0,0 +1,7 @@
+{
+  "established-accounts": "Established accounts",
+  "file-system-wallet": "File system wallet",
+  "web-wallet": "Web wallet",
+  "hardware-wallet": "Hardware wallet",
+  "fees": "Fees on Namada"
+}

apps/specs/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Shu Ding
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

apps/specs/components/Logo.tsx

@@ -0,0 +1,30 @@
+import { useEffect, useState } from "react";
+import { useTheme } from "nextra-theme-docs";
+
+export const Logo = () => {
+  const { theme } = useTheme();
+  const [isDark, setDark] = useState(false);
+
+  useEffect(() => {
+    setDark(theme === "dark");
+  }, [theme]);
+
+  return (
+    <div>
+      <svg
+        className="nx-w-full nx-py-4 nx-max-w-[200px] "
+        style={{ maxWidth: "100px" }}
+        xmlns="http://www.w3.org/2000/svg"
+        viewBox="0 0 751 208.9"
+        fill={isDark ? "#ffff00" : "currentColor"}
+      >
+        <rect width="61.5" height="208.9" x="689.5" />
+        <rect width="61.5" height="208.9" x="609.5" />
+        <rect width="61.5" height="208.9" x="529" />
+        <polygon points="476.9 208.9 409.8 208.9 409.8 70.1 332.4 70.1 332.4 208.9 265.3 208.9 265.3 0 476.9 0 476.9 208.9" />
+        <circle cx="371.1" cy="111.5" r="28.8" />
+        <polygon points="211.5 208.9 144.5 208.9 144.5 70.1 67 70.1 67 208.9 0 208.9 0 0 211.5 0 211.5 208.9" />
+      </svg>
+    </div>
+  );
+};

apps/specs/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

apps/specs/next.config.js

@@ -0,0 +1,11 @@
+const withNextra = require("nextra")({
+  theme: "nextra-theme-docs",
+  themeConfig: "./theme.config.tsx",
+});
+
+module.exports = {
+  ...withNextra(),
+  images: {
+    unoptimized: true,
+  },
+};

apps/specs/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "nextra-docs-template",
+  "version": "0.0.1",
+  "description": "Namada Docs",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build && next export",
+    "start": "next start"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shuding/nextra-docs-template.git"
+  },
+  "author": "Shu Ding <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/shuding/nextra-docs-template/issues"
+  },
+  "homepage": "https://github.com/shuding/nextra-docs-template#readme",
+  "dependencies": {
+    "next": "^13.0.6",
+    "nextra": "latest",
+    "nextra-theme-docs": "latest",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "18.11.10",
+    "typescript": "^4.9.3"
+  }
+}

apps/specs/pages/_meta.json

@@ -0,0 +1,9 @@
+{
+  "index": "Introduction",
+  "base-ledger": "Base ledger",
+  "masp": "Multi-asset shielded pool",
+  "interoperability": "Interoperability",
+  "economics": "Economics",
+  "user-interfaces": "User interfaces",
+  "further-reading": "Further reading"
+}

apps/specs/pages/base-ledger.md

@@ -0,0 +1,3 @@
+## Base ledger
+
+The base ledger of Namada includes a [consensus system](./base-ledger/consensus.md), validity predicate-based [execution system](./base-ledger/execution.md), and signalling-based [governance mechanism](./base-ledger/governance.md). Namada's ledger also includes proof-of-stake, slashing, fees, and inflation funding for staking rewards, shielded pool incentives, and public goods — these are specified in the [economics section](./economics.md). This section also documents Namada's [multisignature VP](./base-ledger/multisignature.md), [fungible token VP](./base-ledger/fungible-token.md), and [replay protection system](./base-ledger/replay-protection.md).

apps/specs/pages/base-ledger/_meta.json

@@ -0,0 +1,9 @@
+{
+  "consensus": "Consensus",
+  "execution": "Execution",
+  "governance": "Governance",
+  "multisignature": "Multisignature",
+  "fungible-token": "Fungible token",
+  "replay-protection": "Replay protection",
+  "block-space-allocator": "Block space allocator"
+}