chore: use address-hook encoding

Author: 0xpatrickdev

packages/fast-usdc/package.json

@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "@agoric/client-utils": "^0.1.0",
+    "@agoric/cosmic-proto": "^0.4.0",
     "@agoric/ertp": "^0.16.2",
     "@agoric/internal": "^0.3.2",
     "@agoric/notifier": "^0.6.2",

packages/fast-usdc/src/cli/transfer.js

@@ -6,6 +6,7 @@ import {
   makeVStorage,
   pickEndpoint,
 } from '@agoric/client-utils';
+import { encodeAddressHook } from '@agoric/cosmic-proto/address-hooks.js';
 import { queryFastUSDCLocalChainAccount } from '../util/agoric.js';
 import { depositForBurn, makeProvider } from '../util/cctp.js';
 import {
@@ -39,13 +40,16 @@ const transfer = async (
       { chainName: 'agoric', rpcAddrs: [pickEndpoint(netConfig)] },
     );
     const agoricAddr = await queryFastUSDCLocalChainAccount(vstorage, out);
-    const appendedAddr = `${agoricAddr}?EUD=${destination}`;
-    out.log(`forwarding destination ${appendedAddr}`);
+    const encodedAddr = encodeAddressHook(agoricAddr, {
+      EUD: destination,
+    });
+
+    out.log(`forwarding destination ${encodedAddr}`);
 
     const { exists, address } = await queryForwardingAccount(
       config.nobleApi,
       config.nobleToAgoricChannel,
-      appendedAddr,
+      encodedAddr,
       out,
       fetch,
     );
@@ -58,13 +62,13 @@ const transfer = async (
           signer,
           signerAddress,
           config.nobleToAgoricChannel,
-          appendedAddr,
+          encodedAddr,
           out,
         );
         out.log(res);
       } catch (e) {
         out.error(
-          `Error registering noble forwarding account for ${appendedAddr} on channel ${config.nobleToAgoricChannel}`,
+          `Error registering noble forwarding account for ${encodedAddr} on channel ${config.nobleToAgoricChannel}`,
         );
         throw e;
       }

packages/fast-usdc/src/exos/advancer.js

@@ -1,17 +1,17 @@
+import { decodeAddressHook } from '@agoric/cosmic-proto/address-hooks.js';
 import { AmountMath } from '@agoric/ertp';
 import { assertAllDefined, makeTracer } from '@agoric/internal';
 import { AnyNatAmountShape, ChainAddressShape } from '@agoric/orchestration';
 import { pickFacet } from '@agoric/vat-data';
 import { VowShape } from '@agoric/vow';
 import { q } from '@endo/errors';
 import { E } from '@endo/far';
-import { M } from '@endo/patterns';
+import { M, mustMatch } from '@endo/patterns';
 import {
   CctpTxEvidenceShape,
-  EudParamShape,
+  AddressHookShape,
   EvmHashShape,
 } from '../type-guards.js';
-import { addressTools } from '../utils/address.js';
 import { makeFeeTools } from '../utils/fees.js';
 
 /**
@@ -22,7 +22,7 @@ import { makeFeeTools } from '../utils/fees.js';
  * @import {ZoeTools} from '@agoric/orchestration/src/utils/zoe-tools.js';
  * @import {VowTools} from '@agoric/vow';
  * @import {Zone} from '@agoric/zone';
- * @import {CctpTxEvidence, EvmHash, FeeConfig, LogFn, NobleAddress} from '../types.js';
+ * @import {CctpTxEvidence, AddressHook, EvmHash, FeeConfig, LogFn, NobleAddress} from '../types.js';
  * @import {StatusManager} from './status-manager.js';
  * @import {LiquidityPoolKit} from './liquidity-pool.js';
  */
@@ -148,11 +148,10 @@ export const prepareAdvancerKit = (
 
             const { borrowerFacet, poolAccount } = this.state;
             const { recipientAddress } = evidence.aux;
-            // throws if EUD is not found
-            const { EUD } = addressTools.getQueryParams(
-              recipientAddress,
-              EudParamShape,
-            );
+            const decoded = decodeAddressHook(recipientAddress);
+            mustMatch(decoded, AddressHookShape);
+            const { EUD } = /** @type {AddressHook['query']} */ (decoded.query);
+            log(`decoded EUD: ${EUD}`);
             // throws if the bech32 prefix is not found
             const destination = chainHub.makeChainAddress(EUD);
 

packages/fast-usdc/src/exos/settler.js

@@ -3,10 +3,10 @@ import { assertAllDefined, makeTracer } from '@agoric/internal';
 import { ChainAddressShape } from '@agoric/orchestration';
 import { atob } from '@endo/base64';
 import { E } from '@endo/far';
-import { M } from '@endo/patterns';
+import { M, matches } from '@endo/patterns';
 
+import { decodeAddressHook } from '@agoric/cosmic-proto/address-hooks.js';
 import { PendingTxStatus } from '../constants.js';
-import { addressTools } from '../utils/address.js';
 import { makeFeeTools } from '../utils/fees.js';
 import { EvmHashShape } from '../type-guards.js';
 
@@ -151,17 +151,23 @@ export const prepareSettler = (
             return;
           }
 
-          if (!addressTools.hasQueryParams(tx.receiver)) {
+          let endUserDestination;
+          try {
+            const { EUD } = decodeAddressHook(tx.receiver).query;
+            if (!EUD) {
+              console.log('no EUD parameter', tx.receiver);
+              return;
+            }
+            if (!matches(EUD, M.string())) {
+              console.log('EUD is not a string', EUD);
+              return;
+            }
+            endUserDestination = /** @type {string} */ (EUD);
+          } catch (e) {
             console.log('not query params', tx.receiver);
             return;
           }
 
-          const { EUD } = addressTools.getQueryParams(tx.receiver);
-          if (!EUD) {
-            console.log('no EUD parameter', tx.receiver);
-            return;
-          }
-
           const amount = BigInt(tx.amount); // TODO: what if this throws?
 
           const { self } = this.facets;
@@ -177,7 +183,12 @@ export const prepareSettler = (
 
             case PendingTxStatus.Observed:
             case PendingTxStatus.AdvanceFailed:
-              return self.forward(found.txHash, sender, amount, EUD);
+              return self.forward(
+                found.txHash,
+                sender,
+                amount,
+                endUserDestination,
+              );
 
             case undefined:
             default:

packages/fast-usdc/src/type-guards.js

@@ -6,7 +6,7 @@ import { PendingTxStatus } from './constants.js';
  * @import {TypedPattern} from '@agoric/internal';
  * @import {FastUsdcTerms} from './fast-usdc.contract.js';
  * @import {USDCProposalShapes} from './pool-share-math.js';
- * @import {CctpTxEvidence, FeeConfig, PendingTx, PoolMetrics, ChainPolicy, FeedPolicy} from './types.js';
+ * @import {CctpTxEvidence, FeeConfig, PendingTx, PoolMetrics, ChainPolicy, FeedPolicy, AddressHookParameters} from './types.js';
  */
 
 /**
@@ -67,10 +67,12 @@ export const PendingTxShape = {
 };
 harden(PendingTxShape);
 
-export const EudParamShape = {
-  EUD: M.string(),
+/** @type {TypedPattern<AddressHookParameters>} */
+export const AddressHookShape = {
+  baseAddress: M.string(),
+  query: { EUD: M.string() },
 };
-harden(EudParamShape);
+harden(AddressHookShape);
 
 const NatAmountShape = { brand: BrandShape, value: M.nat() };
 /** @type {TypedPattern<FeeConfig>} */

packages/fast-usdc/src/types.ts

@@ -82,5 +82,14 @@ export type FastUSDCConfig = {
   assetInfo: [Denom, DenomDetail & { brandKey?: string }][];
 } & CopyRecord;
 
+/** decoded address hook parameters */
+export type AddressHook = {
+  baseAddress: string;
+  query: {
+    /** end user destination address */
+    EUD: string;
+  };
+};
+
 export type * from './constants.js';
 export type { LiquidityPoolKit } from './exos/liquidity-pool.js';

packages/fast-usdc/src/utils/address.js

@@ -15,7 +15,7 @@ Generated by [AVA](https://avajs.dev).
           typeUrl: '/noble.forwarding.v1.MsgRegisterAccount',
           value: {
             channel: 'channel-test-7',
-            recipient: 'agoric123456?EUD=dydx1234',
+            recipient: 'agoric10rchp4vc53apxn32q42c3zryml8xq3xshyzuhjk6405wtxy7tl3d7e0f8az423pav3ukg7p3xgengqpq4066gy',
             signer: 'noble09876',
           },
         },

packages/fast-usdc/test/cli/snapshots/transfer.test.ts.md

@@ -1,4 +1,5 @@
 import test from 'ava';
+import { encodeAddressHook } from '@agoric/cosmic-proto/address-hooks.js';
 import transfer from '../../src/cli/transfer.js';
 import {
   mockOut,
@@ -63,14 +64,20 @@ test('Transfer registers the noble forwarding account if it does not exist', asy
   };
   const out = mockOut();
   const file = mockFile(path, JSON.stringify(config));
-  const agoricSettlementAccount = 'agoric123456';
+  const agoricSettlementAccount =
+    'agoric16kv2g7snfc4q24vg3pjdlnnqgngtjpwtetd2h689nz09lcklvh5s8u37ek';
   const settlementAccountVstoragePath = 'published.fastUsdc.settlementAccount';
   const vstorageMock = makeVstorageMock({
     [settlementAccountVstoragePath]: agoricSettlementAccount,
   });
   const amount = '150';
   const destination = 'dydx1234';
-  const nobleFwdAccountQuery = `${nobleApi}/noble/forwarding/v1/address/${nobleToAgoricChannel}/${agoricSettlementAccount}${encodeURIComponent('?EUD=')}${destination}/`;
+  const nobleFwdAccountQuery = `${nobleApi}/noble/forwarding/v1/address/${nobleToAgoricChannel}/${encodeAddressHook(
+    agoricSettlementAccount,
+    {
+      EUD: destination,
+    },
+  )}/`;
   const fetchMock = makeFetchMock({
     [nobleFwdAccountQuery]: {
       address: 'noble14lwerrcfzkzrv626w49pkzgna4dtga8c5x479h',
@@ -114,14 +121,20 @@ test('Transfer signs and broadcasts the depositForBurn message on Ethereum', asy
   };
   const out = mockOut();
   const file = mockFile(path, JSON.stringify(config));
-  const agoricSettlementAccount = 'agoric123456';
+  const agoricSettlementAccount =
+    'agoric16kv2g7snfc4q24vg3pjdlnnqgngtjpwtetd2h689nz09lcklvh5s8u37ek';
   const settlementAccountVstoragePath = 'published.fastUsdc.settlementAccount';
   const vstorageMock = makeVstorageMock({
     [settlementAccountVstoragePath]: agoricSettlementAccount,
   });
   const amount = '150';
   const destination = 'dydx1234';
-  const nobleFwdAccountQuery = `${nobleApi}/noble/forwarding/v1/address/${nobleToAgoricChannel}/${agoricSettlementAccount}${encodeURIComponent('?EUD=')}${destination}/`;
+  const nobleFwdAccountQuery = `${nobleApi}/noble/forwarding/v1/address/${nobleToAgoricChannel}/${encodeAddressHook(
+    agoricSettlementAccount,
+    {
+      EUD: destination,
+    },
+  )}/`;
   const fetchMock = makeFetchMock({
     [nobleFwdAccountQuery]: {
       address: 'noble14lwerrcfzkzrv626w49pkzgna4dtga8c5x479h',