af_sui_types/sui/
object.rs

1use sui_sdk_types::{Object, Owner, Version};
2
3use crate::Address;
4
5// =============================================================================
6//  Object
7// =============================================================================
8
9pub trait ObjectHelpers {
10    #[cfg(feature = "hash")]
11    /// Input for transactions that interact with this object.
12    fn object_arg(&self, mutable: bool) -> crate::ObjectArg;
13}
14
15impl ObjectHelpers for Object {
16    #[cfg(feature = "hash")]
17    fn object_arg(&self, mutable: bool) -> crate::ObjectArg {
18        use Owner::*;
19        let id = self.object_id();
20        match self.owner() {
21            Address(_) | Object(_) | Immutable => {
22                crate::ObjectArg::ImmOrOwnedObject((id, self.version(), self.digest()))
23            }
24            Shared(initial_shared_version)
25            | ConsensusAddress {
26                start_version: initial_shared_version,
27                ..
28            } => crate::ObjectArg::SharedObject {
29                id,
30                initial_shared_version: *initial_shared_version,
31                mutable,
32            },
33            _ => panic!("unknown Owner variant"),
34        }
35    }
36}
37
38pub trait OwnerHelpers {
39    /// Only return address of [`AddressOwner`], otherwise return error.
40    ///
41    /// [`ObjectOwner`]'s address is converted from object id, thus we will skip it.
42    ///
43    /// [`AddressOwner`]: Owner::AddressOwner
44    /// [`ObjectOwner`]: Owner::ObjectOwner
45    fn get_address_owner_address(&self) -> Option<Address>;
46
47    /// This function will return address of [`AddressOwner`], [`ObjectOwner`] and [`ConsensusAddress`],
48    ///
49    /// Address of [`ObjectOwner`] is converted from object id, even though the type is [`Address`].
50    ///
51    /// [`AddressOwner`]: Owner::AddressOwner
52    /// [`ObjectOwner`]: Owner::ObjectOwner
53    fn get_owner_address(&self) -> Option<Address>;
54
55    fn is_immutable(&self) -> bool;
56
57    fn is_address_owned(&self) -> bool;
58
59    fn is_child_object(&self) -> bool;
60
61    fn is_shared(&self) -> bool;
62
63    /// Either the `initial_shared_version` for a [`Shared`] object or the `start_version` of a
64    /// [`ConsensusV2`] one.
65    ///
66    /// [`Shared`]: Owner::Shared
67    /// [`ConsensusV2`]: Owner::ConsensusV2
68    fn start_version(&self) -> Option<Version>;
69}
70
71impl OwnerHelpers for Owner {
72    fn get_address_owner_address(&self) -> Option<Address> {
73        match self {
74            Self::Address(address) => Some(*address),
75            Self::Shared { .. }
76            | Self::Immutable
77            | Self::Object(_)
78            | Self::ConsensusAddress { .. } => None,
79            _ => panic!("unknown Owner variant"),
80        }
81    }
82
83    fn get_owner_address(&self) -> Option<Address> {
84        match self {
85            Self::Address(address) => Some(*address),
86            Self::Object(id) => Some(*id),
87            Self::ConsensusAddress { owner, .. } => Some(*owner),
88            Self::Shared { .. } | Self::Immutable => None,
89            _ => panic!("unknown Owner variant"),
90        }
91    }
92
93    fn is_immutable(&self) -> bool {
94        matches!(self, Self::Immutable)
95    }
96
97    fn is_address_owned(&self) -> bool {
98        matches!(self, Self::Address(_))
99    }
100
101    fn is_child_object(&self) -> bool {
102        matches!(self, Self::Object(_))
103    }
104
105    fn is_shared(&self) -> bool {
106        matches!(self, Self::Shared { .. })
107    }
108
109    fn start_version(&self) -> Option<Version> {
110        match self {
111            Self::Immutable | Self::Object(_) | Self::Address(_) => None,
112            Self::Shared(version) => Some(*version),
113            Self::ConsensusAddress { start_version, .. } => Some(*start_version),
114            _ => panic!("unknown Owner variant"),
115        }
116    }
117}
af_sui_types/sui/object.rs

af_sui_types/sui/
object.rs
