Release/docs 2 owner

website/docs/library/access/Owner/Data/OwnerDataFacet.mdx

@@ -0,0 +1,94 @@
+---
+sidebar_position: 100
+title: "Owner Data Facet"
+description: "ERC-173 read-only owner data access for diamonds"
+sidebar_label: "Facet"
+gitSource: "https://github.com/Perfect-Abstractions/Compose/tree/main/src/access/Owner/Data/OwnerDataFacet.sol"
+---
+
+import DocSubtitle  from '@site/src/components/docs/DocSubtitle';
+import Badge from '@site/src/components/ui/Badge';
+import Callout from '@site/src/components/ui/Callout';
+import CalloutBox from '@site/src/components/ui/CalloutBox';
+import Accordion, { AccordionGroup } from '@site/src/components/ui/Accordion';
+import PropertyTable from '@site/src/components/api/PropertyTable';
+import ExpandableCode from '@site/src/components/code/ExpandableCode';
+import CodeShowcase from '@site/src/components/code/CodeShowcase';
+import RelatedDocs from '@site/src/components/docs/RelatedDocs';
+import WasThisHelpful from '@site/src/components/docs/WasThisHelpful';
+import LastUpdated from '@site/src/components/docs/LastUpdated';
+import ReadingTime from '@site/src/components/docs/ReadingTime';
+import GradientText from '@site/src/components/ui/GradientText';
+import GradientButton from '@site/src/components/ui/GradientButton';
+import PackageImport from '@site/src/components/docs/PackageImport';
+
+<PackageImport/>
+
+<DocSubtitle>
+Read-only Owner data access for diamonds
+</DocSubtitle>
+
+<Callout type="info" title="Key Features">
+- Exposes the contract owner via external `owner()`.
+- Shares `OwnerStorage` at `erc8042:erc173.owner` with `OwnerDataMod` and other Ownership facets.
+- Read-Only facet
+</Callout>
+
+## Storage
+
+### State Variables
+
+<PropertyTable
+  properties={[
+    {
+      name: "STORAGE_POSITION",
+      type: "bytes32",
+      description: "Owner storage position within the diamond (Value: `keccak256(\"erc173.owner\")`)"
+    }
+  ]}
+  showRequired={false}
+/>
+
+### OwnerStorage
+
+
+<ExpandableCode language="solidity" maxLines={15} title="Definition">
+{`/** storage-location: erc8042:erc173.owner */
+struct OwnerStorage {
+    address owner;
+}`}
+</ExpandableCode>
+
+## Functions
+
+### owner
+
+Returns the address of the diamond owner
+
+<ExpandableCode language="solidity" maxLines={8}>
+{`function owner() external view returns (address);`}
+</ExpandableCode>
+
+**Returns:**
+
+<PropertyTable
+  properties={[
+    {
+      name: "-",
+      type: "address",
+      description: "The current owner, or `address(0)` if unset or renounced."
+    }
+  ]}
+  showRequired={false}
+/>
+
+
+
+## Best Practices
+
+- Transfer ownership with a facet that uses `OwnerDataMod` (for example `OwnerTransferFacet`) so `owner()` always reflects the real owner.
+- Avoid defining a second facet that writes to a different owner slot; keep all -owner state at `erc173.owner`
+- Use [`setContractOwner()`](/docs/library/access/Owner/Data/OwnerDataMod#setcontractowner) in `OwnerDataMod` to initialize the owner when constructing your diamond.
+
+
+<LastUpdated date="2026-06-05T12:00:00.000Z" />

website/docs/library/access/Owner/Data/OwnerDataMod.mdx

@@ -0,0 +1,215 @@
+---
+sidebar_position: 110
+title: "Owner Data Module"
+description: "ERC-173 diamond storage, owner reads, guards, and initial owner setup"
+sidebar_label: "Module"
+gitSource: "https://github.com/Perfect-Abstractions/Compose/tree/main/src/access/Owner/Data/OwnerDataMod.sol"
+---
+
+import DocSubtitle  from '@site/src/components/docs/DocSubtitle';
+import Badge from '@site/src/components/ui/Badge';
+import Callout from '@site/src/components/ui/Callout';
+import CalloutBox from '@site/src/components/ui/CalloutBox';
+import Accordion, { AccordionGroup } from '@site/src/components/ui/Accordion';
+import PropertyTable from '@site/src/components/api/PropertyTable';
+import ExpandableCode from '@site/src/components/code/ExpandableCode';
+import CodeShowcase from '@site/src/components/code/CodeShowcase';
+import RelatedDocs from '@site/src/components/docs/RelatedDocs';
+import WasThisHelpful from '@site/src/components/docs/WasThisHelpful';
+import LastUpdated from '@site/src/components/docs/LastUpdated';
+import ReadingTime from '@site/src/components/docs/ReadingTime';
+import GradientText from '@site/src/components/ui/GradientText';
+import GradientButton from '@site/src/components/ui/GradientButton';
+import PackageImport from '@site/src/components/docs/PackageImport';
+
+<PackageImport/>
+
+<DocSubtitle>
+Helper functions for owner storage, reads, and owner check based on ERC-173
+</DocSubtitle>
+
+<Callout type="info" title="Key Features">
+- `requireOwner()` guards by requiring `msg.sender` is the stored owner.
+- `setContractOwner` has no access control validation (Trusted initialization only).
+- Emits `OwnershipTransferred` from `setContractOwner` with `previousOwner == address(0)`.
+</Callout>
+
+<Callout type="important" title="Module Usage">
+You can use modules to wrap around you own project logic while using the default Compose building blocks. Modules provides all the necessary internal helpers for maximum integration.
+
+See <a href="/docs/foundations/facets-and-modules">Facets &amp; Modules</a> for more information.
+</Callout>
+
+
+## Storage
+
+### State Variables
+
+<PropertyTable
+  properties={[
+    {
+      name: "STORAGE_POSITION",
+      type: "bytes32",
+      description: "Owner storage position within the diamond (Value: `keccak256(\"erc173.owner\")`)"
+    }
+  ]}
+  showRequired={false}
+/>
+
+### OwnerStorage
+
+<ExpandableCode language="solidity" maxLines={15} title="Definition">
+{`/** storage-location: erc8042:erc173.owner */
+struct OwnerStorage {
+    address owner;
+}`}
+</ExpandableCode>
+
+## Functions
+
+### getStorage
+
+Returns a pointer to the `OwnerStorage` struct.
+
+<ExpandableCode language="solidity" maxLines={8}>
+{`function getStorage() pure returns (OwnerStorage storage s);`}
+</ExpandableCode>
+
+**Returns:**
+
+<PropertyTable
+  properties={[
+    {
+      name: "s",
+      type: "OwnerStorage storage",
+      description: "The struct in storage."
+    }
+  ]}
+  showRequired={false}
+/>
+
+---
+### owner
+
+Get the address of the owner
+
+<ExpandableCode language="solidity" maxLines={8}>
+{`function owner() view returns (address);`}
+</ExpandableCode>
+
+**Returns:**
+
+<PropertyTable
+  properties={[
+    {
+      name: "-",
+      type: "address",
+      description: "The stored owner, or `address(0)` if never set or cleared."
+    }
+  ]}
+  showRequired={false}
+/>
+
+---
+### requireOwner
+
+Verify if the message sender is the current diamond owner. Useful for gating specify logic inside your own facets.
+
+<ExpandableCode language="solidity" maxLines={8}>
+{`function requireOwner() view;`}
+</ExpandableCode>
+
+**Reverts:**
+
+<PropertyTable
+  properties={[
+    {
+      name: "OwnerUnauthorizedAccount",
+      type: "error",
+      description: "Caller is not the current owner."
+    }
+  ]}
+  showRequired={false}
+/>
+
+---
+### setContractOwner
+
+Writes the inital owner address to storage and emits `OwnershipTransferred(address(0), _initialOwner)`. 
+
+There is **no** `msg.sender` or role check performed. Use only from trusted initialization code, or wrap with your own checks in a facet.
+
+<ExpandableCode language="solidity" maxLines={8}>
+{`function setContractOwner(address _initialOwner);`}
+</ExpandableCode>
+
+**Parameters:**
+
+<PropertyTable
+  properties={[
+    {
+      name: "_initialOwner",
+      type: "address",
+      description: "The address of the initial owner."
+    }
+  ]}
+  showRequired={false}
+/>
+
+## Events
+
+<AccordionGroup>
+  <Accordion title="OwnershipTransferred" defaultOpen={false}>
+    <div style={{marginBottom: "1rem"}}>
+      Emitted when the ownership changes. `setContractOwner` always uses `previousOwner == address(0)`. Transfer facets typically emit with the real previous owner.
+    </div>
+
+    <div style={{marginBottom: "1rem"}}>
+      <strong>Signature:</strong>
+      <ExpandableCode language="solidity" maxLines={5}>
+{`event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);`}
+      </ExpandableCode>
+    </div>
+
+  </Accordion>
+</AccordionGroup>
+
+## Errors
+
+<AccordionGroup>
+  <Accordion title="OwnerUnauthorizedAccount" defaultOpen={false}>
+    <div style={{marginBottom: "1rem"}}>
+      Thrown by `requireOwner` when `msg.sender` is not the curent owner. Other owner facets may also revert with this error.
+    </div>
+    <div>
+      <strong>Signature:</strong>
+      <ExpandableCode language="solidity" maxLines={5}>
+error OwnerUnauthorizedAccount();
+      </ExpandableCode>
+    </div>
+  </Accordion>
+  <Accordion title="OwnerAlreadyRenounced" defaultOpen={false}>
+    <div style={{marginBottom: "1rem"}}>
+      Declared here for shared use (for example renounce flows). This module does not reference it; companion facets may revert with it when ownership was already renounced.
+    </div>
+    <div>
+      <strong>Signature:</strong>
+      <ExpandableCode language="solidity" maxLines={5}>
+error OwnerAlreadyRenounced();
+      </ExpandableCode>
+    </div>
+  </Accordion>
+</AccordionGroup>
+
+## Best Practices
+
+- Call `setContractOwner` only from trusted init paths (constructor, one-off setup). For transfers, use `OwnerTransferMod.transferOwnership` or an equivalent facet so events record the real previous owner.
+- Guard external entrypoints with `requireOwner()` or equivalent before state changes restricted to the owner.
+
+## Integration Notes
+
+`OwnerStorage` is located at `keccak256("erc173.owner")` inside the diamond.
+
+All Compose Owner contracts use that slot, so `owner()` and transfer logic observe the same address.
+
+<LastUpdated date="2026-06-05T12:00:00.000Z" />

website/docs/library/access/Owner/Data/_category_.json

@@ -0,0 +1,6 @@
+{
+  "label": "Data",
+  "position": 99,
+  "collapsible": true,
+  "collapsed": true
+}