fix: network option works (#243)

Fixes issues with --network flag implementation from #240:
- Fixed --network and --mainnet compatibility with --rpc-url
- Fixed pinning server to use getRpcUrl properly
- Fixed getRpcUrl to return url immediately if given
- Fixed help output for network option
- Created re-usable network option with ENV and choice validation
- Formatted long option strings in CLI commands for Biome compliance

Co-authored-by: Phi <[email protected]>

Author: SgtPooki

src/commands/server.ts

@@ -1,5 +1,4 @@
-import { RPC_URLS } from '@filoz/synapse-sdk'
-import { Command } from 'commander'
+import { Command, Option } from 'commander'
 import { startServer } from '../server.js'
 import { addNetworkOptions } from '../utils/cli-options.js'
 
@@ -12,10 +11,9 @@ export const serverCommand = new Command('server')
   .option('--private-key <key>', 'private key for Synapse (or use PRIVATE_KEY env var)')
 
 addNetworkOptions(serverCommand)
-  .option(
-    '--rpc-url <url>',
-    'RPC URL for Filecoin network (overrides --network, can also use RPC_URL env)',
-    RPC_URLS.calibration.websocket
+  .addOption(
+    new Option('--rpc-url <url>', 'RPC URL for Filecoin network (overrides --network)').env('RPC_URL')
+    // default rpcUrl value is defined in ../common/get-rpc-url.ts
   )
   .action(async (options) => {
     // Override environment variables with CLI options if provided

src/common/get-rpc-url.ts

@@ -2,7 +2,9 @@ import { RPC_URLS } from '@filoz/synapse-sdk'
 import type { CLIAuthOptions } from '../utils/cli-auth.js'
 
 /**
- * Get the RPC URL from the CLI options and environment variables
+ * Get the RPC URL from the CLI options.
+ *
+ * This should only be called from commands using commander, so ENV vars are already handled.
  *
  * Network selection priority:
  * 1. Explicit --rpc-url (highest priority)
@@ -13,15 +15,13 @@ import type { CLIAuthOptions } from '../utils/cli-auth.js'
 export function getRpcUrl(options: CLIAuthOptions): string {
   // Determine RPC URL with priority: explicit rpcUrl > RPC_URL env > network flag/env > default
   let rpcUrl: string | undefined
-  if (options.rpcUrl || process.env.RPC_URL) {
+  if (options.rpcUrl) {
     // Explicit RPC URL takes highest priority
-    rpcUrl = options.rpcUrl || process.env.RPC_URL
-  }
-  if (rpcUrl) {
-    return rpcUrl
+    return options.rpcUrl
   }
-  // Try to use network flag/env var
-  const network = (options.network || process.env.NETWORK)?.toLowerCase().trim()
+
+  // Try to use network flag
+  const network = options.network?.toLowerCase().trim()
   if (network) {
     // Validate network value
     if (network !== 'mainnet' && network !== 'calibration') {

src/payments/auto.ts

@@ -49,12 +49,7 @@ export async function runAutoSetup(options: PaymentSetupOptions): Promise<void>
 
   try {
     // Parse and validate authentication
-    const authConfig = parseCLIAuth({
-      privateKey: options.privateKey,
-      walletAddress: options.walletAddress,
-      sessionKey: options.sessionKey,
-      rpcUrl: options.rpcUrl,
-    })
+    const authConfig = parseCLIAuth(options)
 
     const logger = getCLILogger()
     const synapse = await initializeSynapse(

src/payments/deposit.ts

@@ -50,12 +50,7 @@ export async function runDeposit(options: DepositOptions): Promise<void> {
   spinner.start('Connecting...')
   try {
     // Parse and validate authentication
-    const authConfig = parseCLIAuth({
-      privateKey: options.privateKey,
-      walletAddress: options.walletAddress,
-      sessionKey: options.sessionKey,
-      rpcUrl: options.rpcUrl,
-    })
+    const authConfig = parseCLIAuth(options)
 
     const logger = getCLILogger()
     const synapse = await initializeSynapse(

src/payments/fund.ts

@@ -235,12 +235,7 @@ export async function runFund(options: FundOptions): Promise<void> {
   spinner.start('Connecting...')
   try {
     // Parse and validate authentication
-    const authConfig = parseCLIAuth({
-      privateKey: options.privateKey,
-      walletAddress: options.walletAddress,
-      sessionKey: options.sessionKey,
-      rpcUrl: options.rpcUrl,
-    })
+    const authConfig = parseCLIAuth(options)
 
     const logger = getCLILogger()
     const synapse = await initializeSynapse(

src/payments/status.ts

@@ -85,12 +85,7 @@ export async function showPaymentStatus(options: StatusOptions): Promise<void> {
 
   try {
     // Parse and validate authentication
-    const authConfig = parseCLIAuth({
-      privateKey: options.privateKey,
-      walletAddress: options.walletAddress,
-      sessionKey: options.sessionKey,
-      rpcUrl: options.rpcUrl,
-    })
+    const authConfig = parseCLIAuth(options)
 
     const logger = getCLILogger()
     const synapse = await initializeSynapse(

src/payments/withdraw.ts

@@ -35,12 +35,7 @@ export async function runWithdraw(options: WithdrawOptions): Promise<void> {
   spinner.start('Connecting...')
   try {
     // Parse and validate authentication
-    const authConfig = parseCLIAuth({
-      privateKey: options.privateKey,
-      walletAddress: options.walletAddress,
-      sessionKey: options.sessionKey,
-      rpcUrl: options.rpcUrl,
-    })
+    const authConfig = parseCLIAuth(options)
 
     const logger = getCLILogger()
     const synapse = await initializeSynapse(

src/test/unit/get-rpc-url.test.ts

@@ -0,0 +1,58 @@
+import { RPC_URLS } from '@filoz/synapse-sdk'
+import { describe, expect, it } from 'vitest'
+import { getRpcUrl } from '../../common/get-rpc-url.js'
+import type { CLIAuthOptions } from '../../utils/cli-auth.js'
+
+/**
+ * In production Commander already maps env vars (NETWORK/RPC_URL) into CLI options.
+ * These tests cover the behavior of getRpcUrl given the options object Commander
+ * would pass, without interacting with process.env directly.
+ */
+
+describe('getRpcUrl', () => {
+  it('returns explicit rpcUrl even when network is provided', () => {
+    const options: CLIAuthOptions = {
+      rpcUrl: 'wss://custom.rpc.url/ws',
+      network: 'mainnet',
+    }
+
+    expect(getRpcUrl(options)).toBe('wss://custom.rpc.url/ws')
+  })
+
+  it.each([
+    ['mainnet', RPC_URLS.mainnet.websocket],
+    ['calibration', RPC_URLS.calibration.websocket],
+  ])('returns RPC URL for %s network', (network, expected) => {
+    expect(getRpcUrl({ network } satisfies CLIAuthOptions)).toBe(expected)
+  })
+
+  it('normalizes network casing and whitespace', () => {
+    expect(
+      getRpcUrl({
+        network: '  MAINNET  ',
+      })
+    ).toBe(RPC_URLS.mainnet.websocket)
+
+    expect(
+      getRpcUrl({
+        network: '\tCaLiBrAtIoN\n',
+      })
+    ).toBe(RPC_URLS.calibration.websocket)
+  })
+
+  it('defaults to calibration when network is missing or blank', () => {
+    expect(getRpcUrl({})).toBe(RPC_URLS.calibration.websocket)
+    expect(getRpcUrl({ network: '' })).toBe(RPC_URLS.calibration.websocket)
+    expect(getRpcUrl({ network: '   ' })).toBe(RPC_URLS.calibration.websocket)
+  })
+
+  it('treats empty rpcUrl as falsy and falls back to defaults', () => {
+    expect(getRpcUrl({ rpcUrl: '' })).toBe(RPC_URLS.calibration.websocket)
+  })
+
+  it('throws for unsupported networks', () => {
+    expect(() => getRpcUrl({ network: 'invalid' })).toThrow(
+      'Invalid network: "invalid". Must be "mainnet" or "calibration"'
+    )
+  })
+})

src/utils/cli-options.ts

@@ -4,8 +4,6 @@
  * This module provides reusable option definitions for Commander.js commands
  * to ensure consistency across all CLI commands.
  */
-
-import { RPC_URLS } from '@filoz/synapse-sdk'
 import { type Command, Option } from 'commander'
 
 /**
@@ -45,10 +43,9 @@ export function addAuthOptions(command: Command): Command {
     .option('--session-key <key>', 'Session key for session key auth (can also use SESSION_KEY env)')
 
   return addNetworkOptions(command)
-    .option(
-      '--rpc-url <url>',
-      'RPC endpoint (can also use RPC_URL env, overrides --network)',
-      RPC_URLS.calibration.websocket
+    .addOption(
+      new Option('--rpc-url <url>', 'RPC endpoint').env('RPC_URL')
+      // default rpcUrl value is defined in ../common/get-rpc-url.ts
     )
     .option(
       '--warm-storage-address <address>',
@@ -89,10 +86,13 @@ export function addProviderOptions(command: Command): Command {
 }
 
 export function addNetworkOptions(command: Command): Command {
-  return command.addOption(
-    new Option('--network <network>', 'Filecoin network to use')
-      .choices(['mainnet', 'calibration'])
-      .env('NETWORK')
-      .default('calibration')
-  )
+  command
+    .addOption(
+      new Option('--network <network>', 'Filecoin network to use')
+        .choices(['mainnet', 'calibration'])
+        .env('NETWORK')
+        .default('calibration')
+    )
+    .addOption(new Option('--mainnet', 'Use mainnet (shorthand for --network mainnet)').implies({ network: 'mainnet' }))
+  return command
 }