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

package/src/provisionPool.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @import {Marshal} from '@endo/marshal';
+ * @import {Amount, Brand, Payment, Purse} from '@agoric/ertp';
+ * @import {ContractMeta, Invitation, StandardTerms, ZCF} from '@agoric/zoe';
+ * @import {GovernanceTerms} from '@agoric/governance/src/types.js';
+ */
+/** @type {ContractMeta} */
+export const meta: ContractMeta;
+export function start(zcf: ZCF<ProvisionTerms>, privateArgs: {
+    poolBank: import("@endo/far").ERef<import("@agoric/vats/src/vat-bank.js").Bank>;
+    initialPoserInvitation: Invitation;
+    storageNode: StorageNode;
+    marshaller: Marshal<any>;
+    metricsOverride?: import("./provisionPoolKit.js").MetricsNotification;
+    governedParamOverrides?: Record<string, Amount | undefined>;
+}, baggage: import("@agoric/vat-data").Baggage): Promise<{
+    creatorFacet: import("@endo/exo").Guarded<{
+        getParamMgrRetriever: () => {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                PerAccountInitialAmount: "amount";
+            } & {
+                Electorate: "invitation";
+            }>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                PerAccountInitialAmount: "amount";
+            } & {
+                Electorate: "invitation";
+            }>;
+        }>;
+        getInvitation: (name: any) => Promise<Invitation>;
+        getLimitedCreatorFacet: () => any;
+        getGovernedApis: () => GovernedApis;
+        getGovernedApiNames: () => string[];
+        setOfferFilter: (strings: any) => Promise<void>;
+    }>;
+    publicFacet: import("@endo/exo").Guarded<{
+        getAmount: (name: string) => Amount;
+        getBrand: (name: string) => Brand;
+        getInstance: (name: string) => Instance;
+        getInstallation: (name: string) => Installation;
+        getInvitationAmount: (name: string) => InvitationAmount;
+        getNat: (name: string) => bigint;
+        getRatio: (name: string) => Ratio;
+        getString: (name: string) => string;
+        getTimestamp: (name: string) => import("@agoric/time").TimestampRecord;
+        getRelativeTime: (name: string) => import("@agoric/time").RelativeTimeRecord;
+        getUnknown: (name: string) => any;
+        getSubscription: () => globalThis.StoredSubscription<globalThis.GovernanceSubscriptionState>;
+        getGovernedParams: () => globalThis.ERef<globalThis.ParamStateRecord>;
+        getMetrics(): Promise<any>;
+        getPublicTopics(): Promise<any>;
+    }>;
+}>;
+/**
+ * TODO: ERef<GovernedCreatorFacet<ProvisionCreator>>
+ */
+export type ProvisionTerms = StandardTerms & GovernanceTerms<{
+    PerAccountInitialAmount: "amount";
+}>;
+import type { ContractMeta } from '@agoric/zoe';
+import type { ZCF } from '@agoric/zoe';
+import type { Invitation } from '@agoric/zoe';
+import type { Marshal } from '@endo/marshal';
+import type { Amount } from '@agoric/ertp';
+import type { Brand } from '@agoric/ertp';
+import type { StandardTerms } from '@agoric/zoe';
+import type { GovernanceTerms } from '@agoric/governance/src/types.js';
+//# sourceMappingURL=provisionPool.d.ts.map

package/src/provisionPool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provisionPool.d.ts","sourceRoot":"","sources":["provisionPool.js"],"names":[],"mappings":"AAmBA;;;;;GAKG;AAEH,2BAA2B;AAC3B,mBADW,YAAY,CAerB;AAsBK,2BAbI,IAAI,cAAc,CAAC,eACnB;IACN,QAAQ,EAAE,OAAO,WAAW,EAAE,IAAI,CACtC,OAAa,8BAA8B,EAAE,IAAI,CAC5C,CAAC;IACF,sBAAsB,EAAE,UAAU,CAAC;IACnC,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,QAAQ,GAAG,CAAC,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,uBAAuB,EAAE,mBAAmB,CAAC;IACtE,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;CAC7D,WACO,OAAO,kBAAkB,EAAE,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0E5C;;;;6BA1FY,aAAa,GACzB,gBAAoB;IACd,uBAAuB,EAAE,QAAQ,CAAC;CACnC,CAAC;kCA1BwD,aAAa;yBAAb,aAAa;gCAAb,aAAa;6BAFlD,eAAe;4BACO,cAAc;2BAAd,cAAc;mCACC,aAAa;qCAC1C,iCAAiC"}

package/src/provisionPool.js

@@ -0,0 +1,138 @@
+// @jessie-check
+
+import {
+  handleParamGovernance,
+  ParamTypes,
+  publicMixinAPI,
+} from '@agoric/governance';
+import { InvitationShape } from '@agoric/governance/src/typeGuards.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 {Marshal} from '@endo/marshal';
+ * @import {Amount, Brand, Payment, Purse} from '@agoric/ertp';
+ * @import {ContractMeta, Invitation, StandardTerms, ZCF} from '@agoric/zoe';
+ * @import {GovernanceTerms} from '@agoric/governance/src/types.js';
+ */
+
+/** @type {ContractMeta} */
+export const meta = {
+  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: import('@endo/far').ERef<
+ *     import('@agoric/vats/src/vat-bank.js').Bank
+ *   >;
+ *   initialPoserInvitation: Invitation;
+ *   storageNode: StorageNode;
+ *   marshaller: Marshal<any>;
+ *   metricsOverride?: import('./provisionPoolKit.js').MetricsNotification;
+ *   governedParamOverrides?: Record<string, Amount | undefined>;
+ * }} privateArgs
+ * @param {import('@agoric/vat-data').Baggage} baggage
+ */
+export const start = async (zcf, privateArgs, baggage) => {
+  const { poolBank, metricsOverride } = privateArgs;
+
+  const { makeRecorderKit } = prepareRecorderKitMakers(
+    baggage,
+    privateArgs.marshaller,
+  );
+
+  // 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

@@ -0,0 +1,129 @@
+export function prepareBridgeProvisionTool(zone: import("@agoric/zone").Zone): (bankManager: ERef<import("@endo/exo").Guarded<{
+    getAssetSubscription(): IterableEachTopic<AssetDescriptor>;
+    getRewardDistributorDepositFacet(denom: string, feeKit: AssetIssuerKit): ERef<import("jessie.js").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<import("@agoric/vats/src/vat-bank.js").Bank>, namesByAddressAdmin: ERef<import("@agoric/vats").NameAdmin>): Promise<[wallet: import("@agoric/smart-wallet/src/smartWallet").SmartWallet, isNew: boolean]>;
+}>>, namesByAddressAdmin: ERef<import("@agoric/vats").NameAdmin>, forHandler: any) => import("@endo/exo").Guarded<{
+    /** @param {BridgeMessage} obj */
+    fromBridge(obj: BridgeMessage): Promise<void>;
+}>;
+export function prepareProvisionPoolKit(zone: import("@agoric/zone").Zone, { makeRecorderKit, params, poolBank, zcf, makeBridgeProvisionTool }: {
+    makeRecorderKit: import("@agoric/zoe/src/contractSupport/recorder.js").MakeRecorderKit;
+    params: any;
+    poolBank: import("@endo/far").ERef<Bank>;
+    zcf: ZCF;
+    makeBridgeProvisionTool: ReturnType<typeof prepareBridgeProvisionTool>;
+}): ({ poolBrand, storageNode }: {
+    poolBrand: Brand<"nat">;
+    storageNode: ERef<StorageNode>;
+}) => Promise<ProvisionPoolKit>;
+export type ProvisionPoolKit = {
+    machine: any;
+    helper: any;
+    forHandler: any;
+    public: any;
+};
+export type PsmInstance = import("@agoric/zoe/src/zoeService/utils.js").Instance<(zcf: ZCF<GovernanceTerms<{
+    GiveMintedFee: "ratio";
+    WantMintedFee: "ratio";
+    MintLimit: "amount";
+}> & {
+    anchorBrand: Brand<"nat">;
+    anchorPerMinted: Ratio;
+}>, privateArgs: {
+    feeMintAccess: FeeMintAccess;
+    initialPoserInvitation: Invitation;
+    storageNode: StorageNode;
+    marshaller: Marshaller;
+}, baggage: Baggage) => Promise<{
+    creatorFacet: import("@endo/exo").Guarded<{
+        getParamMgrRetriever: () => {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager").TypedParamManager<{
+                GiveMintedFee: "ratio";
+                MintLimit: "amount";
+                WantMintedFee: "ratio";
+            } & {
+                Electorate: "invitation";
+            }>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager").TypedParamManager<{
+                GiveMintedFee: "ratio";
+                MintLimit: "amount";
+                WantMintedFee: "ratio";
+            } & {
+                Electorate: "invitation";
+            }>;
+        }>;
+        getInvitation: (name: any) => Promise<globalThis.Invitation>;
+        getLimitedCreatorFacet: () => import("@endo/exo").Guarded<{
+            getRewardAllocation(): Allocation;
+            makeCollectFeesInvitation(): Promise<globalThis.Invitation<string>>;
+            makeRestoreMetricsInvitation(): Promise<globalThis.Invitation<void, Omit<import("@agoric/inter-protocol/src/psm/psm.js").MetricsNotification, "anchorPoolBalance">>>;
+        }>;
+        getGovernedApis: () => GovernedApis;
+        getGovernedApiNames: () => string[];
+        setOfferFilter: (strings: any) => Promise<void>;
+    }>;
+    publicFacet: import("@endo/exo").Guarded<{
+        getAmount: (name: string) => Amount;
+        getBrand: (name: string) => Brand;
+        getInstance: (name: string) => Instance;
+        getInstallation: (name: string) => Installation;
+        getInvitationAmount: (name: string) => InvitationAmount;
+        getNat: (name: string) => bigint;
+        getRatio: (name: string) => Ratio;
+        getString: (name: string) => string;
+        getTimestamp: (name: string) => import("@agoric/time").TimestampRecord;
+        getRelativeTime: (name: string) => import("@agoric/time").RelativeTimeRecord;
+        getUnknown: (name: string) => any;
+        getSubscription: () => globalThis.StoredSubscription<globalThis.GovernanceSubscriptionState>;
+        getGovernedParams: () => ERef<globalThis.ParamStateRecord>;
+        getMetrics(): globalThis.Subscriber<import("@agoric/inter-protocol/src/psm/psm.js").MetricsNotification>;
+        getPoolBalance(): import("@agoric/ertp").NatAmount;
+        getPublicTopics(): {
+            metrics: import("@agoric/zoe/src/contractSupport").PublicTopic<import("@agoric/inter-protocol/src/psm/psm.js").MetricsNotification>;
+        };
+        makeWantMintedInvitation(): Promise<globalThis.Invitation<void, undefined>>;
+        makeGiveMintedInvitation(): Promise<globalThis.Invitation<void, undefined>>;
+    }>;
+}>>;
+export type ProvisionPoolKitReferences = {
+    bankManager: ERef<BankManager>;
+    namesByAddressAdmin: ERef<import("@agoric/vats").NameAdmin>;
+    walletFactory: ERef<import("@agoric/vats/src/core/startWalletFactory.js").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 { ERef } from '@endo/far';
+import type { Payment } from '@agoric/ertp';
+import type { Bank } from '@agoric/vats/src/vat-bank.js';
+import type { BridgeMessage } from '@agoric/cosmic-swingset/src/types.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 { Amount } from '@agoric/ertp';
+import type { BankManager } from '@agoric/vats/src/vat-bank.js';
+//# sourceMappingURL=provisionPoolKit.d.ts.map

package/src/provisionPoolKit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provisionPoolKit.d.ts","sourceRoot":"","sources":["provisionPoolKit.js"],"names":[],"mappings":"AAoFO,iDAFI,OAAO,cAAc,EAAE,IAAI;;;;;eA8gB8mB,CAAC;;;;;;IArf/oB,iCAAiC;oBAArB,aAAa;GA6B5B;AAYI,8CATI,OAAO,cAAc,EAAE,IAAI,uEAC3B;IACN,eAAe,EAAE,OAAO,6CAA6C,EAAE,eAAe,CAAC;IACvF,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,OAAO,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,GAAG,EAAE,GAAG,CAAC;IACT,uBAAuB,EAAE,UAAU,CAAC,OAAO,0BAA0B,CAAC,CAAC;CACxE,gCA6bC;IAA2B,SAAS,EAA5B,MAAM,KAAK,CAAC;IACY,WAAW,EAAnC,KAAK,WAAW,CAAC;CACzB,KAAU,OAAO,CAAC,gBAAgB,CAAC,CAcvC;+BAljBY;IACR,OAAO,EAAE,GAAG,CAAC;IACb,MAAM,EAAE,GAAG,CAAC;IACZ,UAAU,EAAE,GAAG,CAAC;IAChB,MAAM,EAAE,GAAG,CAAC;CACb;0BAIS,OAAO,qCAAqC,EAAE,QAAQ,CAClE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAyD,CACtD;;iBAKU,KAAK,WAAW,CAAC;yBACjB,KAAK,OAAO,cAAc,EAAE,SAAS,CAAC;mBACtC,KACb,OAAW,6CAA6C,EAAE,wBAAwB,CAAC,cAAc,CAAC,CAC/F;;;;;;;;;;wBAMU,MAAM;;;;;yBACN,OAAO,KAAK,CAAC;;;;;0BAEb,OAAO,KAAK,CAAC;;0BA1CJ,WAAW;6BAHc,cAAc;0BAI1B,8BAA8B;mCALlC,sCAAsC;yBAGhD,aAAa;2BAFa,cAAc;iCAChC,0CAA0C;4BADxB,cAAc;iCAI1B,8BAA8B"}