8000 Update docs by JohnGuilding · Pull Request #352 · getwax/bls-wallet · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
This repository was archived by the owner on Nov 5, 2023. It is now read-only.

Update docs #352

Merged
merged 8 commits into from
Oct 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions aggregator-proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,13 @@ runAggregatorProxy(
},
);
```

## Instant wallet without dapp-sponsored transaction
![Instant wallet without dapp-sponsored transactions](./../docs/images/system-overview/instant-wallet-without-dapp-sponsored-txs.jpg)

## Instant wallet with dapp-sponsored transaction
![Instant wallet with dapp-sponsored transaction](./../docs/images/system-overview/instant-wallet-with-dapp-sponsored-txs.jpg)

## Example dApp using a proxy aggregator

- https://github.com/JohnGuilding/single-pool-dex
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/local_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ make these changes in aggregator > .env
RPC_URL=http://localhost:8545
NETWORK_CONFIG_PATH=../contracts/networks/local.json

In a seperate terminal/shell instance

```sh
docker-compose up -d postgres # Or see local postgres instructions in ./aggregator/README.md#PostgreSQL
cd ./aggregator
Expand Down
35 changes: 11 additions & 24 deletions docs/remote_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Follow the instructions for [Local Development](./local_development.md), replaci

### Deployer account

BLS Wallet contract deploys use `CREATE2` to maintain consistent addresses across networks. As such, a create2 deployer contract is used and listed in `./contracts/.env` under the environment variables `DEPLOYER_MNEMONIC` & `DEPLOYER_SET_INDEX`. The HD address will need to be funded in order to deploy the contracts.
BLS Wallet contract deploys use `CREATE2` to maintain consistent addresses across networks. As such, a create2 deployer contract is used and listed in `./contracts/.env` under the environment variables `DEPLOYER_MNEMONIC` & `DEPLOYER_SET_INDEX`. The hierarchical deterministic (HD) wallet address will need to be funded in order to deploy the contracts.

If you do not need consistent addresses, for example on a local or testnet network, you can replace the `DEPLOYER_MNEMONIC` with another seed phrase which already has a funded account.

Expand Down Expand Up @@ -66,40 +66,27 @@ PRIVATE_KEY_ADMIN=PK1

### Extension

Check the [controller constants file](../extension/source/Controllers/constants.ts) to see if your network is already added. If not, you will need to add chainid & supported networks entries for your network/chain. These changes can be committed.
Check the [`config.json` file](../extension//config.json) to see if your network is already added. If not, you will need to add the relevant properties for your network/chain. These changes can be committed.

Then, update this value in `./extension/.env`.
```
...

DEFAULT_CHAIN_ID=YOUR_CHAIN_ID
...
```

## Run
## Example: Arbitrum Testnet (Arbitrum Goerli Testnet)

Follow the remaing instruction in [Local Development](./local_development.md) starting with the `Run` section.
You will need two ETH addresses with Abitrum Goerli ETH and their private keys (PRIVATE_KEY_AGG & PRIVATE_KEY_ADMIN) for running the aggregator. It is **NOT** recommended that you use any primary wallets with ETH Mainnet assets.

## Example: Arbitrum Testnet (Rinkeby Arbitrum Testnet)

You will need two ETH addresses with Rinkeby ETH and their private keys (PK0 & PK1) for running the aggregator. It is NOT recommended that you use any primary wallets with ETH Mainnet assets.

You can get Rinkeby ETH at https://app.mycrypto.com/faucet, and transfer it into the Arbitrum testnet via https://bridge.arbitrum.io/. Make sure when doing so that your network is set to Rinkeby in your web3 wallet extension, such as MetaMask.
You can get Goerli ETH at https://goerlifaucet.com/ or https://app.mycrypto.com/faucet, and transfer it into the Arbitrum testnet via https://bridge.arbitrum.io/. Make sure when doing so that your network is set to Goerli in your web3 wallet extension, such as MetaMask.

Update these values in `./aggregator/.env`.
```
RPC_URL=https://rinkeby.arbitrum.io/rpc
RPC_URL=https://goerli-rollup.arbitrum.io/rpc
...
NETWORK_CONFIG_PATH=../contracts/networks/arbitrum-testnet.json
NETWORK_CONFIG_PATH=../contracts/networks/arbitrum-goerli.json
PRIVATE_KEY_AGG=PK0
PRIVATE_KEY_ADMIN=PK1
...
```

And then update this value in `./extension/.env`.
```
And then ensure the `defaultNetwork` value in `./extension/config.json` is set to `arbitrum-goerli`.
```json
...

DEFAULT_CHAIN_ID=421611
"defaultNetwork": "arbitrum-goerli",
...
```
```
3 changes: 2 additions & 1 deletion docs/use_bls_wallet_dapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Next, connect your dApp to Quill just like you would any other extension wallet.
```typescript
import { providers } from 'ethers';

const provider = providers.Web3Provider(window.ethereum);
const provider = new providers.Web3Provider(window.ethereum);

await window.ethereum.request({ method: "eth_accounts" });
```
Expand Down Expand Up @@ -113,6 +113,7 @@ See the [System Overview](./system_overview.md) for more details on what's happe

- https://github.com/kautukkundan/BLSWallet-ERC20-demo
- https://github.com/voltrevo/bls-wallet-billboard
- https://github.com/JohnGuilding/single-pool-dex

## Coming soon

Expand Down
0