@agoric/inter-protocol 0.16.2-dev-2da8e5c.0.2da8e5c → 0.16.2-dev-57c6564.0.57c6564

package/src/provisionPool.js

@@ -1,145 +0,0 @@
-import {
-  handleParamGovernance,
-  ParamTypes,
-  publicMixinAPI,
-} from '@agoric/governance';
-import { InvitationShape } from '@agoric/governance/src/typeGuards.js';
-import { wrapRemoteMarshaller } from '@agoric/internal/src/marshal/wrap-marshaller.js';
-import { M } from '@agoric/store';
-import { prepareExo } from '@agoric/vat-data';
-import { provideSingleton } from '@agoric/zoe/src/contractSupport/durability.js';
-import { prepareRecorderKitMakers } from '@agoric/zoe/src/contractSupport/recorder.js';
-import { TopicsRecordShape } from '@agoric/zoe/src/contractSupport/topics.js';
-import { makeDurableZone } from '@agoric/zone/durable.js';
-import {
-  prepareBridgeProvisionTool,
-  prepareProvisionPoolKit,
-} from './provisionPoolKit.js';
-
-/**
- * @import {Remote} from '@agoric/internal';
- * @import {Amount, Brand, Payment, Purse} from '@agoric/ertp';
- * @import {ContractMeta, Invitation, StandardTerms, ZCF} from '@agoric/zoe';
- * @import {GovernanceTerms} from '@agoric/governance/src/types.js';
- * @import {ERef} from '@endo/far';
- * @import {Bank} from '@agoric/vats/src/vat-bank.js';
- * @import {MetricsNotification} from './provisionPoolKit.js';
- * @import {Baggage} from '@agoric/vat-data';
- * @import {StorageNode} from '@agoric/internal/src/lib-chainStorage.js';
- * @import {Marshaller} from '@agoric/internal/src/lib-chainStorage.js';
- */
-
-/** @type {ContractMeta<typeof start>} */
-export const meta = {
-  // @ts-expect-error splitRecord loses the property keys
-  privateArgsShape: M.splitRecord(
-    {
-      poolBank: M.eref(M.remotable('bank')),
-      storageNode: M.eref(M.remotable('storageNode')),
-      marshaller: M.eref(M.remotable('marshaller')),
-    },
-    {
-      // only necessary on first invocation, not subsequent
-      initialPoserInvitation: InvitationShape,
-      metricsOverride: M.recordOf(M.string()),
-    },
-  ),
-  upgradability: 'canUpgrade',
-};
-harden(meta);
-
-/**
- * @typedef {StandardTerms &
- *   GovernanceTerms<{
- *     PerAccountInitialAmount: 'amount';
- *   }>} ProvisionTerms
- *   TODO: ERef<GovernedCreatorFacet<ProvisionCreator>>
- * @param {ZCF<ProvisionTerms>} zcf
- * @param {{
- *   poolBank: ERef<Bank>;
- *   initialPoserInvitation: Invitation;
- *   storageNode: Remote<StorageNode>;
- *   marshaller: Remote<Marshaller>;
- *   metricsOverride?: MetricsNotification;
- *   governedParamOverrides?: Record<string, Amount | undefined>;
- * }} privateArgs
- * @param {Baggage} baggage
- */
-export const start = async (zcf, privateArgs, baggage) => {
-  const { poolBank, metricsOverride } = privateArgs;
-
-  const { marshaller: remoteMarshaller } = privateArgs;
-  const cachingMarshaller = wrapRemoteMarshaller(remoteMarshaller);
-
-  const { makeRecorderKit } = prepareRecorderKitMakers(
-    baggage,
-    cachingMarshaller,
-  );
-
-  // Governance
-  const { publicMixin, makeDurableGovernorFacet, params } =
-    await handleParamGovernance(
-      zcf,
-      privateArgs.initialPoserInvitation,
-      {
-        PerAccountInitialAmount: ParamTypes.AMOUNT,
-      },
-      privateArgs.storageNode,
-      privateArgs.marshaller,
-      privateArgs.governedParamOverrides,
-    );
-
-  const zone = makeDurableZone(baggage);
-
-  const makeBridgeProvisionTool = prepareBridgeProvisionTool(zone);
-  const makeProvisionPoolKit = prepareProvisionPoolKit(zone, {
-    makeRecorderKit,
-    params,
-    poolBank,
-    zcf,
-    makeBridgeProvisionTool,
-  });
-
-  const poolBrand = /** @type {Brand<'nat'>} */ (
-    params.getPerAccountInitialAmount().brand
-  );
-  const provisionPoolKit = await provideSingleton(
-    baggage,
-    'provisionPoolKit',
-    () =>
-      makeProvisionPoolKit({
-        poolBrand,
-        storageNode: privateArgs.storageNode,
-      }),
-  );
-  provisionPoolKit.helper.start(poolBrand, { metrics: metricsOverride });
-
-  const publicFacet = prepareExo(
-    baggage,
-    'Provisioning Pool public',
-    M.interface('ProvisionPool', {
-      getMetrics: M.callWhen().returns(M.remotable('MetricsSubscriber')),
-      getPublicTopics: M.callWhen().returns(TopicsRecordShape),
-      ...publicMixinAPI,
-    }),
-    {
-      async getMetrics() {
-        await null;
-        return provisionPoolKit.public.getPublicTopics().metrics.subscriber;
-      },
-      async getPublicTopics() {
-        await null;
-        return provisionPoolKit.public.getPublicTopics();
-      },
-      ...publicMixin,
-    },
-  );
-
-  return harden({
-    creatorFacet: makeDurableGovernorFacet(baggage, provisionPoolKit.machine)
-      .governorFacet,
-    publicFacet,
-  });
-};
-
-harden(start);

package/src/provisionPoolKit.d.ts

@@ -1,81 +0,0 @@
-export function prepareBridgeProvisionTool(zone: Zone): (bankManager: ERef<import("@endo/exo").Guarded<{
-    getAssetSubscription(): import("@agoric/notifier").IterableEachTopic<AssetDescriptor>;
-    getRewardDistributorDepositFacet(denom: string, feeKit: AssetIssuerKit): ERef<import("@endo/far").EOnly<import("@agoric/ertp").DepositFacet>>;
-    getModuleAccountAddress(moduleName: string): Promise<string | null>;
-    addAsset(denom: string, issuerName: string, proposedName: string, kit: AssetIssuerKit & {
-        payment?: ERef<Payment<"nat">>;
-    }): Promise<void>;
-    getBankForAddress(address: string): Promise<Bank>;
-}>>, walletFactory: ERef<import("@endo/exo").Guarded<{
-    provideSmartWallet(address: string, bank: ERef<Bank>, namesByAddressAdmin: ERef<NameAdmin>): Promise<[wallet: import("@agoric/smart-wallet/src/smartWallet.js").SmartWallet, isNew: boolean]>;
-}>>, namesByAddressAdmin: ERef<NameAdmin>, forHandler: any) => import("@endo/exo").Guarded<{
-    /** @param {BridgeMessage} obj */
-    fromBridge(obj: BridgeMessage): Promise<void>;
-}>;
-export function prepareProvisionPoolKit(zone: Zone, { makeRecorderKit, params, poolBank, zcf, makeBridgeProvisionTool }: {
-    makeRecorderKit: MakeRecorderKit;
-    params: any;
-    poolBank: ERef<Bank>;
-    zcf: ZCF;
-    makeBridgeProvisionTool: ReturnType<typeof prepareBridgeProvisionTool>;
-}): ({ poolBrand, storageNode }: {
-    poolBrand: Brand<"nat">;
-    storageNode: ERemote<StorageNode>;
-}) => Promise<ProvisionPoolKit>;
-export type ProvisionPoolKit = {
-    machine: {
-        addRevivableAddresses: (oldAddresses: string[]) => void;
-        getWalletReviver: () => ERef<any>;
-        setReferences: (erefs: ProvisionPoolKitReferences) => Promise<void>;
-        makeHandler: () => ERef<BridgeHandler>;
-        initPSM: (brand: Brand, instance: Instance<typeof psmStart>) => void;
-    };
-    helper: any;
-    forHandler: any;
-    public: any;
-};
-export type PsmInstance = Instance<typeof psmStart>;
-export type ProvisionPoolKitReferences = {
-    bankManager: ERef<BankManager>;
-    namesByAddressAdmin: ERef<NameAdmin>;
-    walletFactory: ERef<WalletFactoryStartResult["creatorFacet"]>;
-};
-/**
- * Metrics naming scheme is that nouns are
- *   present values and past-participles are accumulative.
- */
-export type MetricsNotification = {
-    /**
-     * count of new wallets provisioned
-     */
-    walletsProvisioned: bigint;
-    /**
-     * running sum of Minted provided
-     * to new wallets
-     */
-    totalMintedProvided: Amount<"nat">;
-    /**
-     * running sum of Minted ever
-     * received by the contract from PSM
-     */
-    totalMintedConverted: Amount<"nat">;
-};
-import type { Zone } from '@agoric/zone';
-import type { AssetDescriptor } from '@agoric/vats/src/vat-bank.js';
-import type { ERef } from '@endo/far';
-import type { Payment } from '@agoric/ertp';
-import type { Bank } from '@agoric/vats/src/vat-bank.js';
-import type { NameAdmin } from '@agoric/vats';
-import type { BridgeMessage } from '@agoric/cosmic-swingset/src/types.js';
-import type { MakeRecorderKit } from '@agoric/zoe/src/contractSupport/recorder.js';
-import type { ZCF } from '@agoric/zoe';
-import type { Brand } from '@agoric/ertp';
-import type { StorageNode } from '@agoric/internal/src/lib-chainStorage.js';
-import type { ERemote } from '@agoric/internal';
-import type { BridgeHandler } from '@agoric/vats';
-import type { start as psmStart } from '@agoric/inter-protocol/src/psm/psm.js';
-import type { Instance } from '@agoric/zoe/src/zoeService/utils.js';
-import type { BankManager } from '@agoric/vats/src/vat-bank.js';
-import type { WalletFactoryStartResult } from '@agoric/vats/src/core/startWalletFactory.js';
-import type { Amount } from '@agoric/ertp';
-//# sourceMappingURL=provisionPoolKit.d.ts.map

package/src/provisionPoolKit.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"provisionPoolKit.d.ts","sourceRoot":"","sources":["provisionPoolKit.js"],"names":[],"mappings":"AAiGO,iDAFI,IAAI;;;;;eA2gBgY,CAAC;;;;;;IAtf1Y,iCAAiC;oBAArB,aAAa;GA6B5B;AAYI,8CATI,IAAI,uEACJ;IACN,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,KAAK,IAAI,CAAC,CAAC;IACrB,GAAG,EAAE,GAAG,CAAC;IACT,uBAAuB,EAAE,UAAU,CAAC,OAAO,0BAA0B,CAAC,CAAC;CACxE,gCA6bC;IAA2B,SAAS,EAA5B,MAAM,KAAK,CAAC;IACe,WAAW,EAAtC,QAAQ,WAAW,CAAC;CAC5B,KAAU,OAAO,CAAC,gBAAgB,CAAC,CAevC;+BAjjBY;IACR,OAAO,EAAE;QACP,qBAAqB,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;QACxD,gBAAgB,EAAE,MAAM,KAAK,GAAG,CAAC,CAAC;QAClC,aAAa,EAAE,CAAC,KAAK,EAAE,0BAA0B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACpE,WAAW,EAAE,MAAM,KAAK,aAAa,CAAC,CAAC;QACvC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,eAAe,CAAC,KAAK,IAAI,CAAC;KACtE,CAAC;IACF,MAAM,EAAE,GAAG,CAAC;IACZ,UAAU,EAAE,GAAG,CAAC;IAChB,MAAM,EAAE,GAAG,CAAC;CACb;0BAIS,SAAS,eAAe,CAAC;;iBAKxB,KAAK,WAAW,CAAC;yBACjB,KAAK,SAAS,CAAC;mBACf,KAAK,wBAAwB,CAAC,cAAc,CAAC,CAAC;;;;;;;;;;wBAM9C,MAAM;;;;;yBACN,OAAO,KAAK,CAAC;;;;;0BAEb,OAAO,KAAK,CAAC;;0BA/CJ,cAAc;qCAKH,8BAA8B;0BAZzC,WAAW;6BAJc,cAAc;0BAK1B,8BAA8B;+BAItC,cAAc;mCAVV,sCAAsC;qCAcpC,6CAA6C;yBAVzD,aAAa;2BAHa,cAAc;iCAEhC,0CAA0C;6BADtC,kBAAkB;mCAcpB,cAAc;uCAPV,uCAAuC;8BADhD,qCAAqC;iCAF5B,8BAA8B;8CAKvB,6CAA6C;4BAVxC,cAAc"}