Struct BaseGroupAvatar 

pub struct BaseGroupAvatar {
    pub address: Address,
    pub info: AvatarInfo,
    pub core: Arc<Core>,
    pub runner: Option<Arc<dyn ContractRunner>>,
    pub common: CommonAvatar,
}

Top-level avatar enum variant: base group.

Fields

address: Address

Avatar address on-chain.

info: AvatarInfo

RPC-derived avatar metadata.

core: Arc<Core>

Shared contract bundle and configuration.

runner: Option<Arc<dyn ContractRunner>>

Optional runner used for write-capable flows.

common: CommonAvatar

Shared read/write helper implementation.

Implementations

impl BaseGroupAvatar

pub async fn balances( &self, as_time_circles: bool, use_v2: bool, ) -> Result<Vec<TokenBalanceResponse>, SdkError>

Get detailed token balances (v1/v2 selectable).

pub async fn total_balance( &self, as_time_circles: bool, use_v2: bool, ) -> Result<Balance, SdkError>

Get aggregate balance (v1/v2 selectable).

pub async fn total_supply(&self) -> Result<U256, SdkError>

Get the total supply of this group’s token.

pub async fn trust_relations(&self) -> Result<Vec<TrustRelation>, SdkError>

Get trust relations.

pub async fn aggregated_trust_relations( &self, ) -> Result<Vec<AggregatedTrustRelation>, SdkError>

Get aggregated trust relations.

pub async fn trusts(&self) -> Result<Vec<AggregatedTrustRelation>, SdkError>

Get outgoing trust relations only.

pub async fn trusted_by(&self) -> Result<Vec<AggregatedTrustRelation>, SdkError>

Get incoming trust relations only.

pub async fn mutual_trusts( &self, ) -> Result<Vec<AggregatedTrustRelation>, SdkError>

Get mutual trust relations only.

pub async fn is_trusting(&self, other_avatar: Address) -> Result<bool, SdkError>

Check whether this avatar trusts other_avatar.

pub async fn is_trusted_by( &self, other_avatar: Address, ) -> Result<bool, SdkError>

Check whether other_avatar trusts this avatar.

pub async fn owner(&self) -> Result<Address, SdkError>

Get the group owner address.

pub async fn mint_handler(&self) -> Result<Address, SdkError>

Get the mint handler address.

pub async fn service(&self) -> Result<Address, SdkError>

Get the service address.

pub async fn fee_collection(&self) -> Result<Address, SdkError>

Get the fee collection address.

pub async fn membership_conditions(&self) -> Result<Vec<Address>, SdkError>

Get all membership conditions.

pub async fn profile(&self) -> Result<Option<Profile>, SdkError>

Fetch profile (cached by CID in memory).

pub fn transaction_history( &self, limit: u32, sort_order: SortOrder, ) -> PagedQuery<TransactionHistoryRow>

Get transaction history for this avatar using cursor-based pagination.

pub async fn update_profile( &self, profile: &Profile, ) -> Result<Vec<SubmittedTx>, SdkError>

Update profile metadata digest on the base group (requires runner).

pub async fn update_profile_metadata( &self, cid: &str, ) -> Result<Vec<SubmittedTx>, SdkError>

Update the on-chain profile CID pointer through the BaseGroup contract (requires runner).

pub async fn register_short_name( &self, nonce: u64, ) -> Result<Vec<SubmittedTx>, SdkError>

Register a short name using a specific nonce (requires runner).

pub async fn trust_add( &self, avatars: &[Address], expiry: u128, ) -> Result<Vec<SubmittedTx>, SdkError>

Trust one or more avatars via BaseGroup::trust (requires runner).

pub async fn trust_remove( &self, avatars: &[Address], ) -> Result<Vec<SubmittedTx>, SdkError>

Remove trust (sets expiry to 0). Requires runner.

pub async fn trust_add_batch_with_conditions( &self, avatars: &[Address], expiry: u128, ) -> Result<Vec<SubmittedTx>, SdkError>

Trust a batch of members with membership condition checks (requires runner).

pub async fn set_owner( &self, owner: Address, ) -> Result<Vec<SubmittedTx>, SdkError>

Set a new owner for the group (requires runner).

pub async fn set_service( &self, service: Address, ) -> Result<Vec<SubmittedTx>, SdkError>

Set a new service address for the group (requires runner).

pub async fn set_fee_collection( &self, fee_collection: Address, ) -> Result<Vec<SubmittedTx>, SdkError>

Set a new fee collection address for the group (requires runner).

pub async fn set_membership_condition( &self, condition: Address, enabled: bool, ) -> Result<Vec<SubmittedTx>, SdkError>

Enable or disable a membership condition (requires runner).

pub async fn plan_transfer( &self, to: Address, amount: U256, options: Option<AdvancedTransferOptions>, ) -> Result<Vec<PreparedTransaction>, SdkError>

Plan a transfer without submitting.

pub async fn transfer( &self, to: Address, amount: U256, options: Option<AdvancedTransferOptions>, ) -> Result<Vec<SubmittedTx>, SdkError>

Execute a transfer using the runner (requires runner).

pub async fn plan_direct_transfer( &self, to: Address, amount: U256, token_address: Option<Address>, tx_data: Option<Bytes>, ) -> Result<Vec<PreparedTransaction>, SdkError>

Plan a direct transfer without pathfinding.

pub async fn direct_transfer( &self, to: Address, amount: U256, token_address: Option<Address>, tx_data: Option<Bytes>, ) -> Result<Vec<SubmittedTx>, SdkError>

Execute a direct transfer using the runner (requires runner).

pub async fn plan_replenish( &self, token_id: Address, amount: U256, receiver: Option<Address>, ) -> Result<Vec<PreparedTransaction>, SdkError>

Plan a replenish flow without submitting.

pub async fn replenish( &self, token_id: Address, amount: U256, receiver: Option<Address>, ) -> Result<Vec<SubmittedTx>, SdkError>

Execute a replenish flow using the runner (requires runner).

pub async fn find_path( &self, to: Address, target_flow: U256, options: Option<AdvancedTransferOptions>, ) -> Result<PathfindingResult, SdkError>

Find a path between this avatar and to with a target flow.

pub async fn max_flow_to( &self, to: Address, options: Option<AdvancedTransferOptions>, ) -> Result<PathfindingResult, SdkError>

Max-flow helper: sets target_flow to U256::MAX.

pub fn new( address: Address, info: AvatarInfo, core: Arc<Core>, profiles: Profiles, rpc: Arc<CirclesRpc>, runner: Option<Arc<dyn ContractRunner>>, ) -> Self

Build a typed base-group avatar wrapper from already-fetched components.