Skip to content

Commit 0b8f7e8

Browse files
committed
feat: update API references
1 parent d9e31d5 commit 0b8f7e8

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

content/contracts-sui/1.x/access.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public fun wrap_admin_cap(
4848
## Choosing a transfer policy
4949

5050
- Use `two_step_transfer` when the signer triggering transfer initiation is the same principal that should retain cancel authority.
51-
- Use `delayed_transfer` when protocol safety requires on-chain lead time before transfer or unwrap execution.
51+
- Use `delayed_transfer` when protocol safety requires on-chain lead time before transfer or unwrap execution, and when initial wrapper custody should be assigned explicitly at wrap time.
5252

5353
## API Reference
5454

content/contracts-sui/1.x/api/access.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ Raised when caller is not the designated prospective owner in `accept_transfer`.
314314
use openzeppelin_access::delayed_transfer;
315315
```
316316

317-
Time-locked ownership wrapper for `T: key + store`. Transfers and unwraps must be scheduled and can only execute after `min_delay_ms` elapses.
317+
Time-locked ownership wrapper for `T: key + store`. The wrapped object is placed under a wrapper that is immediately transferred to a chosen recipient. After that, transfers and unwraps must be scheduled and can only execute after `min_delay_ms` elapses.
318318

319319
Types
320320

@@ -325,7 +325,7 @@ Types
325325

326326
Functions
327327

328-
- [`wrap(obj, min_delay_ms, ctx)`](#delayed_transfer-wrap)
328+
- [`wrap(obj, min_delay_ms, recipient, ctx)`](#delayed_transfer-wrap)
329329
- [`borrow(self)`](#delayed_transfer-borrow)
330330
- [`borrow_mut(self)`](#delayed_transfer-borrow_mut)
331331
- [`borrow_val(self)`](#delayed_transfer-borrow_val)
@@ -391,11 +391,11 @@ Hot-potato guard proving a value extracted with `borrow_val` is returned to the
391391
#### Functions [!toc] [#delayed_transfer-Functions]
392392

393393
<APIItem
394-
functionSignature="wrap<T: key + store>(obj: T, min_delay_ms: u64, ctx: &mut TxContext) -> DelayedTransferWrapper<T>"
394+
functionSignature="wrap<T: key + store>(obj: T, min_delay_ms: u64, recipient: address, ctx: &mut TxContext)"
395395
id="delayed_transfer-wrap"
396396
kind="public"
397397
>
398-
Wraps `obj` in a delayed-transfer wrapper and records minimum execution delay.
398+
Wraps `obj` in a delayed-transfer wrapper, records the minimum execution delay, and transfers initial wrapper custody to `recipient`.
399399

400400
The wrapped object is stored under a dynamic object field so object ID discovery remains straightforward for indexers.
401401

0 commit comments

Comments
 (0)