Keywords
The complete reference guide to all Clarity keywords.
block-height
Deprecated in Clarity 3.
Introduced in: Clarity 1
output: uint
description:
Returns the current block height of the Stacks blockchain in Clarity 1 and 2. Upon activation of epoch 3.0, block-height will return the same value as tenure-height. In Clarity 3, block-height is removed and has been replaced with stacks-block-height.
example:
(> block-height u1000) ;; returns true if the current block-height has passed 1000 blocks.burn-block-height
Introduced in: Clarity 1
output: uint
description:
Returns the current block height of the underlying burn blockchain.
example:
(> burn-block-height u832000) ;; returns true if the current height of the underlying burn blockchain has passed 832,000 blocks.chain-id
Introduced in: Clarity 2
output: uint
description:
Returns the 32-bit chain ID of the blockchain running this transaction
example:
contract-caller
Introduced in: Clarity 1
output: principal
description:
Returns the caller of the current contract context. If this contract is the first one called by a signed transaction, the caller will be equal to the signing principal. If contract-call? was used to invoke a function from a new contract, contract-caller changes to the calling contract's principal. If as-contract is used to change the tx-sender context, contract-caller also changes to the same contract principal.
example:
current-contract
Introduced in: Clarity 4
output: principal
description:
Returns the principal of the current contract.
example:
false
Introduced in: Clarity 1
output: bool
description:
Boolean false constant.
example:
is-in-mainnet
Introduced in: Clarity 2
output: bool
description:
Returns a boolean indicating whether or not the code is running on the mainnet
example:
is-in-regtest
Introduced in: Clarity 1
output: bool
description:
Returns whether or not the code is running in a regression test
example:
none
Introduced in: Clarity 1
output: (optional ?)
description:
Represents the none option indicating no value for a given optional (analogous to a null value).
example:
stacks-block-height
Introduced in: Clarity 3
output: uint
description:
Returns the current block height of the Stacks blockchain.
example:
stacks-block-time
Introduced in: Clarity 4
output: uint
description:
Returns the Unix timestamp (in seconds) of the current Stacks block. Introduced in Clarity 4. Provides access to the timestamp of the current block, which is not available with get-stacks-block-info?.
example:
stx-liquid-supply
Introduced in: Clarity 1
output: uint
description:
Returns the total number of micro-STX (uSTX) that are liquid in the system as of this block.
example:
tenure-height
Introduced in: Clarity 3
output: uint
description:
Returns the number of tenures that have passed. At the start of epoch 3.0, tenure-height will return the same value as block-height, then it will continue to increase as each tenures passes.
example:
true
Introduced in: Clarity 1
output: bool
description:
Boolean true constant.
example:
tx-sender
Use caution when leveraging tx-sender, as based on the design, you can unintentionally introduce attack surface area. Read more.
Introduced in: Clarity 1
output: principal
description:
Returns the original sender of the current transaction, or if as-contract was called to modify the sending context, it returns that contract principal.
example:
tx-sponsor?
Introduced in: Clarity 2
output: optional principal
description:
Returns the sponsor of the current transaction if there is a sponsor, otherwise returns None.
example:
Last updated
Was this helpful?