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

package/src/types.d.ts

@@ -0,0 +1,296 @@
+import type { NatAmount } from '@agoric/ertp';
+import { type AccountId, type Bech32Address, type CaipChainId, type CosmosChainAddress, type TrafficEntry } from '@agoric/orchestration';
+import type { Address as EVMAddress } from 'abitype';
+import type { AxelarChain, SupportedChain, YieldProtocol } from './constants.js';
+import type { InstrumentId } from './instruments.js';
+import type { PublishedTx } from './resolver.js';
+import type { EVMWalletUpdate, PortfolioPath } from './evm/types.js';
+/**
+ * Feature flags to handle contract upgrade flow compatibility.
+ */
+export type FlowFeatures = {
+    /** Control `ProgressTracker` support. */
+    useProgressTracker?: boolean;
+};
+/**
+ * Configuration options for flows.
+ */
+export type FlowConfig = {
+    features?: FlowFeatures;
+};
+export type SeatKeyword = 'Cash' | 'Deposit';
+/**
+ * Reference to a local chain accounts (LCA).
+ * '+agoric' is published as `depositAddress`
+ */
+export type LocalChainAccountRef = '+agoric';
+/**
+ * Identifies the blockchain hosting an address external to ymax from which
+ * funds for a deposit must be supplied.
+ */
+export type DepositFromChainRef = `+${AxelarChain}`;
+/**
+ * Identifies the blockchain hosting an address external to ymax to which
+ * withdrawn funds will be sent.
+ */
+export type WithdrawToChainRef = `-${AxelarChain}`;
+export type InterChainAccountRef = `@${SupportedChain}`;
+/**
+ * An AssetPlaceRef describes a place where funds can be, either an
+ * {@link InstrumentId} (starting with an ASCII letter), a {@link SeatKeyword}
+ * wrapped in `<...>` angle brackets, or a value consisting of a
+ * single-character punctuator followed by a SupportedChain (that character
+ * being `@` for {@link InterChainAccountRef}, `+` for
+ * {@link LocalChainAccountRef} and {@link DepositFromChainRef}, and `-` for
+ * {@link WithdrawToChainRef}).
+ */
+export type AssetPlaceRef = `<${SeatKeyword}>` | LocalChainAccountRef | DepositFromChainRef | WithdrawToChainRef | 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;
+    toChain?: SupportedChain;
+} | {
+    type: 'deposit';
+    amount: NatAmount;
+    fromChain?: SupportedChain;
+} | {
+    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 TxPhase = 'makeSrcAccount' | 'makeDestAccount' | 'apply';
+export type FlowStep = {
+    /** Human readable description of how the step accomplishes the transfer from `src` to `dest` */
+    how: string;
+    amount: NatAmount;
+    src: AssetPlaceRef;
+    dest: AssetPlaceRef;
+    /**
+     * A single FlowStep can have an arbitrary number of associated pendingTxs
+     * entries. They are tracked by grouping them into "phases", each phase
+     * containing a sequence of TxIds in order of execution and with no implied
+     * relative sequencing constraints across phases.
+     *
+     * It is valid for the phases record
+     * - to be omitted,
+     * - to have one property,
+     * - to have no properties,
+     * - to have more than one property.
+     * and for each property, to have an array of zero or more TxIds.
+     */
+    phases?: Partial<Record<TxPhase, TxId[]>>;
+};
+/**
+ * Each step in the `flow` of a FundsFlowPlan can depend upon any number of
+ * other steps, subject to the complete directed graph being acyclic.
+ * The dependencies are expressed using 0-based indices.
+ */
+type FlowStepDependency = [stepIndex: number, prerequisiteIndexes: number[]];
+export type FundsFlowPlan = {
+    flow: MovementDesc[];
+    /** When `order` is absent, default to fully sequential dependencies. */
+    order?: FlowStepDependency[];
+};
+export type TxId = `tx${number}`;
+export type TrafficReport = {
+    traffic: TrafficEntry[];
+    appendedTxIds?: TxId[];
+};
+export type PortfolioKey = `portfolio${number}`;
+export type FlowKey = `flow${number}`;
+export type PortfolioRemoteAccountCommonStates = 'provisioning' | 'active' | 'failed';
+export type PortfolioGenericRemoteAccountState = {
+    chainId: CaipChainId;
+    address: string;
+    state: PortfolioRemoteAccountCommonStates;
+} | {
+    state: 'provisioning' | 'unknown';
+};
+export type PortfolioEVMRemoteAccountState = {
+    chainId: `eip155:${number | bigint | string}`;
+    address: EVMAddress;
+} & {
+    state: PortfolioRemoteAccountCommonStates;
+    /**
+     * The factory that deployed the router-based remote account and maintains a map of authorized routers.
+     *
+     * Absent for legacy accounts.
+     */
+    routerFactory?: EVMAddress;
+};
+export type PortfolioCosmosRemoteAccountState = {
+    chainId: `cosmos:${string}`;
+    address: Bech32Address;
+    state: PortfolioRemoteAccountCommonStates;
+};
+export type PortfolioRemoteAccountState = PortfolioEVMRemoteAccountState | PortfolioCosmosRemoteAccountState | PortfolioGenericRemoteAccountState;
+export type StatusFor = {
+    contract: {
+        contractAccount: CosmosChainAddress['value'];
+        depositFactoryAddresses?: Partial<Record<AxelarChain, AccountId>>;
+        evmRemoteAccountConfig?: {
+            remoteAccountImplementationAddresses: Partial<Record<AxelarChain, AccountId>>;
+            factoryAddresses: Partial<Record<AxelarChain, AccountId>>;
+            currentRouterAddresses: Partial<Record<AxelarChain, AccountId>>;
+        };
+    };
+    pendingTx: PublishedTx;
+    evmWallet: EVMWalletUpdate;
+    evmWalletPortfolios: PortfolioPath[];
+    portfolios: {
+        addPortfolio: PortfolioKey;
+    };
+    portfolio: {
+        positionKeys: InstrumentId[];
+        accountIdByChain: Partial<Record<SupportedChain, AccountId>>;
+        accountsPending?: SupportedChain[];
+        accountStateByChain?: {
+            [evmChain in AxelarChain]?: PortfolioEVMRemoteAccountState;
+        } & {
+            [cosmosChain in 'agoric' | 'noble']?: PortfolioCosmosRemoteAccountState;
+        } & {
+            [genericChain in Exclude<SupportedChain, AxelarChain | 'agoric' | 'noble'>]?: PortfolioGenericRemoteAccountState;
+        };
+        depositAddress?: Bech32Address;
+        /** Noble Forwarding Address (NFA) registered by the contract for the `@agoric` address */
+        nobleForwardingAddress?: Bech32Address;
+        targetAllocation?: TargetAllocation;
+        /**
+         * CAIP-10 account ID of the authenticated EVM account that opened this portfolio.
+         * Derived from `permit2Payload.owner` in `openPortfolioFromEVM()`.
+         * The Permit2 signature is verified on-chain by the `depositFactory` contract
+         * when it receives the GMP call via `sendCreateAndDepositCall()`.
+         */
+        sourceAccountId?: AccountId;
+        /** 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'];
+};
+/**
+ * Published vstorage values produced by the portfolio contract.
+ */
+export type PortfolioPublishedPathTypes = {
+    ymax0: StatusFor['contract'];
+    ymax1: StatusFor['contract'];
+    'ymax0.portfolios': StatusFor['portfolios'];
+    'ymax1.portfolios': StatusFor['portfolios'];
+} & {
+    [K in `ymax${'0' | '1'}.portfolios.portfolio${number}`]: StatusFor['portfolio'];
+} & {
+    [K in `ymax${'0' | '1'}.portfolios.portfolio${number}.positions.${string}`]: StatusFor['position'];
+} & {
+    [K in `ymax${'0' | '1'}.portfolios.portfolio${number}.pendingTx.tx${number}`]: StatusFor['pendingTx'];
+} & {
+    [K in `ymax${'0' | '1'}.portfolios.portfolio${number}.flows.flow${number}`]: StatusFor['flow'];
+} & {
+    [K in `ymax${'0' | '1'}.portfolios.portfolio${number}.flows.flow${number}.steps`]: StatusFor['flowSteps'];
+} & {
+    [K in `ymax${'0' | '1'}.evmWallets.0x${string}.portfolio`]: StatusFor['evmWalletPortfolios'];
+} & {
+    [K in `ymax${'0' | '1'}.evmWallets.0x${string}`]: StatusFor['evmWallet'];
+};
+/**
+ * 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,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EAClB,MAAM,uBAAuB,CAAC;AAK/B,OAAO,KAAK,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EACV,WAAW,EACX,cAAc,EACd,aAAa,EACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,yCAAyC;IACzC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,WAAW,EAAE,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,WAAW,EAAE,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAAG,IAAI,cAAc,EAAE,CAAC;AAExD;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GACrB,IAAI,WAAW,GAAG,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,kBAAkB,GAClB,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,CAAC;IAAC,OAAO,CAAC,EAAE,cAAc,CAAA;CAAE,GACjE;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,SAAS,CAAC;IAAC,SAAS,CAAC,EAAE,cAAc,CAAA;CAAE,GAClE;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,OAAO,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,OAAO,CAAC;AAErE,MAAM,MAAM,QAAQ,GAAG;IACrB,gGAAgG;IAEhG,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,SAAS,CAAC;IAClB,GAAG,EAAE,aAAa,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;CAE3C,CAAC;AAEF;;;;GAIG;AACH,KAAK,kBAAkB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,EAAE,CAAC,CAAC;AAE7E,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,YAAY,EAAE,CAAC;IACrB,wEAAwE;IACxE,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAC9B,CAAC;AAGF,MAAM,MAAM,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;AAEjC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,YAAY,MAAM,EAAE,CAAC;AAChD,MAAM,MAAM,OAAO,GAAG,OAAO,MAAM,EAAE,CAAC;AAEtC,MAAM,MAAM,kCAAkC,GAC1C,cAAc,GACd,QAAQ,GACR,QAAQ,CAAC;AAEb,MAAM,MAAM,kCAAkC,GAC1C;IACE,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,kCAAkC,CAAC;CAC3C,GACD;IACE,KAAK,EAAE,cAAc,GAAG,SAAS,CAAC;CACnC,CAAC;AAEN,MAAM,MAAM,8BAA8B,GAAG;IAC3C,OAAO,EAAE,UAAU,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9C,OAAO,EAAE,UAAU,CAAC;CACrB,GAAG;IACF,KAAK,EAAE,kCAAkC,CAAC;IAC1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,UAAU,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,EAAE,UAAU,MAAM,EAAE,CAAC;IAC5B,OAAO,EAAE,aAAa,CAAC;IACvB,KAAK,EAAE,kCAAkC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,2BAA2B,GACnC,8BAA8B,GAC9B,iCAAiC,GACjC,kCAAkC,CAAC;AAEvC,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE;QACR,eAAe,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC7C,uBAAuB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;QAClE,sBAAsB,CAAC,EAAE;YACvB,oCAAoC,EAAE,OAAO,CAC3C,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAC/B,CAAC;YACF,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;YAC1D,sBAAsB,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;SACjE,CAAC;KACH,CAAC;IACF,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,eAAe,CAAC;IAC3B,mBAAmB,EAAE,aAAa,EAAE,CAAC;IACrC,UAAU,EAAE;QACV,YAAY,EAAE,YAAY,CAAC;KAC5B,CAAC;IACF,SAAS,EAAE;QACT,YAAY,EAAE,YAAY,EAAE,CAAC;QAG7B,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC;QAC7D,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;QACnC,mBAAmB,CAAC,EAAE;aACnB,QAAQ,IAAI,WAAW,CAAC,CAAC,EAAE,8BAA8B;SAC3D,GAAG;aACD,WAAW,IAAI,QAAQ,GAAG,OAAO,CAAC,CAAC,EAAE,iCAAiC;SACxE,GAAG;aACD,YAAY,IAAI,OAAO,CACtB,cAAc,EACd,WAAW,GAAG,QAAQ,GAAG,OAAO,CACjC,CAAC,CAAC,EAAE,kCAAkC;SACxC,CAAC;QACF,cAAc,CAAC,EAAE,aAAa,CAAC;QAC/B,0FAA0F;QAC1F,sBAAsB,CAAC,EAAE,aAAa,CAAC;QACvC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;QACpC;;;;;WAKG;QACH,eAAe,CAAC,EAAE,SAAS,CAAC;QAC5B,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,2BAA2B,GAAG;IACxC,KAAK,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;IAC7B,KAAK,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;IAC7B,kBAAkB,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IAC5C,kBAAkB,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;CAC7C,GAAG;KACD,CAAC,IAAI,OAAO,GAAG,GAAG,GAAG,wBAAwB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC;CAChF,GAAG;KACD,CAAC,IAAI,OAAO,GAAG,GAAG,GAAG,wBAAwB,MAAM,cAAc,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC;CACnG,GAAG;KACD,CAAC,IAAI,OAAO,GAAG,GAAG,GAAG,wBAAwB,MAAM,gBAAgB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC;CACtG,GAAG;KACD,CAAC,IAAI,OAAO,GAAG,GAAG,GAAG,wBAAwB,MAAM,cAAc,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC;CAC/F,GAAG;KACD,CAAC,IAAI,OAAO,GAAG,GAAG,GAAG,wBAAwB,MAAM,cAAc,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC;CAC1G,GAAG;KACD,CAAC,IAAI,OAAO,GAAG,GAAG,GAAG,iBAAiB,MAAM,YAAY,GAAG,SAAS,CAAC,qBAAqB,CAAC;CAC7F,GAAG;KACD,CAAC,IAAI,OAAO,GAAG,GAAG,GAAG,iBAAiB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC;CACzE,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.js

@@ -0,0 +1,337 @@
+/* eslint-disable @typescript-eslint/no-unused-vars -- not detecting the TSDoc */
+                                              
+import {
+                 
+                     
+                   
+                          
+                    
+} from '@agoric/orchestration';
+;            
+                           
+                         
+                                                 
+;                                                    
+;            
+              
+                 
+                
+                        
+;                                                    
+;                                                
+;                                                                    
+
+/**
+ * Feature flags to handle contract upgrade flow compatibility.
+ */
+;                           
+                                           
+                               
+  
+
+/**
+ * Configuration options for flows.
+ */
+;                         
+                          
+  
+;                                            
+
+/**
+ * Reference to a local chain accounts (LCA).
+ * '+agoric' is published as `depositAddress`
+ */
+;                                            
+
+/**
+ * Identifies the blockchain hosting an address external to ymax from which
+ * funds for a deposit must be supplied.
+ */
+;                                                   
+
+/**
+ * Identifies the blockchain hosting an address external to ymax to which
+ * withdrawn funds will be sent.
+ */
+;                                                  
+
+;                                                       
+
+/**
+ * An AssetPlaceRef describes a place where funds can be, either an
+ * {@link InstrumentId} (starting with an ASCII letter), a {@link SeatKeyword}
+ * wrapped in `<...>` angle brackets, or a value consisting of a
+ * single-character punctuator followed by a SupportedChain (that character
+ * being `@` for {@link InterChainAccountRef}, `+` for
+ * {@link LocalChainAccountRef} and {@link DepositFromChainRef}, and `-` for
+ * {@link WithdrawToChainRef}).
+ */
+;                          
+                      
+                        
+                       
+                      
+                        
+                 
+
+;                                     
+
+/**
+ * Proposal shapes for portfolio operations.
+ *
+ * **openPortfolio**: Create portfolio with initial funding across protocols
+ * **rebalance**: Add funds (give) or withdraw funds (want) from protocols
+ */
+;                           
+                  
+           
+                                                                        
+                         
+                          
+      
+                 
+    
+            
+                                                    
+                                                 
+                                                       
+                                                         
+  
+
+/**
+ * Target allocation mapping from PoolKey to numerator (typically in basis points).
+ * Denominator is implicitly the sum of all numerators.
+ */
+;                                                                    
+
+;                       
+                                                                     
+                                                                      
+                           // aka simpleRebalance
+
+/** linked list of concurrent failures, including dependencies */
+;                         
+               
+              
+                
+                    
+  
+
+;                       
+     
+                   
+                                           
+                   
+                  
+                                                                 
+                       
+     
+                                                                 
+                                                
+                     
+                                     
+
+;                           
+                    
+                     
+                      
+                             
+                  
+                                      
+                                  
+                  
+  
+
+;                                                                    
+
+;                       
+                                                                                                  
+                                            
+              
+                    
+                     
+                      
+     
+                                                                            
+                                                                         
+                                                                             
+                                                   
+    
+                                      
+                     
+                            
+                             
+                                      
+                                                                   
+     
+                                            
+                            
+  
+
+/**
+ * Each step in the `flow` of a FundsFlowPlan can depend upon any number of
+ * other steps, subject to the complete directed graph being acyclic.
+ * The dependencies are expressed using 0-based indices.
+ */
+;                                                                            
+
+;                            
+                       
+                                                                          
+                               
+  
+
+// tx for transactions
+;                                
+
+;                            
+                          
+                         
+  
+
+;                                               
+;                                     
+
+;                                               
+                  
+            
+             
+
+;                                               
+     
+                           
+                      
+                                                
+     
+     
+                                        
+      
+
+;                                             
+                                                
+                      
+     
+                                            
+     
+                                                                                                         
+    
+                                
+     
+                             
+  
+
+;                                                
+                              
+                         
+                                            
+  
+
+;                                        
+                                  
+                                     
+                                       
+
+;                        
+             
+                                                 
+                                                                      
+                              
+                                                    
+                                      
+        
+                                                                
+                                                                      
+      
+    
+                         
+                             
+                                       
+               
+                               
+    
+              
+                                 
+                                                      
+                                      
+                                                                 
+                                       
+                           
+                                                                 
+         
+                                                                              
+         
+                               
+                       
+                                        
+                                              
+      
+                                   
+                                                                                              
+                                           
+                                        
+       
+                                                                                      
+                                                                       
+                                                                                  
+                                                                      
+       
+                                
+                                                                                                                 
+                          
+                                                                                                             
+                           
+                                               
+                      
+                                               
+    
+             
+                            
+                         
+                       
+                        
+    
+                                
+                        
+                                    
+  
+
+/**
+ * Published vstorage values produced by the portfolio contract.
+ */
+;                                          
+                               
+                               
+                                              
+                                              
+     
+                                                                                  
+     
+                                                                                                     
+     
+                                                                                                        
+     
+                                                                                                 
+     
+                                                                                                            
+     
+                                                                                               
+     
+                                                                           
+  
+
+/**
+ * Names suitable for use as `publicInvitationMaker` in {@link ContractInvitationSpec}.
+ */
+;                                                                          
+
+/**
+ * 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.
+ */
+;                                               
+             
+              
+               
+                      

package/src/types.ts

@@ -1 +0,0 @@
-export type * from './constants.js';