@l.x/config 1.0.4 → 1.0.5

package/LICENSE

@@ -0,0 +1,122 @@
+Lux Ecosystem License
+Version 1.2, December 2025
+
+Copyright (c) 2020-2025 Lux Industries Inc.
+All rights reserved.
+
+TECHNOLOGY PORTFOLIO - PATENT APPLICATIONS PLANNED
+Contact: licensing@lux.network
+
+================================================================================
+                          TERMS AND CONDITIONS
+================================================================================
+
+1. DEFINITIONS
+
+   "Lux Primary Network" means the official Lux blockchain with Network ID=1
+   and EVM Chain ID=96369.
+   
+   "Authorized Network" means the Lux Primary Network, official testnets/devnets,
+   and any L1/L2/L3 chain descending from the Lux Primary Network.
+   
+   "Descending Chain" means an L1/L2/L3 chain built on, anchored to, or deriving
+   security from the Lux Primary Network or its authorized testnets.
+   
+   "Research Use" means non-commercial academic research, education, personal
+   study, or evaluation purposes.
+   
+   "Commercial Use" means any use in connection with a product or service
+   offered for sale or fee, internal use by a for-profit entity, or any use
+   to generate revenue.
+
+2. GRANT OF LICENSE
+
+   Subject to these terms, Lux Industries Inc grants you a non-exclusive,
+   royalty-free license to:
+   
+   (a) Use for Research Use without restriction;
+   
+   (b) Operate on the Lux Primary Network (Network ID=1, EVM Chain ID=96369);
+   
+   (c) Operate on official Lux testnets and devnets;
+   
+   (d) Operate L1/L2/L3 chains descending from the Lux Primary Network;
+   
+   (e) Build applications within the Lux ecosystem;
+   
+   (f) Contribute improvements back to the original repositories.
+
+3. RESTRICTIONS
+
+   Without a commercial license from Lux Industries Inc, you may NOT:
+   
+   (a) Fork the Lux Network or any Lux software;
+   
+   (b) Create competing networks not descending from Lux Primary Network;
+   
+   (c) Use for Commercial Use outside the Lux ecosystem;
+   
+   (d) Sublicense or transfer rights outside the Lux ecosystem;
+   
+   (e) Use to create competing blockchain networks, exchanges, custody
+       services, or cryptographic systems outside the Lux ecosystem.
+
+4. NO FORKS POLICY
+
+   Lux Industries Inc maintains ZERO TOLERANCE for unauthorized forks.
+   Any fork or deployment on an unauthorized network constitutes:
+   
+   (a) Breach of this license;
+   (b) Grounds for immediate legal action.
+
+5. RIGHTS RESERVATION
+
+   All rights not explicitly granted are reserved by Lux Industries Inc.
+   
+   We plan to apply for patent protection for the technology in this
+   repository. Any implementation outside the Lux ecosystem may require
+   a separate commercial license.
+
+6. DISCLAIMER OF WARRANTY
+
+   THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+
+7. LIMITATION OF LIABILITY
+
+   IN NO EVENT SHALL LUX INDUSTRIES INC BE LIABLE FOR ANY CLAIM, DAMAGES
+   OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE.
+
+8. TERMINATION
+
+   This license terminates immediately upon any breach, including but not
+   limited to deployment on unauthorized networks or creation of forks.
+
+9. GOVERNING LAW
+
+   This License shall be governed by the laws of the State of Delaware.
+
+10. COMMERCIAL LICENSING
+
+    For commercial use outside the Lux ecosystem:
+    
+    Lux Industries Inc.
+    Email: licensing@lux.network
+    Subject: Commercial License Request
+
+================================================================================
+                              TL;DR
+================================================================================
+
+- Research/academic use = OK
+- Lux Primary Network (Network ID=1, Chain ID=96369) = OK
+- L1/L2/L3 chains descending from Lux Primary Network = OK
+- Commercial products outside Lux ecosystem = Contact licensing@lux.network
+- Forks = Absolutely not
+
+================================================================================
+
+See LP-0012 for full licensing documentation:
+https://github.com/luxfi/lps/blob/main/LPs/lp-0012-ecosystem-licensing.md

package/__tests__/brand-and-legal.test.ts

@@ -20,6 +20,9 @@ describe('BrandConfig interface completeness', () => {
     'title',
     'description',
     'legalEntity',
+    'walletName',
+    'protocolName',
+    'copyrightHolder',
     'appDomain',
     'docsDomain',
     'infoDomain',
@@ -318,4 +321,65 @@ describe('loadBrandConfig()', () => {
     expect(brand.faviconUrl).toBe('/favicon.ico')
     expect(brand.primaryColor).toBe('#FC72FF')
   })
+
+  it('derives walletName from name when not explicitly set', async () => {
+    vi.stubGlobal(
+      'fetch',
+      vi.fn().mockResolvedValue({
+        ok: true,
+        json: async () => ({
+          brand: { name: 'Zoo Exchange' },
+          chains: { defaultChainId: 200200, supported: [200200] },
+          rpc: {},
+          api: { graphql: '', gateway: '', insights: '' },
+          walletConnect: { projectId: '' },
+        }),
+      }),
+    )
+
+    await loadBrandConfig()
+
+    expect(brand.walletName).toBe('Zoo Wallet')
+    expect(brand.protocolName).toBe('Zoo Protocol')
+  })
+
+  it('uses explicit walletName over derived value', async () => {
+    vi.stubGlobal(
+      'fetch',
+      vi.fn().mockResolvedValue({
+        ok: true,
+        json: async () => ({
+          brand: { name: 'Zoo Exchange', walletName: 'Custom Wallet' },
+          chains: { defaultChainId: 200200, supported: [200200] },
+          rpc: {},
+          api: { graphql: '', gateway: '', insights: '' },
+          walletConnect: { projectId: '' },
+        }),
+      }),
+    )
+
+    await loadBrandConfig()
+
+    expect(brand.walletName).toBe('Custom Wallet')
+  })
+
+  it('derives copyrightHolder from legalEntity when not set', async () => {
+    vi.stubGlobal(
+      'fetch',
+      vi.fn().mockResolvedValue({
+        ok: true,
+        json: async () => ({
+          brand: { name: 'Zoo Exchange', legalEntity: 'Zoo Labs Foundation' },
+          chains: { defaultChainId: 200200, supported: [200200] },
+          rpc: {},
+          api: { graphql: '', gateway: '', insights: '' },
+          walletConnect: { projectId: '' },
+        }),
+      }),
+    )
+
+    await loadBrandConfig()
+
+    expect(brand.copyrightHolder).toBe('Zoo Labs Foundation')
+  })
 })

package/package.json

@@ -1,20 +1,26 @@
 {
   "name": "@l.x/config",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "dependencies": {
     "react-native-dotenv": "3.2.0",
-    "@luxfi/utilities": "workspace:^"
+    "@luxfi/utilities": "^1.0.6"
   },
   "devDependencies": {
     "@types/node": "22.13.1",
     "@typescript/native-preview": "7.0.0-dev.20260311.1",
-    "@luxfi/eslint-config": "workspace:^",
     "depcheck": "1.4.7",
     "eslint": "8.57.1",
     "jsdom": "^26.1.0",
     "typescript": "5.8.3",
-    "vitest": "^4.0.16"
+    "vitest": "^4.0.16",
+    "@luxfi/eslint-config": "^1.0.6"
   },
+  "nx": {
+    "includedScripts": []
+  },
+  "main": "src/index.ts",
+  "private": false,
+  "sideEffects": false,
   "scripts": {
     "typecheck": "nx typecheck config",
     "typecheck:tsgo": "nx typecheck:tsgo config",
@@ -26,11 +32,5 @@
     "lint:eslint:fix": "nx lint:eslint:fix config",
     "test": "vitest run",
     "check:deps:usage": "nx check:deps:usage config"
-  },
-  "nx": {
-    "includedScripts": []
-  },
-  "main": "src/index.ts",
-  "private": false,
-  "sideEffects": false
+  }
 }

package/src/brand.ts

@@ -10,14 +10,45 @@
  *
  * For zoo.exchange: mount a ConfigMap with Zoo branding over /config.json
  * For any L2: same image, different ConfigMap
+ *
+ * KMS integration: set KMS_BRAND_SECRET env var to load brand config from
+ * KMS (Infisical) instead of a ConfigMap. The secret should contain the
+ * full RuntimeConfig JSON. The /config.json endpoint in the serving layer
+ * should proxy to KMS when this env var is set.
  */
 
+/** Theme color overrides applied on top of the default dark/light themes */
+export interface BrandTheme {
+  /** Primary accent color (buttons, links) */
+  accent1?: string
+  /** Background color */
+  surface1?: string
+  /** Secondary surface */
+  surface2?: string
+  /** Tertiary surface */
+  surface3?: string
+  /** Primary text color */
+  neutral1?: string
+  /** Secondary text color */
+  neutral2?: string
+  /** Success status color */
+  statusSuccess?: string
+  /** Critical/error status color */
+  statusCritical?: string
+}
+
 export interface BrandConfig {
   name: string
   title: string
   description: string
   /** Legal entity name for Terms/Privacy, e.g. "Lux Industries Inc." */
   legalEntity: string
+  /** Wallet product name, e.g. "Zoo Wallet" or "Lux Wallet" */
+  walletName: string
+  /** Protocol product name, e.g. "Zoo Protocol" or "Lux Protocol" */
+  protocolName: string
+  /** Copyright holder name, e.g. "Zoo Labs Foundation" */
+  copyrightHolder: string
   appDomain: string
   docsDomain: string
   infoDomain: string
@@ -40,6 +71,11 @@ export interface BrandConfig {
   walletConnectProjectId: string
   insightsHost: string
   insightsApiKey: string
+  /** Theme color overrides for dark and light modes */
+  theme?: {
+    light?: BrandTheme
+    dark?: BrandTheme
+  }
 }
 
 export interface RuntimeConfig {
@@ -66,6 +102,9 @@ export const brand: BrandConfig = {
   title: '',
   description: '',
   legalEntity: '',
+  walletName: '',
+  protocolName: '',
+  copyrightHolder: '',
   appDomain: '',
   docsDomain: '',
   infoDomain: '',
@@ -97,6 +136,10 @@ export let runtimeConfig: RuntimeConfig | null = null
  * Load brand config from /config.json. Call once before React renders.
  * The config.json is either the default shipped in the image, or a
  * ConfigMap mounted by K8s for white-label deployments.
+ *
+ * KMS integration: when the serving layer sets KMS_BRAND_SECRET, it should
+ * proxy /config.json to fetch the secret value from KMS (Infisical). The
+ * SPA itself always fetches /config.json — KMS resolution is server-side.
  */
 export async function loadBrandConfig(): Promise<RuntimeConfig> {
   try {
@@ -109,6 +152,17 @@ export async function loadBrandConfig(): Promise<RuntimeConfig> {
       Object.assign(brand, config.brand)
     }
 
+    // Derive convenience fields from name if not explicitly set
+    if (!brand.walletName && brand.name) {
+      brand.walletName = brand.name.replace(/\s*exchange\s*/i, '') + ' Wallet'
+    }
+    if (!brand.protocolName && brand.name) {
+      brand.protocolName = brand.name.replace(/\s*exchange\s*/i, '') + ' Protocol'
+    }
+    if (!brand.copyrightHolder) {
+      brand.copyrightHolder = brand.legalEntity
+    }
+
     // Apply chain config
     if (config.chains) {
       brand.defaultChainId = config.chains.defaultChainId ?? brand.defaultChainId
@@ -125,9 +179,17 @@ export async function loadBrandConfig(): Promise<RuntimeConfig> {
       brand.insightsHost = config.api.insights
     }
 
-    // Update document title
-    if (typeof document !== 'undefined' && config.brand?.title) {
-      document.title = config.brand.title
+    // Update document title and favicon
+    if (typeof document !== 'undefined') {
+      if (config.brand?.title) {
+        document.title = config.brand.title
+      }
+      if (config.brand?.faviconUrl) {
+        const link = document.querySelector("link[rel*='icon']") as HTMLLinkElement | null
+        if (link) {
+          link.href = config.brand.faviconUrl
+        }
+      }
     }
 
     runtimeConfig = config

package/src/index.ts

@@ -1,4 +1,4 @@
 export type { Config } from './config-types'
 export { getConfig } from './getConfig'
-export { brand, getBrandUrl, getDocsUrl, getGatewayUrl, getWsUrl } from './brand'
-export type { BrandConfig } from './brand'
+export { brand, loadBrandConfig, getBrandUrl, getDocsUrl, getGatewayUrl, getWsUrl } from './brand'
+export type { BrandConfig, BrandTheme } from './brand'