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

package/README.md

@@ -42,7 +42,7 @@ import { makeFollower } from '@agoric/casting';
 
 The canonical keys (under `published`) are as follows. Non-terminal nodes could have data but don't yet. A `0` indicates the index of that child in added order. To get the actual key look it up in parent. High cardinality types get a parent key for enumeration (e.g. `vaults`.)
 - `published`
-    - `vaultFactory` - [snapshot of details](./test/vaultFactory/snapshots/test-vaultFactory.js.md)
+    - `vaultFactory` - [snapshot of details](./test/vaultFactory/snapshots/vaultFactory.test.js.md)
         - `governance`
         - `metrics`
         - `managers`
@@ -51,22 +51,22 @@ The canonical keys (under `published`) are as follows. Non-terminal nodes could
               - `governance`
               - `vaults`
                 - `vault0`
-    - `auction` - [snapshot of details](./test/auction/snapshots/test-auctionContract.js.md)
+    - `auction` - [snapshot of details](./test/auction/snapshots/auctionContract.test.js.md)
         - `schedule`
         - `governance`
         - `book0`
-    - `reserve` - [snapshot of details](./test/reserve/snapshots/test-reserve.js.md)
+    - `reserve` - [snapshot of details](./test/reserve/snapshots/reserve.test.js.md)
       - `governance`
       - `metrics`
-    - `priceFeed` - [snapshot of details](./test/price/snapshots/test-fluxAggregatorKit.js.md)
+    - `priceFeed` - [snapshot of details](./test/price/snapshots/fluxAggregatorKit.test.js.md)
       - `${inputBrand}-${outputBrand}_price_feed`
       - `${inputBrand}-${outputBrand}_price_feed.latestRound`
-    - `psm` - [snapshot of details](./test/psm/snapshots/test-psm.js.md)
+    - `psm` - [snapshot of details](./test/psm/snapshots/psm.test.js.md)
       - `<minted>`
         - `<anchor>`
           - `governance`
           - `metrics`
-    - `committees` - [snapshot of details](../governance/test/unitTests/snapshots/test-committee.js.md)
+    - `committees` - [snapshot of details](../governance/test/unitTests/snapshots/committee.test.js.md)
         - `Economic_Committee`
           - `latestQuestion`
           - `latestOutcome`

package/package.json

@@ -1,22 +1,24 @@
 {
   "name": "@agoric/inter-protocol",
-  "version": "0.16.2-other-dev-8f8782b.0+8f8782b",
+  "version": "0.16.2-other-dev-3eb1a1d.0+3eb1a1d",
   "description": "Core cryptoeconomy contracts",
   "type": "module",
   "main": "src/index.js",
   "engines": {
-    "node": ">=14.15.0"
+    "node": "^18.12 || ^20.9"
   },
   "scripts": {
     "build": "yarn build:bundles",
     "build:bundles": "node ./scripts/build-bundles.js",
+    "prepack": "tsc --build tsconfig.build.json",
+    "postpack": "git clean -f '*.d.ts*' '*.tsbuildinfo'",
     "test": "ava",
-    "test:c8": "c8 $C8_OPTIONS ava --config=ava-nesm.config.js",
+    "test:c8": "c8 --all $C8_OPTIONS ava",
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "run-s --continue-on-error lint:*",
     "lint:eslint": "eslint .",
-    "lint:types": "tsc -p jsconfig.json"
+    "lint:types": "tsc"
   },
   "repository": {
     "type": "git",
@@ -29,54 +31,58 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-other-dev-8f8782b.0+8f8782b",
-    "@agoric/ertp": "0.16.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/governance": "0.10.4-other-dev-8f8782b.0+8f8782b",
-    "@agoric/internal": "0.3.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/notifier": "0.6.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/store": "0.9.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/time": "0.3.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/vat-data": "0.5.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/vats": "0.15.2-other-dev-8f8782b.0+8f8782b",
-    "@agoric/zoe": "0.26.3-other-dev-8f8782b.0+8f8782b",
-    "@endo/captp": "3.1.1",
-    "@endo/eventual-send": "0.17.2",
-    "@endo/far": "0.2.18",
-    "@endo/marshal": "0.8.5",
-    "@endo/nat": "4.1.27",
-    "agoric": "0.21.2-other-dev-8f8782b.0+8f8782b",
-    "jessie.js": "^0.3.2"
+    "@agoric/ertp": "0.16.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/governance": "0.10.4-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/internal": "0.3.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/notifier": "0.6.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/store": "0.9.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/time": "0.3.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/vat-data": "0.5.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/vats": "0.15.2-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/zoe": "0.26.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@endo/captp": "^4.4.3",
+    "@endo/errors": "^1.2.8",
+    "@endo/eventual-send": "^1.2.8",
+    "@endo/far": "^1.1.9",
+    "@endo/marshal": "^1.6.2",
+    "@endo/nat": "^5.0.13",
+    "@endo/promise-kit": "^1.1.8",
+    "jessie.js": "^0.3.4"
   },
   "devDependencies": {
-    "@agoric/deploy-script-support": "0.10.4-other-dev-8f8782b.0+8f8782b",
-    "@agoric/smart-wallet": "0.5.4-other-dev-8f8782b.0+8f8782b",
-    "@agoric/swingset-liveslots": "0.10.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/swingset-vat": "0.32.3-other-dev-8f8782b.0+8f8782b",
-    "@endo/bundle-source": "2.5.2-upstream-rollup",
-    "@endo/init": "0.5.56",
-    "@endo/promise-kit": "0.2.56",
-    "@fast-check/ava": "^1.1.3",
-    "ava": "^5.2.0",
-    "c8": "^7.13.0",
+    "@agoric/smart-wallet": "0.5.4-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/swingset-liveslots": "0.10.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/swingset-vat": "0.32.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/zone": "0.2.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@endo/bundle-source": "^3.5.0",
+    "@endo/init": "^1.1.7",
+    "@endo/promise-kit": "^1.1.8",
+    "@fast-check/ava": "^1.1.5",
+    "ava": "^5.3.0",
+    "c8": "^10.1.2",
     "deep-object-diff": "^1.1.9",
     "import-meta-resolve": "^2.2.1"
   },
   "files": [
-    "scripts/",
+    "scripts",
     "src/",
-    "exported.js",
     "NEWS.md"
   ],
   "ava": {
     "files": [
-      "test/**/test-*.js"
+      "test/**/*.test.*"
+    ],
+    "require": [
+      "@endo/init/debug.js"
     ],
-    "concurrency": 2,
     "workerThreads": false,
     "timeout": "10m"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8f8782bc52393e9d4fc82523ecf31cab429b11b3"
+  "typeCoverage": {
+    "atLeast": 95.71
+  },
+  "gitHead": "3eb1a1d2d75b2b4a94807cd3bf759bc9fc531f05"
 }

package/scripts/build-bundles.js

@@ -1,36 +1,20 @@
 #! /usr/bin/env node
 import '@endo/init';
-import {
-  createBundles,
-  extractProposalBundles,
-} from '@agoric/internal/src/node/createBundles.js';
-import url from 'url';
-import process from 'process';
-
-import { defaultProposalBuilder } from './init-core.js';
-import { defaultProposalBuilder as collateralProposalBuilder } from './add-collateral-core.js';
 
-process.env.INTERCHAIN_ISSUER_BOARD_ID =
-  'arbitrary value to prevent build error';
+import { createBundles } from '@agoric/internal/src/node/createBundles.js';
+import url from 'url';
 
 const dirname = url.fileURLToPath(new URL('.', import.meta.url));
-await extractProposalBundles(
-  [
-    ['.', defaultProposalBuilder],
-    ['.', collateralProposalBuilder],
-  ],
-  dirname,
-);
 
 await createBundles(
   [
-    ['../src/psm/psm.js', '../bundles/bundle-psm.js'],
+    ['@agoric/inter-protocol/src/psm/psm.js', '../bundles/bundle-psm.js'],
     [
-      '../src/econCommitteeCharter.js',
+      '@agoric/inter-protocol/src/econCommitteeCharter.js',
       '../bundles/bundle-econCommitteeCharter.js',
     ],
     [
-      '../src/price/fluxAggregatorContract.js',
+      '@agoric/inter-protocol/src/price/fluxAggregatorContract.js',
       '../bundles/bundle-fluxAggregatorKit.js',
     ],
   ],

package/src/auction/auctionBook.d.ts

@@ -0,0 +1,147 @@
+export function makeOfferSpecShape(bidBrand: Brand<"nat">, collateralBrand: Brand<"nat">): import("@endo/patterns").Matcher;
+export function prepareAuctionBook(baggage: Baggage, zcf: ZCF, makeRecorderKit: import("@agoric/zoe/src/contractSupport/recorder.js").MakeRecorderKit): (bidBrand: globalThis.Brand<"nat">, collateralBrand: globalThis.Brand<"nat">, pAuthority: PriceAuthority, node: globalThis.StorageNode) => ReturnType<(bidBrand: globalThis.Brand<"nat">, collateralBrand: globalThis.Brand<"nat">, pAuthority: PriceAuthority, node: globalThis.StorageNode) => import("@endo/exo").GuardedKit<{
+    helper: {
+        /**
+         * remove the key from the appropriate book, indicated by whether the
+         * price is defined.
+         *
+         * @param {string} key
+         * @param {Ratio | undefined} price
+         */
+        removeFromItsBook(key: string, price: Ratio | undefined): void;
+        /**
+         * Update the entry in the appropriate book, indicated by whether the
+         * price is defined.
+         *
+         * @param {string} key
+         * @param {Amount} collateralSold
+         * @param {Ratio | undefined} price
+         */
+        updateItsBook(key: string, collateralSold: Amount, price: Ratio | undefined): void;
+        /**
+         * Settle with seat. The caller is responsible for updating the book, if
+         * any.
+         *
+         * @param {ZCFSeat} seat
+         * @param {Amount<'nat'>} collateralWanted
+         */
+        settle(seat: ZCFSeat, collateralWanted: Amount<"nat">): import("@agoric/ertp").NatAmount;
+        /**
+         * Accept an offer expressed as a price. If the auction is active,
+         * attempt to buy collateral. If any of the offer remains add it to the
+         * book.
+         *
+         * @param {ZCFSeat} seat
+         * @param {Ratio} price
+         * @param {Amount<'nat'>} maxBuy
+         * @param {object} opts
+         * @param {boolean} opts.trySettle
+         * @param {boolean} [opts.exitAfterBuy]
+         */
+        acceptPriceOffer(seat: ZCFSeat, price: Ratio, maxBuy: Amount<"nat">, { trySettle, exitAfterBuy }: {
+            trySettle: boolean;
+            exitAfterBuy?: boolean | undefined;
+        }): void;
+        /**
+         * Accept an offer expressed as a discount (or markup). If the auction
+         * is active, attempt to buy collateral. If any of the offer remains add
+         * it to the book.
+         *
+         * @param {ZCFSeat} seat
+         * @param {Ratio} bidScaling
+         * @param {Amount<'nat'>} maxBuy
+         * @param {object} opts
+         * @param {boolean} opts.trySettle
+         * @param {boolean} [opts.exitAfterBuy]
+         */
+        acceptScaledBidOffer(seat: ZCFSeat, bidScaling: Ratio, maxBuy: Amount<"nat">, { trySettle, exitAfterBuy }: {
+            trySettle: boolean;
+            exitAfterBuy?: boolean | undefined;
+        }): void;
+        publishBookData(): Promise<void>;
+        observeQuoteNotifier(): void;
+    };
+    self: {
+        /**
+         * @param {Amount<'nat'>} assetAmount
+         * @param {ZCFSeat} sourceSeat
+         * @param {Amount<'nat'>} [proceedsGoal] an amount that the depositor
+         *   would like to raise. The auction is requested to not sell more
+         *   collateral than required to raise that much. The auctioneer might
+         *   sell more if there is more than one supplier of collateral, and
+         *   they request inconsistent limits.
+         */
+        addAssets(assetAmount: Amount<"nat">, sourceSeat: ZCFSeat, proceedsGoal?: import("@agoric/ertp").NatAmount | undefined): void;
+        /** @type {(reduction: Ratio) => void} */
+        settleAtNewRate(reduction: Ratio): void;
+        getCurrentPrice(): Ratio | null;
+        hasOrders(): boolean;
+        captureOraclePriceForRound(): void;
+        setStartingRate(rate: any): void;
+        /**
+         * @param {OfferSpec} offerSpec
+         * @param {ZCFSeat} seat
+         * @param {boolean} trySettle
+         */
+        addOffer(offerSpec: OfferSpec, seat: ZCFSeat, trySettle: boolean): void;
+        getSeats(): {
+            collateralSeat: ZCFSeat;
+            bidHoldingSeat: ZCFSeat;
+        };
+        exitAllSeats(): void;
+        endAuction(): void;
+        getDataUpdates(): globalThis.Subscriber<BookDataNotification>;
+        getPublicTopics(): {
+            bookData: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<BookDataNotification>;
+        };
+    };
+}>>["self"];
+export type OfferSpec = {
+    maxBuy: Amount<"nat">;
+} & {
+    exitAfterBuy?: boolean;
+} & ({
+    offerPrice: Ratio;
+} | {
+    offerBidScaling: Ratio;
+});
+export type BookDataNotification = {
+    /**
+     * identifies the priceAuthority and price
+     */
+    startPrice: Ratio | null;
+    /**
+     * the price at the current auction
+     * tier
+     */
+    currentPriceLevel: Ratio | null;
+    /**
+     * The proceeds the sellers
+     * were targeting to raise
+     */
+    startProceedsGoal: Amount<"nat"> | null;
+    /**
+     * The remainder of the
+     * proceeds the sellers were targeting to raise
+     */
+    remainingProceedsGoal: Amount<"nat"> | null;
+    /**
+     * The proceeds raised so
+     * far in the auction
+     */
+    proceedsRaised: Amount<"nat"> | undefined;
+    /**
+     * How much collateral was available
+     * for sale at the start. (If more is deposited later, it'll be added in.)
+     */
+    startCollateral: Amount<"nat">;
+    /**
+     * The amount of collateral
+     * remaining
+     */
+    collateralAvailable: Amount<"nat"> | null;
+};
+export type AuctionBook = ReturnType<ReturnType<typeof prepareAuctionBook>>;
+import type { Baggage } from '@agoric/vat-data';
+import type { PriceAuthority } from '@agoric/zoe/tools/types.js';
+//# sourceMappingURL=auctionBook.d.ts.map

package/src/auction/auctionBook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auctionBook.d.ts","sourceRoot":"","sources":["auctionBook.js"],"names":[],"mappings":"AA8EO,6CAHI,KAAK,CAAC,KAAK,CAAC,mBACZ,KAAK,CAAC,KAAK,CAAC,oCAiBtB;AAwBM,4CAJI,OAAO,OACP,GAAG,mBACH,OAAO,6CAA6C,EAAE,eAAe,8IAsoBtE,UAAU;;QA/gBZ;;;;;;WAMG;+BAFQ,MAAM,SACN,KAAK,GAAG,SAAS;QAW5B;;;;;;;WAOG;2BAHQ,MAAM,kBACN,MAAM,SACN,KAAK,GAAG,SAAS;QAW5B;;;;;;WAMG;qBAFQ,OAAO,oBACP,MAAM,CAAC,KAAK,CAAC;QA+DxB;;;;;;;;;;;WAWG;+BANQ,OAAO,SACP,KAAK,UACL,MAAM,CAAC,KAAK,CAAC,+BAErB;YAAsB,SAAS,EAAvB,OAAO;YACQ,YAAY;SAAC;QAsCvC;;;;;;;;;;;WAWG;mCANQ,OAAO,cACP,KAAK,UACL,MAAM,CAAC,KAAK,CAAC,+BAErB;YAAsB,SAAS,EAAvB,OAAO;YACQ,YAAY;SAAC;;;;;QAoGvC;;;;;;;;WAQG;+BAPQ,MAAM,CAAC,KAAK,CAAC,cACb,OAAO;QA4ElB,yCAAyC;mCAAlB,KAAK,GAAK,IAAI;;;;;QAsGrC;;;;WAIG;4BAHQ,SAAS,QACT,OAAO,aACP,OAAO;;;;;;;;;;;;GAqFqB,CAAC,MAAM,CAAC,CAItD;wBAhsBY;IACR,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;CACvB,GAAG;IACF,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,CACE;IACE,UAAU,EAAE,KAAK,CAAC;CACnB,GACD;IACE,eAAe,EAAE,KAAK,CAAC;CACxB,CACJ;;;;;gBAyBQ,KAAK,GAAG,IAAI;;;;;uBACZ,KAAK,GAAG,IAAI;;;;;uBAEZ,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI;;;;;2BAEpB,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI;;;;;oBAEpB,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS;;;;;qBAEzB,MAAM,CAAC,KAAK,CAAC;;;;;yBAEb,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI;;0BAopBpB,UAAU,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC;6BAluBrC,kBAAkB;oCACX,4BAA4B"}