-
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.
Merge pull request #2 from zenguardxyz/feature/vocs
Migrated docs to vocs
- Loading branch information
Showing
52 changed files
with
6,073 additions
and
19,279 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 |
---|---|---|
|
@@ -3,6 +3,7 @@ | |
|
||
# Production | ||
/build | ||
dist | ||
|
||
# Generated files | ||
.docusaurus | ||
|
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,41 +1 @@ | ||
# Website | ||
|
||
Documentation to integrate ZenGuard to DApp and Wallets | ||
|
||
### Installation | ||
|
||
``` | ||
$ yarn | ||
``` | ||
|
||
### Local Development | ||
|
||
``` | ||
$ yarn start | ||
``` | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
### Build | ||
|
||
``` | ||
$ yarn build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
### Deployment | ||
|
||
Using SSH: | ||
|
||
``` | ||
$ USE_SSH=true yarn deploy | ||
``` | ||
|
||
Not using SSH: | ||
|
||
``` | ||
$ GIT_USER=<Your GitHub username> yarn deploy | ||
``` | ||
|
||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. | ||
This is a [Vocs](https://vocs.dev) project bootstrapped with the Vocs CLI. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
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,7 +1,3 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Basics | ||
|
||
## What is Account Abstraction? | ||
|
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
5 changes: 0 additions & 5 deletions
5
...ng-started/build-modules/build-modules.md → docs/pages/build/build-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,8 +1,3 @@ | ||
--- | ||
sidebar_position: 1 | ||
|
||
--- | ||
|
||
# Getting Started | ||
|
||
|
||
|
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,41 @@ | ||
--- | ||
sidebar_position: 5 | ||
|
||
--- | ||
|
||
# ERC-6900 | ||
|
||
ERC-6900 is laying the groundwork for a future of permissionless innovation in modular smart accounts. By standardizing account interfaces and plugins, 6900 seeks to make it easier for developers to build secure, interoperable and composable modular smart accounts and plugins. | ||
|
||
### Compatible Smart Accounts | ||
|
||
ERC-6900 compatible smart account implementations | ||
|
||
There are various implementations for ERC-6900 accounts including: | ||
|
||
- [Modular Account](https://www.erc6900.io/compatible-accounts#modular-account) | ||
|
||
- [Upgradable Modular Smart Contract Account](https://www.erc6900.io/compatible-accounts#upgradable-modular-smart-contract-account-factory) | ||
|
||
- [SingleOwner Modular Smart Contract Account](https://www.erc6900.io/compatible-accounts#singleowner-semi-modular-smart-contract-account-factory) | ||
|
||
|
||
### Safe Account Support | ||
|
||
Not yet available | ||
|
||
|
||
|
||
### Getting started: | ||
|
||
- [How to write a plugin](https://notes.zenguard.xyz/How-to-write-an-ERC-6900-Plugin-8ef518630b1a43a1b301723925407ec5?pvs=21) - *Article* | ||
- [How to build a plugin](https://youtu.be/ht9FJYYkF2A) - *Video* | ||
- [Plugin template](https://github.com/erc6900/plugin-template) - *Repo* | ||
|
||
|
||
### Additional Resources | ||
|
||
* [Reference implementation](https://github.com/erc6900/reference-implementation/tree/main) | ||
* [List of Module Templates](https://github.com/zenguardxyz/module-templates) | ||
* [ERC 6900](https://erc6900.io) | ||
|
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,75 @@ | ||
--- | ||
sidebar_position: 4 | ||
|
||
--- | ||
|
||
# ERC-7579 | ||
|
||
ERC-7579 outlines the minimally required interfaces and behavior for modular smart accounts and modules to ensure interoperability across implementations. | ||
|
||
|
||
### Compatible Smart Accounts | ||
|
||
ERC-7579 compatible smart account implementations | ||
|
||
There are various implementations for ERC-6900 accounts including: | ||
|
||
- [ZeroDev Kernel](https://github.com/zerodevapp/kernel) | ||
|
||
|
||
- [Biconomy Smart Account](https://github.com/bcnmy/scw-contracts) | ||
|
||
|
||
### Safe Account Support | ||
|
||
ERC-7579 based modules are natively not supported on Safe smart accounts. They can be easily supported via adapters. | ||
|
||
Safe along with Rhinestone team has developed a [7579 adapter](https://github.com/rhinestonewtf/safe7579) that will make Safe compatible with 7579 based modules. | ||
|
||
### How to make a Safe comaptible with 7579 standard | ||
|
||
- An existing Safe can be 7579 compatible just by adding the [7579 adapter](https://github.com/rhinestonewtf/safe7579) as a Safe Module and Safe Fallback handler. | ||
|
||
### Getting started: | ||
|
||
The best way to get started with the module development is with the help of [module-template](https://github.com/rhinestonewtf/module-template) by Rhinestone. | ||
|
||
Here are a few links to get started with building and testing. | ||
|
||
|
||
- [With Rhinestone Module Kit](https://github.com/rhinestonewtf/modulekit/tree/main) - *Repo* | ||
- [Module template](https://github.com/rhinestonewtf/module-template) - *Repo* | ||
- [How to build a module](https://docs.rhinestone.wtf/modulekit/build/module-basics) - *Docs* | ||
|
||
|
||
Once the module has been independantly developed. It can be tested and enabled on Safe Accounts. | ||
If you are looking to enable the module on the existing Safe, it can be achieved by building a Safe App along with the [7579 adapter](https://github.com/rhinestonewtf/safe7579). | ||
|
||
Here is a [module template](https://github.com/koshikraj/module-template-7579) to get started building module and Safe App that enables and interacts with the module developed. | ||
|
||
## Usage | ||
|
||
1. Clone the repository: | ||
|
||
```bash | ||
git clone https://github.com/koshikraj/module-template-7579.git | ||
``` | ||
|
||
2. Project structure: | ||
|
||
├── module-template-7579 <br/> | ||
│ ├── [Safe App](https://github.com/koshikraj/module-template-7579/tree/main/web)<br/> | ||
│ ├── [Module](https://github.com/koshikraj/module-template-7579/tree/main/module)<br/> | ||
│ └── [Dependency Packages](https://github.com/koshikraj/module-template-7579/tree/main/packages) | ||
|
||
|
||
|
||
### Additional Resources | ||
|
||
* [List of Module Templates](https://github.com/zenguardxyz/module-templates) | ||
* [Reference implementation](https://github.com/erc7579/erc7579-implementation) | ||
* [7579 Module template](https://github.com/koshikraj/module-template-7579) | ||
* [ERC 7579](https://erc7579.com) | ||
|
||
|
||
|
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,26 @@ | ||
# 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. | ||
|
||
## Features: | ||
There are numerous usecases and benefits of building the modules on these standards. | ||
|
||
- The standards are adapted by majority of smart account providers are such as Biconomy, ZeroDev, Alchemy and much more. | ||
- Wider support for tools and testing | ||
- Supports Account Abstraction via ERC-4337 spec- This means, it supports the AA features such as transaction batching, fee sponsorship and much more. | ||
|
||
There are 2 prominent standards to develop the modules. Follow these guides to start buildin modules using them | ||
|
||
- [ERC-7579](./erc-7579.md) | ||
- [ERC-6900](./erc-6900.md) | ||
|
||
### Additional Resources | ||
|
||
* [List of Module Templates](https://github.com/zenguardxyz/module-templates) | ||
* [7579 Module template](https://github.com/koshikraj/module-template-7579) | ||
* [ERC 7579](https://erc7579.com) | ||
|
||
|
||
|
File renamed without changes.
4 changes: 0 additions & 4 deletions
4
docs/getting-started/explore-module.md → docs/pages/explore-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,7 +1,3 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Explore Modules | ||
|
||
Module explorer can be directly used as a Safe App. | ||
|
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,15 @@ | ||
--- | ||
layout: landing | ||
--- | ||
|
||
import { HomePage } from 'vocs/components' | ||
|
||
<HomePage.Root> | ||
<HomePage.Logo /> | ||
<HomePage.Tagline>Documentation to enter into the world of modular smart account</HomePage.Tagline> | ||
<HomePage.Description>ZenGuard Docs is a one stop documentation to build, test, audit and publish modules for Smart Acccounts</HomePage.Description> | ||
<HomePage.Buttons> | ||
<HomePage.Button href="/introduction" variant="accent">Get started</HomePage.Button> | ||
<HomePage.Button href="https://github.com/zenguardxyz">GitHub</HomePage.Button> | ||
</HomePage.Buttons> | ||
</HomePage.Root> |
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,3 @@ | ||
# Integrate module to your app/ wallet | ||
|
||
Stay tuned! |
Oops, something went wrong.