account/account library

Full generated bindings for the account Move module (account): every move-call builder and BCS struct, including symbols the flat package:deepbook/account.dart surface hides to avoid name collisions. Import with a prefix: import 'package:deepbook/account/account.dart' as account;

Properties

Account → BcsType<Map<String, dynamic>, dynamic>

final

AccountWrapper → BcsType<Map<String, dynamic>, dynamic>

final

Auth → BcsType<Map<String, dynamic>, dynamic>

final

CoinKey → BcsType<List, List>

final

DataKey → BcsType<List, List>

final

Functions

accountId({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Returns the canonical account ID.

attach({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

Attach an app's Data under its witness namespace. Requires Permit<App>. Aborts if App already has data attached.

balance({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

Returns the total balance of T available to the account, including funds delivered through the ambient accumulator but not yet settled into the account.

borrowData({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

Borrow an app's attached Data. Open (no witness): the slot is namespaced by App and on-chain state is public, so composing apps can read it. Aborts if nothing is attached.

borrowDataMut({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

Mutably borrow an app's attached Data. Requires Permit<App>. Aborts if nothing is attached.

deposit({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

Deposits into stored balance only; callers that include accumulator funds must settle through the wrapper first.

depositFunds({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

PTB entrypoint that settles accumulator funds, consumes authority, and deposits into stored balance in one call.

detach({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

Detach and return an app's Data. Requires Permit<App>. Aborts if nothing is attached.

generateAuth({String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Creates owner authority bound to the transaction sender.

generateAuthAsObject({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Creates owner authority bound to an owning object's address.

hasData({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

Whether App has data attached to this account.

id({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Returns the wrapper object ID.

loadAccount({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Borrows the wrapped account for read-only composition.

loadAccountMut({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Consumes owner or app authority and returns the account's full mutable surface. Owner authority must match the stored owner; app authority is package-issued after registry authorization and carries no owner or operation restriction.

owner({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Returns the account owner address. This may be an EOA address or an object-ID-as-address.

receiveAddress({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Returns the accumulator receive address for this account (the wrapper address).

referrerAccountId({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Returns the canonical referrer account ID recorded at creation for external Move composition.

referrerReceiveAddress({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Returns the referrer's accumulator receive address for external Move composition.

settle({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

Permissionlessly folds accumulator-delivered T at the wrapper address into stored account balance. The per-coin timestamp is latched before reading the accumulator, preventing duplicate withdrawal and same-timestamp double counting even when no funds are available. Only the wrapper UID can authenticate the address-balance withdrawal; value leaving the account still requires a mutable borrow through Auth.

share({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Shares a newly created account wrapper.

withdraw({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

Withdraws from stored balance only; callers that include accumulator funds must settle through the wrapper first.

withdrawFunds({required dynamic arguments, String? package, List<String> typeArguments = const [], Map<String, dynamic>? config}) → MoveCallBuilder

PTB entrypoint that settles accumulator funds, consumes authority, and withdraws from stored balance in one call.