https://github.com/decentralized-identity/web5-wallet
A reference implementation of a web5 wallet in react native
https://github.com/decentralized-identity/web5-wallet
web5
Last synced: 24 days ago
JSON representation
A reference implementation of a web5 wallet in react native
- Host: GitHub
- URL: https://github.com/decentralized-identity/web5-wallet
- Owner: decentralized-identity
- License: apache-2.0
- Created: 2023-04-20T22:39:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-14T11:17:31.000Z (over 1 year ago)
- Last Synced: 2025-07-19T01:52:45.267Z (11 months ago)
- Topics: web5
- Language: TypeScript
- Homepage:
- Size: 2.82 MB
- Stars: 16
- Watchers: 4
- Forks: 7
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Governance: GOVERNANCE.md
Awesome Lists containing this project
README
# Web5 Wallet
Built with React Native and Expo
# Application Setup
Note that most things are not installed using Homewbrew. Homebrew is nice for personal projects but doesn't scale well for teams.
Installation prerequisites:
- `nvm` (Node Version Manager) - install NOT using `homebrew`:
`curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash`
Change the version in the command above to latest `nvm` version as needed.
- `rvm` (Ruby Version Manager) - install NOT using `homebrew`:
`\curl -sSL https://get.rvm.io | bash -s stable`
- `node` v20.15.1 and select it - install using `nvm`:
`nvm install 20.15.1`
`nvm use 20.15.1` - installing should already switch to the desired version, but run this if `node -v` shows a wrong version
- `ruby` v3.2.2 and select it - install using `rvm`:
`rvm install 3.2.2`
`rvm use 3.2.2` - installing should already switch to the desired version, but run this if `ruby -v` shows a wrong version
Note, `ruby` installation requires openSSL v1, if you have openSSL v3 installed, you might need to override with explicit reference to openSSL v1 directory if you installation fails on openSSL. e.g.
`rvm install 3.2.2 --with-openssl-dir=$(brew --prefix openssl@1.1)`
- `watchman`
`brew install watchman`
- This project uses the web5-js repo symlinked locally. You must clone the web5-js repo into a sibling folder next to this repo. Afterwards, install and build the web5-js repo.
Installation steps:
1. Run `corepack enable` to turn on `corepack` for this node version if you haven't already turned it on.
2. Run `corepack install` to install `yarn` pkg manager
3. Run `yarn` to install `node_modules`
Note, if you encounter the following error:
```
"Internal Error: Error when performing the request to https://registry.npmjs.org/yarn;
```
Check to see if you are running a VPN that blocks this URL, if so, disable the VPN and try again.
4. From root repo directory, run:
`cd ios` then `bundle install`
5. From root repo directory, run:
`cd android` the `bundle install`
6. In the root repo directory run `yarn pods` to install CocoaPods
Note: if you encounter the error below:
```
[!] CocoaPods could not find compatible versions for pod "hermes-engine"
```
You will need to run the following command to update `hermes-engine` version in `Podfile.lock` file in the `ios` directory as suggested in the full error message:
`pod update hermes-engine --no-repo-update`
7. Install XCode with the latest SDK if necessary
8. Install Android Studio with the latest SDK if necessary
The project should now be ready to run.
First start the Metro Bundler:
`yarn start`
To Run iOS: Inside the `ios` folder, open the `.xcworkspace` and run the build (click the "play" button).
To Run Android: Open the `android` folder in Android Studio and run the build.
## Debugging
The application can be debugged through VSCode
1. Download the Expo Tools VSCode Extension.
2. Use the "Run and Debug" menu in VSCode to run the script "Debug Expo App."
3. Fire up a simulator so that the session attaches to the debugger.
4. Set your breakpoints as needed.
> Caution: Reused breakpoints don't work. Make sure to clear breakpoints in between sessions.
### Alternative Method
If you are having trouble getting the above method to work. Consider the [alternative method](https://reactnative.dev/docs/debugging?js-debugger=new-debugger#opening-the-debugger) below.
Start Metro Bundler with:
`npx react-native start --experimental-debugger`
Then you can launch the debugger by triggering the Dev Menu in the app (e.g. by pressing `d` in the Metro Bundler terminal) then choosing the "Open Debugger" option, this will launch the debugger in the browser.
## Troubleshooting install
- `which yarn` should be `/Users/{USER}/.yarn/bin/yarn`
- `which rvm` should be `/Users/{USER}/.rvm/bin/rvm`
- `which node` should be `/Users/{USER}/.nvm/versions/node/v20.15.1/bin/node`
- `which npm` should be `/Users/{USER}/.nvm/versions/node/v20.15.1/bin/npm`
- `nvm list` should include `-> v20.15.1`
- `rvm list` should include `=* ruby-3.2.2 [ arm64 ]`
## Further troubleshooting install
- Run `npx expo-env-info@latest` and send that info to a maintainer or post it in an issue