|
1 | | -# |
2 | | -# Licensed to the Apache Software Foundation (ASF) under one |
3 | | -# or more contributor license agreements. See the NOTICE file |
4 | | -# distributed with this work for additional information |
5 | | -# regarding copyright ownership. The ASF licenses this file |
6 | | -# to you under the Apache License, Version 2.0 (the |
7 | | -# "License"); you may not use this file except in compliance |
8 | | -# with the License. You may obtain a copy of the License at |
9 | | -# |
10 | | -# http://www.apache.org/licenses/LICENSE-2.0 |
11 | | -# |
12 | | -# Unless required by applicable law or agreed to in writing, |
13 | | -# software distributed under the License is distributed on an |
14 | | -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
15 | | -# KIND, either express or implied. See the License for the |
16 | | -# specific language governing permissions and limitations |
17 | | -# under the License. |
18 | | -# |
19 | | - |
| 1 | +<!-- |
| 2 | +Licensed to the Apache Software Foundation (ASF) under one |
| 3 | +or more contributor license agreements. See the NOTICE file |
| 4 | +distributed with this work for additional information |
| 5 | +regarding copyright ownership. The ASF licenses this file |
| 6 | +to you under the Apache License, Version 2.0 (the |
| 7 | +"License"); you may not use this file except in compliance |
| 8 | +with the License. You may obtain a copy of the License at |
| 9 | +
|
| 10 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +
|
| 12 | +Unless required by applicable law or agreed to in writing, |
| 13 | +software distributed under the License is distributed on an |
| 14 | +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | +KIND, either express or implied. See the License for the |
| 16 | +specific language governing permissions and limitations |
| 17 | +under the License. |
| 18 | +--> |
| 19 | +--- |
20 | 20 | <div align="center"> |
21 | 21 | <br /> |
22 | 22 | <p> |
|
28 | 28 | </a> |
29 | 29 | <a href="https://github.com/ResilientApp/ResVault/actions"><img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/ResilientApp/ResVault/release.yml"> |
30 | 30 | </a> |
31 | | - <a href="https://github.com/ResilientApp/ResVault/commits/main"><img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/w/ResilientApp/ResVault"> |
| 31 | + <a href="https://github.com/ResilientApp/ResVault/commits/main"><img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/ResilientApp/ResVault"> |
32 | 32 | </a> |
33 | 33 | <a href="https://github.com/ResilientApp/ResVault/blob/main/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/ResilientApp/ResVault"> |
34 | 34 | </a> |
|
41 | 41 |
|
42 | 42 | ## About |
43 | 43 |
|
44 | | -ResVault is a chrome extension that serves as a wallet for [ResilientDB](https://resilientdb.com). ResilientDB is a High Throughput Yielding Permissioned Blockchain Fabric founded by [ExpoLab](https://expolab.org/) at [UC Davis](https://www.ucdavis.edu/) in 2018. ResilientDB advocates a system-centric design by adopting a multi-threaded architecture that encompasses deep pipelines. Further, ResilientDB separates the ordering of client transactions from their execution, which allows it to process messages out-of-order. |
45 | | - |
46 | | -- Create Account |
47 | | -- Delete Account |
48 | | -- Login |
49 | | -- Submit Transactions |
50 | | -- Transactions logging |
51 | | -- User Profiles |
52 | | -- Multi-account support |
53 | | - |
54 | | -**Pending**: |
| 44 | +ResVault is a Chrome extension that serves as a comprehensive wallet for [ResilientDB](https://resilientdb.com). ResilientDB is a High Throughput Yielding Permissioned Blockchain Fabric founded by [ExpoLab](https://expolab.org/) at [UC Davis](https://www.ucdavis.edu/) in 2018. ResilientDB advocates a system-centric design by adopting a multi-threaded architecture that encompasses deep pipelines. Further, ResilientDB separates the ordering of client transactions from their execution, which allows it to process messages out-of-order. |
| 45 | + |
| 46 | +## Features |
| 47 | + |
| 48 | +### Core Wallet Functionality |
| 49 | +- **Create Account** - Generate new wallet accounts with secure key management |
| 50 | +- **Delete Account** - Remove accounts with proper cleanup |
| 51 | +- **Login/Logout** - Secure authentication system |
| 52 | +- **Submit Transactions** - Send transactions to ResilientDB network |
| 53 | +- **Transaction Logging** - Complete transaction history and audit trail |
| 54 | +- **User Profiles** - Manage multiple user identities |
| 55 | +- **Multi-account Support** - Handle multiple wallet accounts simultaneously |
| 56 | + |
| 57 | +### Smart Contract Integration (v1.2.0) |
| 58 | +- **Contract Deployment** - Deploy Solidity smart contracts directly from the wallet |
| 59 | +- **Address Ownership** - Contracts are deployed using your wallet address for proper ownership |
| 60 | +- **GraphQL Integration** - Seamless communication with ResilientDB smart contract service |
| 61 | +- **Solidity Compilation** - Automatic compilation of Solidity contracts before deployment |
| 62 | +- **Enhanced Error Handling** - Improved debugging and error reporting for contract operations |
| 63 | +- **Network Flexibility** - Connect to mainnet or your local ResilientDB server |
| 64 | + |
| 65 | +### Security & Performance |
| 66 | +- **Secure Key Management** - Ed25519 key pairs with proper encryption |
| 67 | +- **Transaction Validation** - Built-in validation for all operations |
| 68 | +- **Network Connectivity** - Support for custom ResilientDB network endpoints |
| 69 | +- **Real-time Updates** - Live transaction status and balance updates |
| 70 | + |
| 71 | +**Pending Features**: |
55 | 72 | - [ ] Password improvement |
56 | | -- [ ] Transaction details |
| 73 | +- [ ] Transaction details view |
57 | 74 | - [ ] View all transactions |
| 75 | +- [ ] Contract execution and interaction |
| 76 | +- [ ] Contract interaction history |
| 77 | +- [ ] Gas estimation and optimization |
58 | 78 |
|
59 | 79 | ## Installation |
60 | 80 | ### Via GitHub release |
61 | 81 | Open [chrome://extensions/](chrome://extensions/) in Google Chrome, toggle Developer mode on: |
62 | 82 | - Click on Load unpacked |
63 | 83 | - Select the build folder that you downloaded from the GitHub releases. |
64 | 84 |
|
65 | | -### Via Chrome Webstore |
66 | | -Coming Soon |
| 85 | +### Via Chrome Web Store |
| 86 | +**🎉 Now Available on Chrome Web Store!** |
| 87 | + |
| 88 | +[](https://chromewebstore.google.com/detail/resvault/ejlihnefafcgfajaomeeogdhdhhajamf) |
| 89 | + |
| 90 | +**[Install ResVault from Chrome Web Store](https://chromewebstore.google.com/detail/resvault/ejlihnefafcgfajaomeeogdhdhhajamf)** |
| 91 | + |
67 | 92 |
|
68 | 93 | ## Build |
69 | 94 | **NodeJS is required.** |
70 | 95 | Open `terminal` and execute: |
71 | 96 | ```shell |
72 | 97 | git clone https://github.com/ResilientApp/ResVault.git |
73 | 98 | cd ResVault |
74 | | -npm install |
75 | | -npm run build |
| 99 | +npm install --legacy-peer-deps |
| 100 | +CI= npm run build |
76 | 101 | ``` |
77 | 102 |
|
| 103 | +## Smart Contract Usage |
| 104 | + |
| 105 | +### Deploying Contracts |
| 106 | +1. Navigate to the **Contract** tab in ResVault |
| 107 | +2. Enter your ResilientDB server URL: |
| 108 | + - **Mainnet**: Use the production ResilientDB endpoint |
| 109 | + - **Local Development**: Use your local server (e.g., `http://localhost:8400`) |
| 110 | + - **Custom Server**: Use any ResilientDB instance (e.g., `http://your-server:8400`) |
| 111 | +3. Paste your Solidity contract code |
| 112 | +4. Provide constructor arguments if needed |
| 113 | +5. Click **Deploy** - the contract will be deployed using your wallet address |
| 114 | + |
78 | 115 | ## Example Usage |
79 | 116 | #### Demo Video |
80 | 117 | Coming Soon |
81 | 118 |
|
82 | 119 | ## Links |
83 | 120 |
|
84 | 121 | - [Website](https://resilientdb.com) |
| 122 | +- [Chrome Web Store](https://chromewebstore.google.com/detail/resvault/ejlihnefafcgfajaomeeogdhdhhajamf) - Install ResVault |
| 123 | +- [GitHub Repository](https://github.com/ResilientApp/ResVault) - Source Code |
85 | 124 |
|
86 | 125 | ## Contributing |
87 | 126 |
|
|
0 commit comments