feat(types): ExoObj utility

packages/governance/src/contractGovernorKit.js

@@ -273,4 +273,4 @@ export const prepareContractGovernorKit = (baggage, powers) => {
   return makeContractGovernorKit;
 };
 
-/** @typedef {ReturnType<ReturnType<typeof prepareContractGovernorKit>>} ContractGovernorKit */
+/** @typedef {import('@agoric/internal').ExoObj<typeof prepareContractGovernorKit>} ContractGovernorKit */

packages/governance/test/swingsetTests/contractGovernor/vat-voter.js

@@ -106,7 +106,7 @@ const build = async (log, zoe) => {
 };
 
 /**
- * @typedef {ReturnType<Awaited<ReturnType<typeof build>>['createVoter']>} EVatVoter
+ * @typedef {import('@agoric/internal').ExoObjtypeof build>>['createVoter']>} EVatVoter
  */
 
 /** @type {import('@agoric/swingset-vat/src/kernel/vat-loader/types.js').BuildRootObjectForTestVat} */

packages/inter-protocol/src/auction/auctionBook.js

@@ -789,4 +789,4 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
 };
 harden(prepareAuctionBook);
 
-/** @typedef {ReturnType<ReturnType<typeof prepareAuctionBook>>} AuctionBook */
+/** @typedef {import('@agoric/internal').ExoObj<typeof prepareAuctionBook>} AuctionBook */

packages/inter-protocol/src/price/fluxAggregatorKit.js

@@ -374,4 +374,4 @@ export const prepareFluxAggregatorKit = async (
   return makeFluxAggregatorKit;
 };
 harden(prepareFluxAggregatorKit);
-/** @typedef {ReturnType<Awaited<ReturnType<typeof prepareFluxAggregatorKit>>>} FluxAggregatorKit */
+/** @typedef {import('@agoric/internal').ExoObjtypeof prepareFluxAggregatorKit>>>} FluxAggregatorKit */

packages/inter-protocol/src/price/priceOracleKit.js

@@ -122,4 +122,4 @@ export const prepareOracleAdminKit = baggage =>
     },
   );
 
-/** @typedef {ReturnType<ReturnType<typeof prepareOracleAdminKit>>} OracleKit */
+/** @typedef {import('@agoric/internal').ExoObj<typeof prepareOracleAdminKit>} OracleKit */

packages/inter-protocol/src/reserve/assetReserveKit.js

@@ -286,4 +286,4 @@ export const prepareAssetReserveKit = async (
   return makeAssetReserveKit;
 };
 harden(prepareAssetReserveKit);
-/** @typedef {ReturnType<Awaited<ReturnType<typeof prepareAssetReserveKit>>>} AssetReserveKit */
+/** @typedef {import('@agoric/internal').ExoObjtypeof prepareAssetReserveKit>>>} AssetReserveKit */

packages/inter-protocol/src/vaultFactory/vault.js

@@ -867,4 +867,4 @@ export const prepareVault = (baggage, makeRecorderKit, zcf) => {
   return maker;
 };
 
-/** @typedef {ReturnType<ReturnType<typeof prepareVault>>['self']} Vault */
+/** @typedef {import('@agoric/internal').ExoObj<typeof prepareVault>['self']} Vault */

packages/inter-protocol/src/vaultFactory/vaultDirector.js

@@ -510,13 +510,14 @@ const prepareVaultDirector = (
   return makeVaultDirector;
 };
 harden(prepareVaultDirector);
+/** @typedef {import('@agoric/internal').ExoObj<typeof prepareVaultDirector>} VaultDirector */
 
 /**
  * Prepare the VaultDirector kind, get or make the singleton
  *
  * @type {(
  *   ...pvdArgs: Parameters<typeof prepareVaultDirector>
- * ) => ReturnType<ReturnType<typeof prepareVaultDirector>>}
+ * ) => VaultDirector}
  */
 export const provideDirector = (...args) => {
   const makeVaultDirector = prepareVaultDirector(...args);

packages/inter-protocol/src/vaultFactory/vaultKit.js

@@ -44,4 +44,4 @@ export const prepareVaultKit = (baggage, makeRecorderKit) => {
   return makeVaultKit;
 };
 
-/** @typedef {ReturnType<ReturnType<typeof prepareVaultKit>>} VaultKit */
+/** @typedef {import('@agoric/internal').ExoObj<typeof prepareVaultKit>} VaultKit */

packages/inter-protocol/src/vaultFactory/vaultManager.js

@@ -1280,7 +1280,7 @@ export const prepareVaultManagerKit = (
   return makeVaultManagerKit;
 };
 
-/** @typedef {Awaited<ReturnType<ReturnType<typeof prepareVaultManagerKit>>>} VaultManagerKit */
+/** @typedef {import('@agoric/internal').ExoObj<typeof prepareVaultManagerKit>} VaultManagerKit */
 /**
  * @typedef {VaultManagerKit['self']} VaultManager Each VaultManager manages a
  *   single collateral type.

packages/internal/src/index.js

@@ -7,6 +7,8 @@ export * from './debug.js';
 export * from './utils.js';
 export * from './method-tools.js';
 export * from './typeGuards.js';
+// eslint-disable-next-line import/no-unresolved -- implemented as .d.ts
+export * from './types.js';
 
 export { objectMap } from '@endo/common/object-map.js';
 export { fromUniqueEntries } from '@endo/common/from-unique-entries.js';

packages/internal/src/types.d.ts

@@ -18,3 +18,5 @@ export declare class SyncCallback<
 
   public isSync: true;
 }
+
+export type ExoObj<T> = Awaited<ReturnType<Awaited<ReturnType<T>>>>;

packages/smart-wallet/src/smartWallet.js

@@ -1187,5 +1187,4 @@ export const prepareSmartWallet = (baggage, shared) => {
   return makeSmartWallet;
 };
 harden(prepareSmartWallet);
-
-/** @typedef {Awaited<ReturnType<ReturnType<typeof prepareSmartWallet>>>} SmartWallet */
+/** @typedef {import('@agoric/internal').ExoObj<typeof prepareSmartWallet>} SmartWallet */

packages/vats/src/bridge.js

@@ -110,7 +110,7 @@ export const prepareBridgeManager = (zone, D) => {
       /**
        * @type {MapStore<
        *   string,
-       *   ReturnType<ReturnType<typeof prepareScopedManager>>
+       *   import('@agoric/internal').ExoObj<typeof prepareScopedManager>
        * >}
        */
       scopedManagers: zone.detached().mapStore('scopedManagers'),

packages/vats/src/localchain.js

@@ -55,6 +55,11 @@ const prepareLocalChainAccount = zone =>
       },
     },
   );
+/**
+ * @typedef {import('@agoric/internal').ExoObj<
+ *   typeof prepareLocalChainAccount
+ * >} LocalChainAccount
+ */
 
 export const LocalChainI = M.interface('LocalChain', {
   createAccount: M.callWhen().returns(M.remotable('LocalChainAccount')),
@@ -92,6 +97,7 @@ const prepareLocalChain = (zone, createAccount) =>
       },
     },
   );
+/** @typedef {import('@agoric/internal').ExoObj<typeof prepareLocalChain>} LocalChain */
 
 /** @param {import('@agoric/base-zone').Zone} zone */
 export const prepareLocalChainTools = zone => {
@@ -101,6 +107,4 @@ export const prepareLocalChainTools = zone => {
   return harden({ makeLocalChain });
 };
 harden(prepareLocalChainTools);
-
 /** @typedef {ReturnType<typeof prepareLocalChainTools>} LocalChainTools */
-/** @typedef {ReturnType<LocalChainTools['makeLocalChain']>} LocalChain */

packages/vats/src/vat-bank.js

@@ -35,7 +35,7 @@ const BridgeChannelI = M.interface('BridgeChannel', {
 /**
  * @typedef {import('./virtual-purse.js').VirtualPurseController} VirtualPurseController
  *
- * @typedef {Awaited<ReturnType<ReturnType<typeof prepareVirtualPurse>>>} VirtualPurse
+ * @typedef {import('@agoric/internal').ExoObj<typeof prepareVirtualPurse>} VirtualPurse
  */
 
 /**

packages/vow/src/tools.js

@@ -29,3 +29,4 @@ export const prepareVowTools = (zone, powers = {}) => {
   return harden({ when, watch, makeVowKit });
 };
 harden(prepareVowTools);
+/** @type {import('@agoric/internal').ExoObj<typeof prepareVowTools>} VowTools */