Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/palladians/pallad
π¦ Progressive Mina Protocol Wallet
https://github.com/palladians/pallad
cryptocurrency mina mina-navigators mina-protocol minanavigators self-custodial staking wallet web3 zk-snarks zkapps
Last synced: 3 months ago
JSON representation
π¦ Progressive Mina Protocol Wallet
- Host: GitHub
- URL: https://github.com/palladians/pallad
- Owner: palladians
- License: apache-2.0
- Created: 2023-05-27T09:43:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-17T20:47:25.000Z (7 months ago)
- Last Synced: 2024-04-18T12:11:48.744Z (7 months ago)
- Topics: cryptocurrency, mina, mina-navigators, mina-protocol, minanavigators, self-custodial, staking, wallet, web3, zk-snarks, zkapps
- Language: TypeScript
- Homepage: https://pallad.xyz/
- Size: 10.3 MB
- Stars: 16
- Watchers: 3
- Forks: 2
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
![Module type: ESM](https://img.shields.io/badge/module%20type-esm-brightgreen)
[![Discord](https://img.shields.io/discord/1127906495409958953?label=Discord)](https://discord.gg/ExzzfTGUnB)
![example workflow](https://github.com/palladians/pallad/actions/workflows/apps-extension-ci.yml/badge.svg)β οΈ Work in progress β οΈ
π¨ Now in Beta π¨Welcome to Pallad an experimental and progressive Mina Protocol wallet!
In the vast and evolving world of Web3, a wallet is not just a tool; it's the gateway to a whole new universe. It's the first consumer application anyone encounters in a blockchain ecosystem, and it's pivotal in shaping the user experience. That's where Pallad steps in!
Pallad is at the frontier, leading the way in innovation and user-centric design. We're not just building a wallet; we're crafting the cornerstone of zero-knowledge application interaction design. With Pallad, you're stepping into the future.
## Getting Started π
### Prerequisite π
- [NVM](https://github.com/nvm-sh/nvm)
- pnpm### Installation π»
Make sure you're on the right Node.js version, and you got pnpm installed.
```shell
$ nvm use
$ npm i -g pnpm
```Install the dependencies:
```shell
$ pnpm i
```From `apps/extension` copy the `.env.example` as `.env` and adjust the variables there.
Build all the modules in repo:
```shell
$ pnpm build
```## Structure ποΈ
This is a monorepo for all the Pallad-related code.
- `apps`
- `extension` - Browser extension app.
- `packages`
- `_template` - Template to follow for new packages in this repo.
- `common` - Common configuration for packages (tsup and vitest).
- `features` - Wallet features, views, and UI components.
- `key-management` - Blockchain agnostic key management.
- `mina-core` - Core Mina Package SDK.
- `offchain-data` - Client for fetching off-chain data like fiat price.
- `persistence` - Persistence logic for wallet related data.
- `util` - Shared util functions for other packages.
- `vault` - Credentials storage.
- `web-provider` - Web provider to consume wallet interfaces in browser context.## Development π οΈ
Set up the dev server of extension:
```shell
$ pnpm dev:extension
```## Testing π§ͺ
Running linter:
```shell
$ pnpm lint
```Running unit tests (Vitest):
```shell
$ pnpm test:unit
```Running E2E tests for browser extension (Playwright):
```shell
$ npx playwright install chromium # make sure you have Chromium driver
$ pnpm test:e2e:extension
```## Contributors β¨
Thanks goes to these wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Tomek Marciniak
π»
Teddy Pender
π»
RafaΕ GoΕawski
π»
Mariusz
π»
## Contributing π€
We specified contributing guidelines. Please refer to them before starting contributing to this repository.
[Contributing Guidelines](https://github.com/palladians/pallad/blob/main/CONTRIBUTING.md)
## Links π
[pallad.co - The official website of Pallad](https://get.pallad.co/website)
[Ladle](https://palladians.github.io/pallad/)
[Discord](https://discord.gg/ExzzfTGUnB)