back out 'transferable' name change

Agoric · Feb 23, 2022 · 792c388 · 792c388
1 parent 0a78627
commit 792c388
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/packages/run-protocol/src/vaultFactory/types.js b/packages/run-protocol/src/vaultFactory/types.js
@@ -66,7 +66,7 @@
  * @property {Ratio} interestRate Annual interest rate charge
  * @property {Ratio} liquidationRatio
  * @property {boolean} liquidated boolean showing whether liquidation occurred
- * @property {'active' | 'liquidating' | 'transferable' | 'closed' | 'liquidated'} vaultState
+ * @property {'active' | 'liquidating' | 'transfer' | 'closed' | 'liquidated'} vaultState
  */
 
 /**

diff --git a/packages/run-protocol/src/vaultFactory/vault.js b/packages/run-protocol/src/vaultFactory/vault.js
@@ -32,7 +32,7 @@ const trace = makeTracer('Vault');
  *
  * ACTIVE       - vault is in use and can be changed
  * LIQUIDATING  - vault is being liquidated by the vault manager, and cannot be changed by the user
- * TRANSFERABLE - vault is released from the manager and able to be transferred
+ * TRANSFER     - vault is able to be transferred (payments and debits frozen until it has a new owner)
  * CLOSED       - vault was closed by the user and all assets have been paid out
  * LIQUIDATED   - vault was closed by the manager, with remaining assets paid to owner
  *
@@ -43,7 +43,7 @@ export const VaultPhase = /** @type {const} */ ({
   LIQUIDATING: 'liquidating',
   CLOSED: 'closed',
   LIQUIDATED: 'liquidated',
-  TRANSFERABLE: 'transferable',
+  TRANSFER: 'transfer',
 });
 
 /**
@@ -52,11 +52,11 @@ export const VaultPhase = /** @type {const} */ ({
 const validTransitions = {
   [VaultPhase.ACTIVE]: [
     VaultPhase.LIQUIDATING,
-    VaultPhase.TRANSFERABLE,
+    VaultPhase.TRANSFER,
     VaultPhase.CLOSED,
   ],
   [VaultPhase.LIQUIDATING]: [VaultPhase.LIQUIDATED],
-  [VaultPhase.TRANSFERABLE]: [VaultPhase.ACTIVE, VaultPhase.LIQUIDATING],
+  [VaultPhase.TRANSFER]: [VaultPhase.ACTIVE, VaultPhase.LIQUIDATING],
   [VaultPhase.LIQUIDATED]: [],
   [VaultPhase.CLOSED]: [],
 };
@@ -296,7 +296,7 @@ export const makeInnerVault = (
         break;
       case VaultPhase.CLOSED:
       case VaultPhase.LIQUIDATED:
-      case VaultPhase.TRANSFERABLE:
+      case VaultPhase.TRANSFER:
         outerUpdater.finish(uiState);
         break;
       default:
@@ -695,7 +695,7 @@ export const makeInnerVault = (
     makeCloseInvitation,
     makeTransferInvitation: () => {
       if (outerUpdater) {
-        assignPhase(VaultPhase.TRANSFERABLE);
+        assignPhase(VaultPhase.TRANSFER);
         updateUiState();
         outerUpdater = null;
       }