circles-sdk 0.1.1

Circles SDK orchestrating RPC, profiles, pathfinding, transfers, and contract runners.
Documentation 
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

//! Internal contract bundle used by the SDK.
//!
//! `Core` owns the resolved Circles configuration and constructs lightweight Alloy
//! contract handles on demand. It is shared by `Sdk` and the typed avatar wrappers.

use alloy_provider::{Identity, ProviderBuilder, RootProvider};
use circles_abis::{
    BaseGroup, BaseGroupFactory, DemurrageCircles, HubV2, InflationaryCircles, InvitationEscrow,
    InvitationFarm, LiftERC20, NameRegistry, ReferralsModule,
};
use circles_types::CirclesConfig;

/// Core contract bundle for the Circles SDK.
#[derive(Clone)]
pub struct Core {
    pub config: CirclesConfig,
}

impl Core {
    /// Build a new contract bundle from the provided Circles configuration.
    pub fn new(config: CirclesConfig) -> Self {
        Self { config }
    }

    /// HTTP provider built from the configured Circles RPC URL.
    pub fn provider(&self) -> RootProvider {
        ProviderBuilder::<Identity, Identity>::default().connect_http(
            self.config
                .circles_rpc_url
                .parse()
                .expect("circles_rpc_url must be a valid URL"),
        )
    }

    /// Hub v2 contract instance bound to the configured v2 hub address.
    pub fn hub_v2(&self) -> HubV2::HubV2Instance<RootProvider> {
        HubV2::new(self.config.v2_hub_address, self.provider())
    }

    /// Name registry contract instance.
    pub fn name_registry(&self) -> NameRegistry::NameRegistryInstance<RootProvider> {
        NameRegistry::new(self.config.name_registry_address, self.provider())
    }

    /// Base group factory contract instance.
    pub fn base_group_factory(&self) -> BaseGroupFactory::BaseGroupFactoryInstance<RootProvider> {
        BaseGroupFactory::new(self.config.base_group_factory_address, self.provider())
    }

    /// Base group contract instance for an already-known group address.
    pub fn base_group(
        &self,
        address: alloy_primitives::Address,
    ) -> BaseGroup::BaseGroupInstance<RootProvider> {
        BaseGroup::new(address, self.provider())
    }

    /// Invitation escrow contract instance.
    pub fn invitation_escrow(&self) -> InvitationEscrow::InvitationEscrowInstance<RootProvider> {
        InvitationEscrow::new(self.config.invitation_escrow_address, self.provider())
    }

    /// Invitation farm contract instance.
    pub fn invitation_farm(&self) -> InvitationFarm::InvitationFarmInstance<RootProvider> {
        InvitationFarm::new(self.config.invitation_farm_address, self.provider())
    }

    /// LiftERC20 helper contract instance.
    pub fn lift_erc20(&self) -> LiftERC20::LiftERC20Instance<RootProvider> {
        LiftERC20::new(self.config.lift_erc20_address, self.provider())
    }

    /// Demurraged Circles token contract handle.
    pub fn demurrage_circles(&self) -> DemurrageCircles::DemurrageCirclesInstance<RootProvider> {
        DemurrageCircles::new(self.config.v2_hub_address, self.provider())
    }

    /// Inflationary Circles token contract handle.
    pub fn inflationary_circles(
        &self,
    ) -> InflationaryCircles::InflationaryCirclesInstance<RootProvider> {
        InflationaryCircles::new(self.config.v2_hub_address, self.provider())
    }

    /// Referrals module contract instance.
    pub fn referrals_module(&self) -> ReferralsModule::ReferralsModuleInstance<RootProvider> {
        ReferralsModule::new(self.config.referrals_module_address, self.provider())
    }
}