@agoric/portfolio-api 0.1.1-other-dev-fbe72e7.0.fbe72e7 → 0.1.1-other-dev-d15096d.0.d15096d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/portfolio-api",
-  "version": "0.1.1-other-dev-fbe72e7.0.fbe72e7",
+  "version": "0.1.1-other-dev-d15096d.0.d15096d",
   "description": "API for Portfolio management",
   "type": "module",
   "files": [
@@ -11,6 +11,8 @@
   "bin": "./src/cli/bin.js",
   "scripts": {
     "build": "exit 0",
+    "prepack": "yarn run -T tsc --build tsconfig.build.json",
+    "postpack": "git clean -f '*.d.*ts*' '*.tsbuildinfo'",
     "test": "ava",
     "test:c8": "c8 --all $C8_OPTIONS ava",
     "test:xs": "exit 0",
@@ -19,33 +21,16 @@
     "lint:eslint": "yarn run -T eslint .",
     "lint:types": "yarn run -T tsc"
   },
+  "dependencies": {
+    "@agoric/orchestration": "0.1.1-other-dev-d15096d.0.d15096d",
+    "@endo/common": "^1.2.13"
+  },
   "devDependencies": {
-    "@fast-check/ava": "^2.0.1",
+    "@agoric/internal": "0.3.3-other-dev-d15096d.0.d15096d",
     "ava": "^5.3.0",
     "c8": "^10.1.3",
-    "ts-blank-space": "^0.6.2"
-  },
-  "dependencies": {
-    "@agoric/client-utils": "0.1.1-other-dev-fbe72e7.0.fbe72e7",
-    "@agoric/cosmic-proto": "0.4.1-other-dev-fbe72e7.0.fbe72e7",
-    "@agoric/ertp": "0.16.3-other-dev-fbe72e7.0.fbe72e7",
-    "@agoric/internal": "0.3.3-other-dev-fbe72e7.0.fbe72e7",
-    "@agoric/notifier": "0.6.3-other-dev-fbe72e7.0.fbe72e7",
-    "@agoric/orchestration": "0.1.1-other-dev-fbe72e7.0.fbe72e7",
-    "@agoric/zoe": "0.26.3-other-dev-fbe72e7.0.fbe72e7",
-    "@cosmjs/proto-signing": "^0.36.0",
-    "@cosmjs/stargate": "^0.36.0",
-    "@endo/base64": "^1.0.12",
-    "@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"
+    "ts-blank-space": "^0.6.2",
+    "tsd": "^0.33.0"
   },
   "ava": {
     "extensions": {
@@ -71,5 +56,5 @@
   "engines": {
     "node": "^20.9 || ^22.11"
   },
-  "gitHead": "fbe72e72107f9997f788674e668c660d92ec4492"
+  "gitHead": "d15096dc4ff8b96e9b6cd11954c20d3a9efbb393"
 }

package/src/constants.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Yield protocols for Proof of Concept.
+ */
+export type YieldProtocol = (typeof YieldProtocol)[keyof typeof YieldProtocol];
+export namespace YieldProtocol {
+    let Aave: "Aave";
+    let Compound: "Compound";
+    let USDN: "USDN";
+    let Beefy: "Beefy";
+}
+/**
+ * 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];
+export namespace AxelarChain {
+    let Arbitrum: "Arbitrum";
+    let Avalanche: "Avalanche";
+    let Base: "Base";
+    let Ethereum: "Ethereum";
+    let Optimism: "Optimism";
+}
+/**
+ * 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];
+export namespace SupportedChain {
+    let Arbitrum_1: "Arbitrum";
+    export { Arbitrum_1 as Arbitrum };
+    let Avalanche_1: "Avalanche";
+    export { Avalanche_1 as Avalanche };
+    let Base_1: "Base";
+    export { Base_1 as Base };
+    let Ethereum_1: "Ethereum";
+    export { Ethereum_1 as Ethereum };
+    let Optimism_1: "Optimism";
+    export { Optimism_1 as Optimism };
+    export let agoric: "agoric";
+    export let noble: "noble";
+}
+/**
+ * cf. https://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;
+import type { ClusterName } from '@agoric/internal';
+import type { CaipChainId } from '@agoric/orchestration';
+//# 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":";;;4BAYU,CAAC,OAAO,aAAa,EAAE,MAAM,OAAO,aAAa,CAAC;;;;;;;;;;;;;qCAgBlD,CAAC,OAAO,sBAAsB,EAAE,MAAM,OAAO,sBAAsB,CAAC;;;;;;0BAUpE,CAAC,OAAO,WAAW,EAAE,MAAM,OAAO,WAAW,CAAC;;;;;;;;AAWxD;;;;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;;;;;;;;;;;;;;;AAmB9D;;;;;;;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;iCArKV,kBAAkB;iCAClB,uBAAuB"}

package/src/constants.js

@@ -2,6 +2,11 @@
 
 /// <reference types="ses" />
 
+import { objectMap } from '@endo/common/object-map.js';
+
+/** @import {ClusterName} from '@agoric/internal'; */
+/** @import {CaipChainId} from '@agoric/orchestration'; */
+
 /**
  * Yield protocols for Proof of Concept.
  *
@@ -15,29 +20,132 @@ export const YieldProtocol = /** @type {const} */ ({
 });
 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',
+  Avalanche: 'Avalanche',
+  Base: 'Base',
   Ethereum: 'Ethereum',
+  Optimism: 'Optimism',
 });
 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,
+  // ...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://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 +164,9 @@ 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;

package/src/instruments.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Mnemonic IDs for supported financial instruments in which a portfolio can use
+ * assets to take a position.
+ *
+ * Treat these identifers as opaque strings. There are separate data structures
+ * to map them to functional interfaces for interoperation.
+ */
+export type InstrumentId = (typeof InstrumentId)[keyof typeof InstrumentId];
+export namespace InstrumentId {
+    let Aave_Arbitrum: "Aave_Arbitrum";
+    let Aave_Avalanche: "Aave_Avalanche";
+    let Aave_Base: "Aave_Base";
+    let Aave_Ethereum: "Aave_Ethereum";
+    let Aave_Optimism: "Aave_Optimism";
+    let Beefy_compoundUsdc_Arbitrum: "Beefy_compoundUsdc_Arbitrum";
+    let Beefy_compoundUsdc_Optimism: "Beefy_compoundUsdc_Optimism";
+    let Beefy_morphoGauntletUsdc_Ethereum: "Beefy_morphoGauntletUsdc_Ethereum";
+    let Beefy_morphoSeamlessUsdc_Base: "Beefy_morphoSeamlessUsdc_Base";
+    let Beefy_morphoSmokehouseUsdc_Ethereum: "Beefy_morphoSmokehouseUsdc_Ethereum";
+    let Beefy_re7_Avalanche: "Beefy_re7_Avalanche";
+    let Compound_Arbitrum: "Compound_Arbitrum";
+    let Compound_Base: "Compound_Base";
+    let Compound_Ethereum: "Compound_Ethereum";
+    let Compound_Optimism: "Compound_Optimism";
+    let USDN: "USDN";
+    let USDNVault: "USDNVault";
+}
+//# sourceMappingURL=instruments.d.ts.map

package/src/instruments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instruments.d.ts","sourceRoot":"","sources":["instruments.js"],"names":[],"mappings":";;;;;;;2BAOU,CAAC,OAAO,YAAY,EAAE,MAAM,OAAO,YAAY,CAAC"}

package/src/instruments.js

@@ -0,0 +1,29 @@
+/**
+ * Mnemonic IDs for supported financial instruments in which a portfolio can use
+ * assets to take a position.
+ *
+ * Treat these identifers as opaque strings. There are separate data structures
+ * to map them to functional interfaces for interoperation.
+ *
+ * @enum {(typeof InstrumentId)[keyof typeof InstrumentId]}
+ */
+export const InstrumentId = /** @type {const} */ ({
+  Aave_Arbitrum: 'Aave_Arbitrum',
+  Aave_Avalanche: 'Aave_Avalanche',
+  Aave_Base: 'Aave_Base',
+  Aave_Ethereum: 'Aave_Ethereum',
+  Aave_Optimism: 'Aave_Optimism',
+  Beefy_compoundUsdc_Arbitrum: 'Beefy_compoundUsdc_Arbitrum',
+  Beefy_compoundUsdc_Optimism: 'Beefy_compoundUsdc_Optimism',
+  Beefy_morphoGauntletUsdc_Ethereum: 'Beefy_morphoGauntletUsdc_Ethereum',
+  Beefy_morphoSeamlessUsdc_Base: 'Beefy_morphoSeamlessUsdc_Base',
+  Beefy_morphoSmokehouseUsdc_Ethereum: 'Beefy_morphoSmokehouseUsdc_Ethereum',
+  Beefy_re7_Avalanche: 'Beefy_re7_Avalanche',
+  Compound_Arbitrum: 'Compound_Arbitrum',
+  Compound_Base: 'Compound_Base',
+  Compound_Ethereum: 'Compound_Ethereum',
+  Compound_Optimism: 'Compound_Optimism',
+  USDN: 'USDN',
+  USDNVault: 'USDNVault',
+});
+harden(InstrumentId);

package/src/main.d.ts

@@ -0,0 +1,5 @@
+export * from "./constants.js";
+export * from "./instruments.js";
+export * from "./resolver.js";
+export * from "./types-index.js";
+//# sourceMappingURL=main.d.ts.map

package/src/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["main.js"],"names":[],"mappings":""}

package/src/main.js

@@ -1,2 +1,6 @@
 export * from './constants.js';
-export * from './types.js';
+export * from './instruments.js';
+export * from './resolver.js';
+
+// eslint-disable-next-line import/export -- just types
+export * from './types-index.js';

package/src/resolver.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Tx statuses for published transactions. Exhaustive state machine flows:
+ *   - pending -> success (when cross-chain operation completes successfully)
+ *   - pending -> failed (when operation fails or times out)
+ */
+export type TxStatus = (typeof TxStatus)[keyof typeof TxStatus];
+export namespace TxStatus {
+    let PENDING: "pending";
+    let SUCCESS: "success";
+    let FAILED: "failed";
+}
+/**
+ * Tx types for published transactions
+ */
+export type TxType = (typeof TxType)[keyof typeof TxType];
+export namespace TxType {
+    let CCTP_TO_EVM: "CCTP_TO_EVM";
+    let GMP: "GMP";
+    let CCTP_TO_AGORIC: "CCTP_TO_AGORIC";
+}
+/**
+ * Represents a published transaction with its type, optional amount, destination, and status.
+ */
+export type PublishedTx = {
+    /**
+     * - The type of transaction (CCTP_TO_EVM, GMP or CCTP_TO_AGORIC)
+     */
+    type: TxType;
+    /**
+     * - Optional transaction amount as a bigint
+     */
+    amount?: bigint | undefined;
+    /**
+     * - The destination account identifier for the transaction
+     */
+    destinationAddress: AccountId;
+    /**
+     * - Current status of the transaction (pending, success, or failed)
+     */
+    status: TxStatus;
+};
+import type { AccountId } from '@agoric/orchestration';
+//# sourceMappingURL=resolver.d.ts.map

package/src/resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.d.ts","sourceRoot":"","sources":["resolver.js"],"names":[],"mappings":";;;;;uBAmBU,CAAC,OAAO,QAAQ,EAAE,MAAM,OAAO,QAAQ,CAAC;;;;;;;;;qBAYxC,CAAC,OAAO,MAAM,EAAE,MAAM,OAAO,MAAM,CAAC;;;;;;;;;;;;;UAvBhC,MAAM;;;;;;;;wBAEN,SAAS;;;;YACT,QAAQ;;+BAVM,uBAAuB"}

package/src/resolver.js

@@ -0,0 +1,39 @@
+/**
+ * @import {AccountId} from '@agoric/orchestration';
+ */
+
+/**
+ * Represents a published transaction with its type, optional amount, destination, and status.
+ *
+ * @typedef {object} PublishedTx
+ * @property {TxType} type - The type of transaction (CCTP_TO_EVM, GMP or CCTP_TO_AGORIC)
+ * @property {bigint} [amount] - Optional transaction amount as a bigint
+ * @property {AccountId} destinationAddress - The destination account identifier for the transaction
+ * @property {TxStatus} status - Current status of the transaction (pending, success, or failed)
+ */
+
+/**
+ * Tx statuses for published transactions. Exhaustive state machine flows:
+ *   - pending -> success (when cross-chain operation completes successfully)
+ *   - pending -> failed (when operation fails or times out)
+ *
+ * @enum {(typeof TxStatus)[keyof typeof TxStatus]}
+ */
+export const TxStatus = /** @type {const} */ ({
+  PENDING: 'pending',
+  SUCCESS: 'success',
+  FAILED: 'failed',
+});
+harden(TxStatus);
+
+/**
+ * Tx types for published transactions
+ *
+ * @enum {(typeof TxType)[keyof typeof TxType]}
+ */
+export const TxType = /** @type {const} */ ({
+  CCTP_TO_EVM: 'CCTP_TO_EVM',
+  GMP: 'GMP',
+  CCTP_TO_AGORIC: 'CCTP_TO_AGORIC',
+});
+harden(TxType);

package/src/type-guards.d.ts

@@ -0,0 +1,10 @@
+import type { InterChainAccountRef, LocalChainAccountRef } from './types.js';
+/**
+ * Does it match the pattern, without regard to supported chains.
+ */
+export declare const isLocalChainAccountRef: (ref: string) => ref is LocalChainAccountRef;
+/**
+ * Does it match the pattern, without regard to supported chains.
+ */
+export declare const isInterChainAccountRef: (ref: string) => ref is InterChainAccountRef;
+//# sourceMappingURL=type-guards.d.ts.map

package/src/type-guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,sBAAsB,GACjC,KAAK,MAAM,KACV,GAAG,IAAI,oBAA2C,CAAC;AAGtD;;GAEG;AACH,eAAO,MAAM,sBAAsB,GACjC,KAAK,MAAM,KACV,GAAG,IAAI,oBAA2C,CAAC"}

package/src/type-guards.ts

@@ -0,0 +1,17 @@
+import type { InterChainAccountRef, LocalChainAccountRef } from './types.js';
+
+/**
+ * Does it match the pattern, without regard to supported chains.
+ */
+export const isLocalChainAccountRef = (
+  ref: string,
+): ref is LocalChainAccountRef => ref.startsWith('+');
+harden(isLocalChainAccountRef);
+
+/**
+ * Does it match the pattern, without regard to supported chains.
+ */
+export const isInterChainAccountRef = (
+  ref: string,
+): ref is InterChainAccountRef => ref.startsWith('@');
+harden(isInterChainAccountRef);

package/src/types.d.ts

@@ -0,0 +1,162 @@
+import type { NatAmount } from '@agoric/ertp';
+import { type AccountId, type Bech32Address, type CosmosChainAddress } from '@agoric/orchestration';
+import type { SupportedChain, YieldProtocol } from './constants.js';
+import type { InstrumentId } from './instruments.js';
+import type { PublishedTx } from './resolver.js';
+export type SeatKeyword = 'Cash' | 'Deposit';
+/**
+ * Reference to a local chain accounts (LCA).
+ * '+agoric' is published as `depositAddress`
+ */
+export type LocalChainAccountRef = '+agoric';
+export type InterChainAccountRef = `@${SupportedChain}`;
+export type AssetPlaceRef = `<${SeatKeyword}>` | LocalChainAccountRef | InterChainAccountRef | InstrumentId;
+type Empty = Record<never, NatAmount>;
+/**
+ * Proposal shapes for portfolio operations.
+ *
+ * **openPortfolio**: Create portfolio with initial funding across protocols
+ * **rebalance**: Add funds (give) or withdraw funds (want) from protocols
+ */
+export type ProposalType = {
+    openPortfolio: {
+        give: {
+            /** required iff the contract was started with an Access issuer */
+            Access?: NatAmount;
+            Deposit?: NatAmount;
+        };
+        want?: Empty;
+    };
+    rebalance: {
+        give: {
+            Deposit?: NatAmount;
+        };
+        want: Empty;
+    } | {
+        want: {
+            Cash: NatAmount;
+        };
+        give: Empty;
+    };
+    withdraw: {
+        want: {
+            Cash: NatAmount;
+        };
+        give: Empty;
+    };
+    deposit: {
+        give: {
+            Deposit: NatAmount;
+        };
+        want: Empty;
+    };
+};
+/**
+ * Target allocation mapping from PoolKey to numerator (typically in basis points).
+ * Denominator is implicitly the sum of all numerators.
+ */
+export type TargetAllocation = Partial<Record<InstrumentId, bigint>>;
+export type FlowDetail = {
+    type: 'withdraw';
+    amount: NatAmount;
+} | {
+    type: 'deposit';
+    amount: NatAmount;
+} | {
+    type: 'rebalance';
+};
+/** linked list of concurrent failures, including dependencies */
+export type FlowErrors = {
+    step: number;
+    how: string;
+    error: string;
+    next?: FlowErrors;
+};
+export type FlowStatus = {
+    state: 'run';
+    /** minimum currently running step */
+    step: number;
+    how: string;
+    /** currently running steps, when executing concurrently */
+    steps?: number[];
+}
+/** @deprecated - contract no longer does automatic recovery */
+ | {
+    state: 'undo';
+    step: number;
+    how: string;
+} | {
+    state: 'done';
+} | ({
+    state: 'fail';
+} & FlowErrors);
+export type MovementDesc = {
+    amount: NatAmount;
+    src: AssetPlaceRef;
+    dest: AssetPlaceRef;
+    /** for example: GMP fee */
+    fee?: NatAmount;
+    /** for example: { usdnOut: 98n } */
+    detail?: Record<string, bigint>;
+    claim?: boolean;
+};
+export type FlowStep = {
+    how: string;
+    amount: NatAmount;
+    src: AssetPlaceRef;
+    dest: AssetPlaceRef;
+};
+export type FundsFlowPlan = {
+    flow: MovementDesc[];
+    /** default to full order */
+    order?: [target: number, prereqs: number[]][];
+};
+export type PortfolioKey = `portfolio${number}`;
+export type FlowKey = `flow${number}`;
+export type StatusFor = {
+    contract: {
+        contractAccount: CosmosChainAddress['value'];
+    };
+    pendingTx: PublishedTx;
+    portfolios: {
+        addPortfolio: PortfolioKey;
+    };
+    portfolio: {
+        positionKeys: InstrumentId[];
+        accountIdByChain: Partial<Record<SupportedChain, AccountId>>;
+        accountsPending?: SupportedChain[];
+        depositAddress?: Bech32Address;
+        /** Noble Forwarding Address (NFA) registered by the contract for the `@agoric` address */
+        nobleForwardingAddress?: Bech32Address;
+        targetAllocation?: TargetAllocation;
+        /** incremented by the contract every time the user sends a transaction that the planner should respond to */
+        policyVersion: number;
+        /** the count of acknowledged submissions [from the planner] associated with the current policyVersion */
+        rebalanceCount: number;
+        /** @deprecated in favor of flowsRunning */
+        flowCount: number;
+        flowsRunning?: Record<FlowKey, FlowDetail>;
+    };
+    position: {
+        protocol: YieldProtocol;
+        accountId: AccountId;
+        totalIn: NatAmount;
+        totalOut: NatAmount;
+    };
+    flow: FlowStatus & FlowDetail;
+    flowSteps: FlowStep[];
+    flowOrder: FundsFlowPlan['order'];
+};
+/**
+ * Names suitable for use as `publicInvitationMaker` in {@link ContractInvitationSpec}.
+ */
+export type PortfolioPublicInvitationMaker = 'makeOpenPortfolioInvitation';
+/**
+ * Names suitable for use as `invitationMakerName` in {@link ContinuingInvitationSpec}.
+ *
+ * These continuing invitation makers are returned from portfolio creation and enable
+ * ongoing operations like rebalancing between yield protocols.
+ */
+export type PortfolioContinuingInvitationMaker = 'Deposit' | 'Withdraw' | 'Rebalance' | 'SimpleRebalance';
+export {};
+//# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EACL,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACxB,MAAM,uBAAuB,CAAC;AAK/B,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAC;AAE7C,MAAM,MAAM,oBAAoB,GAAG,IAAI,cAAc,EAAE,CAAC;AAExD,MAAM,MAAM,aAAa,GACrB,IAAI,WAAW,GAAG,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,YAAY,CAAC;AAEjB,KAAK,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,aAAa,EAAE;QACb,IAAI,EAAE;YACJ,kEAAkE;YAClE,MAAM,CAAC,EAAE,SAAS,CAAC;YACnB,OAAO,CAAC,EAAE,SAAS,CAAC;SACrB,CAAC;QACF,IAAI,CAAC,EAAE,KAAK,CAAC;KACd,CAAC;IACF,SAAS,EACL;QAAE,IAAI,EAAE;YAAE,OAAO,CAAC,EAAE,SAAS,CAAA;SAAE,CAAC;QAAC,IAAI,EAAE,KAAK,CAAA;KAAE,GAC9C;QAAE,IAAI,EAAE;YAAE,IAAI,EAAE,SAAS,CAAA;SAAE,CAAC;QAAC,IAAI,EAAE,KAAK,CAAA;KAAE,CAAC;IAC/C,QAAQ,EAAE;QAAE,IAAI,EAAE;YAAE,IAAI,EAAE,SAAS,CAAA;SAAE,CAAC;QAAC,IAAI,EAAE,KAAK,CAAA;KAAE,CAAC;IACrD,OAAO,EAAE;QAAE,IAAI,EAAE;YAAE,OAAO,EAAE,SAAS,CAAA;SAAE,CAAC;QAAC,IAAI,EAAE,KAAK,CAAA;KAAE,CAAC;CACxD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;AAErE,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,GACtC;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC;AAE1B,iEAAiE;AACjE,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,UAAU,GAClB;IACE,KAAK,EAAE,KAAK,CAAC;IACb,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,2DAA2D;IAC3D,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AACH,+DAA+D;GAC7D;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC5C;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GACjB,CAAC;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,UAAU,CAAC,CAAC;AAErC,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,SAAS,CAAC;IAClB,GAAG,EAAE,aAAa,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,2BAA2B;IAC3B,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,SAAS,CAAC;IAClB,GAAG,EAAE,aAAa,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;CAErB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,YAAY,EAAE,CAAC;IACrB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,YAAY,MAAM,EAAE,CAAC;AAChD,MAAM,MAAM,OAAO,GAAG,OAAO,MAAM,EAAE,CAAC;AAEtC,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE;QACR,eAAe,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;KAC9C,CAAC;IACF,SAAS,EAAE,WAAW,CAAC;IACvB,UAAU,EAAE;QACV,YAAY,EAAE,YAAY,CAAC;KAC5B,CAAC;IACF,SAAS,EAAE;QACT,YAAY,EAAE,YAAY,EAAE,CAAC;QAC7B,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC;QAC7D,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;QACnC,cAAc,CAAC,EAAE,aAAa,CAAC;QAC/B,0FAA0F;QAC1F,sBAAsB,CAAC,EAAE,aAAa,CAAC;QACvC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;QACpC,6GAA6G;QAC7G,aAAa,EAAE,MAAM,CAAC;QACtB,yGAAyG;QACzG,cAAc,EAAE,MAAM,CAAC;QACvB,2CAA2C;QAC3C,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;KAC5C,CAAC;IACF,QAAQ,EAAE;QACR,QAAQ,EAAE,aAAa,CAAC;QACxB,SAAS,EAAE,SAAS,CAAC;QACrB,OAAO,EAAE,SAAS,CAAC;QACnB,QAAQ,EAAE,SAAS,CAAC;KACrB,CAAC;IACF,IAAI,EAAE,UAAU,GAAG,UAAU,CAAC;IAC9B,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,SAAS,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,6BAA6B,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAC1C,SAAS,GACT,UAAU,GACV,WAAW,GACX,iBAAiB,CAAC"}

package/src/types.ts

@@ -1 +1,167 @@
-export type * from './constants.js';
+/* eslint-disable @typescript-eslint/no-unused-vars -- doesn't see type usage in JSDoc */
+import type { NatAmount } from '@agoric/ertp';
+import {
+  type AccountId,
+  type Bech32Address,
+  type CosmosChainAddress,
+} from '@agoric/orchestration';
+import type {
+  ContinuingInvitationSpec,
+  ContractInvitationSpec,
+} from '@agoric/smart-wallet/src/invitations.js';
+import type { SupportedChain, YieldProtocol } from './constants.js';
+import type { InstrumentId } from './instruments.js';
+import type { PublishedTx } from './resolver.js';
+
+export type SeatKeyword = 'Cash' | 'Deposit';
+
+/**
+ * Reference to a local chain accounts (LCA).
+ * '+agoric' is published as `depositAddress`
+ */
+export type LocalChainAccountRef = '+agoric';
+
+export type InterChainAccountRef = `@${SupportedChain}`;
+
+export type AssetPlaceRef =
+  | `<${SeatKeyword}>`
+  | LocalChainAccountRef
+  | InterChainAccountRef
+  | InstrumentId;
+
+type Empty = Record<never, NatAmount>;
+
+/**
+ * Proposal shapes for portfolio operations.
+ *
+ * **openPortfolio**: Create portfolio with initial funding across protocols
+ * **rebalance**: Add funds (give) or withdraw funds (want) from protocols
+ */
+export type ProposalType = {
+  openPortfolio: {
+    give: {
+      /** required iff the contract was started with an Access issuer */
+      Access?: NatAmount;
+      Deposit?: NatAmount;
+    };
+    want?: Empty;
+  };
+  rebalance:
+    | { give: { Deposit?: NatAmount }; want: Empty }
+    | { want: { Cash: NatAmount }; give: Empty };
+  withdraw: { want: { Cash: NatAmount }; give: Empty };
+  deposit: { give: { Deposit: NatAmount }; want: Empty };
+};
+
+/**
+ * Target allocation mapping from PoolKey to numerator (typically in basis points).
+ * Denominator is implicitly the sum of all numerators.
+ */
+export type TargetAllocation = Partial<Record<InstrumentId, bigint>>;
+
+export type FlowDetail =
+  | { type: 'withdraw'; amount: NatAmount }
+  | { type: 'deposit'; amount: NatAmount }
+  | { type: 'rebalance' }; // aka simpleRebalance
+
+/** linked list of concurrent failures, including dependencies */
+export type FlowErrors = {
+  step: number;
+  how: string;
+  error: string;
+  next?: FlowErrors;
+};
+
+export type FlowStatus =
+  | {
+      state: 'run';
+      /** minimum currently running step */
+      step: number;
+      how: string;
+      /** currently running steps, when executing concurrently */
+      steps?: number[];
+    }
+  /** @deprecated - contract no longer does automatic recovery */
+  | { state: 'undo'; step: number; how: string }
+  | { state: 'done' }
+  | ({ state: 'fail' } & FlowErrors);
+
+export type MovementDesc = {
+  amount: NatAmount;
+  src: AssetPlaceRef;
+  dest: AssetPlaceRef;
+  /** for example: GMP fee */
+  fee?: NatAmount;
+  /** for example: { usdnOut: 98n } */
+  detail?: Record<string, bigint>;
+  claim?: boolean;
+};
+
+export type FlowStep = {
+  how: string;
+  amount: NatAmount;
+  src: AssetPlaceRef;
+  dest: AssetPlaceRef;
+  // XXX all parts: fee etc.
+};
+
+export type FundsFlowPlan = {
+  flow: MovementDesc[];
+  /** default to full order */
+  order?: [target: number, prereqs: number[]][];
+};
+
+export type PortfolioKey = `portfolio${number}`;
+export type FlowKey = `flow${number}`;
+
+export type StatusFor = {
+  contract: {
+    contractAccount: CosmosChainAddress['value'];
+  };
+  pendingTx: PublishedTx;
+  portfolios: {
+    addPortfolio: PortfolioKey;
+  };
+  portfolio: {
+    positionKeys: InstrumentId[];
+    accountIdByChain: Partial<Record<SupportedChain, AccountId>>;
+    accountsPending?: SupportedChain[];
+    depositAddress?: Bech32Address;
+    /** Noble Forwarding Address (NFA) registered by the contract for the `@agoric` address */
+    nobleForwardingAddress?: Bech32Address;
+    targetAllocation?: TargetAllocation;
+    /** incremented by the contract every time the user sends a transaction that the planner should respond to */
+    policyVersion: number;
+    /** the count of acknowledged submissions [from the planner] associated with the current policyVersion */
+    rebalanceCount: number;
+    /** @deprecated in favor of flowsRunning */
+    flowCount: number;
+    flowsRunning?: Record<FlowKey, FlowDetail>;
+  };
+  position: {
+    protocol: YieldProtocol;
+    accountId: AccountId;
+    totalIn: NatAmount;
+    totalOut: NatAmount;
+  };
+  flow: FlowStatus & FlowDetail;
+  flowSteps: FlowStep[];
+  flowOrder: FundsFlowPlan['order'];
+};
+
+/**
+ * Names suitable for use as `publicInvitationMaker` in {@link ContractInvitationSpec}.
+ */
+export type PortfolioPublicInvitationMaker = 'makeOpenPortfolioInvitation';
+
+/**
+ * Names suitable for use as `invitationMakerName` in {@link ContinuingInvitationSpec}.
+ *
+ * These continuing invitation makers are returned from portfolio creation and enable
+ * ongoing operations like rebalancing between yield protocols.
+ */
+export type PortfolioContinuingInvitationMaker =
+  | 'Deposit'
+  | 'Withdraw'
+  | 'Rebalance'
+  | 'SimpleRebalance';