contracts-sui

KO | EN

gitlite — search

#react #typescript #llm #go #machine-learning #rust #docker #nodejs #java #cli #awesome-list #ios #mcp #open-source

(★ 49)

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

contracts-sui Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OpenZeppelin Contracts for Sui

[![Lint and Test](https://github.com/OpenZeppelin/contracts-sui/actions/workflows/test.yml/badge.svg)](https://github.com/OpenZeppelin/contracts-sui/actions/workflows/test.yml)
[![Coverage Status](https://codecov.io/gh/OpenZeppelin/contracts-sui/graph/badge.svg)](https://codecov.io/gh/OpenZeppelin/contracts-sui)
[![License](https://img.shields.io/github/license/OpenZeppelin/contracts-sui)](https://github.com/OpenZeppelin/contracts-sui/blob/main/LICENSE)

> [!WARNING]
> This library is open source and available to use, but is no longer under
active maintenance. No new features, bug fixes, or updates should be
expected on existing releases.
>
> The `UpgradeCap` for packages published to the Move Registry
under `@openzeppelin-move/*` has been made immutable, so these packages can no
longer be upgraded by OpenZeppelin or anyone else.

**OpenZeppelin Contracts for Sui** is a collection of secure smart contract
libraries written in Move for the [Sui blockchain](https://sui.io/). 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](https://docs.sui.io/guides/developer/getting-started/sui-install).

**Required version**: Sui CLI [1.75.2](https://github.com/MystenLabs/sui/releases/tag/mainnet-v1.75.2).

## Docs

Documentation is available inline in the source code. You can generate the
documentation locally using:

```bash
# Generate and view documentation for a specific package
sui move build --doc --path <module>
```

**AI agents:** [`llms.txt`](./llms.txt) is the discovery entry point for integrating
this library into a downstream project - it points to the package catalogs, examples,
generated API reference, and audits.

## 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

This project was built by OpenZeppelin with the goal of providing a secure and reliable library of smart contract components
for the Sui ecosystem. We addressed 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](SECURITY.md) for more details.

Past audits can be found in [`audits/`](./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.

## Contribute

We welcome contributions from the community!

If you are looking for a good place to start, find a good first issue
[here](https://github.com/OpenZeppelin/contracts-sui/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22).

You can open an issue for a
[bug report](https://github.com/OpenZeppelin/contracts-sui/issues/new?template=bug_report.yml),
or [feature request](https://github.com/OpenZeppelin/contracts-sui/issues/new?template=feature_request.yml).

You can find more details in our [Contributing](./CONTRIBUTING.md) guide, and
please read our [Code of Conduct](./CODE_OF_CONDUCT.md).

## License

OpenZeppelin Contracts for Sui is released under the [MIT License](./LICENSE).

contracts-sui

contracts-sui Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

contracts-sui

contracts-sui Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README