@agoric/inter-protocol 0.16.2-dev-6e5b422.0 → 0.16.2-dev-bd1190d.0

package/src/vaultFactory/proceeds.d.ts

@@ -0,0 +1,34 @@
+export function calculateDistributionPlan({ proceeds, totalDebt, totalCollateral, oraclePriceAtStart, vaultsBalances, penaltyRate, }: {
+    proceeds: AmountKeywordRecord;
+    totalDebt: Amount<'nat'>;
+    totalCollateral: Amount<'nat'>;
+    oraclePriceAtStart: PriceDescription;
+    vaultsBalances: Array<VaultBalances>;
+    penaltyRate: Ratio;
+}): DistributionPlan;
+/**
+ * The plan to execute for distributing proceeds of a liquidation.
+ *
+ * Vaults are referenced by index in the list sent to the calculator.
+ */
+export type DistributionPlan = {
+    overage: Amount<'nat'>;
+    shortfallToReserve: Amount<'nat'>;
+    collateralForReserve: Amount<'nat'>;
+    actualCollateralSold: Amount<'nat'>;
+    collateralSold: Amount<'nat'>;
+    collatRemaining: Amount<'nat'>;
+    debtToBurn: Amount<'nat'>;
+    mintedForReserve: Amount<'nat'>;
+    mintedProceeds: Amount<'nat'>;
+    phantomDebt: Amount<'nat'>;
+    totalPenalty: Amount<'nat'>;
+    transfersToVault: Array<[number, AmountKeywordRecord]>;
+    vaultsToReinstate: Array<number>;
+};
+export type VaultBalances = {
+    collateral: Amount<'nat'>;
+    presaleDebt: Amount<'nat'>;
+    currentDebt: Amount<'nat'>;
+};
+//# sourceMappingURL=proceeds.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"proceeds.d.ts","sourceRoot":"","sources":["proceeds.js"],"names":[],"mappings":"AAoDO;IARgC,QAAQ,EAApC,mBAAmB;IACG,SAAS,EAA/B,OAAO,KAAK,CAAC;IACS,eAAe,EAArC,OAAO,KAAK,CAAC;IACY,kBAAkB,EAA3C,gBAAgB;IACa,cAAc,EAA3C,MAAM,aAAa,CAAC;IACN,WAAW,EAAzB,KAAK;IACH,gBAAgB,CA8N5B;;;;;;+BApQY;IACZ,OAAW,EAAE,OAAO,KAAK,CAAC,CAAC;IAC3B,kBAAsB,EAAE,OAAO,KAAK,CAAC,CAAC;IACtC,oBAAwB,EAAE,OAAO,KAAK,CAAC,CAAC;IACxC,oBAAwB,EAAE,OAAO,KAAK,CAAC,CAAC;IACxC,cAAkB,EAAE,OAAO,KAAK,CAAC,CAAC;IAClC,eAAmB,EAAE,OAAO,KAAK,CAAC,CAAC;IACnC,UAAc,EAAE,OAAO,KAAK,CAAC,CAAC;IAC9B,gBAAoB,EAAE,OAAO,KAAK,CAAC,CAAC;IACpC,cAAkB,EAAE,OAAO,KAAK,CAAC,CAAC;IAClC,WAAe,EAAE,OAAO,KAAK,CAAC,CAAC;IAC/B,YAAgB,EAAE,OAAO,KAAK,CAAC,CAAC;IAChC,gBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAC3D,iBAAqB,EAAE,MAAM,MAAM,CAAC,CAAA;CACjC;4BAOU;IAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;IAAC,WAAW,EAAG,OAAO,KAAK,CAAC,CAAC;IAAC,WAAW,EAAE,OAAO,KAAK,CAAC,CAAA;CAAE"}

package/src/vaultFactory/storeUtils.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @typedef {import('@endo/marshal').PureData} PureData
+ */
+/**
+ * @typedef {[normalizedCollateralization: number, vaultId: VaultId]} CompositeKey
+ */
+/**
+ * @param {PureData} key
+ * @returns {string}
+ */
+export const encodeData: (passable: any) => string;
+/**
+ * @param {string} encoded
+ * @returns {PureData}
+ */
+export const decodeData: (encoded: string) => any;
+export function toVaultKey(normalizedDebt: NormalizedDebt, collateral: Amount<'nat'>, vaultId: VaultId): string;
+export function fromVaultKey(key: string): [normalizedCollateralization: number, vaultId: VaultId];
+export function normalizedCollRatio(quote: PriceQuote, compoundedStabilityFee: Ratio, margin: Ratio): number;
+export function normalizedCollRatioKey(quote: PriceQuote, compoundedStabilityFee: Ratio, margin: Ratio): string;
+export type PureData = import('@endo/marshal').PureData;
+export type CompositeKey = [normalizedCollateralization: number, vaultId: VaultId];
+export type NormalizedDebt = Amount<'nat'> & {
+    normalized: true;
+};
+export type ActualDebt = Amount<'nat'> & {
+    normalized: false;
+};
+//# sourceMappingURL=storeUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"storeUtils.d.ts","sourceRoot":"","sources":["storeUtils.js"],"names":[],"mappings":"AAqBA;;GAEG;AAEH;;GAEG;AAOH;;;GAGG;AACH,mDAA+C;AAO/C;;;GAGG;AACH,kDAA+C;AAkDxC,2CANI,cAAc,cACd,OAAO,KAAK,CAAC,WACb,OAAO,GACL,MAAM,CAelB;AAOM,kCAHI,MAAM,GACJ,CAAC,2BAA2B,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAKnE;AAgBM,2CALI,UAAU,0BACV,KAAK,UACL,KAAK,GACH,MAAM,CAiBlB;AAcM,8CANI,UAAU,0BACV,KAAK,UACL,KAAK,GACH,MAAM,CAUlB;uBAvJY,OAAO,eAAe,EAAE,QAAQ;2BAIhC,CAAC,2BAA2B,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;6BA6CtD,OAAO,KAAK,CAAC,GAAG;IAAC,UAAU,EAAE,IAAI,CAAA;CAAC;yBAClC,OAAO,KAAK,CAAC,GAAG;IAAC,UAAU,EAAE,KAAK,CAAA;CAAC"}

package/src/vaultFactory/type-imports.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-imports.d.ts.map

package/src/vaultFactory/type-imports.d.ts.map

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

package/src/vaultFactory/types.d.ts

@@ -0,0 +1,132 @@
+type VaultNotification = import('./vault').VaultNotification;
+type Vault = import('./vault').Vault;
+type VaultKit = import('./vaultKit').VaultKit;
+type VaultManager = import('./vaultManager').VaultManager;
+type CollateralManager = import('./vaultManager').CollateralManager;
+type AssetReserveCreatorFacet = import('../reserve/assetReserve.js').AssetReserveLimitedCreatorFacet;
+type AssetReservePublicFacet = import('../reserve/assetReserve.js').AssetReservePublicFacet;
+type AuctioneerPublicFacet = import('../auction/auctioneer.js').AuctioneerPublicFacet;
+type VaultFactoryPublicFacet = import('./vaultFactory.js').VaultFactoryContract['publicFacet'];
+type Timestamp = import('@agoric/time/src/types').Timestamp;
+type RelativeTime = import('@agoric/time/src/types').RelativeTime;
+type AutoswapLocal = {
+    getInputPrice: (amount: Amount, brand: Brand) => Amount;
+    makeSwapInvitation: () => Invitation;
+};
+type VaultManagerParamValues = {
+    /**
+     * - margin below which collateral will be
+     * liquidated to satisfy the debt.
+     */
+    liquidationMargin: Ratio;
+    /**
+     * - penalty charged upon liquidation as proportion of debt
+     */
+    liquidationPenalty: Ratio;
+    /**
+     * - annual interest rate charged on debt positions
+     */
+    stabilityFee: Ratio;
+    /**
+     * - The fee (in BasisPoints) charged when creating
+     * or increasing a debt position.
+     */
+    mintFee: Ratio;
+    debtLimit: Amount<'nat'>;
+    /**
+     * - vault must maintain this in order to remove collateral or add debt
+     */
+    liquidationPadding?: Ratio | undefined;
+};
+type AddVaultType = (collateralIssuer: Issuer, collateralKeyword: Keyword, params: VaultManagerParamValues) => Promise<VaultManager>;
+type VaultFactoryCreatorFacet = {
+    addVaultType: AddVaultType;
+    getRewardAllocation: () => Allocation;
+    makeCollectFeesInvitation: () => Promise<Invitation<string, never>>;
+    makeLiquidationWaker: () => import('@agoric/time/src/types').TimerWaker;
+    makePriceLockWaker: () => import('@agoric/time/src/types').TimerWaker;
+};
+/**
+ * Mint new debt `toMint` and transfer the `fee` portion to the vaultFactory's reward
+ * pool. Then reallocate over all the seat arguments and the rewardPoolSeat. Update
+ * the `totalDebt` if the reallocate succeeds.
+ */
+type MintAndTransfer = (mintReceiver: ZCFSeat, toMint: Amount<'nat'>, fee: Amount<'nat'>, transfers: import('@agoric/zoe/src/contractSupport/atomicTransfer.js').TransferPart[]) => void;
+/**
+ * Burn debt tokens off a seat and update
+ * the `totalDebt` if the reallocate succeeds.
+ */
+type BurnDebt = (toBurn: Amount, fromSeat: ZCFSeat) => void;
+type GetVaultParams = {
+    getLiquidationMargin: () => Ratio;
+    getMintFee: () => Ratio;
+    getCollateralQuote: () => Promise<PriceQuote>;
+    /**
+     * - The annual interest rate on a debt position
+     */
+    getStabilityFee: () => Ratio;
+    /**
+     * - The period (in seconds) at
+     * which interest is charged to the debt position.
+     */
+    getChargingPeriod: () => RelativeTime;
+    /**
+     * - The period (in seconds)
+     * at which interest is recorded to the debt position.
+     */
+    getRecordingPeriod: () => RelativeTime;
+};
+type VaultId = string;
+type InterestTiming = {
+    /**
+     * in seconds
+     */
+    chargingPeriod: RelativeTime;
+    /**
+     * in seconds
+     */
+    recordingPeriod: RelativeTime;
+};
+type LiquidationStrategy = {
+    keywordMapping: () => KeywordKeywordRecord;
+    makeProposal: (collateral: Amount, run: Amount) => Proposal;
+    makeInvitation: (debt: Amount) => Promise<Invitation>;
+};
+type Liquidator = {
+    makeLiquidateInvitation: () => Promise<Invitation<void, {
+        debt: Amount<'nat'>;
+        penaltyRate: Ratio;
+    }>>;
+};
+type DebtStatus = {
+    latestStabilityFeeUpdate: Timestamp;
+    /**
+     * interest accrued since latestStabilityFeeUpdate
+     */
+    interest: NatValue;
+    /**
+     * total including principal and interest
+     */
+    newDebt: NatValue;
+};
+type Calculate = (debtStatus: DebtStatus, currentTime: Timestamp) => DebtStatus;
+type CalculatorKit = {
+    /**
+     * calculate new debt for charging periods up to
+     * the present.
+     */
+    calculate: Calculate;
+    /**
+     * calculate new debt for
+     * reporting periods up to the present. If some charging periods have elapsed
+     * that don't constitute whole reporting periods, the time is not updated past
+     * them and interest is not accumulated for them.
+     */
+    calculateReportingPeriod: Calculate;
+};
+type VaultFactoryParamPath = {
+    key: 'governedParams' | {
+        collateralBrand: Brand;
+    };
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":"yBAGa,OAAO,SAAS,EAAE,iBAAiB;aACnC,OAAO,SAAS,EAAE,KAAK;gBACvB,OAAO,YAAY,EAAE,QAAQ;oBAC7B,OAAO,gBAAgB,EAAE,YAAY;yBACrC,OAAO,gBAAgB,EAAE,iBAAiB;gCAC1C,OAAO,4BAA4B,EAAE,+BAA+B;+BACpE,OAAO,4BAA4B,EAAE,uBAAuB;6BAC5D,OAAO,0BAA0B,EAAE,qBAAqB;+BACxD,OAAO,mBAAmB,EAAE,oBAAoB,CAAC,aAAa,CAAC;iBAE/D,OAAO,wBAAwB,EAAE,SAAS;oBAC1C,OAAO,wBAAwB,EAAE,YAAY;;4BAKnC,MAAM,SAAS,KAAK,KAAK,MAAM;wBACxC,MAAM,UAAU;;;;;;;uBAKhB,KAAK;;;;wBAEL,KAAK;;;;kBACL,KAAK;;;;;aACL,KAAK;eAEL,OAAO,KAAK,CAAC;;;;;;uCAMhB,MAAM,qBACN,OAAO,UACP,uBAAuB,KACrB,QAAQ,YAAY,CAAC;;kBAKpB,YAAY;yBACZ,MAAM,UAAU;+BAChB,MAAM,QAAQ,WAAW,MAAM,EAAE,KAAK,CAAC,CAAC;0BACxC,MAAM,OAAO,wBAAwB,EAAE,UAAU;wBACjD,MAAM,OAAO,wBAAwB,EAAE,UAAU;;;;;;;sCAQpD,OAAO,UACP,OAAO,KAAK,CAAC,OACb,OAAO,KAAK,CAAC,aACb,OAAO,mDAAmD,EAAE,YAAY,EAAE,KACxE,IAAI;;;;;yBASN,MAAM,YACN,OAAO,KACL,IAAI;;0BAKH,MAAM,KAAK;gBACX,MAAM,KAAK;wBACX,MAAM,QAAQ,UAAU,CAAC;;;;qBACzB,MAAM,KAAK;;;;;uBACX,MAAM,YAAY;;;;;wBAElB,MAAM,YAAY;;eAKnB,MAAM;;;;;oBAKL,YAAY;;;;qBACZ,YAAY;;;oBAKZ,MAAM,oBAAoB;+BACb,MAAM,OAAO,MAAM,KAAK,QAAQ;2BACtC,MAAM,KAAK,QAAQ,UAAU,CAAC;;;6BAKrC,MAAM,QAAQ,WAAW,IAAI,EAAE;QAAE,IAAI,EAAE,OAAO,KAAK,CAAC,CAAC;QAAC,WAAW,EAAE,KAAK,CAAC;KAAE,CAAC,CAAC;;;8BAK7E,SAAS;;;;cACT,QAAQ;;;;aACR,QAAQ;;8BAKX,UAAU,eACV,SAAS,KACP,UAAU;;;;;;eAKT,SAAS;;;;;;;8BAET,SAAS;;6BAMT;IAAC,GAAG,EAAE,gBAAgB,GAAG;QAAC,eAAe,EAAE,KAAK,CAAA;KAAC,CAAA;CAAC"}