docs: distinguish Rose from Rex with comments

Agoric · Mar 5, 2024 · 486bc8b · 486bc8b
1 parent 1be077b
commit 486bc8b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/contract/test/market-actors.js b/contract/test/market-actors.js
@@ -70,6 +70,10 @@ export const payerPete = async (
 };
 
 /**
+ * Rose expects to receive `shared.toSend` amounts.
+ * She expects initial balances to be empty;
+ * and relies on `wellKnown.assetKind` to make an empty amount from a brand.
+ *
  * @param {import('ava').ExecutionContext} t
  * @param {{ wallet: import('./wallet-tools.js').MockWallet, }} mine
  * @param {{ toSend: AmountKeywordRecord }} shared
@@ -107,6 +111,9 @@ export const receiverRose = async (t, { wallet }, { toSend }) => {
 };
 
 /**
+ * Rex expects to receive `shared.toSend` amounts.
+ * Rex doesn't check his initial balances
+ *
  * @param {import('ava').ExecutionContext} t
  * @param {{ wallet: import('./wallet-tools.js').MockWallet, }} mine
  * @param {{ toSend: AmountKeywordRecord }} shared