docs/net.corda.finance.contracts.asset

Package-level declarations

Types

data class BilateralNetState(val partyKeys: Set<AbstractParty>, val template: Obligation.Terms) : NetState

Subset of state, containing the elements which must match for two obligation transactions to be nettable. If two obligation state objects produce equal bilateral net states, they are considered safe to net directly. Bilateral states are used in close-out netting.

Cash

class Cash : OnLedgerAsset<Currency, Cash.Commands, Cash.State>

A cash transaction may split and merge money represented by a set of (issuer, depositRef) pairs, across multiple input and output states. Imagine a Bitcoin transaction but in which all UTXOs had a colour (a blend of issuer+depositRef) and you couldn't merge outputs of two colours together, but you COULD put them in the same transaction.

MultilateralNetState

data class MultilateralNetState(val template: Obligation.Terms) : NetState

Subset of state, containing the elements which must match for two or more obligation transactions to be candidates for netting (this does not include the checks to enforce that everyone's amounts received are the same at the end, which is handled under the verify() function). In comparison to BilateralNetState, this doesn't include the parties' keys, as ensuring balances match on input and output is handled elsewhere. Used in cases where all parties (or their proxies) are signing, such as central clearing.

NetState

interface NetState

Common interface for the state subsets used when determining nettability of two or more states. Exposes the underlying issued thing.

Obligation

class Obligation : Contract

An obligation contract commits the obligor to delivering a specified amount of a fungible asset (for example the Cash contract) at a specified future point in time. Settlement transactions may split and merge contracts across multiple input and output states. The goal of this design is to handle amounts owed, and these contracts are expected to be netted/merged, with settlement only for any remainder amount.

OnLedgerAsset

abstract class OnLedgerAsset<T : Any, out C : CommandData, S : FungibleAsset<T>> : Contract

An asset transaction may split and merge assets represented by a set of (issuer, depositRef) pairs, across multiple input and output states. Imagine a Bitcoin transaction but in which all UTXOs had a colour (a blend of issuer+depositRef) and you couldn't merge outputs of two colours together, but you COULD put them in the same transaction.

PartyAndAmount

data class PartyAndAmount<T : Any>(val party: AbstractParty, val amount: Amount<T>)

A simple holder for a (possibly anonymous) AbstractParty and a quantity of tokens

Properties

CASH

val Amount<Currency>.CASH: Cash.State

An extension property that lets you write 100.DOLLARS.CASH

STATE

val Amount<Issued<Currency>>.STATE: Cash.State

An extension property that lets you get a cash state from an issued token, under the NULL_PARTY

Functions

infix fun <T : Any> Obligation.State<T>.at(dueBefore: Instant): Obligation.State<T>

between

infix fun <T : Any> Obligation.State<T>.between(parties: <Error class: unknown class><AbstractParty, AbstractParty>): Obligation.State<T>

extractAmountsDue

fun extractAmountsDue(product: Obligation.Terms, states: Iterable<Obligation.State>): Map<<Error class: unknown class><AbstractParty, AbstractParty>, Amount<Obligation.Terms>>

Convert a list of settlement states into total from each obligor to a beneficiary.

issued by

infix fun <T : Any> Obligation.State<T>.issued by(party: AbstractParty): Obligation.State<T>

issuedBy

fun <T : Any> Obligation.State<T>.issuedBy(party: AnonymousParty): Obligation.State<T>

netAmountsDue

fun netAmountsDue(balances: Map<<Error class: unknown class><P, P>, Amount<T>>): Map<<Error class: unknown class><P, P>, Amount<T>>

Net off the amounts due between parties.

owned by

infix fun <T : Any> Obligation.State<T>.owned by(owner: AbstractParty): Obligation.State<T>

ownedBy

fun <T : Any> Obligation.State<T>.ownedBy(owner: AbstractParty): Obligation.State<T>

sumAmountsDue

fun sumAmountsDue(balances: Map<<Error class: unknown class><P, P>, Amount<T>>): Map<P, Long>

Calculate the total balance movement for each party in the transaction, based off a summary of balances between each obligor and beneficiary.