Skip to content

Commit 0f084be

Browse files
Updated resvault page
1 parent 3cc0a80 commit 0f084be

File tree

1 file changed

+81
-22
lines changed

1 file changed

+81
-22
lines changed

content/resvault.mdx

Lines changed: 81 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { Divider, Box, Space, Alert, Text, Code, Title } from '@mantine/core'
33

44
# ResVault
55

6-
A Chrome extension that serves as a wallet for ResilientDB, providing a user-friendly interface for managing accounts, submitting transactions, and interacting with the ResilientDB blockchain network.
6+
A Chrome extension that serves as a comprehensive wallet for ResilientDB, providing a user-friendly interface for managing accounts, submitting transactions, deploying smart contracts, and interacting with the ResilientDB blockchain network.
77

88
## Overview
99

@@ -14,26 +14,49 @@ ResVault is a Chrome extension wallet designed specifically for ResilientDB, a H
1414
### Core Functionality
1515

1616
- **Account Management**
17-
- Create new accounts
17+
- Create new accounts with secure key generation
1818
- Delete existing accounts
19-
- Multi-account support
20-
- User profiles
19+
- Multi-account support with key pair switching
20+
- User profiles and authentication
2121

2222
- **Transaction Operations**
23-
- Submit transactions to ResilientDB
23+
- Submit transactions to ResilientDB networks
2424
- Transaction logging and history
25-
- Secure transaction signing
26-
27-
- **User Experience**
28-
- Login/logout functionality
29-
- Intuitive Chrome extension interface
30-
- Secure key management
25+
- Secure transaction signing with Ed25519 keys
26+
- File upload for transaction data
27+
28+
- **Network Management**
29+
- Switch between ResilientDB Mainnet and Localnet
30+
- Custom network configuration
31+
- Real-time connection status
32+
- Network-specific settings
33+
34+
- **Service Modes**
35+
- Key-Value service mode for data operations
36+
- Smart Contract service mode for contract deployment
37+
- Dynamic mode switching
38+
39+
### Smart Contract Features (v1.2.0)
40+
41+
- **Contract Deployment**
42+
- Deploy Solidity smart contracts directly from the wallet
43+
- Automatic contract compilation on the server
44+
- Address ownership using your wallet address
45+
- GraphQL integration with ResilientDB contract service
46+
47+
- **Contract Management**
48+
- Upload and deploy contract files
49+
- Constructor argument support
50+
- Contract address tracking
51+
- Deployment status monitoring
3152

3253
### Planned Features
3354

3455
- Password improvement
3556
- Transaction details view
3657
- View all transactions functionality
58+
- Contract execution and interaction
59+
- Gas estimation and optimization
3760

3861
## Installation
3962

@@ -56,7 +79,7 @@ ResVault can be built from source and then installed into chrome.
5679

5780
2. **Install Dependencies**
5881
```bash
59-
npm install
82+
npm install --legacy-peer-deps
6083
```
6184

6285
3. **Build the Extension**
@@ -98,31 +121,66 @@ ResVault can be built from source and then installed into chrome.
98121

99122
### Managing Accounts
100123

101-
- **Create Account**: Generate new wallet addresses
124+
- **Create Account**: Generate new wallet addresses with secure key pairs
102125
- **Delete Account**: Remove accounts you no longer need
103-
- **Switch Accounts**: Easily switch between multiple accounts
126+
- **Switch Accounts**: Easily switch between multiple key pairs
104127
- **User Profiles**: Manage different user profiles within the wallet
128+
- **Export/Import Keys**: Download and upload key pair files
129+
130+
### Network Configuration
131+
132+
1. **Select Network**
133+
- Choose between ResilientDB Mainnet and Localnet
134+
- Configure custom network endpoints
135+
- Set protocol (HTTP/HTTPS)
136+
137+
2. **Service Mode**
138+
- Toggle between Key-Value and Smart Contract modes
139+
- Mode-specific functionality and interfaces
140+
141+
3. **Connection Status**
142+
- Real-time connection indicators
143+
- Network-specific settings and configurations
105144

106145
### Submitting Transactions
107146

108147
1. **Prepare Transaction**
109-
- Enter the transaction details
110-
- Verify the recipient address
111-
- Set the transaction amount
148+
- Upload JSON transaction files
149+
- Enter transaction details manually
150+
- Verify recipient addresses and amounts
112151

113152
2. **Review and Confirm**
114153
- Double-check all transaction details
115-
- Confirm the transaction
154+
- Confirm the transaction with your private key
116155

117156
3. **Monitor Status**
118-
- Track transaction status in the logging section
119-
- View transaction history
157+
- Track transaction status in real-time
158+
- View transaction history and confirmations
159+
- Copy transaction IDs for reference
160+
161+
### Smart Contract Deployment
162+
163+
1. **Upload Contract**
164+
- Upload Solidity contract files
165+
- Paste contract code directly
166+
- Provide constructor arguments if needed
167+
168+
2. **Deploy Contract**
169+
- Deploy using your wallet address as owner
170+
- Monitor deployment progress
171+
- Receive contract address upon successful deployment
172+
173+
3. **Contract Management**
174+
- Track deployed contracts
175+
- View contract addresses and ownership
176+
- Monitor contract deployment status
120177

121178
### Transaction Logging
122179

123180
- View all submitted transactions
124181
- Check transaction status and confirmations
125182
- Access detailed transaction information
183+
- Export transaction history
126184

127185
## Security Considerations
128186

@@ -161,11 +219,12 @@ ResVault can be built from source and then installed into chrome.
161219
## Links
162220

163221
- **Website**: [ResilientDB](https://resilientdb.com)
164-
- **GitHub Repository**: [ResVault](https://github.com/ResilientApp/ResVault)
222+
- **GitHub Repository**: [ResVault](https://github.com/apache/incubator-resilientdb-resvault)
223+
- **Apache Incubator**: [Apache Incubator ResVault](https://github.com/apache/incubator-resilientdb-resvault)
165224

166225
## License
167226

168-
This project is licensed under the Apache License 2.0 - see the [LICENSE](https://github.com/ResilientApp/ResVault/blob/main/LICENSE) file for details.
227+
This project is licensed under the Apache License 2.0 - see the [LICENSE](https://github.com/apache/incubator-resilientdb-resvault/blob/main/LICENSE) file for details.
169228

170229
## Related Tools
171230

0 commit comments

Comments
 (0)