refactor: separate planning tools from ymax contract (#11988)

## Description

### Security / Scaling / Upgrade Considerations

pure refactor; no runtime impact

### Documentation / Testing Considerations

clarifies boundaries of contract a bit

Author: dtribble

.prettierrc.json5

@@ -31,7 +31,7 @@
     {
       // Keep network definitions readable on wide lines
       files: [
-        'packages/portfolio-contract/src/network/network.prod.ts',
+        'packages/portfolio-contract/tools/network/network.prod.ts',
         'packages/portfolio-contract/test/network/test-network.ts',
       ],
       options: {

multichain-testing/scripts/ymax-tool.ts

@@ -13,7 +13,7 @@ import {
   type ProposalType,
   type TargetAllocation,
 } from '@aglocal/portfolio-contract/src/type-guards.ts';
-import { makePortfolioSteps } from '@aglocal/portfolio-contract/src/plan-transfers.ts';
+import { makePortfolioSteps } from '@aglocal/portfolio-contract/tools/plan-transfers.ts';
 import { makePortfolioQuery } from '@aglocal/portfolio-contract/tools/portfolio-actors.ts';
 import {
   axelarConfigTestnet,

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

@@ -1,10 +1,11 @@
 import test from 'ava';
 import { Far } from '@endo/marshal';
 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';
+import type { NetworkSpec } from '../../tools/network/network-spec.js';
+import { makeGraphFromDefinition } from '../../tools/network/buildGraph.js';
+import { planRebalanceFlow } from '../../tools/plan-solve.js';
 
 const brand = Far('TestBrand') as any;
 const feeBrand = Far('TestFeeBrand') as any;

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

@@ -1,7 +1,7 @@
 /* eslint-disable camelcase */
 
 import type { SupportedChain } from '@agoric/portfolio-api/src/constants.js';
-import type { NetworkSpec } from '../../src/network/network-spec.js';
+import type { NetworkSpec } from '../../tools/network/network-spec.js';
 import type { PoolKey } from '../../src/type-guards.js';
 import type { AssetPlaceRef } from '../../src/type-guards-steps.js';
 

packages/portfolio-contract/test/plan-deposit-transfers.test.ts

@@ -3,7 +3,7 @@ import { AmountMath, type Brand } from '@agoric/ertp';
 import { Far } from '@endo/pass-style';
 import type { TargetAllocation } from '@aglocal/portfolio-contract/src/type-guards.js';
 import { makeTracer } from '@agoric/internal';
-import { planDepositTransfers } from '../src/plan-transfers.ts';
+import { planDepositTransfers } from '../tools/plan-transfers.ts';
 
 const brand = Far('mock brand') as Brand<'nat'>;
 const trace = makeTracer('planDepositTransfers');

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

@@ -66,7 +66,7 @@ import {
   type ProposalType,
   type StatusFor,
 } from '../src/type-guards.ts';
-import { makePortfolioSteps } from '../src/plan-transfers.ts';
+import { makePortfolioSteps } from '../tools/plan-transfers.ts';
 import { decodeFunctionCall } from './abi-utils.ts';
 import {
   axelarIdsMock,

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

@@ -11,9 +11,9 @@ import { Far } from '@endo/marshal';
 import type {
   NetworkSpec,
   TransferProtocol,
-} from '../src/network/network-spec.js';
-import { planRebalanceFlow } from '../src/plan-solve.js';
-import type { FlowEdge, RebalanceMode } from '../src/plan-solve.js';
+} from '../tools/network/network-spec.js';
+import { planRebalanceFlow } from '../tools/plan-solve.js';
+import type { FlowEdge, RebalanceMode } from '../tools/plan-solve.js';
 import type { PoolKey } from '../src/type-guards.js';
 import type { AssetPlaceRef } from '../src/type-guards-steps.js';
 import { TEST_NETWORK } from './network/test-network.js';

packages/portfolio-contract/src/graph-diagnose.ts renamed to packages/portfolio-contract/tools/graph-diagnose.ts

@@ -8,7 +8,11 @@ import { provideLazyMap } from '@agoric/internal/src/js-utils.js';
 
 import type { NetworkSpec } from './network/network-spec.js';
 import type { RebalanceGraph, LpModel } from './plan-solve.js';
-import { PoolPlaces, type PoolKey, type PoolPlaceInfo } from './type-guards.js';
+import {
+  PoolPlaces,
+  type PoolKey,
+  type PoolPlaceInfo,
+} from '../src/type-guards.js';
 
 /**
  * Build human-readable diagnostics for infeasible models.

packages/portfolio-contract/src/jsLPSolver.md renamed to packages/portfolio-contract/tools/jsLPSolver.md

@@ -3,8 +3,8 @@ import type { NatAmount, Amount } from '@agoric/ertp/src/types.js';
 import { partialMap } from '@agoric/internal/src/js-utils.js';
 
 import { buildBaseGraph, type FlowEdge } from '../plan-solve.js';
-import { PoolPlaces, type PoolKey } from '../type-guards.js';
-import type { AssetPlaceRef } from '../type-guards-steps.js';
+import { PoolPlaces, type PoolKey } from '../../src/type-guards.js';
+import type { AssetPlaceRef } from '../../src/type-guards-steps.js';
 
 import type { NetworkSpec } from './network-spec.js';