chore: responses to review

renamed some files from treasury/stablecoin to vaultFactory
annotated some ts-ignore statements in tests.

regenerated png files in docs/threat_models

docs/threat_models/index.md

@@ -27,7 +27,7 @@
 
 [![./smart_contracts/multipool_autoswap/mpas_sequence_003.png](./smart_contracts/multipool_autoswap/mpas_sequence_003.png)](./smart_contracts/multipool_autoswap/mpas_sequence_003.png)
 
-## ./treasury/treasury.png
+## ./vaultFactory/vaultFactory.png
 
-[![./treasury/treasury.png](./treasury/treasury.png)](./treasury/treasury.png)
+[![./vaultFactory/vaultFactory.png](./vaultFactory/vaultFactory.png)](./vaultFactory/vaultFactory.png)
 

docs/threat_models/treasury/treasury.puml → docs/threat_models/vaultFactory/vaultFactory.puml

@@ -1,13 +1,13 @@
 @startuml
 header Agoric Systems Operating Company.
 footer v0.0.1
-title Treasury
+title VaultFactory
 
 skinparam componentStyle rectangle
 skinparam defaultTextAlignment center
 
 
-actor "TreasuryCreator aka Governance" as tc
+actor "VaultFactoryCreator aka Governance" as vfc
 
 actor Borrower
 
@@ -19,7 +19,7 @@ node LiquidationSeat {
     circle getPayouts
 }
 node "Vat" {
-    node Treasury {
+    node VaultFactory {
         node AMM
         node "publicAPI" {
             circle getCollaterals
@@ -52,7 +52,7 @@ Borrower -u-> getPayouts: retrieve any proceeds
 Borrower -d-> LiquidationPromise: did loan get liquidated?
 Borrower -> AdjustBalancesInvitation: add or remove collateral or \nincrease or decrease the loan balance
 Borrower -l-> CloseVaultInvitation: close loan and withdraw \nany remaining collateral
-tc -d-> makeAddTypeInvitation
+vfc -d-> makeAddTypeInvitation
 Borrower -d-> getDebtAmount: how much do I owe
 Borrower -d-> getCollateralAmount: how much did I \ndeposit as collateral
 

packages/run-protocol/test/amm/constantProduct/test-checkInvariants.js

@@ -119,7 +119,7 @@ function checkGetOutput(t, args, result) {
 
 const testGetInputPrice = (t, inputs, runIn) => {
   const args = runIn ? prepareRUNInTest(inputs) : prepareRUNOutTest(inputs);
-  // @ts-ignore
+  // @ts-ignore typescript doesn't like param list built by destructuring
   const result = pricesForStatedInput(...args);
   checkGetInput(t, args, result);
 };
@@ -128,7 +128,7 @@ const testGetInputPriceThrows = (t, inputs, message, runIn) => {
   t.throws(
     _ => {
       const args = runIn ? prepareRUNInTest(inputs) : prepareRUNOutTest(inputs);
-      // @ts-ignore
+      // @ts-ignore typescript doesn't like param list built by destructuring
       return pricesForStatedInput(...args);
     },
     {
@@ -139,15 +139,15 @@ const testGetInputPriceThrows = (t, inputs, message, runIn) => {
 
 const testGetInputPriceNoTrade = (t, inputs, runIn) => {
   const args = runIn ? prepareRUNInTest(inputs) : prepareRUNOutTest(inputs);
-  // @ts-ignore
+  // @ts-ignore typescript doesn't like param list built by destructuring
   const result = pricesForStatedInput(...args);
   t.truthy(AmountMath.isEmpty(result.swapperGets));
   t.truthy(AmountMath.isEmpty(result.swapperGives));
 };
 
 const testGetOutputPrice = (t, inputs, runIn) => {
   const args = runIn ? prepareRUNInTest(inputs) : prepareRUNOutTest(inputs);
-  // @ts-ignore
+  // @ts-ignore typescript doesn't like param list built by destructuring
   const result = pricesForStatedOutput(...args);
   checkGetOutput(t, args, result);
 };
@@ -156,7 +156,7 @@ const getOutputPriceThrows = (t, inputs, message, runIn) => {
   t.throws(
     _ => {
       const args = runIn ? prepareRUNInTest(inputs) : prepareRUNOutTest(inputs);
-      // @ts-ignore
+      // @ts-ignore typescript doesn't like param list built by destructuring
       return pricesForStatedOutput(...args);
     },
     {
@@ -167,7 +167,7 @@ const getOutputPriceThrows = (t, inputs, message, runIn) => {
 
 const testGetOutputPriceNoTrade = (t, inputs, runIn) => {
   const args = runIn ? prepareRUNInTest(inputs) : prepareRUNOutTest(inputs);
-  // @ts-ignore
+  // @ts-ignore typescript doesn't like param list built by destructuring
   const result = pricesForStatedOutput(...args);
   t.truthy(AmountMath.isEmpty(result.swapperGets));
   t.truthy(AmountMath.isEmpty(result.swapperGives));

packages/run-protocol/test/amm/constantProduct/test-compareBondingCurves.js

@@ -39,7 +39,7 @@ const prepareSwapInTest = ({ inputReserve, outputReserve, inputValue }) => {
 
 const testInputGetPrice = (t, inputs, expectedOutput) => {
   const { args, bld } = prepareSwapInTest(inputs);
-  // @ts-ignore
+  // @ts-ignore typescript doesn't like param list built by destructuring
   const result = pricesForStatedInput(...args);
   t.deepEqual(result.swapperGets, bld(expectedOutput));
 };
@@ -48,7 +48,7 @@ const getInputPriceThrows = (t, inputs, message) => {
   t.throws(
     _ => {
       const { args } = prepareSwapInTest(inputs);
-      // @ts-ignore
+      // @ts-ignore typescript doesn't like param list built by destructuring
       return pricesForStatedInput(...args);
     },
     {
@@ -87,14 +87,14 @@ const prepareSwapOutTest = ({ inputReserve, outputReserve, outputValue }) => {
 
 const testGetOutputPrice = (t, inputs, expectedInput) => {
   const { args, run } = prepareSwapOutTest(inputs);
-  // @ts-ignore
+  // @ts-ignore typescript doesn't like param list built by destructuring
   const result = pricesForStatedOutput(...args);
   t.deepEqual(result.swapperGives, run(expectedInput));
 };
 
 const getOutputPriceThrows = (t, inputs, message) => {
   const { args } = prepareSwapOutTest(inputs);
-  // @ts-ignore
+  // @ts-ignore typescript doesn't like param list built by destructuring
   t.throws(_ => pricesForStatedOutput(...args), {
     message,
   });

packages/run-protocol/test/amm/constantProduct/test-readmeScenario.js

@@ -47,7 +47,7 @@ test('pricesForStatedInput  README example', async t => {
   const protocolFeeRatio = makeRatio(5n, moolaKit.brand, BASIS_POINTS);
   const poolFeeRatio = makeRatio(25n, bucksKit.brand, BASIS_POINTS);
 
-  // @ts-ignore
+  // @ts-ignore typescript doesn't like param list built by destructuring
   const noFeesResult = swapInNoFees({ amountGiven, poolAllocation });
   t.deepEqual(noFeesResult.amountIn, moola(29996n));
   t.deepEqual(noFeesResult.amountOut, bucks(2248n));

packages/run-protocol/test/amm/constantProduct/test-swapScenarios.js

@@ -51,7 +51,7 @@ const prepareSwapInTest = ({
 
 const testGetPrice = (t, inputs, expectedOutput) => {
   const { args, run, bld } = prepareSwapInTest(inputs);
-  // @ts-ignore
+  // @ts-ignore typescript doesn't like param list built by destructuring
   const result = pricesForStatedInput(...args);
   const expected = harden({
     protocolFee: run(expectedOutput.protocolFee),