Struct Deploy

pub struct Deploy { /* private fields */ }

A signed smart contract.

Implementations

impl Deploy

pub fn new( hash: DeployHash, header: DeployHeader, payment: ExecutableDeployItem, session: ExecutableDeployItem, ) -> Deploy

Constructs a new Deploy.

pub fn new_signed( timestamp: Timestamp, ttl: TimeDiff, gas_price: u64, dependencies: Vec<DeployHash>, chain_name: String, payment: ExecutableDeployItem, session: ExecutableDeployItem, secret_key: &SecretKey, account: Option<PublicKey>, ) -> Deploy

Available on crate features std and testing only.

Constructs a new signed Deploy.

pub fn hash(&self) -> &DeployHash

Returns the DeployHash identifying this Deploy.

pub fn account(&self) -> &PublicKey

Returns the public key of the account providing the context in which to run the Deploy.

pub fn timestamp(&self) -> Timestamp

Returns the creation timestamp of the Deploy.

pub fn ttl(&self) -> TimeDiff

Returns the duration after the creation timestamp for which the Deploy will stay valid.

After this duration has ended, the Deploy will be considered expired.

pub fn expired(&self, current_instant: Timestamp) -> bool

Returns true if the Deploy has expired.

pub fn gas_price(&self) -> u64

Returns the sender’s gas price tolerance for block inclusion.

pub fn body_hash(&self) -> &Digest

Returns the hash of the body (i.e. the Wasm code) of the Deploy.

pub fn chain_name(&self) -> &str

Returns the name of the chain the Deploy should be executed on.

pub fn header(&self) -> &DeployHeader

Returns a reference to the DeployHeader of this Deploy.

pub fn take_header(self) -> DeployHeader

Consumes self, returning the DeployHeader of this Deploy.

pub fn payment(&self) -> &ExecutableDeployItem

Returns the ExecutableDeployItem for payment code.

pub fn session(&self) -> &ExecutableDeployItem

Returns the ExecutableDeployItem for session code.

pub fn approvals(&self) -> &BTreeSet<Approval>

Returns the Approvals for this deploy.

pub fn destructure( self, ) -> (DeployHash, DeployHeader, ExecutableDeployItem, ExecutableDeployItem, BTreeSet<Approval>)

Consumes self, returning a tuple of its constituent parts.

pub fn sign(&mut self, secret_key: &SecretKey)

Adds a signature of this Deploy’s hash to its approvals.

pub fn compute_approvals_hash(&self) -> Result<ApprovalsHash, Error>

Returns the ApprovalsHash of this Deploy’s approvals.

pub fn is_valid_size( &self, max_transaction_size: u32, ) -> Result<(), DeployExcessiveSizeError>

Available on crate feature std only.

Returns true if the serialized size of the deploy is not greater than max_transaction_size.

pub fn has_valid_hash(&self) -> Result<(), InvalidDeploy>

Returns Ok if and only if this Deploy’s body hashes to the value of body_hash(), and if this Deploy’s header hashes to the value claimed as the deploy hash.

pub fn is_valid(&self) -> Result<(), InvalidDeploy>

Returns Ok if and only if:

• the deploy hash is correct (should be the hash of the header), and
• the body hash is correct (should be the hash of the body), and
• approvals are non empty, and
• all approvals are valid signatures of the deploy hash

pub fn is_transfer(&self) -> bool

Returns true if this deploy is a native transfer.

pub fn is_account_session(&self) -> bool

Should this transaction start in the initiating accounts context?

pub fn is_config_compliant( &self, chainspec: &Chainspec, timestamp_leeway: TimeDiff, at: Timestamp, ) -> Result<(), InvalidDeploy>

Available on crate features std and testing only.

Returns Ok if and only if:

• the chain_name is correct,
• the configured parameters are complied with at the given timestamp

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

Available on crate features std and testing only.

Returns a random Deploy.

pub fn random_with_timestamp_and_ttl( rng: &mut TestRng, timestamp: Timestamp, ttl: TimeDiff, ) -> Self

Available on crate features std and testing only.

Returns a random Deploy but using the specified timestamp and ttl.

pub fn invalidate(&mut self)

Available on crate features std and testing only.

Turns self into an invalid Deploy by clearing the chain_name, invalidating the deploy hash.

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

Available on crate features std and testing only.

Returns a random Deploy for a native transfer.

pub fn random_valid_native_transfer_with_timestamp_and_ttl( rng: &mut TestRng, timestamp: Timestamp, ttl: TimeDiff, ) -> Self

Available on crate features std and testing only.

Returns a random Deploy for a native transfer with timestamp and ttl.

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

Available on crate features std and testing only.

Returns a random Deploy for a native transfer with no dependencies.

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

Available on crate features std and testing only.

Returns a random invalid Deploy without a payment amount specified.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with an invalid value for the payment amount.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with insufficient payment amount.

pub fn random_with_insufficient_payment_amount( rng: &mut TestRng, payment_amount: U512, ) -> Self

Available on crate features std and testing only.

Returns a random invalid Deploy with insufficient payment amount.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with an invalid value for the payment amount.

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

Available on crate features std and testing only.

Returns a random Deploy with custom payment specified as a stored contract by name.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with custom payment specified as a stored contract by hash, but missing the runtime args.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with custom payment specified as a stored contract by hash, but calling an invalid entry point.

pub fn random_with_versioned_payment_package_by_name( version: Option<u32>, rng: &mut TestRng, ) -> Self

Available on crate features std and testing only.

Returns a random Deploy with custom payment specified as a stored versioned contract by name.

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

Available on crate features std and testing only.

Returns a random Deploy with custom payment specified as a stored versioned contract by name.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with custom payment specified as a stored versioned contract by hash, but missing the runtime args.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with custom payment specified as a stored versioned contract by hash, but calling an invalid entry point.

pub fn random_with_payment_package_version_by_hash( version: Option<u32>, rng: &mut TestRng, ) -> Self

Available on crate features std and testing only.

Returns a random invalid Deploy with custom payment specified as a stored versioned contract by hash, but missing the runtime args.

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

Available on crate features std and testing only.

Returns a random Deploy with custom session specified as a stored contract by name.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with custom session specified as a stored contract by hash, but missing the runtime args.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with custom session specified as a stored contract by hash, but calling an invalid entry point.

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

Available on crate features std and testing only.

Returns a random Deploy with custom session specified as a stored versioned contract by name.

pub fn random_with_versioned_session_package_by_name( version: Option<u32>, rng: &mut TestRng, ) -> Self

Available on crate features std and testing only.

Returns a random Deploy with custom session specified as a stored versioned contract by name.

pub fn random_contract_by_name( rng: &mut TestRng, maybe_secret_key: Option<SecretKey>, maybe_contract_name: Option<String>, maybe_entry_point_name: Option<String>, maybe_timestamp: Option<Timestamp>, maybe_ttl: Option<TimeDiff>, ) -> Self

Available on crate features std and testing only.

Returns a random deploy with custom session specified as a stored versioned contract by name.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with custom session specified as a stored versioned contract by hash, but missing the runtime args.

pub fn random_with_versioned_session_package_by_hash( version: Option<u32>, rng: &mut TestRng, ) -> Self

Available on crate features std and testing only.

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

Available on crate features std and testing only.

Returns a random invalid transfer Deploy with the “target” runtime arg missing.

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

Available on crate features std and testing only.

Returns a random invalid transfer Deploy with the “amount” runtime arg missing.

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

Available on crate features std and testing only.

Returns a random invalid transfer Deploy with an invalid “amount” runtime arg.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with empty session bytes.

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

Available on crate features std and testing only.

Returns a random invalid Deploy with an expired TTL.

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

Available on crate features std and testing only.

Returns a random Deploy with native transfer as payment code.

pub fn random_with_gas_price(rng: &mut TestRng, gas_price: u64) -> Self

Available on crate features std and testing only.

Returns a random valid Deploy with specified gas price.

pub fn add_bid( chain_name: String, auction_contract_hash: AddressableEntityHash, public_key: PublicKey, bid_amount: U512, delegation_rate: u8, timestamp: Timestamp, ttl: TimeDiff, ) -> Self

Available on crate features std and testing only.

Creates an add bid deploy, for testing.

pub fn withdraw_bid( chain_name: String, auction_contract_hash: AddressableEntityHash, public_key: PublicKey, amount: U512, timestamp: Timestamp, ttl: TimeDiff, ) -> Self

Available on crate features std and testing only.

Creates a withdraw bid deploy, for testing.

pub fn delegate( chain_name: String, auction_contract_hash: AddressableEntityHash, validator_public_key: PublicKey, delegator_public_key: PublicKey, amount: U512, timestamp: Timestamp, ttl: TimeDiff, ) -> Self

Available on crate features std and testing only.

Creates a delegate deploy, for testing.

pub fn undelegate( chain_name: String, auction_contract_hash: AddressableEntityHash, validator_public_key: PublicKey, delegator_public_key: PublicKey, amount: U512, timestamp: Timestamp, ttl: TimeDiff, ) -> Self

Available on crate features std and testing only.

Creates an undelegate deploy, for testing.

pub fn redelegate( chain_name: String, auction_contract_hash: AddressableEntityHash, validator_public_key: PublicKey, delegator_public_key: PublicKey, redelegate_validator_public_key: PublicKey, amount: U512, timestamp: Timestamp, ttl: TimeDiff, ) -> Self

Available on crate features std and testing only.

Creates an redelegate deploy, for testing.

pub fn native_transfer( chain_name: String, source_purse: Option<URef>, sender_public_key: PublicKey, receiver_public_key: PublicKey, amount: Option<U512>, timestamp: Timestamp, ttl: TimeDiff, gas_price: u64, ) -> Self

Available on crate features std and testing only.

Creates a native transfer, for testing.

Trait Implementations

impl Clone for Deploy

fn clone(&self) -> Deploy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for Deploy

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 Deploy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Deploy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Deploy

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

Formats the value using the given formatter.

impl From<Deploy> for Transaction

fn from(deploy: Deploy) -> Self

Converts to this type from the input type.

impl FromBytes for Deploy

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 GasLimited for Deploy

Available on crate feature std only.

type Error = InvalidDeploy

The error type.

fn gas_cost( &self, chainspec: &Chainspec, gas_price: u8, ) -> Result<Motes, Self::Error>

Returns a gas cost based upon the gas_limit, the gas price, and the chainspec settings.

fn gas_limit(&self, chainspec: &Chainspec) -> Result<Gas, Self::Error>

Returns the gas / computation limit prior to execution.

fn gas_price_tolerance(&self) -> Result<u8, Self::Error>

Returns the gas price tolerance.

const GAS_PRICE_FLOOR: u8 = 1u8

The minimum allowed gas price (aka the floor).

impl Hash for Deploy

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 Deploy

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 Deploy

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

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

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

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 Deploy

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 Eq for Deploy