-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adds module selection guide to build modules
- Loading branch information
Showing
8 changed files
with
102 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 2 | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Add Audit Attestations | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"label": "Build Modules", | ||
"position": 2, | ||
"link": { | ||
"type": "generated-index" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
sidebar_position: 1 | ||
|
||
--- | ||
|
||
# Getting Started | ||
|
||
|
||
Here is a step-by-step guide on how to get started with building modules for Safe accounts using the available module templates and templates provided by ZenGuard. | ||
|
||
### Prerequisites | ||
|
||
- An environment to write, build and test solidity scripts. | ||
- Familiarity with smart accounts ans Safe accounts. | ||
|
||
|
||
### Choosing the right template | ||
|
||
There are plenty of ways to start building the module based on what kind of module and feature we want to build. | ||
These are different ways to build modules. | ||
|
||
- ### Independant Safe Modules | ||
- These are modules that are directly added to Safe accounts and natively supported by Safe and Safe {Wallet} | ||
<br/>Reference: https://docs.safe.global/advanced/smart-account-modules | ||
|
||
- ### Safe modules that are compliant with Safe{Core} Protocol spec. | ||
- These are modules that are compliant with Safe {Core} Protocol spec with the help of managers. | ||
<br/>Reference: https://github.com/5afe/safe-core-protocol-specs | ||
|
||
- ### Safe modules that are interoperable with other smart accounts. | ||
- These are modules developed using interoperable standards such as ERC-7579 and ERC-6900 | ||
<br/>Reference: https://erc7579.com | ||
|
||
|
||
|
||
### Steps to Build Modules | ||
|
||
After selecting the right approach to build the module based on the usecase, follow the guide to start building the module. | ||
|
||
|
||
### Additional Resources | ||
|
||
|
||
* [Module Templates](https://github.com/zenguardxyz/module-templates) | ||
* [Building Modules for Safe Accounts](https://github.com/zenguardxyz/module-templates/docs/building-modules.md) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
sidebar_position: 3 | ||
|
||
--- | ||
|
||
# Interoperable standards | ||
|
||
|
||
### Safe modules that are interoperable with other smart accounts. | ||
- These are modules developed using interoperable standards such as ERC-7579 and ERC-6900 | ||
<br/>Reference: https://erc7579.com | ||
|
||
|
||
|
||
### Additional Resources | ||
|
||
|
||
* [Module Templates](https://github.com/zenguardxyz/module-templates) | ||
* [Building Modules for Safe Accounts](https://github.com/zenguardxyz/module-templates/docs/building-modules.md) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
sidebar_position: 2 | ||
|
||
--- | ||
|
||
# Safe Core Protocol | ||
|
||
### Safe modules that are compliant with Safe{Core} Protocol spec. | ||
- These are modules that are compliant with Safe {Core} Protocol spec with the help of managers. | ||
<br/>Reference: https://github.com/5afe/safe-core-protocol-specs | ||
|
||
|
||
|
||
### Additional Resources | ||
|
||
|
||
* [Module Templates](https://github.com/zenguardxyz/module-templates) | ||
* [Building Modules for Safe Accounts](https://github.com/zenguardxyz/module-templates/docs/building-modules.md) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 3 | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Explore Modules | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 4 | ||
sidebar_position: 5 | ||
--- | ||
|
||
# Integrate Modules from ZenGuard | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 1 | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Publish Modules | ||
|