docs: drop all references to reallocate() and its helpers #1266
Conversation
| contract-->>-zoe: reallocate() | ||
| contract-->>-zoe: atomicRearrange() |
There was a problem hiding this comment.
the corresponding .svg should be regenerated.
it shows up in Specifying Offers
https://10871-excisereallocate.documentation-7tp.pages.dev/assets/zoe-simp.1Ml6HzzR.svg
Crud: CONTRIBUTING.md doesn't say how. IOU, I suppose.
In brief: I use Mermaid Editor - Visual Studio Marketplace.
There was a problem hiding this comment.
That page also has a link to a web editor which works fine for small diagrams like this, and allowed me to save as svg.
main/guides/zoe/index.md
Outdated
| @@ -21,7 +21,7 @@ Trading with a contract using Zoe typically goes through these steps: | |||
| 1. Parties call [E(zoe).offer(invitation, proposal, assets)](/reference/zoe-api/zoe#e-zoe-offer-invitation-proposal-paymentpkeywordrecord-offerargs). Zoe escrows the assets. | |||
| 2. Zoe relays the proposal to the contract identified in the invitation. | |||
| 3. The contract handles proposals using its custom business logic. | |||
| 4. The contract instructs Zoe to [reallocate](/reference/zoe-api/zoe-contract-facet#zcf-reallocate-seats) assets among the parties. | |||
| 4. The contract instructs Zoe to [reallocate](/reference/zoe-api/zoe-contract-facet.html#zcf-atomicrearrange-transfers) assets among the parties. | |||
There was a problem hiding this comment.
| 4. The contract instructs Zoe to [reallocate](/reference/zoe-api/zoe-contract-facet.html#zcf-atomicrearrange-transfers) assets among the parties. | |
| 4. The contract instructs Zoe to [reallocate](/reference/zoe-api/zoe-contract-facet#zcf-atomicrearrange-transfers) assets among the parties. |
Deploying documentation with
|
| Latest commit: |
9693576
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3c253471.documentation-7tp.pages.dev |
| Branch Preview URL: | https://10871-excisereallocate.documentation-7tp.pages.dev |
|
Cloudflare deployment logs are available here |
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.
|
This pull request has been removed from the queue for the following reason: Pull request #1266 has been dequeued. The pull request could not be merged. This could be related to an activated branch protection or ruleset rule that prevents us from merging. (details: Required status check "build (18.x)" is in progress.) You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it. If you want to requeue this pull request, you need to post a comment with the text: |
|
I don't understand what failed. I'll try requeuing. @Mergifyio requeue |
|
@Mergifyio requeue |
✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically |
closes: #798
See #10871
We converted from
zcf.reallocate()tozcf.atomicRearrange()over the course of several releases. The old code will be completely gone as of #10871. This PR cleans up the last of the remaining documentation.