@metamask/ramps-controller 1.0.0

package/dist/RampsController.mjs

@@ -0,0 +1,69 @@
+import { BaseController } from "@metamask/base-controller";
+// === GENERAL ===
+/**
+ * The name of the {@link RampsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export const controllerName = 'RampsController';
+/**
+ * The metadata for each property in {@link RampsControllerState}.
+ */
+const rampsControllerMetadata = {
+    geolocation: {
+        persist: true,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
+};
+/**
+ * Constructs the default {@link RampsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link RampsController} state.
+ */
+export function getDefaultRampsControllerState() {
+    return {
+        geolocation: null,
+    };
+}
+// === CONTROLLER DEFINITION ===
+/**
+ * Manages cryptocurrency on/off ramps functionality.
+ */
+export class RampsController extends BaseController {
+    /**
+     * Constructs a new {@link RampsController}.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.state - The desired state with which to initialize this
+     * controller. Missing properties will be filled in with defaults.
+     */
+    constructor({ messenger, state = {}, }) {
+        super({
+            messenger,
+            metadata: rampsControllerMetadata,
+            name: controllerName,
+            state: {
+                ...getDefaultRampsControllerState(),
+                ...state,
+            },
+        });
+    }
+    /**
+     * Updates the user's geolocation.
+     * This method calls the OnRampService to get the geolocation
+     * and stores the result in state.
+     */
+    async updateGeolocation() {
+        const geolocation = await this.messenger.call('OnRampService:getGeolocation');
+        this.update((state) => {
+            state.geolocation = geolocation;
+        });
+    }
+}
+//# sourceMappingURL=RampsController.mjs.map

package/dist/RampsController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"RampsController.mjs","sourceRoot":"","sources":["../src/RampsController.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAC;AAchD;;GAEG;AACH,MAAM,uBAAuB,GAAG;IAC9B,WAAW,EAAE;QACX,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,IAAI;KACf;CAC4C,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,UAAU,8BAA8B;IAC5C,OAAO;QACL,WAAW,EAAE,IAAI;KAClB,CAAC;AACJ,CAAC;AAkDD,gCAAgC;AAEhC;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,cAIpC;IACC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,GAIX;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,uBAAuB;YACjC,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,8BAA8B,EAAE;gBACnC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,iBAAiB;QACrB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC3C,8BAA8B,CAC/B,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport type { OnRampServiceGetGeolocationAction } from './OnRampService-method-action-types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link RampsController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'RampsController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link RampsController}.\n */\nexport type RampsControllerState = {\n  /**\n   * The user's country code determined by geolocation.\n   */\n  geolocation: string | null;\n};\n\n/**\n * The metadata for each property in {@link RampsControllerState}.\n */\nconst rampsControllerMetadata = {\n  geolocation: {\n    persist: true,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: true,\n  },\n} satisfies StateMetadata<RampsControllerState>;\n\n/**\n * Constructs the default {@link RampsController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link RampsController} state.\n */\nexport function getDefaultRampsControllerState(): RampsControllerState {\n  return {\n    geolocation: null,\n  };\n}\n\n// === MESSENGER ===\n\n/**\n * Retrieves the state of the {@link RampsController}.\n */\nexport type RampsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  RampsControllerState\n>;\n\n/**\n * Actions that {@link RampsControllerMessenger} exposes to other consumers.\n */\nexport type RampsControllerActions = RampsControllerGetStateAction;\n\n/**\n * Actions from other messengers that {@link RampsController} calls.\n */\ntype AllowedActions = OnRampServiceGetGeolocationAction;\n\n/**\n * Published when the state of {@link RampsController} changes.\n */\nexport type RampsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  RampsControllerState\n>;\n\n/**\n * Events that {@link RampsControllerMessenger} exposes to other consumers.\n */\nexport type RampsControllerEvents = RampsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link RampsController} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link RampsController}.\n */\nexport type RampsControllerMessenger = Messenger<\n  typeof controllerName,\n  RampsControllerActions | AllowedActions,\n  RampsControllerEvents | AllowedEvents\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * Manages cryptocurrency on/off ramps functionality.\n */\nexport class RampsController extends BaseController<\n  typeof controllerName,\n  RampsControllerState,\n  RampsControllerMessenger\n> {\n  /**\n   * Constructs a new {@link RampsController}.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to initialize this\n   * controller. Missing properties will be filled in with defaults.\n   */\n  constructor({\n    messenger,\n    state = {},\n  }: {\n    messenger: RampsControllerMessenger;\n    state?: Partial<RampsControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: rampsControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultRampsControllerState(),\n        ...state,\n      },\n    });\n  }\n\n  /**\n   * Updates the user's geolocation.\n   * This method calls the OnRampService to get the geolocation\n   * and stores the result in state.\n   */\n  async updateGeolocation(): Promise<void> {\n    const geolocation = await this.messenger.call(\n      'OnRampService:getGeolocation',\n    );\n\n    this.update((state) => {\n      state.geolocation = geolocation;\n    });\n  }\n}\n"]}

package/dist/index.cjs

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnRampEnvironment = exports.OnRampService = exports.getDefaultRampsControllerState = exports.RampsController = void 0;
+var RampsController_1 = require("./RampsController.cjs");
+Object.defineProperty(exports, "RampsController", { enumerable: true, get: function () { return RampsController_1.RampsController; } });
+Object.defineProperty(exports, "getDefaultRampsControllerState", { enumerable: true, get: function () { return RampsController_1.getDefaultRampsControllerState; } });
+var OnRampService_1 = require("./OnRampService.cjs");
+Object.defineProperty(exports, "OnRampService", { enumerable: true, get: function () { return OnRampService_1.OnRampService; } });
+Object.defineProperty(exports, "OnRampEnvironment", { enumerable: true, get: function () { return OnRampService_1.OnRampEnvironment; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAQA,yDAG2B;AAFzB,kHAAA,eAAe,OAAA;AACf,iIAAA,8BAA8B,OAAA;AAOhC,qDAAmE;AAA1D,8GAAA,aAAa,OAAA;AAAE,kHAAA,iBAAiB,OAAA","sourcesContent":["export type {\n  RampsControllerActions,\n  RampsControllerEvents,\n  RampsControllerGetStateAction,\n  RampsControllerMessenger,\n  RampsControllerState,\n  RampsControllerStateChangeEvent,\n} from './RampsController';\nexport {\n  RampsController,\n  getDefaultRampsControllerState,\n} from './RampsController';\nexport type {\n  OnRampServiceActions,\n  OnRampServiceEvents,\n  OnRampServiceMessenger,\n} from './OnRampService';\nexport { OnRampService, OnRampEnvironment } from './OnRampService';\nexport type { OnRampServiceGetGeolocationAction } from './OnRampService-method-action-types';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,6 @@
+export type { RampsControllerActions, RampsControllerEvents, RampsControllerGetStateAction, RampsControllerMessenger, RampsControllerState, RampsControllerStateChangeEvent, } from "./RampsController.cjs";
+export { RampsController, getDefaultRampsControllerState, } from "./RampsController.cjs";
+export type { OnRampServiceActions, OnRampServiceEvents, OnRampServiceMessenger, } from "./OnRampService.cjs";
+export { OnRampService, OnRampEnvironment } from "./OnRampService.cjs";
+export type { OnRampServiceGetGeolocationAction } from "./OnRampService-method-action-types.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,sBAAsB,EACtB,qBAAqB,EACrB,6BAA6B,EAC7B,wBAAwB,EACxB,oBAAoB,EACpB,+BAA+B,GAChC,8BAA0B;AAC3B,OAAO,EACL,eAAe,EACf,8BAA8B,GAC/B,8BAA0B;AAC3B,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,GACvB,4BAAwB;AACzB,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,4BAAwB;AACnE,YAAY,EAAE,iCAAiC,EAAE,gDAA4C"}

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+export type { RampsControllerActions, RampsControllerEvents, RampsControllerGetStateAction, RampsControllerMessenger, RampsControllerState, RampsControllerStateChangeEvent, } from "./RampsController.mjs";
+export { RampsController, getDefaultRampsControllerState, } from "./RampsController.mjs";
+export type { OnRampServiceActions, OnRampServiceEvents, OnRampServiceMessenger, } from "./OnRampService.mjs";
+export { OnRampService, OnRampEnvironment } from "./OnRampService.mjs";
+export type { OnRampServiceGetGeolocationAction } from "./OnRampService-method-action-types.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,sBAAsB,EACtB,qBAAqB,EACrB,6BAA6B,EAC7B,wBAAwB,EACxB,oBAAoB,EACpB,+BAA+B,GAChC,8BAA0B;AAC3B,OAAO,EACL,eAAe,EACf,8BAA8B,GAC/B,8BAA0B;AAC3B,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,GACvB,4BAAwB;AACzB,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,4BAAwB;AACnE,YAAY,EAAE,iCAAiC,EAAE,gDAA4C"}

package/dist/index.mjs

@@ -0,0 +1,3 @@
+export { RampsController, getDefaultRampsControllerState } from "./RampsController.mjs";
+export { OnRampService, OnRampEnvironment } from "./OnRampService.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,eAAe,EACf,8BAA8B,EAC/B,8BAA0B;AAM3B,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,4BAAwB","sourcesContent":["export type {\n  RampsControllerActions,\n  RampsControllerEvents,\n  RampsControllerGetStateAction,\n  RampsControllerMessenger,\n  RampsControllerState,\n  RampsControllerStateChangeEvent,\n} from './RampsController';\nexport {\n  RampsController,\n  getDefaultRampsControllerState,\n} from './RampsController';\nexport type {\n  OnRampServiceActions,\n  OnRampServiceEvents,\n  OnRampServiceMessenger,\n} from './OnRampService';\nexport { OnRampService, OnRampEnvironment } from './OnRampService';\nexport type { OnRampServiceGetGeolocationAction } from './OnRampService-method-action-types';\n"]}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@metamask/ramps-controller",
+  "version": "1.0.0",
+  "description": "A controller for managing cryptocurrency on/off ramps functionality",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/ramps-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/ramps-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/ramps-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^9.0.0",
+    "@metamask/controller-utils": "^11.16.0",
+    "@metamask/messenger": "^0.3.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@ts-bridge/cli": "^0.6.4",
+    "@types/jest": "^27.4.1",
+    "@types/sinon": "^9.0.10",
+    "deepmerge": "^4.2.2",
+    "isomorphic-fetch": "^3.0.0",
+    "jest": "^27.5.1",
+    "nock": "^13.3.1",
+    "sinon": "^9.2.4",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.3.3"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}