Struct iota_types::gas::checked::GasCostSummary

pub struct GasCostSummary {
    pub computation_cost: u64,
    pub computation_cost_burned: u64,
    pub storage_cost: u64,
    pub storage_rebate: u64,
    pub non_refundable_storage_fee: u64,
}

Summary of the charges in a transaction. Storage is charged independently of computation. There are 3 parts to the storage charges: storage_cost: it is the charge of storage at the time the transaction is executed. The cost of storage is the number of bytes of the objects being mutated multiplied by a variable storage cost per byte storage_rebate: this is the amount a user gets back when manipulating an object. The storage_rebate is the storage_cost for an object minus fees. non_refundable_storage_fee: not all the value of the object storage cost is given back to user and there is a small fraction that is kept by the system. This value tracks that charge.

When looking at a gas cost summary the amount charged to the user is computation_cost + storage_cost - storage_rebate and that is the amount that is deducted from the gas coins. non_refundable_storage_fee is collected from the objects being mutated/deleted and it is tracked by the system in storage funds.

Objects deleted, including the older versions of objects mutated, have the storage field on the objects added up to a pool of “potential rebate”. This rebate then is reduced by the “nonrefundable rate” such that: potential_rebate(storage cost of deleted/mutated objects) = storage_rebate + non_refundable_storage_fee

Fields

computation_cost: u64

Cost of computation/execution

computation_cost_burned: u64

The burned component of the computation/execution costs

storage_cost: u64

Storage cost, it’s the sum of all storage cost for all objects created or mutated.

storage_rebate: u64

The amount of storage cost refunded to the user for all objects deleted or mutated in the transaction.

non_refundable_storage_fee: u64

The fee for the rebate. The portion of the storage rebate kept by the system.

Implementations

impl GasCostSummary

pub fn new( computation_cost: u64, computation_cost_burned: u64, storage_cost: u64, storage_rebate: u64, non_refundable_storage_fee: u64, ) -> GasCostSummary

pub fn gas_used(&self) -> u64

pub fn sender_rebate(&self, storage_rebate_rate: u64) -> u64

Portion of the storage rebate that gets passed on to the transaction sender. The remainder will be burned, then re-minted + added to the storage fund at the next epoch change

pub fn net_gas_usage(&self) -> i64

Get net gas usage, positive number means used gas; negative number means refund.

pub fn new_from_txn_effects<'a>( transactions: impl Iterator<Item = &'a TransactionEffects>, ) -> GasCostSummary

Trait Implementations

impl AddAssign<&GasCostSummary> for GasCostSummary

fn add_assign(&mut self, other: &Self)

Performs the += operation.

impl AddAssign for GasCostSummary

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for GasCostSummary

fn clone(&self) -> GasCostSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GasCostSummary

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

Formats the value using the given formatter.

impl Default for GasCostSummary

fn default() -> GasCostSummary

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GasCostSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GasCostSummary

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

Formats the value using the given formatter.

impl From<GasCostSummary> for GasCostSummary

fn from(value: GasCostSummary) -> Self

Converts to this type from the input type.

impl From<GasCostSummary> for GasCostSummary

fn from(value: GasCostSummary) -> Self

Converts to this type from the input type.

impl JsonSchema for GasCostSummary

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(gen: &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 GasCostSummary

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GasCostSummary

impl StructuralPartialEq for GasCostSummary