@agoric/portfolio-api 0.2.0 → 0.2.1-upgrade-23-dev-bd79330.0.bd79330

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/portfolio-api",
-  "version": "0.2.0",
+  "version": "0.2.1-upgrade-23-dev-bd79330.0.bd79330",
   "description": "API for Portfolio management",
   "type": "module",
   "files": [
@@ -11,41 +11,36 @@
   "bin": "./src/cli/bin.js",
   "scripts": {
     "build": "exit 0",
+    "prepack": "yarn run -T prepack-package",
+    "postpack": "yarn run -T postpack-package",
     "test": "ava",
     "test:c8": "c8 --all $C8_OPTIONS ava",
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "yarn run -T run-s --continue-on-error 'lint:*'",
-    "lint:eslint": "yarn run -T eslint .",
-    "lint:types": "yarn run -T tsc"
-  },
-  "devDependencies": {
-    "@fast-check/ava": "^2.0.1",
-    "ava": "^5.3.0",
-    "c8": "^10.1.3",
-    "ts-blank-space": "^0.6.2"
+    "lint:eslint": "node ../../scripts/eslint-repo.mjs .",
+    "lint:types": "yarn run -T tsc",
+    "lint:mermaid": "npx tsx scripts/gen-mermaid.mts --check",
+    "lint:ymax-diagram": "npx tsx scripts/lint-ymax-state-diagram.mts",
+    "lint:ymax-machine": "npx tsx scripts/gen-ymax-machine.mts --check",
+    "lint:visualizer-data": "npx tsx scripts/gen-visualizer-data.mts --check",
+    "generate:ymax-machine": "npx tsx scripts/gen-ymax-machine.mts"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.2.0",
-    "@agoric/cosmic-proto": "0.5.0",
-    "@agoric/ertp": "0.17.0",
-    "@agoric/internal": "0.4.0",
-    "@agoric/notifier": "0.7.0",
-    "@agoric/orchestration": "0.2.0",
-    "@agoric/zoe": "0.27.0",
-    "@cosmjs/proto-signing": "^0.36.0",
-    "@cosmjs/stargate": "^0.36.0",
-    "@endo/base64": "^1.0.12",
+    "@agoric/internal": "0.4.1-upgrade-23-dev-bd79330.0.bd79330",
+    "@agoric/orchestration": "0.2.1-upgrade-23-dev-bd79330.0.bd79330",
     "@endo/common": "^1.2.13",
     "@endo/errors": "^1.2.13",
-    "@endo/eventual-send": "^1.3.4",
-    "@endo/far": "^1.1.14",
-    "@endo/init": "^1.1.12",
-    "@endo/marshal": "^1.8.0",
-    "@endo/nat": "^5.1.3",
-    "@endo/pass-style": "^1.6.3",
-    "@endo/patterns": "^1.7.0",
-    "@endo/promise-kit": "^1.1.13"
+    "@endo/patterns": "^1.7.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4",
+    "ajv": "^6.12.6",
+    "ava": "^6.4.1",
+    "c8": "^10.1.3",
+    "js-yaml": "^4.1.1",
+    "ts-blank-space": "^0.6.2",
+    "tsd": "^0.33.0"
   },
   "ava": {
     "extensions": {
@@ -64,6 +59,9 @@
     ],
     "timeout": "20m"
   },
+  "typeCoverage": {
+    "atLeast": 100
+  },
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
@@ -71,5 +69,5 @@
   "engines": {
     "node": "^20.9 || ^22.11"
   },
-  "gitHead": "0922d0447ab8fae9d2d87415964403330b5ca313"
+  "gitHead": "bd79330f78dae2faf9cc3d8b10063567700da07b"
 }

package/src/constants.d.ts

@@ -0,0 +1,115 @@
+/**
+ * @import {ClusterName, TypedPattern} from '@agoric/internal';
+ * @import {CaipChainId} from '@agoric/orchestration';
+ * @import {FlowConfig} from './types.js';
+ */
+/**
+ * Configuration arguments for newly-created portfolio flows.
+ *
+ * This is only a default so that existing flows continue to behave as before
+ * for replay fidelity.
+ *
+ * @type {FlowConfig | undefined}
+ */
+export const DEFAULT_FLOW_CONFIG: FlowConfig | undefined;
+/**
+ * Yield protocols for Proof of Concept.
+ */
+export type YieldProtocol = (typeof YieldProtocol)[keyof typeof YieldProtocol];
+/**
+ * Yield protocols for Proof of Concept.
+ *
+ * @enum {(typeof YieldProtocol)[keyof typeof YieldProtocol]}
+ */
+export const YieldProtocol: import("@agoric/internal").KeyMirrorResult<{
+    Aave: null;
+    Compound: null;
+    USDN: null;
+    Beefy: null;
+    ERC4626: null;
+}>;
+/**
+ * EVM chain wallet operations that incur different gas costs.
+ * Supply: user is supplying assets to a yield protocol on the target chain.
+ * Withdraw: user is withdrawing assets from a yield protocol on the target chain.
+ * DepositForBurn: user is transferring assets off the target chain via CCTP.
+ */
+export type EvmWalletOperationType = (typeof EvmWalletOperationType)[keyof typeof EvmWalletOperationType];
+export namespace EvmWalletOperationType {
+    let Supply: "supply";
+    let Withdraw: "withdraw";
+    let DepositForBurn: "depositforburn";
+}
+export type AxelarChain = (typeof AxelarChain)[keyof typeof AxelarChain];
+/**
+ * @enum {(typeof AxelarChain)[keyof typeof AxelarChain]}
+ */
+export const AxelarChain: import("@agoric/internal").KeyMirrorResult<{
+    Arbitrum: null;
+    Avalanche: null;
+    Base: null;
+    Ethereum: null;
+    Optimism: null;
+}>;
+/**
+ * cf. https://chainlist.org/
+ * XXX this probably belongs in @agoric/orchestration
+ * @type {Readonly<Record<ClusterName, Readonly<Partial<Record<AxelarChain, bigint>>>>>}
+ */
+export const Eip155ChainIds: Readonly<Record<ClusterName, Readonly<Partial<Record<AxelarChain, bigint>>>>>;
+export type SupportedChain = (typeof SupportedChain)[keyof typeof SupportedChain];
+/**
+ * @enum {(typeof SupportedChain)[keyof typeof SupportedChain]}
+ */
+export const SupportedChain: import("@agoric/internal").KeyMirrorResult<{
+    Arbitrum: "Arbitrum";
+    Avalanche: "Avalanche";
+    Base: "Base";
+    Ethereum: "Ethereum";
+    Optimism: "Optimism";
+    agoric: "agoric";
+    noble: "noble";
+}>;
+/**
+ * cf. https://standards.chainagnostic.org/CAIPs/caip-2
+ * Please keep in sync with ../../../services/ymax-planner/src/support.ts `spectrumChainIds`
+ *
+ * XXX this probably belongs in @agoric/orchestration
+ *
+ * @type {Readonly<Record<ClusterName, Readonly<Partial<Record<SupportedChain, CaipChainId>>>>>}
+ */
+export const CaipChainIds: Readonly<Record<ClusterName, Readonly<Partial<Record<SupportedChain, CaipChainId>>>>>;
+/**
+ * cf. https://developers.circle.com/stablecoins/usdc-contract-addresses
+ * XXX this might belong in @agoric/orchestration
+ * @type {Readonly<Record<ClusterName, Readonly<Partial<Record<SupportedChain, string>>>>>}
+ */
+export const UsdcTokenIds: Readonly<Record<ClusterName, Readonly<Partial<Record<SupportedChain, string>>>>>;
+/**
+ * Strategies for portfolio rebalancing of bulk deposits.
+ */
+export type RebalanceStrategy = (typeof RebalanceStrategy)[keyof typeof RebalanceStrategy];
+export namespace RebalanceStrategy {
+    let Preset: "preset";
+    let PreserveExistingProportions: "pep";
+}
+/**
+ * Treat account deltas smaller than this value (in micro-units) as dust.
+ * This corresponds to 100 uusdc, i.e., $0.0001 for USDC.
+ */
+export const ACCOUNT_DUST_EPSILON: 100n;
+/**
+ * Feature flags to handle contract upgrade flow compatibility.
+ * @type {TypedPattern<FlowConfig['features']>}
+ */
+export const FlowFeaturesShape: TypedPattern<FlowConfig["features"]>;
+/**
+ * Configuration options for flows.
+ * @type {TypedPattern<FlowConfig>}
+ */
+export const FlowConfigShape: TypedPattern<FlowConfig>;
+import type { FlowConfig } from './types.js';
+import type { ClusterName } from '@agoric/internal';
+import type { CaipChainId } from '@agoric/orchestration';
+import type { TypedPattern } from '@agoric/internal';
+//# sourceMappingURL=constants.d.ts.map

package/src/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["constants.js"],"names":[],"mappings":"AAOA;;;;GAIG;AAEH;;;;;;;GAOG;AACH,kCAFU,UAAU,GAAG,SAAS,CAO9B;;;;4BAMQ,CAAC,OAAO,aAAa,EAAE,MAAM,OAAO,aAAa,CAAC;AAH5D;;;;GAIG;AACH;;;;;;GAMG;;;;;;;qCASO,CAAC,OAAO,sBAAsB,EAAE,MAAM,OAAO,sBAAsB,CAAC;;;;;;0BAUpE,CAAC,OAAO,WAAW,EAAE,MAAM,OAAO,WAAW,CAAC;AADxD;;GAEG;AACH;;;;;;GAMG;AAGH;;;;GAIG;AACH,6BAFU,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAkBrF;6BAIQ,CAAC,OAAO,cAAc,EAAE,MAAM,OAAO,cAAc,CAAC;AAD9D;;GAEG;AACH;;;;;;;;GAWG;AAMH;;;;;;;GAOG;AACH,2BAFU,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAgB7F;AAGF;;;;GAIG;AACH,2BAFU,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAwBxF;;;;gCAMQ,CAAC,OAAO,iBAAiB,EAAE,MAAM,OAAO,iBAAiB,CAAC;;;;;AAgBpE;;;GAGG;AACH,mCAAoC,IAAI,CAAC;AAEzC;;;GAGG;AACH,gCAFU,aAAa,UAAU,CAAC,UAAU,CAAC,CAAC,CAO5C;AAEF;;;GAGG;AACH,8BAFU,aAAa,UAAU,CAAC,CAOhC;gCA5M2B,YAAY;iCAFG,kBAAkB;iCAChC,uBAAuB;kCADT,kBAAkB"}

package/src/constants.js

@@ -2,42 +2,171 @@
 
 /// <reference types="ses" />
 
+import { keyMirror } from '@agoric/internal';
+import { M, objectMap } from '@endo/patterns';
+
+/**
+ * @import {ClusterName, TypedPattern} from '@agoric/internal';
+ * @import {CaipChainId} from '@agoric/orchestration';
+ * @import {FlowConfig} from './types.js';
+ */
+
+/**
+ * Configuration arguments for newly-created portfolio flows.
+ *
+ * This is only a default so that existing flows continue to behave as before
+ * for replay fidelity.
+ *
+ * @type {FlowConfig | undefined}
+ */
+export const DEFAULT_FLOW_CONFIG = {
+  features: {
+    /** Enable ProgressTracker support in new flows. */
+    useProgressTracker: true,
+  },
+};
+harden(DEFAULT_FLOW_CONFIG);
+
 /**
  * Yield protocols for Proof of Concept.
  *
  * @enum {(typeof YieldProtocol)[keyof typeof YieldProtocol]}
  */
-export const YieldProtocol = /** @type {const} */ ({
-  Aave: 'Aave',
-  Compound: 'Compound',
-  USDN: 'USDN',
-  Beefy: 'Beefy',
+export const YieldProtocol = keyMirror({
+  Aave: null,
+  Compound: null,
+  USDN: null,
+  Beefy: null,
+  ERC4626: null,
 });
 harden(YieldProtocol);
 
+/**
+ * EVM chain wallet operations that incur different gas costs.
+ * Supply: user is supplying assets to a yield protocol on the target chain.
+ * Withdraw: user is withdrawing assets from a yield protocol on the target chain.
+ * DepositForBurn: user is transferring assets off the target chain via CCTP.
+ *
+ * @enum {(typeof EvmWalletOperationType)[keyof typeof EvmWalletOperationType]}
+ */
+export const EvmWalletOperationType = /** @type {const} */ ({
+  Supply: 'supply',
+  Withdraw: 'withdraw',
+  DepositForBurn: 'depositforburn',
+});
+harden(EvmWalletOperationType);
+
 /**
  * @enum {(typeof AxelarChain)[keyof typeof AxelarChain]}
  */
-export const AxelarChain = /** @type {const} */ ({
-  Avalanche: 'Avalanche',
-  Arbitrum: 'Arbitrum',
-  Optimism: 'Optimism',
-  Polygon: 'Polygon',
-  Ethereum: 'Ethereum',
+export const AxelarChain = keyMirror({
+  Arbitrum: null,
+  Avalanche: null,
+  Base: null,
+  Ethereum: null,
+  Optimism: null,
 });
 harden(AxelarChain);
 
+/**
+ * cf. https://chainlist.org/
+ * XXX this probably belongs in @agoric/orchestration
+ * @type {Readonly<Record<ClusterName, Readonly<Partial<Record<AxelarChain, bigint>>>>>}
+ */
+export const Eip155ChainIds = {
+  mainnet: {
+    Arbitrum: 42161n,
+    Avalanche: 43114n,
+    Base: 8453n,
+    Ethereum: 1n,
+    Optimism: 10n,
+  },
+  testnet: {
+    Arbitrum: 421614n, // Sepolia
+    Avalanche: 43113n, // Fuji
+    Base: 84532n, // Sepolia
+    Ethereum: 11155111n, // Sepolia
+    Optimism: 11155420n, // Sepolia
+  },
+  local: {},
+};
+harden(Eip155ChainIds);
+
 /**
  * @enum {(typeof SupportedChain)[keyof typeof SupportedChain]}
  */
-export const SupportedChain = /** @type {const} */ ({
-  ...AxelarChain,
+export const SupportedChain = keyMirror({
+  // ...AxelarChain works locally but gets lost in .d.ts generation
+  Arbitrum: 'Arbitrum',
+  Avalanche: 'Avalanche',
+  Base: 'Base',
+  Ethereum: 'Ethereum',
+  Optimism: 'Optimism',
+  // Unique to this object
   agoric: 'agoric',
   noble: 'noble',
   // XXX: check privateArgs for chainInfo for all of these
 });
 harden(SupportedChain);
 
+/** @type {(eip155ChainId: bigint) => CaipChainId} */
+const caipChainIdFromEip155 = chainId => `eip155:${chainId}`;
+
+/**
+ * cf. https://standards.chainagnostic.org/CAIPs/caip-2
+ * Please keep in sync with ../../../services/ymax-planner/src/support.ts `spectrumChainIds`
+ *
+ * XXX this probably belongs in @agoric/orchestration
+ *
+ * @type {Readonly<Record<ClusterName, Readonly<Partial<Record<SupportedChain, CaipChainId>>>>>}
+ */
+export const CaipChainIds = {
+  mainnet: {
+    ...objectMap(Eip155ChainIds.mainnet, caipChainIdFromEip155),
+    agoric: 'cosmos:agoric-3',
+    noble: 'cosmos:noble-1',
+  },
+  testnet: {
+    ...objectMap(Eip155ChainIds.testnet, caipChainIdFromEip155),
+    agoric: 'cosmos:agoricdev-25',
+    noble: 'cosmos:grand-1',
+  },
+  local: {
+    ...objectMap(Eip155ChainIds.local, caipChainIdFromEip155),
+  },
+};
+harden(CaipChainIds);
+
+/**
+ * cf. https://developers.circle.com/stablecoins/usdc-contract-addresses
+ * XXX this might belong in @agoric/orchestration
+ * @type {Readonly<Record<ClusterName, Readonly<Partial<Record<SupportedChain, string>>>>>}
+ */
+export const UsdcTokenIds = {
+  mainnet: {
+    Arbitrum: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831',
+    Avalanche: '0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E',
+    Base: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
+    Ethereum: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+    Optimism: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85',
+    agoric:
+      'ibc/FE98AAD68F02F03565E9FA39A5E627946699B2B07115889ED812D8BA639576A9',
+    noble: 'usdc',
+  },
+  testnet: {
+    Arbitrum: '0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d', // Sepolia
+    Avalanche: '0x5425890298aed601595a70AB815c96711a31Bc65', // Fuji
+    Base: '0x036CbD53842c5426634e7929541eC2318f3dCF7e', // Sepolia
+    Ethereum: '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238', // Sepolia
+    Optimism: '0x5fd84259d66Cd46123540766Be93DFE6D43130D7', // Sepolia
+    agoric:
+      'ibc/75F84596DDE9EE93010620701FFED959F3FFA1D0979F6773DE994FFEEA7D32F3',
+    noble: 'usdc',
+  },
+  local: {},
+};
+harden(UsdcTokenIds);
+
 /**
  * Strategies for portfolio rebalancing of bulk deposits.
  *
@@ -56,3 +185,31 @@ export const RebalanceStrategy = /** @type {const} */ ({
   PreserveExistingProportions: 'pep',
 });
 harden(RebalanceStrategy);
+
+/**
+ * Treat account deltas smaller than this value (in micro-units) as dust.
+ * This corresponds to 100 uusdc, i.e., $0.0001 for USDC.
+ */
+export const ACCOUNT_DUST_EPSILON = 100n;
+
+/**
+ * Feature flags to handle contract upgrade flow compatibility.
+ * @type {TypedPattern<FlowConfig['features']>}
+ */
+export const FlowFeaturesShape = M.splitRecord(
+  {},
+  {
+    useProgressTracker: M.boolean(),
+  },
+);
+
+/**
+ * Configuration options for flows.
+ * @type {TypedPattern<FlowConfig>}
+ */
+export const FlowConfigShape = M.splitRecord(
+  {},
+  {
+    features: FlowFeaturesShape,
+  },
+);

package/src/evm/types.d.ts

@@ -0,0 +1,19 @@
+import type { PureData } from '@endo/pass-style';
+export type PortfolioPath = `published.ymax${0 | 1}.portfolios.portfolio${number}`;
+type EIPCommonMessageUpdate = {
+    updated: 'messageUpdate';
+    nonce: bigint;
+    deadline: bigint;
+};
+export type EIPMessageUpdate = EIPCommonMessageUpdate & ({
+    status: 'pending';
+} | {
+    status: 'error';
+    error: string;
+} | {
+    status: 'ok';
+    result: PureData;
+});
+export type EVMWalletUpdate = EIPMessageUpdate | never;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/src/evm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,MAAM,MAAM,aAAa,GACvB,iBAAiB,CAAC,GAAG,CAAC,wBAAwB,MAAM,EAAE,CAAC;AAEzD,KAAK,sBAAsB,GAAG;IAC5B,OAAO,EAAE,eAAe,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GACnD,CACI;IACE,MAAM,EAAE,SAAS,CAAC;CACnB,GACD;IACE,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,GACD;IACE,MAAM,EAAE,IAAI,CAAC;IACb,MAAM,EAAE,QAAQ,CAAC;CAClB,CACJ,CAAC;AAEJ,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG,KAAK,CAAC"}

package/src/evm/types.js

@@ -0,0 +1,27 @@
+                                                 
+
+                           
+                                                         
+
+                               
+                           
+                
+                   
+  
+
+                                                       
+   
+       
+                          
+       
+       
+                        
+                      
+       
+       
+                     
+                         
+       
+    
+
+