Struct HumanAvatar 

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

Top-level avatar enum variant: human.

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 HumanAvatar

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 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 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 via profiles service and store CID through NameRegistry (requires runner).

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

Update the on-chain profile CID pointer through NameRegistry (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 HubV2::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 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 max_replenishable( &self, options: Option<AdvancedTransferOptions>, ) -> Result<U256, SdkError>

Compute the maximum amount that can be replenished into this human’s own token.

pub async fn plan_replenish_max( &self, options: Option<AdvancedTransferOptions>, ) -> Result<Vec<PreparedTransaction>, SdkError>

Plan a replenish flow for the maximum currently replenishable amount.

pub async fn replenish_max( &self, options: Option<AdvancedTransferOptions>, ) -> Result<Vec<SubmittedTx>, SdkError>

Execute a replenish flow for the maximum currently replenishable amount.

pub async fn plan_group_token_mint( &self, group: Address, amount: U256, ) -> Result<Vec<PreparedTransaction>, SdkError>

Plan a group-token mint by routing collateral to the group’s mint handler.

pub async fn mint_group_token( &self, group: Address, amount: U256, ) -> Result<Vec<SubmittedTx>, SdkError>

Execute a group-token mint by routing collateral to the group’s mint handler.

pub async fn plan_group_token_redeem( &self, group: Address, amount: U256, ) -> Result<Vec<PreparedTransaction>, SdkError>

Plan a group-token redeem flow back into trusted treasury collateral.

pub async fn redeem_group_token( &self, group: Address, amount: U256, ) -> Result<Vec<SubmittedTx>, SdkError>

Execute a group-token redeem flow back into trusted treasury collateral.

pub async fn max_group_token_mintable( &self, group: Address, ) -> Result<U256, SdkError>

Compute the maximum amount mintable for a group from this avatar.

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

Find a path from this avatar to to for the requested target flow.

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

Compute the maximum available flow from this avatar to to.

pub async fn group_owner(&self, group: Address) -> Result<Address, SdkError>

Get the owner address for a group.

pub async fn group_mint_handler( &self, group: Address, ) -> Result<Address, SdkError>

Get the mint handler address for a group.

pub async fn group_treasury(&self, group: Address) -> Result<Address, SdkError>

Get the treasury address for a group.

pub async fn group_service(&self, group: Address) -> Result<Address, SdkError>

Get the service address for a group.

pub async fn group_fee_collection( &self, group: Address, ) -> Result<Address, SdkError>

Get the fee collection address for a group.

pub async fn group_membership_conditions( &self, group: Address, ) -> Result<Vec<Address>, SdkError>

Get all membership conditions for a group.

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

Get group memberships for this avatar using the shared paged-query helper.

pub async fn group_membership_details( &self, limit: u32, ) -> Result<Vec<GroupRow>, SdkError>

Fetch all group memberships, then resolve full group rows for the referenced groups.

This mirrors the TS helper shape: limit is used as the page size for the membership query, not as a hard cap on the final enriched result count.

pub async fn personal_mint(&self) -> Result<Vec<SubmittedTx>, SdkError>

Mint all currently claimable personal tokens (requires runner).

pub async fn stop_mint(&self) -> Result<Vec<SubmittedTx>, SdkError>

Permanently stop personal token minting (requires runner).

pub async fn plan_generate_referrals( &self, number_of_invites: u64, ) -> Result<GeneratedInvites, SdkError>

Plan batch referral generation via the invitation farm without submitting.

pub async fn generate_invites( &self, number_of_invites: u64, ) -> Result<GeneratedInvites, SdkError>

Backward-compatible alias for the older plan-only helper name.

pub async fn generate_referrals( &self, number_of_invites: u64, ) -> Result<GeneratedInvites, SdkError>

Execute batch referral generation using the configured runner.

pub fn invitation_fee(&self) -> U256

Invitation fee in atto-circles (96 CRC), matching the TS helper constant.

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

Invitation module address currently configured on the invitation farm.

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

Remaining invitation quota available to this avatar on the invitation farm.

pub async fn compute_referral_address( &self, signer: Address, ) -> Result<Address, SdkError>

Compute the deterministic Safe address used by the referrals module for a signer.

pub async fn invitation_origin( &self, ) -> Result<Option<InvitationOriginResponse>, SdkError>

Unified invitation-origin helper for this avatar.

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

Direct inviter for this avatar when available.

pub async fn available_invitations( &self, minimum_balance: Option<String>, ) -> Result<AllInvitationsResponse, SdkError>

Combined invitation availability for this avatar across trust, escrow, and at-scale sources.

pub async fn proxy_inviters(&self) -> Result<Vec<ProxyInviter>, SdkError>

Proxy inviters that can route invitations to the invitation module.

pub async fn find_invite_path( &self, proxy_inviter_address: Option<Address>, ) -> Result<PathfindingResult, SdkError>

Find an invitation path to the configured invitation module, optionally forcing a proxy inviter.

pub async fn find_farm_invite_path(&self) -> Result<PathfindingResult, SdkError>

Find a fallback path from this avatar to the invitation farm destination.

pub async fn plan_invite( &self, invitee: Address, ) -> Result<Vec<PreparedTransaction>, SdkError>

Plan a direct invite flow for an existing Safe wallet without submitting.

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

Execute a direct invite flow using the configured runner.

pub async fn plan_referral_code(&self) -> Result<ReferralCodePlan, SdkError>

Plan the TS-style single-referral flow and return the generated private key.

pub async fn get_referral_code(&self) -> Result<ReferralCodePlan, SdkError>

Backward-compatible TS-style name for the single-referral planner.

pub async fn invitations_from( &self, accepted: bool, ) -> Result<InvitationsFromResponse, SdkError>

Accounts invited by this avatar, filtered by accepted vs pending status.

pub async fn accepted_invitees( &self, ) -> Result<Vec<InvitedAccountInfo>, SdkError>

Accepted invitees for this avatar.

pub async fn pending_invitees( &self, ) -> Result<Vec<InvitedAccountInfo>, SdkError>

Pending invitees for this avatar.

pub async fn list_referrals( &self, limit: Option<u32>, offset: Option<u32>, ) -> Result<ReferralPreviewList, SdkError>

Public referral previews created by this avatar via the optional referrals backend.

pub async fn invitations(&self) -> Result<Vec<InvitationRow>, SdkError>

Legacy invitation-balance rows (RPC helper).

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

Redeem an invitation from an inviter (requires runner).

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

Revoke a specific invitation (requires runner).

pub async fn revoke_all_invitations(&self) -> Result<Vec<SubmittedTx>, SdkError>

Revoke all invitations sent by this avatar (requires runner).

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