Agoric · mergify · May 20, 2024 · May 17, 2024 · May 17, 2024 · May 17, 2024
diff --git a/docs/typescript.md b/docs/typescript.md
@@ -7,13 +7,17 @@ Our use of TypeScript has to accomodate both .js development in agoric-sdk (whic
 - `.d.ts` for types modules
 - package entrypoint(s) exports explicit types
 - for packages upon which other packages expect ambient types:
- - `exported.js` exports the explicit types and ambient re-exports
+ - `exported.js` supplies ambients
+- don't use runtime imports to get types ([issue](https://github.com/Agoric/agoric-sdk/issues/6512))
 
 ## .d.ts modules
 
-We cannot use `.ts` files any modules that are transitively imported into an Endo bundle. The reason is that the Endo bundler doesn't understand `.ts` syntax and we don't want it to until we have sufficient auditability of the transformation. Moreover we've tried to avoid a build step in order to import a module. (The one exception so far is `@agoric/cosmic-proto` because we codegen the types. Those modules are written in `.ts` syntax and build to `.js` by a build step that creates `dist`, which is the package export.)
+We cannot use `.ts` files in any modules that are transitively imported into an Endo bundle. The reason is that the Endo bundler doesn't understand `.ts` syntax and we don't want it to until we have sufficient auditability of the transformation. Moreover we've tried to avoid a build step in order to import a module. (The one exception so far is `@agoric/cosmic-proto` because we codegen the types. Those modules are written in `.ts` syntax and build to `.js` by a build step that creates `dist`, which is the package export.)
 
-A `.d.ts` module allows defining the type in `.ts` syntax, without any risk that it will be included in runtime code. The `.js` is what actually gets imported.
+### Benefits
+
+- A `.d.ts` module allows defining the type in `.ts` syntax, without any risk that it will be included in runtime code. The `.js` is what actually gets imported.
+- Only `.d.ts` files can be used in [triple-slash reference types](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html#-reference-types-)
 
 The are some consequences to this approach.
 

diff --git a/packages/ERTP/exported.d.ts b/packages/ERTP/exported.d.ts
@@ -2,8 +2,7 @@
 /** @see {@link /docs/typescript.md} */
 /* eslint-disable -- doesn't understand .d.ts */
 
-// XXX also explicit exports because `@agoric/ertp` top level confuses the type and value of `AssetKind`
-export * from './src/types.js';
+import '@agoric/notifier/exported.js';
 
 import {
  Amount as _Amount,

diff --git a/packages/ERTP/src/paymentLedger.js b/packages/ERTP/src/paymentLedger.js
@@ -1,15 +1,14 @@
 // @jessie-check
 
+/// <reference types="@agoric/store/exported.js" />
+
 /* eslint-disable no-use-before-define */
 import { isPromise } from '@endo/promise-kit';
 import { mustMatch, M, keyEQ } from '@agoric/store';
 import { AmountMath } from './amountMath.js';
 import { preparePaymentKind } from './payment.js';
 import { preparePurseKind } from './purse.js';
 
-// XXX ambient types runtime imports until https://github.com/Agoric/agoric-sdk/issues/6512
-import '@agoric/store/exported.js';
-
 import { BrandI, makeIssuerInterfaces } from './typeGuards.js';
 
 /**

diff --git a/packages/ERTP/tsconfig.json b/packages/ERTP/tsconfig.json
@@ -1,9 +1,7 @@
 // This file can contain .js-specific Typescript compiler config.
 {
  "extends": "../../tsconfig.json",
- "compilerOptions": {
- "maxNodeModuleJsDepth": 1,
- },
+ "compilerOptions": {},
  "include": [
  // omit exported.js because 1) it need not be included in the typecheck of
  // this package because it's only consumed by other packages and 2)

diff --git a/packages/SwingSet/exported.js b/packages/SwingSet/exported.js
diff --git a/packages/SwingSet/src/vats/plugin-manager.js b/packages/SwingSet/src/vats/plugin-manager.js
@@ -5,8 +5,6 @@ import { HandledPromise } from '@endo/eventual-send';
 import { Remotable } from '@endo/marshal';
 import { Far, E } from '@endo/far';
 
-import '@agoric/store/exported.js';
-
 /**
  * @template T
  * @typedef {T | PromiseLike<T>} ERef

diff --git a/packages/SwingSet/tools/prepare-test-env-ava.js b/packages/SwingSet/tools/prepare-test-env-ava.js
@@ -8,8 +8,6 @@ import '@endo/init/pre-bundle-source.js';
 
 import '@agoric/swingset-liveslots/tools/prepare-test-env.js';
 
-import '@endo/ses-ava/exported.js';
-
 import { wrapTest } from '@endo/ses-ava';
 import rawTest from 'ava';
 

diff --git a/packages/SwingSet/tsconfig.json b/packages/SwingSet/tsconfig.json
@@ -1,9 +1,7 @@
 // This file can contain .js-specific Typescript compiler config.
 {
  "extends": "../../tsconfig.json",
- "compilerOptions": {
- "maxNodeModuleJsDepth": 2,
- },
+ "compilerOptions": {},
  "include": [
  "exported.js",
  "demo/**/*.js",

diff --git a/packages/agoric-cli/package.json b/packages/agoric-cli/package.json
@@ -99,6 +99,6 @@
  "workerThreads": false
  },
  "typeCoverage": {
- "atLeast": 76.88
+ "atLeast": 76.99
  }
 }
diff --git a/packages/agoric-cli/src/init.js b/packages/agoric-cli/src/init.js
@@ -2,8 +2,6 @@ import chalk from 'chalk';
 import { makePspawn } from './helpers.js';
 
 /// <reference types="@endo/captp/src/types.js" />
-/// <reference types="@agoric/swingset-vat/exported.js" />
-/// <reference types="@agoric/network/exported.js" />
 
 // Use either an absolute template URL, or find it relative to DAPP_URL_BASE.
 const gitURL = (relativeOrAbsoluteURL, base) => {

diff --git a/packages/agoric-cli/tsconfig.json b/packages/agoric-cli/tsconfig.json
@@ -3,7 +3,6 @@
  "extends": "../../tsconfig.json",
  "compilerOptions": {
  "checkJs": false,
- "maxNodeModuleJsDepth": 2,
  },
  "include": [
  "*.js",

diff --git a/packages/assert/exported.js b/packages/assert/exported.js
diff --git a/packages/assert/package.json b/packages/assert/package.json
@@ -46,7 +46,6 @@
  "homepage": "https://github.com/Agoric/agoric-sdk#readme",
  "files": [
  "src/",
- "exported.js",
  "NEWS.md"
  ],
  "publishConfig": {

diff --git a/packages/assert/tsconfig.json b/packages/assert/tsconfig.json
@@ -2,7 +2,6 @@
 {
  "extends": "../../tsconfig.json",
  "include": [
- "exported.js",
  "src/**/*.js",
  "test/**/*.js",
  ],

diff --git a/packages/async-flow/package.json b/packages/async-flow/package.json
@@ -61,6 +61,6 @@
  "workerThreads": false
  },
  "typeCoverage": {
- "atLeast": 96.68
+ "atLeast": 77.83
  }
 }
diff --git a/packages/base-zone/src/index.js b/packages/base-zone/src/index.js
@@ -1,7 +1,6 @@
 // @jessie-check
 
-// XXX ambient types runtime imports until https://github.com/Agoric/agoric-sdk/issues/6512
-import '@agoric/store/exported.js';
+/// <reference types="@agoric/store/exported.js" />
 
 // eslint-disable-next-line import/export
 export * from './exports.js';

diff --git a/packages/base-zone/tsconfig.json b/packages/base-zone/tsconfig.json
@@ -1,9 +1,7 @@
 // This file can contain .js-specific Typescript compiler config.
 {
  "extends": "../../tsconfig.json",
- "compilerOptions": {
- "maxNodeModuleJsDepth": 2,
- },
+ "compilerOptions": {},
  "include": [
  "*.js",
  "scripts",

diff --git a/packages/benchmark/src/benchmarkerator.js b/packages/benchmark/src/benchmarkerator.js
@@ -4,10 +4,6 @@ import fs from 'node:fs';
 import '@endo/init/pre-bundle-source.js';
 import '@endo/init';
 
-// XXX ambient types runtime imports until https://github.com/Agoric/agoric-sdk/issues/6512
-import '@agoric/vats/exported.js';
-import '@agoric/inter-protocol/exported.js';
-import '@agoric/zoe/exported.js';
 import '@agoric/cosmic-swingset/src/launch-chain.js';
 
 import { Fail } from '@agoric/assert';

diff --git a/packages/benchmark/tsconfig.json b/packages/benchmark/tsconfig.json
@@ -3,7 +3,6 @@
  "compilerOptions": {
  "allowImportingTsExtensions": true,
  "checkJs": true,
- "maxNodeModuleJsDepth": 2,
  },
  "include": [
  "*.js",

diff --git a/packages/boot/test/bootstrapTests/zcfProbe.js b/packages/boot/test/bootstrapTests/zcfProbe.js
@@ -1,6 +1,3 @@
-// XXX ambient types runtime imports until https://github.com/Agoric/agoric-sdk/issues/6512
-import '@agoric/zoe/exported.js';
-
 import { makeTracer } from '@agoric/internal';
 import { E } from '@endo/far';
 import {

diff --git a/packages/boot/tools/supports.ts b/packages/boot/tools/supports.ts
@@ -18,9 +18,6 @@ import { loadSwingsetConfigFile } from '@agoric/swingset-vat';
 import { makeSlogSender } from '@agoric/telemetry';
 import { TimeMath, Timestamp } from '@agoric/time';
 
-// XXX ambient types runtime imports until https://github.com/Agoric/agoric-sdk/issues/6512
-import '@agoric/vats/exported.js';
-
 import {
  boardSlottingMarshaller,
  slotToBoardRemote,

diff --git a/packages/boot/tsconfig.json b/packages/boot/tsconfig.json
@@ -3,7 +3,6 @@
  "compilerOptions": {
  "allowImportingTsExtensions": true,
  "checkJs": true,
- "maxNodeModuleJsDepth": 2,
  },
  "include": [
  "*.js",

diff --git a/packages/builders/tsconfig.json b/packages/builders/tsconfig.json
@@ -2,7 +2,6 @@
  "extends": "../../tsconfig.json",
  "compilerOptions": {
  "checkJs": true,
- "maxNodeModuleJsDepth": 2,
  },
  "include": [
  "*.js",

diff --git a/packages/cache/src/types.js b/packages/cache/src/types.js
@@ -1,8 +1,8 @@
 // @jessie-check
 
+/// <reference types="@agoric/store/exported.js" />
+
 // XXX package factoring debt
-import '@agoric/notifier/exported.js';
-import '@agoric/store/exported.js';
 
 // Ensure this is a module.
 export {};

diff --git a/packages/cache/tsconfig.json b/packages/cache/tsconfig.json
@@ -1,9 +1,7 @@
 // This file can contain .js-specific Typescript compiler config.
 {
  "extends": "../../tsconfig.json",
- "compilerOptions": {
- "maxNodeModuleJsDepth": 1,
- },
+ "compilerOptions": {},
  "include": [
  "*.js",
  "public/**/*.js",

diff --git a/packages/casting/tsconfig.json b/packages/casting/tsconfig.json
@@ -1,9 +1,7 @@
 // This file can contain .js-specific Typescript compiler config.
 {
  "extends": "../../tsconfig.json",
- "compilerOptions": {
- "maxNodeModuleJsDepth": 2,
- },
+ "compilerOptions": {},
  "include": [
  "*.js",
  "public/**/*.js",

diff --git a/packages/cosmic-swingset/tsconfig.json b/packages/cosmic-swingset/tsconfig.json
@@ -3,7 +3,6 @@
  "extends": "../../tsconfig.json",
  "compilerOptions": {
  "checkJs": false,
- "maxNodeModuleJsDepth": 1,
  },
  "include": [
  "calc-*.js",

diff --git a/packages/deploy-script-support/exported.js b/packages/deploy-script-support/exported.js
diff --git a/packages/deploy-script-support/package.json b/packages/deploy-script-support/package.json
@@ -58,8 +58,7 @@
  },
  "files": [
  "src",
- "NEWS.md",
- "exported.js"
+ "NEWS.md"
  ],
  "ava": {
  "files": [

diff --git a/packages/deploy-script-support/test/unitTests/depositInvitation.test.js b/packages/deploy-script-support/test/unitTests/depositInvitation.test.js
@@ -3,8 +3,6 @@ import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 
 import { makeIssuerKit, AssetKind, AmountMath } from '@agoric/ertp';
 
-import '../../exported.js';
-
 import { makeDepositInvitation } from '../../src/depositInvitation.js';
 
 test('depositInvitation', async t => {

diff --git a/packages/deploy-script-support/test/unitTests/findInvitationAmount.test.js b/packages/deploy-script-support/test/unitTests/findInvitationAmount.test.js
@@ -3,8 +3,6 @@ import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 
 import { makeIssuerKit, AssetKind, AmountMath } from '@agoric/ertp';
 
-import '../../exported.js';
-
 import { makeOfferAndFindInvitationAmount } from '../../src/offer.js';
 
 test('findInvitationAmount', async t => {

diff --git a/packages/deploy-script-support/test/unitTests/install.test.js b/packages/deploy-script-support/test/unitTests/install.test.js
@@ -6,8 +6,6 @@ import { makeFakeBoard } from '@agoric/vats/tools/board-utils.js';
 import bundleSource from '@endo/bundle-source';
 import { resolve as importMetaResolve } from 'import-meta-resolve';
 
-import '../../exported.js';
-
 import { makeInstall } from '../../src/install.js';
 
 test('install', async t => {

diff --git a/packages/deploy-script-support/test/unitTests/offer.test.js b/packages/deploy-script-support/test/unitTests/offer.test.js
@@ -7,8 +7,6 @@ import { makeIssuerKit, AmountMath } from '@agoric/ertp';
 import { resolve as importMetaResolve } from 'import-meta-resolve';
 import { E } from '@endo/far';
 
-import '../../exported.js';
-
 import { makeOfferAndFindInvitationAmount } from '../../src/offer.js';
 
 test('offer', async t => {

diff --git a/packages/deploy-script-support/tsconfig.json b/packages/deploy-script-support/tsconfig.json
@@ -1,9 +1,7 @@
 // This file can contain .js-specific Typescript compiler config.
 {
  "extends": "../../tsconfig.json",
- "compilerOptions": {
- "maxNodeModuleJsDepth": 2,
- },
+ "compilerOptions": {},
  "include": [
  "*.js",
  "src/**/*.js",

diff --git a/packages/governance/package.json b/packages/governance/package.json
@@ -77,6 +77,6 @@
  "access": "public"
  },
  "typeCoverage": {
- "atLeast": 89.32
+ "atLeast": 89.31
  }
 }
diff --git a/packages/governance/src/index.js b/packages/governance/src/index.js
@@ -1,7 +1,6 @@
 /// <reference types="@agoric/internal/exported" />
 /// <reference types="@agoric/ertp/exported" />
-// XXX ambient types runtime imports until https://github.com/Agoric/agoric-sdk/issues/6512
-import '@agoric/zoe/exported.js';
+/// <reference types="@agoric/zoe/exported" />
 
 export {
  ChoiceMethod,

diff --git a/packages/governance/src/types.js b/packages/governance/src/types.js
@@ -699,6 +699,7 @@ export {};
  * @param {ERef<ZoeService>} zoe
  * @param {Instance} allegedGovernor
  * @param {Instance} allegedElectorate
+ * @returns {Promise<true>}
  */
 
 /**

diff --git a/packages/governance/test/unitTests/binaryballotCount.test.js b/packages/governance/test/unitTests/binaryballotCount.test.js
@@ -1,8 +1,6 @@
 /* eslint @typescript-eslint/no-floating-promises: "warn" */
-import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 
-// XXX ambient types runtime imports until https://github.com/Agoric/agoric-sdk/issues/6512
-import '@agoric/zoe/exported.js';
+import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 
 import { E } from '@endo/eventual-send';
 import buildManualTimer from '@agoric/zoe/tools/manualTimer.js';

diff --git a/packages/governance/test/unitTests/committee.test.js b/packages/governance/test/unitTests/committee.test.js
@@ -1,8 +1,5 @@
 import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 
-// XXX ambient types runtime imports until https://github.com/Agoric/agoric-sdk/issues/6512
-import '@agoric/zoe/exported.js';
-
 import { makeMockChainStorageRoot } from '@agoric/internal/src/storage-test-utils.js';
 import { eventLoopIteration } from '@agoric/internal/src/testing-utils.js';
 import buildManualTimer from '@agoric/zoe/tools/manualTimer.js';

diff --git a/packages/governance/test/unitTests/paramChangePositions.test.js b/packages/governance/test/unitTests/paramChangePositions.test.js
@@ -1,5 +1,5 @@
 import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
-import '@agoric/zoe/exported.js';
+
 import { AmountMath, AssetKind, makeIssuerKit } from '@agoric/ertp';
 import { makeRatio } from '@agoric/zoe/src/contractSupport/index.js';
 

diff --git a/packages/governance/test/unitTests/paramGovernance.test.js b/packages/governance/test/unitTests/paramGovernance.test.js
@@ -1,4 +1,3 @@
-import '@agoric/zoe/exported.js';
 import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 
 import { makeMockChainStorageRoot } from '@agoric/internal/src/storage-test-utils.js';

diff --git a/packages/governance/tsconfig.json b/packages/governance/tsconfig.json
@@ -1,8 +1,6 @@
 {
  "extends": "../../tsconfig.json",
- "compilerOptions": {
- "maxNodeModuleJsDepth": 2,
- },
+ "compilerOptions": {},
  "include": [
  // omit exported.js because 1) it need not be included in the typecheck of
  // this package because it's only consumed by other packages and 2)

diff --git a/packages/inter-protocol/exported.js b/packages/inter-protocol/exported.js
diff --git a/packages/inter-protocol/package.json b/packages/inter-protocol/package.json
@@ -66,7 +66,6 @@
  "files": [
  "scripts",
  "src/",
- "exported.js",
  "NEWS.md"
  ],
  "ava": {

diff --git a/packages/inter-protocol/src/auction/auctionBook.js b/packages/inter-protocol/src/auction/auctionBook.js
@@ -1,9 +1,6 @@
 /// <reference types="@agoric/internal/exported" />
 /// <reference types="@agoric/governance/exported" />
-
-// XXX ambient types runtime imports until https://github.com/Agoric/agoric-sdk/issues/6512
-import '@agoric/zoe/exported.js';
-import '@agoric/zoe/src/contracts/exported.js';
+/// <reference types="@agoric/zoe/exported" />
 
 import { AmountMath, RatioShape } from '@agoric/ertp';
 import { mustMatch } from '@agoric/store';