1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
//! # Represents Abstract Client
//!
//! [`AbstractClient`] allows you to do everything you might need to work with the Abstract
//! or to be more precise
//!
//! - Create or interact with Account
//! - Install or interact with a module (including apps and adapters)
//! - Publish modules
//! - Do integration tests with Abstract
//!
//! Example of publishing mock app
//!
//! ```
//! # use abstract_client::AbstractClientError;
//! use abstract_app::mock::interface::MockAppI;
//! use cw_orch::prelude::*;
//! use abstract_client::{AbstractClient, Publisher, Namespace};
//!
//! let chain = Mock::new(&Addr::unchecked("sender"));
//! let client = AbstractClient::builder(chain).build()?;
//!
//! let namespace = Namespace::new("tester")?;
//! let publisher: Publisher<Mock> = client
//! .publisher_builder(namespace)
//! .build()?;
//!
//! publisher.publish_app::<MockAppI<Mock>>()?;
//! # Ok::<(), AbstractClientError>(())
//! ```
use abstract_core::objects::namespace::Namespace;
use abstract_core::objects::AccountId;
use abstract_interface::{Abstract, AnsHost, VersionControl};
use abstract_interface::{AbstractAccount, ManagerQueryFns};
use cosmwasm_std::{Addr, BlockInfo, Coin, Uint128};
use cw_orch::state::StateInterface;
use cw_orch::{deploy::Deploy, prelude::CwEnv};
use crate::{
account::{Account, AccountBuilder},
AbstractClientError, Environment, PublisherBuilder,
};
/// Client to interact with Abstract accounts and modules
pub struct AbstractClient<Chain: CwEnv> {
pub(crate) abstr: Abstract<Chain>,
}
/// The result type for the Abstract Client.
pub type AbstractClientResult<T> = Result<T, AbstractClientError>;
impl<Chain: CwEnv> AbstractClient<Chain> {
/// Get [`AbstractClient`] from a chosen environment. [`Abstract`] should
/// already be deployed to this environment.
///
/// ```
/// use abstract_client::AbstractClient;
/// # use abstract_client::{Environment, AbstractClientError};
/// # use cw_orch::prelude::*;
/// # let chain = Mock::new(&Addr::unchecked("sender"));
/// # let client = AbstractClient::builder(chain.clone()).build().unwrap(); // Deploy mock abstract
///
/// let client = AbstractClient::new(chain)?;
/// # Ok::<(), AbstractClientError>(())
/// ```
pub fn new(chain: Chain) -> AbstractClientResult<Self> {
let abstr = Abstract::load_from(chain)?;
Ok(Self { abstr })
}
/// Version Control contract API
///
/// The Version Control contract is a database contract that stores all module-related information.
/// ```
/// # use abstract_client::AbstractClientError;
/// # let chain = cw_orch::prelude::Mock::new(&Addr::unchecked("sender"));
/// # let client = abstract_client::AbstractClient::builder(chain).build().unwrap();
/// use abstract_core::objects::{module_reference::ModuleReference, module::ModuleInfo};
/// // For getting version control address
/// use cw_orch::prelude::*;
///
/// let version_control = client.version_control();
/// let vc_module = version_control.module(ModuleInfo::from_id_latest("abstract:version-control")?)?;
/// assert_eq!(vc_module.reference, ModuleReference::Native(version_control.address()?));
/// # Ok::<(), AbstractClientError>(())
/// ```
pub fn version_control(&self) -> &VersionControl<Chain> {
&self.abstr.version_control
}
/// Abstract Name Service contract API
///
/// The Abstract Name Service contract is a database contract that stores all asset-related information.
/// ```
/// # use abstract_client::AbstractClientError;
/// use abstract_client::{AbstractClient, ClientResolve};
/// use cw_asset::AssetInfo;
/// use abstract_app::objects::AssetEntry;
/// // For getting version control address
/// use cw_orch::prelude::*;
///
/// let denom = "test_denom";
/// let entry = "denom";
/// # let client = AbstractClient::builder(Mock::new(&Addr::unchecked("sender")))
/// # .asset(entry, cw_asset::AssetInfoBase::Native(denom.to_owned()))
/// # .build()?;
///
/// let name_service = client.name_service();
/// let asset_entry = AssetEntry::new(entry);
/// let asset = asset_entry.resolve(name_service)?;
/// assert_eq!(asset, AssetInfo::Native(denom.to_owned()));
/// # Ok::<(), AbstractClientError>(())
/// ```
pub fn name_service(&self) -> &AnsHost<Chain> {
&self.abstr.ans_host
}
/// Return current block info see [`BlockInfo`].
pub fn block_info(&self) -> AbstractClientResult<BlockInfo> {
self.environment()
.block_info()
.map_err(|e| AbstractClientError::CwOrch(e.into()))
}
/// Publisher builder for creating new [`Publisher`] Abstract Account
/// To publish any modules your account requires to have claimed a namespace.
pub fn publisher_builder(&self, namespace: Namespace) -> PublisherBuilder<Chain> {
PublisherBuilder::new(AccountBuilder::new(&self.abstr), namespace)
}
/// Publisher builder for creating a new Abstract [`Account`].
pub fn account_builder(&self) -> AccountBuilder<Chain> {
AccountBuilder::new(&self.abstr)
}
/// Address of the sender
pub fn sender(&self) -> Addr {
self.environment().sender()
}
/// Retrieve denom balance for provided address
pub fn query_balance(
&self,
address: &Addr,
denom: impl Into<String>,
) -> AbstractClientResult<Uint128> {
let coins = self
.environment()
.balance(address, Some(denom.into()))
.map_err(Into::into)?;
// There will always be a single element in this case.
Ok(coins[0].amount)
}
/// Retrieve balances of all denoms for provided address
pub fn query_balances(&self, address: &Addr) -> AbstractClientResult<Vec<Coin>> {
self.environment()
.balance(address, None)
.map_err(Into::into)
.map_err(Into::into)
}
/// Waits for a specified number of blocks.
pub fn wait_blocks(&self, amount: u64) -> AbstractClientResult<()> {
self.environment()
.wait_blocks(amount)
.map_err(Into::into)
.map_err(Into::into)
}
/// Waits for a specified number of blocks.
pub fn wait_seconds(&self, secs: u64) -> AbstractClientResult<()> {
self.environment()
.wait_seconds(secs)
.map_err(Into::into)
.map_err(Into::into)
}
/// Waits for next block.
pub fn next_block(&self) -> AbstractClientResult<()> {
self.environment()
.next_block()
.map_err(Into::into)
.map_err(Into::into)
}
// Retrieve the last account created by the client.
/// Returns `None` if no account has been created yet.
/// **Note**: This only returns accounts that were created with the Client. Any accounts created through the web-app will not be returned.
pub fn get_last_account(&self) -> AbstractClientResult<Option<Account<Chain>>> {
let addresses = self.environment().state().get_all_addresses()?;
// Now search for all the keys that start with "abstract:manager-x" and return the one which has the highest x.
let mut last_account: Option<(u32, Account<Chain>)> = None;
for id in addresses.keys() {
let Some(account_id) = is_local_manager(id.as_str())? else {
continue;
};
// only take accounts that the current sender owns
let account = AbstractAccount::new(&self.abstr, account_id.clone());
if account.manager.ownership()?.owner != Some(self.environment().sender().to_string()) {
continue;
}
if let Some((last_account_id, _)) = last_account {
if account_id.seq() > last_account_id {
last_account = Some((account_id.seq(), Account::new(account, true)));
}
} else {
last_account = Some((account_id.seq(), Account::new(account, true)));
}
}
Ok(last_account.map(|(_, account)| account))
}
}
pub(crate) fn is_local_manager(id: &str) -> AbstractClientResult<Option<AccountId>> {
if !id.starts_with(abstract_core::MANAGER) {
return Ok(None);
}
let (_, account_id_str) = id.split_once('-').unwrap();
let account_id = AccountId::try_from(account_id_str)?;
// Only take local accounts into account.
if account_id.is_remote() {
return Ok(None);
}
Ok(Some(account_id))
}
#[cfg(test)]
mod tests {
use cw_orch::mock::Mock;
use super::*;
#[test]
fn local_account() {
let result = is_local_manager("abstract:manager-local-9");
assert!(result.unwrap().is_some());
}
#[test]
fn remote_account() {
let result = is_local_manager("abstract:manager-eth>btc-9");
assert!(result.unwrap().is_none());
}
#[test]
fn not_manager() {
let result = is_local_manager("abstract:proxy-local-9");
assert!(result.unwrap().is_none());
}
#[test]
fn last_owned_abstract_account() {
let sender = Addr::unchecked("sender");
let chain = Mock::new(&sender);
Abstract::deploy_on(chain.clone(), sender.to_string()).unwrap();
let client = AbstractClient::new(chain).unwrap();
let _acc = client.account_builder().build().unwrap();
let acc_2 = client.account_builder().build().unwrap();
let other_owner = Addr::unchecked("other_owner");
// create account with sender as sender but other owner
client
.account_builder()
.ownership(
abstract_core::objects::gov_type::GovernanceDetails::Monarchy {
monarch: other_owner.to_string(),
},
)
.build()
.unwrap();
let last_account = client.get_last_account().unwrap().unwrap();
assert_eq!(acc_2.id().unwrap(), last_account.id().unwrap());
}
}