Join our community of builders on

Home Forum Website Impact

Contracts for Sui 1.x

OpenZeppelin Contracts for Sui v1.x ships two core packages:

openzeppelin_math for deterministic arithmetic, configurable rounding, and decimal scaling.
openzeppelin_access for ownership-transfer wrappers around privileged key + store objects.

Quickstart

Prerequisites

Sui CLI installed.
MVR CLI installed.
A new or existing Move package.

1. Create a Move Package

sui move new my_sui_app
cd my_sui_app

2. Add OpenZeppelin Dependencies from MVR

mvr add @openzeppelin-move/access
mvr add @openzeppelin-move/integer-math

3. Verify `Move.toml`

mvr add updates Move.toml automatically. It should include:

[dependencies]
openzeppelin_access = { r.mvr = "@openzeppelin-move/access" }
openzeppelin_math = { r.mvr = "@openzeppelin-move/integer-math" }

4. Add a Minimal Module

Create sources/quickstart.move:

module my_sui_app::quickstart;

use openzeppelin_math::{rounding, u64};
use std::option;

// === Functions ===

public fun quote_with_fee(amount: u64): u64 {
    // 2.5% fee, rounded to nearest.
    let quoted = amount.mul_div(1025u64, 1000u64, rounding::nearest());
    quoted.destroy_some()
}

public fun sqrt_floor(value: u64): u64 {
    value.sqrt(rounding::down())
}

5. Build and Test

sui move build
sui move test

Next Steps

Read package guides: Integer Math, Access.
Use API docs: Integer Math, Access.

On this page

Quickstart Prerequisites 1. Create a Move Package 2. Add OpenZeppelin Dependencies from MVR 3. Verify Move.toml4. Add a Minimal Module 5. Build and Test Next Steps