From c843758c3a294fabe399d44ce794da1d90379231 Mon Sep 17 00:00:00 2001
From: Turadg Aleahmad <turadg@agoric.com>
Date: Wed, 12 Jun 2024 08:28:00 -0700
Subject: [PATCH] docs: upgradability meta

---
 packages/zoe/src/contractFacet/types-ambient.d.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/packages/zoe/src/contractFacet/types-ambient.d.ts b/packages/zoe/src/contractFacet/types-ambient.d.ts
index 219e97e864d..168fdca74be 100644
--- 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;
 };
 /**