normalize package privacy (#11137)

mergify[bot] · web-flow · commit 9825f6d28093 · 2025-03-21T21:17:26.000Z
refs: #10811 ## Description #10811 introduces a new private package. I wanted to make clear in the naming that it's private and I arrived at this rule: - ~the package is published if and only if it starts with `@agoric` or `agoric`~ - a new org called `@aglocal` for packages that shouldn't be published This adds a lint rule to enforce that, then it renames a few packages to comply. ~It also removes `@agoric/benchmark` because I believe that's no longer being used. @gibson042 please confirm. If it is needed I'll just rename it.~ ### Security Considerations Makes more clear what gets published to NPM ### Scaling Considerations n/a ### Documentation Considerations Documentation in the script ### Testing Considerations CI ### Upgrade Considerations n/a
diff --git a/.github/workflows/test-all-packages.yml b/.github/workflows/test-all-packages.yml
@@ -93,6 +93,7 @@ jobs:
 
       - name: lint repo format
         run: yarn lint:format
+      - run: yarn lint:package-names
       # eslint and tsc
       - run: yarn lint:packages
 
diff --git a/package.json b/package.json
@@ -63,6 +63,7 @@
     "lint-fix": "yarn lerna run --no-bail lint-fix",
     "lint": "run-s --continue-on-error lint:*",
     "lint:packages": "yarn lerna run --no-bail lint",
+    "lint:package-names": "./scripts/verify-package-names.js",
     "test": "yarn lerna run --no-bail test",
     "test:xs": "yarn workspaces run test:xs",
     "build": "yarn workspaces run build && scripts/agd-builder.sh stamp yarn-built",
diff --git a/packages/agoric-cli/src/sdk-package-names.js b/packages/agoric-cli/src/sdk-package-names.js
@@ -1,11 +1,13 @@
 // DO NOT EDIT - automatically generated by get-sdk-package-names.js
 // prettier-ignore
 export default [
+  "@aglocal/benchmark",
+  "@aglocal/boot",
+  "@aglocal/deployment",
+  "@aglocal/swingset-runner",
   "@agoric/access-token",
   "@agoric/async-flow",
   "@agoric/base-zone",
-  "@agoric/benchmark",
-  "@agoric/boot",
   "@agoric/builders",
   "@agoric/cache",
   "@agoric/casting",
@@ -15,7 +17,6 @@ export default [
   "@agoric/cosmos",
   "@agoric/create-dapp",
   "@agoric/deploy-script-support",
-  "@agoric/deployment",
   "@agoric/ertp",
   "@agoric/eslint-config",
   "@agoric/fast-usdc",
@@ -36,7 +37,6 @@ export default [
   "@agoric/store",
   "@agoric/swing-store",
   "@agoric/swingset-liveslots",
-  "@agoric/swingset-runner",
   "@agoric/swingset-vat",
   "@agoric/swingset-xsnap-supervisor",
   "@agoric/telemetry",
diff --git a/packages/benchmark/benchmark/benchmark-liquidation.js b/packages/benchmark/benchmark/benchmark-liquidation.js
@@ -2,7 +2,7 @@
 import { bench } from '../src/benchmarkerator.js';
 
 import { Offers } from '@agoric/inter-protocol/src/clientSupport.js';
-import { scale6 } from '@agoric/boot/tools/liquidation.js';
+import { scale6 } from '@aglocal/boot/tools/liquidation.js';
 
 const setupData = {
   vaults: [
diff --git a/packages/benchmark/doc/benchmarkerator.md b/packages/benchmark/doc/benchmarkerator.md
@@ -41,7 +41,7 @@ yourself).[^2]
 
 The first thing a benchmark should do is import The Benchmarkerator:
 ```
-import { bench } from '@agoric/benchmark';
+import { bench } from '@aglocal/benchmark';
 ```
 
 Note that this importation usually should be the very first thing you do, much
diff --git a/packages/benchmark/package.json b/packages/benchmark/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@agoric/benchmark",
+  "name": "@aglocal/benchmark",
   "version": "0.1.0",
   "private": true,
   "description": "Benchmark support",
@@ -22,13 +22,13 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@endo/errors": "^1.2.9",
-    "@agoric/boot": "^0.1.0",
+    "@aglocal/boot": "^0.1.0",
     "@agoric/cosmic-swingset": "^0.41.3",
-    "@agoric/internal": "^0.3.2",
     "@agoric/inter-protocol": "^0.16.1",
+    "@agoric/internal": "^0.3.2",
     "@agoric/vats": "^0.15.1",
     "@agoric/zoe": "^0.26.2",
+    "@endo/errors": "^1.2.9",
     "@endo/init": "^1.1.8"
   },
   "devDependencies": {},
diff --git a/packages/benchmark/src/benchmarkerator.js b/packages/benchmark/src/benchmarkerator.js
@@ -9,12 +9,12 @@ import '@agoric/cosmic-swingset/src/launch-chain.js';
 import { Fail } from '@endo/errors';
 import { eventLoopIteration } from '@agoric/internal/src/testing-utils.js';
 import { makeAgoricNamesRemotesFromFakeStorage } from '@agoric/vats/tools/board-utils.js';
-import { makeSwingsetTestKit } from '@agoric/boot/tools/supports.js';
+import { makeSwingsetTestKit } from '@aglocal/boot/tools/supports.js';
 import {
   makeWalletFactoryDriver,
   makeGovernanceDriver,
-} from '@agoric/boot/tools/drivers.js';
-import { makeLiquidationTestKit } from '@agoric/boot/tools/liquidation.js';
+} from '@aglocal/boot/tools/drivers.js';
+import { makeLiquidationTestKit } from '@aglocal/boot/tools/liquidation.js';
 
 // When I was a child my family took a lot of roadtrips around California to go
 // camping and backpacking and so on.  It was not uncommon in those days (nor is
@@ -44,7 +44,7 @@ import { makeLiquidationTestKit } from '@agoric/boot/tools/liquidation.js';
  * @typedef {{
  *    options: Record<string, string>,
  *    argv: string[],
- *    actors: Record<string, import('@agoric/boot/tools/drivers.ts').SmartWalletDriver>,
+ *    actors: Record<string, import('@aglocal/boot/tools/drivers.ts').SmartWalletDriver>,
  *    tools: Record<string, unknown>,
  *    title?: string,
  *    rounds?: number,
diff --git a/packages/boot/package.json b/packages/boot/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@agoric/boot",
+  "name": "@aglocal/boot",
   "version": "0.1.0",
   "private": true,
   "description": "Config and utilities to bootstrap an Agoric chain",
diff --git a/packages/deployment/package.json b/packages/deployment/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@agoric/deployment",
+  "name": "@aglocal/deployment",
   "version": "3.0.0",
   "description": "Set up Agoric public chain nodes",
   "type": "module",
@@ -29,9 +29,6 @@
     "minimist": "^1.2.0",
     "temp": "^0.9.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "devDependencies": {
     "readline-transform": "^1.0.0"
   },
diff --git a/packages/fast-usdc/README.md b/packages/fast-usdc/README.md
@@ -9,12 +9,12 @@ This package is meant to contain all the code for the Fast USDC product. However
 
 - a3p integration tests are in the `a3p-integration` top-level package, separate from this workspace
 - the proposal builders are in `@agoric/builders` to work with the a3p-integration `build:submissions` script
-- the RunUtils tests are in `@agoric/boot` to test running them atop a fresh bootstrapped environment
+- the RunUtils tests are in `@aglocal/boot` to test running them atop a fresh bootstrapped environment
 
 Over time we can update our tooling to decouple this more from the `packages` directory.
 
 1. Make a3p-integration `build:submissions` script work with arbitrary builder paths, allowing this to be above `@agoric/builders` in the package graph
-2. Export bootstrap testing utilities from `@agoric/boot`, allowing this to be above `@agoric/boot` in the package graph
+2. Export bootstrap testing utilities from `@aglocal/boot`, allowing this to be above `@aglocal/boot` in the package graph
 3. Update CI to support packages that aren't under `packages/`, eg. a top-level `dapps` directory
 4. Move this package out of agoric-sdk
 
diff --git a/packages/swingset-runner/package.json b/packages/swingset-runner/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@agoric/swingset-runner",
+  "name": "@aglocal/swingset-runner",
   "version": "0.22.2",
   "private": true,
   "description": "Application to launch SwingSet instances for development and testing",
diff --git a/packages/vm-config/README.md b/packages/vm-config/README.md
@@ -1,8 +1,8 @@
 # VM Config
 
-Factored out of [@agoric/vats](../vats), by way of [@agoric/boot](../boot).
+Factored out of [@agoric/vats](../vats), by way of [@aglocal/boot](../boot).
 
-This is similar to `@agoric/boot` but because that has the integration testing of bootstrap, it depends on almost everything.
+This is similar to `@aglocal/boot` but because that has the integration testing of bootstrap, it depends on almost everything.
 
 The configs themselves have no dependencies. Keeping them separate allows packages to depend on them without depending on the world.
 
diff --git a/scripts/verify-package-names.js b/scripts/verify-package-names.js
@@ -0,0 +1,58 @@
+#!/usr/bin/env node
+
+/**
+ * This script verifies that every package in the @agoric/sdk project has an
+ * Agoric-controlled name and its name matches its `private` flag.
+ *
+ * This helps make more clear when viewing a package name whether it will be published.
+ * It's also a backstop against accidentally flipping the `private` flag because
+ * our NPM account doesn't have permission to publish to non-Agoric names.
+ */
+
+import { execFileSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+// eslint-disable-next-line import/no-relative-packages -- one-off script
+import { listWorkspaces } from '../packages/agoric-cli/src/lib/packageManager.js';
+
+let hasErrors = false;
+const err = msg => {
+  console.error(msg);
+  hasErrors = true;
+};
+
+// Get all workspaces in the project
+const workspaces = listWorkspaces({ execFileSync });
+
+// Check each package.json
+for (const { name, location } of workspaces) {
+  const packageJsonPath = path.join(location, 'package.json');
+
+  try {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    const { private: isPrivate } = packageJson;
+
+    // These orgs and name are owned in NPM by OpCo
+    const owned =
+      name.startsWith('@agoric/') ||
+      name.startsWith('@aglocal/') ||
+      name === 'agoric';
+
+    if (!owned) {
+      err(`Uncontrolled package name ${name}`);
+    }
+
+    const isLocal = name.startsWith('@aglocal/');
+
+    if (isLocal && !isPrivate) {
+      err(`Package ${name} is a local name but is not marked private`);
+    } else if (isPrivate && !isLocal) {
+      err(`Package ${name} is a public name but marked private`);
+    }
+  } catch (error) {
+    err(`Error processing ${packageJsonPath}: ${error.message}`);
+  }
+}
+
+// Exit with error code if any issues were found
+process.exit(hasErrors ? 1 : 0);
diff --git a/tsconfig.json b/tsconfig.json
@@ -25,5 +25,6 @@
   "include": [
     "eslint.config.mjs",
     "dist",
+    "scripts"
   ]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "@agoric/boot",`
	`2`	`+ "name": "@aglocal/boot",`
`3`	`3`	`"version": "0.1.0",`
`4`	`4`	`"private": true,`
`5`	`5`	`"description": "Config and utilities to bootstrap an Agoric chain",`