@agoric/fast-usdc 0.2.0-u19.1 → 0.2.0-u20.0

package/src/utils/fees.js

@@ -1,56 +1,142 @@
 import { AmountMath } from '@agoric/ertp';
-import { multiplyBy } from '@agoric/zoe/src/contractSupport/ratio.js';
+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';
- * @import {RepayAmountKWR} from '../exos/liquidity-pool.js';
  */
 
-/** @param {FeeConfig} feeConfig */
+/**
+ * @typedef {{
+ *  Principal: Amount<'nat'>;
+ *  PoolFee: Amount<'nat'>;
+ *  ContractFee: Amount<'nat'>;
+ *  RelayFee: Amount<'nat'>;
+ * }} RepayAmountKWR
+ */
+
+/**
+ * @typedef {{
+ *  Principal: Payment<'nat'>;
+ *  PoolFee: Payment<'nat'>;
+ *  ContractFee: Payment<'nat'>;
+ *  RelayFee: Payment<'nat'>;
+ * }} RepayPaymentKWR
+ */
+
+/**
+ * @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;

package/tools/mock-evidence.ts

@@ -0,0 +1,208 @@
+import { encodeAddressHook } from '@agoric/cosmic-proto/address-hooks.js';
+import type { Bech32Address, CosmosChainAddress } from '@agoric/orchestration';
+import type { CctpTxEvidence, EvmAddress } from '../src/types.js';
+
+const mockScenarios = [
+  'AGORIC_PLUS_OSMO',
+  'AGORIC_PLUS_DYDX',
+  'AGORIC_PLUS_AGORIC',
+  'AGORIC_NO_PARAMS',
+  'AGORIC_UNKNOWN_EUD',
+  'AGORIC_PLUS_ETHEREUM',
+  'AGORIC_PLUS_NOBLE',
+  'AGORIC_PLUS_NOBLE_B32EUD',
+] as const;
+
+export type MockScenario = (typeof mockScenarios)[number];
+
+export const Senders = {
+  default: '0xDefaultFakeEthereumAddress',
+} as unknown as Record<string, EvmAddress>;
+
+const blockTimestamp = 1632340000n;
+
+export const MockCctpTxEvidences: Record<
+  MockScenario,
+  (receiverAddress?: Bech32Address) => CctpTxEvidence
+> = {
+  AGORIC_PLUS_OSMO: (receiverAddress?: Bech32Address) => ({
+    blockHash:
+      '0x90d7343e04f8160892e94f02d6a9b9f255663ed0ac34caca98544c8143fee665',
+    blockNumber: 21037663n,
+    blockTimestamp,
+    txHash:
+      '0xc81bc6105b60a234c7c50ac17816ebcd5561d366df8bf3be59ff387552761702',
+    tx: {
+      amount: 150000000n,
+      forwardingAddress: 'noble1x0ydg69dh6fqvr27xjvp6maqmrldam6yfelqkd',
+      sender: Senders.default,
+    },
+    aux: {
+      forwardingChannel: 'channel-21',
+      recipientAddress:
+        receiverAddress ||
+        encodeAddressHook(settlementAddress.value, {
+          EUD: 'osmo183dejcnmkka5dzcu9xw6mywq0p2m5peks28men',
+        }),
+    },
+    chainId: 1,
+  }),
+  AGORIC_PLUS_DYDX: (receiverAddress?: Bech32Address) => ({
+    blockHash:
+      '0x80d7343e04f8160892e94f02d6a9b9f255663ed0ac34caca98544c8143fee699',
+    blockNumber: 21037669n,
+    blockTimestamp,
+    txHash:
+      '0xd81bc6105b60a234c7c50ac17816ebcd5561d366df8bf3be59ff387552761799',
+    tx: {
+      amount: 300000000n,
+      forwardingAddress: 'noble1x0ydg69dh6fqvr27xjvp6maqmrldam6yfelktz',
+      sender: Senders.default,
+    },
+    aux: {
+      forwardingChannel: 'channel-21',
+      recipientAddress:
+        receiverAddress ||
+        encodeAddressHook(settlementAddress.value, {
+          EUD: 'dydx183dejcnmkka5dzcu9xw6mywq0p2m5peks28men',
+        }),
+    },
+    chainId: 1,
+  }),
+  AGORIC_PLUS_AGORIC: (receiverAddress?: Bech32Address) => ({
+    blockHash:
+      '0x80d7343e04f8160892e94f02d6a9b9f255663ed0ac34caca98544c8143fee6z9',
+    blockNumber: 21037600n,
+    blockTimestamp,
+    txHash:
+      '0xd81bc6105b60a234c7c50ac17816ebcd5561d366df8bf3be59ff3875527617z9',
+    tx: {
+      amount: 250000000n,
+      forwardingAddress: 'noble17ww3rfusv895d92c0ncgj0fl9trntn70jz7hd5',
+      sender: Senders.default,
+    },
+    aux: {
+      forwardingChannel: 'channel-21',
+      recipientAddress:
+        receiverAddress ||
+        encodeAddressHook(settlementAddress.value, {
+          EUD: 'agoric13rj0cc0hm5ac2nt0sdup2l7gvkx4v9tyvgq3h2',
+        }),
+    },
+    chainId: 1,
+  }),
+  AGORIC_NO_PARAMS: (receiverAddress?: Bech32Address) => ({
+    blockHash:
+      '0x70d7343e04f8160892e94f02d6a9b9f255663ed0ac34caca98544c8143fee699',
+    blockNumber: 21037669n,
+    blockTimestamp,
+    txHash:
+      '0xa81bc6105b60a234c7c50ac17816ebcd5561d366df8bf3be59ff387552761799',
+    tx: {
+      amount: 200000000n,
+      forwardingAddress: 'noble1x0ydg69dh6fqvr27xjvp6maqmrldam6yfelyyy',
+      sender: Senders.default,
+    },
+    aux: {
+      forwardingChannel: 'channel-21',
+      recipientAddress: receiverAddress || settlementAddress.value,
+    },
+    chainId: 1,
+  }),
+  AGORIC_UNKNOWN_EUD: (receiverAddress?: Bech32Address) => ({
+    blockHash:
+      '0x70d7343e04f8160892e94f02d6a9b9f255663ed0ac34caca98544c8143fee699',
+    blockNumber: 21037669n,
+    blockTimestamp,
+    txHash:
+      '0xa81bc6105b60a234c7c50ac17816ebcd5561d366df8bf3be59ff387552761799',
+    tx: {
+      amount: 200000000n,
+      forwardingAddress: 'noble1x0ydg69dh6fqvr27xjvp6maqmrldam6yfelyyy',
+      sender: Senders.default,
+    },
+    aux: {
+      forwardingChannel: 'channel-21',
+      recipientAddress:
+        receiverAddress ||
+        encodeAddressHook(settlementAddress.value, {
+          EUD: 'random1addr',
+        }),
+    },
+    chainId: 1,
+  }),
+  AGORIC_PLUS_ETHEREUM: (receiverAddress?: Bech32Address) => ({
+    blockHash:
+      '0x80d7343e04f8160892e94f02d6a9b9f255663ed0ac34caca98544c8143fee6z9',
+    blockNumber: 21037600n,
+    blockTimestamp,
+    txHash:
+      '0xe81bc6105b60a234c7c50ac17816ebcd5561d366df8bf3be59ff3875527617z9',
+    tx: {
+      amount: 950000000n,
+      forwardingAddress: 'noble17ww3rfusv895d92c0ncgj0fl9trntn70jz7ee5',
+      sender: Senders.default,
+    },
+    aux: {
+      forwardingChannel: 'channel-21',
+      recipientAddress:
+        receiverAddress ||
+        encodeAddressHook(settlementAddress.value, {
+          EUD: 'eip155:1:0x1234567890123456789012345678901234567890',
+        }),
+    },
+    chainId: 8453,
+  }),
+  AGORIC_PLUS_NOBLE: (receiverAddress?: Bech32Address) => ({
+    blockHash:
+      '0x80d7343e04f8160892e94f02d6a9b9f255663ed0ac34caca98544c8143fee6z9',
+    blockNumber: 21037600n,
+    blockTimestamp,
+    txHash:
+      '0xe81bc6105b60a234c7c50ac17816ebcd5561d366df8bf3be59ff3875527617z9',
+    tx: {
+      amount: 950000000n,
+      forwardingAddress: 'noble17ww3rfusv895d92c0ncgj0fl9trntn70jz7ee5',
+      sender: Senders.default,
+    },
+    aux: {
+      forwardingChannel: 'channel-21',
+      recipientAddress:
+        receiverAddress ||
+        encodeAddressHook(settlementAddress.value, {
+          EUD: 'cosmos:noble-1:noble1u2l9za2wa7wvffhtekgyuvyvum06lwhqxfyr5d',
+        }),
+    },
+    chainId: 8453,
+  }),
+  /** Identical to AGORIC_PLUS_NOBLE, but the EUD is a bare bech32 */
+  AGORIC_PLUS_NOBLE_B32EUD: (receiverAddress?: Bech32Address) => ({
+    blockHash:
+      '0x80d7343e04f8160892e94f02d6a9b9f255663ed0ac34caca98544c8143fee6z9',
+    blockNumber: 21037600n,
+    blockTimestamp,
+    txHash:
+      '0xe81bc6105b60a234c7c50ac17816ebcd5561d366df8bf3be59ff3875527617z9',
+    tx: {
+      amount: 950000000n,
+      forwardingAddress: 'noble17ww3rfusv895d92c0ncgj0fl9trntn70jz7ee5',
+      sender: Senders.default,
+    },
+    aux: {
+      forwardingChannel: 'channel-21',
+      recipientAddress:
+        receiverAddress ||
+        encodeAddressHook(settlementAddress.value, {
+          EUD: 'noble1u2l9za2wa7wvffhtekgyuvyvum06lwhqxfyr5d',
+        }),
+    },
+    chainId: 8453,
+  }),
+};
+
+export const settlementAddress: CosmosChainAddress = harden({
+  chainId: 'agoric-3',
+  encoding: 'bech32' as const,
+  // Random value, copied from tests of address hooks
+  value: 'agoric16kv2g7snfc4q24vg3pjdlnnqgngtjpwtetd2h689nz09lcklvh5s8u37ek',
+});

package/src/add-operators.core.js

@@ -1,63 +0,0 @@
-import { makeTracer } from '@agoric/internal';
-import { inviteOracles } from './utils/core-eval.js';
-
-/**
- * @import {ManifestBundleRef} from '@agoric/deploy-script-support/src/externalTypes.js'
- * @import {BootstrapManifest} from '@agoric/vats/src/core/lib-boot.js'
- * @import {LegibleCapData} from './utils/config-marshal.js'
- * @import {FastUSDCConfig} from './types.js'
- * @import {FastUSDCCorePowers, FastUSDCKit} from './start-fast-usdc.core.js';
- */
-
-const trace = makeTracer('FUSD-AddOperators', true);
-
-/**
- * @throws if oracle smart wallets are not yet provisioned
- *
- * @param {BootstrapPowers & FastUSDCCorePowers } powers
- * @param {{ options: LegibleCapData<FastUSDCConfig> }} config
- */
-export const addOperators = async (
-  { consume: { namesByAddress, fastUsdcKit } },
-  config,
-) => {
-  trace(addOperators.name);
-
-  const kit = await fastUsdcKit;
-
-  const { creatorFacet } = kit;
-
-  trace(config);
-
-  // @ts-expect-error XXX LegibleCapData typedef
-  const { oracles } = config.options.structure;
-
-  await inviteOracles({ creatorFacet, namesByAddress }, oracles);
-};
-harden(addOperators);
-
-/**
- * @param {{
- *   restoreRef: (b: ERef<ManifestBundleRef>) => Promise<Installation>;
- * }} utils
- * @param {{
- *   options: LegibleCapData<FastUSDCConfig>;
- * }} param1
- */
-export const getManifestForAddOperators = ({ restoreRef: _ }, { options }) => {
-  return {
-    /** @type {BootstrapManifest} */
-    manifest: {
-      [addOperators.name]: {
-        consume: {
-          fastUsdcKit: true,
-
-          // widely shared: name services
-          agoricNames: true,
-          namesByAddress: true,
-        },
-      },
-    },
-    options,
-  };
-};

package/src/distribute-fees.core.js

@@ -1,93 +0,0 @@
-/** @file core eval module to collect fees. */
-import { AmountMath } from '@agoric/ertp';
-import { floorMultiplyBy } from '@agoric/zoe/src/contractSupport/index.js';
-import { E } from '@endo/far';
-import { makeTracer } from '@agoric/internal';
-import { fromExternalConfig } from './utils/config-marshal.js';
-
-/**
- * @import {DepositFacet} from '@agoric/ertp';
- * @import {FastUSDCCorePowers} from '@agoric/fast-usdc/src/start-fast-usdc.core.js';
- * @import {CopyRecord} from '@endo/pass-style'
- * @import {BootstrapManifestPermit} from '@agoric/vats/src/core/lib-boot.js'
- * @import {LegibleCapData} from './utils/config-marshal.js'
- */
-
-/**
- * @typedef {{ destinationAddress: string } &
- *  ({ feePortion: Ratio} | {fixedFees: Amount<'nat'>}) &
- *  CopyRecord
- * } FeeDistributionTerms
- */
-
-const kwUSDC = 'USDC'; // keyword in AmountKeywordRecord
-const issUSDC = 'USDC'; // issuer name
-
-const trace = makeTracer('FUCF', true);
-
-/**
- * @param {BootstrapPowers & FastUSDCCorePowers } permittedPowers
- * @param {{ options: LegibleCapData<{ feeTerms: FeeDistributionTerms}> }} config
- */
-export const distributeFees = async (permittedPowers, config) => {
-  trace('distributeFees...', config.options);
-
-  const { agoricNames, namesByAddress, zoe } = permittedPowers.consume;
-  /** @type {Brand<'nat'>} */
-  const usdcBrand = await E(agoricNames).lookup('brand', issUSDC);
-  /** @type {{ feeTerms: FeeDistributionTerms}} */
-  const { feeTerms: terms } = fromExternalConfig(config.options, {
-    USDC: usdcBrand,
-  });
-
-  const { creatorFacet } = await permittedPowers.consume.fastUsdcKit;
-  const want = {
-    [kwUSDC]: await ('fixedFees' in terms
-      ? terms.fixedFees
-      : E(creatorFacet)
-          .getContractFeeBalance()
-          .then(balance => floorMultiplyBy(balance, terms.feePortion))),
-  };
-  const proposal = harden({ want });
-
-  /** @type {DepositFacet} */
-  const depositFacet = await E(namesByAddress).lookup(
-    terms.destinationAddress,
-    'depositFacet',
-  );
-  trace('to:', terms.destinationAddress, depositFacet);
-
-  const toWithdraw = await E(creatorFacet).makeWithdrawFeesInvitation();
-  trace('invitation:', toWithdraw, 'proposal:', proposal);
-  const seat = E(zoe).offer(toWithdraw, proposal);
-  const result = await E(seat).getOfferResult();
-  trace('offer result', result);
-  const payout = await E(seat).getPayout(kwUSDC);
-  /** @type {Amount<'nat'>} */
-  // @ts-expect-error USDC is a nat brand
-  const rxd = await E(depositFacet).receive(payout);
-  trace('received', rxd);
-  if (!AmountMath.isGTE(rxd, proposal.want[kwUSDC])) {
-    trace('🚨 expected', proposal.want[kwUSDC], 'got', rxd);
-  }
-  trace('done');
-};
-harden(distributeFees);
-
-/** @satisfies {BootstrapManifestPermit} */
-const permit = {
-  consume: {
-    fastUsdcKit: true,
-    agoricNames: true,
-    namesByAddress: true,
-    zoe: true,
-  },
-};
-
-/**
- * @param {unknown} _utils
- * @param {Parameters<typeof distributeFees>[1]} config
- */
-export const getManifestForDistributeFees = (_utils, { options }) => {
-  return { manifest: { [distributeFees.name]: permit }, options };
-};