@agoric/inter-protocol 0.16.2-other-dev-8f8782b.0 → 0.16.2-other-dev-fbe72e7.0.fbe72e7

package/src/vaultFactory/vaultDirector.d.ts

@@ -0,0 +1,347 @@
+export function makeAllManagersDo(collateralManagers: any, vaultManagers: any): (fn: (vm: VaultManager) => void) => void;
+/** @typedef {EReturn<EReturn<typeof prepareVaultDirector>>} VaultDirector */
+/**
+ * Prepare the VaultDirector kind, get or make the singleton
+ *
+ * @type {(
+ *   ...pvdArgs: Parameters<typeof prepareVaultDirector>
+ * ) => VaultDirector}
+ */
+export const provideDirector: (...pvdArgs: Parameters<typeof prepareVaultDirector>) => VaultDirector;
+export type MetricsNotification = {
+    collaterals: Brand[];
+    rewardPoolAllocation: AmountKeywordRecord;
+};
+export type ImmutableState = Readonly<{}>;
+export type MutableState = {};
+export type State = ImmutableState & MutableState;
+export type FactoryPowersFacet = {
+    burnDebt: BurnDebt;
+    getGovernedParams: (collateralBrand: Brand) => import("./vaultManager.js").GovernedParamGetters;
+    mintAndTransfer: MintAndTransfer;
+    getShortfallReporter: () => Promise<import("../reserve/assetReserve.js").ShortfallReporter>;
+};
+export type MethodContext = Readonly<{
+    state: State;
+}>;
+export type VaultDirectorParamManager = import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<import("./params.js").VaultDirectorParams>;
+export type VaultDirector = EReturn<EReturn<typeof prepareVaultDirector>>;
+/**
+ * @param {import('@agoric/swingset-liveslots').Baggage} baggage
+ * @param {import('./vaultFactory.js').VaultFactoryZCF} zcf
+ * @param {VaultDirectorParamManager} directorParamManager
+ * @param {ZCFMint<'nat'>} debtMint
+ * @param {ERef<import('@agoric/time').TimerService>} timer
+ * @param {ERef<import('../auction/auctioneer.js').AuctioneerPublicFacet>} auctioneer
+ * @param {ERef<StorageNode>} storageNode
+ * @param {ERef<Marshaller>} marshaller
+ * @param {import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit} makeRecorderKit
+ * @param {import('@agoric/zoe/src/contractSupport/recorder.js').MakeERecorderKit} makeERecorderKit
+ * @param {Record<string, import('./params.js').VaultManagerParamOverrides>} managerParams
+ */
+declare function prepareVaultDirector(baggage: import("@agoric/swingset-liveslots").Baggage, zcf: import("./vaultFactory.js").VaultFactoryZCF, directorParamManager: VaultDirectorParamManager, debtMint: ZCFMint<"nat">, timer: ERef<import("@agoric/time").TimerService>, auctioneer: ERef<import("../auction/auctioneer.js").AuctioneerPublicFacet>, storageNode: ERef<StorageNode>, marshaller: ERef<Marshaller>, makeRecorderKit: import("@agoric/zoe/src/contractSupport/recorder.js").MakeRecorderKit, makeERecorderKit: import("@agoric/zoe/src/contractSupport/recorder.js").MakeERecorderKit, managerParams: Record<string, import("./params.js").VaultManagerParamOverrides>): () => import("@endo/exo").GuardedKit<{
+    creator: {
+        getParamMgrRetriever: () => {
+            /** @param {VaultFactoryParamPath} paramPath */
+            get: (paramPath?: VaultFactoryParamPath) => VaultDirectorParamManager | import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                DebtLimit: "amount";
+                InterestRate: "ratio";
+                LiquidationPadding: "ratio";
+                LiquidationMargin: "ratio";
+                LiquidationPenalty: "ratio";
+                MintFee: "ratio";
+            }>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            /** @param {VaultFactoryParamPath} paramPath */
+            get: (paramPath?: VaultFactoryParamPath) => VaultDirectorParamManager | import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                DebtLimit: "amount";
+                InterestRate: "ratio";
+                LiquidationPadding: "ratio";
+                LiquidationMargin: "ratio";
+                LiquidationPenalty: "ratio";
+                MintFee: "ratio";
+            }>;
+        }>;
+        /** @param {string} name */
+        getInvitation(name: string): Promise<globalThis.Invitation>;
+        getLimitedCreatorFacet(): import("@endo/exo").Guarded<{
+            /**
+             * @param {Issuer<'nat'>} collateralIssuer
+             * @param {Keyword} collateralKeyword
+             * @param {VaultManagerParamValues} initialParamValues
+             */
+            addVaultType(collateralIssuer: Issuer<"nat">, collateralKeyword: Keyword, initialParamValues: VaultManagerParamValues): Promise<import("@endo/exo").Guarded<{
+                getGovernedParams(): import("./vaultManager.js").GovernedParamGetters;
+                makeVaultKit(seat: ZCFSeat): Promise<{
+                    publicSubscribers: {
+                        vault: {
+                            description: string;
+                            subscriber: globalThis.Subscriber<VaultNotification>;
+                            storagePath: Promise<string>;
+                        };
+                    };
+                    invitationMakers: import("@endo/exo").Guarded<{
+                        AdjustBalances(): Promise<globalThis.Invitation<string, undefined>>;
+                        CloseVault(): Promise<globalThis.Invitation<string, undefined>>;
+                        TransferVault(): Promise<globalThis.Invitation</*elided*/ any>>;
+                    }>;
+                    vault: import("@endo/exo").Guarded<{
+                        getPublicTopics(): {
+                            vault: {
+                                description: string;
+                                subscriber: globalThis.Subscriber<VaultNotification>;
+                                storagePath: Promise<string>;
+                            };
+                        };
+                        makeAdjustBalancesInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                        makeCloseInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                        makeTransferInvitation(): Promise<globalThis.Invitation</*elided*/ any>>;
+                        getCollateralAmount(): import("@agoric/ertp").NatAmount;
+                        getCurrentDebt(): import("@agoric/ertp").NatAmount;
+                        getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+                    }>;
+                    vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
+                }>;
+                getCollateralQuote(): import("@agoric/zoe/tools/types.js").PriceQuote;
+                getPublicFacet(): import("@endo/exo").Guarded<{
+                    makeVaultInvitation(): Promise<globalThis.Invitation<{
+                        publicSubscribers: {
+                            vault: {
+                                description: string;
+                                subscriber: globalThis.Subscriber<VaultNotification>;
+                                storagePath: Promise<string>;
+                            };
+                        };
+                        invitationMakers: import("@endo/exo").Guarded<{
+                            AdjustBalances(): Promise<globalThis.Invitation<string, undefined>>;
+                            CloseVault(): Promise<globalThis.Invitation<string, undefined>>;
+                            TransferVault(): Promise<globalThis.Invitation</*elided*/ any>>;
+                        }>;
+                        vault: import("@endo/exo").Guarded<{
+                            getPublicTopics(): {
+                                vault: {
+                                    description: string;
+                                    subscriber: globalThis.Subscriber<VaultNotification>;
+                                    storagePath: Promise<string>;
+                                };
+                            };
+                            makeAdjustBalancesInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                            makeCloseInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                            makeTransferInvitation(): Promise<globalThis.Invitation</*elided*/ any>>;
+                            getCollateralAmount(): import("@agoric/ertp").NatAmount;
+                            getCurrentDebt(): import("@agoric/ertp").NatAmount;
+                            getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+                        }>;
+                        vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
+                    }, undefined>>;
+                    getQuotes(): import("@agoric/notifier").StoredNotifier<import("@agoric/zoe/tools/types.js").PriceQuote>;
+                    getCompoundedInterest(): Ratio;
+                    getPublicTopics(): {
+                        asset: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./vaultManager.js").AssetState>;
+                        metrics: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./vaultManager.js").MetricsNotification>;
+                    };
+                }>;
+                lockOraclePrices(): import("@agoric/zoe/tools/types.js").PriceQuote;
+                liquidateVaults(auctionPF: ERef<AuctioneerPublicFacet>): Promise<void>;
+            }>>;
+            makeCollectFeesInvitation(): Promise<globalThis.Invitation<string>>;
+            getRewardAllocation(): Allocation;
+            makeLiquidationWaker(): {
+                wake: (timestamp: any) => any;
+            } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+                wake: (timestamp: any) => any;
+            }>;
+            makeReschedulerWaker(): {
+                wake: (timestamp: any) => any;
+            } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+                wake: (timestamp: any) => any;
+            }>;
+            makePriceLockWaker(): {
+                wake: (timestamp: any) => any;
+            } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+                wake: (timestamp: any) => any;
+            }>;
+            setShortfallReporter(newInvitation: any): Promise<void>;
+        }>;
+        /** @returns {ERef<GovernedApis>} */
+        getGovernedApis(): ERef<GovernedApis>;
+        getGovernedApiNames(): never[];
+        setOfferFilter: (strings: any) => Promise<void>;
+    };
+    machine: {
+        /**
+         * @param {Issuer<'nat'>} collateralIssuer
+         * @param {Keyword} collateralKeyword
+         * @param {VaultManagerParamValues} initialParamValues
+         */
+        addVaultType(collateralIssuer: Issuer<"nat">, collateralKeyword: Keyword, initialParamValues: VaultManagerParamValues): Promise<import("@endo/exo").Guarded<{
+            getGovernedParams(): import("./vaultManager.js").GovernedParamGetters;
+            makeVaultKit(seat: ZCFSeat): Promise<{
+                publicSubscribers: {
+                    vault: {
+                        description: string;
+                        subscriber: globalThis.Subscriber<VaultNotification>;
+                        storagePath: Promise<string>;
+                    };
+                };
+                invitationMakers: import("@endo/exo").Guarded<{
+                    AdjustBalances(): Promise<globalThis.Invitation<string, undefined>>;
+                    CloseVault(): Promise<globalThis.Invitation<string, undefined>>;
+                    TransferVault(): Promise<globalThis.Invitation</*elided*/ any>>;
+                }>;
+                vault: import("@endo/exo").Guarded<{
+                    getPublicTopics(): {
+                        vault: {
+                            description: string;
+                            subscriber: globalThis.Subscriber<VaultNotification>;
+                            storagePath: Promise<string>;
+                        };
+                    };
+                    makeAdjustBalancesInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                    makeCloseInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                    makeTransferInvitation(): Promise<globalThis.Invitation</*elided*/ any>>;
+                    getCollateralAmount(): import("@agoric/ertp").NatAmount;
+                    getCurrentDebt(): import("@agoric/ertp").NatAmount;
+                    getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+                }>;
+                vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
+            }>;
+            getCollateralQuote(): import("@agoric/zoe/tools/types.js").PriceQuote;
+            getPublicFacet(): import("@endo/exo").Guarded<{
+                makeVaultInvitation(): Promise<globalThis.Invitation<{
+                    publicSubscribers: {
+                        vault: {
+                            description: string;
+                            subscriber: globalThis.Subscriber<VaultNotification>;
+                            storagePath: Promise<string>;
+                        };
+                    };
+                    invitationMakers: import("@endo/exo").Guarded<{
+                        AdjustBalances(): Promise<globalThis.Invitation<string, undefined>>;
+                        CloseVault(): Promise<globalThis.Invitation<string, undefined>>;
+                        TransferVault(): Promise<globalThis.Invitation</*elided*/ any>>;
+                    }>;
+                    vault: import("@endo/exo").Guarded<{
+                        getPublicTopics(): {
+                            vault: {
+                                description: string;
+                                subscriber: globalThis.Subscriber<VaultNotification>;
+                                storagePath: Promise<string>;
+                            };
+                        };
+                        makeAdjustBalancesInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                        makeCloseInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                        makeTransferInvitation(): Promise<globalThis.Invitation</*elided*/ any>>;
+                        getCollateralAmount(): import("@agoric/ertp").NatAmount;
+                        getCurrentDebt(): import("@agoric/ertp").NatAmount;
+                        getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+                    }>;
+                    vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
+                }, undefined>>;
+                getQuotes(): import("@agoric/notifier").StoredNotifier<import("@agoric/zoe/tools/types.js").PriceQuote>;
+                getCompoundedInterest(): Ratio;
+                getPublicTopics(): {
+                    asset: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./vaultManager.js").AssetState>;
+                    metrics: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./vaultManager.js").MetricsNotification>;
+                };
+            }>;
+            lockOraclePrices(): import("@agoric/zoe/tools/types.js").PriceQuote;
+            liquidateVaults(auctionPF: ERef<AuctioneerPublicFacet>): Promise<void>;
+        }>>;
+        makeCollectFeesInvitation(): Promise<globalThis.Invitation<string>>;
+        getRewardAllocation(): Allocation;
+        makeLiquidationWaker(): {
+            wake: (timestamp: any) => any;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            wake: (timestamp: any) => any;
+        }>;
+        makeReschedulerWaker(): {
+            wake: (timestamp: any) => any;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            wake: (timestamp: any) => any;
+        }>;
+        makePriceLockWaker(): {
+            wake: (timestamp: any) => any;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            wake: (timestamp: any) => any;
+        }>;
+        setShortfallReporter(newInvitation: any): Promise<void>;
+    };
+    public: {
+        /** @param {Brand} brandIn */
+        getCollateralManager(brandIn: Brand): import("@endo/exo").Guarded<{
+            makeVaultInvitation(): Promise<globalThis.Invitation<{
+                publicSubscribers: {
+                    vault: {
+                        description: string;
+                        subscriber: globalThis.Subscriber<VaultNotification>;
+                        storagePath: Promise<string>;
+                    };
+                };
+                invitationMakers: import("@endo/exo").Guarded<{
+                    AdjustBalances(): Promise<globalThis.Invitation<string, undefined>>;
+                    CloseVault(): Promise<globalThis.Invitation<string, undefined>>;
+                    TransferVault(): Promise<globalThis.Invitation</*elided*/ any>>;
+                }>;
+                vault: import("@endo/exo").Guarded<{
+                    getPublicTopics(): {
+                        vault: {
+                            description: string;
+                            subscriber: globalThis.Subscriber<VaultNotification>;
+                            storagePath: Promise<string>;
+                        };
+                    };
+                    makeAdjustBalancesInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                    makeCloseInvitation(): Promise<globalThis.Invitation<string, undefined>>;
+                    makeTransferInvitation(): Promise<globalThis.Invitation</*elided*/ any>>;
+                    getCollateralAmount(): import("@agoric/ertp").NatAmount;
+                    getCurrentDebt(): import("@agoric/ertp").NatAmount;
+                    getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+                }>;
+                vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
+            }, undefined>>;
+            getQuotes(): import("@agoric/notifier").StoredNotifier<import("@agoric/zoe/tools/types.js").PriceQuote>;
+            getCompoundedInterest(): Ratio;
+            getPublicTopics(): {
+                asset: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./vaultManager.js").AssetState>;
+                metrics: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./vaultManager.js").MetricsNotification>;
+            };
+        }>;
+        getDebtIssuer(): globalThis.Issuer<"nat", import("@endo/patterns").Key>;
+        /**
+         * subscription for the paramManager for a particular vaultManager
+         *
+         * @param {{ collateralBrand: Brand }} selector
+         */
+        getSubscription({ collateralBrand }: {
+            collateralBrand: Brand;
+        }): globalThis.StoredSubscription<globalThis.GovernanceSubscriptionState>;
+        getPublicTopics(): {
+            metrics: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<MetricsNotification>;
+        };
+        /** subscription for the paramManager for the vaultFactory's electorate */
+        getElectorateSubscription(): globalThis.StoredSubscription<globalThis.GovernanceSubscriptionState>;
+        /**
+         * Note this works only for a collateral manager. For the director use,
+         * `getDirectorGovernedParams`
+         *
+         * @param {{ collateralBrand: Brand }} selector
+         */
+        getGovernedParams({ collateralBrand }: {
+            collateralBrand: Brand;
+        }): globalThis.ERef<globalThis.ParamStateRecord>;
+        getDirectorGovernedParams(): globalThis.ERef<globalThis.ParamStateRecord>;
+        /** @param {string} name */
+        getInvitationAmount(name: string): import("@agoric/ertp").SetAmount<import("@agoric/zoe").InvitationDetails>;
+    };
+    helper: {
+        resetWakeupsForNextAuction(): Promise<void>;
+        /** Start non-durable processes (or restart if needed after vat restart) */
+        start(): Promise<void>;
+    };
+}>;
+import type { EReturn } from '@endo/far';
+import type { ZCFMint } from '@agoric/zoe';
+import type { ZCFSeat } from '@agoric/zoe';
+export {};
+//# sourceMappingURL=vaultDirector.d.ts.map

package/src/vaultFactory/vaultDirector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaultDirector.d.ts","sourceRoot":"","sources":["vaultDirector.js"],"names":[],"mappings":"AA0FO,iFAEE,IADK,CAAC,EAAE,EAAE,YAAY,KAAK,IACzB,UAOV;AAmcD,6EAA6E;AAE7E;;;;;;GAMG;AACH,8BAJU,CACT,GAAO,OAAO,EAAE,UAAU,CAAC,OAAO,oBAAoB,CAAC,KAChD,aAAa,CAQnB;kCAlgBW;IACR,WAAW,EAAE,KAAK,EAAE,CAAC;IACrB,oBAAoB,EAAE,mBAAmB,CAAC;CAC3C;6BAGS,QAAQ,CAAC,EAAE,CAAC;2BAEZ,EAAE;oBAEF,cAAc,GAAG,YAAY;iCAE7B;IACR,QAAQ,EAAE,QAAQ,CAAC;IACnB,iBAAiB,EAAE,CACjB,eAAe,EAAE,KAAK,KACnB,OAAO,mBAAmB,EAAE,oBAAoB,CAAC;IACtD,eAAe,EAAE,eAAe,CAAC;IACjC,oBAAoB,EAAE,MAAM,OAAO,CACvC,OAAa,4BAA4B,EAAE,iBAAiB,CACvD,CAAC;CACH;4BAGS,QAAQ,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;wCAEQ,OAAO,gEAAgE,EAAE,iBAAiB,CACtG,OAAa,aAAa,EAAE,mBAAmB,CAC1C;4BAqdQ,QAAQ,QAAQ,OAAO,oBAAoB,CAAC,CAAC;AAjc3D;;;;;;;;;;;;GAYG;AACH,+CAZW,OAAO,4BAA4B,EAAE,OAAO,OAC5C,OAAO,mBAAmB,EAAE,eAAe,wBAC3C,yBAAyB,YACzB,QAAQ,KAAK,CAAC,SACd,IAAI,CAAC,OAAO,cAAc,EAAE,YAAY,CAAC,cACzC,IAAI,CAAC,OAAO,0BAA0B,EAAE,qBAAqB,CAAC,eAC9D,IAAI,CAAC,WAAW,CAAC,cACjB,IAAI,CAAC,UAAU,CAAC,mBAChB,OAAO,6CAA6C,EAAE,eAAe,oBACrE,OAAO,6CAA6C,EAAE,gBAAgB,iBACtE,MAAM,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,0BAA0B,CAAC;;;YAwO/D,+CAA+C;8BAAnC,qBAAqB;;;;;;;;;YAAjC,+CAA+C;8BAAnC,qBAAqB;;;;;;;;;QAarC,2BAA2B;4BAAf,MAAM;;YAmBlB;;;;eAIG;2CAHQ,MAAM,CAAC,KAAK,CAAC,qBACb,OAAO,sBACP,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAflC,oCAAoC;2BAAtB,IAAI,CAAC,YAAY,CAAC;;;;;QAYhC;;;;WAIG;uCAHQ,MAAM,CAAC,KAAK,CAAC,qBACb,OAAO,sBACP,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA4FlC,6BAA6B;sCAAjB,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAUjB;;;;WAIG;6CADQ;YAAE,eAAe,EAAE,KAAK,CAAA;SAAE;;;;QAQrC,0EAA0E;;QAI1E;;;;;WAKG;+CADQ;YAAE,eAAe,EAAE,KAAK,CAAA;SAAE;;QASrC,2BAA2B;kCAAf,MAAM;;;;QAoBlB,2EAA2E;;;GAmBlF;6BAxfyB,WAAW;6BADiB,aAAa;6BAAb,aAAa"}