github/bls-wallet
1
1
Fork 0
mirror of https://github.com/getwax/bls-wallet.git synced 2026-01-08 21:38:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix: typos (#517)

Browse Source 
Fix docs typos
This commit is contained in:
omahs
2023-02-09 19:41:15 +01:00
committed by GitHub
parent 99ed78bf49
commit 5769d08a0e
6 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -1,6 +1,6 @@
# Contribute to BLS Wallet
Thank for taking the time to contribute to BLS Wallet!
Thanks for taking the time to contribute to BLS Wallet!
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
@@ -18,7 +18,7 @@ First search for an [existing issue](https://github.com/web3well/bls-wallet/issu
### Solve an issue
Search for a [existing issue](https://github.com/github/docs/issues) that is unassigned and interests you. If this is your first time contributing, you may want to choose a [good first issue](https://github.com/web3well/bls-wallet/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
Search for an [existing issue](https://github.com/github/docs/issues) that is unassigned and interests you. If this is your first time contributing, you may want to choose a [good first issue](https://github.com/web3well/bls-wallet/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
## Make Changes
@@ -34,7 +34,7 @@ Search for a [existing issue](https://github.com/github/docs/issues) that is una
## Commit your update
Commit your changes over one or more commits. It is recommend your format your commit messages as follows:
Commit your changes over one or more commits. It is recommended to format your commit messages as follows:
```
A short summary of what you did
@@ -50,11 +50,11 @@ Once ready, a BLS Wallet team member will review the PR.
- When run, all Github Actions workflows should succeed.
- All TODO/FIXME comments in code should be resolved, unless marked `merge-ok` with a description/issue link describing how they can be resolved in future work.
- The author of a comment may mark it as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations) when they are satisified with a requested change or answer to a question. You are not required to resolve all comments as some may provide good historical information.
- The author of a comment may mark it as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations) when they are satisfied with a requested change or answer to a question. You are not required to resolve all comments as some may provide good historical information.
## Your PR is merged!
Thanks for your hard work! Accept our heartfelt graditiude and revel in your masterful coding and/or documentational skills.
Thanks for your hard work! Accept our heartfelt gratitude and revel in your masterful coding and/or documentational skills.
### Thanks

2
README.md
View File

@@ -14,7 +14,7 @@ You can watch a full end-to-end demo of the project [here](https://www.youtube.c
### Setup your development environment
- [Local develeopment](./docs/local_development.md)
- [Local development](./docs/local_development.md)
- [Remote development](./docs/remote_development.md)
## Components

2
docs/README.md
View File

@@ -4,5 +4,5 @@
- [Use BLS Wallet in a browser/NodeJS/Deno app](./use_bls_wallet_clients.md)
- [Use BLS Wallet in your L2 dApp for cheaper, multi action transactions](./use_bls_wallet_dapp.md)
- Setup the BLS Wallet components for:
- [Local develeopment](./local_development.md)
- [Local development](./local_development.md)
- [Remote development](./remote_development.md)

8
docs/local_development.md
View File

@@ -14,7 +14,7 @@ If you're running a Windows machine, we recommend using [WSL2](https://learn.mic
- [Yarn](https://yarnpkg.com/getting-started/install) (`npm install -g yarn`)
- [Deno](https://deno.land/#installation)
### Optional (Recomended)
### Optional (Recommended)
- [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
- [docker-compose](https://docs.docker.com/compose/install/)
@@ -71,7 +71,7 @@ cp .env.local.example .env
The [extension](../extension/) (otherwise referred to as Quill) is a prototype extension wallet used to showcase and test BLS Wallet features. **Note it is not a production wallet.**
In a seperate terminal/shell instance
In a separate terminal/shell instance
```sh
cd ./extension
@@ -106,11 +106,11 @@ yarn run dev:chrome # or dev:firefox, dev:opera
### Additional troubleshooting tips
- In general, the bundle or submission issues we've encountered have been us misconfiguring the data in the bundle or not configuring the aggregator properly.
- Be careful using HH accounts 0 and 1 in your code when running a local aggregator. This is because the local aggregator config uses the same key pairs as Hardhat accounts 0 and 1 by default. You can get round this by not using accounts 0 and 1 elsewhere, or changing the default accounts that the aggregator uses locally.
- Be careful using HH accounts 0 and 1 in your code when running a local aggregator. This is because the local aggregator config uses the same key pairs as Hardhat accounts 0 and 1 by default. You can get around this by not using accounts 0 and 1 elsewhere, or changing the default accounts that the aggregator uses locally.
### Tests
See each components `README.md` for how to run tests.
See each component's `README.md` for how to run tests.
## Testing/using updates to ./clients

4
docs/remote_development.md
View File

@@ -12,7 +12,7 @@ If you're running a Windows machine, we recommend using [WSL2](https://learn.mic
- [Yarn](https://yarnpkg.com/getting-started/install) (`npm install -g yarn`)
- [Deno](https://deno.land/#installation)
### Optional (Recomended)
### Optional (Recommended)
- [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
- [docker-compose](https://docs.docker.com/compose/install/)
@@ -77,7 +77,7 @@ A network config file will be generated at `./contracts/networks/local.json`. Yo
mv ./networks/local.json ./networks/your-network.json
```
This file can be commited so others can use your deployed contracts.
This file can be committed so others can use your deployed contracts.
## Aggregator

4
docs/use_bls_wallet_dapp.md
View File

@@ -4,9 +4,9 @@ This guide will show you how to use BLS Wallet in your L2 dApp (Layer 2 decentra
## Download, Install, & Setup Quill
[Quill](../extension/) is a protoype browser extension wallet which intergrates [bls-wallet-clients](../contracts/clients/) to communicate with the BLS Wallet smart contracts & transaction aggregator. It supports most of the functionality in [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193).
[Quill](../extension/) is a prototype browser extension wallet which integrates [bls-wallet-clients](../contracts/clients/) to communicate with the BLS Wallet smart contracts & transaction aggregator. It supports most of the functionality in [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193).
Currently, we have the contracts deployed to the networks/chains listed [here](https://github.com/web3well/bls-wallet/tree/main/contracts/networks). If your desired network isn't there, you can use the [Remote Development](./remote_development.md) contract deployment intrsuctions or request a network deploy by [opening an issue](https://github.com/web3well/bls-wallet/issues/new) or [starting a discussion](https://github.com/web3well/bls-wallet/discussions/new).
Currently, we have the contracts deployed to the networks/chains listed [here](https://github.com/web3well/bls-wallet/tree/main/contracts/networks). If your desired network isn't there, you can use the [Remote Development](./remote_development.md) contract deployment instructions or request a network deploy by [opening an issue](https://github.com/web3well/bls-wallet/issues/new) or [starting a discussion](https://github.com/web3well/bls-wallet/discussions/new).
Below are the instructions for 2 ways you can add Quill to your browser.