circles-types 0.3.1

Core type definitions for the Circles protocol
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

use alloy_primitives::{Address, TxHash, U256};
use serde::{Deserialize, Serialize};

/// Group row information
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GroupRow {
    pub block_number: u64,
    pub timestamp: u64,
    pub transaction_index: u32,
    pub log_index: u32,
    pub transaction_hash: TxHash,
    pub group: Address,
    #[serde(rename = "type")]
    pub group_type: String,
    pub owner: Address,
    pub mint_policy: Option<Address>,
    pub mint_handler: Option<Address>,
    pub treasury: Option<Address>,
    pub service: Option<Address>,
    pub fee_collection: Option<Address>,
    pub member_count: Option<u32>,
    pub name: Option<String>,
    pub symbol: Option<String>,
    pub cid_v0_digest: Option<String>,
    pub erc20_wrapper_demurraged: Option<Address>,
    pub erc20_wrapper_static: Option<Address>,
}

/// Group membership row
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GroupMembershipRow {
    pub block_number: u64,
    pub timestamp: u64,
    pub transaction_index: u32,
    pub log_index: u32,
    pub transaction_hash: TxHash,
    pub group: Address,
    pub member: Address,
    pub expiry_time: u64,
}

/// Group token holder row for `GroupTokenHoldersBalance`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct GroupTokenHolderRow {
    pub group: Address,
    pub holder: Address,
    pub total_balance: U256,
    pub demurraged_total_balance: U256,
    pub fraction_ownership: f64,
}

/// Group query parameters
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GroupQueryParams {
    pub name_starts_with: Option<String>,
    pub symbol_starts_with: Option<String>,
    pub group_address_in: Option<Vec<Address>>,
    pub group_type_in: Option<Vec<String>>,
    pub owner_in: Option<Vec<Address>>,
    pub mint_handler_equals: Option<Address>,
    pub treasury_equals: Option<Address>,
}