gas-payments

Definitions

getGasConsumedAtTheMoment

fun getGasConsumedAtTheMoment(): int

Returns amount of gas (in gas units) consumed in current Computation Phase.

acceptExternalMessage

fun acceptExternalMessage(): void

This function is required to be called when you process an external message (from an outer world) and "accept" it to blockchain. Without calling this function, an external message would be discarded. As an effect, the current smart contract agrees to buy some gas to finish the current transaction. For more details, check accept_message effects.

setGasLimitToMaximum

fun setGasLimitToMaximum(): void

When processing an internal message, by default, the limit of gas consumption is determined by incoming message. Functions setGasLimit and setGasLimitToMaximum allow you to change this behavior. Sets current gas limit gl to its maximal allowed value gm, and resets the gas credit gc to zero, decreasing the value of gr by gc in the process.

setGasLimit

fun setGasLimit(limit: int): void

When processing an internal message, by default, the limit of gas consumption is determined by incoming message. Functions setGasLimit and setGasLimitToMaximum allow you to change this behavior. Sets current gas limit gl to the minimum of limit and gm, and resets the gas credit gc to zero. If the gas consumed so far (including the present instruction) exceeds the resulting value of gl, an (unhandled) out of gas exception is thrown before setting new gas limits.

calculateGasFee

@pure
fun calculateGasFee(workchain: int8, gasUsed: int): coins

Calculates fee (amount in nanotoncoins to be paid) for a transaction which consumed gasUsed gas units.

calculateGasFeeWithoutFlatPrice

@pure
fun calculateGasFeeWithoutFlatPrice(workchain: int8, gasUsed: int): coins

Same as calculateGasFee, but without flat price. Docs about fees

calculateStorageFee

fun calculateStorageFee(workchain: int8, seconds: int, bits: int, cells: int): coins

Calculates amount of nanotoncoins you should pay for storing a contract of provided size for seconds. bits and cells represent contract state (code + data).

calculateForwardFee

@pure
fun calculateForwardFee(workchain: int8, bits: int, cells: int): coins

Calculates amount of nanotoncoins you should pay to send a message of a specified size.

calculateForwardFeeWithoutLumpPrice

@pure
fun calculateForwardFeeWithoutLumpPrice(workchain: int8, bits: int, cells: int): coins

Same as calculateForwardFee, but without lump price. Docs about fees

calculateOriginalForwardFee

@deprecated("use modern `onInternalMessage` and access `in.originalForwardFee` directly")
fun calculateOriginalForwardFee(workchain: int8, incomingFwdFee: coins): coins

Calculates fee that was paid by the sender of an incoming internal message.

contract.getStorageDuePayment

@pure
fun contract.getStorageDuePayment(): coins

Returns the amount of nanotoncoins current contract debts for storage. ("due" and "debt" are synonyms) If it has no debt, 0 is returned.

contract.getStoragePaidPayment

@pure
fun contract.getStoragePaidPayment(): coins

Returns the amount of nanotoncoins charged for storage. (during the storage phase preceding the current computation phase)