Rebrand to Checker. #2048

README.md

@@ -1,18 +1,18 @@
-# Filecoin Station
+# Checker
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai/)
 [![](https://img.shields.io/badge/project-Filecoin-blue.svg?style=flat-square)](https://filecoin.io/)
-[![ci](https://github.com/filecoin-station/desktop/actions/workflows/ci.yml/badge.svg)](https://github.com/filecoin-station/desktop/actions/workflows/ci.yml)
+[![ci](https://github.com/CheckerNetwork/app/actions/workflows/ci.yml/badge.svg)](https://github.com/CheckerNetwork/app/actions/workflows/ci.yml)
 
-Filecoin Station is a desktop app that connects your computer’s idle resources
+Checker is a desktop app that connects your computer’s idle resources
 to the Filecoin network and rewards you with Filecoin. Taking part is simple,
 just launch the app and start earning. Learn more at
-[filstation.app](https://filstation.app).
+[app.checker.network](https://app.checker.network).
 
 ## Install
 
-Release notes and all versions of Filecoin Station can be found on the
-[releases page](https://github.com/filecoin-station/desktop/releases).
+Release notes and all versions of Checker can be found on the
+[releases page](https://github.com/CheckerNetwork/app/releases).
 
 Each release has packages for desktop platforms:
 

SECURITY.md

@@ -33,4 +33,4 @@ as a security vulnerability, .
 ## Reporting a non security bug
 
 For non-security bugs, please simply file a GitHub
-[issue](https://github.com/filecoin-station/desktop/issues/new).
+[issue](https://github.com/CheckerNetwork/app/issues/new).

build/after-pack.js

@@ -29,7 +29,7 @@ exports.default = async function (context) {
     {
       cwd: join(
         context.appOutDir,
-        'Filecoin Station.app',
+        'Checker.app',
         'Contents',
         'Resources',
         'core'

docs/DEVELOPING.md

@@ -6,8 +6,8 @@
 
 ```mermaid
 graph
-  fil-stat-repo(github.com/filecoin-station/desktop) --> fil-stat-main(Station main process)
-  fil-stat-repo --> fil-stat-webui(Station WebUI)
+  fil-stat-repo(github.com/CheckerNetwork/app) --> fil-stat-main(Checker main process)
+  fil-stat-repo --> fil-stat-webui(Checker WebUI)
 
   saturn-l2-repo(https://github.com/filecoin-project/saturn-l2)
   --> saturn-l2-go(Saturn L2 Node binary)
@@ -23,7 +23,7 @@ graph
 
 Repositories:
 
-- https://github.com/filecoin-station/desktop
+- https://github.com/CheckerNetwork/app
 - https://github.com/filecoin-saturn/L2-node
 - https://github.com/filecoin-project/saturn-webui
 
@@ -32,8 +32,8 @@ Repositories:
 1. `filecoin-project/saturn-webui` publishes a new release with WebUI assets
 2. `filecoin-saturn/L2-node` is updated to use the new `saturn-webui` version
 3. `filecoin-saturn/L2-node` publishes a new release
-4. `filecoin-station/desktop` is updated to use the new `L2-node` version
-5. `filecoin-station/desktop` publishes a new release
+4. `CheckerNetwork/app` is updated to use the new `L2-node` version
+5. `CheckerNetwork/app` publishes a new release
 
 ## Development workflow
 

docs/RELEASE_PROCESS.md

@@ -1,6 +1,6 @@
 ## Overview
 
-Filecoin Station uses
+Checker uses
 [electron-build/auto-update](https://www.electron.build/auto-update) and a
 modified flow from
 [Electron Builder Action](https://github.com/samuelmeuli/action-electron-builder#electron-builder-action):
@@ -38,12 +38,12 @@ modified flow from
    ```
 
 1. Wait for GitHub Actions CI to upload the binaries to a draft release
-   [here](https://github.com/filecoin-station/desktop/releases) (a new
+   [here](https://github.com/CheckerNetwork/app/releases) (a new
    one will be created if you haven't drafted one).
 1. Review and publish the release draft.
    - Once a release is published, users will receive the app update
    - The `latest.yml, latest-mac.yml, latest-linux.yml` files attached to
-     [/releases](https://github.com/filecoin-station/desktop/releases)
+     [/releases](https://github.com/CheckerNetwork/app/releases)
      are used by the desktop app to determine when an app update is available.
 1. Done!
 
@@ -56,12 +56,12 @@ modified flow from
 4. Publish local changes and the tag to the GitHub repo:
    `git push && git push origin vA.B.C`.
 5. Wait for GitHub Actions CI to upload the binaries to a draft release
-   [here](https://github.com/filecoin-station/desktop/releases) (a new
+   [here](https://github.com/CheckerNetwork/app/releases) (a new
    one will be created if you haven't drafted one).
 6. Review and publish the release draft.
    - Once a release is published, users will receive the app update
    - The `latest.yml, latest-mac.yml, latest-linux.yml` files attached to
-     [/releases](https://github.com/filecoin-station/desktop/releases)
+     [/releases](https://github.com/CheckerNetwork/app/releases)
      are used by the desktop app to determine when an app update is available.
 7. Done!
 

docs/MODULE_INTERFACE.md → docs/SUBNET_INTERFACE.md

@@ -1,33 +1,33 @@
-# Station module interface
+# Checker subnet interface
 
-1. A module itself is a long-running executable, which
+1. A subnet itself is a long-running executable, which
     - performs its business logic
     - writes informative messages to `stdio`
     - exposes stats via a builtin webserver
 
-1. A module needs to have its __binaries hosted__ on HTTPS accessible URLs, so that Station can download updates. Path patterns are flexible, GitHub Releases would be nice.
+1. A subnet needs to have its __binaries hosted__ on HTTPS accessible URLs, so that Checker can download updates. Path patterns are flexible, GitHub Releases would be nice.
 
     Example:
     ```
     https://github.com/filecoin-saturn/L2-node/releases
     ```
 
-1. A module should run on as many operating systems as possible, without requiring any prior setup before executing its binary. On macOS, x86 is required, arm64 nice to have.
+1. A subnet should run on as many operating systems as possible, without requiring any prior setup before executing its binary. On macOS, x86 is required, arm64 nice to have.
 
-2. A module can provide a custom __command string__ for launching its executable. Ideally a module doesn't require any extra arguments when launching.
+2. A subnet can provide a custom __command string__ for launching its executable. Ideally a subnet doesn't require any extra arguments when launching.
 
     Example:
     ```bash
     $ bacalhau # ideal
     $ bacalhau --foo=bar
     ```
 
-3. A module's executable gets passed the following environment variables:
+3. A subnet's executable gets passed the following environment variables:
     - `FIL_WALLET_ADDRESS` The user's Filecoin wallet address
-    - `STATE_ROOT` The long-lived working directory on disk. The module must store
+    - `STATE_ROOT` The long-lived working directory on disk. The subnet must store
       all of its permanent files inside (subdirectories of) this directory. The directory
       isn't expected to be backed up or shared across machines in any way.
-    - `CACHE_ROOT` The temporary working directory on disk. The module must store
+    - `CACHE_ROOT` The temporary working directory on disk. The subnet must store
       all of its caches inside (subdirectories of) this directory. The directory
       isn't expected to be backed up or shared across machines in any way.
 
@@ -36,17 +36,17 @@
     $ FIL_WALLET_ADDRESS=f1... STATE_ROOT=~/.local/state/bacalhau CACHE_ROOT=~/.cache/bacalhau bacalhau
     ```
 
-4. A module communicates activity by writing to its `stdout` stream:
-    - `API: $1` The module has launched and `$1` can be queried for fetching module stats (see below)
-    - `INFO: $1` `$1` will be displayed to the user inside Station's Activity Log
-    - `ERROR: $1` `$1` will be displayed to the user inside Station's Activity Log, with a warning icon
-    - `$1` all log lines will be stored in a module-specific log file, which can be submitted to Sentry for error handling
+4. A subnet communicates activity by writing to its `stdout` stream:
+    - `API: $1` The subnet has launched and `$1` can be queried for fetching subnet stats (see below)
+    - `INFO: $1` `$1` will be displayed to the user inside Checker's Activity Log
+    - `ERROR: $1` `$1` will be displayed to the user inside Checker's Activity Log, with a warning icon
+    - `$1` all log lines will be stored in a subnet-specific log file, which can be submitted to Sentry for error handling
 
-5. A module is expected to have provided its `API` URL in `<=500ms`
+5. A subnet is expected to have provided its `API` URL in `<=500ms`
 
-6. A module's `stderr` will be stored in the same module-specific log file as its `stdout`, to be used for post-mortem debugging.
+6. A subnet's `stderr` will be stored in the same subnet-specific log file as its `stdout`, to be used for post-mortem debugging.
 
-7. A module exposes its stats via HTTP(S), on an address communicated via
+7. A subnet exposes its stats via HTTP(S), on an address communicated via
 `stdout` (see above `API:`). The response will be a JSON object with at least
 the following fields:
 
@@ -57,12 +57,12 @@ the following fields:
     ```
 
     The number of jobs completed is expected to be a monotonically increasing
-    number. It's the responsibility of the module to persist this number across
+    number. It's the responsibility of the subnet to persist this number across
     process restarts, somewhere in `ROOT_DIR`.
 
-    The module may include additional fields in the JSON response, although
-    these will be ignored by Station.
+    The subnet may include additional fields in the JSON response, although
+    these will be ignored by Checker.
 
-7. A module can be told to shut down via signal `SIGTERM`
+7. A subnet can be told to shut down via signal `SIGTERM`
 
-8. A module can shut down at any time, which is always considered an error. Its exit will be shown in Station's UI, and the last 100 lines of its output streams forwarded to Sentry. The module won't automatically be restarted by Station (for now).
+8. A subnet can shut down at any time, which is always considered an error. Its exit will be shown in Checker's UI, and the last 100 lines of its output streams forwarded to Sentry. The subnet won't automatically be restarted by Checker (for now).

electron-builder.yml

@@ -1,4 +1,4 @@
-appId: io.filecoin.station
+appId: network.checker.app
 generateUpdatesFilesForAllChannels: true
 
 extraMetadata:
@@ -58,8 +58,8 @@ nsis:
 
 linux:
   artifactName: ${name}-${os}-${arch}.${ext}
-  executableName: filecoin-station
-  icon: filecoin-station
+  executableName: checker
+  icon: checker
   category: Network;FileTransfer;P2P
   synopsis: A desktop client for Filecoin Retrieval Markets
   maintainer: [email protected]

main/activities.js

@@ -7,7 +7,7 @@ class Activities {
   /** @type {Activity[]} */
   #activities = []
   #online = {
-    spark: false,
+    spark: true,
     voyager: false
   }
 

main/app-menu.js

@@ -11,8 +11,8 @@ function setupAppMenu (/** @type {import('./typings').Context} */ ctx) {
 
   // File menu
   menu.items[1].submenu?.insert(0, new MenuItem({
-    label: 'Save Module Logs As…',
-    click: () => { ctx.saveModuleLogsAs() }
+    label: 'Save Subnet Logs As…',
+    click: () => { ctx.saveSubnetLogsAs() }
   }))
 
   Menu.setApplicationMenu(menu)
@@ -37,7 +37,7 @@ function setupCheckForUpdatesMenuItem (ctx, menu) {
     visible: false
   })
 
-  // Filecoin Station menu
+  // Checker menu
   menu.items[0].submenu?.insert(1, checkForUpdates)
   menu.items[0].submenu?.insert(2, checkingForUpdates)
 }

main/station-config.js → main/checker-config.js

@@ -5,11 +5,11 @@ const Store = require('electron-store')
 const log = require('electron-log').scope('config')
 
 const ConfigKeys = {
-  OnboardingCompleted: 'station.OnboardingCompleted',
-  TrayOperationExplained: 'station.TrayOperationExplained',
-  StationID: 'station.StationID',
-  FilAddress: 'station.FilAddress',
-  DestinationFilAddress: 'station.DestinationFilAddress'
+  OnboardingCompleted: 'checker.OnboardingCompleted',
+  TrayOperationExplained: 'checker.TrayOperationExplained',
+  CheckerID: 'checker.CheckerID',
+  FilAddress: 'checker.FilAddress',
+  DestinationFilAddress: 'checker.DestinationFilAddress'
 }
 
 // Use this to test migrations
@@ -18,6 +18,31 @@ const ConfigKeys = {
 
 const configStore = new Store({
   migrations: {
+    '>=3.0.0': store => {
+      const migration = [
+        {
+          from: 'station.OnboardingCompleted',
+          to: ConfigKeys.OnboardingCompleted
+        }, {
+          from: 'station.TrayOperationExplained',
+          to: ConfigKeys.TrayOperationExplained
+        }, {
+          from: 'station.stationID',
+          to: ConfigKeys.CheckerID
+        }, {
+          from: 'station.FilAddress',
+          to: ConfigKeys.FilAddress
+        }, {
+          from: 'station.DestinationFilAddress',
+          to: ConfigKeys.DestinationFilAddress
+        }
+      ]
+      for (const { from, to } of migration) {
+        if (store.has(from)) {
+          store.set(to, store.get(from))
+        }
+      }
+    },
     '>=0.9.0': store => {
       if (store.has('station.onboardingCompleted')) {
         store.set(
@@ -32,13 +57,13 @@ const configStore = new Store({
   },
   beforeEachMigration: (_, context) => {
     log.info(
-      `Migrating station-config from ${context.fromVersion} → ` +
+      `Migrating checker-config from ${context.fromVersion} → ` +
         context.toVersion
     )
   }
 })
 
-log.info('Loading Station configuration from', configStore.path)
+log.info('Loading Checker configuration from', configStore.path)
 
 let OnboardingCompleted =
   /** @type {boolean} */

main/consts.js

@@ -9,9 +9,9 @@ const assert = require('assert')
 const { getBuildVersion } = require('./build-version')
 
 const appIDs = {
-  darwin: 'app.filstation.desktop',
-  win32: 'Filecoin Station Desktop',
-  linux: 'filecoin-station-desktop'
+  darwin: 'network.checker.app',
+  win32: 'Checker',
+  linux: 'checker'
 }
 
 module.exports = Object.freeze({
@@ -21,7 +21,7 @@ module.exports = Object.freeze({
   IS_MAC: os.platform() === 'darwin',
   IS_WIN: os.platform() === 'win32',
   IS_APPIMAGE: typeof process.env.APPIMAGE !== 'undefined',
-  STATION_VERSION: packageJson.version,
+  CHECKER_VERSION: packageJson.version,
   BUILD_VERSION: getBuildVersion(packageJson),
 
   ELECTRON_VERSION: process.versions.electron
@@ -30,8 +30,8 @@ module.exports = Object.freeze({
 // Replace with `app.get('localUserData')` after this PR is landed & released:
 // https://github.com/electron/electron/pull/34337
 function getCacheRoot () {
-  if (process.env.STATION_ROOT) {
-    return path.join(process.env.STATION_ROOT, 'cache')
+  if (process.env.CHECKER_ROOT) {
+    return path.join(process.env.CHECKER_ROOT, 'cache')
   }
 
   const platform = os.platform()
@@ -55,8 +55,8 @@ function getCacheRoot () {
 }
 
 function getStateRoot () {
-  if (process.env.STATION_ROOT) {
-    return path.join(process.env.STATION_ROOT, 'state')
+  if (process.env.CHECKER_ROOT) {
+    return path.join(process.env.CHECKER_ROOT, 'state')
   }
 
   const platform = os.platform()
@@ -87,8 +87,8 @@ function getStateRoot () {
 
 // Used for migrations
 function getLegacyCacheHome () {
-  if (process.env.STATION_ROOT) {
-    return path.join(process.env.STATION_ROOT, 'cache')
+  if (process.env.CHECKER_ROOT) {
+    return path.join(process.env.CHECKER_ROOT, 'cache')
   }
 
   const platform = os.platform()

main/core.js

@@ -35,9 +35,9 @@ let totalJobsCompleted = 0
  * @param {Context} ctx
  */
 async function setup (ctx) {
-  ctx.saveModuleLogsAs = async () => {
+  ctx.saveSubnetLogsAs = async () => {
     const opts = {
-      defaultPath: `station-modules-${(new Date()).getTime()}.log`
+      defaultPath: `checker-subnets-${(new Date()).getTime()}.log`
     }
     // The dialog might not show if the UI is hidden
     ctx.showUI()
@@ -67,7 +67,7 @@ function maybeReportErrorToSentry (err, scopeFn) {
   if (now - lastCrashReportedAt < 4 /* HOURS */ * 3600_000) return
   lastCrashReportedAt = now
   log.error(
-    'Reporting the problem to Sentry for inspection by the Station team.'
+    'Reporting the problem to Sentry for inspection by the Checker team.'
   )
   Sentry.captureException(err, scopeFn)
 }