From 31871480c25dfd6590fa7ba73c87ade4980ad0ed Mon Sep 17 00:00:00 2001 From: panditdhamdhere Date: Fri, 5 Dec 2025 12:50:19 +0530 Subject: [PATCH 1/2] fix: add braces to one-line if statements in ERC721EnumerableFacet Fix style guide violation by adding braces around one-line if statements that call revert. This ensures compliance with Compose's coding standards which require all if statements to use braces. Fixes two instances in safeTransferFrom functions (lines 331 and 354). --- .../ERC721/ERC721Enumerable/ERC721EnumerableFacet.sol | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/token/ERC721/ERC721Enumerable/ERC721EnumerableFacet.sol b/src/token/ERC721/ERC721Enumerable/ERC721EnumerableFacet.sol index 0d0671c1..c0bf1e4f 100644 --- a/src/token/ERC721/ERC721Enumerable/ERC721EnumerableFacet.sol +++ b/src/token/ERC721/ERC721Enumerable/ERC721EnumerableFacet.sol @@ -328,7 +328,9 @@ contract ERC721EnumerableFacet { revert ERC721InvalidReceiver(_to); } } catch (bytes memory reason) { - if (reason.length == 0) revert ERC721InvalidReceiver(_to); + if (reason.length == 0) { + revert ERC721InvalidReceiver(_to); + } assembly ("memory-safe") { revert(add(reason, 0x20), mload(reason)) } @@ -351,7 +353,9 @@ contract ERC721EnumerableFacet { revert ERC721InvalidReceiver(_to); } } catch (bytes memory reason) { - if (reason.length == 0) revert ERC721InvalidReceiver(_to); + if (reason.length == 0) { + revert ERC721InvalidReceiver(_to); + } assembly ("memory-safe") { revert(add(reason, 0x20), mload(reason)) } From c3511078c333ebfe90a5bce02dc6d40d3e295a29 Mon Sep 17 00:00:00 2001 From: panditdhamdhere Date: Fri, 5 Dec 2025 16:29:05 +0530 Subject: [PATCH 2/2] fix: correct typos in documentation - Fix 'Descrition' -> 'Description' in solidity-modules.mdx - Fix 'facet modules' -> 'facet module' (singular) in design-for-composition.mdx - Fix 'ERC20BridgableFacet' -> 'ERC20BridgeableFacet' in reusable-facet-logic.mdx - Fix numbering in composable-facets.mdx (1, 3, 4 -> 1, 2, 3) - Fix 'It's own' -> 'Its own' in diamond-contracts.mdx --- website/docs/design/design-for-composition.mdx | 2 +- website/docs/foundations/composable-facets.mdx | 4 ++-- website/docs/foundations/diamond-contracts.mdx | 2 +- website/docs/foundations/reusable-facet-logic.mdx | 2 +- website/docs/foundations/solidity-modules.mdx | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/design/design-for-composition.mdx b/website/docs/design/design-for-composition.mdx index 5399de1a..6c1ed3c7 100644 --- a/website/docs/design/design-for-composition.mdx +++ b/website/docs/design/design-for-composition.mdx @@ -23,7 +23,7 @@ We focus on building **small, independent, and easy-to-read facets**. Each facet ## Writing Facet Modules 1. Facet modules are self-contained code units. They do not import anything. -2. Each facet should have one corresponding facet modules. +2. Each facet should have one corresponding facet module. 3. Facet modules are used to initialize facets on deployment and during upgrades. 4. Facet modules are also used to integrate custom facets with Compose facets. 5. Facet modules have one or more functions which are used to initialize storage variables during deployment. diff --git a/website/docs/foundations/composable-facets.mdx b/website/docs/foundations/composable-facets.mdx index ad80355d..f0282259 100644 --- a/website/docs/foundations/composable-facets.mdx +++ b/website/docs/foundations/composable-facets.mdx @@ -78,8 +78,8 @@ On-chain facets are the **building blocks** of Compose. Like LEGO bricks, they'r ## Composability Benefits 1. **Start Simple, then Scale**: Begin with core functionality, add features -3. **Increase Confidence**: Use tested, audited facets from the Compose library to build your project -4. **Architectural Flexibility**: Same facets, infinite configurations based on your project needs +2. **Increase Confidence**: Use tested, audited facets from the Compose library to build your project +3. **Architectural Flexibility**: Same facets, infinite configurations based on your project needs ### Composition vs. Inheritance diff --git a/website/docs/foundations/diamond-contracts.mdx b/website/docs/foundations/diamond-contracts.mdx index 5241dae2..fecef74c 100644 --- a/website/docs/foundations/diamond-contracts.mdx +++ b/website/docs/foundations/diamond-contracts.mdx @@ -18,7 +18,7 @@ A diamond contract is a smart contract made from multiple small building blocks A diamond has: - One address -- It's own data storage +- Its own data storage - Multiple facets providing functionality Below is a diagram showing a diamond with multiple facets. diff --git a/website/docs/foundations/reusable-facet-logic.mdx b/website/docs/foundations/reusable-facet-logic.mdx index a67eb727..10fd0fdf 100644 --- a/website/docs/foundations/reusable-facet-logic.mdx +++ b/website/docs/foundations/reusable-facet-logic.mdx @@ -40,7 +40,7 @@ Suppose you want to create a new ERC-20 token that supports gasless approvals (p With Compose, you: -1. **Select existing facets**: `ERC20Facet`, `ERC20PermitFacet`, and `ERC20BridgableFacet` are already deployed on-chain +1. **Select existing facets**: `ERC20Facet`, `ERC20PermitFacet`, and `ERC20BridgeableFacet` are already deployed on-chain 2. **Provide initialization data**: your token's name, symbol, and total supply 3. **Deploy your diamond**: a small proxy contract that references the facet addresses and logic diff --git a/website/docs/foundations/solidity-modules.mdx b/website/docs/foundations/solidity-modules.mdx index 5427171c..8f51c6b5 100644 --- a/website/docs/foundations/solidity-modules.mdx +++ b/website/docs/foundations/solidity-modules.mdx @@ -1,7 +1,7 @@ --- sidebar_position: 3 title: Solidity Modules -description: Descrition of what Solidity modules are and how they are used in Compose. +description: Description of what Solidity modules are and how they are used in Compose. ---