net.corda.finance.contracts.asset

Class Cash.Companion

net.corda.finance.contracts.asset.Cash.Companion

Enclosing class:

Cash

public static class Cash.Companion

Method Summary

Modifier and Type	Method and Description
kotlin.Pair<net.corda.core.transactions.TransactionBuilder,java.util.List>	generateSpend(ServiceHub services, TransactionBuilder tx, Amount<java.util.Currency> amount, AbstractParty to, java.util.Set<? extends net.corda.core.identity.AbstractParty> onlyFromParties) Generate a transaction that moves an amount of currency to the given pubkey.
kotlin.Pair<net.corda.core.transactions.TransactionBuilder,java.util.List>	generateSpend(ServiceHub services, TransactionBuilder tx, java.util.List<net.corda.finance.contracts.asset.PartyAndAmount> payments, java.util.Set<? extends net.corda.core.identity.AbstractParty> onlyFromParties) Generate a transaction that moves an amount of currency to the given pubkey.

Method Detail

generateSpend

public kotlin.Pair<net.corda.core.transactions.TransactionBuilder,java.util.List> generateSpend(ServiceHub services,
                                                                                                TransactionBuilder tx,
                                                                                                Amount<java.util.Currency> amount,
                                                                                                AbstractParty to,
                                                                                                java.util.Set<? extends net.corda.core.identity.AbstractParty> onlyFromParties)

Generate a transaction that moves an amount of currency to the given pubkey.

Note: an class Amount of Currency is only fungible for a given Issuer Party within a interface FungibleAsset

Parameters:

services - The interface ServiceHub to provide access to the database session.

tx - A builder, which may contain inputs, outputs and commands already. The relevant components needed to move the cash will be added on top.

amount - How much currency to send.

to - a key of the recipient.

onlyFromParties - if non-null, the asset states will be filtered to only include those issued by the set of given parties. This can be useful if the party you're trying to pay has expectations about which type of asset claims they are willing to accept.

Returns:

A Pair of the same transaction builder passed in as tx, and the list of keys that need to sign the resulting transaction for it to be valid.

Throws:

- when a cash spending transaction fails because there is insufficient quantity for a given currency (and optionally set of Issuer Parties).

See Also:

class Amount, interface FungibleAsset

generateSpend

public kotlin.Pair<net.corda.core.transactions.TransactionBuilder,java.util.List> generateSpend(ServiceHub services,
                                                                                                TransactionBuilder tx,
                                                                                                java.util.List<net.corda.finance.contracts.asset.PartyAndAmount> payments,
                                                                                                java.util.Set<? extends net.corda.core.identity.AbstractParty> onlyFromParties)

Generate a transaction that moves an amount of currency to the given pubkey.

Note: an class Amount of Currency is only fungible for a given Issuer Party within a interface FungibleAsset

Parameters:

services - The interface ServiceHub to provide access to the database session.

tx - A builder, which may contain inputs, outputs and commands already. The relevant components needed to move the cash will be added on top.

onlyFromParties - if non-null, the asset states will be filtered to only include those issued by the set of given parties. This can be useful if the party you're trying to pay has expectations about which type of asset claims they are willing to accept.

Returns:

A Pair of the same transaction builder passed in as tx, and the list of keys that need to sign the resulting transaction for it to be valid.

Throws:

- when a cash spending transaction fails because there is insufficient quantity for a given currency (and optionally set of Issuer Parties).

See Also:

class Amount, interface FungibleAsset