Module `sui::pay`

This module provides handy functionality for wallets and <code>sui::Coin</code> management.

Constants
Function keep
Function split
Function split_vec
Function split_and_transfer
Function divide_and_keep
Function join
Function join_vec
Function join_vec_and_transfer

<pre><code>use <a href="../std/address.md#std_address">std::address</a>; use <a href="../std/ascii.md#std_ascii">std::ascii</a>; use <a href="../std/bcs.md#std_bcs">std::bcs</a>; use <a href="../std/internal.md#std_internal">std::internal</a>; use <a href="../std/option.md#std_option">std::option</a>; use <a href="../std/string.md#std_string">std::string</a>; use <a href="../std/type_name.md#std_type_name">std::type_name</a>; use <a href="../std/u128.md#std_u128">std::u128</a>; use <a href="../std/vector.md#std_vector">std::vector</a>; use <a href="../sui/accumulator.md#sui_accumulator">sui::accumulator</a>; use <a href="../sui/accumulator_settlement.md#sui_accumulator_settlement">sui::accumulator_settlement</a>; use <a href="../sui/address.md#sui_address">sui::address</a>; use <a href="../sui/bag.md#sui_bag">sui::bag</a>; use <a href="../sui/balance.md#sui_balance">sui::balance</a>; use <a href="../sui/bcs.md#sui_bcs">sui::bcs</a>; use <a href="../sui/coin.md#sui_coin">sui::coin</a>; use <a href="../sui/config.md#sui_config">sui::config</a>; use <a href="../sui/deny_list.md#sui_deny_list">sui::deny_list</a>; use <a href="../sui/dynamic_field.md#sui_dynamic_field">sui::dynamic_field</a>; use <a href="../sui/dynamic_object_field.md#sui_dynamic_object_field">sui::dynamic_object_field</a>; use <a href="../sui/event.md#sui_event">sui::event</a>; use <a href="../sui/funds_accumulator.md#sui_funds_accumulator">sui::funds_accumulator</a>; use <a href="../sui/hash.md#sui_hash">sui::hash</a>; use <a href="../sui/hex.md#sui_hex">sui::hex</a>; use <a href="../sui/object.md#sui_object">sui::object</a>; use <a href="../sui/party.md#sui_party">sui::party</a>; use <a href="../sui/protocol_config.md#sui_protocol_config">sui::protocol_config</a>; use <a href="../sui/table.md#sui_table">sui::table</a>; use <a href="../sui/transfer.md#sui_transfer">sui::transfer</a>; use <a href="../sui/tx_context.md#sui_tx_context">sui::tx_context</a>; use <a href="../sui/types.md#sui_types">sui::types</a>; use <a href="../sui/url.md#sui_url">sui::url</a>; use <a href="../sui/vec_map.md#sui_vec_map">sui::vec_map</a>; use <a href="../sui/vec_set.md#sui_vec_set">sui::vec_set</a>; </code></pre>

Constants

For when empty vector is supplied into join function.

<pre><code>const <a href="../sui/pay.md#sui_pay_ENoCoins">ENoCoins</a>: u64 = 0; </code></pre>

Function `keep`

Transfer <code>c</code> to the sender of the current transaction

<pre><code>public fun <a href="../sui/pay.md#sui_pay_keep">keep</a><T>(c: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>, ctx: &<a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/pay.md#sui_pay_keep">keep</a><T>(c: Coin<T>, ctx: &TxContext) { <a href="../sui/transfer.md#sui_transfer_public_transfer">transfer::public_transfer</a>(c, ctx.sender()) } </code></pre> </details>

Function `split`

Split <code><a href="../sui/coin.md#sui_coin">coin</a></code> to two coins, one with balance <code>split_amount</code>, and the remaining balance is left in <code><a href="../sui/coin.md#sui_coin">coin</a></code>.

<pre><code>public entry fun <a href="../sui/pay.md#sui_pay_split">split</a><T>(<a href="../sui/coin.md#sui_coin">coin</a>: &mut <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>, split_amount: u64, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public entry fun <a href="../sui/pay.md#sui_pay_split">split</a><T>(<a href="../sui/coin.md#sui_coin">coin</a>: &mut Coin<T>, split_amount: u64, ctx: &mut TxContext) { <a href="../sui/pay.md#sui_pay_keep">keep</a>(<a href="../sui/coin.md#sui_coin">coin</a>.<a href="../sui/pay.md#sui_pay_split">split</a>(split_amount, ctx), ctx) } </code></pre> </details>

Function `split_vec`

Split coin <code>self</code> into multiple coins, each with balance specified in <code>split_amounts</code>. Remaining balance is left in <code>self</code>.

<pre><code>public entry fun <a href="../sui/pay.md#sui_pay_split_vec">split_vec</a><T>(self: &mut <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>, split_amounts: vector<u64>, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public entry fun <a href="../sui/pay.md#sui_pay_split_vec">split_vec</a><T>(self: &mut Coin<T>, split_amounts: vector<u64>, ctx: &mut TxContext) { split_amounts.do!(|amount| <a href="../sui/pay.md#sui_pay_split">split</a>(self, amount, ctx)); } </code></pre> </details>

Function `split_and_transfer`

Send <code>amount</code> units of <code>c</code> to <code>recipient</code> Aborts with <code><a href="../sui/balance.md#sui_balance_ENotEnough">sui::balance::ENotEnough</a></code> if <code>amount</code> is greater than the balance in <code>c</code>

<pre><code>public entry fun <a href="../sui/pay.md#sui_pay_split_and_transfer">split_and_transfer</a><T>(c: &mut <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>, amount: u64, recipient: address, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public entry fun <a href="../sui/pay.md#sui_pay_split_and_transfer">split_and_transfer</a><T>( c: &mut Coin<T>, amount: u64, recipient: address, ctx: &mut TxContext, ) { <a href="../sui/transfer.md#sui_transfer_public_transfer">transfer::public_transfer</a>(c.<a href="../sui/pay.md#sui_pay_split">split</a>(amount, ctx), recipient) } </code></pre> </details>

Function `divide_and_keep`

Divide coin <code>self</code> into <code>n - 1</code> coins with equal balances. If the balance is not evenly divisible by <code>n</code>, the remainder is left in <code>self</code>.

<pre><code>public entry fun <a href="../sui/pay.md#sui_pay_divide_and_keep">divide_and_keep</a><T>(self: &mut <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>, n: u64, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public entry fun <a href="../sui/pay.md#sui_pay_divide_and_keep">divide_and_keep</a><T>(self: &mut Coin<T>, n: u64, ctx: &mut TxContext) { self.divide_into_n(n, ctx).destroy!(|<a href="../sui/coin.md#sui_coin">coin</a>| <a href="../sui/transfer.md#sui_transfer_public_transfer">transfer::public_transfer</a>(<a href="../sui/coin.md#sui_coin">coin</a>, ctx.sender())); } </code></pre> </details>

Function `join`

Join <code><a href="../sui/coin.md#sui_coin">coin</a></code> into <code>self</code>. Re-exports <code><a href="../sui/coin.md#sui_coin_join">coin::join</a></code> function. Deprecated: you should call <code><a href="../sui/coin.md#sui_coin">coin</a>.<a href="../sui/pay.md#sui_pay_join">join</a>(other)</code> directly.

<pre><code>public entry fun <a href="../sui/pay.md#sui_pay_join">join</a><T>(self: &mut <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>, <a href="../sui/coin.md#sui_coin">coin</a>: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public entry fun <a href="../sui/pay.md#sui_pay_join">join</a><T>(self: &mut Coin<T>, <a href="../sui/coin.md#sui_coin">coin</a>: Coin<T>) { self.<a href="../sui/pay.md#sui_pay_join">join</a>(<a href="../sui/coin.md#sui_coin">coin</a>) } </code></pre> </details>

Function `join_vec`

Join everything in <code>coins</code> with <code>self</code>

<pre><code>public entry fun <a href="../sui/pay.md#sui_pay_join_vec">join_vec</a><T>(self: &mut <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>, coins: vector<<a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public entry fun <a href="../sui/pay.md#sui_pay_join_vec">join_vec</a><T>(self: &mut Coin<T>, coins: vector<Coin<T>>) { coins.destroy!(|<a href="../sui/coin.md#sui_coin">coin</a>| self.<a href="../sui/pay.md#sui_pay_join">join</a>(<a href="../sui/coin.md#sui_coin">coin</a>)); } </code></pre> </details>

Function `join_vec_and_transfer`

Join a vector of <code>Coin</code> into a single object and transfer it to <code>receiver</code>.

<pre><code>public entry fun <a href="../sui/pay.md#sui_pay_join_vec_and_transfer">join_vec_and_transfer</a><T>(coins: vector<<a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>>, receiver: address) </code></pre> <details> <summary>Implementation</summary> <pre><code>public entry fun <a href="../sui/pay.md#sui_pay_join_vec_and_transfer">join_vec_and_transfer</a><T>(mut coins: vector<Coin<T>>, receiver: address) { assert!(coins.length() > 0, <a href="../sui/pay.md#sui_pay_ENoCoins">ENoCoins</a>); let mut self = coins.pop_back(); <a href="../sui/pay.md#sui_pay_join_vec">join_vec</a>(&mut self, coins); <a href="../sui/transfer.md#sui_transfer_public_transfer">transfer::public_transfer</a>(self, receiver) } </code></pre> </details>

Constants

Function keep

Function split

Function split_vec

Function split_and_transfer

Function divide_and_keep

Function join

Function join_vec

Function join_vec_and_transfer