Skip to content

Commit

Permalink
chore: rebrand Snap to Masca (#157)
Browse files Browse the repository at this point in the history
* chore: remove old website (#136)

* chore: removed workflows, website

* chore: update lock file and some other fixes

* feat: update packages to esm (#135)

* feat: esm ssi-snap-types

* feat: esm connector

* fix: add readme to output

* chore: update connector deps

* chore: lintstaged.cjs

* chore: more lintstaged.cjs

* chore: connector lintstaged.cjs

* feat: esm vcmanager and update configs

* feat: esm utils

* feat: update tests

* chore: deps

* fix: build dapp

* fix: docs

* fix: fixes config issues

* fix: fixes config issues

* fix: resolve last issues

* chore: update dev deps (#144)

* chore: update dev deps

* fix: fixes lockfile

* fix: fixes lockfile

* chore: update nodejs and pnpm

* chore: remove patch

* chore: add back snap types patch

* fix: should fix CI workflow

* fix: set pnpm version in main CI

* chore: rename in snap

* chore: rebrand connector

* chore: change package json description

* chore: change packages

* chore: change packages

* chore: change packages

* fix: fix website bugs

* chore: update package json

* chore: typo

* chore: add logo to README.md

* chore: show correct logo in README.md based on dark/light mode

* chore: add dark mode logo

* chore: add light mode logo

* chore: update README.md

* chore: fixes

* chore: remove deploy dapp/docs workflows

* fix: update docker files

* fix: resolve initial upgrade issues

* fix: patch cross-fetch

* feat: update postprocess to work with 0.30.0 snaps

* fix: fixes test index.html page

* fix: update connector, update tailwind config

* chore: add cross-env to dapp

* chore: change env var dev to development

* chore: use USE_LOCAL env var

* feat: update connector for setCurrentAccount

* feat: update dapp for setCurrentAccount

---------

Co-authored-by: Martin Domajnko <[email protected]>
Co-authored-by: Urban <[email protected]>
Co-authored-by: Vid Kersic <[email protected]>
Co-authored-by: martines3000 <[email protected]>
  • Loading branch information
5 people authored Apr 20, 2023
1 parent d1fc4fe commit 0f0c0fd
Show file tree
Hide file tree
Showing 101 changed files with 898 additions and 997 deletions.
1 change: 0 additions & 1 deletion .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ module.exports = {
ignorePatterns: [
'**/node_modules/**',
'**/dist/**',
'**/!.eslintrc.js',
'**/!.eslintrc.cjs',
'**/coverage/**',
'**/build/**',
Expand Down
106 changes: 0 additions & 106 deletions .github/workflows/deploy_dapp.yml

This file was deleted.

98 changes: 0 additions & 98 deletions .github/workflows/deploy_docs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/publish_core.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ jobs:
env:
NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
- name: Publish
run: npm publish -w @blockchain-lab-um/ssi-snap -w @blockchain-lab-um/ssi-snap-connector -w @blockchain-lab-um/veramo-vc-manager -w @blockchain-lab-um/ssi-snap-types
run: npm publish -w @blockchain-lab-um/masca -w @blockchain-lab-um/masca-connector -w @blockchain-lab-um/veramo-vc-manager -w @blockchain-lab-um/masca-types
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
2 changes: 1 addition & 1 deletion .github/workflows/sonarcloud.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: Test snap
run: pnpm nx test:ci @blockchain-lab-um/ssi-snap
run: pnpm nx test:ci @blockchain-lab-um/masca
env:
NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
- name: Scan snap
Expand Down
2 changes: 0 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,5 @@ RUN pnpm install
# Copy all other files
COPY . .

ENV NODE_ENV=production

# Build affected projects
RUN pnpm build:docker
44 changes: 28 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,42 @@
# SSI Snap &middot; [![npm version](https://img.shields.io/npm/v/@blockchain-lab-um/ssi-snap.svg?style=flat)](https://www.npmjs.com/package/@blockchain-lab-um/ssi-snap)
<div align="center" id="logo">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/masca_logo_dark.svg">
<source media="(prefers-color-scheme: light)" srcset="assets/masca_logo_light.svg">
<img width="250" height="250" alt="Masca logo" src="assets/masca_logo_dark.svg">
</picture>
</div>

The SSI Snap enables everyone to build their **decentralized and self-sovereign identity by enhancing MetaMask with functionalities to manage DIDs, VCs, and VPs.** Any dApp can connect it to access identity data, and dApp developers can already start with the integration!
## [![npm version](https://img.shields.io/npm/v/@blockchain-lab-um/masca.svg?style=flat)](https://www.npmjs.com/package/@blockchain-lab-um/masca)

- [Website](https://blockchain-lab-um.github.io/ssi-snap/)
Masca enables everyone to build their **decentralized and self-sovereign identity by enhancing MetaMask with functionalities to manage DIDs, VCs, and VPs.** Any dApp can connect it to access identity data, and dApp developers can already start with the integration!

- [Website](https://blockchain-lab-um.github.io/masca/)
- [Demo](https://blockchain-lab-um.github.io/course-dapp/)
- [Docs](https://blockchain-lab-um.github.io/ssi-snap-docs/)
- [Docs](https://blockchain-lab-um.github.io/masca-docs/)
- [Blog post](https://medium.com/@blockchainlabum/open-sourcing-ssi-snap-for-metamask-aaa176775be2)

# Features

The SSI Snap is built agnostic, leaving the user to choose his preferred **blockchain, DID method, and data storage provider.** Everything is configurable, just like selecting the network in MetaMask. Currently supported technologies:
Masca is built agnostic, leaving the user to choose his preferred **blockchain, DID method, and data storage provider.** Everything is configurable, just like selecting the network in MetaMask. Currently supported technologies:

- **Blockchains:** Any EVM-based blockchain that is supported by DID methods
- **DID methods:** `did:ethr`, `did:key`, `did:pkh`
- **DID methods:** `did:ethr`, `did:key`, `did:pkh`, `did:jwk`
- **Data storage providers:** Local MetaMask Snap state, Ceramic Network

Many new features are already in the works. For more information, please check the [roadmap](https://blockchain-lab-um.github.io/ssi-snap-docs/docs/roadmap) on the documentation.
Many new features are already in the works. For more information, please check the [roadmap](https://blockchain-lab-um.github.io/masca-docs/docs/roadmap) on the documentation.

# Development

### Versions

Every version of SSI Snap does NOT work with every version of MetaMask Flask! Here is a table of compatible versions:
Every version of Masca does NOT work with every version of MetaMask Flask! Here is a table of compatible versions:

| SSI Snap Version | Flask Version |
| ---------------- | ------------- |
| 1.2.2 | up to 10.19.0 |
| 1.3.0 | 10.24.0 |
| 1.4.0 | 10.25.0 |
| 1.5.0 | 10.26.1 |
| Masca version | MetaMask Flask version |
| ------------- | ---------------------- |
| 1.2.2 | up to 10.19.0 |
| 1.3.0 | 10.24.0 |
| 1.4.0 | 10.25.0 |
| 1.5.0 | 10.26.1 |

### Prerequisites

Expand All @@ -44,7 +52,7 @@ Every version of SSI Snap does NOT work with every version of MetaMask Flask! He
### Snap

- To start the Snap run `pnpm start:snap`
- Snap can be tested on `localhost:8081/` or on SSI Snap Website
- Snap can be tested on `localhost:8081/` or on Masca website

### Website

Expand All @@ -56,7 +64,11 @@ Every version of SSI Snap does NOT work with every version of MetaMask Flask! He

# Feature requests

Is SSI Snap missing some crucial features? For new features and other enhancements, please open a new issue. If you are unsure if it fits in the Snap, start a new discussion under the Discussions tab.
Is Masca missing some crucial features? For new features and other enhancements, please open a new issue. If you are unsure if it fits in the Snap, start a new discussion under the Discussions tab.

# Rebrand

Masca was previously called SSI Snap; thus, the old name can still appear in some places. You can also find earlier versions of the Snap under the SSI Snap packages.

# Licenses

Expand Down
15 changes: 15 additions & 0 deletions assets/masca_logo_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0f0c0fd

Please sign in to comment.