From 5050815e83170a4ce7c9ac1270827ae513696291 Mon Sep 17 00:00:00 2001 From: Nikita Sukhachev Date: Thu, 8 Aug 2024 17:09:21 +0700 Subject: [PATCH] feat: update links --- README.md | 54 +------------------------- package.json | 12 +++--- packages/snap/README.md | 13 +------ packages/snap/package.json | 6 +-- packages/snap/snap.manifest.json | 6 +-- yarn.lock | 66 ++++++++++++++++---------------- 6 files changed, 49 insertions(+), 108 deletions(-) diff --git a/README.md b/README.md index 9a8403a..0ba9c21 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,3 @@ -# @metamask/template-snap-monorepo +# Nomis Protocol Snap -This repository demonstrates how to develop a snap with TypeScript. For detailed -instructions, see [the MetaMask documentation](https://docs.metamask.io/guide/snaps.html#serving-a-snap-to-your-local-environment). - -MetaMask Snaps is a system that allows anyone to safely expand the capabilities -of MetaMask. A _snap_ is a program that we run in an isolated environment that -can customize the wallet experience. - -## Snaps is pre-release software - -To interact with (your) Snaps, you will need to install [MetaMask Flask](https://metamask.io/flask/), -a canary distribution for developers that provides access to upcoming features. - -## Getting Started - -Clone the template-snap repository [using this template](https://github.com/MetaMask/template-snap-monorepo/generate) -and set up the development environment: - -```shell -yarn install && yarn start -``` - -## Cloning - -This repository contains GitHub Actions that you may find useful, see -`.github/workflows` and [Releasing & Publishing](https://github.com/MetaMask/template-snap-monorepo/edit/main/README.md#releasing--publishing) -below for more information. - -If you clone or create this repository outside the MetaMask GitHub organization, -you probably want to run `./scripts/cleanup.sh` to remove some files that will -not work properly outside the MetaMask GitHub organization. - -If you don't wish to use any of the existing GitHub actions in this repository, -simply delete the `.github/workflows` directory. - -## Contributing - -### Testing and Linting - -Run `yarn test` to run the tests once. - -Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and -fix any automatically fixable issues. - -### Using NPM packages with scripts - -Scripts are disabled by default for security reasons. If you need to use NPM -packages with scripts, you can run `yarn allow-scripts auto`, and enable the -script in the `lavamoat.allowScripts` section of `package.json`. - -See the documentation for [@lavamoat/allow-scripts](https://github.com/LavaMoat/LavaMoat/tree/main/packages/allow-scripts) -for more information. +Leverage your onchain reputation inside MetaMask Snap! diff --git a/package.json b/package.json index d2ef845..c4194bc 100644 --- a/package.json +++ b/package.json @@ -3,13 +3,13 @@ "version": "0.1.0", "private": true, "description": "", - "homepage": "https://github.com/MetaMask/template-snap-monorepo#readme", + "homepage": "https://github.com/Nomis-cc/nomis-snaps#readme", "bugs": { - "url": "https://github.com/MetaMask/template-snap-monorepo/issues" + "url": "https://github.com/Nomis-cc/nomis-snaps/issues" }, "repository": { "type": "git", - "url": "git+https://github.com/MetaMask/template-snap-monorepo.git" + "url": "git+https://github.com/Nomis-cc/nomis-snaps.git" }, "license": "(MIT-0 OR Apache-2.0)", "author": "", @@ -25,6 +25,9 @@ "start": "yarn workspaces foreach --parallel --interlaced --verbose run start", "test": "yarn workspace snap run test" }, + "dependencies": { + "@metamask/snaps-sdk": "^6.2.1" + }, "devDependencies": { "@lavamoat/allow-scripts": "^3.0.0", "@lavamoat/preinstall-always-fail": "^2.0.0", @@ -56,8 +59,5 @@ "@lavamoat/preinstall-always-fail": false, "sharp": true } - }, - "dependencies": { - "@metamask/snaps-sdk": "^6.2.1" } } diff --git a/packages/snap/README.md b/packages/snap/README.md index c3601a1..0ba9c21 100644 --- a/packages/snap/README.md +++ b/packages/snap/README.md @@ -1,12 +1,3 @@ -# TypeScript Example Snap +# Nomis Protocol Snap -This snap demonstrates how to develop a snap with TypeScript. It is a simple -snap that displays a confirmation dialog when the `hello` JSON-RPC method is -called. - -## Testing - -The snap comes with some basic tests, to demonstrate how to write tests for -snaps. To test the snap, run `yarn test` in this directory. This will use -[`@metamask/snaps-jest`](https://github.com/MetaMask/snaps/tree/main/packages/snaps-jest) -to run the tests in `src/index.test.ts`. +Leverage your onchain reputation inside MetaMask Snap! diff --git a/packages/snap/package.json b/packages/snap/package.json index e528bf3..be59764 100644 --- a/packages/snap/package.json +++ b/packages/snap/package.json @@ -1,10 +1,10 @@ { - "name": "snap", + "name": "nomis-snap", "version": "0.1.0", - "description": "The 'Hello, world!' of MetaMask Snaps, now written in TypeScript.", + "description": "Onchain Reputation and Decentralized Identity Protocol", "repository": { "type": "git", - "url": "https://github.com/MetaMask/template-snap-monorepo.git" + "url": "https://github.com/Nomis-cc/nomis-snaps.git" }, "license": "(MIT-0 OR Apache-2.0)", "main": "./dist/bundle.js", diff --git a/packages/snap/snap.manifest.json b/packages/snap/snap.manifest.json index 9694928..a1de2b3 100644 --- a/packages/snap/snap.manifest.json +++ b/packages/snap/snap.manifest.json @@ -4,14 +4,14 @@ "proposedName": "Nomis Protocol", "repository": { "type": "git", - "url": "https://github.com/MetaMask/template-snap-monorepo.git" + "url": "https://github.com/Nomis-cc/nomis-snaps.git" }, "source": { - "shasum": "0C3mfmcJh/qFOWCIID/CAZs+VkoVzSeutoYPilVCoRw=", + "shasum": "FLSiqxW/xsoi//HFObHfb+sM9i9ysZYMSYtCr1drulw=", "location": { "npm": { "filePath": "dist/bundle.js", - "packageName": "snap", + "packageName": "nomis-snap", "registry": "https://registry.npmjs.org/", "iconPath": "images/icon.svg" } diff --git a/yarn.lock b/yarn.lock index c97b31a..25d8c11 100644 --- a/yarn.lock +++ b/yarn.lock @@ -14438,6 +14438,39 @@ __metadata: languageName: node linkType: hard +"nomis_snap@workspace:packages/snap": + version: 0.0.0-use.local + resolution: "nomis_snap@workspace:packages/snap" + dependencies: + "@jest/globals": ^29.5.0 + "@metamask/auto-changelog": ^3.4.4 + "@metamask/eslint-config": ^12.2.0 + "@metamask/eslint-config-jest": ^12.1.0 + "@metamask/eslint-config-nodejs": ^12.1.0 + "@metamask/eslint-config-typescript": ^12.1.0 + "@metamask/snaps-cli": ^6.3.0 + "@metamask/snaps-jest": ^8.3.0 + "@metamask/snaps-sdk": ^6.2.1 + "@typescript-eslint/eslint-plugin": ^5.42.1 + "@typescript-eslint/parser": ^5.42.1 + buffer: ^6.0.3 + eslint: ^8.45.0 + eslint-config-prettier: ^8.5.0 + eslint-plugin-import: ~2.26.0 + eslint-plugin-jest: ^27.1.5 + eslint-plugin-jsdoc: ^41.1.2 + eslint-plugin-n: ^15.7.0 + eslint-plugin-prettier: ^4.2.1 + eslint-plugin-promise: ^6.1.1 + jest: ^29.5.0 + prettier: ^2.7.1 + prettier-plugin-packagejson: ^2.2.11 + rimraf: ^3.0.2 + ts-jest: ^29.1.0 + typescript: ^4.7.4 + languageName: unknown + linkType: soft + "nopt@npm:^7.0.0": version: 7.2.1 resolution: "nopt@npm:7.2.1" @@ -17182,39 +17215,6 @@ __metadata: languageName: node linkType: hard -"snap@workspace:packages/snap": - version: 0.0.0-use.local - resolution: "snap@workspace:packages/snap" - dependencies: - "@jest/globals": ^29.5.0 - "@metamask/auto-changelog": ^3.4.4 - "@metamask/eslint-config": ^12.2.0 - "@metamask/eslint-config-jest": ^12.1.0 - "@metamask/eslint-config-nodejs": ^12.1.0 - "@metamask/eslint-config-typescript": ^12.1.0 - "@metamask/snaps-cli": ^6.3.0 - "@metamask/snaps-jest": ^8.3.0 - "@metamask/snaps-sdk": ^6.2.1 - "@typescript-eslint/eslint-plugin": ^5.42.1 - "@typescript-eslint/parser": ^5.42.1 - buffer: ^6.0.3 - eslint: ^8.45.0 - eslint-config-prettier: ^8.5.0 - eslint-plugin-import: ~2.26.0 - eslint-plugin-jest: ^27.1.5 - eslint-plugin-jsdoc: ^41.1.2 - eslint-plugin-n: ^15.7.0 - eslint-plugin-prettier: ^4.2.1 - eslint-plugin-promise: ^6.1.1 - jest: ^29.5.0 - prettier: ^2.7.1 - prettier-plugin-packagejson: ^2.2.11 - rimraf: ^3.0.2 - ts-jest: ^29.1.0 - typescript: ^4.7.4 - languageName: unknown - linkType: soft - "socket.io-adapter@npm:~2.5.2": version: 2.5.5 resolution: "socket.io-adapter@npm:2.5.5"