Enum ExecutableDeployItem

pub enum ExecutableDeployItem {
    ModuleBytes {
        module_bytes: Bytes,
        args: RuntimeArgs,
    },
    StoredContractByHash {
        hash: ContractHash,
        entry_point: String,
        args: RuntimeArgs,
    },
    StoredContractByName {
        name: String,
        entry_point: String,
        args: RuntimeArgs,
    },
    StoredVersionedContractByHash {
        hash: ContractPackageHash,
        version: Option<ContractVersion>,
        entry_point: String,
        args: RuntimeArgs,
    },
    StoredVersionedContractByName {
        name: String,
        version: Option<ContractVersion>,
        entry_point: String,
        args: RuntimeArgs,
    },
    Transfer {
        args: RuntimeArgs,
    },
}

The executable component of a Deploy.

Variants

ModuleBytes

Executable specified as raw bytes that represent Wasm code and an instance of RuntimeArgs.

Fields

module_bytes: Bytes

Raw Wasm module bytes with ‘call’ exported as an entrypoint.

args: RuntimeArgs

Runtime arguments.

StoredContractByHash

Stored contract referenced by its AddressableEntityHash, entry point and an instance of RuntimeArgs.

Fields

hash: ContractHash

Contract hash.

entry_point: String

Name of an entry point.

args: RuntimeArgs

Runtime arguments.

StoredContractByName

Stored contract referenced by a named key existing in the signer’s account context, entry point and an instance of RuntimeArgs.

Fields

name: String

Named key.

entry_point: String

Name of an entry point.

args: RuntimeArgs

Runtime arguments.

StoredVersionedContractByHash

Stored versioned contract referenced by its PackageHash, entry point and an instance of RuntimeArgs.

Fields

hash: ContractPackageHash

Contract package hash

version: Option<ContractVersion>

An optional version of the contract to call. It will default to the highest enabled version if no value is specified.

entry_point: String

Entry point name.

args: RuntimeArgs

Runtime arguments.

StoredVersionedContractByName

Stored versioned contract referenced by a named key existing in the signer’s account context, entry point and an instance of RuntimeArgs.

Fields

name: String

Named key.

version: Option<ContractVersion>

An optional version of the contract to call. It will default to the highest enabled version if no value is specified.

entry_point: String

Entry point name.

args: RuntimeArgs

Runtime arguments.

Transfer

A native transfer which does not contain or reference a Wasm code.

Fields

args: RuntimeArgs

Runtime arguments.

Implementations

impl ExecutableDeployItem

pub fn new_module_bytes(module_bytes: Bytes, args: RuntimeArgs) -> Self

Returns a new ExecutableDeployItem::ModuleBytes.

pub fn new_standard_payment<A: Into<U512>>(amount: A) -> Self

Returns a new ExecutableDeployItem::ModuleBytes suitable for use as standard payment code of a Deploy.

pub fn new_stored_contract_by_hash( hash: ContractHash, entry_point: String, args: RuntimeArgs, ) -> Self

Returns a new ExecutableDeployItem::StoredContractByHash.

pub fn new_stored_contract_by_name( name: String, entry_point: String, args: RuntimeArgs, ) -> Self

Returns a new ExecutableDeployItem::StoredContractByName.

pub fn new_stored_versioned_contract_by_hash( hash: ContractPackageHash, version: Option<ContractVersion>, entry_point: String, args: RuntimeArgs, ) -> Self

Returns a new ExecutableDeployItem::StoredVersionedContractByHash.

pub fn new_stored_versioned_contract_by_name( name: String, version: Option<ContractVersion>, entry_point: String, args: RuntimeArgs, ) -> Self

Returns a new ExecutableDeployItem::StoredVersionedKeyContractByName.

pub fn new_transfer<A: Into<U512>, T: Into<TransferTarget>>( amount: A, maybe_source: Option<URef>, target: T, maybe_transfer_id: Option<u64>, ) -> Self

Returns a new ExecutableDeployItem suitable for use as session code for a transfer.

If maybe_source is None, the account’s main purse is used as the source.

pub fn entry_point_name(&self) -> &str

Returns the entry point name.

pub fn identifier(&self) -> ExecutableDeployItemIdentifier

Returns the identifier of the ExecutableDeployItem.

pub fn contract_identifier(&self) -> Option<AddressableEntityIdentifier>

Returns the identifier of the contract in the deploy item, if present.

pub fn contract_package_identifier(&self) -> Option<PackageIdentifier>

Returns the identifier of the contract package in the deploy item, if present.

pub fn args(&self) -> &RuntimeArgs

Returns the runtime arguments.

pub fn payment_amount(&self, conv_rate: u8) -> Option<Gas>

Returns the payment amount from args (if any) as Gas.

pub fn is_transfer(&self) -> bool

Returns true if this deploy item is a native transfer.

pub fn is_standard_payment(&self, phase: Phase) -> bool

Returns true if this deploy item is a standard payment.

pub fn is_by_name(&self) -> bool

Returns true if the deploy item is a contract identified by its name.

pub fn by_name(&self) -> Option<String>

Returns the name of the contract or contract package, if the deploy item is identified by name.

pub fn is_stored_contract(&self) -> bool

Returns true if the deploy item is a stored contract.

pub fn is_stored_contract_package(&self) -> bool

Returns true if the deploy item is a stored contract package.

pub fn is_module_bytes(&self) -> bool

Returns true if the deploy item is ModuleBytes.

pub fn random(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random ExecutableDeployItem.

Trait Implementations

impl Clone for ExecutableDeployItem

fn clone(&self) -> ExecutableDeployItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for ExecutableDeployItem

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 ExecutableDeployItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExecutableDeployItem

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ExecutableDeployItem

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

Formats the value using the given formatter.

impl Distribution<ExecutableDeployItem> for Standard

Available on crate feature testing only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> ExecutableDeployItem

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl FromBytes for ExecutableDeployItem

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 Hash for ExecutableDeployItem

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 JsonSchema for ExecutableDeployItem

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 Ord for ExecutableDeployItem

fn cmp(&self, other: &ExecutableDeployItem) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ExecutableDeployItem

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

fn partial_cmp(&self, other: &ExecutableDeployItem) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ExecutableDeployItem

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 ExecutableDeployItem

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

Writes &self into a mutable writer.

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 into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl Eq for ExecutableDeployItem

impl StructuralPartialEq for ExecutableDeployItem