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
//! # Represents Abstract Publisher
//!
//! [`Publisher`] is an Account with helpers for publishing and maintaining Abstract Applications and Adapters
use abstract_core::objects::{gov_type::GovernanceDetails, AssetEntry};
use abstract_interface::{AdapterDeployer, AppDeployer, DeployStrategy, RegisteredModule};
use cw_orch::{
contract::Contract,
prelude::{ContractInstance, CwEnv},
};
use serde::Serialize;
use crate::{
account::{Account, AccountBuilder},
client::AbstractClientResult,
Environment,
};
use abstract_core::objects::namespace::Namespace;
/// A builder for creating [`Publishers`](Account).
/// Get the builder from the [`AbstractClient::publisher_builder`](crate::AbstractClient)
/// and create the account with the `build` method.
///
/// ```
/// # use abstract_client::{AbstractClientError, Environment};
/// # use cw_orch::prelude::*;
/// # let chain = Mock::new(&Addr::unchecked("sender"));
/// # let abstr_client = abstract_client::AbstractClient::builder(chain).build().unwrap();
/// # let chain = abstr_client.environment();
/// use abstract_client::{AbstractClient, Publisher, Namespace};
///
/// let client = AbstractClient::new(chain)?;
///
/// let namespace = Namespace::new("alice-namespace")?;
/// let publisher: Publisher<Mock> = client.publisher_builder(namespace)
/// .name("alice")
/// // other configurations
/// .build()?;
/// # Ok::<(), AbstractClientError>(())
/// ```
pub struct PublisherBuilder<'a, Chain: CwEnv> {
account_builder: AccountBuilder<'a, Chain>,
}
impl<'a, Chain: CwEnv> PublisherBuilder<'a, Chain> {
pub(crate) fn new(
mut account_builder: AccountBuilder<'a, Chain>,
namespace: Namespace,
) -> Self {
account_builder.namespace(namespace);
Self { account_builder }
}
/// Username for the account
/// Defaults to "Default Abstract Account"
pub fn name(&mut self, name: impl Into<String>) -> &mut Self {
self.account_builder.name(name);
self
}
/// Description for the account
pub fn description(&mut self, description: impl Into<String>) -> &mut Self {
self.account_builder.description(description);
self
}
/// http(s) or ipfs link for the account
pub fn link(&mut self, link: impl Into<String>) -> &mut Self {
self.account_builder.link(link);
self
}
/// Overwrite the configured namespace
pub fn namespace(&mut self, namespace: Namespace) -> &mut Self {
self.account_builder.namespace(namespace);
self
}
/// Base Asset for the account
pub fn base_asset(&mut self, base_asset: AssetEntry) -> &mut Self {
self.account_builder.base_asset(base_asset);
self
}
/// Governance of the account.
/// Defaults to the [`GovernanceDetails::Monarchy`] variant, owned by the sender
pub fn ownership(&mut self, ownership: GovernanceDetails<String>) -> &mut Self {
self.account_builder.ownership(ownership);
self
}
/// Install modules on a new sub-account instead of current account.
/// Defaults to `true`
pub fn install_on_sub_account(&mut self, value: bool) -> &mut Self {
self.account_builder.install_on_sub_account(value);
self
}
/// Builds the [`Publisher`].
/// Creates an account if the namespace is not already owned.
pub fn build(&self) -> AbstractClientResult<Publisher<Chain>> {
let account = self.account_builder.build()?;
Ok(Publisher { account })
}
}
/// A Publisher represents an account that owns a namespace with the goal of publishing modules to the on-chain module-store.
pub struct Publisher<Chain: CwEnv> {
account: Account<Chain>,
}
impl<Chain: CwEnv> Publisher<Chain> {
/// Publish an Abstract App
pub fn publish_app<
M: ContractInstance<Chain> + RegisteredModule + From<Contract<Chain>> + AppDeployer<Chain>,
>(
&self,
) -> AbstractClientResult<()> {
let contract = Contract::new(M::module_id().to_owned(), self.account.environment());
let app: M = contract.into();
app.deploy(M::module_version().parse()?, DeployStrategy::Try)
.map_err(Into::into)
}
/// Publish an Abstract Adapter
pub fn publish_adapter<
CustomInitMsg: Serialize,
M: ContractInstance<Chain>
+ RegisteredModule
+ From<Contract<Chain>>
+ AdapterDeployer<Chain, CustomInitMsg>,
>(
&self,
init_msg: CustomInitMsg,
) -> AbstractClientResult<()> {
let contract = Contract::new(M::module_id().to_owned(), self.account.environment());
let adapter: M = contract.into();
adapter
.deploy(M::module_version().parse()?, init_msg, DeployStrategy::Try)
.map_err(Into::into)
}
/// Abstract Account of the publisher
pub fn account(&self) -> &Account<Chain> {
&self.account
}
}