From 0f4464ffe12c3bd48844bd242b49eb63752cfd8b Mon Sep 17 00:00:00 2001 From: Koshik Raj Date: Sun, 5 May 2024 16:14:06 +0530 Subject: [PATCH] feat: adds module selection guide to build modules --- docs/getting-started/audit-module.md | 2 +- .../build-modules/_category_.json | 7 +++ .../build-modules/build-modules.md | 48 +++++++++++++++++++ .../build-modules/interoperable-spec.md | 22 +++++++++ .../build-modules/safe-core-protocol.md | 21 ++++++++ docs/getting-started/explore-module.md | 2 +- docs/getting-started/integrate.md | 2 +- docs/getting-started/publish-module.md | 2 +- 8 files changed, 102 insertions(+), 4 deletions(-) create mode 100644 docs/getting-started/build-modules/_category_.json create mode 100644 docs/getting-started/build-modules/build-modules.md create mode 100644 docs/getting-started/build-modules/interoperable-spec.md create mode 100644 docs/getting-started/build-modules/safe-core-protocol.md diff --git a/docs/getting-started/audit-module.md b/docs/getting-started/audit-module.md index a85df41..66a09cb 100644 --- a/docs/getting-started/audit-module.md +++ b/docs/getting-started/audit-module.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 --- # Add Audit Attestations diff --git a/docs/getting-started/build-modules/_category_.json b/docs/getting-started/build-modules/_category_.json new file mode 100644 index 0000000..16f195e --- /dev/null +++ b/docs/getting-started/build-modules/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Build Modules", + "position": 2, + "link": { + "type": "generated-index" + } +} diff --git a/docs/getting-started/build-modules/build-modules.md b/docs/getting-started/build-modules/build-modules.md new file mode 100644 index 0000000..440cb41 --- /dev/null +++ b/docs/getting-started/build-modules/build-modules.md @@ -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} +
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. +
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 +
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) + + + diff --git a/docs/getting-started/build-modules/interoperable-spec.md b/docs/getting-started/build-modules/interoperable-spec.md new file mode 100644 index 0000000..8203783 --- /dev/null +++ b/docs/getting-started/build-modules/interoperable-spec.md @@ -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 +
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) + + + diff --git a/docs/getting-started/build-modules/safe-core-protocol.md b/docs/getting-started/build-modules/safe-core-protocol.md new file mode 100644 index 0000000..0deb180 --- /dev/null +++ b/docs/getting-started/build-modules/safe-core-protocol.md @@ -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. +
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) + + + diff --git a/docs/getting-started/explore-module.md b/docs/getting-started/explore-module.md index 10a4651..ed2379b 100644 --- a/docs/getting-started/explore-module.md +++ b/docs/getting-started/explore-module.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- # Explore Modules diff --git a/docs/getting-started/integrate.md b/docs/getting-started/integrate.md index 2954f27..187e125 100644 --- a/docs/getting-started/integrate.md +++ b/docs/getting-started/integrate.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- # Integrate Modules from ZenGuard diff --git a/docs/getting-started/publish-module.md b/docs/getting-started/publish-module.md index 0bb043c..cf7aa28 100644 --- a/docs/getting-started/publish-module.md +++ b/docs/getting-started/publish-module.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 --- # Publish Modules