chore: added gas estimation api to planner (#11953)

## Description
Includes code to add gas estimation in planner. It estimates two different types of gas values. Outgoing as well as incoming.

For the outgoing txs i.e Agoric -> EVM. We have a record of `gasLimitEstimates` that are representative of real world gas amounts used during makeAccount / supply / withdraw tx.

At the moment there are only two types of gas limits we've added. one for the execution of the factory contract. the other for the execution of the wallet contract.
In the future in place of the `Wallet` gas limit, we would have a list of gas Limits representing each item in the matrix {supply, withdraw} x {Aave, Compund, Beefy} since each is silghtly different and it would be more efficient to have the minimum possible value for each

For incoming, the API call  the estimation seems to be off according to our testing. The API gives an esitmate which is 20x higher than the value we use in testnet (0.0002 vs 0.005)

### Testing Considerations
Tested in this Tx: https://testnet.axelarscan.io/gmp/0xa1b399894a97b70bf38302d1297fa1f6b2fd198b1fffc0529c0bb1e5c89725af-4
It supplied the build amount for the outgoing tx but also calculated the eth amount for the incoming tx

Author: mergify[bot]

packages/portfolio-contract/src/network/network-spec.ts

@@ -16,7 +16,29 @@ export type TransferProtocol =
   | 'cctpReturn'
   | 'cctpSlow'
   | 'local';
-export type FeeMode = 'toUSDN' | 'gmpCall' | 'gmpTransfer';
+/**
+ * Link to Factory and Wallet contracts:
+ * https://github.com/agoric-labs/agoric-to-axelar-local/blob/cd6087fa44de3b019b2cdac6962bb49b6a2bc1ca/packages/axelar-local-dev-cosmos/src/__tests__/contracts/Factory.sol
+ *
+ * Steps submitted to the contract are expected to include fee/gas payment
+ * details which vary by the traversed link.
+ * - toUSDN: transferring into USDN transfer reduces the *payload* (e.g., $10k
+ *   might get reduced to $9995)
+ * - makeEvmAccount: the fee for executing the Factory contract to
+ *   create a new remote wallet
+ * - evmToNoble: the fee for running the tx to send tokens from the remote wallet
+ *   to Noble
+ * - evmToPool: the fee for sending and executing a tx on the Wallet contract
+ *   to supply tokens to a specified pool
+ * - poolToEvm: the fee for sending and executing a tx on the Wallet contract
+ *   to withdraw tokens from a specified pool
+ */
+export type FeeMode =
+  | 'toUSDN'
+  | 'makeEvmAccount'
+  | 'evmToNoble'
+  | 'evmToPool'
+  | 'poolToEvm';
 
 // Chains (hubs)
 export interface ChainSpec {

packages/portfolio-contract/src/network/network.prod.ts

@@ -58,23 +58,23 @@ export const PROD_NETWORK: NetworkSpec = {
       transfer: 'cctpReturn',
       variableFeeBps: 0,
       timeSec: 20,
-      feeMode: 'gmpTransfer',
+      feeMode: 'makeEvmAccount',
     },
     {
       src: '@noble',
       dest: '@Avalanche',
       transfer: 'cctpReturn',
       variableFeeBps: 0,
       timeSec: 20,
-      feeMode: 'gmpTransfer',
+      feeMode: 'makeEvmAccount',
     },
     {
       src: '@noble',
       dest: '@Ethereum',
       transfer: 'cctpReturn',
       variableFeeBps: 0,
       timeSec: 20,
-      feeMode: 'gmpTransfer',
+      feeMode: 'makeEvmAccount',
     },
     // Fast USDC (Axelar GMP)
     {
@@ -83,20 +83,23 @@ export const PROD_NETWORK: NetworkSpec = {
       transfer: 'fastusdc',
       variableFeeBps: 15,
       timeSec: 45,
+      feeMode: 'evmToNoble',
     },
     {
       src: '@Avalanche',
       dest: '@noble',
       transfer: 'fastusdc',
       variableFeeBps: 15,
       timeSec: 45,
+      feeMode: 'evmToNoble',
     },
     {
       src: '@Ethereum',
       dest: '@noble',
       transfer: 'fastusdc',
       variableFeeBps: 15,
       timeSec: 45,
+      feeMode: 'evmToNoble',
     },
     // IBC between agoric and noble
     { src: '@agoric', dest: '@noble', transfer: 'ibc', variableFeeBps: 0, timeSec: 10 },

packages/portfolio-contract/src/plan-solve.ts

@@ -87,6 +87,25 @@ export interface SolvedEdgeFlow {
 /** Model shape for javascript-lp-solver */
 export type LpModel = IModel<string, string>;
 
+/**
+ * Link to Factory and Wallet contracts:
+ * https://github.com/agoric-labs/agoric-to-axelar-local/blob/cd6087fa44de3b019b2cdac6962bb49b6a2bc1ca/packages/axelar-local-dev-cosmos/src/__tests__/contracts/Factory.sol
+ *
+ * Gas estimation interface -
+ *   @see {@link ../../../services/ymax-planner/src/gas-estimation.ts}
+ * - getFactoryContractEstimate: Estimate gas fees for executing the factory
+ *   contract to create a wallet on the specified chain
+ * - getReturnFeeEstimate: Estimate return fees for sending a transaction back
+ *   from the factory contract to Agoric
+ * - getWalletEstimate: Estimate gas fees for remote wallet operations on the
+ *   specified chain
+ */
+type GasEstimator = {
+  getWalletEstimate: (chainName: AxelarChain) => Promise<bigint>;
+  getFactoryContractEstimate: (chainName: AxelarChain) => Promise<bigint>;
+  getReturnFeeEstimate: (chainName: AxelarChain) => Promise<bigint>;
+};
+
 // --- keep existing type declarations above ---
 
 /**
@@ -150,26 +169,35 @@ export const buildBaseGraph = (
     const hub = `@${chainName}` as AssetPlaceRef;
     if (node === hub) continue;
 
-    const feeMode = Object.keys(AxelarChain).includes(chainName)
-      ? { feeMode: 'gmpCall' as FeeMode }
-      : {};
+    const chainIsEvm = Object.keys(AxelarChain).includes(chainName);
     const base: Omit<FlowEdge, 'src' | 'dest' | 'id'> = {
       capacity: (Number.MAX_SAFE_INTEGER + 1) / 4,
       variableFee: vf,
       fixedFee: 0,
       timeFixed: tf,
       via: 'local',
-      ...feeMode,
     };
 
-    // eslint-disable-next-line no-plusplus
-    edges.push({ id: `e${eid++}`, src: node, dest: hub, ...base });
+    edges.push({
+      // eslint-disable-next-line no-plusplus
+      id: `e${eid++}`,
+      src: node,
+      dest: hub,
+      ...base,
+      ...(chainIsEvm ? { feeMode: 'poolToEvm' } : {}),
+    });
 
     // Skip @agoric → +agoric edge
     if (node === '+agoric') continue;
 
-    // eslint-disable-next-line no-plusplus
-    edges.push({ id: `e${eid++}`, src: hub, dest: node, ...base });
+    edges.push({
+      // eslint-disable-next-line no-plusplus
+      id: `e${eid++}`,
+      src: hub,
+      dest: node,
+      ...base,
+      ...(chainIsEvm ? { feeMode: 'evmToPool' } : {}),
+    });
   }
 
   // Return mutable graph (do NOT harden so we can add inter-chain links later)
@@ -373,10 +401,11 @@ export const solveRebalance = async (
   return flows;
 };
 
-export const rebalanceMinCostFlowSteps = (
+export const rebalanceMinCostFlowSteps = async (
   flows: SolvedEdgeFlow[],
   graph: RebalanceGraph,
-): MovementDesc[] => {
+  gasEstimator: GasEstimator,
+): Promise<MovementDesc[]> => {
   const supplies = new Map(
     typedEntries(graph.supplies).filter(([_place, amount]) => amount > 0),
   );
@@ -425,37 +454,67 @@ export const rebalanceMinCostFlowSteps = (
     pendingFlows.delete(chosen.edge.id);
     lastChain = chosen.srcChain;
   }
-
-  const steps: MovementDesc[] = prioritized.map(({ edge, flow }) => {
-    Number.isSafeInteger(flow) ||
-      Fail`flow ${flow} for edge ${edge} is not a safe integer`;
-    const amount = AmountMath.make(graph.brand, BigInt(flow));
-
-    let details = {};
-    switch (edge.feeMode) {
-      case 'gmpTransfer':
-        // TODO: Rather than hard-code, derive from Axelar `estimateGasFee`.
-        // https://docs.axelar.dev/dev/axelarjs-sdk/axelar-query-api#estimategasfee
-        details = { fee: AmountMath.make(graph.feeBrand, 30_000_000n) };
-        break;
-      case 'gmpCall':
-        // TODO: Rather than hard-code, derive from Axelar `estimateGasFee`.
-        // https://docs.axelar.dev/dev/axelarjs-sdk/axelar-query-api#estimategasfee
-        details = { fee: AmountMath.make(graph.feeBrand, 30_000_000n) };
-        break;
-      case 'toUSDN': {
-        // NOTE USDN transfer incurs a fee on output amount in basis points
-        const usdnOut =
-          (BigInt(flow) * (10000n - BigInt(edge.variableFee))) / 10000n;
-        details = { detail: { usdnOut } };
-        break;
+  /**
+   * Pad each fee estimate in case the landscape changes between estimation and
+   * execution.
+   */
+  const padFeeEstimate = (estimate: bigint): bigint => estimate * 3n;
+
+  const steps: MovementDesc[] = await Promise.all(
+    prioritized.map(async ({ edge, flow }) => {
+      Number.isSafeInteger(flow) ||
+        Fail`flow ${flow} for edge ${edge} is not a safe integer`;
+      const amount = AmountMath.make(graph.brand, BigInt(flow));
+
+      await null;
+      let details = {};
+      switch (edge.feeMode) {
+        case 'makeEvmAccount': {
+          const feeValue = await gasEstimator.getFactoryContractEstimate(
+            chainOf(edge.dest) as AxelarChain,
+          );
+          details = {
+            // XXX: not using getReturnFeeEstimate until we can verify axelar
+            // API is accurate for this
+            detail: { evmGas: 200_000_000_000_000n },
+            fee: AmountMath.make(graph.feeBrand, padFeeEstimate(feeValue)),
+          };
+          break;
+        }
+        // XXX: revisit https://github.com/Agoric/agoric-sdk/pull/11953#discussion_r2383034184
+        case 'poolToEvm':
+        case 'evmToPool': {
+          const feeValue = await gasEstimator.getWalletEstimate(
+            chainOf(edge.dest) as AxelarChain,
+          );
+          details = {
+            fee: AmountMath.make(graph.feeBrand, padFeeEstimate(feeValue)),
+          };
+          break;
+        }
+        case 'evmToNoble': {
+          const feeValue = await gasEstimator.getWalletEstimate(
+            chainOf(edge.src) as AxelarChain,
+          );
+          details = {
+            fee: AmountMath.make(graph.feeBrand, padFeeEstimate(feeValue)),
+          };
+          break;
+        }
+        case 'toUSDN': {
+          // NOTE USDN transfer incurs a fee on output amount in basis points
+          const usdnOut =
+            (BigInt(flow) * (10000n - BigInt(edge.variableFee))) / 10000n;
+          details = { detail: { usdnOut } };
+          break;
+        }
+        default:
+          break;
       }
-      default:
-        break;
-    }
 
-    return { src: edge.src, dest: edge.dest, amount, ...details };
-  });
+      return { src: edge.src, dest: edge.dest, amount, ...details };
+    }),
+  );
 
   return harden(steps);
 };
@@ -476,8 +535,17 @@ export const planRebalanceFlow = async (opts: {
   brand: Amount['brand'];
   feeBrand: Amount['brand'];
   mode?: RebalanceMode;
+  gasEstimator: GasEstimator;
 }) => {
-  const { network, current, target, brand, feeBrand, mode = 'fastest' } = opts;
+  const {
+    network,
+    current,
+    target,
+    brand,
+    feeBrand,
+    mode = 'fastest',
+    gasEstimator,
+  } = opts;
   // TODO remove "automatic" values that should be static
   const graph = makeGraphFromDefinition(
     network,
@@ -497,7 +565,7 @@ export const planRebalanceFlow = async (opts: {
     preflightValidateNetworkPlan(network as any, current as any, target as any);
     throw err;
   }
-  const steps = rebalanceMinCostFlowSteps(flows, graph);
+  const steps = await rebalanceMinCostFlowSteps(flows, graph, gasEstimator);
   return harden({ graph, model, flows, steps });
 };
 

packages/portfolio-contract/src/plan-transfers.ts

@@ -119,6 +119,12 @@ export const makePortfolioSteps = async <
     '<Deposit>': deposit,
   };
 
+  const staticGasEstimator = {
+    getWalletEstimate: async () => 30_000_000n,
+    getFactoryContractEstimate: async () => 30_000_000n,
+    getReturnFeeEstimate: async () => 200_000_000_000_000n,
+  };
+
   // Run the solver to compute movement steps
   const { steps: raw } = await planRebalanceFlow({
     network: PROD_NETWORK,
@@ -127,6 +133,7 @@ export const makePortfolioSteps = async <
     brand,
     feeBrand: brand, // Use same brand for fees in this context
     mode: 'cheapest',
+    gasEstimator: staticGasEstimator,
   });
 
   // Inject USDN detail and EVM fees to match existing behavior/tests

packages/portfolio-contract/test/mocks.ts

@@ -399,3 +399,9 @@ export const gmpAddresses: GmpAddresses = harden({
     'axelar1dv4u5k73pzqrxlzujxg3qp8kvc3pje7jtdvu72npnt5zhq05ejcsn5qme5',
   AXELAR_GAS: 'axelar1aythygn6z5thymj6tmzfwekzh05ewg3l7d6y89',
 });
+
+export const gasEstimator = {
+  getWalletEstimate: async () => 10_000_000n,
+  getFactoryContractEstimate: async () => 10_000_000n,
+  getReturnFeeEstimate: async () => 200_000_000_000_000n,
+};

packages/portfolio-contract/test/network/buildGraph.test.ts

@@ -4,6 +4,7 @@ import { AmountMath } from '@agoric/ertp';
 import type { NetworkSpec } from '../../src/network/network-spec.js';
 import { makeGraphFromDefinition } from '../../src/network/buildGraph.js';
 import { planRebalanceFlow } from '../../src/plan-solve.js';
+import { gasEstimator } from '../mocks.js';
 
 const brand = Far('TestBrand') as any;
 const feeBrand = Far('TestFeeBrand') as any;
@@ -109,6 +110,7 @@ test('planRebalanceFlow uses NetworkSpec (legacy links param ignored at type lev
     brand,
     feeBrand,
     mode: 'cheapest',
+    gasEstimator,
   });
   // Ensure only the two provided inter edges (plus intra) exist, not link-derived ones
   const hubEdges = res.graph.edges.filter(

packages/portfolio-contract/test/network/test-network.ts

@@ -48,10 +48,10 @@ export const TEST_NETWORK: NetworkSpec = {
     { src: '@Avalanche', dest: '@noble', transfer: 'cctpSlow', variableFeeBps: 0, timeSec: 1080 },
     { src: '@Ethereum', dest: '@noble', transfer: 'cctpSlow', variableFeeBps: 0, timeSec: 1080 },
     // Return path
-    { src: '@noble', dest: '@Arbitrum', transfer: 'cctpReturn', variableFeeBps: 0, timeSec: 20, feeMode: 'gmpTransfer' },
-    { src: '@noble', dest: '@Polygon' as AssetPlaceRef, transfer: 'cctpReturn', variableFeeBps: 0, timeSec: 20, feeMode: 'gmpTransfer' },
-    { src: '@noble', dest: '@Avalanche', transfer: 'cctpReturn', variableFeeBps: 0, timeSec: 20, feeMode: 'gmpTransfer' },
-    { src: '@noble', dest: '@Ethereum', transfer: 'cctpReturn', variableFeeBps: 0, timeSec: 20, feeMode: 'gmpTransfer' },
+    { src: '@noble', dest: '@Arbitrum', transfer: 'cctpReturn', variableFeeBps: 0, timeSec: 20, feeMode: 'makeEvmAccount' },
+    { src: '@noble', dest: '@Polygon' as AssetPlaceRef, transfer: 'cctpReturn', variableFeeBps: 0, timeSec: 20, feeMode: 'makeEvmAccount' },
+    { src: '@noble', dest: '@Avalanche', transfer: 'cctpReturn', variableFeeBps: 0, timeSec: 20, feeMode: 'makeEvmAccount' },
+    { src: '@noble', dest: '@Ethereum', transfer: 'cctpReturn', variableFeeBps: 0, timeSec: 20, feeMode: 'makeEvmAccount' },
     // IBC agoric<->noble
     { src: '@agoric', dest: '@noble', transfer: 'ibc', variableFeeBps: 0, timeSec: 10 },
     { src: '@noble', dest: '@agoric', transfer: 'ibc', variableFeeBps: 0, timeSec: 10 },