@agoric/fast-usdc 0.1.1-dev-4feddb0.0 → 0.1.1-dev-254e849.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/fast-usdc",
-  "version": "0.1.1-dev-4feddb0.0+4feddb0",
+  "version": "0.1.1-dev-254e849.0+254e849",
   "description": "CLI and library for Fast USDC product",
   "type": "module",
   "files": [
@@ -22,9 +22,9 @@
     "lint:eslint": "eslint ."
   },
   "devDependencies": {
-    "@agoric/swingset-liveslots": "0.10.3-dev-4feddb0.0+4feddb0",
-    "@agoric/vats": "0.15.2-dev-4feddb0.0+4feddb0",
-    "@agoric/zone": "0.2.3-dev-4feddb0.0+4feddb0",
+    "@agoric/swingset-liveslots": "0.10.3-dev-254e849.0+254e849",
+    "@agoric/vats": "0.15.2-dev-254e849.0+254e849",
+    "@agoric/zone": "0.2.3-dev-254e849.0+254e849",
     "@fast-check/ava": "^2.0.1",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
@@ -32,15 +32,16 @@
     "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.1.1-dev-4feddb0.0+4feddb0",
-    "@agoric/ertp": "0.16.3-dev-4feddb0.0+4feddb0",
-    "@agoric/internal": "0.3.3-dev-4feddb0.0+4feddb0",
-    "@agoric/notifier": "0.6.3-dev-4feddb0.0+4feddb0",
-    "@agoric/orchestration": "0.1.1-dev-4feddb0.0+4feddb0",
-    "@agoric/store": "0.9.3-dev-4feddb0.0+4feddb0",
-    "@agoric/vat-data": "0.5.3-dev-4feddb0.0+4feddb0",
-    "@agoric/vow": "0.1.1-dev-4feddb0.0+4feddb0",
-    "@agoric/zoe": "0.26.3-dev-4feddb0.0+4feddb0",
+    "@agoric/client-utils": "0.1.1-dev-254e849.0+254e849",
+    "@agoric/cosmic-proto": "0.4.1-dev-254e849.0+254e849",
+    "@agoric/ertp": "0.16.3-dev-254e849.0+254e849",
+    "@agoric/internal": "0.3.3-dev-254e849.0+254e849",
+    "@agoric/notifier": "0.6.3-dev-254e849.0+254e849",
+    "@agoric/orchestration": "0.1.1-dev-254e849.0+254e849",
+    "@agoric/store": "0.9.3-dev-254e849.0+254e849",
+    "@agoric/vat-data": "0.5.3-dev-254e849.0+254e849",
+    "@agoric/vow": "0.1.1-dev-254e849.0+254e849",
+    "@agoric/zoe": "0.26.3-dev-254e849.0+254e849",
     "@cosmjs/proto-signing": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
     "@endo/base64": "^1.0.9",
@@ -80,5 +81,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "4feddb0e0fbdf2343622c7424c6e6d3de013c85d"
+  "gitHead": "254e849f0057e00c73aca7c454b266713e2c8425"
 }

package/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 {
@@ -22,7 +23,7 @@ import {
 const transfer = async (
   /** @type {File} */ configFile,
   /** @type {string} */ amount,
-  /** @type {string} */ destination,
+  /** @type {string} */ EUD,
   out = console,
   fetch = globalThis.fetch,
   /** @type {VStorage | undefined} */ vstorage,
@@ -39,13 +40,13 @@ 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 });
+    out.log(`forwarding destination ${encodedAddr}`);
 
     const { exists, address } = await queryForwardingAccount(
       config.nobleApi,
       config.nobleToAgoricChannel,
-      appendedAddr,
+      encodedAddr,
       out,
       fetch,
     );
@@ -58,13 +59,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;
       }

package/src/exos/advancer.js

@@ -1,16 +1,16 @@
+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 { 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';
 
 /**
@@ -21,7 +21,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';
  */
@@ -147,11 +147,9 @@ 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);

package/src/exos/settler.js

@@ -5,8 +5,8 @@ import { atob } from '@endo/base64';
 import { E } from '@endo/far';
 import { M } 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,14 +151,19 @@ export const prepareSettler = (
             return;
           }
 
-          if (!addressTools.hasQueryParams(tx.receiver)) {
-            console.log('not query params', tx.receiver);
-            return;
-          }
-
-          const { EUD } = addressTools.getQueryParams(tx.receiver);
-          if (!EUD) {
-            console.log('no EUD parameter', tx.receiver);
+          let EUD;
+          try {
+            ({ EUD } = decodeAddressHook(tx.receiver).query);
+            if (!EUD) {
+              log('no EUD parameter', tx.receiver);
+              return;
+            }
+            if (typeof EUD !== 'string') {
+              log('EUD is not a string', EUD);
+              return;
+            }
+          } catch (e) {
+            log('no query params', tx.receiver);
             return;
           }
 

package/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, AddressHook} from './types.js';
  */
 
 /**
@@ -67,10 +67,12 @@ export const PendingTxShape = {
 };
 harden(PendingTxShape);
 
-export const EudParamShape = {
-  EUD: M.string(),
+/** @type {TypedPattern<AddressHook>} */
+export const AddressHookShape = {
+  baseAddress: M.string(),
+  query: { EUD: M.string() },
 };
-harden(EudParamShape);
+harden(AddressHookShape);
 
 const NatAmountShape = { brand: BrandShape, value: M.nat() };
 /** @type {TypedPattern<FeeConfig>} */

package/src/types.ts

@@ -85,5 +85,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';

package/src/utils/address.js

@@ -1,71 +0,0 @@
-import { makeError, q } from '@endo/errors';
-import { M, mustMatch } from '@endo/patterns';
-
-/**
- * @import {Pattern} from '@endo/patterns';
- */
-
-/**
- * Default pattern matcher for `getQueryParams`.
- * Does not assert keys exist, but ensures existing keys are strings.
- */
-const QueryParamsShape = M.splitRecord(
-  {},
-  {},
-  M.recordOf(M.string(), M.string()),
-);
-
-/**
- * Very minimal 'URL query string'-like parser that handles:
- *  - Query string delimiter (?)
- *  - Key-value separator (=)
- *  - Query parameter separator (&)
- *
- * Does not handle:
- * - Subpaths (`agoric1bech32addr/opt/account?k=v`)
- * - URI encoding/decoding (`%20` -> ` `)
- *    - note: `decodeURIComponent` seems to be available in XS
- * - Multiple question marks (foo?bar=1?baz=2)
- * - Empty parameters (foo=)
- * - Array parameters (`foo?k=v1&k=v2` -> k: [v1, v2])
- * - Parameters without values (foo&bar=2)
- */
-export const addressTools = {
-  /**
-   * @param {string} address
-   * @returns {boolean}
-   */
-  hasQueryParams: address => {
-    try {
-      const params = addressTools.getQueryParams(address);
-      return Object.keys(params).length > 0;
-    } catch {
-      return false;
-    }
-  },
-  /**
-   * @param {string} address
-   * @param {Pattern} [shape]
-   * @returns {Record<string, string>}
-   * @throws {Error} if the address cannot be parsed or params do not match `shape`
-   */
-  getQueryParams: (address, shape = QueryParamsShape) => {
-    const parts = address.split('?');
-    if (parts.length !== 2) {
-      throw makeError(`Unable to parse query params: ${q(address)}`);
-    }
-    /** @type {Record<string, string>} */
-    const result = {};
-    const paramPairs = parts[1].split('&');
-    for (const pair of paramPairs) {
-      const [key, value] = pair.split('=');
-      if (!key || !value) {
-        throw makeError(`Invalid parameter format in pair: ${q(pair)}`);
-      }
-      result[key] = value;
-    }
-    harden(result);
-    mustMatch(result, shape);
-    return result;
-  },
-};