Sui (SUI)
Sui wallet structure
The Sui wallet has the following structure.
- Main address
- Fee address
- Child address
TIP In a centralized wallet, the fee (SUI) is deducted from the fee address when gathering. When withdrawing, the fee is deducted from the fee address only if the fee delegation feature is used.
Deposit
Deposit status
When an asset from the outside arrives at the main address, Octet recognizes it as a deposit. When an asset is sent to the main address but has not arrived, that transaction is not recognized. Therefore, there is no FAILED status for the deposit transaction.
| Status name | Description |
|---|---|
FINALIZED | Deposit is completed |
Gathering
Gathering is only available for centralized wallets.
Gathering process
Assets stored in child addresses don't move to the main address unless gathering is requested. Therefore, gatherings should be made regularly to avoid a deficit in the main address.
When gathering of a specific asset is requested, all assets stored in every child address get transferred to the main address. At this point, one transaction occurs per child address. For example, if SUI is stored in 10 child addresses, 10 transactions will occur in total.
At this point, gathering will not proceed if the asset to be gathered is less than the estimated fees. The gathering process is as follows.
- Request gathering.
- Generate a transaction for each child address to be gathered.
- Calculate the optimal fees and propagate the transactions.
- Gathering is completed when the transactions are confirmed in the blocks.
Gathering fees
The gathering fee is deducted from the fee address using the Sui fee delegation feature. Therefore, before starting the gathering, you must fill the fee address with Sui (SUI) to avoid a deficit.
If the balance of the fee address is insufficient, gathering proceeds only for as many transactions as can be generated. For example, if gathering needs to proceed for 10 child addresses but the fee address only has enough balance for 5 transactions, gathering proceeds for only 5 addresses and the remaining addresses are not gathered.
Gathering status
Gathering status can be specified into four types, depending on the process. The asset stored in the child address is in AWAITING_GATHERING status.
When gathering is requested and a gathering transaction is generated, the status of the asset changes to GATHERING. When the transaction is included in the blocks, the status of the asset is processed to COMPLETED and the gathering is finished.
When a gathering is tried and the transaction failed, the status of the asset is processed to GATHERING_FAILED. Assets in gathering failed status are included in the gathering target again. When a gathering is tried but failed to generate a transaction due to insufficient fees, it remains in AWAITING_GATHERING status.
| Status name | Description |
|---|---|
AWAITING_GATHERING | Awaiting gathering |
GATHERING | Generate gathering transaction |
COMPLETED | Complete gathering transaction |
GATHERING_FAILED | Failed gathering transaction |
Withdrawal
Withdrawal status
Unlike a deposit, a withdrawal is finalized (FINALIZED) at the moment when the transaction is included in the blocks.
| Status name | Description |
|---|---|
AWAITING_DECISION | Awaiting withdrawal approval |
REJECTED | Withdrawal is rejected |
AWAITING_WITHDRAWAL | Approved and awaiting withdrawal |
PENDING | Withdrawal transaction is generated |
FINALIZED | Withdrawal transaction is included in the blocks |
FAILED | Withdrawal transaction failed |
Balance lookup criteria
You can check the balance of the asset stored in a specific address by calling the Get Address Balance API. The accessed balances are divided into total balance and liquid balance.
- Total balance means all assets with a confirmation of 1 or above.
- Liquid balance only counts the assets in finalized status. The liquid balance of a child address represents the assets that can be gathered, while the liquid balance of the main address represents the assets that can be withdrawn.
Fees
Sui does not provide an estimated fee formula.