Clear up wording around how the FungibleAsset superclass is used

Clear up wording around how the FungibleAsset superclass is used, and in particular
that it contains contract code, but provides an interface that should be extended by
subclass state objects.
This commit is contained in:
Ross Nicoll 2016-06-10 11:30:44 +01:00
parent 8d1ac66787
commit 4b39ab0357

View File

@ -38,9 +38,10 @@ which standardises how the ID is extracted.
FungibleAssets and Cash
-----------------------
There is a common ``FungibleAsset`` superclass for contracts which model fungible assets, with ``Cash`` being the obvious
example. This is intended to be readily extensible to cover other assets, for example commodities could be modelled by
using a state object that included further details such as location of the commodity.
There is a common ``FungibleAsset`` superclass for contracts which model fungible assets, which also provides a standard
interface for its subclasses' state objects to implement. The clear use-case is ``Cash``, however ``FungibleAsset`` is
intended to be readily extensible to cover other assets, for example commodities could be modelled by using a subclass
whose state objects include further details (location of the commodity, origin, grade, etc.) as needed.
Transaction Types
-----------------