Skip to content

Commit 0fd75e8

Browse files
Updated ResVault to match the Standalone repo
1 parent 5cefdbe commit 0fd75e8

File tree

14 files changed

+46151
-490
lines changed

14 files changed

+46151
-490
lines changed

ecosystem/tools/resvault/README.md

Lines changed: 75 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
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+
---
2020
<div align="center">
2121
<br />
2222
<p>
@@ -28,7 +28,7 @@
2828
</a>
2929
<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">
3030
</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">
3232
</a>
3333
<a href="https://github.com/ResilientApp/ResVault/blob/main/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/ResilientApp/ResVault">
3434
</a>
@@ -41,47 +41,86 @@
4141

4242
## About
4343

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**:
5572
- [ ] Password improvement
56-
- [ ] Transaction details
73+
- [ ] Transaction details view
5774
- [ ] View all transactions
75+
- [ ] Contract execution and interaction
76+
- [ ] Contract interaction history
77+
- [ ] Gas estimation and optimization
5878

5979
## Installation
6080
### Via GitHub release
6181
Open [chrome://extensions/](chrome://extensions/) in Google Chrome, toggle Developer mode on:
6282
- Click on Load unpacked
6383
- Select the build folder that you downloaded from the GitHub releases.
6484

65-
### Via Chrome Webstore
66-
Coming Soon
85+
### Via Chrome Web Store
86+
**🎉 Now Available on Chrome Web Store!**
87+
88+
[![Chrome Web Store](https://img.shields.io/badge/Chrome%20Web%20Store-Available-green)](https://chromewebstore.google.com/detail/resvault/ejlihnefafcgfajaomeeogdhdhhajamf)
89+
90+
**[Install ResVault from Chrome Web Store](https://chromewebstore.google.com/detail/resvault/ejlihnefafcgfajaomeeogdhdhhajamf)**
91+
6792

6893
## Build
6994
**NodeJS is required.**
7095
Open `terminal` and execute:
7196
```shell
7297
git clone https://github.com/ResilientApp/ResVault.git
7398
cd ResVault
74-
npm install
75-
npm run build
99+
npm install --legacy-peer-deps
100+
CI= npm run build
76101
```
77102

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+
78115
## Example Usage
79116
#### Demo Video
80117
Coming Soon
81118

82119
## Links
83120

84121
- [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
85124

86125
## Contributing
87126

0 commit comments

Comments
 (0)