Warning
This is experimental software and is provided on an "as is" and "as available" basis. We do not give any warranties and will not be liable for any losses incurred through any use of this code base.
OpenZeppelin Contracts for Sui is a collection of secure smart contract libraries written in Move for the Sui blockchain. Our goal is to bring Web3 standards under the OpenZeppelin quality by providing a set of high-quality, battle-tested contracts that can be used to build decentralized applications on the Sui network.
Sui smart contracts are written in Move leveraging the Sui Move framework.
Follow the installation guide in the Sui documentation.
Required version: Sui CLI 1.59.1.
Documentation is available inline in the source code. You can generate the documentation locally using:
# Generate and view documentation for a specific package
sui move build --doc --path <module>We strive to maintain consistency with other OpenZeppelin libraries as much as possible, following the same conventions and patterns. However, this Sui library does not have a 1-to-1 mapping with other OpenZeppelin contracts. Due to differences in the Sui architecture and Move language capabilities, certain features and implementations may differ from their counterparts in other ecosystems.
This project is maintained by OpenZeppelin with the goal of providing a secure and reliable library of smart contract components for the Sui ecosystem. We address security through risk management in various areas such as engineering and open source best practices, scoping and API design, multi-layered review processes, and incident response preparedness.
Refer to SECURITY.md for more details.
Past audits can be found in audits/.
Smart contracts are an evolving technology and carry a high level of technical risk and uncertainty. Although OpenZeppelin is well known for its security audits, using this library is not a substitute for a security audit.
We welcome contributions from the community!
If you are looking for a good place to start, find a good first issue here.
You can open an issue for a bug report, or feature request.
You can find more details in our Contributing guide, and please read our Code of Conduct.
OpenZeppelin Contracts for Sui is released under the MIT License.