feat(types): ContractMeta

Agoric · Jun 12, 2024 · 9d02dfa · 9d02dfa
1 parent 0282e58
commit 9d02dfa
Show file tree

Hide file tree

Showing 13 changed files with 56 additions and 14 deletions.
diff --git a/packages/agoric-cli/test/upgrade-contract/fixed-contract.js b/packages/agoric-cli/test/upgrade-contract/fixed-contract.js
@@ -1,7 +1,7 @@
 import { AmountMath } from '@agoric/ertp';
 import { makeDurableZone } from '@agoric/zone/durable.js';
 
-/** @type {ContractMeta} */
+/** @type {ContractMeta<typeof start>} */
 export const meta = {
   upgradability: 'canUpgrade',
 };

diff --git a/packages/boot/test/bootstrapTests/zcfProbe.js b/packages/boot/test/bootstrapTests/zcfProbe.js
@@ -17,7 +17,7 @@ const ZcfProbeI = M.interface('ZCF Probe', {
   makeFaucetInvitation: M.call().returns(M.promise()),
 });
 
-// /** @type {ContractMeta} */
+// /** @type {ContractMeta<typeof start>} */
 // export const meta = { upgradability: 'canUpgrade' };
 // harden(meta);
 

diff --git a/packages/governance/src/committee.js b/packages/governance/src/committee.js
@@ -28,7 +28,7 @@ const { ceilDivide } = natSafeMath;
  * }} CommitteeElectorateCreatorFacet
  */
 
-/** @type {ContractMeta} */
+/** @type {ContractMeta<typeof start>} */
 export const meta = {
   privateArgsShape: {
     storageNode: StorageNodeShape,

diff --git a/packages/governance/src/contractGovernor.js b/packages/governance/src/contractGovernor.js
@@ -15,7 +15,7 @@ const { Fail } = assert;
 
 const trace = makeTracer('CGov', false);
 
-/** @type {ContractMeta} */
+/** @type {ContractMeta<typeof start>} */
 export const meta = {
   upgradability: 'canUpgrade',
 };

diff --git a/packages/inter-protocol/src/econCommitteeCharter.js b/packages/inter-protocol/src/econCommitteeCharter.js
@@ -38,7 +38,7 @@ const ParamChangesOfferArgsShape = M.splitRecord(
   },
 );
 
-/** @type {ContractMeta} */
+/** @type {ContractMeta<typeof start>} */
 export const meta = {
   customTermsShape: {
     binaryVoteCounterInstallation: InstallationShape,

diff --git a/packages/inter-protocol/src/feeDistributor.js b/packages/inter-protocol/src/feeDistributor.js
@@ -9,7 +9,7 @@ import { KeywordShape } from '@agoric/zoe/src/typeGuards.js';
 
 const KeywordSharesShape = M.recordOf(KeywordShape, M.nat());
 
-/** @type {ContractMeta} */
+/** @type {ContractMeta<typeof start>} */
 export const meta = {
   customTermsShape: {
     keywordShares: KeywordSharesShape,

diff --git a/packages/inter-protocol/src/reserve/assetReserve.js b/packages/inter-protocol/src/reserve/assetReserve.js
@@ -10,7 +10,7 @@ import { prepareAssetReserveKit } from './assetReserveKit.js';
 
 const trace = makeTracer('AR', true);
 
-/** @type {ContractMeta} */
+/** @type {ContractMeta<typeof start>} */
 export const meta = {
   upgradability: 'canUpgrade',
 };

diff --git a/packages/orchestration/src/examples/stakeIca.contract.js b/packages/orchestration/src/examples/stakeIca.contract.js
@@ -17,6 +17,7 @@ const trace = makeTracer('StakeAtom');
  * @import {ICQConnection, OrchestrationService} from '../types.js';
  */
 
+/** @type {ContractMeta<typeof start>} */
 export const meta = harden({
   customTermsShape: {
     chainId: M.string(),

diff --git a/packages/orchestration/src/examples/swapExample.contract.js b/packages/orchestration/src/examples/swapExample.contract.js
@@ -21,7 +21,7 @@ import { prepareLocalChainAccountKit } from '../exos/local-chain-account-kit.js'
  * @import {NameHub} from '@agoric/vats';
  */
 
-/** @type {ContractMeta} */
+/** @type {ContractMeta<typeof start>} */
 export const meta = {
   privateArgsShape: {
     agoricNames: M.remotable('agoricNames'),

diff --git a/packages/vats/src/mintHolder.js b/packages/vats/src/mintHolder.js
@@ -25,7 +25,7 @@ function provideIssuerKit(zcf, baggage) {
   return prepareIssuerKit(baggage, keyword, assetKind, displayInfo);
 }
 
-/** @type {ContractMeta} */
+/** @type {ContractMeta<typeof start>} */
 export const meta = {
   upgradability: 'canUpgrade',
 };

diff --git a/packages/zoe/src/contractFacet/types-ambient.d.ts b/packages/zoe/src/contractFacet/types-ambient.d.ts
@@ -217,9 +217,15 @@ type OfferHandler<OR extends unknown = unknown, OA = never> =
   | {
       handle: HandleOffer<OR, OA>;
     };
-type ContractMeta = {
-  customTermsShape?: import('@endo/pass-style').CopyRecord<any> | undefined;
-  privateArgsShape?: import('@endo/pass-style').CopyRecord<any> | undefined;
+type ContractMeta<
+  SF extends // import inline to maintain ambient mode
+    import('../zoeService/utils').ContractStartFunction = import('../zoeService/utils').ContractStartFunction,
+> = {
+  customTermsShape?: Record<
+    Parameters<SF>[0] extends ZCF<infer CT> ? keyof CT : never,
+    Pattern
+  >;
+  privateArgsShape?: { [K in keyof Parameters<SF>[1]]: Pattern };
   upgradability?: 'none' | 'canBeUpgraded' | 'canUpgrade' | undefined;
 };
 /**

diff --git a/packages/zoe/test/swingsetTests/upgradeCoveredCall/coveredCall-durable-V3.js b/packages/zoe/test/swingsetTests/upgradeCoveredCall/coveredCall-durable-V3.js
@@ -12,7 +12,7 @@ const { details: X } = assert;
 
 const sellSeatExpiredMsg = 'The covered call option is expired.';
 
-/** @type {ContractMeta} */
+/** @type {ContractMeta<typeof start>} */
 export const meta = {
   upgradability: 'canUpgrade',
 };

diff --git a/packages/zoe/test/types.test-d.ts b/packages/zoe/test/types.test-d.ts
@@ -7,7 +7,7 @@
 import { E, RemoteFunctions } from '@endo/eventual-send';
 import { expectNotType, expectType } from 'tsd';
 
-import type { Key } from '@endo/patterns';
+import { M, type Key } from '@endo/patterns';
 // 'prepare' is deprecated but still supported
 import type { prepare as scaledPriceAuthorityStart } from '../src/contracts/scaledPriceAuthority.js';
 import type { Instance } from '../src/zoeService/utils.js';
@@ -104,3 +104,38 @@ const mock = null as any;
   // @ts-expect-error
   pf2.notInPublicFacet;
 }
+
+{
+  const start = async (
+    zcf: ZCF<{ anchorBrand: Brand<'nat'> }>,
+    privateArgs: {
+      storageNode: StorageNode;
+      marshaller: Marshaller;
+      feeMintAccess?: FeeMintAccess;
+    },
+  ) => ({});
+
+  const meta: ContractMeta<typeof start> = {
+    // XXX not detected
+    extrakey: 'bad',
+    privateArgsShape: {
+      // @ts-expect-error extra key
+      extraKey: 'bad',
+      marshaller: mock,
+      storageNode: mock,
+    },
+    // @ts-expect-error invalid upgradability value
+    upgradability: 'invalid',
+  };
+
+  const metaWithSplitRecord: ContractMeta<typeof start> = {
+    // XXX not detected
+    extrakey: 'bad',
+    // @ts-expect-error Matcher not assignable
+    privateArgsShape: M.splitRecord({
+      extraKey: 'bad',
+      marshaller: mock,
+      storageNode: mock,
+    }),
+  };
+}