@agoric/smart-wallet 0.5.4-dev-dcc80f2.0.dcc80f2 → 0.5.4-dev-a6c0604.0.a6c0604

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/smart-wallet",
-  "version": "0.5.4-dev-dcc80f2.0.dcc80f2",
+  "version": "0.5.4-dev-a6c0604.0.a6c0604",
   "description": "Wallet contract",
   "type": "module",
   "main": "src/index.js",
@@ -16,9 +16,9 @@
     "lint:eslint": "yarn run -T eslint ."
   },
   "devDependencies": {
-    "@agoric/casting": "0.4.3-dev-dcc80f2.0.dcc80f2",
-    "@agoric/cosmic-proto": "0.4.1-dev-dcc80f2.0.dcc80f2",
-    "@agoric/swingset-vat": "0.32.3-dev-dcc80f2.0.dcc80f2",
+    "@agoric/casting": "0.4.3-dev-a6c0604.0.a6c0604",
+    "@agoric/cosmic-proto": "0.4.1-dev-a6c0604.0.a6c0604",
+    "@agoric/swingset-vat": "0.32.3-dev-a6c0604.0.a6c0604",
     "@endo/bundle-source": "^4.1.2",
     "@endo/captp": "^4.4.8",
     "@endo/init": "^1.1.12",
@@ -26,15 +26,15 @@
     "import-meta-resolve": "^4.1.0"
   },
   "dependencies": {
-    "@agoric/ertp": "0.16.3-dev-dcc80f2.0.dcc80f2",
-    "@agoric/internal": "0.3.3-dev-dcc80f2.0.dcc80f2",
-    "@agoric/notifier": "0.6.3-dev-dcc80f2.0.dcc80f2",
-    "@agoric/store": "0.9.3-dev-dcc80f2.0.dcc80f2",
-    "@agoric/vat-data": "0.5.3-dev-dcc80f2.0.dcc80f2",
-    "@agoric/vats": "0.15.2-dev-dcc80f2.0.dcc80f2",
-    "@agoric/vow": "0.1.1-dev-dcc80f2.0.dcc80f2",
-    "@agoric/zoe": "0.26.3-dev-dcc80f2.0.dcc80f2",
-    "@agoric/zone": "0.2.3-dev-dcc80f2.0.dcc80f2",
+    "@agoric/ertp": "0.16.3-dev-a6c0604.0.a6c0604",
+    "@agoric/internal": "0.3.3-dev-a6c0604.0.a6c0604",
+    "@agoric/notifier": "0.6.3-dev-a6c0604.0.a6c0604",
+    "@agoric/store": "0.9.3-dev-a6c0604.0.a6c0604",
+    "@agoric/vat-data": "0.5.3-dev-a6c0604.0.a6c0604",
+    "@agoric/vats": "0.15.2-dev-a6c0604.0.a6c0604",
+    "@agoric/vow": "0.1.1-dev-a6c0604.0.a6c0604",
+    "@agoric/zoe": "0.26.3-dev-a6c0604.0.a6c0604",
+    "@agoric/zone": "0.2.3-dev-a6c0604.0.a6c0604",
     "@endo/errors": "^1.2.13",
     "@endo/eventual-send": "^1.3.4",
     "@endo/far": "^1.1.14",
@@ -45,6 +45,7 @@
   },
   "files": [
     "src/",
+    "tools/",
     "source-spec-registry.*"
   ],
   "keywords": [],
@@ -76,5 +77,5 @@
   "engines": {
     "node": "^20.9 || ^22.11"
   },
-  "gitHead": "dcc80f24250a2f7221c8ffbc913d6f289c366313"
+  "gitHead": "a6c06040100171553fdf07d11e906d073c019dee"
 }

package/tools/fixtures/gameAssetContract.d.ts

@@ -0,0 +1,12 @@
+export function start(zcf: ZCF<{
+    joinPrice: Amount;
+}>): Promise<{
+    publicFacet: {
+        makeJoinInvitation: () => Promise<import("@agoric/zoe").Invitation<string, undefined>>;
+    } & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+        makeJoinInvitation: () => Promise<import("@agoric/zoe").Invitation<string, undefined>>;
+    }>;
+}>;
+import type { Amount } from '@agoric/ertp';
+import type { ZCF } from '@agoric/zoe';
+//# sourceMappingURL=gameAssetContract.d.ts.map

package/tools/fixtures/gameAssetContract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gameAssetContract.d.ts","sourceRoot":"","sources":["gameAssetContract.js"],"names":[],"mappings":"AA8BO,2BAFI,IAAI;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC;;;;;;GA6CpC;4BA3DwB,cAAc;yBAFjB,aAAa"}

package/tools/fixtures/gameAssetContract.js

@@ -0,0 +1,75 @@
+/** @file illustrates using non-vbank assets */
+
+// deep import to avoid dependency on all of ERTP, vat-data
+import { Fail, q } from '@endo/errors';
+import { E, Far } from '@endo/far';
+
+import { AmountShape } from '@agoric/ertp/src/typeGuards.js';
+import { AmountMath, AssetKind } from '@agoric/ertp/src/amountMath.js';
+import { makeTracer } from '@agoric/internal';
+import { M, getCopyBagEntries } from '@agoric/store';
+
+/**
+ * @import {ZCF} from '@agoric/zoe';
+ * @import {ZCFSeat} from '@agoric/zoe';
+ * @import {Amount} from '@agoric/ertp';
+ */
+
+const trace = makeTracer('Game', true);
+
+/** @param {Amount<'copyBag'>} amt */
+const totalPlaces = amt => {
+  /** @type {[unknown, bigint][]} */
+  const entries = getCopyBagEntries(amt.value); // XXX getCopyBagEntries returns any???
+  const total = entries.reduce((acc, [_place, qty]) => acc + qty, 0n);
+  return total;
+};
+
+/**
+ * @param {ZCF<{ joinPrice: Amount }>} zcf
+ */
+export const start = async zcf => {
+  const { joinPrice } = zcf.getTerms();
+  const stableIssuer = await E(zcf.getZoeService()).getFeeIssuer();
+  await zcf.saveIssuer(stableIssuer, 'Price');
+
+  const { zcfSeat: gameSeat } = zcf.makeEmptySeatKit();
+  const mint = await zcf.makeZCFMint('Place', AssetKind.COPY_BAG);
+
+  const joinShape = harden({
+    give: { Price: AmountShape },
+    want: { Places: AmountShape },
+    exit: M.any(),
+  });
+
+  /** @param {ZCFSeat} playerSeat */
+  const joinHook = playerSeat => {
+    const { give, want } = playerSeat.getProposal();
+    trace('join', 'give', give, 'want', want.Places.value);
+
+    AmountMath.isGTE(give.Price, joinPrice) ||
+      Fail`${q(give.Price)} below joinPrice of ${q(joinPrice)}`;
+
+    totalPlaces(want.Places) <= 3n || Fail`only 3 places allowed when joining`;
+
+    // We use the deprecated stage/reallocate API
+    // so that we can test this with the version of zoe on mainnet1B.
+    const tmp = mint.mintGains(want);
+    zcf.atomicRearrange(
+      harden([
+        [playerSeat, gameSeat, give],
+        [tmp, playerSeat, want],
+      ]),
+    );
+    playerSeat.exit(true);
+    return 'welcome to the game';
+  };
+
+  const publicFacet = Far('API', {
+    makeJoinInvitation: () =>
+      zcf.makeInvitation(joinHook, 'join', undefined, joinShape),
+  });
+
+  return harden({ publicFacet });
+};
+harden(start);

package/tools/fixtures/start-game1-proposal.d.ts

@@ -0,0 +1,14 @@
+export function startGameContract(permittedPowers: BootstrapPowers): Promise<void>;
+export function getManifestForGame1({ restoreRef }: {
+    restoreRef: any;
+}, { game1Ref }: {
+    game1Ref: any;
+}): {
+    manifest: BootstrapManifest;
+    installations: {
+        game1: any;
+    };
+};
+import type { BootstrapPowers } from '@agoric/vats/src/core/types.js';
+import type { BootstrapManifest } from '@agoric/vats/src/core/lib-boot.js';
+//# sourceMappingURL=start-game1-proposal.d.ts.map

package/tools/fixtures/start-game1-proposal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-game1-proposal.d.ts","sourceRoot":"","sources":["start-game1-proposal.js"],"names":[],"mappings":"AA+CO,mDAFI,eAAe,iBAiDzB;AAoBM;;;;;;;;;EAON;qCA/GiC,gCAAgC;uCAH9B,mCAAmC"}

package/tools/fixtures/start-game1-proposal.js

@@ -0,0 +1,122 @@
+// @ts-check
+import { Fail } from '@endo/errors';
+import { E } from '@endo/far';
+import { makeMarshal } from '@endo/marshal';
+import { AmountMath } from '@agoric/ertp/src/amountMath.js';
+
+/**
+ * @import {BootstrapManifest} from '@agoric/vats/src/core/lib-boot.js';
+ * @import {StorageNode} from '@agoric/internal/src/lib-chainStorage.js';
+ * @import {ERef} from '@agoric/vow';
+ * @import {BootstrapPowers} from '@agoric/vats/src/core/types.js';
+ */
+
+// vstorage paths under published.*
+const BOARD_AUX = 'boardAux';
+
+const marshalData = makeMarshal(_val => Fail`data only`);
+
+const IST_UNIT = 1_000_000n;
+const CENT = IST_UNIT / 100n;
+
+/**
+ * Make a storage node for auxiliary data for a value on the board.
+ *
+ * @param {ERef<StorageNode>} chainStorage
+ * @param {string} boardId
+ */
+const makeBoardAuxNode = async (chainStorage, boardId) => {
+  const boardAux = E(chainStorage).makeChildNode(BOARD_AUX);
+  return E(boardAux).makeChildNode(boardId);
+};
+
+const publishBrandInfo = async (chainStorage, board, brand) => {
+  const [id, displayInfo] = await Promise.all([
+    E(board).getId(brand),
+    E(brand).getDisplayInfo(),
+  ]);
+  const node = makeBoardAuxNode(chainStorage, id);
+  const aux = marshalData.toCapData(harden({ displayInfo }));
+  await E(node).setValue(JSON.stringify(aux));
+};
+
+/**
+ * Core eval script to start contract
+ *
+ * @param {BootstrapPowers} permittedPowers
+ */
+export const startGameContract = async permittedPowers => {
+  const {
+    consume: { agoricNames, board, chainStorage, startUpgradable, zoe },
+    brand: {
+      // @ts-expect-error dynamic extension to promise space
+      produce: { Place: producePlaceBrand },
+    },
+    issuer: {
+      // @ts-expect-error dynamic extension to promise space
+      produce: { Place: producePlaceIssuer },
+    },
+    instance: {
+      // @ts-expect-error dynamic extension to promise space
+      produce: { game1: produceInstance },
+    },
+  } = permittedPowers;
+
+  const istBrand = await E(agoricNames).lookup('brand', 'IST');
+  const ist = {
+    brand: istBrand,
+  };
+  // NOTE: joinPrice could be configurable
+  const terms = { joinPrice: AmountMath.make(ist.brand, 25n * CENT) };
+
+  // agoricNames can be updated on each bootstrap run; the promise-space
+  // producers resolve only once and then remain fixed.
+  const installation = await E(agoricNames).lookup('installation', 'game1');
+
+  const { instance } = await E(startUpgradable)({
+    installation,
+    label: 'game1',
+    terms,
+  });
+  const {
+    brands: { Place: brand },
+    issuers: { Place: issuer },
+  } = await E(zoe).getTerms(instance);
+
+  produceInstance.reset();
+  produceInstance.resolve(instance);
+
+  producePlaceBrand.reset();
+  producePlaceIssuer.reset();
+  producePlaceBrand.resolve(brand);
+  producePlaceIssuer.resolve(issuer);
+
+  await publishBrandInfo(chainStorage, board, brand);
+};
+
+/** @type {BootstrapManifest} */
+const gameManifest = {
+  [startGameContract.name]: {
+    consume: {
+      agoricNames: true,
+      board: true, // to publish boardAux info for game NFT
+      chainStorage: true, // to publish boardAux info for game NFT
+      startUpgradable: true, // to start contract and save adminFacet
+      zoe: true, // to get contract terms, including issuer/brand
+    },
+    installation: { consume: { game1: true } },
+    issuer: { produce: { Place: true } },
+    brand: { produce: { Place: true } },
+    instance: { produce: { game1: true } },
+  },
+};
+harden(gameManifest);
+
+export const getManifestForGame1 = ({ restoreRef }, { game1Ref }) => {
+  return harden({
+    manifest: gameManifest,
+    installations: {
+      game1: restoreRef(game1Ref),
+    },
+  });
+};

package/tools/wf-tools.d.ts

@@ -0,0 +1,81 @@
+export function makeBootstrap({ root }?: {
+    root?: string | undefined;
+}): Promise<{
+    agoricNames: import("@agoric/vats").NameHub<any>;
+    agoricNamesAdmin: import("@agoric/vats").NameAdmin;
+    board: import("@endo/exo").Guarded<{
+        getId(value: import("@endo/pass-style").RemotableObject): string;
+        getValue(id: BoardId): import("@endo/pass-style").RemotableObject;
+        lookup(...path: string[]): Promise<any>;
+        has(val: import("@endo/pass-style").RemotableObject): boolean;
+        ids(): string[];
+        getPublishingMarshaller(): import("@endo/exo").Guarded<{
+            toCapData(val: any): import("@endo/marshal").CapData<string>;
+            fromCapData(data: any): any;
+            serialize(data: any): import("@endo/marshal").CapData<string>;
+            unserialize(data: any): any;
+        }>;
+        getReadonlyMarshaller(): import("@endo/exo").Guarded<{
+            toCapData(val: any): import("@endo/marshal").CapData<string | null>;
+            fromCapData(data: any): any;
+            serialize(data: any): import("@endo/marshal").CapData<string | null>;
+            unserialize(data: any): any;
+        }>;
+    }>;
+    bankManager: import("@endo/exo").Guarded<{
+        getAssetSubscription(): import("@agoric/notifier").IterableEachTopic<AssetDescriptor>;
+        getRewardDistributorDepositFacet(denom: string, feeKit: AssetIssuerKit): import("@endo/eventual-send").ERef<import("@endo/eventual-send").EOnly<import("@agoric/ertp").DepositFacet>>;
+        getModuleAccountAddress(moduleName: string): Promise<string | null>;
+        addAsset(denom: string, issuerName: string, proposedName: string, kit: AssetIssuerKit & {
+            payment?: import("@endo/eventual-send").ERef<import("@agoric/ertp").Payment<"nat">>;
+        }): Promise<void>;
+        getBankForAddress(address: string): Promise<Bank>;
+    }>;
+    namesByAddress: import("@agoric/vats").NameHub<any>;
+    namesByAddressAdmin: import("@agoric/vats").NameAdmin;
+    storage: {
+        rootNode: import("@endo/exo").Guarded<{
+            getPath(): string;
+            getStoreKey(): Promise<VStorageKey>;
+            makeChildNode(name: string, childNodeOptions?: {
+                sequence?: boolean;
+            }): StorageNode;
+            setValue(value: string): Promise<void>;
+        }>;
+        data: Map<string, string>;
+        updateNewCellBlockHeight: (blockHeight?: number) => void;
+        getValues: (path: string) => string[];
+        messages: import("@agoric/internal/src/lib-chainStorage.js").StorageMessage[];
+        toStorage: ((message: import("@agoric/internal/src/lib-chainStorage.js").StorageMessage) => string | number | true | any[] | {
+            storeName: string;
+            storeSubkey: string;
+        } | null) & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, (message: import("@agoric/internal/src/lib-chainStorage.js").StorageMessage) => string | number | true | any[] | {
+            storeName: string;
+            storeSubkey: string;
+        } | null>;
+    };
+    zoe: import("@endo/exo").Guarded<import("@agoric/zoe").ZoeService>;
+    utils: {
+        pourPayment: (amount: import("@agoric/ertp").Amount<"nat">) => Promise<import("@agoric/ertp").Payment<"nat">>;
+        bundleAndInstall: (pathOrExports: object, bundleId?: string) => Promise<Installation>;
+        readLegible: (path: string) => Promise<{
+            structure: any;
+            slots: any;
+        }>;
+        getTestJig: () => any;
+    };
+}>;
+export function deploy({ boot }?: {
+    boot?: typeof makeBootstrap;
+}): Promise<{
+    walletFactoryFacets: StartedInstanceKit<wfExports.start>;
+    bootstrap: Awaited<ReturnType<typeof makeBootstrap>>;
+    provisionSmartWallet: (addr: string) => Promise<[SmartWallet, boolean]>;
+    testJig: SmartWalletTestJig;
+}>;
+import type { Installation } from '@agoric/zoe';
+import * as wfExports from '../src/walletFactory.js';
+import type { StartedInstanceKit } from '@agoric/zoe/src/zoeService/utils.js';
+import type { SmartWallet } from '../src/smartWallet.js';
+import type { SmartWalletTestJig } from '../src/smartWallet.js';
+//# sourceMappingURL=wf-tools.d.ts.map

package/tools/wf-tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wf-tools.d.ts","sourceRoot":"","sources":["wf-tools.js"],"names":[],"mappings":"AA2BO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAiG6riB,CAAC;;;;;;;;;;;wBAA1he,CAAC;;;;;;;;;;;;;;;;;;;;4BAnE9pE,MAAM;;;;;;GAiBnB;AAWM,kCARI;IAAE,IAAI,CAAC,EAAE,OAAO,aAAa,CAAA;CAAE,GAC7B,OAAO,CAAC;IAChB,mBAAmB,EAAE,mBAAmB,eAAO,CAAC,CAAC;IACjD,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC;IACrD,oBAAoB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;IACxE,OAAO,EAAE,kBAAkB,CAAC;CAC7B,CAAC,CAwCJ;kCA3G8B,aAAa;2BANjB,yBAAyB;wCAKf,qCAAqC;iCADxB,uBAAuB;wCAAvB,uBAAuB"}

package/tools/wf-tools.js

@@ -0,0 +1,124 @@
+import { VBankAccount } from '@agoric/internal';
+import { makeFakeStorageKit } from '@agoric/internal/src/storage-test-utils.js';
+import { eventLoopIteration } from '@agoric/internal/src/testing-utils.js';
+import { makeNameHubKit } from '@agoric/vats';
+import { makeWellKnownSpaces } from '@agoric/vats/src/core/utils.js';
+import { makeFakeBankManagerKit } from '@agoric/vats/tools/bank-utils.js';
+import { makeFakeBoard } from '@agoric/vats/tools/board-utils.js';
+import { setUpZoeForTest } from '@agoric/zoe/tools/setup-zoe.js';
+import { E } from '@endo/eventual-send';
+import { passStyleOf } from '@endo/far';
+import * as wfExports from '../src/walletFactory.js';
+
+/**
+ * @import {start as StartFn} from '../src/walletFactory.js';
+ * @import {SmartWallet, SmartWalletTestJig} from '../src/smartWallet.js'
+ * @import {StartedInstanceKit} from '@agoric/zoe/src/zoeService/utils.js';
+ * @import {Installation} from '@agoric/zoe';
+ */
+
+const ROOT_STORAGE_PATH = 'ROOT';
+
+const getCapDataStructure = cell => {
+  const { body, slots } = JSON.parse(cell);
+  const structure = JSON.parse(body.replace(/^#/, ''));
+  return { structure, slots };
+};
+
+export const makeBootstrap = async ({ root = ROOT_STORAGE_PATH } = {}) => {
+  let testJig;
+  const setJig = jig => (testJig = jig);
+  const getTestJig = () => testJig;
+  const { zoe, bundleAndInstall } = await setUpZoeForTest({ setJig });
+
+  const storage = makeFakeStorageKit(root);
+  const board = makeFakeBoard();
+
+  const { nameHub: agoricNames, nameAdmin: agoricNamesAdmin } =
+    makeNameHubKit();
+  await makeWellKnownSpaces(agoricNamesAdmin);
+  const { nameHub: namesByAddress, nameAdmin: namesByAddressAdmin } =
+    makeNameHubKit();
+
+  const bankBridgeMessages = [];
+  const { bankManager, pourPayment } = await makeFakeBankManagerKit({
+    onToBridge: obj => bankBridgeMessages.push(obj),
+  });
+
+  const feeIssuer = await E(zoe).getFeeIssuer();
+  const feeBrand = await E(feeIssuer).getBrand();
+  await E(bankManager).addAsset('uist', 'IST', 'IST', {
+    issuer: feeIssuer,
+    brand: feeBrand,
+  });
+  await E(E(agoricNamesAdmin).lookupAdmin('issuer')).update('IST', feeIssuer);
+  await E(E(agoricNamesAdmin).lookupAdmin('brand')).update('IST', feeBrand);
+  board.getId(feeBrand);
+
+  /** @param {string} path */
+  const readLegible = async path => {
+    await eventLoopIteration();
+    return getCapDataStructure(storage.getValues(path).at(-1));
+  };
+
+  return {
+    agoricNames,
+    agoricNamesAdmin,
+    board,
+    bankManager,
+    namesByAddress,
+    namesByAddressAdmin,
+    storage,
+    zoe,
+    utils: { pourPayment, bundleAndInstall, readLegible, getTestJig },
+  };
+};
+
+/**
+ * @param {{ boot?: typeof makeBootstrap }} param0
+ * @returns {Promise<{
+ *   walletFactoryFacets: StartedInstanceKit<StartFn>;
+ *   bootstrap: Awaited<ReturnType<typeof makeBootstrap>>;
+ *   provisionSmartWallet: (addr: string) => Promise<[SmartWallet, boolean]>;
+ *   testJig: SmartWalletTestJig;
+ * }>}
+ */
+export const deploy = async ({ boot = makeBootstrap } = {}) => {
+  const bootstrap = await boot();
+  const { zoe, utils } = bootstrap;
+
+  /** @type {Installation<StartFn>} */
+  const installation = await utils.bundleAndInstall(wfExports);
+  assert.equal(passStyleOf(installation), 'remotable');
+
+  const { agoricNames, board, bankManager, storage } = bootstrap;
+  const storageNode = storage.rootNode.makeChildNode('wallet');
+
+  const assetPublisher = await bankManager.getBankForAddress(
+    VBankAccount.provision.address,
+  );
+  const walletFactoryFacets = await E(zoe).startInstance(
+    installation,
+    {},
+    {
+      agoricNames,
+      board,
+      assetPublisher,
+    },
+    { storageNode },
+  );
+
+  const { creatorFacet } = walletFactoryFacets;
+  const { namesByAddressAdmin } = bootstrap;
+
+  /** @param {string} addr */
+  const provisionSmartWallet = async addr => {
+    const bank = bankManager.getBankForAddress(addr);
+    return E(creatorFacet).provideSmartWallet(addr, bank, namesByAddressAdmin);
+  };
+
+  /** @type {SmartWalletTestJig} */
+  const testJig = utils.getTestJig();
+
+  return { walletFactoryFacets, bootstrap, provisionSmartWallet, testJig };
+};