refactor(store): fix lint errors

Agoric · Apr 15, 2023 · 227bc19 · 227bc19
1 parent 8b237f1
commit 227bc19
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 2 deletions.
diff --git a/packages/ERTP/src/paymentLedger.js b/packages/ERTP/src/paymentLedger.js
@@ -20,7 +20,7 @@ const { details: X, quote: q, Fail } = assert;
 /**
  * @param {Brand} brand
  * @param {AssetKind} assetKind
- * @param {Matcher} elementShape
+ * @param {Pattern} elementShape
  */
 const amountShapeFromElementShape = (brand, assetKind, elementShape) => {
   let valueShape;

diff --git a/packages/store/src/types.js b/packages/store/src/types.js
@@ -7,6 +7,10 @@
 /** @template T @typedef {import('@endo/marshal').CopyArray<T>} CopyArray */
 /** @typedef {import('@endo/marshal').Checker} Checker */
 /** @typedef {import('@endo/marshal/src/rankOrder').RankCompare} RankCompare */
+/** @typedef {import('@endo/marshal/src/rankOrder').RankComparison} RankComparison */
+
+// /////////////////////////////////////////////////////////////////////////////
+// Placeholder redundant types, to be imported from `@endo/patterns` instead.
 
 /**
  * @typedef {Passable} Key
@@ -27,6 +31,15 @@
  * TODO placeholder. Figure out how to import from `@endo/patterns` instead
  */
 
+/**
+ * @template {Key} [K=Key]
+ * @typedef {CopyTagged & {
+ *   [Symbol.toStringTag]: 'copyBag',
+ *   payload: Array<[K, bigint]>,
+ * }} CopyBag
+ * TODO placeholder. Figure out how to import from `@endo/patterns` instead
+ */
+
 /**
  * @template {Key} [K=Key]
  * @template {Passable} [V=Passable]
@@ -37,6 +50,53 @@
  * TODO placeholder. Figure out how to import from `@endo/patterns` instead
  */
 
+/**
+ * @typedef {object} GuardMakers
+ * @property {<M extends Record<any, any>>(interfaceName: string,
+ *             methodGuards: M,
+ *             options?: {sloppy?: boolean}
+ * ) => InterfaceGuard} interface
+ * TODO placeholder. Figure out how to import from `@endo/patterns` instead
+ *
+ * @property {(...argGuards: ArgGuard[]) => MethodGuardMaker} call Guard a synchronous call
+ *
+ * @property {(...argGuards: ArgGuard[]) => MethodGuardMaker} callWhen Guard an async call
+ *
+ * @property {(argGuard: ArgGuard) => ArgGuard} await Guard an await
+ */
+
+/**
+ * @typedef {(...args: any[]) => any} Method
+ * TODO placeholder. Figure out how to import from `@endo/patterns` instead
+ */
+
+/**
+ * @typedef {{
+ * klass: 'Interface',
+ * interfaceName: string,
+ * methodGuards: Record<string | symbol, MethodGuard>
+ * sloppy?: boolean
+ * }} InterfaceGuard
+ * TODO placeholder. Figure out how to import from `@endo/patterns` instead
+ */
+
+/**
+ * @typedef {any} MethodGuardMaker
+ * TODO placeholder. Figure out how to import from `@endo/patterns` instead
+ */
+
+/**
+ * @typedef {{ klass: 'methodGuard', callKind: 'sync' | 'async', returnGuard: unknown }} MethodGuard
+ * TODO placeholder. Figure out how to import from `@endo/patterns` instead
+ */
+
+/**
+ * @typedef {any} ArgGuard
+ * TODO placeholder. Figure out how to import from `@endo/patterns` instead
+ */
+
+// /////////////////////////////////////////////////////////////////////////////
+
 /**
  * @typedef {object} StoreOptions
  * Of the dimensions on which KeyedStores can differ, we only represent a few

diff --git a/packages/zoe/src/contractSupport/recorder.js b/packages/zoe/src/contractSupport/recorder.js
@@ -252,7 +252,7 @@ export const prepareMockRecorderKitMakers = () => {
  * explictly specify the type that the Pattern will verify through a match.
  *
  * @template T
- * @typedef {Matcher & {validatedType?: T}} TypedMatcher
+ * @typedef {Pattern & {validatedType?: T}} TypedMatcher
  */
 
 /**