Struct abstract_client::AccountBuilder

pub struct AccountBuilder<'a, Chain: CwEnv> { /* private fields */ }

A builder for creating Accounts. Get the builder from the AbstractClient::account_builder and create the account with the build method.

use abstract_client::{AbstractClient, Account};

let client = AbstractClient::new(chain)?;
let account: Account<MockBech32> = client.account_builder()
    .name("alice")
    // other account configuration
    .build()?;

Implementations

impl<'a, Chain: CwEnv> AccountBuilder<'a, Chain>

pub fn name(&mut self, name: impl Into<String>) -> &mut Self

Username for the account Defaults to “Default Abstract Account”

pub fn description(&mut self, description: impl Into<String>) -> &mut Self

Description for the account

pub fn link(&mut self, link: impl Into<String>) -> &mut Self

http(s) or ipfs link for the account

pub fn namespace(&mut self, namespace: Namespace) -> &mut Self

Unique namespace for the account Setting this will claim the namespace for the account on construction.

pub fn base_asset(&mut self, base_asset: AssetEntry) -> &mut Self

Base Asset for the account

pub fn fetch_if_namespace_claimed(&mut self, value: bool) -> &mut Self

Try to fetch the account before creating it if the namespace is already claimed. Defaults to true.

pub fn install_on_sub_account(&mut self, value: bool) -> &mut Self

Install modules on a new sub-account instead of current account. Defaults to true

pub fn sub_account(&mut self, owner_account: &'a Account<Chain>) -> &mut Self

Create sub-account instead

pub fn ownership(&mut self, ownership: GovernanceDetails<String>) -> &mut Self

Governance of the account. Defaults to the GovernanceDetails::Monarchy variant, owned by the sender

pub fn install_adapter<M: InstallConfig<InitMsg = Empty>>( &mut self ) -> Result<&mut Self, AbstractClientError>

Install an adapter on current account.

pub fn install_app<M: InstallConfig>( &mut self, configuration: &M::InitMsg ) -> Result<&mut Self, AbstractClientError>

Install an application on current account.

pub fn install_app_with_dependencies<M: DependencyCreation + InstallConfig>( &mut self, module_configuration: &M::InitMsg, dependencies_config: M::DependenciesConfig ) -> Result<&mut Self, AbstractClientError>

Install an application with dependencies on current account.

pub fn auto_fund_assert<F: Fn(&[Coin]) -> bool + 'static>( &mut self, f: F ) -> &mut Self

Enables automatically paying for module instantiations and namespace registration. The provided function will be called with the required funds. If the function returns false, the account creation will fail.

pub fn auto_fund(&mut self) -> &mut Self

Enables automatically paying for module instantiations and namespace registration. Use auto_fund_assert to add limits to the auto fund mode.

pub fn funds( &mut self, funds: &[Coin] ) -> Result<&mut Self, AbstractClientError>

Add funds to the account creation Can’t be used in pair with auto fund mode

pub fn expected_account_id(&mut self, local_account_id: u32) -> &mut Self

Assign expected local account_id on creation. The tx will error if this does not match the account-id at runtime. Useful for instantiate2 address prediction.

pub fn build(&self) -> Result<Account<Chain>, AbstractClientError>

Builds the Account.