Expand documentation on obligation contract

Expand documentation on obligation contract and add an example issuance function for cash obligations.
This commit is contained in:
Ross Nicoll 2017-07-19 13:34:28 +01:00 committed by GitHub
parent 264b9316e3
commit 298287fe28
2 changed files with 40 additions and 2 deletions

View File

@ -254,6 +254,12 @@ class Obligation<P : Any> : Contract {
* Subset of state, containing the elements specified when issuing a new settlement contract.
*
* @param P the product the obligation is for payment of.
* @param acceptableContracts is the contract types that can be accepted, such as cash.
* @param acceptableIssuedProducts is the assets which are acceptable forms of payment (i.e. GBP issued by the Bank
* of England).
* @param dueBefore when payment is due by.
* @param timeTolerance tolerance value on [dueBefore], to handle clock skew between distributed systems. Generally
* this would be about 30 seconds.
*/
@CordaSerializable
data class Terms<P : Any>(
@ -467,8 +473,39 @@ class Obligation<P : Any> : Contract {
generateExitCommand = { amount -> Commands.Exit(amount) }
)
/**
* Puts together an issuance transaction for the specified currency obligation amount that starts out being owned by
* the given pubkey.
*
* @param tx transaction builder to add states and commands to.
* @param obligor the party who is expected to pay some currency amount to fulfil the obligation (also the owner of
* the obligation).
* @param amount currency amount the obligor is expected to pay.
* @param dueBefore the date on which the obligation is due. The default time tolerance is used (currently this is
* 30 seconds).
* @param beneficiary the party the obligor is expected to pay.
* @param notary the notary for this transaction's outputs.
*/
fun generateCashIssue(tx: TransactionBuilder,
obligor: AbstractParty,
amount: Amount<Issued<Currency>>,
dueBefore: Instant,
beneficiary: AbstractParty,
notary: Party) {
val issuanceDef = Terms(NonEmptySet.of(Cash().legalContractReference), NonEmptySet.of(amount.token), dueBefore)
OnLedgerAsset.generateIssue(tx, TransactionState(State(Lifecycle.NORMAL, obligor, issuanceDef, amount.quantity, beneficiary), notary), Commands.Issue())
}
/**
* Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.
*
* @param tx transaction builder to add states and commands to.
* @param obligor the party who is expected to pay some amount to fulfil the obligation.
* @param issuanceDef the terms of the obligation, including which contracts and underlying assets are acceptable
* forms of payment.
* @param pennies the quantity of the asset (in the smallest normal unit of measurement) owed.
* @param beneficiary the party the obligor is expected to pay.
* @param notary the notary for this transaction's outputs.
*/
fun generateIssue(tx: TransactionBuilder,
obligor: AbstractParty,

View File

@ -274,9 +274,10 @@ class ObligationTests {
// We don't actually verify the states, this is just here to make things look sensible
val dueBefore = TEST_TX_TIME - 7.days
// Generate a transaction issuing the obligation
// Generate a transaction issuing the obligation.
var tx = TransactionType.General.Builder(null).apply {
Obligation<Currency>().generateIssue(this, MINI_CORP, megaCorpDollarSettlement.copy(dueBefore = dueBefore), 100.DOLLARS.quantity,
val amount = Amount(100, Issued(defaultIssuer, USD))
Obligation<Currency>().generateCashIssue(this, ALICE, amount, dueBefore,
beneficiary = MINI_CORP, notary = DUMMY_NOTARY)
}
var stx = miniCorpServices.signInitialTransaction(tx)