Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 38 additions & 13 deletions docs/tools/openzeppelin-contracts.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: OpenZeppelin Stellar Contracts
description: OpenZeppelin Stellar Contract Library and Contract Wizard
sidebar_label: OpenZeppelin Contracts
title: OpenZeppelin Contracts and Toolings
description: OpenZeppelin Contract Library and Toolings
sidebar_label: OpenZeppelin Contracts and Toolings
sidebar_position: 44
---

<script async src="https://wizard.openzeppelin.com/build/embed.js"></script>

To bring battle-tested smart contracts to the Stellar developer community, OpenZeppelin is actively contributing towards a library of smart contracts and extensions, as well as developer tooling.
To bring battle-tested smart contracts to the Stellar developer community, OpenZeppelin is actively contributing towards a library of smart contracts and extensions, as well as developer tooling (including products such as [Contract Wizard](https://wizard.openzeppelin.com/stellar), [Relayer](https://github.com/OpenZeppelin/openzeppelin-relayer), [Monitor](https://github.com/OpenZeppelin/openzeppelin-monitor), and [UI Builder](https://builder.openzeppelin.com/)). For latest docs on OpenZeppelin products, please visit: [https://docs.openzeppelin.com/stellar-contracts](https://docs.openzeppelin.com/stellar-contracts/.).

## Getting started with Contract Wizard

Expand Down Expand Up @@ -58,6 +58,29 @@ OpenZeppelin Stellar Contracts is a collection of audited contracts and utilitie
- **Allowlist**: Restrict transfers to approved addresses
- **Blocklist**: Prevent transfers from/to blocked addresses

**RWA (ERC-3643) Token** The RWA token extends the standard fungible token functionality with regulatory features required for security tokens, including:

- Features:
- **Identity Management**: Integration with identity registries for KYC/AML compliance
- **Compliance Framework**: Modular compliance rules and validation for transfers and minting
- **Transfer Controls**: Sophisticated transfer restrictions and validations
- **Freezing Mechanisms**: Address-level and partial token freezing capabilities
- **Recovery System**: Lost/old account recovery for verified investors
- **Pausable Operations**: Emergency pause functionality for the entire token
- **Role-Based Access Control (RBAC)**: Flexible privilege management for administrative functions

**Token Vault** The Fungible Token Vault extends the Fungible Token and implents [SEP-56 Tokenized Vault Standard](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0056.md), enabling fungible tokens to represent shares in an underlying asset pool. The tokenized vault standard is the formalized interface for yield-bearing vaults that hold underlying assets. Vault shares enable hyperfungible collaterals in DeFi and remain fully compatible with standard fungible token operations.

**Smart Accounts**

Smart Accounts are contract based wallets made for flexible and programmable authorization. This framework takes a context-centric approach, separating three distinct concerns: who is allowed to sign (signers), what they are allowed to do (scope/context rules), and how those permissions are enforced (policies). The initial release includes policies for multisig and spending limits.

- Components:
- **Context rules**: Routing table for authorization
- **Signers**: List of authorized signers (delegated address, or external signers)
- **Policies**: Enforcement module attached to context rules
- **Verifiers**: Trust contracts that validate signatures on behalf of smart accounts

**Utilities**

- **Pausable and Upgradeable Utilities**
Expand All @@ -66,28 +89,30 @@ OpenZeppelin Stellar Contracts is a collection of audited contracts and utilitie

**Coming Soon**

- Security Token (ERC-3643)
- Multisig
- Passkey signer
- Token Vault (ERC-4626)
- Fixed point math
- Governor

These implementations are being released over time, ensuring that Stellar developers have access to extensible contract options. All contracts and extensions are audited by OpenZeppelin's security team, enhancing security and reliability of the contracts and extensions. To use the library, please go to: https://github.com/OpenZeppelin/stellar-contracts.
All contracts and extensions are audited by OpenZeppelin's security team, enhancing security and reliability of the contracts and extensions. Additional formal verification is being completed by Certora. To use the library, please visit: https://github.com/OpenZeppelin/stellar-contracts.

```
Repository Structure
│── audits/ # Audit reports
│── docs/ # Documentation
│── examples/ # Example contracts
│── packages/
│ ├── tokens/ # Various token types (fungible, non-fungible, etc.)
│ ├── access/ # Access control, ownable, and role transfer utilities
│ ├── accounts/ # Smart account framework
│ ├── tokens/ # Various token types (fungible, non-fungible, RWA, vault, etc.)
│ ├── contract-utils/ # Utilities for token types (pausable, upgradable, etc.)
│ ├── constants/ # Shared constants
│ ├── test-utils/ # Utilities for tests

```

To provide feedback, please open issues here: [https://github.com/OpenZeppelin/stellar-contracts/issues](https://github.com/OpenZeppelin/stellar-contracts/issues)
To provide feedback on these contracts and utilties, please open issues at: [https://github.com/OpenZeppelin/stellar-contracts/issues](https://github.com/OpenZeppelin/stellar-contracts/issues)

## Docs for OpenZeppelin Stellar Contracts
### OpenZeppelin Tools

For additional docs on Stellar smart contracts by OpenZeppelin, please visit: [https://docs.openzeppelin.com/stellar-contracts](https://docs.openzeppelin.com/stellar-contracts/.).
- [Relayer](https://github.com/OpenZeppelin/openzeppelin-relayer): Infrastructure for relaying transactions on Stellar.
- [Monitor](https://github.com/OpenZeppelin/openzeppelin-monitor): Infrastructure tool for monitoring blockchain events and transactions.
- [UI Builder](https://builder.openzeppelin.com/): Open source tool for creating UI forms for contracts.