@agoric/pegasus 0.7.12 → 0.7.13-dev-8c14632.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/pegasus",
-  "version": "0.7.12",
+  "version": "0.7.13-dev-8c14632.0+8c14632",
   "description": "Peg-as-us contract",
   "type": "module",
   "main": "./src/pegasus.js",
@@ -29,14 +29,14 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "^0.6.0",
-    "@agoric/ertp": "^0.16.2",
-    "@agoric/internal": "^0.3.2",
-    "@agoric/notifier": "^0.6.2",
-    "@agoric/store": "^0.9.2",
-    "@agoric/swingset-vat": "^0.32.2",
-    "@agoric/vats": "^0.15.1",
-    "@agoric/zoe": "^0.26.2",
+    "@agoric/assert": "0.6.1-dev-8c14632.0+8c14632",
+    "@agoric/ertp": "0.16.3-dev-8c14632.0+8c14632",
+    "@agoric/internal": "0.3.3-dev-8c14632.0+8c14632",
+    "@agoric/notifier": "0.6.3-dev-8c14632.0+8c14632",
+    "@agoric/store": "0.9.3-dev-8c14632.0+8c14632",
+    "@agoric/swingset-vat": "0.32.3-dev-8c14632.0+8c14632",
+    "@agoric/vats": "0.15.2-dev-8c14632.0+8c14632",
+    "@agoric/zoe": "0.26.3-dev-8c14632.0+8c14632",
     "@endo/bundle-source": "^2.5.1",
     "@endo/captp": "^3.1.1",
     "@endo/far": "^0.2.18",
@@ -45,8 +45,8 @@
     "@endo/promise-kit": "^0.2.56"
   },
   "devDependencies": {
-    "@agoric/deploy-script-support": "^0.10.3",
-    "ava": "^5.2.0",
+    "@agoric/deploy-script-support": "0.10.4-dev-8c14632.0+8c14632",
+    "ava": "^5.3.0",
     "c8": "^7.13.0",
     "import-meta-resolve": "^2.2.1"
   },
@@ -65,5 +65,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ba3b776444425bbcb275ce918794d9259f8e15da"
+  "gitHead": "8c14632298cfb982f91dc0ef271681703237a93f"
 }

package/src/courier.js

@@ -56,13 +56,14 @@ export const makeCourierMaker =
     transferProtocol,
   }) => {
     /** @type {Sender} */
-    const send = async (zcfSeat, depositAddress) => {
+    const send = async (zcfSeat, depositAddress, memo) => {
       const tryToSend = async () => {
         const amount = zcfSeat.getAmountAllocated('Transfer', localBrand);
         const transferPacket = await E(transferProtocol).makeTransferPacket({
           value: amount.value,
           remoteDenom: sendDenom,
           depositAddress,
+          memo,
         });
 
         // Retain the payment.  We must not proceed on failure.

package/src/ics20.js

@@ -10,6 +10,7 @@ import { assert, details as X, Fail } from '@agoric/assert';
  * @property {Denom} denom The denomination of the amount
  * @property {string} sender The sender address
  * @property {DepositAddress} receiver The receiver deposit address
+ * @property {string} memo The packet memo
  */
 
 // As specified in ICS20, the success result is a base64-encoded '\0x1' byte.
@@ -50,10 +51,16 @@ const safeJSONParseObject = s => {
  */
 export const parseICS20TransferPacket = async packet => {
   const ics20Packet = safeJSONParseObject(packet);
-  const { amount, denom, receiver } = ics20Packet;
+  const { amount, denom, receiver, memo } = ics20Packet;
 
   assert.typeof(denom, 'string', X`Denom ${denom} must be a string`);
   assert.typeof(receiver, 'string', X`Receiver ${receiver} must be a string`);
+  memo === undefined ||
+    assert.typeof(
+      memo,
+      'string',
+      X`Memo ${memo} must be a string or 'undefined'`,
+    );
 
   // amount is a string in JSON.
   assert.typeof(amount, 'string', X`Amount ${amount} must be a string`);
@@ -66,6 +73,7 @@ export const parseICS20TransferPacket = async packet => {
     depositAddress: receiver,
     remoteDenom: denom,
     value,
+    memo,
   });
 };
 
@@ -80,6 +88,7 @@ export const makeICS20TransferPacket = async ({
   value,
   remoteDenom,
   depositAddress,
+  memo,
 }) => {
   // We're using Nat as a dynamic check for overflow.
   const stringValue = String(Nat(value));
@@ -91,6 +100,7 @@ export const makeICS20TransferPacket = async ({
     denom: remoteDenom,
     receiver: depositAddress,
     sender: DUMMY_SENDER_ADDRESS,
+    memo,
   };
 
   return JSON.stringify(ics20);

package/src/pegasus.js

@@ -458,9 +458,10 @@ const makePegasus = (zcf, board, namesByAddress) => {
      *
      * @param {ERef<Peg>} pegP the peg over which to transfer
      * @param {DepositAddress} depositAddress the remote receiver's address
+     * @param {string} [memo] the memo to attach to ics transfer packet
      * @returns {Promise<Invitation>} to transfer, make an offer of { give: { Transfer: pegAmount } } to this invitation
      */
-    async makeInvitationToTransfer(pegP, depositAddress) {
+    async makeInvitationToTransfer(pegP, depositAddress, memo = '') {
       // Verify the peg.
       const peg = await pegP;
       const denomState = pegToDenomState.get(peg);
@@ -482,7 +483,7 @@ const makePegasus = (zcf, board, namesByAddress) => {
        */
       const offerHandler = zcfSeat => {
         assertProposalShape(zcfSeat, TRANSFER_PROPOSAL_SHAPE);
-        send(zcfSeat, depositAddress);
+        send(zcfSeat, depositAddress, memo);
       };
 
       return zcf.makeInvitation(offerHandler, `pegasus ${sendDenom} transfer`);

package/src/types.js

@@ -12,6 +12,7 @@
  * @property {AmountValue} value
  * @property {Denom} remoteDenom
  * @property {DepositAddress} depositAddress
+ * @property {string} memo
  */
 
 /**
@@ -46,7 +47,7 @@
  */
 
 /**
- * @typedef {(zcfSeat: ZCFSeat, depositAddress: DepositAddress) => Promise<void>} Sender
+ * @typedef {(zcfSeat: ZCFSeat, depositAddress: DepositAddress, memo: string) => Promise<void>} Sender
  * Successive transfers are not guaranteed to be processed in the order in which they were sent.
  * @typedef {(parts: PacketParts) => Promise<Bytes>} Receiver
  * @typedef {object} Courier