@agoric/vats 0.15.2-dev-ecf2d8e.0 → 0.15.2-other-dev-70beeb7.0

package/src/provisionPoolKit.d.ts

@@ -0,0 +1,408 @@
+export function makeBridgeProvisionTool(sendInitialPayment: (depositBank: ERef<Bank>) => Promise<void>, onProvisioned: () => void): ({ bankManager, namesByAddressAdmin, walletFactory, }: ProvisionPoolKitReferences) => {
+    fromBridge: (obj: any) => Promise<void>;
+} & import("@endo/eventual-send").RemotableBrand<{}, {
+    fromBridge: (obj: any) => Promise<void>;
+}>;
+export function prepareProvisionPoolKit(baggage: MapStore<string, unknown>, { makeRecorderKit, params, poolBank, zcf }: {
+    makeRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit;
+    params: any;
+    poolBank: import('@endo/far').ERef<Bank>;
+    zcf: ZCF;
+}): ({ poolBrand, storageNode }: {
+    poolBrand: Brand;
+    storageNode: ERef<StorageNode>;
+}) => Promise<{
+    machine: {
+        /**
+         * @param {string[]} oldAddresses
+         */
+        addRevivableAddresses(oldAddresses: string[]): void;
+        getWalletReviver(): {
+            /** @param {string} address */
+            reviveWallet(address: string): Promise<{
+                handleBridgeAction(actionCapData: import("@endo/marshal").CapData<string>, canSpend?: boolean | undefined): Promise<void>;
+                getDepositFacet(): {
+                    receive(payment: Payment<AssetKind>): Promise<Amount<AssetKind>>;
+                };
+                getOffersFacet(): {
+                    executeOffer(offerSpec: import("@agoric/smart-wallet/src/offers.js").OfferSpec): Promise<void>;
+                    tryExitOffer(offerId: import("@agoric/smart-wallet/src/offers.js").OfferId): Promise<void>;
+                };
+                getCurrentSubscriber(): Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").CurrentWalletRecord>;
+                getUpdatesSubscriber(): Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").UpdateRecord>;
+                getPublicTopics(): {
+                    current: {
+                        description: string;
+                        subscriber: Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").CurrentWalletRecord>;
+                        storagePath: Promise<string>;
+                    };
+                    updates: {
+                        description: string;
+                        subscriber: Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").UpdateRecord>;
+                        storagePath: Promise<string>;
+                    };
+                };
+            }>;
+            /**
+             * @param {string} address
+             * @returns {boolean} isRevive
+             */
+            ackWallet(address: string): boolean;
+        };
+        /**
+         * @param {ProvisionPoolKitReferences} erefs
+         */
+        setReferences(erefs: ProvisionPoolKitReferences): Promise<void>;
+        makeHandler(): {
+            fromBridge: (obj: any) => Promise<void>;
+        } & import("@endo/eventual-send").RemotableBrand<{}, {
+            fromBridge: (obj: any) => Promise<void>;
+        }>;
+        /**
+         * @param {Brand} brand
+         * @param {PsmInstance} instance
+         */
+        initPSM(brand: Brand, instance: PsmInstance): void;
+    };
+    walletReviver: {
+        /** @param {string} address */
+        reviveWallet(address: string): Promise<{
+            handleBridgeAction(actionCapData: import("@endo/marshal").CapData<string>, canSpend?: boolean | undefined): Promise<void>;
+            getDepositFacet(): {
+                receive(payment: Payment<AssetKind>): Promise<Amount<AssetKind>>;
+            };
+            getOffersFacet(): {
+                executeOffer(offerSpec: import("@agoric/smart-wallet/src/offers.js").OfferSpec): Promise<void>;
+                tryExitOffer(offerId: import("@agoric/smart-wallet/src/offers.js").OfferId): Promise<void>;
+            };
+            getCurrentSubscriber(): Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").CurrentWalletRecord>;
+            getUpdatesSubscriber(): Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").UpdateRecord>;
+            getPublicTopics(): {
+                current: {
+                    description: string;
+                    subscriber: Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").CurrentWalletRecord>;
+                    storagePath: Promise<string>;
+                };
+                updates: {
+                    description: string;
+                    subscriber: Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").UpdateRecord>;
+                    storagePath: Promise<string>;
+                };
+            };
+        }>;
+        /**
+         * @param {string} address
+         * @returns {boolean} isRevive
+         */
+        ackWallet(address: string): boolean;
+    };
+    helper: {
+        publishMetrics(): void;
+        onTrade(converted: any): void;
+        onSendFunds(provided: any): void;
+        onProvisioned(): void;
+        /**
+         *
+         * @param {ERef<Bank>} destBank
+         */
+        sendInitialPayment(destBank: ERef<Bank>): Promise<void>;
+        /**
+         * @param {object} [options]
+         * @param {MetricsNotification} [options.metrics]
+         */
+        start({ metrics }?: {
+            metrics?: MetricsNotification | undefined;
+        } | undefined): void;
+        /**
+         * @param {ERef<Payment>} payIn
+         * @param {Amount} amount
+         * @param {PsmInstance} instance
+         */
+        swap(payIn: ERef<Payment>, amount: Amount, instance: PsmInstance): Promise<Amount<"nat">>;
+    };
+    public: {
+        getPublicTopics(): {
+            metrics: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<MetricsNotification>;
+        };
+    };
+} & import("@endo/eventual-send").RemotableBrand<{}, {
+    machine: {
+        /**
+         * @param {string[]} oldAddresses
+         */
+        addRevivableAddresses(oldAddresses: string[]): void;
+        getWalletReviver(): {
+            /** @param {string} address */
+            reviveWallet(address: string): Promise<{
+                handleBridgeAction(actionCapData: import("@endo/marshal").CapData<string>, canSpend?: boolean | undefined): Promise<void>;
+                getDepositFacet(): {
+                    receive(payment: Payment<AssetKind>): Promise<Amount<AssetKind>>;
+                };
+                getOffersFacet(): {
+                    executeOffer(offerSpec: import("@agoric/smart-wallet/src/offers.js").OfferSpec): Promise<void>;
+                    tryExitOffer(offerId: import("@agoric/smart-wallet/src/offers.js").OfferId): Promise<void>;
+                };
+                getCurrentSubscriber(): Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").CurrentWalletRecord>;
+                getUpdatesSubscriber(): Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").UpdateRecord>;
+                getPublicTopics(): {
+                    current: {
+                        description: string;
+                        subscriber: Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").CurrentWalletRecord>;
+                        storagePath: Promise<string>;
+                    };
+                    updates: {
+                        description: string;
+                        subscriber: Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").UpdateRecord>;
+                        storagePath: Promise<string>;
+                    };
+                };
+            }>;
+            /**
+             * @param {string} address
+             * @returns {boolean} isRevive
+             */
+            ackWallet(address: string): boolean;
+        };
+        /**
+         * @param {ProvisionPoolKitReferences} erefs
+         */
+        setReferences(erefs: ProvisionPoolKitReferences): Promise<void>;
+        makeHandler(): {
+            fromBridge: (obj: any) => Promise<void>;
+        } & import("@endo/eventual-send").RemotableBrand<{}, {
+            fromBridge: (obj: any) => Promise<void>;
+        }>;
+        /**
+         * @param {Brand} brand
+         * @param {PsmInstance} instance
+         */
+        initPSM(brand: Brand, instance: PsmInstance): void;
+    };
+    walletReviver: {
+        /** @param {string} address */
+        reviveWallet(address: string): Promise<{
+            handleBridgeAction(actionCapData: import("@endo/marshal").CapData<string>, canSpend?: boolean | undefined): Promise<void>;
+            getDepositFacet(): {
+                receive(payment: Payment<AssetKind>): Promise<Amount<AssetKind>>;
+            };
+            getOffersFacet(): {
+                executeOffer(offerSpec: import("@agoric/smart-wallet/src/offers.js").OfferSpec): Promise<void>;
+                tryExitOffer(offerId: import("@agoric/smart-wallet/src/offers.js").OfferId): Promise<void>;
+            };
+            getCurrentSubscriber(): Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").CurrentWalletRecord>;
+            getUpdatesSubscriber(): Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").UpdateRecord>;
+            getPublicTopics(): {
+                current: {
+                    description: string;
+                    subscriber: Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").CurrentWalletRecord>;
+                    storagePath: Promise<string>;
+                };
+                updates: {
+                    description: string;
+                    subscriber: Subscriber<import("@agoric/smart-wallet/src/smartWallet.js").UpdateRecord>;
+                    storagePath: Promise<string>;
+                };
+            };
+        }>;
+        /**
+         * @param {string} address
+         * @returns {boolean} isRevive
+         */
+        ackWallet(address: string): boolean;
+    };
+    helper: {
+        publishMetrics(): void;
+        onTrade(converted: any): void;
+        onSendFunds(provided: any): void;
+        onProvisioned(): void;
+        /**
+         *
+         * @param {ERef<Bank>} destBank
+         */
+        sendInitialPayment(destBank: ERef<Bank>): Promise<void>;
+        /**
+         * @param {object} [options]
+         * @param {MetricsNotification} [options.metrics]
+         */
+        start({ metrics }?: {
+            metrics?: MetricsNotification | undefined;
+        } | undefined): void;
+        /**
+         * @param {ERef<Payment>} payIn
+         * @param {Amount} amount
+         * @param {PsmInstance} instance
+         */
+        swap(payIn: ERef<Payment>, amount: Amount, instance: PsmInstance): Promise<Amount<"nat">>;
+    };
+    public: {
+        getPublicTopics(): {
+            metrics: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<MetricsNotification>;
+        };
+    };
+}>>;
+export type PsmInstance = import('@agoric/zoe/src/zoeService/utils').Instance<(zcf: ZCF<GovernanceTerms<{
+    GiveMintedFee: "ratio";
+    WantMintedFee: "ratio";
+    MintLimit: "amount";
+}> & {
+    anchorBrand: Brand<"nat">;
+    anchorPerMinted: Ratio;
+}>, privateArgs: {
+    feeMintAccess: FeeMintAccess;
+    initialPoserInvitation: Invitation<unknown, never>;
+    storageNode: StorageNode;
+    marshaller: Marshaller<unknown>;
+}, baggage: MapStore<string, unknown>) => Promise<{
+    creatorFacet: {
+        getParamMgrRetriever: () => {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                GiveMintedFee: "ratio";
+                MintLimit: "amount";
+                WantMintedFee: "ratio";
+            } & {
+                Electorate: "invitation";
+            }>;
+        } & import("@endo/eventual-send").RemotableBrand<{}, {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                GiveMintedFee: "ratio";
+                MintLimit: "amount";
+                WantMintedFee: "ratio";
+            } & {
+                Electorate: "invitation";
+            }>;
+        }>;
+        getInvitation: (name: any) => Promise<Invitation<unknown, never>>;
+        getLimitedCreatorFacet: () => {
+            getRewardAllocation(): AmountKeywordRecord;
+            makeCollectFeesInvitation(): Promise<Invitation<string, never>>;
+            makeRestoreMetricsInvitation(): Promise<Invitation<void, never>>;
+        } & import("@endo/eventual-send").RemotableBrand<{}, {
+            getRewardAllocation(): AmountKeywordRecord;
+            makeCollectFeesInvitation(): Promise<Invitation<string, never>>;
+            makeRestoreMetricsInvitation(): Promise<Invitation<void, never>>;
+        }>;
+        getGovernedApis: () => GovernedApis;
+        getGovernedApiNames: () => string[];
+        setOfferFilter: (strings: any) => Promise<void>;
+    } & import("@endo/eventual-send").RemotableBrand<{}, {
+        getParamMgrRetriever: () => {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                GiveMintedFee: "ratio";
+                MintLimit: "amount";
+                WantMintedFee: "ratio";
+            } & {
+                Electorate: "invitation";
+            }>;
+        } & import("@endo/eventual-send").RemotableBrand<{}, {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                GiveMintedFee: "ratio";
+                MintLimit: "amount";
+                WantMintedFee: "ratio";
+            } & {
+                Electorate: "invitation";
+            }>;
+        }>;
+        getInvitation: (name: any) => Promise<Invitation<unknown, never>>;
+        getLimitedCreatorFacet: () => {
+            getRewardAllocation(): AmountKeywordRecord;
+            makeCollectFeesInvitation(): Promise<Invitation<string, never>>;
+            makeRestoreMetricsInvitation(): Promise<Invitation<void, never>>;
+        } & import("@endo/eventual-send").RemotableBrand<{}, {
+            getRewardAllocation(): AmountKeywordRecord;
+            makeCollectFeesInvitation(): Promise<Invitation<string, never>>;
+            makeRestoreMetricsInvitation(): Promise<Invitation<void, never>>;
+        }>;
+        getGovernedApis: () => GovernedApis;
+        getGovernedApiNames: () => string[];
+        setOfferFilter: (strings: any) => Promise<void>;
+    }>;
+    publicFacet: {
+        getAmount: (name: string) => Amount<AssetKind>;
+        getBrand: (name: string) => Brand<AssetKind>;
+        getInstance: (name: string) => Instance;
+        getInstallation: (name: string) => Installation<any>;
+        getInvitationAmount: (name: string) => Amount<"set">;
+        getNat: (name: string) => bigint;
+        getRatio: (name: string) => Ratio;
+        getString: (name: string) => string; /**
+         * @param {import('@agoric/vat-data').Baggage} baggage
+         * @param {{
+         *   makeRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit,
+         *   params: *,
+         *   poolBank: import('@endo/far').ERef<Bank>,
+         *   zcf: ZCF,
+         * }} powers
+         */
+        getTimestamp: (name: string) => import("@agoric/time/src/types.js").TimestampRecord;
+        getRelativeTime: (name: string) => import("@agoric/time/src/types.js").RelativeTimeRecord;
+        getUnknown: (name: string) => any;
+        getSubscription: () => StoredSubscription<GovernanceSubscriptionState>;
+        getGovernedParams: () => ERef<ParamStateRecord>;
+        getMetrics(): Subscriber<import("@agoric/inter-protocol/src/psm/psm.js").MetricsNotification>;
+        getPoolBalance(): Amount<any>;
+        getPublicTopics(): {
+            metrics: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("@agoric/inter-protocol/src/psm/psm.js").MetricsNotification>;
+        };
+        makeWantMintedInvitation(): Promise<Invitation<void, never>>;
+        makeGiveMintedInvitation(): Promise<Invitation<void, never>>;
+    } & import("@endo/eventual-send").RemotableBrand<{}, {
+        getAmount: (name: string) => Amount<AssetKind>;
+        getBrand: (name: string) => Brand<AssetKind>;
+        getInstance: (name: string) => Instance;
+        getInstallation: (name: string) => Installation<any>;
+        getInvitationAmount: (name: string) => Amount<"set">;
+        getNat: (name: string) => bigint;
+        getRatio: (name: string) => Ratio;
+        getString: (name: string) => string; /**
+         * @param {import('@agoric/vat-data').Baggage} baggage
+         * @param {{
+         *   makeRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit,
+         *   params: *,
+         *   poolBank: import('@endo/far').ERef<Bank>,
+         *   zcf: ZCF,
+         * }} powers
+         */
+        getTimestamp: (name: string) => import("@agoric/time/src/types.js").TimestampRecord;
+        getRelativeTime: (name: string) => import("@agoric/time/src/types.js").RelativeTimeRecord;
+        getUnknown: (name: string) => any;
+        getSubscription: () => StoredSubscription<GovernanceSubscriptionState>;
+        getGovernedParams: () => ERef<ParamStateRecord>;
+        getMetrics(): Subscriber<import("@agoric/inter-protocol/src/psm/psm.js").MetricsNotification>;
+        getPoolBalance(): Amount<any>;
+        getPublicTopics(): {
+            metrics: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("@agoric/inter-protocol/src/psm/psm.js").MetricsNotification>;
+        };
+        makeWantMintedInvitation(): Promise<Invitation<void, never>>;
+        makeGiveMintedInvitation(): Promise<Invitation<void, never>>;
+    }>;
+}>>;
+export type ProvisionPoolKitReferences = {
+    bankManager: ERef<BankManager>;
+    namesByAddressAdmin: ERef<import('@agoric/vats').NameAdmin>;
+    walletFactory: ERef<import('@agoric/vats/src/core/startWalletFactory').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'>;
+};
+/**
+ * Given attenuated access to the funding purse,
+ * handle requests to provision smart wallets.
+ */
+export type Bank = import('./vat-bank.js').Bank;
+//# 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":"AAqDO,0EAJkB,KAAK,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,iBAC1C,MAAM,IAAI,0DAKR,0BAA0B;;;;GAgCtC;AAWM,wHAPI;IACV,eAAmB,EAAE,OAAO,6CAA6C,EAAE,eAAe,CAAC;IAC3F,MAAU,MAAI;IACd,QAAY,EAAE,OAAO,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,GAAO,EAAE,GAAG,CAAC;CACV;IA8VqB,SAAS,EAArB,KAAK;IACmB,WAAW,EAAnC,KAAK,WAAW,CAAC;;;QAhRtB;;WAEG;4CADQ,MAAM,EAAE;;YAkDnB,8BAA8B;kCAAlB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;YAqBlB;;;eAGG;+BAFQ,MAAM,GACJ,OAAO;;QAhEpB;;WAEG;6BADQ,0BAA0B;;;;;;QA8BrC;;;WAGG;uBAFQ,KAAK,YACL,WAAW;;;QAQtB,8BAA8B;8BAAlB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;QAqBlB;;;WAGG;2BAFQ,MAAM,GACJ,OAAO;;;;;;;QAgDpB;;;WAGG;qCADQ,KAAK,IAAI,CAAC;QA2BrB;;;WAGG;;;;QA2EH;;;;WAIG;oBAHQ,KAAK,OAAO,CAAC,UACb,MAAM,YACN,WAAW;;;;;;;;;QAxOtB;;WAEG;4CADQ,MAAM,EAAE;;YAkDnB,8BAA8B;kCAAlB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;YAqBlB;;;eAGG;+BAFQ,MAAM,GACJ,OAAO;;QAhEpB;;WAEG;6BADQ,0BAA0B;;;;;;QA8BrC;;;WAGG;uBAFQ,KAAK,YACL,WAAW;;;QAQtB,8BAA8B;8BAAlB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;QAqBlB;;;WAGG;2BAFQ,MAAM,GACJ,OAAO;;;;;;;QAgDpB;;;WAGG;qCADQ,KAAK,IAAI,CAAC;QA2BrB;;;WAGG;;;;QA2EH;;;;WAIG;oBAHQ,KAAK,OAAO,CAAC,UACb,MAAM,YACN,WAAW;;;;;;;IAwD7B;0BAtba,OAAO,kCAAkC,EAAE,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6CAgEjE;;;;;;;;WAQG;;;;;;;;;;;;;;;;;;;;;6CARH;;;;;;;;WAQG;;;;;;;;;;;;;;GAxEuH;;iBAI5G,KAAK,WAAW,CAAC;yBACjB,KAAK,OAAO,cAAc,EAAE,SAAS,CAAC;mBACtC,KAAK,OAAO,0CAA0C,EAAE,wBAAwB,CAAC,cAAc,CAAC,CAAC;;;;;;;;;;wBAQjG,MAAM;;;;yBACN,OAAO,KAAK,CAAC;;;;;0BACb,OAAO,KAAK,CAAC;;;;;;mBAUd,OAAO,eAAe,EAAE,IAAI"}