Skip to content

docs: update chain expansion guide for entrypoint v0.6 #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: entry-point-v0.6
Choose a base branch
from

Conversation

weikangsong
Copy link
Contributor

@weikangsong weikangsong commented May 3, 2025

Summary

Update chain expansion guide in README for EP v0.6 branch

Detail

Changeset

Update README with a comprehensive "Chain Expansion Guide". main branch PR

Checklist

  • Did you add new tests and confirm all tests pass? (yarn test)
  • Did you ensure any new Solidity source code files meet minimum test coverage requirements? (yarn coverage)
  • Did you update relevant docs? (docs are found in the docs folder)
  • Do your commits follow the Conventional Commits standard?
  • Does your PR title also follow the Conventional Commits standard?
  • Did you run lint (yarn lint) and fix any issues?
  • Did you run formatter (yarn format:check) and fix any issues (yarn format:write)?

Testing

Mandatory section.
For each changeset, please highlight the tests you've added.

Documentation

Optional section.
Link to the doc.

@weikangsong weikangsong changed the title docs: update chain expansion guide for EP v0.6 docs: update chain expansion guide for entrypoint v0.6 May 3, 2025
README.md Outdated

4. Include the relevant logs from the `broadcast` folder in your commit.
```shell
forge script script/bytecode-deploy/107_DeploySponsorPaymasterEPv06.s.sol -vvvv --slow --broadcast --force --multi
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor, we only have 101_DeploySponsorPaymaster.s.sol as an example on this branch

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed all the typos

README.md Outdated
* License: Option 5 in https://etherscan.io/contract-license-types
* Upload the JSON file
* If the contract you are verifying took constructor arguments, input the output of the below command with the `0x` prefix removed into the "Constructor Arguments ABI-encoded" section:
Use `script/bytecode-deploy/standard-json-input/SponsorPaymasterEP.json` to verify. Select the following options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor, should probably use SponsorPaymaster.json

Use `script/bytecode-deploy/standard-json-input/SponsorPaymasterEP.json` to verify. Select the following options
in block explorers verify contract UI:
* Compiler Type: `Solidity(Standard-Json-Input)`
* Compiler Version: `v0.8.17`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v0.8.24?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sponsor paymaster on EP v0.6 uses v0.8.17

README.md Outdated
```shell
cast abi-encode "constructor(<arg type 1>, <arg type 2>, ...)" "arg1Val" "arg2Val"
### Deploy & Verify SingleOwnerMSCAFactory
Deploy, setup and verify SingleOwnerMSCAFactory compatible with ERC-4337 v0.6 and ERC-6900 v0.7.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: removing and ERC-6900 v0.7

README.md Outdated
Tip: if your contract's constructor arguments have complicated types, you can get this value instead by `console.log`ing the output of `abi.encode(arg1, arg2, ...)` in Solidity.
```shell
# Deploy PluginManagerEPv06
forge script script/bytecode-deploy/108_DeployPluginManagerEPv06.s.sol -vvvv --slow --broadcast --force --multi
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

102_DeployPluginManager.s.sol

README.md Outdated

* For account factory contracts, you may also need to manually verify the proxy contract. To do this, you will first need to create an account using the account factory, and follow the above strategy. After verifying one account, all subsequent proxies should be automatically detected.
# Deploy SingleOwnerMSCAFactoryEPv06
forge script script/bytecode-deploy/109_DeploySingleOwnerMSCAFactoryEPv06.s.sol -vvvv --slow --broadcast --force --multi
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

103_DeploySingleOwnerMSCAFactory.s.sol

README.md Outdated

* For account factory contracts, you may also need to manually verify the proxy contract. To do this, you will first need to create an account using the account factory, and follow the above strategy. After verifying one account, all subsequent proxies should be automatically detected.
# Deploy SingleOwnerMSCAFactoryEPv06
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy SingleOwnerMSCAFactory

README.md Outdated

Tip: analyze the account creation function on the factory (e.g. `createAccount` for `SingleOwnerMSCAFactory`) to deduce the constructor arguments for the proxy deployment when trying to verify it on a block explorer.
# Deploy ColdStorageAddressBookPluginEPv06
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy ColdStorageAddressBookPlugin

README.md Outdated

Tip: analyze the account creation function on the factory (e.g. `createAccount` for `SingleOwnerMSCAFactory`) to deduce the constructor arguments for the proxy deployment when trying to verify it on a block explorer.
# Deploy ColdStorageAddressBookPluginEPv06
forge script script/bytecode-deploy/110_DeployColdStorageAddressBookPluginEPv06.s.sol -vvvv --slow --broadcast --force --multi
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

104_DeployColdStorageAddressBookPlugin.s.sol

@weikangsong weikangsong requested a review from huaweigu May 5, 2025 21:26
@@ -85,7 +85,7 @@ Deploy, setup and verify SponsorPaymaster compatible with ERC-4337 v0.6.
Note that deploy commands attempt to deploy on all chains listed in foundry.toml.

```shell
forge script script/bytecode-deploy/107_DeploySponsorPaymasterEPv06.s.sol -vvvv --slow --broadcast --force --multi
forge script script/bytecode-deploy/101_DeploySponsorPaymasterEPv06.s.sol -vvvv --slow --broadcast --force --multi
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo, 101_DeploySponsorPaymaster.s.sol

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants