Skip to content

Add Token Sale docs #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0xNeshi wants to merge 3 commits into
base: release/sui-v1.5
Choose a base branch
from
Open

Add Token Sale docs #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dfedbd5
Add Token Sale docs
0xNeshi Jul 14, 2026
0b57a1a
Update llms.txt with new documentation links
0xNeshi Jul 16, 2026
9062557
Add overview link for Sale package in llms.txt
0xNeshi Jul 16, 2026
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
1,218 changes: 1,218 additions & 0 deletions content/contracts-sui/1.x/api/sale.mdx
View file
Open in desktop

Large diffs are not rendered by default.

19 changes: 16 additions & 3 deletions content/contracts-sui/1.x/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: Contracts for Sui 1.x
---

**OpenZeppelin Contracts for Sui v1.x** ships four core packages:
**OpenZeppelin Contracts for Sui v1.x** ships these core packages:

- `openzeppelin_math` for deterministic integer arithmetic, configurable rounding, and decimal scaling.
- `openzeppelin_fp_math` for 9-decimal fixed-point arithmetic (`UD30x9`, `SD29x9`) backed by `u128`.
- `openzeppelin_access` for role-based authorization and ownership-transfer wrappers around privileged `key + store` objects.
- `openzeppelin_utils` for embeddable building blocks; its first module, `rate_limiter`, provides multi-strategy rate limiting.
- `openzeppelin_sale` for fixed-price token sales (presale / IDO): a prefunded inventory sold in a capped window, with refunds, optional compliance gating, and optional vesting.

## Quickstart

Expand Down Expand Up @@ -35,6 +36,8 @@ mvr add @openzeppelin-move/utils

You only need the dependencies your app actually uses. Add what you need and drop the others.

Packages not yet on the Move Registry - currently `openzeppelin_sale` - are added by git revision instead of `mvr add` (see the next step).

### 3. Verify `Move.toml`

`mvr add` updates `Move.toml` automatically. With all three installed it should include:
Expand All @@ -47,6 +50,14 @@ openzeppelin_fp_math = { r.mvr = "@openzeppelin-move/fixed-point-math" }
openzeppelin_utils = { r.mvr = "@openzeppelin-move/utils" }
```

Since `openzeppelin_sale` isn't on MVR yet, add it manually, pinned to a git revision:

```toml
openzeppelin_sale = { git = "https://github.com/OpenZeppelin/contracts-sui.git", subdir = "contracts/finance", rev = "v1.5.0" }
```

Alternatively, copy the module sources directly into your package's `sources/` so you fully own the code - see each package guide for the per-package options.

### 4. Add a Minimal Module

Create `sources/quickstart.move`:
Expand Down Expand Up @@ -83,13 +94,15 @@ sui move test
- Need fractional values like prices, fees, rates, or signed deltas? Use [Fixed-Point Math](/contracts-sui/1.x/fixed-point).
- Need integer arithmetic with safe overflow and explicit rounding? Use [Integer Math](/contracts-sui/1.x/math).
- Need to throttle withdrawals, meter per-user budgets, gate action reuse, or delay an action? Use [Rate Limiter](/contracts-sui/1.x/rate-limiter).
- Need to run a fixed-price token sale or presale with caps, refunds, and optional KYC or vesting? Use [Sale](/contracts-sui/1.x/sale).

The packages compose. A typical protocol module imports `openzeppelin_math` for share math, `openzeppelin_fp_math` for rate and fee math, and `openzeppelin_access` for the admin capability that governs both.

## Next steps

- Package guides: [Integer Math](/contracts-sui/1.x/math), [Fixed-Point Math](/contracts-sui/1.x/fixed-point), [Access](/contracts-sui/1.x/access), [Utilities](/contracts-sui/1.x/utils).
- Package guides: [Integer Math](/contracts-sui/1.x/math), [Fixed-Point Math](/contracts-sui/1.x/fixed-point), [Access](/contracts-sui/1.x/access), [Utilities](/contracts-sui/1.x/utils), [Sale](/contracts-sui/1.x/sale).
- Access modules: [RBAC](/contracts-sui/1.x/access-control), [Two-Step Transfer](/contracts-sui/1.x/two-step-transfer), [Delayed Transfer](/contracts-sui/1.x/delayed-transfer).
- Utilities modules: [Rate Limiter](/contracts-sui/1.x/rate-limiter).
- Sale modules: [Prefunded Sale](/contracts-sui/1.x/prefunded-sale).
- Learn: [Role Based Access Control](/contracts-sui/1.x/guides/access-control).
- API reference: [Integer Math](/contracts-sui/1.x/api/math), [Fixed-Point Math](/contracts-sui/1.x/api/fixed-point), [Access](/contracts-sui/1.x/api/access), [Utilities](/contracts-sui/1.x/api/utils).
- API reference: [Integer Math](/contracts-sui/1.x/api/math), [Fixed-Point Math](/contracts-sui/1.x/api/fixed-point), [Access](/contracts-sui/1.x/api/access), [Utilities](/contracts-sui/1.x/api/utils), [Sale](/contracts-sui/1.x/api/sale).
Loading