diff --git a/book/babel.config.js b/book/babel.config.js deleted file mode 100644 index e00595da..00000000 --- a/book/babel.config.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = { - presets: [require.resolve('@docusaurus/core/lib/babel/preset')], -}; diff --git a/book/bun.lockb b/book/bun.lockb deleted file mode 100755 index 3652259e..00000000 Binary files a/book/bun.lockb and /dev/null differ diff --git a/book/docusaurus.config.ts b/book/docusaurus.config.ts deleted file mode 100644 index 761ad856..00000000 --- a/book/docusaurus.config.ts +++ /dev/null @@ -1,149 +0,0 @@ -import type * as Preset from "@docusaurus/preset-classic"; -import type { Config } from "@docusaurus/types"; -import { themes as prismThemes } from "prism-react-renderer"; - -const config: Config = { - title: "Meta Contract Documentation", - tagline: "Meta Contract is a smart contract development framework.", - favicon: "img/favicon.ico", - - url: "https://mc-book.ecdysis.xyz", - baseUrl: "/", - - organizationName: "metacontract", - projectName: "mc", - - onBrokenLinks: "warn", - onBrokenMarkdownLinks: "warn", - - i18n: { - defaultLocale: "en", - locales: ["en"], - }, - - presets: [ - [ - "classic", - { - docs: { - path: "../docs", - routeBasePath: "/", - sidebarPath: require.resolve("./sidebars.ts"), - editUrl: "https://github.com/metacontract/mc/tree/main/book", - }, - theme: { - customCss: "./src/css/custom.css", - }, - } satisfies Preset.Options, - ], - ], - - markdown: { - mermaid: true, - format: "detect", - }, - themes: ["@docusaurus/theme-mermaid"], - - themeConfig: { - image: "img/ecdysis-logo.png", - navbar: { - title: "Meta Contract", - logo: { - alt: "Ecdysis Logo", - src: "img/ecdysis-logo.png", - }, - items: [ - { - to: "introduction", - html: "Introduction", - position: "left", - }, - { - to: "tutorials", - html: "Tutorial", - position: "left", - }, - { - to: "devops", - html: "DevOps", - position: "left", - }, - { - to: "plugin-functions", - html: "Plugin Functions", - position: "left", - }, - { - to: "resources", - html: "Resources", - position: "left", - }, - { - href: "https://github.com/metacontract/mc", - label: "GitHub", - position: "right", - }, - ], - }, - footer: { - style: "dark", - links: [ - { - title: "Docs", - items: [ - { - label: "Introduction", - to: "/introduction", - }, - { - label: "Tutorial", - to: "/tutorials", - }, - { - label: "DevOps", - to: "/devops", - }, - { - label: "Plugin Functions", - to: "/plugin-functions", - }, - { - label: "Resources", - to: "/resources", - }, - ], - }, - { - title: "Community", - items: [ - { - label: "Stack Overflow", - href: "https://stackoverflow.com/questions/tagged/metacontract", - }, - { - label: "X", - href: "https://x.com/ecdysis_xyz", - }, - ], - }, - { - title: "More", - items: [ - { - label: "GitHub", - href: "https://github.com/metacontract/mc", - }, - ], - }, - ], - copyright: `Copyright © ${new Date().getFullYear()} Ecdysis, Inc. Built with Docusaurus.`, - }, - prism: { - theme: prismThemes.github, - darkTheme: prismThemes.dracula, - additionalLanguages: ["solidity"], - }, - } satisfies Preset.ThemeConfig, -}; - -export default config; diff --git a/book/sidebars.ts b/book/sidebars.ts deleted file mode 100644 index 4bcf6d60..00000000 --- a/book/sidebars.ts +++ /dev/null @@ -1,7 +0,0 @@ -import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; - -const sidebars: SidebarsConfig = { - sidebar: [{ type: "autogenerated", dirName: "." }], -}; - -export default sidebars; diff --git a/book/src/css/custom.css b/book/src/css/custom.css deleted file mode 100644 index 2bc6a4cf..00000000 --- a/book/src/css/custom.css +++ /dev/null @@ -1,30 +0,0 @@ -/** - * Any CSS included here will be global. The classic template - * bundles Infima by default. Infima is a CSS framework designed to - * work well for content-centric websites. - */ - -/* You can override the default Infima variables here. */ -:root { - --ifm-color-primary: #2e8555; - --ifm-color-primary-dark: #29784c; - --ifm-color-primary-darker: #277148; - --ifm-color-primary-darkest: #205d3b; - --ifm-color-primary-light: #33925d; - --ifm-color-primary-lighter: #359962; - --ifm-color-primary-lightest: #3cad6e; - --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); -} - -/* For readability concerns, you should choose a lighter palette in dark mode. */ -[data-theme='dark'] { - --ifm-color-primary: #25c2a0; - --ifm-color-primary-dark: #21af90; - --ifm-color-primary-darker: #1fa588; - --ifm-color-primary-darkest: #1a8870; - --ifm-color-primary-light: #29d5b0; - --ifm-color-primary-lighter: #32d8b4; - --ifm-color-primary-lightest: #4fddbf; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); -} diff --git a/book/src/pages/index.module.css b/book/src/pages/index.module.css deleted file mode 100644 index b2752308..00000000 --- a/book/src/pages/index.module.css +++ /dev/null @@ -1,35 +0,0 @@ -/** - * CSS files with the .module.css suffix will be treated as CSS modules - * and scoped locally. - */ - -.heroBanner { - padding: 4rem 0; - text-align: center; - position: relative; - overflow: hidden; -} - -@media screen and (max-width: 996px) { - .heroBanner { - padding: 2rem; - } -} - -.buttons { - display: flex; - align-items: center; - justify-content: center; -} - -.features { - display: flex; - align-items: center; - padding: 2rem 0; - width: 100%; -} - -.featureSvg { - height: 200px; - width: 200px; -} diff --git a/book/src/pages/index.tsx b/book/src/pages/index.tsx deleted file mode 100644 index 9d31fb4f..00000000 --- a/book/src/pages/index.tsx +++ /dev/null @@ -1,108 +0,0 @@ -import Link from "@docusaurus/Link"; -import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; -import Heading from "@theme/Heading"; -import Layout from "@theme/Layout"; -import clsx from "clsx"; - -import styles from "./index.module.css"; - -export default function Home(): JSX.Element { - const { siteConfig } = useDocusaurusContext(); - return ( - -
-
- -
- - ); -} - -function Header() { - const { siteConfig } = useDocusaurusContext(); - return ( -
-
- - {siteConfig.title} - -

{siteConfig.tagline}

-
- - Introduction - -
-
-
- ); -} - -const Features = (): JSX.Element => { - return ( -
-
-
- {FeatureList.map((feature) => ( - - ))} -
-
-
- ); -}; - -const Feature = ({ title, to, Svg, description }: FeatureItem) => { - return ( -
- -
- -
-
- {title} -

{description}

-
- -
- ); -}; - -type FeatureItem = { - title: string; - to: string; - Svg: React.ComponentType>; - description: JSX.Element; -}; - -const FeatureList: FeatureItem[] = [ - { - title: "Tutorials", - to: "/tutorials", - Svg: require("@site/static/img/undraw_docusaurus_mountain.svg").default, - description: <>, - }, - { - title: "DevOps", - to: "/devops", - Svg: require("@site/static/img/undraw_docusaurus_tree.svg").default, - description: <>, - }, - { - title: "Plugin Functions", - to: "/plugin-functions", - Svg: require("@site/static/img/undraw_docusaurus_react.svg").default, - description: <>, - }, - { - title: "Resources", - to: "/resources", - Svg: require("@site/static/img/undraw_docusaurus_react.svg").default, - description: <>, - }, -]; diff --git a/book/static/img/docusaurus.png b/book/static/img/docusaurus.png deleted file mode 100644 index f458149e..00000000 Binary files a/book/static/img/docusaurus.png and /dev/null differ diff --git a/book/static/img/undraw_docusaurus_mountain.svg b/book/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index af961c49..00000000 --- a/book/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,171 +0,0 @@ - - Easy to Use - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/book/static/img/undraw_docusaurus_react.svg b/book/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index 94b5cf08..00000000 --- a/book/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,170 +0,0 @@ - - Powered by React - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/book/static/img/undraw_docusaurus_tree.svg b/book/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index d9161d33..00000000 --- a/book/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1,40 +0,0 @@ - - Focus on What Matters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/01-introduction/03-getting-started/index.md b/docs/01-introduction/03-getting-started/index.md deleted file mode 100644 index f4c38a73..00000000 --- a/docs/01-introduction/03-getting-started/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Getting Started - -In smart contract development, dealing with domains that involve complex logic or making contracts upgradeable for operational flexibility often presents significant challenges. The Upgradeable Clone Standard (UCS) is designed as a framework to address these issues, facilitating the development of complex smart contracts for DeFi protocols, DAOs, and other applications. - -UCS introduces the concept of ***Operations (Ops)***, which allows for the separation of concerns within contracts. This modular approach not only enables developers to focus more on specific domains but also facilitates collaboration among multiple developers. By breaking down complex contracts into more manageable components, UCS streamlines the development process, making it more efficient and conducive to teamwork. - -:::caution -Please note that as it is still in the development version, there may be potentially breaking changes made without notice. Use it with caution. -::: diff --git a/docs/01-introduction/index.md b/docs/01-introduction/index.md deleted file mode 100644 index 1fd0eb34..00000000 --- a/docs/01-introduction/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Introduction" -version: 0.1.0 -lastUpdated: 2024-09-06 -author: Meta Contract Development Team -scope: project -type: overview -tags: [meta-contract, introduction, overview, getting-started] -relatedDocs: [01-what-is-meta-contract.md, 02-key-concepts.md, 03-getting-started/index.md] -changeLog: - - version: 0.1.0 - date: 2024-09-06 - description: Initial version of the Meta Contract introduction overview ---- - -# Introduction - -This section provides an overview of the Meta Contract project and its fundamental concepts. Here you'll find: - -- [What is Meta Contract?](01-what-is-meta-contract.md): An introduction to the Meta Contract project and its goals. -- [Key Concepts](02-key-concepts.md): Essential concepts and terminology used throughout the Meta Contract ecosystem. -- [Getting Started](03-getting-started/index.md): A guide to help you set up and start using Meta Contract. - - [Installation](03-getting-started/01-installation.md) - - [Basic Setup](03-getting-started/02-basic-setup.md) - -If you're new to Meta Contract, we recommend starting with "What is Meta Contract?" and then proceeding through the documents in the order listed above. - -:::caution -Please note that as it is still in the development version, there may be potentially breaking changes made without notice. Use it with caution. -::: diff --git a/docs/02-tutorials/01-simple-dao.md b/docs/02-tutorials/01-simple-dao.md deleted file mode 100644 index 09552ad8..00000000 --- a/docs/02-tutorials/01-simple-dao.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Simple DAO Tutorial" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: tutorial -type: guide -tags: [DAO, tutorial, Solidity] -relatedDocs: ["01-simple-dao.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the Simple DAO tutorial -changeLogLink: /CHANGELOG.md ---- - -# Simple DAO Tutorial - -This guide walks you through the process of creating a simple decentralized autonomous organization (DAO) using Solidity. - -- [GitHub Repository](https://github.com/ecdysisxyz/simple-dao) - -## Overview - -The Simple DAO tutorial demonstrates: - -1. DAO structure in Solidity -2. Voting mechanism implementation -3. Handling proposals and votes diff --git a/docs/02-tutorials/02-simple-dex.md b/docs/02-tutorials/02-simple-dex.md deleted file mode 100644 index 2cad1479..00000000 --- a/docs/02-tutorials/02-simple-dex.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Simple DEX Tutorial" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: tutorial -type: guide -tags: [DEX, Solidity, tutorial] -relatedDocs: ["02-simple-dex.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the Simple DEX tutorial -changeLogLink: /CHANGELOG.md ---- - -# Simple DEX Tutorial - -This guide explains how to build a simple decentralized exchange (DEX) using Solidity. - -- [GitHub Repository](https://github.com/ecdysisxyz/forkathon-dex) - -## Overview - -The Simple DEX tutorial covers: - -1. Liquidity pool management -2. Token swapping mechanism -3. Smart contract interactions with ERC20 tokens diff --git a/docs/02-tutorials/03-stable-credit.md b/docs/02-tutorials/03-stable-credit.md deleted file mode 100644 index 0744c670..00000000 --- a/docs/02-tutorials/03-stable-credit.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Stable Credit Tutorial" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: tutorial -type: guide -tags: [StableCoin, Solidity, tutorial] -relatedDocs: ["03-stable-credit.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the Stable Credit tutorial -changeLogLink: /CHANGELOG.md ---- - -# Stable Credit Tutorial - -This guide walks you through building a stablecoin system using Solidity. - -- [GitHub Repository](https://github.com/ecdysisxyz/StableCredit) - -## Overview - -The Stable Credit tutorial includes: - -1. Stablecoin issuance and redemption -2. Pegging mechanisms -3. Credit scoring and stability mechanisms diff --git a/docs/02-tutorials/04-erc-implementations/01-erc20.md b/docs/02-tutorials/04-erc-implementations/01-erc20.md deleted file mode 100644 index 0f52ad8b..00000000 --- a/docs/02-tutorials/04-erc-implementations/01-erc20.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ERC20 Tutorial" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: tutorial -type: guide -tags: [ERC20, Solidity, tutorial] -relatedDocs: ["04-erc-implementations/01-erc20.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the ERC20 tutorial -changeLogLink: /CHANGELOG.md ---- - -# ERC20 Tutorial - -This guide explains how to implement an ERC20 token using Meta Contract. - -- [GitHub Repository](https://github.com/ecdysisxyz/ERC20) - -## Overview - -The ERC20 tutorial covers: - -1. Token creation -2. Transfer and approval mechanics -3. ERC20 interface implementation diff --git a/docs/02-tutorials/04-erc-implementations/02-erc721.md b/docs/02-tutorials/04-erc-implementations/02-erc721.md deleted file mode 100644 index 913837fd..00000000 --- a/docs/02-tutorials/04-erc-implementations/02-erc721.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ERC721 Tutorial" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: tutorial -type: guide -tags: [ERC721, Solidity, tutorial] -relatedDocs: ["04-erc-implementations/02-erc721.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the ERC721 tutorial -changeLogLink: /CHANGELOG.md ---- - -# ERC721 Tutorial - -This guide explains how to implement an ERC721 token using Meta Contract. - -- [GitHub Repository](https://github.com/ecdysisxyz/ERC721) - -## Overview - -The ERC721 tutorial includes: - -1. NFT creation -2. Token metadata and ownership -3. ERC721 interface implementation diff --git a/docs/02-tutorials/04-erc-implementations/03-erc1155.md b/docs/02-tutorials/04-erc-implementations/03-erc1155.md deleted file mode 100644 index b357e89f..00000000 --- a/docs/02-tutorials/04-erc-implementations/03-erc1155.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ERC1155 Tutorial" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: tutorial -type: guide -tags: [ERC1155, Solidity, tutorial] -relatedDocs: ["04-erc-implementations/03-erc1155.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the ERC1155 tutorial -changeLogLink: /CHANGELOG.md ---- - -# ERC1155 Tutorial - -This guide explains how to implement an ERC1155 multi-token standard using Meta Contract. - -- [GitHub Repository](https://github.com/ecdysisxyz/ERC1155) - -## Overview - -The ERC1155 tutorial covers: - -1. Multi-token management -2. Batch transfers -3. ERC1155 interface implementation diff --git a/docs/02-tutorials/04-erc-implementations/04-erc4337.md b/docs/02-tutorials/04-erc-implementations/04-erc4337.md deleted file mode 100644 index 3f31af84..00000000 --- a/docs/02-tutorials/04-erc-implementations/04-erc4337.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ERC4337 Tutorial" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: tutorial -type: guide -tags: [ERC4337, Solidity, tutorial] -relatedDocs: ["04-erc-implementations/04-erc4337.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the ERC4337 tutorial -changeLogLink: /CHANGELOG.md ---- - -# ERC4337 Tutorial - -This guide explains how to implement ERC4337, focused on account abstraction. - -- [GitHub Repository](https://github.com/ecdysisxyz/ERC4337) - -## Overview - -The ERC4337 tutorial covers: - -1. Account abstraction mechanics -2. User operations -3. ERC4337 interface implementation diff --git a/docs/02-tutorials/04-erc-implementations/index.md b/docs/02-tutorials/04-erc-implementations/index.md deleted file mode 100644 index 125c43f5..00000000 --- a/docs/02-tutorials/04-erc-implementations/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "ERC Implementations" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: erc-implementations -type: overview -tags: [ERC standards, Solidity, guide] -relatedDocs: ["02-tutorials/04-erc-implementations/01-erc20.md", "02-tutorials/04-erc-implementations/02-erc721.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the ERC implementations section -changeLogLink: /CHANGELOG.md ---- - -# ERC Implementations - -This section provides tutorials for implementing various ERC standards, such as ERC20, ERC721, ERC1155, and ERC4337. - -## Contents - -- [ERC20 Implementation](01-erc20.md) -- [ERC721 Implementation](02-erc721.md) -- [ERC1155 Implementation](03-erc1155.md) -- [ERC4337 Implementation](04-erc4337.md) - -Each tutorial walks through the complete implementation of the respective ERC standard, from code structure to deployment. diff --git a/docs/02-tutorials/index.md b/docs/02-tutorials/index.md deleted file mode 100644 index 54159c90..00000000 --- a/docs/02-tutorials/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Tutorials" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: tutorials -type: overview -tags: [tutorials, guide, Solidity] -relatedDocs: ["02-tutorials/01-simple-dao.md", "02-tutorials/02-simple-dex.md", "02-tutorials/04-erc-implementations/index.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the tutorials section -changeLogLink: /CHANGELOG.md ---- - -# Tutorials - -This section contains tutorials that guide you through various implementations of smart contracts and decentralized applications using the Meta Contract framework. - -## Contents - -- [Simple DAO](01-simple-dao.md) -- [Simple DEX](02-simple-dex.md) -- [Stable Credit](03-stable-credit.md) -- [ERC Implementations](04-erc-implementations/index.md) - - [ERC20 Implementation](./04-erc-implementations/01-erc20.md) - - [ERC721 Implementation](./04-erc-implementations/02-erc721.md) - - [ERC1155 Implementation](./04-erc-implementations/03-erc1155.md) - - [ERC4337 Implementation](./04-erc-implementations/04-erc4337.md) - -Learn how to build decentralized systems with detailed, step-by-step tutorials that cover everything from basic to advanced use cases. diff --git a/docs/03-devops/index.md b/docs/03-devops/index.md deleted file mode 100644 index f44f186c..00000000 --- a/docs/03-devops/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "DevOps" -version: 0.1.0 -lastUpdated: 2024-09-09 -author: Meta Contract DevOps Team -scope: devops -type: overview -tags: [devops, TDD, implementation, deployment, upgrades, ci-cd, foundry] -relatedDocs: ["01-test-driven-development-and-implementation.md", "02-deployment.md", "03-upgrades.md", "04-ci-cd.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-09 - description: Initial version of the DevOps overview ---- - -# DevOps - -This section covers the essential DevOps processes and tools for developing, testing, deploying, and maintaining Meta Contract projects. Our DevOps practices are crucial for ensuring the reliability, security, and efficiency of smart contract development and operations. - -## Contents - -1. [Test-Driven Development and Implementation](01-tdd.md) - - AI-enhanced Test-Driven Development (TDD) methodology - - Setting up the Foundry testing environment - - Writing and running Foundry tests - - Implementing features based on tests - - Best practices for Meta Contract development - -2. [Deployment](02-deployment.md) - - Strategies for deploying Meta Contract projects - - Network considerations (testnet, mainnet) - - Gas optimization techniques - - Post-deployment verification - -3. [Upgrades](03-upgrades.md) - - Understanding Meta Contract's upgrade mechanisms - - Planning and implementing safe contract upgrades - - Testing upgraded contracts - - Managing contract versions - -4. [CI/CD](04-ci-cd.md) - - Setting up Continuous Integration for Meta Contract - - Automating test runs with Foundry - - Implementing Continuous Deployment pipelines - - Security checks and audits in the CI/CD process - -## Key Aspects of Meta Contract DevOps - -1. **Test-Driven Development**: We prioritize writing tests before implementing features, ensuring robust and well-tested contracts. - -2. **Foundry-Based Testing**: We use Foundry for writing and running tests, which provides a fast and efficient testing environment for Solidity smart contracts. - -3. **AI-Enhanced Development**: Our process incorporates AI assistance in various stages of development, from initial specification to code review. - -4. **Gas Optimization**: We prioritize gas efficiency in our development and deployment processes. - -5. **Security-First Approach**: Security considerations are integrated throughout the development lifecycle. - -6. **Automated Workflows**: We leverage CI/CD pipelines to automate testing, deployment, and upgrade processes. - -By following the guidelines in this section, you'll be able to implement a solid DevOps workflow for your Meta Contract projects, ensuring higher quality, security, and maintainability. diff --git a/docs/04-plugin-functions/05-std/functions/internal/index.md b/docs/04-plugin-functions/05-std/functions/internal/index.md deleted file mode 100644 index 3455e97e..00000000 --- a/docs/04-plugin-functions/05-std/functions/internal/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Internal - - -- [ProxyCreator.sol](./ProxyCreator.sol/index.md) - diff --git a/docs/04-plugin-functions/05-std/functions/protected/FeatureToggle.sol/contract.FeatureToggle.md b/docs/04-plugin-functions/05-std/functions/protected/FeatureToggle.sol/contract.FeatureToggle.md deleted file mode 100644 index 76d7a31b..00000000 --- a/docs/04-plugin-functions/05-std/functions/protected/FeatureToggle.sol/contract.FeatureToggle.md +++ /dev/null @@ -1,19 +0,0 @@ -# FeatureToggle -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/protected/FeatureToggle.sol) - -**Inherits:** -[ProtectionBase](/plugin-functions/std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase) - -< MC Standard Function > - - -## Functions -### featureToggle - -DO NOT USE STORAGE DIRECTLY !!! - - -```solidity -function featureToggle(bytes4 selector) external onlyAdmin; -``` - diff --git a/docs/04-plugin-functions/05-std/functions/protected/InitSetAdmin.sol/contract.InitSetAdmin.md b/docs/04-plugin-functions/05-std/functions/protected/InitSetAdmin.sol/contract.InitSetAdmin.md deleted file mode 100644 index 7ebd087b..00000000 --- a/docs/04-plugin-functions/05-std/functions/protected/InitSetAdmin.sol/contract.InitSetAdmin.md +++ /dev/null @@ -1,26 +0,0 @@ -# InitSetAdmin -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/protected/InitSetAdmin.sol) - -**Inherits:** -[ProtectionBase](/plugin-functions/std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase) - -< MC Standard Function > - - -## Functions -### initSetAdmin - - -```solidity -function initSetAdmin(address admin) external initializer; -``` - -## Events -### AdminSet -DO NOT USE STORAGE DIRECTLY !!! - - -```solidity -event AdminSet(address admin); -``` - diff --git a/docs/04-plugin-functions/05-std/functions/protected/UpgradeDictionary.sol/contract.UpgradeDictionary.md b/docs/04-plugin-functions/05-std/functions/protected/UpgradeDictionary.sol/contract.UpgradeDictionary.md deleted file mode 100644 index db696886..00000000 --- a/docs/04-plugin-functions/05-std/functions/protected/UpgradeDictionary.sol/contract.UpgradeDictionary.md +++ /dev/null @@ -1,19 +0,0 @@ -# UpgradeDictionary -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/protected/UpgradeDictionary.sol) - -**Inherits:** -[ProtectionBase](/plugin-functions/std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase) - -< MC Standard Function > - - -## Functions -### upgradeDictionary - -DO NOT USE STORAGE DIRECTLY !!! - - -```solidity -function upgradeDictionary(address newDictionary) external onlyAdmin; -``` - diff --git a/docs/04-plugin-functions/05-std/functions/protected/index.md b/docs/04-plugin-functions/05-std/functions/protected/index.md deleted file mode 100644 index e38c257a..00000000 --- a/docs/04-plugin-functions/05-std/functions/protected/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Protected Functions - - -- [FeatureToggle.sol](./FeatureToggle.sol/index.md) -- [InitSetAdmin.sol](./InitSetAdmin.sol/index.md) -- [UpgradeDictionary.sol](./UpgradeDictionary.sol/index.md) -- [protection](./protection/index.md) - diff --git a/docs/04-plugin-functions/05-std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase.md b/docs/04-plugin-functions/05-std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase.md deleted file mode 100644 index 69dc45fc..00000000 --- a/docs/04-plugin-functions/05-std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase.md +++ /dev/null @@ -1,19 +0,0 @@ -# ProtectionBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/protected/protection/ProtectionBase.sol) - - -## Functions -### initializer - - -```solidity -modifier initializer(); -``` - -### onlyAdmin - - -```solidity -modifier onlyAdmin(); -``` - diff --git a/docs/04-plugin-functions/05-std/functions/protected/protection/index.md b/docs/04-plugin-functions/05-std/functions/protected/protection/index.md deleted file mode 100644 index cfb4dedd..00000000 --- a/docs/04-plugin-functions/05-std/functions/protected/protection/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Protection - - -- [FeatureToggle.sol](./FeatureToggle.sol/index.md) -- [Initialization.sol](./Initialization.sol/index.md) -- [MsgSender.sol](./MsgSender.sol/index.md) -- [ProtectionBase.sol](./ProtectionBase.sol/index.md) - diff --git a/docs/04-plugin-functions/index.md b/docs/04-plugin-functions/index.md deleted file mode 100644 index 01e700cb..00000000 --- a/docs/04-plugin-functions/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Plugin Functions - -comming soon diff --git a/docs/05-resources/01-general/01-ethereum.md b/docs/05-resources/01-general/01-ethereum.md deleted file mode 100644 index 5bdf590a..00000000 --- a/docs/05-resources/01-general/01-ethereum.md +++ /dev/null @@ -1,8 +0,0 @@ -# Ethereum - -- Ethereum Developer Guide https://ethereum.org/en/developers/docs/ - -- EVM - - Basics https://docs.huff.sh/tutorial/evm-basics/ - - Illustrated https://takenobu-hs.github.io/downloads/ethereum_evm_illustrated.pdf - - Opcodes https://www.evm.codes/ diff --git a/docs/05-resources/01-general/02-foundry.md b/docs/05-resources/01-general/02-foundry.md deleted file mode 100644 index b10a84f6..00000000 --- a/docs/05-resources/01-general/02-foundry.md +++ /dev/null @@ -1,2 +0,0 @@ -# Foundry -https://book.getfoundry.sh/ diff --git a/docs/05-resources/01-general/03-solidity.md b/docs/05-resources/01-general/03-solidity.md deleted file mode 100644 index 6a5cf692..00000000 --- a/docs/05-resources/01-general/03-solidity.md +++ /dev/null @@ -1,2 +0,0 @@ -# Solidity -https://docs.soliditylang.org/en/latest/ diff --git a/docs/05-resources/01-general/index.md b/docs/05-resources/01-general/index.md deleted file mode 100644 index 33f44045..00000000 --- a/docs/05-resources/01-general/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "General Smart Contract Development Concepts" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: general -type: index -tags: [smart contract development, ethereum, foundry, solidity] ---- - -# General Smart Contract Development Concepts - -This section covers fundamental concepts and tools related to samrt contract development, with a focus on those relevant to the Meta Contract project. - -## Contents - -- [Ethereum](./01-ethereum.md) -- [Foundry](./02-foundry.md) -- [Solidity](./03-solidity.md) - -These resources provide a solid foundation for understanding the blockchain ecosystem in which Meta Contract operates. diff --git a/docs/05-resources/02-meta-contract-architecture/01-erc7546.md b/docs/05-resources/02-meta-contract-architecture/01-erc7546.md deleted file mode 100644 index 7a3d8682..00000000 --- a/docs/05-resources/02-meta-contract-architecture/01-erc7546.md +++ /dev/null @@ -1,3 +0,0 @@ -# ERC-7546: Upgradeable Clone for Scalable Contracts - -https://eips.ethereum.org/EIPS/eip-7546 diff --git a/docs/05-resources/02-meta-contract-architecture/02-overview.md b/docs/05-resources/02-meta-contract-architecture/02-overview.md deleted file mode 100644 index 07dd0c5c..00000000 --- a/docs/05-resources/02-meta-contract-architecture/02-overview.md +++ /dev/null @@ -1 +0,0 @@ -# Overview diff --git a/docs/05-resources/02-meta-contract-architecture/03-schema-based-storage.md b/docs/05-resources/02-meta-contract-architecture/03-schema-based-storage.md deleted file mode 100644 index fa6b2388..00000000 --- a/docs/05-resources/02-meta-contract-architecture/03-schema-based-storage.md +++ /dev/null @@ -1 +0,0 @@ -# Schema-based Storage Management diff --git a/docs/05-resources/02-meta-contract-architecture/04-interfaces.md b/docs/05-resources/02-meta-contract-architecture/04-interfaces.md deleted file mode 100644 index 89ce18fb..00000000 --- a/docs/05-resources/02-meta-contract-architecture/04-interfaces.md +++ /dev/null @@ -1 +0,0 @@ -# Interfaces diff --git a/docs/05-resources/02-meta-contract-architecture/index.md b/docs/05-resources/02-meta-contract-architecture/index.md deleted file mode 100644 index fe21537c..00000000 --- a/docs/05-resources/02-meta-contract-architecture/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Meta Contract Architecture" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: architecture -type: index -tags: [architecture, erc7546, schema-based-storage, interfaces] ---- - -# Meta Contract Architecture - -This section details the architectural design of the Meta Contract project, including its core concepts and implementation details. - -## Contents - -- [Overview](./01-overview.md) -- [ERC7546](./02-erc7546.md) -- [Schema-based Storage](./03-schema-based-storage.md) -- [Interfaces](./04-interfaces.md) - -Understanding these architectural components is crucial for developers working on or integrating with the Meta Contract system. diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCScript.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCScript.md deleted file mode 100644 index 8c758785..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCScript.md +++ /dev/null @@ -1,15 +0,0 @@ -# MCScript -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[MCScriptBase](/resources/devkit/api-reference/Flattened.sol/abstract.MCScriptBase) - - -## Functions -### _saveAddrToEnv - - -```solidity -function _saveAddrToEnv(address addr, string memory envKeyBase) internal; -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCScriptBase.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCScriptBase.md deleted file mode 100644 index 02f57f0c..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCScriptBase.md +++ /dev/null @@ -1,15 +0,0 @@ -# MCScriptBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[MCBase](/resources/devkit/api-reference/Flattened.sol/abstract.MCBase), [Script](/resources/devkit/api-reference/Flattened.sol/abstract.Script) - - -## Functions -### startBroadcastWith - - -```solidity -modifier startBroadcastWith(string memory envKey); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCTestBase.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCTestBase.md deleted file mode 100644 index 39c6221c..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCTestBase.md +++ /dev/null @@ -1,15 +0,0 @@ -# MCTestBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[MCBase](/resources/devkit/api-reference/Flattened.sol/abstract.MCBase), [Test](/resources/devkit/api-reference/Flattened.sol/abstract.Test) - - -## Functions -### startPrankWith - - -```solidity -modifier startPrankWith(string memory envKey); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Script.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Script.md deleted file mode 100644 index f5b46a7d..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Script.md +++ /dev/null @@ -1,15 +0,0 @@ -# Script -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[ScriptBase](/resources/devkit/api-reference/Flattened.sol/abstract.ScriptBase), [StdChains](/resources/devkit/api-reference/Flattened.sol/abstract.StdChains), [StdCheatsSafe](/resources/devkit/api-reference/Flattened.sol/abstract.StdCheatsSafe), [StdUtils](/resources/devkit/api-reference/Flattened.sol/abstract.StdUtils) - - -## State Variables -### IS_SCRIPT - -```solidity -bool public IS_SCRIPT = true; -``` - - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.ScriptBase.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.ScriptBase.md deleted file mode 100644 index 8f397dae..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.ScriptBase.md +++ /dev/null @@ -1,15 +0,0 @@ -# ScriptBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[CommonBase](/resources/devkit/api-reference/Flattened.sol/abstract.CommonBase) - - -## State Variables -### vmSafe - -```solidity -VmSafe internal constant vmSafe = VmSafe(VM_ADDRESS); -``` - - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Test.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Test.md deleted file mode 100644 index 11c7b8a1..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Test.md +++ /dev/null @@ -1,15 +0,0 @@ -# Test -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[TestBase](/resources/devkit/api-reference/Flattened.sol/abstract.TestBase), [StdAssertions](/resources/devkit/api-reference/Flattened.sol/abstract.StdAssertions), [StdChains](/resources/devkit/api-reference/Flattened.sol/abstract.StdChains), [StdCheats](/resources/devkit/api-reference/Flattened.sol/abstract.StdCheats), [StdInvariant](/resources/devkit/api-reference/Flattened.sol/abstract.StdInvariant), [StdUtils](/resources/devkit/api-reference/Flattened.sol/abstract.StdUtils) - - -## State Variables -### IS_TEST - -```solidity -bool public IS_TEST = true; -``` - - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.TestBase.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.TestBase.md deleted file mode 100644 index 0aade26d..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.TestBase.md +++ /dev/null @@ -1,7 +0,0 @@ -# TestBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[CommonBase](/resources/devkit/api-reference/Flattened.sol/abstract.CommonBase) - - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Dictionary_0.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Dictionary_0.md deleted file mode 100644 index 80981625..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Dictionary_0.md +++ /dev/null @@ -1,29 +0,0 @@ -# Dictionary_0 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[DictionaryBase](/resources/devkit/api-reference/Flattened.sol/abstract.DictionaryBase), [Ownable](/resources/devkit/api-reference/Flattened.sol/abstract.Ownable), [IDictionary](/resources/devkit/api-reference/Flattened.sol/interface.IDictionary) - - -## Functions -### constructor - - -```solidity -constructor(address owner) Ownable(owner); -``` - -### setImplementation - - -```solidity -function setImplementation(bytes4 selector, address implementation) external onlyOwner; -``` - -### upgradeFacade - - -```solidity -function upgradeFacade(address newFacade) external onlyOwner; -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.DummyContract.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.DummyContract.md deleted file mode 100644 index d51e890b..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.DummyContract.md +++ /dev/null @@ -1,4 +0,0 @@ -# DummyContract -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.DummyFacade.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.DummyFacade.md deleted file mode 100644 index 0f23c58c..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.DummyFacade.md +++ /dev/null @@ -1,4 +0,0 @@ -# DummyFacade -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.FeatureToggle.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.FeatureToggle.md deleted file mode 100644 index 40ff8f3c..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.FeatureToggle.md +++ /dev/null @@ -1,19 +0,0 @@ -# FeatureToggle -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[ProtectionBase](/plugin-functions/std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase) - -< MC Standard Function > - - -## Functions -### featureToggle - -DO NOT USE STORAGE DIRECTLY !!! - - -```solidity -function featureToggle(bytes4 selector) external onlyAdmin; -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.MockDictionary.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.MockDictionary.md deleted file mode 100644 index ba15d830..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.MockDictionary.md +++ /dev/null @@ -1,15 +0,0 @@ -# MockDictionary -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[Dictionary_0](/resources/devkit/api-reference/Flattened.sol/contract.Dictionary_0) - - -## Functions -### constructor - - -```solidity -constructor(address owner, Function[] memory functions) Dictionary_0(owner); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.UpgradeDictionary.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.UpgradeDictionary.md deleted file mode 100644 index f5824c66..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.UpgradeDictionary.md +++ /dev/null @@ -1,19 +0,0 @@ -# UpgradeDictionary -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -**Inherits:** -[ProtectionBase](/plugin-functions/std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase) - -< MC Standard Function > - - -## Functions -### upgradeDictionary - -DO NOT USE STORAGE DIRECTLY !!! - - -```solidity -function upgradeDictionary(address newDictionary) external onlyAdmin; -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/enum.TypeStatus.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/enum.TypeStatus.md deleted file mode 100644 index de118c63..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/enum.TypeStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# TypeStatus -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -enum TypeStatus { - Uninitialized, - Building, - Built, - Locked -} -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.loadAddressFrom.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.loadAddressFrom.md deleted file mode 100644 index 0ead58a2..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.loadAddressFrom.md +++ /dev/null @@ -1,8 +0,0 @@ -# loadAddressFrom -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function loadAddressFrom(string memory envKey) view returns (address); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_0.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_0.md deleted file mode 100644 index 321b15e1..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_0.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_0 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_0(address addr) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_1.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_1.md deleted file mode 100644 index d6938e70..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_1.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_1 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_1(address addr, bytes memory b) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_10.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_10.md deleted file mode 100644 index 4963dd8d..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_10.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_10 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_10(string memory str, bytes memory b) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_11.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_11.md deleted file mode 100644 index 0bd54af8..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_11.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_11 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_11(Dictionary_1 memory dict) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_12.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_12.md deleted file mode 100644 index c4003c8d..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_12.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_12 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_12(bytes4 b4) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_14.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_14.md deleted file mode 100644 index e0e55585..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_14.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_14 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_14(string memory str, Dictionary_1 memory dictionary) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_15.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_15.md deleted file mode 100644 index d63f042f..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_15.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_15 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_15(address addr, string memory str) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_16.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_16.md deleted file mode 100644 index a07cd417..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_16.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_16 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_16(Dictionary_1 memory dict, address addr) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_17.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_17.md deleted file mode 100644 index 583a2167..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_17.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_17 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_17(Dictionary_1 memory dict, bytes4 b4, address addr) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_18.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_18.md deleted file mode 100644 index c350512f..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_18.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_18 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_18(Function[] memory functions) pure returns (string memory res); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_19.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_19.md deleted file mode 100644 index a38b259a..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_19.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_19 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_19(Bundle memory bundle, address addr, bytes memory b) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_2.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_2.md deleted file mode 100644 index 826bc6fe..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_2.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_2 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_2(Dictionary_1 memory dict, bytes memory b) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_20.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_20.md deleted file mode 100644 index 14fc0839..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_20.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_20 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_20(string memory str, bytes4 b4, address addr) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_21.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_21.md deleted file mode 100644 index e7a76ad0..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_21.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_21 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_21(string memory str, Proxy_2 memory proxy) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_22.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_22.md deleted file mode 100644 index 5fd3e59b..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_22.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_22 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_22(string memory str, Function[] memory funcs) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_23.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_23.md deleted file mode 100644 index 6e807c1c..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_23.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_23 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_23(string memory str, address addr, Function[] memory funcs) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_24.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_24.md deleted file mode 100644 index 550d53ff..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_24.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_24 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_24(bytes4 b4, address addr) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_25.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_25.md deleted file mode 100644 index 1e23ba31..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_25.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_25 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_25(Bundle memory bundle) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_26.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_26.md deleted file mode 100644 index adad6a97..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_26.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_26 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_26(Bundle memory bundle, bytes memory b) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_27.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_27.md deleted file mode 100644 index cdc4997b..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_27.md +++ /dev/null @@ -1,10 +0,0 @@ -# param_27 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - -Params - - -```solidity -function param_27(string memory str) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_3.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_3.md deleted file mode 100644 index b4ab82c5..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_3.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_3 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_3(Dictionary_1 memory dict1, Dictionary_1 memory dict2) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_4.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_4.md deleted file mode 100644 index edfa970c..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_4.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_4 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_4(bytes memory b) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_5.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_5.md deleted file mode 100644 index 92d18d0f..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_5.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_5 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_5(address addr, address addr2) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_6.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_6.md deleted file mode 100644 index 7aa44fca..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_6.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_6 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_6(Function memory func) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_7.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_7.md deleted file mode 100644 index 5602b272..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_7.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_7 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_7(Bundle memory bundle, address addr) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_8.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_8.md deleted file mode 100644 index 50d89e82..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_8.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_8 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_8(Function[] memory functions, address facade) pure returns (string memory res); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_9.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_9.md deleted file mode 100644 index 35d18388..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_9.md +++ /dev/null @@ -1,8 +0,0 @@ -# param_9 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -function param_9(string memory str, address addr) pure returns (string memory); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Current.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Current.md deleted file mode 100644 index 2beb6dc6..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Current.md +++ /dev/null @@ -1,14 +0,0 @@ -# Current -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - ---------------------- -Support Methods ------------------------ - - -```solidity -struct Current { - string name; -} -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.FindData.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.FindData.md deleted file mode 100644 index 7476ba9b..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.FindData.md +++ /dev/null @@ -1,13 +0,0 @@ -# FindData -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -struct FindData { - uint256 slot; - uint256 offsetLeft; - uint256 offsetRight; - bool found; -} -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.SetupConfig.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.SetupConfig.md deleted file mode 100644 index f7d5c2a6..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.SetupConfig.md +++ /dev/null @@ -1,10 +0,0 @@ -# SetupConfig -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -struct SetupConfig { - bool STD_FUNCS; -} -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.SystemConfig.md b/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.SystemConfig.md deleted file mode 100644 index 7d708623..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.SystemConfig.md +++ /dev/null @@ -1,11 +0,0 @@ -# SystemConfig -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) - - -```solidity -struct SystemConfig { - Logger.Level LOG_LEVEL; - uint256 SCAN_RANGE; -} -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/abstract.MCScriptBase.md b/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/abstract.MCScriptBase.md deleted file mode 100644 index 6d528093..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/abstract.MCScriptBase.md +++ /dev/null @@ -1,15 +0,0 @@ -# MCScriptBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/MCBase.sol) - -**Inherits:** -[MCBase](/resources/devkit/api-reference/Flattened.sol/abstract.MCBase), ForgeScript - - -## Functions -### startBroadcastWith - - -```solidity -modifier startBroadcastWith(string memory envKey); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/abstract.MCTestBase.md b/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/abstract.MCTestBase.md deleted file mode 100644 index bb343c80..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/abstract.MCTestBase.md +++ /dev/null @@ -1,15 +0,0 @@ -# MCTestBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/MCBase.sol) - -**Inherits:** -[MCBase](/resources/devkit/api-reference/Flattened.sol/abstract.MCBase), ForgeTest - - -## Functions -### startPrankWith - - -```solidity -modifier startPrankWith(string memory envKey); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/MCScript.sol/abstract.MCScript.md b/docs/05-resources/03-devkit/03-api-reference/MCScript.sol/abstract.MCScript.md deleted file mode 100644 index 49a79c6b..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/MCScript.sol/abstract.MCScript.md +++ /dev/null @@ -1,15 +0,0 @@ -# MCScript -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/MCScript.sol) - -**Inherits:** -[MCScriptBase](/resources/devkit/api-reference/Flattened.sol/abstract.MCScriptBase) - - -## Functions -### _saveAddrToEnv - - -```solidity -function _saveAddrToEnv(address addr, string memory envKeyBase) internal; -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/context/Current.sol/struct.Current.md b/docs/05-resources/03-devkit/03-api-reference/registry/context/Current.sol/struct.Current.md deleted file mode 100644 index d8ca85c7..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/registry/context/Current.sol/struct.Current.md +++ /dev/null @@ -1,14 +0,0 @@ -# Current -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/context/Current.sol) - ---------------------- -Support Methods ------------------------ - - -```solidity -struct Current { - string name; -} -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/context/index.md b/docs/05-resources/03-devkit/03-api-reference/registry/context/index.md deleted file mode 100644 index aaa7ef74..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/registry/context/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Context - - -- [Current.sol](./Current.sol/index.md) - diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.SetupConfig.md b/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.SetupConfig.md deleted file mode 100644 index 92e02a85..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.SetupConfig.md +++ /dev/null @@ -1,10 +0,0 @@ -# SetupConfig -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Config.sol) - - -```solidity -struct SetupConfig { - bool STD_FUNCS; -} -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.SystemConfig.md b/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.SystemConfig.md deleted file mode 100644 index dadc9368..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.SystemConfig.md +++ /dev/null @@ -1,11 +0,0 @@ -# SystemConfig -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Config.sol) - - -```solidity -struct SystemConfig { - Logger.Level LOG_LEVEL; - uint256 SCAN_RANGE; -} -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/system/message/index.md b/docs/05-resources/03-devkit/03-api-reference/system/message/index.md deleted file mode 100644 index 24981e6a..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/system/message/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# Message - - -- [DecodeErrorString.sol](./DecodeErrorString.sol/index.md) -- [MessageBody.sol](./MessageBody.sol/index.md) -- [MessageHead.sol](./MessageHead.sol/index.md) - diff --git a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyContract.sol/contract.DummyContract.md b/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyContract.sol/contract.DummyContract.md deleted file mode 100644 index ad85593d..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyContract.sol/contract.DummyContract.md +++ /dev/null @@ -1,4 +0,0 @@ -# DummyContract -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/test/dummy/DummyContract.sol) - - diff --git a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFacade.sol/contract.DummyFacade.md b/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFacade.sol/contract.DummyFacade.md deleted file mode 100644 index 9c7167ba..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFacade.sol/contract.DummyFacade.md +++ /dev/null @@ -1,4 +0,0 @@ -# DummyFacade -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/test/dummy/DummyFacade.sol) - - diff --git a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFunction.sol/contract.DummyFunction.md b/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFunction.sol/contract.DummyFunction.md deleted file mode 100644 index 421d073e..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFunction.sol/contract.DummyFunction.md +++ /dev/null @@ -1,19 +0,0 @@ -# DummyFunction -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/test/dummy/DummyFunction.sol) - - -## Functions -### dummy - - -```solidity -function dummy() external; -``` - -### dummy2 - - -```solidity -function dummy2() external; -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/test/dummy/index.md b/docs/05-resources/03-devkit/03-api-reference/test/dummy/index.md deleted file mode 100644 index 62d4f649..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/test/dummy/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Dummy - - -- [Dummy.sol](./Dummy.sol/index.md) -- [DummyContract.sol](./DummyContract.sol/index.md) -- [DummyFacade.sol](./DummyFacade.sol/index.md) -- [DummyFunction.sol](./DummyFunction.sol/index.md) - diff --git a/docs/05-resources/03-devkit/03-api-reference/test/mocks/index.md b/docs/05-resources/03-devkit/03-api-reference/test/mocks/index.md deleted file mode 100644 index 01371906..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/test/mocks/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# Mocks - - -- [MockDictionary.sol](./MockDictionary.sol/index.md) -- [SimpleMockProxy.sol](./SimpleMockProxy.sol/index.md) - diff --git a/docs/05-resources/03-devkit/03-api-reference/types/TypeGuard.sol/enum.TypeStatus.md b/docs/05-resources/03-devkit/03-api-reference/types/TypeGuard.sol/enum.TypeStatus.md deleted file mode 100644 index f264ea2e..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/types/TypeGuard.sol/enum.TypeStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# TypeStatus -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/types/TypeGuard.sol) - - -```solidity -enum TypeStatus { - Uninitialized, - Building, - Built, - Locked -} -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/function.loadAddressFrom.md b/docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/function.loadAddressFrom.md deleted file mode 100644 index 9b46a474..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/function.loadAddressFrom.md +++ /dev/null @@ -1,8 +0,0 @@ -# loadAddressFrom -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/utils/ForgeHelper.sol) - - -```solidity -function loadAddressFrom(string memory envKey) view returns (address); -``` - diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/index.md b/docs/05-resources/03-devkit/03-api-reference/utils/global/index.md deleted file mode 100644 index 7bd07c44..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Global - - -- [MCDeployLib.sol](./MCDeployLib.sol/index.md) -- [MCFinderLib.sol](./MCFinderLib.sol/index.md) -- [MCHelpers.sol](./MCHelpers.sol/index.md) -- [MCInitLib.sol](./MCInitLib.sol/index.md) -- [MCMockLib.sol](./MCMockLib.sol/index.md) - diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/mapping/index.md b/docs/05-resources/03-devkit/03-api-reference/utils/mapping/index.md deleted file mode 100644 index f8332369..00000000 --- a/docs/05-resources/03-devkit/03-api-reference/utils/mapping/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# mapping - - -- [NameGenerator.sol](./NameGenerator.sol/index.md) - diff --git a/docs/05-resources/03-devkit/index.md b/docs/05-resources/03-devkit/index.md deleted file mode 100644 index 2790372b..00000000 --- a/docs/05-resources/03-devkit/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Meta Contract DevKit" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: development -type: index -tags: [devkit, api, usage, best-practices] ---- - -# Meta Contract DevKit - -The DevKit is a comprehensive set of tools and libraries designed to facilitate development within the Meta Contract ecosystem. - -## Contents - -- [Overview](./01-overview.md) -- [Usage](./02-usage.md) -- [API Reference](./03-api-reference/index.md) - -This section provides all the necessary information to get started with and effectively use the Meta Contract DevKit. diff --git a/docs/05-resources/04-project-management/01-documentation-guidelines.md b/docs/05-resources/04-project-management/01-documentation-guidelines.md deleted file mode 100644 index e0a83aac..00000000 --- a/docs/05-resources/04-project-management/01-documentation-guidelines.md +++ /dev/null @@ -1,590 +0,0 @@ ---- -title: "Documentation Guidelines" -version: 0.1.0 -lastUpdated: 2024-09-06 -author: Meta Contract Development Team -scope: project -type: guide -tags: [documentation, guidelines, best-practices] -relatedDocs: [project-structure.md, glossary.md] -changeLog: - - version: 0.1.0 - date: 2024-09-06 - description: Initial version of the documentation guidelines -changeLogLink: /CHANGELOG.md ---- - -# Documentation Guidelines - -This guide outlines the standards and best practices for creating and maintaining documentation in the Meta Contract project. - -## General Principles - -1. Write clear, concise, and accurate documentation. -2. Keep documentation up-to-date with code changes. -3. Use a consistent style and format across all documentation. -4. Write for your audience, considering their technical background. - -## Documentation Structure - -The documentation should follow this structure: - -``` -docs/ -├── 01-introduction -│ ├── 01-what-is-meta-contract.md -│ ├── 02-key-concepts.md -│ ├── 03-getting-started -│ │ ├── 01-installation.md -│ │ ├── 02-basic-setup.md -│ │ └── index.md -│ └── index.md -├── 02-tutorials -│ ├── 01-simple-dao.md -│ ├── 02-simple-dex.md -│ ├── 03-stable-credit.md -│ ├── 04-erc-implementations -│ │ ├── 01-erc20.md -│ │ ├── 02-erc721.md -│ │ ├── 03-erc1155.md -│ │ ├── 04-erc4337.md -│ │ └── index.md -│ └── index.md -├── 03-devops -│ ├── 01-tdd.md -│ ├── 02-deployment.md -│ ├── 03-upgrades.md -│ ├── 04-ci-cd.md -│ └── index.md -├── 04-plugin-functions -│ ├── 01-common -│ │ ├── 01-access-control -│ │ │ └── index.md -│ │ └── index.md -│ ├── 02-deliberation -│ │ └── index.md -│ ├── 03-token -│ │ └── index.md -│ ├── 04-defi -│ │ └── index.md -│ ├── 05-std -│ │ ├── functions -│ │ │ ├── Clone.sol -│ │ │ │ ├── contract.Clone.md -│ │ │ │ └── index.md -│ │ │ ├── Create.sol -│ │ │ │ ├── contract.Create.md -│ │ │ │ └── index.md -│ │ │ ├── GetFunctions.sol -│ │ │ │ ├── contract.GetFunctions.md -│ │ │ │ └── index.md -│ │ │ ├── Receive.sol -│ │ │ │ ├── contract.Receive.md -│ │ │ │ └── index.md -│ │ │ ├── index.md -│ │ │ ├── internal -│ │ │ │ ├── ProxyCreator.sol -│ │ │ │ │ ├── index.md -│ │ │ │ │ └── library.ProxyCreator.md -│ │ │ │ └── index.md -│ │ │ └── protected -│ │ │ ├── FeatureToggle.sol -│ │ │ │ ├── contract.FeatureToggle.md -│ │ │ │ └── index.md -│ │ │ ├── InitSetAdmin.sol -│ │ │ │ ├── contract.InitSetAdmin.md -│ │ │ │ └── index.md -│ │ │ ├── UpgradeDictionary.sol -│ │ │ │ ├── contract.UpgradeDictionary.md -│ │ │ │ └── index.md -│ │ │ ├── index.md -│ │ │ └── protection -│ │ │ ├── FeatureToggle.sol -│ │ │ │ ├── index.md -│ │ │ │ └── library.FeatureToggle.md -│ │ │ ├── Initialization.sol -│ │ │ │ ├── index.md -│ │ │ │ └── library.Initialization.md -│ │ │ ├── MsgSender.sol -│ │ │ │ ├── index.md -│ │ │ │ └── library.MsgSender.md -│ │ │ ├── ProtectionBase.sol -│ │ │ │ ├── abstract.ProtectionBase.md -│ │ │ │ └── index.md -│ │ │ └── index.md -│ │ ├── index.md -│ │ ├── interfaces -│ │ │ ├── IStd.sol -│ │ │ │ ├── index.md -│ │ │ │ └── interface.IStd.md -│ │ │ ├── StdFacade.sol -│ │ │ │ ├── contract.StdFacade.md -│ │ │ │ └── index.md -│ │ │ └── index.md -│ │ └── storage -│ │ ├── Schema.sol -│ │ │ ├── index.md -│ │ │ └── interface.Schema.md -│ │ ├── Storage.sol -│ │ │ ├── index.md -│ │ │ └── library.Storage.md -│ │ └── index.md -│ └── index.md -└── 05-resources - ├── 01-general - │ ├── 01-ethereum.md - │ ├── 02-foundry.md - │ ├── 03-solidity.md - │ └── index.md - ├── 02-meta-contract-architecture - │ ├── 01-erc7546.md - │ ├── 02-overview.md - │ ├── 03-schema-based-storage.md - │ ├── 04-interfaces.md - │ └── index.md - ├── 03-devkit - │ ├── 01-overview.md - │ ├── 02-usage.md - │ ├── 03-api-reference - │ │ ├── Flattened.sol - │ │ │ ├── abstract.CommonBase.md - │ │ │ ├── abstract.Context.md - │ │ │ ├── abstract.DictionaryBase.md - │ │ │ ├── abstract.MCBase.md - │ │ │ ├── abstract.MCScript.md - │ │ │ ├── abstract.MCScriptBase.md - │ │ │ ├── abstract.MCTest.md - │ │ │ ├── abstract.MCTestBase.md - │ │ │ ├── abstract.Ownable.md - │ │ │ ├── abstract.ProtectionBase.md - │ │ │ ├── abstract.Proxy_0.md - │ │ │ ├── abstract.Script.md - │ │ │ ├── abstract.ScriptBase.md - │ │ │ ├── abstract.StdAssertions.md - │ │ │ ├── abstract.StdChains.md - │ │ │ ├── abstract.StdCheats.md - │ │ │ ├── abstract.StdCheatsSafe.md - │ │ │ ├── abstract.StdInvariant.md - │ │ │ ├── abstract.StdUtils.md - │ │ │ ├── abstract.Test.md - │ │ │ ├── abstract.TestBase.md - │ │ │ ├── constants.Flattened.md - │ │ │ ├── contract.BeaconDictionary.md - │ │ │ ├── contract.Clone.md - │ │ │ ├── contract.Dictionary_0.md - │ │ │ ├── contract.DummyContract.md - │ │ │ ├── contract.DummyFacade.md - │ │ │ ├── contract.DummyFunction.md - │ │ │ ├── contract.FeatureToggle.md - │ │ │ ├── contract.GetFunctions.md - │ │ │ ├── contract.ImmutableDictionary.md - │ │ │ ├── contract.InitSetAdmin.md - │ │ │ ├── contract.MockDictionary.md - │ │ │ ├── contract.MockERC20.md - │ │ │ ├── contract.MockERC721.md - │ │ │ ├── contract.Proxy_1.md - │ │ │ ├── contract.Receive.md - │ │ │ ├── contract.SimpleMockProxy.md - │ │ │ ├── contract.StdFacade.md - │ │ │ ├── contract.UpgradeDictionary.md - │ │ │ ├── contract.UpgradeableBeacon.md - │ │ │ ├── enum.DictionaryKind.md - │ │ │ ├── enum.ProxyKind.md - │ │ │ ├── enum.TypeStatus.md - │ │ │ ├── function.loadAddressFrom.md - │ │ │ ├── function.param_0.md - │ │ │ ├── function.param_1.md - │ │ │ ├── function.param_10.md - │ │ │ ├── function.param_11.md - │ │ │ ├── function.param_12.md - │ │ │ ├── function.param_13.md - │ │ │ ├── function.param_14.md - │ │ │ ├── function.param_15.md - │ │ │ ├── function.param_16.md - │ │ │ ├── function.param_17.md - │ │ │ ├── function.param_18.md - │ │ │ ├── function.param_19.md - │ │ │ ├── function.param_2.md - │ │ │ ├── function.param_20.md - │ │ │ ├── function.param_21.md - │ │ │ ├── function.param_22.md - │ │ │ ├── function.param_23.md - │ │ │ ├── function.param_24.md - │ │ │ ├── function.param_25.md - │ │ │ ├── function.param_26.md - │ │ │ ├── function.param_27.md - │ │ │ ├── function.param_3.md - │ │ │ ├── function.param_4.md - │ │ │ ├── function.param_5.md - │ │ │ ├── function.param_6.md - │ │ │ ├── function.param_7.md - │ │ │ ├── function.param_8.md - │ │ │ ├── function.param_9.md - │ │ │ ├── index.md - │ │ │ ├── interface.IBeacon.md - │ │ │ ├── interface.IDictionary.md - │ │ │ ├── interface.IDictionaryCore.md - │ │ │ ├── interface.IERC165_0.md - │ │ │ ├── interface.IERC165_1.md - │ │ │ ├── interface.IERC20.md - │ │ │ ├── interface.IERC721.md - │ │ │ ├── interface.IERC721Enumerable.md - │ │ │ ├── interface.IERC721Metadata.md - │ │ │ ├── interface.IERC721TokenReceiver.md - │ │ │ ├── interface.IMulticall3.md - │ │ │ ├── interface.IProxy.md - │ │ │ ├── interface.IStd.md - │ │ │ ├── interface.IVerifiable.md - │ │ │ ├── interface.Schema.md - │ │ │ ├── interface.Vm.md - │ │ │ ├── interface.VmSafe.md - │ │ │ ├── library.Address.md - │ │ │ ├── library.BundleLib.md - │ │ │ ├── library.BundleRegistryLib.md - │ │ │ ├── library.ConfigLib.md - │ │ │ ├── library.CurrentLib.md - │ │ │ ├── library.DictionaryLib.md - │ │ │ ├── library.DictionaryRegistryLib.md - │ │ │ ├── library.Dummy.md - │ │ │ ├── library.ERC1967Utils.md - │ │ │ ├── library.ForgeHelper.md - │ │ │ ├── library.Formatter.md - │ │ │ ├── library.FunctionLib.md - │ │ │ ├── library.FunctionRegistryLib.md - │ │ │ ├── library.Initialization.md - │ │ │ ├── library.Inspector.md - │ │ │ ├── library.Logger.md - │ │ │ ├── library.MCDeployLib.md - │ │ │ ├── library.MCFinderLib.md - │ │ │ ├── library.MCHelpers.md - │ │ │ ├── library.MCInitLib.md - │ │ │ ├── library.MCMockLib.md - │ │ │ ├── library.MessageBody.md - │ │ │ ├── library.MessageHead.md - │ │ │ ├── library.MsgSender.md - │ │ │ ├── library.NameGenerator.md - │ │ │ ├── library.Parser.md - │ │ │ ├── library.ProxyCreator.md - │ │ │ ├── library.ProxyLib.md - │ │ │ ├── library.ProxyRegistryLib.md - │ │ │ ├── library.ProxyUtils.md - │ │ │ ├── library.SimpleMockProxyLib.md - │ │ │ ├── library.StdFunctionsArgs.md - │ │ │ ├── library.StdFunctionsLib.md - │ │ │ ├── library.StdRegistryLib.md - │ │ │ ├── library.StdStyle.md - │ │ │ ├── library.Storage.md - │ │ │ ├── library.StorageSlot.md - │ │ │ ├── library.System.md - │ │ │ ├── library.Tracer.md - │ │ │ ├── library.TypeGuard.md - │ │ │ ├── library.Validator.md - │ │ │ ├── library.console.md - │ │ │ ├── library.safeconsole.md - │ │ │ ├── library.stdError.md - │ │ │ ├── library.stdJson.md - │ │ │ ├── library.stdMath.md - │ │ │ ├── library.stdStorage.md - │ │ │ ├── library.stdStorageSafe.md - │ │ │ ├── library.stdToml.md - │ │ │ ├── struct.Bundle.md - │ │ │ ├── struct.BundleRegistry.md - │ │ │ ├── struct.ConfigState.md - │ │ │ ├── struct.Current.md - │ │ │ ├── struct.DictionaryRegistry.md - │ │ │ ├── struct.Dictionary_1.md - │ │ │ ├── struct.FindData.md - │ │ │ ├── struct.Function.md - │ │ │ ├── struct.FunctionRegistry.md - │ │ │ ├── struct.MCDevKit.md - │ │ │ ├── struct.NamingConfig.md - │ │ │ ├── struct.Process.md - │ │ │ ├── struct.ProxyRegistry.md - │ │ │ ├── struct.Proxy_2.md - │ │ │ ├── struct.SetupConfig.md - │ │ │ ├── struct.StdFunctions.md - │ │ │ ├── struct.StdRegistry.md - │ │ │ ├── struct.StdStorage.md - │ │ │ ├── struct.SystemConfig.md - │ │ │ └── struct.Trace.md - │ │ ├── MCBase.sol - │ │ │ ├── abstract.MCBase.md - │ │ │ ├── abstract.MCScriptBase.md - │ │ │ ├── abstract.MCTestBase.md - │ │ │ └── index.md - │ │ ├── MCDevKit.sol - │ │ │ ├── index.md - │ │ │ └── struct.MCDevKit.md - │ │ ├── MCScript.sol - │ │ │ ├── abstract.MCScript.md - │ │ │ └── index.md - │ │ ├── MCTest.sol - │ │ │ ├── abstract.MCTest.md - │ │ │ └── index.md - │ │ ├── core - │ │ │ ├── Bundle.sol - │ │ │ │ ├── index.md - │ │ │ │ ├── library.BundleLib.md - │ │ │ │ └── struct.Bundle.md - │ │ │ ├── Dictionary.sol - │ │ │ │ ├── enum.DictionaryKind.md - │ │ │ │ ├── index.md - │ │ │ │ ├── library.DictionaryLib.md - │ │ │ │ └── struct.Dictionary.md - │ │ │ ├── Function.sol - │ │ │ │ ├── index.md - │ │ │ │ ├── library.FunctionLib.md - │ │ │ │ └── struct.Function.md - │ │ │ ├── Proxy.sol - │ │ │ │ ├── enum.ProxyKind.md - │ │ │ │ ├── index.md - │ │ │ │ ├── library.ProxyLib.md - │ │ │ │ └── struct.Proxy.md - │ │ │ └── index.md - │ │ ├── index.md - │ │ ├── registry - │ │ │ ├── BundleRegistry.sol - │ │ │ │ ├── index.md - │ │ │ │ ├── library.BundleRegistryLib.md - │ │ │ │ └── struct.BundleRegistry.md - │ │ │ ├── DictionaryRegistry.sol - │ │ │ │ ├── index.md - │ │ │ │ ├── library.DictionaryRegistryLib.md - │ │ │ │ └── struct.DictionaryRegistry.md - │ │ │ ├── FunctionRegistry.sol - │ │ │ │ ├── index.md - │ │ │ │ ├── library.FunctionRegistryLib.md - │ │ │ │ └── struct.FunctionRegistry.md - │ │ │ ├── ProxyRegistry.sol - │ │ │ │ ├── index.md - │ │ │ │ ├── library.ProxyRegistryLib.md - │ │ │ │ └── struct.ProxyRegistry.md - │ │ │ ├── StdFunctions.sol - │ │ │ │ ├── index.md - │ │ │ │ ├── library.StdFunctionsLib.md - │ │ │ │ └── struct.StdFunctions.md - │ │ │ ├── StdRegistry.sol - │ │ │ │ ├── index.md - │ │ │ │ ├── library.StdFunctionsArgs.md - │ │ │ │ ├── library.StdRegistryLib.md - │ │ │ │ └── struct.StdRegistry.md - │ │ │ ├── context - │ │ │ │ ├── Current.sol - │ │ │ │ │ ├── index.md - │ │ │ │ │ ├── library.CurrentLib.md - │ │ │ │ │ └── struct.Current.md - │ │ │ │ └── index.md - │ │ │ └── index.md - │ │ ├── system - │ │ │ ├── Config.sol - │ │ │ │ ├── index.md - │ │ │ │ ├── library.ConfigLib.md - │ │ │ │ ├── struct.ConfigState.md - │ │ │ │ ├── struct.NamingConfig.md - │ │ │ │ ├── struct.SetupConfig.md - │ │ │ │ └── struct.SystemConfig.md - │ │ │ ├── Logger.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.Logger.md - │ │ │ ├── System.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.System.md - │ │ │ ├── Tracer.sol - │ │ │ │ ├── function.param.md - │ │ │ │ ├── index.md - │ │ │ │ ├── library.Tracer.md - │ │ │ │ ├── struct.Process.md - │ │ │ │ └── struct.Trace.md - │ │ │ ├── Validator.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.Validator.md - │ │ │ ├── index.md - │ │ │ └── message - │ │ │ ├── DecodeErrorString.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.DecodeErrorString.md - │ │ │ ├── MessageBody.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.MessageBody.md - │ │ │ ├── MessageHead.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.MessageHead.md - │ │ │ └── index.md - │ │ ├── test - │ │ │ ├── dummy - │ │ │ │ ├── Dummy.sol - │ │ │ │ │ ├── index.md - │ │ │ │ │ └── library.Dummy.md - │ │ │ │ ├── DummyContract.sol - │ │ │ │ │ ├── contract.DummyContract.md - │ │ │ │ │ └── index.md - │ │ │ │ ├── DummyFacade.sol - │ │ │ │ │ ├── contract.DummyFacade.md - │ │ │ │ │ └── index.md - │ │ │ │ ├── DummyFunction.sol - │ │ │ │ │ ├── contract.DummyFunction.md - │ │ │ │ │ └── index.md - │ │ │ │ └── index.md - │ │ │ ├── index.md - │ │ │ └── mocks - │ │ │ ├── MockDictionary.sol - │ │ │ │ ├── contract.MockDictionary.md - │ │ │ │ └── index.md - │ │ │ ├── SimpleMockProxy.sol - │ │ │ │ ├── contract.SimpleMockProxy.md - │ │ │ │ ├── index.md - │ │ │ │ └── library.SimpleMockProxyLib.md - │ │ │ └── index.md - │ │ ├── types - │ │ │ ├── Formatter.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.Formatter.md - │ │ │ ├── Inspector.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.Inspector.md - │ │ │ ├── Parser.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.Parser.md - │ │ │ ├── TypeGuard.sol - │ │ │ │ ├── enum.TypeStatus.md - │ │ │ │ ├── index.md - │ │ │ │ └── library.TypeGuard.md - │ │ │ └── index.md - │ │ └── utils - │ │ ├── ForgeHelper.sol - │ │ │ ├── constants.ForgeHelper.md - │ │ │ ├── function.loadAddressFrom.md - │ │ │ ├── index.md - │ │ │ └── library.ForgeHelper.md - │ │ ├── global - │ │ │ ├── MCDeployLib.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.MCDeployLib.md - │ │ │ ├── MCFinderLib.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.MCFinderLib.md - │ │ │ ├── MCHelpers.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.MCHelpers.md - │ │ │ ├── MCInitLib.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.MCInitLib.md - │ │ │ ├── MCMockLib.sol - │ │ │ │ ├── index.md - │ │ │ │ └── library.MCMockLib.md - │ │ │ └── index.md - │ │ ├── index.md - │ │ └── mapping - │ │ ├── NameGenerator.sol - │ │ │ ├── index.md - │ │ │ └── library.NameGenerator.md - │ │ └── index.md - │ └── index.md - ├── 04-project-management - │ ├── 01-documentation-guidelines.md - │ ├── 02-glossary.md - │ ├── 03-versioning.md - │ ├── 04-changelog.md - │ └── index.md - ├── 05-integration - │ ├── 01-the-graph.md - │ ├── 02-etherscan.md - │ └── index.md - ├── 06-best-practices - │ ├── 01-ai-tdd.md - │ ├── 02-using-internal-library.md - │ └── index.md - └── index.md -``` - -Each `index.md` file should contain: -1. A brief description of the contents of that directory -2. Links to the files and subdirectories within it -3. Any additional context or information relevant to that section of the documentation - -## File Naming Convention - -Use kebab-case for all documentation file names: - -``` -what-is-meta-contract.md -key-concepts.md -``` - -## Markdown Formatting - -1. Use ATX-style headers (`#` for h1, `##` for h2, etc.). -2. Use backticks for inline code and triple backticks for code blocks. -3. Use appropriate language identifiers for code blocks (e.g., ```solidity). -4. Use unordered lists (`-`) for most lists, and ordered lists (`1.`) when sequence matters. - -## Documentation Header - -Each documentation file should start with a metadata block followed by the document content: - -```markdown ---- -title: "Full Document Title" -version: 0.1.0 -lastUpdated: YYYY-MM-DD -author: [Author Names] -scope: [Scope of the document, e.g., dev, arch] -type: [Type of document, e.g., spec, guide] -tags: [tag1, tag2, tag3] -relatedDocs: ["RELATED_DOC_1.md", "RELATED_DOC_2.md"] -changeLog: - - version: 0.1.0 - date: YYYY-MM-DD - description: [Description of initial version] ---- - -# Document Title - -Brief description or introduction to the document content. - -[Main document content starts here] -``` - -## Code Documentation - -### Solidity - -Use NatSpec comments for all public and external functions: - -```solidity -/** - * @notice Calculates the sum of two numbers - * @param a The first number - * @param b The second number - * @return The sum of a and b - */ -function calculateSum(uint256 a, uint256 b) public pure returns (uint256) { - return a + b; -} -``` - -## Diagrams - -Use Mermaid for creating diagrams in documentation. Include the diagram source in the Markdown file: - -```mermaid -graph TD - A[Proxy Contract] --> B{Dictionary Contract} - B --> C[Function Contract 1] - B --> D[Function Contract 2] - B --> E[Function Contract 3] -``` - -## Versioning Documentation - -1. Start all document versions at 0.1.0. -2. Increment the version number when making significant updates to a document. -3. Clearly indicate which version of the software each document applies to. - -## Review Process - -1. All documentation changes should go through peer review. -2. Check for technical accuracy, clarity, and adherence to these guidelines. -3. Ensure all links are working and point to the correct destinations. - -By following these guidelines, we ensure consistency and quality across all Meta Contract documentation, making it easier for developers and users to understand and use our project. diff --git a/docs/05-resources/04-project-management/02-glossary.md b/docs/05-resources/04-project-management/02-glossary.md deleted file mode 100644 index ca3c8276..00000000 --- a/docs/05-resources/04-project-management/02-glossary.md +++ /dev/null @@ -1 +0,0 @@ -# Glossary diff --git a/docs/05-resources/04-project-management/03-versioning.md b/docs/05-resources/04-project-management/03-versioning.md deleted file mode 100644 index 1ca61baa..00000000 --- a/docs/05-resources/04-project-management/03-versioning.md +++ /dev/null @@ -1 +0,0 @@ -# Versioning diff --git a/docs/05-resources/04-project-management/04-changelog.md b/docs/05-resources/04-project-management/04-changelog.md deleted file mode 100644 index 825c32f0..00000000 --- a/docs/05-resources/04-project-management/04-changelog.md +++ /dev/null @@ -1 +0,0 @@ -# Changelog diff --git a/docs/05-resources/04-project-management/index.md b/docs/05-resources/04-project-management/index.md deleted file mode 100644 index 2cce7524..00000000 --- a/docs/05-resources/04-project-management/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Project Management" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: management -type: index -tags: [documentation, versioning, changelog] ---- - -# Project Management - -This section covers guidelines and best practices for managing the Meta Contract project, including documentation standards and version control. - -## Contents - -- [Documentation Guidelines](./01-documentation-guidelines.md) -- [Glossary](./02-glossary.md) -- [Versioning](./03-versioning.md) -- [Changelog](./04-changelog.md) - -These resources ensure consistency and quality across the project's development and documentation processes. diff --git a/docs/05-resources/05-integration/01-the-graph.md b/docs/05-resources/05-integration/01-the-graph.md deleted file mode 100644 index b69738b6..00000000 --- a/docs/05-resources/05-integration/01-the-graph.md +++ /dev/null @@ -1 +0,0 @@ -# TheGraph diff --git a/docs/05-resources/05-integration/02-etherscan.md b/docs/05-resources/05-integration/02-etherscan.md deleted file mode 100644 index 13553eb0..00000000 --- a/docs/05-resources/05-integration/02-etherscan.md +++ /dev/null @@ -1 +0,0 @@ -# Etherscan diff --git a/docs/05-resources/05-integration/index.md b/docs/05-resources/05-integration/index.md deleted file mode 100644 index dd1de116..00000000 --- a/docs/05-resources/05-integration/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Integration" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: integration -type: index -tags: [integration, the-graph, etherscan] ---- - -# Integration - -This section provides guidance on integrating Meta Contract with various blockchain tools and services. - -## Contents - -- [The Graph](./01-the-graph.md) -- [Etherscan](./02-etherscan.md) - -These guides will help developers leverage external tools and services to enhance the functionality and visibility of their Meta Contract implementations. diff --git a/docs/05-resources/06-best-practices/01-ai-tdd.md b/docs/05-resources/06-best-practices/01-ai-tdd.md deleted file mode 100644 index b3ac28f5..00000000 --- a/docs/05-resources/06-best-practices/01-ai-tdd.md +++ /dev/null @@ -1 +0,0 @@ -# AI TDD diff --git a/docs/05-resources/06-best-practices/02-using-internal-library.md b/docs/05-resources/06-best-practices/02-using-internal-library.md deleted file mode 100644 index 9a7291ce..00000000 --- a/docs/05-resources/06-best-practices/02-using-internal-library.md +++ /dev/null @@ -1 +0,0 @@ -# Using Internal Library diff --git a/docs/05-resources/06-best-practices/index.md b/docs/05-resources/06-best-practices/index.md deleted file mode 100644 index 63e859b3..00000000 --- a/docs/05-resources/06-best-practices/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Best Practices" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: development -type: index -tags: [best-practices, ai-tdd, internal-library] ---- - -# Best Practices - -This section covers recommended practices and methodologies for developing with Meta Contract. These best practices are designed to improve code quality, efficiency, and maintainability. - -## Contents - -- [AI-Driven Test-Driven Development (AI-TDD)](./01-ai-tdd.md) -- [Using Internal Libraries](./02-using-internal-library.md) - -## Overview - -Adopting best practices is crucial for building robust, efficient, and maintainable smart contracts. This section provides guidance on advanced development techniques and approaches that can significantly enhance your Meta Contract development process. - -### AI-Driven Test-Driven Development (AI-TDD) - -AI-TDD is an innovative approach that combines the principles of Test-Driven Development with AI-assisted coding. This methodology can help developers write more comprehensive tests and catch potential issues earlier in the development cycle. - -### Using Internal Libraries - -Effective use of internal libraries can greatly improve code reusability and maintainability. This guide provides best practices for creating, organizing, and utilizing internal libraries within your Meta Contract projects. - -By following these best practices, developers can create more robust, efficient, and maintainable Meta Contract implementations. We encourage all contributors to familiarize themselves with these guidelines and apply them in their development process. diff --git a/docs/05-resources/index.md b/docs/05-resources/index.md deleted file mode 100644 index 15ee5cbb..00000000 --- a/docs/05-resources/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Resources" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: project -type: index -tags: [resources, documentation] ---- - -# Resources - -This section contains various resources and references for the Meta Contract project. Here you'll find information on general smart contract development concepts, Meta Contract architecture, DevKit usage, project management guidelines, and integration details. - -## Contents - -- [General Smart Contract Development Concepts](./01-general/index.md) -- [Meta Contract Architecture](./02-meta-contract-architecture/index.md) -- [DevKit](./03-devkit/index.md) -- [Project Management](./04-project-management/index.md) -- [Integration](./05-integration/index.md) - -These resources are designed to provide comprehensive information for developers, architects, and project managers working with the Meta Contract ecosystem. diff --git a/package.json b/package.json index f6fa1a13..df55a194 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,12 @@ { "name": "mc", - "workspaces": ["book/*"], + "workspaces": ["site/*"], "scripts": { - "book:install": "cd book && bun install", - "book:start": "cd book && npm run start", - "book:build": "cd book && npm run build", - "book:clear": "cd book && npm run clear", - "book:soldocs": "sh ./shell-script/generate_soldocs.sh" + "site:install": "cd site && bun install", + "site:start": "cd site && npm run start", + "site:build": "cd site && npm run build", + "site:serve": "cd site && npm run serve", + "site:clear": "cd site && npm run clear", + "site:soldocs": "cd site && npm run soldocs" } } diff --git a/shell-script/generate_soldocs.sh b/shell-script/generate_soldocs.sh deleted file mode 100644 index 17feaaf8..00000000 --- a/shell-script/generate_soldocs.sh +++ /dev/null @@ -1,26 +0,0 @@ -#!/usr/bin/env sh - -set -e # Exit immediately if a command exits with a non-zero status. - -# Source the index utilities -. "$(dirname "$0")/soldocs/generate_and_move_forge_docs.sh" -. "$(dirname "$0")/soldocs/generate_index.sh" -. "$(dirname "$0")/soldocs/convert_links.sh" - -# Main function -main() { - # Generate and Move forge docs - generate_and_move_forge_docs - - # Generate index files: process directories - generate_index docs/04-plugin-functions/05-std/ - generate_index docs/05-resources/03-devkit/03-api-reference/ - - # Convert links - convert_links - - echo "Successfully generated Solidity API docs and processed $(find docs -type f | wc -l) files!" -} - -# Run the main function -main diff --git a/shell-script/soldocs/convert_links.sh b/shell-script/soldocs/convert_links.sh deleted file mode 100644 index 2b12c014..00000000 --- a/shell-script/soldocs/convert_links.sh +++ /dev/null @@ -1,33 +0,0 @@ -#!/usr/bin/env sh - -set -e # Exit immediately if a command exits with a non-zero status. - -convert_links() { - docs_dir="./docs" - - find "$docs_dir" -type f -name "*.md" | while read -r file; do - tmp_file=$(mktemp) - - sed -E ' - s|(/src/std/)([^)]+)\.md(#[^)]*)?|/plugin-functions/std/\2\3|g - s|(/src/std/)|/plugin-functions/std/|g - s|(/src/devkit/)([^)]+)\.md(#[^)]*)?|/resources/devkit/api-reference/\2\3|g - s|(/src/devkit/)|/resources/devkit/api-reference/|g - ' "$file" > "$tmp_file" - - if ! cmp -s "$file" "$tmp_file"; then - mv "$tmp_file" "$file" - echo "Updated: $file" - else - rm "$tmp_file" - echo "No changes: $file" - fi - done - - echo "Link conversion completed." -} - -# Use the function if this script is run directly -if [ "$(basename "$0")" = "convert_links.sh" ]; then - convert_links -fi diff --git a/shell-script/soldocs/gen_index_copy_readme_to_index.sh b/shell-script/soldocs/gen_index_copy_readme_to_index.sh deleted file mode 100644 index 3c277870..00000000 --- a/shell-script/soldocs/gen_index_copy_readme_to_index.sh +++ /dev/null @@ -1,43 +0,0 @@ -#!/usr/bin/env sh - -set -e # Exit immediately if a command exits with a non-zero status. - -gen_index_copy_readme_to_index() { - basepath=$1 - readme_file=$2 - index_file="${basepath}index.md" - - # Define markers - start_marker="" - end_marker="" - - # Update or create index.md - if [ -f "$index_file" ]; then - # File exists, update the index section - awk -v start="$start_marker" -v end="$end_marker" -v readme="$readme_file" ' - BEGIN {in_index=0; printed=0} - $0 ~ start {in_index=1; print; while((getline line < readme) > 0) {print line}; printed=1; next} - $0 ~ end {in_index=0; print; next} - !in_index {print} - END {if (!printed) {print ""; print start; while((getline line < readme) > 0) {print line}; print ""; print end}} - ' "$index_file" > "${index_file}.tmp" && mv "${index_file}.tmp" "$index_file" - else - # File doesn't exist, create new content - { - echo "# Index" - echo "" - echo "$start_marker" - cat "$readme_file" - echo "" - echo "$end_marker" - } > "$index_file" - fi - - # Replace index.md with the updated content - echo "Copied processed content to $index_file" -} - -# Use the function if this script is run directly -if [ "$(basename "$0")" = "gen_index_copy_readme_to_index.sh" ]; then - gen_index_copy_readme_to_index "$1" "$2" -fi diff --git a/shell-script/soldocs/gen_index_format_relative_links.sh b/shell-script/soldocs/gen_index_format_relative_links.sh deleted file mode 100644 index 191ae445..00000000 --- a/shell-script/soldocs/gen_index_format_relative_links.sh +++ /dev/null @@ -1,68 +0,0 @@ -#!/usr/bin/env sh - -set -e # Exit immediately if a command exits with a non-zero status. - -format_link() { - name="$1" - path="$2" - - # Remove everything before ./docs/ if present - path="${path#*./docs/}" - - # Extract the last two parts of the path - path=$(echo "$path" | awk -F'/' '{if (NF>1) print $(NF-1)"/"$NF; else print $NF}') - - # If the second-to-last part doesn't end with .sol, use only the last part - case "$path" in - *".sol/"*) ;; - *) path=$(echo "$path" | awk -F'/' '{print $NF}') ;; - esac - - # If the path doesn't end with .md, assume it's a directory and add index.md - case "$path" in - *.md) ;; - *) path="${path%/}/index.md" ;; - esac - - echo "- [$name](./$path)" -} - -gen_index_format_relative_links() { - if [ -z "$1" ] || [ -z "$2" ]; then - echo "Error: File and base path are required" >&2 - return 1 - fi - file="$1" - basepath="$2" - temp_file="${file}.tmp" - - while IFS= read -r line; do - case "$line" in - "- ["*) - name="${line#- [}" - name="${name%%]*}" - path="${line#*](}" - path="${path%)}" - - if echo "$path" | grep -q '^\.\/.*index\.md$'; then - echo "$line" - else - format_link "$name" "$path" - fi - ;; - *) echo "$line" ;; - esac - done < "$file" > "$temp_file" - - mv "$temp_file" "$file" - echo "Formatted relative links in $file" -} - -# Use the function if this script is run directly -if [ "$(basename "$0")" = "gen_index_format_relative_links.sh" ]; then - if [ $# -lt 2 ]; then - echo "Error: Please provide a file and a base path" >&2 - exit 1 - fi - gen_index_format_relative_links "$1" "$2" -fi diff --git a/shell-script/soldocs/gen_index_remove_unnecessary_content.sh b/shell-script/soldocs/gen_index_remove_unnecessary_content.sh deleted file mode 100644 index a8b04582..00000000 --- a/shell-script/soldocs/gen_index_remove_unnecessary_content.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env sh - -set -e # Exit immediately if a command exits with a non-zero status. - -gen_index_remove_unnecessary_content() { - file="$1" - # Remove "# Contents" line and keep only the link list - sed -i.bak '/^# Contents$/d; /^- /,$!d' "$file" && rm -f "${file}.bak" - echo "Removed unnecessary content from $file" -} - -# Use the function if this script is run directly -if [ "$(basename "$0")" = "gen_index_remove_unnecessary_content.sh" ]; then - gen_index_remove_unnecessary_content "$1" -fi diff --git a/shell-script/soldocs/gen_index_update_index.sh b/shell-script/soldocs/gen_index_update_index.sh deleted file mode 100644 index 63021039..00000000 --- a/shell-script/soldocs/gen_index_update_index.sh +++ /dev/null @@ -1,137 +0,0 @@ -#!/usr/bin/env sh - -set -e # Exit immediately if a command exits with a non-zero status. - -# Import functions from other scripts -. "$(dirname "$0")/soldocs/gen_index_remove_unnecessary_content.sh" -. "$(dirname "$0")/soldocs/gen_index_format_relative_links.sh" -. "$(dirname "$0")/soldocs/gen_index_copy_readme_to_index.sh" - -count_md_files() { - dir="$1" - find "$dir" -maxdepth 1 -type f -name "*.md" ! -name "index.md" ! -name "README.md" | wc -l -} - -generate_links_for_directory() { - dir="$1" - has_content=false - - for item in "$dir"/*; do - if [ -f "$item" ]; then - filename=$(basename "$item") - case "$filename" in - index.md|README.md) - # Skip index.md and README.md - ;; - *.md) - # For .md files, use the file name as the link text - printf -- "- [%s](./%s)\n" "$(basename "$filename" .md)" "$filename" - has_content=true - ;; - *) - # For non-.md files, use the full filename as the link text - printf -- "- [%s](./%s)\n" "$filename" "$filename" - has_content=true - ;; - esac - elif [ -d "$item" ]; then - dirname=$(basename "$item") - # For directories, create a link to the index.md file inside - printf -- "- [%s](./%s/index.md)\n" "$dirname" "$dirname" - has_content=true - fi - done - - # If no content was generated, return non-zero exit code - if [ "$has_content" = false ]; then - return 1 - fi -} - -update_index_content() { - index_file="$1" - temp_file="${index_file}.tmp" - start_marker="" - end_marker="" - - # Generate new content - new_content=$(generate_links_for_directory "$(dirname "$index_file")") || { - echo "No content generated for index. The directory might be empty or contain only index.md/README.md." - return 1 - } - - # Check if the file exists and contains markers - if [ -f "$index_file" ] && grep -q "$start_marker" "$index_file" && grep -q "$end_marker" "$index_file"; then - # Update existing file while preserving marker positions - { - sed -n "1,/$start_marker/p" "$index_file" - echo "$new_content" - sed -n "/$end_marker/,\$p" "$index_file" - } > "$temp_file" - - # Check if the temp file was created successfully - if [ -s "$temp_file" ]; then - mv "$temp_file" "$index_file" - else - echo "Error: Failed to update index file" >&2 - rm -f "$temp_file" - return 1 - fi - else - # Create new file with content - { - echo "# Index" - echo - echo "$start_marker" - echo "$new_content" - echo "$end_marker" - } > "$index_file" - fi -} - -gen_index_update_index() { - if [ -z "$1" ]; then - echo "Error: Base path is required" >&2 - return 1 - fi - basepath="$1" - readme_file="${basepath}README.md" - index_file="${basepath}index.md" - - echo "Starting update_index for $basepath" - echo "README file: $readme_file" - echo "Index file: $index_file" - - # Check if README.md exists - if [ -f "$readme_file" ]; then - echo "README.md found. Processing..." - # Step 1: Remove unnecessary content from README.md - gen_index_remove_unnecessary_content "$readme_file" || { echo "Failed to remove unnecessary content"; return 1; } - - # Step 2: Format links to be relative in README.md - gen_index_format_relative_links "$readme_file" "$basepath" || { echo "Failed to format relative links"; return 1; } - - # Step 3: Copy processed content to index.md - gen_index_copy_readme_to_index "$basepath" "$readme_file" || { echo "Failed to copy content to index.md"; return 1; } - - # Step 4: Remove README.md - rm "$readme_file" - else - echo "README.md not found. Checking directory contents..." - update_index_content "$index_file" || { - echo "Failed to update index.md. The directory might be empty or contain only index.md/README.md." - return 1 - } - fi - - echo "Index update completed for $basepath" -} - -# Use the function if this script is run directly -if [ "$(basename "$0")" = "gen_index_update_index.sh" ]; then - if [ $# -eq 0 ]; then - echo "Error: Please provide a base path" >&2 - exit 1 - fi - gen_index_update_index "$1" -fi diff --git a/shell-script/soldocs/generate_and_move_forge_docs.sh b/shell-script/soldocs/generate_and_move_forge_docs.sh deleted file mode 100644 index 64223783..00000000 --- a/shell-script/soldocs/generate_and_move_forge_docs.sh +++ /dev/null @@ -1,31 +0,0 @@ -#!/usr/bin/env sh - -set -e # Exit immediately if a command exits with a non-zero status. - -# Generate solidity docs using `forge doc`` -generate_forge_docs() { - forge doc -o soldocs/ || { echo "Failed to generate solidity docs"; exit 1; } -} - -# Move generated docs to appropriate directories -move_forge_docs() { - cp -r soldocs/src/src/std/ docs/04-plugin-functions/05-std/ || { echo "Failed to move plugin docs"; exit 1; } - cp -r soldocs/src/src/devkit/ docs/05-resources/03-devkit/03-api-reference/ || { echo "Failed to move devkit docs"; exit 1; } -} - -# Remove unnecessary soldocs/ -remove_forge_docs() { - rm -rf soldocs -} - -# Main function -generate_and_move_forge_docs() { - generate_forge_docs - move_forge_docs - remove_forge_docs -} - -# Use the function if this script is run directly -if [ "$(basename "$0")" = "generate_and_move_forge_docs.sh" ]; then - generate_and_move_forge_docs -fi diff --git a/shell-script/soldocs/generate_index.sh b/shell-script/soldocs/generate_index.sh deleted file mode 100644 index ef060267..00000000 --- a/shell-script/soldocs/generate_index.sh +++ /dev/null @@ -1,45 +0,0 @@ -#!/usr/bin/env sh - -set -e # Exit immediately if a command exits with a non-zero status. - -# Import functions from other scripts -. "$(dirname "$0")/soldocs/gen_index_update_index.sh" - -# Function to recursively process directories -gen_index_process_directory() { - if [ -z "$1" ]; then - echo "Error: Directory path is required" >&2 - return 1 - fi - dir="$1" - - echo "Processing directory: $dir" - - # Process current directory - gen_index_update_index "$dir" - - # Process subdirectories - find "$dir" -mindepth 1 -type d | while read -r subdir; do - gen_index_process_directory "$subdir/" - done - - echo "Index files have been updated successfully in $dir and its subdirectories." -} - -# Main function -generate_index() { - if [ -z "$1" ]; then - echo "Error: Directory path is required" >&2 - return 1 - fi - gen_index_process_directory "$1" -} - -# Use the function if this script is run directly -if [ "$(basename "$0")" = "generate_index.sh" ]; then - if [ $# -eq 0 ]; then - echo "Error: Please provide a directory path" >&2 - exit 1 - fi - generate_index "$1" -fi diff --git a/book/.gitignore b/site/.gitignore similarity index 100% rename from book/.gitignore rename to site/.gitignore diff --git a/book/README.md b/site/README.md similarity index 100% rename from book/README.md rename to site/README.md diff --git a/site/babel.config.js b/site/babel.config.js new file mode 100644 index 00000000..f8c7bb99 --- /dev/null +++ b/site/babel.config.js @@ -0,0 +1,3 @@ +module.exports = { + presets: [require.resolve("@docusaurus/core/lib/babel/preset")], +}; diff --git a/site/biome.json b/site/biome.json new file mode 100644 index 00000000..24f52116 --- /dev/null +++ b/site/biome.json @@ -0,0 +1,17 @@ +{ + "formatter": { + "enabled": true, + "indentStyle": "space", + "lineWidth": 120 + }, + "linter": { + "enabled": true + }, + "organizeImports": { + "enabled": true + }, + "files": { + "ignore": [".docusaurus/**", "node_modules/**"], + "include": ["./**/*.{js,ts,tsx,json}"] + } +} diff --git a/site/bun.lockb b/site/bun.lockb new file mode 100755 index 00000000..fa961f81 Binary files /dev/null and b/site/bun.lockb differ diff --git a/site/docs/00-getting-started.md b/site/docs/00-getting-started.md new file mode 100644 index 00000000..89bf7c34 --- /dev/null +++ b/site/docs/00-getting-started.md @@ -0,0 +1,52 @@ +--- +sidebar_label: Getting Started +keywords: [meta-contract, installation, setup, development-environment] +tags: [meta-contract, installation, setup, development-environment] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Meta Contract + +Meta Contract is a Foundry-based smart contract framework designed to create flexible, upgradeable, and scalable blockchain applications. It implements the UCS (Upgradeable Clone for Scalable Contracts) architecture, providing developers with powerful tools to build and maintain complex decentralized systems. + +:::caution +Please note that as it is still in the development version, there may be potentially breaking changes made without notice. Use it with caution. +::: + +## Quick Start + +Just run this: + +```bash +forge init -t metacontract/template +``` + +After the installation, run the following command to test the _Counter_ sample project and see how it works: + +```bash +cd +forge test +``` + +If you want to learn more about meta contract installation, please refer to [installation guide](./02-guides/01-setup/01-installation.md). + +## Features + +- **Upgradeability 🔄**: Meta Contracts can be upgraded without changing their address, allowing for seamless improvements and bug fixes. +- **Modularity 🗂️**: The framework separates contract logic into distinct, manageable components, enhancing code organization and reusability. +- **Scalability 📈**: Meta Contracts are designed to handle growth efficiently, making them suitable for large-scale applications. +- **Flexibility ⚙️**: Developers can easily extend and customize Meta Contracts to suit specific project needs. +- **Testability ✅**: The modular structure of Meta Contracts facilitates comprehensive testing, including unit tests for individual functions and integration tests for the entire system. + +## Documentation Overview + +This documentation is structured to guide you through the Meta Contract framework: + +1. **[Concepts](./01-concepts/index.md)**: Understand the fundamental concepts and architecture of Meta Contract. +2. **[Guides](./02-guides/index.md)**: Learn about best practices for development, deployment, and operations. +3. **[API Reference](./03-api/index.md)**: Explore the API details and usage of the Meta Contract DevKit. +4. **[Examples](./04-examples/index.md)**: Review examples of various use cases. + +Each section provides detailed information to help you effectively use and understand the Meta Contract framework. For more information, follow the links to each section. diff --git a/docs/01-introduction/01-what-is-meta-contract.md b/site/docs/01-concepts/01-what-is-meta-contract.md similarity index 79% rename from docs/01-introduction/01-what-is-meta-contract.md rename to site/docs/01-concepts/01-what-is-meta-contract.md index a19946dc..0cb153b3 100644 --- a/docs/01-introduction/01-what-is-meta-contract.md +++ b/site/docs/01-concepts/01-what-is-meta-contract.md @@ -1,21 +1,14 @@ --- -title: "What is Meta Contract?" -version: 0.1.0 -lastUpdated: 2024-09-06 -author: Meta Contract Development Team -scope: intro -type: concept +keywords: [meta-contract, introduction, overview, features, benefits] tags: [meta-contract, introduction, overview, features, benefits] -relatedDocs: ["02-key-concepts.md", "./03-getting-started/01-installation.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-06 - description: Initial version of the Meta Contract introduction document +last_update: + date: 2024-10-26 + author: Meta Contract Development Team --- # What is Meta Contract? -Meta Contract (MC) is an innovative smart contract framework designed to create flexible, upgradeable, and scalable blockchain applications. It implements the UCS (Upgradeable Clone for Scalable Contracts) architecture, providing developers with powerful tools to build and maintain complex decentralized systems. +Meta Contract (MC) is an innovative smart contract framework designed to create flexible, upgradeable, and scalable blockchain applications. It implements the UCS (Upgradeable Clone for Scalable Contracts, defined in [ERC-7546](https://eips.ethereum.org/EIPS/eip-7546)) architecture, providing developers with powerful tools to build and maintain complex decentralized systems. ## Key Features @@ -57,8 +50,8 @@ Meta Contracts are particularly well-suited for: To start building with Meta Contract: -1. Explore the [Key Concepts](02-key-concepts.md) to understand the core principles. -2. Follow our [Installation Guide](03-getting-started/01-installation.md) to set up your development environment. -3. Check out our [Tutorials](../02-tutorials/index.md) for hands-on examples. +1. Explore the [Key Concepts](./02-key-concepts.md) to understand the core principles. +2. Follow our [Installation Guide](../02-guides/01-setup/01-installation.md) to set up your development environment. +3. Check out our [Examples](../04-examples/index.md). For any questions or support, join our [community forum](https://github.com/orgs/metacontract/discussions). diff --git a/docs/01-introduction/02-key-concepts.md b/site/docs/01-concepts/02-key-concepts.md similarity index 75% rename from docs/01-introduction/02-key-concepts.md rename to site/docs/01-concepts/02-key-concepts.md index 5e108a2a..e920aebd 100644 --- a/docs/01-introduction/02-key-concepts.md +++ b/site/docs/01-concepts/02-key-concepts.md @@ -1,16 +1,9 @@ --- -title: "Key Concepts and Architecture" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: arch -type: guide +keywords: [meta-contract, concepts, architecture, proxy, dictionary, function-contracts, upgradeability, cloneability, ucs] tags: [meta-contract, concepts, architecture, proxy, dictionary, function-contracts, upgradeability, cloneability, ucs] -relatedDocs: ["03-devops/01-deployment.md", "03-devops/03-upgrades.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-06 - description: Initial version of key concepts document +last_update: + date: 2024-10-26 + author: Meta Contract Development Team --- # Key Concepts and Architecture @@ -19,7 +12,7 @@ Meta Contract implements the UCS (Upgradeable Clone for Scalable Contracts) arch ## Core Components and Concepts -The Meta Contract architecture consists of three main components: +The UCS architecture consists of three main components: 1. Proxy Contract 2. Dictionary Contract @@ -41,7 +34,7 @@ Key points: ### 2. Dictionary Contract -The Dictionary Contract acts as a registry for all Function Contracts within a Meta Contract system. Its main responsibilities are: +The Dictionary Contract acts as a registry for all Function Contracts within a Meta Contract. Its main responsibilities are: - Mapping function selectors to the addresses of their corresponding Function Contracts. - Providing a mechanism to update these mappings, enabling upgrades. @@ -60,10 +53,11 @@ Key characteristics: - They don't store state directly but instead work with the state stored in the Proxy Contract. - Function Contracts can be shared across multiple Meta Contract instances, promoting code reuse. - They are designed to be stateless, working with the state stored in the Proxy Contract. +- In Meta Contracts, a collection of multiple functions made available together is referred to as a ***bundle***. ## Architecture Overview -The following diagram illustrates how these components interact within the Meta Contract architecture: +The following diagram illustrates how these components interact within the UCS architecture: ```mermaid graph TD @@ -73,13 +67,18 @@ graph TD B -->|Delegates call| D[Function Contract] D -->|Executes logic| B B -->|Returns result| A + + style A color:#000000,fill:#ffffcc,stroke:#cccc00,stroke-width:2px + style B color:#000000,fill:#ffcccc,stroke:#ff0000,stroke-width:2px + style C color:#000000,fill:#ccffcc,stroke:#00ff00,stroke-width:2px + style D color:#000000,fill:#ccccff,stroke:#0000ff,stroke-width:2px ``` ## Key Features ### 1. Upgradeability -Upgradeability is a core feature of Meta Contracts, allowing for the evolution of contract functionality without changing the contract's address or losing its state. +Upgradeability is a core feature of Meta Contracts, allowing for the evolution of contract functionality without changing the contract's address or losing its state. This allows for granular upgrades without changing the Proxy Contract's address or disrupting the overall system. How it works: - To upgrade a function, deploy a new Function Contract and update the Dictionary Contract to point to the new address. @@ -91,7 +90,7 @@ Benefits: ### 2. Cloneability -Cloneability refers to the ability to create multiple instances of a Meta Contract system with minimal gas costs. +Cloneability refers to the ability to create multiple instances of a Meta Contract with minimal gas costs. Key aspects: - Multiple Proxy Contracts can be deployed, each with its own state. @@ -100,17 +99,15 @@ Key aspects: Use cases: - Creating multiple instances of a standardized contract (e.g., token contracts, voting systems). -- Deploying personalized contract instances for users or organizations. +- Deploying personalized contract instances for users or organizations. (e.g. contract wallets, DAO contracts) -## Upgrade Process +### 3. Contract Size Management -The upgrade process in the Meta Contract architecture is straightforward: +By splitting logic into individual Function Contracts, Meta Contracts effectively bypass the 24.576kB contract size limit. This modular approach allows for more complex and feature-rich contracts without being constrained by size limitations. -1. Deploy a new Function Contract with updated logic. -2. Update the Dictionary Contract to point the relevant function selector(s) to the new Function Contract address. -3. The Proxy Contract will automatically use the new Function Contract for subsequent calls. +### 4. Schema-based Storage Management -This process allows for granular upgrades without changing the Proxy Contract's address or disrupting the overall system. +The use of a schema-based storage management system simplifies handling storage conflicts during contract upgrades. This system ensures that storage layouts remain consistent and conflicts are minimized, facilitating smoother upgrades and maintenance. ## Security Considerations @@ -128,5 +125,5 @@ These key concepts and architectural components work together to create a flexib For more detailed information on specific aspects of Meta Contracts, please refer to the following resources: -- [Meta Contract Deployment](../03-devops/02-deployment.md) -- [Upgrading Meta Contracts](../03-devops/03-upgrades.md) +- [Meta Contract Deployment](../02-guides/03-operations/01-deployment.md) +- [Upgrading Meta Contracts](../02-guides/03-operations/03-upgrades.md) diff --git a/site/docs/01-concepts/03-glossary.md b/site/docs/01-concepts/03-glossary.md new file mode 100644 index 00000000..0534708e --- /dev/null +++ b/site/docs/01-concepts/03-glossary.md @@ -0,0 +1,49 @@ +--- +keywords: [glossary, definitions, concepts, meta-contract, architecture, proxy, dictionary, function-contracts, upgradeability, cloneability, ucs] +tags: [glossary, definitions, concepts, meta-contract, architecture, proxy, dictionary, function-contracts, upgradeability, cloneability, ucs] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Glossary + +## Meta Contract + +A Foundry-based framework for creating flexible, upgradeable, and scalable blockchain applications using the UCS architecture. + +## UCS + +Architecture for creating scalable contracts, introduced as [ERC-7546](https://eips.ethereum.org/EIPS/eip-7546). + +## Proxy Contract + +Manages state and delegates function calls to Function Contracts. + +## Dictionary Contract + +Registry mapping function selectors to Function Contracts, allowing upgrades. + +## Function Contracts + +Stateless contracts implementing specific functionalities, upgradeable independently. + +## Function Delegation + +Process of delegating calls to Function Contracts based on selectors. + +## MCTest + +Functions and modifiers for testing scenarios. + +## MCScript + +Deployment and upgrade scripts with transaction broadcasting. + +## DevKit + +Tools and libraries for developing Meta Contract projects, aiding in scripting, testing, and lifecycle management. + +## mc + +Core object in DevKit for testing and scripting functionalities. diff --git a/site/docs/01-concepts/index.md b/site/docs/01-concepts/index.md new file mode 100644 index 00000000..d6ac75df --- /dev/null +++ b/site/docs/01-concepts/index.md @@ -0,0 +1,15 @@ +--- +keywords: [meta-contract, introduction, overview, getting-started] +tags: [meta-contract, introduction, overview, getting-started] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Concepts + +This section provides an overview of the Meta Contract project and its fundamental concepts. If you're new to Meta Contract, we recommend starting with "What is Meta Contract?" and then proceeding through the documents in the order listed above. Here you'll find: + +1. **[What is Meta Contract?](01-what-is-meta-contract.md)**: An introduction to the Meta Contract project and its goals. +2. **[Key Concepts](02-key-concepts.md)**: Essential concepts and architecture used throughout the Meta Contract ecosystem. +3. **[Glossary](03-glossary.md)**: A list of terms and concepts used in the Meta Contract documentation. diff --git a/docs/01-introduction/03-getting-started/01-installation.md b/site/docs/02-guides/01-setup/01-installation.md similarity index 79% rename from docs/01-introduction/03-getting-started/01-installation.md rename to site/docs/02-guides/01-setup/01-installation.md index 187fb0bf..b13ba25c 100644 --- a/docs/01-introduction/03-getting-started/01-installation.md +++ b/site/docs/02-guides/01-setup/01-installation.md @@ -1,16 +1,9 @@ --- -title: "Installation" -version: 0.1.0 -lastUpdated: 2024-09-06 -author: Meta Contract Development Team -scope: dev -type: guide +keywords: [meta-contract, installation, setup, development-environment] tags: [meta-contract, installation, setup, development-environment] -relatedDocs: ["02-basic-setup.md", "../../02-tutorials/01-simple-dao.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-06 - description: Initial version of the installation guide +last_update: + date: 2024-10-26 + author: Meta Contract Development Team --- # Installation @@ -21,7 +14,7 @@ This guide will walk you through the process of installing Meta Contract, a Foun Before installing Meta Contract, ensure you have the following: -1. [Foundry](https://book.getfoundry.sh/getting-started/installation) installed on your system +1. [Foundry](https://book.getfoundry.sh/getting-started/installation) installed on your system (version 0.2.0 or later) 2. Git installed on your system 3. A code editor of your choice (e.g., Cursor, Visual Studio Code) @@ -72,5 +65,3 @@ If you're still experiencing issues, please reach out to [our community](https:/ ## Next Steps Now that you have Meta Contract installed, proceed to the [Basic Setup](02-basic-setup.md) guide to configure your development environment and start working on your first Meta Contract project. - -For a hands-on introduction to Meta Contract, check out our [Simple DAO Tutorial](../../02-tutorials/01-simple-dao.md). diff --git a/docs/01-introduction/03-getting-started/02-basic-setup.md b/site/docs/02-guides/01-setup/02-basic-setup.md similarity index 66% rename from docs/01-introduction/03-getting-started/02-basic-setup.md rename to site/docs/02-guides/01-setup/02-basic-setup.md index 977bfe7a..54126745 100644 --- a/docs/01-introduction/03-getting-started/02-basic-setup.md +++ b/site/docs/02-guides/01-setup/02-basic-setup.md @@ -1,16 +1,9 @@ --- -title: "Basic Setup" -version: 0.1.0 -lastUpdated: 2024-09-06 -author: Meta Contract Development Team -scope: dev -type: guide +keywords: [setup, configuration, development-environment] tags: [setup, configuration, development-environment] -relatedDocs: ["01-installation.md", "../../02-tutorials/01-simple-dao.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-06 - description: Initial version of the basic setup guide +last_update: + date: 2024-10-28 + author: Meta Contract Development Team --- # Basic Setup @@ -19,21 +12,26 @@ This guide will walk you through the process of setting up your development envi ## Prerequisites -Before proceeding with the setup, ensure you have completed the [installation process](01-installation.md) for Meta Contract. +Before proceeding with the setup, ensure you have completed the [installation process](./01-installation.md) for Meta Contract. ## Development Environment Setup ### 1. Code Editor Configuration -We recommend using Visual Studio Code (VSCode) with the following extensions: +We recommend using [Cursor](https://www.cursor.sh/) / [Visual Studio Code (VSCode)](https://code.visualstudio.com/) with the following extensions: -- [Solidity by Juan Blanco](https://github.com/juanfranblanco/vscode-solidity) +- [Hardhat VSCode Extension](https://marketplace.visualstudio.com/items?itemName=NomicFoundation.hardhat-solidity) (Extension ID: `nomicfoundation.hardhat-solidity`) -To install these extensions: + To install this extensions: + 1. Open Cursor/VSCode + 2. Go to the Extensions view + 3. Search for and install extension -1. Open Cursor/VSCode -2. Go to the Extensions view -3. Search for and install each extension + See details in [official instruction](https://marketplace.visualstudio.com/items?itemName=NomicFoundation.hardhat-solidity#installation). + +:::info +[Solidity by Juan Blanco](https://github.com/juanfranblanco/vscode-solidity) is also very useful, but in the current version, it does not integrate well with the remappings that foundry uses by default, resulting in continuous import errors. +::: ### 2. Configuring Foundry @@ -121,10 +119,10 @@ If this command executes without errors, your basic setup is complete and workin ## Next Steps -Now that your development environment is set up, you're ready to start building with Meta Contract: +Now that your development environment is set up, you're ready to start building with Meta Contract 🚀🚀🚀 -1. Explore the [Simple DAO Tutorial](../../02-tutorials/01-simple-dao.md) for a hands-on introduction to Meta Contract development. -2. Review the [MC DevKit Usage Guide](../../05-resources/04-devkit/01-usage.md) to learn about the development tools available. -3. Check out the [Best Practices](../../05-resources/06-best-practices/01-ai-tdd.md) for tips on efficient Meta Contract development. +- Refer to the [Development Guide](../02-development/index.md), [Operation Guide](../03-operations/index.md) and [Middleware Guide](../04-middlewares/index.md) for best practices and tips. +- Find implementation examples in the [Examples](../../04-examples/index.md) section. +- Check out the [MC DevKit API Reference](../../03-api/index.md) for detailed information about the development tools available. -For any issues or questions, reach out to our [community support channels](https://github.com/orgs/metacontract/discussions). +For any issues or questions, reach out to our [community support channels](https://github.com/metacontract/mc/discussions). diff --git a/site/docs/02-guides/01-setup/index.md b/site/docs/02-guides/01-setup/index.md new file mode 100644 index 00000000..5225323b --- /dev/null +++ b/site/docs/02-guides/01-setup/index.md @@ -0,0 +1,16 @@ +--- +keywords: [meta-contract, setup, guide] +tags: [meta-contract, setup, guide] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Setup Guide + +This guide provides a comprehensive overview of the Meta Contract setup process, including installation, configuration. + +1. **[Installation](./01-installation.md)**: How to install Meta Contract. +2. **[Basic Setup](./02-basic-setup.md)**: How to configure Meta Contract. + +If you're new to Meta Contract, we recommend starting with "Installation" and then proceeding through the documents in the order listed above. diff --git a/site/docs/02-guides/02-development/01-resources.md b/site/docs/02-guides/02-development/01-resources.md new file mode 100644 index 00000000..e0d9f517 --- /dev/null +++ b/site/docs/02-guides/02-development/01-resources.md @@ -0,0 +1,34 @@ +--- +sidebar_label: Useful Resources +keywords: [smart contract development, ethereum, foundry, solidity] +tags: [smart contract development, ethereum, foundry, solidity] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Useful Resources for General Smart Contract Development + +This guide provides useful resources for general smart contract development. +These resources provide a solid foundation for understanding the blockchain ecosystem in which Meta Contract operates. + +## Ethereum + +- Ethereum Developer Guide https://ethereum.org/en/developers/docs/ + +- EVM + - Basics https://docs.huff.sh/tutorial/evm-basics/ + - Illustrated https://takenobu-hs.github.io/downloads/ethereum_evm_illustrated.pdf + - OpCodes https://www.evm.codes/ + +## Language + +- Solidity https://docs.soliditylang.org/en/latest/ + - The most popular language for developing smart contracts on Ethereum. +- Huff https://docs.huff.sh/ + - A low-level assembly language for the EVM. + +## Development Tools + +- [Foundry](https://book.getfoundry.sh/) + diff --git a/docs/03-devops/01-tdd.md b/site/docs/02-guides/02-development/02-tdd.md similarity index 69% rename from docs/03-devops/01-tdd.md rename to site/docs/02-guides/02-development/02-tdd.md index 247b1e61..c02bf69e 100644 --- a/docs/03-devops/01-tdd.md +++ b/site/docs/02-guides/02-development/02-tdd.md @@ -1,41 +1,15 @@ --- -title: "TDD and Implementation" -version: 0.1.0 -lastUpdated: 2024-09-09 -author: Meta Contract DevOps Team -scope: devops -type: guide -tags: [TDD, implementation, AI-enhanced development, smart contracts, foundry, colocation] -relatedDocs: ["02-deployment.md", "03-upgrades.md", "04-ci-cd.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-09 - description: Initial version of Test-Driven Development and Implementation guide +keywords: [TDD, implementation, AI-assisted development, smart contracts, foundry, colocation] +tags: [TDD, implementation, AI-assisted development, smart contracts, foundry, colocation] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team --- -# TDD and Implementation +# Test-Driven Development This guide outlines our approach to Test-Driven Development (TDD) and implementation in Meta Contract projects, leveraging Foundry as our testing framework and incorporating AI assistance throughout the process. -## Table of Contents - -## Table of Contents - -1. [Understanding Testing Challenges in Smart Contracts](#understanding-testing-challenges-in-smart-contracts) -2. [AI-Enhanced Test-Driven Development](#ai-enhanced-test-driven-development) - - [Key Principles](#key-principles) -3. [TDD Workflow with Foundry](#tdd-workflow-with-foundry) -4. [Setting Up the Foundry Environment](#setting-up-the-foundry-environment) -5. [AI-Enhanced TDD: Practical Examples](#ai-enhanced-tdd-practical-examples) -6. [Writing and Running Unit Tests](#writing-and-running-unit-tests) - - [Colocation in Meta Contract Development](#colocation-in-meta-contract-development) - - [Benefits of Colocation](#benefits-of-colocation) - - [Example of Colocated Test and Implementation](#example-of-colocated-test-and-implementation) -7. [Implementing Features](#implementing-features) -8. [Writing and Running Integration Tests](#writing-and-running-integration-tests) -9. [Best Practices](#best-practices) -10. [Troubleshooting Common Issues](#troubleshooting-common-issues) - ## Understanding Testing Challenges in Smart Contracts Smart contract developers often face three major challenges: @@ -44,47 +18,69 @@ Smart contract developers often face three major challenges: 2. **Managing Computational Resources**: Optimizing for gas efficiency (often called "gas golfing") can increase complexity and reduce readability. 3. **Managing Software Complexity**: Especially when dealing with complex domain logic, balancing functionality with simplicity becomes crucial. -Meta Contract, through its UCS (Upgradeable Clone for Scalable Contracts) architecture, provides a framework to address these challenges through automated testing and modular design. - -## AI-Enhanced Test-Driven Development - -Our development process integrates AI assistance with Foundry-based TDD practices to create a more efficient and thorough development cycle. +To address these challenges, our AI-assisted Test-Driven Development (AITDD) approach, integrated with the architecture of Meta Contract, provides a robust framework through automated testing and modular design. -### Key Principles +## AI-Assisted Test-Driven Development with Foundry -1. **Test-First Approach**: Write Foundry tests before implementing features. -2. **AI-Assisted Specification**: Use AI to help articulate and refine project requirements and test cases. -3. **Continuous AI Feedback**: Leverage AI for code review and improvement suggestions. -4. **Iterative Development**: Continuously refine tests and implementations based on AI insights. +This section introduces an AI-assisted Test-Driven Development (TDD) approach using Foundry, enabling a more efficient and thorough development cycle. -## TDD Workflow with Foundry +### Basic TDD Workflow -1. **Specify**: Define the feature or functionality you want to implement. +1. **Specify & Analyze**: Define the feature or functionality you want to implement. Use AI to clarify project requirements and suggest test cases, identifying risks and challenges. 2. **Write Tests**: Create Foundry tests that define the expected behavior. 3. **Run Tests**: Execute the tests (they should fail initially). 4. **Implement**: Write the minimum code necessary to pass the tests. 5. **Refactor**: Improve the code while ensuring tests continue to pass. 6. **Repeat**: Move on to the next feature or refinement. -## Setting Up the Foundry Environment +```mermaid +flowchart LR + A[Specify & Analyze] --> B[Write & Run Tests] + B --> C[Implement to Pass] + C --> D[Refactor] + D --> A + + style A color:#000000,fill:#ffffcc,stroke:#cccc00,stroke-width:2px + style B color:#000000,fill:#ffcccc,stroke:#ff6666,stroke-width:2px + style C color:#000000,fill:#ccffcc,stroke:#66ff66,stroke-width:2px + style D color:#000000,fill:#ccccff,stroke:#6666ff,stroke-width:2px +``` -1. Install Foundry (recommended version 0.2.0 or later): - ```bash - curl -L https://foundry.paradigm.xyz | bash - foundryup - ``` +### Leveraging AI -2. Create a new Meta Contract project: - ```bash - forge init -t metacontract/mc - cd - ``` +1. **AI-Assisted Specification**: Utilize AI to articulate and refine project requirements and test cases. +2. **Continuous AI Feedback**: Leverage AI for code review and improvement suggestions, optimizing computational resources and enhancing security. +3. **Iterative Development**: Continuously refine tests and implementations based on AI insights, ensuring adaptability and robustness in the face of evolving challenges. + +## Example Workflow + +Here are practical ways to integrate AI into your TDD workflow. + +### 1. Setting Up the Project + +Create a new Meta Contract project. For details, refer to the [Setup Guide](../01-setup/index.md). + +### 2. Defining Features and Analyzing Requirements + +Clearly define the feature you want to implement, such as "allow users to vote on proposals" in a voting system. Gather requirements from stakeholders or documentation, and use AI to refine these requirements and suggest test cases. Identify any risks or challenges, like security concerns, and set success criteria for the feature's expected behavior and outcomes. This prepares you for writing tests in the next step. + +### 3. Writing Unit Tests and Implementations + +#### Colocation in Meta Contract Development + +The architecture of Meta Contract allows for function-level granularity, enabling developers to manage functions in separate files. This feature facilitates a colocated TDD approach, where tests are placed in the same file as the implementation. + +##### Benefits of Colocation -## AI-Enhanced TDD: Practical Examples +1. **Improved Maintainability**: Keep related code and tests together for easier updates. +2. **Enhanced Readability**: Developers can easily understand the expected behavior alongside the implementation. +3. **Faster Development Cycle**: Quickly iterate between writing tests and implementation. -Here are some practical ways to integrate AI into your TDD workflow: +#### Code Generation & Review with AI -1. **Test Case Generation**: Use AI to suggest potential test cases based on your function specifications. +1. **Test Case Generation with AI** + + Use AI to suggest potential test cases based on your function specifications. Example: ``` @@ -101,7 +97,9 @@ Here are some practical ways to integrate AI into your TDD workflow: 8. Boundary conditions (e.g., first vote, last vote) ``` -2. **Code Review Assistance**: After implementing a feature, use AI to review your code and suggest improvements. +2. **Code Review Assistance** + + After implementing a feature, use AI to review your code and suggest improvements. Example: ``` @@ -116,18 +114,6 @@ Here are some practical ways to integrate AI into your TDD workflow: 4. Error Handling: Use custom errors instead of require statements for better gas efficiency and more informative error messages. ``` -## Writing and Running Unit Tests - -### Colocation in Meta Contract Development - -Meta Contract's architecture allows for function-level granularity, enabling developers to manage functions in separate files. This feature facilitates a colocated TDD approach, where tests are placed in the same file as the implementation. - -#### Benefits of Colocation - -1. **Improved Maintainability**: Keep related code and tests together for easier updates. -2. **Enhanced Readability**: Developers can easily understand the expected behavior alongside the implementation. -3. **Faster Development Cycle**: Quickly iterate between writing tests and implementation. - #### Example of Colocated Test and Implementation ```solidity @@ -158,7 +144,7 @@ contract Vote { } // Unit Testing -import {MCTest} from "@devkit/Flattened.sol"; +import {MCTest} from "@mc-devkit/Flattened.sol"; import {VotingSystemErrors} from "bundle/voting-system/interfaces/VotingSystemErrors.sol"; import {VotingSystemEvents} from "bundle/voting-system/interfaces/VotingSystemEvents.sol"; @@ -211,17 +197,7 @@ This example demonstrates: - Event emission and checking - Error handling and testing -## Implementing Features - -When implementing features, follow these steps: - -1. Write the test in the same file as the function you're implementing. -2. Run the test to ensure it fails (red phase). -3. Implement the minimum code necessary to pass the test. -4. Run the test again to ensure it passes (green phase). -5. Refactor the code if necessary, ensuring the test still passes. - -## Writing and Running Integration Tests +### 4. Writing Integration Tests Integration tests are crucial for ensuring that different components of your system work together correctly. They differ from unit tests in that they test the interaction between multiple functions or contracts. @@ -231,7 +207,7 @@ Integration tests are crucial for ensuring that different components of your sys // SPDX-License-Identifier: MIT pragma solidity ^0.8.24; - import {MCTest} from "@devkit/Flattened.sol"; + import {MCTest} from "@mc-devkit/Flattened.sol"; import {IVotingSystem} from "bundle/voting-system/interfaces/IVotingSystem.sol"; import {VotingSystemErrors} from "bundle/voting-system/interfaces/VotingSystemErrors.sol"; import {VotingSystemEvents} from "bundle/voting-system/interfaces/VotingSystemEvents.sol"; @@ -281,6 +257,10 @@ This integration test demonstrates: - Testing a complete voting scenario - Checking interactions between different parts of the system +### 5. Refactoring and Iteration + +Refactoring is essential in TDD to improve code structure without changing its behavior. Focus on simplifying code, removing redundancies, and enhancing readability. Break down large functions into smaller, reusable components, and ensure variable and function names are descriptive. Apply the DRY principle to eliminate duplicate code and optimize performance, especially for gas efficiency in smart contracts. Always update documentation to reflect changes. For example, refactor a vote calculation by creating a [helper function](./04-using-internal-library.md) to sum votes, promoting clarity and reuse. + ## Best Practices 1. **Comprehensive Testing**: Aim for high test coverage, including edge cases and failure scenarios. @@ -293,7 +273,7 @@ This integration test demonstrates: 8. **Use Meta Contract DevKit**: Utilize the tools provided in the Meta Contract DevKit for more efficient testing and development. 9. **Consistent Naming Conventions**: Follow Meta Contract's naming conventions for functions, events, and errors to maintain consistency across your project. -By following this AI-enhanced TDD approach with Foundry and leveraging Meta Contract's function-level granularity for colocation, you can develop more robust, efficient, and well-tested smart contract projects. +By following this AI-assisted TDD approach with Foundry and leveraging the architecture of Meta Contract for colocation, you can develop more robust, efficient, and well-tested smart contract projects. ## Troubleshooting Common Issues @@ -315,4 +295,4 @@ By following this AI-enhanced TDD approach with Foundry and leveraging Meta Cont - Check that all necessary setup steps (e.g., creating a proposal before voting) are performed in your tests. - Verify that you're calling functions with the correct parameters and from the correct addresses (use `vm.prank` when necessary). -If you encounter persistent issues, don't hesitate to reach out to the Meta Contract community for support. +If you encounter persistent issues, don't hesitate to reach out to the [Meta Contract community](https://github.com/metacontract/mc/discussions) for support. diff --git a/docs/04-plugin-functions/01-common/01-access-control/index.md b/site/docs/02-guides/02-development/03-std-functions/01-common/01-access-control/index.md similarity index 100% rename from docs/04-plugin-functions/01-common/01-access-control/index.md rename to site/docs/02-guides/02-development/03-std-functions/01-common/01-access-control/index.md diff --git a/docs/04-plugin-functions/01-common/index.md b/site/docs/02-guides/02-development/03-std-functions/01-common/index.md similarity index 100% rename from docs/04-plugin-functions/01-common/index.md rename to site/docs/02-guides/02-development/03-std-functions/01-common/index.md diff --git a/docs/04-plugin-functions/02-deliberation/index.md b/site/docs/02-guides/02-development/03-std-functions/02-deliberation/index.md similarity index 100% rename from docs/04-plugin-functions/02-deliberation/index.md rename to site/docs/02-guides/02-development/03-std-functions/02-deliberation/index.md diff --git a/docs/04-plugin-functions/03-token/index.md b/site/docs/02-guides/02-development/03-std-functions/03-token/index.md similarity index 100% rename from docs/04-plugin-functions/03-token/index.md rename to site/docs/02-guides/02-development/03-std-functions/03-token/index.md diff --git a/docs/04-plugin-functions/04-defi/index.md b/site/docs/02-guides/02-development/03-std-functions/04-defi/index.md similarity index 100% rename from docs/04-plugin-functions/04-defi/index.md rename to site/docs/02-guides/02-development/03-std-functions/04-defi/index.md diff --git a/docs/04-plugin-functions/05-std/functions/Clone.sol/contract.Clone.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Clone.sol/contract.Clone.md similarity index 54% rename from docs/04-plugin-functions/05-std/functions/Clone.sol/contract.Clone.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/Clone.sol/contract.Clone.md index e5f7e874..c6898361 100644 --- a/docs/04-plugin-functions/05-std/functions/Clone.sol/contract.Clone.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Clone.sol/contract.Clone.md @@ -1,8 +1,13 @@ # Clone -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/Clone.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/Clone.sol) < MC Standard Function > +**Notes:** +- v0.1.0 + +- none + ## Functions ### clone diff --git a/docs/04-plugin-functions/05-std/functions/Clone.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Clone.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/Clone.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/Clone.sol/index.md index aeab678b..5a3b98e0 100644 --- a/docs/04-plugin-functions/05-std/functions/Clone.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Clone.sol/index.md @@ -1,5 +1,6 @@ -# Clone.sol +# Index - [contract.Clone](./contract.Clone.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/functions/Create.sol/contract.Create.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Create.sol/contract.Create.md similarity index 57% rename from docs/04-plugin-functions/05-std/functions/Create.sol/contract.Create.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/Create.sol/contract.Create.md index e55db2a9..03d7f690 100644 --- a/docs/04-plugin-functions/05-std/functions/Create.sol/contract.Create.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Create.sol/contract.Create.md @@ -1,8 +1,13 @@ # Create -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/Create.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/Create.sol) < MC Standard Function > +**Notes:** +- v0.1.0 + +- none + ## Functions ### create diff --git a/docs/04-plugin-functions/05-std/functions/Create.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Create.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/Create.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/Create.sol/index.md index 11a19121..1ceca587 100644 --- a/docs/04-plugin-functions/05-std/functions/Create.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Create.sol/index.md @@ -1,5 +1,6 @@ -# Create.sol +# Index - [contract.Create](./contract.Create.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.GetFunctions.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/GetFunctions.sol/contract.GetFunctions.md similarity index 65% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.GetFunctions.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/GetFunctions.sol/contract.GetFunctions.md index 5eb77520..2338e6ac 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.GetFunctions.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/GetFunctions.sol/contract.GetFunctions.md @@ -1,8 +1,13 @@ # GetFunctions -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/GetFunctions.sol) < MC Standard Function > +**Notes:** +- v0.1.0 + +- none + ## Functions ### getFunctions diff --git a/docs/04-plugin-functions/05-std/functions/GetFunctions.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/GetFunctions.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/GetFunctions.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/GetFunctions.sol/index.md index b679779c..1b59609d 100644 --- a/docs/04-plugin-functions/05-std/functions/GetFunctions.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/GetFunctions.sol/index.md @@ -1,5 +1,6 @@ -# GetFunctions.sol +# Index - [contract.GetFunctions](./contract.GetFunctions.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Receive.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Receive.sol/contract.Receive.md similarity index 59% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Receive.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/Receive.sol/contract.Receive.md index 44513259..357ef065 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Receive.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Receive.sol/contract.Receive.md @@ -1,8 +1,13 @@ # Receive -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/Receive.sol) < MC Standard Function > +**Notes:** +- v0.1.0 + +- none + ## Functions ### receive diff --git a/docs/04-plugin-functions/05-std/functions/Receive.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Receive.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/Receive.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/Receive.sol/index.md index 8988dc1b..b359b725 100644 --- a/docs/04-plugin-functions/05-std/functions/Receive.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/Receive.sol/index.md @@ -1,5 +1,6 @@ -# Receive.sol +# Index - [contract.Receive](./contract.Receive.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/functions/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/index.md similarity index 100% rename from docs/04-plugin-functions/05-std/functions/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/index.md diff --git a/docs/04-plugin-functions/05-std/functions/internal/ProxyCreator.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/internal/ProxyCreator.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/internal/ProxyCreator.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/internal/ProxyCreator.sol/index.md index e6acc42e..5ce41b78 100644 --- a/docs/04-plugin-functions/05-std/functions/internal/ProxyCreator.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/internal/ProxyCreator.sol/index.md @@ -1,5 +1,6 @@ -# ProxyCreator.sol +# Index - [library.ProxyCreator](./library.ProxyCreator.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/functions/internal/ProxyCreator.sol/library.ProxyCreator.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/internal/ProxyCreator.sol/library.ProxyCreator.md similarity index 62% rename from docs/04-plugin-functions/05-std/functions/internal/ProxyCreator.sol/library.ProxyCreator.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/internal/ProxyCreator.sol/library.ProxyCreator.md index b3dec97c..5f04cf3e 100644 --- a/docs/04-plugin-functions/05-std/functions/internal/ProxyCreator.sol/library.ProxyCreator.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/internal/ProxyCreator.sol/library.ProxyCreator.md @@ -1,8 +1,13 @@ # ProxyCreator -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/internal/ProxyCreator.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/internal/ProxyCreator.sol) < MC Standard Helper Library > +**Notes:** +- v0.1.0 + +- none + ## Functions ### create diff --git a/site/docs/02-guides/02-development/03-std-functions/05-std/functions/internal/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/internal/index.md new file mode 100644 index 00000000..f32d07b0 --- /dev/null +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/internal/index.md @@ -0,0 +1,5 @@ +# Internal + + +- [ProxyCreator](./ProxyCreator.sol/library.ProxyCreator.md) + diff --git a/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/FeatureToggle.sol/contract.FeatureToggle.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/FeatureToggle.sol/contract.FeatureToggle.md new file mode 100644 index 00000000..204155c0 --- /dev/null +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/FeatureToggle.sol/contract.FeatureToggle.md @@ -0,0 +1,24 @@ +# FeatureToggle +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/protected/FeatureToggle.sol) + +**Inherits:** +[ProtectionBase](../protection/ProtectionBase.sol/abstract.ProtectionBase.md) + +< MC Standard Function > + +**Notes:** +- 0.1.0 + +- v0.1.0 + + +## Functions +### featureToggle + +DO NOT USE STORAGE DIRECTLY !!! + + +```solidity +function featureToggle(bytes4 selector) external onlyAdmin; +``` + diff --git a/docs/04-plugin-functions/05-std/functions/protected/FeatureToggle.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/FeatureToggle.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/protected/FeatureToggle.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/FeatureToggle.sol/index.md index ec08b292..831343a6 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/FeatureToggle.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/FeatureToggle.sol/index.md @@ -1,5 +1,6 @@ -# FeatureToggle.sol +# Index - [contract.FeatureToggle](./contract.FeatureToggle.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.InitSetAdmin.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/InitSetAdmin.sol/contract.InitSetAdmin.md similarity index 51% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.InitSetAdmin.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/InitSetAdmin.sol/contract.InitSetAdmin.md index 43e9b114..96c0d90b 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.InitSetAdmin.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/InitSetAdmin.sol/contract.InitSetAdmin.md @@ -1,11 +1,16 @@ # InitSetAdmin -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/protected/InitSetAdmin.sol) **Inherits:** -[ProtectionBase](/plugin-functions/std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase) +[ProtectionBase](../protection/ProtectionBase.sol/abstract.ProtectionBase.md) < MC Standard Function > +**Notes:** +- v0.1.0 + +- v0.1.0 + ## Functions ### initSetAdmin diff --git a/docs/04-plugin-functions/05-std/functions/protected/InitSetAdmin.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/InitSetAdmin.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/protected/InitSetAdmin.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/InitSetAdmin.sol/index.md index f23c0bbd..01336147 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/InitSetAdmin.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/InitSetAdmin.sol/index.md @@ -1,5 +1,6 @@ -# InitSetAdmin.sol +# Index - [contract.InitSetAdmin](./contract.InitSetAdmin.md) - + + \ No newline at end of file diff --git a/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/UpgradeDictionary.sol/contract.UpgradeDictionary.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/UpgradeDictionary.sol/contract.UpgradeDictionary.md new file mode 100644 index 00000000..c738af92 --- /dev/null +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/UpgradeDictionary.sol/contract.UpgradeDictionary.md @@ -0,0 +1,24 @@ +# UpgradeDictionary +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/protected/UpgradeDictionary.sol) + +**Inherits:** +[ProtectionBase](../protection/ProtectionBase.sol/abstract.ProtectionBase.md) + +< MC Standard Function > + +**Notes:** +- 0.1.0 + +- v0.1.0 + + +## Functions +### upgradeDictionary + +DO NOT USE STORAGE DIRECTLY !!! + + +```solidity +function upgradeDictionary(address newDictionary) external onlyAdmin; +``` + diff --git a/docs/04-plugin-functions/05-std/functions/protected/UpgradeDictionary.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/UpgradeDictionary.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/protected/UpgradeDictionary.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/UpgradeDictionary.sol/index.md index 9a89834c..e5bfdc20 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/UpgradeDictionary.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/UpgradeDictionary.sol/index.md @@ -1,5 +1,6 @@ -# UpgradeDictionary.sol +# Index - [contract.UpgradeDictionary](./contract.UpgradeDictionary.md) - + + \ No newline at end of file diff --git a/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/index.md new file mode 100644 index 00000000..b61f8b43 --- /dev/null +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/index.md @@ -0,0 +1,8 @@ +# Protected Functions + + +- [protection](./protection/index.md) +- [FeatureToggle](./FeatureToggle.sol/contract.FeatureToggle.md) +- [InitSetAdmin](./InitSetAdmin.sol/contract.InitSetAdmin.md) +- [UpgradeDictionary](./UpgradeDictionary.sol/contract.UpgradeDictionary.md) + diff --git a/docs/04-plugin-functions/05-std/functions/protected/protection/FeatureToggle.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/FeatureToggle.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/protected/protection/FeatureToggle.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/FeatureToggle.sol/index.md index 883075ed..18b56a38 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/protection/FeatureToggle.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/FeatureToggle.sol/index.md @@ -1,5 +1,6 @@ -# FeatureToggle.sol +# Index - [library.FeatureToggle](./library.FeatureToggle.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/functions/protected/protection/FeatureToggle.sol/library.FeatureToggle.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/FeatureToggle.sol/library.FeatureToggle.md similarity index 54% rename from docs/04-plugin-functions/05-std/functions/protected/protection/FeatureToggle.sol/library.FeatureToggle.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/FeatureToggle.sol/library.FeatureToggle.md index 4362890d..1818a600 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/protection/FeatureToggle.sol/library.FeatureToggle.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/FeatureToggle.sol/library.FeatureToggle.md @@ -1,5 +1,5 @@ # FeatureToggle -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/protected/protection/FeatureToggle.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/protected/protection/FeatureToggle.sol) ## Functions diff --git a/docs/04-plugin-functions/05-std/functions/protected/protection/Initialization.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/Initialization.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/protected/protection/Initialization.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/Initialization.sol/index.md index a365139f..f7ae5efa 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/protection/Initialization.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/Initialization.sol/index.md @@ -1,5 +1,6 @@ -# Initialization.sol +# Index - [library.Initialization](./library.Initialization.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/functions/protected/protection/Initialization.sol/library.Initialization.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/Initialization.sol/library.Initialization.md similarity index 68% rename from docs/04-plugin-functions/05-std/functions/protected/protection/Initialization.sol/library.Initialization.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/Initialization.sol/library.Initialization.md index 4bffd9eb..64e59cdd 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/protection/Initialization.sol/library.Initialization.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/Initialization.sol/library.Initialization.md @@ -1,5 +1,5 @@ # Initialization -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/protected/protection/Initialization.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/protected/protection/Initialization.sol) ## Functions diff --git a/docs/04-plugin-functions/05-std/functions/protected/protection/MsgSender.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/MsgSender.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/protected/protection/MsgSender.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/MsgSender.sol/index.md index 68149798..a449d196 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/protection/MsgSender.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/MsgSender.sol/index.md @@ -1,5 +1,6 @@ -# MsgSender.sol +# Index - [library.MsgSender](./library.MsgSender.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/functions/protected/protection/MsgSender.sol/library.MsgSender.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/MsgSender.sol/library.MsgSender.md similarity index 64% rename from docs/04-plugin-functions/05-std/functions/protected/protection/MsgSender.sol/library.MsgSender.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/MsgSender.sol/library.MsgSender.md index 8fa119ee..709a36b6 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/protection/MsgSender.sol/library.MsgSender.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/MsgSender.sol/library.MsgSender.md @@ -1,5 +1,5 @@ # MsgSender -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/protected/protection/MsgSender.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/protected/protection/MsgSender.sol) ## Functions diff --git a/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase.md new file mode 100644 index 00000000..d4fe6ca6 --- /dev/null +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase.md @@ -0,0 +1,19 @@ +# ProtectionBase +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/functions/protected/protection/ProtectionBase.sol) + + +## Functions +### initializer + + +```solidity +modifier initializer(); +``` + +### onlyAdmin + + +```solidity +modifier onlyAdmin(); +``` + diff --git a/docs/04-plugin-functions/05-std/functions/protected/protection/ProtectionBase.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/ProtectionBase.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/functions/protected/protection/ProtectionBase.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/ProtectionBase.sol/index.md index ae53664d..709fbc1c 100644 --- a/docs/04-plugin-functions/05-std/functions/protected/protection/ProtectionBase.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/ProtectionBase.sol/index.md @@ -1,5 +1,6 @@ -# ProtectionBase.sol +# Index - [abstract.ProtectionBase](./abstract.ProtectionBase.md) - + + \ No newline at end of file diff --git a/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/index.md new file mode 100644 index 00000000..680e3d8a --- /dev/null +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/functions/protected/protection/index.md @@ -0,0 +1,8 @@ +# Protection + + +- [FeatureToggle](./FeatureToggle.sol/library.FeatureToggle.md) +- [Initialization](./Initialization.sol/library.Initialization.md) +- [MsgSender](./MsgSender.sol/library.MsgSender.md) +- [ProtectionBase](./ProtectionBase.sol/abstract.ProtectionBase.md) + diff --git a/docs/04-plugin-functions/05-std/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/index.md similarity index 100% rename from docs/04-plugin-functions/05-std/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/index.md diff --git a/docs/04-plugin-functions/05-std/interfaces/IStd.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/IStd.sol/index.md similarity index 67% rename from docs/04-plugin-functions/05-std/interfaces/IStd.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/IStd.sol/index.md index caa2f685..430aa006 100644 --- a/docs/04-plugin-functions/05-std/interfaces/IStd.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/IStd.sol/index.md @@ -1,5 +1,6 @@ -# IStd.sol +# Index - [interface.IStd](./interface.IStd.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/interfaces/IStd.sol/interface.IStd.md b/site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/IStd.sol/interface.IStd.md similarity index 71% rename from docs/04-plugin-functions/05-std/interfaces/IStd.sol/interface.IStd.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/IStd.sol/interface.IStd.md index 8f0b0a99..5266adb3 100644 --- a/docs/04-plugin-functions/05-std/interfaces/IStd.sol/interface.IStd.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/IStd.sol/interface.IStd.md @@ -1,8 +1,8 @@ # IStd -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/interfaces/IStd.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/interfaces/IStd.sol) **Inherits:** -[IProxy](/resources/devkit/api-reference/Flattened.sol/interface.IProxy) +[IProxy](../../../../../../03-api/03-api-details/Flattened.sol/interface.IProxy.md) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.StdFacade.md b/site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/StdFacade.sol/contract.StdFacade.md similarity index 72% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.StdFacade.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/StdFacade.sol/contract.StdFacade.md index 37f44c17..cae160fd 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.StdFacade.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/StdFacade.sol/contract.StdFacade.md @@ -1,8 +1,8 @@ # StdFacade -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/interfaces/StdFacade.sol) **Inherits:** -[IStd](/plugin-functions/std/interfaces/IStd.sol/interface.IStd) +[IStd](../IStd.sol/interface.IStd.md) ## Functions diff --git a/docs/04-plugin-functions/05-std/interfaces/StdFacade.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/StdFacade.sol/index.md similarity index 66% rename from docs/04-plugin-functions/05-std/interfaces/StdFacade.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/StdFacade.sol/index.md index 063d4d56..02b3319f 100644 --- a/docs/04-plugin-functions/05-std/interfaces/StdFacade.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/StdFacade.sol/index.md @@ -1,5 +1,6 @@ -# StdFacade.sol +# Index - [contract.StdFacade](./contract.StdFacade.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/interfaces/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/index.md similarity index 100% rename from docs/04-plugin-functions/05-std/interfaces/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/interfaces/index.md diff --git a/docs/04-plugin-functions/05-std/storage/Schema.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/storage/Schema.sol/index.md similarity index 67% rename from docs/04-plugin-functions/05-std/storage/Schema.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/storage/Schema.sol/index.md index 0b486949..54cee2fe 100644 --- a/docs/04-plugin-functions/05-std/storage/Schema.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/storage/Schema.sol/index.md @@ -1,5 +1,6 @@ -# Schema.sol +# Index - [interface.Schema](./interface.Schema.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/storage/Schema.sol/interface.Schema.md b/site/docs/02-guides/02-development/03-std-functions/05-std/storage/Schema.sol/interface.Schema.md similarity index 76% rename from docs/04-plugin-functions/05-std/storage/Schema.sol/interface.Schema.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/storage/Schema.sol/interface.Schema.md index affb3d86..cabe647f 100644 --- a/docs/04-plugin-functions/05-std/storage/Schema.sol/interface.Schema.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/storage/Schema.sol/interface.Schema.md @@ -1,11 +1,14 @@ # Schema -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/storage/Schema.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/storage/Schema.sol) Storage Schema v0.1.0 ## Structs ### $Admin +**Note:** +erc7201:mc.std.admin + ```solidity struct $Admin { @@ -14,6 +17,9 @@ struct $Admin { ``` ### $Clone +**Note:** +erc7201:mc.std.clone + ```solidity struct $Clone { @@ -22,6 +28,9 @@ struct $Clone { ``` ### $Proposal +**Note:** +erc7201:mc.std.proposal + ```solidity struct $Proposal { @@ -65,6 +74,9 @@ struct Op { ``` ### $Member +**Note:** +erc7201:mc.std.member + ```solidity struct $Member { @@ -73,6 +85,9 @@ struct $Member { ``` ### $FeatureToggle +**Note:** +erc7201:mc.std.featureToggle + ```solidity struct $FeatureToggle { @@ -81,6 +96,9 @@ struct $FeatureToggle { ``` ### $Initialization +**Note:** +erc7201:mc.std.initializer + ```solidity struct $Initialization { diff --git a/docs/04-plugin-functions/05-std/storage/Storage.sol/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/storage/Storage.sol/index.md similarity index 65% rename from docs/04-plugin-functions/05-std/storage/Storage.sol/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/storage/Storage.sol/index.md index da9c16e4..d1a9038d 100644 --- a/docs/04-plugin-functions/05-std/storage/Storage.sol/index.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/storage/Storage.sol/index.md @@ -1,5 +1,6 @@ -# Storage.sol +# Index - [library.Storage](./library.Storage.md) - + + \ No newline at end of file diff --git a/docs/04-plugin-functions/05-std/storage/Storage.sol/library.Storage.md b/site/docs/02-guides/02-development/03-std-functions/05-std/storage/Storage.sol/library.Storage.md similarity index 83% rename from docs/04-plugin-functions/05-std/storage/Storage.sol/library.Storage.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/storage/Storage.sol/library.Storage.md index 080593c8..378d4fc1 100644 --- a/docs/04-plugin-functions/05-std/storage/Storage.sol/library.Storage.md +++ b/site/docs/02-guides/02-development/03-std-functions/05-std/storage/Storage.sol/library.Storage.md @@ -1,5 +1,5 @@ # Storage -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/storage/Storage.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/std/storage/Storage.sol) Storage Library v0.1.0 diff --git a/docs/04-plugin-functions/05-std/storage/index.md b/site/docs/02-guides/02-development/03-std-functions/05-std/storage/index.md similarity index 100% rename from docs/04-plugin-functions/05-std/storage/index.md rename to site/docs/02-guides/02-development/03-std-functions/05-std/storage/index.md diff --git a/site/docs/02-guides/02-development/03-std-functions/index.md b/site/docs/02-guides/02-development/03-std-functions/index.md new file mode 100644 index 00000000..5b3d17f3 --- /dev/null +++ b/site/docs/02-guides/02-development/03-std-functions/index.md @@ -0,0 +1,4 @@ +# Standard Functions + +comming soon + diff --git a/site/docs/02-guides/02-development/04-using-internal-library.md b/site/docs/02-guides/02-development/04-using-internal-library.md new file mode 100644 index 00000000..9797228c --- /dev/null +++ b/site/docs/02-guides/02-development/04-using-internal-library.md @@ -0,0 +1,49 @@ +--- +keywords: [internal library, data management, schema, abstract data types] +tags: [internal library, data management, schema, abstract data types] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Using Internal Library + +The Meta Contract DevKit uses a Schema-based data management system, and it is recommended to use Solidity's internal library for data operations. Conceptually, this approach is akin to handling abstract data types. + +## Overview + +Using an internal library allows for efficient data management, enhancing consistency and reusability, and improving code maintainability. + + diff --git a/site/docs/02-guides/02-development/index.md b/site/docs/02-guides/02-development/index.md new file mode 100644 index 00000000..e8c7d2dd --- /dev/null +++ b/site/docs/02-guides/02-development/index.md @@ -0,0 +1,18 @@ +--- +keywords: [best-practices, ai-tdd, internal-library] +tags: [best-practices, ai-tdd, internal-library] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Development Guide + +This section covers recommended practices and methodologies for developing with Meta Contract. These best practices are designed to improve code quality, efficiency, and maintainability. + +## Contents + +- [Useful Resources](./01-resources.md) +- [Test-Driven Development](./02-tdd.md) +- [Using Standard Functions](./03-std-functions/index.md) +- [Using Internal Libraries](./04-using-internal-library.md) diff --git a/docs/03-devops/02-deployment.md b/site/docs/02-guides/03-operations/01-deployment.md similarity index 93% rename from docs/03-devops/02-deployment.md rename to site/docs/02-guides/03-operations/01-deployment.md index aea15e03..49b2a9c2 100644 --- a/docs/03-devops/02-deployment.md +++ b/site/docs/02-guides/03-operations/01-deployment.md @@ -1,16 +1,9 @@ --- -title: "Deployment" -version: 0.1.0 -lastUpdated: 2024-09-09 -author: Meta Contract DevOps Team -scope: devops -type: guide +keywords: [deployment, smart-contracts, blockchain, foundry, metacontract] tags: [deployment, smart-contracts, blockchain, foundry, metacontract] -relatedDocs: ["01-tdd.md", "03-upgrades.md", "04-ci-cd.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-09 - description: Initial version of the deployment guide +last_update: + date: 2024-10-28 + author: Meta Contract DevOps Team --- # Deployment @@ -51,7 +44,7 @@ Use Foundry's `script` feature and mc's custom script template to create deploym // SPDX-License-Identifier: MIT pragma solidity ^0.8.24; -import {MCScript} from "@devkit/Flattened.sol"; +import {MCScript} from "@mc-devkit/Flattened.sol"; import {VotingSystemDeployer} from "script/VotingSystemDeployer.sol"; contract DeployVotingSystemScript is MCScript { diff --git a/site/docs/02-guides/03-operations/02-contract-verification.md b/site/docs/02-guides/03-operations/02-contract-verification.md new file mode 100644 index 00000000..2258b85c --- /dev/null +++ b/site/docs/02-guides/03-operations/02-contract-verification.md @@ -0,0 +1,13 @@ +--- +keywords: [contract-verification, smart-contracts, blockchain, foundry, metacontract] +tags: [contract-verification, smart-contracts, blockchain, foundry, metacontract] +last_update: + date: 2024-10-28 + author: Meta Contract DevOps Team +--- + +# Contract Verification + +This guide outlines the process of verifying Meta Contract contracts. + +Meta Contract supports Etherscan's contract verification. To utilize Etherscan's "Read as Proxy" or "Write as Proxy" features, it is necessary to use a Facade contract to register the contract's interface. diff --git a/docs/03-devops/03-upgrades.md b/site/docs/02-guides/03-operations/03-upgrades.md similarity index 94% rename from docs/03-devops/03-upgrades.md rename to site/docs/02-guides/03-operations/03-upgrades.md index 1f196041..14af3b2b 100644 --- a/docs/03-devops/03-upgrades.md +++ b/site/docs/02-guides/03-operations/03-upgrades.md @@ -1,16 +1,9 @@ --- -title: "Upgrades" -version: 0.1.0 -lastUpdated: 2024-09-09 -author: Meta Contract DevOps Team -scope: devops -type: guide +keywords: [upgrades, smart-contracts, blockchain, foundry, metacontract] tags: [upgrades, smart-contracts, blockchain, foundry, metacontract] -relatedDocs: ["01-tdd.md", "02-deployment.md", "04-ci-cd.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-09 - description: Initial version of the upgrades guide +last_update: + date: 2024-10-28 + author: Meta Contract DevOps Team --- # Upgrades @@ -76,7 +69,7 @@ Use Foundry and Meta Contract's DevKit to create and test the upgrade: } // Unit Testing - import {MCTest} from "@devkit/Flattened.sol"; + import {MCTest} from "@mc-devkit/Flattened.sol"; import {VotingSystemErrors} from "bundle/voting-system/interfaces/VotingSystemErrors.sol"; import {VotingSystemEvents} from "bundle/voting-system/interfaces/VotingSystemEvents.sol"; @@ -125,7 +118,7 @@ Use Foundry and Meta Contract's DevKit to create and test the upgrade: // SPDX-License-Identifier: MIT pragma solidity ^0.8.24; - import {MCScript} from "@devkit/Flattened.sol"; + import {MCScript} from "@mc-devkit/Flattened.sol"; import {VotingSystemUpgrader} from "script/VotingSystemUpgrader.sol"; contract UpgradeVoteToV2Script is MCScript { diff --git a/docs/03-devops/04-ci-cd.md b/site/docs/02-guides/03-operations/04-ci-cd.md similarity index 92% rename from docs/03-devops/04-ci-cd.md rename to site/docs/02-guides/03-operations/04-ci-cd.md index e6a58efb..b9fd51bb 100644 --- a/docs/03-devops/04-ci-cd.md +++ b/site/docs/02-guides/03-operations/04-ci-cd.md @@ -1,16 +1,9 @@ --- -title: "CI/CD" -version: 0.1.0 -lastUpdated: 2024-09-08 -author: Meta Contract Development Team -scope: devops -type: guide +keywords: [ci-cd, automation, testing, deployment] tags: [ci-cd, automation, testing, deployment] -relatedDocs: ["../02-testing.md", "../03-upgrades.md", "../../05-resources/02-architecture/01-erc7546.md"] -changeLog: - - version: 0.1.0 - date: 2024-09-08 - description: Initial version of the CI/CD guide for Meta Contract +last_update: + date: 2024-10-28 + author: Meta Contract DevOps Team --- # CI/CD diff --git a/site/docs/02-guides/03-operations/index.md b/site/docs/02-guides/03-operations/index.md new file mode 100644 index 00000000..7a0cfddf --- /dev/null +++ b/site/docs/02-guides/03-operations/index.md @@ -0,0 +1,18 @@ +--- +keywords: [best-practices, deployment, contract-verification, upgrades, cicd] +tags: [best-practices, deployment, contract-verification, upgrades, cicd] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Operations Guide + +This section covers recommended practices and methodologies for operating with Meta Contract. These best practices are designed to improve code quality, efficiency, and maintainability. + +## Contents + +- [Deployment](./01-deployment.md) +- [Contract Verification](./02-contract-verification.md) +- [Upgrades](./03-upgrades.md) +- [CI/CD](./04-ci-cd.md) diff --git a/site/docs/02-guides/04-middlewares/01-the-graph.md b/site/docs/02-guides/04-middlewares/01-the-graph.md new file mode 100644 index 00000000..aca88c7c --- /dev/null +++ b/site/docs/02-guides/04-middlewares/01-the-graph.md @@ -0,0 +1,15 @@ +--- +keywords: [integration, the-graph, subgraph, indexing] +tags: [integration, the-graph, subgraph, indexing] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# The Graph + +[The Graph](https://thegraph.com/) is a decentralized protocol for indexing and querying data from blockchains, starting with Ethereum. It allows developers to build and publish open APIs, called subgraphs, that applications can query using GraphQL. + +## Creating a Subgraph with Meta Contracts + +In Meta Contracts, a subgraph is created based on Bundle's events. This allows for efficient querying and indexing of event data within the blockchain ecosystem. diff --git a/site/docs/02-guides/04-middlewares/index.md b/site/docs/02-guides/04-middlewares/index.md new file mode 100644 index 00000000..8ed34665 --- /dev/null +++ b/site/docs/02-guides/04-middlewares/index.md @@ -0,0 +1,15 @@ +--- +keywords: [middleware, integration, the-graph] +tags: [middleware, integration, the-graph] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Middleware Guide + +This section provides guidance on integrating Meta Contract with various blockchain tools and services. + +## Contents + +- [The Graph](./01-the-graph.md) diff --git a/site/docs/02-guides/05-project-management/01-documentation-guidelines.md b/site/docs/02-guides/05-project-management/01-documentation-guidelines.md new file mode 100644 index 00000000..043dc7e0 --- /dev/null +++ b/site/docs/02-guides/05-project-management/01-documentation-guidelines.md @@ -0,0 +1,86 @@ +--- +keywords: [documentation, guidelines, best-practices] +tags: [documentation, guidelines, best-practices] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Documentation Guidelines + +This guide outlines the standards and best practices for creating and maintaining documentation in the Meta Contract project. + +## General Principles + +1. Write clear, concise, and accurate documentation. +2. Keep documentation up-to-date with code changes. +3. Use a consistent style and format across all documentation. +4. Write for your audience, considering their technical background. + +## File Naming Convention + +Use kebab-case for all documentation file names: + +``` +what-is-meta-contract.md +key-concepts.md +``` + +## Markdown Formatting + +1. Use ATX-style headers (`#` for h1, `##` for h2, etc.). +2. Use backticks for inline code and triple backticks for code blocks. +3. Use appropriate language identifiers for code blocks (e.g., ```solidity). +4. Use unordered lists (`-`) for most lists, and ordered lists (`1.`) when sequence matters. + +## Documentation Header + +Each documentation file should start with a metadata block followed by the document content: + +```markdown +--- +keywords: [keyword1, keyword2, keyword3] +tags: [tag1, tag2, tag3] +last_update: + date: YYYY-MM-DD + author: [Author Names] +--- + +# Document Title + +Brief description or introduction to the document content. + +[Main document content starts here] +``` + +See details in [Docusaurus Frontmatter](https://docusaurus.io/docs/create-doc#doc-front-matter). Ensure to add any necessary elements according to the Docusaurus frontmatter guidelines. + +## Code Documentation + +### Solidity + +Use [NatSpec](https://docs.soliditylang.org/en/latest/natspec-format.html) comments for all public and external functions: + +```solidity +/** + * @notice Calculates the sum of two numbers + * @param a The first number + * @param b The second number + * @return The sum of a and b + */ +function calculateSum(uint256 a, uint256 b) public pure returns (uint256) { + return a + b; +} +``` + +## Diagrams + +Use [Mermaid](https://mermaid.js.org/intro/syntax-reference.html) for creating diagrams in documentation. Include the diagram source in the Markdown file: + +```mermaid +graph TD + A[Proxy Contract] --> B{Dictionary Contract} + B --> C[Function Contract 1] + B --> D[Function Contract 2] + B --> E[Function Contract 3] +``` diff --git a/site/docs/02-guides/05-project-management/02-branching-and-release-strategy.md b/site/docs/02-guides/05-project-management/02-branching-and-release-strategy.md new file mode 100644 index 00000000..56aa738b --- /dev/null +++ b/site/docs/02-guides/05-project-management/02-branching-and-release-strategy.md @@ -0,0 +1,84 @@ +--- +sidebar_label: Branching and Release +keywords: [versioning, strategy, best-practices, release-management, branching] +tags: [versioning, strategy, best-practices, release-management, branching] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Branching and Release Strategy + +This guide outlines the branching and release management practices for the Meta Contract project using [GitHub Flow](https://docs.github.com/get-started/quickstart/github-flow) and [Semantic Versioning](https://semver.org/). + +## Basics of GitHub Flow + +- **main**: Always maintain a stable state. +- **feature branches**: Short-lived branches for new features or fixes. Created from `main` and merged back into `main` once work is complete. + +## Branch Naming Conventions + +- **Prefix**: Use an appropriate prefix to indicate the purpose of the branch. +- **Lowercase and Hyphens**: Use lowercase letters for branch names and separate words with hyphens. + +### Examples: + - `feature/user-authentication` + - `bugfix/fix-login-error` + +## Semantic Versioning (SemVer) + +Semantic Versioning follows the format `MAJOR.MINOR.PATCH`, where: + +- **MAJOR**: Incremented for incompatible API changes. +- **MINOR**: Incremented for adding functionality in a backwards-compatible manner. +- **PATCH**: Incremented for backwards-compatible bug fixes. + +## Versioning Workflow + +1. **New Feature Addition**: + - Increment the MINOR version. + - Example: From `v1.0.0` to `v1.1.0`. + +2. **Bug Fix**: + - Increment the PATCH version. + - Example: From `v1.1.0` to `v1.1.1`. + +3. **Incompatible Changes**: + - Increment the MAJOR version and reset MINOR and PATCH to zero. + - Example: From `v1.1.1` to `v2.0.0`. + +4. **Hotfix**: + - Increment the PATCH version for urgent fixes. + - Example: From `v2.0.0` to `v2.0.1`. + +## Release Process + +### Stable Releases + +1. Create a feature branch from `main` for new releases. +2. Once the release is ready, merge it back into `main` and tag with the new version number. + +### Hotfix Releases + +1. Create a hotfix branch from `main` for urgent fixes. +2. Once the hotfix is ready, merge it back into `main` and tag with the new version number. + +## Example Workflow + +```mermaid +gitGraph + commit id: "Initial commit" + commit tag: "v0.1.0" + branch feature/feature-name + commit id: "Add feature 1" + checkout main + merge feature/feature-name + branch bugfix/bug-name + commit id: "Fix bug 1" + checkout main + merge bugfix/bug-name tag: "v0.1.1" +``` + +## Conclusion + +By adopting GitHub Flow and Semantic Versioning, we maintain a clear and consistent development and release process, facilitating easier understanding of project state and changes over time. For more details, refer to [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow). diff --git a/site/docs/02-guides/05-project-management/03-coding-standards.md b/site/docs/02-guides/05-project-management/03-coding-standards.md new file mode 100644 index 00000000..9b15141f --- /dev/null +++ b/site/docs/02-guides/05-project-management/03-coding-standards.md @@ -0,0 +1,187 @@ +--- +keywords: [smart-contracts, coding-standards, solidity, best-practices] +tags: [smart-contracts, coding-standards, solidity, best-practices] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Coding Standards + +This guide outlines the coding standards and best practices for developing smart contracts in the Meta Contract project. Adhering to these standards ensures consistency, readability, and maintainability across the codebase. + +## General Guidelines + +1. Use Solidity version 0.8.24 or later. +2. Follow the official [Solidity Style Guide](https://docs.soliditylang.org/en/latest/style-guide.html) as a baseline. +3. Use `pragma solidity ^0.8.24;` at the beginning of each file. See [solidity versioning](https://docs.soliditylang.org/en/latest/installing-solidity.html#versioning) for more details. + - For production deployments, it is recommended to lock the version to avoid unexpected compatibility issues. + - For library development, using a loose version specification (e.g., `^0.8.24`) is acceptable to ensure compatibility across different projects. Ensure to define and test the compatible version range clearly. + +## Naming Conventions + +### Contracts and Libraries +- Use ***PascalCase*** + - Example: `MyContract`, `TextDAOLibrary` + +### Interfaces +- Prefix with `I` and use ***PascalCase*** + - Example: `IMyInterface`, `ITextDAO` + +### Functions +- Use ***camelCase*** + - Examples: `myFunction`, `calculateTotal` +- Prefix internal or private functions in contracts with an underscore (_). + - Examples: `_internalFunction` +- Do not prefix internal functions in libraries with an underscore. + - Examples: `Math.add` + +### Modifiers +- Use ***mixedCase*** + - Examples: `onlyOwner`, `nonReentrant` + +### Variables +- Use ***camelCase*** for function parameters, return variables, and local variables + - Prefix storage variables with `$` (Note: This is a project-specific standard to clearly distinguish storage variables.) + - Prefix local stack or memory variables with `_` + - No prefix for function parameters and return variables + - Examples: `uint256 $totalAmount`, `uint256 _localVariable`, `function myFunction(uint256 param) public returns (uint256 ret)` + +### Constants and Immutable Variables +- Use ***UPPER_CASE*** for constants and immutable variables + - Examples: `uint256 public constant MAX_SUPPLY = 1000000`, `uint256 public immutable QUORUM_PERCENTAGE = 50` + +### Errors +- Prefer custom errors over revert strings for gas efficiency and clarity. +- Use ***PascalCase*** for error names and ***camelCase*** for error parameters + - Examples: `InsufficientBalance`, `InvalidInput(uint256 value)` + +### Events +- Use ***PascalCase*** for event names and ***camelCase*** for event parameters + - Use past tense for event names to indicate that the event has occurred. + - Examples: `ProposalCreated(uint256 proposalId, address proposer)` + +### Enums +- Use ***PascalCase*** for enum name, and ***ALL_CAPS*** for values + - Example: + ```solidity + enum Color { RED, GREEN, BLUE } + ``` + +### Struct +- Use ***PascalCase*** + - Example: `struct UserInfo { ... }` + +## Code Layout + +- Use 4 spaces for indentation (not tabs). +- Maximum line length is 120 characters. +- Use double quotes for strings. +- Place the opening brace on the same line as the declaration. +- Place the closing brace on a new line. + +Example: + +```solidity +contract MyContract { + uint256 private constant MAX_VALUE = 100; + + function calculateSum(uint256 a, uint256 b) public pure returns (uint256) { + if (a >= MAX_VALUE || b >= MAX_VALUE) revert InvalidInput(a, b); + emit SumCalculated(a, b, a + b); + return a + b; + } +} +``` + +## Documentation + +- Use [NatSpec](https://docs.soliditylang.org/en/latest/natspec-format.html) comments for all public and external functions and state variables. +- Write clear and concise comments explaining complex logic. +- Keep comments up-to-date when changing code. + +Example: + +```solidity +/// @notice Calculates the sum of two numbers +/// @param a The first number +/// @param b The second number +/// @return The sum of a and b +/// @dev This function will revert if the inputs are too large +/// @dev This function emits a `SumCalculated` event with the sum of a and b +function calculateSum(uint256 a, uint256 b) public pure returns (uint256) { + // Ensure inputs are within acceptable range + if (a >= MAX_VALUE || b >= MAX_VALUE) revert InvalidInput(a, b); + emit SumCalculated(a, b, a + b); + return a + b; +} +``` + +## Security Considerations + +- Use the `Checks-Effects-Interactions` pattern to prevent reentrancy attacks. This pattern ensures that all checks are performed before any state changes, and external calls are made only after state changes are completed. +- Be cautious with `delegatecall` as it executes code in the context of the calling contract, which can lead to unexpected behavior if not properly managed. +- Use `transfer()` or `call{value: amount}()` for ETH transfers. Prefer the "withdraw" pattern over "send" to avoid issues with call stack depth and gas limits. + - **`send`**: Uses 2300 gas and returns `true` or `false`. Requires manual error handling and is generally not recommended due to its limitations. + - **`transfer`**: Also uses 2300 gas and throws an exception on failure, rolling back the transaction. It was previously recommended for its simplicity and safety, but recent gas limit changes may restrict its use. + - **`call`**: Allows using all remaining gas and returns `true` or `false`. It requires checking the return value for error handling. Due to recent gas limit changes, `call` is increasingly recommended, especially when the recipient may perform complex operations. +- Avoid using `tx.origin` for authentication as it can be manipulated by malicious contracts. Use `msg.sender` instead for reliable authentication. +- For Solidity versions < 0.8.0, use SafeMath to prevent integer overflows and underflows. For versions 0.8.0 and later, Solidity includes built-in overflow checks, making SafeMath unnecessary. +- Consider implementing a fail-safe mode to handle unexpected contract behavior, allowing for emergency stops or controlled shutdowns. +- Regularly review and test your contracts, and consider peer reviews to identify potential security vulnerabilities. + +See [Solidity Security Considerations](https://docs.soliditylang.org/en/latest/security-considerations.html) for more details. + +## Gas Optimization + +- Avoid loops with unbounded length. +- Use `memory` for read-only arrays, `storage` for modifiable state. +- Use events to store data that doesn't need to be accessed by smart contracts. +- Use custom errors instead of `revert("...")` strings for gas efficiency. + +## Testing + +- Write comprehensive unit tests for all functions. +- Use the MC DevKit for enhanced testing capabilities. +- Implement fuzzing tests for critical functions with foundry. +- Test for edge cases and boundary conditions. + +See [Test Strategy](./04-test-strategy.md) for more details. + +## Meta Contract (MC) Specific Guidelines + +- Use the `MC DevKit` for testing and scripting. +- Import the DevKit contracts (like `MCTest` or `MCScript`) from the flattened file `@mc-devkit/Flattened.sol` in order to reduce the resolution time of the compiler. +- Use the `_use` function to set up contracts and selectors for testing. +- Use proper storage management techniques to prevent storage conflicts. + - [Research on the Collisions issues between EVM Storage Layout and Upgrade Proxy Pattern](https://mirror.xyz/zer0luck.eth/-7_tRRhql4TOQp-y9GQS1jVf-ev_QmId9vTKEdbF2Hw) + +Example of MC DevKit usage in tests: + +```solidity +import {MCTest} from "@mc-devkit/Flattened.sol"; + +contract MyContractTest is MCTest { + function setUp() public { + _use(MyContract.someFunction.selector, address(new MyContract())); + } + + function test_someFunction_success() public { + // Test implementation + (bool success, ) = target.call(abi.encodeWithSelector(MyContract.someFunction.selector, arg1, arg2)); + assertTrue(success); + } +} +``` + +## Continuous Integration + +- Integrate automated testing into the CI/CD pipeline. +- Ensure all tests pass before merging changes into the main branch. +- Use static analysis tools (e.g., Slither, Mythril) as part of the CI process. + +## Conclusion + +By adhering to these coding standards, we ensure consistency, readability, and maintainability across the Meta Contract smart contracts. These standards should be followed by all contributors to the project. Regular code reviews and automated linting tools should be used to enforce these standards. + +Remember that while these guidelines are important, they should not impede productivity or innovation. Use your judgment and discuss with the team if you believe a deviation from these standards is warranted in a specific case. diff --git a/site/docs/02-guides/05-project-management/04-test-strategy.md b/site/docs/02-guides/05-project-management/04-test-strategy.md new file mode 100644 index 00000000..0cf5c67e --- /dev/null +++ b/site/docs/02-guides/05-project-management/04-test-strategy.md @@ -0,0 +1,274 @@ +--- +keywords: [smart-contracts, testing, test-strategy, solidity, best-practices] +tags: [smart-contracts, testing, test-strategy, solidity, best-practices] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Test Strategy + +This document outlines the comprehensive test strategy for the Meta Contract smart contracts. It provides guidelines for writing and maintaining tests, ensuring code quality, and optimizing gas usage. + +## Test Types + +1. Unit Tests +2. Integration Tests +3. State-Focused Integration Tests +4. Behavior-Focused Integration Tests +5. Fuzzing Tests +6. Gas Optimization Tests +7. Upgrade Tests +8. Snapshot Tests + +## Test Location + +Given the structure of the Meta Contract where functions are separated into individual files, we adopt the following test location strategy: + +1. Unit Tests: Colocated with the function implementation in the same file under the `src` directory. +2. Integration Tests: Located in separate files under the `test` directory. +3. Upgrade Tests: Located in the `test` directory, typically in a file named `UpgradeTest.sol` or similar. +4. Snapshot Tests: Incorporated into State-Focused Integration Tests or other test types as needed. + +## Test File Structure + +A typical Solidity file containing a function implementation and its unit tests should have the following structure: + +```solidity +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.24; + +import "..."; + +contract SomeFunction { + // Function implementation +} + +// Testing +import {MCTest} from "@mc-devkit/Flattened.sol"; + +contract SomeFunctionTest is MCTest { + // Unit tests +} +``` + +## Test Function Naming Convention + +Use the following format for test function names: + +``` +test_[MethodName]_[ExpectedBehavior]_[TestCondition]() +``` + +Example: +```solidity +function test_propose_success_withValidInput() public { + // Test implementation +} +``` + +## Integration Testing Strategy + +### State-Focused Integration Tests + +These tests utilize MC's State Fuzzing capabilities to test individual functions and state transitions. + +Example: + +```solidity +function test_someStateCondition() public { + Schema.Proposal storage $proposal = Storage.Deliberation().getProposal(0); + // ... perform state modifications and assertions +} +``` + +### Behavior-Focused Integration Tests + +These tests simulate end-to-end flows and specific use cases of the TextDAO system from an end-user perspective. + +Example: + +```solidity +function test_fullProposalLifecycle() public { + uint256 proposalId = textDAO.propose("Test Proposal", new Schema.Action[](0)); + textDAO.vote(proposalId, someVote); + // ... other interactions and assertions +} +``` + +## Fuzzing Tests + +For fuzz tests, include "Random" in the name and describe the varying input: + +```solidity +function test_vote_success_withRandomVoteValues(uint8 rnd_headerChoice, uint8 rnd_commandChoice) public { + // Implement test with random inputs +} +``` + +## Gas Optimization Testing + +Include gas usage checks for potentially heavy operations: + +```solidity +function test_heavyOperation_gasUsage(uint256 inputSize) public { + vm.assume(inputSize > 0 && inputSize <= 1000); + + uint256 gasStart = gasleft(); + // Perform the heavy operation + uint256 gasUsed = gasStart - gasleft(); + + uint256 expectedMaxGas = inputSize * 5000; // Adjust based on operation complexity + assertLt(gasUsed, expectedMaxGas, "Gas usage exceeds expected maximum"); +} +``` + +## Upgrade Tests + +Ensure that contract upgrades maintain expected functionality: + +1. Test the upgrade process itself +2. Verify that existing state is preserved after an upgrade +3. Test new functionality introduced in the upgrade +4. Ensure that existing functionality continues to work as expected post-upgrade + +Example: + +```solidity +function testUpgrade() public { + // Set up initial state + // ... + + // Perform upgrade + textDAO.upgrade(newImplementationAddress); + + // Verify state preservation + // ... + + // Test new functionality + // ... + + // Verify existing functionality + // ... +} +``` + +## Snapshot Tests + +Use Foundry's snapshot feature to capture and verify the state of the system at specific points: + +```solidity +function testSnapshot() public { + // Initial setup + textDAO.propose("Test Proposal", new Schema.Action[](0)); + + uint256 snapshotId = vm.snapshot(); + + // Modify state + textDAO.vote(0, someVote); + textDAO.tally(0); + + // Verify changed state + // ... assertions ... + + // Revert to snapshot + vm.revertTo(snapshotId); + + // Verify reverted state + // ... assertions ... +} +``` + +## Best Practices + +1. Use descriptive test names that clearly indicate what is being tested. +2. Write both positive and negative test cases. +3. Use mock contracts when testing interactions with external contracts. +4. Leverage MC DevKit's capabilities for state management and testing. +5. Keep tests independent and idempotent. +6. Use setup functions to initialize common test scenarios. + +## Assertion Best Practices + +1. Use specific assertion messages to provide clear feedback on test failures. +2. Prefer equality assertions (`assertEq`) over boolean assertions when possible. +3. Use fuzzing to test with a wide range of inputs. + +Example: + +```solidity +function test_calculateScore_success(uint256 votes) public { + vm.assume(votes > 0 && votes <= 1000000); + uint256 expectedScore = votes * 2; + uint256 actualScore = textDAO.calculateScore(votes); + assertEq(actualScore, expectedScore, "Score calculation incorrect"); +} +``` + +## Code Coverage + +Aim for high code coverage, but remember that coverage alone doesn't guarantee comprehensive testing: + +1. Use Foundry's coverage reports to identify untested code paths. +2. Aim for 100% coverage of critical contract logic. +3. Write tests that cover edge cases and boundary conditions. + +## Continuous Integration + +Integrate testing into the CI/CD pipeline: + +1. Run all tests as part of the CI process. +2. Include gas usage checks in CI to catch performance regressions. +3. Use static analysis tools (e.g., Slither) in conjunction with tests. + +## Test Maintenance + +1. Review and update tests when contract logic changes. +2. Regularly run the full test suite to catch regressions. +3. Refactor tests as needed to improve clarity and reduce duplication. + +## MC DevKit Specific Testing + +Leverage MC DevKit's features for enhanced testing: + +1. Use State Fuzzing for comprehensive state testing. +2. Utilize MC DevKit's storage management utilities in tests. +3. Implement custom state generators for complex scenarios. + +Example: + +```solidity +function test_complexScenario_withCustomState() public { + Schema.Deliberation memory delib = generateCustomDeliberation(); + // ... use the custom state in your test +} + +function generateCustomDeliberation() internal returns (Schema.Deliberation memory) { + // Generate and return a custom Deliberation state +} +``` + +## Security-Focused Testing + +1. Implement specific tests for known vulnerabilities (e.g., reentrancy, integer overflow). +2. Use symbolic execution tools to identify potential security issues. +3. Test access control and permission systems thoroughly. + +## Performance Testing + +For critical operations, include performance tests: + +1. Measure execution time and resource usage. +2. Set performance benchmarks and ensure they are met in each release. +3. Test performance under various network conditions and gas prices. + +## Documentation + +1. Include inline comments explaining the purpose and setup of complex tests. +2. Maintain a separate document describing the overall test strategy and any test-specific setup required. + +## Conclusion + +This test strategy provides a comprehensive approach to ensuring the quality, security, and performance of the TextDAO smart contracts. By following these guidelines and leveraging the power of MC DevKit and Foundry, developers can create robust and reliable tests that contribute to the overall stability of the TextDAO ecosystem. + +Remember that testing is an ongoing process. As new features are added and the system evolves, the test suite should be continuously updated and expanded to maintain comprehensive coverage. diff --git a/site/docs/02-guides/05-project-management/index.md b/site/docs/02-guides/05-project-management/index.md new file mode 100644 index 00000000..c5d1d1cc --- /dev/null +++ b/site/docs/02-guides/05-project-management/index.md @@ -0,0 +1,33 @@ +--- +keywords: [documentation, versioning, changelog] +tags: [documentation, versioning, changelog] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team +--- + +# Project Management Guide + +This section covers guidelines and best practices for managing the Meta Contract project, including documentation standards and version control. + +## Community Profile + +Documentations for the [GitHub Community Standards](https://github.com/metacontract/mc/community) to interact with the community. + +- [README](https://github.com/metacontract/mc/blob/main/README.md) - Overview of the project. +- [Code of Conduct](https://github.com/metacontract/mc/blob/main/CODE_OF_CONDUCT.md) - Guidelines for community behavior. +- [Contributing Guidelines](https://github.com/metacontract/mc/blob/main/CONTRIBUTING.md) - How to contribute to the project. +- [License](https://github.com/metacontract/mc/blob/main/LICENSE) - Licensing information. +- [Security Policy](https://github.com/metacontract/mc/blob/main/SECURITY.md) - Security practices and reporting. +- [Issue Templates](https://github.com/metacontract/mc/tree/main/.github/ISSUE_TEMPLATE) - Templates for reporting issues. +- [Pull Request Templates](https://github.com/metacontract/mc/tree/main/.github/PULL_REQUEST_TEMPLATE) - Templates for submitting pull requests. + +## Project Documentation + +Documentations for the standards for Meta Contract project. + +- [Documentation Guidelines](./01-documentation-guidelines.md) - Standards for documentation. +- [Branching and Release Strategy](./02-branching-and-release-strategy.md) - Guidelines for branch management. +- [Coding Standards](./03-coding-standards.md) - Standards for coding. +- [Test Strategy](./04-test-strategy.md) - Guidelines for testing. +- [Changelog](https://github.com/metacontract/mc/blob/main/CHANGELOG.md) - Record of all notable changes. diff --git a/site/docs/02-guides/index.md b/site/docs/02-guides/index.md new file mode 100644 index 00000000..53b5d91d --- /dev/null +++ b/site/docs/02-guides/index.md @@ -0,0 +1,32 @@ +--- +keywords: [devops, TDD, implementation, deployment, upgrades, ci-cd, foundry] +tags: [devops, TDD, implementation, deployment, upgrades, ci-cd, foundry] +last_update: + date: 2024-10-28 + author: Meta Contract DevOps Team +--- + +# Guides + +This section outlines key DevOps processes and tools for Meta Contract projects, ensuring reliable, secure, and efficient smart contract development and operations. + +## Contents + +1. **[Setup](./01-setup/index.md)**: Setup overview. + - Installation + - Configuration +2. **[Development](./02-development/index.md)**: Development best practices. + - Resources + - TDD + - Functions + - Libraries +3. **[Operations](./03-operations/index.md)**: Deployment strategies. + - Deployment + - Contract Verification + - Upgrade + - CI/CD +4. **[Middleware](./04-middlewares/index.md)**: Middleware tools. + - The Graph +5. **[Project Management](./05-project-management/index.md)**: Management guidelines. + - Community Profile + - Project Documentations diff --git a/docs/05-resources/03-devkit/01-overview.md b/site/docs/03-api/01-overview.md similarity index 52% rename from docs/05-resources/03-devkit/01-overview.md rename to site/docs/03-api/01-overview.md index 07a17c7d..e26338a0 100644 --- a/docs/05-resources/03-devkit/01-overview.md +++ b/site/docs/03-api/01-overview.md @@ -1,11 +1,9 @@ --- -title: "Overview" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: development -type: overview +keywords: [devkit, overview, features] tags: [devkit, overview, features] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team --- # Overview @@ -14,11 +12,11 @@ The Meta Contract DevKit is a comprehensive suite of tools and libraries designe ## Key Features -1. **Scripting Utilities**: Facilitates deployment scripts and interaction sequences with built-in transaction broadcasting capabilities. +1. **Testing Helpers**: Provides a set of functions and modifiers to simulate various scenarios and streamline the testing process. -2. **Testing Helpers**: Provides a set of functions and modifiers to simulate various scenarios and streamline the testing process. +2. **Scripting Utilities**: Facilitates deployment and upgrade scripts and interaction sequences with built-in transaction broadcasting capabilities. -3. **Object Lifecycle Management**: Offers a robust system for managing the states and transitions of core Meta Contract objects (Function, Bundle, Proxy, Dictionary). +3. **Object Lifecycle Management**: Offers a robust system for managing the states and transitions of core Meta Contract objects (Function, Bundle, Proxy, Dictionary) to efficiently handle the core architecture known as UCS. 4. **Integration with Foundry**: Seamlessly integrates with the Foundry development environment, enhancing its capabilities for Meta Contract development. @@ -26,17 +24,14 @@ The Meta Contract DevKit is a comprehensive suite of tools and libraries designe ## Components -The DevKit consists of several key components: +The DevKit consists of two base contracts: -- **MCScript**: A base contract for deployment and interaction scripts. -- **MCTest**: A base contract for writing and running tests. -- **Core Libraries**: A collection of libraries for managing Meta Contract objects and their lifecycles. -- **Utility Functions**: Helper functions for common tasks in Meta Contract development. +- **MCTest**: A base contract for writing and running tests. Within contracts that inherit from MCTest, you can utilize the primary object `mc` for various testing functionalities. -## Getting Started +- **MCScript**: A base contract for deployment and interaction scripts. Contracts inheriting from MCScript can also use the primary object `mc` to facilitate deployment and interaction processes. -To start using the Meta Contract DevKit, refer to the [Usage Guide](./02-usage.md) for detailed instructions on installation, setup, and basic usage patterns. +## How to Use -For a deep dive into the API and available functions, check out the [API Reference](./03-api-reference/index.md). +To start using the Meta Contract DevKit, refer to the [Usage Guide](./02-usage.md) for detailed instructions on installation, setup, and basic usage patterns. -The Meta Contract DevKit is designed to empower developers to build, test, and deploy Meta Contracts with ease and efficiency. Whether you're new to Meta Contracts or an experienced developer, the DevKit provides the tools you need to streamline your workflow and focus on creating innovative smart contract solutions. +For a deep dive into the API and available functions, check out the [DevKit API Details](./03-api-details/index.md). diff --git a/docs/05-resources/03-devkit/02-usage.md b/site/docs/03-api/02-usage.md similarity index 66% rename from docs/05-resources/03-devkit/02-usage.md rename to site/docs/03-api/02-usage.md index 8be8de4f..5d49d19f 100644 --- a/docs/05-resources/03-devkit/02-usage.md +++ b/site/docs/03-api/02-usage.md @@ -1,37 +1,65 @@ --- -title: "Usage" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: development -type: guide -tags: [devkit, usage, scripting, testing] +keywords: [devkit, usage, scripting, testing, UCS] +tags: [devkit, usage, scripting, testing, UCS] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team --- -# Usage +# Usage Guide This guide provides an overview of key functions and modifiers in the Meta Contract DevKit, focusing on their usage in scripting and testing scenarios. -## Scripting +## Primary Object -When writing deployment or interaction scripts, you'll typically use the `MCScript` base contract. Here's a key modifier you'll often use: +The primary object `mc` is available in both `MCTest` and `MCScript` base contracts. It provides a set of functions and modifiers for testing and scripting. -### startBroadcastWithDeployerPrivKey +### mc.init -This modifier is used in scripting to broadcast transactions using the deployer's private key. +This function initializes the **bundle** with a given name, which is a set of functions acting as a proxy for the current meta contract. It prepares the bundle for use in both testing and scripting scenarios. -```solidity -modifier startBroadcastWithDeployerPrivKey(); -``` +- Example usage: + ```solidity + function setUp() public { + mc.init("MyBundle"); + } + ``` -**Example:** -```solidity -function run() public startBroadcastWithDeployerPrivKey { - // Deployment script logic here -} -``` +### mc.use + +This function sets the **function** with a given name, selector and address to be used for the current bundle. + +- Example usage: + ```solidity + function setUp() public { + mc.use("MyFunctionA", MyFunctionA.myFunctionA.selector, address(new MyFunctionA())); + mc.use("MyFunctionB", MyFunctionB.myFunctionB.selector, address(new MyFunctionB())); + } + ``` + +### mc.deploy + +This function deploys all contracts (including the bundled functions, dictionary and proxy) with a given init bytecode. + +- Example usage: + ```solidity + function setUp() public { + mc.deploy(abi.encodeCall(Initialize.initialize, (params1, params2))); + } + ``` + +### mc.toProxyAddress + +This function returns the address of the proxy contract. -## Testing +- Example usage: + ```solidity + function setUp() public { + address myMetaContract = mc.toProxyAddress(); + } + ``` + +## For Testing For writing tests, you'll use the `MCTest` base contract. Here are some key functions and modifiers: @@ -76,9 +104,28 @@ function ignorePrecompiles(address target) internal; ignorePrecompiles(dictionary); ``` +## For Scripting + +When writing deployment or interaction scripts, you'll typically use the `MCScript` base contract. Here's a key modifier you'll often use: + +### startBroadcastWithDeployerPrivKey + +This modifier is used in scripting to broadcast transactions using the deployer's private key. + +```solidity +modifier startBroadcastWithDeployerPrivKey(); +``` + +**Example:** +```solidity +function run() public startBroadcastWithDeployerPrivKey { + // Deployment script logic here +} +``` + ## Object Lifecycle Management -The DevKit provides a robust system for managing the lifecycle of core Meta Contract objects (Function, Bundle, Proxy, Dictionary). This system uses state transitions to ensure the integrity and proper usage of these objects. +The DevKit provides a system for managing the lifecycle of core Meta Contract objects (Function, Bundle, Proxy, Dictionary) to efficiently handle the core architecture known as UCS. ### Core Objects - Function @@ -137,8 +184,8 @@ stateDiagram-v2 ## Best Practices -1. Always use the appropriate base contract (`MCScript` for scripting, `MCTest` for testing) to ensure access to all relevant DevKit features. +1. Always use the appropriate base contract (`MCTest` for testing, `MCScript` for scripting) to ensure access to all relevant DevKit features. 2. Leverage the object lifecycle management system to maintain the integrity of your Meta Contract objects throughout their usage. 3. Use the provided modifiers and functions to simulate different scenarios in your tests, ensuring comprehensive coverage of your contract's behavior. -For more advanced usage patterns and detailed API documentation, refer to the [API Reference](./03-api-reference/index.md) section. +For more advanced usage patterns and detailed API documentation, refer to the [DevKit API Details](./03-api-details/index.md) section. diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.CommonBase.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.CommonBase.md similarity index 90% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.CommonBase.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.CommonBase.md index dc868a32..a0917dd9 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.CommonBase.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.CommonBase.md @@ -1,5 +1,5 @@ # CommonBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Context.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Context.md similarity index 85% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Context.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.Context.md index c56bf967..7fe313d3 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Context.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Context.md @@ -1,5 +1,5 @@ # Context -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *Provides information about the current execution context, including the sender of the transaction and its data. While these are generally available diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.DictionaryBase.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.DictionaryBase.md similarity index 83% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.DictionaryBase.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.DictionaryBase.md index 291071ab..21ac8b70 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.DictionaryBase.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.DictionaryBase.md @@ -1,8 +1,8 @@ # DictionaryBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IDictionaryCore](/resources/devkit/api-reference/Flattened.sol/interface.IDictionaryCore), [IVerifiable](/resources/devkit/api-reference/Flattened.sol/interface.IVerifiable) +[IDictionaryCore](interface.IDictionaryCore.md), [IVerifiable](interface.IVerifiable.md) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/abstract.MCBase.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCBase.md similarity index 56% rename from docs/05-resources/03-devkit/03-api-reference/MCBase.sol/abstract.MCBase.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.MCBase.md index 3a463b06..8905ebc8 100644 --- a/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/abstract.MCBase.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCBase.md @@ -1,8 +1,8 @@ # MCBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/MCBase.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[CommonBase](/resources/devkit/api-reference/Flattened.sol/abstract.CommonBase) +[CommonBase](abstract.CommonBase.md) ## State Variables diff --git a/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCScript.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCScript.md new file mode 100644 index 00000000..b65e0d3e --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCScript.md @@ -0,0 +1,15 @@ +# MCScript +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[MCScriptBase](abstract.MCScriptBase.md) + + +## Functions +### _saveAddrToEnv + + +```solidity +function _saveAddrToEnv(address addr, string memory envKeyBase) internal; +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCScriptBase.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCScriptBase.md new file mode 100644 index 00000000..0c971f84 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCScriptBase.md @@ -0,0 +1,15 @@ +# MCScriptBase +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[MCBase](abstract.MCBase.md), [Script](abstract.Script.md) + + +## Functions +### startBroadcastWith + + +```solidity +modifier startBroadcastWith(string memory envKey); +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/MCTest.sol/abstract.MCTest.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCTest.md similarity index 79% rename from docs/05-resources/03-devkit/03-api-reference/MCTest.sol/abstract.MCTest.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.MCTest.md index cfca93c9..b1ab01eb 100644 --- a/docs/05-resources/03-devkit/03-api-reference/MCTest.sol/abstract.MCTest.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCTest.md @@ -1,8 +1,8 @@ # MCTest -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/MCTest.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[MCTestBase](/resources/devkit/api-reference/Flattened.sol/abstract.MCTestBase), OZProxy +[MCTestBase](abstract.MCTestBase.md), [Proxy_0](abstract.Proxy_0.md) ## State Variables diff --git a/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCTestBase.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCTestBase.md new file mode 100644 index 00000000..2703c9ee --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.MCTestBase.md @@ -0,0 +1,15 @@ +# MCTestBase +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[MCBase](abstract.MCBase.md), [Test](abstract.Test.md) + + +## Functions +### startPrankWith + + +```solidity +modifier startPrankWith(string memory envKey); +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Ownable.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Ownable.md similarity index 87% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Ownable.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.Ownable.md index 2adaec01..0e7f4e27 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Ownable.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Ownable.md @@ -1,14 +1,14 @@ # Ownable -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[Context](/resources/devkit/api-reference/Flattened.sol/abstract.Context) +[Context](abstract.Context.md) *Contract module which provides a basic access control mechanism, where there is an account (an owner) that can be granted exclusive access to specific functions. The initial owner is set to the address provided by the deployer. This can -later be changed with [transferOwnership](/resources/devkit/api-reference/Flattened.sol/abstract.Ownable#transferownership). +later be changed with [transferOwnership](abstract.Ownable.md#transferownership). This module is used through inheritance. It will make available the modifier `onlyOwner`, which can be applied to your functions to restrict their use to the owner.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.ProtectionBase.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.ProtectionBase.md similarity index 51% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.ProtectionBase.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.ProtectionBase.md index 918e3c27..88755fa7 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.ProtectionBase.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.ProtectionBase.md @@ -1,5 +1,5 @@ # ProtectionBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Proxy_0.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Proxy_0.md similarity index 78% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Proxy_0.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.Proxy_0.md index c9cd96fd..582c4f30 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.Proxy_0.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Proxy_0.md @@ -1,9 +1,9 @@ # Proxy_0 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *This abstract contract provides a fallback function that delegates all calls to another contract using the EVM instruction `delegatecall`. We refer to the second contract as the _implementation_ behind the proxy, and it has to -be specified by overriding the virtual [_implementation](/resources/devkit/api-reference/Flattened.sol/abstract.Proxy_0#_implementation) function. +be specified by overriding the virtual [_implementation](abstract.Proxy_0.md#_implementation) function. Additionally, delegation to the implementation can be triggered manually through the {_fallback} function, or to a different contract through the {_delegate} function. The success and return data of the delegated call will be returned back to the caller of the proxy.* @@ -23,7 +23,7 @@ function _delegate(address implementation) internal virtual; ### _implementation *This is a virtual function that should be overridden so it returns the address to which the fallback -function and [_fallback](/resources/devkit/api-reference/Flattened.sol/abstract.Proxy_0#_fallback) should delegate.* +function and [_fallback](abstract.Proxy_0.md#_fallback) should delegate.* ```solidity diff --git a/site/docs/03-api/03-api-details/Flattened.sol/abstract.Script.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Script.md new file mode 100644 index 00000000..24ae49d4 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Script.md @@ -0,0 +1,15 @@ +# Script +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[ScriptBase](abstract.ScriptBase.md), [StdChains](abstract.StdChains.md), [StdCheatsSafe](abstract.StdCheatsSafe.md), [StdUtils](abstract.StdUtils.md) + + +## State Variables +### IS_SCRIPT + +```solidity +bool public IS_SCRIPT = true; +``` + + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/abstract.ScriptBase.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.ScriptBase.md new file mode 100644 index 00000000..ac19187c --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.ScriptBase.md @@ -0,0 +1,15 @@ +# ScriptBase +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[CommonBase](abstract.CommonBase.md) + + +## State Variables +### vmSafe + +```solidity +VmSafe internal constant vmSafe = VmSafe(VM_ADDRESS); +``` + + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdAssertions.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdAssertions.md similarity index 99% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdAssertions.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.StdAssertions.md index 9d83cc46..367b25c1 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdAssertions.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdAssertions.md @@ -1,5 +1,5 @@ # StdAssertions -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdChains.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdChains.md similarity index 96% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdChains.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.StdChains.md index 780a3d6a..c7237ac4 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdChains.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdChains.md @@ -1,5 +1,5 @@ # StdChains -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) StdChains provides information about EVM compatible chains that can be used in scripts/tests. For each chain, the chain's name, chain ID, and a default RPC URL are provided. Chains are diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdCheats.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdCheats.md similarity index 92% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdCheats.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.StdCheats.md index 08d7bc77..609b86e2 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdCheats.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdCheats.md @@ -1,8 +1,8 @@ # StdCheats -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[StdCheatsSafe](/resources/devkit/api-reference/Flattened.sol/abstract.StdCheatsSafe) +[StdCheatsSafe](abstract.StdCheatsSafe.md) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdCheatsSafe.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdCheatsSafe.md similarity index 98% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdCheatsSafe.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.StdCheatsSafe.md index c1c79b60..62f18f74 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdCheatsSafe.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdCheatsSafe.md @@ -1,5 +1,5 @@ # StdCheatsSafe -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdInvariant.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdInvariant.md similarity index 96% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdInvariant.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.StdInvariant.md index 1b88337a..37d07c47 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdInvariant.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdInvariant.md @@ -1,5 +1,5 @@ # StdInvariant -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdUtils.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdUtils.md similarity index 97% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdUtils.md rename to site/docs/03-api/03-api-details/Flattened.sol/abstract.StdUtils.md index fa17a38d..6b7730ab 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.StdUtils.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.StdUtils.md @@ -1,5 +1,5 @@ # StdUtils -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/site/docs/03-api/03-api-details/Flattened.sol/abstract.Test.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Test.md new file mode 100644 index 00000000..586a53bf --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.Test.md @@ -0,0 +1,15 @@ +# Test +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[TestBase](abstract.TestBase.md), [StdAssertions](abstract.StdAssertions.md), [StdChains](abstract.StdChains.md), [StdCheats](abstract.StdCheats.md), [StdInvariant](abstract.StdInvariant.md), [StdUtils](abstract.StdUtils.md) + + +## State Variables +### IS_TEST + +```solidity +bool public IS_TEST = true; +``` + + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/abstract.TestBase.md b/site/docs/03-api/03-api-details/Flattened.sol/abstract.TestBase.md new file mode 100644 index 00000000..fc58829b --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/abstract.TestBase.md @@ -0,0 +1,7 @@ +# TestBase +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[CommonBase](abstract.CommonBase.md) + + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/constants.Flattened.md b/site/docs/03-api/03-api-details/Flattened.sol/constants.Flattened.md similarity index 53% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/constants.Flattened.md rename to site/docs/03-api/03-api-details/Flattened.sol/constants.Flattened.md index 88aded8e..9b97ce95 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/constants.Flattened.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/constants.Flattened.md @@ -1,5 +1,5 @@ # Constants -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ### vm *address(uint160(uint256(keccak256("hevm cheat code"))));* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.BeaconDictionary.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.BeaconDictionary.md similarity index 57% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.BeaconDictionary.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.BeaconDictionary.md index 0ae03613..54410a62 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.BeaconDictionary.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.BeaconDictionary.md @@ -1,8 +1,8 @@ # BeaconDictionary -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[UpgradeableBeacon](/resources/devkit/api-reference/Flattened.sol/contract.UpgradeableBeacon) +[UpgradeableBeacon](contract.UpgradeableBeacon.md) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Clone.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.Clone.md similarity index 55% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Clone.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.Clone.md index 0890a5e6..170bde39 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Clone.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.Clone.md @@ -1,8 +1,13 @@ # Clone -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) < MC Standard Function > +**Notes:** +- v0.1.0 + +- none + ## Functions ### clone diff --git a/site/docs/03-api/03-api-details/Flattened.sol/contract.Dictionary_0.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.Dictionary_0.md new file mode 100644 index 00000000..58aebcf9 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.Dictionary_0.md @@ -0,0 +1,29 @@ +# Dictionary_0 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[DictionaryBase](abstract.DictionaryBase.md), [Ownable](abstract.Ownable.md), [IDictionary](interface.IDictionary.md) + + +## Functions +### constructor + + +```solidity +constructor(address owner) Ownable(owner); +``` + +### setImplementation + + +```solidity +function setImplementation(bytes4 selector, address implementation) external onlyOwner; +``` + +### upgradeFacade + + +```solidity +function upgradeFacade(address newFacade) external onlyOwner; +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/contract.DummyContract.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.DummyContract.md new file mode 100644 index 00000000..da894f5c --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.DummyContract.md @@ -0,0 +1,4 @@ +# DummyContract +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/contract.DummyFacade.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.DummyFacade.md new file mode 100644 index 00000000..2e2635a6 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.DummyFacade.md @@ -0,0 +1,4 @@ +# DummyFacade +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.DummyFunction.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.DummyFunction.md similarity index 50% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.DummyFunction.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.DummyFunction.md index 11350a3f..1f248752 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.DummyFunction.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.DummyFunction.md @@ -1,5 +1,5 @@ # DummyFunction -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/site/docs/03-api/03-api-details/Flattened.sol/contract.FeatureToggle.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.FeatureToggle.md new file mode 100644 index 00000000..0975d874 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.FeatureToggle.md @@ -0,0 +1,24 @@ +# FeatureToggle +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[ProtectionBase](../../../02-guides/02-development/03-std-functions/05-std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase.md) + +< MC Standard Function > + +**Notes:** +- 0.1.0 + +- v0.1.0 + + +## Functions +### featureToggle + +DO NOT USE STORAGE DIRECTLY !!! + + +```solidity +function featureToggle(bytes4 selector) external onlyAdmin; +``` + diff --git a/docs/04-plugin-functions/05-std/functions/GetFunctions.sol/contract.GetFunctions.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.GetFunctions.md similarity index 67% rename from docs/04-plugin-functions/05-std/functions/GetFunctions.sol/contract.GetFunctions.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.GetFunctions.md index 6e9e88bf..4b58f9fd 100644 --- a/docs/04-plugin-functions/05-std/functions/GetFunctions.sol/contract.GetFunctions.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.GetFunctions.md @@ -1,8 +1,13 @@ # GetFunctions -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/GetFunctions.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) < MC Standard Function > +**Notes:** +- v0.1.0 + +- none + ## Functions ### getFunctions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.ImmutableDictionary.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.ImmutableDictionary.md similarity index 67% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.ImmutableDictionary.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.ImmutableDictionary.md index 5000889d..0f696bf0 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.ImmutableDictionary.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.ImmutableDictionary.md @@ -1,8 +1,8 @@ # ImmutableDictionary -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[DictionaryBase](/resources/devkit/api-reference/Flattened.sol/abstract.DictionaryBase) +[DictionaryBase](abstract.DictionaryBase.md) ## Functions diff --git a/site/docs/03-api/03-api-details/Flattened.sol/contract.InitSetAdmin.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.InitSetAdmin.md new file mode 100644 index 00000000..8f20855f --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.InitSetAdmin.md @@ -0,0 +1,31 @@ +# InitSetAdmin +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[ProtectionBase](../../../02-guides/02-development/03-std-functions/05-std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase.md) + +< MC Standard Function > + +**Notes:** +- v0.1.0 + +- v0.1.0 + + +## Functions +### initSetAdmin + + +```solidity +function initSetAdmin(address admin) external initializer; +``` + +## Events +### AdminSet +DO NOT USE STORAGE DIRECTLY !!! + + +```solidity +event AdminSet(address admin); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/contract.MockDictionary.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.MockDictionary.md new file mode 100644 index 00000000..5209b312 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.MockDictionary.md @@ -0,0 +1,15 @@ +# MockDictionary +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[Dictionary_0](contract.Dictionary_0.md) + + +## Functions +### constructor + + +```solidity +constructor(address owner, Function[] memory functions) Dictionary_0(owner); +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.MockERC20.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.MockERC20.md similarity index 94% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.MockERC20.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.MockERC20.md index 616a9c0e..3a7dc64d 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.MockERC20.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.MockERC20.md @@ -1,8 +1,8 @@ # MockERC20 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IERC20](/resources/devkit/api-reference/Flattened.sol/interface.IERC20) +[IERC20](interface.IERC20.md) This is a mock contract of the ERC20 standard for testing purposes only, it SHOULD NOT be used in production. diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.MockERC721.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.MockERC721.md similarity index 93% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.MockERC721.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.MockERC721.md index ce6bd81e..a1d53e03 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.MockERC721.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.MockERC721.md @@ -1,8 +1,8 @@ # MockERC721 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IERC721Metadata](/resources/devkit/api-reference/Flattened.sol/interface.IERC721Metadata) +[IERC721Metadata](interface.IERC721Metadata.md) This is a mock contract of the ERC721 standard for testing purposes only, it SHOULD NOT be used in production. diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Proxy_1.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.Proxy_1.md similarity index 63% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Proxy_1.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.Proxy_1.md index fc651a4d..1d608694 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.Proxy_1.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.Proxy_1.md @@ -1,8 +1,8 @@ # Proxy_1 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[Proxy_0](/resources/devkit/api-reference/Flattened.sol/abstract.Proxy_0) +[Proxy_0](abstract.Proxy_0.md) *Library version has been tested with version 5.0.0.* diff --git a/docs/04-plugin-functions/05-std/functions/Receive.sol/contract.Receive.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.Receive.md similarity index 60% rename from docs/04-plugin-functions/05-std/functions/Receive.sol/contract.Receive.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.Receive.md index 16919c89..ed8418bf 100644 --- a/docs/04-plugin-functions/05-std/functions/Receive.sol/contract.Receive.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.Receive.md @@ -1,8 +1,13 @@ # Receive -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/functions/Receive.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) < MC Standard Function > +**Notes:** +- v0.1.0 + +- none + ## Functions ### receive diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.SimpleMockProxy.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.SimpleMockProxy.md similarity index 52% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.SimpleMockProxy.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.SimpleMockProxy.md index f2865327..fbe706c1 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.SimpleMockProxy.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.SimpleMockProxy.md @@ -1,8 +1,8 @@ # SimpleMockProxy -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[Proxy_0](/resources/devkit/api-reference/Flattened.sol/abstract.Proxy_0) +[Proxy_0](abstract.Proxy_0.md) ## Functions diff --git a/docs/04-plugin-functions/05-std/interfaces/StdFacade.sol/contract.StdFacade.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.StdFacade.md similarity index 70% rename from docs/04-plugin-functions/05-std/interfaces/StdFacade.sol/contract.StdFacade.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.StdFacade.md index 331085e7..eb0405bc 100644 --- a/docs/04-plugin-functions/05-std/interfaces/StdFacade.sol/contract.StdFacade.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.StdFacade.md @@ -1,8 +1,8 @@ # StdFacade -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/plugin-functions/std/interfaces/StdFacade.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IStd](/plugin-functions/std/interfaces/IStd.sol/interface.IStd) +[IStd](../../../02-guides/02-development/03-std-functions/05-std/interfaces/IStd.sol/interface.IStd.md) ## Functions diff --git a/site/docs/03-api/03-api-details/Flattened.sol/contract.UpgradeDictionary.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.UpgradeDictionary.md new file mode 100644 index 00000000..f85531b1 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.UpgradeDictionary.md @@ -0,0 +1,24 @@ +# UpgradeDictionary +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +**Inherits:** +[ProtectionBase](../../../02-guides/02-development/03-std-functions/05-std/functions/protected/protection/ProtectionBase.sol/abstract.ProtectionBase.md) + +< MC Standard Function > + +**Notes:** +- 0.1.0 + +- v0.1.0 + + +## Functions +### upgradeDictionary + +DO NOT USE STORAGE DIRECTLY !!! + + +```solidity +function upgradeDictionary(address newDictionary) external onlyAdmin; +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.UpgradeableBeacon.md b/site/docs/03-api/03-api-details/Flattened.sol/contract.UpgradeableBeacon.md similarity index 80% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.UpgradeableBeacon.md rename to site/docs/03-api/03-api-details/Flattened.sol/contract.UpgradeableBeacon.md index cb469ddf..a6da09a0 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/contract.UpgradeableBeacon.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/contract.UpgradeableBeacon.md @@ -1,8 +1,8 @@ # UpgradeableBeacon -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IBeacon](/resources/devkit/api-reference/Flattened.sol/interface.IBeacon), [Ownable](/resources/devkit/api-reference/Flattened.sol/abstract.Ownable) +[IBeacon](interface.IBeacon.md), [Ownable](abstract.Ownable.md) *This contract is used in conjunction with one or more instances of {BeaconProxy} to determine their implementation contract, which is where they will delegate all function calls. @@ -39,7 +39,7 @@ function implementation() public view virtual returns (address); ### upgradeTo *Upgrades the beacon to a new implementation. -Emits an [Upgraded](/resources/devkit/api-reference/Flattened.sol/contract.UpgradeableBeacon#upgraded) event. +Emits an [Upgraded](contract.UpgradeableBeacon.md#upgraded) event. Requirements: - msg.sender must be the owner of the contract. - `newImplementation` must be a contract.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/enum.DictionaryKind.md b/site/docs/03-api/03-api-details/Flattened.sol/enum.DictionaryKind.md similarity index 57% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/enum.DictionaryKind.md rename to site/docs/03-api/03-api-details/Flattened.sol/enum.DictionaryKind.md index ca394a6d..0383a1bf 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/enum.DictionaryKind.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/enum.DictionaryKind.md @@ -1,5 +1,5 @@ # DictionaryKind -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) -------------------- Dictionary Kind diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/enum.ProxyKind.md b/site/docs/03-api/03-api-details/Flattened.sol/enum.ProxyKind.md similarity index 51% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/enum.ProxyKind.md rename to site/docs/03-api/03-api-details/Flattened.sol/enum.ProxyKind.md index 1e93fee1..9d5e96ba 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/enum.ProxyKind.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/enum.ProxyKind.md @@ -1,5 +1,5 @@ # ProxyKind -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------- Proxy Kind diff --git a/site/docs/03-api/03-api-details/Flattened.sol/enum.TypeStatus.md b/site/docs/03-api/03-api-details/Flattened.sol/enum.TypeStatus.md new file mode 100644 index 00000000..91b03501 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/enum.TypeStatus.md @@ -0,0 +1,13 @@ +# TypeStatus +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +enum TypeStatus { + Uninitialized, + Building, + Built, + Locked +} +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.loadAddressFrom.md b/site/docs/03-api/03-api-details/Flattened.sol/function.loadAddressFrom.md new file mode 100644 index 00000000..922e00f1 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.loadAddressFrom.md @@ -0,0 +1,8 @@ +# loadAddressFrom +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function loadAddressFrom(string memory envKey) view returns (address); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_0.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_0.md new file mode 100644 index 00000000..8147a3ca --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_0.md @@ -0,0 +1,8 @@ +# param_0 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_0(address addr) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_1.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_1.md new file mode 100644 index 00000000..1327a6e5 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_1.md @@ -0,0 +1,8 @@ +# param_1 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_1(address addr, bytes memory b) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_10.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_10.md new file mode 100644 index 00000000..971fa06f --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_10.md @@ -0,0 +1,8 @@ +# param_10 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_10(string memory str, bytes memory b) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_11.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_11.md new file mode 100644 index 00000000..ea96ad0b --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_11.md @@ -0,0 +1,8 @@ +# param_11 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_11(Dictionary_1 memory dict) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_12.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_12.md new file mode 100644 index 00000000..348108c8 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_12.md @@ -0,0 +1,8 @@ +# param_12 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_12(bytes4 b4) pure returns (string memory); +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_13.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_13.md similarity index 50% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_13.md rename to site/docs/03-api/03-api-details/Flattened.sol/function.param_13.md index 2ed93ebb..43e5dcab 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/function.param_13.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_13.md @@ -1,5 +1,5 @@ # param_13 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ```solidity diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_14.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_14.md new file mode 100644 index 00000000..8b9b7923 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_14.md @@ -0,0 +1,8 @@ +# param_14 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_14(string memory str, Dictionary_1 memory dictionary) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_15.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_15.md new file mode 100644 index 00000000..dfdfcf28 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_15.md @@ -0,0 +1,8 @@ +# param_15 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_15(address addr, string memory str) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_16.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_16.md new file mode 100644 index 00000000..2270de5c --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_16.md @@ -0,0 +1,8 @@ +# param_16 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_16(Dictionary_1 memory dict, address addr) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_17.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_17.md new file mode 100644 index 00000000..db84e385 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_17.md @@ -0,0 +1,8 @@ +# param_17 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_17(Dictionary_1 memory dict, bytes4 b4, address addr) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_18.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_18.md new file mode 100644 index 00000000..54b32478 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_18.md @@ -0,0 +1,8 @@ +# param_18 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_18(Function[] memory functions) pure returns (string memory res); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_19.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_19.md new file mode 100644 index 00000000..6f95df19 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_19.md @@ -0,0 +1,8 @@ +# param_19 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_19(Bundle memory bundle, address addr, bytes memory b) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_2.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_2.md new file mode 100644 index 00000000..31451edc --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_2.md @@ -0,0 +1,8 @@ +# param_2 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_2(Dictionary_1 memory dict, bytes memory b) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_20.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_20.md new file mode 100644 index 00000000..7fe3c4f0 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_20.md @@ -0,0 +1,8 @@ +# param_20 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_20(string memory str, bytes4 b4, address addr) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_21.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_21.md new file mode 100644 index 00000000..f9debc47 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_21.md @@ -0,0 +1,8 @@ +# param_21 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_21(string memory str, Proxy_2 memory proxy) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_22.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_22.md new file mode 100644 index 00000000..8887b024 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_22.md @@ -0,0 +1,8 @@ +# param_22 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_22(string memory str, Function[] memory funcs) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_23.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_23.md new file mode 100644 index 00000000..51477d44 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_23.md @@ -0,0 +1,8 @@ +# param_23 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_23(string memory str, address addr, Function[] memory funcs) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_24.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_24.md new file mode 100644 index 00000000..11a5d12e --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_24.md @@ -0,0 +1,8 @@ +# param_24 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_24(bytes4 b4, address addr) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_25.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_25.md new file mode 100644 index 00000000..45f7c148 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_25.md @@ -0,0 +1,8 @@ +# param_25 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_25(Bundle memory bundle) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_26.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_26.md new file mode 100644 index 00000000..8211226a --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_26.md @@ -0,0 +1,8 @@ +# param_26 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_26(Bundle memory bundle, bytes memory b) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_27.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_27.md new file mode 100644 index 00000000..82df7bd9 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_27.md @@ -0,0 +1,10 @@ +# param_27 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +Params + + +```solidity +function param_27(string memory str) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_3.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_3.md new file mode 100644 index 00000000..5270b754 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_3.md @@ -0,0 +1,8 @@ +# param_3 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_3(Dictionary_1 memory dict1, Dictionary_1 memory dict2) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_4.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_4.md new file mode 100644 index 00000000..5ba98718 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_4.md @@ -0,0 +1,8 @@ +# param_4 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_4(bytes memory b) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_5.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_5.md new file mode 100644 index 00000000..34107fdb --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_5.md @@ -0,0 +1,8 @@ +# param_5 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_5(address addr, address addr2) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_6.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_6.md new file mode 100644 index 00000000..eff353ff --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_6.md @@ -0,0 +1,8 @@ +# param_6 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_6(Function memory func) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_7.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_7.md new file mode 100644 index 00000000..7e56822f --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_7.md @@ -0,0 +1,8 @@ +# param_7 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_7(Bundle memory bundle, address addr) pure returns (string memory); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_8.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_8.md new file mode 100644 index 00000000..9068743d --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_8.md @@ -0,0 +1,8 @@ +# param_8 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_8(Function[] memory functions, address facade) pure returns (string memory res); +``` + diff --git a/site/docs/03-api/03-api-details/Flattened.sol/function.param_9.md b/site/docs/03-api/03-api-details/Flattened.sol/function.param_9.md new file mode 100644 index 00000000..689c47b1 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/function.param_9.md @@ -0,0 +1,8 @@ +# param_9 +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +function param_9(string memory str, address addr) pure returns (string memory); +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/index.md b/site/docs/03-api/03-api-details/Flattened.sol/index.md similarity index 99% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/index.md rename to site/docs/03-api/03-api-details/Flattened.sol/index.md index cded323d..6c05f7cb 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/index.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/index.md @@ -1,163 +1,164 @@ -# Flattened.sol +# Index -- [abstract.CommonBase](./abstract.CommonBase.md) -- [abstract.Context](./abstract.Context.md) -- [abstract.DictionaryBase](./abstract.DictionaryBase.md) -- [abstract.MCBase](./abstract.MCBase.md) -- [abstract.MCScript](./abstract.MCScript.md) -- [abstract.MCScriptBase](./abstract.MCScriptBase.md) -- [abstract.MCTest](./abstract.MCTest.md) -- [abstract.MCTestBase](./abstract.MCTestBase.md) -- [abstract.Ownable](./abstract.Ownable.md) -- [abstract.ProtectionBase](./abstract.ProtectionBase.md) -- [abstract.Proxy_0](./abstract.Proxy_0.md) -- [abstract.Script](./abstract.Script.md) -- [abstract.ScriptBase](./abstract.ScriptBase.md) -- [abstract.StdAssertions](./abstract.StdAssertions.md) -- [abstract.StdChains](./abstract.StdChains.md) -- [abstract.StdCheats](./abstract.StdCheats.md) -- [abstract.StdCheatsSafe](./abstract.StdCheatsSafe.md) - [abstract.StdInvariant](./abstract.StdInvariant.md) -- [abstract.StdUtils](./abstract.StdUtils.md) -- [abstract.Test](./abstract.Test.md) -- [abstract.TestBase](./abstract.TestBase.md) +- [library.stdToml](./library.stdToml.md) +- [abstract.Ownable](./abstract.Ownable.md) +- [struct.StdRegistry](./struct.StdRegistry.md) +- [interface.IERC721TokenReceiver](./interface.IERC721TokenReceiver.md) - [constants.Flattened](./constants.Flattened.md) -- [contract.BeaconDictionary](./contract.BeaconDictionary.md) -- [contract.Clone](./contract.Clone.md) +- [function.loadAddressFrom](./function.loadAddressFrom.md) +- [function.param_25](./function.param_25.md) +- [library.Formatter](./library.Formatter.md) +- [function.param_11](./function.param_11.md) +- [library.MCInitLib](./library.MCInitLib.md) +- [library.Dummy](./library.Dummy.md) +- [abstract.CommonBase](./abstract.CommonBase.md) - [contract.Dictionary_0](./contract.Dictionary_0.md) -- [contract.DummyContract](./contract.DummyContract.md) -- [contract.DummyFacade](./contract.DummyFacade.md) -- [contract.DummyFunction](./contract.DummyFunction.md) +- [function.param_9](./function.param_9.md) - [contract.FeatureToggle](./contract.FeatureToggle.md) -- [contract.GetFunctions](./contract.GetFunctions.md) -- [contract.ImmutableDictionary](./contract.ImmutableDictionary.md) -- [contract.InitSetAdmin](./contract.InitSetAdmin.md) -- [contract.MockDictionary](./contract.MockDictionary.md) -- [contract.MockERC20](./contract.MockERC20.md) -- [contract.MockERC721](./contract.MockERC721.md) -- [contract.Proxy_1](./contract.Proxy_1.md) -- [contract.Receive](./contract.Receive.md) -- [contract.SimpleMockProxy](./contract.SimpleMockProxy.md) +- [library.Validator](./library.Validator.md) - [contract.StdFacade](./contract.StdFacade.md) -- [contract.UpgradeDictionary](./contract.UpgradeDictionary.md) -- [contract.UpgradeableBeacon](./contract.UpgradeableBeacon.md) -- [enum.DictionaryKind](./enum.DictionaryKind.md) -- [enum.ProxyKind](./enum.ProxyKind.md) -- [enum.TypeStatus](./enum.TypeStatus.md) -- [function.loadAddressFrom](./function.loadAddressFrom.md) -- [function.param_0](./function.param_0.md) -- [function.param_1](./function.param_1.md) -- [function.param_10](./function.param_10.md) -- [function.param_11](./function.param_11.md) -- [function.param_12](./function.param_12.md) -- [function.param_13](./function.param_13.md) -- [function.param_14](./function.param_14.md) +- [interface.IERC721Metadata](./interface.IERC721Metadata.md) - [function.param_15](./function.param_15.md) -- [function.param_16](./function.param_16.md) -- [function.param_17](./function.param_17.md) -- [function.param_18](./function.param_18.md) -- [function.param_19](./function.param_19.md) -- [function.param_2](./function.param_2.md) -- [function.param_20](./function.param_20.md) +- [library.MessageBody](./library.MessageBody.md) - [function.param_21](./function.param_21.md) -- [function.param_22](./function.param_22.md) -- [function.param_23](./function.param_23.md) -- [function.param_24](./function.param_24.md) -- [function.param_25](./function.param_25.md) -- [function.param_26](./function.param_26.md) -- [function.param_27](./function.param_27.md) -- [function.param_3](./function.param_3.md) -- [function.param_4](./function.param_4.md) -- [function.param_5](./function.param_5.md) -- [function.param_6](./function.param_6.md) -- [function.param_7](./function.param_7.md) +- [abstract.StdUtils](./abstract.StdUtils.md) +- [interface.IStd](./interface.IStd.md) +- [library.stdJson](./library.stdJson.md) +- [abstract.Test](./abstract.Test.md) +- [library.ConfigLib](./library.ConfigLib.md) +- [interface.IERC721Enumerable](./interface.IERC721Enumerable.md) - [function.param_8](./function.param_8.md) -- [function.param_9](./function.param_9.md) -- [interface.IBeacon](./interface.IBeacon.md) -- [interface.IDictionary](./interface.IDictionary.md) -- [interface.IDictionaryCore](./interface.IDictionaryCore.md) -- [interface.IERC165_0](./interface.IERC165_0.md) -- [interface.IERC165_1](./interface.IERC165_1.md) +- [struct.Proxy_2](./struct.Proxy_2.md) +- [library.stdStorage](./library.stdStorage.md) +- [struct.ConfigState](./struct.ConfigState.md) +- [function.param_14](./function.param_14.md) +- [struct.BundleRegistry](./struct.BundleRegistry.md) +- [abstract.ScriptBase](./abstract.ScriptBase.md) +- [function.param_20](./function.param_20.md) +- [abstract.Proxy_0](./abstract.Proxy_0.md) +- [abstract.MCScriptBase](./abstract.MCScriptBase.md) +- [library.MCDeployLib](./library.MCDeployLib.md) +- [library.StdFunctionsLib](./library.StdFunctionsLib.md) +- [struct.SystemConfig](./struct.SystemConfig.md) +- [contract.ImmutableDictionary](./contract.ImmutableDictionary.md) +- [library.Logger](./library.Logger.md) +- [function.param_24](./function.param_24.md) +- [function.param_10](./function.param_10.md) - [interface.IERC20](./interface.IERC20.md) -- [interface.IERC721](./interface.IERC721.md) -- [interface.IERC721Enumerable](./interface.IERC721Enumerable.md) -- [interface.IERC721Metadata](./interface.IERC721Metadata.md) -- [interface.IERC721TokenReceiver](./interface.IERC721TokenReceiver.md) +- [abstract.StdCheats](./abstract.StdCheats.md) - [interface.IMulticall3](./interface.IMulticall3.md) -- [interface.IProxy](./interface.IProxy.md) -- [interface.IStd](./interface.IStd.md) -- [interface.IVerifiable](./interface.IVerifiable.md) -- [interface.Schema](./interface.Schema.md) -- [interface.Vm](./interface.Vm.md) +- [abstract.MCBase](./abstract.MCBase.md) +- [library.stdMath](./library.stdMath.md) +- [function.param_7](./function.param_7.md) +- [struct.Function](./struct.Function.md) +- [contract.DummyFunction](./contract.DummyFunction.md) +- [library.Storage](./library.Storage.md) - [interface.VmSafe](./interface.VmSafe.md) -- [library.Address](./library.Address.md) -- [library.BundleLib](./library.BundleLib.md) +- [library.ProxyCreator](./library.ProxyCreator.md) - [library.BundleRegistryLib](./library.BundleRegistryLib.md) -- [library.ConfigLib](./library.ConfigLib.md) +- [function.param_3](./function.param_3.md) +- [library.Initialization](./library.Initialization.md) - [library.CurrentLib](./library.CurrentLib.md) -- [library.DictionaryLib](./library.DictionaryLib.md) -- [library.DictionaryRegistryLib](./library.DictionaryRegistryLib.md) -- [library.Dummy](./library.Dummy.md) +- [library.MCHelpers](./library.MCHelpers.md) +- [library.System](./library.System.md) +- [contract.SimpleMockProxy](./contract.SimpleMockProxy.md) +- [function.param_2](./function.param_2.md) +- [abstract.StdAssertions](./abstract.StdAssertions.md) +- [struct.Process](./struct.Process.md) +- [contract.DummyContract](./contract.DummyContract.md) +- [contract.InitSetAdmin](./contract.InitSetAdmin.md) +- [contract.DummyFacade](./contract.DummyFacade.md) +- [library.ProxyUtils](./library.ProxyUtils.md) - [library.ERC1967Utils](./library.ERC1967Utils.md) +- [library.DictionaryLib](./library.DictionaryLib.md) +- [interface.IERC721](./interface.IERC721.md) +- [struct.Dictionary_1](./struct.Dictionary_1.md) +- [library.Inspector](./library.Inspector.md) +- [abstract.StdChains](./abstract.StdChains.md) - [library.ForgeHelper](./library.ForgeHelper.md) -- [library.Formatter](./library.Formatter.md) -- [library.FunctionLib](./library.FunctionLib.md) +- [library.NameGenerator](./library.NameGenerator.md) +- [struct.Trace](./struct.Trace.md) +- [function.param_6](./function.param_6.md) +- [library.stdStorageSafe](./library.stdStorageSafe.md) +- [abstract.DictionaryBase](./abstract.DictionaryBase.md) +- [abstract.ProtectionBase](./abstract.ProtectionBase.md) +- [enum.TypeStatus](./enum.TypeStatus.md) +- [function.param_1](./function.param_1.md) +- [library.StdStyle](./library.StdStyle.md) - [library.FunctionRegistryLib](./library.FunctionRegistryLib.md) -- [library.Initialization](./library.Initialization.md) -- [library.Inspector](./library.Inspector.md) -- [library.Logger](./library.Logger.md) -- [library.MCDeployLib](./library.MCDeployLib.md) -- [library.MCFinderLib](./library.MCFinderLib.md) -- [library.MCHelpers](./library.MCHelpers.md) -- [library.MCInitLib](./library.MCInitLib.md) - [library.MCMockLib](./library.MCMockLib.md) -- [library.MessageBody](./library.MessageBody.md) +- [interface.IDictionary](./interface.IDictionary.md) +- [library.StorageSlot](./library.StorageSlot.md) +- [abstract.MCTestBase](./abstract.MCTestBase.md) +- [function.param_5](./function.param_5.md) +- [library.DictionaryRegistryLib](./library.DictionaryRegistryLib.md) +- [abstract.Context](./abstract.Context.md) +- [library.BundleLib](./library.BundleLib.md) +- [library.stdError](./library.stdError.md) +- [struct.FindData](./struct.FindData.md) +- [contract.GetFunctions](./contract.GetFunctions.md) - [library.MessageHead](./library.MessageHead.md) +- [function.param_19](./function.param_19.md) +- [abstract.MCTest](./abstract.MCTest.md) +- [struct.ProxyRegistry](./struct.ProxyRegistry.md) +- [function.param_4](./function.param_4.md) +- [interface.IProxy](./interface.IProxy.md) +- [library.Tracer](./library.Tracer.md) +- [enum.DictionaryKind](./enum.DictionaryKind.md) +- [function.param_18](./function.param_18.md) +- [function.param_0](./function.param_0.md) - [library.MsgSender](./library.MsgSender.md) -- [library.NameGenerator](./library.NameGenerator.md) +- [contract.MockERC721](./contract.MockERC721.md) +- [struct.SetupConfig](./struct.SetupConfig.md) +- [struct.Current](./struct.Current.md) +- [contract.UpgradeDictionary](./contract.UpgradeDictionary.md) +- [library.TypeGuard](./library.TypeGuard.md) +- [contract.MockDictionary](./contract.MockDictionary.md) +- [contract.BeaconDictionary](./contract.BeaconDictionary.md) +- [abstract.TestBase](./abstract.TestBase.md) +- [contract.Proxy_1](./contract.Proxy_1.md) - [library.Parser](./library.Parser.md) -- [library.ProxyCreator](./library.ProxyCreator.md) -- [library.ProxyLib](./library.ProxyLib.md) -- [library.ProxyRegistryLib](./library.ProxyRegistryLib.md) -- [library.ProxyUtils](./library.ProxyUtils.md) -- [library.SimpleMockProxyLib](./library.SimpleMockProxyLib.md) +- [contract.UpgradeableBeacon](./contract.UpgradeableBeacon.md) +- [function.param_17](./function.param_17.md) +- [struct.StdStorage](./struct.StdStorage.md) +- [function.param_23](./function.param_23.md) +- [contract.Clone](./contract.Clone.md) +- [struct.StdFunctions](./struct.StdFunctions.md) +- [struct.MCDevKit](./struct.MCDevKit.md) +- [interface.Schema](./interface.Schema.md) - [library.StdFunctionsArgs](./library.StdFunctionsArgs.md) -- [library.StdFunctionsLib](./library.StdFunctionsLib.md) +- [function.param_27](./function.param_27.md) +- [interface.IERC165_1](./interface.IERC165_1.md) +- [function.param_13](./function.param_13.md) +- [contract.MockERC20](./contract.MockERC20.md) +- [abstract.MCScript](./abstract.MCScript.md) +- [enum.ProxyKind](./enum.ProxyKind.md) +- [struct.NamingConfig](./struct.NamingConfig.md) +- [library.ProxyRegistryLib](./library.ProxyRegistryLib.md) - [library.StdRegistryLib](./library.StdRegistryLib.md) -- [library.StdStyle](./library.StdStyle.md) -- [library.Storage](./library.Storage.md) -- [library.StorageSlot](./library.StorageSlot.md) -- [library.System](./library.System.md) -- [library.Tracer](./library.Tracer.md) -- [library.TypeGuard](./library.TypeGuard.md) -- [library.Validator](./library.Validator.md) +- [function.param_26](./function.param_26.md) +- [interface.IERC165_0](./interface.IERC165_0.md) +- [library.Address](./library.Address.md) +- [function.param_12](./function.param_12.md) +- [interface.IBeacon](./interface.IBeacon.md) +- [contract.Receive](./contract.Receive.md) +- [library.SimpleMockProxyLib](./library.SimpleMockProxyLib.md) +- [library.FunctionLib](./library.FunctionLib.md) +- [abstract.Script](./abstract.Script.md) - [library.console](./library.console.md) +- [interface.IVerifiable](./interface.IVerifiable.md) +- [interface.Vm](./interface.Vm.md) - [library.safeconsole](./library.safeconsole.md) -- [library.stdError](./library.stdError.md) -- [library.stdJson](./library.stdJson.md) -- [library.stdMath](./library.stdMath.md) -- [library.stdStorage](./library.stdStorage.md) -- [library.stdStorageSafe](./library.stdStorageSafe.md) -- [library.stdToml](./library.stdToml.md) -- [struct.Bundle](./struct.Bundle.md) -- [struct.BundleRegistry](./struct.BundleRegistry.md) -- [struct.ConfigState](./struct.ConfigState.md) -- [struct.Current](./struct.Current.md) -- [struct.DictionaryRegistry](./struct.DictionaryRegistry.md) -- [struct.Dictionary_1](./struct.Dictionary_1.md) -- [struct.FindData](./struct.FindData.md) -- [struct.Function](./struct.Function.md) +- [function.param_16](./function.param_16.md) +- [library.ProxyLib](./library.ProxyLib.md) +- [abstract.StdCheatsSafe](./abstract.StdCheatsSafe.md) +- [function.param_22](./function.param_22.md) - [struct.FunctionRegistry](./struct.FunctionRegistry.md) -- [struct.MCDevKit](./struct.MCDevKit.md) -- [struct.NamingConfig](./struct.NamingConfig.md) -- [struct.Process](./struct.Process.md) -- [struct.ProxyRegistry](./struct.ProxyRegistry.md) -- [struct.Proxy_2](./struct.Proxy_2.md) -- [struct.SetupConfig](./struct.SetupConfig.md) -- [struct.StdFunctions](./struct.StdFunctions.md) -- [struct.StdRegistry](./struct.StdRegistry.md) -- [struct.StdStorage](./struct.StdStorage.md) -- [struct.SystemConfig](./struct.SystemConfig.md) -- [struct.Trace](./struct.Trace.md) - +- [struct.DictionaryRegistry](./struct.DictionaryRegistry.md) +- [struct.Bundle](./struct.Bundle.md) +- [interface.IDictionaryCore](./interface.IDictionaryCore.md) +- [library.MCFinderLib](./library.MCFinderLib.md) + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IBeacon.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IBeacon.md similarity index 69% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IBeacon.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IBeacon.md index b8994720..205300a8 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IBeacon.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IBeacon.md @@ -1,5 +1,5 @@ # IBeacon -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *This is the interface that {BeaconProxy} expects of its beacon.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IDictionary.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IDictionary.md similarity index 54% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IDictionary.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IDictionary.md index 54996716..0f016bd8 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IDictionary.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IDictionary.md @@ -1,8 +1,8 @@ # IDictionary -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IDictionaryCore](/resources/devkit/api-reference/Flattened.sol/interface.IDictionaryCore), [IVerifiable](/resources/devkit/api-reference/Flattened.sol/interface.IVerifiable) +[IDictionaryCore](interface.IDictionaryCore.md), [IVerifiable](interface.IVerifiable.md) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IDictionaryCore.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IDictionaryCore.md similarity index 82% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IDictionaryCore.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IDictionaryCore.md index 11a3a5d9..96d04c85 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IDictionaryCore.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IDictionaryCore.md @@ -1,5 +1,5 @@ # IDictionaryCore -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC165_0.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC165_0.md similarity index 81% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC165_0.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IERC165_0.md index a567a645..ac294df6 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC165_0.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC165_0.md @@ -1,5 +1,5 @@ # IERC165_0 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC165_1.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC165_1.md similarity index 82% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC165_1.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IERC165_1.md index 818395e5..2191e5bb 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC165_1.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC165_1.md @@ -1,5 +1,5 @@ # IERC165_1 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *Interface of the ERC165 standard, as defined in the https://eips.ethereum.org/EIPS/eip-165[EIP]. diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC20.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC20.md similarity index 93% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC20.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IERC20.md index f8367c73..fe095aa1 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC20.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC20.md @@ -1,5 +1,5 @@ # IERC20 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *Interface of the ERC20 standard as defined in the EIP.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721.md similarity index 96% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721.md index 39d971ba..9b862da4 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721.md @@ -1,8 +1,8 @@ # IERC721 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IERC165_0](/resources/devkit/api-reference/Flattened.sol/interface.IERC165_0) +[IERC165_0](interface.IERC165_0.md) *See https://eips.ethereum.org/EIPS/eip-721 Note: the ERC-165 identifier for this interface is 0x80ac58cd.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721Enumerable.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721Enumerable.md similarity index 88% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721Enumerable.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721Enumerable.md index 626445a7..c72372b7 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721Enumerable.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721Enumerable.md @@ -1,8 +1,8 @@ # IERC721Enumerable -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IERC721](/resources/devkit/api-reference/Flattened.sol/interface.IERC721) +[IERC721](interface.IERC721.md) *See https://eips.ethereum.org/EIPS/eip-721 Note: the ERC-165 identifier for this interface is 0x780e9d63.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721Metadata.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721Metadata.md similarity index 78% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721Metadata.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721Metadata.md index 94e816fa..a3fb19a9 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721Metadata.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721Metadata.md @@ -1,8 +1,8 @@ # IERC721Metadata -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IERC721](/resources/devkit/api-reference/Flattened.sol/interface.IERC721) +[IERC721](interface.IERC721.md) *See https://eips.ethereum.org/EIPS/eip-721 Note: the ERC-165 identifier for this interface is 0x5b5e139f.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721TokenReceiver.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721TokenReceiver.md similarity index 88% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721TokenReceiver.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721TokenReceiver.md index 680873d2..657313a6 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IERC721TokenReceiver.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IERC721TokenReceiver.md @@ -1,5 +1,5 @@ # IERC721TokenReceiver -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *Note: the ERC-165 identifier for this interface is 0x150b7a02.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IMulticall3.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IMulticall3.md similarity index 94% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IMulticall3.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IMulticall3.md index a8924382..1a7268b8 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IMulticall3.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IMulticall3.md @@ -1,5 +1,5 @@ # IMulticall3 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IProxy.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IProxy.md similarity index 65% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IProxy.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IProxy.md index 8472569e..0a2bbe8e 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IProxy.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IProxy.md @@ -1,5 +1,5 @@ # IProxy -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Events diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IStd.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IStd.md similarity index 71% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IStd.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IStd.md index 5a16fdd9..4dc62d6f 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IStd.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IStd.md @@ -1,8 +1,8 @@ # IStd -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IProxy](/resources/devkit/api-reference/Flattened.sol/interface.IProxy) +[IProxy](interface.IProxy.md) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IVerifiable.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.IVerifiable.md similarity index 52% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IVerifiable.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.IVerifiable.md index 6dab4be0..14a3d44a 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.IVerifiable.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.IVerifiable.md @@ -1,8 +1,8 @@ # IVerifiable -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[IBeacon](/resources/devkit/api-reference/Flattened.sol/interface.IBeacon), [IERC165_1](/resources/devkit/api-reference/Flattened.sol/interface.IERC165_1) +[IBeacon](interface.IBeacon.md), [IERC165_1](interface.IERC165_1.md) *Library version has been tested with version 5.0.0.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.Schema.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.Schema.md similarity index 76% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.Schema.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.Schema.md index c759cbfe..5032b795 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.Schema.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.Schema.md @@ -1,11 +1,14 @@ # Schema -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) Storage Schema v0.1.0 ## Structs ### $Admin +**Note:** +erc7201:mc.std.admin + ```solidity struct $Admin { @@ -14,6 +17,9 @@ struct $Admin { ``` ### $Clone +**Note:** +erc7201:mc.std.clone + ```solidity struct $Clone { @@ -22,6 +28,9 @@ struct $Clone { ``` ### $Proposal +**Note:** +erc7201:mc.std.proposal + ```solidity struct $Proposal { @@ -65,6 +74,9 @@ struct Op { ``` ### $Member +**Note:** +erc7201:mc.std.member + ```solidity struct $Member { @@ -73,6 +85,9 @@ struct $Member { ``` ### $FeatureToggle +**Note:** +erc7201:mc.std.featureToggle + ```solidity struct $FeatureToggle { @@ -81,6 +96,9 @@ struct $FeatureToggle { ``` ### $Initialization +**Note:** +erc7201:mc.std.initializer + ```solidity struct $Initialization { diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.Vm.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.Vm.md similarity index 98% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.Vm.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.Vm.md index c3e5288a..957bbe53 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.Vm.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.Vm.md @@ -1,8 +1,8 @@ # Vm -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Inherits:** -[VmSafe](/resources/devkit/api-reference/Flattened.sol/interface.VmSafe) +[VmSafe](interface.VmSafe.md) The `Vm` interface does allow manipulation of the EVM state. These are all intended to be used in tests, but it is not recommended to use these cheats in scripts. diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.VmSafe.md b/site/docs/03-api/03-api-details/Flattened.sol/interface.VmSafe.md similarity index 99% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.VmSafe.md rename to site/docs/03-api/03-api-details/Flattened.sol/interface.VmSafe.md index 4019f81a..6fec397f 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/interface.VmSafe.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/interface.VmSafe.md @@ -1,5 +1,5 @@ # VmSafe -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) The `VmSafe` interface does not allow manipulation of the EVM state or other actions that may result in Script simulations differing from on-chain execution. It is recommended to only use diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Address.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Address.md similarity index 75% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Address.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Address.md index d4d236a9..cb08a70b 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Address.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Address.md @@ -1,5 +1,5 @@ # Address -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *Collection of functions related to the address type* @@ -12,7 +12,7 @@ https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost of certain opcodes, possibly making contracts go over the 2300 gas limit imposed by `transfer`, making them unable to receive funds via -`transfer`. [sendValue](/resources/devkit/api-reference/Flattened.sol/library.Address#sendvalue) removes this limitation. +`transfer`. [sendValue](library.Address.md#sendvalue) removes this limitation. https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more]. IMPORTANT: because control is transferred to `recipient`, care must be taken to not create reentrancy vulnerabilities. Consider using @@ -32,7 +32,7 @@ function instead. If `target` reverts with a revert reason or custom error, it is bubbled up by this function (like regular Solidity function calls). However, if the call reverted with no returned reason, this function reverts with a -[FailedInnerCall](/resources/devkit/api-reference/Flattened.sol/library.Address#failedinnercall) error. +[FailedInnerCall](library.Address.md#failedinnercall) error. Returns the raw returned data. To convert to the expected return value, use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. Requirements: @@ -46,7 +46,7 @@ function functionCall(address target, bytes memory data) internal returns (bytes ### functionCallWithValue -*Same as [`functionCall`](/lib/ucs-contracts/lib/openzeppelin-contracts/contracts/mocks/token/ERC20Reentrant.sol/contract.ERC20Reentrant.md#functioncall), +*Same as [`functionCall`](../../../lib/ucs-contracts/lib/openzeppelin-contracts/contracts/mocks/token/ERC20Reentrant.sol/contract.ERC20Reentrant.md#functioncall), but also transferring `value` wei to `target`. Requirements: - the calling contract must have an ETH balance of at least `value`. @@ -59,7 +59,7 @@ function functionCallWithValue(address target, bytes memory data, uint256 value) ### functionStaticCall -*Same as [`functionCall`](/lib/ucs-contracts/lib/openzeppelin-contracts/contracts/mocks/token/ERC20Reentrant.sol/contract.ERC20Reentrant.md#functioncall), +*Same as [`functionCall`](../../../lib/ucs-contracts/lib/openzeppelin-contracts/contracts/mocks/token/ERC20Reentrant.sol/contract.ERC20Reentrant.md#functioncall), but performing a static call.* @@ -69,7 +69,7 @@ function functionStaticCall(address target, bytes memory data) internal view ret ### functionDelegateCall -*Same as [`functionCall`](/lib/ucs-contracts/lib/openzeppelin-contracts/contracts/mocks/token/ERC20Reentrant.sol/contract.ERC20Reentrant.md#functioncall), +*Same as [`functionCall`](../../../lib/ucs-contracts/lib/openzeppelin-contracts/contracts/mocks/token/ERC20Reentrant.sol/contract.ERC20Reentrant.md#functioncall), but performing a delegate call.* @@ -80,7 +80,7 @@ function functionDelegateCall(address target, bytes memory data) internal return ### verifyCallResultFromTarget *Tool to verify that a low level call to smart-contract was successful, and reverts if the target -was not a contract or bubbling up the revert reason (falling back to [FailedInnerCall](/resources/devkit/api-reference/Flattened.sol/library.Address#failedinnercall)) in case of an +was not a contract or bubbling up the revert reason (falling back to [FailedInnerCall](library.Address.md#failedinnercall)) in case of an unsuccessful call.* @@ -94,7 +94,7 @@ function verifyCallResultFromTarget(address target, bool success, bytes memory r ### verifyCallResult *Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the -revert reason or with a default [FailedInnerCall](/resources/devkit/api-reference/Flattened.sol/library.Address#failedinnercall) error.* +revert reason or with a default [FailedInnerCall](library.Address.md#failedinnercall) error.* ```solidity @@ -103,7 +103,7 @@ function verifyCallResult(bool success, bytes memory returndata) internal pure r ### _revert -*Reverts with returndata if present. Otherwise reverts with [FailedInnerCall](/resources/devkit/api-reference/Flattened.sol/library.Address#failedinnercall).* +*Reverts with returndata if present. Otherwise reverts with [FailedInnerCall](library.Address.md#failedinnercall).* ```solidity diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.BundleLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.BundleLib.md similarity index 84% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.BundleLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.BundleLib.md index 6a86b788..542f1c54 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.BundleLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.BundleLib.md @@ -1,5 +1,5 @@ # BundleLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.BundleRegistryLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.BundleRegistryLib.md similarity index 86% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.BundleRegistryLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.BundleRegistryLib.md index 8ae07f75..3c6c727e 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.BundleRegistryLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.BundleRegistryLib.md @@ -1,5 +1,5 @@ # BundleRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ConfigLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.ConfigLib.md similarity index 75% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ConfigLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.ConfigLib.md index 0b2fc52c..dc391e9c 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ConfigLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.ConfigLib.md @@ -1,5 +1,5 @@ # ConfigLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.CurrentLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.CurrentLib.md similarity index 79% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.CurrentLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.CurrentLib.md index b08fd7b3..64bd95fb 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.CurrentLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.CurrentLib.md @@ -1,5 +1,5 @@ # CurrentLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.DictionaryLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.DictionaryLib.md similarity index 94% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.DictionaryLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.DictionaryLib.md index a15d8925..47c97a9e 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.DictionaryLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.DictionaryLib.md @@ -1,5 +1,5 @@ # DictionaryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.DictionaryRegistryLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.DictionaryRegistryLib.md similarity index 88% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.DictionaryRegistryLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.DictionaryRegistryLib.md index 38ce1bfe..c30aec13 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.DictionaryRegistryLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.DictionaryRegistryLib.md @@ -1,5 +1,5 @@ # DictionaryRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Dummy.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Dummy.md similarity index 85% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Dummy.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Dummy.md index 57af4990..6a77d23e 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Dummy.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Dummy.md @@ -1,5 +1,5 @@ # Dummy -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ERC1967Utils.md b/site/docs/03-api/03-api-details/Flattened.sol/library.ERC1967Utils.md similarity index 87% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ERC1967Utils.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.ERC1967Utils.md index 57a3058a..e8c26513 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ERC1967Utils.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.ERC1967Utils.md @@ -1,5 +1,5 @@ # ERC1967Utils -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *This abstract contract provides getters and event emitting update functions for https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.* @@ -60,7 +60,7 @@ function _setImplementation(address newImplementation) private; *Performs implementation upgrade with additional setup call if data is nonempty. This function is payable only if the setup call is performed, otherwise `msg.value` is rejected to avoid stuck value in the contract. -Emits an [IERC1967-Upgraded](/resources/devkit/api-reference/Flattened.sol/contract.UpgradeableBeacon#upgraded) event.* +Emits an [IERC1967-Upgraded](contract.UpgradeableBeacon.md#upgraded) event.* ```solidity @@ -91,7 +91,7 @@ function _setAdmin(address newAdmin) private; ### changeAdmin *Changes the admin of the proxy. -Emits an [IERC1967-AdminChanged](/lib/ucs-contracts/lib/openzeppelin-contracts/contracts/proxy/ERC1967/ERC1967Utils.sol/library.ERC1967Utils.md#adminchanged) event.* +Emits an [IERC1967-AdminChanged](../../../lib/ucs-contracts/lib/openzeppelin-contracts/contracts/proxy/ERC1967/ERC1967Utils.sol/library.ERC1967Utils.md#adminchanged) event.* ```solidity @@ -121,7 +121,7 @@ function _setBeacon(address newBeacon) private; *Change the beacon and trigger a setup call if data is nonempty. This function is payable only if the setup call is performed, otherwise `msg.value` is rejected to avoid stuck value in the contract. -Emits an [IERC1967-BeaconUpgraded](/lib/ucs-contracts/lib/openzeppelin-contracts/contracts/proxy/ERC1967/ERC1967Utils.sol/library.ERC1967Utils.md#beaconupgraded) event. +Emits an [IERC1967-BeaconUpgraded](../../../lib/ucs-contracts/lib/openzeppelin-contracts/contracts/proxy/ERC1967/ERC1967Utils.sol/library.ERC1967Utils.md#beaconupgraded) event. CAUTION: Invoking this function has no effect on an instance of {BeaconProxy} since v5, since it uses an immutable beacon without looking at the value of the ERC-1967 beacon slot for efficiency.* diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ForgeHelper.md b/site/docs/03-api/03-api-details/Flattened.sol/library.ForgeHelper.md similarity index 94% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ForgeHelper.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.ForgeHelper.md index 348ecd16..d62eab9c 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ForgeHelper.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.ForgeHelper.md @@ -1,5 +1,5 @@ # ForgeHelper -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) 🛠 Helper Methods for Forge Std diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Formatter.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Formatter.md similarity index 96% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Formatter.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Formatter.md index 8d0b5ed7..c4cc84ec 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Formatter.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Formatter.md @@ -1,5 +1,5 @@ # Formatter -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ================== 🗒️ Formatter diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.FunctionLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.FunctionLib.md similarity index 88% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.FunctionLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.FunctionLib.md index 0a0b3311..89a925a9 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.FunctionLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.FunctionLib.md @@ -1,5 +1,5 @@ # FunctionLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.FunctionRegistryLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.FunctionRegistryLib.md similarity index 82% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.FunctionRegistryLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.FunctionRegistryLib.md index bda12214..43fb430c 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.FunctionRegistryLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.FunctionRegistryLib.md @@ -1,5 +1,5 @@ # FunctionRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Initialization.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Initialization.md similarity index 72% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Initialization.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Initialization.md index b7235b60..bd71d2a6 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Initialization.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Initialization.md @@ -1,5 +1,5 @@ # Initialization -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Inspector.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Inspector.md similarity index 97% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Inspector.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Inspector.md index 484f20e2..df6bd247 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Inspector.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Inspector.md @@ -1,5 +1,5 @@ # Inspector -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) =================== 🕵️‍♀️ Inspector diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Logger.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Logger.md similarity index 93% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Logger.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Logger.md index 85ca960e..2c289aab 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Logger.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Logger.md @@ -1,5 +1,5 @@ # Logger -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) =============== 📊 Logger diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCDeployLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.MCDeployLib.md similarity index 96% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCDeployLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.MCDeployLib.md index 68a57f11..a0035bd4 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCDeployLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.MCDeployLib.md @@ -1,5 +1,5 @@ # MCDeployLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) 🚀 Deployment 🌞 Deploy Meta Contract diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCFinderLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.MCFinderLib.md similarity index 80% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCFinderLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.MCFinderLib.md index f7003964..443a2820 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCFinderLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.MCFinderLib.md @@ -1,5 +1,5 @@ # MCFinderLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) 🔍 Finder 🏠 Find Current Proxy Address diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCHelpers.md b/site/docs/03-api/03-api-details/Flattened.sol/library.MCHelpers.md similarity index 95% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCHelpers.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.MCHelpers.md index 84c6f496..902fb9ba 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCHelpers.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.MCHelpers.md @@ -1,5 +1,5 @@ # MCHelpers -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) 🛠️ Helper ♻️ Reset Current Context diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCInitLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.MCInitLib.md similarity index 91% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCInitLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.MCInitLib.md index 13b5243f..3c764079 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCInitLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.MCInitLib.md @@ -1,5 +1,5 @@ # MCInitLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) 🎁 MC Initial Configuration 🌱 Init Bundle diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCMockLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.MCMockLib.md similarity index 92% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCMockLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.MCMockLib.md index ae59d712..fd397d41 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MCMockLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.MCMockLib.md @@ -1,5 +1,5 @@ # MCMockLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) 🎭 Mock 🌞 Mocking Meta Contract diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MessageBody.md b/site/docs/03-api/03-api-details/Flattened.sol/library.MessageBody.md similarity index 98% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MessageBody.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.MessageBody.md index e6601aab..0d9cafc9 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MessageBody.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.MessageBody.md @@ -1,5 +1,5 @@ # MessageBody -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MessageHead.md b/site/docs/03-api/03-api-details/Flattened.sol/library.MessageHead.md similarity index 97% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MessageHead.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.MessageHead.md index 4c94d756..54513145 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MessageHead.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.MessageHead.md @@ -1,5 +1,5 @@ # MessageHead -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MsgSender.md b/site/docs/03-api/03-api-details/Flattened.sol/library.MsgSender.md similarity index 67% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MsgSender.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.MsgSender.md index 001b1a31..75e52d27 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.MsgSender.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.MsgSender.md @@ -1,5 +1,5 @@ # MsgSender -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.NameGenerator.md b/site/docs/03-api/03-api-details/Flattened.sol/library.NameGenerator.md similarity index 94% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.NameGenerator.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.NameGenerator.md index f1fe42d3..f29a0dd3 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.NameGenerator.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.NameGenerator.md @@ -1,5 +1,5 @@ # NameGenerator -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ======================= 🏷️ Name Generator diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Parser.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Parser.md similarity index 62% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Parser.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Parser.md index 87b0d04c..b3c2112e 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Parser.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Parser.md @@ -1,5 +1,5 @@ # Parser -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) =============== 🗒️ Parser diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyCreator.md b/site/docs/03-api/03-api-details/Flattened.sol/library.ProxyCreator.md similarity index 65% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyCreator.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.ProxyCreator.md index 17d2ff53..c92c6cbd 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyCreator.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.ProxyCreator.md @@ -1,8 +1,13 @@ # ProxyCreator -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) < MC Standard Helper Library > +**Notes:** +- v0.1.0 + +- none + ## Functions ### create diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.ProxyLib.md similarity index 76% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.ProxyLib.md index b0653051..a62b43b7 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.ProxyLib.md @@ -1,5 +1,5 @@ # ProxyLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyRegistryLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.ProxyRegistryLib.md similarity index 87% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyRegistryLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.ProxyRegistryLib.md index dbd3ae07..baba4faf 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyRegistryLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.ProxyRegistryLib.md @@ -1,5 +1,5 @@ # ProxyRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyUtils.md b/site/docs/03-api/03-api-details/Flattened.sol/library.ProxyUtils.md similarity index 82% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyUtils.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.ProxyUtils.md index 6d8ade20..36b49e05 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.ProxyUtils.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.ProxyUtils.md @@ -1,5 +1,5 @@ # ProxyUtils -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *Library version has been tested with version 5.0.0.* @@ -32,7 +32,7 @@ function getDictionary() internal view returns (address); Change the dictionary and trigger a setup call if data is nonempty. This function is payable only if the setup call is performed, otherwise `msg.value` is rejected to avoid stuck value in the contract. -Emits an [IERC7546-DictionaryUpgraded](/lib/ucs-contracts/src/proxy/IProxy.sol/interface.IProxy.md#dictionaryupgraded) event. +Emits an [IERC7546-DictionaryUpgraded](../../../lib/ucs-contracts/src/proxy/IProxy.sol/interface.IProxy.md#dictionaryupgraded) event. ```solidity diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.SimpleMockProxyLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.SimpleMockProxyLib.md similarity index 81% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.SimpleMockProxyLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.SimpleMockProxyLib.md index 10de9228..c7c9c264 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.SimpleMockProxyLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.SimpleMockProxyLib.md @@ -1,5 +1,5 @@ # SimpleMockProxyLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables @@ -34,6 +34,9 @@ function getImplementation(bytes4 selector) internal view returns (address); ## Structs ### SimpleMockProxyStorage +**Note:** +erc7021:mc.mock.proxy + ```solidity struct SimpleMockProxyStorage { diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdFunctionsArgs.md b/site/docs/03-api/03-api-details/Flattened.sol/library.StdFunctionsArgs.md similarity index 58% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdFunctionsArgs.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.StdFunctionsArgs.md index 50b019f4..40b93008 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdFunctionsArgs.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.StdFunctionsArgs.md @@ -1,5 +1,5 @@ # StdFunctionsArgs -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) 🧩 Std Ops Primitive Utils for Arguments diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdFunctionsLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.StdFunctionsLib.md similarity index 93% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdFunctionsLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.StdFunctionsLib.md index f2f98df6..1d276453 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdFunctionsLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.StdFunctionsLib.md @@ -1,5 +1,5 @@ # StdFunctionsLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdRegistryLib.md b/site/docs/03-api/03-api-details/Flattened.sol/library.StdRegistryLib.md similarity index 82% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdRegistryLib.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.StdRegistryLib.md index 7671c0dd..3b84fa42 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdRegistryLib.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.StdRegistryLib.md @@ -1,5 +1,5 @@ # StdRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdStyle.md b/site/docs/03-api/03-api-details/Flattened.sol/library.StdStyle.md similarity index 98% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdStyle.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.StdStyle.md index 9e6790ff..90bae547 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StdStyle.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.StdStyle.md @@ -1,5 +1,5 @@ # StdStyle -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Storage.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Storage.md similarity index 83% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Storage.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Storage.md index a8b39a73..21531725 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Storage.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Storage.md @@ -1,5 +1,5 @@ # Storage -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) Storage Library v0.1.0 diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StorageSlot.md b/site/docs/03-api/03-api-details/Flattened.sol/library.StorageSlot.md similarity index 95% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StorageSlot.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.StorageSlot.md index 9d7a5358..6d7e17ae 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.StorageSlot.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.StorageSlot.md @@ -1,5 +1,5 @@ # StorageSlot -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) *Library for reading and writing primitive types to specific storage slots. Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts. diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.System.md b/site/docs/03-api/03-api-details/Flattened.sol/library.System.md similarity index 73% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.System.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.System.md index 7cada777..f82de517 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.System.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.System.md @@ -1,5 +1,5 @@ # System -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ===============\ | 💻 System | diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Tracer.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Tracer.md similarity index 97% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Tracer.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Tracer.md index 1f4a0831..7fe9e0e6 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Tracer.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Tracer.md @@ -1,5 +1,5 @@ # Tracer -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.TypeGuard.md b/site/docs/03-api/03-api-details/Flattened.sol/library.TypeGuard.md similarity index 95% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.TypeGuard.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.TypeGuard.md index 45915b38..6cadea34 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.TypeGuard.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.TypeGuard.md @@ -1,5 +1,5 @@ # TypeGuard -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ================================================== 🔒 Type Guard diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Validator.md b/site/docs/03-api/03-api-details/Flattened.sol/library.Validator.md similarity index 98% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Validator.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.Validator.md index 84ca3063..f7cb415e 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.Validator.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.Validator.md @@ -1,5 +1,5 @@ # Validator -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ================== ✅ Validator diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.console.md b/site/docs/03-api/03-api-details/Flattened.sol/library.console.md similarity index 99% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.console.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.console.md index 8336ba9d..d7656085 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.console.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.console.md @@ -1,5 +1,5 @@ # console -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.safeconsole.md b/site/docs/03-api/03-api-details/Flattened.sol/library.safeconsole.md similarity index 99% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.safeconsole.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.safeconsole.md index da5a2155..a266c626 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.safeconsole.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.safeconsole.md @@ -1,5 +1,5 @@ # safeconsole -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) **Author:** philogy diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdError.md b/site/docs/03-api/03-api-details/Flattened.sol/library.stdError.md similarity index 89% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdError.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.stdError.md index 5563d5c5..70f4021f 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdError.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.stdError.md @@ -1,5 +1,5 @@ # stdError -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdJson.md b/site/docs/03-api/03-api-details/Flattened.sol/library.stdJson.md similarity index 98% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdJson.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.stdJson.md index 36fafbde..b8d00ede 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdJson.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.stdJson.md @@ -1,5 +1,5 @@ # stdJson -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdMath.md b/site/docs/03-api/03-api-details/Flattened.sol/library.stdMath.md similarity index 83% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdMath.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.stdMath.md index 795a9f57..c6d3bdf3 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdMath.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.stdMath.md @@ -1,5 +1,5 @@ # stdMath -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdStorage.md b/site/docs/03-api/03-api-details/Flattened.sol/library.stdStorage.md similarity index 95% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdStorage.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.stdStorage.md index 3c3b3a9b..fe06f60f 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdStorage.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.stdStorage.md @@ -1,5 +1,5 @@ # stdStorage -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdStorageSafe.md b/site/docs/03-api/03-api-details/Flattened.sol/library.stdStorageSafe.md similarity index 96% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdStorageSafe.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.stdStorageSafe.md index bfe48920..b8a88da6 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdStorageSafe.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.stdStorageSafe.md @@ -1,5 +1,5 @@ # stdStorageSafe -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdToml.md b/site/docs/03-api/03-api-details/Flattened.sol/library.stdToml.md similarity index 98% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdToml.md rename to site/docs/03-api/03-api-details/Flattened.sol/library.stdToml.md index e27421a0..4fb6963a 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/library.stdToml.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/library.stdToml.md @@ -1,5 +1,5 @@ # stdToml -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Bundle.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.Bundle.md similarity index 58% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Bundle.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.Bundle.md index 7ac4a4f8..18969b93 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Bundle.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.Bundle.md @@ -1,5 +1,5 @@ # Bundle -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.BundleRegistry.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.BundleRegistry.md similarity index 57% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.BundleRegistry.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.BundleRegistry.md index 80c55f82..c13ac6a9 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.BundleRegistry.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.BundleRegistry.md @@ -1,5 +1,5 @@ # BundleRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.ConfigState.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.ConfigState.md similarity index 61% rename from docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.ConfigState.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.ConfigState.md index dd0cba56..4fce53fe 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.ConfigState.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.ConfigState.md @@ -1,5 +1,5 @@ # ConfigState -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Config.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ---------------------- 📝 Config @@ -8,6 +8,9 @@ | 📝 Config | \================ +**Note:** +erc7201:mc.devkit.config + ```solidity struct ConfigState { diff --git a/site/docs/03-api/03-api-details/Flattened.sol/struct.Current.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.Current.md new file mode 100644 index 00000000..ff4ca6ea --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.Current.md @@ -0,0 +1,14 @@ +# Current +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + +--------------------- +Support Methods +----------------------- + + +```solidity +struct Current { + string name; +} +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.DictionaryRegistry.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.DictionaryRegistry.md similarity index 59% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.DictionaryRegistry.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.DictionaryRegistry.md index 02cc5ad3..8cfc0390 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.DictionaryRegistry.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.DictionaryRegistry.md @@ -1,5 +1,5 @@ # DictionaryRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Dictionary_1.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.Dictionary_1.md similarity index 59% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Dictionary_1.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.Dictionary_1.md index b86d73de..9b9fb0b5 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Dictionary_1.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.Dictionary_1.md @@ -1,5 +1,5 @@ # Dictionary_1 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/site/docs/03-api/03-api-details/Flattened.sol/struct.FindData.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.FindData.md new file mode 100644 index 00000000..e2f18874 --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.FindData.md @@ -0,0 +1,13 @@ +# FindData +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +struct FindData { + uint256 slot; + uint256 offsetLeft; + uint256 offsetRight; + bool found; +} +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Function.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.Function.md similarity index 59% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Function.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.Function.md index fa5a5a59..673849dd 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Function.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.Function.md @@ -1,5 +1,5 @@ # Function -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.FunctionRegistry.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.FunctionRegistry.md similarity index 58% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.FunctionRegistry.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.FunctionRegistry.md index f88f53ae..f6a11e5a 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.FunctionRegistry.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.FunctionRegistry.md @@ -1,5 +1,5 @@ # FunctionRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/MCDevKit.sol/struct.MCDevKit.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.MCDevKit.md similarity index 60% rename from docs/05-resources/03-devkit/03-api-reference/MCDevKit.sol/struct.MCDevKit.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.MCDevKit.md index cb396d74..1d2cd905 100644 --- a/docs/05-resources/03-devkit/03-api-reference/MCDevKit.sol/struct.MCDevKit.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.MCDevKit.md @@ -1,5 +1,5 @@ # MCDevKit -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/MCDevKit.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) 🌟 Meta Contract DevKit diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.NamingConfig.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.NamingConfig.md similarity index 61% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.NamingConfig.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.NamingConfig.md index 50d09209..0e48c515 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.NamingConfig.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.NamingConfig.md @@ -1,5 +1,5 @@ # NamingConfig -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ```solidity diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Process.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.Process.md similarity index 51% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Process.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.Process.md index 8a38e72a..fc2069e5 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Process.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.Process.md @@ -1,5 +1,5 @@ # Process -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ```solidity diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.ProxyRegistry.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.ProxyRegistry.md similarity index 57% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.ProxyRegistry.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.ProxyRegistry.md index 594983ad..20cc1e2b 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.ProxyRegistry.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.ProxyRegistry.md @@ -1,5 +1,5 @@ # ProxyRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Proxy_2.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.Proxy_2.md similarity index 55% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Proxy_2.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.Proxy_2.md index a94b6ad1..7b8e6fb4 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Proxy_2.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.Proxy_2.md @@ -1,5 +1,5 @@ # Proxy_2 -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/site/docs/03-api/03-api-details/Flattened.sol/struct.SetupConfig.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.SetupConfig.md new file mode 100644 index 00000000..185b384b --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.SetupConfig.md @@ -0,0 +1,10 @@ +# SetupConfig +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +struct SetupConfig { + bool STD_FUNCS; +} +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.StdFunctions.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.StdFunctions.md similarity index 60% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.StdFunctions.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.StdFunctions.md index 5ceafa53..116f8a0b 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.StdFunctions.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.StdFunctions.md @@ -1,5 +1,5 @@ # StdFunctions -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.StdRegistry.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.StdRegistry.md similarity index 57% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.StdRegistry.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.StdRegistry.md index 07212765..3ad5e8b7 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.StdRegistry.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.StdRegistry.md @@ -1,5 +1,5 @@ # StdRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.StdStorage.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.StdStorage.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.StdStorage.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.StdStorage.md index 7ce9b675..491772a8 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.StdStorage.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.StdStorage.md @@ -1,5 +1,5 @@ # StdStorage -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ```solidity diff --git a/site/docs/03-api/03-api-details/Flattened.sol/struct.SystemConfig.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.SystemConfig.md new file mode 100644 index 00000000..45c58baf --- /dev/null +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.SystemConfig.md @@ -0,0 +1,11 @@ +# SystemConfig +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) + + +```solidity +struct SystemConfig { + Logger.Level LOG_LEVEL; + uint256 SCAN_RANGE; +} +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Trace.md b/site/docs/03-api/03-api-details/Flattened.sol/struct.Trace.md similarity index 52% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Trace.md rename to site/docs/03-api/03-api-details/Flattened.sol/struct.Trace.md index 539ba542..183dd02d 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.Trace.md +++ b/site/docs/03-api/03-api-details/Flattened.sol/struct.Trace.md @@ -1,10 +1,13 @@ # Trace -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/Flattened.sol) ================= ⛓️ Process =================== +**Note:** +erc7201:mc.devkit.tracer + ```solidity struct Trace { diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCBase.md b/site/docs/03-api/03-api-details/MCBase.sol/abstract.MCBase.md similarity index 56% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCBase.md rename to site/docs/03-api/03-api-details/MCBase.sol/abstract.MCBase.md index 97c505c5..bf847657 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCBase.md +++ b/site/docs/03-api/03-api-details/MCBase.sol/abstract.MCBase.md @@ -1,8 +1,8 @@ # MCBase -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/MCBase.sol) **Inherits:** -[CommonBase](/resources/devkit/api-reference/Flattened.sol/abstract.CommonBase) +[CommonBase](../Flattened.sol/abstract.CommonBase.md) ## State Variables diff --git a/site/docs/03-api/03-api-details/MCBase.sol/abstract.MCScriptBase.md b/site/docs/03-api/03-api-details/MCBase.sol/abstract.MCScriptBase.md new file mode 100644 index 00000000..803063bd --- /dev/null +++ b/site/docs/03-api/03-api-details/MCBase.sol/abstract.MCScriptBase.md @@ -0,0 +1,15 @@ +# MCScriptBase +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/MCBase.sol) + +**Inherits:** +[MCBase](../Flattened.sol/abstract.MCBase.md), ForgeScript + + +## Functions +### startBroadcastWith + + +```solidity +modifier startBroadcastWith(string memory envKey); +``` + diff --git a/site/docs/03-api/03-api-details/MCBase.sol/abstract.MCTestBase.md b/site/docs/03-api/03-api-details/MCBase.sol/abstract.MCTestBase.md new file mode 100644 index 00000000..330db7d2 --- /dev/null +++ b/site/docs/03-api/03-api-details/MCBase.sol/abstract.MCTestBase.md @@ -0,0 +1,15 @@ +# MCTestBase +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/MCBase.sol) + +**Inherits:** +[MCBase](../Flattened.sol/abstract.MCBase.md), ForgeTest + + +## Functions +### startPrankWith + + +```solidity +modifier startPrankWith(string memory envKey); +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/index.md b/site/docs/03-api/03-api-details/MCBase.sol/index.md similarity index 84% rename from docs/05-resources/03-devkit/03-api-reference/MCBase.sol/index.md rename to site/docs/03-api/03-api-details/MCBase.sol/index.md index 66b60504..26120543 100644 --- a/docs/05-resources/03-devkit/03-api-reference/MCBase.sol/index.md +++ b/site/docs/03-api/03-api-details/MCBase.sol/index.md @@ -1,7 +1,8 @@ -# MCBase.sol +# Index -- [abstract.MCBase](./abstract.MCBase.md) - [abstract.MCScriptBase](./abstract.MCScriptBase.md) +- [abstract.MCBase](./abstract.MCBase.md) - [abstract.MCTestBase](./abstract.MCTestBase.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/MCDevKit.sol/index.md b/site/docs/03-api/03-api-details/MCDevKit.sol/index.md similarity index 65% rename from docs/05-resources/03-devkit/03-api-reference/MCDevKit.sol/index.md rename to site/docs/03-api/03-api-details/MCDevKit.sol/index.md index 68c69dda..26f4849d 100644 --- a/docs/05-resources/03-devkit/03-api-reference/MCDevKit.sol/index.md +++ b/site/docs/03-api/03-api-details/MCDevKit.sol/index.md @@ -1,5 +1,6 @@ -# MCDevKit.sol +# Index - [struct.MCDevKit](./struct.MCDevKit.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.MCDevKit.md b/site/docs/03-api/03-api-details/MCDevKit.sol/struct.MCDevKit.md similarity index 60% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.MCDevKit.md rename to site/docs/03-api/03-api-details/MCDevKit.sol/struct.MCDevKit.md index 2d61b1a2..1dad824b 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.MCDevKit.md +++ b/site/docs/03-api/03-api-details/MCDevKit.sol/struct.MCDevKit.md @@ -1,5 +1,5 @@ # MCDevKit -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/MCDevKit.sol) 🌟 Meta Contract DevKit diff --git a/site/docs/03-api/03-api-details/MCScript.sol/abstract.MCScript.md b/site/docs/03-api/03-api-details/MCScript.sol/abstract.MCScript.md new file mode 100644 index 00000000..ba8f189c --- /dev/null +++ b/site/docs/03-api/03-api-details/MCScript.sol/abstract.MCScript.md @@ -0,0 +1,15 @@ +# MCScript +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/MCScript.sol) + +**Inherits:** +[MCScriptBase](../Flattened.sol/abstract.MCScriptBase.md) + + +## Functions +### _saveAddrToEnv + + +```solidity +function _saveAddrToEnv(address addr, string memory envKeyBase) internal; +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/MCScript.sol/index.md b/site/docs/03-api/03-api-details/MCScript.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/MCScript.sol/index.md rename to site/docs/03-api/03-api-details/MCScript.sol/index.md index 6492e656..b83eb826 100644 --- a/docs/05-resources/03-devkit/03-api-reference/MCScript.sol/index.md +++ b/site/docs/03-api/03-api-details/MCScript.sol/index.md @@ -1,5 +1,6 @@ -# MCScript.sol +# Index - [abstract.MCScript](./abstract.MCScript.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCTest.md b/site/docs/03-api/03-api-details/MCTest.sol/abstract.MCTest.md similarity index 74% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCTest.md rename to site/docs/03-api/03-api-details/MCTest.sol/abstract.MCTest.md index 170fe677..d1d10132 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/abstract.MCTest.md +++ b/site/docs/03-api/03-api-details/MCTest.sol/abstract.MCTest.md @@ -1,8 +1,8 @@ # MCTest -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/MCTest.sol) **Inherits:** -[MCTestBase](/resources/devkit/api-reference/Flattened.sol/abstract.MCTestBase), [Proxy_0](/resources/devkit/api-reference/Flattened.sol/abstract.Proxy_0) +[MCTestBase](../Flattened.sol/abstract.MCTestBase.md), OZProxy ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/MCTest.sol/index.md b/site/docs/03-api/03-api-details/MCTest.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/MCTest.sol/index.md rename to site/docs/03-api/03-api-details/MCTest.sol/index.md index 5dbca97a..5ebbbea3 100644 --- a/docs/05-resources/03-devkit/03-api-reference/MCTest.sol/index.md +++ b/site/docs/03-api/03-api-details/MCTest.sol/index.md @@ -1,5 +1,6 @@ -# MCTest.sol +# Index - [abstract.MCTest](./abstract.MCTest.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Bundle.sol/index.md b/site/docs/03-api/03-api-details/core/Bundle.sol/index.md similarity index 76% rename from docs/05-resources/03-devkit/03-api-reference/core/Bundle.sol/index.md rename to site/docs/03-api/03-api-details/core/Bundle.sol/index.md index a3e7eb9c..7cb81935 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Bundle.sol/index.md +++ b/site/docs/03-api/03-api-details/core/Bundle.sol/index.md @@ -1,6 +1,7 @@ -# Bundle.sol +# Index - [library.BundleLib](./library.BundleLib.md) - [struct.Bundle](./struct.Bundle.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Bundle.sol/library.BundleLib.md b/site/docs/03-api/03-api-details/core/Bundle.sol/library.BundleLib.md similarity index 84% rename from docs/05-resources/03-devkit/03-api-reference/core/Bundle.sol/library.BundleLib.md rename to site/docs/03-api/03-api-details/core/Bundle.sol/library.BundleLib.md index 60b6bb6c..395a925b 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Bundle.sol/library.BundleLib.md +++ b/site/docs/03-api/03-api-details/core/Bundle.sol/library.BundleLib.md @@ -1,5 +1,5 @@ # BundleLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Bundle.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Bundle.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Bundle.sol/struct.Bundle.md b/site/docs/03-api/03-api-details/core/Bundle.sol/struct.Bundle.md similarity index 57% rename from docs/05-resources/03-devkit/03-api-reference/core/Bundle.sol/struct.Bundle.md rename to site/docs/03-api/03-api-details/core/Bundle.sol/struct.Bundle.md index 828ff94c..9f42c1be 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Bundle.sol/struct.Bundle.md +++ b/site/docs/03-api/03-api-details/core/Bundle.sol/struct.Bundle.md @@ -1,5 +1,5 @@ # Bundle -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Bundle.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Bundle.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/enum.DictionaryKind.md b/site/docs/03-api/03-api-details/core/Dictionary.sol/enum.DictionaryKind.md similarity index 56% rename from docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/enum.DictionaryKind.md rename to site/docs/03-api/03-api-details/core/Dictionary.sol/enum.DictionaryKind.md index 97cfdb21..4a149c44 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/enum.DictionaryKind.md +++ b/site/docs/03-api/03-api-details/core/Dictionary.sol/enum.DictionaryKind.md @@ -1,5 +1,5 @@ # DictionaryKind -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Dictionary.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Dictionary.sol) -------------------- Dictionary Kind diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/index.md b/site/docs/03-api/03-api-details/core/Dictionary.sol/index.md similarity index 82% rename from docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/index.md rename to site/docs/03-api/03-api-details/core/Dictionary.sol/index.md index 9121310f..5a841e3e 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/index.md +++ b/site/docs/03-api/03-api-details/core/Dictionary.sol/index.md @@ -1,7 +1,8 @@ -# Dictionary.sol +# Index -- [enum.DictionaryKind](./enum.DictionaryKind.md) - [library.DictionaryLib](./library.DictionaryLib.md) +- [enum.DictionaryKind](./enum.DictionaryKind.md) - [struct.Dictionary](./struct.Dictionary.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/library.DictionaryLib.md b/site/docs/03-api/03-api-details/core/Dictionary.sol/library.DictionaryLib.md similarity index 94% rename from docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/library.DictionaryLib.md rename to site/docs/03-api/03-api-details/core/Dictionary.sol/library.DictionaryLib.md index acea54ce..10efadff 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/library.DictionaryLib.md +++ b/site/docs/03-api/03-api-details/core/Dictionary.sol/library.DictionaryLib.md @@ -1,5 +1,5 @@ # DictionaryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Dictionary.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Dictionary.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/struct.Dictionary.md b/site/docs/03-api/03-api-details/core/Dictionary.sol/struct.Dictionary.md similarity index 57% rename from docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/struct.Dictionary.md rename to site/docs/03-api/03-api-details/core/Dictionary.sol/struct.Dictionary.md index 75dc6797..a957b29c 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Dictionary.sol/struct.Dictionary.md +++ b/site/docs/03-api/03-api-details/core/Dictionary.sol/struct.Dictionary.md @@ -1,5 +1,5 @@ # Dictionary -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Dictionary.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Dictionary.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Function.sol/index.md b/site/docs/03-api/03-api-details/core/Function.sol/index.md similarity index 77% rename from docs/05-resources/03-devkit/03-api-reference/core/Function.sol/index.md rename to site/docs/03-api/03-api-details/core/Function.sol/index.md index 31d966d7..cce1887c 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Function.sol/index.md +++ b/site/docs/03-api/03-api-details/core/Function.sol/index.md @@ -1,6 +1,7 @@ -# Function.sol +# Index -- [library.FunctionLib](./library.FunctionLib.md) - [struct.Function](./struct.Function.md) - +- [library.FunctionLib](./library.FunctionLib.md) + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Function.sol/library.FunctionLib.md b/site/docs/03-api/03-api-details/core/Function.sol/library.FunctionLib.md similarity index 88% rename from docs/05-resources/03-devkit/03-api-reference/core/Function.sol/library.FunctionLib.md rename to site/docs/03-api/03-api-details/core/Function.sol/library.FunctionLib.md index 47516955..925dc3da 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Function.sol/library.FunctionLib.md +++ b/site/docs/03-api/03-api-details/core/Function.sol/library.FunctionLib.md @@ -1,5 +1,5 @@ # FunctionLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Function.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Function.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Function.sol/struct.Function.md b/site/docs/03-api/03-api-details/core/Function.sol/struct.Function.md similarity index 58% rename from docs/05-resources/03-devkit/03-api-reference/core/Function.sol/struct.Function.md rename to site/docs/03-api/03-api-details/core/Function.sol/struct.Function.md index d01a5ae9..9b59549f 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Function.sol/struct.Function.md +++ b/site/docs/03-api/03-api-details/core/Function.sol/struct.Function.md @@ -1,5 +1,5 @@ # Function -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Function.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Function.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/enum.ProxyKind.md b/site/docs/03-api/03-api-details/core/Proxy.sol/enum.ProxyKind.md similarity index 51% rename from docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/enum.ProxyKind.md rename to site/docs/03-api/03-api-details/core/Proxy.sol/enum.ProxyKind.md index d9107080..a24e1653 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/enum.ProxyKind.md +++ b/site/docs/03-api/03-api-details/core/Proxy.sol/enum.ProxyKind.md @@ -1,5 +1,5 @@ # ProxyKind -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Proxy.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Proxy.sol) --------------- Proxy Kind diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/index.md b/site/docs/03-api/03-api-details/core/Proxy.sol/index.md similarity index 82% rename from docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/index.md rename to site/docs/03-api/03-api-details/core/Proxy.sol/index.md index 0d875d67..131fadc1 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/index.md +++ b/site/docs/03-api/03-api-details/core/Proxy.sol/index.md @@ -1,7 +1,8 @@ -# Proxy.sol +# Index +- [struct.Proxy](./struct.Proxy.md) - [enum.ProxyKind](./enum.ProxyKind.md) - [library.ProxyLib](./library.ProxyLib.md) -- [struct.Proxy](./struct.Proxy.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/library.ProxyLib.md b/site/docs/03-api/03-api-details/core/Proxy.sol/library.ProxyLib.md similarity index 76% rename from docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/library.ProxyLib.md rename to site/docs/03-api/03-api-details/core/Proxy.sol/library.ProxyLib.md index 270c2469..cc14e8e3 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/library.ProxyLib.md +++ b/site/docs/03-api/03-api-details/core/Proxy.sol/library.ProxyLib.md @@ -1,5 +1,5 @@ # ProxyLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Proxy.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Proxy.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/struct.Proxy.md b/site/docs/03-api/03-api-details/core/Proxy.sol/struct.Proxy.md similarity index 54% rename from docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/struct.Proxy.md rename to site/docs/03-api/03-api-details/core/Proxy.sol/struct.Proxy.md index 7b7bf578..fa3066de 100644 --- a/docs/05-resources/03-devkit/03-api-reference/core/Proxy.sol/struct.Proxy.md +++ b/site/docs/03-api/03-api-details/core/Proxy.sol/struct.Proxy.md @@ -1,5 +1,5 @@ # Proxy -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/core/Proxy.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/core/Proxy.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/core/index.md b/site/docs/03-api/03-api-details/core/index.md similarity index 100% rename from docs/05-resources/03-devkit/03-api-reference/core/index.md rename to site/docs/03-api/03-api-details/core/index.md diff --git a/docs/05-resources/03-devkit/03-api-reference/index.md b/site/docs/03-api/03-api-details/index.md similarity index 97% rename from docs/05-resources/03-devkit/03-api-reference/index.md rename to site/docs/03-api/03-api-details/index.md index be0b9a16..cf869386 100644 --- a/docs/05-resources/03-devkit/03-api-reference/index.md +++ b/site/docs/03-api/03-api-details/index.md @@ -1,14 +1,12 @@ --- -title: "DevKit API Reference" -version: 0.1.0 -lastUpdated: 2024-09-19 -author: Meta Contract Development Team -scope: development -type: index -tags: [api, reference, solidity] +keywords: [devkit, api, details, solidity] +tags: [devkit, api, details, solidity] +last_update: + date: 2024-10-28 + author: Meta Contract Development Team --- -# DevKit API Reference +# DevKit API Details This section provides detailed documentation for the Solidity contracts and libraries that make up the Meta Contract DevKit. @@ -150,35 +148,35 @@ This section provides detailed documentation for the Solidity contracts and libr - [MCScript](./Flattened.sol/abstract.MCScript.md) - [MCTest](./Flattened.sol/abstract.MCTest.md) - [Dummy](./Flattened.sol/library.Dummy.md) -- [param_21](./Flattened.sol/function.param_21.md) -- [param_25](./Flattened.sol/function.param_25.md) -- [param_0](./Flattened.sol/function.param_0.md) -- [param_22](./Flattened.sol/function.param_22.md) +- [param_6](./Flattened.sol/function.param_6.md) +- [param_19](./Flattened.sol/function.param_19.md) +- [param_23](./Flattened.sol/function.param_23.md) - [param_7](./Flattened.sol/function.param_7.md) -- [param_18](./Flattened.sol/function.param_18.md) -- [param_9](./Flattened.sol/function.param_9.md) +- [param_15](./Flattened.sol/function.param_15.md) +- [param_12](./Flattened.sol/function.param_12.md) - [param_2](./Flattened.sol/function.param_2.md) -- [loadAddressFrom](./Flattened.sol/function.loadAddressFrom.md) -- [param_24](./Flattened.sol/function.param_24.md) -- [param_10](./Flattened.sol/function.param_10.md) - [param_13](./Flattened.sol/function.param_13.md) -- [param_1](./Flattened.sol/function.param_1.md) -- [param_14](./Flattened.sol/function.param_14.md) - [param_20](./Flattened.sol/function.param_20.md) -- [param_6](./Flattened.sol/function.param_6.md) -- [param_27](./Flattened.sol/function.param_27.md) -- [param_8](./Flattened.sol/function.param_8.md) -- [param_12](./Flattened.sol/function.param_12.md) -- [param_16](./Flattened.sol/function.param_16.md) -- [param_17](./Flattened.sol/function.param_17.md) -- [param_23](./Flattened.sol/function.param_23.md) +- [param_24](./Flattened.sol/function.param_24.md) +- [param_10](./Flattened.sol/function.param_10.md) +- [loadAddressFrom](./Flattened.sol/function.loadAddressFrom.md) +- [param_11](./Flattened.sol/function.param_11.md) - [param_26](./Flattened.sol/function.param_26.md) -- [param_15](./Flattened.sol/function.param_15.md) -- [param_4](./Flattened.sol/function.param_4.md) -- [param_19](./Flattened.sol/function.param_19.md) +- [param_17](./Flattened.sol/function.param_17.md) +- [param_27](./Flattened.sol/function.param_27.md) +- [param_14](./Flattened.sol/function.param_14.md) +- [param_1](./Flattened.sol/function.param_1.md) - [param_5](./Flattened.sol/function.param_5.md) -- [param_11](./Flattened.sol/function.param_11.md) +- [param_21](./Flattened.sol/function.param_21.md) +- [param_22](./Flattened.sol/function.param_22.md) +- [param_4](./Flattened.sol/function.param_4.md) +- [param_16](./Flattened.sol/function.param_16.md) +- [param_9](./Flattened.sol/function.param_9.md) +- [param_8](./Flattened.sol/function.param_8.md) - [param_3](./Flattened.sol/function.param_3.md) +- [param_25](./Flattened.sol/function.param_25.md) +- [param_18](./Flattened.sol/function.param_18.md) +- [param_0](./Flattened.sol/function.param_0.md) - [Flattened constants](./Flattened.sol/constants.Flattened.md) - [MCBase](./MCBase.sol/abstract.MCBase.md) - [MCScriptBase](./MCBase.sol/abstract.MCScriptBase.md) diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/BundleRegistry.sol/index.md b/site/docs/03-api/03-api-details/registry/BundleRegistry.sol/index.md similarity index 77% rename from docs/05-resources/03-devkit/03-api-reference/registry/BundleRegistry.sol/index.md rename to site/docs/03-api/03-api-details/registry/BundleRegistry.sol/index.md index 9feed622..fb12cc60 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/BundleRegistry.sol/index.md +++ b/site/docs/03-api/03-api-details/registry/BundleRegistry.sol/index.md @@ -1,6 +1,7 @@ -# BundleRegistry.sol +# Index -- [library.BundleRegistryLib](./library.BundleRegistryLib.md) - [struct.BundleRegistry](./struct.BundleRegistry.md) - +- [library.BundleRegistryLib](./library.BundleRegistryLib.md) + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/BundleRegistry.sol/library.BundleRegistryLib.md b/site/docs/03-api/03-api-details/registry/BundleRegistry.sol/library.BundleRegistryLib.md similarity index 85% rename from docs/05-resources/03-devkit/03-api-reference/registry/BundleRegistry.sol/library.BundleRegistryLib.md rename to site/docs/03-api/03-api-details/registry/BundleRegistry.sol/library.BundleRegistryLib.md index 46a3d881..2d90a700 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/BundleRegistry.sol/library.BundleRegistryLib.md +++ b/site/docs/03-api/03-api-details/registry/BundleRegistry.sol/library.BundleRegistryLib.md @@ -1,5 +1,5 @@ # BundleRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/BundleRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/BundleRegistry.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/BundleRegistry.sol/struct.BundleRegistry.md b/site/docs/03-api/03-api-details/registry/BundleRegistry.sol/struct.BundleRegistry.md similarity index 55% rename from docs/05-resources/03-devkit/03-api-reference/registry/BundleRegistry.sol/struct.BundleRegistry.md rename to site/docs/03-api/03-api-details/registry/BundleRegistry.sol/struct.BundleRegistry.md index b0745171..131ee33a 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/BundleRegistry.sol/struct.BundleRegistry.md +++ b/site/docs/03-api/03-api-details/registry/BundleRegistry.sol/struct.BundleRegistry.md @@ -1,5 +1,5 @@ # BundleRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/BundleRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/BundleRegistry.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/DictionaryRegistry.sol/index.md b/site/docs/03-api/03-api-details/registry/DictionaryRegistry.sol/index.md similarity index 77% rename from docs/05-resources/03-devkit/03-api-reference/registry/DictionaryRegistry.sol/index.md rename to site/docs/03-api/03-api-details/registry/DictionaryRegistry.sol/index.md index f5ad2412..950f98aa 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/DictionaryRegistry.sol/index.md +++ b/site/docs/03-api/03-api-details/registry/DictionaryRegistry.sol/index.md @@ -1,6 +1,7 @@ -# DictionaryRegistry.sol +# Index - [library.DictionaryRegistryLib](./library.DictionaryRegistryLib.md) - [struct.DictionaryRegistry](./struct.DictionaryRegistry.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/DictionaryRegistry.sol/library.DictionaryRegistryLib.md b/site/docs/03-api/03-api-details/registry/DictionaryRegistry.sol/library.DictionaryRegistryLib.md similarity index 87% rename from docs/05-resources/03-devkit/03-api-reference/registry/DictionaryRegistry.sol/library.DictionaryRegistryLib.md rename to site/docs/03-api/03-api-details/registry/DictionaryRegistry.sol/library.DictionaryRegistryLib.md index 27f332f5..ee85d760 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/DictionaryRegistry.sol/library.DictionaryRegistryLib.md +++ b/site/docs/03-api/03-api-details/registry/DictionaryRegistry.sol/library.DictionaryRegistryLib.md @@ -1,5 +1,5 @@ # DictionaryRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/DictionaryRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/DictionaryRegistry.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/DictionaryRegistry.sol/struct.DictionaryRegistry.md b/site/docs/03-api/03-api-details/registry/DictionaryRegistry.sol/struct.DictionaryRegistry.md similarity index 56% rename from docs/05-resources/03-devkit/03-api-reference/registry/DictionaryRegistry.sol/struct.DictionaryRegistry.md rename to site/docs/03-api/03-api-details/registry/DictionaryRegistry.sol/struct.DictionaryRegistry.md index 2d564f91..a5b3db58 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/DictionaryRegistry.sol/struct.DictionaryRegistry.md +++ b/site/docs/03-api/03-api-details/registry/DictionaryRegistry.sol/struct.DictionaryRegistry.md @@ -1,5 +1,5 @@ # DictionaryRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/DictionaryRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/DictionaryRegistry.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/FunctionRegistry.sol/index.md b/site/docs/03-api/03-api-details/registry/FunctionRegistry.sol/index.md similarity index 77% rename from docs/05-resources/03-devkit/03-api-reference/registry/FunctionRegistry.sol/index.md rename to site/docs/03-api/03-api-details/registry/FunctionRegistry.sol/index.md index 2f3e3220..cd54d46b 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/FunctionRegistry.sol/index.md +++ b/site/docs/03-api/03-api-details/registry/FunctionRegistry.sol/index.md @@ -1,6 +1,7 @@ -# FunctionRegistry.sol +# Index - [library.FunctionRegistryLib](./library.FunctionRegistryLib.md) - [struct.FunctionRegistry](./struct.FunctionRegistry.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/FunctionRegistry.sol/library.FunctionRegistryLib.md b/site/docs/03-api/03-api-details/registry/FunctionRegistry.sol/library.FunctionRegistryLib.md similarity index 80% rename from docs/05-resources/03-devkit/03-api-reference/registry/FunctionRegistry.sol/library.FunctionRegistryLib.md rename to site/docs/03-api/03-api-details/registry/FunctionRegistry.sol/library.FunctionRegistryLib.md index 0581c853..f7965fab 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/FunctionRegistry.sol/library.FunctionRegistryLib.md +++ b/site/docs/03-api/03-api-details/registry/FunctionRegistry.sol/library.FunctionRegistryLib.md @@ -1,5 +1,5 @@ # FunctionRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/FunctionRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/FunctionRegistry.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/FunctionRegistry.sol/struct.FunctionRegistry.md b/site/docs/03-api/03-api-details/registry/FunctionRegistry.sol/struct.FunctionRegistry.md similarity index 55% rename from docs/05-resources/03-devkit/03-api-reference/registry/FunctionRegistry.sol/struct.FunctionRegistry.md rename to site/docs/03-api/03-api-details/registry/FunctionRegistry.sol/struct.FunctionRegistry.md index 3674211e..82c3c90b 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/FunctionRegistry.sol/struct.FunctionRegistry.md +++ b/site/docs/03-api/03-api-details/registry/FunctionRegistry.sol/struct.FunctionRegistry.md @@ -1,5 +1,5 @@ # FunctionRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/FunctionRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/FunctionRegistry.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/ProxyRegistry.sol/index.md b/site/docs/03-api/03-api-details/registry/ProxyRegistry.sol/index.md similarity index 77% rename from docs/05-resources/03-devkit/03-api-reference/registry/ProxyRegistry.sol/index.md rename to site/docs/03-api/03-api-details/registry/ProxyRegistry.sol/index.md index 991b7777..75f0c42c 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/ProxyRegistry.sol/index.md +++ b/site/docs/03-api/03-api-details/registry/ProxyRegistry.sol/index.md @@ -1,6 +1,7 @@ -# ProxyRegistry.sol +# Index -- [library.ProxyRegistryLib](./library.ProxyRegistryLib.md) - [struct.ProxyRegistry](./struct.ProxyRegistry.md) - +- [library.ProxyRegistryLib](./library.ProxyRegistryLib.md) + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/ProxyRegistry.sol/library.ProxyRegistryLib.md b/site/docs/03-api/03-api-details/registry/ProxyRegistry.sol/library.ProxyRegistryLib.md similarity index 86% rename from docs/05-resources/03-devkit/03-api-reference/registry/ProxyRegistry.sol/library.ProxyRegistryLib.md rename to site/docs/03-api/03-api-details/registry/ProxyRegistry.sol/library.ProxyRegistryLib.md index deeded94..a912226d 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/ProxyRegistry.sol/library.ProxyRegistryLib.md +++ b/site/docs/03-api/03-api-details/registry/ProxyRegistry.sol/library.ProxyRegistryLib.md @@ -1,5 +1,5 @@ # ProxyRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/ProxyRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/ProxyRegistry.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/ProxyRegistry.sol/struct.ProxyRegistry.md b/site/docs/03-api/03-api-details/registry/ProxyRegistry.sol/struct.ProxyRegistry.md similarity index 55% rename from docs/05-resources/03-devkit/03-api-reference/registry/ProxyRegistry.sol/struct.ProxyRegistry.md rename to site/docs/03-api/03-api-details/registry/ProxyRegistry.sol/struct.ProxyRegistry.md index c49d5071..acb6c4b5 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/ProxyRegistry.sol/struct.ProxyRegistry.md +++ b/site/docs/03-api/03-api-details/registry/ProxyRegistry.sol/struct.ProxyRegistry.md @@ -1,5 +1,5 @@ # ProxyRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/ProxyRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/ProxyRegistry.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/StdFunctions.sol/index.md b/site/docs/03-api/03-api-details/registry/StdFunctions.sol/index.md similarity index 77% rename from docs/05-resources/03-devkit/03-api-reference/registry/StdFunctions.sol/index.md rename to site/docs/03-api/03-api-details/registry/StdFunctions.sol/index.md index 69269d03..8813b79c 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/StdFunctions.sol/index.md +++ b/site/docs/03-api/03-api-details/registry/StdFunctions.sol/index.md @@ -1,6 +1,7 @@ -# StdFunctions.sol +# Index - [library.StdFunctionsLib](./library.StdFunctionsLib.md) - [struct.StdFunctions](./struct.StdFunctions.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/StdFunctions.sol/library.StdFunctionsLib.md b/site/docs/03-api/03-api-details/registry/StdFunctions.sol/library.StdFunctionsLib.md similarity index 92% rename from docs/05-resources/03-devkit/03-api-reference/registry/StdFunctions.sol/library.StdFunctionsLib.md rename to site/docs/03-api/03-api-details/registry/StdFunctions.sol/library.StdFunctionsLib.md index e5257f19..3aa0fb3f 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/StdFunctions.sol/library.StdFunctionsLib.md +++ b/site/docs/03-api/03-api-details/registry/StdFunctions.sol/library.StdFunctionsLib.md @@ -1,5 +1,5 @@ # StdFunctionsLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/StdFunctions.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/StdFunctions.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/StdFunctions.sol/struct.StdFunctions.md b/site/docs/03-api/03-api-details/registry/StdFunctions.sol/struct.StdFunctions.md similarity index 58% rename from docs/05-resources/03-devkit/03-api-reference/registry/StdFunctions.sol/struct.StdFunctions.md rename to site/docs/03-api/03-api-details/registry/StdFunctions.sol/struct.StdFunctions.md index 4e608073..c9c91b62 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/StdFunctions.sol/struct.StdFunctions.md +++ b/site/docs/03-api/03-api-details/registry/StdFunctions.sol/struct.StdFunctions.md @@ -1,5 +1,5 @@ # StdFunctions -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/StdFunctions.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/StdFunctions.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/index.md b/site/docs/03-api/03-api-details/registry/StdRegistry.sol/index.md similarity index 83% rename from docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/index.md rename to site/docs/03-api/03-api-details/registry/StdRegistry.sol/index.md index 89bc18b6..a53a0a57 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/index.md +++ b/site/docs/03-api/03-api-details/registry/StdRegistry.sol/index.md @@ -1,7 +1,8 @@ -# StdRegistry.sol +# Index +- [struct.StdRegistry](./struct.StdRegistry.md) - [library.StdFunctionsArgs](./library.StdFunctionsArgs.md) - [library.StdRegistryLib](./library.StdRegistryLib.md) -- [struct.StdRegistry](./struct.StdRegistry.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/library.StdFunctionsArgs.md b/site/docs/03-api/03-api-details/registry/StdRegistry.sol/library.StdFunctionsArgs.md similarity index 56% rename from docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/library.StdFunctionsArgs.md rename to site/docs/03-api/03-api-details/registry/StdRegistry.sol/library.StdFunctionsArgs.md index 6112b10f..7867f1ab 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/library.StdFunctionsArgs.md +++ b/site/docs/03-api/03-api-details/registry/StdRegistry.sol/library.StdFunctionsArgs.md @@ -1,5 +1,5 @@ # StdFunctionsArgs -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/StdRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/StdRegistry.sol) 🧩 Std Ops Primitive Utils for Arguments diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/library.StdRegistryLib.md b/site/docs/03-api/03-api-details/registry/StdRegistry.sol/library.StdRegistryLib.md similarity index 81% rename from docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/library.StdRegistryLib.md rename to site/docs/03-api/03-api-details/registry/StdRegistry.sol/library.StdRegistryLib.md index 53f86550..73b05fe0 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/library.StdRegistryLib.md +++ b/site/docs/03-api/03-api-details/registry/StdRegistry.sol/library.StdRegistryLib.md @@ -1,5 +1,5 @@ # StdRegistryLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/StdRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/StdRegistry.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/struct.StdRegistry.md b/site/docs/03-api/03-api-details/registry/StdRegistry.sol/struct.StdRegistry.md similarity index 55% rename from docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/struct.StdRegistry.md rename to site/docs/03-api/03-api-details/registry/StdRegistry.sol/struct.StdRegistry.md index 6edb4d5c..3feace38 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/StdRegistry.sol/struct.StdRegistry.md +++ b/site/docs/03-api/03-api-details/registry/StdRegistry.sol/struct.StdRegistry.md @@ -1,5 +1,5 @@ # StdRegistry -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/StdRegistry.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/StdRegistry.sol) --------------------- Support Methods diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/context/Current.sol/index.md b/site/docs/03-api/03-api-details/registry/context/Current.sol/index.md similarity index 76% rename from docs/05-resources/03-devkit/03-api-reference/registry/context/Current.sol/index.md rename to site/docs/03-api/03-api-details/registry/context/Current.sol/index.md index 682d5475..6f4b6908 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/context/Current.sol/index.md +++ b/site/docs/03-api/03-api-details/registry/context/Current.sol/index.md @@ -1,6 +1,7 @@ -# Current.sol +# Index - [library.CurrentLib](./library.CurrentLib.md) - [struct.Current](./struct.Current.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/context/Current.sol/library.CurrentLib.md b/site/docs/03-api/03-api-details/registry/context/Current.sol/library.CurrentLib.md similarity index 78% rename from docs/05-resources/03-devkit/03-api-reference/registry/context/Current.sol/library.CurrentLib.md rename to site/docs/03-api/03-api-details/registry/context/Current.sol/library.CurrentLib.md index 3ec5db6a..5f232bda 100644 --- a/docs/05-resources/03-devkit/03-api-reference/registry/context/Current.sol/library.CurrentLib.md +++ b/site/docs/03-api/03-api-details/registry/context/Current.sol/library.CurrentLib.md @@ -1,5 +1,5 @@ # CurrentLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/registry/context/Current.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/context/Current.sol) ## Functions diff --git a/site/docs/03-api/03-api-details/registry/context/Current.sol/struct.Current.md b/site/docs/03-api/03-api-details/registry/context/Current.sol/struct.Current.md new file mode 100644 index 00000000..5d483ff1 --- /dev/null +++ b/site/docs/03-api/03-api-details/registry/context/Current.sol/struct.Current.md @@ -0,0 +1,14 @@ +# Current +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/registry/context/Current.sol) + +--------------------- +Support Methods +----------------------- + + +```solidity +struct Current { + string name; +} +``` + diff --git a/site/docs/03-api/03-api-details/registry/context/index.md b/site/docs/03-api/03-api-details/registry/context/index.md new file mode 100644 index 00000000..74af67ea --- /dev/null +++ b/site/docs/03-api/03-api-details/registry/context/index.md @@ -0,0 +1,6 @@ +# Context + + +- [Current](./Current.sol/struct.Current.md) +- [CurrentLib](./Current.sol/library.CurrentLib.md) + diff --git a/docs/05-resources/03-devkit/03-api-reference/registry/index.md b/site/docs/03-api/03-api-details/registry/index.md similarity index 100% rename from docs/05-resources/03-devkit/03-api-reference/registry/index.md rename to site/docs/03-api/03-api-details/registry/index.md diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/index.md b/site/docs/03-api/03-api-details/system/Config.sol/index.md similarity index 89% rename from docs/05-resources/03-devkit/03-api-reference/system/Config.sol/index.md rename to site/docs/03-api/03-api-details/system/Config.sol/index.md index 69f7ac29..149aaaba 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/index.md +++ b/site/docs/03-api/03-api-details/system/Config.sol/index.md @@ -1,9 +1,10 @@ -# Config.sol +# Index - [library.ConfigLib](./library.ConfigLib.md) - [struct.ConfigState](./struct.ConfigState.md) -- [struct.NamingConfig](./struct.NamingConfig.md) -- [struct.SetupConfig](./struct.SetupConfig.md) - [struct.SystemConfig](./struct.SystemConfig.md) - +- [struct.SetupConfig](./struct.SetupConfig.md) +- [struct.NamingConfig](./struct.NamingConfig.md) + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/library.ConfigLib.md b/site/docs/03-api/03-api-details/system/Config.sol/library.ConfigLib.md similarity index 74% rename from docs/05-resources/03-devkit/03-api-reference/system/Config.sol/library.ConfigLib.md rename to site/docs/03-api/03-api-details/system/Config.sol/library.ConfigLib.md index cc5d9b24..0b5b946f 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/library.ConfigLib.md +++ b/site/docs/03-api/03-api-details/system/Config.sol/library.ConfigLib.md @@ -1,5 +1,5 @@ # ConfigLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Config.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Config.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.ConfigState.md b/site/docs/03-api/03-api-details/system/Config.sol/struct.ConfigState.md similarity index 61% rename from docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.ConfigState.md rename to site/docs/03-api/03-api-details/system/Config.sol/struct.ConfigState.md index d1a56da4..e197cf88 100644 --- a/docs/05-resources/03-devkit/03-api-reference/Flattened.sol/struct.ConfigState.md +++ b/site/docs/03-api/03-api-details/system/Config.sol/struct.ConfigState.md @@ -1,5 +1,5 @@ # ConfigState -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/Flattened.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Config.sol) ---------------------- 📝 Config @@ -8,6 +8,9 @@ | 📝 Config | \================ +**Note:** +erc7201:mc.devkit.config + ```solidity struct ConfigState { diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.NamingConfig.md b/site/docs/03-api/03-api-details/system/Config.sol/struct.NamingConfig.md similarity index 60% rename from docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.NamingConfig.md rename to site/docs/03-api/03-api-details/system/Config.sol/struct.NamingConfig.md index a451c8e8..91023e7b 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Config.sol/struct.NamingConfig.md +++ b/site/docs/03-api/03-api-details/system/Config.sol/struct.NamingConfig.md @@ -1,5 +1,5 @@ # NamingConfig -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Config.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Config.sol) ```solidity diff --git a/site/docs/03-api/03-api-details/system/Config.sol/struct.SetupConfig.md b/site/docs/03-api/03-api-details/system/Config.sol/struct.SetupConfig.md new file mode 100644 index 00000000..4ba444cd --- /dev/null +++ b/site/docs/03-api/03-api-details/system/Config.sol/struct.SetupConfig.md @@ -0,0 +1,10 @@ +# SetupConfig +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Config.sol) + + +```solidity +struct SetupConfig { + bool STD_FUNCS; +} +``` + diff --git a/site/docs/03-api/03-api-details/system/Config.sol/struct.SystemConfig.md b/site/docs/03-api/03-api-details/system/Config.sol/struct.SystemConfig.md new file mode 100644 index 00000000..3649ff1d --- /dev/null +++ b/site/docs/03-api/03-api-details/system/Config.sol/struct.SystemConfig.md @@ -0,0 +1,11 @@ +# SystemConfig +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Config.sol) + + +```solidity +struct SystemConfig { + Logger.Level LOG_LEVEL; + uint256 SCAN_RANGE; +} +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Logger.sol/index.md b/site/docs/03-api/03-api-details/system/Logger.sol/index.md similarity index 65% rename from docs/05-resources/03-devkit/03-api-reference/system/Logger.sol/index.md rename to site/docs/03-api/03-api-details/system/Logger.sol/index.md index 13039c0a..a8a3c6c5 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Logger.sol/index.md +++ b/site/docs/03-api/03-api-details/system/Logger.sol/index.md @@ -1,5 +1,6 @@ -# Logger.sol +# Index - [library.Logger](./library.Logger.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Logger.sol/library.Logger.md b/site/docs/03-api/03-api-details/system/Logger.sol/library.Logger.md similarity index 92% rename from docs/05-resources/03-devkit/03-api-reference/system/Logger.sol/library.Logger.md rename to site/docs/03-api/03-api-details/system/Logger.sol/library.Logger.md index 6b5fd374..cfc3dfc9 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Logger.sol/library.Logger.md +++ b/site/docs/03-api/03-api-details/system/Logger.sol/library.Logger.md @@ -1,5 +1,5 @@ # Logger -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Logger.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Logger.sol) =============== 📊 Logger diff --git a/docs/05-resources/03-devkit/03-api-reference/system/System.sol/index.md b/site/docs/03-api/03-api-details/system/System.sol/index.md similarity index 65% rename from docs/05-resources/03-devkit/03-api-reference/system/System.sol/index.md rename to site/docs/03-api/03-api-details/system/System.sol/index.md index 8b2a7337..e24f4cb0 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/System.sol/index.md +++ b/site/docs/03-api/03-api-details/system/System.sol/index.md @@ -1,5 +1,6 @@ -# System.sol +# Index - [library.System](./library.System.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/system/System.sol/library.System.md b/site/docs/03-api/03-api-details/system/System.sol/library.System.md similarity index 72% rename from docs/05-resources/03-devkit/03-api-reference/system/System.sol/library.System.md rename to site/docs/03-api/03-api-details/system/System.sol/library.System.md index d3787e8f..d1a5fe15 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/System.sol/library.System.md +++ b/site/docs/03-api/03-api-details/system/System.sol/library.System.md @@ -1,5 +1,5 @@ # System -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/System.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/System.sol) ===============\ | 💻 System | diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/function.param.md b/site/docs/03-api/03-api-details/system/Tracer.sol/function.param.md similarity index 96% rename from docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/function.param.md rename to site/docs/03-api/03-api-details/system/Tracer.sol/function.param.md index eabea86e..a6be8645 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/function.param.md +++ b/site/docs/03-api/03-api-details/system/Tracer.sol/function.param.md @@ -1,5 +1,5 @@ # function param -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Tracer.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Tracer.sol) ### param(string) Params diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/index.md b/site/docs/03-api/03-api-details/system/Tracer.sol/index.md similarity index 84% rename from docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/index.md rename to site/docs/03-api/03-api-details/system/Tracer.sol/index.md index 4b4060f2..e6dc32cc 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/index.md +++ b/site/docs/03-api/03-api-details/system/Tracer.sol/index.md @@ -1,8 +1,9 @@ -# Tracer.sol +# Index - [function.param](./function.param.md) -- [library.Tracer](./library.Tracer.md) - [struct.Process](./struct.Process.md) - [struct.Trace](./struct.Trace.md) - +- [library.Tracer](./library.Tracer.md) + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/library.Tracer.md b/site/docs/03-api/03-api-details/system/Tracer.sol/library.Tracer.md similarity index 97% rename from docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/library.Tracer.md rename to site/docs/03-api/03-api-details/system/Tracer.sol/library.Tracer.md index 4f2a794b..132a6e22 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/library.Tracer.md +++ b/site/docs/03-api/03-api-details/system/Tracer.sol/library.Tracer.md @@ -1,5 +1,5 @@ # Tracer -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Tracer.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Tracer.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/struct.Process.md b/site/docs/03-api/03-api-details/system/Tracer.sol/struct.Process.md similarity index 50% rename from docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/struct.Process.md rename to site/docs/03-api/03-api-details/system/Tracer.sol/struct.Process.md index 4743792e..54b39010 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/struct.Process.md +++ b/site/docs/03-api/03-api-details/system/Tracer.sol/struct.Process.md @@ -1,5 +1,5 @@ # Process -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Tracer.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Tracer.sol) ```solidity diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/struct.Trace.md b/site/docs/03-api/03-api-details/system/Tracer.sol/struct.Trace.md similarity index 51% rename from docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/struct.Trace.md rename to site/docs/03-api/03-api-details/system/Tracer.sol/struct.Trace.md index fbb908ae..af3dc677 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Tracer.sol/struct.Trace.md +++ b/site/docs/03-api/03-api-details/system/Tracer.sol/struct.Trace.md @@ -1,10 +1,13 @@ # Trace -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Tracer.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Tracer.sol) ================= ⛓️ Process =================== +**Note:** +erc7201:mc.devkit.tracer + ```solidity struct Trace { diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Validator.sol/index.md b/site/docs/03-api/03-api-details/system/Validator.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/system/Validator.sol/index.md rename to site/docs/03-api/03-api-details/system/Validator.sol/index.md index cea9601c..6b2240af 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Validator.sol/index.md +++ b/site/docs/03-api/03-api-details/system/Validator.sol/index.md @@ -1,5 +1,6 @@ -# Validator.sol +# Index - [library.Validator](./library.Validator.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/system/Validator.sol/library.Validator.md b/site/docs/03-api/03-api-details/system/Validator.sol/library.Validator.md similarity index 98% rename from docs/05-resources/03-devkit/03-api-reference/system/Validator.sol/library.Validator.md rename to site/docs/03-api/03-api-details/system/Validator.sol/library.Validator.md index 28004f0c..e9738250 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/Validator.sol/library.Validator.md +++ b/site/docs/03-api/03-api-details/system/Validator.sol/library.Validator.md @@ -1,5 +1,5 @@ # Validator -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/Validator.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/Validator.sol) ================== ✅ Validator diff --git a/docs/05-resources/03-devkit/03-api-reference/system/index.md b/site/docs/03-api/03-api-details/system/index.md similarity index 100% rename from docs/05-resources/03-devkit/03-api-reference/system/index.md rename to site/docs/03-api/03-api-details/system/index.md diff --git a/docs/05-resources/03-devkit/03-api-reference/system/message/DecodeErrorString.sol/index.md b/site/docs/03-api/03-api-details/system/message/DecodeErrorString.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/system/message/DecodeErrorString.sol/index.md rename to site/docs/03-api/03-api-details/system/message/DecodeErrorString.sol/index.md index 0f89db50..b14de14c 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/message/DecodeErrorString.sol/index.md +++ b/site/docs/03-api/03-api-details/system/message/DecodeErrorString.sol/index.md @@ -1,5 +1,6 @@ -# DecodeErrorString.sol +# Index - [library.DecodeErrorString](./library.DecodeErrorString.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/system/message/DecodeErrorString.sol/library.DecodeErrorString.md b/site/docs/03-api/03-api-details/system/message/DecodeErrorString.sol/library.DecodeErrorString.md similarity index 91% rename from docs/05-resources/03-devkit/03-api-reference/system/message/DecodeErrorString.sol/library.DecodeErrorString.md rename to site/docs/03-api/03-api-details/system/message/DecodeErrorString.sol/library.DecodeErrorString.md index 5614ca1d..d5fa8f5a 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/message/DecodeErrorString.sol/library.DecodeErrorString.md +++ b/site/docs/03-api/03-api-details/system/message/DecodeErrorString.sol/library.DecodeErrorString.md @@ -1,5 +1,5 @@ # DecodeErrorString -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/message/DecodeErrorString.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/message/DecodeErrorString.sol) ## Functions diff --git a/docs/05-resources/03-devkit/03-api-reference/system/message/MessageBody.sol/index.md b/site/docs/03-api/03-api-details/system/message/MessageBody.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/system/message/MessageBody.sol/index.md rename to site/docs/03-api/03-api-details/system/message/MessageBody.sol/index.md index 262efd31..34072e6e 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/message/MessageBody.sol/index.md +++ b/site/docs/03-api/03-api-details/system/message/MessageBody.sol/index.md @@ -1,5 +1,6 @@ -# MessageBody.sol +# Index - [library.MessageBody](./library.MessageBody.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/system/message/MessageBody.sol/library.MessageBody.md b/site/docs/03-api/03-api-details/system/message/MessageBody.sol/library.MessageBody.md similarity index 98% rename from docs/05-resources/03-devkit/03-api-reference/system/message/MessageBody.sol/library.MessageBody.md rename to site/docs/03-api/03-api-details/system/message/MessageBody.sol/library.MessageBody.md index c3a46beb..a6ed7f30 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/message/MessageBody.sol/library.MessageBody.md +++ b/site/docs/03-api/03-api-details/system/message/MessageBody.sol/library.MessageBody.md @@ -1,5 +1,5 @@ # MessageBody -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/message/MessageBody.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/message/MessageBody.sol) ## State Variables diff --git a/docs/05-resources/03-devkit/03-api-reference/system/message/MessageHead.sol/index.md b/site/docs/03-api/03-api-details/system/message/MessageHead.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/system/message/MessageHead.sol/index.md rename to site/docs/03-api/03-api-details/system/message/MessageHead.sol/index.md index 368e690f..5cbbecc3 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/message/MessageHead.sol/index.md +++ b/site/docs/03-api/03-api-details/system/message/MessageHead.sol/index.md @@ -1,5 +1,6 @@ -# MessageHead.sol +# Index - [library.MessageHead](./library.MessageHead.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/system/message/MessageHead.sol/library.MessageHead.md b/site/docs/03-api/03-api-details/system/message/MessageHead.sol/library.MessageHead.md similarity index 97% rename from docs/05-resources/03-devkit/03-api-reference/system/message/MessageHead.sol/library.MessageHead.md rename to site/docs/03-api/03-api-details/system/message/MessageHead.sol/library.MessageHead.md index d5d8658a..85fd66de 100644 --- a/docs/05-resources/03-devkit/03-api-reference/system/message/MessageHead.sol/library.MessageHead.md +++ b/site/docs/03-api/03-api-details/system/message/MessageHead.sol/library.MessageHead.md @@ -1,5 +1,5 @@ # MessageHead -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/system/message/MessageHead.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/system/message/MessageHead.sol) ## State Variables diff --git a/site/docs/03-api/03-api-details/system/message/index.md b/site/docs/03-api/03-api-details/system/message/index.md new file mode 100644 index 00000000..753a0dad --- /dev/null +++ b/site/docs/03-api/03-api-details/system/message/index.md @@ -0,0 +1,7 @@ +# Message + + +- [DecodeErrorString](./DecodeErrorString.sol/library.DecodeErrorString.md) +- [MessageBody](./MessageBody.sol/library.MessageBody.md) +- [MessageHead](./MessageHead.sol/library.MessageHead.md) + diff --git a/docs/05-resources/03-devkit/03-api-reference/test/dummy/Dummy.sol/index.md b/site/docs/03-api/03-api-details/test/dummy/Dummy.sol/index.md similarity index 65% rename from docs/05-resources/03-devkit/03-api-reference/test/dummy/Dummy.sol/index.md rename to site/docs/03-api/03-api-details/test/dummy/Dummy.sol/index.md index e9c5d2fd..03d16df4 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/dummy/Dummy.sol/index.md +++ b/site/docs/03-api/03-api-details/test/dummy/Dummy.sol/index.md @@ -1,5 +1,6 @@ -# Dummy.sol +# Index - [library.Dummy](./library.Dummy.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/test/dummy/Dummy.sol/library.Dummy.md b/site/docs/03-api/03-api-details/test/dummy/Dummy.sol/library.Dummy.md similarity index 84% rename from docs/05-resources/03-devkit/03-api-reference/test/dummy/Dummy.sol/library.Dummy.md rename to site/docs/03-api/03-api-details/test/dummy/Dummy.sol/library.Dummy.md index f91a05aa..5472dc4d 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/dummy/Dummy.sol/library.Dummy.md +++ b/site/docs/03-api/03-api-details/test/dummy/Dummy.sol/library.Dummy.md @@ -1,5 +1,5 @@ # Dummy -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/test/dummy/Dummy.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/test/dummy/Dummy.sol) ## Functions diff --git a/site/docs/03-api/03-api-details/test/dummy/DummyContract.sol/contract.DummyContract.md b/site/docs/03-api/03-api-details/test/dummy/DummyContract.sol/contract.DummyContract.md new file mode 100644 index 00000000..29d2a576 --- /dev/null +++ b/site/docs/03-api/03-api-details/test/dummy/DummyContract.sol/contract.DummyContract.md @@ -0,0 +1,4 @@ +# DummyContract +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/test/dummy/DummyContract.sol) + + diff --git a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyContract.sol/index.md b/site/docs/03-api/03-api-details/test/dummy/DummyContract.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyContract.sol/index.md rename to site/docs/03-api/03-api-details/test/dummy/DummyContract.sol/index.md index 49364488..dc5386d3 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyContract.sol/index.md +++ b/site/docs/03-api/03-api-details/test/dummy/DummyContract.sol/index.md @@ -1,5 +1,6 @@ -# DummyContract.sol +# Index - [contract.DummyContract](./contract.DummyContract.md) - + + \ No newline at end of file diff --git a/site/docs/03-api/03-api-details/test/dummy/DummyFacade.sol/contract.DummyFacade.md b/site/docs/03-api/03-api-details/test/dummy/DummyFacade.sol/contract.DummyFacade.md new file mode 100644 index 00000000..0176d463 --- /dev/null +++ b/site/docs/03-api/03-api-details/test/dummy/DummyFacade.sol/contract.DummyFacade.md @@ -0,0 +1,4 @@ +# DummyFacade +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/test/dummy/DummyFacade.sol) + + diff --git a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFacade.sol/index.md b/site/docs/03-api/03-api-details/test/dummy/DummyFacade.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFacade.sol/index.md rename to site/docs/03-api/03-api-details/test/dummy/DummyFacade.sol/index.md index 2267d811..45374af1 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFacade.sol/index.md +++ b/site/docs/03-api/03-api-details/test/dummy/DummyFacade.sol/index.md @@ -1,5 +1,6 @@ -# DummyFacade.sol +# Index - [contract.DummyFacade](./contract.DummyFacade.md) - + + \ No newline at end of file diff --git a/site/docs/03-api/03-api-details/test/dummy/DummyFunction.sol/contract.DummyFunction.md b/site/docs/03-api/03-api-details/test/dummy/DummyFunction.sol/contract.DummyFunction.md new file mode 100644 index 00000000..a75dc232 --- /dev/null +++ b/site/docs/03-api/03-api-details/test/dummy/DummyFunction.sol/contract.DummyFunction.md @@ -0,0 +1,19 @@ +# DummyFunction +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/test/dummy/DummyFunction.sol) + + +## Functions +### dummy + + +```solidity +function dummy() external; +``` + +### dummy2 + + +```solidity +function dummy2() external; +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFunction.sol/index.md b/site/docs/03-api/03-api-details/test/dummy/DummyFunction.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFunction.sol/index.md rename to site/docs/03-api/03-api-details/test/dummy/DummyFunction.sol/index.md index 48bad4f0..e357f6ba 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/dummy/DummyFunction.sol/index.md +++ b/site/docs/03-api/03-api-details/test/dummy/DummyFunction.sol/index.md @@ -1,5 +1,6 @@ -# DummyFunction.sol +# Index - [contract.DummyFunction](./contract.DummyFunction.md) - + + \ No newline at end of file diff --git a/site/docs/03-api/03-api-details/test/dummy/index.md b/site/docs/03-api/03-api-details/test/dummy/index.md new file mode 100644 index 00000000..00613185 --- /dev/null +++ b/site/docs/03-api/03-api-details/test/dummy/index.md @@ -0,0 +1,8 @@ +# Dummy + + +- [Dummy](./Dummy.sol/library.Dummy.md) +- [DummyContract](./DummyContract.sol/contract.DummyContract.md) +- [DummyFacade](./DummyFacade.sol/contract.DummyFacade.md) +- [DummyFunction](./DummyFunction.sol/contract.DummyFunction.md) + diff --git a/docs/05-resources/03-devkit/03-api-reference/test/index.md b/site/docs/03-api/03-api-details/test/index.md similarity index 100% rename from docs/05-resources/03-devkit/03-api-reference/test/index.md rename to site/docs/03-api/03-api-details/test/index.md diff --git a/docs/05-resources/03-devkit/03-api-reference/test/mocks/MockDictionary.sol/contract.MockDictionary.md b/site/docs/03-api/03-api-details/test/mocks/MockDictionary.sol/contract.MockDictionary.md similarity index 51% rename from docs/05-resources/03-devkit/03-api-reference/test/mocks/MockDictionary.sol/contract.MockDictionary.md rename to site/docs/03-api/03-api-details/test/mocks/MockDictionary.sol/contract.MockDictionary.md index a6181d84..caceac7a 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/mocks/MockDictionary.sol/contract.MockDictionary.md +++ b/site/docs/03-api/03-api-details/test/mocks/MockDictionary.sol/contract.MockDictionary.md @@ -1,5 +1,5 @@ # MockDictionary -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/test/mocks/MockDictionary.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/test/mocks/MockDictionary.sol) **Inherits:** Dictionary diff --git a/docs/05-resources/03-devkit/03-api-reference/test/mocks/MockDictionary.sol/index.md b/site/docs/03-api/03-api-details/test/mocks/MockDictionary.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/test/mocks/MockDictionary.sol/index.md rename to site/docs/03-api/03-api-details/test/mocks/MockDictionary.sol/index.md index 4fc69820..8c0cfb20 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/mocks/MockDictionary.sol/index.md +++ b/site/docs/03-api/03-api-details/test/mocks/MockDictionary.sol/index.md @@ -1,5 +1,6 @@ -# MockDictionary.sol +# Index - [contract.MockDictionary](./contract.MockDictionary.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/test/mocks/SimpleMockProxy.sol/contract.SimpleMockProxy.md b/site/docs/03-api/03-api-details/test/mocks/SimpleMockProxy.sol/contract.SimpleMockProxy.md similarity index 60% rename from docs/05-resources/03-devkit/03-api-reference/test/mocks/SimpleMockProxy.sol/contract.SimpleMockProxy.md rename to site/docs/03-api/03-api-details/test/mocks/SimpleMockProxy.sol/contract.SimpleMockProxy.md index a8c7ba71..b9bbb12c 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/mocks/SimpleMockProxy.sol/contract.SimpleMockProxy.md +++ b/site/docs/03-api/03-api-details/test/mocks/SimpleMockProxy.sol/contract.SimpleMockProxy.md @@ -1,5 +1,5 @@ # SimpleMockProxy -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/test/mocks/SimpleMockProxy.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/test/mocks/SimpleMockProxy.sol) **Inherits:** OZProxy diff --git a/docs/05-resources/03-devkit/03-api-reference/test/mocks/SimpleMockProxy.sol/index.md b/site/docs/03-api/03-api-details/test/mocks/SimpleMockProxy.sol/index.md similarity index 78% rename from docs/05-resources/03-devkit/03-api-reference/test/mocks/SimpleMockProxy.sol/index.md rename to site/docs/03-api/03-api-details/test/mocks/SimpleMockProxy.sol/index.md index 3dd8adad..a6535479 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/mocks/SimpleMockProxy.sol/index.md +++ b/site/docs/03-api/03-api-details/test/mocks/SimpleMockProxy.sol/index.md @@ -1,6 +1,7 @@ -# SimpleMockProxy.sol +# Index - [contract.SimpleMockProxy](./contract.SimpleMockProxy.md) - [library.SimpleMockProxyLib](./library.SimpleMockProxyLib.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/test/mocks/SimpleMockProxy.sol/library.SimpleMockProxyLib.md b/site/docs/03-api/03-api-details/test/mocks/SimpleMockProxy.sol/library.SimpleMockProxyLib.md similarity index 79% rename from docs/05-resources/03-devkit/03-api-reference/test/mocks/SimpleMockProxy.sol/library.SimpleMockProxyLib.md rename to site/docs/03-api/03-api-details/test/mocks/SimpleMockProxy.sol/library.SimpleMockProxyLib.md index 013e1450..5502aa36 100644 --- a/docs/05-resources/03-devkit/03-api-reference/test/mocks/SimpleMockProxy.sol/library.SimpleMockProxyLib.md +++ b/site/docs/03-api/03-api-details/test/mocks/SimpleMockProxy.sol/library.SimpleMockProxyLib.md @@ -1,5 +1,5 @@ # SimpleMockProxyLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/test/mocks/SimpleMockProxy.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/test/mocks/SimpleMockProxy.sol) ## State Variables @@ -34,6 +34,9 @@ function getImplementation(bytes4 selector) internal view returns (address); ## Structs ### SimpleMockProxyStorage +**Note:** +erc7021:mc.mock.proxy + ```solidity struct SimpleMockProxyStorage { diff --git a/site/docs/03-api/03-api-details/test/mocks/index.md b/site/docs/03-api/03-api-details/test/mocks/index.md new file mode 100644 index 00000000..b6567c60 --- /dev/null +++ b/site/docs/03-api/03-api-details/test/mocks/index.md @@ -0,0 +1,7 @@ +# Mocks + + +- [MockDictionary](./MockDictionary.sol/contract.MockDictionary.md) +- [SimpleMockProxy](./SimpleMockProxy.sol/contract.SimpleMockProxy.md) +- [SimpleMockProxyLib](./SimpleMockProxy.sol/library.SimpleMockProxyLib.md) + diff --git a/docs/05-resources/03-devkit/03-api-reference/types/Formatter.sol/index.md b/site/docs/03-api/03-api-details/types/Formatter.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/types/Formatter.sol/index.md rename to site/docs/03-api/03-api-details/types/Formatter.sol/index.md index eb07db20..5c6938d8 100644 --- a/docs/05-resources/03-devkit/03-api-reference/types/Formatter.sol/index.md +++ b/site/docs/03-api/03-api-details/types/Formatter.sol/index.md @@ -1,5 +1,6 @@ -# Formatter.sol +# Index - [library.Formatter](./library.Formatter.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/types/Formatter.sol/library.Formatter.md b/site/docs/03-api/03-api-details/types/Formatter.sol/library.Formatter.md similarity index 96% rename from docs/05-resources/03-devkit/03-api-reference/types/Formatter.sol/library.Formatter.md rename to site/docs/03-api/03-api-details/types/Formatter.sol/library.Formatter.md index b567fbd3..f4624bb7 100644 --- a/docs/05-resources/03-devkit/03-api-reference/types/Formatter.sol/library.Formatter.md +++ b/site/docs/03-api/03-api-details/types/Formatter.sol/library.Formatter.md @@ -1,5 +1,5 @@ # Formatter -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/types/Formatter.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/types/Formatter.sol) ================== 🗒️ Formatter diff --git a/docs/05-resources/03-devkit/03-api-reference/types/Inspector.sol/index.md b/site/docs/03-api/03-api-details/types/Inspector.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/types/Inspector.sol/index.md rename to site/docs/03-api/03-api-details/types/Inspector.sol/index.md index c6d5510a..48029151 100644 --- a/docs/05-resources/03-devkit/03-api-reference/types/Inspector.sol/index.md +++ b/site/docs/03-api/03-api-details/types/Inspector.sol/index.md @@ -1,5 +1,6 @@ -# Inspector.sol +# Index - [library.Inspector](./library.Inspector.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/types/Inspector.sol/library.Inspector.md b/site/docs/03-api/03-api-details/types/Inspector.sol/library.Inspector.md similarity index 97% rename from docs/05-resources/03-devkit/03-api-reference/types/Inspector.sol/library.Inspector.md rename to site/docs/03-api/03-api-details/types/Inspector.sol/library.Inspector.md index ccc066ab..b78ad5aa 100644 --- a/docs/05-resources/03-devkit/03-api-reference/types/Inspector.sol/library.Inspector.md +++ b/site/docs/03-api/03-api-details/types/Inspector.sol/library.Inspector.md @@ -1,5 +1,5 @@ # Inspector -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/types/Inspector.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/types/Inspector.sol) =================== 🕵️‍♀️ Inspector diff --git a/docs/05-resources/03-devkit/03-api-reference/types/Parser.sol/index.md b/site/docs/03-api/03-api-details/types/Parser.sol/index.md similarity index 65% rename from docs/05-resources/03-devkit/03-api-reference/types/Parser.sol/index.md rename to site/docs/03-api/03-api-details/types/Parser.sol/index.md index b82e4f63..4ee4a4f9 100644 --- a/docs/05-resources/03-devkit/03-api-reference/types/Parser.sol/index.md +++ b/site/docs/03-api/03-api-details/types/Parser.sol/index.md @@ -1,5 +1,6 @@ -# Parser.sol +# Index - [library.Parser](./library.Parser.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/types/Parser.sol/library.Parser.md b/site/docs/03-api/03-api-details/types/Parser.sol/library.Parser.md similarity index 61% rename from docs/05-resources/03-devkit/03-api-reference/types/Parser.sol/library.Parser.md rename to site/docs/03-api/03-api-details/types/Parser.sol/library.Parser.md index debca090..71179837 100644 --- a/docs/05-resources/03-devkit/03-api-reference/types/Parser.sol/library.Parser.md +++ b/site/docs/03-api/03-api-details/types/Parser.sol/library.Parser.md @@ -1,5 +1,5 @@ # Parser -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/types/Parser.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/types/Parser.sol) =============== 🗒️ Parser diff --git a/site/docs/03-api/03-api-details/types/TypeGuard.sol/enum.TypeStatus.md b/site/docs/03-api/03-api-details/types/TypeGuard.sol/enum.TypeStatus.md new file mode 100644 index 00000000..879795e2 --- /dev/null +++ b/site/docs/03-api/03-api-details/types/TypeGuard.sol/enum.TypeStatus.md @@ -0,0 +1,13 @@ +# TypeStatus +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/types/TypeGuard.sol) + + +```solidity +enum TypeStatus { + Uninitialized, + Building, + Built, + Locked +} +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/types/TypeGuard.sol/index.md b/site/docs/03-api/03-api-details/types/TypeGuard.sol/index.md similarity index 75% rename from docs/05-resources/03-devkit/03-api-reference/types/TypeGuard.sol/index.md rename to site/docs/03-api/03-api-details/types/TypeGuard.sol/index.md index 8e3e91c2..6882d0de 100644 --- a/docs/05-resources/03-devkit/03-api-reference/types/TypeGuard.sol/index.md +++ b/site/docs/03-api/03-api-details/types/TypeGuard.sol/index.md @@ -1,6 +1,7 @@ -# TypeGuard.sol +# Index - [enum.TypeStatus](./enum.TypeStatus.md) - [library.TypeGuard](./library.TypeGuard.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/types/TypeGuard.sol/library.TypeGuard.md b/site/docs/03-api/03-api-details/types/TypeGuard.sol/library.TypeGuard.md similarity index 94% rename from docs/05-resources/03-devkit/03-api-reference/types/TypeGuard.sol/library.TypeGuard.md rename to site/docs/03-api/03-api-details/types/TypeGuard.sol/library.TypeGuard.md index 05a5a6c6..242f168f 100644 --- a/docs/05-resources/03-devkit/03-api-reference/types/TypeGuard.sol/library.TypeGuard.md +++ b/site/docs/03-api/03-api-details/types/TypeGuard.sol/library.TypeGuard.md @@ -1,5 +1,5 @@ # TypeGuard -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/types/TypeGuard.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/types/TypeGuard.sol) ================================================== 🔒 Type Guard diff --git a/docs/05-resources/03-devkit/03-api-reference/types/index.md b/site/docs/03-api/03-api-details/types/index.md similarity index 100% rename from docs/05-resources/03-devkit/03-api-reference/types/index.md rename to site/docs/03-api/03-api-details/types/index.md diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/constants.ForgeHelper.md b/site/docs/03-api/03-api-details/utils/ForgeHelper.sol/constants.ForgeHelper.md similarity index 52% rename from docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/constants.ForgeHelper.md rename to site/docs/03-api/03-api-details/utils/ForgeHelper.sol/constants.ForgeHelper.md index f52da1c4..b29a76f7 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/constants.ForgeHelper.md +++ b/site/docs/03-api/03-api-details/utils/ForgeHelper.sol/constants.ForgeHelper.md @@ -1,5 +1,5 @@ # Constants -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/utils/ForgeHelper.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/utils/ForgeHelper.sol) ### vm *address(uint160(uint256(keccak256("hevm cheat code"))));* diff --git a/site/docs/03-api/03-api-details/utils/ForgeHelper.sol/function.loadAddressFrom.md b/site/docs/03-api/03-api-details/utils/ForgeHelper.sol/function.loadAddressFrom.md new file mode 100644 index 00000000..11ca8917 --- /dev/null +++ b/site/docs/03-api/03-api-details/utils/ForgeHelper.sol/function.loadAddressFrom.md @@ -0,0 +1,8 @@ +# loadAddressFrom +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/utils/ForgeHelper.sol) + + +```solidity +function loadAddressFrom(string memory envKey) view returns (address); +``` + diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/index.md b/site/docs/03-api/03-api-details/utils/ForgeHelper.sol/index.md similarity index 83% rename from docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/index.md rename to site/docs/03-api/03-api-details/utils/ForgeHelper.sol/index.md index 0de43cca..cec59e4e 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/index.md +++ b/site/docs/03-api/03-api-details/utils/ForgeHelper.sol/index.md @@ -1,7 +1,8 @@ -# ForgeHelper.sol +# Index -- [constants.ForgeHelper](./constants.ForgeHelper.md) - [function.loadAddressFrom](./function.loadAddressFrom.md) - [library.ForgeHelper](./library.ForgeHelper.md) - +- [constants.ForgeHelper](./constants.ForgeHelper.md) + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/library.ForgeHelper.md b/site/docs/03-api/03-api-details/utils/ForgeHelper.sol/library.ForgeHelper.md similarity index 94% rename from docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/library.ForgeHelper.md rename to site/docs/03-api/03-api-details/utils/ForgeHelper.sol/library.ForgeHelper.md index 34f43e8b..eae23402 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/ForgeHelper.sol/library.ForgeHelper.md +++ b/site/docs/03-api/03-api-details/utils/ForgeHelper.sol/library.ForgeHelper.md @@ -1,5 +1,5 @@ # ForgeHelper -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/utils/ForgeHelper.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/utils/ForgeHelper.sol) 🛠 Helper Methods for Forge Std diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCDeployLib.sol/index.md b/site/docs/03-api/03-api-details/utils/global/MCDeployLib.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCDeployLib.sol/index.md rename to site/docs/03-api/03-api-details/utils/global/MCDeployLib.sol/index.md index af1e28c0..0116d271 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCDeployLib.sol/index.md +++ b/site/docs/03-api/03-api-details/utils/global/MCDeployLib.sol/index.md @@ -1,5 +1,6 @@ -# MCDeployLib.sol +# Index - [library.MCDeployLib](./library.MCDeployLib.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCDeployLib.sol/library.MCDeployLib.md b/site/docs/03-api/03-api-details/utils/global/MCDeployLib.sol/library.MCDeployLib.md similarity index 96% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCDeployLib.sol/library.MCDeployLib.md rename to site/docs/03-api/03-api-details/utils/global/MCDeployLib.sol/library.MCDeployLib.md index a4c9fc8f..2e1d61bc 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCDeployLib.sol/library.MCDeployLib.md +++ b/site/docs/03-api/03-api-details/utils/global/MCDeployLib.sol/library.MCDeployLib.md @@ -1,5 +1,5 @@ # MCDeployLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/utils/global/MCDeployLib.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/utils/global/MCDeployLib.sol) 🚀 Deployment 🌞 Deploy Meta Contract diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCFinderLib.sol/index.md b/site/docs/03-api/03-api-details/utils/global/MCFinderLib.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCFinderLib.sol/index.md rename to site/docs/03-api/03-api-details/utils/global/MCFinderLib.sol/index.md index 8b055585..d46b5b64 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCFinderLib.sol/index.md +++ b/site/docs/03-api/03-api-details/utils/global/MCFinderLib.sol/index.md @@ -1,5 +1,6 @@ -# MCFinderLib.sol +# Index - [library.MCFinderLib](./library.MCFinderLib.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCFinderLib.sol/library.MCFinderLib.md b/site/docs/03-api/03-api-details/utils/global/MCFinderLib.sol/library.MCFinderLib.md similarity index 78% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCFinderLib.sol/library.MCFinderLib.md rename to site/docs/03-api/03-api-details/utils/global/MCFinderLib.sol/library.MCFinderLib.md index 577daa25..6d55df43 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCFinderLib.sol/library.MCFinderLib.md +++ b/site/docs/03-api/03-api-details/utils/global/MCFinderLib.sol/library.MCFinderLib.md @@ -1,5 +1,5 @@ # MCFinderLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/utils/global/MCFinderLib.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/utils/global/MCFinderLib.sol) 🔍 Finder 🏠 Find Current Proxy Address diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCHelpers.sol/index.md b/site/docs/03-api/03-api-details/utils/global/MCHelpers.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCHelpers.sol/index.md rename to site/docs/03-api/03-api-details/utils/global/MCHelpers.sol/index.md index f77f3ba0..3a88e7f6 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCHelpers.sol/index.md +++ b/site/docs/03-api/03-api-details/utils/global/MCHelpers.sol/index.md @@ -1,5 +1,6 @@ -# MCHelpers.sol +# Index - [library.MCHelpers](./library.MCHelpers.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCHelpers.sol/library.MCHelpers.md b/site/docs/03-api/03-api-details/utils/global/MCHelpers.sol/library.MCHelpers.md similarity index 95% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCHelpers.sol/library.MCHelpers.md rename to site/docs/03-api/03-api-details/utils/global/MCHelpers.sol/library.MCHelpers.md index f5e6c756..64cd1b73 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCHelpers.sol/library.MCHelpers.md +++ b/site/docs/03-api/03-api-details/utils/global/MCHelpers.sol/library.MCHelpers.md @@ -1,5 +1,5 @@ # MCHelpers -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/utils/global/MCHelpers.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/utils/global/MCHelpers.sol) 🛠️ Helper ♻️ Reset Current Context diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCInitLib.sol/index.md b/site/docs/03-api/03-api-details/utils/global/MCInitLib.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCInitLib.sol/index.md rename to site/docs/03-api/03-api-details/utils/global/MCInitLib.sol/index.md index 699532d7..04b319be 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCInitLib.sol/index.md +++ b/site/docs/03-api/03-api-details/utils/global/MCInitLib.sol/index.md @@ -1,5 +1,6 @@ -# MCInitLib.sol +# Index - [library.MCInitLib](./library.MCInitLib.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCInitLib.sol/library.MCInitLib.md b/site/docs/03-api/03-api-details/utils/global/MCInitLib.sol/library.MCInitLib.md similarity index 90% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCInitLib.sol/library.MCInitLib.md rename to site/docs/03-api/03-api-details/utils/global/MCInitLib.sol/library.MCInitLib.md index 8f32a2ff..0310c05a 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCInitLib.sol/library.MCInitLib.md +++ b/site/docs/03-api/03-api-details/utils/global/MCInitLib.sol/library.MCInitLib.md @@ -1,5 +1,5 @@ # MCInitLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/utils/global/MCInitLib.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/utils/global/MCInitLib.sol) 🎁 MC Initial Configuration 🌱 Init Bundle diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCMockLib.sol/index.md b/site/docs/03-api/03-api-details/utils/global/MCMockLib.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCMockLib.sol/index.md rename to site/docs/03-api/03-api-details/utils/global/MCMockLib.sol/index.md index 8f3085e1..afc99752 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCMockLib.sol/index.md +++ b/site/docs/03-api/03-api-details/utils/global/MCMockLib.sol/index.md @@ -1,5 +1,6 @@ -# MCMockLib.sol +# Index - [library.MCMockLib](./library.MCMockLib.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCMockLib.sol/library.MCMockLib.md b/site/docs/03-api/03-api-details/utils/global/MCMockLib.sol/library.MCMockLib.md similarity index 91% rename from docs/05-resources/03-devkit/03-api-reference/utils/global/MCMockLib.sol/library.MCMockLib.md rename to site/docs/03-api/03-api-details/utils/global/MCMockLib.sol/library.MCMockLib.md index 4320a144..83020bab 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/global/MCMockLib.sol/library.MCMockLib.md +++ b/site/docs/03-api/03-api-details/utils/global/MCMockLib.sol/library.MCMockLib.md @@ -1,5 +1,5 @@ # MCMockLib -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/utils/global/MCMockLib.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/utils/global/MCMockLib.sol) 🎭 Mock 🌞 Mocking Meta Contract diff --git a/site/docs/03-api/03-api-details/utils/global/index.md b/site/docs/03-api/03-api-details/utils/global/index.md new file mode 100644 index 00000000..8d1d134a --- /dev/null +++ b/site/docs/03-api/03-api-details/utils/global/index.md @@ -0,0 +1,9 @@ +# Global + + +- [MCDeployLib](./MCDeployLib.sol/library.MCDeployLib.md) +- [MCFinderLib](./MCFinderLib.sol/library.MCFinderLib.md) +- [MCHelpers](./MCHelpers.sol/library.MCHelpers.md) +- [MCInitLib](./MCInitLib.sol/library.MCInitLib.md) +- [MCMockLib](./MCMockLib.sol/library.MCMockLib.md) + diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/index.md b/site/docs/03-api/03-api-details/utils/index.md similarity index 100% rename from docs/05-resources/03-devkit/03-api-reference/utils/index.md rename to site/docs/03-api/03-api-details/utils/index.md diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/mapping/NameGenerator.sol/index.md b/site/docs/03-api/03-api-details/utils/mapping/NameGenerator.sol/index.md similarity index 66% rename from docs/05-resources/03-devkit/03-api-reference/utils/mapping/NameGenerator.sol/index.md rename to site/docs/03-api/03-api-details/utils/mapping/NameGenerator.sol/index.md index fa25198d..0b1150de 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/mapping/NameGenerator.sol/index.md +++ b/site/docs/03-api/03-api-details/utils/mapping/NameGenerator.sol/index.md @@ -1,5 +1,6 @@ -# NameGenerator.sol +# Index - [library.NameGenerator](./library.NameGenerator.md) - + + \ No newline at end of file diff --git a/docs/05-resources/03-devkit/03-api-reference/utils/mapping/NameGenerator.sol/library.NameGenerator.md b/site/docs/03-api/03-api-details/utils/mapping/NameGenerator.sol/library.NameGenerator.md similarity index 93% rename from docs/05-resources/03-devkit/03-api-reference/utils/mapping/NameGenerator.sol/library.NameGenerator.md rename to site/docs/03-api/03-api-details/utils/mapping/NameGenerator.sol/library.NameGenerator.md index d957b91a..6db7c78a 100644 --- a/docs/05-resources/03-devkit/03-api-reference/utils/mapping/NameGenerator.sol/library.NameGenerator.md +++ b/site/docs/03-api/03-api-details/utils/mapping/NameGenerator.sol/library.NameGenerator.md @@ -1,5 +1,5 @@ # NameGenerator -[Git Source](https://github.com/metacontract/mc/blob/df7a49283d8212c99bebd64a186325e91d34c075/resources/devkit/api-reference/utils/mapping/NameGenerator.sol) +[Git Source](https://github.com/metacontract/mc/blob/20954f1387efa0bc72b42d3e78a22f9f845eebbd/src/devkit/utils/mapping/NameGenerator.sol) ======================= 🏷️ Name Generator diff --git a/site/docs/03-api/03-api-details/utils/mapping/index.md b/site/docs/03-api/03-api-details/utils/mapping/index.md new file mode 100644 index 00000000..3182dbbe --- /dev/null +++ b/site/docs/03-api/03-api-details/utils/mapping/index.md @@ -0,0 +1,5 @@ +# mapping + + +- [NameGenerator](./NameGenerator.sol/library.NameGenerator.md) + diff --git a/site/docs/03-api/index.md b/site/docs/03-api/index.md new file mode 100644 index 00000000..ae8116ee --- /dev/null +++ b/site/docs/03-api/index.md @@ -0,0 +1,17 @@ +--- +keywords: [devkit, api, usage, best-practices] +tags: [devkit, api, usage, best-practices] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# API Reference + +This section provides the API reference for the Meta Contract DevKit. + +## Contents + +- [Overview](./01-overview.md) +- [Usage Guide](./02-usage.md) +- [API Details](./03-api-details/index.md) diff --git a/site/docs/04-examples/01-dao/01-textdao.md b/site/docs/04-examples/01-dao/01-textdao.md new file mode 100644 index 00000000..92a3e5bd --- /dev/null +++ b/site/docs/04-examples/01-dao/01-textdao.md @@ -0,0 +1,21 @@ +--- +keywords: [DAO, example, Solidity] +tags: [DAO, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# TextDAO Example + +This example demonstrates a TextDAO structure in Solidity, including a voting mechanism for proposals and handling votes. + +- [GitHub Repository](https://github.com/ecdysisxyz/textdao-monorepo) + +## Overview + +The TextDAO example demonstrates: + +1. DAO structure in Solidity +2. Voting mechanism implementation +3. Handling proposals and votes diff --git a/site/docs/04-examples/01-dao/02-simple-dao.md b/site/docs/04-examples/01-dao/02-simple-dao.md new file mode 100644 index 00000000..12d53a5f --- /dev/null +++ b/site/docs/04-examples/01-dao/02-simple-dao.md @@ -0,0 +1,21 @@ +--- +keywords: [DAO, example, Solidity] +tags: [DAO, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Simple DAO Example + +This example demonstrates a simple DAO structure in Solidity, including a voting mechanism for proposals and handling votes. + +- [GitHub Repository](https://github.com/ecdysisxyz/simple-dao) + +## Overview + +The Simple DAO example demonstrates: + +1. DAO structure in Solidity +2. Voting mechanism implementation +3. Handling proposals and votes diff --git a/site/docs/04-examples/01-dao/index.md b/site/docs/04-examples/01-dao/index.md new file mode 100644 index 00000000..985f60b2 --- /dev/null +++ b/site/docs/04-examples/01-dao/index.md @@ -0,0 +1,19 @@ +--- +sidebar_label: DAO +keywords: [DAO, example, Solidity] +tags: [DAO, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Examples of DAO Implementations + +This section provides examples of implementing various DAO structures, such as TextDAO. + +## Contents + +- [TextDAO](01-textdao.md) +- [Simple DAO](02-simple-dao.md) + +Each example demonstrates the complete implementation of the respective DAO structure, from code structure to deployment. diff --git a/site/docs/04-examples/02-defi/01-stable-credit.md b/site/docs/04-examples/02-defi/01-stable-credit.md new file mode 100644 index 00000000..9401b85e --- /dev/null +++ b/site/docs/04-examples/02-defi/01-stable-credit.md @@ -0,0 +1,21 @@ +--- +keywords: [StableCoin, example, Solidity] +tags: [StableCoin, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Stable Credit Example + +This example demonstrates a stablecoin system using Solidity, including stablecoin issuance and redemption, pegging mechanisms, and credit scoring. + +- [GitHub Repository](https://github.com/ecdysisxyz/StableCredit) + +## Overview + +The Stable Credit example demonstrates: + +1. Stablecoin issuance and redemption +2. Pegging mechanisms +3. Credit scoring and stability mechanisms diff --git a/site/docs/04-examples/02-defi/02-simple-dex.md b/site/docs/04-examples/02-defi/02-simple-dex.md new file mode 100644 index 00000000..30810a2a --- /dev/null +++ b/site/docs/04-examples/02-defi/02-simple-dex.md @@ -0,0 +1,21 @@ +--- +keywords: [DEX, example, Solidity] +tags: [DEX, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Simple DEX Example + +This example demonstrates a simple decentralized exchange (DEX) using Solidity, including liquidity pool management and token swapping mechanism. + +- [GitHub Repository](https://github.com/ecdysisxyz/forkathon-dex) + +## Overview + +The Simple DEX example demonstrates: + +1. Liquidity pool management +2. Token swapping mechanism +3. Smart contract interactions with ERC20 tokens diff --git a/site/docs/04-examples/02-defi/index.md b/site/docs/04-examples/02-defi/index.md new file mode 100644 index 00000000..0d072a3e --- /dev/null +++ b/site/docs/04-examples/02-defi/index.md @@ -0,0 +1,19 @@ +--- +sidebar_label: DeFi +keywords: [DeFi, example, Solidity] +tags: [DeFi, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Examples of DeFi + +This section provides examples of implementing various DeFi protocols, such as lending, borrowing, and staking. + +## Contents + +- [Stable Credit](01-stable-credit.md) +- [Simple DEX](02-simple-dex.md) + +Each example demonstrates the complete implementation of the respective DeFi protocol, from code structure to deployment. diff --git a/site/docs/04-examples/03-erc/01-erc20.md b/site/docs/04-examples/03-erc/01-erc20.md new file mode 100644 index 00000000..198a4954 --- /dev/null +++ b/site/docs/04-examples/03-erc/01-erc20.md @@ -0,0 +1,21 @@ +--- +keywords: [ERC20, example, Solidity] +tags: [ERC20, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# ERC-20 Example + +This example demonstrates how to implement an ERC20 token using Meta Contract. + +- [GitHub Repository](https://github.com/ecdysisxyz/ERC20) + +## Overview + +The ERC20 example demonstrates: + +1. Token creation +2. Transfer and approval mechanics +3. ERC20 interface implementation diff --git a/site/docs/04-examples/03-erc/02-erc721.md b/site/docs/04-examples/03-erc/02-erc721.md new file mode 100644 index 00000000..f9be340f --- /dev/null +++ b/site/docs/04-examples/03-erc/02-erc721.md @@ -0,0 +1,21 @@ +--- +keywords: [ERC721, example, Solidity] +tags: [ERC721, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# ERC-721 Example + +This example demonstrates how to implement an ERC-721 token using Meta Contract. + +- [GitHub Repository](https://github.com/ecdysisxyz/ERC721) + +## Overview + +The ERC-721 example demonstrates: + +1. NFT creation +2. Token metadata and ownership +3. ERC-721 interface implementation diff --git a/site/docs/04-examples/03-erc/03-erc1155.md b/site/docs/04-examples/03-erc/03-erc1155.md new file mode 100644 index 00000000..fd6b05d2 --- /dev/null +++ b/site/docs/04-examples/03-erc/03-erc1155.md @@ -0,0 +1,21 @@ +--- +keywords: [ERC1155, example, Solidity] +tags: [ERC1155, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# ERC-1155 Example + +This example demonstrates how to implement an ERC-1155 multi-token standard using Meta Contract. + +- [GitHub Repository](https://github.com/ecdysisxyz/ERC1155) + +## Overview + +The ERC-1155 example demonstrates: + +1. Multi-token management +2. Batch transfers +3. ERC-1155 interface implementation diff --git a/site/docs/04-examples/03-erc/04-erc4337.md b/site/docs/04-examples/03-erc/04-erc4337.md new file mode 100644 index 00000000..8edfde77 --- /dev/null +++ b/site/docs/04-examples/03-erc/04-erc4337.md @@ -0,0 +1,21 @@ +--- +keywords: [ERC4337, example, Solidity] +tags: [ERC4337, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# ERC-4337 Example + +This example demonstrates how to implement ERC-4337, focused on account abstraction. + +- [GitHub Repository](https://github.com/ecdysisxyz/ERC4337) + +## Overview + +The ERC-4337 example demonstrates: + +1. Account abstraction mechanics +2. User operations +3. ERC-4337 interface implementation diff --git a/site/docs/04-examples/03-erc/index.md b/site/docs/04-examples/03-erc/index.md new file mode 100644 index 00000000..e60bd952 --- /dev/null +++ b/site/docs/04-examples/03-erc/index.md @@ -0,0 +1,21 @@ +--- +sidebar_label: ERC +keywords: [ERC standards, example, Solidity] +tags: [ERC standards, example, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Examples of ERC Implementations + +This section provides examples of implementing various ERC standards, such as ERC-20, ERC-721, ERC-1155, and ERC-4337. + +## Contents + +- [ERC-20 Example](01-erc20.md) +- [ERC-721 Example](02-erc721.md) +- [ERC-1155 Example](03-erc1155.md) +- [ERC-4337 Example](04-erc4337.md) + +Each example demonstrates the complete implementation of the respective ERC standard, from code structure to deployment. diff --git a/site/docs/04-examples/index.md b/site/docs/04-examples/index.md new file mode 100644 index 00000000..44206cad --- /dev/null +++ b/site/docs/04-examples/index.md @@ -0,0 +1,28 @@ +--- +keywords: [examples, guide, Solidity] +tags: [examples, guide, Solidity] +last_update: + date: 2024-10-26 + author: Meta Contract Development Team +--- + +# Examples + +This section contains examples that guide you through various implementations of smart contracts and decentralized applications using the Meta Contract framework. + +## DAO + +- [TextDAO](./01-dao/01-textdao.md) +- [Simple DAO](./01-dao/02-simple-dao.md) + +## DeFi + +- [Stable Credit](./02-defi/01-stable-credit.md) +- [Simple DEX](./02-defi/02-simple-dex.md) + +## ERC Implementations + +- [ERC20 Implementation](./03-erc/01-erc20.md) +- [ERC721 Implementation](./03-erc/02-erc721.md) +- [ERC1155 Implementation](./03-erc/03-erc1155.md) +- [ERC4337 Implementation](./03-erc/04-erc4337.md) diff --git a/site/docusaurus.config.ts b/site/docusaurus.config.ts new file mode 100644 index 00000000..df01ff71 --- /dev/null +++ b/site/docusaurus.config.ts @@ -0,0 +1,191 @@ +import type * as Preset from "@docusaurus/preset-classic"; +import type { Config } from "@docusaurus/types"; +import { themes as prismThemes } from "prism-react-renderer"; + +const config: Config = { + title: "Meta Contract", + tagline: + "A flexible and upgradeable smart contract framework optimized for AI integration and DevOps efficiency, enabling streamlined development and testing.", + favicon: "img/favicon.ico", + + url: "https://mc-book.ecdysis.xyz", + baseUrl: "/", + + organizationName: "metacontract", + projectName: "mc", + + onBrokenLinks: "warn", + onBrokenMarkdownLinks: "warn", + + i18n: { + defaultLocale: "en", + locales: ["en"], + }, + + plugins: [require.resolve("docusaurus-lunr-search")], + + headTags: [ + { + tagName: "link", + attributes: { + rel: "preconnect", + href: "https://fonts.googleapis.com", + }, + }, + { + tagName: "link", + attributes: { + rel: "preconnect", + href: "https://fonts.gstatic.com", + crossorigin: "anonymous", + }, + }, + { + tagName: "link", + attributes: { + rel: "stylesheet", + href: "https://fonts.googleapis.com/css2?family=Noto+Serif:ital,wght@0,100..900;1,100..900&display=swap", + }, + }, + ], + + presets: [ + [ + "classic", + { + docs: { + path: "./docs", + routeBasePath: "/", + sidebarPath: require.resolve("./sidebars.ts"), + async sidebarItemsGenerator({ + defaultSidebarItemsGenerator, + ...args + }) { + const items = await defaultSidebarItemsGenerator(args); + // Filter out index.md from the sidebar items + return items.filter((item) => { + // Add a type guard to check if 'item' has an 'id' property + return !("id" in item) || !item.id.endsWith("index"); + }); + }, + editUrl: "https://github.com/metacontract/mc/tree/main/site", + breadcrumbs: false, + showLastUpdateTime: true, + }, + theme: { + customCss: "./src/css/custom.css", + }, + } satisfies Preset.Options, + ], + ], + + markdown: { + mermaid: true, + format: "detect", + }, + themes: ["@docusaurus/theme-mermaid"], + + themeConfig: { + colorMode: { + defaultMode: "dark", + respectPrefersColorScheme: true, + }, + navbar: { + title: "Meta Contract", + logo: { + alt: "Meta Contract Logo", + src: "img/logo.png", + }, + items: [ + { + type: "search", + position: "left", + }, + { + to: "concepts", + html: "Concepts", + position: "right", + }, + { + to: "guides", + html: "Guides", + position: "right", + }, + { + to: "api", + html: "API", + position: "right", + }, + { + to: "examples", + html: "Examples", + position: "right", + }, + // { + // type: "docsVersionDropdown", + // position: "right", + // dropdownItemsAfter: [ + // { + // to: "https://github.com/metacontract/mc/releases", + // label: "Releases", + // }, + // ], + // dropdownActiveClassDisabled: true, + // }, + { + type: "html", + position: "right", + value: "
", + className: "navbar-divider", + }, + { + href: "https://github.com/metacontract/mc", + className: "header-social-icon header-github-link", + "aria-label": "GitHub repository", + position: "right", + }, + { + href: "https://x.com/ecdysis_xyz", + className: "header-social-icon header-x-link", + "aria-label": "X", + position: "right", + }, + { + type: "html", + position: "right", + value: "
", + className: "navbar-divider", + }, + ], + }, + docs: { + sidebar: { + autoCollapseCategories: false, + }, + }, + footer: { + style: "dark", + copyright: `Copyright © 2024-present Meta Contract Contributors. Released under the MIT License.`, + }, + prism: { + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + additionalLanguages: ["solidity"], + }, + } satisfies Preset.ThemeConfig, + customFields: { + deploymentCode: `mc.init("MyDAO"); +mc.use(Propose.propose.selector, address(new Propose())); +mc.use(Vote.vote.selector, address(new Vote())); +mc.use(Tally.tally.selector, address(new Tally())); +mc.use(Execute.execute.selector, address(new Execute())); +mc.deploy();`, + upgradeCode: `mc.load("MyDAO"); +mc.upgrade( + Propose.propose.selector, + address(new ProposeV2()) +);`, + }, +}; + +export default config; diff --git a/book/package.json b/site/package.json similarity index 78% rename from book/package.json rename to site/package.json index 027eb213..379bc948 100644 --- a/book/package.json +++ b/site/package.json @@ -5,6 +5,7 @@ "scripts": { "docusaurus": "docusaurus", "start": "docusaurus start", + "prebuild": "npm run soldocs", "build": "docusaurus build", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", @@ -12,7 +13,10 @@ "serve": "docusaurus serve", "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", - "typecheck": "tsc" + "typecheck": "tsc", + "presoldocs": "sh ./script/generate_temp_soldocs.sh", + "soldocs": "npm run ./script/integrate_soldocs.ts", + "postsoldocs": "sh ./script/remove_temp_soldocs.sh" }, "dependencies": { "@docusaurus/core": "3.5.2", @@ -20,6 +24,8 @@ "@docusaurus/theme-mermaid": "^3.5.2", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", + "docusaurus-lunr-search": "^3.5.0", + "lucide-react": "^0.453.0", "prism-react-renderer": "^2.3.0", "react": "^18.0.0", "react-dom": "^18.0.0" diff --git a/site/script/config.ts b/site/script/config.ts new file mode 100644 index 00000000..e43ede39 --- /dev/null +++ b/site/script/config.ts @@ -0,0 +1,16 @@ +import { type Config, defaultConfig } from "./soldocs/utils"; + +export const config: Config = { + ...defaultConfig, + copyPaths: [ + { + from: "src/std/", + to: "02-guides/02-development/03-std-functions/05-std/", + }, + { + from: "src/devkit/", + to: "03-api/03-api-details/", + }, + ], + docsDir: "site/docs", +}; diff --git a/site/script/generate_temp_soldocs.sh b/site/script/generate_temp_soldocs.sh new file mode 100644 index 00000000..299125fb --- /dev/null +++ b/site/script/generate_temp_soldocs.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env sh + +command -v forge >/dev/null 2>&1 || { + # Download and install Foundry + curl -L https://foundry.paradigm.xyz | bash + + # Update PATH to include Foundry binaries + export PATH=$HOME/.foundry/bin:$PATH + + # Update Foundry + foundryup + +} + +# Navigate to the parent directory, set PATH, generate docs, and return to site directory +cd .. +forge doc -o temp_soldocs diff --git a/site/script/integrate_soldocs.ts b/site/script/integrate_soldocs.ts new file mode 100644 index 00000000..b6c7ce83 --- /dev/null +++ b/site/script/integrate_soldocs.ts @@ -0,0 +1,22 @@ +import { config } from "./config"; +import { generateAndMoveForgeDocs } from "./soldocs/generate_and_move_forge_docs"; +import { updateLinks } from "./soldocs/update_links"; +import { upsertIndexFile } from "./soldocs/upsert_index_file"; +import { + extractPaths, + logSuccess, + processPathsInSubdirectories, +} from "./soldocs/utils"; + +function integrateSolDocs() { + generateAndMoveForgeDocs(); + + processPathsInSubdirectories(extractPaths(config.copyPaths), [ + upsertIndexFile, + updateLinks, + ]); + + logSuccess("Successfully generated Solidity API docs!", true); +} + +integrateSolDocs(); diff --git a/site/script/remove_temp_soldocs.sh b/site/script/remove_temp_soldocs.sh new file mode 100644 index 00000000..7fb32825 --- /dev/null +++ b/site/script/remove_temp_soldocs.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env sh + +cd .. +rm -rf temp_soldocs diff --git a/site/script/soldocs/generate_and_move_forge_docs.ts b/site/script/soldocs/generate_and_move_forge_docs.ts new file mode 100644 index 00000000..eab02f75 --- /dev/null +++ b/site/script/soldocs/generate_and_move_forge_docs.ts @@ -0,0 +1,72 @@ +import { execSync } from "node:child_process"; +import { readdirSync, statSync } from "node:fs"; +import { join } from "node:path"; +import { copySync, removeSync } from "fs-extra"; +import { config } from "../config"; +import { logError, logInfo, logMessage, logSuccess } from "./utils"; + +function compareAndDeleteDirectories(from: string, to: string) { + const fromFiles = new Set(readdirSync(from)); + const toFiles = readdirSync(to); + + for (const file of toFiles) { + // Ignore 'index.md' files + if (file === "index.md") { + continue; + } + + const fromFilePath = join(from, file); + const toFilePath = join(to, file); + + if (!fromFiles.has(file)) { + removeSync(toFilePath); + logError( + `Deleted file or directory in 'to' but not in 'from': ${toFilePath}`, + true, + ); + } else if (statSync(toFilePath).isDirectory()) { + // If it's a directory, recurse into it + compareAndDeleteDirectories(fromFilePath, toFilePath); + } + } +} + +export function generateAndMoveForgeDocs() { + try { + // // Ensure the PATH includes the directory where forge is installed + // process.env.PATH = `${process.env.HOME}/.foundry/bin:${process.env.PATH}`; + + // // Generate solidity docs into the temporary directory using `forge doc` + // execSync(`cd ${config.rootPath} && forge doc -o ${config.tempDir}`, { + // stdio: "inherit", + // }); + // logInfo(`Generated solidity docs in ${config.rootPath}/${config.tempDir}`); + + // Move generated docs to appropriate directories + if (config.copyPaths.length > 0) { + for (const copyPath of config.copyPaths) { + const from = join( + config.rootPath, + config.tempDir, + config.tempDirOffset, + copyPath.from, + ); + const to = join(config.rootPath, config.docsDir, copyPath.to); + logMessage(`Copying ${from} to ${to}`); + copySync(from, to); + + // Recursively compare and delete files and directories in 'to' that are not in 'from' + compareAndDeleteDirectories(from, to); + } + } + + // // Remove unnecessary temporary directory + // removeSync(`${config.rootPath}/${config.tempDir}`); + // logInfo(`Removed temporary directory ${config.rootPath}/${config.tempDir}`); + + logSuccess("Successfully generated and moved solidity docs"); + } catch (error) { + console.error("Failed to generate and move solidity docs:\n", error); + process.exit(1); + } +} diff --git a/site/script/soldocs/update_links.ts b/site/script/soldocs/update_links.ts new file mode 100644 index 00000000..0cd4d7af --- /dev/null +++ b/site/script/soldocs/update_links.ts @@ -0,0 +1,53 @@ +import { readFileSync, readdirSync, writeFileSync } from "node:fs"; +import { join, relative } from "node:path"; + +import { config } from "../config"; +import { logMessage, logSuccess } from "./utils"; + +export function updateLinks(directoryPath: string) { + const markdownFiles = getMarkdownFiles(directoryPath); + + for (const file of markdownFiles) { + const originalMarkdown = readFileSync(file, "utf-8"); + const replacedMarkdown = replaceLinks(originalMarkdown, directoryPath); + + writeFileSync(file, replacedMarkdown, "utf-8"); + logMessage(`Updated: ${file}`); + } + + logSuccess("Successfully converted links."); +} + +function getMarkdownFiles(directoryPath: string): string[] { + return readdirSync(directoryPath) + .filter((file) => file.endsWith(".md")) + .map((file) => join(directoryPath, file)); +} + +function replaceLinks(markdown: string, directoryPath: string) { + return markdown.replace( + /\[([^\]]+)\]\((\/[^)]+\.md)(#[^\s)]+)?\)/g, + (match, text, path, fragment) => { + if (!path.startsWith("/")) return match; + + const newPath = getNewPath(path, directoryPath); + + return `[${text}](${newPath}${fragment || ""})`; + }, + ); +} + +function getNewPath(path: string, directoryPath: string): string { + let newPath = path; + for (const copyPath of config.copyPaths) { + if (newPath.startsWith(`/${copyPath.from}`)) { + newPath = newPath.replace(`/${copyPath.from}`, `/${copyPath.to}`); + } + } + logMessage(directoryPath); + logMessage(newPath); + return relative( + directoryPath, + join(config.rootPath, config.docsDir, newPath), + ); +} diff --git a/site/script/soldocs/upsert_index_file.ts b/site/script/soldocs/upsert_index_file.ts new file mode 100644 index 00000000..74f702f0 --- /dev/null +++ b/site/script/soldocs/upsert_index_file.ts @@ -0,0 +1,75 @@ +import { + existsSync, + readFileSync, + readdirSync, + statSync, + unlinkSync, +} from "node:fs"; +import { basename, join } from "node:path"; + +import { logMessage, updateIndexFile } from "./utils"; + +export function upsertIndexFile(directoryPath: string) { + const readmeFile = join(directoryPath, "README.md"); + + updateIndexFile( + directoryPath, + existsSync(readmeFile) + ? extractIndexItemsFrom(readmeFile) + : generateIndexItemsFor(directoryPath), + ); +} + +function extractIndexItemsFrom(readmeFile: string): string { + logMessage(`Extracting index items from ${readmeFile}`); + + const readmeMarkdown = readFileSync(readmeFile, "utf-8"); + const indexItems = readmeMarkdown + // Extract lines that match the pattern of an index item + .match(/^- \[.*?\]\(.*?\)$/gm) + // Replace the link with the correct path + .map((line) => { + const linkMatch = line.match(/\((.*?)\)/); + if (linkMatch) { + let linkPath = linkMatch[1]; + // Directory paths need to be converted to index.md + if (linkPath.startsWith("/")) { + linkPath = `${linkPath.split("/").pop()}/index.md`; + } + // Convert the link to a relative path + linkPath = `./${linkPath}`; + return line.replace(/\((.*?)\)/, `(${linkPath})`); + } + return line; + }) + .join("\n"); + + // Remove the README.md file after extracting the index items + unlinkSync(readmeFile); + logMessage(`README.md removed: ${readmeFile}`); + + return indexItems; +} + +function generateIndexItemsFor(directoryPath: string): string { + logMessage(`Generating index items for ${directoryPath}`); + + const items = readdirSync(directoryPath); + let indexItems = ""; + + for (const item of items) { + const itemStats = statSync(join(directoryPath, item)); + + if (itemStats.isDirectory()) { + const dirname = basename(item); + indexItems += `- [${dirname}](./${dirname}/index.md)\n`; + continue; + } + if (itemStats.isFile()) { + if (item === "index.md" || item === "README.md") continue; + indexItems += `- [${basename(item, ".md")}](./${item})\n`; + } + } + + return indexItems; +} diff --git a/site/script/soldocs/utils.ts b/site/script/soldocs/utils.ts new file mode 100644 index 00000000..4bcb981f --- /dev/null +++ b/site/script/soldocs/utils.ts @@ -0,0 +1,120 @@ +import { execSync } from "node:child_process"; +import { + existsSync, + readFileSync, + readdirSync, + statSync, + writeFileSync, +} from "node:fs"; +import { join } from "node:path"; +import { config } from "../config"; + +export interface Config { + copyPaths: { from: string; to: string }[]; + log: boolean; + rootPath: string; + tempDir: string; + tempDirOffset: string; + docsDir: string; +} + +export const defaultConfig: Config = { + copyPaths: [], + log: false, + rootPath: execSync("git rev-parse --show-toplevel").toString().trim(), + tempDir: "temp_soldocs", + tempDirOffset: "src", + docsDir: "docs", +}; + +export function logMessage(message: string, alwaysShow = false) { + if (config.log || alwaysShow) { + console.log(message); + } +} + +const colors = { + red: "\x1b[31m", + green: "\x1b[32m", + blue: "\x1b[34m", + reset: "\x1b[0m", +}; + +export function logSuccess(message: string, alwaysShow = false) { + logMessage(`${colors.green}${message}${colors.reset}`, alwaysShow); +} + +export function logInfo(message: string, alwaysShow = false) { + logMessage(`${colors.blue}${message}${colors.reset}`, alwaysShow); +} + +export function logError(message: string, alwaysShow = false) { + logMessage(`${colors.red}${message}${colors.reset}`, alwaysShow); +} + +export function updateIndexFile(directoryPath: string, indexItems: string) { + if (!indexItems) { + logMessage( + "No index items generated. The directory might be empty or contain only index.md/README.md.", + ); + return; + } + + const indexFilePath = join(directoryPath, "index.md"); + const startMarker = ""; + const endMarker = ""; + + let indexContent = ""; + if (existsSync(indexFilePath)) { + indexContent = readFileSync(indexFilePath, "utf-8"); + } + + const newIndexContent = + indexContent.includes(startMarker) && indexContent.includes(endMarker) + ? indexContent.replace( + new RegExp(`${startMarker}[\\s\\S]*${endMarker}`), + `${startMarker}\n${indexItems}\n${endMarker}`, + ) + : `# Index\n\n${startMarker}\n${indexItems}\n${endMarker}`; + + writeFileSync(indexFilePath, newIndexContent, "utf-8"); + logInfo(`Index file updated: ${indexFilePath}`); +} + +export function getSubdirectories(directoryPath: string): string[] { + return readdirSync(directoryPath).filter((subdir) => { + const subdirPath = join(directoryPath, subdir); + return statSync(subdirPath).isDirectory(); + }); +} + +export function processPathsInSubdirectories( + paths: string[], + callbacks: ((path: string) => void)[], + isResolved = false, +) { + for (const path of paths) { + const resolvedPath = isResolved ? path : resolvePath(path); + for (const callback of callbacks) { + callback(resolvedPath); + } + + const subdirs = getSubdirectories(resolvedPath); + for (const subdir of subdirs) { + processPathsInSubdirectories( + [join(resolvedPath, subdir)], + callbacks, + true, + ); + } + } +} + +export function resolvePath(path: string): string { + const rootPath = execSync("git rev-parse --show-toplevel").toString().trim(); + return join(rootPath, path); +} + +export function extractPaths(copyPaths: Config["copyPaths"]): string[] { + return copyPaths.map((copyPath) => join(config.docsDir, copyPath.to)); +} diff --git a/site/sidebars.ts b/site/sidebars.ts new file mode 100644 index 00000000..4ae593e2 --- /dev/null +++ b/site/sidebars.ts @@ -0,0 +1,42 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebars: SidebarsConfig = { + sidebar: [ + "getting-started", + { + type: "category", + label: "Concepts", + link: { type: "doc", id: "concepts/index" }, + collapsible: true, + collapsed: false, + items: [{ type: "autogenerated", dirName: "01-concepts" }], + }, + { + type: "category", + label: "Guides", + link: { type: "doc", id: "guides/index" }, + collapsible: true, + collapsed: false, + items: [{ type: "autogenerated", dirName: "02-guides" }], + }, + { + type: "category", + label: "API", + link: { type: "doc", id: "api/index" }, + collapsible: true, + collapsed: false, + items: [{ type: "autogenerated", dirName: "03-api" }], + }, + { + type: "category", + label: "Examples", + link: { type: "doc", id: "examples/index" }, + collapsible: true, + collapsed: false, + items: [{ type: "autogenerated", dirName: "04-examples" }], + }, + // { type: "autogenerated", dirName: "." }, + ], +}; + +export default sidebars; diff --git a/site/src/css/custom.css b/site/src/css/custom.css new file mode 100644 index 00000000..416eed4b --- /dev/null +++ b/site/src/css/custom.css @@ -0,0 +1,290 @@ +/** + * Any CSS included here will be global. The classic template + * bundles Infima by default. Infima is a CSS framework designed to + * work well for content-centric websites. + */ + +/* You can override the default Infima variables here. */ +:root { + --ifm-color-primary: #5b5bd6; + --ifm-color-primary-dark: #4343d0; + --ifm-color-primary-darker: #3636cd; + --ifm-color-primary-darkest: #2b2bab; + --ifm-color-primary-light: #7373dc; + --ifm-color-primary-lighter: #8080df; + --ifm-color-primary-lightest: #a4a4e8; + --ifm-code-font-size: 95%; + --ifm-font-family-base: system-ui, -apple-system, "system-ui", "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; + --ifm-background-color: #fafafa; + --docs-color_backgroundAccent: #5b5bd6; + --docs-color_backgroundAccentHover: #5753c6; + --docs-color_textAccent: #ffffff; + --docs-color_backgroundSecondary: #e5e5e5; + --docs-color_backgroundSecondaryHover: #d3d3d3; + --docs-color_textSecondary: #232225; + --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); + --ifm-navbar-search-input-background-color: rgb(235, 235, 235); + --ifm-navbar-search-input-icon: url("/img/common/search-light.svg"); + --sidebar-background-color: rgb(235, 235, 235); + --ifm-menu-color-background-active: inherit; + --footer-background-color: var(--sidebar-background-color); + --footer-color: var(--ifm-font-color-base); + --social-github-icon: url("/img/social/github-black.png"); + --social-x-icon: url("/img/social/x-black.png"); + --title-font-family: "Noto Serif", serif; + --divider-color: rgb(220, 220, 220); + --sidebar-divider-color: rgb(220, 220, 220); + --ifm-spacing-horizontal: 3rem; + --ifm-code-font-size: 12px; +} + +/* For readability concerns, you should choose a lighter palette in dark mode. */ +html[data-theme='dark'] { + --ifm-color-primary: #b1a9ff; + --ifm-color-primary-dark: #8b7fff; + --ifm-color-primary-darker: #7769ff; + --ifm-color-primary-darkest: rgb(91, 91, 214); + --ifm-color-primary-light: #d7d3ff; + --ifm-color-primary-lighter: #ebe9ff; + --ifm-color-primary-lightest: #ffffff; + --ifm-background-color: #232225; + --docs-color_backgroundAccent: #5b5bd6; + --docs-color_backgroundAccentHover: #5753c6; + --docs-color_textAccent: #ffffff; + --docs-color_backgroundSecondary: rgb(50, 48, 53); + --docs-color_backgroundSecondaryHover: rgb(60, 58, 63); + --docs-color_textSecondary: #ffffff; + --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); + --dark-mode-filter: invert(1); + --ifm-navbar-search-input-background-color: rgb(30, 29, 31); + --ifm-navbar-search-input-icon: url("/img/common/search-dark.svg"); + --sidebar-background-color: rgb(30, 29, 31); + --social-github-icon: url("/img/social/github-white.png"); + --social-x-icon: url("/img/social/x-white.png"); + --divider-color: rgb(70, 70, 70); + --sidebar-divider-color: rgb(45, 45, 45); + --sidebar-item-color: rgb(170, 170, 170); + --ifm-hr-background-color: rgb(90, 90, 90); +} + +/* Navbar */ +.navbar { + height: 3rem; + font-size: 14px; +} + +.navbar-divider { + height: 1.2rem; + padding: 0; + margin: 0 0.75rem; + width: 1px; + background-color: var(--divider-color); +} + +.navbar__title { + font-family: var(--title-font-family); + font-size: 1rem; + font-weight: 600; +} + +.navbar__title:hover, +.navbar__title:focus, +.navbar__title:active { + color: var(--ifm-navbar-link-color); + opacity: 0.7; +} + +.navbar__search-input { + height: 1.8rem; + border-radius: 0.3rem; + font-size: 14px; + background-size: 12px; +} + +.header-social-icon { + display: flex; + align-items: center; +} +.header-social-icon:hover { + opacity: 0.7; + transition: opacity 0.3s ease; +} + +.header-github-link::before { + content: ""; + display: inline-block; + width: 18px; + height: 18px; + background-image: var(--social-github-icon); + background-size: contain; + background-repeat: no-repeat; + background-position: center; +} + +.header-x-link::before { + content: ""; + display: inline-block; + width: 16px; + height: 16px; + background-image: var(--social-x-icon); + background-size: contain; + background-repeat: no-repeat; + background-position: center; +} + +/* Sidebar */ + +.theme-doc-sidebar-container { + border-right: 0 !important; + font-size: 14px; + background-color: var(--sidebar-background-color); + transition: all 0; + margin-top: 0; +} + +.theme-doc-sidebar-container > div { + max-height: 100%; + position: fixed; + top: 0; +} + +.theme-doc-sidebar-container > div > div { + padding-top: 3rem; +} + +.theme-doc-sidebar-item-link-level-1.theme-doc-sidebar-item-link { + margin-left: 1rem; +} + +.last-link-before-category { + margin-bottom: 1rem; +} + +.theme-doc-sidebar-item-link-level-1.theme-doc-sidebar-item-link > a { + padding-left: 0; +} + +.menu__link--active { + color: var(--ifm-navbar-link-hover-color) !important; +} + +.theme-doc-sidebar-menu > .theme-doc-sidebar-item-category { + border-top: 1px solid var(--sidebar-divider-color); + margin-top: 0; + padding-top: 0.75rem; + padding-bottom: 0.75rem; + margin-left: 1rem; + margin-right: 1rem; +} + +.theme-doc-sidebar-menu > .theme-doc-sidebar-item-category:first-child { + border-top: 0; +} + +.theme-doc-sidebar-item-category-level-1 > div > a { + font-weight: 600; + color: var(--ifm-font-color-base); +} + +ul.menu__list { + margin-top: 0 !important; +} + +.menu__list-item:not(:first-child) { + margin-top: 0; +} + +.theme-doc-sidebar-item-category a { + padding-left: 0; +} + +.menu__link { + color: var(--sidebar-item-color); +} + +.menu__link:hover, +.menu__list-item-collapsible:hover { + background-color: inherit; +} + +.menu__list-item-collapsible { + background-color: var(--sidebar-background-color); +} + +@media (max-width: 996px) { + .menu__list-item-collapsible { + background-color: transparent; + } + + .navbar-sidebar .menu__list-item { + margin-bottom: 0.25rem; + } + + .navbar-sidebar .menu__list-item a { + color: var(--ifm-font-color-base); + } + + .navbar-sidebar .navbar-divider { + width: 100%; + height: 1px; + margin-top: 1rem; + margin-bottom: 1rem; + background-color: var(--sidebar-divider-color); + } + + .navbar-sidebar .header-social-icon:not(:last-child) { + margin-bottom: 1rem; + } + + .navbar-sidebar .header-github-link::after { + content: "GitHub"; + margin-left: 0.5rem; + } +} + +.menu__caret::before, +.menu__link--sublist-caret::after { + background-image: url("/img/common/chevron.svg"); + background-size: contain; + background-repeat: no-repeat; + background-position: center; +} + +/* Main */ +.padding-top--md { + padding-top: 2rem !important; +} + +.markdown { +} + +.markdown h1:first-child { + --ifm-h1-font-size: 2rem; +} + +.markdown > h2 { + --ifm-h2-font-size: 1.5rem; +} + +.markdown > h3 { + --ifm-h3-font-size: 1.25rem; +} + +.theme-doc-footer { + border-top: 1px solid var(--ifm-hr-background-color); + padding-top: 1.5rem; +} + +/* Footer */ + +.footer { + background-color: var(--footer-background-color); + color: var(--footer-color); + font-size: 14px; + box-shadow: 0 -2px 5px var(--footer-background-color); +} + +.footer a { + color: var(--ifm-font-color-base); + font-style: italic; +} diff --git a/site/src/pages/index.module.css b/site/src/pages/index.module.css new file mode 100644 index 00000000..d3d23b7b --- /dev/null +++ b/site/src/pages/index.module.css @@ -0,0 +1,195 @@ +/** + * CSS files with the .module.css suffix will be treated as CSS modules + * and scoped locally. + */ + +:root { + --prism-background-color: aqua; +} + +.home__container { + padding: 5rem 2rem 4rem; +} + +/* Header styling */ + +.home__headerContainer { + display: flex; + flex-direction: row; + justify-content: space-evenly; +} + +.home__hero { + max-width: 43%; + text-align: left; + margin-bottom: 1rem; +} + +.home__title { + font-family: var(--title-font-family); + font-size: 5vw; + font-weight: 600; +} + +.home__tagline { + font-size: 1.2rem; + margin-top: 1rem; + padding-left: 0.2rem; +} + +.home__buttonGroup { + display: flex; + flex-direction: row; + justify-content: start; + gap: 0.5rem; + margin-top: 2rem; + padding-left: 0.1rem; +} + +.home__header__button { + padding-left: 0.2rem; + font-size: 0.9rem; + border-radius: 0.25rem; + padding: 0.5rem 1rem; + color: var(--docs-color_textAccent); +} + +.primaryButton { + color: var(--docs-color_textAccent); + background-color: var(--docs-color_backgroundAccent); +} + +.primaryButton:hover { + color: var(--docs-color_textAccent); + background-color: var(--docs-color_backgroundAccentHover); +} + +.secondaryButton { + color: var(--docs-color_textSecondary); + background-color: var(--docs-color_backgroundSecondary); +} + +.secondaryButton:hover { + color: var(--docs-color_textSecondary); + background-color: var(--docs-color_backgroundSecondaryHover); +} + +.externalLinkIcon { + height: 1rem; + width: 1rem; +} + +.home__install { + margin-top: 2rem; + width: 40%; +} + +.language-solidity { + background-color: aqua !important; +} + +.home__install .tabs-container { + background-color: aqua; +} + +@media (max-width: 996px) { + .home__hero { + max-width: 90%; + text-align: center; + } + + .home__title { + font-size: 7vw; + } + + .home__tagline { + padding: 0 2rem; + } + + .home__buttonGroup { + justify-content: center; + } + + .home__install { + display: none; + } +} + +/* Main styling */ + +.home__main { + max-width: 82%; + margin: 4rem auto 0; + display: grid; +} + +/* lg */ +@media (min-width: 997px) { + .home__main { + grid-template-columns: repeat(6, 1fr); + gap: 1rem; + } + + .home__main .article:nth-child(1), + .home__main .article:nth-child(2), + .home__main .article:nth-child(3) { + grid-column: span 2; + } + + .home__main .article:nth-child(4), + .home__main .article:nth-child(5) { + grid-column: span 3; + } +} + +/* md */ +@media (min-width: 640px) and (max-width: 996px) { + .home__main { + max-width: 90%; + grid-template-columns: repeat(2, 1fr); + gap: 0.5rem; + } + + .home__main .article:last-child { + grid-column: span 2; + } +} + +/* sm */ +@media (max-width: 639px) { + .home__main { + max-width: 90%; + grid-template-columns: 1fr; + gap: 0; + } + + .home__title { + font-size: 3rem; + } +} + +.article { + padding: 1rem; + border-radius: 0.5rem; + background-color: var(--ifm-background-color); + width: 100%; +} + +.article__title { + display: flex; + align-items: center; + font-weight: bold; + font-size: 1rem; + margin-bottom: 0; +} + +.article__icon { + height: 20px; + width: 20px; + margin-right: 0.5rem; + display: inline-block; +} + +.article__description { + margin-top: 0.25rem; +} diff --git a/site/src/pages/index.tsx b/site/src/pages/index.tsx new file mode 100644 index 00000000..fee95884 --- /dev/null +++ b/site/src/pages/index.tsx @@ -0,0 +1,132 @@ +import Link from "@docusaurus/Link"; +import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; +import CodeBlock from "@theme/CodeBlock"; +import Layout from "@theme/Layout"; +import TabItem from "@theme/TabItem"; +import Tabs from "@theme/Tabs"; +import clsx from "clsx"; +import { + CheckCircle, + Layers, + MoveUpRight, + RefreshCw, + Settings, + TrendingUp, +} from "lucide-react"; +import type React from "react"; + +import styles from "./index.module.css"; + +export default function Home(): JSX.Element { + const { siteConfig } = useDocusaurusContext(); + return ( + +
+
+
+

{siteConfig.title}

+
{siteConfig.tagline}
+
+ + Get started + + + View on GitHub{" "} + + +
+
+
+ + + + {`${siteConfig.customFields.deploymentCode}`} + + + {/* + + {`${siteConfig.customFields.upgradeCode}`} + + */} + +
+
+ +
+
+

+ + Upgradeability +

+

+ Meta Contracts can be upgraded without changing their address, + allowing for seamless improvements and bug fixes. +

+
+ +
+

+ + Modularity +

+

+ The framework separates contract logic into distinct, manageable + components, enhancing code organization and reusability. +

+
+ +
+

+ + Scalability +

+

+ Meta Contracts are designed to handle growth efficiently, making + them suitable for large-scale applications. +

+
+ +
+

+ + Flexibility +

+

+ Developers can easily extend and customize Meta Contracts to suit + specific project needs. +

+
+ +
+

+ + Testability +

+

+ The modular structure of Meta Contracts facilitates comprehensive + testing, including unit tests for individual functions and + integration tests for the entire system. +

+
+
+
+ + ); +} diff --git a/site/src/theme/Navbar/index.tsx b/site/src/theme/Navbar/index.tsx new file mode 100644 index 00000000..c307a3af --- /dev/null +++ b/site/src/theme/Navbar/index.tsx @@ -0,0 +1,92 @@ +import type { WrapperProps } from "@docusaurus/types"; +import Navbar from "@theme-original/Navbar"; +import type NavbarType from "@theme/Navbar"; +import React, { useEffect } from "react"; + +type Props = WrapperProps; + +const addClickListeners = (elements: NodeListOf) => { + for (const item of elements) { + item.addEventListener("click", handleClick); + } +}; + +const handleClick = (event: Event) => { + console.log("Link clicked:", (event.target as HTMLElement).innerText); + + const target = event.target as HTMLElement; + const liElement = target.closest("li.theme-doc-sidebar-item-category"); + if (liElement) { + const isActive = target.classList.contains("menu__link--active"); + if (isActive) { + liElement.classList.toggle("menu__list-item--collapsed"); + } else { + liElement.classList.remove("menu__list-item--collapsed"); + } + + const siblingUl = liElement.querySelector("ul"); + if (siblingUl) { + if (isActive) { + siblingUl.style.display = + siblingUl.style.display === "none" ? "block" : "none"; + } else { + siblingUl.style.display = "block"; + } + } + } +}; + +const identifyBoundaryBetweenLinkAndCategory = () => { + const listItems = document.querySelectorAll("ul.theme-doc-sidebar-menu > li"); + let lastLinkItem: Element | null = null; + for (const item of listItems) { + if (item.classList.contains("theme-doc-sidebar-item-link")) { + lastLinkItem = item; + } else if (item.classList.contains("theme-doc-sidebar-item-category")) { + if (lastLinkItem) { + lastLinkItem.classList.add("last-link-before-category"); + lastLinkItem = null; // Reset after adding class + } + } + } +}; + +const observeMutations = (callback: MutationCallback) => { + const observer = new MutationObserver(callback); + observer.observe(document.body, { + childList: true, + subtree: true, + }); + return observer; +}; + +export default function NavbarWrapper(props: Props): JSX.Element { + useEffect(() => { + // Add click listeners to all sidebar items + const sidebarItems = document.querySelectorAll("a.menu__link--sublist"); + addClickListeners(sidebarItems); + + // Identify the boundary between link and category + identifyBoundaryBetweenLinkAndCategory(); + + // Observe mutations + const observer = observeMutations((mutations) => { + for (const mutation of mutations) { + if (mutation.type === "childList") { + const newItems = document.querySelectorAll("a.menu__link--sublist"); + addClickListeners(newItems); + } + } + }); + + // Cleanup function to remove event listeners + return () => { + for (const item of sidebarItems) { + item.removeEventListener("click", handleClick); + } + observer.disconnect(); + }; + }, []); + + return ; +} diff --git a/book/static/.nojekyll b/site/static/.nojekyll similarity index 100% rename from book/static/.nojekyll rename to site/static/.nojekyll diff --git a/site/static/img/common/chevron.svg b/site/static/img/common/chevron.svg new file mode 100644 index 00000000..15109563 --- /dev/null +++ b/site/static/img/common/chevron.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/site/static/img/common/search-dark.svg b/site/static/img/common/search-dark.svg new file mode 100644 index 00000000..5db5fb20 --- /dev/null +++ b/site/static/img/common/search-dark.svg @@ -0,0 +1 @@ + diff --git a/site/static/img/common/search-light.svg b/site/static/img/common/search-light.svg new file mode 100644 index 00000000..f4911fc2 --- /dev/null +++ b/site/static/img/common/search-light.svg @@ -0,0 +1 @@ + diff --git a/book/static/img/favicon.ico b/site/static/img/favicon.ico similarity index 100% rename from book/static/img/favicon.ico rename to site/static/img/favicon.ico diff --git a/site/static/img/hero.png b/site/static/img/hero.png new file mode 100644 index 00000000..cc5fcfdf Binary files /dev/null and b/site/static/img/hero.png differ diff --git a/book/static/img/ecdysis-logo.png b/site/static/img/logo.png similarity index 100% rename from book/static/img/ecdysis-logo.png rename to site/static/img/logo.png diff --git a/site/static/img/social/github-black.png b/site/static/img/social/github-black.png new file mode 100644 index 00000000..6cb3b705 Binary files /dev/null and b/site/static/img/social/github-black.png differ diff --git a/site/static/img/social/github-white.png b/site/static/img/social/github-white.png new file mode 100644 index 00000000..50b81752 Binary files /dev/null and b/site/static/img/social/github-white.png differ diff --git a/site/static/img/social/x-black.png b/site/static/img/social/x-black.png new file mode 100644 index 00000000..2c2d7e86 Binary files /dev/null and b/site/static/img/social/x-black.png differ diff --git a/site/static/img/social/x-white.png b/site/static/img/social/x-white.png new file mode 100644 index 00000000..2609e580 Binary files /dev/null and b/site/static/img/social/x-white.png differ diff --git a/book/tsconfig.json b/site/tsconfig.json similarity index 100% rename from book/tsconfig.json rename to site/tsconfig.json