Struct Account

pub struct Account { /* private fields */ }

Represents an Account in the global state.

Implementations

impl Account

pub fn new( account_hash: AccountHash, named_keys: NamedKeys, main_purse: URef, associated_keys: AssociatedKeys, action_thresholds: ActionThresholds, ) -> Self

Creates a new account.

pub fn create( account: AccountHash, named_keys: NamedKeys, main_purse: URef, ) -> Self

An Account constructor with presets for associated_keys and action_thresholds.

An account created with this method is valid and can be used as the target of a transaction. It will be created with an AssociatedKeys with a Weight of 1, and a default ActionThresholds.

pub fn named_keys_append(&mut self, keys: NamedKeys)

Appends named keys to an account’s named_keys field.

pub fn named_keys(&self) -> &NamedKeys

Returns named keys.

pub fn named_keys_mut(&mut self) -> &mut NamedKeys

Returns a mutable reference to named keys.

pub fn remove_named_key(&mut self, name: &str) -> Option<Key>

Removes the key under the given name from named keys.

pub fn account_hash(&self) -> AccountHash

Returns account hash.

pub fn main_purse(&self) -> URef

Returns main purse.

pub fn main_purse_add_only(&self) -> URef

Returns an AccessRights::ADD-only version of the main purse’s URef.

pub fn associated_keys(&self) -> &AssociatedKeys

Returns associated keys.

pub fn action_thresholds(&self) -> &ActionThresholds

Returns action thresholds.

pub fn add_associated_key( &mut self, account_hash: AccountHash, weight: Weight, ) -> Result<(), AddKeyFailure>

Adds an associated key to an account.

pub fn remove_associated_key( &mut self, account_hash: AccountHash, ) -> Result<(), RemoveKeyFailure>

Removes an associated key from an account.

Verifies that removing the key will not cause the remaining weight to fall below any action thresholds.

pub fn update_associated_key( &mut self, account_hash: AccountHash, weight: Weight, ) -> Result<(), UpdateKeyFailure>

Updates an associated key.

Returns an error if the update would result in a violation of the key management thresholds.

pub fn set_action_threshold_unchecked( &mut self, action_type: ActionType, threshold: Weight, ) -> Result<(), SetThresholdFailure>

Sets a new action threshold for a given action type for the account without checking against the total weight of the associated keys.

This should only be called when authorized by an administrator account.

Returns an error if setting the action would cause the ActionType::Deployment threshold to be greater than any of the other action types.

pub fn set_action_threshold( &mut self, action_type: ActionType, weight: Weight, ) -> Result<(), SetThresholdFailure>

Sets a new action threshold for a given action type for the account.

Returns an error if the new action threshold weight is greater than the total weight of the account’s associated keys.

pub fn can_set_threshold( &self, new_threshold: Weight, ) -> Result<(), SetThresholdFailure>

Verifies if user can set action threshold.

pub fn can_authorize(&self, authorization_keys: &BTreeSet<AccountHash>) -> bool

Checks whether all authorization keys are associated with this account.

pub fn can_deploy_with( &self, authorization_keys: &BTreeSet<AccountHash>, ) -> bool

Checks whether the sum of the weights of all authorization keys is greater or equal to deploy threshold.

pub fn can_manage_keys_with( &self, authorization_keys: &BTreeSet<AccountHash>, ) -> bool

Checks whether the sum of the weights of all authorization keys is greater or equal to key management threshold.

Trait Implementations

impl Clone for Account

fn clone(&self) -> Account

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for Account

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for Account

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Account

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Account> for AddressableEntity

fn from(value: Account) -> Self

Converts to this type from the input type.

impl From<Account> for StoredValue

fn from(value: Account) -> StoredValue

Converts to this type from the input type.

impl FromBytes for Account

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

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl JsonSchema for Account

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Account

fn eq(&self, other: &Account) -> 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 Serialize for Account

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBytes for Account

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

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

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

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl TryFrom<StoredValue> for Account

type Error = TypeMismatch

The type returned in the event of a conversion error.

fn try_from(stored_value: StoredValue) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Account

impl StructuralPartialEq for Account