@agoric/fast-usdc 0.1.1-dev-db6d589.0 → 0.1.1-dev-47470c7.0

package/README.md

@@ -1,101 +1,27 @@
 # Fast USDC
 
-Development package for the Fast USDC product.
-Here in agoric-sdk as a convenience for integration testing and iterating on the SDK affordances required for the product.
+Development package for the Fast USDC product. Here in agoric-sdk as a
+convenience for integration testing and iterating on the SDK affordances
+required for the product.
 
 # Factoring
 
-This package is meant to contain all the code for the Fast USDC product. However there are some constraints:
+This package is meant to contain all the code for the Fast USDC product.
+However, there are some constraints:
 
-- a3p integration tests are in the `a3p-integration` top-level package, separate from this workspace
-- the proposal builders are in `@agoric/builders` to work with the a3p-integration `build:submissions` script
-- the RunUtils tests are in `@aglocal/boot` to test running them atop a fresh bootstrapped environment
+- a3p integration tests are in the `a3p-integration` top-level package, separate
+    from this workspace
+- the proposal builders are in `@agoric/builders` to work with the
+    a3p-integration `build:submissions` script
+- the RunUtils tests are in `@aglocal/boot` to test running them atop a fresh
+    bootstrapped environment
 
 Over time we can update our tooling to decouple this more from the `packages` directory.
 
-1. Make a3p-integration `build:submissions` script work with arbitrary builder paths, allowing this to be above `@agoric/builders` in the package graph
-2. Export bootstrap testing utilities from `@aglocal/boot`, allowing this to be above `@aglocal/boot` in the package graph
-3. Update CI to support packages that aren't under `packages/`, eg. a top-level `dapps` directory
+1. Make a3p-integration `build:submissions` script work with arbitrary builder
+    paths, allowing this to be above `@agoric/builders` in the package graph
+2. Export bootstrap testing utilities from `@aglocal/boot`, allowing this to be
+    above `@aglocal/boot` in the package graph
+3. Update CI to support packages that aren't under `packages/`, eg. a top-level
+   `dapps` directory
 4. Move this package out of agoric-sdk
-
-# Transaction feed
-
-## Oracles interface
-
-Oracles run off-chain and interact with the contract via an Agoric smart wallet bridge.
-```mermaid
-sequenceDiagram
-    title Becoming an oracle operator
-    participant OW as Operator N<br/>Smart Wallet
-    participant FUC as Fast USDC<br/>Contract Exo
-    participant CE as Core Eval
-
-    CE->>FUC: makeOperatorInvitation()
-    FUC-->>CE: operatorInvitation
-    CE->>+OW: deposit(operatorInvitation)
-
-    Note left of FUC: Off-chain wallet accepts the operator invitation
-
-    OW->>+FUC: offer(operatorInvitation)
-    FUC-->>OW: operator invitationMakers: {SubmitEvidence}
-
-    Note left of FUC: Off-chain watcher detects evidence
-    OW->>+FUC: offer(SubmitEvidence, evidence)
-```
-
-```mermaid
-sequenceDiagram
-    title Receiving evidence
-    participant W as Operator N<br/>Smart Wallet
-    participant A as Operator N<br/>Admin Oexo
-    participant TF as Transaction<br/>Feed
-
-    W->>A: offer(SubmitEvidence, evidence)
-
-    Note left of A: Once 3 operators push the same…
-
-    A->>TF: notify(evidence)
-```
-
-# Status Manager
-
-### Pending Advance State Diagram
-
-*Transactions are qualified by the OCW and EventFeed before arriving to the Advancer.*
-
-```mermaid
-stateDiagram-v2
-  [*] --> Observed: observe()
-  [*] --> Advancing: advancing()
-
-  Advancing --> Advanced: advanceOutcome(...true)
-  Advancing --> AdvanceFailed: advanceOutcome(...false)
-
-  Observed --> [*]: dequeueStatus()
-  Advanced --> [*]: dequeueStatus()
-  AdvanceFailed --> [*]: dequeueStatus()
-
-  note right of [*]
-    After dequeueStatus():
-    Transaction is removed 
-    from pendingTxs store.
-    Settler will .disburse()
-    or .forward()
-  end note
-```
-
-### Complete state diagram (starting from Transaction Feed into Advancer)
-
-```mermaid
-stateDiagram-v2
-  Observed --> AdvanceSkipped : Risks identified
-  Observed --> Advancing : No risks, can advance
-  Observed --> Forwarding : No risks, Mint deposited before advance
-  Forwarding --> Forwarded
-  Advancing --> Advanced
-  Advanced --> Disbursed
-  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-db6d589.0+db6d589",
+  "version": "0.1.1-dev-47470c7.0+47470c7",
   "description": "CLI and library for Fast USDC product",
   "type": "module",
   "files": [
@@ -29,13 +29,13 @@
     "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.1.1-dev-db6d589.0+db6d589",
-    "@agoric/cosmic-proto": "0.4.1-dev-db6d589.0+db6d589",
-    "@agoric/ertp": "0.16.3-dev-db6d589.0+db6d589",
-    "@agoric/internal": "0.3.3-dev-db6d589.0+db6d589",
-    "@agoric/notifier": "0.6.3-dev-db6d589.0+db6d589",
-    "@agoric/orchestration": "0.1.1-dev-db6d589.0+db6d589",
-    "@agoric/zoe": "0.26.3-dev-db6d589.0+db6d589",
+    "@agoric/client-utils": "0.1.1-dev-47470c7.0+47470c7",
+    "@agoric/cosmic-proto": "0.4.1-dev-47470c7.0+47470c7",
+    "@agoric/ertp": "0.16.3-dev-47470c7.0+47470c7",
+    "@agoric/internal": "0.3.3-dev-47470c7.0+47470c7",
+    "@agoric/notifier": "0.6.3-dev-47470c7.0+47470c7",
+    "@agoric/orchestration": "0.1.1-dev-47470c7.0+47470c7",
+    "@agoric/zoe": "0.26.3-dev-47470c7.0+47470c7",
     "@cosmjs/proto-signing": "^0.33.0",
     "@cosmjs/stargate": "^0.33.0",
     "@endo/base64": "^1.0.9",
@@ -75,5 +75,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "db6d58920be363874b45206b746e838043dfe179"
+  "gitHead": "47470c7d3999c1222677244ed29ce6fc60c7766f"
 }

package/src/constants.js

@@ -1,5 +1,5 @@
 /**
- * Status values for FastUSDC.
+ * Status values for FastUSDC. Includes states for advancing and settling.
  *
  * @enum {(typeof TxStatus)[keyof typeof TxStatus]}
  */
@@ -31,7 +31,7 @@ export const TerminalTxStatus = {
 };
 
 /**
- * Status values for the StatusManager.
+ * Status values for the StatusManager while an advance is being processed.
  *
  * @enum {(typeof PendingTxStatus)[keyof typeof PendingTxStatus]}
  */