Create test-snap for cronjob (#125)

packages/cronjob/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  root: true,
+
+  extends: ['../../.eslintrc.js'],
+
+  ignorePatterns: ['!.eslintrc.js', 'dist/', 'build/'],
+};

packages/cronjob/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/test-snaps/

packages/cronjob/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@metamask/test-snap-cronjob",
+  "version": "4.5.0",
+  "description": "MetaMask Cronjob Test Snap",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/test-snaps.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "dist/",
+    "snap.manifest.json",
+    "images/icon.svg"
+  ],
+  "scripts": {
+    "build": "mm-snap build --eval false",
+    "build:dev": "yarn build",
+    "build:clean": "yarn clean && yarn build",
+    "clean": "rimraf 'dist/*'",
+    "start": "mm-snap watch",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch",
+    "lint:eslint": "eslint . --cache --ext js,ts",
+    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' --single-quote --ignore-path ../../.prettierignore --no-error-on-unmatched-pattern",
+    "lint": "yarn lint:eslint && yarn lint:misc --check",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
+    "lint:changelog": "yarn auto-changelog validate"
+  },
+  "dependencies": {
+    "@metamask/snaps-types": "^0.26.2",
+    "@metamask/snaps-ui": "^0.27.1"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^2.5.0",
+    "@metamask/eslint-config": "^6.0.0",
+    "@metamask/eslint-config-jest": "^6.0.0",
+    "@metamask/eslint-config-nodejs": "^6.0.0",
+    "@metamask/eslint-config-typescript": "^6.0.0",
+    "@metamask/snaps-cli": "^0.26.2",
+    "@types/jest": "^26.0.13",
+    "@typescript-eslint/eslint-plugin": "^5.19.0",
+    "@typescript-eslint/parser": "^5.19.0",
+    "eslint": "^7.30.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-jest": "^24.4.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "jest": "^26.4.2",
+    "prettier": "^2.2.1",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^26.3.0",
+    "ts-node": "^9.0.0",
+    "typescript": "^4.4.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}

packages/cronjob/snap.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  cliOptions: {
+    port: 8010,
+    src: './src/index.ts',
+    transpilationMode: 'localOnly',
+  },
+};

packages/cronjob/snap.manifest.json

@@ -0,0 +1,34 @@
+{
+  "version": "4.5.0",
+  "description": "A MetaMask Test Snap that uses the cronjob endowment",
+  "proposedName": "MetaMask Cronjob Test Snap",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/test-snaps.git"
+  },
+  "source": {
+    "shasum": "BFD6zxK5fNJ9TO3iICSA/SfPjlpUUxQtO7kwpyx7NDE=",
+    "location": {
+      "npm": {
+        "filePath": "dist/bundle.js",
+        "iconPath": "images/icon.svg",
+        "packageName": "@metamask/test-snap-cronjob",
+        "registry": "https://registry.npmjs.org/"
+      }
+    }
+  },
+  "initialPermissions": {
+    "endowment:cronjob": {
+      "jobs": [
+        {
+          "expression": "* * * * *",
+          "request": {
+            "method": "fireCronjob"
+          }
+        }
+      ]
+    },
+    "snap_dialog": {}
+  },
+  "manifestVersion": "0.1"
+}

packages/cronjob/src/index.ts

@@ -0,0 +1,17 @@
+import { OnCronjobHandler } from '@metamask/snaps-types';
+import { panel, text, heading } from '@metamask/snaps-ui';
+
+export const onCronjob: OnCronjobHandler = async ({ request }) => {
+  switch (request.method) {
+    case 'fireCronjob':
+      return snap.request({
+        method: 'snap_dialog',
+        params: {
+          type: 'Alert',
+          content: panel([heading('Cronjob'), text('fired')]),
+        },
+      });
+    default:
+      throw new Error('Method not found.');
+  }
+};

packages/cronjob/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "src"
+  },
+  "exclude": ["./src/**/*.test.ts", "./build"],
+  "include": ["./src/**/*.ts"]
+}

packages/site/src/features/cronjob-snap/Cronjob.tsx

@@ -0,0 +1,16 @@
+import { FunctionComponent } from 'react';
+import { Snap } from '../../components';
+
+const CRONJOB_SNAP_ID = 'npm:@metamask/test-snap-cronjob';
+const CRONJOB_SNAP_PORT = 8010;
+
+export const Cronjob: FunctionComponent = () => {
+  return (
+    <Snap
+      name="Cronjob Snap"
+      snapId={CRONJOB_SNAP_ID}
+      port={CRONJOB_SNAP_PORT}
+      testId="CronjobSnap"
+    ></Snap>
+  );
+};

packages/site/src/features/cronjob-snap/index.ts

@@ -0,0 +1 @@
+export * from './Cronjob';

packages/site/src/pages/index.tsx

@@ -4,6 +4,7 @@ import { Container, Row } from 'react-bootstrap';
 import { Logo } from '../components';
 import { Snaps } from '../features/installed-snaps';
 import { Confirm } from '../features/confirm-snap';
+import { Cronjob } from '../features/cronjob-snap';
 import { Dialog } from '../features/dialog-snap';
 import { ErrorSnap } from '../features/error-snap';
 import { BIP44 } from '../features/bip-44-snap';
@@ -42,6 +43,7 @@ const Index: FunctionComponent = () => {
         <Update />
         <Insights />
         <Rpc />
+        <Cronjob />
       </Row>
     </Container>
   );

yarn.lock

@@ -2622,6 +2622,36 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@metamask/test-snap-cronjob@workspace:packages/cronjob":
+  version: 0.0.0-use.local
+  resolution: "@metamask/test-snap-cronjob@workspace:packages/cronjob"
+  dependencies:
+    "@metamask/auto-changelog": ^2.5.0
+    "@metamask/eslint-config": ^6.0.0
+    "@metamask/eslint-config-jest": ^6.0.0
+    "@metamask/eslint-config-nodejs": ^6.0.0
+    "@metamask/eslint-config-typescript": ^6.0.0
+    "@metamask/snaps-cli": ^0.26.2
+    "@metamask/snaps-types": ^0.26.2
+    "@metamask/snaps-ui": ^0.27.1
+    "@types/jest": ^26.0.13
+    "@typescript-eslint/eslint-plugin": ^5.19.0
+    "@typescript-eslint/parser": ^5.19.0
+    eslint: ^7.30.0
+    eslint-config-prettier: ^8.3.0
+    eslint-plugin-import: ^2.23.4
+    eslint-plugin-jest: ^24.4.0
+    eslint-plugin-node: ^11.1.0
+    eslint-plugin-prettier: ^3.4.0
+    jest: ^26.4.2
+    prettier: ^2.2.1
+    rimraf: ^3.0.2
+    ts-jest: ^26.3.0
+    ts-node: ^9.0.0
+    typescript: ^4.4.0
+  languageName: unknown
+  linkType: soft
+
 "@metamask/test-snap-dialog@workspace:packages/dialog":
   version: 0.0.0-use.local
   resolution: "@metamask/test-snap-dialog@workspace:packages/dialog"