refactor: single type-guards.js file

Agoric · Nov 15, 2024 · a1d931d · a1d931d
1 parent 14ec771
commit a1d931d
Show file tree

Hide file tree

Showing 10 changed files with 60 additions and 65 deletions.
diff --git a/packages/fast-usdc/src/exos/advancer.js b/packages/fast-usdc/src/exos/advancer.js
@@ -6,7 +6,7 @@ import { VowShape } from '@agoric/vow';
 import { q } from '@endo/errors';
 import { E } from '@endo/far';
 import { M } from '@endo/patterns';
-import { CctpTxEvidenceShape, EudParamShape } from '../typeGuards.js';
+import { CctpTxEvidenceShape, EudParamShape } from '../type-guards.js';
 import { addressTools } from '../utils/address.js';
 import { makeFeeTools } from '../utils/fees.js';
 

diff --git a/packages/fast-usdc/src/exos/operator-kit.js b/packages/fast-usdc/src/exos/operator-kit.js
@@ -1,7 +1,7 @@
 import { makeTracer } from '@agoric/internal';
 import { Fail } from '@endo/errors';
 import { M } from '@endo/patterns';
-import { CctpTxEvidenceShape } from '../typeGuards.js';
+import { CctpTxEvidenceShape } from '../type-guards.js';
 
 const trace = makeTracer('TxOperator');
 

diff --git a/packages/fast-usdc/src/exos/status-manager.js b/packages/fast-usdc/src/exos/status-manager.js
@@ -2,7 +2,7 @@ import { M } from '@endo/patterns';
 import { makeError, q } from '@endo/errors';
 
 import { appendToStoredArray } from '@agoric/store/src/stores/store-utils.js';
-import { CctpTxEvidenceShape, PendingTxShape } from '../typeGuards.js';
+import { CctpTxEvidenceShape, PendingTxShape } from '../type-guards.js';
 import { PendingTxStatus } from '../constants.js';
 
 /**

diff --git a/packages/fast-usdc/src/exos/transaction-feed.js b/packages/fast-usdc/src/exos/transaction-feed.js
@@ -1,7 +1,7 @@
 import { makeTracer } from '@agoric/internal';
 import { prepareDurablePublishKit } from '@agoric/notifier';
 import { M } from '@endo/patterns';
-import { CctpTxEvidenceShape } from '../typeGuards.js';
+import { CctpTxEvidenceShape } from '../type-guards.js';
 import { defineInertInvitation } from '../utils/zoe.js';
 import { prepareOperatorKit } from './operator-kit.js';
 

diff --git a/packages/fast-usdc/src/fast-usdc.contract.js b/packages/fast-usdc/src/fast-usdc.contract.js
@@ -14,7 +14,7 @@ import { prepareSettler } from './exos/settler.js';
 import { prepareStatusManager } from './exos/status-manager.js';
 import { prepareTransactionFeedKit } from './exos/transaction-feed.js';
 import { defineInertInvitation } from './utils/zoe.js';
-import { FeeConfigShape } from './typeGuards.js';
+import { FeeConfigShape } from './type-guards.js';
 
 const trace = makeTracer('FastUsdc');
 

diff --git a/packages/fast-usdc/src/type-guards.js b/packages/fast-usdc/src/type-guards.js
@@ -1,8 +1,11 @@
 import { M } from '@endo/patterns';
+import { BrandShape, RatioShape } from '@agoric/ertp';
+import { PendingTxStatus } from './constants.js';
 
 /**
- * @import {TypedPattern} from '@agoric/internal'
- * @import {USDCProposalShapes} from './pool-share-math'
+ * @import {TypedPattern} from '@agoric/internal';
+ * @import {USDCProposalShapes} from './pool-share-math';
+ * @import {CctpTxEvidence, FeeConfig, PendingTx} from './types.js';
  */
 
 /**
@@ -26,3 +29,50 @@ export const makeProposalShapes = ({ PoolShares, USDC }) => {
   });
   return harden({ deposit, withdraw });
 };
+
+/** @type {TypedPattern<string>} */
+export const EvmHashShape = M.string({
+  stringLengthLimit: 66,
+});
+harden(EvmHashShape);
+
+/** @type {TypedPattern<CctpTxEvidence>} */
+export const CctpTxEvidenceShape = {
+  aux: {
+    forwardingChannel: M.string(),
+    recipientAddress: M.string(),
+  },
+  blockHash: EvmHashShape,
+  blockNumber: M.bigint(),
+  blockTimestamp: M.bigint(),
+  chainId: M.number(),
+  tx: {
+    amount: M.bigint(),
+    forwardingAddress: M.string(),
+  },
+  txHash: EvmHashShape,
+};
+harden(CctpTxEvidenceShape);
+
+/** @type {TypedPattern<PendingTx>} */
+// @ts-expect-error TypedPattern can't handle spreading?
+export const PendingTxShape = {
+  ...CctpTxEvidenceShape,
+  status: M.or(...Object.values(PendingTxStatus)),
+};
+harden(PendingTxShape);
+
+export const EudParamShape = {
+  EUD: M.string(),
+};
+harden(EudParamShape);
+
+const NatAmountShape = { brand: BrandShape, value: M.nat() };
+/** @type {TypedPattern<FeeConfig>} */
+export const FeeConfigShape = {
+  flat: NatAmountShape,
+  variableRate: RatioShape,
+  maxVariable: NatAmountShape,
+  contractRate: RatioShape,
+};
+harden(FeeConfigShape);
diff --git a/packages/fast-usdc/src/typeGuards.js b/packages/fast-usdc/src/typeGuards.js
diff --git a/packages/fast-usdc/src/utils/fees.js b/packages/fast-usdc/src/utils/fees.js
@@ -2,7 +2,7 @@ import { AmountMath } from '@agoric/ertp';
 import { multiplyBy } from '@agoric/zoe/src/contractSupport/ratio.js';
 import { Fail } from '@endo/errors';
 import { mustMatch } from '@endo/patterns';
-import { FeeConfigShape } from '../typeGuards.js';
+import { FeeConfigShape } from '../type-guards.js';
 
 const { add, isGTE, min, subtract } = AmountMath;
 

diff --git a/packages/fast-usdc/test/typeGuards.test.ts → packages/fast-usdc/test/type-guards.test.ts b/packages/fast-usdc/test/typeGuards.test.ts → packages/fast-usdc/test/type-guards.test.ts
@@ -2,7 +2,7 @@ import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 
 import { mustMatch } from '@endo/patterns';
 import { TxStatus, PendingTxStatus } from '../src/constants.js';
-import { CctpTxEvidenceShape, PendingTxShape } from '../src/typeGuards.js';
+import { CctpTxEvidenceShape, PendingTxShape } from '../src/type-guards.js';
 import type { CctpTxEvidence } from '../src/types.js';
 
 import { MockCctpTxEvidences } from './fixtures.js';

diff --git a/packages/fast-usdc/test/utils/address.test.ts b/packages/fast-usdc/test/utils/address.test.ts
@@ -2,7 +2,7 @@ import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 import { M } from '@endo/patterns';
 
 import { addressTools } from '../../src/utils/address.js';
-import { EudParamShape } from '../../src/typeGuards.js';
+import { EudParamShape } from '../../src/type-guards.js';
 
 const FIXTURES = {
   AGORIC_WITH_DYDX: