Generate specific periods

Author: hsjoberg

.gitignore

@@ -8,3 +8,4 @@ pageviews.json
 pageviews_txt.json
 lnurlpay.json
 addinvoice_payload.json
+data

README.md

@@ -26,6 +26,14 @@ Set `mode: "fake"` or `mode: "fake-backend"` in your `config/config.ts`.
 
 `fake-frontend`: Frontend will generate fake blocks, this mode works in conjuction with `./frontend-dev-server.sh`
 
+## Generating block data from a specific difficulty period
+
+Difficulty period is calculated as `floor([any block in the period])`.
+
+`deno run --allow-net --allow-read --allow-write generate/index.ts [period number]`
+
+Once generated, the data is available via API call `/blocks/[epoch number]` or `[project root]/data/periods/[epoch].json`.
+
 ## Commit and Code-Style
 
 Follow the code style of the file you are working in.

backend/api/blocks.ts

@@ -1,7 +1,33 @@
 import { RouterMiddleware } from "https://deno.land/x/oak@v7.5.0/mod.ts";
+import { exists } from "https://deno.land/std@0.98.0/fs/mod.ts";
+
 import { getBlocks } from "../blocks/index.ts";
 
 export const GetBlocks: RouterMiddleware = (context) => {
   const blocks = getBlocks();
   context.response.body = blocks;
 };
+export const GetBlocksPeriod: RouterMiddleware = async (context) => {
+  try {
+    const period = Number.parseInt(context.params.blocks || "");
+    if (Number.isNaN(period)) {
+      context.response.status = 404;
+      context.response.body = "404 File Not Found";
+      return;
+    }
+
+    const path = Deno.cwd() + `/data/periods/${context.params.blocks}.json`;
+    if (!(await exists(path))) {
+      context.response.status = 404;
+      context.response.body = "404 File Not Found";
+      return;
+    }
+
+    const blocks = await Deno.readFile(path);
+    context.response.body = blocks;
+  } catch (error) {
+    console.log(error);
+    context.response.status = 500;
+    context.response.body = "Unknown error";
+  }
+};

backend/api/index.ts

@@ -1,13 +1,15 @@
 import { Router } from "https://deno.land/x/oak@v7.5.0/mod.ts";
 
-import { GetBlocks } from "./blocks.ts";
+import { GetBlocks, GetBlocksPeriod } from "./blocks.ts";
 import { LnurlPayRequest, LnurlPayRequestCallback } from "./donate.ts";
 import { GetBlockchainInfo, GetBlockCount, GetBlockHash } from "./misc.ts";
 
 const router = new Router();
 
 router.get("/blocks", GetBlocks);
 
+router.get("/blocks/:blocks", GetBlocksPeriod);
+
 router.get("/invoice", LnurlPayRequest);
 
 router.get("/invoice/callback", LnurlPayRequestCallback);

backend/blocks/index.ts

@@ -40,7 +40,7 @@ async function createRealBlock(height: number): Promise<IBlock> {
   };
 }
 
-async function setupPeriod(blockCount: number, startHeight: number, endHeight: number): Promise<IBlock[]> {
+export async function setupPeriod(blockCount: number, startHeight: number, endHeight: number): Promise<IBlock[]> {
   const createBlock = config.mode === "real" ? createRealBlock : createFakeBlock;
 
   const blocks: IBlock[] = [];

data/periods/.gitkeep

@@ -0,0 +1,22 @@
+import { setupPeriod } from "../backend/blocks/index.ts";
+
+const periodString = Deno.args[0];
+
+if (!periodString) {
+  console.log("Usage: [period]");
+  Deno.exit(0);
+}
+
+const period = Number.parseInt(periodString);
+
+if (Number.isNaN(period)) {
+  console.log("Error: Invalid period: " + periodString + " (evaluated as " + period + ")");
+  Deno.exit(1);
+}
+
+const difficultyPeriodStartHeight = period * 2016;
+const difficultyPeriodEndHeight = difficultyPeriodStartHeight + 2016;
+
+const blocks = await setupPeriod(period * 2016 + 0, difficultyPeriodStartHeight, difficultyPeriodEndHeight);
+console.log(Deno.cwd());
+await Deno.writeTextFile(Deno.cwd() + `/data/periods/${period}.json`, JSON.stringify(blocks));