docs: upgradability meta

Agoric · Jun 12, 2024 · c843758 · c843758
1 parent 9d02dfa
commit c843758
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/zoe/src/contractFacet/types-ambient.d.ts b/packages/zoe/src/contractFacet/types-ambient.d.ts
@@ -226,6 +226,11 @@ type ContractMeta<
     Pattern
   >;
   privateArgsShape?: { [K in keyof Parameters<SF>[1]]: Pattern };
+  /**
+   * - `none` means that the contract is not upgradable.
+   * - `canUpgrade` means this code can perform an upgrade
+   * - `canBeUpgraded` means that the contract stores kinds durably such that the next version can upgrade
+   */
   upgradability?: 'none' | 'canBeUpgraded' | 'canUpgrade' | undefined;
 };
 /**