@agoric/fast-usdc 0.1.1-dev-a035a67.0 → 0.1.1-dev-decd4ff.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/fast-usdc",
-  "version": "0.1.1-dev-a035a67.0+a035a67",
+  "version": "0.1.1-dev-decd4ff.0+decd4ff",
   "description": "CLI and library for Fast USDC product",
   "type": "module",
   "files": [
@@ -29,13 +29,13 @@
     "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.1.1-dev-a035a67.0+a035a67",
-    "@agoric/cosmic-proto": "0.4.1-dev-a035a67.0+a035a67",
-    "@agoric/ertp": "0.16.3-dev-a035a67.0+a035a67",
-    "@agoric/internal": "0.3.3-dev-a035a67.0+a035a67",
-    "@agoric/notifier": "0.6.3-dev-a035a67.0+a035a67",
-    "@agoric/orchestration": "0.1.1-dev-a035a67.0+a035a67",
-    "@agoric/zoe": "0.26.3-dev-a035a67.0+a035a67",
+    "@agoric/client-utils": "0.1.1-dev-decd4ff.0+decd4ff",
+    "@agoric/cosmic-proto": "0.4.1-dev-decd4ff.0+decd4ff",
+    "@agoric/ertp": "0.16.3-dev-decd4ff.0+decd4ff",
+    "@agoric/internal": "0.3.3-dev-decd4ff.0+decd4ff",
+    "@agoric/notifier": "0.6.3-dev-decd4ff.0+decd4ff",
+    "@agoric/orchestration": "0.1.1-dev-decd4ff.0+decd4ff",
+    "@agoric/zoe": "0.26.3-dev-decd4ff.0+decd4ff",
     "@cosmjs/proto-signing": "^0.33.0",
     "@cosmjs/stargate": "^0.33.0",
     "@endo/base64": "^1.0.9",
@@ -75,5 +75,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a035a67d66f974ed4b58ed1024bb5aa665e580d4"
+  "gitHead": "decd4fff2577c63c48facbadb8f9ea45080a5e11"
 }

package/src/pool-share-math.js

@@ -218,7 +218,10 @@ export const repayCalc = (shareWorth, split, encumberedBalance, poolStats) => {
       ...poolStats,
       totalRepays: add(poolStats.totalRepays, split.Principal),
       totalPoolFees: add(poolStats.totalPoolFees, split.PoolFee),
-      totalContractFees: add(poolStats.totalContractFees, split.ContractFee),
+      totalContractFees: add(
+        add(poolStats.totalContractFees, split.ContractFee),
+        split.RelayFee,
+      ),
     },
   });
 };

package/src/type-guards.js

@@ -1,7 +1,6 @@
 import { AmountShape, BrandShape, RatioShape } from '@agoric/ertp';
 import { M } from '@endo/patterns';
 import {
-  CosmosChainInfoShape,
   DenomDetailShape,
   DenomShape,
 } from '@agoric/orchestration/src/typeGuards.js';
@@ -10,7 +9,7 @@ import { PendingTxStatus } from './constants.js';
 /**
  * @import {Amount, Brand, NatValue, Payment} from '@agoric/ertp';
  * @import {TypedPattern} from '@agoric/internal';
- * @import {CosmosChainInfo, Denom, DenomDetail, OrchestrationAccount, IBCConnectionInfo} from '@agoric/orchestration';
+ * @import {CosmosChainInfo, Denom, DenomDetail, OrchestrationAccount, IBCConnectionInfo, CaipChainId} from '@agoric/orchestration';
  * @import {USDCProposalShapes} from './pool-share-math.js';
  * @import {CctpTxEvidence, FastUSDCConfig, FastUsdcTerms, FeeConfig, PendingTx, PoolMetrics, ChainPolicy, FeedPolicy, AddressHook, EvmAddress, EvmHash, RiskAssessment, EvidenceWithRisk} from './types.js';
  */
@@ -110,13 +109,33 @@ export const AddressHookShape = {
 harden(AddressHookShape);
 
 const NatAmountShape = { brand: BrandShape, value: M.nat() };
+
+export const DestinationOverridesShape = M.recordOf(
+  M.string(),
+  M.splitRecord(
+    {},
+    {
+      flat: NatAmountShape,
+      variableRate: RatioShape,
+      contractRate: RatioShape,
+      relay: NatAmountShape,
+    },
+  ),
+);
+
 /** @type {TypedPattern<FeeConfig>} */
-export const FeeConfigShape = {
-  flat: NatAmountShape,
-  variableRate: RatioShape,
-  contractRate: RatioShape,
-};
-harden(FeeConfigShape);
+export const FeeConfigShape = M.splitRecord(
+  {
+    flat: NatAmountShape,
+    variableRate: RatioShape,
+    contractRate: RatioShape,
+  },
+  {
+    relay: NatAmountShape,
+    destinationOverrides: DestinationOverridesShape,
+  },
+  {},
+);
 
 /** @type {TypedPattern<PoolMetrics>} */
 export const PoolMetricsShape = {
@@ -162,16 +181,6 @@ export const FeedPolicyShape = M.splitRecord(
 );
 harden(FeedPolicyShape);
 
-/** @type {TypedPattern<FastUSDCConfig>} */
-export const FastUSDCConfigShape = M.splitRecord({
-  terms: FastUSDCTermsShape,
-  oracles: M.recordOf(M.string(), M.string()),
-  feeConfig: FeeConfigShape,
-  feedPolicy: FeedPolicyShape,
-  chainInfo: M.recordOf(M.string(), CosmosChainInfoShape),
-  assetInfo: M.arrayOf([DenomShape, DenomDetailShape]),
-});
-
 /**
  * The version of CosmosChainInfoShape that matches the `valueShape` used in FUSDC's ChainHub's `chainInfos` mapStore.
  * @type {TypedPattern<CosmosChainInfo>}
@@ -189,3 +198,13 @@ export const CosmosChainInfoShapeV1 = M.splitRecord(
     pfmEnabled: M.boolean(),
   },
 );
+
+/** @type {TypedPattern<FastUSDCConfig>} */
+export const FastUSDCConfigShape = M.splitRecord({
+  terms: FastUSDCTermsShape,
+  oracles: M.recordOf(M.string(), M.string()),
+  feeConfig: FeeConfigShape,
+  feedPolicy: FeedPolicyShape,
+  chainInfo: M.recordOf(M.string(), CosmosChainInfoShapeV1),
+  assetInfo: M.arrayOf([DenomShape, DenomDetailShape]),
+});

package/src/types.ts

@@ -7,6 +7,7 @@ import type {
   DenomDetail,
   BaseChainInfo,
   KnownNamespace,
+  CaipChainId,
 } from '@agoric/orchestration';
 import type { IBCChannelID } from '@agoric/vats';
 import type { Amount } from '@agoric/ertp';
@@ -42,7 +43,7 @@ export interface CctpTxEvidence {
   /** from Noble RPC */
   aux: {
     forwardingChannel: IBCChannelID;
-    recipientAddress: CosmosChainAddress['value'];
+    recipientAddress: CosmosChainAddress['value'] | AccountId;
   };
   /** on the source chain (e.g. L1 Ethereum and L2s Arbitrum, Base) */
   blockHash: EvmHash;
@@ -98,12 +99,22 @@ export interface PendingTx extends CctpTxEvidence {
 }
 
 export type FeeConfig = {
-  /** flat fee charged for every advance */
+  /** flat fee charged for every advance, eligible for LP disbursement */
   flat: Amount<'nat'>;
-  /** proportion of advance kept as a fee */
+  /** proportion of advance kept as a fee, eligible for LP disbursement */
   variableRate: Ratio;
-  /** proportion of fees that goes to the contract (remaining goes to LPs) */
+  /** proportion of `flat` and `variableRate` fees that goes to the contract (remaining goes to LPs) */
   contractRate: Ratio;
+  /**
+   * if present, a fee required to relay (e.g. CCTP to EVM/Solana). Not
+   * considered for LP disbursement - goes to `contractSeat`.
+   */
+  relay?: Amount<'nat'>;
+  /** Optional destination-specific overrides. If present, must supersede base values. */
+  destinationOverrides?: Record<
+    CaipChainId,
+    Partial<Omit<FeeConfig, 'destinationOverrides'>>
+  >;
 };
 
 export interface PoolStats {

package/src/utils/fees.js

@@ -2,12 +2,14 @@ import { AmountMath } from '@agoric/ertp';
 import { multiplyBy } from '@agoric/ertp/src/ratio.js';
 import { Fail } from '@endo/errors';
 import { mustMatch } from '@endo/patterns';
+import { chainOfAccount } from '@agoric/orchestration/src/utils/address.js';
 import { FeeConfigShape } from '../type-guards.js';
 
-const { add, isGTE, subtract } = AmountMath;
+const { add, isGTE, subtract, makeEmpty } = AmountMath;
 
 /**
  * @import {Amount} from '@agoric/ertp';
+ * @import {AccountId} from '@agoric/orchestration';
  * @import {FeeConfig} from '../types.js';
  */
 
@@ -16,6 +18,7 @@ const { add, isGTE, subtract } = AmountMath;
  *  Principal: Amount<'nat'>;
  *  PoolFee: Amount<'nat'>;
  *  ContractFee: Amount<'nat'>;
+ *  RelayFee: Amount<'nat'>;
  * }} RepayAmountKWR
  */
 
@@ -24,48 +27,116 @@ const { add, isGTE, subtract } = AmountMath;
  *  Principal: Payment<'nat'>;
  *  PoolFee: Payment<'nat'>;
  *  ContractFee: Payment<'nat'>;
+ *  RelayFee: Payment<'nat'>;
  * }} RepayPaymentKWR
  */
 
-/** @param {FeeConfig} feeConfig */
+/**
+ * @template {keyof Omit<FeeConfig, 'destinationOverrides'>} K
+ * @param {FeeConfig} feeConfig
+ * @param {K} key
+ * @param {AccountId} destination
+ * @returns {FeeConfig[K]}
+ */
+const getConfigValue = (feeConfig, key, destination) => {
+  const chainId = chainOfAccount(destination);
+  if (
+    feeConfig.destinationOverrides?.[chainId] &&
+    feeConfig.destinationOverrides[chainId][key] !== undefined
+  ) {
+    return feeConfig.destinationOverrides[chainId][key];
+  }
+  return feeConfig[key];
+};
+
+/**
+ * @param {FeeConfig} feeConfig
+ */
 export const makeFeeTools = feeConfig => {
   mustMatch(feeConfig, FeeConfigShape, 'Must provide feeConfig');
-  const { flat, variableRate } = feeConfig;
+  const emptyAmount = makeEmpty(feeConfig.flat.brand);
+
   const feeTools = harden({
     /**
-     * Calculate the net amount to advance after withholding fees.
+     * Calculate the base fee to charge for the advance (variable + flat).
+     * Will be shared between the pool and the contract based on
+     * {@link FeeConfig.contractRate}.
      *
      * @param {Amount<'nat'>} requested
-     * @throws {Error} if requested does not exceed fees
+     * @param {AccountId} destination
+     * @returns {Amount<'nat'>}
      */
-    calculateAdvance(requested) {
-      const fee = feeTools.calculateAdvanceFee(requested);
-      return subtract(requested, fee);
+    calculateBaseFee(requested, destination) {
+      const flat = getConfigValue(feeConfig, 'flat', destination);
+      const variableRate = getConfigValue(
+        feeConfig,
+        'variableRate',
+        destination,
+      );
+      return add(multiplyBy(requested, variableRate), flat);
+    },
+    /**
+     * Calculate the optional relay fee charged for certain destinations.
+     * Only disbursed to contract seat.
+     *
+     * @param {AccountId} destination
+     * @returns {Amount<'nat'>}
+     */
+    calculateRelayFee(destination) {
+      const relay = getConfigValue(feeConfig, 'relay', destination);
+      return relay || emptyAmount;
     },
     /**
      * Calculate the total fee to charge for the advance.
      *
      * @param {Amount<'nat'>} requested
+     * @param {AccountId} destination
      * @throws {Error} if requested does not exceed fees
      */
-    calculateAdvanceFee(requested) {
-      const fee = add(multiplyBy(requested, variableRate), flat);
+    calculateAdvanceFee(requested, destination) {
+      const baseFee = feeTools.calculateBaseFee(requested, destination);
+      const relayFee = feeTools.calculateRelayFee(destination);
+      const fee = add(baseFee, relayFee);
       !isGTE(fee, requested) || Fail`Request must exceed fees.`;
       return fee;
     },
+    /**
+     * Calculate the net amount to advance after withholding fees.
+     *
+     * @param {Amount<'nat'>} requested
+     * @param {AccountId} destination
+     * @throws {Error} if requested does not exceed fees
+     */
+    calculateAdvance(requested, destination) {
+      const fee = feeTools.calculateAdvanceFee(requested, destination);
+      return subtract(requested, fee);
+    },
     /**
      * Calculate the split of fees between pool and contract.
      *
+     * The `ContractFee` includes base fees plus the relay fee.
+     *
      * @param {Amount<'nat'>} requested
+     * @param {AccountId} destination
      * @returns {RepayAmountKWR} an {@link AmountKeywordRecord}
      * @throws {Error} if requested does not exceed fees
      */
-    calculateSplit(requested) {
-      const fee = feeTools.calculateAdvanceFee(requested);
-      const Principal = subtract(requested, fee);
-      const ContractFee = multiplyBy(fee, feeConfig.contractRate);
-      const PoolFee = subtract(fee, ContractFee);
-      return harden({ Principal, PoolFee, ContractFee });
+    calculateSplit(requested, destination) {
+      const baseFee = feeTools.calculateBaseFee(requested, destination);
+      const relayFee = feeTools.calculateRelayFee(destination);
+      const totalFee = add(baseFee, relayFee);
+      !isGTE(totalFee, requested) || Fail`Request must exceed fees.`;
+
+      const contractRate = getConfigValue(
+        feeConfig,
+        'contractRate',
+        destination,
+      );
+      const Principal = subtract(requested, totalFee);
+      const ContractFee = multiplyBy(baseFee, contractRate);
+      const PoolFee = subtract(baseFee, ContractFee);
+
+      return harden({ Principal, PoolFee, ContractFee, RelayFee: relayFee });
     },
   });
   return feeTools;