From 60df3f23b6061dd9291107c43a099c5312b226a0 Mon Sep 17 00:00:00 2001 From: kopy-kat Date: Thu, 13 Jun 2024 17:16:29 +0100 Subject: [PATCH] feat: add accounts, modules and tools --- package.json | 12 +++--- pages/_meta.json | 2 + pages/accounts.mdx | 43 +++++++++++++++++++++ pages/index.mdx | 77 ++++++++++++++++++++++++++++--------- pages/modules.mdx | 39 +++++++++++++++++++ pages/resources/_meta.json | 3 +- pages/resources/modules.mdx | 14 ------- pages/resources/talks.mdx | 2 + pages/resources/writing.mdx | 6 +++ pages/tooling.mdx | 13 +++++-- pages/tooling/_meta.json | 3 -- pages/tooling/modulekit.mdx | 62 ----------------------------- theme.config.tsx | 1 - 13 files changed, 168 insertions(+), 109 deletions(-) create mode 100644 pages/accounts.mdx create mode 100644 pages/modules.mdx delete mode 100644 pages/resources/modules.mdx delete mode 100644 pages/tooling/_meta.json delete mode 100644 pages/tooling/modulekit.mdx diff --git a/package.json b/package.json index 91a4e32..845417c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "nextra-docs-template", + "name": "erc7579-docs", "version": "0.0.1", - "description": "Nextra docs template", + "description": "ERC-7579 Docs", "scripts": { "dev": "next dev", "build": "next build", @@ -9,14 +9,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/shuding/nextra-docs-template.git" + "url": "git+https://github.com/shuding/erc7579/erc7579.github.io.git" }, - "author": "Shu Ding ", + "author": "ERC-7579", "license": "MIT", "bugs": { - "url": "https://github.com/shuding/nextra-docs-template/issues" + "url": "https://github.com/erc7579/erc7579.github.io/issues" }, - "homepage": "https://github.com/shuding/nextra-docs-template#readme", + "homepage": "https://github.com/erc7579/erc7579.github.io#readme", "dependencies": { "next": "^13.0.6", "nextra": "latest", diff --git a/pages/_meta.json b/pages/_meta.json index 3cc147b..25dd116 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -1,5 +1,7 @@ { "index": "Introduction", + "accounts": "Accounts", + "modules": "Modules", "tooling": "Tooling", "extensions": "Extensions", "resources": "Resources" diff --git a/pages/accounts.mdx b/pages/accounts.mdx new file mode 100644 index 0000000..b9dfb40 --- /dev/null +++ b/pages/accounts.mdx @@ -0,0 +1,43 @@ +# Accounts + +There are many different ERC-7579 compatible accounts and more being built. Different ERC-7579 accounts make different architectural choices, but all comply with the core interfaces of the standard. Here is a list of them: + +## Kernel + +**A gas efficient and feature rich modular smart account** + +GitHub repo: [Kernel](https://github.com/zerodevapp/kernel) + +Built by: [ZeroDev](https://zerodev.app/) + +## Safe7579 + +**An adapter for the battle-tested Safe smart account** + +GitHub repo: [Safe7579](https://github.com/rhinestonewtf/safe7579) + +Built by: [Rhinestone](https://www.rhinestone.wtf/) and [Safe](https://safe.global/) + +## Nexus + +**Coming soon** + +GitHub repo: [Nexus](https://github.com/bcnmy/nexus) + +Built by: [Biconomy](https://biconomy.io/) + +## Prime + +**Coming soon** + +GitHub repo: [Prime](https://github.com/etherspot/etherspot-prime-contracts) + +Built by: [Etherspot](https://etherspot.io/) + +## ERC-7579 Reference implementation + +**A reference implementation of the ERC-7579 standard** + +GitHub repo: [Reference implementation](https://github.com/erc7579/erc7579-implementation) + +Built by: [ERC-7579](https://erc7579.com/) diff --git a/pages/index.mdx b/pages/index.mdx index 38febce..2fc69c7 100644 --- a/pages/index.mdx +++ b/pages/index.mdx @@ -3,7 +3,7 @@ import Image from "next/image"; # Introduction -Welcome to the documentation of ERC-7579. These docs aim to provide a comprehensive overview of the standard, including guides, references and overview of tooling. +Welcome to the documentation of ERC-7579. These docs aim to provide a comprehensive overview of the standard, including guides, references and overview of the ecosystem. ![Hello](/bannerv2.png) @@ -34,12 +34,13 @@ The [reference implementation](https://github.com/erc7579/erc7579-implementation ## Extensions -Standardization will need to continue to happen for smart accounts and modules. This standardization might also happen for a subset of smart accounts or modules, such as, for example, further standardizing security safeguards around module usage. To encompass this, we encourage members of the community to create extensions to this standard, by creating new ERCs that extend the behavior of ERC-7579. For example, an ERC might use the title “[FEATURE] Extension for ERC-7579” to indicate that it is an extension to ERC-7579. +Standardization will need to continue to happen for smart accounts and modules. This standardization might also happen for a subset of smart accounts or modules, such as, for example, further standardizing security safeguards around module usage. To encompass this, we encourage members of the community to create extensions to this standard, by creating new ERCs that extend the behavior of ERC-7579. For example, an ERC might use the title “[FEATURE] Extension for ERC-7579” to indicate that it is an extension to ERC-7579. You can also find a list of extensions under [extensions](/extensions). ## Contributing There are several ways to contribute to the standard: +- Follow our [Twitter](https://x.com/erc7579) to stay up to date with the latest news - Join the [Telegram](https://t.me/+KfB9WuhKDgk5YzIx) to discuss the standard - Give feedback on the ERC on [Ethereum Magicians](https://ethereum-magicians.org/t/erc-7579-minimal-modular-smart-accounts/17336) - Contribute to the [reference implementation](https://github.com/erc7579/erc7579-implementation) through discussions, issues or pull requests @@ -47,32 +48,72 @@ There are several ways to contribute to the standard: ## Supporters - + } - /> - } + icon={ + + } /> + } + /> + } + icon={ + + } /> } - /> + icon={ + + } + /> } - /> + title="Etherspot" + href="https://etherspot.io" + icon={ + + } + /> - - - ```bash copy - npm i @rhinestone/modulekit - ``` - - - - - ```bash copy - yarn add @rhinestone/modulekit - ``` - - - - - ```bash copy - pnpm i @rhinestone/modulekit - ``` - - - - -### Using git submodules - -```bash copy -forge install rhinestonewtf/modulekit -``` - -### Using the template - -Fork the [module-template](https://github.com/rhinestonewtf/module-template) and install it by running: - -```bash copy -git clone https://github.com/[YOUR_GITHUB_HANDLE]/module-template.git -cd module-template -pnpm install -``` - -## Documentation - -You can find the documentation for ModuleKit in the [Rhinestone Docs](https://docs.rhinestone.wtf/modulekit). diff --git a/theme.config.tsx b/theme.config.tsx index 31a2c73..4c3feb3 100644 --- a/theme.config.tsx +++ b/theme.config.tsx @@ -47,7 +47,6 @@ const config: DocsThemeConfig = { ), }, - faviconGlyph: "📝", }; export default config;