Struct ContractPackage

pub struct ContractPackage { /* private fields */ }

Contract definition, metadata, and security container.

Implementations

impl ContractPackage

pub fn new( access_key: URef, versions: ContractVersions, disabled_versions: DisabledVersions, groups: Groups, lock_status: ContractPackageStatus, ) -> Self

Create new ContractPackage (with no versions) from given access key.

pub fn access_key(&self) -> URef

Get the access key for this contract.

pub fn groups(&self) -> &Groups

Get the group definitions for this contract.

pub fn versions(&self) -> &ContractVersions

Returns reference to all of this contract’s versions.

pub fn versions_mut(&mut self) -> &mut ContractVersions

Returns mutable reference to all of this contract’s versions (enabled and disabled).

pub fn take_versions(self) -> ContractVersions

Consumes the object and returns all of this contract’s versions (enabled and disabled).

pub fn take_groups(self) -> Groups

Consumes the object and returns all the groups of the contract package.

pub fn disabled_versions(&self) -> &DisabledVersions

Returns all of this contract’s disabled versions.

pub fn disabled_versions_mut(&mut self) -> &mut DisabledVersions

Returns mut reference to all of this contract’s disabled versions.

pub fn lock_status(&self) -> ContractPackageStatus

Returns lock_status of the contract package.

pub fn is_locked(&self) -> bool

pub fn disable_contract_version( &mut self, contract_hash: ContractHash, ) -> Result<(), Error>

Disable the contract version corresponding to the given hash (if it exists).

pub fn enable_contract_version( &mut self, contract_hash: ContractHash, ) -> Result<(), Error>

Enable the contract version corresponding to the given hash (if it exists).

pub fn remove_group(&mut self, group: &Group) -> bool

Removes a group from this entity (if it exists).

pub fn is_version_enabled( &self, contract_version_key: ContractVersionKey, ) -> bool

Returns true if the given contract version exists and is enabled.

pub fn enabled_versions(&self) -> ContractVersions

Returns all of this contract’s enabled contract versions.

pub fn current_contract_version(&self) -> Option<ContractVersionKey>

Return the contract version key for the newest enabled contract version.

pub fn current_contract_hash(&self) -> Option<ContractHash>

Return the contract hash for the newest enabled contract version.

pub fn insert_contract_version( &mut self, protocol_version_major: ProtocolVersionMajor, contract_hash: ContractHash, ) -> ContractVersionKey

pub fn groups_mut(&mut self) -> &mut Groups

Trait Implementations

impl CLTyped for ContractPackage

fn cl_type() -> CLType

The CLType of Self.

impl Clone for ContractPackage

fn clone(&self) -> ContractPackage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for ContractPackage

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 ContractPackage

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

Formats the value using the given formatter.

impl Default for ContractPackage

fn default() -> ContractPackage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContractPackage

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<ContractPackage> for Package

fn from(value: ContractPackage) -> Self

Converts to this type from the input type.

impl From<ContractPackage> for StoredValue

fn from(value: ContractPackage) -> Self

Converts to this type from the input type.

impl FromBytes for ContractPackage

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 ContractPackage

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 ContractPackage

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl ToBytes for ContractPackage

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 ContractPackage

type Error = TypeMismatch

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for ContractPackage

impl StructuralPartialEq for ContractPackage