@perspectivefi/addresses 0.0.0-stage → 0.1.1

package/eslint/index.cjs

@@ -0,0 +1,55 @@
+'use strict'
+/**
+ * ESLint flat-config preset for @perspectivefi/addresses. Plain JS, no eslint dependency.
+ *
+ * ESLint keeps only ONE `no-restricted-syntax` setting per file, so everything is combined
+ * into one rule entry. If you already use `no-restricted-syntax`, merge `restrictedSyntax`
+ * into your own list instead of spreading the preset.
+ */
+
+const MESSAGE = 'Contract addresses come from @perspectivefi/addresses (see ADDRESS_REGISTRY spec)'
+
+// Zero address is allowed; every other 0x + 40 hex string is an error.
+const EVM = '/^0x(?!0{40}$)[0-9a-fA-F]{40}$/'
+const STELLAR = '/^C[A-Z2-7]{55}$/'
+
+/** Error on string literals and template chunks that look like a contract address. */
+const hardcodedAddressRules = [
+    { selector: `Literal[value=${EVM}]`, message: MESSAGE },
+    { selector: `Literal[value=${STELLAR}]`, message: MESSAGE },
+    { selector: `TemplateElement[value.cooked=${EVM}]`, message: MESSAGE },
+    { selector: `TemplateElement[value.cooked=${STELLAR}]`, message: MESSAGE },
+]
+
+const CALLEE = '/^(address|requireAddress)$/'
+const CALL_MESSAGE =
+    'The 2nd argument of address()/requireAddress() must be a string literal so the key can be checked statically.'
+
+/** Error when address()/requireAddress() gets a non-literal key (also matches `ns.address(...)`). */
+const literalKeyRules = [
+    {
+        selector: `CallExpression[callee.name=${CALLEE}][arguments.length>=2][arguments.1.type!="Literal"]`,
+        message: CALL_MESSAGE,
+    },
+    {
+        selector: `CallExpression[callee.property.name=${CALLEE}][arguments.length>=2][arguments.1.type!="Literal"]`,
+        message: CALL_MESSAGE,
+    },
+]
+
+const restrictedSyntax = [...hardcodedAddressRules, ...literalKeyRules]
+
+const config = {
+    name: '@perspectivefi/addresses',
+    rules: {
+        'no-restricted-syntax': ['error', ...restrictedSyntax],
+    },
+}
+
+// Helpers are non-enumerable so spreading / passing `config` to ESLint never sees unknown keys.
+const helpers = { default: config, restrictedSyntax, hardcodedAddressRules, literalKeyRules }
+for (const [name, value] of Object.entries(helpers)) {
+    Object.defineProperty(config, name, { value, enumerable: false })
+}
+
+module.exports = config

package/eslint/index.d.ts

@@ -0,0 +1,21 @@
+export interface RestrictedSyntaxRule {
+    selector: string
+    message: string
+}
+
+export interface AddressesEslintConfig {
+    name: string
+    rules: { 'no-restricted-syntax': ['error', ...RestrictedSyntaxRule[]] }
+}
+
+declare const config: AddressesEslintConfig & {
+    default: AddressesEslintConfig
+    /** All selectors, to merge into an existing `no-restricted-syntax` list. */
+    restrictedSyntax: RestrictedSyntaxRule[]
+    /** Only the hardcoded-address selectors. */
+    hardcodedAddressRules: RestrictedSyntaxRule[]
+    /** Only the "2nd argument must be a literal" selectors. */
+    literalKeyRules: RestrictedSyntaxRule[]
+}
+
+export default config

package/package.json

@@ -1,6 +1,83 @@
 {
-  "name": "@perspectivefi/addresses",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+    "name": "@perspectivefi/addresses",
+    "version": "0.1.1",
+    "description": "Contract address registry for Spectra: one list of every address, each with a status. Prod only accepts `safe`.",
+    "main": "./dist/index.js",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "sideEffects": false,
+    "engines": {
+        "node": ">=18"
+    },
+    "exports": {
+        ".": {
+            "import": {
+                "types": "./dist/index.d.mts",
+                "default": "./dist/index.mjs"
+            },
+            "require": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/index.js"
+            }
+        },
+        "./prod": {
+            "import": {
+                "types": "./dist/prod.d.mts",
+                "default": "./dist/prod.mjs"
+            },
+            "require": {
+                "types": "./dist/prod.d.ts",
+                "default": "./dist/prod.js"
+            }
+        },
+        "./eslint": {
+            "types": "./eslint/index.d.ts",
+            "default": "./eslint/index.cjs"
+        },
+        "./registry.json": "./dist/registry.json",
+        "./package.json": "./package.json"
+    },
+    "bin": {
+        "spectra-addresses": "./dist/cli.js"
+    },
+    "files": [
+        "dist",
+        "eslint"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/perspectivefi/spectra-addresses.git"
+    },
+    "keywords": [
+        "spectra",
+        "addresses",
+        "registry",
+        "contracts"
+    ],
+    "author": "Spectra",
+    "license": "ISC",
+    "scripts": {
+        "generate": "tsx scripts/generate.ts",
+        "build": "npm run generate && rm -rf dist && tsup && tsx scripts/emit-registry.ts",
+        "typecheck": "npm run generate && tsc --noEmit",
+        "test": "npm run generate && npm run build && vitest run",
+        "validate": "tsx scripts/validate.ts",
+        "onchain": "tsx scripts/onchain.ts",
+        "format": "prettier --write .",
+        "format:check": "prettier --check ."
+    },
+    "devDependencies": {
+        "@types/node": "^26.6.4",
+        "esbuild": "^0.28.2",
+        "eslint": "^10.12.0",
+        "prettier": "^3.9.9",
+        "tsup": "^8.5.1",
+        "tsx": "^4.23.15",
+        "typescript": "^5.9.3",
+        "viem": "^2.57.4",
+        "vitest": "^5.0.3"
+    }
+}