Struct SubAccount

pub struct SubAccount<T: MoveType> {
    pub id: UID,
    pub users: MoveVec<Address>,
    pub account_id: u64,
    pub collateral: Balance<T>,
    /* private fields */
}

The SubAccount object represents a shared version of the Account object with limited access to protocol’s features. Being a shared object, it can only be used by the addresses specified in the users field. Only the parent Account can withdraw Coin from a subaccount. The parent account is required to specify a Sui address that will be able to use the subaccount on its behalf and can change this address at any moment.

Subaccounts are used for trading and depositing, without running into race conditions, i.e., concurrent transactions using the same subaccount can be created and submitted (unlike accounts).

The created subaccount will share the primary’s account_id. That means it has access to the same positions of the primary.

The subaccount’s users are then able to:

• deposit collateral into the subaccount
• allocate collateral from subaccount to a clearing house
• use session to trade and liquidate on clearing house
• cancel pending orders
• deallocate from a clearing house to a subaccount

Fields

id: UID

users: MoveVec<Address>

Addresses able to make calls using this SubAccount

account_id: u64

Numerical value associated to the parent account

collateral: Balance<T>

Balance available to be allocated to markets.

Implementations

impl<T: MoveType> SubAccount<T>

pub fn new( id: UID, users: MoveVec<Address>, account_id: u64, collateral: Balance<T>, ) -> Self

Constructs a new SubAccount.

impl<T: MoveType> SubAccount<T>

pub fn move_instance( self, address: Address, t: <T as MoveType>::TypeTag, ) -> MoveInstance<Self>

pub fn type_( address: Address, t: <T as MoveType>::TypeTag, ) -> SubAccountTypeTag<T>

Trait Implementations

impl<T: Clone + MoveType> Clone for SubAccount<T>

fn clone(&self) -> SubAccount<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + MoveType> Debug for SubAccount<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T: MoveType> Deserialize<'de> for SubAccount<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: MoveType> Display for SubAccount<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: MoveType> HasKey for SubAccount<T>

fn object_id(&self) -> ObjectId

impl<T: Hash + MoveType> Hash for SubAccount<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: MoveType> MoveStruct for SubAccount<T>

type StructTag = SubAccountTypeTag<T>

impl<T: MoveType> MoveType for SubAccount<T>

type TypeTag = SubAccountTypeTag<T>

fn from_bcs(bytes: &[u8]) -> Result<Self, Error>

Deserialize the contents of the Move type from BCS bytes.

fn into_bcs(self) -> Result<Vec<u8>, Error>

Consuming version of to_bcs.

fn to_bcs(&self) -> Result<Vec<u8>, Error>

Serialize the contents of the Move type to BCS bytes.

fn into_json(self) -> Value

Consuming version of to_json.

fn to_json(&self) -> Value

Serialize the contents of the Move type to JSON.

impl<T: PartialEq + MoveType> PartialEq for SubAccount<T>

fn eq(&self, other: &SubAccount<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for SubAccount<T>

where T: Serialize + MoveType,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: MoveType> StaticModule for SubAccount<T>

fn module() -> Identifier

impl<T: MoveType> StaticName for SubAccount<T>

fn name() -> Identifier

impl<T: MoveType + StaticTypeTag> StaticTypeParams for SubAccount<T>

fn type_params() -> Vec<TypeTag>

impl<T: MoveType> Tabled for SubAccount<T>

const LENGTH: usize = 4usize

A length of fields and headers, which must be the same.

fn fields(&self) -> Vec<Cow<'_, str>>

Fields method must return a list of cells.

fn headers() -> Vec<Cow<'static, str>>

Headers must return a list of column names.

impl<T: Eq + MoveType> Eq for SubAccount<T>

impl<T: MoveType> StructuralPartialEq for SubAccount<T>