@agoric/inter-protocol 0.16.2-dev-7cc5def.0 → 0.16.2-u11.0

package/scripts/manual-price-feed.js

@@ -0,0 +1,117 @@
+import { E } from '@endo/far';
+import { deeplyFulfilled } from '@endo/marshal';
+import { makeNotifierFromAsyncIterable } from '@agoric/notifier';
+
+import process from 'process';
+
+/**
+ * After extracting the oracleAdmins to entries in home.scratch, you can use one
+ * from the REPL like:
+ *
+ * lookup('agoricNames', 'oracleBrand', 'ATOM').then(brand => atom = brand)
+ * -> [Object Alleged: ATOM brand]{}
+ * lookup('agoricNames', 'oracleBrand', 'USD').then(brand => usd = brand)
+ * -> [Object Alleged: USD brand]{}
+ * pa = home.priceAuthority
+ *  -> [Object Alleged: PriceAuthority]{}
+ * qn = E(pa).makeQuoteNotifier({ value: 1n * 10n ** 6n, brand: atom }, usd)
+ * -> [Object Alleged: QuoteNotifier]{}
+ * oa = E(home.scratch).get("offerResult unknown#1652669688625")
+ * -> [Object Alleged: OracleAdmin]{}
+ * E(oa).pushResult('19.37')
+ * E(qn).getUpdateSince()
+ *
+ * @typedef {{ board: import('@agoric/vats').Board, chainTimerService, scratch, zoe }} Home
+ * @param {Promise<Home>} homePromise
+ * @param {object} root0
+ * @param {(...path: string[]) => Promise<any>} root0.lookup
+ * A promise for the references available from REPL home
+ */
+export default async function priceAuthorityFromNotifier(
+  homePromise,
+  { lookup },
+) {
+  const { AGGREGATOR_INSTANCE_LOOKUP } = process.env;
+
+  // Let's wait for the promise to resolve.
+  const home = await deeplyFulfilled(homePromise);
+
+  let aggregatorInstance;
+  if (AGGREGATOR_INSTANCE_LOOKUP) {
+    aggregatorInstance = await lookup(JSON.parse(AGGREGATOR_INSTANCE_LOOKUP));
+  }
+
+  if (!aggregatorInstance) {
+    console.log('Autodetecting aggregator instance...');
+    const purse = E(home.wallet).getPurse('Default Zoe invite purse');
+    const { value } = await E(purse).getCurrentAmount();
+    const invitations = value.filter(
+      ({ description }) => description === 'oracle invitation',
+    );
+    if (invitations.length > 1) {
+      console.error('Multiple oracle invitations found', invitations);
+      throw Error('You need an AGGREGATOR_INSTANCE_LOOKUP to disambiguate');
+    }
+    if (invitations.length === 0) {
+      console.error(
+        'No oracle invitations found; you may need an AGGREGATOR_INSTANCE_LOOKUP',
+      );
+    } else {
+      console.log('Found oracle invitation', invitations);
+      aggregatorInstance = invitations[0].instance;
+    }
+  }
+
+  if (!aggregatorInstance) {
+    return;
+  }
+
+  const offer = {
+    id: Date.now(),
+    proposalTemplate: {},
+    invitationQuery: {
+      description: 'oracle invitation',
+      instance: aggregatorInstance,
+    },
+  };
+
+  console.log('Getting wallet bridge...');
+  const bridge = await E(home.wallet).getBridge();
+
+  // Consume an aggregator invitation for this instance.
+  await E(bridge)
+    .addOffer(offer)
+    .then(
+      () =>
+        console.log(
+          `Please approve your wallet's proposal to connect the aggregator ${aggregatorInstance}...`,
+        ),
+      () => {},
+    );
+
+  const walletAdmin = E(home.wallet).getAdminFacet();
+
+  console.log('=====================================================');
+  console.log('=== Extracting oracleAdmins from price feed offers...');
+  console.log('=== Control-C to cancel');
+  const offerIt = E(walletAdmin).getOffersNotifier();
+  for await (const offers of makeNotifierFromAsyncIterable(offerIt)) {
+    // console.log(offers);
+    offers
+      .filter(
+        ({ status, invitationQuery: { instance } }) =>
+          status === 'complete' && instance === aggregatorInstance,
+      )
+      .forEach(async ({ id }) => {
+        const orKey = `offerResult ${id}`;
+        await E(home.scratch).set(
+          orKey,
+          E(home.wallet).lookup('offerResult', id),
+        );
+        console.log(
+          'Use this oracleAdmin:',
+          `E(home.scratch).get(${JSON.stringify(orKey)})`,
+        );
+      });
+  }
+}

package/scripts/price-feed-core.js

@@ -0,0 +1,104 @@
+/* global process */
+import { makeHelpers } from '@agoric/deploy-script-support';
+
+const DEFAULT_CONTRACT_TERMS = {
+  POLL_INTERVAL: 30n,
+  maxSubmissionCount: 1000,
+  minSubmissionCount: 2,
+  restartDelay: 1, // the number of rounds an Oracle has to wait before they can initiate another round
+  timeout: 10, // in seconds according to chainTimerService
+  minSubmissionValue: 1n,
+  maxSubmissionValue: 2n ** 256n,
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').ProposalBuilder} */
+export const defaultProposalBuilder = async (
+  { publishRef, install },
+  options = {},
+) => {
+  const {
+    brandIn,
+    brandOut,
+    contractTerms = DEFAULT_CONTRACT_TERMS,
+    AGORIC_INSTANCE_NAME,
+    IN_BRAND_LOOKUP,
+    OUT_BRAND_LOOKUP,
+    IN_BRAND_NAME = IN_BRAND_LOOKUP[IN_BRAND_LOOKUP.length - 1],
+    OUT_BRAND_NAME = OUT_BRAND_LOOKUP[OUT_BRAND_LOOKUP.length - 1],
+    oracleAddresses,
+    ...optionsRest
+  } = options;
+
+  assert(AGORIC_INSTANCE_NAME, 'AGORIC_INSTANCE_NAME is required');
+  assert(Array.isArray(oracleAddresses), 'oracleAddresses array is required');
+
+  if (!brandIn) {
+    assert.equal(IN_BRAND_LOOKUP[0], 'agoricNames');
+    assert(IN_BRAND_NAME);
+  }
+  if (!brandOut) {
+    assert.equal(OUT_BRAND_LOOKUP[0], 'agoricNames');
+    assert(OUT_BRAND_NAME);
+  }
+
+  return harden({
+    sourceSpec: '../src/proposals/price-feed-proposal.js',
+    getManifestCall: [
+      'getManifestForPriceFeed',
+      {
+        ...optionsRest,
+        AGORIC_INSTANCE_NAME,
+        contractTerms,
+        oracleAddresses,
+        IN_BRAND_LOOKUP,
+        OUT_BRAND_LOOKUP,
+        IN_BRAND_NAME,
+        OUT_BRAND_NAME,
+        brandInRef: brandIn && publishRef(brandIn),
+        brandOutRef: brandOut && publishRef(brandOut),
+        priceAggregatorRef: publishRef(
+          install(
+            '@agoric/inter-protocol/src/price/fluxAggregatorContract.js',
+            '../bundles/bundle-fluxAggregatorKit.js',
+          ),
+        ),
+      },
+    ],
+  });
+};
+
+export const createGov = async (homeP, endowments) => {
+  const { lookup } = endowments;
+
+  const {
+    AGORIC_INSTANCE_NAME,
+    IN_BRAND_DECIMALS = '6',
+    IN_BRAND_LOOKUP = JSON.stringify(['wallet', 'brand', 'BLD']),
+    OUT_BRAND_DECIMALS = '6',
+    OUT_BRAND_LOOKUP = JSON.stringify(['agoricNames', 'oracleBrand', 'USD']),
+    ORACLE_ADDRESSES,
+  } = process.env;
+
+  assert(AGORIC_INSTANCE_NAME, 'AGORIC_INSTANCE_NAME is required');
+  assert(ORACLE_ADDRESSES, 'ORACLE_ADDRESSES is required');
+
+  const oracleAddresses = ORACLE_ADDRESSES.split(',');
+
+  const { writeCoreProposal } = await makeHelpers(homeP, endowments);
+
+  const inLookup = JSON.parse(IN_BRAND_LOOKUP);
+  const outLookup = JSON.parse(OUT_BRAND_LOOKUP);
+
+  const proposalBuilder = powers =>
+    defaultProposalBuilder(powers, {
+      AGORIC_INSTANCE_NAME,
+      IN_BRAND_DECIMALS: parseInt(IN_BRAND_DECIMALS, 10),
+      OUT_BRAND_DECIMALS: parseInt(OUT_BRAND_DECIMALS, 10),
+      oracleAddresses,
+      brandIn: lookup(inLookup).catch(() => undefined),
+      brandOut: lookup(outLookup).catch(() => undefined),
+    });
+  await writeCoreProposal('gov-price-feed', proposalBuilder); // gov-price-feed.js gov-price-feed-permit.json
+};
+
+export default createGov;

package/scripts/start-local-chain.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+#
+# Start a chain with "economy" and provision wallet to use it
+#
+
+# run an Archive node to keep all history https://docs.desmos.network/fullnode/overview/
+# (the Makefile passes this to agd start)
+export AGC_START_ARGS="--pruning=nothing"
+
+CHAIN_LOG=$(mktemp -t Agoric-start-local-chain-log-XXXXXXX)
+if [[ $(uname) == "Darwin" ]]; then
+    open -a /System/Applications/Utilities/Console.app "$CHAIN_LOG"
+fi
+
+# ugly way to get SDK path regardless of cwd
+SDK=$(readlink -f "$(dirname -- "$(readlink -f -- "$0")")/../../..")
+
+WALLET=gov1
+WALLET_BECH32=$(agd keys --keyring-backend=test show "$WALLET" --output json | jq -r .address)
+
+if [ -z "$WALLET_BECH32" ]; then
+    echo "USAGE: $0 wallet-key"
+    # The key must be from the 'test' keyring, for non-interactive use.
+    # To migrate one of your 'os' keys:
+    #   agd keys export the-wallet-key-name > wallet.key
+    #   agd keys import --keyring-backend=test the-wallet-key-name wallet.key
+    exit 1
+fi
+
+# this is in economy-template.json in the oracleAddresses list (agoric1dy0yegdsev4xvce3dx7zrz2ad9pesf5svzud6y)
+# to use it run `agd keys --keyring-backend=test add oracle2 --interactive` and enter this mnenomic:
+# dizzy scale gentle good play scene certain acquire approve alarm retreat recycle inch journey fitness grass minimum learn funny way unlock what buzz upon
+WALLET2=gov2
+WALLET2_BECH32=$(agd keys --keyring-backend=test show "$WALLET2" --output json | jq -r .address)
+if [ -z "$WALLET2_BECH32" ]; then
+    echo "missing oracle2 key in test keyring"
+    exit 1
+fi
+
+echo CHAIN_LOG "$CHAIN_LOG"
+echo SDK "$SDK"
+echo WALLET "$WALLET"
+echo WALLET_BECH32 "$WALLET_BECH32"
+
+cd "$SDK"/packages/cosmic-swingset || exit 1
+
+echo "Logs written to $CHAIN_LOG"
+# specifies the address to use for chain config
+export PRIMARY_ADDRESS=$WALLET_BECH32
+# nobuild variety skips Golang artifacts; if you get errors try make scenario2-setup
+make scenario2-setup-nobuild >>"$CHAIN_LOG" 2>&1
+
+# TODO detect it's already running, indicate when it started and offer to restart
+# e.g. killall node xsnap-worker
+echo "Starting the chain..."
+# use -economy target to get the kitchen sink
+# disable pruning to keep all history https://docs.desmos.network/fullnode/overview/
+make AGC_START_ARGS="--pruning=nothing" CHAIN_BOOTSTRAP_VAT_CONFIG=@agoric/vats/decentral-itest-vaults-config.json scenario2-run-chain >>"$CHAIN_LOG" 2>&1 &
+make wait-for-cosmos
+
+# xxx sleep to let it settle
+sleep 15
+
+echo "Funding the pool..."
+make fund-provision-pool
+
+echo "Funding your wallet account..."
+# After `fund-provision-pool` there is 900 IST remaining for other account funding.
+# A wallet can be tested with 20 BLD for provisioning wallet and 20 USDC for psm trading
+# Also include 1M ATOM
+make ACCT_ADDR="$WALLET_BECH32" FUNDS=20000000ubld,20000000ibc/toyusdc,1000000000000ibc/toyatom fund-acct
+agd query bank balances "$WALLET_BECH32" | grep ubld || exit 1
+
+echo "Provisioning your smart wallet..."
+agoric wallet --keyring-backend=test provision --spend --account "$WALLET"
+echo "waiting for blocks"
+sleep 15
+# verify
+agoric wallet --keyring-backend=test list
+agoric wallet --keyring-backend=test show --from "$WALLET"
+
+echo "Repeating for gov2 account..."
+make ACCT_ADDR="$WALLET2_BECH32" FUNDS=20000000ubld,20000000ibc/toyusdc fund-acct
+agoric wallet --keyring-backend=test provision --spend --account "$WALLET2"

package/src/auction/auctionBook.js

@@ -34,38 +34,34 @@ const DEFAULT_DECIMALS = 9;
 
 /**
  * @file The book represents the collateral-specific state of an ongoing
- *   auction. It holds the book, the capturedPrice, and the collateralSeat that
- *   has the allocation of assets for sale.
- *
- *   The book contains orders for the collateral. It holds two kinds of orders:
+ * auction. It holds the book, the capturedPrice, and the collateralSeat that has
+ * the allocation of assets for sale.
  *
+ * The book contains orders for the collateral. It holds two kinds of
+ * orders:
  *   - Prices express the bidding offer in terms of a Bid amount
- *   - ScaledBids express the offer in terms of a discount (or markup) from the most
- *       recent oracle price.
+ *   - ScaledBids express the offer in terms of a discount (or markup) from the
+ *     most recent oracle price.
  *
- *   Offers can be added in three ways. 1) When the auction is not active, prices
- *   are automatically added to the appropriate collection. When the auction is
- *   active, 2) if a new offer is at or above the current price, it will be
- *   settled immediately; 2) If the offer is below the current price, it will be
- *   added in the appropriate place and settled when the price reaches that
- *   level.
+ * Offers can be added in three ways. 1) When the auction is not active, prices
+ * are automatically added to the appropriate collection. When the auction is
+ * active, 2) if a new offer is at or above the current price, it will be
+ * settled immediately; 2) If the offer is below the current price, it will be
+ * added in the appropriate place and settled when the price reaches that level.
  */
 
 const trace = makeTracer('AucBook', true);
 
 /**
  * @typedef {{
- *   maxBuy: Amount<'nat'>;
+ *   maxBuy: Amount<'nat'>
  * } & {
- *   exitAfterBuy?: boolean;
- * } & (
- *     | {
- *         offerPrice: Ratio;
- *       }
- *     | {
- *         offerBidScaling: Ratio;
- *       }
- *   )} OfferSpec
+ *   exitAfterBuy?: boolean,
+ * } & ({
+ *   offerPrice: Ratio,
+ * } | {
+ *    offerBidScaling: Ratio,
+ * })} OfferSpec
  */
 /**
  * @param {Brand<'nat'>} bidBrand
@@ -92,19 +88,17 @@ export const makeOfferSpecShape = (bidBrand, collateralBrand) => {
 
 /**
  * @typedef {object} BookDataNotification
- * @property {Ratio | null} startPrice identifies the priceAuthority and price
- * @property {Ratio | null} currentPriceLevel the price at the current auction
- *   tier
- * @property {Amount<'nat'> | null} startProceedsGoal The proceeds the sellers
- *   were targeting to raise
- * @property {Amount<'nat'> | null} remainingProceedsGoal The remainder of the
- *   proceeds the sellers were targeting to raise
- * @property {Amount<'nat'> | undefined} proceedsRaised The proceeds raised so
- *   far in the auction
- * @property {Amount<'nat'>} startCollateral How much collateral was available
- *   for sale at the start. (If more is deposited later, it'll be added in.)
- * @property {Amount<'nat'> | null} collateralAvailable The amount of collateral
- *   remaining
+ *
+ * @property {Ratio         | null}      startPrice identifies the priceAuthority and price
+ * @property {Ratio         | null}      currentPriceLevel the price at the current auction tier
+ * @property {Amount<'nat'> | null}      startProceedsGoal The proceeds the sellers were targeting to raise
+ * @property {Amount<'nat'> | null}      remainingProceedsGoal The remainder of
+ *     the proceeds the sellers were targeting to raise
+ * @property {Amount<'nat'> | undefined} proceedsRaised The proceeds raised so far in the auction
+ * @property {Amount<'nat'>}             startCollateral How much collateral was
+ *    available for sale at the start. (If more is deposited later, it'll be
+ *    added in.)
+ * @property {Amount<'nat'> | null}      collateralAvailable The amount of collateral remaining
  */
 
 /**
@@ -237,8 +231,8 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
     {
       helper: {
         /**
-         * remove the key from the appropriate book, indicated by whether the
-         * price is defined.
+         * remove the key from the appropriate book, indicated by whether the price
+         * is defined.
          *
          * @param {string} key
          * @param {Ratio | undefined} price
@@ -253,8 +247,8 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
         },
 
         /**
-         * Update the entry in the appropriate book, indicated by whether the
-         * price is defined.
+         * Update the entry in the appropriate book, indicated by whether the price
+         * is defined.
          *
          * @param {string} key
          * @param {Amount} collateralSold
@@ -270,8 +264,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
         },
 
         /**
-         * Settle with seat. The caller is responsible for updating the book, if
-         * any.
+         * Settle with seat. The caller is responsible for updating the book, if any.
          *
          * @param {ZCFSeat} seat
          * @param {Amount<'nat'>} collateralWanted
@@ -348,16 +341,15 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
         },
 
         /**
-         * 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.
+         *  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]
+         *  @param {ZCFSeat} seat
+         *  @param {Ratio} price
+         *  @param {Amount<'nat'>} maxBuy
+         *  @param {object} opts
+         *  @param {boolean} opts.trySettle
+         *  @param {boolean} [opts.exitAfterBuy]
          */
         acceptPriceOffer(
           seat,
@@ -396,16 +388,16 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
         },
 
         /**
-         * 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.
+         *  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]
+         *  @param {ZCFSeat} seat
+         *  @param {Ratio} bidScaling
+         *  @param {Amount<'nat'>} maxBuy
+         *  @param {object} opts
+         *  @param {boolean} opts.trySettle
+         *  @param {boolean} [opts.exitAfterBuy]
          */
         acceptScaledBidOffer(
           seat,
@@ -474,10 +466,10 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
          * @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.
+         *    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, sourceSeat, proceedsGoal) {
           const { state, facets } = this;
@@ -762,11 +754,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
     },
   );
 
-  /**
-   * @type {(
-   *   ...args: Parameters<typeof makeAuctionBookKit>
-   * ) => ReturnType<typeof makeAuctionBookKit>['self']}
-   */
+  /** @type {(...args: Parameters<typeof makeAuctionBookKit>) => ReturnType<typeof makeAuctionBookKit>['self']} */
   const makeAuctionBook = (...args) => makeAuctionBookKit(...args).self;
   return makeAuctionBook;
 };