Excise reallocate() (#10871)

closes: #6679 ## Description Removes the last vestiges of `zcf.reallocate()` and staged allocations. ### Security Considerations The deprecated code turned out to be a bug farm. We've had no problems with the replacement. ### Scaling Considerations None. ### Documentation Considerations A separate PR ([Docs:#1266](Agoric/documentation#1266)) will remove the documentation. It has been marked deprecated for quite some time. ### Testing Considerations Removed tests. All the new code (using `atomicRearrange`) has had tests all along. ### Upgrade Considerations No known code uses the deprecated functionality. These changes are confined to ZCF. It won't matter when or if Zoe gets upgraded. The next time we bump the ZCF version, new and upgraded contracts will start using the new ZCF, but there's no hurry to make that happen.
Agoric · Feb 16, 2025 · c9e286a · c9e286a
2 parents 8ef3fde + c522d55
commit c9e286a
Show file tree

Hide file tree

Showing 20 changed files with 35 additions and 1,235 deletions.
diff --git a/golang/cosmos/app/upgrade.go b/golang/cosmos/app/upgrade.go
@@ -183,6 +183,10 @@ func unreleasedUpgradeHandler(app *GaiaApp, targetUpgrade string) func(sdk.Conte
 			// Each CoreProposalStep runs sequentially, and can be constructed from
 			// one or more modules executing in parallel within the step.
 			CoreProposalSteps = append(CoreProposalSteps,
+				// Register a new ZCF to be used for all future contract instances and upgrades
+				vm.CoreProposalStepForModules(
+					"@agoric/builders/scripts/vats/upgrade-zcf.js",
+				),
 				// because of #10794, we need to do at least a null upgrade of
 				// the walletFactory on every software upgrade
 				vm.CoreProposalStepForModules(

diff --git a/packages/boot/test/bootstrapTests/zcf-upgrade.test.ts b/packages/boot/test/bootstrapTests/zcf-upgrade.test.ts
diff --git a/packages/boot/test/bootstrapTests/zcfProbe.contract.js b/packages/boot/test/bootstrapTests/zcfProbe.contract.js
diff --git a/packages/smart-wallet/test/gameAssetContract.js b/packages/smart-wallet/test/gameAssetContract.js
@@ -48,10 +48,13 @@ export const start = async zcf => {
 
     // We use the deprecated stage/reallocate API
     // so that we can test this with the version of zoe on mainnet1B.
-    playerSeat.decrementBy(gameSeat.incrementBy(give));
     const tmp = mint.mintGains(want);
-    playerSeat.incrementBy(tmp.decrementBy(want));
-    zcf.reallocate(playerSeat, tmp, gameSeat);
+    zcf.atomicRearrange(
+      harden([
+        [playerSeat, gameSeat, give],
+        [tmp, playerSeat, want],
+      ]),
+    );
     playerSeat.exit(true);
     return 'welcome to the game';
   };

diff --git a/packages/zoe/docs/AttackGuide.md b/packages/zoe/docs/AttackGuide.md
@@ -18,6 +18,8 @@ The main focus of most threats would be a breach of one of Zoe's core invariants
 
 ## Reallocation
 
+THIS SECTION IS OBSOLETE. We've converted all code to use atomicRearrange
+
 The current approach (staging, incrementBy/decrementBy and the fact that all seats must
 be included in realloc) has led to a few bugs. It's probably worth looking for other cases
 that create new stagings or presume there are none outstanding. We plan to replace this

diff --git a/packages/zoe/docs/seats.md b/packages/zoe/docs/seats.md
@@ -13,11 +13,6 @@ __ZCFSeat.exit() Flow:__
 
 ![ZCFSeat Exit Flow](./zcf-seat-exit-flow.png)
 
-__ZCF.reallocate() Flow:__
-
-![ZCF Reallocate Flow](./zcf-reallocate-flow.png)
-
-
 ## UserSeat 
 
 The `UserSeat` is what is returned when a user calls
@@ -67,12 +62,7 @@ The type of the ZCFSeat is:
  * @property {() => ProposalRecord} getProposal
  * @property {ZCFGetAmountAllocated} getAmountAllocated
  * @property {() => Allocation} getCurrentAllocation
- * @property {() => Allocation} getStagedAllocation
- * @property {() => boolean} hasStagedAllocation
  * @property {(newAllocation: Allocation) => boolean} isOfferSafe
- * @property {(amountKeywordRecord: AmountKeywordRecord) => AmountKeywordRecord} incrementBy
- * @property {(amountKeywordRecord: AmountKeywordRecord) => AmountKeywordRecord} decrementBy
- * @property {() => void} clear
  */
  ```
 

diff --git a/packages/zoe/docs/zcf-reallocate-flow.png b/packages/zoe/docs/zcf-reallocate-flow.png
diff --git a/packages/zoe/docs/zcf-reallocate-flow.puml b/packages/zoe/docs/zcf-reallocate-flow.puml
diff --git a/packages/zoe/docs/zoe-catalog-of-storage.md b/packages/zoe/docs/zoe-catalog-of-storage.md
@@ -187,8 +187,8 @@ seats.
 
 ### sumsByBrand - Store from `@agoric/store`
 
-Two of these are created in every call to `zcf.reallocate`, and then
-are immediately dropped.
+One of these is created in every call to `zcf.atomicRearrange`, and then
+is immediately dropped.
 
 **Expected cardinality**: One key per brand of allocation reallocated over.