@metamask/snaps-controllers 0.38.0-flask.1 → 1.0.0

package/dist/cronjob/CronjobController.js

@@ -0,0 +1,248 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _CronjobController_messenger, _CronjobController_dailyTimer, _CronjobController_timers, _CronjobController_snapIds;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CronjobController = exports.DAILY_TIMEOUT = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const __1 = require("..");
+const cronjob_1 = require("../snaps/endowments/cronjob");
+const Timer_1 = require("../snaps/Timer");
+exports.DAILY_TIMEOUT = (0, utils_1.inMilliseconds)(24, utils_1.Duration.Hour);
+const controllerName = 'CronjobController';
+/**
+ * Use this controller to register and schedule periodically executed jobs
+ * using RPC method hooks.
+ */
+class CronjobController extends base_controller_1.BaseControllerV2 {
+    constructor({ messenger, state }) {
+        super({
+            messenger,
+            metadata: {
+                jobs: { persist: true, anonymous: false },
+            },
+            name: controllerName,
+            state: {
+                jobs: {},
+                ...state,
+            },
+        });
+        _CronjobController_messenger.set(this, void 0);
+        _CronjobController_dailyTimer.set(this, void 0);
+        _CronjobController_timers.set(this, void 0);
+        // Mapping from jobId to snapId
+        _CronjobController_snapIds.set(this, void 0);
+        __classPrivateFieldSet(this, _CronjobController_timers, new Map(), "f");
+        __classPrivateFieldSet(this, _CronjobController_snapIds, new Map(), "f");
+        __classPrivateFieldSet(this, _CronjobController_messenger, messenger, "f");
+        this._handleEventSnapInstalled = this._handleEventSnapInstalled.bind(this);
+        this._handleEventSnapRemoved = this._handleEventSnapRemoved.bind(this);
+        this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);
+        // Subscribe to Snap events
+        /* eslint-disable @typescript-eslint/unbound-method */
+        this.messagingSystem.subscribe('SnapController:snapInstalled', this._handleEventSnapInstalled);
+        this.messagingSystem.subscribe('SnapController:snapRemoved', this._handleEventSnapRemoved);
+        this.messagingSystem.subscribe('SnapController:snapUpdated', this._handleEventSnapUpdated);
+        /* eslint-enable @typescript-eslint/unbound-method */
+        this.dailyCheckIn().catch((error) => {
+            (0, snaps_utils_1.logError)(error);
+        });
+    }
+    /**
+     * Retrieve all cronjob specifications for all runnable snaps.
+     *
+     * @returns Array of Cronjob specifications.
+     */
+    getAllJobs() {
+        const snaps = this.messagingSystem.call('SnapController:getAll');
+        const filteredSnaps = (0, __1.getRunnableSnaps)(snaps);
+        const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        return jobs.flat().filter((job) => job !== undefined);
+    }
+    /**
+     * Retrieve all Cronjob specifications for a Snap.
+     *
+     * @param snapId - ID of a Snap.
+     * @returns Array of Cronjob specifications.
+     */
+    getSnapJobs(snapId) {
+        const permissions = __classPrivateFieldGet(this, _CronjobController_messenger, "f").call('PermissionController:getPermissions', snapId);
+        const permission = permissions?.[__1.SnapEndowments.Cronjob];
+        const definitions = (0, cronjob_1.getCronjobCaveatJobs)(permission);
+        return definitions?.map((definition, idx) => {
+            return { ...definition, id: `${snapId}-${idx}`, snapId };
+        });
+    }
+    /**
+     * Register cron jobs for a given snap by getting specification from a permission caveats.
+     * Once registered, each job will be scheduled.
+     *
+     * @param snapId - ID of a snap.
+     */
+    register(snapId) {
+        const jobs = this.getSnapJobs(snapId);
+        jobs?.forEach((job) => this.schedule(job));
+    }
+    /**
+     * Schedule a new job.
+     * This will interpret the cron expression and tell the timer to execute the job
+     * at the next suitable point in time.
+     * Job last run state will be initialized afterwards.
+     *
+     * Note: Schedule will be skipped if the job's execution time is too far in the future and
+     * will be revisited on a daily check.
+     *
+     * @param job - Cronjob specification.
+     */
+    schedule(job) {
+        if (__classPrivateFieldGet(this, _CronjobController_timers, "f").has(job.id)) {
+            return;
+        }
+        const parsed = (0, snaps_utils_1.parseCronExpression)(job.expression);
+        const next = parsed.next();
+        const now = new Date();
+        const ms = next.getTime() - now.getTime();
+        // Don't schedule this job yet as it is too far in the future
+        if (ms > exports.DAILY_TIMEOUT) {
+            return;
+        }
+        const timer = new Timer_1.Timer(ms);
+        timer.start(() => {
+            this.executeCronjob(job).catch((error) => {
+                // TODO: Decide how to handle errors.
+                (0, snaps_utils_1.logError)(error);
+            });
+            __classPrivateFieldGet(this, _CronjobController_timers, "f").delete(job.id);
+            this.schedule(job);
+        });
+        this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually
+        __classPrivateFieldGet(this, _CronjobController_timers, "f").set(job.id, timer);
+        __classPrivateFieldGet(this, _CronjobController_snapIds, "f").set(job.id, job.snapId);
+    }
+    /**
+     * Execute job.
+     *
+     * @param job - Cronjob specification.
+     */
+    async executeCronjob(job) {
+        this.updateJobLastRunState(job.id, Date.now());
+        await __classPrivateFieldGet(this, _CronjobController_messenger, "f").call('SnapController:handleRequest', {
+            snapId: job.snapId,
+            origin: '',
+            handler: snaps_utils_1.HandlerType.OnCronjob,
+            request: job.request,
+        });
+    }
+    /**
+     * Unregister all jobs related to the given snapId.
+     *
+     * @param snapId - ID of a snap.
+     */
+    unregister(snapId) {
+        const jobs = [...__classPrivateFieldGet(this, _CronjobController_snapIds, "f").entries()].filter(([_, jobSnapId]) => jobSnapId === snapId);
+        if (jobs.length) {
+            jobs.forEach(([id]) => {
+                const timer = __classPrivateFieldGet(this, _CronjobController_timers, "f").get(id);
+                if (timer) {
+                    timer.cancel();
+                    __classPrivateFieldGet(this, _CronjobController_timers, "f").delete(id);
+                    __classPrivateFieldGet(this, _CronjobController_snapIds, "f").delete(id);
+                }
+            });
+        }
+    }
+    /**
+     * Update time of a last run for the Cronjob specified by ID.
+     *
+     * @param jobId - ID of a cron job.
+     * @param lastRun - Unix timestamp when the job was last ran.
+     */
+    updateJobLastRunState(jobId, lastRun) {
+        this.update((state) => {
+            state.jobs[jobId] = {
+                lastRun,
+            };
+        });
+    }
+    /**
+     * Runs every 24 hours to check if new jobs need to be scheduled.
+     *
+     * This is necesary for longer running jobs that execute with more than 24 hours between them.
+     */
+    async dailyCheckIn() {
+        const jobs = this.getAllJobs();
+        for (const job of jobs) {
+            const parsed = (0, snaps_utils_1.parseCronExpression)(job.expression);
+            const lastRun = this.state.jobs[job.id]?.lastRun;
+            // If a job was supposed to run while we were shut down but wasn't we run it now
+            if (lastRun !== undefined &&
+                parsed.hasPrev() &&
+                parsed.prev().getTime() > lastRun) {
+                await this.executeCronjob(job);
+            }
+            // Try scheduling, will fail if an existing scheduled job is found
+            this.schedule(job);
+        }
+        __classPrivateFieldSet(this, _CronjobController_dailyTimer, new Timer_1.Timer(exports.DAILY_TIMEOUT), "f");
+        __classPrivateFieldGet(this, _CronjobController_dailyTimer, "f").start(() => {
+            this.dailyCheckIn().catch((error) => {
+                // TODO: Decide how to handle errors.
+                (0, snaps_utils_1.logError)(error);
+            });
+        });
+    }
+    /**
+     * Run controller teardown process and unsubscribe from Snap events.
+     */
+    destroy() {
+        super.destroy();
+        /* eslint-disable @typescript-eslint/unbound-method */
+        this.messagingSystem.unsubscribe('SnapController:snapInstalled', this._handleEventSnapInstalled);
+        this.messagingSystem.unsubscribe('SnapController:snapRemoved', this._handleEventSnapRemoved);
+        this.messagingSystem.unsubscribe('SnapController:snapUpdated', this._handleEventSnapUpdated);
+        /* eslint-enable @typescript-eslint/unbound-method */
+        __classPrivateFieldGet(this, _CronjobController_snapIds, "f").forEach((snapId) => {
+            this.unregister(snapId);
+        });
+    }
+    /**
+     * Handle cron jobs on 'snapInstalled' event.
+     *
+     * @param snap - Basic Snap information.
+     */
+    _handleEventSnapInstalled(snap) {
+        this.register(snap.id);
+    }
+    /**
+     * Handle cron jobs on 'snapRemoved' event.
+     *
+     * @param snap - Basic Snap information.
+     */
+    _handleEventSnapRemoved(snap) {
+        this.unregister(snap.id);
+    }
+    /**
+     * Handle cron jobs on 'snapUpdated' event.
+     *
+     * @param snap - Basic Snap information.
+     */
+    _handleEventSnapUpdated(snap) {
+        this.unregister(snap.id);
+        this.register(snap.id);
+    }
+}
+exports.CronjobController = CronjobController;
+_CronjobController_messenger = new WeakMap(), _CronjobController_dailyTimer = new WeakMap(), _CronjobController_timers = new WeakMap(), _CronjobController_snapIds = new WeakMap();
+//# sourceMappingURL=CronjobController.js.map

package/dist/cronjob/CronjobController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CronjobController.js","sourceRoot":"","sources":["../../src/cronjob/CronjobController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAGmC;AAEnC,uDAO+B;AAC/B,2CAA2D;AAE3D,0BAQY;AACZ,yDAAmE;AACnE,0CAAuC;AAiB1B,QAAA,aAAa,GAAG,IAAA,sBAAc,EAAC,EAAE,EAAE,gBAAQ,CAAC,IAAI,CAAC,CAAC;AAwB/D,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAE3C;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,kCAItC;IAUC,YAAY,EAAE,SAAS,EAAE,KAAK,EAAyB;QACrD,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE;gBACR,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;aAC1C;YACD,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,IAAI,EAAE,EAAE;gBACR,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QApBL,+CAAuC;QAEvC,gDAAoB;QAEpB,4CAA4B;QAE5B,+BAA+B;QAC/B,6CAA8B;QAc5B,uBAAA,IAAI,6BAAW,IAAI,GAAG,EAAE,MAAA,CAAC;QACzB,uBAAA,IAAI,8BAAY,IAAI,GAAG,EAAE,MAAA,CAAC;QAC1B,uBAAA,IAAI,gCAAc,SAAS,MAAA,CAAC;QAE5B,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvE,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEvE,2BAA2B;QAC3B,sDAAsD;QACtD,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,8BAA8B,EAC9B,IAAI,CAAC,yBAAyB,CAC/B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QACF,qDAAqD;QAErD,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAClC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,UAAU;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QACjE,MAAM,aAAa,GAAG,IAAA,oBAAgB,EAAC,KAAK,CAAC,CAAC;QAE9C,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,4EAA4E;QAC5E,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,CAAc,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,MAAc;QAChC,MAAM,WAAW,GAAG,uBAAA,IAAI,oCAAW,CAAC,IAAI,CACtC,qCAAqC,EACrC,MAAM,CACP,CAAC;QAEF,MAAM,UAAU,GAAG,WAAW,EAAE,CAAC,kBAAc,CAAC,OAAO,CAAC,CAAC;QACzD,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,UAAU,CAAC,CAAC;QAErD,OAAO,WAAW,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;YAC1C,OAAO,EAAE,GAAG,UAAU,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,MAAc;QACrB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;OAUG;IACK,QAAQ,CAAC,GAAY;QAC3B,IAAI,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC5B,OAAO;SACR;QAED,MAAM,MAAM,GAAG,IAAA,iCAAmB,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;QAE1C,6DAA6D;QAC7D,IAAI,EAAE,GAAG,qBAAa,EAAE;YACtB,OAAO;SACR;QAED,MAAM,KAAK,GAAG,IAAI,aAAK,CAAC,EAAE,CAAC,CAAC;QAC5B,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE;YACf,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACvC,qCAAqC;gBACrC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;YAEH,uBAAA,IAAI,iCAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC5B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,iCAAiC;QACxE,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAChC,uBAAA,IAAI,kCAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,cAAc,CAAC,GAAY;QACvC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,MAAM,uBAAA,IAAI,oCAAW,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACzD,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,MAAM,EAAE,EAAE;YACV,OAAO,EAAE,yBAAW,CAAC,SAAS;YAC9B,OAAO,EAAE,GAAG,CAAC,OAAO;SACrB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,MAAc;QACvB,MAAM,IAAI,GAAG,CAAC,GAAG,uBAAA,IAAI,kCAAS,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAC9C,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,KAAK,MAAM,CACzC,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACpB,MAAM,KAAK,GAAG,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACnC,IAAI,KAAK,EAAE;oBACT,KAAK,CAAC,MAAM,EAAE,CAAC;oBACf,uBAAA,IAAI,iCAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBACxB,uBAAA,IAAI,kCAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;iBAC1B;YACH,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,KAAa,EAAE,OAAe;QAC1D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG;gBAClB,OAAO;aACR,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAE/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,MAAM,GAAG,IAAA,iCAAmB,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC;YACjD,gFAAgF;YAChF,IACE,OAAO,KAAK,SAAS;gBACrB,MAAM,CAAC,OAAO,EAAE;gBAChB,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,OAAO,EACjC;gBACA,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;aAChC;YAED,kEAAkE;YAClE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SACpB;QAED,uBAAA,IAAI,iCAAe,IAAI,aAAK,CAAC,qBAAa,CAAC,MAAA,CAAC;QAC5C,uBAAA,IAAI,qCAAY,CAAC,KAAK,CAAC,GAAG,EAAE;YAC1B,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAClC,qCAAqC;gBACrC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO;QACL,KAAK,CAAC,OAAO,EAAE,CAAC;QAEhB,sDAAsD;QACtD,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,8BAA8B,EAC9B,IAAI,CAAC,yBAAyB,CAC/B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QACF,qDAAqD;QAErD,uBAAA,IAAI,kCAAS,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC/B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,yBAAyB,CAAC,IAAmB;QACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACK,uBAAuB,CAAC,IAAmB;QACjD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACK,uBAAuB,CAAC,IAAmB;QACjD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;CACF;AA3RD,8CA2RC","sourcesContent":["import {\n  BaseControllerV2 as BaseController,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { GetPermissions } from '@metamask/permission-controller';\nimport {\n  HandlerType,\n  SnapId,\n  TruncatedSnap,\n  CronjobSpecification,\n  parseCronExpression,\n  logError,\n} from '@metamask/snaps-utils';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport {\n  GetAllSnaps,\n  getRunnableSnaps,\n  HandleSnapRequest,\n  SnapEndowments,\n  SnapInstalled,\n  SnapRemoved,\n  SnapUpdated,\n} from '..';\nimport { getCronjobCaveatJobs } from '../snaps/endowments/cronjob';\nimport { Timer } from '../snaps/Timer';\n\nexport type CronjobControllerActions =\n  | GetAllSnaps\n  | HandleSnapRequest\n  | GetPermissions;\n\nexport type CronjobControllerEvents = SnapInstalled | SnapRemoved | SnapUpdated;\n\nexport type CronjobControllerMessenger = RestrictedControllerMessenger<\n  'CronjobController',\n  CronjobControllerActions,\n  CronjobControllerEvents,\n  CronjobControllerActions['type'],\n  CronjobControllerEvents['type']\n>;\n\nexport const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);\n\nexport type CronjobControllerArgs = {\n  messenger: CronjobControllerMessenger;\n  /**\n   * Persisted state that will be used for rehydration.\n   */\n  state?: CronjobControllerState;\n};\n\nexport type Cronjob = {\n  timer?: Timer;\n  id: string;\n  snapId: SnapId;\n} & CronjobSpecification;\n\nexport type StoredJobInformation = {\n  lastRun: number;\n};\n\nexport type CronjobControllerState = {\n  jobs: Record<string, StoredJobInformation>;\n};\n\nconst controllerName = 'CronjobController';\n\n/**\n * Use this controller to register and schedule periodically executed jobs\n * using RPC method hooks.\n */\nexport class CronjobController extends BaseController<\n  typeof controllerName,\n  CronjobControllerState,\n  CronjobControllerMessenger\n> {\n  #messenger: CronjobControllerMessenger;\n\n  #dailyTimer!: Timer;\n\n  #timers: Map<string, Timer>;\n\n  // Mapping from jobId to snapId\n  #snapIds: Map<string, string>;\n\n  constructor({ messenger, state }: CronjobControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        jobs: { persist: true, anonymous: false },\n      },\n      name: controllerName,\n      state: {\n        jobs: {},\n        ...state,\n      },\n    });\n    this.#timers = new Map();\n    this.#snapIds = new Map();\n    this.#messenger = messenger;\n\n    this._handleEventSnapInstalled = this._handleEventSnapInstalled.bind(this);\n    this._handleEventSnapRemoved = this._handleEventSnapRemoved.bind(this);\n    this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);\n\n    // Subscribe to Snap events\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.subscribe(\n      'SnapController:snapInstalled',\n      this._handleEventSnapInstalled,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapRemoved',\n      this._handleEventSnapRemoved,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.dailyCheckIn().catch((error) => {\n      logError(error);\n    });\n  }\n\n  /**\n   * Retrieve all cronjob specifications for all runnable snaps.\n   *\n   * @returns Array of Cronjob specifications.\n   */\n  private getAllJobs(): Cronjob[] {\n    const snaps = this.messagingSystem.call('SnapController:getAll');\n    const filteredSnaps = getRunnableSnaps(snaps);\n\n    const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    return jobs.flat().filter((job) => job !== undefined) as Cronjob[];\n  }\n\n  /**\n   * Retrieve all Cronjob specifications for a Snap.\n   *\n   * @param snapId - ID of a Snap.\n   * @returns Array of Cronjob specifications.\n   */\n  private getSnapJobs(snapId: SnapId): Cronjob[] | undefined {\n    const permissions = this.#messenger.call(\n      'PermissionController:getPermissions',\n      snapId,\n    );\n\n    const permission = permissions?.[SnapEndowments.Cronjob];\n    const definitions = getCronjobCaveatJobs(permission);\n\n    return definitions?.map((definition, idx) => {\n      return { ...definition, id: `${snapId}-${idx}`, snapId };\n    });\n  }\n\n  /**\n   * Register cron jobs for a given snap by getting specification from a permission caveats.\n   * Once registered, each job will be scheduled.\n   *\n   * @param snapId - ID of a snap.\n   */\n  register(snapId: SnapId) {\n    const jobs = this.getSnapJobs(snapId);\n    jobs?.forEach((job) => this.schedule(job));\n  }\n\n  /**\n   * Schedule a new job.\n   * This will interpret the cron expression and tell the timer to execute the job\n   * at the next suitable point in time.\n   * Job last run state will be initialized afterwards.\n   *\n   * Note: Schedule will be skipped if the job's execution time is too far in the future and\n   * will be revisited on a daily check.\n   *\n   * @param job - Cronjob specification.\n   */\n  private schedule(job: Cronjob) {\n    if (this.#timers.has(job.id)) {\n      return;\n    }\n\n    const parsed = parseCronExpression(job.expression);\n    const next = parsed.next();\n    const now = new Date();\n    const ms = next.getTime() - now.getTime();\n\n    // Don't schedule this job yet as it is too far in the future\n    if (ms > DAILY_TIMEOUT) {\n      return;\n    }\n\n    const timer = new Timer(ms);\n    timer.start(() => {\n      this.executeCronjob(job).catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n\n      this.#timers.delete(job.id);\n      this.schedule(job);\n    });\n\n    this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually\n    this.#timers.set(job.id, timer);\n    this.#snapIds.set(job.id, job.snapId);\n  }\n\n  /**\n   * Execute job.\n   *\n   * @param job - Cronjob specification.\n   */\n  private async executeCronjob(job: Cronjob) {\n    this.updateJobLastRunState(job.id, Date.now());\n    await this.#messenger.call('SnapController:handleRequest', {\n      snapId: job.snapId,\n      origin: '',\n      handler: HandlerType.OnCronjob,\n      request: job.request,\n    });\n  }\n\n  /**\n   * Unregister all jobs related to the given snapId.\n   *\n   * @param snapId - ID of a snap.\n   */\n  unregister(snapId: SnapId) {\n    const jobs = [...this.#snapIds.entries()].filter(\n      ([_, jobSnapId]) => jobSnapId === snapId,\n    );\n\n    if (jobs.length) {\n      jobs.forEach(([id]) => {\n        const timer = this.#timers.get(id);\n        if (timer) {\n          timer.cancel();\n          this.#timers.delete(id);\n          this.#snapIds.delete(id);\n        }\n      });\n    }\n  }\n\n  /**\n   * Update time of a last run for the Cronjob specified by ID.\n   *\n   * @param jobId - ID of a cron job.\n   * @param lastRun - Unix timestamp when the job was last ran.\n   */\n  private updateJobLastRunState(jobId: string, lastRun: number) {\n    this.update((state) => {\n      state.jobs[jobId] = {\n        lastRun,\n      };\n    });\n  }\n\n  /**\n   * Runs every 24 hours to check if new jobs need to be scheduled.\n   *\n   * This is necesary for longer running jobs that execute with more than 24 hours between them.\n   */\n  async dailyCheckIn() {\n    const jobs = this.getAllJobs();\n\n    for (const job of jobs) {\n      const parsed = parseCronExpression(job.expression);\n      const lastRun = this.state.jobs[job.id]?.lastRun;\n      // If a job was supposed to run while we were shut down but wasn't we run it now\n      if (\n        lastRun !== undefined &&\n        parsed.hasPrev() &&\n        parsed.prev().getTime() > lastRun\n      ) {\n        await this.executeCronjob(job);\n      }\n\n      // Try scheduling, will fail if an existing scheduled job is found\n      this.schedule(job);\n    }\n\n    this.#dailyTimer = new Timer(DAILY_TIMEOUT);\n    this.#dailyTimer.start(() => {\n      this.dailyCheckIn().catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n    });\n  }\n\n  /**\n   * Run controller teardown process and unsubscribe from Snap events.\n   */\n  destroy() {\n    super.destroy();\n\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapInstalled',\n      this._handleEventSnapInstalled,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapRemoved',\n      this._handleEventSnapRemoved,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.#snapIds.forEach((snapId) => {\n      this.unregister(snapId);\n    });\n  }\n\n  /**\n   * Handle cron jobs on 'snapInstalled' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapInstalled(snap: TruncatedSnap) {\n    this.register(snap.id);\n  }\n\n  /**\n   * Handle cron jobs on 'snapRemoved' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapRemoved(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n  }\n\n  /**\n   * Handle cron jobs on 'snapUpdated' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapUpdated(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n    this.register(snap.id);\n  }\n}\n"]}

package/dist/cronjob/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CronjobController"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cronjob/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cronjob/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC","sourcesContent":["export * from './CronjobController';\n"]}

package/dist/{types/fsm.d.ts → fsm.d.ts}

@@ -1,4 +1,4 @@
-import type { EventObject, StateMachine, Typestate } from '@xstate/fsm';
+import { EventObject, StateMachine, Typestate } from '@xstate/fsm';
 /**
  * Validates the set-up of a @xstate/fsm machine.
  *

package/dist/fsm.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.forceStrict = exports.validateMachine = void 0;
+const utils_1 = require("@metamask/utils");
+const fsm_1 = require("@xstate/fsm");
+/**
+ * Validates the set-up of a @xstate/fsm machine.
+ *
+ * 1. Ensures that all named actions in the config have a provided implementation.
+ *
+ * @param machine - The machine to validate.
+ * @throws {@link AssertionError}. If the validation fails.
+ */
+function validateMachine(machine) {
+    (0, utils_1.assert)('_options' in machine, 'The machine is not an @xstate/fsm machine');
+    const typed = machine;
+    // 1.
+    const toArray = (obj) => {
+        if (Array.isArray(obj)) {
+            return obj;
+        }
+        else if (obj === undefined || obj === null) {
+            return [];
+        }
+        return [obj];
+    };
+    const allActions = new Set();
+    const addActions = (actions) => toArray(actions)
+        .flatMap((action) => {
+        if (typeof action === 'string') {
+            return [action];
+        }
+        (0, utils_1.assert)(typeof action === 'function');
+        return [];
+    })
+        .forEach(allActions.add.bind(allActions));
+    for (const state of Object.values(typed.config.states)) {
+        addActions(state.entry);
+        addActions(state.exit);
+        for (const transition of Object.values(state.on ?? {})) {
+            addActions(transition.actions);
+        }
+    }
+    allActions.forEach((action) => (0, utils_1.assert)(typed._options.actions !== undefined && action in typed._options.actions, `Action "${action}" doesn't have an implementation`));
+}
+exports.validateMachine = validateMachine;
+/**
+ * Ensure that the interpreter is strict.
+ * Strict means that the transition must occur.
+ * The event must exist in .on {} state config and it's guard must succeed.
+ *
+ * The error will be thrown when an invalid `interpreter.send()` is called
+ * and will be bubbled there.
+ *
+ * TODO(ritave): Doesn't support self transitions.
+ *
+ * @param interpreter - The interpreter that will be force into strict mode.
+ * @throws {@link Error} Thrown when the transition is invalid.
+ */
+function forceStrict(interpreter) {
+    // As soon as a listener subscribes, it is called. It might be called in
+    // an initial state which doesn't have the .changed property
+    let onInitialCalled = false;
+    interpreter.subscribe((state) => {
+        (0, utils_1.assert)(!onInitialCalled || state.changed, 'Invalid state transition');
+        onInitialCalled = true;
+    });
+    const ogSend = interpreter.send.bind(interpreter);
+    interpreter.send = (...args) => {
+        (0, utils_1.assert)(interpreter.status === fsm_1.InterpreterStatus.Running, 'Interpreter is stopped');
+        return ogSend(...args);
+    };
+}
+exports.forceStrict = forceStrict;
+//# sourceMappingURL=fsm.js.map

package/dist/fsm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fsm.js","sourceRoot":"","sources":["../src/fsm.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AACzC,qCAKqB;AAErB;;;;;;;GAOG;AACH,SAAgB,eAAe,CAI7B,OAAuD;IACvD,IAAA,cAAM,EAAC,UAAU,IAAI,OAAO,EAAE,2CAA2C,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAG,OAEb,CAAC;IAEF,KAAK;IACL,MAAM,OAAO,GAAG,CAAI,GAAY,EAAO,EAAE;QACvC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,OAAO,GAAG,CAAC;SACZ;aAAM,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YAC5C,OAAO,EAAE,CAAC;SACX;QACD,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC,CAAC;IACF,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IACrC,MAAM,UAAU,GAAG,CAAC,OAAY,EAAE,EAAE,CAClC,OAAO,CAAC,OAAO,CAAC;SACb,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAClB,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,OAAO,CAAC,MAAM,CAAC,CAAC;SACjB;QACD,IAAA,cAAM,EAAC,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC;QACrC,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC;SACD,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAE9C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAC/B,KAAK,CAAC,MAAM,CAAC,MAAM,CACpB,EAAE;QACD,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxB,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvB,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAM,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;YAC3D,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;SAChC;KACF;IAED,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAC5B,IAAA,cAAM,EACJ,KAAK,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,EACxE,WAAW,MAAM,kCAAkC,CACpD,CACF,CAAC;AACJ,CAAC;AA/CD,0CA+CC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,WAAW,CAAC,WAAgD;IAC1E,wEAAwE;IACxE,4DAA4D;IAC5D,IAAI,eAAe,GAAG,KAAK,CAAC;IAC5B,WAAW,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9B,IAAA,cAAM,EAAC,CAAC,eAAe,IAAI,KAAK,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;QACtE,eAAe,GAAG,IAAI,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,WAAW,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE;QAC7B,IAAA,cAAM,EACJ,WAAW,CAAC,MAAM,KAAK,uBAAiB,CAAC,OAAO,EAChD,wBAAwB,CACzB,CAAC;QACF,OAAO,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC;AACJ,CAAC;AAjBD,kCAiBC","sourcesContent":["import { assert } from '@metamask/utils';\nimport {\n  EventObject,\n  InterpreterStatus,\n  StateMachine,\n  Typestate,\n} from '@xstate/fsm';\n\n/**\n * Validates the set-up of a @xstate/fsm machine.\n *\n * 1. Ensures that all named actions in the config have a provided implementation.\n *\n * @param machine - The machine to validate.\n * @throws {@link AssertionError}. If the validation fails.\n */\nexport function validateMachine<\n  TContext extends object,\n  TEvent extends EventObject,\n  TState extends Typestate<TContext>,\n>(machine: StateMachine.Machine<TContext, TEvent, TState>) {\n  assert('_options' in machine, 'The machine is not an @xstate/fsm machine');\n  const typed = machine as StateMachine.Machine<TContext, TEvent, TState> & {\n    _options: { actions?: StateMachine.ActionMap<TContext, TEvent> };\n  };\n\n  // 1.\n  const toArray = <T>(obj: T | T[]): T[] => {\n    if (Array.isArray(obj)) {\n      return obj;\n    } else if (obj === undefined || obj === null) {\n      return [];\n    }\n    return [obj];\n  };\n  const allActions = new Set<string>();\n  const addActions = (actions: any) =>\n    toArray(actions)\n      .flatMap((action) => {\n        if (typeof action === 'string') {\n          return [action];\n        }\n        assert(typeof action === 'function');\n        return [];\n      })\n      .forEach(allActions.add.bind(allActions));\n\n  for (const state of Object.values<typeof typed.config.states[string]>(\n    typed.config.states,\n  )) {\n    addActions(state.entry);\n    addActions(state.exit);\n    for (const transition of Object.values<any>(state.on ?? {})) {\n      addActions(transition.actions);\n    }\n  }\n\n  allActions.forEach((action) =>\n    assert(\n      typed._options.actions !== undefined && action in typed._options.actions,\n      `Action \"${action}\" doesn't have an implementation`,\n    ),\n  );\n}\n\n/**\n * Ensure that the interpreter is strict.\n * Strict means that the transition must occur.\n * The event must exist in .on {} state config and it's guard must succeed.\n *\n * The error will be thrown when an invalid `interpreter.send()` is called\n * and will be bubbled there.\n *\n * TODO(ritave): Doesn't support self transitions.\n *\n * @param interpreter - The interpreter that will be force into strict mode.\n * @throws {@link Error} Thrown when the transition is invalid.\n */\nexport function forceStrict(interpreter: StateMachine.Service<any, any, any>) {\n  // As soon as a listener subscribes, it is called. It might be called in\n  // an initial state which doesn't have the .changed property\n  let onInitialCalled = false;\n  interpreter.subscribe((state) => {\n    assert(!onInitialCalled || state.changed, 'Invalid state transition');\n    onInitialCalled = true;\n  });\n\n  const ogSend = interpreter.send.bind(interpreter);\n  interpreter.send = (...args) => {\n    assert(\n      interpreter.status === InterpreterStatus.Running,\n      'Interpreter is stopped',\n    );\n    return ogSend(...args);\n  };\n}\n"]}

package/dist/{types/index.d.ts → index.d.ts}

@@ -2,4 +2,5 @@ export type { Json } from '@metamask/utils';
 export * from './services';
 export * from './snaps';
 export * from './utils';
+export * from './multichain';
 export * from './cronjob';

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./services"), exports);
+__exportStar(require("./snaps"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./multichain"), exports);
+__exportStar(require("./cronjob"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,6CAA2B;AAC3B,0CAAwB;AACxB,0CAAwB;AACxB,+CAA6B;AAC7B,4CAA0B","sourcesContent":["export type { Json } from '@metamask/utils';\nexport * from './services';\nexport * from './snaps';\nexport * from './utils';\nexport * from './multichain';\nexport * from './cronjob';\n"]}

package/dist/logging.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.log = void 0;
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+/**
+ * A logging function specific to this package. The log messages don't show up
+ * by default, but they can be enabled by setting the environment variable:
+ * - `DEBUG=metamask:snaps:snaps-controllers`, or
+ * - `DEBUG=metamask:snaps:*` to enable all logs from `@metamask/snaps-*`.
+ */
+exports.log = (0, utils_1.createModuleLogger)(snaps_utils_1.snapsLogger, 'snaps-controllers');
+//# sourceMappingURL=logging.js.map

package/dist/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,2CAAqD;AAErD;;;;;GAKG;AACU,QAAA,GAAG,GAAG,IAAA,0BAAkB,EAAC,yBAAW,EAAE,mBAAmB,CAAC,CAAC","sourcesContent":["import { snapsLogger } from '@metamask/snaps-utils';\nimport { createModuleLogger } from '@metamask/utils';\n\n/**\n * A logging function specific to this package. The log messages don't show up\n * by default, but they can be enabled by setting the environment variable:\n * - `DEBUG=metamask:snaps:snaps-controllers`, or\n * - `DEBUG=metamask:snaps:*` to enable all logs from `@metamask/snaps-*`.\n */\nexport const log = createModuleLogger(snapsLogger, 'snaps-controllers');\n"]}

package/dist/multichain/MultiChainController.d.ts

@@ -0,0 +1,137 @@
+import { AddApprovalRequest } from '@metamask/approval-controller';
+import { BaseControllerV2 as BaseController, RestrictedControllerMessenger } from '@metamask/base-controller';
+import { GetPermissions, GrantPermissions, HasPermission } from '@metamask/permission-controller';
+import { ChainId, ConnectArguments, NamespaceId, RequestArguments, RequestNamespace, Session, SnapId } from '@metamask/snaps-utils';
+import { GetAllSnaps, HandleSnapRequest, IncrementActiveReferences, DecrementActiveReferences } from '../snaps';
+declare const controllerName = "MultiChainController";
+declare type AllowedActions = GetAllSnaps | IncrementActiveReferences | DecrementActiveReferences | HandleSnapRequest | GetPermissions | HasPermission | AddApprovalRequest | GrantPermissions;
+declare type MultiChainControllerMessenger = RestrictedControllerMessenger<typeof controllerName, AllowedActions, never, AllowedActions['type'], never>;
+declare type SessionData = {
+    origin: string;
+    requestedNamespaces: Record<NamespaceId, RequestNamespace>;
+    providedNamespaces: Record<NamespaceId, RequestNamespace>;
+    handlingSnaps: Record<NamespaceId, SnapId>;
+};
+declare type MultiChainControllerState = {
+    sessions: {
+        [origin: string]: SessionData;
+    };
+};
+declare type Notify = (origin: string, data: {
+    method: string;
+    params?: Record<string, unknown>;
+}) => Promise<void>;
+declare type MultiChainControllerArgs = {
+    notify: Notify;
+    messenger: MultiChainControllerMessenger;
+};
+export declare class MultiChainController extends BaseController<typeof controllerName, MultiChainControllerState, MultiChainControllerMessenger> {
+    #private;
+    /**
+     * Construct a new {@link MultiChainController} instance.
+     *
+     * @param args - The arguments to construct the controller with.
+     * @param args.messenger - The controller messenger to use.
+     * @param args.notify - A function that should handle JSON-RPC notifications.
+     */
+    constructor({ messenger, notify }: MultiChainControllerArgs);
+    /**
+     * Get an open session for the given origin.
+     *
+     * @param origin - The origin to get the session for.
+     * @returns The session, if it exists, or `undefined` otherwise.
+     */
+    getSession(origin: string): SessionData | undefined;
+    /**
+     * Close a session for the given origin.
+     *
+     * @param origin - The origin to close the session for.
+     * @throws If the session does not exist.
+     */
+    closeSession(origin: string): Promise<void>;
+    /**
+     * Handles a new connection from the given origin. This will create a new
+     * session, and close any existing session for the origin.
+     *
+     * @param origin - The origin to create the session for.
+     * @param connection - The connection arguments.
+     * @param connection.requiredNamespaces - The namespaces that the origin
+     * requires.
+     * @returns The session that was created.
+     */
+    onConnect(origin: string, connection: ConnectArguments): Promise<Session>;
+    /**
+     * Handle an incoming multichain request from the given origin. This will
+     * forward the request to the appropriate Snap, and return the response.
+     *
+     * @param origin - The origin to handle the request for.
+     * @param data - The request data.
+     * @param data.chainId - The chain ID for the request.
+     * @param data.request - The request arguments, i.e., the method and params.
+     * @returns The response from the Snap.
+     * @throws If the session does not exist, or the session does not provide the
+     * requested namespace.
+     */
+    onRequest(origin: string, data: {
+        chainId: ChainId;
+        request: RequestArguments;
+    }): Promise<unknown>;
+    /**
+     * Send a request to the given Snap. This calls the given method with the
+     * given arguments on the keyring class in the given Snap.
+     *
+     * @param options - The request options.
+     * @param options.snapId - The ID of the Snap to send the request to.
+     * @param options.origin - The origin of the request.
+     * @param options.method - The request method.
+     * @param options.args - The request params.
+     * @returns The response from the Snap.
+     */
+    private snapRequest;
+    /**
+     * Get the accounts exposed by the Snap's keyring.
+     *
+     * This also verifies that the accounts returned by the snap are valid CAIP-10
+     * account IDs.
+     *
+     * @param origin - The origin of the request.
+     * @param snapId - The ID of the Snap to get the accounts from.
+     * @returns The accounts, or `null` if the Snap does not have any accounts, or
+     * the accounts are invalid (i.e., not valid CAIP-10 account IDs).
+     */
+    private getSnapAccounts;
+    /**
+     * Get the namespaces for the given Snap, as described in the Snap's manifest.
+     *
+     * @param snap - The Snap to get the namespaces for.
+     * @returns The namespaces, or `null` if the Snap does not have any
+     * namespaces.
+     */
+    private snapToNamespaces;
+    /**
+     * Maps from an object of namespace IDs and Snap IDs, and an object of
+     * namespace IDs and requested namespaces, to an object of namespace IDs and
+     * resolved accounts, with the Snap ID providing the accounts.
+     *
+     * @param origin - The origin of the request.
+     * @param namespacesAndSnaps - An object of namespace IDs and Snap IDs
+     * providing the namespace.
+     * @param requestedNamespaces - An object of namespace IDs and requested
+     * namespaces.
+     * @returns An object of namespace IDs and resolved accounts, with the Snap ID
+     * providing the accounts.
+     */
+    private namespacesToAccounts;
+    /**
+     * If multiple Snap IDs are provided for a namespace, this method will
+     * determine which Snap ID to use for the namespace, by showing the user a
+     * prompt.
+     *
+     * @param origin - The origin of the request.
+     * @param possibleAccounts - An object containing the accounts provided by
+     * each Snap ID for each namespace.
+     * @returns An object containing the Snap ID to use for each namespace.
+     */
+    private resolveConflicts;
+}
+export {};