api: Add fixed # tasks per round. Closes space-meridian/roadmap#82

api/lib/round-tracker.js

@@ -11,8 +11,12 @@ import { createMeridianContract } from './ie-contract.js'
 // We will need to tweak this value based on measurements; that's why I put it here as a constant.
 export const TASKS_PER_ROUND = 1000
 
-// How many tasks is each SPARK checker node expected to complete every round (at most).
-export const MAX_TASKS_PER_NODE = 15
+// Tweak this to control the network's overall task count.
+export const MAX_TASKS_EXECUTED_PER_ROUND = 500_000
+
+// Baseline value for how many tasks each SPARK checker node is expected to complete every round (at most).
+// The actual value will be set dynamically based on MAX_TASKS_EXECUTED_PER_ROUND and the number of active nodes.
+export const BASELINE_MAX_TASKS_PER_NODE = 15
 
 /** @typedef {Awaited<ReturnType<import('./ie-contract.js').createMeridianContract>>} MeridianContract */
 
@@ -169,7 +173,8 @@ export async function mapCurrentMeridianRoundToSparkRound ({
   meridianContractAddress,
   meridianRoundIndex,
   roundStartEpoch,
-  pgClient
+  pgClient,
+  useDynamicTaskCount = true
 }) {
   let sparkRoundNumber
 
@@ -223,7 +228,8 @@ export async function mapCurrentMeridianRoundToSparkRound ({
     sparkRoundNumber,
     meridianContractAddress,
     meridianRoundIndex,
-    roundStartEpoch
+    roundStartEpoch,
+    useDynamicTaskCount
   })
 
   return sparkRoundNumber
@@ -233,7 +239,8 @@ export async function maybeCreateSparkRound (pgClient, {
   sparkRoundNumber,
   meridianContractAddress,
   meridianRoundIndex,
-  roundStartEpoch
+  roundStartEpoch,
+  useDynamicTaskCount = true
 }) {
   const { rowCount } = await pgClient.query(`
     INSERT INTO spark_rounds
@@ -245,10 +252,30 @@ export async function maybeCreateSparkRound (pgClient, {
     meridianContractAddress,
     meridianRoundIndex,
     roundStartEpoch,
-    MAX_TASKS_PER_NODE
+    BASELINE_MAX_TASKS_PER_NODE
   ])
 
   if (rowCount) {
+    if (useDynamicTaskCount) {
+      try {
+        const res = await fetch('https://stats.filspark.com/stations/daily')
+        const [{ station_id_count: stationIdCount }] = await res.json()
+        if (stationIdCount === 0) {
+          throw new Error('No active stations found')
+        }
+        await pgClient.query(`
+          UPDATE spark_rounds
+          SET max_tasks_per_node = $1
+          WHERE id = $2  
+        `, [
+          Math.floor(MAX_TASKS_EXECUTED_PER_ROUND / stationIdCount),
+          sparkRoundNumber
+        ])
+      } catch (err) {
+        console.error(err)
+      }
+    }
+
     // We created a new SPARK round. Let's define retrieval tasks for this new round.
     // This is a short- to medium-term solution until we move to fully decentralized tasking
     await defineTasksForRound(pgClient, sparkRoundNumber)

api/test/round-tracker.test.js

@@ -53,7 +53,8 @@ describe('Round Tracker', () => {
         meridianContractAddress: '0x1a',
         meridianRoundIndex: 120n,
         roundStartEpoch: 321n,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(sparkRoundNumber, 1n)
       let sparkRounds = (await pgClient.query('SELECT * FROM spark_rounds ORDER BY id')).rows
@@ -69,7 +70,8 @@ describe('Round Tracker', () => {
         meridianContractAddress: '0x1a',
         meridianRoundIndex: 121n,
         roundStartEpoch: 321n,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(sparkRoundNumber, 2n)
       sparkRounds = (await pgClient.query('SELECT * FROM spark_rounds ORDER BY id')).rows
@@ -88,7 +90,8 @@ describe('Round Tracker', () => {
         meridianContractAddress: '0x1a',
         meridianRoundIndex: 120n,
         roundStartEpoch: 321n,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(sparkRoundNumber, 1n)
 
@@ -97,7 +100,8 @@ describe('Round Tracker', () => {
         meridianContractAddress: '0x1b',
         meridianRoundIndex: 10n,
         roundStartEpoch: 321n,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(sparkRoundNumber, 2n)
 
@@ -114,7 +118,8 @@ describe('Round Tracker', () => {
         meridianContractAddress: '0x1b',
         meridianRoundIndex: 11n,
         roundStartEpoch: 321n,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(sparkRoundNumber, 3n)
 
@@ -136,7 +141,8 @@ describe('Round Tracker', () => {
         meridianContractAddress,
         meridianRoundIndex,
         roundStartEpoch,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(sparkRoundNumber, 1n)
       let sparkRounds = (await pgClient.query('SELECT * FROM spark_rounds ORDER BY id')).rows
@@ -149,7 +155,8 @@ describe('Round Tracker', () => {
         meridianContractAddress,
         meridianRoundIndex,
         roundStartEpoch,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(sparkRoundNumber, 1n)
       sparkRounds = (await pgClient.query('SELECT * FROM spark_rounds ORDER BY id')).rows
@@ -164,7 +171,8 @@ describe('Round Tracker', () => {
         meridianContractAddress: '0x1a',
         meridianRoundIndex: 1n,
         roundStartEpoch: 321n,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
 
       const { rows: tasks } = await pgClient.query('SELECT * FROM retrieval_tasks ORDER BY id')
@@ -188,13 +196,15 @@ describe('Round Tracker', () => {
         meridianContractAddress,
         meridianRoundIndex,
         roundStartEpoch,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       const secondRoundNumber = await mapCurrentMeridianRoundToSparkRound({
         meridianContractAddress,
         meridianRoundIndex,
         roundStartEpoch,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(firstRoundNumber, secondRoundNumber)
 
@@ -214,7 +224,8 @@ describe('Round Tracker', () => {
         meridianContractAddress,
         meridianRoundIndex,
         roundStartEpoch,
-        pgClient
+        pgClient,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(sparkRoundNumber, 1n)
       const sparkRounds = (await pgClient.query('SELECT * FROM spark_rounds ORDER BY id')).rows

api/test/test.js

@@ -7,7 +7,7 @@ import {
   TASKS_PER_ROUND,
   maybeCreateSparkRound,
   mapCurrentMeridianRoundToSparkRound,
-  MAX_TASKS_PER_NODE
+  BASELINE_MAX_TASKS_PER_NODE
 } from '../lib/round-tracker.js'
 import { delegatedFromEthAddress } from '@glif/filecoin-address'
 
@@ -59,7 +59,8 @@ describe('Routes', () => {
       sparkRoundNumber: currentSparkRoundNumber,
       meridianContractAddress: '0x1a',
       meridianRoundIndex: 123n,
-      roundStartEpoch: 321n
+      roundStartEpoch: 321n,
+      useDynamicTaskCount: false
     })
     const handler = await createHandler({
       client,
@@ -454,7 +455,8 @@ describe('Routes', () => {
         pgClient: client,
         meridianContractAddress: '0xOLD',
         meridianRoundIndex: 10n,
-        roundStartEpoch: 321n
+        roundStartEpoch: 321n,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(num, 1n)
 
@@ -463,7 +465,8 @@ describe('Routes', () => {
         pgClient: client,
         meridianContractAddress: '0xNEW',
         meridianRoundIndex: 120n,
-        roundStartEpoch: 621n
+        roundStartEpoch: 621n,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(num, 2n)
 
@@ -472,7 +475,8 @@ describe('Routes', () => {
         pgClient: client,
         meridianContractAddress: '0xNEW',
         meridianRoundIndex: 121n,
-        roundStartEpoch: 921n
+        roundStartEpoch: 921n,
+        useDynamicTaskCount: false
       })
       assert.strictEqual(num, 3n)
     })
@@ -484,7 +488,7 @@ describe('Routes', () => {
 
       assert.deepStrictEqual(details, {
         roundId: '2',
-        maxTasksPerNode: MAX_TASKS_PER_NODE,
+        maxTasksPerNode: BASELINE_MAX_TASKS_PER_NODE,
         startEpoch: '621'
       })
       assert.strictEqual(retrievalTasks.length, TASKS_PER_ROUND)
@@ -502,7 +506,7 @@ describe('Routes', () => {
 
       assert.deepStrictEqual(details, {
         roundId: '1',
-        maxTasksPerNode: MAX_TASKS_PER_NODE,
+        maxTasksPerNode: BASELINE_MAX_TASKS_PER_NODE,
         startEpoch: '321'
       })
       assert.strictEqual(retrievalTasks.length, TASKS_PER_ROUND)
@@ -527,7 +531,8 @@ describe('Routes', () => {
         sparkRoundNumber: currentSparkRoundNumber,
         meridianContractAddress: '0x1a',
         meridianRoundIndex: 123n,
-        roundStartEpoch: 321n
+        roundStartEpoch: 321n,
+        useDynamicTaskCount: false
       })
     })
 
@@ -568,7 +573,8 @@ describe('Routes', () => {
         sparkRoundNumber: currentSparkRoundNumber,
         meridianContractAddress: '0x1a',
         meridianRoundIndex: 123n,
-        roundStartEpoch: 321n
+        roundStartEpoch: 321n,
+        useDynamicTaskCount: false
       })
     })