Merge pull request #13 from whats-good/kerem/config-2

Kerem/config 2

.changeset/afraid-bananas-lie.md

@@ -0,0 +1,5 @@
+---
+"@whatsgood/nexus": patch
+---
+
+requiring provider configs

.changeset/dull-clocks-unite.md

@@ -0,0 +1,5 @@
+---
+"@whatsgood/nexus": minor
+---
+
+chains need to be explicitly configured via config now

.changeset/great-maps-exercise.md

@@ -0,0 +1,5 @@
+---
+"@whatsgood/nexus": patch
+---
+
+Updated registry override behavior: additional chain support statements will override previous ones for the same chain id

.changeset/loud-insects-press.md

@@ -0,0 +1,5 @@
+---
+"@whatsgood/nexus": minor
+---
+
+Global singleton registry exported now. Clients can now extend the registry to change chain, network and provider behavior

examples/cloudflare-worker/src/index.ts

@@ -4,11 +4,14 @@ import { NexusServer } from "@whatsgood/nexus";
 // TODO: add onboarding & UX. (setup admin access, login, etc)
 // TODO: add tests for the worker
 
+// TODO: add documentation for registry extensions
+
 type Env = Record<string, string>;
 
 const server = NexusServer.create<Env>({
   env: (ctx) => ctx,
   providers: ["alchemy"],
+  chains: [84531],
 });
 
 export default { fetch: server.fetch };

examples/nodejs-standalone-server/src/index.ts

@@ -3,6 +3,7 @@ import { createServer } from "node:http";
 
 const server = NexusServer.create({
   providers: ["base"],
+  chains: [84531],
 });
 
 createServer(server).listen(4005, () => {

packages/nexus/src/chain/chain.ts

@@ -1,40 +1,12 @@
 import type { Registry } from "@src/registry";
-
-export class Network {
-  private readonly chains = new Map<string, Chain>();
-
-  private constructor(public readonly name: string) {}
-
-  public addChain(chain: Chain) {
-    if (this.chains.has(chain.name)) {
-      throw new Error(`Chain ${chain.name} already exists`);
-    }
-
-    this.chains.set(chain.name, chain);
-  }
-
-  public getChain(name: string): Chain | undefined {
-    return this.chains.get(name);
-  }
-
-  public static init(
-    registry: Registry,
-    name: string,
-    aliases?: string[]
-  ): Network {
-    const existingNetwork = registry.getNetwork(name);
-    const network = existingNetwork || new Network(name);
-
-    registry.registerNetwork(network, aliases);
-
-    return network;
-  }
-}
+import type { Config } from "@src/config";
+import type { Network } from "./network";
 
 export interface ChainStatus {
   chainId: number;
   chainName: string;
   networkName: string;
+  isEnabled: boolean;
   // TODO: add isDeprecated
   // isDeprecated: boolean;
 }
@@ -46,11 +18,12 @@ export class Chain {
     public readonly name: string
   ) {}
 
-  public get status(): ChainStatus {
+  public getStatus(config: Config): ChainStatus {
     return {
       chainName: this.name,
       chainId: this.chainId,
       networkName: this.network.name,
+      isEnabled: !!config.chains[this.chainId]?.enabled,
       // isDeprecated: this.isDeprecated,
     };
   }

packages/nexus/src/chain/index.ts

@@ -1 +1,2 @@
 export * from "./chain";
+export * from "./network";

packages/nexus/src/chain/network.ts

@@ -0,0 +1,33 @@
+import type { Registry } from "@src/registry";
+import type { Chain } from "./chain";
+
+export class Network {
+  private readonly chains = new Map<string, Chain>();
+
+  private constructor(public readonly name: string) {}
+
+  public addChain(chain: Chain) {
+    if (this.chains.has(chain.name)) {
+      throw new Error(`Chain ${chain.name} already exists`);
+    }
+
+    this.chains.set(chain.name, chain);
+  }
+
+  public getChain(name: string): Chain | undefined {
+    return this.chains.get(name);
+  }
+
+  public static init(
+    registry: Registry,
+    name: string,
+    aliases?: string[]
+  ): Network {
+    const existingNetwork = registry.getNetwork(name);
+    const network = existingNetwork || new Network(name);
+
+    registry.registerNetwork(network, aliases);
+
+    return network;
+  }
+}

packages/nexus/src/config.ts

@@ -1,6 +1,7 @@
 import { z } from "zod";
-import { defaultRegistry } from "./registry/default-registry";
+import { globalSingletonRegistry } from "./registry/global-singleton-registry";
 import type { Registry } from "./registry";
+import { toUpperSnakeCase } from "./utils";
 
 const RpxRelayRecoveryModeSchema = z.enum(["none", "cycle"]);
 // none -> don't try to recover and fail immediately
@@ -12,14 +13,27 @@ type RpcRelayRecoveryMode = z.infer<typeof RpxRelayRecoveryModeSchema>;
 
 interface ProviderConfig {
   key?: string;
-  disabled?: boolean;
+  enabled: boolean;
 }
 
-interface ProviderConfigWithName extends ProviderConfig {
-  name: string;
+type ProviderConfigParam =
+  | string
+  | {
+      name: string;
+      key?: string;
+      enabled?: boolean;
+    };
+
+interface ChainConfig {
+  enabled: boolean;
 }
 
-type ProviderConfigParam = string | ProviderConfigWithName;
+type ChainConfigParam =
+  | number
+  | {
+      chainId: number;
+      enabled?: boolean;
+    };
 
 type Env = Partial<Record<string, string>>;
 
@@ -32,6 +46,8 @@ export class Config {
 
   public providers: Partial<Record<string, ProviderConfig>> = {};
 
+  public chains: Partial<Record<number, ChainConfig>> = {};
+
   // all client-side access to the rpc-proxy should include this key.
   public globalAccessKey?: string;
 
@@ -41,36 +57,58 @@ export class Config {
 
   public readonly registry: Registry;
 
-  public readonly env: Env;
-
   constructor(params: {
     env?: Env;
-    providers?: ProviderConfigParam[];
+    providers: [ProviderConfigParam, ...ProviderConfigParam[]];
+    chains: [ChainConfigParam, ...ChainConfigParam[]];
     globalAccessKey?: string;
     recoveryMode?: RpcRelayRecoveryMode;
     registry?: Registry;
   }) {
     const envRaw: Env = params.env || process.env;
 
     // only allow keys that start with NEXUS_ to be used
-    this.env = Object.fromEntries(
+    // TODO: is this necessary now that we're not exporting the env object?
+    const env = Object.fromEntries(
       Object.entries(envRaw).filter(([key]) => key.startsWith("NEXUS_"))
     );
 
-    params.providers?.forEach((provider) => {
+    params.providers.forEach((provider) => {
       if (typeof provider === "string") {
         this.providers[provider] = {
-          disabled: false,
+          enabled: true,
+        };
+      } else {
+        // TODO: scan all NEXUS_PROVIDER_*_KEY env vars and warn if there are any unused ones
+        // or alternatively automatically enable the provider if there is a key for it
+        this.providers[provider.name] = {
+          enabled: provider.enabled ?? true,
+          key: provider.key || env[this.getEnvSecretKeyName(provider.name)],
+        };
+      }
+    });
+
+    params.chains.forEach((chain) => {
+      if (typeof chain === "number") {
+        this.chains[chain] = {
+          enabled: true,
         };
       } else {
-        this.providers[provider.name] = provider;
+        this.chains[chain.chainId] = {
+          enabled: chain.enabled ?? true,
+        };
       }
     });
 
     this.globalAccessKey =
-      params.globalAccessKey || this.env.NEXUS_GLOBAL_ACCESS_KEY;
+      params.globalAccessKey || env.NEXUS_GLOBAL_ACCESS_KEY;
     this.recoveryMode = params.recoveryMode ?? "cycle";
 
-    this.registry = params.registry || defaultRegistry;
+    this.registry = params.registry || globalSingletonRegistry;
+  }
+
+  private getEnvSecretKeyName(name: string): string {
+    // TODO: update env vars and documentation to reflect this change
+    return `NEXUS_PROVIDER_${toUpperSnakeCase(name)}_KEY`;
   }
 }

packages/nexus/src/index.ts

@@ -1,2 +1,3 @@
 export * from "./nexus";
 export * from "./config";
+export * from "./registry";

packages/nexus/src/nexus/nexus.ts

@@ -34,7 +34,7 @@ export class NexusServer<TServerContext = EmptyServerContext>
         typeof value === "function" ? value(serverContext, request) : value,
       ])
     );
-    const config = new Config(configParams);
+    const config = new Config(configParams as ConfigConstructorParams);
 
     return this.requestHandler.handle(config, request);
   };

packages/nexus/src/registry/default-registry.ts → packages/nexus/src/registry/global-singleton-registry.ts

@@ -1,8 +1,8 @@
 import { Registry } from "./registry";
 
-export const defaultRegistry = new Registry();
+export const globalSingletonRegistry = new Registry();
 
-defaultRegistry
+globalSingletonRegistry
   .network("ethereum", ["eth"])
   .chain(1, "mainnet")
   .chain(4, "rinkeby")
@@ -19,7 +19,7 @@ defaultRegistry
   .network("local", ["hardhat", "foundry"])
   .chain(31337, "local");
 
-defaultRegistry
+globalSingletonRegistry
   .provider("alchemy")
   .support(1, {
     baseURL: "https://eth-mainnet.alchemyapi.io/v2",

packages/nexus/src/registry/index.ts

@@ -1,2 +1,2 @@
 export * from "./registry";
-export * from "./default-registry";
+export * from "./global-singleton-registry";