feat: add Zinnia.walletAddress API

docs/building-modules.md

@@ -201,6 +201,14 @@ for await (const chunk of response) {
 }
 ```
 
+### `Zinnia.walletAddress`
+
+The wallet address where to send rewards. When running inside the Station Desktop, this API will
+return the address of Station's built-in wallet.
+
+The value is hard-coded to a testnet address `t1abjxfbp274xpdqcpuaykwkfb43omjotacm2p3za` when
+running the module via `zinnia` CLI.
+
 <!--
 UNSUPPORTED APIs
 -->

runtime/js/99_main.js

@@ -91,6 +91,10 @@ function bootstrapMainRuntime(runtimeOptions) {
 
   runtimeStart(runtimeOptions);
 
+  ObjectDefineProperties(globalThis.Zinnia, {
+    walletAddress: util.readOnly(runtimeOptions.walletAddress),
+  });
+
   // delete `Deno` global
   delete globalThis.Deno;
 

runtime/runtime.rs

@@ -34,6 +34,9 @@ pub struct BootstrapOptions {
 
     /// Seed value for initializing the random number generator
     pub rng_seed: Option<u64>,
+
+    /// Filecoin wallet address - typically the built-in wallet in Filecoin Station
+    pub wallet_address: String,
 }
 
 impl Default for BootstrapOptions {
@@ -43,6 +46,8 @@ impl Default for BootstrapOptions {
             is_tty: colors::is_tty(),
             agent_version: format!("zinnia_runtime/{}", env!("CARGO_PKG_VERSION")),
             rng_seed: None,
+            // See https://lotus.filecoin.io/lotus/manage/manage-fil/#public-key-address
+            wallet_address: String::from("t1abjxfbp274xpdqcpuaykwkfb43omjotacm2p3za"),
         }
     }
 }
@@ -52,6 +57,7 @@ impl BootstrapOptions {
         let payload = serde_json::json!({
           "noColor": self.no_color,
           "isTty": self.is_tty,
+          "walletAddress": self.wallet_address,
         });
         serde_json::to_string_pretty(&payload).unwrap()
     }

runtime/tests/js/station_apis_tests.js

@@ -0,0 +1,20 @@
+import { assertStrictEquals } from "https://deno.land/std@0.177.0/testing/asserts.ts";
+
+test("Zinnia.walletAddress", () => {
+  // Runtime JS tests are executed with the default configuration
+  // In this test, we assert that we can access the wallet address
+  // and the value is the default testnet one.
+  assertStrictEquals(Zinnia.walletAddress, "t1abjxfbp274xpdqcpuaykwkfb43omjotacm2p3za");
+});
+
+// A dummy wrapper to create isolated scopes for individual tests
+// We should eventually replace this with a proper test runner
+// See https://github.com/filecoin-station/zinnia/issues/30
+function test(name, fn) {
+  try {
+    fn();
+  } catch (err) {
+    err.message = `Test ${name} failed. ` + err.message;
+    throw err;
+  }
+}

runtime/tests/runtime_integration_tests.rs

@@ -21,6 +21,7 @@ js_tests!(timers_tests);
 js_tests!(webapis_tests);
 js_tests!(webcrypto_tests);
 js_tests!(libp2p_tests);
+js_tests!(station_apis_tests);
 
 // Run all tests in a single JS file
 async fn run_js_test_file(name: &str) -> Result<(), AnyError> {