@agoric/inter-protocol 0.13.3 → 0.13.4-dev-d32a66a.0

package/README.md

@@ -30,6 +30,8 @@ To maintain that the keys of vaults to liquidate are stable requires that its ke
 
 VaultFactory publishes data using StoredPublishKit which tees writes to off-chain storage. These can then be followed off-chain like so,
 ```js
+import { makeFollower } from '@agoric/casting';
+
   const key = `published.vaultFactory.metrics`; // or whatever the stream of interest is
   const leader = makeDefaultLeader();
   const follower = makeFollower(storeKey, leader);
@@ -40,30 +42,34 @@ VaultFactory publishes data using StoredPublishKit which tees writes to off-chai
 
 The canonical keys (under `published`) are as follows. Non-terminal nodes could have data but don't yet. A `0` indicates the index of that child in added order. To get the actual key look it up in parent. High cardinality types get a parent key for enumeration (e.g. `vaults`.)
 - `published`
-    - `vaultFactory`
+    - `vaultFactory` - [snapshot of details](./test/vaultFactory/snapshots/test-vaultFactory.js.md)
         - `governance`
         - `metrics`
-        - `manager0`
-            - `metrics`
-            - `governance`
-            - `vaults`
-              - `vault0`
-    - `amm`
-        - `metrics`
+        - `managers`
+          - `manager0`
+              - `metrics`
+              - `governance`
+              - `vaults`
+                - `vault0`
+    - `auction` - [snapshot of details](./test/auction/snapshots/test-auctionContract.js.md)
+        - `schedule`
         - `governance`
-        - `pool0`
-            - `init`
-            - `metrics`
-    - `psm`
+        - `book0`
+    - `reserve` - [snapshot of details](./test/reserve/snapshots/test-reserve.js.md)
+      - `governance`
+      - `metrics`
+    - `priceFeed` - [snapshot of details](./test/price/snapshots/test-fluxAggregatorKit.js.md)
+      - `${inputBrand}-${outputBrand}_price_feed`
+      - `${inputBrand}-${outputBrand}_price_feed.latestRound`
+    - `psm` - [snapshot of details](./test/psm/snapshots/test-psm.js.md)
       - `<minted>`
         - `<anchor>`
           - `governance`
           - `metrics`
-    - `stakeFactory`
-        - `governance`
-    - `committees`
+    - `committees` - [snapshot of details](../governance/test/unitTests/snapshots/test-committee.js.md)
         - `Economic_Committee`
           - `latestQuestion`
+          - `latestOutcome`
 
 ### Demo
 
@@ -77,9 +83,9 @@ Once you see a string like `block 17 commit` then the chain is available. In ano
 # shows keys of the vaultFactory
 agd query vstorage keys 'published.vaultFactory'
 # lists vaults
-agd query vstorage keys 'published.vaultFactory.manager0.vaults'
+agd query vstorage keys 'published.vaultFactory.managers.manager0.vaults'
 # follow metrics
-agoric follow :published.vaultFactory.manager0.metrics
+agoric follow :published.vaultFactory.managers.manager0.metrics
 ```
 
 Start a new terminal to get a prompt.
@@ -102,16 +108,16 @@ vaultFactoryInstance = E(home.agoricNames).lookup('instance', 'VaultFactory')
 vaultFactoryPublicFacet = E(home.zoe).getPublicFacet(vaultFactoryInstance)
 # get a reference to the minted brand (soon to be IST)
 E(home.agoricNames).lookup('brand', 'IST');
-runBrand=history[-1]
+stableBrand=history[-1]
 # get a reference to the collateral brand
-E(home.agoricNames).lookup('brand', 'IbcATOM')
+E(home.agoricNames).lookup('brand', 'ATOM')
 atomBrand=history[-1]
 # get a reference to the collateral manager, using history because the brand must be the same object
 collateralManager = E(vaultFactoryPublicFacet).getCollateralManager(atomBrand)
 # proposal
 proposal = ({
   give: { Collateral: { brand: atomBrand, value: 1000n } },
-  want: { IST: { brand: runBrand, value: 1n } },
+  want: { IST: { brand: stableBrand, value: 1n } },
 })
 # get the ATOM purse
 E(home.wallet).getPurses()