Commodity

data class Commodity(val commodityCode: String, val displayName: String, val defaultFractionDigits: Int = 0) : TokenizableAssetInfo

Class representing a commodity, as an equivalent to the Currency class. This exists purely to enable the CommodityContract contract, and is likely to change in future.

Parameters

commodityCode

a unique code for the commodity. No specific registry for these is currently defined, although this is likely to change in future.

displayName

human readable name for the commodity.

defaultFractionDigits

the number of digits normally after the decimal point when referring to quantities of this commodity.

Constructors

Link copied to clipboard
constructor(commodityCode: String, displayName: String, defaultFractionDigits: Int = 0)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val displayTokenSize: BigDecimal

The nominal display unit size of a single token, potentially with trailing decimal display places if the scale parameter is non-zero.