@agoric/fast-usdc 0.2.0-u18.0 → 0.2.0-u19.0

package/src/types.ts

@@ -27,8 +27,21 @@ export interface CctpTxEvidence {
     forwardingChannel: IBCChannelID;
     recipientAddress: ChainAddress['value'];
   };
+  /** on the source chain (e.g. L1 Ethereum and L2s Arbitrum, Base) */
   blockHash: EvmHash;
+  /** height of blockHash on the source chain */
   blockNumber: bigint;
+  /**
+   * Seconds since Unix epoch. Not all CCTP source chains update time the same
+   * way but they all use Unix epoch and thus are approximately equal. (Within
+   * minutes apart.)
+   */
+  blockTimestamp: bigint;
+  //
+  /**
+   * [Domain of values](https://chainid.network/) per [EIP-155](https://eips.ethereum.org/EIPS/eip-155)
+   * (We don't have [CCTP `domain`](https://developers.circle.com/stablecoins/supported-domains) )
+   */
   chainId: number;
   /** data covered by signature (aka txHash) */
   tx: {
@@ -55,6 +68,12 @@ export interface TransactionRecord extends CopyRecord {
   status: TxStatus;
 }
 
+/** the record in vstorage at the path of the contract's node */
+export interface ContractRecord extends CopyRecord {
+  poolAccount: ChainAddress['value'];
+  settlementAccount: ChainAddress['value'];
+}
+
 export type LogFn = (...args: unknown[]) => void;
 
 export interface PendingTx extends CctpTxEvidence {
@@ -62,9 +81,11 @@ export interface PendingTx extends CctpTxEvidence {
 }
 
 export type FeeConfig = {
+  /** flat fee charged for every advance */
   flat: Amount<'nat'>;
+  /** proportion of advance kept as a fee */
   variableRate: Ratio;
-  maxVariable: Amount<'nat'>;
+  /** proportion of fees that goes to the contract (remaining goes to LPs) */
   contractRate: Ratio;
 };
 
@@ -82,27 +103,35 @@ export interface PoolMetrics extends PoolStats {
 
 export interface ChainPolicy {
   /** `msg.sender` of DepositAndBurn to TokenMessenger must be an attenuated wrapper contract that does not contain `replaceDepositForBurn` */
-  attenuatedCttpBridgeAddress: EvmHash;
+  attenuatedCttpBridgeAddresses: EvmHash[];
   /** @see {@link https://developers.circle.com/stablecoins/evm-smart-contracts} */
   cctpTokenMessengerAddress: EvmHash;
   /** e.g., `1` for ETH mainnet 42161 for Arbitrum One. @see {@link https://chainlist.org/} */
   chainId: EvmChainID;
   /** the number of block confirmations to observe before reporting */
   confirmations: number;
+  rateLimits: {
+    /** do not advance more than this amount for an individual transaction */
+    tx: bigint;
+    /** do not advance more than this amount per block window */
+    blockWindow: bigint;
+    /** the number of blocks to consider for `blockWindow` */
+    blockWindowSize: number;
+  };
 }
 
-export interface FeedPolicy {
+export type FeedPolicy = {
   nobleDomainId: number;
   nobleAgoricChannelId: string;
   chainPolicies: Record<EvmChainName, ChainPolicy>;
   eventFilter?: string;
-}
+} & CopyRecord;
 
 export type FastUSDCConfig = {
   terms: FastUsdcTerms;
   oracles: Record<string, string>;
   feeConfig: FeeConfig;
-  feedPolicy: FeedPolicy & Passable;
+  feedPolicy: FeedPolicy;
   noNoble: boolean; // support a3p-integration, which has no noble chain
   chainInfo: Record<string, CosmosChainInfo & Passable>;
   assetInfo: [Denom, DenomDetail & { brandKey?: string }][];

package/src/utils/chain-policies.js

@@ -0,0 +1,140 @@
+/** @import {ChainPolicy} from '../types.js'; */
+
+/** @satisfies {Record<'MAINNET'| 'TESTNET', Record<string, ChainPolicy>>} */
+export const ChainPolicies = /** @type {const} */ ({
+  MAINNET: {
+    Arbitrum: {
+      attenuatedCttpBridgeAddresses: [
+        '0xe298b93ffB5eA1FB628e0C0D55A43aeaC268e347',
+      ],
+      cctpTokenMessengerAddress: '0x19330d10D9Cc8751218eaf51E8885D058642E08A',
+      chainId: 42161,
+      // TODO confirm confirmations and rateLimits
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+    Base: {
+      attenuatedCttpBridgeAddresses: [
+        '0xB6615B2662b35fc3533F8479002e62D0523341De',
+      ],
+      cctpTokenMessengerAddress: '0x1682Ae6375C4E4A97e4B583BC394c861A46D8962',
+      chainId: 8453,
+      // TODO confirm confirmations and rateLimits
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+    Ethereum: {
+      attenuatedCttpBridgeAddresses: [
+        '0xBC8552339dA68EB65C8b88B414B5854E0E366cFc',
+      ],
+      cctpTokenMessengerAddress: '0xBd3fa81B58Ba92a82136038B25aDec7066af3155',
+      chainId: 1,
+      // TODO confirm confirmations and rateLimits
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+    Optimism: {
+      attenuatedCttpBridgeAddresses: [
+        '0x48C5417ED570928eC85D5e3AD4e7E0EeD7dB1E2A',
+      ],
+      cctpTokenMessengerAddress: '0x2B4069517957735bE00ceE0fadAE88a26365528f',
+      chainId: 10,
+      // TODO confirm confirmations and rateLimits
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+    Polygon: {
+      attenuatedCttpBridgeAddresses: [
+        '0x32cb9574650AFF312c80edc4B4343Ff5500767cA',
+      ],
+      cctpTokenMessengerAddress: '0x9daF8c91AEFAE50b9c0E69629D3F6Ca40cA3B3FE',
+      chainId: 137,
+      // TODO confirm confirmations and rateLimits
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+  },
+  TESTNET: {
+    // Arbitrum Sepolia
+    Arbitrum: {
+      attenuatedCttpBridgeAddresses: ['0xTODO'],
+      cctpTokenMessengerAddress: '0x9f3B8679c73C2Fef8b59B4f3444d4e156fb70AA5',
+      chainId: 421614,
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+    // Base Sepolia
+    Base: {
+      attenuatedCttpBridgeAddresses: ['0xTODO'],
+      cctpTokenMessengerAddress: '0x9f3B8679c73C2Fef8b59B4f3444d4e156fb70AA5',
+      chainId: 84532,
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+    // Ethereum Sepolia
+    Ethereum: {
+      attenuatedCttpBridgeAddresses: ['0xTODO'],
+      cctpTokenMessengerAddress: '0x9f3B8679c73C2Fef8b59B4f3444d4e156fb70AA5',
+      chainId: 11155111,
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+    // OP Sepolia
+    Optimism: {
+      attenuatedCttpBridgeAddresses: ['0xTODO'],
+      cctpTokenMessengerAddress: '0x9f3B8679c73C2Fef8b59B4f3444d4e156fb70AA5',
+      chainId: 11155420,
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+    // Polygon PoS Amoy
+    Polygon: {
+      attenuatedCttpBridgeAddresses: ['0xTODO'],
+      cctpTokenMessengerAddress: '0x9f3B8679c73C2Fef8b59B4f3444d4e156fb70AA5',
+      chainId: 80002,
+      confirmations: 2,
+      rateLimits: {
+        blockWindow: 20_000_000_000n,
+        blockWindowSize: 10,
+        tx: 10_000_000_000n,
+      },
+    },
+  },
+});
+harden(ChainPolicies);

package/src/utils/core-eval.js

@@ -0,0 +1,73 @@
+import { deeplyFulfilledObject, makeTracer, objectMap } from '@agoric/internal';
+import { Fail } from '@endo/errors';
+import { E } from '@endo/eventual-send';
+import { makeMarshal } from '@endo/marshal';
+
+const trace = makeTracer('FUCoreEval');
+
+/**
+ * @import {Brand, DepositFacet} from '@agoric/ertp';
+ * @import {FastUSDCKit} from '../start-fast-usdc.core.js'
+ * @import {FeedPolicy} from '../types.js'
+ */
+
+export const FEED_POLICY = 'feedPolicy';
+export const marshalData = makeMarshal(_val => Fail`data only`);
+
+/**
+ * @param {ERef<StorageNode>} node
+ * @param {FeedPolicy} policy
+ */
+export const publishFeedPolicy = async (node, policy) => {
+  const feedPolicy = E(node).makeChildNode(FEED_POLICY);
+  const value = marshalData.toCapData(policy);
+  await E(feedPolicy).setValue(JSON.stringify(value));
+};
+
+/**
+ * @param {object} powers
+ * @param {FastUSDCKit['creatorFacet']} powers.creatorFacet
+ * @param {BootstrapPowers['consume']['namesByAddress']} powers.namesByAddress
+ * @param {Record<string, string>} oracles
+ */
+export const inviteOracles = async (
+  { creatorFacet, namesByAddress },
+  oracles,
+) => {
+  const oracleDepositFacets = await deeplyFulfilledObject(
+    objectMap(
+      oracles,
+      /** @type {(address: string) => Promise<DepositFacet>} */
+      address => E(namesByAddress).lookup(address, 'depositFacet'),
+    ),
+  );
+  await Promise.all(
+    Object.entries(oracleDepositFacets).map(async ([name, depositFacet]) => {
+      const address = oracles[name];
+      trace('making invitation for', name, address);
+      const toWatch = await E(creatorFacet).makeOperatorInvitation(address);
+
+      const amt = await E(depositFacet).receive(toWatch);
+      trace('sent', amt, 'to', name);
+    }),
+  );
+};
+
+const BOARD_AUX = 'boardAux';
+/**
+ * @param {Brand} brand
+ * @param {Pick<BootstrapPowers['consume'], 'board' | 'chainStorage'>} powers
+ */
+export const publishDisplayInfo = async (brand, { board, chainStorage }) => {
+  // chainStorage type includes undefined, which doesn't apply here.
+  // @ts-expect-error UNTIL https://github.com/Agoric/agoric-sdk/issues/8247
+  const boardAux = E(chainStorage).makeChildNode(BOARD_AUX);
+  const [id, displayInfo, allegedName] = await Promise.all([
+    E(board).getId(brand),
+    E(brand).getDisplayInfo(),
+    E(brand).getAllegedName(),
+  ]);
+  const node = E(boardAux).makeChildNode(id);
+  const aux = marshalData.toCapData(harden({ allegedName, displayInfo }));
+  await E(node).setValue(JSON.stringify(aux));
+};

package/src/utils/deploy-config.js

@@ -1,50 +1,38 @@
 import { denomHash, withChainCapabilities } from '@agoric/orchestration';
 import fetchedChainInfo from '@agoric/orchestration/src/fetched-chain-info.js';
+import { ChainPolicies } from './chain-policies.js';
 
 /**
- * @import {FastUSDCConfig} from '@agoric/fast-usdc/src/types.js'
+ * @import {FastUSDCConfig} from '@agoric/fast-usdc';
  * @import {Passable} from '@endo/marshal';
  * @import {CosmosChainInfo, Denom, DenomDetail} from '@agoric/orchestration';
  */
 
+/** @type {[Denom, DenomDetail & { brandKey?: string}]} */
+const usdcOnAgoric = [
+  `ibc/${denomHash({ denom: 'uusdc', channelId: fetchedChainInfo.agoric.connections['noble-1'].transferChannel.channelId })}`,
+  {
+    baseName: 'noble',
+    chainName: 'agoric',
+    baseDenom: 'uusdc',
+    brandKey: 'USDC',
+  },
+];
+
 /** @type {[Denom, DenomDetail & { brandKey?: string}][]} */
-export const defaultAssetInfo = [
-  [
-    'uusdc',
-    {
-      baseName: 'noble',
-      chainName: 'noble',
-      baseDenom: 'uusdc',
-    },
-  ],
-  [
-    `ibc/${denomHash({ denom: 'uusdc', channelId: fetchedChainInfo.agoric.connections['noble-1'].transferChannel.channelId })}`,
-    {
-      baseName: 'noble',
-      chainName: 'agoric',
-      baseDenom: 'uusdc',
-      brandKey: 'USDC',
-    },
-  ],
-  [
-    `ibc/${denomHash({ denom: 'uusdc', channelId: fetchedChainInfo.osmosis.connections['noble-1'].transferChannel.channelId })}`,
-    {
-      baseName: 'noble',
-      chainName: 'osmosis',
-      baseDenom: 'uusdc',
-    },
-  ],
+export const transferAssetInfo = [
+  ['uusdc', { baseName: 'noble', chainName: 'noble', baseDenom: 'uusdc' }],
+  usdcOnAgoric,
 ];
-harden(defaultAssetInfo);
+harden(transferAssetInfo);
 
-const agoricAssetInfo = defaultAssetInfo.filter(
-  ([_d, i]) => i.chainName === 'agoric',
-);
+/** ABI for DepositForBurn event in TokenMessenger contract */
+const DepositForBurnEvent =
+  'DepositForBurn(uint64,address,uint256,address,bytes32,uint32,bytes32,bytes32)';
 
 /**
  * @type {Record<string, Pick<FastUSDCConfig, 'oracles' | 'feedPolicy' | 'chainInfo' | 'assetInfo' >>}
  *
- * TODO: determine OCW operator addresses
  * meanwhile, use price oracle addresses (from updatePriceFeeds.js).
  */
 export const configurations = {
@@ -62,16 +50,8 @@ export const configurations = {
     feedPolicy: {
       nobleAgoricChannelId: 'channel-does-not-exist',
       nobleDomainId: 4,
-      chainPolicies: {
-        Arbitrum: {
-          attenuatedCttpBridgeAddress:
-            '0xe298b93ffB5eA1FB628e0C0D55A43aeaC268e347',
-          cctpTokenMessengerAddress:
-            '0x19330d10D9Cc8751218eaf51E8885D058642E08A',
-          chainId: 42161,
-          confirmations: 2,
-        },
-      },
+      chainPolicies: ChainPolicies.TESTNET,
+      eventFilter: DepositForBurnEvent,
     },
     chainInfo: /** @type {Record<string, CosmosChainInfo & Passable>} */ (
       withChainCapabilities({
@@ -80,32 +60,25 @@ export const configurations = {
         noble: fetchedChainInfo.noble,
       })
     ),
-    assetInfo: agoricAssetInfo,
+    assetInfo: [usdcOnAgoric],
   },
   MAINNET: {
+    // per JVC 12 Feb 2025
     oracles: {
-      '01node': 'agoric19uscwxdac6cf6z7d5e26e0jm0lgwstc47cpll8',
-      'Simply Staking': 'agoric1krunjcqfrf7la48zrvdfeeqtls5r00ep68mzkr',
-      P2P: 'agoric1n4fcxsnkxe4gj6e24naec99hzmc4pjfdccy5nj',
+      '01node': 'agoric1ym488t6j24x3ys3va3452ftx44lhs64rz8pu7h',
+      SimplyStaking: 'agoric1s5yawjgj6xcw4ea5r2x4cjrnkprmd0fcun2tyk',
+      DSRV: 'agoric17crpkfxarq658e9ddru2petrfr0fhjzvjfccq9',
     },
     feedPolicy: {
       nobleAgoricChannelId: 'channel-21',
       nobleDomainId: 4,
-      chainPolicies: {
-        Arbitrum: {
-          attenuatedCttpBridgeAddress:
-            '0xe298b93ffB5eA1FB628e0C0D55A43aeaC268e347',
-          cctpTokenMessengerAddress:
-            '0x19330d10D9Cc8751218eaf51E8885D058642E08A',
-          chainId: 42161,
-          confirmations: 2,
-        },
-      },
+      chainPolicies: ChainPolicies.MAINNET,
+      eventFilter: DepositForBurnEvent,
     },
     chainInfo: /** @type {Record<string, CosmosChainInfo & Passable>} */ (
       withChainCapabilities(fetchedChainInfo)
     ),
-    assetInfo: defaultAssetInfo,
+    assetInfo: transferAssetInfo,
   },
   DEVNET: {
     oracles: {
@@ -118,19 +91,13 @@ export const configurations = {
     feedPolicy: {
       nobleAgoricChannelId: 'TODO',
       nobleDomainId: 4,
-      chainPolicies: {
-        Arbitrum: {
-          attenuatedCttpBridgeAddress: '0xTODO',
-          cctpTokenMessengerAddress: '0xTODO',
-          chainId: 421614,
-          confirmations: 2,
-        },
-      },
+      chainPolicies: ChainPolicies.TESTNET,
+      eventFilter: DepositForBurnEvent,
     },
     chainInfo: /** @type {Record<string, CosmosChainInfo & Passable>} */ (
       withChainCapabilities(fetchedChainInfo) // TODO: use devnet values
     ),
-    assetInfo: defaultAssetInfo, // TODO: use emerynet values
+    assetInfo: transferAssetInfo,
   },
   EMERYNET: {
     oracles: {
@@ -140,19 +107,13 @@ export const configurations = {
     feedPolicy: {
       nobleAgoricChannelId: 'TODO',
       nobleDomainId: 4,
-      chainPolicies: {
-        Arbitrum: {
-          attenuatedCttpBridgeAddress: '0xTODO',
-          cctpTokenMessengerAddress: '0xTODO',
-          chainId: 421614,
-          confirmations: 2,
-        },
-      },
+      chainPolicies: ChainPolicies.TESTNET,
+      eventFilter: DepositForBurnEvent,
     },
     chainInfo: /** @type {Record<string, CosmosChainInfo & Passable>} */ (
       withChainCapabilities(fetchedChainInfo) // TODO: use emerynet values
     ),
-    assetInfo: defaultAssetInfo, // TODO: use emerynet values
+    assetInfo: transferAssetInfo,
   },
 };
 harden(configurations);

package/src/utils/fees.js

@@ -4,7 +4,7 @@ import { Fail } from '@endo/errors';
 import { mustMatch } from '@endo/patterns';
 import { FeeConfigShape } from '../type-guards.js';
 
-const { add, isGTE, min, subtract } = AmountMath;
+const { add, isGTE, subtract } = AmountMath;
 
 /**
  * @import {Amount} from '@agoric/ertp';
@@ -15,7 +15,7 @@ const { add, isGTE, min, subtract } = AmountMath;
 /** @param {FeeConfig} feeConfig */
 export const makeFeeTools = feeConfig => {
   mustMatch(feeConfig, FeeConfigShape, 'Must provide feeConfig');
-  const { flat, variableRate, maxVariable } = feeConfig;
+  const { flat, variableRate } = feeConfig;
   const feeTools = harden({
     /**
      * Calculate the net amount to advance after withholding fees.
@@ -34,8 +34,7 @@ export const makeFeeTools = feeConfig => {
      * @throws {Error} if requested does not exceed fees
      */
     calculateAdvanceFee(requested) {
-      const variable = min(multiplyBy(requested, variableRate), maxVariable);
-      const fee = add(variable, flat);
+      const fee = add(multiplyBy(requested, variableRate), flat);
       !isGTE(fee, requested) || Fail`Request must exceed fees.`;
       return fee;
     },