Skip to content

OpenZeppelin/contracts-sui

OpenZeppelin Contracts for Sui

Lint and Test Coverage Status License

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.

Usage

Sui smart contracts are written in Move leveraging the Sui Move framework.

Install Sui:

Follow the installation guide in the Sui documentation.

Required version: Sui CLI 1.58.3.

Docs

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>

Notes

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.

Security

Warning

This library has not been audited yet. Use at your own risk.

For security concerns, please refer to our Security Policy.

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 OpenZeppelin Contracts for Sui is not a substitute for a security audit.

Contribute

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.

License

OpenZeppelin Contracts for Sui is released under the MIT License.

About

OpenZeppelin's secure and reusable contracts for the Sui Move ecosystem.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published