orchestration facade returns promises backed by vows

[turadg]

For each of these:

• no async functions
• no callWhen guards
• methods that don't return immediately return Vows
• methods that return vows don't throw

Files to convert

Beta Give feedback

1. exos/chain-account-kit.js (PC)
2. exos/chain-hub.js (TA)
3. exos/cosmos-orchestration-account.js (PC)
4. exos/icq-connection-kit.js (PC)
5. exos/local-chain-facade.js (TA)
6. exos/local-orchestration-account.js
7. exos/orchestrator.js (PC)
8. exos/remote-chain-facade.js (TA/PC)
9. timerUtils
10. withdrawFromSeat
11. agoricNames helper
12. service.js (~vat-orchestration, where we have makeAccount)
13. types (TA) (mainly in facades, see comment in this ticket)
14. chain-hub (currently uses heapVowTools)

[dckc]

@erights and I went over the client code in sendAnywhere.contract.js. We found a few things and sketched fixes...

diff --git a/packages/orchestration/src/examples/sendAnywhere.contract.js b/packages/orchestration/src/examples/sendAnywhere.contract.js
index ed49472ce..d37ae1a49 100644
--- a/packages/orchestration/src/examples/sendAnywhere.contract.js
+++ b/packages/orchestration/src/examples/sendAnywhere.contract.js
@@ -71,7 +71,7 @@ export const start = async (zcf, privateArgs, baggage) => {
     ...orchPowers,
   });
 
-  let contractAccount;
+  const accountCell = {};
 
   const findBrandInVBank = async brand => {
     const assets = await E(
@@ -85,9 +85,9 @@ export const start = async (zcf, privateArgs, baggage) => {
   /** @type {OfferHandler} */
   const sendIt = orchestrate(
     'sendIt',
-    { zcf },
+    { zcf, findBrandInVBank, accountCell },
     // eslint-disable-next-line no-shadow -- this `zcf` is enclosed in a membrane
-    async (orch, { zcf }, seat, offerArgs) => {
+    async (orch, { zcf, findBrandInVBank, accountCell }, seat, offerArgs) => {
       mustMatch(
         offerArgs,
         harden({ chainName: M.scalar(), destAddr: M.string() }),
@@ -98,10 +98,11 @@ export const start = async (zcf, privateArgs, baggage) => {
       const { denom } = await findBrandInVBank(amt.brand);
       const chain = await orch.getChain(chainName);
 
-      // XXX ok to use a heap var crossing the membrane scope this way?
-      if (!contractAccount) {
+      let contractAccount = accountCell.account;
+      if (contractAccount === undefined) {
         const agoricChain = await orch.getChain('agoric');
         contractAccount = await agoricChain.makeAccount();
+        accountCell.account = contractAccount;
       }
 
       const info = await chain.getChainInfo();

[mhofman]

+        accountCell.account = contractAccount;

The arguments must be durable compatible, which implies hardening. Mutating arguments like this is not supported, you'd need a method to get/set that internal state

[erights]

you'd need a method to get/set that internal state

Yeah, after the call with @dckc, I think a “slight” rewrite of the cell puts it in a category similar to the exo state object:

let contractAcctInternal;
const accountCell = harden({
  get account() { return contractAcctInternal; },
  set account(newValue) { contractAcctInternal = newValue; },
});

This can be made less awkward with a helper. It is only similar to the state object in that the state object need additional mechanisms. But this form of endowment does not need any further mechanism than what we’d need to do to support state objects.

Note that this is only intended to go through the endowments path, like functions and zcf, that may not themselves be Passable. The endowment mechanism has to wrap them with durables on the host side, and with unwrapping emulators on the guest side.

[0xpatrickdev]

With #9591, it seems the only remaining items are:

• TS Types in the Facades. See 4149dd8 for more details
• Timer Utils - good candidate for retriable
• withdrawFromSeat - not idempotent (i.e. not retriable) - how should we handle this?
• chainHub - currently uses heapVowTools