ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-02-21 01:42:24 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Attempt to explain the Issued class

Browse Source 
Fix typo
This commit is contained in:
Matthew Nesbit 2017-08-23 11:45:36 +01:00
parent 0458e5415a
commit e26f23b402
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
core/src/main/kotlin/net/corda/core/contracts/Structures.kt
View File

@ -128,10 +128,24 @@ infix fun <T : ContractState> T.`with notary`(newNotary: Party) = withNotary(new
infix fun <T : ContractState> T.withNotary(newNotary: Party) = TransactionState(this, newNotary)
/**
* Definition for an issued product, which can be cash, a cash-like thing, assets, or generally anything else that's
* quantifiable with integer quantities.
* The [Issued] data class holds the details of an on ledger digital asset.
* In particular it gives the public credentials of the entity that created these digital tokens
* and the particular product represented.
*
* @param P the type of product underlying the definition, for example [java.util.Currency].
* @param P the class type of product underlying the definition, for example [java.util.Currency].
* @property issuer The [AbstractParty] details of the entity which issued the asset
* and a reference blob, which can contain other details related to the token creation e.g. serial number,
* warehouse location, etc.
* The issuer is the gatekeeper for creating, or destroying the tokens on the digital ledger and
* only their [PrivateKey] signature can authorise transactions that do not conserve the total number
* of tokens on the ledger.
* Other identities may own the tokens, but they can only create transactions that conserve the total token count.
* Typically the issuer is also a well know organisation that can convert digital tokens to external assets
* and thus underwrites the digital tokens.
* Different issuer values may coexist for a particular product, but these cannot be merged.
* @property product The details of the specific product represented by these digital tokens. The value
* of product may differentiate different kinds of asset within the same logical class e.g the currency, or
* it may just be a type marker for a single custom asset.
*/
@CordaSerializable
data class Issued<out P : Any>(val issuer: PartyAndReference, val product: P) {