Skip to content

Commit

Permalink
docs: readme deployment instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
adamegyed committed Dec 16, 2024
1 parent 5344175 commit 29e8a81
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,12 @@ forge test -vvv

### Deployment

A deployment script can be found in the `scripts/` folder
Deployment scripts can be found in the `scripts/` folder, and depend on reading parameters from your local environment or from `.env`. A sample for the required fields can be found at `.env.example`. Note that some have specific foundry profiles needed for deployment.

You will also need provide a wallet to use for deployment. Available options can be found [here](https://book.getfoundry.sh/reference/forge/forge-script#wallet-options---raw).

```bash
forge script script/Deploy.s.sol --rpc-url $RPC_URL --broadcast
FOUNDRY_PROFILE=<profile> forge script script/<deploy_script>.s.sol --rpc-url $RPC_URL --broadcast
```

## Features overview
Expand All @@ -94,7 +96,7 @@ Certain applications such as Permit2 or Cowswap use the ERC-1271 contract signat

#### Upgradeability

When modular accounts are created from the factory, an ERC-1967 proxy contract is deployed. Users can update the implementation their proxy points to to choose which smart account implementations to use. Modular Account v2 adheres to the ERC-7201 namespaced storage standard to prevent storage collisions when updating between different implementations.
When modular accounts are created from the factory, an ERC-1967 proxy contract is deployed. Users can update the implementation their proxy points to to choose which smart account implementations to use. Modular Account adheres to the ERC-7201 namespaced storage standard to prevent storage collisions when updating between different implementations.

### Customizing your Modular Account

Expand Down

0 comments on commit 29e8a81

Please sign in to comment.