mirror of
https://github.com/corda/corda.git
synced 2024-12-18 20:47:57 +00:00
Rebuild documentation
This commit is contained in:
Ross Nicoll
parent
f9c1f31730
commit
2fed96cad0
1
docs/build/html/_sources/index.txt
vendored
1
docs/build/html/_sources/index.txt
vendored
@ -26,6 +26,7 @@ Read on to learn:
|
||||
inthebox
|
||||
getting-set-up
|
||||
data-model
|
||||
transaction-data-types
|
||||
consensus
|
||||
messaging
|
||||
running-the-demos
|
||||
|
||||
5
docs/build/html/_sources/release-notes.txt
vendored
5
docs/build/html/_sources/release-notes.txt
vendored
@ -8,7 +8,10 @@ Unreleased
|
||||
|
||||
Here are changes in git master that haven't yet made it to a snapshot release:
|
||||
|
||||
* Nothing yet
|
||||
* The cash contract has moved from com.r3corda.contracts to com.r3corda.contracts.cash.
|
||||
* Amount class is now generic, to support non-currency types (such as assets, or currency with additional information).
|
||||
* Refactored the Cash contract to have a new FungibleAsset superclass, to model all countable assets that can be merged
|
||||
and split (currency, barrels of oil, etc.)
|
||||
|
||||
|
||||
Milestone 0
|
||||
|
||||
21
docs/build/html/_sources/release-process.txt
vendored
21
docs/build/html/_sources/release-process.txt
vendored
@ -20,4 +20,23 @@ forever and the software will be considered production ready. Until then, expect
|
||||
hard hat.
|
||||
|
||||
Our goal is to cut a new milestone roughly once a month. There are no fixed dates. If need be, a milestone may slip by
|
||||
a few days to ensure the code is sufficiently usable.
|
||||
a few days to ensure the code is sufficiently usable. Usually the release will happen around the end of the month.
|
||||
|
||||
Steps to cut a release
|
||||
======================
|
||||
|
||||
1. Pick a commit that is stable and do basic QA: run all the tests, run the demos.
|
||||
2. Review the commits between this release and the last looking for new features, API changes, etc. Make sure the
|
||||
summary in the current section of the :doc:`release-notes` is correct and update if not. Then move it into the right
|
||||
section for this release. This is the right place to put any advice on how to port app code from the last release.
|
||||
3. Additionally, if there are any new features or APIs that deserve a new section in the docsite and the author didn't
|
||||
create one, bug them to do so a day or two before the release.
|
||||
4. Regenerate the docsite if necessary and commit.
|
||||
5. Create a branch with a name like `release-M0` where 0 is replaced by the number of the milestone.
|
||||
6. Tag that branch with a tag like `release-M0.0`
|
||||
7. Push the branch and the tag to git.
|
||||
8. Write up a short announcement containing the summary of new features, changes, and API breaks. Send it to the
|
||||
r3dlg-awg mailing list.
|
||||
|
||||
If there are serious bugs found in the release, backport the fix to the branch and then tag it with e.g. `release-M0.1`
|
||||
Minor changes to the branch don't have to be announced unless it'd be critical to get all developers updated.
|
||||
66
docs/build/html/_sources/running-the-demos.txt
vendored
66
docs/build/html/_sources/running-the-demos.txt
vendored
@ -12,23 +12,35 @@ so far. We have:
|
||||
The demos create node data directories in the root of the project. If something goes wrong with them, blow away the
|
||||
directories and try again.
|
||||
|
||||
.. warning:: Corda is developed on MacOS and works best on UNIX systems. The trader demo is easily run on Windows but
|
||||
you won't get the nice coloured output. The IRS demo relies on a shell script wrapper and isn't so easily run on
|
||||
Windows currently: we will fix this soon.
|
||||
.. note:: Corda is developed on MacOS and works best on UNIX systems. Both demos are easily run on Windows but
|
||||
you won't get the nice coloured output.
|
||||
|
||||
Trader demo
|
||||
-----------
|
||||
|
||||
.. note:: On Windows, use the same commands, but run the batch file instead of the shell file (add .bat to the command)
|
||||
Open two terminals, and in the first run:
|
||||
|
||||
Open two terminals, and in the first run:::
|
||||
.. note:: If you are planning to use non-default configuration you will need to run with --role=SetupA and --role=SetupB
|
||||
beforehand with the same parameters you plan to supply to the respective nodes.
|
||||
|
||||
gradle installDist && ./build/install/r3prototyping/bin/trader-demo --role=BUYER
|
||||
**Windows**::
|
||||
|
||||
gradlew.bat & .\build\install\r3prototyping\bin\trader-demo --role=BUYER
|
||||
|
||||
**Other**::
|
||||
|
||||
Other: ./gradlew installDist && ./build/install/r3prototyping/bin/trader-demo --role=BUYER
|
||||
|
||||
It will compile things, if necessary, then create a directory named trader-demo/buyer with a bunch of files inside and
|
||||
start the node. You should see it waiting for a trade to begin.
|
||||
|
||||
In the second terminal, run::
|
||||
In the second terminal, run:
|
||||
|
||||
**Windows**::
|
||||
|
||||
.\build\install\r3prototyping\bin\trader-demo --role=SELLER
|
||||
|
||||
**Other**::
|
||||
|
||||
./build/install/r3prototyping/bin/trader-demo --role=SELLER
|
||||
|
||||
@ -41,26 +53,48 @@ If it doesn't work, jump on the mailing list and let us know.
|
||||
IRS demo
|
||||
--------
|
||||
|
||||
.. warning:: This demo currently works best on MacOS or Linux
|
||||
Open three terminals. In the first run:
|
||||
|
||||
Open three terminals. In the first run:::
|
||||
**Windows**::
|
||||
|
||||
./scripts/irs-demo.sh nodeA
|
||||
gradlew.bat installDist & .\build\install\r3prototyping\bin\irsdemo.bat --role=NodeA
|
||||
|
||||
And in the second run:::
|
||||
**Other**::
|
||||
|
||||
./scripts/irs-demo.sh nodeB
|
||||
./gradlew installDist && ./build/install/r3prototyping/bin/irsdemo --role=NodeA
|
||||
|
||||
And in the second run:
|
||||
|
||||
**Windows**::
|
||||
|
||||
.\build\install\r3prototyping\bin\irsdemo.bat --role=NodeB
|
||||
|
||||
**Other**::
|
||||
|
||||
./build/install/r3prototyping/bin/irsdemo --role=NodeB
|
||||
|
||||
The node in the first terminal will complain that it didn't know about nodeB, so restart it. It'll then find the
|
||||
location and identity keys of nodeA and be happy. NodeB also doubles up as the interest rates oracle and you should
|
||||
see some rates data get loaded.
|
||||
|
||||
Now in the third terminal run:::
|
||||
Now in the third terminal run:
|
||||
|
||||
./scripts/irs-demo.sh trade trade1
|
||||
**Windows**::
|
||||
|
||||
.\build\install\r3prototyping\bin\irsdemo.bat --role=Trade trade1
|
||||
|
||||
**Other**::
|
||||
|
||||
./build/install/r3prototyping/bin/irsdemo --role=Trade trade1
|
||||
|
||||
You should see some activity in the other two terminals as they set up the deal. You can now run this command in
|
||||
a separate window to roll the fake clock forward and trigger lots of fixing events. Things go fast so make sure you
|
||||
can see the other terminals whilst you run this command!::
|
||||
can see the other terminals whilst you run this command!:
|
||||
|
||||
./scripts/irs-demo.sh date 2017-01-30
|
||||
**Windows**::
|
||||
|
||||
.\build\install\r3prototyping\bin\irsdemo.bat --role=Date 2017-01-30
|
||||
|
||||
**Other**::
|
||||
|
||||
./build/install/r3prototyping/bin/irsdemo --role=Date 2017-01-30
|
||||
|
||||
100
docs/build/html/_sources/transaction-data-types.txt
vendored
Normal file
100
docs/build/html/_sources/transaction-data-types.txt
vendored
Normal file
@ -0,0 +1,100 @@
|
||||
Transaction Data Types
|
||||
======================
|
||||
|
||||
There is a large library of data types used in Corda transactions and contract state objects.
|
||||
|
||||
Amount
|
||||
------
|
||||
|
||||
The ``Amount`` class is used to represent an amount of some fungible asset. It is a generic class which wraps around
|
||||
a type used to define the underlying product, generally represented by an ``Issued`` instance, or this can be a more
|
||||
complex type such as an obligation contract issuance definition (which in turn contains a token definition for whatever
|
||||
the obligation is to be settled in).
|
||||
|
||||
.. note:: Fungible is used here to mean that instances of an asset is interchangeable for any other identical instance,
|
||||
and that they can be split/merged. For example a £5 note can reasonably be exchanged for any other £5 note, and a
|
||||
£10 note can be exchanged for two £5 notes, or vice-versa.
|
||||
|
||||
Where a contract refers directly to an amount of something, ``Amount`` should wrap ``Issued``, which in
|
||||
turn can refer to a ``Currency`` (GBP, USD, CHF, etc.), or any other class. Future work in this area will include
|
||||
introducing classes to represent non-currency things (such as commodities) that Issued can wrap. For more
|
||||
complex amounts, ``Amount`` can wrap other types, for example to represent a number of Obligation contracts to be
|
||||
delivered (themselves referring to a currency), an ``Amount`` such as the following would used:
|
||||
|
||||
.. container:: codeset
|
||||
|
||||
.. sourcecode:: kotlin
|
||||
|
||||
Amount<Obligation.State<Currency>>
|
||||
|
||||
Contract State
|
||||
--------------
|
||||
|
||||
A Corda contract is composed of three parts; the executable code, the legal prose, and the state objects that represent
|
||||
the details of the contract (see :doc:`data-model` for further detail). States essentially convert the generic template
|
||||
(code and legal prose) into a specific instance. In a ``WireTransaction``, outputs are provided as ``ContractState``
|
||||
implementations, while the inputs are references to the outputs of a previous transaction. These references are then
|
||||
stored as ``StateRef`` objects, which are converted to ``StateAndRef`` on demand.
|
||||
|
||||
A number of interfaces then extend ``ContractState``, representing standardised functionality for states:
|
||||
|
||||
``OwnableState``
|
||||
A state which has an owner (represented as a ``PublicKey``, discussed later). Exposes the owner and a function for
|
||||
replacing the owner.
|
||||
|
||||
``LinearState``
|
||||
A state which links back to its previous state, creating a thread of states over time. Intended to simplify tracking
|
||||
state versions.
|
||||
|
||||
``DealState``
|
||||
A state representing an agreement between two or more parties. Intended to simplify implementing generic protocols
|
||||
that manipulate many agreement types.
|
||||
|
||||
``FixableDealState``
|
||||
A deal state, with further functions exposed to support fixing of interest rates.
|
||||
|
||||
Things (such as attachments) which are identified by their hash should implement the ``NamedByHash`` interface,
|
||||
which standardises how the ID is extracted.
|
||||
|
||||
FungibleAssets and Cash
|
||||
-----------------------
|
||||
|
||||
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
|
||||
-----------------
|
||||
|
||||
The ``WireTransaction`` class contains the core of a transaction without signatures, and with references to attachments
|
||||
in place of the attachments themselves (see also :doc:`data-model`). Once signed these are encapsulated in the
|
||||
``SignedTransaction`` class. For processing a transaction (i.e. to verify it) it is first converted to a
|
||||
``LedgerTransaction``, which involves verifying the signatures and associating them to the relevant command(s), and
|
||||
resolving the attachment references to the attachments. Commands with valid signatures are encapsulated in the
|
||||
``AuthenticatedObject`` type.
|
||||
|
||||
Party and PublicKey
|
||||
-------------------
|
||||
|
||||
Identities of parties involved in signing a transaction can be represented simply by their ``PublicKey``, or by further
|
||||
information (such as name) using the ``Party`` class. An ``AuthenticatedObject`` contains a list of the public keys
|
||||
for signatures present on the transaction, as well as list of parties for those public keys (where known).
|
||||
|
||||
.. note:: These types are provisional and are likely to change in future, for example to add additional information to
|
||||
``Party``.
|
||||
|
||||
Date Support
|
||||
------------
|
||||
|
||||
There are a number of supporting interfaces and classes for use by contract which deal with dates (especially in the
|
||||
context of deadlines). As contract negotiation typically deals with deadlines in terms such as "overnight", "T+3",
|
||||
etc., it's desirable to allow conversion of these terms to their equivalent deadline. ``Tenor`` models the interval
|
||||
before a deadline, such as 3 days, etc., while ``DateRollConvention`` describes how deadlines are modified to take
|
||||
into account bank holidays or other events that modify normal working days.
|
||||
|
||||
Calculating the rollover of a deadline based on working days requires information on the bank holidays involved
|
||||
(and where a contract's parties are in different countries, for example, this can involve multiple separate sets of
|
||||
bank holidays). The ``BusinessCalendar`` class models these calendars of business holidays; currently it loads these
|
||||
from files on disk, but in future this is likely to involve reference data oracles in order to ensure consensus on the
|
||||
dates used.
|
||||
225
docs/build/html/api/alltypes/index.html
vendored
225
docs/build/html/api/alltypes/index.html
vendored
@ -9,6 +9,14 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.utilities/-a-n-s-i-progress-observer/index.html">com.r3corda.node.utilities.ANSIProgressObserver</a></td>
|
||||
<td>
|
||||
<p>This observes the <a href="../com.r3corda.node.services.statemachine/-state-machine-manager/index.html">StateMachineManager</a> and follows the progress of <a href="../com.r3corda.core.protocols/-protocol-logic/index.html">ProtocolLogic</a>s until they complete in the order
|
||||
they are added to the <a href="../com.r3corda.node.services.statemachine/-state-machine-manager/index.html">StateMachineManager</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.utilities/-a-n-s-i-progress-renderer/index.html">com.r3corda.node.utilities.ANSIProgressRenderer</a></td>
|
||||
<td>
|
||||
<p>Knows how to render a <a href="../com.r3corda.core.utilities/-progress-tracker/index.html">ProgressTracker</a> to the terminal using coloured, emoji-fied output. Useful when writing small
|
||||
@ -99,7 +107,9 @@ for ensuring code runs on the right thread, and also for unit testing.</p>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-amount/index.html">com.r3corda.core.contracts.Amount</a></td>
|
||||
<td>
|
||||
<p>Amount represents a positive quantity of currency, measured in pennies, which are the smallest representable units.</p>
|
||||
<p>Amount represents a positive quantity of some token (currency, asset, etc.), measured in quantity of the smallest
|
||||
representable units. Note that quantity is not necessarily 1/100ths of a currency unit, but are the actual smallest
|
||||
amount used in whatever underlying thing the amount represents.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -114,6 +124,14 @@ as well.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.cash/-asset-issuance-definition/index.html">com.r3corda.contracts.cash.AssetIssuanceDefinition</a></td>
|
||||
<td>
|
||||
<p>Subset of cash-like contract state, containing the issuance definition. If these definitions match for two
|
||||
contracts states, those states can be aggregated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-attachment/index.html">com.r3corda.core.contracts.Attachment</a></td>
|
||||
<td>
|
||||
<p>An attachment is a ZIP (or an optionally signed JAR) that contains one or more files. Attachments are meant to
|
||||
@ -191,7 +209,7 @@ no staff are around to handle problems.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts/-cash/index.html">com.r3corda.contracts.Cash</a></td>
|
||||
<a href="../com.r3corda.contracts.cash/-cash/index.html">com.r3corda.contracts.cash.Cash</a></td>
|
||||
<td>
|
||||
<p>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
|
||||
@ -201,10 +219,9 @@ the same transaction.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.cash/-cash-issuance-definition/index.html">com.r3corda.contracts.cash.CashIssuanceDefinition</a></td>
|
||||
<a href="../com.r3corda.node.services.wallet/-cash-balance-as-metrics-observer/index.html">com.r3corda.node.services.wallet.CashBalanceAsMetricsObserver</a></td>
|
||||
<td>
|
||||
<p>Subset of cash-like contract state, containing the issuance definition. If these definitions match for two
|
||||
contracts states, those states can be aggregated.</p>
|
||||
<p>This class observes the wallet and reflect current cash balances as exposed metrics in the monitoring service.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -229,6 +246,12 @@ contracts states, those states can be aggregated.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.utilities/java.time.-clock/index.html">java.time.Clock</a> (extensions in package com.r3corda.node.utilities)</td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-command/index.html">com.r3corda.core.contracts.Command</a></td>
|
||||
<td>
|
||||
<p>Command data/content plus pubkey pair: the signature is stored at the end of the serialized bytes</p>
|
||||
@ -249,13 +272,6 @@ contracts states, those states can be aggregated.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.cash/-common-cash-state/index.html">com.r3corda.contracts.cash.CommonCashState</a></td>
|
||||
<td>
|
||||
<p>Common elements of cash contract states.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.servlets/-config/index.html">com.r3corda.node.servlets.Config</a></td>
|
||||
<td>
|
||||
<p>Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
|
||||
@ -308,15 +324,6 @@ updated, instead, any changes must generate a new successor state.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts/-crowd-fund/index.html">com.r3corda.contracts.CrowdFund</a></td>
|
||||
<td>
|
||||
<p>This is a basic crowd funding contract. It allows a party to create a funding opportunity, then for others to
|
||||
pledge during the funding period , and then for the party to either accept the funding (if the target has been reached)
|
||||
return the funds to the pledge-makers (if the target has not been reached).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.math/-cubic-spline-interpolator/index.html">com.r3corda.core.math.CubicSplineInterpolator</a></td>
|
||||
<td>
|
||||
<p>Interpolates values between the given data points using a <a href="../com.r3corda.core.math/-spline-function/index.html">SplineFunction</a>.</p>
|
||||
@ -416,7 +423,7 @@ building partially signed transactions.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts/-dummy-contract/index.html">com.r3corda.contracts.DummyContract</a></td>
|
||||
<a href="../com.r3corda.core.contracts/-dummy-contract/index.html">com.r3corda.core.contracts.DummyContract</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
@ -496,6 +503,13 @@ attachments are saved to local storage automatically.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.utilities/-fiber-box/index.html">com.r3corda.node.utilities.FiberBox</a></td>
|
||||
<td>
|
||||
<p>Modelled on <a href="#">ThreadBox</a>, but with support for waiting that is compatible with Quasar <a href="#">Fiber</a>s and <a href="../com.r3corda.node.utilities/-mutable-clock/index.html">MutableClock</a>s</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-fix/index.html">com.r3corda.core.contracts.Fix</a></td>
|
||||
<td>
|
||||
<p>A <a href="../com.r3corda.core.contracts/-fix/index.html">Fix</a> represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx.</p>
|
||||
@ -555,6 +569,31 @@ that would divide into (eg annually = 1, semiannual = 2, monthly = 12 etc).</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.cash/-fungible-asset/index.html">com.r3corda.contracts.cash.FungibleAsset</a></td>
|
||||
<td>
|
||||
<p>Superclass for contracts representing assets which are fungible, countable and issued by a specific party. States
|
||||
contain assets which are equivalent (such as cash of the same currency), so records of their existence can
|
||||
be merged or split as needed where the issuer is the same. For instance, dollars issued by the Fed are fungible and
|
||||
countable (in cents), barrels of West Texas crude are fungible and countable (oil from two small containers
|
||||
can be poured into one large container), shares of the same class in a specific company are fungible and
|
||||
countable, and so on.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.cash/-fungible-asset-state/index.html">com.r3corda.contracts.cash.FungibleAssetState</a></td>
|
||||
<td>
|
||||
<p>Common elements of cash contract states.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.demos/-i-r-s-demo-role/index.html">com.r3corda.demos.IRSDemoRole</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.internal.testing/-i-r-s-simulation/index.html">com.r3corda.node.internal.testing.IRSSimulation</a></td>
|
||||
<td>
|
||||
<p>A simulation in which banks execute interest rate swaps with each other, including the fixing events.</p>
|
||||
@ -617,7 +656,7 @@ testing).</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts/-insufficient-balance-exception/index.html">com.r3corda.contracts.InsufficientBalanceException</a></td>
|
||||
<a href="../com.r3corda.contracts.cash/-insufficient-balance-exception/index.html">com.r3corda.contracts.cash.InsufficientBalanceException</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
@ -691,7 +730,7 @@ from which the state object is initialised.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts/kotlin.collections.-iterable/index.html">kotlin.collections.Iterable</a> (extensions in package com.r3corda.contracts)</td>
|
||||
<a href="../com.r3corda.contracts.cash/kotlin.collections.-iterable/index.html">kotlin.collections.Iterable</a> (extensions in package com.r3corda.contracts.cash)</td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
@ -864,6 +903,12 @@ Components that do IO are either swapped out for mocks, or pointed to a <a href=
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.node.services.testing/-mock-transaction-storage/index.html">com.r3corda.core.node.services.testing.MockTransactionStorage</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.api/-monitoring-service/index.html">com.r3corda.node.services.api.MonitoringService</a></td>
|
||||
<td>
|
||||
<p>Provides access to various metrics and ways to notify monitoring services of things, for sysadmin purposes.
|
||||
@ -872,6 +917,14 @@ This is not an interface because it is too lightweight to bother mocking out.</p
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.utilities/-mutable-clock/index.html">com.r3corda.node.utilities.MutableClock</a></td>
|
||||
<td>
|
||||
<p>An abstract class with helper methods for a type of Clock that might have its concept of "now"
|
||||
adjusted externally.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-named-by-hash/index.html">com.r3corda.core.contracts.NamedByHash</a></td>
|
||||
<td>
|
||||
<p>Implemented by anything that can be named by a secure hash value (e.g. transactions, attachments).</p>
|
||||
@ -905,6 +958,12 @@ replace each other based on a serial number present in the change.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.serialization/-no-references-serializer/index.html">com.r3corda.core.serialization.NoReferencesSerializer</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.internal/-node/index.html">com.r3corda.node.internal.Node</a></td>
|
||||
<td>
|
||||
<p>A Node manages a standalone server that takes part in the P2P network. It creates the services found in <a href="#">ServiceHub</a>,
|
||||
@ -920,6 +979,13 @@ loads important data off disk and starts listening for connections.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.serialization/-node-clock/index.html">com.r3corda.node.serialization.NodeClock</a></td>
|
||||
<td>
|
||||
<p>A <a href="http://docs.oracle.com/javase/6/docs/api/java/time/Clock.html">Clock</a> that tokenizes itself when serialized, and delegates to an underlying <a href="http://docs.oracle.com/javase/6/docs/api/java/time/Clock.html">Clock</a> implementation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.config/-node-configuration/index.html">com.r3corda.node.services.config.NodeConfiguration</a></td>
|
||||
<td>
|
||||
</td>
|
||||
@ -969,6 +1035,14 @@ states relevant to us into a database and once such a wallet is implemented, thi
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.utilities/-non-empty-set/index.html">com.r3corda.core.utilities.NonEmptySet</a></td>
|
||||
<td>
|
||||
<p>A set which is constrained to ensure it can never be empty. An initial value must be provided at
|
||||
construction, and attempting to remove the last element will cause an IllegalStateException.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.protocols/-notary-error/index.html">com.r3corda.protocols.NotaryError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
@ -983,8 +1057,6 @@ states relevant to us into a database and once such a wallet is implemented, thi
|
||||
<td>
|
||||
<a href="../com.r3corda.protocols/-notary-protocol/index.html">com.r3corda.protocols.NotaryProtocol</a></td>
|
||||
<td>
|
||||
<p>A protocol to be used for obtaining a signature from a <a href="#">NotaryService</a> ascertaining the transaction
|
||||
timestamp is correct and none of its inputs have been used in another completed transaction</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -1060,6 +1132,13 @@ ledger. The reference is intended to be encrypted so its meaningless to anyone o
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.persistence/-per-file-transaction-storage/index.html">com.r3corda.node.services.persistence.PerFileTransactionStorage</a></td>
|
||||
<td>
|
||||
<p>File-based transaction storage, storing transactions per file.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts/-percentage-ratio-unit/index.html">com.r3corda.contracts.PercentageRatioUnit</a></td>
|
||||
<td>
|
||||
<p>A class to reprecent a percentage in an unambiguous way.</p>
|
||||
@ -1204,6 +1283,13 @@ e.g. LIBOR 6M as of 17 March 2016. Hence it requires a source (name) and a value
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.serialization/-references-aware-java-serializer/index.html">com.r3corda.core.serialization.ReferencesAwareJavaSerializer</a></td>
|
||||
<td>
|
||||
<p>Improvement to the builtin JavaSerializer by honouring the <a href="#">Kryo.getReferences</a> setting.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.api/-regulator-service/index.html">com.r3corda.node.services.api.RegulatorService</a></td>
|
||||
<td>
|
||||
<p>Placeholder interface for regulator services.</p>
|
||||
@ -1233,6 +1319,14 @@ all the transactions have been successfully verified and inserted into the local
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core/-retryable-exception/index.html">com.r3corda.core.RetryableException</a></td>
|
||||
<td>
|
||||
<p>This represents a transient exception or condition that might no longer be thrown if the operation is re-run or called
|
||||
again.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.demos/-role/index.html">com.r3corda.demos.Role</a></td>
|
||||
<td>
|
||||
</td>
|
||||
@ -1252,14 +1346,6 @@ all the transactions have been successfully verified and inserted into the local
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.serialization/-serialize-as-string-token/index.html">com.r3corda.core.serialization.SerializeAsStringToken</a></td>
|
||||
<td>
|
||||
<p>A base class for implementing large objects / components / services that need to serialize themselves to a string token
|
||||
to indicate which instance the token is a serialized form of.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.serialization/-serialize-as-token/index.html">com.r3corda.core.serialization.SerializeAsToken</a></td>
|
||||
<td>
|
||||
<p>This interface should be implemented by classes that want to substitute a token representation of themselves if
|
||||
@ -1268,6 +1354,13 @@ they are serialized because they have a lot of internal state that does not seri
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.serialization/-serialize-as-token-context/index.html">com.r3corda.core.serialization.SerializeAsTokenContext</a></td>
|
||||
<td>
|
||||
<p>A context for mapping SerializationTokens to/from SerializeAsTokens.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.serialization/-serialize-as-token-serializer/index.html">com.r3corda.core.serialization.SerializeAsTokenSerializer</a></td>
|
||||
<td>
|
||||
<p>A Kryo serializer for <a href="../com.r3corda.core.serialization/-serialize-as-token/index.html">SerializeAsToken</a> implementations.</p>
|
||||
@ -1330,6 +1423,13 @@ contained within.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.transactions/-simple-notary-service/index.html">com.r3corda.node.services.transactions.SimpleNotaryService</a></td>
|
||||
<td>
|
||||
<p>A simple Notary service that does not perform transaction validation</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.internal.testing/-simulation/index.html">com.r3corda.node.internal.testing.Simulation</a></td>
|
||||
<td>
|
||||
<p>Base class for network simulations that are based on the unit test / mock environment.</p>
|
||||
@ -1344,6 +1444,22 @@ contained within.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.serialization/-singleton-serialization-token/index.html">com.r3corda.core.serialization.SingletonSerializationToken</a></td>
|
||||
<td>
|
||||
<p>A class representing a <a href="../com.r3corda.core.serialization/-serialization-token/index.html">SerializationToken</a> for some object that is not serializable but can be looked up
|
||||
(when deserialized) via just the class name.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.serialization/-singleton-serialize-as-token/index.html">com.r3corda.core.serialization.SingletonSerializeAsToken</a></td>
|
||||
<td>
|
||||
<p>A base class for implementing large objects / components / services that need to serialize themselves to a string token
|
||||
to indicate which instance the token is a serialized form of.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.math/-spline-function/index.html">com.r3corda.core.math.SplineFunction</a></td>
|
||||
<td>
|
||||
<p>A <emph>spline</emph> is function piecewise-defined by polynomial functions.
|
||||
@ -1367,7 +1483,7 @@ Points at which polynomial pieces connect are known as <emph>knots</emph>.</p>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.statemachine/-state-machine-manager/index.html">com.r3corda.node.services.statemachine.StateMachineManager</a></td>
|
||||
<td>
|
||||
<p>A StateMachineManager is responsible for coordination and persistence of multiple <a href="../com.r3corda.core.protocols/-protocol-state-machine/index.html">ProtocolStateMachine</a> objects.
|
||||
<p>A StateMachineManager is responsible for coordination and persistence of multiple <a href="#">ProtocolStateMachine</a> objects.
|
||||
Each such object represents an instantiation of a (two-party) protocol that has reached a particular point.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -1428,6 +1544,13 @@ anything like that, this interface is only big enough to support the prototyping
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.internal.testing/-test-clock/index.html">com.r3corda.node.internal.testing.TestClock</a></td>
|
||||
<td>
|
||||
<p>A <a href="http://docs.oracle.com/javase/6/docs/api/java/time/Clock.html">Clock</a> that can have the time advanced for use in testing</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.testing/-test-utils/index.html">com.r3corda.core.testing.TestUtils</a></td>
|
||||
<td>
|
||||
</td>
|
||||
@ -1444,7 +1567,7 @@ way that ensures itll be released if theres an exception.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.transactions/-timestamp-checker/index.html">com.r3corda.node.services.transactions.TimestampChecker</a></td>
|
||||
<a href="../com.r3corda.core.node.services/-timestamp-checker/index.html">com.r3corda.core.node.services.TimestampChecker</a></td>
|
||||
<td>
|
||||
<p>Checks if the given timestamp falls within the allowed tolerance interval</p>
|
||||
</td>
|
||||
@ -1551,6 +1674,13 @@ this subgraph does not contain conflicts and is accepted by the involved contrac
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.node.services/-transaction-storage/index.html">com.r3corda.core.node.services.TransactionStorage</a></td>
|
||||
<td>
|
||||
<p>Thread-safe storage of transactions.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-transaction-verification-exception/index.html">com.r3corda.core.contracts.TransactionVerificationException</a></td>
|
||||
<td>
|
||||
</td>
|
||||
@ -1625,6 +1755,23 @@ intended as the way things will necessarily be done longer term</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.protocols/-validating-notary-protocol/index.html">com.r3corda.protocols.ValidatingNotaryProtocol</a></td>
|
||||
<td>
|
||||
<p>A notary commit protocol that makes sure a given transaction is valid before committing it. This does mean that the calling
|
||||
party has to reveal the whole transaction history; however, we avoid complex conflict resolution logic where a party
|
||||
has its input states "blocked" by a transaction from another party, and needs to establish whether that transaction was
|
||||
indeed valid</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.transactions/-validating-notary-service/index.html">com.r3corda.node.services.transactions.ValidatingNotaryService</a></td>
|
||||
<td>
|
||||
<p>A Notary service that validates the transaction chain of he submitted transaction before committing it</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.node.services/-wallet/index.html">com.r3corda.core.node.services.Wallet</a></td>
|
||||
<td>
|
||||
<p>A wallet (name may be temporary) wraps a set of states that are useful for us to keep track of, for instance,
|
||||
@ -1635,6 +1782,12 @@ about new transactions from our peers and generate new transactions that consume
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.internal.testing/-wallet-filler/index.html">com.r3corda.node.internal.testing.WalletFiller</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.wallet/-wallet-impl/index.html">com.r3corda.node.services.wallet.WalletImpl</a></td>
|
||||
<td>
|
||||
<p>A wallet (name may be temporary) wraps a set of states that are useful for us to keep track of, for instance,
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>CashIssuanceDefinition.deposit - </title>
|
||||
<title>AssetIssuanceDefinition.deposit - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">CashIssuanceDefinition</a> / <a href=".">deposit</a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">AssetIssuanceDefinition</a> / <a href=".">deposit</a><br/>
|
||||
<br/>
|
||||
<h1>deposit</h1>
|
||||
<a name="com.r3corda.contracts.cash.CashIssuanceDefinition$deposit"></a>
|
||||
<a name="com.r3corda.contracts.cash.AssetIssuanceDefinition$deposit"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><br/>
|
||||
<p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
<p>Where the underlying asset backing this ledger entry can be found (propagated)</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
45
docs/build/html/api/com.r3corda.contracts.cash/-asset-issuance-definition/index.html
vendored
Normal file
45
docs/build/html/api/com.r3corda.contracts.cash/-asset-issuance-definition/index.html
vendored
Normal file
@ -0,0 +1,45 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AssetIssuanceDefinition - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href=".">AssetIssuanceDefinition</a><br/>
|
||||
<br/>
|
||||
<h1>AssetIssuanceDefinition</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">AssetIssuanceDefinition</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issuance-definition.html"><span class="identifier">IssuanceDefinition</span></a></code><br/>
|
||||
<p>Subset of cash-like contract state, containing the issuance definition. If these definitions match for two
|
||||
contracts states, those states can be aggregated.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="deposit.html">deposit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying asset backing this ledger entry can be found (propagated)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="token.html">token</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">token</span><span class="symbol">: </span><span class="identifier">T</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-cash/-issuance-definition/index.html">IssuanceDefinition</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">IssuanceDefinition</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">AssetIssuanceDefinition</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/com.r3corda.contracts.cash/-asset-issuance-definition/token.html
vendored
Normal file
15
docs/build/html/api/com.r3corda.contracts.cash/-asset-issuance-definition/token.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AssetIssuanceDefinition.token - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">AssetIssuanceDefinition</a> / <a href=".">token</a><br/>
|
||||
<br/>
|
||||
<h1>token</h1>
|
||||
<a name="com.r3corda.contracts.cash.AssetIssuanceDefinition$token"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">token</span><span class="symbol">: </span><span class="identifier">T</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -4,10 +4,10 @@
|
||||
<link rel="stylesheet" href="../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="index.html">com.r3corda.contracts</a> / <a href=".">CASH_PROGRAM_ID</a><br/>
|
||||
<a href="index.html">com.r3corda.contracts.cash</a> / <a href=".">CASH_PROGRAM_ID</a><br/>
|
||||
<br/>
|
||||
<h1>CASH_PROGRAM_ID</h1>
|
||||
<a name="com.r3corda.contracts$CASH_PROGRAM_ID"></a>
|
||||
<a name="com.r3corda.contracts.cash$CASH_PROGRAM_ID"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">CASH_PROGRAM_ID</span><span class="symbol">: </span><a href="-cash/index.html"><span class="identifier">Cash</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
@ -1,15 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>CashIssuanceDefinition.currency - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">CashIssuanceDefinition</a> / <a href=".">currency</a><br/>
|
||||
<br/>
|
||||
<h1>currency</h1>
|
||||
<a name="com.r3corda.contracts.cash.CashIssuanceDefinition$currency"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">currency</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,45 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>CashIssuanceDefinition - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href=".">CashIssuanceDefinition</a><br/>
|
||||
<br/>
|
||||
<h1>CashIssuanceDefinition</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">CashIssuanceDefinition</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issuance-definition.html"><span class="identifier">IssuanceDefinition</span></a></code><br/>
|
||||
<p>Subset of cash-like contract state, containing the issuance definition. If these definitions match for two
|
||||
contracts states, those states can be aggregated.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="currency.html">currency</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">currency</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="deposit.html">deposit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts/-cash/-issuance-definition/index.html">IssuanceDefinition</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">IssuanceDefinition</span> <span class="symbol">:</span> <span class="identifier">CashIssuanceDefinition</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-exit/-init-.html
vendored
Normal file
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-exit/-init-.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Exit.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Exit</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.Commands.Exit$<init>(com.r3corda.core.contracts.Amount((java.util.Currency)))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">)</span></code><br/>
|
||||
<p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-exit/amount.html
vendored
Normal file
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-exit/amount.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Exit.amount - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Exit</a> / <a href=".">amount</a><br/>
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.cash.Cash.Commands.Exit$amount"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../../-fungible-asset/-commands/-exit/amount.html">Exit.amount</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
40
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-exit/index.html
vendored
Normal file
40
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-exit/index.html
vendored
Normal file
@ -0,0 +1,40 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Exit - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href=".">Exit</a><br/>
|
||||
<br/>
|
||||
<h1>Exit</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><a href="../../../-fungible-asset/-commands/-exit/index.html"><span class="identifier">Exit</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.Commands.Exit$<init>(com.r3corda.core.contracts.Amount((java.util.Currency)))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">)</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="amount.html">amount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-issue/-init-.html
vendored
Normal file
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-issue/-init-.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Issue.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Issue</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.Commands.Issue$<init>(kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> SecureRandom.getInstanceStrong().nextLong()<span class="symbol">)</span></code><br/>
|
||||
<p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -4,10 +4,10 @@
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href=".">Issue</a><br/>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href=".">Issue</a><br/>
|
||||
<br/>
|
||||
<h1>Issue</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../../../-fungible-asset/-commands/-issue/index.html"><span class="identifier">Issue</span></a></code><br/>
|
||||
<p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
<br/>
|
||||
@ -19,7 +19,7 @@ has a unique ID even when there are no inputs.</p>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.Commands.Issue$<init>(kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> SecureRandom.getInstanceStrong().nextLong()<span class="symbol">)</span></code><p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.Commands.Issue$<init>(kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> SecureRandom.getInstanceStrong().nextLong()<span class="symbol">)</span></code><p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-issue/nonce.html
vendored
Normal file
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-commands/-issue/nonce.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Issue.nonce - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Issue</a> / <a href=".">nonce</a><br/>
|
||||
<br/>
|
||||
<h1>nonce</h1>
|
||||
<a name="com.r3corda.contracts.cash.Cash.Commands.Issue$nonce"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">nonce</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
Overrides <a href="../../../-fungible-asset/-commands/-issue/nonce.html">Issue.nonce</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -4,7 +4,7 @@
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Move</a> / <a href="."><init></a><br/>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Move</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Move</span><span class="symbol">(</span><span class="symbol">)</span></code><br/>
|
||||
@ -4,10 +4,10 @@
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href=".">Move</a><br/>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href=".">Move</a><br/>
|
||||
<br/>
|
||||
<h1>Move</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<code><span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><a href="../../../-fungible-asset/-commands/-move.html"><span class="identifier">Move</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
@ -4,7 +4,7 @@
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href=".">Commands</a><br/>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href=".">Commands</a><br/>
|
||||
<br/>
|
||||
<h1>Commands</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code><br/>
|
||||
@ -17,7 +17,7 @@
|
||||
<td>
|
||||
<a href="-exit/index.html">Exit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../../-fungible-asset/-commands/-exit/index.html"><span class="identifier">Exit</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -25,7 +25,7 @@ in some other way.</p>
|
||||
<td>
|
||||
<a href="-issue/index.html">Issue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../../-fungible-asset/-commands/-issue/index.html"><span class="identifier">Issue</span></a></code><p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -33,7 +33,7 @@ has a unique ID even when there are no inputs.</p>
|
||||
<td>
|
||||
<a href="-move/index.html">Move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><a href="../../-fungible-asset/-commands/-move.html"><span class="identifier">Move</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -44,24 +44,10 @@ has a unique ID even when there are no inputs.</p>
|
||||
<td>
|
||||
<a href="-exit/index.html">Exit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../../-fungible-asset/-commands/-exit/index.html"><span class="identifier">Exit</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-issue/index.html">Issue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-move/index.html">Move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
@ -4,7 +4,7 @@
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">Cash</a> / <a href="."><init></a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">Cash</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Cash</span><span class="symbol">(</span><span class="symbol">)</span></code><br/>
|
||||
14
docs/build/html/api/com.r3corda.contracts.cash/-cash/-issuance-definition/-init-.html
vendored
Normal file
14
docs/build/html/api/com.r3corda.contracts.cash/-cash/-issuance-definition/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.IssuanceDefinition.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">IssuanceDefinition</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">IssuanceDefinition</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.IssuanceDefinition$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.contracts.cash.Cash.IssuanceDefinition.T)/deposit">deposit</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash.IssuanceDefinition$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.contracts.cash.Cash.IssuanceDefinition.T)/token">token</span><span class="symbol">:</span> <span class="identifier">T</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -4,12 +4,12 @@
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">IssuanceDefinition</a> / <a href=".">deposit</a><br/>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">IssuanceDefinition</a> / <a href=".">deposit</a><br/>
|
||||
<br/>
|
||||
<h1>deposit</h1>
|
||||
<a name="com.r3corda.contracts.Cash.IssuanceDefinition$deposit"></a>
|
||||
<a name="com.r3corda.contracts.cash.Cash.IssuanceDefinition$deposit"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.contracts.cash/-cash-issuance-definition/deposit.html">CashIssuanceDefinition.deposit</a><br/>
|
||||
Overrides <a href="../../-asset-issuance-definition/deposit.html">AssetIssuanceDefinition.deposit</a><br/>
|
||||
<p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
<br/>
|
||||
<br/>
|
||||
43
docs/build/html/api/com.r3corda.contracts.cash/-cash/-issuance-definition/index.html
vendored
Normal file
43
docs/build/html/api/com.r3corda.contracts.cash/-cash/-issuance-definition/index.html
vendored
Normal file
@ -0,0 +1,43 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.IssuanceDefinition - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href=".">IssuanceDefinition</a><br/>
|
||||
<br/>
|
||||
<h1>IssuanceDefinition</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">IssuanceDefinition</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../-asset-issuance-definition/index.html"><span class="identifier">AssetIssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">IssuanceDefinition</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.IssuanceDefinition$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.contracts.cash.Cash.IssuanceDefinition.T)/deposit">deposit</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash.IssuanceDefinition$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.contracts.cash.Cash.IssuanceDefinition.T)/token">token</span><span class="symbol">:</span> <span class="identifier">T</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="deposit.html">deposit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="token.html">token</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">token</span><span class="symbol">: </span><span class="identifier">T</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-issuance-definition/token.html
vendored
Normal file
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-issuance-definition/token.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.IssuanceDefinition.token - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">IssuanceDefinition</a> / <a href=".">token</a><br/>
|
||||
<br/>
|
||||
<h1>token</h1>
|
||||
<a name="com.r3corda.contracts.cash.Cash.IssuanceDefinition$token"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">token</span><span class="symbol">: </span><span class="identifier">T</span></code><br/>
|
||||
Overrides <a href="../../-asset-issuance-definition/token.html">AssetIssuanceDefinition.token</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/-init-.html
vendored
Normal file
15
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/-init-.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, com.r3corda.core.crypto.Party)/deposit">deposit</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, com.r3corda.core.crypto.Party)/amount">amount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>A state representing a cash claim against some party</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/amount.html
vendored
Normal file
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/amount.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State.amount - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">amount</a><br/>
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.cash.Cash.State$amount"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../-fungible-asset/-state/amount.html">State.amount</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -4,10 +4,10 @@
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">contract</a><br/>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">contract</a><br/>
|
||||
<br/>
|
||||
<h1>contract</h1>
|
||||
<a name="com.r3corda.contracts.Cash.State$contract"></a>
|
||||
<a name="com.r3corda.contracts.cash.Cash.State$contract"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">contract</span><span class="symbol">: </span><a href="../index.html"><span class="identifier">Cash</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-contract-state/contract.html">ContractState.contract</a><br/>
|
||||
<p>Contract by which the state belongs</p>
|
||||
@ -4,12 +4,12 @@
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">deposit</a><br/>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">deposit</a><br/>
|
||||
<br/>
|
||||
<h1>deposit</h1>
|
||||
<a name="com.r3corda.contracts.Cash.State$deposit"></a>
|
||||
<a name="com.r3corda.contracts.cash.Cash.State$deposit"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.contracts.cash/-common-cash-state/deposit.html">CommonCashState.deposit</a><br/>
|
||||
Overrides <a href="../../-fungible-asset/-state/deposit.html">State.deposit</a><br/>
|
||||
<p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
<br/>
|
||||
<br/>
|
||||
107
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/index.html
vendored
Normal file
107
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/index.html
vendored
Normal file
@ -0,0 +1,107 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href=".">State</a><br/>
|
||||
<br/>
|
||||
<h1>State</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <a href="../../-fungible-asset/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<p>A state representing a cash claim against some party</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, com.r3corda.core.crypto.Party)/deposit">deposit</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, com.r3corda.core.crypto.Party)/amount">amount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code><p>A state representing a cash claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="amount.html">amount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="contract.html">contract</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">contract</span><span class="symbol">: </span><a href="../index.html"><span class="identifier">Cash</span></a></code><p>Contract by which the state belongs</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="deposit.html">deposit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="issuance-def.html">issuanceDef</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="notary.html">notary</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">notary</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code><p>Identity of the notary that ensures this state is not used as an input to a transaction more than once</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="owner.html">owner</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">owner</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a></code><p>There must be a MoveCommand signed by this key to claim the amount</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="to-string.html">toString</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">toString</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="with-new-owner.html">withNewOwner</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withNewOwner</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$withNewOwner(java.security.PublicKey)/newOwner">newOwner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Extension Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.contracts.testing/issued by.html">issued by</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="identifier">State</span><span class="symbol">.</span><span class="identifier">issued by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$issued by(com.r3corda.contracts.cash.Cash.State, com.r3corda.core.crypto.Party)/party">party</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">State</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.contracts.testing/owned by.html">owned by</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="identifier">State</span><span class="symbol">.</span><span class="identifier">owned by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.cash.Cash.State, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">State</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/issuance-def.html
vendored
Normal file
16
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/issuance-def.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State.issuanceDef - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">issuanceDef</a><br/>
|
||||
<br/>
|
||||
<h1>issuanceDef</h1>
|
||||
<a name="com.r3corda.contracts.cash.Cash.State$issuanceDef"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../-fungible-asset-state/issuance-def.html">FungibleAssetState.issuanceDef</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,15 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>CrowdFund.State.notary - </title>
|
||||
<title>Cash.State.notary - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">CrowdFund</a> / <a href="index.html">State</a> / <a href=".">notary</a><br/>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">notary</a><br/>
|
||||
<br/>
|
||||
<h1>notary</h1>
|
||||
<a name="com.r3corda.contracts.CrowdFund.State$notary"></a>
|
||||
<a name="com.r3corda.contracts.cash.Cash.State$notary"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">notary</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-contract-state/notary.html">ContractState.notary</a><br/>
|
||||
Overrides <a href="../../-fungible-asset/-state/notary.html">State.notary</a><br/>
|
||||
<p>Identity of the notary that ensures this state is not used as an input to a transaction more than once</p>
|
||||
<br/>
|
||||
<br/>
|
||||
@ -4,12 +4,12 @@
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">owner</a><br/>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">owner</a><br/>
|
||||
<br/>
|
||||
<h1>owner</h1>
|
||||
<a name="com.r3corda.contracts.Cash.State$owner"></a>
|
||||
<a name="com.r3corda.contracts.cash.Cash.State$owner"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">owner</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-ownable-state/owner.html">OwnableState.owner</a><br/>
|
||||
Overrides <a href="../../-fungible-asset/-state/owner.html">State.owner</a><br/>
|
||||
<p>There must be a MoveCommand signed by this key to claim the amount</p>
|
||||
<br/>
|
||||
<br/>
|
||||
@ -4,10 +4,10 @@
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">toString</a><br/>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">toString</a><br/>
|
||||
<br/>
|
||||
<h1>toString</h1>
|
||||
<a name="com.r3corda.contracts.Cash.State$toString()"></a>
|
||||
<a name="com.r3corda.contracts.cash.Cash.State$toString()"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">toString</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
17
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/with-new-owner.html
vendored
Normal file
17
docs/build/html/api/com.r3corda.contracts.cash/-cash/-state/with-new-owner.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State.withNewOwner - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">withNewOwner</a><br/>
|
||||
<br/>
|
||||
<h1>withNewOwner</h1>
|
||||
<a name="com.r3corda.contracts.cash.Cash.State$withNewOwner(java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withNewOwner</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash.State$withNewOwner(java.security.PublicKey)/newOwner">newOwner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-ownable-state/with-new-owner.html">OwnableState.withNewOwner</a><br/>
|
||||
<p>Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
21
docs/build/html/api/com.r3corda.contracts.cash/-cash/generate-issue.html
vendored
Normal file
21
docs/build/html/api/com.r3corda.contracts.cash/-cash/generate-issue.html
vendored
Normal file
@ -0,0 +1,21 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.generateIssue - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">Cash</a> / <a href=".">generateIssue</a><br/>
|
||||
<br/>
|
||||
<h1>generateIssue</h1>
|
||||
<a name="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="../-asset-issuance-definition/index.html"><span class="identifier">AssetIssuanceDefinition</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/pennies">pennies</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<p>Puts together an issuance transaction from the given template, that starts out being owned by the given pubkey.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<a name="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/amount">amount</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/at">at</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<p>Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
22
docs/build/html/api/com.r3corda.contracts.cash/-cash/generate-spend.html
vendored
Normal file
22
docs/build/html/api/com.r3corda.contracts.cash/-cash/generate-spend.html
vendored
Normal file
@ -0,0 +1,22 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.generateSpend - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">Cash</a> / <a href=".">generateSpend</a><br/>
|
||||
<br/>
|
||||
<h1>generateSpend</h1>
|
||||
<a name="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateSpend</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/amount">amount</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/to">to</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/cashStates">cashStates</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/onlyFromParties">onlyFromParties</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">></span></code><br/>
|
||||
<p>Generate a transaction that consumes one or more of the given input states to move money to the given pubkey.
|
||||
Note that the wallet list is not updated: its up to you to do that.</p>
|
||||
<h3>Parameters</h3>
|
||||
<a name="onlyFromParties"></a>
|
||||
<code>onlyFromParties</code> - if non-null, the wallet will be filtered to only include cash states issued by the set
|
||||
of given parties. This can be useful if the party youre trying to pay has expectations
|
||||
about which type of cash claims they are willing to accept.<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
109
docs/build/html/api/com.r3corda.contracts.cash/-cash/index.html
vendored
Normal file
109
docs/build/html/api/com.r3corda.contracts.cash/-cash/index.html
vendored
Normal file
@ -0,0 +1,109 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href=".">Cash</a><br/>
|
||||
<br/>
|
||||
<h1>Cash</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<p>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 couldnt merge outputs of two colours together, but you COULD put them in
|
||||
the same transaction.</p>
|
||||
<p>The goal of this design is to ensure that money can be withdrawn from the ledger easily: if you receive some money
|
||||
via this contract, you always know where to go in order to extract it from the R3 ledger, no matter how many hands
|
||||
it has passed through in the intervening time.</p>
|
||||
<p>At the same time, other contracts that just want money and dont care much who is currently holding it in their
|
||||
vaults can ignore the issuer/depositRefs and just examine the amount fields.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-commands/index.html">Commands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-issuance-definition/index.html">IssuanceDefinition</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">IssuanceDefinition</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../-asset-issuance-definition/index.html"><span class="identifier">AssetIssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <a href="../-fungible-asset/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>A state representing a cash claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Cash</span><span class="symbol">(</span><span class="symbol">)</span></code><p>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 couldnt merge outputs of two colours together, but you COULD put them in
|
||||
the same transaction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="legal-contract-reference.html">legalContractReference</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">legalContractReference</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>TODO:</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="generate-issue.html">generateIssue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="../-asset-issuance-definition/index.html"><span class="identifier">AssetIssuanceDefinition</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/pennies">pennies</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.AssetIssuanceDefinition((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Puts together an issuance transaction from the given template, that starts out being owned by the given pubkey.</p>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/amount">amount</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/at">at</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="generate-spend.html">generateSpend</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateSpend</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/amount">amount</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/to">to</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/cashStates">cashStates</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.cash.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.cash.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/onlyFromParties">onlyFromParties</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">></span></code><p>Generate a transaction that consumes one or more of the given input states to move money to the given pubkey.
|
||||
Note that the wallet list is not updated: its up to you to do that.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fungible-asset/verify.html">verify</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.FungibleAsset$verify(com.r3corda.core.contracts.TransactionForVerification)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-verification/index.html"><span class="identifier">TransactionForVerification</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>This is the function EVERYONE runs</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -4,10 +4,10 @@
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">Cash</a> / <a href=".">legalContractReference</a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">Cash</a> / <a href=".">legalContractReference</a><br/>
|
||||
<br/>
|
||||
<h1>legalContractReference</h1>
|
||||
<a name="com.r3corda.contracts.Cash$legalContractReference"></a>
|
||||
<a name="com.r3corda.contracts.cash.Cash$legalContractReference"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">legalContractReference</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><br/>
|
||||
Overrides <a href="../../com.r3corda.core.contracts/-contract/legal-contract-reference.html">Contract.legalContractReference</a><br/>
|
||||
<p>TODO:</p>
|
||||
@ -1,14 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>CommonCashState.amount - </title>
|
||||
<title>FungibleAssetState.amount - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">CommonCashState</a> / <a href=".">amount</a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">FungibleAssetState</a> / <a href=".">amount</a><br/>
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.cash.CommonCashState$amount"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a></code><br/>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAssetState$amount"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
@ -1,13 +1,13 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>CommonCashState.deposit - </title>
|
||||
<title>FungibleAssetState.deposit - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">CommonCashState</a> / <a href=".">deposit</a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">FungibleAssetState</a> / <a href=".">deposit</a><br/>
|
||||
<br/>
|
||||
<h1>deposit</h1>
|
||||
<a name="com.r3corda.contracts.cash.CommonCashState$deposit"></a>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAssetState$deposit"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><br/>
|
||||
<p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
<br/>
|
||||
@ -1,13 +1,13 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>CommonCashState - </title>
|
||||
<title>FungibleAssetState - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href=".">CommonCashState</a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href=".">FungibleAssetState</a><br/>
|
||||
<br/>
|
||||
<h1>CommonCashState</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">CommonCashState</span><span class="symbol"><</span><span class="identifier">I</span> <span class="symbol">:</span> <a href="../-cash-issuance-definition/index.html"><span class="identifier">CashIssuanceDefinition</span></a><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-ownable-state/index.html"><span class="identifier">OwnableState</span></a></code><br/>
|
||||
<h1>FungibleAssetState</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">FungibleAssetState</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">, </span><span class="identifier">I</span> <span class="symbol">:</span> <a href="../-asset-issuance-definition/index.html"><span class="identifier">AssetIssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-ownable-state/index.html"><span class="identifier">OwnableState</span></a></code><br/>
|
||||
<p>Common elements of cash contract states.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
@ -18,7 +18,7 @@
|
||||
<td>
|
||||
<a href="amount.html">amount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a></code></td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -82,9 +82,9 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts/-cash/-state/index.html">State</a></td>
|
||||
<a href="../-fungible-asset/-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <span class="identifier">CommonCashState</span><span class="symbol"><</span><a href="../../com.r3corda.contracts/-cash/-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol">></span></code><p>A state representing a cash claim against some party</p>
|
||||
<code><span class="keyword">interface </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">FungibleAssetState</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">,</span> <a href="../-asset-issuance-definition/index.html"><span class="identifier">AssetIssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><p>A state representing a claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -1,13 +1,13 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>CommonCashState.issuanceDef - </title>
|
||||
<title>FungibleAssetState.issuanceDef - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">CommonCashState</a> / <a href=".">issuanceDef</a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">FungibleAssetState</a> / <a href=".">issuanceDef</a><br/>
|
||||
<br/>
|
||||
<h1>issuanceDef</h1>
|
||||
<a name="com.r3corda.contracts.cash.CommonCashState$issuanceDef"></a>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAssetState$issuanceDef"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><span class="identifier">I</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
15
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-exit/amount.html
vendored
Normal file
15
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-exit/amount.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.Commands.Exit.amount - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">FungibleAsset</a> / <a href="../index.html">Commands</a> / <a href="index.html">Exit</a> / <a href=".">amount</a><br/>
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAsset.Commands.Exit$amount"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
40
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-exit/index.html
vendored
Normal file
40
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-exit/index.html
vendored
Normal file
@ -0,0 +1,40 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.Commands.Exit - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">FungibleAsset</a> / <a href="../index.html">Commands</a> / <a href=".">Exit</a><br/>
|
||||
<br/>
|
||||
<h1>Exit</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Exit</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="amount.html">amount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../-cash/-commands/-exit/index.html">Exit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span> <span class="symbol">:</span> <a href="../../../-cash/-commands/index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><span class="identifier">Exit</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
40
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-issue/index.html
vendored
Normal file
40
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-issue/index.html
vendored
Normal file
@ -0,0 +1,40 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.Commands.Issue - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">FungibleAsset</a> / <a href="../index.html">Commands</a> / <a href=".">Issue</a><br/>
|
||||
<br/>
|
||||
<h1>Issue</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<p>Allows new asset states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="nonce.html">nonce</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">nonce</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../-cash/-commands/-issue/index.html">Issue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <span class="identifier">Issue</span></code><p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-issue/nonce.html
vendored
Normal file
15
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-issue/nonce.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.Commands.Issue.nonce - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts.cash</a> / <a href="../../index.html">FungibleAsset</a> / <a href="../index.html">Commands</a> / <a href="index.html">Issue</a> / <a href=".">nonce</a><br/>
|
||||
<br/>
|
||||
<h1>nonce</h1>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAsset.Commands.Issue$nonce"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">nonce</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
25
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-move.html
vendored
Normal file
25
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/-move.html
vendored
Normal file
@ -0,0 +1,25 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.Commands.Move - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">FungibleAsset</a> / <a href="index.html">Commands</a> / <a href=".">Move</a><br/>
|
||||
<br/>
|
||||
<h1>Move</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Move</span> <span class="symbol">:</span> <a href="index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-cash/-commands/-move/index.html">Move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Move</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
68
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/index.html
vendored
Normal file
68
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-commands/index.html
vendored
Normal file
@ -0,0 +1,68 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.Commands - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">FungibleAsset</a> / <a href=".">Commands</a><br/>
|
||||
<br/>
|
||||
<h1>Commands</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-exit/index.html">Exit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Exit</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-issue/index.html">Issue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Issue</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>Allows new asset states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-move.html">Move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Move</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-exit/index.html">Exit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Exit</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-issue/index.html">Issue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Issue</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>Allows new asset states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-move.html">Move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Move</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
27
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-init-.html
vendored
Normal file
27
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-init-.html
vendored
Normal file
@ -0,0 +1,27 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">FungibleAsset</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">FungibleAsset</span><span class="symbol">(</span><span class="symbol">)</span></code><br/>
|
||||
<p>Superclass for contracts representing assets which are fungible, countable and issued by a specific party. States
|
||||
contain assets which are equivalent (such as cash of the same currency), so records of their existence can
|
||||
be merged or split as needed where the issuer is the same. For instance, dollars issued by the Fed are fungible and
|
||||
countable (in cents), barrels of West Texas crude are fungible and countable (oil from two small containers
|
||||
can be poured into one large container), shares of the same class in a specific company are fungible and
|
||||
countable, and so on.</p>
|
||||
<p>See <a href="../-cash/index.html">Cash</a> for an example subclass that implements currency.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Parameters</h3>
|
||||
<a name="T"></a>
|
||||
<code>T</code> - a type that represents the asset in question. This should describe the basic type of the asset
|
||||
(GBP, USD, oil, shares in company , etc.) and any additional metadata (issuer, grade, class, etc.)<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/amount.html
vendored
Normal file
16
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/amount.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.State.amount - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">FungibleAsset</a> / <a href="index.html">State</a> / <a href=".">amount</a><br/>
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAsset.State$amount"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../-fungible-asset-state/amount.html">FungibleAssetState.amount</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/deposit.html
vendored
Normal file
17
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/deposit.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.State.deposit - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">FungibleAsset</a> / <a href="index.html">State</a> / <a href=".">deposit</a><br/>
|
||||
<br/>
|
||||
<h1>deposit</h1>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAsset.State$deposit"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><br/>
|
||||
Overrides <a href="../../-fungible-asset-state/deposit.html">FungibleAssetState.deposit</a><br/>
|
||||
<p>Where the underlying asset backing this ledger entry can be found (propagated)</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
70
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/index.html
vendored
Normal file
70
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/index.html
vendored
Normal file
@ -0,0 +1,70 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.State - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">FungibleAsset</a> / <a href=".">State</a><br/>
|
||||
<br/>
|
||||
<h1>State</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../-fungible-asset-state/index.html"><span class="identifier">FungibleAssetState</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">,</span> <a href="../../-asset-issuance-definition/index.html"><span class="identifier">AssetIssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<p>A state representing a claim against some party</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="amount.html">amount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="deposit.html">deposit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying asset backing this ledger entry can be found (propagated)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="notary.html">notary</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">notary</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code><p>Identity of the notary that ensures this state is not used as an input to a transaction more than once</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="owner.html">owner</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">owner</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a></code><p>There must be a MoveCommand signed by this key to claim the amount</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-fungible-asset-state/issuance-def.html">issuanceDef</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><span class="identifier">I</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-cash/-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <span class="identifier">State</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>A state representing a cash claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/notary.html
vendored
Normal file
17
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/notary.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.State.notary - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">FungibleAsset</a> / <a href="index.html">State</a> / <a href=".">notary</a><br/>
|
||||
<br/>
|
||||
<h1>notary</h1>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAsset.State$notary"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">notary</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-contract-state/notary.html">ContractState.notary</a><br/>
|
||||
<p>Identity of the notary that ensures this state is not used as an input to a transaction more than once</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/owner.html
vendored
Normal file
17
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/-state/owner.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.State.owner - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts.cash</a> / <a href="../index.html">FungibleAsset</a> / <a href="index.html">State</a> / <a href=".">owner</a><br/>
|
||||
<br/>
|
||||
<h1>owner</h1>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAsset.State$owner"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">owner</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-ownable-state/owner.html">OwnableState.owner</a><br/>
|
||||
<p>There must be a MoveCommand signed by this key to claim the amount</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
102
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/index.html
vendored
Normal file
102
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/index.html
vendored
Normal file
@ -0,0 +1,102 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href=".">FungibleAsset</a><br/>
|
||||
<br/>
|
||||
<h1>FungibleAsset</h1>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">FungibleAsset</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><br/>
|
||||
<p>Superclass for contracts representing assets which are fungible, countable and issued by a specific party. States
|
||||
contain assets which are equivalent (such as cash of the same currency), so records of their existence can
|
||||
be merged or split as needed where the issuer is the same. For instance, dollars issued by the Fed are fungible and
|
||||
countable (in cents), barrels of West Texas crude are fungible and countable (oil from two small containers
|
||||
can be poured into one large container), shares of the same class in a specific company are fungible and
|
||||
countable, and so on.</p>
|
||||
<p>See <a href="../-cash/index.html">Cash</a> for an example subclass that implements currency.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Parameters</h3>
|
||||
<a name="T"></a>
|
||||
<code>T</code> - a type that represents the asset in question. This should describe the basic type of the asset
|
||||
(GBP, USD, oil, shares in company , etc.) and any additional metadata (issuer, grade, class, etc.)<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-commands/index.html">Commands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../-fungible-asset-state/index.html"><span class="identifier">FungibleAssetState</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">,</span> <a href="../-asset-issuance-definition/index.html"><span class="identifier">AssetIssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><p>A state representing a claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">FungibleAsset</span><span class="symbol">(</span><span class="symbol">)</span></code><p>Superclass for contracts representing assets which are fungible, countable and issued by a specific party. States
|
||||
contain assets which are equivalent (such as cash of the same currency), so records of their existence can
|
||||
be merged or split as needed where the issuer is the same. For instance, dollars issued by the Fed are fungible and
|
||||
countable (in cents), barrels of West Texas crude are fungible and countable (oil from two small containers
|
||||
can be poured into one large container), shares of the same class in a specific company are fungible and
|
||||
countable, and so on.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.core.contracts/-contract/legal-contract-reference.html">legalContractReference</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">legalContractReference</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
|
||||
the contracts contents).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="verify.html">verify</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.FungibleAsset$verify(com.r3corda.core.contracts.TransactionForVerification)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-verification/index.html"><span class="identifier">TransactionForVerification</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>This is the function EVERYONE runs</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-cash/index.html">Cash</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <span class="identifier">FungibleAsset</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>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 couldnt merge outputs of two colours together, but you COULD put them in
|
||||
the same transaction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/verify.html
vendored
Normal file
17
docs/build/html/api/com.r3corda.contracts.cash/-fungible-asset/verify.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FungibleAsset.verify - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">FungibleAsset</a> / <a href=".">verify</a><br/>
|
||||
<br/>
|
||||
<h1>verify</h1>
|
||||
<a name="com.r3corda.contracts.cash.FungibleAsset$verify(com.r3corda.core.contracts.TransactionForVerification)"></a>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.FungibleAsset$verify(com.r3corda.core.contracts.TransactionForVerification)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-verification/index.html"><span class="identifier">TransactionForVerification</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
Overrides <a href="../../com.r3corda.core.contracts/-contract/verify.html">Contract.verify</a><br/>
|
||||
<p>This is the function EVERYONE runs</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/com.r3corda.contracts.cash/-insufficient-balance-exception/-init-.html
vendored
Normal file
14
docs/build/html/api/com.r3corda.contracts.cash/-insufficient-balance-exception/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>InsufficientBalanceException.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">InsufficientBalanceException</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">InsufficientBalanceException</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.InsufficientBalanceException$<init>(com.r3corda.core.contracts.Amount((kotlin.Any)))/amountMissing">amountMissing</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>InsufficientBalanceException.amountMissing - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">InsufficientBalanceException</a> / <a href=".">amountMissing</a><br/>
|
||||
<br/>
|
||||
<h1>amountMissing</h1>
|
||||
<a name="com.r3corda.contracts.cash.InsufficientBalanceException$amountMissing"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">amountMissing</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -4,7 +4,7 @@
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href=".">InsufficientBalanceException</a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href=".">InsufficientBalanceException</a><br/>
|
||||
<br/>
|
||||
<h1>InsufficientBalanceException</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">InsufficientBalanceException</span> <span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html"><span class="identifier">Exception</span></a></code><br/>
|
||||
@ -17,7 +17,7 @@
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">InsufficientBalanceException</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InsufficientBalanceException$<init>(com.r3corda.core.contracts.Amount)/amountMissing">amountMissing</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">)</span></code></td>
|
||||
<code><span class="identifier">InsufficientBalanceException</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash.InsufficientBalanceException$<init>(com.r3corda.core.contracts.Amount((kotlin.Any)))/amountMissing">amountMissing</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -28,7 +28,7 @@
|
||||
<td>
|
||||
<a href="amount-missing.html">amountMissing</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">amountMissing</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a></code></td>
|
||||
<code><span class="keyword">val </span><span class="identifier">amountMissing</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -12,19 +12,74 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-cash-issuance-definition/index.html">CashIssuanceDefinition</a></td>
|
||||
<a href="-asset-issuance-definition/index.html">AssetIssuanceDefinition</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">CashIssuanceDefinition</span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-issuance-definition.html"><span class="identifier">IssuanceDefinition</span></a></code><p>Subset of cash-like contract state, containing the issuance definition. If these definitions match for two
|
||||
<code><span class="keyword">interface </span><span class="identifier">AssetIssuanceDefinition</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-issuance-definition.html"><span class="identifier">IssuanceDefinition</span></a></code><p>Subset of cash-like contract state, containing the issuance definition. If these definitions match for two
|
||||
contracts states, those states can be aggregated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-common-cash-state/index.html">CommonCashState</a></td>
|
||||
<a href="-cash/index.html">Cash</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">CommonCashState</span><span class="symbol"><</span><span class="identifier">I</span> <span class="symbol">:</span> <a href="-cash-issuance-definition/index.html"><span class="identifier">CashIssuanceDefinition</span></a><span class="symbol">></span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-ownable-state/index.html"><span class="identifier">OwnableState</span></a></code><p>Common elements of cash contract states.</p>
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <a href="-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>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 couldnt merge outputs of two colours together, but you COULD put them in
|
||||
the same transaction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-fungible-asset/index.html">FungibleAsset</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">FungibleAsset</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><p>Superclass for contracts representing assets which are fungible, countable and issued by a specific party. States
|
||||
contain assets which are equivalent (such as cash of the same currency), so records of their existence can
|
||||
be merged or split as needed where the issuer is the same. For instance, dollars issued by the Fed are fungible and
|
||||
countable (in cents), barrels of West Texas crude are fungible and countable (oil from two small containers
|
||||
can be poured into one large container), shares of the same class in a specific company are fungible and
|
||||
countable, and so on.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-fungible-asset-state/index.html">FungibleAssetState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">FungibleAssetState</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">, </span><span class="identifier">I</span> <span class="symbol">:</span> <a href="-asset-issuance-definition/index.html"><span class="identifier">AssetIssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-ownable-state/index.html"><span class="identifier">OwnableState</span></a></code><p>Common elements of cash contract states.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Exceptions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-insufficient-balance-exception/index.html">InsufficientBalanceException</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">InsufficientBalanceException</span> <span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html"><span class="identifier">Exception</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Extensions for External Classes</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="kotlin.collections.-iterable/index.html">kotlin.collections.Iterable</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-c-a-s-h_-p-r-o-g-r-a-m_-i-d.html">CASH_PROGRAM_ID</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">CASH_PROGRAM_ID</span><span class="symbol">: </span><a href="-cash/index.html"><span class="identifier">Cash</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
|
||||
77
docs/build/html/api/com.r3corda.contracts.cash/kotlin.collections.-iterable/index.html
vendored
Normal file
77
docs/build/html/api/com.r3corda.contracts.cash/kotlin.collections.-iterable/index.html
vendored
Normal file
@ -0,0 +1,77 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>com.r3corda.contracts.cash.kotlin.collections.Iterable - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href=".">kotlin.collections.Iterable</a><br/>
|
||||
<br/>
|
||||
<h3>Extensions for kotlin.collections.Iterable</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-cash.html">sumCash</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumCash</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the cash states in the list, throwing an exception if there are none, or if any of the cash
|
||||
states cannot be added together (i.e. are different currencies).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-cash-by.html">sumCashBy</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumCashBy</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash$sumCashBy(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the cash states in the list belonging to a single owner, throwing an exception
|
||||
if there are none, or if any of the cash states cannot be added together (i.e. are
|
||||
different currencies).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-cash-or-null.html">sumCashOrNull</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumCashOrNull</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the cash states in the list, returning null if there are none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-cash-or-zero.html">sumCashOrZero</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumCashOrZero</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash$sumCashOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.util.Currency)/currency">currency</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the cash states in the list, returning zero of the given currency if there are none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-fungible.html">sumFungible</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungible</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the asset states in the list, throwing an exception if there are none, or if any of the asset
|
||||
states cannot be added together (i.e. are different tokens).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-fungible-by.html">sumFungibleBy</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungibleBy</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash$sumFungibleBy(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the asset states in the list belonging to a single owner, throwing an exception
|
||||
if there are none, or if any of the asset states cannot be added together (i.e. are
|
||||
different tokens).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-fungible-or-null.html">sumFungibleOrNull</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungibleOrNull</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the asset states in the list, returning null if there are none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-fungible-or-zero.html">sumFungibleOrZero</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungibleOrZero</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash$sumFungibleOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), com.r3corda.contracts.cash.sumFungibleOrZero.T)/token">token</span><span class="symbol">:</span> <span class="identifier">T</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the asset states in the list, returning zero of the given token if there are none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
18
docs/build/html/api/com.r3corda.contracts.cash/kotlin.collections.-iterable/sum-cash-by.html
vendored
Normal file
18
docs/build/html/api/com.r3corda.contracts.cash/kotlin.collections.-iterable/sum-cash-by.html
vendored
Normal file
@ -0,0 +1,18 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>sumCashBy - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumCashBy</a><br/>
|
||||
<br/>
|
||||
<h1>sumCashBy</h1>
|
||||
<a name="com.r3corda.contracts.cash$sumCashBy(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumCashBy</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash$sumCashBy(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>Sums the cash states in the list belonging to a single owner, throwing an exception
|
||||
if there are none, or if any of the cash states cannot be added together (i.e. are
|
||||
different currencies).</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -4,10 +4,10 @@
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumCashOrNull</a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumCashOrNull</a><br/>
|
||||
<br/>
|
||||
<h1>sumCashOrNull</h1>
|
||||
<a name="com.r3corda.contracts$sumCashOrNull(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)))"></a>
|
||||
<a name="com.r3corda.contracts.cash$sumCashOrNull(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumCashOrNull</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>Sums the cash states in the list, returning null if there are none.</p>
|
||||
<br/>
|
||||
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>sumCashOrZero - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumCashOrZero</a><br/>
|
||||
<br/>
|
||||
<h1>sumCashOrZero</h1>
|
||||
<a name="com.r3corda.contracts.cash$sumCashOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.util.Currency)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumCashOrZero</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash$sumCashOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.util.Currency)/currency">currency</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>Sums the cash states in the list, returning zero of the given currency if there are none.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -4,12 +4,13 @@
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumCash</a><br/>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumCash</a><br/>
|
||||
<br/>
|
||||
<h1>sumCash</h1>
|
||||
<a name="com.r3corda.contracts$sumCash(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)))"></a>
|
||||
<a name="com.r3corda.contracts.cash$sumCash(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumCash</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>Sums the cash states in the list, throwing an exception if there are none.</p>
|
||||
<p>Sums the cash states in the list, throwing an exception if there are none, or if any of the cash
|
||||
states cannot be added together (i.e. are different currencies).</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
18
docs/build/html/api/com.r3corda.contracts.cash/kotlin.collections.-iterable/sum-fungible-by.html
vendored
Normal file
18
docs/build/html/api/com.r3corda.contracts.cash/kotlin.collections.-iterable/sum-fungible-by.html
vendored
Normal file
@ -0,0 +1,18 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>sumFungibleBy - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumFungibleBy</a><br/>
|
||||
<br/>
|
||||
<h1>sumFungibleBy</h1>
|
||||
<a name="com.r3corda.contracts.cash$sumFungibleBy(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungibleBy</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash$sumFungibleBy(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>Sums the asset states in the list belonging to a single owner, throwing an exception
|
||||
if there are none, or if any of the asset states cannot be added together (i.e. are
|
||||
different tokens).</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>sumFungibleOrNull - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumFungibleOrNull</a><br/>
|
||||
<br/>
|
||||
<h1>sumFungibleOrNull</h1>
|
||||
<a name="com.r3corda.contracts.cash$sumFungibleOrNull(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungibleOrNull</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>Sums the asset states in the list, returning null if there are none.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>sumFungibleOrZero - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumFungibleOrZero</a><br/>
|
||||
<br/>
|
||||
<h1>sumFungibleOrZero</h1>
|
||||
<a name="com.r3corda.contracts.cash$sumFungibleOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), com.r3corda.contracts.cash.sumFungibleOrZero.T)"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungibleOrZero</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.cash$sumFungibleOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), com.r3corda.contracts.cash.sumFungibleOrZero.T)/token">token</span><span class="symbol">:</span> <span class="identifier">T</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>Sums the asset states in the list, returning zero of the given token if there are none.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/com.r3corda.contracts.cash/kotlin.collections.-iterable/sum-fungible.html
vendored
Normal file
17
docs/build/html/api/com.r3corda.contracts.cash/kotlin.collections.-iterable/sum-fungible.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>sumFungible - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.cash</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumFungible</a><br/>
|
||||
<br/>
|
||||
<h1>sumFungible</h1>
|
||||
<a name="com.r3corda.contracts.cash$sumFungible(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungible</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>Sums the asset states in the list, throwing an exception if there are none, or if any of the asset
|
||||
states cannot be added together (i.e. are different tokens).</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="index.html">com.r3corda.contracts.testing</a> / <a href=".">CASH</a><br/>
|
||||
<br/>
|
||||
<h1>CASH</h1>
|
||||
<a name="com.r3corda.contracts.testing$CASH#com.r3corda.core.contracts.Amount"></a>
|
||||
<code><span class="keyword">val </span><a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">.</span><span class="identifier">CASH</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<a name="com.r3corda.contracts.testing$CASH#com.r3corda.core.contracts.Amount((java.util.Currency))"></a>
|
||||
<code><span class="keyword">val </span><a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">CASH</span><span class="symbol">: </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<br/>
|
||||
<h1>generateState</h1>
|
||||
<a name="com.r3corda.contracts.testing$generateState(com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateState</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$generateState(com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a> <span class="symbol">=</span> DUMMY_NOTARY<span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-dummy-contract/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateState</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$generateState(com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a> <span class="symbol">=</span> DUMMY_NOTARY<span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.core.contracts/-dummy-contract/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
<td>
|
||||
<a href="-c-a-s-h.html">CASH</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">.</span><span class="identifier">CASH</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a></code></td>
|
||||
<code><span class="keyword">val </span><a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">CASH</span><span class="symbol">: </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -31,19 +31,19 @@
|
||||
<td>
|
||||
<a href="generate-state.html">generateState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateState</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$generateState(com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a> <span class="symbol">=</span> DUMMY_NOTARY<span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-dummy-contract/-state/index.html"><span class="identifier">State</span></a></code></td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateState</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$generateState(com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a> <span class="symbol">=</span> DUMMY_NOTARY<span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.core.contracts/-dummy-contract/-state/index.html"><span class="identifier">State</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="issued by.html">issued by</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">issued by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$issued by(com.r3corda.contracts.Cash.State, com.r3corda.core.crypto.Party)/party">party</span><span class="symbol">:</span> <a href="../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a></code></td>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">issued by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$issued by(com.r3corda.contracts.cash.Cash.State, com.r3corda.core.crypto.Party)/party">party</span><span class="symbol">:</span> <a href="../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="owned by.html">owned by</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">owned by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.Cash.State, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">owned by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.cash.Cash.State, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts/-commercial-paper/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">owned by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.CommercialPaper.State, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-commercial-paper/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="identifier"><ERROR CLASS></span><span class="symbol">.</span><span class="identifier">owned by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$owned by(, java.security.PublicKey)/new_owner">new_owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code></td>
|
||||
</tr>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="index.html">com.r3corda.contracts.testing</a> / <a href=".">issued by</a><br/>
|
||||
<br/>
|
||||
<h1>issued by</h1>
|
||||
<a name="com.r3corda.contracts.testing$issued by(com.r3corda.contracts.Cash.State, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">issued by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$issued by(com.r3corda.contracts.Cash.State, com.r3corda.core.crypto.Party)/party">party</span><span class="symbol">:</span> <a href="../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<a name="com.r3corda.contracts.testing$issued by(com.r3corda.contracts.cash.Cash.State, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">issued by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$issued by(com.r3corda.contracts.cash.Cash.State, com.r3corda.core.crypto.Party)/party">party</span><span class="symbol">:</span> <a href="../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="index.html">com.r3corda.contracts.testing</a> / <a href=".">owned by</a><br/>
|
||||
<br/>
|
||||
<h1>owned by</h1>
|
||||
<a name="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.Cash.State, java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">owned by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.Cash.State, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-cash/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<a name="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.cash.Cash.State, java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">owned by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.cash.Cash.State, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts.cash/-cash/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<a name="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.CommercialPaper.State, java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><a href="../com.r3corda.contracts/-commercial-paper/-state/index.html"><span class="identifier">State</span></a><span class="symbol">.</span><span class="identifier">owned by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.CommercialPaper.State, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../com.r3corda.contracts/-commercial-paper/-state/index.html"><span class="identifier">State</span></a></code><br/>
|
||||
<a name="com.r3corda.contracts.testing$owned by(, java.security.PublicKey)"></a>
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>CROWDFUND_PROGRAM_ID - </title>
|
||||
<link rel="stylesheet" href="../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="index.html">com.r3corda.contracts</a> / <a href=".">CROWDFUND_PROGRAM_ID</a><br/>
|
||||
<br/>
|
||||
<h1>CROWDFUND_PROGRAM_ID</h1>
|
||||
<a name="com.r3corda.contracts$CROWDFUND_PROGRAM_ID"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">CROWDFUND_PROGRAM_ID</span><span class="symbol">: </span><a href="-crowd-fund/index.html"><span class="identifier">CrowdFund</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,16 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Exit.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Exit</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.Commands.Exit$<init>(com.r3corda.core.contracts.Amount)/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,15 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Exit.amount - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Exit</a> / <a href=".">amount</a><br/>
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.Cash.Commands.Exit$amount"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,40 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Exit - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href=".">Exit</a><br/>
|
||||
<br/>
|
||||
<h1>Exit</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.Commands.Exit$<init>(com.r3corda.core.contracts.Amount)/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">)</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
in some other way.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="amount.html">amount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,16 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Issue.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Issue</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.Commands.Issue$<init>(kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> SecureRandom.getInstanceStrong().nextLong()<span class="symbol">)</span></code><br/>
|
||||
<p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,15 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.Commands.Issue.nonce - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">Cash</a> / <a href="../index.html">Commands</a> / <a href="index.html">Issue</a> / <a href=".">nonce</a><br/>
|
||||
<br/>
|
||||
<h1>nonce</h1>
|
||||
<a name="com.r3corda.contracts.Cash.Commands.Issue$nonce"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">nonce</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,14 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.IssuanceDefinition.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">IssuanceDefinition</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">IssuanceDefinition</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.IssuanceDefinition$<init>(com.r3corda.core.contracts.PartyAndReference, java.util.Currency)/deposit">deposit</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash.IssuanceDefinition$<init>(com.r3corda.core.contracts.PartyAndReference, java.util.Currency)/currency">currency</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,16 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.IssuanceDefinition.currency - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">IssuanceDefinition</a> / <a href=".">currency</a><br/>
|
||||
<br/>
|
||||
<h1>currency</h1>
|
||||
<a name="com.r3corda.contracts.Cash.IssuanceDefinition$currency"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">currency</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.contracts.cash/-cash-issuance-definition/currency.html">CashIssuanceDefinition.currency</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,43 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.IssuanceDefinition - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href=".">IssuanceDefinition</a><br/>
|
||||
<br/>
|
||||
<h1>IssuanceDefinition</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">IssuanceDefinition</span> <span class="symbol">:</span> <a href="../../../com.r3corda.contracts.cash/-cash-issuance-definition/index.html"><span class="identifier">CashIssuanceDefinition</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">IssuanceDefinition</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.IssuanceDefinition$<init>(com.r3corda.core.contracts.PartyAndReference, java.util.Currency)/deposit">deposit</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash.IssuanceDefinition$<init>(com.r3corda.core.contracts.PartyAndReference, java.util.Currency)/currency">currency</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="currency.html">currency</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">currency</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="deposit.html">deposit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,15 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.security.PublicKey, com.r3corda.core.crypto.Party)/deposit">deposit</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.security.PublicKey, com.r3corda.core.crypto.Party)/amount">amount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>A state representing a cash claim against some party</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,16 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State.amount - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">amount</a><br/>
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.Cash.State$amount"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.contracts.cash/-common-cash-state/amount.html">CommonCashState.amount</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,107 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href=".">State</a><br/>
|
||||
<br/>
|
||||
<h1>State</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <a href="../../../com.r3corda.contracts.cash/-common-cash-state/index.html"><span class="identifier">CommonCashState</span></a><span class="symbol"><</span><a href="../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol">></span></code><br/>
|
||||
<p>A state representing a cash claim against some party</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.security.PublicKey, com.r3corda.core.crypto.Party)/deposit">deposit</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.security.PublicKey, com.r3corda.core.crypto.Party)/amount">amount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash.State$<init>(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code><p>A state representing a cash claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="amount.html">amount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="contract.html">contract</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">contract</span><span class="symbol">: </span><a href="../index.html"><span class="identifier">Cash</span></a></code><p>Contract by which the state belongs</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="deposit.html">deposit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="issuance-def.html">issuanceDef</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="notary.html">notary</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">notary</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code><p>Identity of the notary that ensures this state is not used as an input to a transaction more than once</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="owner.html">owner</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">owner</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a></code><p>There must be a MoveCommand signed by this key to claim the amount</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="to-string.html">toString</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">toString</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="with-new-owner.html">withNewOwner</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withNewOwner</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.State$withNewOwner(java.security.PublicKey)/newOwner">newOwner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Extension Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.contracts.testing/issued by.html">issued by</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="identifier">State</span><span class="symbol">.</span><span class="identifier">issued by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$issued by(com.r3corda.contracts.Cash.State, com.r3corda.core.crypto.Party)/party">party</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">State</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.contracts.testing/owned by.html">owned by</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="identifier">State</span><span class="symbol">.</span><span class="identifier">owned by</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.testing$owned by(com.r3corda.contracts.Cash.State, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">State</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,16 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State.issuanceDef - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">issuanceDef</a><br/>
|
||||
<br/>
|
||||
<h1>issuanceDef</h1>
|
||||
<a name="com.r3corda.contracts.Cash.State$issuanceDef"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.contracts.cash/-common-cash-state/issuance-def.html">CommonCashState.issuanceDef</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,17 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State.notary - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">notary</a><br/>
|
||||
<br/>
|
||||
<h1>notary</h1>
|
||||
<a name="com.r3corda.contracts.Cash.State$notary"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">notary</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-contract-state/notary.html">ContractState.notary</a><br/>
|
||||
<p>Identity of the notary that ensures this state is not used as an input to a transaction more than once</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,17 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.State.withNewOwner - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">withNewOwner</a><br/>
|
||||
<br/>
|
||||
<h1>withNewOwner</h1>
|
||||
<a name="com.r3corda.contracts.Cash.State$withNewOwner(java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withNewOwner</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash.State$withNewOwner(java.security.PublicKey)/newOwner">newOwner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-ownable-state/with-new-owner.html">OwnableState.withNewOwner</a><br/>
|
||||
<p>Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,21 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.generateIssue - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">Cash</a> / <a href=".">generateIssue</a><br/>
|
||||
<br/>
|
||||
<h1>generateIssue</h1>
|
||||
<a name="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="../../com.r3corda.contracts.cash/-cash-issuance-definition/index.html"><span class="identifier">CashIssuanceDefinition</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/pennies">pennies</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<p>Puts together an issuance transaction from the given template, that starts out being owned by the given pubkey.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<a name="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/amount">amount</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/at">at</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<p>Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,22 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.generateSpend - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">Cash</a> / <a href=".">generateSpend</a><br/>
|
||||
<br/>
|
||||
<h1>generateSpend</h1>
|
||||
<a name="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateSpend</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/amount">amount</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/to">to</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/cashStates">cashStates</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/onlyFromParties">onlyFromParties</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">></span></code><br/>
|
||||
<p>Generate a transaction that consumes one or more of the given input states to move money to the given pubkey.
|
||||
Note that the wallet list is not updated: its up to you to do that.</p>
|
||||
<h3>Parameters</h3>
|
||||
<a name="onlyFromParties"></a>
|
||||
<code>onlyFromParties</code> - if non-null, the wallet will be filtered to only include cash states issued by the set
|
||||
of given parties. This can be useful if the party youre trying to pay has expectations
|
||||
about which type of cash claims they are willing to accept.<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,104 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href=".">Cash</a><br/>
|
||||
<br/>
|
||||
<h1>Cash</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><br/>
|
||||
<p>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 couldnt merge outputs of two colours together, but you COULD put them in
|
||||
the same transaction.</p>
|
||||
<p>The goal of this design is to ensure that money can be withdrawn from the ledger easily: if you receive some money
|
||||
via this contract, you always know where to go in order to extract it from the R3 ledger, no matter how many hands
|
||||
it has passed through in the intervening time.</p>
|
||||
<p>At the same time, other contracts that just want money and dont care much who is currently holding it in their
|
||||
vaults can ignore the issuer/depositRefs and just examine the amount fields.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-commands/index.html">Commands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-issuance-definition/index.html">IssuanceDefinition</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">IssuanceDefinition</span> <span class="symbol">:</span> <a href="../../com.r3corda.contracts.cash/-cash-issuance-definition/index.html"><span class="identifier">CashIssuanceDefinition</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <a href="../../com.r3corda.contracts.cash/-common-cash-state/index.html"><span class="identifier">CommonCashState</span></a><span class="symbol"><</span><a href="-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol">></span></code><p>A state representing a cash claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Cash</span><span class="symbol">(</span><span class="symbol">)</span></code><p>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 couldnt merge outputs of two colours together, but you COULD put them in
|
||||
the same transaction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="legal-contract-reference.html">legalContractReference</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">legalContractReference</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>TODO:</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="generate-issue.html">generateIssue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="../../com.r3corda.contracts.cash/-cash-issuance-definition/index.html"><span class="identifier">CashIssuanceDefinition</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/pennies">pennies</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.contracts.cash.CashIssuanceDefinition, kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Puts together an issuance transaction from the given template, that starts out being owned by the given pubkey.</p>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/amount">amount</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/at">at</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="generate-spend.html">generateSpend</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateSpend</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/amount">amount</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/to">to</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/cashStates">cashStates</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.Cash$generateSpend(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount, java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.Cash.State)))), kotlin.collections.Set((com.r3corda.core.crypto.Party)))/onlyFromParties">onlyFromParties</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">></span></code><p>Generate a transaction that consumes one or more of the given input states to move money to the given pubkey.
|
||||
Note that the wallet list is not updated: its up to you to do that.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="verify.html">verify</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash$verify(com.r3corda.core.contracts.TransactionForVerification)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-verification/index.html"><span class="identifier">TransactionForVerification</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>This is the function EVERYONE runs</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -1,17 +0,0 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.verify - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">Cash</a> / <a href=".">verify</a><br/>
|
||||
<br/>
|
||||
<h1>verify</h1>
|
||||
<a name="com.r3corda.contracts.Cash$verify(com.r3corda.core.contracts.TransactionForVerification)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.Cash$verify(com.r3corda.core.contracts.TransactionForVerification)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-verification/index.html"><span class="identifier">TransactionForVerification</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
Overrides <a href="../../com.r3corda.core.contracts/-contract/verify.html">Contract.verify</a><br/>
|
||||
<p>This is the function EVERYONE runs</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">CommercialPaper</a> / <a href="index.html">State</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/issuance">issuance</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/issuance">issuance</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<br/>
|
||||
<h1>faceValue</h1>
|
||||
<a name="com.r3corda.contracts.CommercialPaper.State$faceValue"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">faceValue</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a></code><br/>
|
||||
<code><span class="keyword">val </span><span class="identifier">faceValue</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/issuance">issuance</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code></td>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/issuance">issuance</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/owner">owner</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$<init>(com.r3corda.core.contracts.PartyAndReference, java.security.PublicKey, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -35,7 +35,7 @@
|
||||
<td>
|
||||
<a href="face-value.html">faceValue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">faceValue</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a></code></td>
|
||||
<code><span class="keyword">val </span><span class="identifier">faceValue</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -78,7 +78,7 @@
|
||||
<td>
|
||||
<a href="with-face-value.html">withFaceValue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withFaceValue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$withFaceValue(com.r3corda.core.contracts.Amount)/newFaceValue">newFaceValue</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code></td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withFaceValue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$withFaceValue(com.r3corda.core.contracts.Amount((java.util.Currency)))/newFaceValue">newFaceValue</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../../index.html">com.r3corda.contracts</a> / <a href="../index.html">CommercialPaper</a> / <a href="index.html">State</a> / <a href=".">withFaceValue</a><br/>
|
||||
<br/>
|
||||
<h1>withFaceValue</h1>
|
||||
<a name="com.r3corda.contracts.CommercialPaper.State$withFaceValue(com.r3corda.core.contracts.Amount)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withFaceValue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$withFaceValue(com.r3corda.core.contracts.Amount)/newFaceValue">newFaceValue</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<a name="com.r3corda.contracts.CommercialPaper.State$withFaceValue(com.r3corda.core.contracts.Amount((java.util.Currency)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withFaceValue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$withFaceValue(com.r3corda.core.contracts.Amount((java.util.Currency)))/newFaceValue">newFaceValue</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">CommercialPaper</a> / <a href=".">generateIssue</a><br/>
|
||||
<br/>
|
||||
<h1>generateIssue</h1>
|
||||
<a name="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/issuance">issuance</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount, java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a></code><br/>
|
||||
<a name="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/issuance">issuance</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((java.util.Currency)), java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a></code><br/>
|
||||
<p>Returns a transaction that issues commercial paper, owned by the issuing parties key. Does not update
|
||||
an existing transaction because you arent able to issue multiple pieces of CP in a single transaction
|
||||
at the moment: this restriction is not fundamental and may be lifted later.</p>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user