@agoric/fast-usdc 0.1.1-dev-1f25ee2.0 → 0.1.1-dev-e5813b9.0

package/README.md

@@ -88,12 +88,14 @@ stateDiagram-v2
 
 ```mermaid
 stateDiagram-v2
-  Observed --> Advancing
-  Observed --> Forwarding:Minted
+  Observed --> AdvanceSkipped : Risks identified
+  Observed --> Advancing : No risks, can advance
+  Observed --> Forwarding : No risks, Mint deposited before advance
   Forwarding --> Forwarded
   Advancing --> Advanced
   Advanced --> Disbursed
-  AdvanceFailed --> Forwarding
+  AdvanceSkipped --> Forwarding : Mint deposited
+  AdvanceFailed --> Forwarding : Mint deposited
   Advancing --> AdvanceFailed
   Forwarding --> ForwardFailed
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/fast-usdc",
-  "version": "0.1.1-dev-1f25ee2.0+1f25ee2",
+  "version": "0.1.1-dev-e5813b9.0+e5813b9",
   "description": "CLI and library for Fast USDC product",
   "type": "module",
   "files": [
@@ -22,9 +22,9 @@
     "lint:eslint": "eslint ."
   },
   "devDependencies": {
-    "@agoric/swingset-liveslots": "0.10.3-dev-1f25ee2.0+1f25ee2",
-    "@agoric/vats": "0.15.2-dev-1f25ee2.0+1f25ee2",
-    "@agoric/zone": "0.2.3-dev-1f25ee2.0+1f25ee2",
+    "@agoric/swingset-liveslots": "0.10.3-dev-e5813b9.0+e5813b9",
+    "@agoric/vats": "0.15.2-dev-e5813b9.0+e5813b9",
+    "@agoric/zone": "0.2.3-dev-e5813b9.0+e5813b9",
     "@fast-check/ava": "^2.0.1",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
@@ -32,16 +32,16 @@
     "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.1.1-dev-1f25ee2.0+1f25ee2",
-    "@agoric/cosmic-proto": "0.4.1-dev-1f25ee2.0+1f25ee2",
-    "@agoric/ertp": "0.16.3-dev-1f25ee2.0+1f25ee2",
-    "@agoric/internal": "0.3.3-dev-1f25ee2.0+1f25ee2",
-    "@agoric/notifier": "0.6.3-dev-1f25ee2.0+1f25ee2",
-    "@agoric/orchestration": "0.1.1-dev-1f25ee2.0+1f25ee2",
-    "@agoric/store": "0.9.3-dev-1f25ee2.0+1f25ee2",
-    "@agoric/vat-data": "0.5.3-dev-1f25ee2.0+1f25ee2",
-    "@agoric/vow": "0.1.1-dev-1f25ee2.0+1f25ee2",
-    "@agoric/zoe": "0.26.3-dev-1f25ee2.0+1f25ee2",
+    "@agoric/client-utils": "0.1.1-dev-e5813b9.0+e5813b9",
+    "@agoric/cosmic-proto": "0.4.1-dev-e5813b9.0+e5813b9",
+    "@agoric/ertp": "0.16.3-dev-e5813b9.0+e5813b9",
+    "@agoric/internal": "0.3.3-dev-e5813b9.0+e5813b9",
+    "@agoric/notifier": "0.6.3-dev-e5813b9.0+e5813b9",
+    "@agoric/orchestration": "0.1.1-dev-e5813b9.0+e5813b9",
+    "@agoric/store": "0.9.3-dev-e5813b9.0+e5813b9",
+    "@agoric/vat-data": "0.5.3-dev-e5813b9.0+e5813b9",
+    "@agoric/vow": "0.1.1-dev-e5813b9.0+e5813b9",
+    "@agoric/zoe": "0.26.3-dev-e5813b9.0+e5813b9",
     "@cosmjs/proto-signing": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
     "@endo/base64": "^1.0.9",
@@ -81,5 +81,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1f25ee2ec66788523594e25f020ccf3b6103d259"
+  "gitHead": "e5813b9a1b7aff07f84e2b185351b3283e29e141"
 }

package/src/constants.js

@@ -12,6 +12,8 @@ export const TxStatus = /** @type {const} */ ({
   Advanced: 'ADVANCED',
   /** IBC transfer failed (timed out) */
   AdvanceFailed: 'ADVANCE_FAILED',
+  /** Advance skipped and waiting for forward */
+  AdvanceSkipped: 'ADVANCE_SKIPPED',
   /** settlement for matching advance received and funds disbursed */
   Disbursed: 'DISBURSED',
   /** fallback: do not collect fees */
@@ -42,5 +44,7 @@ export const PendingTxStatus = /** @type {const} */ ({
   AdvanceFailed: 'ADVANCE_FAILED',
   /** IBC transfer is complete */
   Advanced: 'ADVANCED',
+  /** Advance skipped and waiting for forward */
+  AdvanceSkipped: 'ADVANCE_SKIPPED',
 });
 harden(PendingTxStatus);

package/src/exos/advancer.js

@@ -8,9 +8,9 @@ import { E } from '@endo/far';
 import { M, mustMatch } from '@endo/patterns';
 import { Fail, q } from '@endo/errors';
 import {
-  CctpTxEvidenceShape,
   AddressHookShape,
   EvmHashShape,
+  EvidenceWithRiskShape,
 } from '../type-guards.js';
 import { makeFeeTools } from '../utils/fees.js';
 
@@ -22,7 +22,7 @@ import { makeFeeTools } from '../utils/fees.js';
  * @import {ZoeTools} from '@agoric/orchestration/src/utils/zoe-tools.js';
  * @import {VowTools} from '@agoric/vow';
  * @import {Zone} from '@agoric/zone';
- * @import {CctpTxEvidence, AddressHook, EvmHash, FeeConfig, LogFn, NobleAddress} from '../types.js';
+ * @import {CctpTxEvidence, AddressHook, EvmHash, FeeConfig, LogFn, NobleAddress, EvidenceWithRisk} from '../types.js';
  * @import {StatusManager} from './status-manager.js';
  * @import {LiquidityPoolKit} from './liquidity-pool.js';
  */
@@ -55,7 +55,7 @@ const AdvancerVowCtxShape = M.splitRecord(
 /** type guards internal to the AdvancerKit */
 const AdvancerKitI = harden({
   advancer: M.interface('AdvancerI', {
-    handleTransactionEvent: M.callWhen(CctpTxEvidenceShape).returns(),
+    handleTransactionEvent: M.callWhen(EvidenceWithRiskShape).returns(),
     setIntermediateRecipient: M.call(ChainAddressShape).returns(),
   }),
   depositHandler: M.interface('DepositHandlerI', {
@@ -137,9 +137,9 @@ export const prepareAdvancerKit = (
          * `StatusManager` - so we don't need to concern ourselves with
          * preserving the vow chain for callers.
          *
-         * @param {CctpTxEvidence} evidence
+         * @param {EvidenceWithRisk} evidenceWithRisk
          */
-        async handleTransactionEvent(evidence) {
+        async handleTransactionEvent({ evidence, risk }) {
           await null;
           try {
             if (statusManager.hasBeenObserved(evidence)) {
@@ -147,6 +147,12 @@ export const prepareAdvancerKit = (
               return;
             }
 
+            if (risk.risksIdentified?.length) {
+              log('risks identified, skipping advance');
+              statusManager.skipAdvance(evidence, risk.risksIdentified);
+              return;
+            }
+
             const { borrowerFacet, poolAccount, settlementAddress } =
               this.state;
             const { recipientAddress } = evidence.aux;

package/src/exos/operator-kit.js

@@ -1,18 +1,18 @@
 import { makeTracer } from '@agoric/internal';
 import { Fail } from '@endo/errors';
 import { M } from '@endo/patterns';
-import { CctpTxEvidenceShape } from '../type-guards.js';
+import { CctpTxEvidenceShape, RiskAssessmentShape } from '../type-guards.js';
 
 const trace = makeTracer('TxOperator');
 
 /**
  * @import {Zone} from '@agoric/zone';
- * @import {CctpTxEvidence} from '../types.js';
+ * @import {CctpTxEvidence, RiskAssessment} from '../types.js';
  */
 
 /**
  * @typedef {object} OperatorPowers
- * @property {(evidence: CctpTxEvidence, operatorId: string) => void} attest
+ * @property {(evidence: CctpTxEvidence, riskAssessment: RiskAssessment, operatorId: string) => void} attest
  */
 
 /**
@@ -31,11 +31,15 @@ const OperatorKitI = {
   }),
 
   invitationMakers: M.interface('InvitationMakers', {
-    SubmitEvidence: M.call(CctpTxEvidenceShape).returns(M.promise()),
+    SubmitEvidence: M.call(CctpTxEvidenceShape)
+      .optional(RiskAssessmentShape)
+      .returns(M.promise()),
   }),
 
   operator: M.interface('Operator', {
-    submitEvidence: M.call(CctpTxEvidenceShape).returns(),
+    submitEvidence: M.call(CctpTxEvidenceShape)
+      .optional(RiskAssessmentShape)
+      .returns(),
     getStatus: M.call().returns(M.record()),
   }),
 };
@@ -81,13 +85,14 @@ export const prepareOperatorKit = (zone, staticPowers) =>
          * fluxAggregator contract used for price oracles.
          *
          * @param {CctpTxEvidence} evidence
+         * @param {RiskAssessment} [riskAssessment]
          * @returns {Promise<Invitation>}
          */
-        async SubmitEvidence(evidence) {
+        async SubmitEvidence(evidence, riskAssessment) {
           const { operator } = this.facets;
           // TODO(bootstrap integration): cause this call to throw and confirm that it
           // shows up in the the smart-wallet UpdateRecord `error` property
-          operator.submitEvidence(evidence);
+          operator.submitEvidence(evidence, riskAssessment);
           return staticPowers.makeInertInvitation(
             'evidence was pushed in the invitation maker call',
           );
@@ -98,12 +103,13 @@ export const prepareOperatorKit = (zone, staticPowers) =>
          * submit evidence from this operator
          *
          * @param {CctpTxEvidence} evidence
+         * @param {RiskAssessment} [riskAssessment]
          * @returns {void}
          */
-        submitEvidence(evidence) {
+        submitEvidence(evidence, riskAssessment = {}) {
           const { state } = this;
           !state.disabled || Fail`submitEvidence for disabled operator`;
-          state.powers.attest(evidence, state.operatorId);
+          state.powers.attest(evidence, riskAssessment, state.operatorId);
         },
         /** @returns {OperatorStatus} */
         getStatus() {

package/src/exos/settler.js

@@ -181,6 +181,7 @@ export const prepareSettler = (
               return;
 
             case PendingTxStatus.Observed:
+            case PendingTxStatus.AdvanceSkipped:
             case PendingTxStatus.AdvanceFailed:
               return self.forward(found.txHash, nfa, amount, EUD);
 

package/src/exos/status-manager.js

@@ -14,7 +14,7 @@ import {
 /**
  * @import {MapStore, SetStore} from '@agoric/store';
  * @import {Zone} from '@agoric/zone';
- * @import {CctpTxEvidence, NobleAddress, PendingTx, EvmHash, LogFn, TransactionRecord} from '../types.js';
+ * @import {CctpTxEvidence, NobleAddress, PendingTx, EvmHash, LogFn, TransactionRecord, EvidenceWithRisk, RiskAssessment} from '../types.js';
  */
 
 /**
@@ -146,8 +146,9 @@ export const prepareStatusManager = (
    *
    * @param {CctpTxEvidence} evidence
    * @param {PendingTxStatus} status
+   * @param {string[]} [risksIdentified]
    */
-  const initPendingTx = (evidence, status) => {
+  const initPendingTx = (evidence, status, risksIdentified) => {
     const { txHash } = evidence;
     if (seenTxs.has(txHash)) {
       throw makeError(`Transaction already seen: ${q(txHash)}`);
@@ -160,7 +161,9 @@ export const prepareStatusManager = (
       harden({ ...evidence, status }),
     );
     publishEvidence(txHash, evidence);
-    if (status !== PendingTxStatus.Observed) {
+    if (status === PendingTxStatus.AdvanceSkipped) {
+      void publishTxnRecord(txHash, harden({ status, risksIdentified }));
+    } else if (status !== PendingTxStatus.Observed) {
       // publishEvidence publishes Observed
       void publishTxnRecord(txHash, harden({ status }));
     }
@@ -194,6 +197,9 @@ export const prepareStatusManager = (
       // TODO: naming scheme for transition events
       advance: M.call(CctpTxEvidenceShape).returns(M.undefined()),
       advanceOutcome: M.call(M.string(), M.nat(), M.boolean()).returns(),
+      skipAdvance: M.call(CctpTxEvidenceShape, M.arrayOf(M.string())).returns(
+        M.undefined(),
+      ),
       observe: M.call(CctpTxEvidenceShape).returns(M.undefined()),
       hasBeenObserved: M.call(CctpTxEvidenceShape).returns(M.boolean()),
       deleteCompletedTxs: M.call().returns(M.undefined()),
@@ -203,6 +209,7 @@ export const prepareStatusManager = (
             txHash: EvmHashShape,
             status: M.or(
               PendingTxStatus.Advanced,
+              PendingTxStatus.AdvanceSkipped,
               PendingTxStatus.AdvanceFailed,
               PendingTxStatus.Observed,
             ),
@@ -224,7 +231,8 @@ export const prepareStatusManager = (
       /**
        * Add a new transaction with ADVANCING status
        *
-       * NB: this acts like observe() but skips recording the OBSERVED state
+       * NB: this acts like observe() but subsequently records an ADVANCING
+       * state
        *
        * @param {CctpTxEvidence} evidence
        */
@@ -232,6 +240,23 @@ export const prepareStatusManager = (
         initPendingTx(evidence, PendingTxStatus.Advancing);
       },
 
+      /**
+       * Add a new transaction with ADVANCE_SKIPPED status
+       *
+       * NB: this acts like observe() but subsequently records an
+       * ADVANCE_SKIPPED state along with risks identified
+       *
+       * @param {CctpTxEvidence} evidence
+       * @param {string[]} risksIdentified
+       */
+      skipAdvance(evidence, risksIdentified) {
+        initPendingTx(
+          evidence,
+          PendingTxStatus.AdvanceSkipped,
+          risksIdentified,
+        );
+      },
+
       /**
        * Record result of ADVANCING
        *

package/src/exos/transaction-feed.js

@@ -2,14 +2,15 @@ import { makeTracer } from '@agoric/internal';
 import { prepareDurablePublishKit } from '@agoric/notifier';
 import { keyEQ, M } from '@endo/patterns';
 import { Fail } from '@endo/errors';
-import { CctpTxEvidenceShape } from '../type-guards.js';
+import { CctpTxEvidenceShape, RiskAssessmentShape } from '../type-guards.js';
 import { defineInertInvitation } from '../utils/zoe.js';
 import { prepareOperatorKit } from './operator-kit.js';
 
 /**
  * @import {Zone} from '@agoric/zone';
+ * @import {MapStore} from '@agoric/store';
  * @import {OperatorKit} from './operator-kit.js';
- * @import {CctpTxEvidence} from '../types.js';
+ * @import {CctpTxEvidence, EvidenceWithRisk, RiskAssessment} from '../types.js';
  */
 
 const trace = makeTracer('TxFeed', true);
@@ -19,7 +20,11 @@ export const INVITATION_MAKERS_DESC = 'oracle operator invitation';
 
 const TransactionFeedKitI = harden({
   operatorPowers: M.interface('Transaction Feed Admin', {
-    attest: M.call(CctpTxEvidenceShape, M.string()).returns(),
+    attest: M.call(
+      CctpTxEvidenceShape,
+      RiskAssessmentShape,
+      M.string(),
+    ).returns(),
   }),
   creator: M.interface('Transaction Feed Creator', {
     // TODO narrow the return shape to OperatorKit
@@ -32,6 +37,22 @@ const TransactionFeedKitI = harden({
   }),
 });
 
+/**
+ * @param {MapStore<string, RiskAssessment>[]} riskStores
+ * @param {string} txHash
+ */
+const allRisksIdentified = (riskStores, txHash) => {
+  /**  @type {Set<string>} */
+  const setOfRisks = new Set();
+  for (const store of riskStores) {
+    const next = store.get(txHash);
+    for (const risk of next.risksIdentified ?? []) {
+      setOfRisks.add(risk);
+    }
+  }
+  return [...setOfRisks.values()].sort();
+};
+
 /**
  * @param {Zone} zone
  * @param {ZCF} zcf
@@ -42,7 +63,7 @@ export const prepareTransactionFeedKit = (zone, zcf) => {
     kinds,
     'Transaction Feed',
   );
-  /** @type {PublishKit<CctpTxEvidence>} */
+  /** @type {PublishKit<EvidenceWithRisk>} */
   const { publisher, subscriber } = makeDurablePublishKit();
 
   const makeInertInvitation = defineInertInvitation(zcf, 'submitting evidence');
@@ -56,14 +77,12 @@ export const prepareTransactionFeedKit = (zone, zcf) => {
     TransactionFeedKitI,
     () => {
       /** @type {MapStore<string, OperatorKit>} */
-      const operators = zone.mapStore('operators', {
-        durable: true,
-      });
+      const operators = zone.mapStore('operators');
       /** @type {MapStore<string, MapStore<string, CctpTxEvidence>>} */
-      const pending = zone.mapStore('pending', {
-        durable: true,
-      });
-      return { operators, pending };
+      const pending = zone.mapStore('pending');
+      /** @type {MapStore<string, MapStore<string, RiskAssessment>>} */
+      const risks = zone.mapStore('risks');
+      return { operators, pending, risks };
     },
     {
       creator: {
@@ -90,7 +109,7 @@ export const prepareTransactionFeedKit = (zone, zcf) => {
         },
         /** @param {string} operatorId */
         initOperator(operatorId) {
-          const { operators, pending } = this.state;
+          const { operators, pending, risks } = this.state;
           trace('initOperator', operatorId);
 
           const operatorKit = makeOperatorKit(
@@ -102,6 +121,7 @@ export const prepareTransactionFeedKit = (zone, zcf) => {
             operatorId,
             zone.detached().mapStore('pending evidence'),
           );
+          risks.init(operatorId, zone.detached().mapStore('risk assessments'));
 
           return operatorKit;
         },
@@ -122,11 +142,12 @@ export const prepareTransactionFeedKit = (zone, zcf) => {
          * NB: the operatorKit is responsible for
          *
          * @param {CctpTxEvidence} evidence
+         * @param {RiskAssessment} riskAssessment
          * @param {string} operatorId
          */
-        attest(evidence, operatorId) {
-          const { operators, pending } = this.state;
-          trace('submitEvidence', operatorId, evidence);
+        attest(evidence, riskAssessment, operatorId) {
+          const { operators, pending, risks } = this.state;
+          trace('attest', operatorId, evidence);
 
           // TODO https://github.com/Agoric/agoric-sdk/pull/10720
           // TODO validate that it's a valid for Fast USDC before accepting
@@ -141,6 +162,9 @@ export const prepareTransactionFeedKit = (zone, zcf) => {
               trace(`operator ${operatorId} already reported ${txHash}`);
             } else {
               pendingStore.init(txHash, evidence);
+              // accept the risk assessment as well
+              const riskStore = risks.get(operatorId);
+              riskStore.init(txHash, riskAssessment);
             }
           }
 
@@ -183,12 +207,24 @@ export const prepareTransactionFeedKit = (zone, zcf) => {
             lastEvidence = next;
           }
 
-          // sufficient agreement, so remove from pending and publish
+          const riskStores = [...risks.values()].filter(store =>
+            store.has(txHash),
+          );
+          // take the union of risks identified from all operators
+          const risksIdentified = allRisksIdentified(riskStores, txHash);
+
+          // sufficient agreement, so remove from pending risks, then publish
           for (const store of found) {
             store.delete(txHash);
           }
-          trace('publishing evidence', evidence);
-          publisher.publish(evidence);
+          for (const store of riskStores) {
+            store.delete(txHash);
+          }
+          trace('publishing evidence', evidence, risksIdentified);
+          publisher.publish({
+            evidence,
+            risk: { risksIdentified },
+          });
         },
       },
       public: {

package/src/fast-usdc.contract.js

@@ -38,7 +38,7 @@ const ADDRESSES_BAGGAGE_KEY = 'addresses';
  * @import {Marshaller, StorageNode} from '@agoric/internal/src/lib-chainStorage.js'
  * @import {Zone} from '@agoric/zone';
  * @import {OperatorKit} from './exos/operator-kit.js';
- * @import {CctpTxEvidence, FeeConfig} from './types.js';
+ * @import {CctpTxEvidence, FeeConfig, RiskAssessment} from './types.js';
  */
 
 /**
@@ -202,9 +202,10 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
      * capability is available in the smart-wallet bridge during UI testing.
      *
      * @param {CctpTxEvidence} evidence
+     * @param {RiskAssessment} [risk]
      */
-    makeTestPushInvitation(evidence) {
-      void advancer.handleTransactionEvent(evidence);
+    makeTestPushInvitation(evidence, risk = {}) {
+      void advancer.handleTransactionEvent({ evidence, risk });
       return makeTestInvitation();
     },
     makeDepositInvitation() {
@@ -303,9 +304,9 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
   );
   // Connect evidence stream to advancer
   void observeIteration(subscribeEach(feedKit.public.getEvidenceSubscriber()), {
-    updateState(evidence) {
+    updateState(evidenceWithRisk) {
       try {
-        void advancer.handleTransactionEvent(evidence);
+        void advancer.handleTransactionEvent(evidenceWithRisk);
       } catch (err) {
         trace('🚨 Error handling transaction event', err);
       }

package/src/type-guards.js

@@ -6,7 +6,7 @@ import { PendingTxStatus } from './constants.js';
  * @import {TypedPattern} from '@agoric/internal';
  * @import {FastUsdcTerms} from './fast-usdc.contract.js';
  * @import {USDCProposalShapes} from './pool-share-math.js';
- * @import {CctpTxEvidence, FeeConfig, PendingTx, PoolMetrics, ChainPolicy, FeedPolicy, AddressHook, EvmAddress, EvmHash} from './types.js';
+ * @import {CctpTxEvidence, FeeConfig, PendingTx, PoolMetrics, ChainPolicy, FeedPolicy, AddressHook, EvmAddress, EvmHash, RiskAssessment, EvidenceWithRisk} from './types.js';
  */
 
 /**
@@ -49,6 +49,15 @@ export const EvmHashShape = M.string({
 });
 harden(EvmHashShape);
 
+/** @type {TypedPattern<RiskAssessment>} */
+export const RiskAssessmentShape = M.splitRecord(
+  {},
+  {
+    risksIdentified: M.arrayOf(M.string()),
+  },
+);
+harden(RiskAssessmentShape);
+
 /** @type {TypedPattern<CctpTxEvidence>} */
 export const CctpTxEvidenceShape = {
   aux: {
@@ -67,6 +76,13 @@ export const CctpTxEvidenceShape = {
 };
 harden(CctpTxEvidenceShape);
 
+/** @type {TypedPattern<EvidenceWithRisk>} */
+export const EvidenceWithRiskShape = {
+  evidence: CctpTxEvidenceShape,
+  risk: RiskAssessmentShape,
+};
+harden(EvidenceWithRiskShape);
+
 /** @type {TypedPattern<PendingTx>} */
 // @ts-expect-error TypedPattern not recognized as record
 export const PendingTxShape = {

package/src/types.ts

@@ -17,6 +17,10 @@ export type NobleAddress = `noble1${string}`;
 export type EvmChainID = number;
 export type EvmChainName = string;
 
+export interface RiskAssessment {
+  risksIdentified?: string[];
+}
+
 export interface CctpTxEvidence {
   /** from Noble RPC */
   aux: {
@@ -35,6 +39,11 @@ export interface CctpTxEvidence {
   txHash: EvmHash;
 }
 
+export interface EvidenceWithRisk {
+  evidence: CctpTxEvidence;
+  risk: RiskAssessment;
+}
+
 /**
  * 'evidence' only available when it's first observed and not in subsequent
  * updates.
@@ -42,6 +51,7 @@ export interface CctpTxEvidence {
 export interface TransactionRecord extends CopyRecord {
   evidence?: CctpTxEvidence;
   split?: RepayAmountKWR;
+  risksIdentified?: string[];
   status: TxStatus;
 }