Integration with Filecoin Station

[bajtos]

StarMaps entry: space-meridian/roadmap#8

Once the first module is built on Zinnia, we should quickly integrate Zinnia into the Station.

For example, as a short-term solution, we can use the current approach where each module is a standalone executable binary, with the slight modification that new modules will contain two pieces - Zinnia CLI and the module JS bundle.

On the Zinnia side, we may need to implement platform APIs for the following features:

• Get the FIL wallet address for receiving rewards.
• Publish Activity Log items.
• Report completion of jobs.

Tasks

• Architecture decision record:
  docs: Zinnia in Filecoin Station [ADR] #121
• Zinnia API for the wallet address, including docs for module builders:
  feat: add Zinnia.walletAddress API #123
• Zinnia API for publishing activity logs, including docs for module builders.
  feat: APIs for reporting activity to Station #124
• Explain when to use Zinnia.log.info and when to use Console APIs like console.log
  feat: APIs for reporting activity to Station #124
  • see docs: Zinnia in Filecoin Station [ADR] #121 (comment)
• Zinnia API for reporting job completion, including docs for module builders:
  feat: APIs for reporting activity to Station #124
• Binary to be used by Station
  feat: zinniad for Filecoin Station #141
• Configuration via env vars (wallet address, state root dir)
  feat: zinniad for Filecoin Station #141
• CD pipeline to build zinniad release artefacts
  feat: build zinniad release binaries #158
  feat: sign zinniad binary for macOS #159
• A new Zinnia module that will be run by zinniad & the Station
  Initial implementation mod-peer-checker#1
• Integration into Station Core, including automation to update Zinnia & modules.
  feat: Zinnia Runtime and Peer Checker module core#92
  feat: build binary for aarch64-unknown-linux-gnu #172
• Integration into Station Desktop, including automation to update Zinnia & modules.
  → moved to Station Core 👉 Station Desktop integration space-meridian/roadmap#15
• Documentation for module builders explaining how to add their new module to Station
  → we are not ready for adding 3rd-party Zinnia modules yet
• Documentation for zinniad (add a README)
  → docs: add README for zinniad #203

[bajtos]

See also #77