diff --git a/docs/build/html/api/alltypes/index.html b/docs/build/html/api/alltypes/index.html
new file mode 100644
index 0000000000..3cb9c2ed05
--- /dev/null
+++ b/docs/build/html/api/alltypes/index.html
@@ -0,0 +1,1501 @@
+
+
+alltypes -
+All Types
+
+
+
+
+core.utilities.ANSIProgressRenderer
+
+Knows how to render a ProgressTracker to the terminal using coloured, emoji-fied output. Useful when writing small
+command line tools, demos, tests etc. Just set the progressTracker field and it will go ahead and start drawing
+if the terminal supports it. Otherwise it just prints out the name of the step whenever it changes.
+
+
+
+
+api.APIServer
+
+Top level interface to external interaction with the distributed ledger.
+
+
+
+
+api.APIServerImpl
+
+
+
+
+
+core.node.AbstractNode
+
+A base node implementation that can be customised either for production (with real implementations that do real
+I/O), or a mock implementation suitable for unit test environments.
+
+
+
+
+core.node.services.AbstractNodeService
+
+Abstract superclass for services that a node can host, which provides helper functions.
+
+
+
+
+protocols.AbstractRequestMessage
+
+Abstract superclass for request messages sent to services, which includes common
+fields such as replyTo and replyToTopic.
+
+
+
+
+core.node.AcceptsFileUpload
+
+A service that implements AcceptsFileUpload can have new binary data provided to it via an HTTP upload.
+
+
+
+
+core.AccrualAdjustment
+
+Simple enum for returning accurals adjusted or unadjusted.
+We dont actually do anything with this yet though, so its ignored for now.
+
+
+
+
+core.utilities.AddOrRemove
+
+Enum for when adding/removing something, for example adding or removing an entry in a directory.
+
+
+
+
+core.utilities.AffinityExecutor
+
+An extended executor interface that supports thread affinity assertions and short circuiting. This can be useful
+for ensuring code runs on the right thread, and also for unit testing.
+
+
+
+
+core.messaging.AllPossibleRecipients
+
+A special base class for the set of all possible recipients, without having to identify who they all are.
+
+
+
+
+core.Amount
+
+Amount represents a positive quantity of currency, measured in pennies, which are the smallest representable units.
+
+
+
+
+core.node.subsystems.ArtemisMessagingService
+
+This class implements the MessagingService API using Apache Artemis, the successor to their ActiveMQ product.
+Artemis is a message queue broker and here, we embed the entire server inside our own process. Nodes communicate
+with each other using (by default) an Artemis specific protocol, but it supports other protocols like AQMP/1.0
+as well.
+
+
+
+
+core.Attachment
+
+An attachment is a ZIP (or an optionally signed JAR) that contains one or more files. Attachments are meant to
+contain public static data which can be referenced from transactions and utilised from contracts. Good examples
+of how attachments are meant to be used include:
+
+
+
+
+core.node.servlets.AttachmentDownloadServlet
+
+Allows the node administrator to either download full attachment zips, or individual files within those zips.
+
+
+
+
+core.node.services.AttachmentStorage
+
+An attachment store records potentially large binary objects, identified by their hash. Note that attachments are
+immutable and can never be erased once inserted
+
+
+
+
+core.node.AttachmentsClassLoader
+
+A custom ClassLoader that knows how to load classes from a set of attachments. The attachments themselves only
+need to provide JAR streams, and so could be fetched from a database, local disk, etc. Constructing an
+AttachmentsClassLoader is somewhat expensive, as every attachment is scanned to ensure that there are no overlapping
+file paths.
+
+
+
+
+core.AuthenticatedObject
+
+Wraps an object that was signed by a public key, which may be a well known/recognised institutional key.
+
+
+
+
+demos.protocols.AutoOfferProtocol
+
+This whole class is really part of a demo just to initiate the agreement of a deal with a simple
+API call from a single party without bi-directional access to the database of offers etc.
+
+
+
+
+core.utilities.BriefLogFormatter
+
+A Java logging formatter that writes more compact output than the default.
+
+
+
+
+core.BusinessCalendar
+
+A business calendar performs date calculations that take into account national holidays and weekends. This is a
+typical feature of financial contracts, in which a business may not want a payment event to fall on a day when
+no staff are around to handle problems.
+
+
+
+
+kotlin.ByteArray (extensions in package core.crypto)
+
+
+
+
+
+kotlin.ByteArray (extensions in package core.serialization)
+
+
+
+
+
+contracts.Cash
+
+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.
+
+
+
+
+core.node.CityDatabase
+
+A simple lookup table of city names to their coordinates. Lookups are case insensitive.
+
+
+
+
+core.Command
+
+Command data/content plus pubkey pair: the signature is stored at the end of the serialized bytes
+
+
+
+
+core.CommandData
+
+Marker interface for classes that represent commands
+
+
+
+
+contracts.CommercialPaper
+
+
+
+
+
+api.Config
+
+Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
+and to organise serializers / deserializers for java.time.* classes as necessary
+
+
+
+
+core.node.ConfigurationException
+
+
+
+
+
+core.Contract
+
+Implemented by a program that implements business logic on the shared ledger. All participants run this code for
+every LedgerTransaction they see on the network, for every input and output state. All contracts must accept the
+transaction for it to be accepted: failure of any aborts the entire thing. The time is taken from a trusted
+timestamp attached to the transaction itself i.e. it is NOT necessarily the current time.
+
+
+
+
+api.ContractClassRef
+
+
+
+
+
+api.ContractDefRef
+
+Encapsulates the contract type. e.g. Cash or CommercialPaper etc.
+
+
+
+
+api.ContractLedgerRef
+
+
+
+
+
+core.ContractState
+
+A contract state (or just "state") contains opaque data used by a contract program. It can be thought of as a disk
+file that the program can use to persist data across transactions. States are immutable: once created they are never
+updated, instead, any changes must generate a new successor state.
+
+
+
+
+contracts.CrowdFund
+
+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).
+
+
+
+
+core.math.CubicSplineInterpolator
+
+Interpolates values between the given data points using a SplineFunction .
+
+
+
+
+core.node.servlets.DataUploadServlet
+
+Accepts binary streams, finds the right AcceptsFileUpload implementor and hands the stream off to it.
+
+
+
+
+core.node.subsystems.DataVendingService
+
+This class sets up network message handlers for requests from peers for data keyed by hash. It is a piece of simple
+glue that sits between the network layer and the database layer.
+
+
+
+
+core.DateOffset
+
+Date offset that the fixing is done prior to the accrual start date.
+Currently not used in the calculation.
+
+
+
+
+core.DateRollConvention
+
+This reflects what happens if a date on which a business event is supposed to happen actually falls upon a non-working day
+Depending on the accounting requirement, we can move forward until we get to a business day, or backwards
+There are some additional rules which are explained in the individual cases below
+
+
+
+
+core.DateRollDirection
+
+This is utilised in the DateRollConvention class to determine which way we should initially step when
+finding a business day
+
+
+
+
+core.DayCountBasisDay
+
+This forms the day part of the "Day Count Basis" used for interest calculation.
+Note that the first character cannot be a number (enum naming constraints), so we drop that
+in the toString lest some people get confused.
+
+
+
+
+core.DayCountBasisYear
+
+This forms the year part of the "Day Count Basis" used for interest calculation.
+
+
+
+
+contracts.DealState
+
+Interface representing an agreement that exposes various attributes that are common. Implementing it simplifies
+implementation of general protocols that manipulate many agreement types.
+
+
+
+
+demos.DemoClock
+
+A Clock that can have the date advanced for use in demos
+
+
+
+
+core.crypto.DigitalSignature
+
+A wrapper around a digital signature. The covering field is a generic tag usable by whatever is interpreting the
+signature. It isnt used currently, but experience from Bitcoin suggests such a feature is useful, especially when
+building partially signed transactions.
+
+
+
+
+kotlin.Double (extensions in package core)
+
+
+
+
+
+contracts.DummyContract
+
+
+
+
+
+core.crypto.DummyPublicKey
+
+
+
+
+
+core.node.services.DummyTimestampingAuthority
+
+
+
+
+
+core.node.subsystems.E2ETestKeyManagementService
+
+A simple in-memory KMS that doesnt bother saving keys to disk. A real implementation would:
+
+
+
+
+core.utilities.Emoji
+
+A simple wrapper class that contains icons and support for printing them only when were connected to a terminal.
+
+
+
+
+contracts.Event
+
+Event superclass - everything happens on a date.
+
+
+
+
+demos.protocols.ExitServerProtocol
+
+
+
+
+
+core.Expression
+
+Represents a textual expression of e.g. a formula
+
+
+
+
+core.ExpressionDeserializer
+
+
+
+
+
+core.ExpressionSerializer
+
+
+
+
+
+protocols.FetchAttachmentsProtocol
+
+Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
+attachments are saved to local storage automatically.
+
+
+
+
+protocols.FetchDataProtocol
+
+An abstract protocol for fetching typed data from a remote peer.
+
+
+
+
+protocols.FetchTransactionsProtocol
+
+Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.
+
+
+
+
+core.Fix
+
+A Fix represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx.
+
+
+
+
+core.FixOf
+
+A FixOf identifies the question side of a fix: what day, tenor and type of fix ("LIBOR", "EURIBOR" etc)
+
+
+
+
+contracts.FixableDealState
+
+Interface adding fixing specific methods
+
+
+
+
+contracts.FixedRate
+
+A very basic subclass to represent a fixed rate.
+
+
+
+
+contracts.FixedRatePaymentEvent
+
+Basic class for the Fixed Rate Payments on the fixed leg - see RatePaymentEvent
+Assumes that the rate is valid.
+
+
+
+
+contracts.FloatingRate
+
+The parent class of the Floating rate classes
+
+
+
+
+contracts.FloatingRatePaymentEvent
+
+Basic class for the Floating Rate Payments on the floating leg - see RatePaymentEvent
+If the rate is null returns a zero payment. // TODO: Is this the desired behaviour?
+
+
+
+
+core.Frequency
+
+Frequency at which an event occurs - the enumerator also casts to an integer specifying the number of times per year
+that would divide into (eg annually = 1, semiannual = 2, monthly = 12 etc).
+
+
+
+
+core.testing.IRSSimulation
+
+A simulation in which banks execute interest rate swaps with each other, including the fixing events.
+
+
+
+
+core.node.services.IdentityService
+
+An identity service maintains an bidirectional map of Party s to their associated public keys and thus supports
+lookup of a party given its key. This is obviously very incomplete and does not reflect everything a real identity
+service would provide.
+
+
+
+
+core.serialization.ImmutableClassSerializer
+
+Serializes properties and deserializes by using the constructor. This assumes that all backed properties are
+set via the constructor and the class is immutable.
+
+
+
+
+core.node.subsystems.InMemoryIdentityService
+
+Simple identity service which caches parties and provides functionality for efficient lookup.
+
+
+
+
+core.testing.InMemoryMessagingNetwork
+
+An in-memory network allows you to manufacture InMemoryMessaging s for a set of participants. Each
+InMemoryMessaging maintains a queue of messages it has received, and a background thread that dispatches
+messages one by one to registered handlers. Alternatively, a messaging system may be manually pumped, in which
+case no thread is created and a caller is expected to force delivery one at a time (this is useful for unit
+testing).
+
+
+
+
+core.node.subsystems.InMemoryNetworkMapCache
+
+Extremely simple in-memory cache of the network map.
+
+
+
+
+core.node.services.InMemoryNetworkMapService
+
+
+
+
+
+contracts.InsufficientBalanceException
+
+
+
+
+
+kotlin.Int (extensions in package core)
+
+
+
+
+
+kotlin.Int (extensions in package contracts)
+
+
+
+
+
+contracts.InterestRateSwap
+
+The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement)
+This contract has 4 significant data classes within it, the "Common", "Calculation", "FixedLeg" and "FloatingLeg"
+It also has 4 commands, "Agree", "Fix", "Pay" and "Mature".
+Currently, we are not interested (excuse pun) in valuing the swap, calculating the PVs, DFs and all that good stuff (soon though).
+This is just a representation of a vanilla Fixed vs Floating (same currency) IRS in the R3 prototype model.
+
+
+
+
+api.InterestRateSwapAPI
+
+This provides a simplified API, currently for demonstration use only.
+
+
+
+
+core.math.Interpolator
+
+
+
+
+
+core.math.InterpolatorFactory
+
+
+
+
+
+kotlin.collections.Iterable (extensions in package core)
+
+
+
+
+
+kotlin.collections.Iterable (extensions in package contracts)
+
+
+
+
+
+core.utilities.JsonSupport
+
+Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for
+the java.time API, some core types, and Kotlin data classes.
+
+
+
+
+core.node.subsystems.KeyManagementService
+
+The KMS is responsible for storing and using private keys to sign things. An implementation of this may, for example,
+call out to a hardware security module that enforces various auditing and frequency-of-use requirements.
+
+
+
+
+java.security.KeyPair (extensions in package core.crypto)
+
+
+
+
+
+core.LedgerTransaction
+
+A LedgerTransaction wraps the data needed to calculate one or more successor states from a set of input states.
+It is the first step after extraction from a WireTransaction. The signatures at this point have been lined up
+with the commands from the wire, and verified/looked up.
+
+
+
+
+core.math.LinearInterpolator
+
+Interpolates values between the given data points using straight lines
+
+
+
+
+core.LinearState
+
+A state that evolves by superseding itself, all of which share the common "thread"
+
+
+
+
+kotlin.collections.List (extensions in package core)
+
+
+
+
+
+java.time.LocalDate (extensions in package core)
+
+
+
+
+
+kotlin.Long (extensions in package core)
+
+
+
+
+
+core.messaging.Message
+
+A message is defined, at this level, to be a (topic, timestamp, byte arrays) triple, where the topic is a string in
+Java-style reverse dns form, with "platform." being a prefix reserved by the platform for its own use. Vendor
+specific messages can be defined, but use your domain name as the prefix e.g. "uk.co.bigbank.messages.SomeMessage".
+
+
+
+
+core.messaging.MessageHandlerRegistration
+
+
+
+
+
+core.messaging.MessageRecipientGroup
+
+A base class for a set of recipients specifically identified by the sender.
+
+
+
+
+core.messaging.MessageRecipients
+
+The interface for a group of message recipients (which may contain only one recipient)
+
+
+
+
+core.messaging.MessagingService
+
+A MessagingService sits at the boundary between a message routing / networking layer and the core platform code.
+
+
+
+
+core.messaging.MessagingServiceBuilder
+
+This class lets you start up a MessagingService . Its purpose is to stop you from getting access to the methods
+on the messaging service interface until you have successfully started up the system. One of these objects should
+be the only way to obtain a reference to a MessagingService . Startup may be a slow process: some implementations
+may let you cast the returned future to an object that lets you get status info.
+
+
+
+
+core.serialization.MissingAttachmentsException
+
+Thrown during deserialisation to indicate that an attachment needed to construct the WireTransaction is not found
+
+
+
+
+core.testing.MockIdentityService
+
+Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.
+This class allows the provided list of identities to be mutated after construction, so it takes the list lock
+when doing lookups and recalculates the mapping each time. The ability to change the list is used by the
+MockNetwork code.
+
+
+
+
+core.testing.MockNetwork
+
+A mock node brings up a suite of in-memory services in a fast manner suitable for unit testing.
+Components that do IO are either swapped out for mocks, or pointed to a Jimfs in memory filesystem.
+
+
+
+
+core.testing.MockNetworkMapCache
+
+Network map cache with no backing map service.
+
+
+
+
+core.node.subsystems.MonitoringService
+
+Provides access to various metrics and ways to notify monitoring services of things, for sysadmin purposes.
+This is not an interface because it is too lightweight to bother mocking out.
+
+
+
+
+core.NamedByHash
+
+Implemented by anything that can be named by a secure hash value (e.g. transactions, attachments).
+
+
+
+
+core.node.subsystems.NetworkCacheError
+
+
+
+
+
+core.node.subsystems.NetworkMapCache
+
+A network map contains lists of nodes on the network along with information about their identity keys, services
+they provide and host names or IP addresses where they can be connected to. The cache wraps around a map fetched
+from an authoritative service, and adds easy lookup of the data stored within it. Generally it would be initialised
+with a specified network map service, which it fetches data from and then subscribes to updates of.
+
+
+
+
+core.node.services.NetworkMapService
+
+A network map contains lists of nodes on the network along with information about their identity keys, services
+they provide and host names or IP addresses where they can be connected to. This information is cached locally within
+nodes, by the NetworkMapCache . Currently very basic consensus controls are applied, using signed changes which
+replace each other based on a serial number present in the change.
+
+
+
+
+core.node.Node
+
+A Node manages a standalone server that takes part in the P2P network. It creates the services found in ServiceHub ,
+loads important data off disk and starts listening for connections.
+
+
+
+
+core.node.services.NodeAttachmentService
+
+Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.
+
+
+
+
+core.node.NodeConfiguration
+
+
+
+
+
+core.node.NodeConfigurationFromConfig
+
+
+
+
+
+core.node.NodeInfo
+
+Info about a network node that acts on behalf of some form of contract party.
+
+
+
+
+core.node.services.NodeInterestRates
+
+An interest rates service is an oracle that signs transactions which contain embedded assertions about an interest
+rate fix (e.g. LIBOR, EURIBOR ...).
+
+
+
+
+core.node.services.NodeMapError
+
+
+
+
+
+core.node.services.NodeRegistration
+
+A node registration state in the network map.
+
+
+
+
+core.node.services.NodeTimestamperService
+
+This class implements the server side of the timestamping protocol, using the local clock. A future version might
+add features like checking against other NTP servers to make sure the clock hasnt drifted by too much.
+
+
+
+
+core.node.subsystems.NodeWalletService
+
+This class implements a simple, in memory wallet that tracks states that are owned by us, and also has a convenience
+method to auto-generate some self-issued cash states that can be used for test trading. A real wallet would persist
+states relevant to us into a database and once such a wallet is implemented, this scaffolding can be removed.
+
+
+
+
+core.crypto.NullPublicKey
+
+
+
+
+
+core.serialization.OpaqueBytes
+
+A simple class that wraps a byte array and makes the equals/hashCode/toString methods work as you actually expect.
+In an ideal JVM this would be a value type and be completely overhead free. Project Valhalla is adding such
+functionality to Java, but it wont arrive for a few years yet
+
+
+
+
+core.OwnableState
+
+
+
+
+
+core.Party
+
+A Party is well known (name, pubkey) pair. In a real system this would probably be an X.509 certificate.
+
+
+
+
+core.PartyReference
+
+Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal
+ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.
+
+
+
+
+java.nio.file.Path (extensions in package core)
+
+
+
+
+
+contracts.PaymentEvent
+
+Top level PaymentEvent class - represents an obligation to pay an amount on a given date, which may be either in the past or the future.
+
+
+
+
+core.PaymentRule
+
+Whether the payment should be made before the due date, or after it.
+
+
+
+
+contracts.PercentageRatioUnit
+
+A class to reprecent a percentage in an unambiguous way.
+
+
+
+
+core.node.PhysicalLocation
+
+A labelled WorldCoordinate , where the label is human meaningful. For example, the name of the nearest city.
+Labels should not refer to non-landmarks, for example, they should not contain the names of organisations.
+
+
+
+
+core.math.Polynomial
+
+Represents a polynomial function of arbitrary degree
+
+
+
+
+java.security.PrivateKey (extensions in package core.crypto)
+
+
+
+
+
+core.utilities.ProgressTracker
+
+A progress tracker helps surface information about the progress of an operation to a user interface or API of some
+kind. It lets you define a set of steps that represent an operation. A step is represented by an object (typically
+a singleton).
+
+
+
+
+api.ProtocolClassRef
+
+
+
+
+
+api.ProtocolInstanceRef
+
+
+
+
+
+core.protocols.ProtocolLogic
+
+A sub-class of ProtocolLogic implements a protocol flow using direct, straight line blocking code. Thus you
+can write complex protocol logic in an ordinary fashion, without having to think about callbacks, restarting after
+a node crash, how many instances of your protocol there are running and so on.
+
+
+
+
+api.ProtocolRef
+
+Encapsulates the protocol to be instantiated. e.g. TwoPartyTradeProtocol.Buyer.
+
+
+
+
+api.ProtocolRequiringAttention
+
+Thinking that Instant is OK for short lived protocol deadlines.
+
+
+
+
+core.protocols.ProtocolStateMachine
+
+A ProtocolStateMachine instance is a suspendable fiber that delegates all actual logic to a ProtocolLogic instance.
+For any given flow there is only one PSM, even if that protocol invokes subprotocols.
+
+
+
+
+java.security.PublicKey (extensions in package core.crypto)
+
+
+
+
+
+contracts.Rate
+
+Parent of the Rate family. Used to denote fixed rates, floating rates, reference rates etc
+
+
+
+
+contracts.RatePaymentEvent
+
+A RatePaymentEvent represents a dated obligation of payment.
+It is a specialisation / modification of a basic cash flow event (to be written) that has some additional assistance
+functions for interest rate swap legs of the fixed and floating nature.
+For the fixed leg, the rate is already known at creation and therefore the flows can be pre-determined.
+For the floating leg, the rate refers to a reference rate which is to be "fixed" at a point in the future.
+
+
+
+
+protocols.RatesFixProtocol
+
+This protocol queries the given oracle for an interest rate fix, and if it is within the given tolerance embeds the
+fix in the transaction and then proceeds to get the oracle to sign it. Although the call method combines the query
+and signing step, you can run the steps individually by constructing this object and then using the public methods
+for each step.
+
+
+
+
+contracts.RatioUnit
+
+A utility class to prevent the various mixups between percentages, decimals, bips etc.
+
+
+
+
+core.utilities.RecordingMap
+
+A RecordingMap wraps a regular Map<K, V> and records the sequence of gets and puts to it. This is useful in
+white box unit tests to ensure that code is accessing a data store as much as you expect.
+
+
+
+
+contracts.ReferenceRate
+
+So a reference rate is a rate that takes its value from a source at a given date
+e.g. LIBOR 6M as of 17 March 2016. Hence it requires a source (name) and a value date in the getAsOf(..) method.
+
+
+
+
+core.node.services.RegulatorService
+
+Placeholder interface for regulator services.
+
+
+
+
+core.Requirements
+
+
+
+
+
+protocols.ResolveTransactionsProtocol
+
+This protocol fetches each transaction identified by the given hashes from either disk or network, along with all
+their dependencies, and verifies them together using a single TransactionGroup . If no exception is thrown, then
+all the transactions have been successfully verified and inserted into the local database.
+
+
+
+
+api.ResponseFilter
+
+This adds headers needed for cross site scripting on API clients
+
+
+
+
+core.crypto.SecureHash
+
+
+
+
+
+core.serialization.SerializedBytes
+
+A type safe wrapper around a byte array that contains a serialised object. You can call SerializedBytes.deserialize
+to get the original object back.
+
+
+
+
+core.serialization.SerializedBytesSerializer
+
+A serialiser that avoids writing the wrapper class to the byte stream, thus ensuring SerializedBytes is a pure
+type safety hack.
+
+
+
+
+core.node.ServiceHub
+
+A service hub simply vends references to the other services a node has. Some of those services may be missing or
+mocked out. This class is useful to pass to chunks of pluggable code that might have need of many different kinds of
+functionality and you dont want to hard-code which types in the interface.
+
+
+
+
+core.node.services.ServiceType
+
+Identifier for service types a node can expose over the network to other peers. These types are placed into network
+map advertisements. Services that are purely local and are not providing functionality to other parts of the network
+dont need a declared service type.
+
+
+
+
+core.crypto.SignedData
+
+A serialized piece of data and its signature. Enforces signature validity in order to deserialize the data
+contained within.
+
+
+
+
+core.SignedTransaction
+
+Container for a WireTransaction and attached signatures.
+
+
+
+
+core.testing.Simulation
+
+Base class for network simulations that are based on the unit test / mock environment.
+
+
+
+
+core.messaging.SingleMessageRecipient
+
+A base class for the case of point-to-point messages
+
+
+
+
+core.math.SplineFunction
+
+A spline is function piecewise-defined by polynomial functions.
+Points at which polynomial pieces connect are known as knots .
+
+
+
+
+core.messaging.StackSnapshot
+
+
+
+
+
+core.StateAndRef
+
+A StateAndRef is simply a (state, ref) pair. For instance, a wallet (which holds available assets) contains these.
+
+
+
+
+core.messaging.StateMachineManager
+
+A StateMachineManager is responsible for coordination and persistence of multiple ProtocolStateMachine objects.
+Each such object represents an instantiation of a (two-party) protocol that has reached a particular point.
+
+
+
+
+core.StateRef
+
+A stateref is a pointer (reference) to a state, this is an equivalent of an "outpoint" in Bitcoin. It records which
+transaction defined the state and where in that transaction it was.
+
+
+
+
+api.StatesQuery
+
+Extremely rudimentary query language which should most likely be replaced with a product
+
+
+
+
+core.node.subsystems.StorageService
+
+A sketch of an interface to a simple key/value storage system. Intended for persistence of simple blobs like
+transactions, serialised protocol state machines and so on. Again, this isnt intended to imply lack of SQL or
+anything like that, this interface is only big enough to support the prototyping work.
+
+
+
+
+core.node.subsystems.StorageServiceImpl
+
+
+
+
+
+kotlin.String (extensions in package core)
+
+
+
+
+
+kotlin.String (extensions in package contracts)
+
+
+
+
+
+java.time.temporal.Temporal (extensions in package core)
+
+
+
+
+
+core.Tenor
+
+Placeholder class for the Tenor datatype - which is a standardised duration of time until maturity
+
+
+
+
+core.ThreadBox
+
+A threadbox is a simple utility that makes it harder to forget to take a lock before accessing some shared state.
+Simply define a private class to hold the data that must be grouped under the same lock, and then pass the only
+instance to the ThreadBox constructor. You can now use the locked method with a lambda to take the lock in a
+way that ensures itll be released if theres an exception.
+
+
+
+
+core.TimestampCommand
+
+If present in a transaction, contains a time that was verified by the timestamping authority/authorities whose
+public keys are identified in the containing Command object. The true time must be between (after, before)
+
+
+
+
+core.node.services.TimestamperService
+
+Simple interface (for testing) to an abstract timestamping service. Note that this is not "timestamping" in the
+blockchain sense of a total ordering of transactions, but rather, a signature from a well known/trusted timestamping
+service over a transaction that indicates the timestamp in it is accurate. Such a signature may not always be
+necessary: if there are multiple parties involved in a transaction then they can cross-check the timestamp
+themselves.
+
+
+
+
+core.node.services.TimestampingError
+
+
+
+
+
+protocols.TimestampingProtocol
+
+The TimestampingProtocol class is the client code that talks to a NodeTimestamperService on some remote node. It is a
+ProtocolLogic , meaning it can either be a sub-protocol of some other protocol, or be driven independently.
+
+
+
+
+core.messaging.TopicStringValidator
+
+A singleton thats useful for validating topic strings
+
+
+
+
+core.testing.TradeSimulation
+
+Simulates a never ending series of trades that go pair-wise through the banks (e.g. A and B trade with each other,
+then B and C trade with each other, then C and A etc).
+
+
+
+
+demos.TraderDemoProtocolBuyer
+
+
+
+
+
+demos.TraderDemoProtocolSeller
+
+
+
+
+
+api.TransactionBuildStep
+
+Encapsulate a generateXXX method call on a contract.
+
+
+
+
+core.TransactionBuilder
+
+A TransactionBuilder is a transaction class thats mutable (unlike the others which are all immutable). It is
+intended to be passed around contracts that may edit it by adding new states/commands or modifying the existing set.
+Then once the states and commands are right, this class can be used as a holding bucket to gather signatures from
+multiple parties.
+
+
+
+
+core.TransactionConflictException
+
+
+
+
+
+core.TransactionForVerification
+
+A transaction in fully resolved and sig-checked form, ready for passing as input to a verification function.
+
+
+
+
+core.TransactionGraphSearch
+
+Given a map of transaction id to SignedTransaction , performs a breadth first search of the dependency graph from
+the starting point down in order to find transactions that match the given query criteria.
+
+
+
+
+core.TransactionGroup
+
+A TransactionGroup defines a directed acyclic graph of transactions that can be resolved with each other and then
+verified. Successful verification does not imply the non-existence of other conflicting transactions: simply that
+this subgraph does not contain conflicts and is accepted by the involved contracts.
+
+
+
+
+core.TransactionResolutionException
+
+
+
+
+
+core.TransactionVerificationException
+
+Thrown if a verification fails due to a contract rejection.
+
+
+
+
+core.TransientProperty
+
+A simple wrapper that enables the use of Kotlins "val x by TransientProperty { ... }" syntax. Such a property
+will not be serialized to disk, and if its missing (or the first time its accessed), the initializer will be
+used to set it up. Note that the initializer will be called with the TransientProperty object locked.
+
+
+
+
+protocols.TwoPartyDealProtocol
+
+Classes for manipulating a two party deal or agreement.
+
+
+
+
+protocols.TwoPartyTradeProtocol
+
+This asset trading protocol implements a "delivery vs payment" type swap. It has two parties (B and S for buyer
+and seller) and the following steps:
+
+
+
+
+core.TypeOnlyCommandData
+
+Commands that inherit from this are intended to have no data items: its only their presence that matters.
+
+
+
+
+contracts.UnknownType
+
+
+
+
+
+core.utilities.UntrustworthyData
+
+A small utility to approximate taint tracking: if a method gives you back one of these, it means the data came from
+a remote source that may be incentivised to pass us junk that violates basic assumptions and thus must be checked
+first. The wrapper helps you to avoid forgetting this vital step. Things you might want to check are:
+
+
+
+
+demos.protocols.UpdateBusinessDayProtocol
+
+This is a very temporary, demo-oriented way of initiating processing of temporal events and is not
+intended as the way things will necessarily be done longer term
+
+
+
+
+core.node.subsystems.Wallet
+
+A wallet (name may be temporary) wraps a set of states that are useful for us to keep track of, for instance,
+because we own them. This class represents an immutable, stable state of a wallet: it is guaranteed not to
+change out from underneath you, even though the canonical currently-best-known wallet may change as we learn
+about new transactions from our peers and generate new transactions that consume states ourselves.
+
+
+
+
+core.node.subsystems.WalletService
+
+A WalletService is responsible for securely and safely persisting the current state of a wallet to storage. The
+wallet service vends immutable snapshots of the current wallet for working with: if you build a transaction based
+on a wallet that isnt current, be aware that it may end up being invalid if the states that were used have been
+consumed by someone else first
+
+
+
+
+core.node.services.WireNodeRegistration
+
+A node registration and its signature as a pair.
+
+
+
+
+core.WireTransaction
+
+Transaction ready for serialisation, without any signatures attached.
+
+
+
+
+core.serialization.WireTransactionSerializer
+
+A serialisation engine that knows how to deserialise code inside a sandbox
+
+
+
+
+core.node.WorldCoordinate
+
+A latitude/longitude pair.
+
+
+
+
+
+
diff --git a/docs/build/html/api/api/-a-p-i-server-impl/-init-.html b/docs/build/html/api/api/-a-p-i-server-impl/-init-.html
new file mode 100644
index 0000000000..18200d6124
--- /dev/null
+++ b/docs/build/html/api/api/-a-p-i-server-impl/-init-.html
@@ -0,0 +1,14 @@
+
+
+APIServerImpl.<init> -
+api / APIServerImpl / <init> <init>
+APIServerImpl ( node : AbstractNode ) APIServerImpl.buildTransaction -
+api / APIServerImpl / buildTransaction buildTransaction
+fun buildTransaction ( type : ContractDefRef , steps : List < TransactionBuildStep > ) : SerializedBytes < WireTransaction > APIServer.buildTransaction TransactionBuildSteps would be invocations of contract.generateXXX() methods that all share a common TransactionBuilder
+and a common contract type (e.g. Cash or CommercialPaper)
+which would automatically be passed as the first argument (wed need that to be a criteria/pattern of the generateXXX methods).
+APIServerImpl.commitTransaction -
+api / APIServerImpl / commitTransaction commitTransaction
+fun commitTransaction ( tx : SerializedBytes < WireTransaction > , signatures : List < WithKey > ) : SecureHash APIServer.commitTransaction Attempt to commit transaction (returned from build transaction) with the necessary signatures for that to be
+successful, otherwise exception is thrown.
+APIServerImpl.fetchProtocolsRequiringAttention -
+api / APIServerImpl / fetchProtocolsRequiringAttention fetchProtocolsRequiringAttention
+fun fetchProtocolsRequiringAttention ( query : StatesQuery ) : Map < StateRef , ProtocolRequiringAttention > APIServer.fetchProtocolsRequiringAttention Fetch protocols that require a response to some prompt/question by a human (on the "bank" side).
+APIServerImpl.fetchStates -
+api / APIServerImpl / fetchStates fetchStates
+fun fetchStates ( states : List < StateRef > ) : Map < StateRef , ContractState ? > APIServer.fetchStates APIServerImpl.fetchTransactions -
+api / APIServerImpl / fetchTransactions fetchTransactions
+fun fetchTransactions ( txs : List < SecureHash > ) : Map < SecureHash , SignedTransaction ? > APIServer.fetchTransactions Query for immutable transactions (results can be cached indefinitely by their id/hash).
+Parameters
+txs - The hashes (from StateRef.txhash returned from queryStates ) you would like full transactions for.Return APIServerImpl.generateTransactionSignature -
+api / APIServerImpl / generateTransactionSignature generateTransactionSignature
+fun generateTransactionSignature ( tx : SerializedBytes < WireTransaction > ) : WithKey APIServer.generateTransactionSignature Generate a signature for this transaction signed by us.
+APIServerImpl -
+api / APIServerImpl APIServerImpl
+class APIServerImpl : APIServer Constructors
+
+Properties
+
+Functions
+
+
+
+
+buildTransaction
+
+fun buildTransaction ( type : ContractDefRef , steps : List < TransactionBuildStep > ) : SerializedBytes < WireTransaction > TransactionBuildSteps would be invocations of contract.generateXXX() methods that all share a common TransactionBuilder
+and a common contract type (e.g. Cash or CommercialPaper)
+which would automatically be passed as the first argument (wed need that to be a criteria/pattern of the generateXXX methods).
+
+
+
+
+commitTransaction
+
+fun commitTransaction ( tx : SerializedBytes < WireTransaction > , signatures : List < WithKey > ) : SecureHash Attempt to commit transaction (returned from build transaction) with the necessary signatures for that to be
+successful, otherwise exception is thrown.
+
+
+
+
+fetchProtocolsRequiringAttention
+
+fun fetchProtocolsRequiringAttention ( query : StatesQuery ) : Map < StateRef , ProtocolRequiringAttention > Fetch protocols that require a response to some prompt/question by a human (on the "bank" side).
+
+
+
+
+fetchStates
+
+fun fetchStates ( states : List < StateRef > ) : Map < StateRef , ContractState ? >
+
+
+
+fetchTransactions
+
+fun fetchTransactions ( txs : List < SecureHash > ) : Map < SecureHash , SignedTransaction ? > Query for immutable transactions (results can be cached indefinitely by their id/hash).
+
+
+
+
+generateTransactionSignature
+
+fun generateTransactionSignature ( tx : SerializedBytes < WireTransaction > ) : WithKey Generate a signature for this transaction signed by us.
+
+
+
+
+invokeProtocolSync
+
+fun invokeProtocolSync ( type : ProtocolRef , args : Map < String , Any ? > ) : Any ? This method would not return until the protocol is finished (hence the "Sync").
+
+
+
+
+provideProtocolResponse
+
+fun provideProtocolResponse ( protocol : ProtocolInstanceRef , choice : SecureHash , args : Map < String , Any ? > ) : Unit Provide the response that a protocol is waiting for.
+
+
+
+
+queryStates
+
+fun queryStates ( query : StatesQuery ) : List < StateRef > Query your "local" states (containing only outputs involving you) and return the hashes & indexes associated with them
+to probably be later inflated by fetchLedgerTransactions() or fetchStates() although because immutable you can cache them
+to avoid calling fetchLedgerTransactions() many times.
+
+
+
+
+serverTime
+
+fun serverTime ( ) : LocalDateTime Report current UTC time as understood by the platform.
+
+
+
+
+
+
diff --git a/docs/build/html/api/api/-a-p-i-server-impl/invoke-protocol-sync.html b/docs/build/html/api/api/-a-p-i-server-impl/invoke-protocol-sync.html
new file mode 100644
index 0000000000..d3f58a6cc5
--- /dev/null
+++ b/docs/build/html/api/api/-a-p-i-server-impl/invoke-protocol-sync.html
@@ -0,0 +1,22 @@
+
+
+APIServerImpl.invokeProtocolSync -
+api / APIServerImpl / invokeProtocolSync invokeProtocolSync
+fun invokeProtocolSync ( type : ProtocolRef , args : Map < String , Any ? > ) : Any ? APIServer.invokeProtocolSync This method would not return until the protocol is finished (hence the "Sync").
+Longer term wed add an Async version that returns some kind of ProtocolInvocationRef that could be queried and
+would appear on some kind of event message that is broadcast informing of progress.
+Will throw exception if protocol fails.
+APIServerImpl.node -
+api / APIServerImpl / node node
+val node : AbstractNode APIServerImpl.provideProtocolResponse -
+api / APIServerImpl / provideProtocolResponse provideProtocolResponse
+fun provideProtocolResponse ( protocol : ProtocolInstanceRef , choice : SecureHash , args : Map < String , Any ? > ) : Unit APIServer.provideProtocolResponse Provide the response that a protocol is waiting for.
+Parameters
+protocol - Should refer to a previously supplied ProtocolRequiringAttention.stepId - Which step of the protocol are we referring too.choice - Should be one of the choices presented in the ProtocolRequiringAttention.args - Any arguments required.APIServerImpl.queryStates -
+api / APIServerImpl / queryStates queryStates
+fun queryStates ( query : StatesQuery ) : List < StateRef > APIServer.queryStates Query your "local" states (containing only outputs involving you) and return the hashes & indexes associated with them
+to probably be later inflated by fetchLedgerTransactions() or fetchStates() although because immutable you can cache them
+to avoid calling fetchLedgerTransactions() many times.
+Parameters
+query - Some "where clause" like expression.Return APIServerImpl.serverTime -
+api / APIServerImpl / serverTime serverTime
+fun serverTime ( ) : LocalDateTime APIServer.serverTime Report current UTC time as understood by the platform.
+APIServer.buildTransaction -
+api / APIServer / buildTransaction buildTransaction
+abstract fun buildTransaction ( type : ContractDefRef , steps : List < TransactionBuildStep > ) : SerializedBytes < WireTransaction > TransactionBuildSteps would be invocations of contract.generateXXX() methods that all share a common TransactionBuilder
+and a common contract type (e.g. Cash or CommercialPaper)
+which would automatically be passed as the first argument (wed need that to be a criteria/pattern of the generateXXX methods).
+APIServer.commitTransaction -
+api / APIServer / commitTransaction commitTransaction
+abstract fun commitTransaction ( tx : SerializedBytes < WireTransaction > , signatures : List < WithKey > ) : SecureHash Attempt to commit transaction (returned from build transaction) with the necessary signatures for that to be
+successful, otherwise exception is thrown.
+APIServer.fetchProtocolsRequiringAttention -
+api / APIServer / fetchProtocolsRequiringAttention fetchProtocolsRequiringAttention
+abstract fun fetchProtocolsRequiringAttention ( query : StatesQuery ) : Map < StateRef , ProtocolRequiringAttention > Fetch protocols that require a response to some prompt/question by a human (on the "bank" side).
+APIServer.fetchStates -
+api / APIServer / fetchStates fetchStates
+abstract fun fetchStates ( states : List < StateRef > ) : Map < StateRef , ContractState ? > APIServer.fetchTransactions -
+api / APIServer / fetchTransactions fetchTransactions
+abstract fun fetchTransactions ( txs : List < SecureHash > ) : Map < SecureHash , SignedTransaction ? > Query for immutable transactions (results can be cached indefinitely by their id/hash).
+Parameters
+txs - The hashes (from StateRef.txhash returned from queryStates ) you would like full transactions for.Return APIServer.generateTransactionSignature -
+api / APIServer / generateTransactionSignature generateTransactionSignature
+abstract fun generateTransactionSignature ( tx : SerializedBytes < WireTransaction > ) : WithKey Generate a signature for this transaction signed by us.
+APIServer -
+api / APIServer APIServer
+interface APIServer Top level interface to external interaction with the distributed ledger.
+Wherever a list is returned by a fetchXXX method that corresponds with an input list, that output list will have optional elements
+where a null indicates "missing" and the elements returned will be in the order corresponding with the input list.
+Functions
+
+
+
+
+buildTransaction
+
+abstract fun buildTransaction ( type : ContractDefRef , steps : List < TransactionBuildStep > ) : SerializedBytes < WireTransaction > TransactionBuildSteps would be invocations of contract.generateXXX() methods that all share a common TransactionBuilder
+and a common contract type (e.g. Cash or CommercialPaper)
+which would automatically be passed as the first argument (wed need that to be a criteria/pattern of the generateXXX methods).
+
+
+
+
+commitTransaction
+
+abstract fun commitTransaction ( tx : SerializedBytes < WireTransaction > , signatures : List < WithKey > ) : SecureHash Attempt to commit transaction (returned from build transaction) with the necessary signatures for that to be
+successful, otherwise exception is thrown.
+
+
+
+
+fetchProtocolsRequiringAttention
+
+abstract fun fetchProtocolsRequiringAttention ( query : StatesQuery ) : Map < StateRef , ProtocolRequiringAttention > Fetch protocols that require a response to some prompt/question by a human (on the "bank" side).
+
+
+
+
+fetchStates
+
+abstract fun fetchStates ( states : List < StateRef > ) : Map < StateRef , ContractState ? >
+
+
+
+fetchTransactions
+
+abstract fun fetchTransactions ( txs : List < SecureHash > ) : Map < SecureHash , SignedTransaction ? > Query for immutable transactions (results can be cached indefinitely by their id/hash).
+
+
+
+
+generateTransactionSignature
+
+abstract fun generateTransactionSignature ( tx : SerializedBytes < WireTransaction > ) : WithKey Generate a signature for this transaction signed by us.
+
+
+
+
+invokeProtocolSync
+
+abstract fun invokeProtocolSync ( type : ProtocolRef , args : Map < String , Any ? > ) : Any ? This method would not return until the protocol is finished (hence the "Sync").
+
+
+
+
+provideProtocolResponse
+
+abstract fun provideProtocolResponse ( protocol : ProtocolInstanceRef , choice : SecureHash , args : Map < String , Any ? > ) : Unit Provide the response that a protocol is waiting for.
+
+
+
+
+queryStates
+
+abstract fun queryStates ( query : StatesQuery ) : List < StateRef > Query your "local" states (containing only outputs involving you) and return the hashes & indexes associated with them
+to probably be later inflated by fetchLedgerTransactions() or fetchStates() although because immutable you can cache them
+to avoid calling fetchLedgerTransactions() many times.
+
+
+
+
+serverTime
+
+abstract fun serverTime ( ) : LocalDateTime Report current UTC time as understood by the platform.
+
+
+
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/api/-a-p-i-server/invoke-protocol-sync.html b/docs/build/html/api/api/-a-p-i-server/invoke-protocol-sync.html
new file mode 100644
index 0000000000..d37bd9927e
--- /dev/null
+++ b/docs/build/html/api/api/-a-p-i-server/invoke-protocol-sync.html
@@ -0,0 +1,21 @@
+
+
+APIServer.invokeProtocolSync -
+api / APIServer / invokeProtocolSync invokeProtocolSync
+abstract fun invokeProtocolSync ( type : ProtocolRef , args : Map < String , Any ? > ) : Any ? This method would not return until the protocol is finished (hence the "Sync").
+Longer term wed add an Async version that returns some kind of ProtocolInvocationRef that could be queried and
+would appear on some kind of event message that is broadcast informing of progress.
+Will throw exception if protocol fails.
+APIServer.provideProtocolResponse -
+api / APIServer / provideProtocolResponse provideProtocolResponse
+abstract fun provideProtocolResponse ( protocol : ProtocolInstanceRef , choice : SecureHash , args : Map < String , Any ? > ) : Unit Provide the response that a protocol is waiting for.
+Parameters
+protocol - Should refer to a previously supplied ProtocolRequiringAttention.stepId - Which step of the protocol are we referring too.choice - Should be one of the choices presented in the ProtocolRequiringAttention.args - Any arguments required.APIServer.queryStates -
+api / APIServer / queryStates queryStates
+abstract fun queryStates ( query : StatesQuery ) : List < StateRef > Query your "local" states (containing only outputs involving you) and return the hashes & indexes associated with them
+to probably be later inflated by fetchLedgerTransactions() or fetchStates() although because immutable you can cache them
+to avoid calling fetchLedgerTransactions() many times.
+Parameters
+query - Some "where clause" like expression.Return APIServer.serverTime -
+api / APIServer / serverTime serverTime
+abstract fun serverTime ( ) : LocalDateTime Report current UTC time as understood by the platform.
+Config.<init> -
+api / Config / <init> <init>
+Config ( services : ServiceHub ) Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
+and to organise serializers / deserializers for java.time.* classes as necessary
+Config.defaultObjectMapper -
+api / Config / defaultObjectMapper defaultObjectMapper
+val defaultObjectMapper : <ERROR CLASS> Config.getContext -
+api / Config / getContext getContext
+fun getContext ( type : Class < * > ) : <ERROR CLASS> Config -
+api / Config Config
+class Config Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
+and to organise serializers / deserializers for java.time.* classes as necessary
+Constructors
+
+
+
+
+<init>
+
+Config ( services : ServiceHub ) Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
+and to organise serializers / deserializers for java.time.* classes as necessary
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/api/-config/services.html b/docs/build/html/api/api/-config/services.html
new file mode 100644
index 0000000000..d688ab751e
--- /dev/null
+++ b/docs/build/html/api/api/-config/services.html
@@ -0,0 +1,15 @@
+
+
+Config.services -
+api / Config / services services
+val services : ServiceHub ContractClassRef.<init> -
+api / ContractClassRef / <init> <init>
+ContractClassRef ( className : String ) ContractClassRef.className -
+api / ContractClassRef / className className
+val className : String ContractClassRef -
+api / ContractClassRef ContractClassRef
+data class ContractClassRef : ContractDefRef Constructors
+
+
+
+
+<init>
+
+ContractClassRef ( className : String )
+
+
+
+Properties
+
+
+
+
+className
+
+val className : String
+
+
+
+
+
diff --git a/docs/build/html/api/api/-contract-def-ref.html b/docs/build/html/api/api/-contract-def-ref.html
new file mode 100644
index 0000000000..fe2e395882
--- /dev/null
+++ b/docs/build/html/api/api/-contract-def-ref.html
@@ -0,0 +1,32 @@
+
+
+ContractDefRef -
+api / ContractDefRef ContractDefRef
+interface ContractDefRef Encapsulates the contract type. e.g. Cash or CommercialPaper etc.
+Inheritors
+
+
+
diff --git a/docs/build/html/api/api/-contract-ledger-ref/-init-.html b/docs/build/html/api/api/-contract-ledger-ref/-init-.html
new file mode 100644
index 0000000000..2075740aa8
--- /dev/null
+++ b/docs/build/html/api/api/-contract-ledger-ref/-init-.html
@@ -0,0 +1,14 @@
+
+
+ContractLedgerRef.<init> -
+api / ContractLedgerRef / <init> <init>
+ContractLedgerRef ( hash : SecureHash ) ContractLedgerRef.hash -
+api / ContractLedgerRef / hash hash
+val hash : SecureHash ContractLedgerRef -
+api / ContractLedgerRef ContractLedgerRef
+data class ContractLedgerRef : ContractDefRef Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/api/-interest-rate-swap-a-p-i/-init-.html b/docs/build/html/api/api/-interest-rate-swap-a-p-i/-init-.html
new file mode 100644
index 0000000000..7aaf61b4d0
--- /dev/null
+++ b/docs/build/html/api/api/-interest-rate-swap-a-p-i/-init-.html
@@ -0,0 +1,28 @@
+
+
+InterestRateSwapAPI.<init> -
+api / InterestRateSwapAPI / <init> <init>
+InterestRateSwapAPI ( api : APIServer ) This provides a simplified API, currently for demonstration use only.
+It provides several JSON REST calls as follows:
+GET /api/irs/deals - returns an array of all deals tracked by the wallet of this node.
+GET /api/irs/deals/{ref} - return the deal referenced by the externally provided refence that was previously uploaded.
+POST /api/irs/deals - Payload is a JSON formatted InterestRateSwap.State create a new deal (includes an externally provided reference for use above).
+TODO: where we currently refer to singular external deal reference, of course this could easily be multiple identifiers e.g. CUSIP, ISIN.
+GET /api/irs/demodate - return the current date as viewed by the system in YYYY-MM-DD format.
+PUT /api/irs/demodate - put date in format YYYY-MM-DD to advance the current date as viewed by the system and
+simulate any associated business processing (currently fixing).
+TODO: replace simulated date advancement with business event based implementation
+PUT /api/irs/restart - (empty payload) cause the node to restart for API user emergency use in case any servers become unresponsive,
+or if the demodate or population of deals should be reset (will only work while persistence is disabled).
+InterestRateSwapAPI.api -
+api / InterestRateSwapAPI / api api
+val api : APIServer InterestRateSwapAPI.exitServer -
+api / InterestRateSwapAPI / exitServer exitServer
+fun exitServer ( ) : <ERROR CLASS> InterestRateSwapAPI.fetchDeal -
+api / InterestRateSwapAPI / fetchDeal fetchDeal
+fun fetchDeal ( ref : String ) : <ERROR CLASS> InterestRateSwapAPI.fetchDeals -
+api / InterestRateSwapAPI / fetchDeals fetchDeals
+fun fetchDeals ( ) : Array < State > InterestRateSwapAPI.fetchDemoDate -
+api / InterestRateSwapAPI / fetchDemoDate fetchDemoDate
+fun fetchDemoDate ( ) : LocalDate InterestRateSwapAPI -
+api / InterestRateSwapAPI InterestRateSwapAPI
+class InterestRateSwapAPI This provides a simplified API, currently for demonstration use only.
+It provides several JSON REST calls as follows:
+GET /api/irs/deals - returns an array of all deals tracked by the wallet of this node.
+GET /api/irs/deals/{ref} - return the deal referenced by the externally provided refence that was previously uploaded.
+POST /api/irs/deals - Payload is a JSON formatted InterestRateSwap.State create a new deal (includes an externally provided reference for use above).
+TODO: where we currently refer to singular external deal reference, of course this could easily be multiple identifiers e.g. CUSIP, ISIN.
+GET /api/irs/demodate - return the current date as viewed by the system in YYYY-MM-DD format.
+PUT /api/irs/demodate - put date in format YYYY-MM-DD to advance the current date as viewed by the system and
+simulate any associated business processing (currently fixing).
+TODO: replace simulated date advancement with business event based implementation
+PUT /api/irs/restart - (empty payload) cause the node to restart for API user emergency use in case any servers become unresponsive,
+or if the demodate or population of deals should be reset (will only work while persistence is disabled).
+Constructors
+
+
+
+
+<init>
+
+InterestRateSwapAPI ( api : APIServer ) This provides a simplified API, currently for demonstration use only.
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/api/-interest-rate-swap-a-p-i/store-deal.html b/docs/build/html/api/api/-interest-rate-swap-a-p-i/store-deal.html
new file mode 100644
index 0000000000..faa85a14fb
--- /dev/null
+++ b/docs/build/html/api/api/-interest-rate-swap-a-p-i/store-deal.html
@@ -0,0 +1,15 @@
+
+
+InterestRateSwapAPI.storeDeal -
+api / InterestRateSwapAPI / storeDeal storeDeal
+fun storeDeal ( newDeal : State ) : <ERROR CLASS> InterestRateSwapAPI.storeDemoDate -
+api / InterestRateSwapAPI / storeDemoDate storeDemoDate
+fun storeDemoDate ( newDemoDate : LocalDate ) : <ERROR CLASS> ProtocolClassRef.<init> -
+api / ProtocolClassRef / <init> <init>
+ProtocolClassRef ( className : String ) ProtocolClassRef.className -
+api / ProtocolClassRef / className className
+val className : String ProtocolClassRef -
+api / ProtocolClassRef ProtocolClassRef
+data class ProtocolClassRef : ProtocolRef Constructors
+
+
+
+
+<init>
+
+ProtocolClassRef ( className : String )
+
+
+
+Properties
+
+
+
+
+className
+
+val className : String
+
+
+
+
+
diff --git a/docs/build/html/api/api/-protocol-instance-ref/-init-.html b/docs/build/html/api/api/-protocol-instance-ref/-init-.html
new file mode 100644
index 0000000000..cb0b9892ce
--- /dev/null
+++ b/docs/build/html/api/api/-protocol-instance-ref/-init-.html
@@ -0,0 +1,14 @@
+
+
+ProtocolInstanceRef.<init> -
+api / ProtocolInstanceRef / <init> <init>
+ProtocolInstanceRef ( protocolInstance : SecureHash , protocolClass : ProtocolClassRef , protocolStepId : String ) ProtocolInstanceRef -
+api / ProtocolInstanceRef ProtocolInstanceRef
+data class ProtocolInstanceRef Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/api/-protocol-instance-ref/protocol-class.html b/docs/build/html/api/api/-protocol-instance-ref/protocol-class.html
new file mode 100644
index 0000000000..c47de895b5
--- /dev/null
+++ b/docs/build/html/api/api/-protocol-instance-ref/protocol-class.html
@@ -0,0 +1,15 @@
+
+
+ProtocolInstanceRef.protocolClass -
+api / ProtocolInstanceRef / protocolClass protocolClass
+val protocolClass : ProtocolClassRef ProtocolInstanceRef.protocolInstance -
+api / ProtocolInstanceRef / protocolInstance protocolInstance
+val protocolInstance : SecureHash ProtocolInstanceRef.protocolStepId -
+api / ProtocolInstanceRef / protocolStepId protocolStepId
+val protocolStepId : String ProtocolRef -
+api / ProtocolRef ProtocolRef
+interface ProtocolRef Encapsulates the protocol to be instantiated. e.g. TwoPartyTradeProtocol.Buyer.
+Inheritors
+
+
+
diff --git a/docs/build/html/api/api/-protocol-requiring-attention/-init-.html b/docs/build/html/api/api/-protocol-requiring-attention/-init-.html
new file mode 100644
index 0000000000..3d8da22d91
--- /dev/null
+++ b/docs/build/html/api/api/-protocol-requiring-attention/-init-.html
@@ -0,0 +1,15 @@
+
+
+ProtocolRequiringAttention.<init> -
+api / ProtocolRequiringAttention / <init> <init>
+ProtocolRequiringAttention ( ref : ProtocolInstanceRef , prompt : String , choiceIdsToMessages : Map < SecureHash , String > , dueBy : Instant ) Thinking that Instant is OK for short lived protocol deadlines.
+ProtocolRequiringAttention.choiceIdsToMessages -
+api / ProtocolRequiringAttention / choiceIdsToMessages choiceIdsToMessages
+val choiceIdsToMessages : Map < SecureHash , String > ProtocolRequiringAttention.dueBy -
+api / ProtocolRequiringAttention / dueBy dueBy
+val dueBy : Instant ProtocolRequiringAttention -
+api / ProtocolRequiringAttention ProtocolRequiringAttention
+data class ProtocolRequiringAttention Thinking that Instant is OK for short lived protocol deadlines.
+Constructors
+
+
+
+
+<init>
+
+ProtocolRequiringAttention ( ref : ProtocolInstanceRef , prompt : String , choiceIdsToMessages : Map < SecureHash , String > , dueBy : Instant ) Thinking that Instant is OK for short lived protocol deadlines.
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/api/-protocol-requiring-attention/prompt.html b/docs/build/html/api/api/-protocol-requiring-attention/prompt.html
new file mode 100644
index 0000000000..5cd67e63ee
--- /dev/null
+++ b/docs/build/html/api/api/-protocol-requiring-attention/prompt.html
@@ -0,0 +1,15 @@
+
+
+ProtocolRequiringAttention.prompt -
+api / ProtocolRequiringAttention / prompt prompt
+val prompt : String ProtocolRequiringAttention.ref -
+api / ProtocolRequiringAttention / ref ref
+val ref : ProtocolInstanceRef ResponseFilter.<init> -
+api / ResponseFilter / <init> <init>
+ResponseFilter ( ) This adds headers needed for cross site scripting on API clients
+ResponseFilter.filter -
+api / ResponseFilter / filter filter
+fun filter ( requestContext : <ERROR CLASS> , responseContext : <ERROR CLASS> ) : Unit ResponseFilter -
+api / ResponseFilter ResponseFilter
+class ResponseFilter This adds headers needed for cross site scripting on API clients
+Constructors
+
+
+
+
+<init>
+
+ResponseFilter ( ) This adds headers needed for cross site scripting on API clients
+
+
+
+
+Functions
+
+
+
+
+filter
+
+fun filter ( requestContext : <ERROR CLASS> , responseContext : <ERROR CLASS> ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/api/-states-query/-criteria/-all-deals.html b/docs/build/html/api/api/-states-query/-criteria/-all-deals.html
new file mode 100644
index 0000000000..a0c3f1ce10
--- /dev/null
+++ b/docs/build/html/api/api/-states-query/-criteria/-all-deals.html
@@ -0,0 +1,14 @@
+
+
+StatesQuery.Criteria.AllDeals -
+api / StatesQuery / Criteria / AllDeals AllDeals
+object AllDeals : Criteria StatesQuery.Criteria.Deal.<init> -
+api / StatesQuery / Criteria / Deal / <init> <init>
+Deal ( ref : String ) StatesQuery.Criteria.Deal -
+api / StatesQuery / Criteria / Deal Deal
+data class Deal : Criteria Constructors
+
+
+
+
+<init>
+
+Deal ( ref : String )
+
+
+
+Properties
+
+
+
+
+ref
+
+val ref : String
+
+
+
+
+
diff --git a/docs/build/html/api/api/-states-query/-criteria/-deal/ref.html b/docs/build/html/api/api/-states-query/-criteria/-deal/ref.html
new file mode 100644
index 0000000000..91cba70480
--- /dev/null
+++ b/docs/build/html/api/api/-states-query/-criteria/-deal/ref.html
@@ -0,0 +1,15 @@
+
+
+StatesQuery.Criteria.Deal.ref -
+api / StatesQuery / Criteria / Deal / ref ref
+val ref : String StatesQuery.Criteria -
+api / StatesQuery / Criteria Criteria
+interface Criteria Types
+
+
+
+
+AllDeals
+
+object AllDeals : Criteria
+
+
+
+Deal
+
+data class Deal : Criteria
+
+
+
+Inheritors
+
+
+
+
+AllDeals
+
+object AllDeals : Criteria
+
+
+
+Deal
+
+data class Deal : Criteria
+
+
+
+
+
diff --git a/docs/build/html/api/api/-states-query/-selection/-init-.html b/docs/build/html/api/api/-states-query/-selection/-init-.html
new file mode 100644
index 0000000000..ebc534a0b9
--- /dev/null
+++ b/docs/build/html/api/api/-states-query/-selection/-init-.html
@@ -0,0 +1,14 @@
+
+
+StatesQuery.Selection.<init> -
+api / StatesQuery / Selection / <init> <init>
+Selection ( criteria : Criteria ) StatesQuery.Selection.criteria -
+api / StatesQuery / Selection / criteria criteria
+val criteria : Criteria StatesQuery.Selection -
+api / StatesQuery / Selection Selection
+data class Selection : StatesQuery Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/api/-states-query/index.html b/docs/build/html/api/api/-states-query/index.html
new file mode 100644
index 0000000000..bea19a86f7
--- /dev/null
+++ b/docs/build/html/api/api/-states-query/index.html
@@ -0,0 +1,66 @@
+
+
+StatesQuery -
+api / StatesQuery StatesQuery
+interface StatesQuery Extremely rudimentary query language which should most likely be replaced with a product
+Types
+
+
+
+
+Criteria
+
+interface Criteria
+
+
+
+Selection
+
+data class Selection : StatesQuery
+
+
+
+Companion Object Functions
+
+Inheritors
+
+
+
+
+Selection
+
+data class Selection : StatesQuery
+
+
+
+
+
diff --git a/docs/build/html/api/api/-states-query/select-all-deals.html b/docs/build/html/api/api/-states-query/select-all-deals.html
new file mode 100644
index 0000000000..d236f0e17b
--- /dev/null
+++ b/docs/build/html/api/api/-states-query/select-all-deals.html
@@ -0,0 +1,15 @@
+
+
+StatesQuery.selectAllDeals -
+api / StatesQuery / selectAllDeals selectAllDeals
+fun selectAllDeals ( ) : Selection StatesQuery.selectDeal -
+api / StatesQuery / selectDeal selectDeal
+fun selectDeal ( ref : String ) : Selection StatesQuery.select -
+api / StatesQuery / select select
+fun select ( criteria : Criteria ) : Selection TransactionBuildStep.<init> -
+api / TransactionBuildStep / <init> <init>
+TransactionBuildStep ( generateMethodName : String , args : Map < String , Any ? > ) Encapsulate a generateXXX method call on a contract.
+TransactionBuildStep.args -
+api / TransactionBuildStep / args args
+val args : Map < String , Any ? > TransactionBuildStep.generateMethodName -
+api / TransactionBuildStep / generateMethodName generateMethodName
+val generateMethodName : String TransactionBuildStep -
+api / TransactionBuildStep TransactionBuildStep
+data class TransactionBuildStep Encapsulate a generateXXX method call on a contract.
+Constructors
+
+
+
+
+<init>
+
+TransactionBuildStep ( generateMethodName : String , args : Map < String , Any ? > ) Encapsulate a generateXXX method call on a contract.
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/api/index.html b/docs/build/html/api/api/index.html
new file mode 100644
index 0000000000..787f05b97c
--- /dev/null
+++ b/docs/build/html/api/api/index.html
@@ -0,0 +1,110 @@
+
+
+api -
+api Package api
+Types
+
+
+
+
+APIServer
+
+interface APIServer Top level interface to external interaction with the distributed ledger.
+
+
+
+
+APIServerImpl
+
+class APIServerImpl : APIServer
+
+
+
+Config
+
+class Config Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
+and to organise serializers / deserializers for java.time.* classes as necessary
+
+
+
+
+ContractClassRef
+
+data class ContractClassRef : ContractDefRef
+
+
+
+ContractDefRef
+
+interface ContractDefRef Encapsulates the contract type. e.g. Cash or CommercialPaper etc.
+
+
+
+
+ContractLedgerRef
+
+data class ContractLedgerRef : ContractDefRef
+
+
+
+InterestRateSwapAPI
+
+class InterestRateSwapAPI This provides a simplified API, currently for demonstration use only.
+
+
+
+
+ProtocolClassRef
+
+data class ProtocolClassRef : ProtocolRef
+
+
+
+ProtocolInstanceRef
+
+data class ProtocolInstanceRef
+
+
+
+ProtocolRef
+
+interface ProtocolRef Encapsulates the protocol to be instantiated. e.g. TwoPartyTradeProtocol.Buyer.
+
+
+
+
+ProtocolRequiringAttention
+
+data class ProtocolRequiringAttention Thinking that Instant is OK for short lived protocol deadlines.
+
+
+
+
+ResponseFilter
+
+class ResponseFilter This adds headers needed for cross site scripting on API clients
+
+
+
+
+StatesQuery
+
+interface StatesQuery Extremely rudimentary query language which should most likely be replaced with a product
+
+
+
+
+TransactionBuildStep
+
+data class TransactionBuildStep Encapsulate a generateXXX method call on a contract.
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-c-a-s-h_-p-r-o-g-r-a-m_-i-d.html b/docs/build/html/api/contracts/-c-a-s-h_-p-r-o-g-r-a-m_-i-d.html
new file mode 100644
index 0000000000..26638c4d5b
--- /dev/null
+++ b/docs/build/html/api/contracts/-c-a-s-h_-p-r-o-g-r-a-m_-i-d.html
@@ -0,0 +1,15 @@
+
+
+CASH_PROGRAM_ID -
+contracts / CASH_PROGRAM_ID CASH_PROGRAM_ID
+val CASH_PROGRAM_ID : Cash CP_PROGRAM_ID -
+contracts / CP_PROGRAM_ID CP_PROGRAM_ID
+val CP_PROGRAM_ID : CommercialPaper This is an ultra-trivial implementation of commercial paper, which is essentially a simpler version of a corporate
+bond. It can be seen as a company-specific currency. A company issues CP with a particular face value, say $100,
+but sells it for less, say $90. The paper can be redeemed for cash at a given date in the future. Thus this example
+would have a 10% interest rate with a single repayment. Commercial paper is often rolled over (the maturity date
+is adjusted as if the paper was redeemed and immediately repurchased, but without having to front the cash).
+This contract is not intended to realistically model CP. It is here only to act as a next step up above cash in
+the prototyping phase. It is thus very incomplete.
+Open issues:
+In this model, you cannot merge or split CP. Can you do this normally? We could model CP as a specialised form
+of cash, or reuse some of the cash code? Waiting on response from Ayoub and Rajar about whether CP can always
+be split/merged or only in secondary markets. Even if current systems cant do this, would it be a desirable
+feature to have anyway?
+The funding steps of CP is totally ignored in this model.
+No attention is paid to the existing roles of custodians, funding banks, etc.
+There are regional variations on the CP concept, for instance, American CP requires a special "CUSIP number"
+which may need to be tracked. That, in turn, requires validation logic (there is a bean validator that knows how
+to do this in the Apache BVal project).
+CROWDFUND_PROGRAM_ID -
+contracts / CROWDFUND_PROGRAM_ID CROWDFUND_PROGRAM_ID
+val CROWDFUND_PROGRAM_ID : CrowdFund Cash.Commands.Exit.<init> -
+contracts / Cash / Commands / Exit / <init> <init>
+Exit ( amount : Amount ) A command stating that money has been withdrawn from the shared ledger and is now accounted for
+in some other way.
+Cash.Commands.Exit.amount -
+contracts / Cash / Commands / Exit / amount amount
+val amount : Amount Cash.Commands.Exit -
+contracts / Cash / Commands / Exit Exit
+data class Exit : Commands A command stating that money has been withdrawn from the shared ledger and is now accounted for
+in some other way.
+Constructors
+
+
+
+
+<init>
+
+Exit ( amount : Amount ) A command stating that money has been withdrawn from the shared ledger and is now accounted for
+in some other way.
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/contracts/-cash/-commands/-issue/-init-.html b/docs/build/html/api/contracts/-cash/-commands/-issue/-init-.html
new file mode 100644
index 0000000000..bf80ca6432
--- /dev/null
+++ b/docs/build/html/api/contracts/-cash/-commands/-issue/-init-.html
@@ -0,0 +1,16 @@
+
+
+Cash.Commands.Issue.<init> -
+contracts / Cash / Commands / Issue / <init> <init>
+Issue ( nonce : Long = SecureRandom.getInstanceStrong().nextLong()) 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.
+Cash.Commands.Issue -
+contracts / Cash / Commands / Issue Issue
+data class Issue : Commands 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.
+Constructors
+
+
+
+
+<init>
+
+Issue ( nonce : Long = SecureRandom.getInstanceStrong().nextLong()) 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.
+
+
+
+
+Properties
+
+
+
+
+nonce
+
+val nonce : Long
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-cash/-commands/-issue/nonce.html b/docs/build/html/api/contracts/-cash/-commands/-issue/nonce.html
new file mode 100644
index 0000000000..2cadc5d058
--- /dev/null
+++ b/docs/build/html/api/contracts/-cash/-commands/-issue/nonce.html
@@ -0,0 +1,15 @@
+
+
+Cash.Commands.Issue.nonce -
+contracts / Cash / Commands / Issue / nonce nonce
+val nonce : Long Cash.Commands.Move.<init> -
+contracts / Cash / Commands / Move / <init> <init>
+Move ( ) Cash.Commands.Move -
+contracts / Cash / Commands / Move Move
+class Move : TypeOnlyCommandData , Commands Constructors
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-cash/-commands/index.html b/docs/build/html/api/contracts/-cash/-commands/index.html
new file mode 100644
index 0000000000..bf5bb04ec8
--- /dev/null
+++ b/docs/build/html/api/contracts/-cash/-commands/index.html
@@ -0,0 +1,68 @@
+
+
+Cash.Commands -
+contracts / Cash / Commands Commands
+interface Commands : CommandData Types
+
+
+
+
+Exit
+
+data class Exit : Commands A command stating that money has been withdrawn from the shared ledger and is now accounted for
+in some other way.
+
+
+
+
+Issue
+
+data class Issue : Commands 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.
+
+
+
+
+Move
+
+class Move : TypeOnlyCommandData , Commands
+
+
+
+Inheritors
+
+
+
+
+Exit
+
+data class Exit : Commands A command stating that money has been withdrawn from the shared ledger and is now accounted for
+in some other way.
+
+
+
+
+Issue
+
+data class Issue : Commands 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.
+
+
+
+
+Move
+
+class Move : TypeOnlyCommandData , Commands
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-cash/-init-.html b/docs/build/html/api/contracts/-cash/-init-.html
new file mode 100644
index 0000000000..0bb6d2b8a5
--- /dev/null
+++ b/docs/build/html/api/contracts/-cash/-init-.html
@@ -0,0 +1,25 @@
+
+
+Cash.<init> -
+contracts / Cash / <init> <init>
+Cash ( ) 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.
+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.
+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.
+Cash.State.<init> -
+contracts / Cash / State / <init> <init>
+State ( deposit : PartyReference , amount : Amount , owner : PublicKey ) A state representing a cash claim against some party
+Cash.State.amount -
+contracts / Cash / State / amount amount
+val amount : Amount Cash.State.contract -
+contracts / Cash / State / contract contract
+val contract : Cash ContractState.contract Contract by which the state belongs
+Cash.State.deposit -
+contracts / Cash / State / deposit deposit
+val deposit : PartyReference Where the underlying currency backing this ledger entry can be found (propagated)
+Cash.State -
+contracts / Cash / State State
+data class State : OwnableState A state representing a cash claim against some party
+Constructors
+
+Properties
+
+
+
+
+amount
+
+val amount : Amount
+
+
+
+contract
+
+val contract : Cash Contract by which the state belongs
+
+
+
+
+deposit
+
+val deposit : PartyReference Where the underlying currency backing this ledger entry can be found (propagated)
+
+
+
+
+owner
+
+val owner : PublicKey There must be a MoveCommand signed by this key to claim the amount
+
+
+
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+withNewOwner
+
+fun withNewOwner ( newOwner : PublicKey ) : <ERROR CLASS> Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-cash/-state/owner.html b/docs/build/html/api/contracts/-cash/-state/owner.html
new file mode 100644
index 0000000000..40a8915dab
--- /dev/null
+++ b/docs/build/html/api/contracts/-cash/-state/owner.html
@@ -0,0 +1,17 @@
+
+
+Cash.State.owner -
+contracts / Cash / State / owner owner
+val owner : PublicKey OwnableState.owner There must be a MoveCommand signed by this key to claim the amount
+Cash.State.toString -
+contracts / Cash / State / toString toString
+fun toString ( ) : String Cash.State.withNewOwner -
+contracts / Cash / State / withNewOwner withNewOwner
+fun withNewOwner ( newOwner : PublicKey ) : <ERROR CLASS> OwnableState.withNewOwner Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone
+Cash.generateIssue -
+contracts / Cash / generateIssue generateIssue
+fun generateIssue ( tx : TransactionBuilder , amount : Amount , at : PartyReference , owner : PublicKey ) : Unit Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.
+Cash.generateSpend -
+contracts / Cash / generateSpend generateSpend
+fun generateSpend ( tx : TransactionBuilder , amount : Amount , to : PublicKey , cashStates : List < StateAndRef < State > > , onlyFromParties : Set < Party > ? = null) : List < PublicKey > 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.
+Parameters
+onlyFromParties - 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.Cash -
+contracts / Cash Cash
+class Cash : Contract 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.
+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.
+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.
+Types
+
+Constructors
+
+
+
+
+<init>
+
+Cash ( ) 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.
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/contracts/-cash/legal-contract-reference.html b/docs/build/html/api/contracts/-cash/legal-contract-reference.html
new file mode 100644
index 0000000000..d151bdc904
--- /dev/null
+++ b/docs/build/html/api/contracts/-cash/legal-contract-reference.html
@@ -0,0 +1,25 @@
+
+
+Cash.legalContractReference -
+contracts / Cash / legalContractReference legalContractReference
+val legalContractReference : SecureHash Contract.legalContractReference TODO:
+hash should be of the contents, not the URI
+allow the content to be specified at time of instance creation?
+Motivation: its the difference between a state object referencing a programRef, which references a
+legalContractReference and a state object which directly references both. The latter allows the legal wording
+to evolve without requiring code changes. But creates a risk that users create objects governed by a program
+that is inconsistent with the legal contract
+Cash.verify -
+contracts / Cash / verify verify
+fun verify ( tx : TransactionForVerification ) : Unit Contract.verify This is the function EVERYONE runs
+CommercialPaper.Commands.Issue.<init> -
+contracts / CommercialPaper / Commands / Issue / <init> <init>
+Issue ( ) CommercialPaper.Commands.Issue -
+contracts / CommercialPaper / Commands / Issue Issue
+class Issue : TypeOnlyCommandData , Commands Constructors
+
+
+
+
+<init>
+
+Issue ( )
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-commercial-paper/-commands/-move/-init-.html b/docs/build/html/api/contracts/-commercial-paper/-commands/-move/-init-.html
new file mode 100644
index 0000000000..11abf580a4
--- /dev/null
+++ b/docs/build/html/api/contracts/-commercial-paper/-commands/-move/-init-.html
@@ -0,0 +1,14 @@
+
+
+CommercialPaper.Commands.Move.<init> -
+contracts / CommercialPaper / Commands / Move / <init> <init>
+Move ( ) CommercialPaper.Commands.Move -
+contracts / CommercialPaper / Commands / Move Move
+class Move : TypeOnlyCommandData , Commands Constructors
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-commercial-paper/-commands/-redeem/-init-.html b/docs/build/html/api/contracts/-commercial-paper/-commands/-redeem/-init-.html
new file mode 100644
index 0000000000..eb9e49ac8f
--- /dev/null
+++ b/docs/build/html/api/contracts/-commercial-paper/-commands/-redeem/-init-.html
@@ -0,0 +1,14 @@
+
+
+CommercialPaper.Commands.Redeem.<init> -
+contracts / CommercialPaper / Commands / Redeem / <init> <init>
+Redeem ( ) CommercialPaper.Commands.Redeem -
+contracts / CommercialPaper / Commands / Redeem Redeem
+class Redeem : TypeOnlyCommandData , Commands Constructors
+
+
+
+
+<init>
+
+Redeem ( )
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-commercial-paper/-commands/index.html b/docs/build/html/api/contracts/-commercial-paper/-commands/index.html
new file mode 100644
index 0000000000..4eb4ec7d39
--- /dev/null
+++ b/docs/build/html/api/contracts/-commercial-paper/-commands/index.html
@@ -0,0 +1,60 @@
+
+
+CommercialPaper.Commands -
+contracts / CommercialPaper / Commands Commands
+interface Commands : CommandData Types
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/contracts/-commercial-paper/-init-.html b/docs/build/html/api/contracts/-commercial-paper/-init-.html
new file mode 100644
index 0000000000..768c3ca4dc
--- /dev/null
+++ b/docs/build/html/api/contracts/-commercial-paper/-init-.html
@@ -0,0 +1,14 @@
+
+
+CommercialPaper.<init> -
+contracts / CommercialPaper / <init> <init>
+CommercialPaper ( ) CommercialPaper.State.<init> -
+contracts / CommercialPaper / State / <init> <init>
+State ( issuance : PartyReference , owner : PublicKey , faceValue : Amount , maturityDate : Instant ) CommercialPaper.State.contract -
+contracts / CommercialPaper / State / contract contract
+val contract : CommercialPaper ContractState.contract Contract by which the state belongs
+CommercialPaper.State.faceValue -
+contracts / CommercialPaper / State / faceValue faceValue
+val faceValue : Amount CommercialPaper.State -
+contracts / CommercialPaper / State State
+data class State : OwnableState Constructors
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html b/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html
new file mode 100644
index 0000000000..f1f65450bd
--- /dev/null
+++ b/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html
@@ -0,0 +1,15 @@
+
+
+CommercialPaper.State.issuance -
+contracts / CommercialPaper / State / issuance issuance
+val issuance : PartyReference CommercialPaper.State.maturityDate -
+contracts / CommercialPaper / State / maturityDate maturityDate
+val maturityDate : Instant CommercialPaper.State.owner -
+contracts / CommercialPaper / State / owner owner
+val owner : PublicKey OwnableState.owner There must be a MoveCommand signed by this key to claim the amount
+CommercialPaper.State.toString -
+contracts / CommercialPaper / State / toString toString
+fun toString ( ) : String CommercialPaper.State.withFaceValue -
+contracts / CommercialPaper / State / withFaceValue withFaceValue
+fun withFaceValue ( newFaceValue : Amount ) : <ERROR CLASS> CommercialPaper.State.withIssuance -
+contracts / CommercialPaper / State / withIssuance withIssuance
+fun withIssuance ( newIssuance : PartyReference ) : <ERROR CLASS> CommercialPaper.State.withMaturityDate -
+contracts / CommercialPaper / State / withMaturityDate withMaturityDate
+fun withMaturityDate ( newMaturityDate : Instant ) : <ERROR CLASS> CommercialPaper.State.withNewOwner -
+contracts / CommercialPaper / State / withNewOwner withNewOwner
+fun withNewOwner ( newOwner : PublicKey ) : <ERROR CLASS> OwnableState.withNewOwner Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone
+CommercialPaper.State.withOwner -
+contracts / CommercialPaper / State / withOwner withOwner
+fun withOwner ( newOwner : PublicKey ) : <ERROR CLASS> CommercialPaper.State.withoutOwner -
+contracts / CommercialPaper / State / withoutOwner withoutOwner
+fun withoutOwner ( ) : State CommercialPaper.generateIssue -
+contracts / CommercialPaper / generateIssue generateIssue
+fun generateIssue ( issuance : PartyReference , faceValue : Amount , maturityDate : Instant ) : TransactionBuilder 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.
+CommercialPaper.generateMove -
+contracts / CommercialPaper / generateMove generateMove
+fun generateMove ( tx : TransactionBuilder , paper : StateAndRef < State > , newOwner : PublicKey ) : Unit Updates the given partial transaction with an input/output/command to reassign ownership of the paper.
+CommercialPaper.generateRedeem -
+contracts / CommercialPaper / generateRedeem generateRedeem
+fun generateRedeem ( tx : TransactionBuilder , paper : StateAndRef < State > , wallet : List < StateAndRef < State > > ) : Unit Intended to be called by the issuer of some commercial paper, when an owner has notified us that they wish
+to redeem the paper. We must therefore send enough money to the key that owns the paper to satisfy the face
+value, and then ensure the paper is removed from the ledger.
+Exceptions
+InsufficientBalanceException - if the wallet doesnt contain enough money to pay the redeemerCommercialPaper -
+contracts / CommercialPaper CommercialPaper
+class CommercialPaper : Contract Types
+
+Constructors
+
+
+
+
+<init>
+
+CommercialPaper ( )
+
+
+
+Properties
+
+
+
+
+legalContractReference
+
+val legalContractReference : SecureHash Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+
+
+
+
+Functions
+
+
+
+
+generateIssue
+
+fun generateIssue ( issuance : PartyReference , faceValue : Amount , maturityDate : Instant ) : TransactionBuilder 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.
+
+
+
+
+generateMove
+
+fun generateMove ( tx : TransactionBuilder , paper : StateAndRef < State > , newOwner : PublicKey ) : Unit Updates the given partial transaction with an input/output/command to reassign ownership of the paper.
+
+
+
+
+generateRedeem
+
+fun generateRedeem ( tx : TransactionBuilder , paper : StateAndRef < State > , wallet : List < StateAndRef < State > > ) : Unit Intended to be called by the issuer of some commercial paper, when an owner has notified us that they wish
+to redeem the paper. We must therefore send enough money to the key that owns the paper to satisfy the face
+value, and then ensure the paper is removed from the ledger.
+
+
+
+
+verify
+
+fun verify ( tx : TransactionForVerification ) : Unit Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
+Must throw an exception if theres a problem that should prevent state transition. Takes a single object
+rather than an argument so that additional data can be added without breaking binary compatibility with
+existing contract code.
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-commercial-paper/legal-contract-reference.html b/docs/build/html/api/contracts/-commercial-paper/legal-contract-reference.html
new file mode 100644
index 0000000000..6f648f3ba7
--- /dev/null
+++ b/docs/build/html/api/contracts/-commercial-paper/legal-contract-reference.html
@@ -0,0 +1,18 @@
+
+
+CommercialPaper.legalContractReference -
+contracts / CommercialPaper / legalContractReference legalContractReference
+val legalContractReference : SecureHash Contract.legalContractReference Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+CommercialPaper.verify -
+contracts / CommercialPaper / verify verify
+fun verify ( tx : TransactionForVerification ) : Unit Contract.verify Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
+Must throw an exception if theres a problem that should prevent state transition. Takes a single object
+rather than an argument so that additional data can be added without breaking binary compatibility with
+existing contract code.
+CrowdFund.Campaign.<init> -
+contracts / CrowdFund / Campaign / <init> <init>
+Campaign ( owner : PublicKey , name : String , target : Amount , closingTime : Instant ) CrowdFund.Campaign.closingTime -
+contracts / CrowdFund / Campaign / closingTime closingTime
+val closingTime : Instant CrowdFund.Campaign -
+contracts / CrowdFund / Campaign Campaign
+data class Campaign Constructors
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-crowd-fund/-campaign/name.html b/docs/build/html/api/contracts/-crowd-fund/-campaign/name.html
new file mode 100644
index 0000000000..ed02e5e6d5
--- /dev/null
+++ b/docs/build/html/api/contracts/-crowd-fund/-campaign/name.html
@@ -0,0 +1,15 @@
+
+
+CrowdFund.Campaign.name -
+contracts / CrowdFund / Campaign / name name
+val name : String CrowdFund.Campaign.owner -
+contracts / CrowdFund / Campaign / owner owner
+val owner : PublicKey CrowdFund.Campaign.target -
+contracts / CrowdFund / Campaign / target target
+val target : Amount CrowdFund.Campaign.toString -
+contracts / CrowdFund / Campaign / toString toString
+fun toString ( ) : String CrowdFund.Commands.Close.<init> -
+contracts / CrowdFund / Commands / Close / <init> <init>
+Close ( ) CrowdFund.Commands.Close -
+contracts / CrowdFund / Commands / Close Close
+class Close : TypeOnlyCommandData , Commands Constructors
+
+
+
+
+<init>
+
+Close ( )
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-crowd-fund/-commands/-pledge/-init-.html b/docs/build/html/api/contracts/-crowd-fund/-commands/-pledge/-init-.html
new file mode 100644
index 0000000000..47942123f9
--- /dev/null
+++ b/docs/build/html/api/contracts/-crowd-fund/-commands/-pledge/-init-.html
@@ -0,0 +1,14 @@
+
+
+CrowdFund.Commands.Pledge.<init> -
+contracts / CrowdFund / Commands / Pledge / <init> <init>
+Pledge ( ) CrowdFund.Commands.Pledge -
+contracts / CrowdFund / Commands / Pledge Pledge
+class Pledge : TypeOnlyCommandData , Commands Constructors
+
+
+
+
+<init>
+
+Pledge ( )
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-crowd-fund/-commands/-register/-init-.html b/docs/build/html/api/contracts/-crowd-fund/-commands/-register/-init-.html
new file mode 100644
index 0000000000..22df21abc1
--- /dev/null
+++ b/docs/build/html/api/contracts/-crowd-fund/-commands/-register/-init-.html
@@ -0,0 +1,14 @@
+
+
+CrowdFund.Commands.Register.<init> -
+contracts / CrowdFund / Commands / Register / <init> <init>
+Register ( ) CrowdFund.Commands.Register -
+contracts / CrowdFund / Commands / Register Register
+class Register : TypeOnlyCommandData , Commands Constructors
+
+
+
+
+<init>
+
+Register ( )
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-crowd-fund/-commands/index.html b/docs/build/html/api/contracts/-crowd-fund/-commands/index.html
new file mode 100644
index 0000000000..f9e012fe78
--- /dev/null
+++ b/docs/build/html/api/contracts/-crowd-fund/-commands/index.html
@@ -0,0 +1,60 @@
+
+
+CrowdFund.Commands -
+contracts / CrowdFund / Commands Commands
+interface Commands : CommandData Types
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/contracts/-crowd-fund/-init-.html b/docs/build/html/api/contracts/-crowd-fund/-init-.html
new file mode 100644
index 0000000000..b87f6b9808
--- /dev/null
+++ b/docs/build/html/api/contracts/-crowd-fund/-init-.html
@@ -0,0 +1,32 @@
+
+
+CrowdFund.<init> -
+contracts / CrowdFund / <init> <init>
+CrowdFund ( ) 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).
+DiscussionThis method of modelling a crowdfund is similar to how itd be done in Ethereum. The state is essentially a database
+in which transactions evolve it over time. The state transition model we are using here though means its possible
+to do it in a different approach, with some additional (not yet implemented) extensions to the model. In the UTXO
+model you can do something more like the Lighthouse application (https://www.vinumeris.com/lighthouse) in which
+the campaign data and peoples pledges are transmitted out of band, with a pledge being a partially signed
+transaction which is valid only when merged with other transactions. The pledges can then be combined by the project
+owner at the point at which sufficient amounts of money have been gathered, and this creates a valid transaction
+that claims the money.
+TODO: Prototype this second variant of crowdfunding once the core model has been sufficiently extended.
+TODO: Experiment with the use of the javax.validation API to simplify the validation logic by annotating state members.
+See JIRA bug PD-21 for further discussion and followup.
+Author CrowdFund.Pledge.<init> -
+contracts / CrowdFund / Pledge / <init> <init>
+Pledge ( owner : PublicKey , amount : Amount ) CrowdFund.Pledge.amount -
+contracts / CrowdFund / Pledge / amount amount
+val amount : Amount CrowdFund.Pledge -
+contracts / CrowdFund / Pledge Pledge
+data class Pledge Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/contracts/-crowd-fund/-pledge/owner.html b/docs/build/html/api/contracts/-crowd-fund/-pledge/owner.html
new file mode 100644
index 0000000000..037e585180
--- /dev/null
+++ b/docs/build/html/api/contracts/-crowd-fund/-pledge/owner.html
@@ -0,0 +1,15 @@
+
+
+CrowdFund.Pledge.owner -
+contracts / CrowdFund / Pledge / owner owner
+val owner : PublicKey CrowdFund.State.<init> -
+contracts / CrowdFund / State / <init> <init>
+State ( campaign : Campaign , closed : Boolean = false, pledges : List < Pledge > = ArrayList()) CrowdFund.State.campaign -
+contracts / CrowdFund / State / campaign campaign
+val campaign : Campaign CrowdFund.State.closed -
+contracts / CrowdFund / State / closed closed
+val closed : Boolean CrowdFund.State.contract -
+contracts / CrowdFund / State / contract contract
+val contract : CrowdFund ContractState.contract Contract by which the state belongs
+CrowdFund.State -
+contracts / CrowdFund / State State
+data class State : ContractState Constructors
+
+
+
+
+<init>
+
+State ( campaign : Campaign , closed : Boolean = false, pledges : List < Pledge > = ArrayList())
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/contracts/-crowd-fund/-state/pledged-amount.html b/docs/build/html/api/contracts/-crowd-fund/-state/pledged-amount.html
new file mode 100644
index 0000000000..6e9610ac7f
--- /dev/null
+++ b/docs/build/html/api/contracts/-crowd-fund/-state/pledged-amount.html
@@ -0,0 +1,15 @@
+
+
+CrowdFund.State.pledgedAmount -
+contracts / CrowdFund / State / pledgedAmount pledgedAmount
+val pledgedAmount : Amount CrowdFund.State.pledges -
+contracts / CrowdFund / State / pledges pledges
+val pledges : List < Pledge > CrowdFund.generateClose -
+contracts / CrowdFund / generateClose generateClose
+fun generateClose ( tx : TransactionBuilder , campaign : StateAndRef < State > , wallet : List < StateAndRef < State > > ) : Unit CrowdFund.generatePledge -
+contracts / CrowdFund / generatePledge generatePledge
+fun generatePledge ( tx : TransactionBuilder , campaign : StateAndRef < State > , subscriber : PublicKey ) : Unit Updates the given partial transaction with an input/output/command to fund the opportunity.
+CrowdFund.generateRegister -
+contracts / CrowdFund / generateRegister generateRegister
+fun generateRegister ( owner : PartyReference , fundingTarget : Amount , fundingName : String , closingTime : Instant ) : TransactionBuilder Returns a transaction that registers a crowd-funding campaing, owned by the issuing institutions key. Does not update
+an existing transaction because its not possible to register multiple campaigns in a single transaction
+CrowdFund -
+contracts / CrowdFund CrowdFund
+class CrowdFund : Contract 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).
+DiscussionThis method of modelling a crowdfund is similar to how itd be done in Ethereum. The state is essentially a database
+in which transactions evolve it over time. The state transition model we are using here though means its possible
+to do it in a different approach, with some additional (not yet implemented) extensions to the model. In the UTXO
+model you can do something more like the Lighthouse application (https://www.vinumeris.com/lighthouse) in which
+the campaign data and peoples pledges are transmitted out of band, with a pledge being a partially signed
+transaction which is valid only when merged with other transactions. The pledges can then be combined by the project
+owner at the point at which sufficient amounts of money have been gathered, and this creates a valid transaction
+that claims the money.
+TODO: Prototype this second variant of crowdfunding once the core model has been sufficiently extended.
+TODO: Experiment with the use of the javax.validation API to simplify the validation logic by annotating state members.
+See JIRA bug PD-21 for further discussion and followup.
+Author Types
+
+Constructors
+
+
+
+
+<init>
+
+CrowdFund ( ) 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).
+
+
+
+
+Properties
+
+
+
+
+legalContractReference
+
+val legalContractReference : SecureHash Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+
+
+
+
+Functions
+
+
+
+
+generateClose
+
+fun generateClose ( tx : TransactionBuilder , campaign : StateAndRef < State > , wallet : List < StateAndRef < State > > ) : Unit
+
+
+
+generatePledge
+
+fun generatePledge ( tx : TransactionBuilder , campaign : StateAndRef < State > , subscriber : PublicKey ) : Unit Updates the given partial transaction with an input/output/command to fund the opportunity.
+
+
+
+
+generateRegister
+
+fun generateRegister ( owner : PartyReference , fundingTarget : Amount , fundingName : String , closingTime : Instant ) : TransactionBuilder Returns a transaction that registers a crowd-funding campaing, owned by the issuing institutions key. Does not update
+an existing transaction because its not possible to register multiple campaigns in a single transaction
+
+
+
+
+verify
+
+fun verify ( tx : TransactionForVerification ) : Unit Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
+Must throw an exception if theres a problem that should prevent state transition. Takes a single object
+rather than an argument so that additional data can be added without breaking binary compatibility with
+existing contract code.
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-crowd-fund/legal-contract-reference.html b/docs/build/html/api/contracts/-crowd-fund/legal-contract-reference.html
new file mode 100644
index 0000000000..37f5459898
--- /dev/null
+++ b/docs/build/html/api/contracts/-crowd-fund/legal-contract-reference.html
@@ -0,0 +1,18 @@
+
+
+CrowdFund.legalContractReference -
+contracts / CrowdFund / legalContractReference legalContractReference
+val legalContractReference : SecureHash Contract.legalContractReference Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+CrowdFund.verify -
+contracts / CrowdFund / verify verify
+fun verify ( tx : TransactionForVerification ) : Unit Contract.verify Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
+Must throw an exception if theres a problem that should prevent state transition. Takes a single object
+rather than an argument so that additional data can be added without breaking binary compatibility with
+existing contract code.
+DUMMY_PROGRAM_ID -
+contracts / DUMMY_PROGRAM_ID DUMMY_PROGRAM_ID
+val DUMMY_PROGRAM_ID : DummyContract DealState.generateAgreement -
+contracts / DealState / generateAgreement generateAgreement
+abstract fun generateAgreement ( ) : TransactionBuilder Generate a partial transaction representing an agreement (command) to this deal, allowing a general
+deal/agreement protocol to generate the necessary transaction for potential implementations
+TODO: Currently this is the "inception" transaction but in future an offer of some description might be an input state ref
+TODO: This should more likely be a method on the Contract (on a common interface) and the changes to reference a
+Contract instance from a ContractState are imminent, at which point we can move this out of here
+DealState -
+contracts / DealState DealState
+interface DealState : LinearState Interface representing an agreement that exposes various attributes that are common. Implementing it simplifies
+implementation of general protocols that manipulate many agreement types.
+Properties
+
+
+
+
+parties
+
+abstract val parties : Array < Party > Exposes the Parties involved in a generic way
+
+
+
+
+ref
+
+abstract val ref : String Human readable well known reference (e.g. trade reference)
+
+
+
+
+Inherited Properties
+
+
+
+
+thread
+
+abstract val thread : SecureHash Unique thread id within the wallets of all parties
+
+
+
+
+Functions
+
+
+
+
+generateAgreement
+
+abstract fun generateAgreement ( ) : TransactionBuilder Generate a partial transaction representing an agreement (command) to this deal, allowing a general
+deal/agreement protocol to generate the necessary transaction for potential implementations
+
+
+
+
+withPublicKey
+
+abstract fun withPublicKey ( before : Party , after : PublicKey ) : DealState
+
+
+
+Inherited Functions
+
+
+
+
+isRelevant
+
+abstract fun isRelevant ( ourKeys : Set < PublicKey > ) : Boolean true if this should be tracked by our wallet(s)
+
+
+
+
+Extension Functions
+
+
+
+
+hash
+
+fun ContractState . hash ( ) : SecureHash Returns the SHA-256 hash of the serialised contents of this state (not cached)
+
+
+
+
+Inheritors
+
+
+
+
+FixableDealState
+
+interface FixableDealState : DealState Interface adding fixing specific methods
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-deal-state/parties.html b/docs/build/html/api/contracts/-deal-state/parties.html
new file mode 100644
index 0000000000..b7b4b39fca
--- /dev/null
+++ b/docs/build/html/api/contracts/-deal-state/parties.html
@@ -0,0 +1,16 @@
+
+
+DealState.parties -
+contracts / DealState / parties parties
+abstract val parties : Array < Party > Exposes the Parties involved in a generic way
+DealState.ref -
+contracts / DealState / ref ref
+abstract val ref : String Human readable well known reference (e.g. trade reference)
+DealState.withPublicKey -
+contracts / DealState / withPublicKey withPublicKey
+abstract fun withPublicKey ( before : Party , after : PublicKey ) : DealState DummyContract.Commands.Create.<init> -
+contracts / DummyContract / Commands / Create / <init> <init>
+Create ( ) DummyContract.Commands.Create -
+contracts / DummyContract / Commands / Create Create
+class Create : TypeOnlyCommandData , Commands Constructors
+
+
+
+
+<init>
+
+Create ( )
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-dummy-contract/-commands/index.html b/docs/build/html/api/contracts/-dummy-contract/-commands/index.html
new file mode 100644
index 0000000000..1cc55db2b2
--- /dev/null
+++ b/docs/build/html/api/contracts/-dummy-contract/-commands/index.html
@@ -0,0 +1,36 @@
+
+
+DummyContract.Commands -
+contracts / DummyContract / Commands Commands
+interface Commands : CommandData Types
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/contracts/-dummy-contract/-init-.html b/docs/build/html/api/contracts/-dummy-contract/-init-.html
new file mode 100644
index 0000000000..77db1224c8
--- /dev/null
+++ b/docs/build/html/api/contracts/-dummy-contract/-init-.html
@@ -0,0 +1,14 @@
+
+
+DummyContract.<init> -
+contracts / DummyContract / <init> <init>
+DummyContract ( ) DummyContract.State.<init> -
+contracts / DummyContract / State / <init> <init>
+State ( magicNumber : Int = 0) DummyContract.State.contract -
+contracts / DummyContract / State / contract contract
+val contract : DummyContract ContractState.contract Contract by which the state belongs
+DummyContract.State -
+contracts / DummyContract / State State
+class State : ContractState Constructors
+
+
+
+
+<init>
+
+State ( magicNumber : Int = 0)
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/contracts/-dummy-contract/-state/magic-number.html b/docs/build/html/api/contracts/-dummy-contract/-state/magic-number.html
new file mode 100644
index 0000000000..6151c4da66
--- /dev/null
+++ b/docs/build/html/api/contracts/-dummy-contract/-state/magic-number.html
@@ -0,0 +1,15 @@
+
+
+DummyContract.State.magicNumber -
+contracts / DummyContract / State / magicNumber magicNumber
+val magicNumber : Int DummyContract.generateInitial -
+contracts / DummyContract / generateInitial generateInitial
+fun generateInitial ( owner : PartyReference , magicNumber : Int ) : TransactionBuilder DummyContract -
+contracts / DummyContract DummyContract
+class DummyContract : Contract Types
+
+Constructors
+
+
+
+
+<init>
+
+DummyContract ( )
+
+
+
+Properties
+
+
+
+
+legalContractReference
+
+val legalContractReference : SecureHash Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+
+
+
+
+Functions
+
+
+
+
+generateInitial
+
+fun generateInitial ( owner : PartyReference , magicNumber : Int ) : TransactionBuilder
+
+
+
+verify
+
+fun verify ( tx : TransactionForVerification ) : Unit Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
+Must throw an exception if theres a problem that should prevent state transition. Takes a single object
+rather than an argument so that additional data can be added without breaking binary compatibility with
+existing contract code.
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-dummy-contract/legal-contract-reference.html b/docs/build/html/api/contracts/-dummy-contract/legal-contract-reference.html
new file mode 100644
index 0000000000..63bbb94b13
--- /dev/null
+++ b/docs/build/html/api/contracts/-dummy-contract/legal-contract-reference.html
@@ -0,0 +1,18 @@
+
+
+DummyContract.legalContractReference -
+contracts / DummyContract / legalContractReference legalContractReference
+val legalContractReference : SecureHash Contract.legalContractReference Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+DummyContract.verify -
+contracts / DummyContract / verify verify
+fun verify ( tx : TransactionForVerification ) : Unit Contract.verify Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
+Must throw an exception if theres a problem that should prevent state transition. Takes a single object
+rather than an argument so that additional data can be added without breaking binary compatibility with
+existing contract code.
+Event.<init> -
+contracts / Event / <init> <init>
+Event ( date : LocalDate ) Event superclass - everything happens on a date.
+Event.date -
+contracts / Event / date date
+val date : LocalDate Event -
+contracts / Event Event
+open class Event Event superclass - everything happens on a date.
+Constructors
+
+
+
+
+<init>
+
+Event ( date : LocalDate ) Event superclass - everything happens on a date.
+
+
+
+
+Properties
+
+Inheritors
+
+
+
+
+PaymentEvent
+
+abstract class PaymentEvent : Event Top level PaymentEvent class - represents an obligation to pay an amount on a given date, which may be either in the past or the future.
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-fixable-deal-state/generate-fix.html b/docs/build/html/api/contracts/-fixable-deal-state/generate-fix.html
new file mode 100644
index 0000000000..9c852008ec
--- /dev/null
+++ b/docs/build/html/api/contracts/-fixable-deal-state/generate-fix.html
@@ -0,0 +1,20 @@
+
+
+FixableDealState.generateFix -
+contracts / FixableDealState / generateFix generateFix
+abstract fun generateFix ( ptx : TransactionBuilder , oldStateRef : StateRef , fix : Fix ) : Unit Generate a fixing command for this deal and fix
+TODO: This would also likely move to methods on the Contract once the changes to reference
+the Contract from the ContractState are in
+FixableDealState -
+contracts / FixableDealState FixableDealState
+interface FixableDealState : DealState Interface adding fixing specific methods
+Inherited Properties
+
+
+
+
+parties
+
+abstract val parties : Array < Party > Exposes the Parties involved in a generic way
+
+
+
+
+ref
+
+abstract val ref : String Human readable well known reference (e.g. trade reference)
+
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+generateAgreement
+
+abstract fun generateAgreement ( ) : TransactionBuilder Generate a partial transaction representing an agreement (command) to this deal, allowing a general
+deal/agreement protocol to generate the necessary transaction for potential implementations
+
+
+
+
+withPublicKey
+
+abstract fun withPublicKey ( before : Party , after : PublicKey ) : DealState
+
+
+
+Extension Functions
+
+
+
+
+hash
+
+fun ContractState . hash ( ) : SecureHash Returns the SHA-256 hash of the serialised contents of this state (not cached)
+
+
+
+
+Inheritors
+
+
+
+
+State
+
+data class State : FixableDealState The state class contains the 4 major data classes
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-fixable-deal-state/next-fixing-of.html b/docs/build/html/api/contracts/-fixable-deal-state/next-fixing-of.html
new file mode 100644
index 0000000000..b8bc1a4b71
--- /dev/null
+++ b/docs/build/html/api/contracts/-fixable-deal-state/next-fixing-of.html
@@ -0,0 +1,19 @@
+
+
+FixableDealState.nextFixingOf -
+contracts / FixableDealState / nextFixingOf nextFixingOf
+abstract fun nextFixingOf ( ) : FixOf ? When is the next fixing and what is the fixing for?
+TODO: In future we would use this to register for an event to trigger a/the fixing protocol
+FixedRatePaymentEvent.CSVHeader -
+contracts / FixedRatePaymentEvent / CSVHeader CSVHeader
+val CSVHeader : String FixedRatePaymentEvent.<init> -
+contracts / FixedRatePaymentEvent / <init> <init>
+FixedRatePaymentEvent ( date : LocalDate , accrualStartDate : LocalDate , accrualEndDate : LocalDate , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , notional : Amount , rate : Rate ) Basic class for the Fixed Rate Payments on the fixed leg - see RatePaymentEvent
+Assumes that the rate is valid.
+FixedRatePaymentEvent.flow -
+contracts / FixedRatePaymentEvent / flow flow
+val flow : Amount RatePaymentEvent.flow FixedRatePaymentEvent -
+contracts / FixedRatePaymentEvent FixedRatePaymentEvent
+class FixedRatePaymentEvent : RatePaymentEvent Basic class for the Fixed Rate Payments on the fixed leg - see RatePaymentEvent
+Assumes that the rate is valid.
+Constructors
+
+Properties
+
+Inherited Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+Inherited Functions
+
+Companion Object Properties
+
+
+
+
+CSVHeader
+
+val CSVHeader : String
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-fixed-rate-payment-event/to-string.html b/docs/build/html/api/contracts/-fixed-rate-payment-event/to-string.html
new file mode 100644
index 0000000000..628858f51a
--- /dev/null
+++ b/docs/build/html/api/contracts/-fixed-rate-payment-event/to-string.html
@@ -0,0 +1,15 @@
+
+
+FixedRatePaymentEvent.toString -
+contracts / FixedRatePaymentEvent / toString toString
+fun toString ( ) : String FixedRate.<init> -
+contracts / FixedRate / <init> <init>
+FixedRate ( ratioUnit : RatioUnit ) A very basic subclass to represent a fixed rate.
+FixedRate -
+contracts / FixedRate FixedRate
+class FixedRate : Rate A very basic subclass to represent a fixed rate.
+Constructors
+
+
+
+
+<init>
+
+FixedRate ( ratioUnit : RatioUnit ) A very basic subclass to represent a fixed rate.
+
+
+
+
+Inherited Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-fixed-rate/to-string.html b/docs/build/html/api/contracts/-fixed-rate/to-string.html
new file mode 100644
index 0000000000..1487d96da2
--- /dev/null
+++ b/docs/build/html/api/contracts/-fixed-rate/to-string.html
@@ -0,0 +1,15 @@
+
+
+FixedRate.toString -
+contracts / FixedRate / toString toString
+fun toString ( ) : String FloatingRatePaymentEvent.CSVHeader -
+contracts / FloatingRatePaymentEvent / CSVHeader CSVHeader
+val CSVHeader : String FloatingRatePaymentEvent.<init> -
+contracts / FloatingRatePaymentEvent / <init> <init>
+FloatingRatePaymentEvent ( date : LocalDate , accrualStartDate : LocalDate , accrualEndDate : LocalDate , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , fixingDate : LocalDate , notional : Amount , rate : Rate ) Basic class for the Floating Rate Payments on the floating leg - see RatePaymentEvent
+If the rate is null returns a zero payment. // TODO: Is this the desired behaviour?
+FloatingRatePaymentEvent.asCSV -
+contracts / FloatingRatePaymentEvent / asCSV asCSV
+fun asCSV ( ) : String RatePaymentEvent.asCSV FloatingRatePaymentEvent.fixingDate -
+contracts / FloatingRatePaymentEvent / fixingDate fixingDate
+val fixingDate : LocalDate FloatingRatePaymentEvent.flow -
+contracts / FloatingRatePaymentEvent / flow flow
+val flow : Amount RatePaymentEvent.flow FloatingRatePaymentEvent -
+contracts / FloatingRatePaymentEvent FloatingRatePaymentEvent
+class FloatingRatePaymentEvent : RatePaymentEvent Basic class for the Floating Rate Payments on the floating leg - see RatePaymentEvent
+If the rate is null returns a zero payment. // TODO: Is this the desired behaviour?
+Constructors
+
+Properties
+
+Inherited Properties
+
+Functions
+
+
+
+
+asCSV
+
+fun asCSV ( ) : String
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+withNewRate
+
+fun withNewRate ( newRate : Rate ) : FloatingRatePaymentEvent Used for making immutables
+
+
+
+
+Inherited Functions
+
+Companion Object Properties
+
+
+
+
+CSVHeader
+
+val CSVHeader : String
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-floating-rate-payment-event/to-string.html b/docs/build/html/api/contracts/-floating-rate-payment-event/to-string.html
new file mode 100644
index 0000000000..7cf015a43e
--- /dev/null
+++ b/docs/build/html/api/contracts/-floating-rate-payment-event/to-string.html
@@ -0,0 +1,15 @@
+
+
+FloatingRatePaymentEvent.toString -
+contracts / FloatingRatePaymentEvent / toString toString
+fun toString ( ) : String FloatingRatePaymentEvent.withNewRate -
+contracts / FloatingRatePaymentEvent / withNewRate withNewRate
+fun withNewRate ( newRate : Rate ) : FloatingRatePaymentEvent Used for making immutables
+FloatingRate.<init> -
+contracts / FloatingRate / <init> <init>
+FloatingRate ( ) The parent class of the Floating rate classes
+FloatingRate -
+contracts / FloatingRate FloatingRate
+open class FloatingRate : Rate The parent class of the Floating rate classes
+Constructors
+
+
+
+
+<init>
+
+FloatingRate ( ) The parent class of the Floating rate classes
+
+
+
+
+Inherited Properties
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+Inheritors
+
+
+
+
+ReferenceRate
+
+class ReferenceRate : FloatingRate So a reference rate is a rate that takes its value from a source at a given date
+e.g. LIBOR 6M as of 17 March 2016. Hence it requires a source (name) and a value date in the getAsOf(..) method.
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-i-r-s_-p-r-o-g-r-a-m_-i-d.html b/docs/build/html/api/contracts/-i-r-s_-p-r-o-g-r-a-m_-i-d.html
new file mode 100644
index 0000000000..a9870016b3
--- /dev/null
+++ b/docs/build/html/api/contracts/-i-r-s_-p-r-o-g-r-a-m_-i-d.html
@@ -0,0 +1,15 @@
+
+
+IRS_PROGRAM_ID -
+contracts / IRS_PROGRAM_ID IRS_PROGRAM_ID
+val IRS_PROGRAM_ID : InterestRateSwap InsufficientBalanceException.<init> -
+contracts / InsufficientBalanceException / <init> <init>
+InsufficientBalanceException ( amountMissing : Amount ) InsufficientBalanceException.amountMissing -
+contracts / InsufficientBalanceException / amountMissing amountMissing
+val amountMissing : Amount InsufficientBalanceException -
+contracts / InsufficientBalanceException InsufficientBalanceException
+class InsufficientBalanceException : Exception Constructors
+
+
+
+
+<init>
+
+InsufficientBalanceException ( amountMissing : Amount )
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-calculation/-init-.html b/docs/build/html/api/contracts/-interest-rate-swap/-calculation/-init-.html
new file mode 100644
index 0000000000..106c73c07a
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-calculation/-init-.html
@@ -0,0 +1,17 @@
+
+
+InterestRateSwap.Calculation.<init> -
+contracts / InterestRateSwap / Calculation / <init> <init>
+Calculation ( expression : Expression , floatingLegPaymentSchedule : Map < LocalDate , FloatingRatePaymentEvent > , fixedLegPaymentSchedule : Map < LocalDate , FixedRatePaymentEvent > ) The Calculation data class is "mutable" through out the life of the swap, as in, its the only thing that contains
+data that will changed from state to state (Recall that the design insists that everything is immutable, so we actually
+copy / update for each transition)
+InterestRateSwap.Calculation.applyFixing -
+contracts / InterestRateSwap / Calculation / applyFixing applyFixing
+fun applyFixing ( date : LocalDate , newRate : Rate ) : Calculation Returns a copy after modifying (applying) the fixing for that date.
+InterestRateSwap.Calculation.exportSchedule -
+contracts / InterestRateSwap / Calculation / exportSchedule exportSchedule
+fun exportSchedule ( ) : Unit InterestRateSwap.Calculation.expression -
+contracts / InterestRateSwap / Calculation / expression expression
+val expression : Expression InterestRateSwap.Calculation.fixedLegPaymentSchedule -
+contracts / InterestRateSwap / Calculation / fixedLegPaymentSchedule fixedLegPaymentSchedule
+val fixedLegPaymentSchedule : Map < LocalDate , FixedRatePaymentEvent > InterestRateSwap.Calculation.floatingLegPaymentSchedule -
+contracts / InterestRateSwap / Calculation / floatingLegPaymentSchedule floatingLegPaymentSchedule
+val floatingLegPaymentSchedule : Map < LocalDate , FloatingRatePaymentEvent > InterestRateSwap.Calculation.getFixing -
+contracts / InterestRateSwap / Calculation / getFixing getFixing
+fun getFixing ( date : LocalDate ) : FloatingRatePaymentEvent Returns the fixing for that date
+InterestRateSwap.Calculation -
+contracts / InterestRateSwap / Calculation Calculation
+data class Calculation The Calculation data class is "mutable" through out the life of the swap, as in, its the only thing that contains
+data that will changed from state to state (Recall that the design insists that everything is immutable, so we actually
+copy / update for each transition)
+Constructors
+
+
+
+
+<init>
+
+Calculation ( expression : Expression , floatingLegPaymentSchedule : Map < LocalDate , FloatingRatePaymentEvent > , fixedLegPaymentSchedule : Map < LocalDate , FixedRatePaymentEvent > ) The Calculation data class is "mutable" through out the life of the swap, as in, its the only thing that contains
+data that will changed from state to state (Recall that the design insists that everything is immutable, so we actually
+copy / update for each transition)
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-calculation/next-fixing-date.html b/docs/build/html/api/contracts/-interest-rate-swap/-calculation/next-fixing-date.html
new file mode 100644
index 0000000000..dd5d3faacd
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-calculation/next-fixing-date.html
@@ -0,0 +1,18 @@
+
+
+InterestRateSwap.Calculation.nextFixingDate -
+contracts / InterestRateSwap / Calculation / nextFixingDate nextFixingDate
+fun nextFixingDate ( ) : LocalDate ? Gets the date of the next fixing.
+Return InterestRateSwap.Commands.Agree.<init> -
+contracts / InterestRateSwap / Commands / Agree / <init> <init>
+Agree ( ) InterestRateSwap.Commands.Agree -
+contracts / InterestRateSwap / Commands / Agree Agree
+class Agree : TypeOnlyCommandData , Commands Constructors
+
+
+
+
+<init>
+
+Agree ( )
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-commands/-fix/-init-.html b/docs/build/html/api/contracts/-interest-rate-swap/-commands/-fix/-init-.html
new file mode 100644
index 0000000000..e22a3cd566
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-commands/-fix/-init-.html
@@ -0,0 +1,14 @@
+
+
+InterestRateSwap.Commands.Fix.<init> -
+contracts / InterestRateSwap / Commands / Fix / <init> <init>
+Fix ( ) InterestRateSwap.Commands.Fix -
+contracts / InterestRateSwap / Commands / Fix Fix
+class Fix : TypeOnlyCommandData , Commands Constructors
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-commands/-mature/-init-.html b/docs/build/html/api/contracts/-interest-rate-swap/-commands/-mature/-init-.html
new file mode 100644
index 0000000000..15cb25f580
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-commands/-mature/-init-.html
@@ -0,0 +1,14 @@
+
+
+InterestRateSwap.Commands.Mature.<init> -
+contracts / InterestRateSwap / Commands / Mature / <init> <init>
+Mature ( ) InterestRateSwap.Commands.Mature -
+contracts / InterestRateSwap / Commands / Mature Mature
+class Mature : TypeOnlyCommandData , Commands Constructors
+
+
+
+
+<init>
+
+Mature ( )
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-commands/-pay/-init-.html b/docs/build/html/api/contracts/-interest-rate-swap/-commands/-pay/-init-.html
new file mode 100644
index 0000000000..c45d98e3c3
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-commands/-pay/-init-.html
@@ -0,0 +1,14 @@
+
+
+InterestRateSwap.Commands.Pay.<init> -
+contracts / InterestRateSwap / Commands / Pay / <init> <init>
+Pay ( ) InterestRateSwap.Commands.Pay -
+contracts / InterestRateSwap / Commands / Pay Pay
+class Pay : TypeOnlyCommandData , Commands Constructors
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-commands/index.html b/docs/build/html/api/contracts/-interest-rate-swap/-commands/index.html
new file mode 100644
index 0000000000..13f0e1752d
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-commands/index.html
@@ -0,0 +1,72 @@
+
+
+InterestRateSwap.Commands -
+contracts / InterestRateSwap / Commands Commands
+interface Commands : CommandData Types
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-common-leg/-init-.html b/docs/build/html/api/contracts/-interest-rate-swap/-common-leg/-init-.html
new file mode 100644
index 0000000000..8f5d29858b
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-common-leg/-init-.html
@@ -0,0 +1,14 @@
+
+
+InterestRateSwap.CommonLeg.<init> -
+contracts / InterestRateSwap / CommonLeg / <init> <init>
+CommonLeg ( notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment ) InterestRateSwap.CommonLeg.dayCountBasisDay -
+contracts / InterestRateSwap / CommonLeg / dayCountBasisDay dayCountBasisDay
+var dayCountBasisDay : DayCountBasisDay InterestRateSwap.CommonLeg.dayCountBasisYear -
+contracts / InterestRateSwap / CommonLeg / dayCountBasisYear dayCountBasisYear
+var dayCountBasisYear : DayCountBasisYear InterestRateSwap.CommonLeg.dayInMonth -
+contracts / InterestRateSwap / CommonLeg / dayInMonth dayInMonth
+var dayInMonth : Int InterestRateSwap.CommonLeg.effectiveDateAdjustment -
+contracts / InterestRateSwap / CommonLeg / effectiveDateAdjustment effectiveDateAdjustment
+val effectiveDateAdjustment : DateRollConvention ? InterestRateSwap.CommonLeg.effectiveDate -
+contracts / InterestRateSwap / CommonLeg / effectiveDate effectiveDate
+val effectiveDate : LocalDate InterestRateSwap.CommonLeg.equals -
+contracts / InterestRateSwap / CommonLeg / equals equals
+open fun equals ( other : Any ? ) : Boolean InterestRateSwap.CommonLeg.hashCode -
+contracts / InterestRateSwap / CommonLeg / hashCode hashCode
+open fun hashCode ( ) : Int InterestRateSwap.CommonLeg -
+contracts / InterestRateSwap / CommonLeg CommonLeg
+abstract class CommonLeg Constructors
+
+
+
+
+<init>
+
+CommonLeg ( notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment )
+
+
+
+Properties
+
+Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+Inheritors
+
+
+
+
+FixedLeg
+
+class FixedLeg : CommonLeg
+
+
+
+FloatingLeg
+
+class FloatingLeg : CommonLeg
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-common-leg/interest-period-adjustment.html b/docs/build/html/api/contracts/-interest-rate-swap/-common-leg/interest-period-adjustment.html
new file mode 100644
index 0000000000..4411b85b13
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-common-leg/interest-period-adjustment.html
@@ -0,0 +1,15 @@
+
+
+InterestRateSwap.CommonLeg.interestPeriodAdjustment -
+contracts / InterestRateSwap / CommonLeg / interestPeriodAdjustment interestPeriodAdjustment
+var interestPeriodAdjustment : AccrualAdjustment InterestRateSwap.CommonLeg.notional -
+contracts / InterestRateSwap / CommonLeg / notional notional
+val notional : Amount InterestRateSwap.CommonLeg.paymentCalendar -
+contracts / InterestRateSwap / CommonLeg / paymentCalendar paymentCalendar
+var paymentCalendar : BusinessCalendar InterestRateSwap.CommonLeg.paymentDelay -
+contracts / InterestRateSwap / CommonLeg / paymentDelay paymentDelay
+var paymentDelay : Int InterestRateSwap.CommonLeg.paymentFrequency -
+contracts / InterestRateSwap / CommonLeg / paymentFrequency paymentFrequency
+val paymentFrequency : Frequency InterestRateSwap.CommonLeg.paymentRule -
+contracts / InterestRateSwap / CommonLeg / paymentRule paymentRule
+var paymentRule : PaymentRule InterestRateSwap.CommonLeg.terminationDateAdjustment -
+contracts / InterestRateSwap / CommonLeg / terminationDateAdjustment terminationDateAdjustment
+val terminationDateAdjustment : DateRollConvention ? InterestRateSwap.CommonLeg.terminationDate -
+contracts / InterestRateSwap / CommonLeg / terminationDate terminationDate
+val terminationDate : LocalDate InterestRateSwap.CommonLeg.toString -
+contracts / InterestRateSwap / CommonLeg / toString toString
+open fun toString ( ) : String InterestRateSwap.Common.<init> -
+contracts / InterestRateSwap / Common / <init> <init>
+Common ( baseCurrency : Currency , eligibleCurrency : Currency , eligibleCreditSupport : String , independentAmounts : Amount , threshold : Amount , minimumTransferAmount : Amount , rounding : Amount , valuationDate : String , notificationTime : String , resolutionTime : String , interestRate : ReferenceRate , addressForTransfers : String , exposure : UnknownType , localBusinessDay : BusinessCalendar , dailyInterestAmount : Expression , tradeID : String , hashLegalDocs : String ) This Common area contains all the information that is not leg specific.
+InterestRateSwap.Common.addressForTransfers -
+contracts / InterestRateSwap / Common / addressForTransfers addressForTransfers
+val addressForTransfers : String InterestRateSwap.Common.baseCurrency -
+contracts / InterestRateSwap / Common / baseCurrency baseCurrency
+val baseCurrency : Currency InterestRateSwap.Common.dailyInterestAmount -
+contracts / InterestRateSwap / Common / dailyInterestAmount dailyInterestAmount
+val dailyInterestAmount : Expression InterestRateSwap.Common.eligibleCreditSupport -
+contracts / InterestRateSwap / Common / eligibleCreditSupport eligibleCreditSupport
+val eligibleCreditSupport : String InterestRateSwap.Common.eligibleCurrency -
+contracts / InterestRateSwap / Common / eligibleCurrency eligibleCurrency
+val eligibleCurrency : Currency InterestRateSwap.Common.exposure -
+contracts / InterestRateSwap / Common / exposure exposure
+val exposure : UnknownType InterestRateSwap.Common.hashLegalDocs -
+contracts / InterestRateSwap / Common / hashLegalDocs hashLegalDocs
+val hashLegalDocs : String InterestRateSwap.Common.independentAmounts -
+contracts / InterestRateSwap / Common / independentAmounts independentAmounts
+val independentAmounts : Amount InterestRateSwap.Common -
+contracts / InterestRateSwap / Common Common
+data class Common This Common area contains all the information that is not leg specific.
+Constructors
+
+
+
+
+<init>
+
+Common ( baseCurrency : Currency , eligibleCurrency : Currency , eligibleCreditSupport : String , independentAmounts : Amount , threshold : Amount , minimumTransferAmount : Amount , rounding : Amount , valuationDate : String , notificationTime : String , resolutionTime : String , interestRate : ReferenceRate , addressForTransfers : String , exposure : UnknownType , localBusinessDay : BusinessCalendar , dailyInterestAmount : Expression , tradeID : String , hashLegalDocs : String ) This Common area contains all the information that is not leg specific.
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-common/interest-rate.html b/docs/build/html/api/contracts/-interest-rate-swap/-common/interest-rate.html
new file mode 100644
index 0000000000..4bf78464d8
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-common/interest-rate.html
@@ -0,0 +1,15 @@
+
+
+InterestRateSwap.Common.interestRate -
+contracts / InterestRateSwap / Common / interestRate interestRate
+val interestRate : ReferenceRate InterestRateSwap.Common.localBusinessDay -
+contracts / InterestRateSwap / Common / localBusinessDay localBusinessDay
+val localBusinessDay : BusinessCalendar InterestRateSwap.Common.minimumTransferAmount -
+contracts / InterestRateSwap / Common / minimumTransferAmount minimumTransferAmount
+val minimumTransferAmount : Amount InterestRateSwap.Common.notificationTime -
+contracts / InterestRateSwap / Common / notificationTime notificationTime
+val notificationTime : String InterestRateSwap.Common.resolutionTime -
+contracts / InterestRateSwap / Common / resolutionTime resolutionTime
+val resolutionTime : String InterestRateSwap.Common.rounding -
+contracts / InterestRateSwap / Common / rounding rounding
+val rounding : Amount InterestRateSwap.Common.threshold -
+contracts / InterestRateSwap / Common / threshold threshold
+val threshold : Amount InterestRateSwap.Common.tradeID -
+contracts / InterestRateSwap / Common / tradeID tradeID
+val tradeID : String InterestRateSwap.Common.valuationDate -
+contracts / InterestRateSwap / Common / valuationDate valuationDate
+val valuationDate : String InterestRateSwap.FixedLeg.<init> -
+contracts / InterestRateSwap / FixedLeg / <init> <init>
+FixedLeg ( fixedRatePayer : Party , notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment , fixedRate : FixedRate , rollConvention : DateRollConvention ) InterestRateSwap.FixedLeg.equals -
+contracts / InterestRateSwap / FixedLeg / equals equals
+open fun equals ( other : Any ? ) : Boolean CommonLeg.equals InterestRateSwap.FixedLeg.fixedRatePayer -
+contracts / InterestRateSwap / FixedLeg / fixedRatePayer fixedRatePayer
+var fixedRatePayer : Party InterestRateSwap.FixedLeg.fixedRate -
+contracts / InterestRateSwap / FixedLeg / fixedRate fixedRate
+var fixedRate : FixedRate InterestRateSwap.FixedLeg.hashCode -
+contracts / InterestRateSwap / FixedLeg / hashCode hashCode
+open fun hashCode ( ) : Int CommonLeg.hashCode InterestRateSwap.FixedLeg -
+contracts / InterestRateSwap / FixedLeg FixedLeg
+class FixedLeg : CommonLeg Constructors
+
+
+
+
+<init>
+
+FixedLeg ( fixedRatePayer : Party , notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment , fixedRate : FixedRate , rollConvention : DateRollConvention )
+
+
+
+Properties
+
+Inherited Properties
+
+Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-fixed-leg/roll-convention.html b/docs/build/html/api/contracts/-interest-rate-swap/-fixed-leg/roll-convention.html
new file mode 100644
index 0000000000..3226758b71
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-fixed-leg/roll-convention.html
@@ -0,0 +1,15 @@
+
+
+InterestRateSwap.FixedLeg.rollConvention -
+contracts / InterestRateSwap / FixedLeg / rollConvention rollConvention
+var rollConvention : DateRollConvention InterestRateSwap.FixedLeg.toString -
+contracts / InterestRateSwap / FixedLeg / toString toString
+open fun toString ( ) : String CommonLeg.toString InterestRateSwap.FloatingLeg.index -
+contracts / InterestRateSwap / FloatingLeg / index index
+var index : String InterestRateSwap.FloatingLeg.<init> -
+contracts / InterestRateSwap / FloatingLeg / <init> <init>
+FloatingLeg ( floatingRatePayer : Party , notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment , rollConvention : DateRollConvention , fixingRollConvention : DateRollConvention , resetDayInMonth : Int , fixingPeriod : DateOffset , resetRule : PaymentRule , fixingsPerPayment : Frequency , fixingCalendar : BusinessCalendar , index : String , indexSource : String , indexTenor : Tenor ) InterestRateSwap.FloatingLeg.equals -
+contracts / InterestRateSwap / FloatingLeg / equals equals
+open fun equals ( other : Any ? ) : Boolean CommonLeg.equals InterestRateSwap.FloatingLeg.fixingCalendar -
+contracts / InterestRateSwap / FloatingLeg / fixingCalendar fixingCalendar
+var fixingCalendar : BusinessCalendar InterestRateSwap.FloatingLeg.fixingPeriod -
+contracts / InterestRateSwap / FloatingLeg / fixingPeriod fixingPeriod
+var fixingPeriod : DateOffset InterestRateSwap.FloatingLeg.fixingRollConvention -
+contracts / InterestRateSwap / FloatingLeg / fixingRollConvention fixingRollConvention
+var fixingRollConvention : DateRollConvention InterestRateSwap.FloatingLeg.fixingsPerPayment -
+contracts / InterestRateSwap / FloatingLeg / fixingsPerPayment fixingsPerPayment
+var fixingsPerPayment : Frequency InterestRateSwap.FloatingLeg.floatingRatePayer -
+contracts / InterestRateSwap / FloatingLeg / floatingRatePayer floatingRatePayer
+var floatingRatePayer : Party InterestRateSwap.FloatingLeg.hashCode -
+contracts / InterestRateSwap / FloatingLeg / hashCode hashCode
+open fun hashCode ( ) : Int CommonLeg.hashCode InterestRateSwap.FloatingLeg.indexSource -
+contracts / InterestRateSwap / FloatingLeg / indexSource indexSource
+var indexSource : String InterestRateSwap.FloatingLeg.indexTenor -
+contracts / InterestRateSwap / FloatingLeg / indexTenor indexTenor
+var indexTenor : Tenor InterestRateSwap.FloatingLeg -
+contracts / InterestRateSwap / FloatingLeg FloatingLeg
+class FloatingLeg : CommonLeg Constructors
+
+
+
+
+<init>
+
+FloatingLeg ( floatingRatePayer : Party , notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment , rollConvention : DateRollConvention , fixingRollConvention : DateRollConvention , resetDayInMonth : Int , fixingPeriod : DateOffset , resetRule : PaymentRule , fixingsPerPayment : Frequency , fixingCalendar : BusinessCalendar , index : String , indexSource : String , indexTenor : Tenor )
+
+
+
+Properties
+
+Inherited Properties
+
+Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-floating-leg/reset-day-in-month.html b/docs/build/html/api/contracts/-interest-rate-swap/-floating-leg/reset-day-in-month.html
new file mode 100644
index 0000000000..4603a5450f
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-floating-leg/reset-day-in-month.html
@@ -0,0 +1,15 @@
+
+
+InterestRateSwap.FloatingLeg.resetDayInMonth -
+contracts / InterestRateSwap / FloatingLeg / resetDayInMonth resetDayInMonth
+var resetDayInMonth : Int InterestRateSwap.FloatingLeg.resetRule -
+contracts / InterestRateSwap / FloatingLeg / resetRule resetRule
+var resetRule : PaymentRule InterestRateSwap.FloatingLeg.rollConvention -
+contracts / InterestRateSwap / FloatingLeg / rollConvention rollConvention
+var rollConvention : DateRollConvention InterestRateSwap.FloatingLeg.toString -
+contracts / InterestRateSwap / FloatingLeg / toString toString
+open fun toString ( ) : String CommonLeg.toString InterestRateSwap.<init> -
+contracts / InterestRateSwap / <init> <init>
+InterestRateSwap ( ) The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement)
+This contract has 4 significant data classes within it, the "Common", "Calculation", "FixedLeg" and "FloatingLeg"
+It also has 4 commands, "Agree", "Fix", "Pay" and "Mature".
+Currently, we are not interested (excuse pun) in valuing the swap, calculating the PVs, DFs and all that good stuff (soon though).
+This is just a representation of a vanilla Fixed vs Floating (same currency) IRS in the R3 prototype model.
+InterestRateSwap.State.<init> -
+contracts / InterestRateSwap / State / <init> <init>
+State ( fixedLeg : FixedLeg , floatingLeg : FloatingLeg , calculation : Calculation , common : Common ) The state class contains the 4 major data classes
+InterestRateSwap.State.calculation -
+contracts / InterestRateSwap / State / calculation calculation
+val calculation : Calculation InterestRateSwap.State.common -
+contracts / InterestRateSwap / State / common common
+val common : Common InterestRateSwap.State.contract -
+contracts / InterestRateSwap / State / contract contract
+val contract : InterestRateSwap ContractState.contract Contract by which the state belongs
+InterestRateSwap.State.evaluateCalculation -
+contracts / InterestRateSwap / State / evaluateCalculation evaluateCalculation
+fun evaluateCalculation ( businessDate : LocalDate , expression : Expression = calculation.expression) : Any For evaluating arbitrary java on the platform
+InterestRateSwap.State.fixedLeg -
+contracts / InterestRateSwap / State / fixedLeg fixedLeg
+val fixedLeg : FixedLeg InterestRateSwap.State.floatingLeg -
+contracts / InterestRateSwap / State / floatingLeg floatingLeg
+val floatingLeg : FloatingLeg InterestRateSwap.State.generateAgreement -
+contracts / InterestRateSwap / State / generateAgreement generateAgreement
+fun generateAgreement ( ) : TransactionBuilder DealState.generateAgreement Generate a partial transaction representing an agreement (command) to this deal, allowing a general
+deal/agreement protocol to generate the necessary transaction for potential implementations
+TODO: Currently this is the "inception" transaction but in future an offer of some description might be an input state ref
+TODO: This should more likely be a method on the Contract (on a common interface) and the changes to reference a
+Contract instance from a ContractState are imminent, at which point we can move this out of here
+InterestRateSwap.State.generateFix -
+contracts / InterestRateSwap / State / generateFix generateFix
+fun generateFix ( ptx : TransactionBuilder , oldStateRef : StateRef , fix : Fix ) : Unit FixableDealState.generateFix Generate a fixing command for this deal and fix
+TODO: This would also likely move to methods on the Contract once the changes to reference
+the Contract from the ContractState are in
+InterestRateSwap.State -
+contracts / InterestRateSwap / State State
+data class State : FixableDealState The state class contains the 4 major data classes
+Constructors
+
+Properties
+
+Functions
+
+
+
+
+evaluateCalculation
+
+fun evaluateCalculation ( businessDate : LocalDate , expression : Expression = calculation.expression) : Any For evaluating arbitrary java on the platform
+
+
+
+
+generateAgreement
+
+fun generateAgreement ( ) : TransactionBuilder Generate a partial transaction representing an agreement (command) to this deal, allowing a general
+deal/agreement protocol to generate the necessary transaction for potential implementations
+
+
+
+
+generateFix
+
+fun generateFix ( ptx : TransactionBuilder , oldStateRef : StateRef , fix : Fix ) : Unit Generate a fixing command for this deal and fix
+
+
+
+
+isRelevant
+
+fun isRelevant ( ourKeys : Set < PublicKey > ) : Boolean true if this should be tracked by our wallet(s)
+
+
+
+
+nextFixingOf
+
+fun nextFixingOf ( ) : FixOf ? When is the next fixing and what is the fixing for?
+
+
+
+
+prettyPrint
+
+fun prettyPrint ( ) : String Just makes printing it out a bit better for those who dont have 80000 column wide monitors.
+
+
+
+
+withPublicKey
+
+fun withPublicKey ( before : Party , after : PublicKey ) : DealState
+
+
+
+Extension Functions
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/-state/is-relevant.html b/docs/build/html/api/contracts/-interest-rate-swap/-state/is-relevant.html
new file mode 100644
index 0000000000..15ff265ffa
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/-state/is-relevant.html
@@ -0,0 +1,17 @@
+
+
+InterestRateSwap.State.isRelevant -
+contracts / InterestRateSwap / State / isRelevant isRelevant
+fun isRelevant ( ourKeys : Set < PublicKey > ) : Boolean LinearState.isRelevant true if this should be tracked by our wallet(s)
+InterestRateSwap.State.nextFixingOf -
+contracts / InterestRateSwap / State / nextFixingOf nextFixingOf
+fun nextFixingOf ( ) : FixOf ? FixableDealState.nextFixingOf When is the next fixing and what is the fixing for?
+TODO: In future we would use this to register for an event to trigger a/the fixing protocol
+InterestRateSwap.State.parties -
+contracts / InterestRateSwap / State / parties parties
+val parties : Array < Party > DealState.parties Exposes the Parties involved in a generic way
+Getter Exposes the Parties involved in a generic way
+InterestRateSwap.State.prettyPrint -
+contracts / InterestRateSwap / State / prettyPrint prettyPrint
+fun prettyPrint ( ) : String Just makes printing it out a bit better for those who dont have 80000 column wide monitors.
+InterestRateSwap.State.ref -
+contracts / InterestRateSwap / State / ref ref
+val ref : String DealState.ref Human readable well known reference (e.g. trade reference)
+InterestRateSwap.State.thread -
+contracts / InterestRateSwap / State / thread thread
+val thread : <ERROR CLASS> LinearState.thread Unique thread id within the wallets of all parties
+InterestRateSwap.State.withPublicKey -
+contracts / InterestRateSwap / State / withPublicKey withPublicKey
+fun withPublicKey ( before : Party , after : PublicKey ) : DealState DealState.withPublicKey InterestRateSwap.generateAgreement -
+contracts / InterestRateSwap / generateAgreement generateAgreement
+fun generateAgreement ( floatingLeg : FloatingLeg , fixedLeg : FixedLeg , calculation : Calculation , common : Common ) : TransactionBuilder This generates the agreement state and also the schedules from the initial data.
+Note: The day count, interest rate calculation etc are not finished yet, but they are demonstrable.
+InterestRateSwap.generateFix -
+contracts / InterestRateSwap / generateFix generateFix
+fun generateFix ( tx : TransactionBuilder , irs : StateAndRef < State > , fixing : <ERROR CLASS> < LocalDate , Rate > ) : Unit InterestRateSwap -
+contracts / InterestRateSwap InterestRateSwap
+class InterestRateSwap : Contract The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement)
+This contract has 4 significant data classes within it, the "Common", "Calculation", "FixedLeg" and "FloatingLeg"
+It also has 4 commands, "Agree", "Fix", "Pay" and "Mature".
+Currently, we are not interested (excuse pun) in valuing the swap, calculating the PVs, DFs and all that good stuff (soon though).
+This is just a representation of a vanilla Fixed vs Floating (same currency) IRS in the R3 prototype model.
+Types
+
+
+
+
+Calculation
+
+data class Calculation The Calculation data class is "mutable" through out the life of the swap, as in, its the only thing that contains
+data that will changed from state to state (Recall that the design insists that everything is immutable, so we actually
+copy / update for each transition)
+
+
+
+
+Commands
+
+interface Commands : CommandData
+
+
+
+Common
+
+data class Common This Common area contains all the information that is not leg specific.
+
+
+
+
+CommonLeg
+
+abstract class CommonLeg
+
+
+
+FixedLeg
+
+class FixedLeg : CommonLeg
+
+
+
+FloatingLeg
+
+class FloatingLeg : CommonLeg
+
+
+
+State
+
+data class State : FixableDealState The state class contains the 4 major data classes
+
+
+
+
+Constructors
+
+
+
+
+<init>
+
+InterestRateSwap ( ) The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement)
+This contract has 4 significant data classes within it, the "Common", "Calculation", "FixedLeg" and "FloatingLeg"
+It also has 4 commands, "Agree", "Fix", "Pay" and "Mature".
+Currently, we are not interested (excuse pun) in valuing the swap, calculating the PVs, DFs and all that good stuff (soon though).
+This is just a representation of a vanilla Fixed vs Floating (same currency) IRS in the R3 prototype model.
+
+
+
+
+Properties
+
+
+
+
+legalContractReference
+
+val legalContractReference : SecureHash Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/contracts/-interest-rate-swap/legal-contract-reference.html b/docs/build/html/api/contracts/-interest-rate-swap/legal-contract-reference.html
new file mode 100644
index 0000000000..7c94a9dd42
--- /dev/null
+++ b/docs/build/html/api/contracts/-interest-rate-swap/legal-contract-reference.html
@@ -0,0 +1,18 @@
+
+
+InterestRateSwap.legalContractReference -
+contracts / InterestRateSwap / legalContractReference legalContractReference
+val legalContractReference : SecureHash Contract.legalContractReference Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+InterestRateSwap.verify -
+contracts / InterestRateSwap / verify verify
+fun verify ( tx : TransactionForVerification ) : Unit Contract.verify verify() with a few examples of what needs to be checked. TODO: Lots more to add.
+PaymentEvent.<init> -
+contracts / PaymentEvent / <init> <init>
+PaymentEvent ( date : LocalDate ) Top level PaymentEvent class - represents an obligation to pay an amount on a given date, which may be either in the past or the future.
+PaymentEvent.calculate -
+contracts / PaymentEvent / calculate calculate
+abstract fun calculate ( ) : Amount PaymentEvent -
+contracts / PaymentEvent PaymentEvent
+abstract class PaymentEvent : Event Top level PaymentEvent class - represents an obligation to pay an amount on a given date, which may be either in the past or the future.
+Constructors
+
+
+
+
+<init>
+
+PaymentEvent ( date : LocalDate ) Top level PaymentEvent class - represents an obligation to pay an amount on a given date, which may be either in the past or the future.
+
+
+
+
+Inherited Properties
+
+Functions
+
+Inheritors
+
+
+
+
+RatePaymentEvent
+
+abstract class RatePaymentEvent : PaymentEvent A RatePaymentEvent represents a dated obligation of payment.
+It is a specialisation / modification of a basic cash flow event (to be written) that has some additional assistance
+functions for interest rate swap legs of the fixed and floating nature.
+For the fixed leg, the rate is already known at creation and therefore the flows can be pre-determined.
+For the floating leg, the rate refers to a reference rate which is to be "fixed" at a point in the future.
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-percentage-ratio-unit/-init-.html b/docs/build/html/api/contracts/-percentage-ratio-unit/-init-.html
new file mode 100644
index 0000000000..9f2a55f382
--- /dev/null
+++ b/docs/build/html/api/contracts/-percentage-ratio-unit/-init-.html
@@ -0,0 +1,15 @@
+
+
+PercentageRatioUnit.<init> -
+contracts / PercentageRatioUnit / <init> <init>
+PercentageRatioUnit ( percentageAsString : String ) A class to reprecent a percentage in an unambiguous way.
+PercentageRatioUnit -
+contracts / PercentageRatioUnit PercentageRatioUnit
+open class PercentageRatioUnit : RatioUnit A class to reprecent a percentage in an unambiguous way.
+Constructors
+
+
+
+
+<init>
+
+PercentageRatioUnit ( percentageAsString : String ) A class to reprecent a percentage in an unambiguous way.
+
+
+
+
+Inherited Properties
+
+Functions
+
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-percentage-ratio-unit/to-string.html b/docs/build/html/api/contracts/-percentage-ratio-unit/to-string.html
new file mode 100644
index 0000000000..0c2d3592de
--- /dev/null
+++ b/docs/build/html/api/contracts/-percentage-ratio-unit/to-string.html
@@ -0,0 +1,15 @@
+
+
+PercentageRatioUnit.toString -
+contracts / PercentageRatioUnit / toString toString
+open fun toString ( ) : String RatePaymentEvent.CSVHeader -
+contracts / RatePaymentEvent / CSVHeader CSVHeader
+val CSVHeader : String RatePaymentEvent.<init> -
+contracts / RatePaymentEvent / <init> <init>
+RatePaymentEvent ( date : LocalDate , accrualStartDate : LocalDate , accrualEndDate : LocalDate , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , notional : Amount , rate : Rate ) A RatePaymentEvent represents a dated obligation of payment.
+It is a specialisation / modification of a basic cash flow event (to be written) that has some additional assistance
+functions for interest rate swap legs of the fixed and floating nature.
+For the fixed leg, the rate is already known at creation and therefore the flows can be pre-determined.
+For the floating leg, the rate refers to a reference rate which is to be "fixed" at a point in the future.
+RatePaymentEvent.accrualEndDate -
+contracts / RatePaymentEvent / accrualEndDate accrualEndDate
+val accrualEndDate : LocalDate RatePaymentEvent.accrualStartDate -
+contracts / RatePaymentEvent / accrualStartDate accrualStartDate
+val accrualStartDate : LocalDate RatePaymentEvent.asCSV -
+contracts / RatePaymentEvent / asCSV asCSV
+open fun asCSV ( ) : String RatePaymentEvent.calculate -
+contracts / RatePaymentEvent / calculate calculate
+open fun calculate ( ) : Amount PaymentEvent.calculate RatePaymentEvent.dayCountBasisDay -
+contracts / RatePaymentEvent / dayCountBasisDay dayCountBasisDay
+val dayCountBasisDay : DayCountBasisDay RatePaymentEvent.dayCountBasisYear -
+contracts / RatePaymentEvent / dayCountBasisYear dayCountBasisYear
+val dayCountBasisYear : DayCountBasisYear RatePaymentEvent.dayCountFactor -
+contracts / RatePaymentEvent / dayCountFactor dayCountFactor
+val dayCountFactor : BigDecimal RatePaymentEvent.days -
+contracts / RatePaymentEvent / days days
+val days : Int RatePaymentEvent.flow -
+contracts / RatePaymentEvent / flow flow
+abstract val flow : Amount RatePaymentEvent -
+contracts / RatePaymentEvent RatePaymentEvent
+abstract class RatePaymentEvent : PaymentEvent A RatePaymentEvent represents a dated obligation of payment.
+It is a specialisation / modification of a basic cash flow event (to be written) that has some additional assistance
+functions for interest rate swap legs of the fixed and floating nature.
+For the fixed leg, the rate is already known at creation and therefore the flows can be pre-determined.
+For the floating leg, the rate refers to a reference rate which is to be "fixed" at a point in the future.
+Constructors
+
+
+
+
+<init>
+
+RatePaymentEvent ( date : LocalDate , accrualStartDate : LocalDate , accrualEndDate : LocalDate , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , notional : Amount , rate : Rate ) A RatePaymentEvent represents a dated obligation of payment.
+It is a specialisation / modification of a basic cash flow event (to be written) that has some additional assistance
+functions for interest rate swap legs of the fixed and floating nature.
+For the fixed leg, the rate is already known at creation and therefore the flows can be pre-determined.
+For the floating leg, the rate refers to a reference rate which is to be "fixed" at a point in the future.
+
+
+
+
+Properties
+
+Functions
+
+Companion Object Properties
+
+
+
+
+CSVHeader
+
+val CSVHeader : String
+
+
+
+Inheritors
+
+
+
+
+FixedRatePaymentEvent
+
+class FixedRatePaymentEvent : RatePaymentEvent Basic class for the Fixed Rate Payments on the fixed leg - see RatePaymentEvent
+Assumes that the rate is valid.
+
+
+
+
+FloatingRatePaymentEvent
+
+class FloatingRatePaymentEvent : RatePaymentEvent Basic class for the Floating Rate Payments on the floating leg - see RatePaymentEvent
+If the rate is null returns a zero payment. // TODO: Is this the desired behaviour?
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-rate-payment-event/notional.html b/docs/build/html/api/contracts/-rate-payment-event/notional.html
new file mode 100644
index 0000000000..6507963145
--- /dev/null
+++ b/docs/build/html/api/contracts/-rate-payment-event/notional.html
@@ -0,0 +1,15 @@
+
+
+RatePaymentEvent.notional -
+contracts / RatePaymentEvent / notional notional
+val notional : Amount RatePaymentEvent.rate -
+contracts / RatePaymentEvent / rate rate
+val rate : Rate Rate.<init> -
+contracts / Rate / <init> <init>
+Rate ( ratioUnit : RatioUnit ? = null) Parent of the Rate family. Used to denote fixed rates, floating rates, reference rates etc
+Rate.equals -
+contracts / Rate / equals equals
+open fun equals ( other : Any ? ) : Boolean Rate.hashCode -
+contracts / Rate / hashCode hashCode
+open fun hashCode ( ) : Int Returns Rate -
+contracts / Rate Rate
+open class Rate Parent of the Rate family. Used to denote fixed rates, floating rates, reference rates etc
+Constructors
+
+
+
+
+<init>
+
+Rate ( ratioUnit : RatioUnit ? = null) Parent of the Rate family. Used to denote fixed rates, floating rates, reference rates etc
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+Inheritors
+
+
+
+
+FixedRate
+
+class FixedRate : Rate A very basic subclass to represent a fixed rate.
+
+
+
+
+FloatingRate
+
+open class FloatingRate : Rate The parent class of the Floating rate classes
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-rate/ratio-unit.html b/docs/build/html/api/contracts/-rate/ratio-unit.html
new file mode 100644
index 0000000000..bed563f5f4
--- /dev/null
+++ b/docs/build/html/api/contracts/-rate/ratio-unit.html
@@ -0,0 +1,15 @@
+
+
+Rate.ratioUnit -
+contracts / Rate / ratioUnit ratioUnit
+val ratioUnit : RatioUnit ? RatioUnit.<init> -
+contracts / RatioUnit / <init> <init>
+RatioUnit ( value : BigDecimal ) A utility class to prevent the various mixups between percentages, decimals, bips etc.
+RatioUnit.equals -
+contracts / RatioUnit / equals equals
+open fun equals ( other : Any ? ) : Boolean RatioUnit.hashCode -
+contracts / RatioUnit / hashCode hashCode
+open fun hashCode ( ) : Int RatioUnit -
+contracts / RatioUnit RatioUnit
+open class RatioUnit A utility class to prevent the various mixups between percentages, decimals, bips etc.
+Constructors
+
+
+
+
+<init>
+
+RatioUnit ( value : BigDecimal ) A utility class to prevent the various mixups between percentages, decimals, bips etc.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+Inheritors
+
+
+
+
+PercentageRatioUnit
+
+open class PercentageRatioUnit : RatioUnit A class to reprecent a percentage in an unambiguous way.
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-ratio-unit/value.html b/docs/build/html/api/contracts/-ratio-unit/value.html
new file mode 100644
index 0000000000..962c70aee2
--- /dev/null
+++ b/docs/build/html/api/contracts/-ratio-unit/value.html
@@ -0,0 +1,15 @@
+
+
+RatioUnit.value -
+contracts / RatioUnit / value value
+val value : BigDecimal ReferenceRate.<init> -
+contracts / ReferenceRate / <init> <init>
+ReferenceRate ( oracle : String , tenor : Tenor , name : String ) So a reference rate is a rate that takes its value from a source at a given date
+e.g. LIBOR 6M as of 17 March 2016. Hence it requires a source (name) and a value date in the getAsOf(..) method.
+ReferenceRate -
+contracts / ReferenceRate ReferenceRate
+class ReferenceRate : FloatingRate So a reference rate is a rate that takes its value from a source at a given date
+e.g. LIBOR 6M as of 17 March 2016. Hence it requires a source (name) and a value date in the getAsOf(..) method.
+Constructors
+
+
+
+
+<init>
+
+ReferenceRate ( oracle : String , tenor : Tenor , name : String ) So a reference rate is a rate that takes its value from a source at a given date
+e.g. LIBOR 6M as of 17 March 2016. Hence it requires a source (name) and a value date in the getAsOf(..) method.
+
+
+
+
+Properties
+
+
+
+
+name
+
+val name : String
+
+
+
+oracle
+
+val oracle : String
+
+
+
+tenor
+
+val tenor : Tenor
+
+
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/-reference-rate/name.html b/docs/build/html/api/contracts/-reference-rate/name.html
new file mode 100644
index 0000000000..612fa9c1ab
--- /dev/null
+++ b/docs/build/html/api/contracts/-reference-rate/name.html
@@ -0,0 +1,15 @@
+
+
+ReferenceRate.name -
+contracts / ReferenceRate / name name
+val name : String ReferenceRate.oracle -
+contracts / ReferenceRate / oracle oracle
+val oracle : String ReferenceRate.tenor -
+contracts / ReferenceRate / tenor tenor
+val tenor : Tenor ReferenceRate.toString -
+contracts / ReferenceRate / toString toString
+fun toString ( ) : String UnknownType.<init> -
+contracts / UnknownType / <init> <init>
+UnknownType ( ) UnknownType.equals -
+contracts / UnknownType / equals equals
+open fun equals ( other : Any ? ) : Boolean UnknownType.hashCode -
+contracts / UnknownType / hashCode hashCode
+open fun hashCode ( ) : Int UnknownType -
+contracts / UnknownType UnknownType
+open class UnknownType Constructors
+
+
+
+
+<init>
+
+UnknownType ( )
+
+
+
+Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/export-i-r-s-to-c-s-v.html b/docs/build/html/api/contracts/export-i-r-s-to-c-s-v.html
new file mode 100644
index 0000000000..3a8dd27ae5
--- /dev/null
+++ b/docs/build/html/api/contracts/export-i-r-s-to-c-s-v.html
@@ -0,0 +1,15 @@
+
+
+exportIRSToCSV -
+contracts / exportIRSToCSV exportIRSToCSV
+fun State . exportIRSToCSV ( ) : String contracts -
+contracts Package contracts
+Types
+
+
+
+
+Cash
+
+class Cash : Contract 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.
+
+
+
+
+CommercialPaper
+
+class CommercialPaper : Contract
+
+
+
+CrowdFund
+
+class CrowdFund : Contract 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).
+
+
+
+
+DealState
+
+interface DealState : LinearState Interface representing an agreement that exposes various attributes that are common. Implementing it simplifies
+implementation of general protocols that manipulate many agreement types.
+
+
+
+
+DummyContract
+
+class DummyContract : Contract
+
+
+
+Event
+
+open class Event Event superclass - everything happens on a date.
+
+
+
+
+FixableDealState
+
+interface FixableDealState : DealState Interface adding fixing specific methods
+
+
+
+
+FixedRate
+
+class FixedRate : Rate A very basic subclass to represent a fixed rate.
+
+
+
+
+FixedRatePaymentEvent
+
+class FixedRatePaymentEvent : RatePaymentEvent Basic class for the Fixed Rate Payments on the fixed leg - see RatePaymentEvent
+Assumes that the rate is valid.
+
+
+
+
+FloatingRate
+
+open class FloatingRate : Rate The parent class of the Floating rate classes
+
+
+
+
+FloatingRatePaymentEvent
+
+class FloatingRatePaymentEvent : RatePaymentEvent Basic class for the Floating Rate Payments on the floating leg - see RatePaymentEvent
+If the rate is null returns a zero payment. // TODO: Is this the desired behaviour?
+
+
+
+
+InterestRateSwap
+
+class InterestRateSwap : Contract The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement)
+This contract has 4 significant data classes within it, the "Common", "Calculation", "FixedLeg" and "FloatingLeg"
+It also has 4 commands, "Agree", "Fix", "Pay" and "Mature".
+Currently, we are not interested (excuse pun) in valuing the swap, calculating the PVs, DFs and all that good stuff (soon though).
+This is just a representation of a vanilla Fixed vs Floating (same currency) IRS in the R3 prototype model.
+
+
+
+
+PaymentEvent
+
+abstract class PaymentEvent : Event Top level PaymentEvent class - represents an obligation to pay an amount on a given date, which may be either in the past or the future.
+
+
+
+
+PercentageRatioUnit
+
+open class PercentageRatioUnit : RatioUnit A class to reprecent a percentage in an unambiguous way.
+
+
+
+
+Rate
+
+open class Rate Parent of the Rate family. Used to denote fixed rates, floating rates, reference rates etc
+
+
+
+
+RatePaymentEvent
+
+abstract class RatePaymentEvent : PaymentEvent A RatePaymentEvent represents a dated obligation of payment.
+It is a specialisation / modification of a basic cash flow event (to be written) that has some additional assistance
+functions for interest rate swap legs of the fixed and floating nature.
+For the fixed leg, the rate is already known at creation and therefore the flows can be pre-determined.
+For the floating leg, the rate refers to a reference rate which is to be "fixed" at a point in the future.
+
+
+
+
+RatioUnit
+
+open class RatioUnit A utility class to prevent the various mixups between percentages, decimals, bips etc.
+
+
+
+
+ReferenceRate
+
+class ReferenceRate : FloatingRate So a reference rate is a rate that takes its value from a source at a given date
+e.g. LIBOR 6M as of 17 March 2016. Hence it requires a source (name) and a value date in the getAsOf(..) method.
+
+
+
+
+UnknownType
+
+open class UnknownType
+
+
+
+Exceptions
+
+Extensions for External Classes
+
+Properties
+
+
+
+
+CASH_PROGRAM_ID
+
+val CASH_PROGRAM_ID : Cash
+
+
+
+CP_PROGRAM_ID
+
+val CP_PROGRAM_ID : CommercialPaper This is an ultra-trivial implementation of commercial paper, which is essentially a simpler version of a corporate
+bond. It can be seen as a company-specific currency. A company issues CP with a particular face value, say $100,
+but sells it for less, say $90. The paper can be redeemed for cash at a given date in the future. Thus this example
+would have a 10% interest rate with a single repayment. Commercial paper is often rolled over (the maturity date
+is adjusted as if the paper was redeemed and immediately repurchased, but without having to front the cash).
+
+
+
+
+CROWDFUND_PROGRAM_ID
+
+val CROWDFUND_PROGRAM_ID : CrowdFund
+
+
+
+DUMMY_PROGRAM_ID
+
+val DUMMY_PROGRAM_ID : DummyContract
+
+
+
+IRS_PROGRAM_ID
+
+val IRS_PROGRAM_ID : InterestRateSwap
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/contracts/kotlin.-int/index.html b/docs/build/html/api/contracts/kotlin.-int/index.html
new file mode 100644
index 0000000000..a1b8bfcc6d
--- /dev/null
+++ b/docs/build/html/api/contracts/kotlin.-int/index.html
@@ -0,0 +1,23 @@
+
+
+contracts.kotlin.Int -
+contracts / kotlin.Int Extensions for kotlin.Int
+
+
+
+
+times
+
+operator fun Int . times ( other : FixedRate ) : Int operator fun Int . times ( other : Rate ) : Int operator fun Int . times ( other : RatioUnit ) : Int
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/kotlin.-int/times.html b/docs/build/html/api/contracts/kotlin.-int/times.html
new file mode 100644
index 0000000000..e00e9f8c13
--- /dev/null
+++ b/docs/build/html/api/contracts/kotlin.-int/times.html
@@ -0,0 +1,19 @@
+
+
+times -
+contracts / kotlin.Int / times times
+operator fun Int . times ( other : FixedRate ) : Int operator fun Int . times ( other : Rate ) : Int operator fun Int . times ( other : RatioUnit ) : Int contracts.kotlin.String -
+contracts / kotlin.String Extensions for kotlin.String
+
+
+
+
+percent
+
+val String . percent : PercentageRatioUnit For the convenience of writing "5".percent
+Note that we do not currently allow 10.percent (ie no quotes) as this might get a little confusing if
+0.1.percent was written TODO: Discuss
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/kotlin.-string/percent.html b/docs/build/html/api/contracts/kotlin.-string/percent.html
new file mode 100644
index 0000000000..ddedd3a2f1
--- /dev/null
+++ b/docs/build/html/api/contracts/kotlin.-string/percent.html
@@ -0,0 +1,18 @@
+
+
+percent -
+contracts / kotlin.String / percent percent
+val String . percent : PercentageRatioUnit For the convenience of writing "5".percent
+Note that we do not currently allow 10.percent (ie no quotes) as this might get a little confusing if
+0.1.percent was written TODO: Discuss
+contracts.kotlin.collections.Iterable -
+contracts / kotlin.collections.Iterable Extensions for kotlin.collections.Iterable
+
+
+
+
+sumCash
+
+fun Iterable < ContractState > . sumCash ( ) : <ERROR CLASS> Sums the cash states in the list, throwing an exception if there are none.
+
+
+
+
+sumCashBy
+
+fun Iterable < ContractState > . sumCashBy ( owner : PublicKey ) : <ERROR CLASS> Sums the cash states in the list that are owned by the given key, throwing an exception if there are none.
+
+
+
+
+sumCashOrNull
+
+fun Iterable < ContractState > . sumCashOrNull ( ) : <ERROR CLASS> Sums the cash states in the list, returning null if there are none.
+
+
+
+
+sumCashOrZero
+
+fun Iterable < ContractState > . sumCashOrZero ( currency : Currency ) : <ERROR CLASS> Sums the cash states in the list, returning zero of the given currency if there are none.
+
+
+
+
+
+
diff --git a/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-by.html b/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-by.html
new file mode 100644
index 0000000000..d8e3203abf
--- /dev/null
+++ b/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-by.html
@@ -0,0 +1,16 @@
+
+
+sumCashBy -
+contracts / kotlin.collections.Iterable / sumCashBy sumCashBy
+fun Iterable < ContractState > . sumCashBy ( owner : PublicKey ) : <ERROR CLASS> Sums the cash states in the list that are owned by the given key, throwing an exception if there are none.
+sumCashOrNull -
+contracts / kotlin.collections.Iterable / sumCashOrNull sumCashOrNull
+fun Iterable < ContractState > . sumCashOrNull ( ) : <ERROR CLASS> Sums the cash states in the list, returning null if there are none.
+sumCashOrZero -
+contracts / kotlin.collections.Iterable / sumCashOrZero sumCashOrZero
+fun Iterable < ContractState > . sumCashOrZero ( currency : Currency ) : <ERROR CLASS> Sums the cash states in the list, returning zero of the given currency if there are none.
+sumCash -
+contracts / kotlin.collections.Iterable / sumCash sumCash
+fun Iterable < ContractState > . sumCash ( ) : <ERROR CLASS> Sums the cash states in the list, throwing an exception if there are none.
+times -
+contracts / times times
+operator fun Amount . times ( other : RatioUnit ) : Amount DigitalSignature.<init> -
+core.crypto / DigitalSignature / <init> <init>
+DigitalSignature ( bits : ByteArray , covering : Int = 0) A wrapper around a digital signature. The covering field is a generic tag usable by whatever is interpreting the
+signature. It isnt used currently, but experience from Bitcoin suggests such a feature is useful, especially when
+building partially signed transactions.
+DigitalSignature.LegallyIdentifiable.<init> -
+core.crypto / DigitalSignature / LegallyIdentifiable / <init> <init>
+LegallyIdentifiable ( signer : Party , bits : ByteArray , covering : Int ) DigitalSignature.LegallyIdentifiable -
+core.crypto / DigitalSignature / LegallyIdentifiable LegallyIdentifiable
+class LegallyIdentifiable : WithKey Constructors
+
+
+
+
+<init>
+
+LegallyIdentifiable ( signer : Party , bits : ByteArray , covering : Int )
+
+
+
+Properties
+
+Inherited Properties
+
+Inherited Functions
+
+
+
diff --git a/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/signer.html b/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/signer.html
new file mode 100644
index 0000000000..3e970b86a0
--- /dev/null
+++ b/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/signer.html
@@ -0,0 +1,15 @@
+
+
+DigitalSignature.LegallyIdentifiable.signer -
+core.crypto / DigitalSignature / LegallyIdentifiable / signer signer
+val signer : Party DigitalSignature.WithKey.<init> -
+core.crypto / DigitalSignature / WithKey / <init> <init>
+WithKey ( by : PublicKey , bits : ByteArray , covering : Int = 0) A digital signature that identifies who the public key is owned by.
+DigitalSignature.WithKey.by -
+core.crypto / DigitalSignature / WithKey / by by
+val by : PublicKey DigitalSignature.WithKey -
+core.crypto / DigitalSignature / WithKey WithKey
+open class WithKey : DigitalSignature A digital signature that identifies who the public key is owned by.
+Constructors
+
+
+
+
+<init>
+
+WithKey ( by : PublicKey , bits : ByteArray , covering : Int = 0) A digital signature that identifies who the public key is owned by.
+
+
+
+
+Properties
+
+Inherited Properties
+
+
+
+
+covering
+
+val covering : Int
+
+
+
+Functions
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/core.crypto/-digital-signature/-with-key/verify-with-e-c-d-s-a.html b/docs/build/html/api/core.crypto/-digital-signature/-with-key/verify-with-e-c-d-s-a.html
new file mode 100644
index 0000000000..f13a695a97
--- /dev/null
+++ b/docs/build/html/api/core.crypto/-digital-signature/-with-key/verify-with-e-c-d-s-a.html
@@ -0,0 +1,17 @@
+
+
+DigitalSignature.WithKey.verifyWithECDSA -
+core.crypto / DigitalSignature / WithKey / verifyWithECDSA verifyWithECDSA
+fun verifyWithECDSA ( content : ByteArray ) : Unit fun verifyWithECDSA ( content : OpaqueBytes ) : Unit DigitalSignature.covering -
+core.crypto / DigitalSignature / covering covering
+val covering : Int DigitalSignature -
+core.crypto / DigitalSignature DigitalSignature
+open class DigitalSignature : OpaqueBytes A wrapper around a digital signature. The covering field is a generic tag usable by whatever is interpreting the
+signature. It isnt used currently, but experience from Bitcoin suggests such a feature is useful, especially when
+building partially signed transactions.
+Types
+
+
+
+
+LegallyIdentifiable
+
+class LegallyIdentifiable : WithKey
+
+
+
+WithKey
+
+open class WithKey : DigitalSignature A digital signature that identifies who the public key is owned by.
+
+
+
+
+Constructors
+
+
+
+
+<init>
+
+DigitalSignature ( bits : ByteArray , covering : Int = 0) A wrapper around a digital signature. The covering field is a generic tag usable by whatever is interpreting the
+signature. It isnt used currently, but experience from Bitcoin suggests such a feature is useful, especially when
+building partially signed transactions.
+
+
+
+
+Properties
+
+
+
+
+covering
+
+val covering : Int
+
+
+
+Inherited Properties
+
+
+
+
+bits
+
+val bits : ByteArray
+
+
+
+size
+
+val size : Int
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+Extension Functions
+
+Inheritors
+
+
+
+
+WithKey
+
+open class WithKey : DigitalSignature A digital signature that identifies who the public key is owned by.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/-init-.html b/docs/build/html/api/core.crypto/-dummy-public-key/-init-.html
new file mode 100644
index 0000000000..7e497cf3f6
--- /dev/null
+++ b/docs/build/html/api/core.crypto/-dummy-public-key/-init-.html
@@ -0,0 +1,14 @@
+
+
+DummyPublicKey.<init> -
+core.crypto / DummyPublicKey / <init> <init>
+DummyPublicKey ( s : String ) DummyPublicKey.compareTo -
+core.crypto / DummyPublicKey / compareTo compareTo
+fun compareTo ( other : PublicKey ) : Int DummyPublicKey.equals -
+core.crypto / DummyPublicKey / equals equals
+fun equals ( other : Any ? ) : Boolean DummyPublicKey.getAlgorithm -
+core.crypto / DummyPublicKey / getAlgorithm getAlgorithm
+fun getAlgorithm ( ) : String DummyPublicKey.getEncoded -
+core.crypto / DummyPublicKey / getEncoded getEncoded
+fun getEncoded ( ) : <ERROR CLASS> DummyPublicKey.getFormat -
+core.crypto / DummyPublicKey / getFormat getFormat
+fun getFormat ( ) : String DummyPublicKey.hashCode -
+core.crypto / DummyPublicKey / hashCode hashCode
+fun hashCode ( ) : Int DummyPublicKey -
+core.crypto / DummyPublicKey DummyPublicKey
+class DummyPublicKey : PublicKey , Comparable < PublicKey > Constructors
+
+
+
+
+<init>
+
+DummyPublicKey ( s : String )
+
+
+
+Properties
+
+
+
+
+s
+
+val s : String
+
+
+
+Functions
+
+Extension Functions
+
+
+
+
+toStringShort
+
+fun PublicKey . toStringShort ( ) : String Render a public key to a string, using a short form if its an elliptic curve public key
+
+
+
+
+verifyWithECDSA
+
+fun PublicKey . verifyWithECDSA ( content : ByteArray , signature : DigitalSignature ) : Unit Utility to simplify the act of verifying a signature
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/s.html b/docs/build/html/api/core.crypto/-dummy-public-key/s.html
new file mode 100644
index 0000000000..bb917254a3
--- /dev/null
+++ b/docs/build/html/api/core.crypto/-dummy-public-key/s.html
@@ -0,0 +1,15 @@
+
+
+DummyPublicKey.s -
+core.crypto / DummyPublicKey / s s
+val s : String DummyPublicKey.toString -
+core.crypto / DummyPublicKey / toString toString
+fun toString ( ) : String NullPublicKey.compareTo -
+core.crypto / NullPublicKey / compareTo compareTo
+fun compareTo ( other : PublicKey ) : Int NullPublicKey.getAlgorithm -
+core.crypto / NullPublicKey / getAlgorithm getAlgorithm
+fun getAlgorithm ( ) : String NullPublicKey.getEncoded -
+core.crypto / NullPublicKey / getEncoded getEncoded
+fun getEncoded ( ) : ByteArray NullPublicKey.getFormat -
+core.crypto / NullPublicKey / getFormat getFormat
+fun getFormat ( ) : String NullPublicKey -
+core.crypto / NullPublicKey NullPublicKey
+object NullPublicKey : PublicKey , Comparable < PublicKey > Functions
+
+Extension Functions
+
+
+
+
+toStringShort
+
+fun PublicKey . toStringShort ( ) : String Render a public key to a string, using a short form if its an elliptic curve public key
+
+
+
+
+verifyWithECDSA
+
+fun PublicKey . verifyWithECDSA ( content : ByteArray , signature : DigitalSignature ) : Unit Utility to simplify the act of verifying a signature
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.crypto/-null-public-key/to-string.html b/docs/build/html/api/core.crypto/-null-public-key/to-string.html
new file mode 100644
index 0000000000..db2e9a537c
--- /dev/null
+++ b/docs/build/html/api/core.crypto/-null-public-key/to-string.html
@@ -0,0 +1,15 @@
+
+
+NullPublicKey.toString -
+core.crypto / NullPublicKey / toString toString
+fun toString ( ) : String SecureHash.SHA256.<init> -
+core.crypto / SecureHash / SHA256 / <init> <init>
+SHA256 ( bits : ByteArray ) SecureHash.SHA256 -
+core.crypto / SecureHash / SHA256 SHA256
+class SHA256 : SecureHash Constructors
+
+
+
+
+<init>
+
+SHA256 ( bits : ByteArray )
+
+
+
+Properties
+
+Inherited Functions
+
+
+
+
+prefixChars
+
+fun prefixChars ( prefixLen : Int = 6) : <ERROR CLASS>
+
+
+
+toString
+
+open fun toString ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/signature-algorithm-name.html b/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/signature-algorithm-name.html
new file mode 100644
index 0000000000..f385a8d85b
--- /dev/null
+++ b/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/signature-algorithm-name.html
@@ -0,0 +1,16 @@
+
+
+SecureHash.SHA256.signatureAlgorithmName -
+core.crypto / SecureHash / SHA256 / signatureAlgorithmName signatureAlgorithmName
+val signatureAlgorithmName : String SecureHash.signatureAlgorithmName SecureHash -
+core.crypto / SecureHash SecureHash
+sealed class SecureHash : OpaqueBytes Types
+
+
+
+
+SHA256
+
+class SHA256 : SecureHash
+
+
+
+Properties
+
+Inherited Properties
+
+
+
+
+bits
+
+val bits : ByteArray
+
+
+
+size
+
+val size : Int
+
+
+
+Functions
+
+
+
+
+prefixChars
+
+fun prefixChars ( prefixLen : Int = 6) : <ERROR CLASS>
+
+
+
+toString
+
+open fun toString ( ) : <ERROR CLASS>
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+Companion Object Functions
+
+
+
+
+parse
+
+fun parse ( str : String ) : <ERROR CLASS>
+
+
+
+randomSHA256
+
+fun randomSHA256 ( ) : SHA256
+
+
+
+sha256
+
+fun sha256 ( bits : ByteArray ) : SHA256 fun sha256 ( str : String ) : <ERROR CLASS>
+
+
+
+sha256Twice
+
+fun sha256Twice ( bits : ByteArray ) : SHA256
+
+
+
+Extension Functions
+
+Inheritors
+
+
+
+
+SHA256
+
+class SHA256 : SecureHash
+
+
+
+
+
diff --git a/docs/build/html/api/core.crypto/-secure-hash/parse.html b/docs/build/html/api/core.crypto/-secure-hash/parse.html
new file mode 100644
index 0000000000..80b4fd3c1f
--- /dev/null
+++ b/docs/build/html/api/core.crypto/-secure-hash/parse.html
@@ -0,0 +1,15 @@
+
+
+SecureHash.parse -
+core.crypto / SecureHash / parse parse
+fun parse ( str : String ) : <ERROR CLASS> SecureHash.prefixChars -
+core.crypto / SecureHash / prefixChars prefixChars
+fun prefixChars ( prefixLen : Int = 6) : <ERROR CLASS> SecureHash.randomSHA256 -
+core.crypto / SecureHash / randomSHA256 randomSHA256
+fun randomSHA256 ( ) : SHA256 SecureHash.sha256Twice -
+core.crypto / SecureHash / sha256Twice sha256Twice
+fun sha256Twice ( bits : ByteArray ) : SHA256 SecureHash.sha256 -
+core.crypto / SecureHash / sha256 sha256
+fun sha256 ( bits : ByteArray ) : SHA256 fun sha256 ( str : String ) : <ERROR CLASS> SecureHash.signatureAlgorithmName -
+core.crypto / SecureHash / signatureAlgorithmName signatureAlgorithmName
+abstract val signatureAlgorithmName : String SecureHash.toString -
+core.crypto / SecureHash / toString toString
+open fun toString ( ) : <ERROR CLASS> OpaqueBytes.toString SignedData.<init> -
+core.crypto / SignedData / <init> <init>
+SignedData ( raw : SerializedBytes < T > , sig : WithKey ) A serialized piece of data and its signature. Enforces signature validity in order to deserialize the data
+contained within.
+Parameters
+raw - the raw serialized datasig - the (unverified) signature for the dataSignedData -
+core.crypto / SignedData SignedData
+open class SignedData < T : Any > A serialized piece of data and its signature. Enforces signature validity in order to deserialize the data
+contained within.
+Parameters
+raw - the raw serialized datasig - the (unverified) signature for the dataConstructors
+
+
+
+
+<init>
+
+SignedData ( raw : SerializedBytes < T > , sig : WithKey ) A serialized piece of data and its signature. Enforces signature validity in order to deserialize the data
+contained within.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+verified
+
+fun verified ( ) : T Return the deserialized data if the signature can be verified.
+
+
+
+
+verifyData
+
+open fun verifyData ( data : T ) : Unit Verify the wrapped data after the signature has been verified and the data deserialised. Provided as an extension
+point for subclasses.
+
+
+
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/core.crypto/-signed-data/raw.html b/docs/build/html/api/core.crypto/-signed-data/raw.html
new file mode 100644
index 0000000000..355bb7a031
--- /dev/null
+++ b/docs/build/html/api/core.crypto/-signed-data/raw.html
@@ -0,0 +1,15 @@
+
+
+SignedData.raw -
+core.crypto / SignedData / raw raw
+val raw : SerializedBytes < T > SignedData.sig -
+core.crypto / SignedData / sig sig
+val sig : WithKey SignedData.verified -
+core.crypto / SignedData / verified verified
+fun verified ( ) : T Return the deserialized data if the signature can be verified.
+Exceptions
+IllegalArgumentException - if the data is invalid (only used if verifyData() is overloaded).SignatureException - if the signature is invalid.SignedData.verifyData -
+core.crypto / SignedData / verifyData verifyData
+protected open fun verifyData ( data : T ) : Unit Verify the wrapped data after the signature has been verified and the data deserialised. Provided as an extension
+point for subclasses.
+Exceptions
+IllegalArgumentException - if the data is invalid.generateKeyPair -
+core.crypto / generateKeyPair generateKeyPair
+fun generateKeyPair ( ) : KeyPair A simple wrapper that will make it easier to swap out the EC algorithm we use in future
+core.crypto -
+core.crypto Package core.crypto
+Types
+
+
+
+
+DigitalSignature
+
+open class DigitalSignature : OpaqueBytes A wrapper around a digital signature. The covering field is a generic tag usable by whatever is interpreting the
+signature. It isnt used currently, but experience from Bitcoin suggests such a feature is useful, especially when
+building partially signed transactions.
+
+
+
+
+DummyPublicKey
+
+class DummyPublicKey : PublicKey , Comparable < PublicKey >
+
+
+
+NullPublicKey
+
+object NullPublicKey : PublicKey , Comparable < PublicKey >
+
+
+
+SecureHash
+
+sealed class SecureHash : OpaqueBytes
+
+
+
+SignedData
+
+open class SignedData < T : Any > A serialized piece of data and its signature. Enforces signature validity in order to deserialize the data
+contained within.
+
+
+
+
+Extensions for External Classes
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.crypto/java.security.-key-pair/component1.html b/docs/build/html/api/core.crypto/java.security.-key-pair/component1.html
new file mode 100644
index 0000000000..e3cd60f572
--- /dev/null
+++ b/docs/build/html/api/core.crypto/java.security.-key-pair/component1.html
@@ -0,0 +1,15 @@
+
+
+component1 -
+core.crypto / java.security.KeyPair / component1 component1
+operator fun KeyPair . component1 ( ) : PrivateKey component2 -
+core.crypto / java.security.KeyPair / component2 component2
+operator fun KeyPair . component2 ( ) : PublicKey core.crypto.java.security.KeyPair -
+core.crypto / java.security.KeyPair Extensions for java.security.KeyPair
+
+
+
diff --git a/docs/build/html/api/core.crypto/java.security.-key-pair/sign-with-e-c-d-s-a.html b/docs/build/html/api/core.crypto/java.security.-key-pair/sign-with-e-c-d-s-a.html
new file mode 100644
index 0000000000..ea70ec4e1c
--- /dev/null
+++ b/docs/build/html/api/core.crypto/java.security.-key-pair/sign-with-e-c-d-s-a.html
@@ -0,0 +1,21 @@
+
+
+signWithECDSA -
+core.crypto / java.security.KeyPair / signWithECDSA signWithECDSA
+fun KeyPair . signWithECDSA ( bitsToSign : ByteArray ) : WithKey fun KeyPair . signWithECDSA ( bitsToSign : OpaqueBytes ) : WithKey fun KeyPair . signWithECDSA ( bitsToSign : OpaqueBytes , party : Party ) : LegallyIdentifiable fun KeyPair . signWithECDSA ( bitsToSign : ByteArray , party : Party ) : LegallyIdentifiable core.crypto.java.security.PrivateKey -
+core.crypto / java.security.PrivateKey Extensions for java.security.PrivateKey
+
+
+
diff --git a/docs/build/html/api/core.crypto/java.security.-private-key/sign-with-e-c-d-s-a.html b/docs/build/html/api/core.crypto/java.security.-private-key/sign-with-e-c-d-s-a.html
new file mode 100644
index 0000000000..bab411e816
--- /dev/null
+++ b/docs/build/html/api/core.crypto/java.security.-private-key/sign-with-e-c-d-s-a.html
@@ -0,0 +1,20 @@
+
+
+signWithECDSA -
+core.crypto / java.security.PrivateKey / signWithECDSA signWithECDSA
+fun PrivateKey . signWithECDSA ( bits : ByteArray ) : DigitalSignature Utility to simplify the act of signing a byte array
+fun PrivateKey . signWithECDSA ( bitsToSign : ByteArray , publicKey : PublicKey ) : WithKey core.crypto.java.security.PublicKey -
+core.crypto / java.security.PublicKey Extensions for java.security.PublicKey
+
+
+
+
+toStringShort
+
+fun PublicKey . toStringShort ( ) : String Render a public key to a string, using a short form if its an elliptic curve public key
+
+
+
+
+verifyWithECDSA
+
+fun PublicKey . verifyWithECDSA ( content : ByteArray , signature : DigitalSignature ) : Unit Utility to simplify the act of verifying a signature
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.crypto/java.security.-public-key/to-string-short.html b/docs/build/html/api/core.crypto/java.security.-public-key/to-string-short.html
new file mode 100644
index 0000000000..ce69028b41
--- /dev/null
+++ b/docs/build/html/api/core.crypto/java.security.-public-key/to-string-short.html
@@ -0,0 +1,16 @@
+
+
+toStringShort -
+core.crypto / java.security.PublicKey / toStringShort toStringShort
+fun PublicKey . toStringShort ( ) : String Render a public key to a string, using a short form if its an elliptic curve public key
+verifyWithECDSA -
+core.crypto / java.security.PublicKey / verifyWithECDSA verifyWithECDSA
+fun PublicKey . verifyWithECDSA ( content : ByteArray , signature : DigitalSignature ) : Unit Utility to simplify the act of verifying a signature
+core.crypto.kotlin.ByteArray -
+core.crypto / kotlin.ByteArray Extensions for kotlin.ByteArray
+
+
+
diff --git a/docs/build/html/api/core.crypto/kotlin.-byte-array/sha256.html b/docs/build/html/api/core.crypto/kotlin.-byte-array/sha256.html
new file mode 100644
index 0000000000..1d3b8e305a
--- /dev/null
+++ b/docs/build/html/api/core.crypto/kotlin.-byte-array/sha256.html
@@ -0,0 +1,15 @@
+
+
+sha256 -
+core.crypto / kotlin.ByteArray / sha256 sha256
+fun ByteArray . sha256 ( ) : SHA256 sha256 -
+core.crypto / sha256 sha256
+fun OpaqueBytes . sha256 ( ) : SHA256 CubicSplineInterpolator.<init> -
+core.math / CubicSplineInterpolator / <init> <init>
+CubicSplineInterpolator ( xs : DoubleArray , ys : DoubleArray ) Interpolates values between the given data points using a SplineFunction .
+Implementation uses the Natural Cubic Spline algorithm as described in
+R. L. Burden and J. D. Faires (2011), Numerical Analysis . 9th ed. Boston, MA: Brooks/Cole, Cengage Learning. p149-150.
+CubicSplineInterpolator.create -
+core.math / CubicSplineInterpolator / create create
+fun create ( xs : DoubleArray , ys : DoubleArray ) : CubicSplineInterpolator InterpolatorFactory.create CubicSplineInterpolator -
+core.math / CubicSplineInterpolator CubicSplineInterpolator
+class CubicSplineInterpolator : Interpolator Interpolates values between the given data points using a SplineFunction .
+Implementation uses the Natural Cubic Spline algorithm as described in
+R. L. Burden and J. D. Faires (2011), Numerical Analysis . 9th ed. Boston, MA: Brooks/Cole, Cengage Learning. p149-150.
+Constructors
+
+
+
+
+<init>
+
+CubicSplineInterpolator ( xs : DoubleArray , ys : DoubleArray ) Interpolates values between the given data points using a SplineFunction .
+
+
+
+
+Functions
+
+
+
+
+interpolate
+
+fun interpolate ( x : Double ) : Double
+
+
+
+Companion Object Functions
+
+
+
+
+create
+
+fun create ( xs : DoubleArray , ys : DoubleArray ) : CubicSplineInterpolator
+
+
+
+
+
diff --git a/docs/build/html/api/core.math/-cubic-spline-interpolator/interpolate.html b/docs/build/html/api/core.math/-cubic-spline-interpolator/interpolate.html
new file mode 100644
index 0000000000..bb03b871b1
--- /dev/null
+++ b/docs/build/html/api/core.math/-cubic-spline-interpolator/interpolate.html
@@ -0,0 +1,16 @@
+
+
+CubicSplineInterpolator.interpolate -
+core.math / CubicSplineInterpolator / interpolate interpolate
+fun interpolate ( x : Double ) : Double Interpolator.interpolate InterpolatorFactory.create -
+core.math / InterpolatorFactory / create create
+abstract fun create ( xs : DoubleArray , ys : DoubleArray ) : Interpolator InterpolatorFactory -
+core.math / InterpolatorFactory InterpolatorFactory
+interface InterpolatorFactory Functions
+
+
+
+
+create
+
+abstract fun create ( xs : DoubleArray , ys : DoubleArray ) : Interpolator
+
+
+
+
+
diff --git a/docs/build/html/api/core.math/-interpolator/index.html b/docs/build/html/api/core.math/-interpolator/index.html
new file mode 100644
index 0000000000..5ff1f88cb7
--- /dev/null
+++ b/docs/build/html/api/core.math/-interpolator/index.html
@@ -0,0 +1,44 @@
+
+
+Interpolator -
+core.math / Interpolator Interpolator
+interface Interpolator Functions
+
+
+
+
+interpolate
+
+abstract fun interpolate ( x : Double ) : Double
+
+
+
+Inheritors
+
+
+
+
+CubicSplineInterpolator
+
+class CubicSplineInterpolator : Interpolator Interpolates values between the given data points using a SplineFunction .
+
+
+
+
+LinearInterpolator
+
+class LinearInterpolator : Interpolator Interpolates values between the given data points using straight lines
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.math/-interpolator/interpolate.html b/docs/build/html/api/core.math/-interpolator/interpolate.html
new file mode 100644
index 0000000000..62912b5690
--- /dev/null
+++ b/docs/build/html/api/core.math/-interpolator/interpolate.html
@@ -0,0 +1,15 @@
+
+
+Interpolator.interpolate -
+core.math / Interpolator / interpolate interpolate
+abstract fun interpolate ( x : Double ) : Double LinearInterpolator.<init> -
+core.math / LinearInterpolator / <init> <init>
+LinearInterpolator ( xs : DoubleArray , ys : DoubleArray ) Interpolates values between the given data points using straight lines
+LinearInterpolator.create -
+core.math / LinearInterpolator / create create
+fun create ( xs : DoubleArray , ys : DoubleArray ) : LinearInterpolator InterpolatorFactory.create LinearInterpolator -
+core.math / LinearInterpolator LinearInterpolator
+class LinearInterpolator : Interpolator Interpolates values between the given data points using straight lines
+Constructors
+
+
+
+
+<init>
+
+LinearInterpolator ( xs : DoubleArray , ys : DoubleArray ) Interpolates values between the given data points using straight lines
+
+
+
+
+Functions
+
+
+
+
+interpolate
+
+fun interpolate ( x : Double ) : Double
+
+
+
+Companion Object Functions
+
+
+
+
+create
+
+fun create ( xs : DoubleArray , ys : DoubleArray ) : LinearInterpolator
+
+
+
+
+
diff --git a/docs/build/html/api/core.math/-linear-interpolator/interpolate.html b/docs/build/html/api/core.math/-linear-interpolator/interpolate.html
new file mode 100644
index 0000000000..c2177cf1eb
--- /dev/null
+++ b/docs/build/html/api/core.math/-linear-interpolator/interpolate.html
@@ -0,0 +1,16 @@
+
+
+LinearInterpolator.interpolate -
+core.math / LinearInterpolator / interpolate interpolate
+fun interpolate ( x : Double ) : Double Interpolator.interpolate Polynomial.<init> -
+core.math / Polynomial / <init> <init>
+Polynomial ( coefficients : DoubleArray ) Represents a polynomial function of arbitrary degree
+Parameters
+coefficients - polynomial coefficients in the order of degree (constant first, followed by higher degree term coefficients)Polynomial.getValue -
+core.math / Polynomial / getValue getValue
+fun getValue ( x : Double ) : <ERROR CLASS> Polynomial -
+core.math / Polynomial Polynomial
+class Polynomial Represents a polynomial function of arbitrary degree
+Parameters
+coefficients - polynomial coefficients in the order of degree (constant first, followed by higher degree term coefficients)Constructors
+
+
+
+
+<init>
+
+Polynomial ( coefficients : DoubleArray ) Represents a polynomial function of arbitrary degree
+
+
+
+
+Functions
+
+
+
+
+getValue
+
+fun getValue ( x : Double ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/core.math/-spline-function/-init-.html b/docs/build/html/api/core.math/-spline-function/-init-.html
new file mode 100644
index 0000000000..ff34aea811
--- /dev/null
+++ b/docs/build/html/api/core.math/-spline-function/-init-.html
@@ -0,0 +1,19 @@
+
+
+SplineFunction.<init> -
+core.math / SplineFunction / <init> <init>
+SplineFunction ( segmentMap : TreeMap < Double , Polynomial > ) A spline is function piecewise-defined by polynomial functions.
+Points at which polynomial pieces connect are known as knots .
+Parameters
+segmentMap - a mapping between a knot and the polynomial that covers the subsequent intervalSplineFunction.getValue -
+core.math / SplineFunction / getValue getValue
+fun getValue ( x : Double ) : Double SplineFunction -
+core.math / SplineFunction SplineFunction
+class SplineFunction A spline is function piecewise-defined by polynomial functions.
+Points at which polynomial pieces connect are known as knots .
+Parameters
+segmentMap - a mapping between a knot and the polynomial that covers the subsequent intervalConstructors
+
+
+
+
+<init>
+
+SplineFunction ( segmentMap : TreeMap < Double , Polynomial > ) A spline is function piecewise-defined by polynomial functions.
+Points at which polynomial pieces connect are known as knots .
+
+
+
+
+Functions
+
+
+
+
+getValue
+
+fun getValue ( x : Double ) : Double
+
+
+
+
+
diff --git a/docs/build/html/api/core.math/index.html b/docs/build/html/api/core.math/index.html
new file mode 100644
index 0000000000..7b74ffa5b4
--- /dev/null
+++ b/docs/build/html/api/core.math/index.html
@@ -0,0 +1,57 @@
+
+
+core.math -
+core.math Package core.math
+Types
+
+
+
+
+CubicSplineInterpolator
+
+class CubicSplineInterpolator : Interpolator Interpolates values between the given data points using a SplineFunction .
+
+
+
+
+Interpolator
+
+interface Interpolator
+
+
+
+InterpolatorFactory
+
+interface InterpolatorFactory
+
+
+
+LinearInterpolator
+
+class LinearInterpolator : Interpolator Interpolates values between the given data points using straight lines
+
+
+
+
+Polynomial
+
+class Polynomial Represents a polynomial function of arbitrary degree
+
+
+
+
+SplineFunction
+
+class SplineFunction A spline is function piecewise-defined by polynomial functions.
+Points at which polynomial pieces connect are known as knots .
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/-all-possible-recipients.html b/docs/build/html/api/core.messaging/-all-possible-recipients.html
new file mode 100644
index 0000000000..e7c15d9999
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-all-possible-recipients.html
@@ -0,0 +1,15 @@
+
+
+AllPossibleRecipients -
+core.messaging / AllPossibleRecipients AllPossibleRecipients
+interface AllPossibleRecipients : MessageRecipients A special base class for the set of all possible recipients, without having to identify who they all are.
+MessageHandlerRegistration -
+core.messaging / MessageHandlerRegistration MessageHandlerRegistration
+interface MessageHandlerRegistration Inheritors
+
+
+
+
+Handler
+
+inner class Handler : MessageHandlerRegistration A registration to handle messages of different types
+
+
+
+
+Handler
+
+inner class Handler : MessageHandlerRegistration
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/-message-recipient-group.html b/docs/build/html/api/core.messaging/-message-recipient-group.html
new file mode 100644
index 0000000000..2c0e30e09c
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-message-recipient-group.html
@@ -0,0 +1,15 @@
+
+
+MessageRecipientGroup -
+core.messaging / MessageRecipientGroup MessageRecipientGroup
+interface MessageRecipientGroup : MessageRecipients A base class for a set of recipients specifically identified by the sender.
+MessageRecipients -
+core.messaging / MessageRecipients MessageRecipients
+interface MessageRecipients The interface for a group of message recipients (which may contain only one recipient)
+Inheritors
+
+
+
+
+AllPossibleRecipients
+
+interface AllPossibleRecipients : MessageRecipients A special base class for the set of all possible recipients, without having to identify who they all are.
+
+
+
+
+MessageRecipientGroup
+
+interface MessageRecipientGroup : MessageRecipients A base class for a set of recipients specifically identified by the sender.
+
+
+
+
+SingleMessageRecipient
+
+interface SingleMessageRecipient : MessageRecipients A base class for the case of point-to-point messages
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/-message/data.html b/docs/build/html/api/core.messaging/-message/data.html
new file mode 100644
index 0000000000..6265b6f3cb
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-message/data.html
@@ -0,0 +1,15 @@
+
+
+Message.data -
+core.messaging / Message / data data
+abstract val data : ByteArray Message.debugMessageID -
+core.messaging / Message / debugMessageID debugMessageID
+abstract val debugMessageID : String Message.debugTimestamp -
+core.messaging / Message / debugTimestamp debugTimestamp
+abstract val debugTimestamp : Instant Message -
+core.messaging / Message Message
+interface Message A message is defined, at this level, to be a (topic, timestamp, byte arrays) triple, where the topic is a string in
+Java-style reverse dns form, with "platform." being a prefix reserved by the platform for its own use. Vendor
+specific messages can be defined, but use your domain name as the prefix e.g. "uk.co.bigbank.messages.SomeMessage".
+The debugTimestamp field is intended to aid in tracking messages as they flow across the network, likewise, the
+message ID is intended to be an ad-hoc way to identify a message sent in the system through debug logs and so on.
+These IDs and timestamps should not be assumed to be globally unique, although due to the nanosecond precision of
+the timestamp field they probably will be, even if an implementation just uses a hash prefix as the message id.
+Properties
+
+Functions
+
+
+
+
+serialise
+
+abstract fun serialise ( ) : ByteArray
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/-message/serialise.html b/docs/build/html/api/core.messaging/-message/serialise.html
new file mode 100644
index 0000000000..fbd1892aac
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-message/serialise.html
@@ -0,0 +1,15 @@
+
+
+Message.serialise -
+core.messaging / Message / serialise serialise
+abstract fun serialise ( ) : ByteArray Message.topic -
+core.messaging / Message / topic topic
+abstract val topic : String MessagingServiceBuilder -
+core.messaging / MessagingServiceBuilder MessagingServiceBuilder
+interface MessagingServiceBuilder < out T : MessagingService > This class lets you start up a MessagingService . Its purpose is to stop you from getting access to the methods
+on the messaging service interface until you have successfully started up the system. One of these objects should
+be the only way to obtain a reference to a MessagingService . Startup may be a slow process: some implementations
+may let you cast the returned future to an object that lets you get status info.
+A specific implementation of the controller class will have extra features that let you customise it before starting
+it up.
+Functions
+
+
+
+
+start
+
+abstract fun start ( ) : <ERROR CLASS> < out T >
+
+
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/core.messaging/-messaging-service-builder/start.html b/docs/build/html/api/core.messaging/-messaging-service-builder/start.html
new file mode 100644
index 0000000000..1f0675d399
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-messaging-service-builder/start.html
@@ -0,0 +1,15 @@
+
+
+MessagingServiceBuilder.start -
+core.messaging / MessagingServiceBuilder / start start
+abstract fun start ( ) : <ERROR CLASS> < out T > MessagingService.addMessageHandler -
+core.messaging / MessagingService / addMessageHandler addMessageHandler
+abstract fun addMessageHandler ( topic : String = "", executor : Executor ? = null, callback : ( Message , MessageHandlerRegistration ) -> Unit ) : MessageHandlerRegistration The provided function will be invoked for each received message whose topic matches the given string, on the given
+executor. The topic can be the empty string to match all messages.
+If no executor is received then the callback will run on threads provided by the messaging service, and the
+callback is expected to be thread safe as a result.
+The returned object is an opaque handle that may be used to un-register handlers later with removeMessageHandler .
+The handle is passed to the callback as well, to avoid race conditions whereby the callback wants to unregister
+itself and yet addMessageHandler hasnt returned the handle yet.
+MessagingService.createMessage -
+core.messaging / MessagingService / createMessage createMessage
+abstract fun createMessage ( topic : String , data : ByteArray ) : Message Returns an initialised Message with the current time, etc, already filled in.
+MessagingService -
+core.messaging / MessagingService MessagingService
+interface MessagingService A MessagingService sits at the boundary between a message routing / networking layer and the core platform code.
+A messaging system must provide the ability to send 1:many messages, potentially to an abstract "group", the
+membership of which is defined elsewhere. Messages are atomic and the system guarantees that a sent message
+eventually will arrive in the exact form it was sent, however, messages can be arbitrarily re-ordered or delayed.
+Example implementations might be a custom P2P layer, Akka, Apache Kafka, etc. It is assumed that the message layer
+is reliable and as such messages may be stored to disk once queued.
+Properties
+
+Functions
+
+
+
+
+addMessageHandler
+
+abstract fun addMessageHandler ( topic : String = "", executor : Executor ? = null, callback : ( Message , MessageHandlerRegistration ) -> Unit ) : MessageHandlerRegistration The provided function will be invoked for each received message whose topic matches the given string, on the given
+executor. The topic can be the empty string to match all messages.
+
+
+
+
+createMessage
+
+abstract fun createMessage ( topic : String , data : ByteArray ) : Message Returns an initialised Message with the current time, etc, already filled in.
+
+
+
+
+removeMessageHandler
+
+abstract fun removeMessageHandler ( registration : MessageHandlerRegistration ) : Unit Removes a handler given the object returned from addMessageHandler . The callback will no longer be invoked once
+this method has returned, although executions that are currently in flight will not be interrupted.
+
+
+
+
+send
+
+abstract fun send ( message : Message , target : MessageRecipients ) : Unit Sends a message to the given receiver. The details of how receivers are identified is up to the messaging
+implementation: the type system provides an opaque high level view, with more fine grained control being
+available via type casting. Once this function returns the message is queued for delivery but not necessarily
+delivered: if the recipients are offline then the message could be queued hours or days later.
+
+
+
+
+stop
+
+abstract fun stop ( ) : Unit
+
+
+
+Extension Functions
+
+
+
+
+runOnNextMessage
+
+fun MessagingService . runOnNextMessage ( topic : String = "", executor : Executor ? = null, callback : ( Message ) -> Unit ) : Unit Registers a handler for the given topic that runs the given callback with the message and then removes itself. This
+is useful for one-shot handlers that arent supposed to stick around permanently. Note that this callback doesnt
+take the registration object, unlike the callback to MessagingService.addMessageHandler .
+
+
+
+
+send
+
+fun MessagingService . send ( topic : String , to : MessageRecipients , obj : Any ) : Unit
+
+
+
+Inheritors
+
+
+
+
+ArtemisMessagingService
+
+class ArtemisMessagingService : MessagingService This class implements the MessagingService API using Apache Artemis, the successor to their ActiveMQ product.
+Artemis is a message queue broker and here, we embed the entire server inside our own process. Nodes communicate
+with each other using (by default) an Artemis specific protocol, but it supports other protocols like AQMP/1.0
+as well.
+
+
+
+
+InMemoryMessaging
+
+inner class InMemoryMessaging : MessagingService An InMemoryMessaging provides a MessagingService that isnt backed by any kind of network or disk storage
+system, but just uses regular queues on the heap instead. It is intended for unit testing and developer convenience
+when all entities on the network are being simulated in-process.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/-messaging-service/my-address.html b/docs/build/html/api/core.messaging/-messaging-service/my-address.html
new file mode 100644
index 0000000000..5f0286063d
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-messaging-service/my-address.html
@@ -0,0 +1,16 @@
+
+
+MessagingService.myAddress -
+core.messaging / MessagingService / myAddress myAddress
+abstract val myAddress : SingleMessageRecipient Returns an address that refers to this node.
+MessagingService.removeMessageHandler -
+core.messaging / MessagingService / removeMessageHandler removeMessageHandler
+abstract fun removeMessageHandler ( registration : MessageHandlerRegistration ) : Unit Removes a handler given the object returned from addMessageHandler . The callback will no longer be invoked once
+this method has returned, although executions that are currently in flight will not be interrupted.
+Exceptions
+IllegalArgumentException - if the given registration isnt valid for this messaging service.IllegalStateException - if the given registration was already de-registered.MessagingService.send -
+core.messaging / MessagingService / send send
+abstract fun send ( message : Message , target : MessageRecipients ) : Unit Sends a message to the given receiver. The details of how receivers are identified is up to the messaging
+implementation: the type system provides an opaque high level view, with more fine grained control being
+available via type casting. Once this function returns the message is queued for delivery but not necessarily
+delivered: if the recipients are offline then the message could be queued hours or days later.
+There is no way to know if a message has been received. If your protocol requires this, you need the recipient
+to send an ACK message back.
+MessagingService.stop -
+core.messaging / MessagingService / stop stop
+abstract fun stop ( ) : Unit SingleMessageRecipient -
+core.messaging / SingleMessageRecipient SingleMessageRecipient
+interface SingleMessageRecipient : MessageRecipients A base class for the case of point-to-point messages
+Inheritors
+
+
+
+
+Handle
+
+class Handle : SingleMessageRecipient
+
+
+
+MockAddress
+
+data class MockAddress : SingleMessageRecipient
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/-stack-snapshot/-init-.html b/docs/build/html/api/core.messaging/-stack-snapshot/-init-.html
new file mode 100644
index 0000000000..e918751227
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-stack-snapshot/-init-.html
@@ -0,0 +1,14 @@
+
+
+StackSnapshot.<init> -
+core.messaging / StackSnapshot / <init> <init>
+StackSnapshot ( ) StackSnapshot -
+core.messaging / StackSnapshot StackSnapshot
+class StackSnapshot : Throwable Constructors
+
+
+
+
+<init>
+
+StackSnapshot ( )
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/-init-.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/-init-.html
new file mode 100644
index 0000000000..bc39c91e16
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/-init-.html
@@ -0,0 +1,14 @@
+
+
+StateMachineManager.FiberRequest.ExpectingResponse.<init> -
+core.messaging / StateMachineManager / FiberRequest / ExpectingResponse / <init> <init>
+ExpectingResponse ( topic : String , destination : MessageRecipients ? , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ? , responseType : Class < R > ) StateMachineManager.FiberRequest.ExpectingResponse -
+core.messaging / StateMachineManager / FiberRequest / ExpectingResponse ExpectingResponse
+class ExpectingResponse < R : Any > : FiberRequest Constructors
+
+
+
+
+<init>
+
+ExpectingResponse ( topic : String , destination : MessageRecipients ? , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ? , responseType : Class < R > )
+
+
+
+Properties
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/response-type.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/response-type.html
new file mode 100644
index 0000000000..06808768a7
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/response-type.html
@@ -0,0 +1,15 @@
+
+
+StateMachineManager.FiberRequest.ExpectingResponse.responseType -
+core.messaging / StateMachineManager / FiberRequest / ExpectingResponse / responseType responseType
+val responseType : Class < R > StateMachineManager.FiberRequest.<init> -
+core.messaging / StateMachineManager / FiberRequest / <init> <init>
+FiberRequest ( topic : String , destination : MessageRecipients ? , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ? ) StateMachineManager.FiberRequest.NotExpectingResponse.<init> -
+core.messaging / StateMachineManager / FiberRequest / NotExpectingResponse / <init> <init>
+NotExpectingResponse ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , obj : Any ? ) StateMachineManager.FiberRequest.NotExpectingResponse -
+core.messaging / StateMachineManager / FiberRequest / NotExpectingResponse NotExpectingResponse
+class NotExpectingResponse : FiberRequest Constructors
+
+
+
+
+<init>
+
+NotExpectingResponse ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , obj : Any ? )
+
+
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/destination.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/destination.html
new file mode 100644
index 0000000000..c67bf7ad20
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/destination.html
@@ -0,0 +1,15 @@
+
+
+StateMachineManager.FiberRequest.destination -
+core.messaging / StateMachineManager / FiberRequest / destination destination
+val destination : MessageRecipients ? StateMachineManager.FiberRequest -
+core.messaging / StateMachineManager / FiberRequest FiberRequest
+class FiberRequest Types
+
+Constructors
+
+
+
+
+<init>
+
+FiberRequest ( topic : String , destination : MessageRecipients ? , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ? )
+
+
+
+Properties
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/obj.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/obj.html
new file mode 100644
index 0000000000..59a930234b
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/obj.html
@@ -0,0 +1,15 @@
+
+
+StateMachineManager.FiberRequest.obj -
+core.messaging / StateMachineManager / FiberRequest / obj obj
+val obj : Any ? StateMachineManager.FiberRequest.sessionIDForReceive -
+core.messaging / StateMachineManager / FiberRequest / sessionIDForReceive sessionIDForReceive
+val sessionIDForReceive : Long StateMachineManager.FiberRequest.sessionIDForSend -
+core.messaging / StateMachineManager / FiberRequest / sessionIDForSend sessionIDForSend
+val sessionIDForSend : Long StateMachineManager.FiberRequest.stackTraceInCaseOfProblems -
+core.messaging / StateMachineManager / FiberRequest / stackTraceInCaseOfProblems stackTraceInCaseOfProblems
+val stackTraceInCaseOfProblems : StackSnapshot StateMachineManager.FiberRequest.topic -
+core.messaging / StateMachineManager / FiberRequest / topic topic
+val topic : String StateMachineManager.FiberScheduler.<init> -
+core.messaging / StateMachineManager / FiberScheduler / <init> <init>
+FiberScheduler ( ) StateMachineManager.FiberScheduler -
+core.messaging / StateMachineManager / FiberScheduler FiberScheduler
+inner class FiberScheduler Constructors
+
+
+
+
+<init>
+
+FiberScheduler ( )
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-init-.html b/docs/build/html/api/core.messaging/-state-machine-manager/-init-.html
new file mode 100644
index 0000000000..70db983fe2
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-state-machine-manager/-init-.html
@@ -0,0 +1,35 @@
+
+
+StateMachineManager.<init> -
+core.messaging / StateMachineManager / <init> <init>
+StateMachineManager ( serviceHub : ServiceHub , executor : AffinityExecutor ) A StateMachineManager is responsible for coordination and persistence of multiple ProtocolStateMachine objects.
+Each such object represents an instantiation of a (two-party) protocol that has reached a particular point.
+An implementation of this class will persist state machines to long term storage so they can survive process restarts
+and, if run with a single-threaded executor, will ensure no two state machines run concurrently with each other
+(bad for performance, good for programmer mental health).
+A "state machine" is a class with a single call method. The call method and any others it invokes are rewritten by
+a bytecode rewriting engine called Quasar, to ensure the code can be suspended and resumed at any point.
+The SMM will always invoke the protocol fibers on the given AffinityExecutor , regardless of which thread actually
+starts them via add .
+TODO: Session IDs should be set up and propagated automatically, on demand.
+TODO: Consider the issue of continuation identity more deeply: is it a safe assumption that a serialised
+continuation is always unique?
+TODO: Think about how to bring the system to a clean stop so it can be upgraded without any serialised stacks on disk
+TODO: Timeouts
+TODO: Surfacing of exceptions via an API and/or management UI
+TODO: Ability to control checkpointing explicitly, for cases where you know replaying a message cant hurt
+TODO: Make Kryo (de)serialize markers for heavy objects that are currently in the service hub. This avoids mistakes
+where services are temporarily put on the stack.
+TODO: Implement stub/skel classes that provide a basic RPC framework on top of this.
+StateMachineManager.add -
+core.messaging / StateMachineManager / add add
+fun < T > add ( loggerName : String , logic : ProtocolLogic < T > ) : <ERROR CLASS> < T > Kicks off a brand new state machine of the given class. It will log with the named logger.
+The state machine will be persisted when it suspends, with automated restart if the StateMachineManager is
+restarted with checkpointed state machines in the storage service.
+StateMachineManager.executor -
+core.messaging / StateMachineManager / executor executor
+val executor : AffinityExecutor StateMachineManager.findStateMachines -
+core.messaging / StateMachineManager / findStateMachines findStateMachines
+fun < T > findStateMachines ( klass : Class < out ProtocolLogic < T > > ) : List < <ERROR CLASS> < ProtocolLogic < T > , <ERROR CLASS> < T > > > Returns a list of all state machines executing the given protocol logic at the top level (subprotocols do not count)
+StateMachineManager -
+core.messaging / StateMachineManager StateMachineManager
+class StateMachineManager A StateMachineManager is responsible for coordination and persistence of multiple ProtocolStateMachine objects.
+Each such object represents an instantiation of a (two-party) protocol that has reached a particular point.
+An implementation of this class will persist state machines to long term storage so they can survive process restarts
+and, if run with a single-threaded executor, will ensure no two state machines run concurrently with each other
+(bad for performance, good for programmer mental health).
+A "state machine" is a class with a single call method. The call method and any others it invokes are rewritten by
+a bytecode rewriting engine called Quasar, to ensure the code can be suspended and resumed at any point.
+The SMM will always invoke the protocol fibers on the given AffinityExecutor , regardless of which thread actually
+starts them via add .
+TODO: Session IDs should be set up and propagated automatically, on demand.
+TODO: Consider the issue of continuation identity more deeply: is it a safe assumption that a serialised
+continuation is always unique?
+TODO: Think about how to bring the system to a clean stop so it can be upgraded without any serialised stacks on disk
+TODO: Timeouts
+TODO: Surfacing of exceptions via an API and/or management UI
+TODO: Ability to control checkpointing explicitly, for cases where you know replaying a message cant hurt
+TODO: Make Kryo (de)serialize markers for heavy objects that are currently in the service hub. This avoids mistakes
+where services are temporarily put on the stack.
+TODO: Implement stub/skel classes that provide a basic RPC framework on top of this.
+Types
+
+Constructors
+
+
+
+
+<init>
+
+StateMachineManager ( serviceHub : ServiceHub , executor : AffinityExecutor ) A StateMachineManager is responsible for coordination and persistence of multiple ProtocolStateMachine objects.
+Each such object represents an instantiation of a (two-party) protocol that has reached a particular point.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+add
+
+fun < T > add ( loggerName : String , logic : ProtocolLogic < T > ) : <ERROR CLASS> < T > Kicks off a brand new state machine of the given class. It will log with the named logger.
+The state machine will be persisted when it suspends, with automated restart if the StateMachineManager is
+restarted with checkpointed state machines in the storage service.
+
+
+
+
+findStateMachines
+
+fun < T > findStateMachines ( klass : Class < out ProtocolLogic < T > > ) : List < <ERROR CLASS> < ProtocolLogic < T > , <ERROR CLASS> < T > > > Returns a list of all state machines executing the given protocol logic at the top level (subprotocols do not count)
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/scheduler.html b/docs/build/html/api/core.messaging/-state-machine-manager/scheduler.html
new file mode 100644
index 0000000000..f99b8f43ef
--- /dev/null
+++ b/docs/build/html/api/core.messaging/-state-machine-manager/scheduler.html
@@ -0,0 +1,15 @@
+
+
+StateMachineManager.scheduler -
+core.messaging / StateMachineManager / scheduler scheduler
+val scheduler : FiberScheduler StateMachineManager.serviceHub -
+core.messaging / StateMachineManager / serviceHub serviceHub
+val serviceHub : ServiceHub TopicStringValidator.check -
+core.messaging / TopicStringValidator / check check
+fun check ( tag : String ) : <ERROR CLASS> Exceptions
+IllegalArgumentException - if the given topic contains invalid charactersTopicStringValidator -
+core.messaging / TopicStringValidator TopicStringValidator
+object TopicStringValidator A singleton thats useful for validating topic strings
+Functions
+
+
+
+
+check
+
+fun check ( tag : String ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/core.messaging/index.html b/docs/build/html/api/core.messaging/index.html
new file mode 100644
index 0000000000..842b8f464b
--- /dev/null
+++ b/docs/build/html/api/core.messaging/index.html
@@ -0,0 +1,122 @@
+
+
+core.messaging -
+core.messaging Package core.messaging
+Types
+
+
+
+
+AllPossibleRecipients
+
+interface AllPossibleRecipients : MessageRecipients A special base class for the set of all possible recipients, without having to identify who they all are.
+
+
+
+
+Message
+
+interface Message A message is defined, at this level, to be a (topic, timestamp, byte arrays) triple, where the topic is a string in
+Java-style reverse dns form, with "platform." being a prefix reserved by the platform for its own use. Vendor
+specific messages can be defined, but use your domain name as the prefix e.g. "uk.co.bigbank.messages.SomeMessage".
+
+
+
+
+MessageHandlerRegistration
+
+interface MessageHandlerRegistration
+
+
+
+MessageRecipientGroup
+
+interface MessageRecipientGroup : MessageRecipients A base class for a set of recipients specifically identified by the sender.
+
+
+
+
+MessageRecipients
+
+interface MessageRecipients The interface for a group of message recipients (which may contain only one recipient)
+
+
+
+
+MessagingService
+
+interface MessagingService A MessagingService sits at the boundary between a message routing / networking layer and the core platform code.
+
+
+
+
+MessagingServiceBuilder
+
+interface MessagingServiceBuilder < out T : MessagingService > This class lets you start up a MessagingService . Its purpose is to stop you from getting access to the methods
+on the messaging service interface until you have successfully started up the system. One of these objects should
+be the only way to obtain a reference to a MessagingService . Startup may be a slow process: some implementations
+may let you cast the returned future to an object that lets you get status info.
+
+
+
+
+SingleMessageRecipient
+
+interface SingleMessageRecipient : MessageRecipients A base class for the case of point-to-point messages
+
+
+
+
+StateMachineManager
+
+class StateMachineManager A StateMachineManager is responsible for coordination and persistence of multiple ProtocolStateMachine objects.
+Each such object represents an instantiation of a (two-party) protocol that has reached a particular point.
+
+
+
+
+TopicStringValidator
+
+object TopicStringValidator A singleton thats useful for validating topic strings
+
+
+
+
+Exceptions
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.messaging/run-on-next-message.html b/docs/build/html/api/core.messaging/run-on-next-message.html
new file mode 100644
index 0000000000..5f29bdc4a7
--- /dev/null
+++ b/docs/build/html/api/core.messaging/run-on-next-message.html
@@ -0,0 +1,18 @@
+
+
+runOnNextMessage -
+core.messaging / runOnNextMessage runOnNextMessage
+fun MessagingService . runOnNextMessage ( topic : String = "", executor : Executor ? = null, callback : ( Message ) -> Unit ) : Unit Registers a handler for the given topic that runs the given callback with the message and then removes itself. This
+is useful for one-shot handlers that arent supposed to stick around permanently. Note that this callback doesnt
+take the registration object, unlike the callback to MessagingService.addMessageHandler .
+send -
+core.messaging / send send
+fun MessagingService . send ( topic : String , to : MessageRecipients , obj : Any ) : Unit AbstractNodeService.<init> -
+core.node.services / AbstractNodeService / <init> <init>
+AbstractNodeService ( net : MessagingService ) Abstract superclass for services that a node can host, which provides helper functions.
+AbstractNodeService.addMessageHandler -
+core.node.services / AbstractNodeService / addMessageHandler addMessageHandler
+protected inline fun < reified Q : AbstractRequestMessage , reified R : Any > addMessageHandler ( topic : String , crossinline handler : ( Q ) -> R , crossinline exceptionConsumer : ( Message , Exception ) -> Unit ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are caught and passed to the provided consumer.
+Parameters
+topic - the topic, without the default session ID postfix (".0)handler - a function to handle the deserialised request and return a responseexceptionConsumer - a function to which any thrown exception is passed.protected inline fun < reified Q : AbstractRequestMessage , reified R : Any > addMessageHandler ( topic : String , crossinline handler : ( Q ) -> R ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are propagated to the messaging layer.
+Parameters
+topic - the topic, without the default session ID postfix (".0)handler - a function to handle the deserialised request and return a responseAbstractNodeService -
+core.node.services / AbstractNodeService AbstractNodeService
+abstract class AbstractNodeService Abstract superclass for services that a node can host, which provides helper functions.
+Constructors
+
+
+
+
+<init>
+
+AbstractNodeService ( net : MessagingService ) Abstract superclass for services that a node can host, which provides helper functions.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+addMessageHandler
+
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R , exceptionConsumer : ( Message , Exception ) -> Unit ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are caught and passed to the provided consumer.
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are propagated to the messaging layer.
+
+
+
+
+Inheritors
+
+
+
+
+DataVendingService
+
+class DataVendingService : AbstractNodeService This class sets up network message handlers for requests from peers for data keyed by hash. It is a piece of simple
+glue that sits between the network layer and the database layer.
+
+
+
+
+InMemoryNetworkMapService
+
+class InMemoryNetworkMapService : NetworkMapService , AbstractNodeService
+
+
+
+NodeTimestamperService
+
+class NodeTimestamperService : AbstractNodeService This class implements the server side of the timestamping protocol, using the local clock. A future version might
+add features like checking against other NTP servers to make sure the clock hasnt drifted by too much.
+
+
+
+
+Service
+
+class Service : AcceptsFileUpload , AbstractNodeService The Service that wraps Oracle and handles messages/network interaction/request scrubbing.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-abstract-node-service/net.html b/docs/build/html/api/core.node.services/-abstract-node-service/net.html
new file mode 100644
index 0000000000..3c56620f90
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-abstract-node-service/net.html
@@ -0,0 +1,15 @@
+
+
+AbstractNodeService.net -
+core.node.services / AbstractNodeService / net net
+val net : MessagingService AttachmentStorage.importAttachment -
+core.node.services / AttachmentStorage / importAttachment importAttachment
+abstract fun importAttachment ( jar : InputStream ) : SecureHash Inserts the given attachment into the store, does not close the input stream. This can be an intensive
+operation due to the need to copy the bytes to disk and hash them along the way.
+Note that you should not pass a JarInputStream into this method and it will throw if you do, because access
+to the raw byte stream is required.
+Exceptions
+FileAlreadyExistsException - if the given byte stream has already been inserted.IllegalArgumentException - if the given byte stream is empty or a JarInputStream IOException - if something went wrong.AttachmentStorage -
+core.node.services / AttachmentStorage AttachmentStorage
+interface AttachmentStorage An attachment store records potentially large binary objects, identified by their hash. Note that attachments are
+immutable and can never be erased once inserted
+Functions
+
+
+
+
+importAttachment
+
+abstract fun importAttachment ( jar : InputStream ) : SecureHash Inserts the given attachment into the store, does not close the input stream. This can be an intensive
+operation due to the need to copy the bytes to disk and hash them along the way.
+
+
+
+
+openAttachment
+
+abstract fun openAttachment ( id : SecureHash ) : Attachment ? Returns a newly opened stream for the given locally stored attachment, or null if no such attachment is known.
+The returned stream must be closed when you are done with it to avoid resource leaks. You should probably wrap
+the result in a JarInputStream unless youre sending it somewhere, there is a convenience helper for this
+on Attachment .
+
+
+
+
+Inheritors
+
+
+
+
+NodeAttachmentService
+
+class NodeAttachmentService : AttachmentStorage , AcceptsFileUpload Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-attachment-storage/open-attachment.html b/docs/build/html/api/core.node.services/-attachment-storage/open-attachment.html
new file mode 100644
index 0000000000..c8994d97e9
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-attachment-storage/open-attachment.html
@@ -0,0 +1,19 @@
+
+
+AttachmentStorage.openAttachment -
+core.node.services / AttachmentStorage / openAttachment openAttachment
+abstract fun openAttachment ( id : SecureHash ) : Attachment ? Returns a newly opened stream for the given locally stored attachment, or null if no such attachment is known.
+The returned stream must be closed when you are done with it to avoid resource leaks. You should probably wrap
+the result in a JarInputStream unless youre sending it somewhere, there is a convenience helper for this
+on Attachment .
+DummyTimestampingAuthority.identity -
+core.node.services / DummyTimestampingAuthority / identity identity
+val identity : Party DummyTimestampingAuthority -
+core.node.services / DummyTimestampingAuthority DummyTimestampingAuthority
+object DummyTimestampingAuthority Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-dummy-timestamping-authority/key.html b/docs/build/html/api/core.node.services/-dummy-timestamping-authority/key.html
new file mode 100644
index 0000000000..bc68a6b5b6
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-dummy-timestamping-authority/key.html
@@ -0,0 +1,15 @@
+
+
+DummyTimestampingAuthority.key -
+core.node.services / DummyTimestampingAuthority / key key
+val key : KeyPair IdentityService -
+core.node.services / IdentityService IdentityService
+interface IdentityService An identity service maintains an bidirectional map of Party s to their associated public keys and thus supports
+lookup of a party given its key. This is obviously very incomplete and does not reflect everything a real identity
+service would provide.
+Functions
+
+Inheritors
+
+
+
+
+InMemoryIdentityService
+
+class InMemoryIdentityService : IdentityService Simple identity service which caches parties and provides functionality for efficient lookup.
+
+
+
+
+MockIdentityService
+
+class MockIdentityService : IdentityService Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.
+This class allows the provided list of identities to be mutated after construction, so it takes the list lock
+when doing lookups and recalculates the mapping each time. The ability to change the list is used by the
+MockNetwork code.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-identity-service/party-from-key.html b/docs/build/html/api/core.node.services/-identity-service/party-from-key.html
new file mode 100644
index 0000000000..8e1681c060
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-identity-service/party-from-key.html
@@ -0,0 +1,15 @@
+
+
+IdentityService.partyFromKey -
+core.node.services / IdentityService / partyFromKey partyFromKey
+abstract fun partyFromKey ( key : PublicKey ) : Party ? IdentityService.partyFromName -
+core.node.services / IdentityService / partyFromName partyFromName
+abstract fun partyFromName ( name : String ) : Party ? IdentityService.registerIdentity -
+core.node.services / IdentityService / registerIdentity registerIdentity
+abstract fun registerIdentity ( party : Party ) : Unit InMemoryNetworkMapService.<init> -
+core.node.services / InMemoryNetworkMapService / <init> <init>
+InMemoryNetworkMapService ( net : MessagingService , home : NodeRegistration , cache : NetworkMapCache ) InMemoryNetworkMapService.cache -
+core.node.services / InMemoryNetworkMapService / cache cache
+val cache : NetworkMapCache InMemoryNetworkMapService.getUnacknowledgedCount -
+core.node.services / InMemoryNetworkMapService / getUnacknowledgedCount getUnacknowledgedCount
+fun getUnacknowledgedCount ( subscriber : SingleMessageRecipient ) : Int ? InMemoryNetworkMapService -
+core.node.services / InMemoryNetworkMapService InMemoryNetworkMapService
+class InMemoryNetworkMapService : NetworkMapService , AbstractNodeService Constructors
+
+Properties
+
+
+
+
+cache
+
+val cache : NetworkMapCache
+
+
+
+maxSizeRegistrationRequestBytes
+
+val maxSizeRegistrationRequestBytes : Int Maximum credible size for a registration request. Generally requests are around 500-600 bytes, so this gives a
+10 times overhead.
+
+
+
+
+maxUnacknowledgedUpdates
+
+val maxUnacknowledgedUpdates : Int Maximum number of unacknowledged updates to send to a node before automatically unregistering them for updates
+
+
+
+
+nodes
+
+val nodes : List < NodeInfo >
+
+
+
+Inherited Properties
+
+Functions
+
+Inherited Functions
+
+
+
+
+addMessageHandler
+
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R , exceptionConsumer : ( Message , Exception ) -> Unit ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are caught and passed to the provided consumer.
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are propagated to the messaging layer.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-in-memory-network-map-service/max-size-registration-request-bytes.html b/docs/build/html/api/core.node.services/-in-memory-network-map-service/max-size-registration-request-bytes.html
new file mode 100644
index 0000000000..61d590c4f1
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-in-memory-network-map-service/max-size-registration-request-bytes.html
@@ -0,0 +1,17 @@
+
+
+InMemoryNetworkMapService.maxSizeRegistrationRequestBytes -
+core.node.services / InMemoryNetworkMapService / maxSizeRegistrationRequestBytes maxSizeRegistrationRequestBytes
+val maxSizeRegistrationRequestBytes : Int Maximum credible size for a registration request. Generally requests are around 500-600 bytes, so this gives a
+10 times overhead.
+InMemoryNetworkMapService.maxUnacknowledgedUpdates -
+core.node.services / InMemoryNetworkMapService / maxUnacknowledgedUpdates maxUnacknowledgedUpdates
+val maxUnacknowledgedUpdates : Int Maximum number of unacknowledged updates to send to a node before automatically unregistering them for updates
+InMemoryNetworkMapService.nodes -
+core.node.services / InMemoryNetworkMapService / nodes nodes
+val nodes : List < NodeInfo > NetworkMapService.nodes InMemoryNetworkMapService.notifySubscribers -
+core.node.services / InMemoryNetworkMapService / notifySubscribers notifySubscribers
+fun notifySubscribers ( wireReg : WireNodeRegistration ) : Unit InMemoryNetworkMapService.processAcknowledge -
+core.node.services / InMemoryNetworkMapService / processAcknowledge processAcknowledge
+fun processAcknowledge ( req : UpdateAcknowledge ) : Unit InMemoryNetworkMapService.processFetchAllRequest -
+core.node.services / InMemoryNetworkMapService / processFetchAllRequest processFetchAllRequest
+fun processFetchAllRequest ( req : FetchMapRequest ) : FetchMapResponse InMemoryNetworkMapService.processQueryRequest -
+core.node.services / InMemoryNetworkMapService / processQueryRequest processQueryRequest
+fun processQueryRequest ( req : QueryIdentityRequest ) : QueryIdentityResponse InMemoryNetworkMapService.processRegistrationChangeRequest -
+core.node.services / InMemoryNetworkMapService / processRegistrationChangeRequest processRegistrationChangeRequest
+fun processRegistrationChangeRequest ( req : RegistrationRequest ) : RegistrationResponse InMemoryNetworkMapService.processSubscriptionRequest -
+core.node.services / InMemoryNetworkMapService / processSubscriptionRequest processSubscriptionRequest
+fun processSubscriptionRequest ( req : SubscribeRequest ) : SubscribeResponse NetworkMapService.DEFAULT_EXPIRATION_PERIOD -
+core.node.services / NetworkMapService / DEFAULT_EXPIRATION_PERIOD DEFAULT_EXPIRATION_PERIOD
+val DEFAULT_EXPIRATION_PERIOD : Period NetworkMapService.FETCH_PROTOCOL_TOPIC -
+core.node.services / NetworkMapService / FETCH_PROTOCOL_TOPIC FETCH_PROTOCOL_TOPIC
+val FETCH_PROTOCOL_TOPIC : String NetworkMapService.FetchMapRequest.<init> -
+core.node.services / NetworkMapService / FetchMapRequest / <init> <init>
+FetchMapRequest ( subscribe : Boolean , ifChangedSinceVersion : Int ? , replyTo : MessageRecipients , sessionID : Long ) NetworkMapService.FetchMapRequest.ifChangedSinceVersion -
+core.node.services / NetworkMapService / FetchMapRequest / ifChangedSinceVersion ifChangedSinceVersion
+val ifChangedSinceVersion : Int ? NetworkMapService.FetchMapRequest -
+core.node.services / NetworkMapService / FetchMapRequest FetchMapRequest
+class FetchMapRequest : AbstractRequestMessage Constructors
+
+
+
+
+<init>
+
+FetchMapRequest ( subscribe : Boolean , ifChangedSinceVersion : Int ? , replyTo : MessageRecipients , sessionID : Long )
+
+
+
+Properties
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-fetch-map-request/subscribe.html b/docs/build/html/api/core.node.services/-network-map-service/-fetch-map-request/subscribe.html
new file mode 100644
index 0000000000..e089589b14
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-fetch-map-request/subscribe.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapService.FetchMapRequest.subscribe -
+core.node.services / NetworkMapService / FetchMapRequest / subscribe subscribe
+val subscribe : Boolean NetworkMapService.FetchMapResponse.<init> -
+core.node.services / NetworkMapService / FetchMapResponse / <init> <init>
+FetchMapResponse ( nodes : Collection < NodeRegistration > ? , version : Int ) NetworkMapService.FetchMapResponse -
+core.node.services / NetworkMapService / FetchMapResponse FetchMapResponse
+data class FetchMapResponse Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-fetch-map-response/nodes.html b/docs/build/html/api/core.node.services/-network-map-service/-fetch-map-response/nodes.html
new file mode 100644
index 0000000000..6489556d3b
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-fetch-map-response/nodes.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapService.FetchMapResponse.nodes -
+core.node.services / NetworkMapService / FetchMapResponse / nodes nodes
+val nodes : Collection < NodeRegistration > ? NetworkMapService.FetchMapResponse.version -
+core.node.services / NetworkMapService / FetchMapResponse / version version
+val version : Int NetworkMapService.PUSH_ACK_PROTOCOL_TOPIC -
+core.node.services / NetworkMapService / PUSH_ACK_PROTOCOL_TOPIC PUSH_ACK_PROTOCOL_TOPIC
+val PUSH_ACK_PROTOCOL_TOPIC : String NetworkMapService.PUSH_PROTOCOL_TOPIC -
+core.node.services / NetworkMapService / PUSH_PROTOCOL_TOPIC PUSH_PROTOCOL_TOPIC
+val PUSH_PROTOCOL_TOPIC : String NetworkMapService.QUERY_PROTOCOL_TOPIC -
+core.node.services / NetworkMapService / QUERY_PROTOCOL_TOPIC QUERY_PROTOCOL_TOPIC
+val QUERY_PROTOCOL_TOPIC : String NetworkMapService.QueryIdentityRequest.<init> -
+core.node.services / NetworkMapService / QueryIdentityRequest / <init> <init>
+QueryIdentityRequest ( identity : Party , replyTo : MessageRecipients , sessionID : Long ) NetworkMapService.QueryIdentityRequest.identity -
+core.node.services / NetworkMapService / QueryIdentityRequest / identity identity
+val identity : Party NetworkMapService.QueryIdentityRequest -
+core.node.services / NetworkMapService / QueryIdentityRequest QueryIdentityRequest
+class QueryIdentityRequest : AbstractRequestMessage Constructors
+
+Properties
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-query-identity-response/-init-.html b/docs/build/html/api/core.node.services/-network-map-service/-query-identity-response/-init-.html
new file mode 100644
index 0000000000..38680a0759
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-query-identity-response/-init-.html
@@ -0,0 +1,14 @@
+
+
+NetworkMapService.QueryIdentityResponse.<init> -
+core.node.services / NetworkMapService / QueryIdentityResponse / <init> <init>
+QueryIdentityResponse ( node : NodeInfo ? ) NetworkMapService.QueryIdentityResponse -
+core.node.services / NetworkMapService / QueryIdentityResponse QueryIdentityResponse
+data class QueryIdentityResponse Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-query-identity-response/node.html b/docs/build/html/api/core.node.services/-network-map-service/-query-identity-response/node.html
new file mode 100644
index 0000000000..3512d24d27
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-query-identity-response/node.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapService.QueryIdentityResponse.node -
+core.node.services / NetworkMapService / QueryIdentityResponse / node node
+val node : NodeInfo ? NetworkMapService.REGISTER_PROTOCOL_TOPIC -
+core.node.services / NetworkMapService / REGISTER_PROTOCOL_TOPIC REGISTER_PROTOCOL_TOPIC
+val REGISTER_PROTOCOL_TOPIC : String NetworkMapService.RegistrationRequest.<init> -
+core.node.services / NetworkMapService / RegistrationRequest / <init> <init>
+RegistrationRequest ( wireReg : WireNodeRegistration , replyTo : MessageRecipients , sessionID : Long ) NetworkMapService.RegistrationRequest -
+core.node.services / NetworkMapService / RegistrationRequest RegistrationRequest
+class RegistrationRequest : AbstractRequestMessage Constructors
+
+Properties
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-registration-request/wire-reg.html b/docs/build/html/api/core.node.services/-network-map-service/-registration-request/wire-reg.html
new file mode 100644
index 0000000000..d9be6ddb4e
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-registration-request/wire-reg.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapService.RegistrationRequest.wireReg -
+core.node.services / NetworkMapService / RegistrationRequest / wireReg wireReg
+val wireReg : WireNodeRegistration NetworkMapService.RegistrationResponse.<init> -
+core.node.services / NetworkMapService / RegistrationResponse / <init> <init>
+RegistrationResponse ( success : Boolean ) NetworkMapService.RegistrationResponse -
+core.node.services / NetworkMapService / RegistrationResponse RegistrationResponse
+data class RegistrationResponse Constructors
+
+
+
+
+<init>
+
+RegistrationResponse ( success : Boolean )
+
+
+
+Properties
+
+
+
+
+success
+
+val success : Boolean
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-registration-response/success.html b/docs/build/html/api/core.node.services/-network-map-service/-registration-response/success.html
new file mode 100644
index 0000000000..76e186bc00
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-registration-response/success.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapService.RegistrationResponse.success -
+core.node.services / NetworkMapService / RegistrationResponse / success success
+val success : Boolean NetworkMapService.SUBSCRIPTION_PROTOCOL_TOPIC -
+core.node.services / NetworkMapService / SUBSCRIPTION_PROTOCOL_TOPIC SUBSCRIPTION_PROTOCOL_TOPIC
+val SUBSCRIPTION_PROTOCOL_TOPIC : String NetworkMapService.SubscribeRequest.<init> -
+core.node.services / NetworkMapService / SubscribeRequest / <init> <init>
+SubscribeRequest ( subscribe : Boolean , replyTo : MessageRecipients , sessionID : Long ) NetworkMapService.SubscribeRequest -
+core.node.services / NetworkMapService / SubscribeRequest SubscribeRequest
+class SubscribeRequest : AbstractRequestMessage Constructors
+
+Properties
+
+
+
+
+subscribe
+
+val subscribe : Boolean
+
+
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-subscribe-request/subscribe.html b/docs/build/html/api/core.node.services/-network-map-service/-subscribe-request/subscribe.html
new file mode 100644
index 0000000000..4870d74d68
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-subscribe-request/subscribe.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapService.SubscribeRequest.subscribe -
+core.node.services / NetworkMapService / SubscribeRequest / subscribe subscribe
+val subscribe : Boolean NetworkMapService.SubscribeResponse.<init> -
+core.node.services / NetworkMapService / SubscribeResponse / <init> <init>
+SubscribeResponse ( confirmed : Boolean ) NetworkMapService.SubscribeResponse.confirmed -
+core.node.services / NetworkMapService / SubscribeResponse / confirmed confirmed
+val confirmed : Boolean NetworkMapService.SubscribeResponse -
+core.node.services / NetworkMapService / SubscribeResponse SubscribeResponse
+data class SubscribeResponse Constructors
+
+
+
+
+<init>
+
+SubscribeResponse ( confirmed : Boolean )
+
+
+
+Properties
+
+
+
+
+confirmed
+
+val confirmed : Boolean
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-type.html b/docs/build/html/api/core.node.services/-network-map-service/-type.html
new file mode 100644
index 0000000000..733d39c608
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-type.html
@@ -0,0 +1,48 @@
+
+
+NetworkMapService.Type -
+core.node.services / NetworkMapService / Type Type
+object Type : ServiceType Inherited Properties
+
+
+
+
+id
+
+val id : String
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open operator fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-update-acknowledge/-init-.html b/docs/build/html/api/core.node.services/-network-map-service/-update-acknowledge/-init-.html
new file mode 100644
index 0000000000..7266d08e30
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-update-acknowledge/-init-.html
@@ -0,0 +1,14 @@
+
+
+NetworkMapService.UpdateAcknowledge.<init> -
+core.node.services / NetworkMapService / UpdateAcknowledge / <init> <init>
+UpdateAcknowledge ( wireRegHash : SecureHash , replyTo : MessageRecipients ) NetworkMapService.UpdateAcknowledge -
+core.node.services / NetworkMapService / UpdateAcknowledge UpdateAcknowledge
+data class UpdateAcknowledge Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-update-acknowledge/reply-to.html b/docs/build/html/api/core.node.services/-network-map-service/-update-acknowledge/reply-to.html
new file mode 100644
index 0000000000..3e386e36cd
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-update-acknowledge/reply-to.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapService.UpdateAcknowledge.replyTo -
+core.node.services / NetworkMapService / UpdateAcknowledge / replyTo replyTo
+val replyTo : MessageRecipients NetworkMapService.UpdateAcknowledge.wireRegHash -
+core.node.services / NetworkMapService / UpdateAcknowledge / wireRegHash wireRegHash
+val wireRegHash : SecureHash NetworkMapService.Update.<init> -
+core.node.services / NetworkMapService / Update / <init> <init>
+Update ( wireReg : WireNodeRegistration , replyTo : MessageRecipients ) NetworkMapService.Update -
+core.node.services / NetworkMapService / Update Update
+data class Update Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/-update/reply-to.html b/docs/build/html/api/core.node.services/-network-map-service/-update/reply-to.html
new file mode 100644
index 0000000000..d508d11149
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/-update/reply-to.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapService.Update.replyTo -
+core.node.services / NetworkMapService / Update / replyTo replyTo
+val replyTo : MessageRecipients NetworkMapService.Update.wireReg -
+core.node.services / NetworkMapService / Update / wireReg wireReg
+val wireReg : WireNodeRegistration NetworkMapService -
+core.node.services / NetworkMapService NetworkMapService
+interface NetworkMapService A network map contains lists of nodes on the network along with information about their identity keys, services
+they provide and host names or IP addresses where they can be connected to. This information is cached locally within
+nodes, by the NetworkMapCache . Currently very basic consensus controls are applied, using signed changes which
+replace each other based on a serial number present in the change.
+Types
+
+Properties
+
+Companion Object Properties
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/core.node.services/-network-map-service/logger.html b/docs/build/html/api/core.node.services/-network-map-service/logger.html
new file mode 100644
index 0000000000..5e5a95482e
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-network-map-service/logger.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapService.logger -
+core.node.services / NetworkMapService / logger logger
+val logger : <ERROR CLASS> NetworkMapService.nodes -
+core.node.services / NetworkMapService / nodes nodes
+abstract val nodes : List < NodeInfo > NodeAttachmentService.<init> -
+core.node.services / NodeAttachmentService / <init> <init>
+NodeAttachmentService ( storePath : Path , metrics : <ERROR CLASS> ) Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.
+NodeAttachmentService.OnDiskHashMismatch.<init> -
+core.node.services / NodeAttachmentService / OnDiskHashMismatch / <init> <init>
+OnDiskHashMismatch ( file : Path , actual : SecureHash ) NodeAttachmentService.OnDiskHashMismatch.actual -
+core.node.services / NodeAttachmentService / OnDiskHashMismatch / actual actual
+val actual : SecureHash NodeAttachmentService.OnDiskHashMismatch.file -
+core.node.services / NodeAttachmentService / OnDiskHashMismatch / file file
+val file : Path NodeAttachmentService.OnDiskHashMismatch -
+core.node.services / NodeAttachmentService / OnDiskHashMismatch OnDiskHashMismatch
+class OnDiskHashMismatch : Exception Constructors
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/to-string.html b/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/to-string.html
new file mode 100644
index 0000000000..1216e5b38a
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/to-string.html
@@ -0,0 +1,15 @@
+
+
+NodeAttachmentService.OnDiskHashMismatch.toString -
+core.node.services / NodeAttachmentService / OnDiskHashMismatch / toString toString
+fun toString ( ) : String NodeAttachmentService.acceptableFileExtensions -
+core.node.services / NodeAttachmentService / acceptableFileExtensions acceptableFileExtensions
+val acceptableFileExtensions : <ERROR CLASS> AcceptsFileUpload.acceptableFileExtensions What file extensions are acceptable for the file to be handed to upload()
+NodeAttachmentService.automaticallyExtractAttachments -
+core.node.services / NodeAttachmentService / automaticallyExtractAttachments automaticallyExtractAttachments
+var automaticallyExtractAttachments : Boolean If true, newly inserted attachments will be unzipped to a subdirectory of the storePath . This is intended for
+human browsing convenience: the attachment itself will still be the file (that is, edits to the extracted directory
+will not have any effect).
+NodeAttachmentService.checkAttachmentsOnLoad -
+core.node.services / NodeAttachmentService / checkAttachmentsOnLoad checkAttachmentsOnLoad
+var checkAttachmentsOnLoad : Boolean NodeAttachmentService.dataTypePrefix -
+core.node.services / NodeAttachmentService / dataTypePrefix dataTypePrefix
+val dataTypePrefix : String AcceptsFileUpload.dataTypePrefix A string that prefixes the URLs, e.g. "attachments" or "interest-rates". Should be OK for URLs.
+NodeAttachmentService.importAttachment -
+core.node.services / NodeAttachmentService / importAttachment importAttachment
+fun importAttachment ( jar : InputStream ) : SecureHash AttachmentStorage.importAttachment Inserts the given attachment into the store, does not close the input stream. This can be an intensive
+operation due to the need to copy the bytes to disk and hash them along the way.
+Note that you should not pass a JarInputStream into this method and it will throw if you do, because access
+to the raw byte stream is required.
+Exceptions
+FileAlreadyExistsException - if the given byte stream has already been inserted.IllegalArgumentException - if the given byte stream is empty or a JarInputStream IOException - if something went wrong.NodeAttachmentService -
+core.node.services / NodeAttachmentService NodeAttachmentService
+class NodeAttachmentService : AttachmentStorage , AcceptsFileUpload Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.
+Exceptions
+
+Constructors
+
+
+
+
+<init>
+
+NodeAttachmentService ( storePath : Path , metrics : <ERROR CLASS> ) Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.
+
+
+
+
+Properties
+
+
+
+
+acceptableFileExtensions
+
+val acceptableFileExtensions : <ERROR CLASS> What file extensions are acceptable for the file to be handed to upload()
+
+
+
+
+automaticallyExtractAttachments
+
+var automaticallyExtractAttachments : Boolean If true, newly inserted attachments will be unzipped to a subdirectory of the storePath . This is intended for
+human browsing convenience: the attachment itself will still be the file (that is, edits to the extracted directory
+will not have any effect).
+
+
+
+
+checkAttachmentsOnLoad
+
+var checkAttachmentsOnLoad : Boolean
+
+
+
+dataTypePrefix
+
+val dataTypePrefix : String A string that prefixes the URLs, e.g. "attachments" or "interest-rates". Should be OK for URLs.
+
+
+
+
+metrics
+
+val metrics : <ERROR CLASS>
+
+
+
+storePath
+
+val storePath : Path
+
+
+
+Functions
+
+
+
+
+importAttachment
+
+fun importAttachment ( jar : InputStream ) : SecureHash Inserts the given attachment into the store, does not close the input stream. This can be an intensive
+operation due to the need to copy the bytes to disk and hash them along the way.
+
+
+
+
+openAttachment
+
+fun openAttachment ( id : SecureHash ) : Attachment ? Returns a newly opened stream for the given locally stored attachment, or null if no such attachment is known.
+The returned stream must be closed when you are done with it to avoid resource leaks. You should probably wrap
+the result in a JarInputStream unless youre sending it somewhere, there is a convenience helper for this
+on Attachment .
+
+
+
+
+upload
+
+fun upload ( data : InputStream ) : <ERROR CLASS> Accepts the data in the given input stream, and returns some sort of useful return message that will be sent
+back to the user in the response.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/metrics.html b/docs/build/html/api/core.node.services/-node-attachment-service/metrics.html
new file mode 100644
index 0000000000..30fa055874
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-attachment-service/metrics.html
@@ -0,0 +1,15 @@
+
+
+NodeAttachmentService.metrics -
+core.node.services / NodeAttachmentService / metrics metrics
+val metrics : <ERROR CLASS> NodeAttachmentService.openAttachment -
+core.node.services / NodeAttachmentService / openAttachment openAttachment
+fun openAttachment ( id : SecureHash ) : Attachment ? AttachmentStorage.openAttachment Returns a newly opened stream for the given locally stored attachment, or null if no such attachment is known.
+The returned stream must be closed when you are done with it to avoid resource leaks. You should probably wrap
+the result in a JarInputStream unless youre sending it somewhere, there is a convenience helper for this
+on Attachment .
+NodeAttachmentService.storePath -
+core.node.services / NodeAttachmentService / storePath storePath
+val storePath : Path NodeAttachmentService.upload -
+core.node.services / NodeAttachmentService / upload upload
+fun upload ( data : InputStream ) : <ERROR CLASS> AcceptsFileUpload.upload Accepts the data in the given input stream, and returns some sort of useful return message that will be sent
+back to the user in the response.
+NodeInterestRates.FixContainer.<init> -
+core.node.services / NodeInterestRates / FixContainer / <init> <init>
+FixContainer ( fixes : List < Fix > , factory : InterpolatorFactory = CubicSplineInterpolator.Factory) Fix container, for every fix name & date pair stores a tenor to interest rate map - InterpolatingRateMap
+NodeInterestRates.FixContainer.factory -
+core.node.services / NodeInterestRates / FixContainer / factory factory
+val factory : InterpolatorFactory NodeInterestRates.FixContainer.fixes -
+core.node.services / NodeInterestRates / FixContainer / fixes fixes
+val fixes : List < Fix > NodeInterestRates.FixContainer.get -
+core.node.services / NodeInterestRates / FixContainer / get get
+operator fun get ( fixOf : FixOf ) : Fix ? NodeInterestRates.FixContainer -
+core.node.services / NodeInterestRates / FixContainer FixContainer
+class FixContainer Fix container, for every fix name & date pair stores a tenor to interest rate map - InterpolatingRateMap
+Constructors
+
+Properties
+
+Functions
+
+
+
+
+get
+
+operator fun get ( fixOf : FixOf ) : Fix ?
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-interest-rates/-fix-container/size.html b/docs/build/html/api/core.node.services/-node-interest-rates/-fix-container/size.html
new file mode 100644
index 0000000000..f26be8ea5e
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-interest-rates/-fix-container/size.html
@@ -0,0 +1,15 @@
+
+
+NodeInterestRates.FixContainer.size -
+core.node.services / NodeInterestRates / FixContainer / size size
+val size : Int NodeInterestRates.InterpolatingRateMap.<init> -
+core.node.services / NodeInterestRates / InterpolatingRateMap / <init> <init>
+InterpolatingRateMap ( date : LocalDate , inputRates : Map < Tenor , BigDecimal > , calendar : BusinessCalendar , factory : InterpolatorFactory ) Stores a mapping between tenors and interest rates.
+Interpolates missing values using the provided interpolation mechanism.
+NodeInterestRates.InterpolatingRateMap.calendar -
+core.node.services / NodeInterestRates / InterpolatingRateMap / calendar calendar
+val calendar : BusinessCalendar NodeInterestRates.InterpolatingRateMap.date -
+core.node.services / NodeInterestRates / InterpolatingRateMap / date date
+val date : LocalDate NodeInterestRates.InterpolatingRateMap.factory -
+core.node.services / NodeInterestRates / InterpolatingRateMap / factory factory
+val factory : InterpolatorFactory NodeInterestRates.InterpolatingRateMap.getRate -
+core.node.services / NodeInterestRates / InterpolatingRateMap / getRate getRate
+fun getRate ( tenor : Tenor ) : BigDecimal ? Returns the interest rate for a given Tenor ,
+or null if the rate is not found and cannot be interpolated
+NodeInterestRates.InterpolatingRateMap -
+core.node.services / NodeInterestRates / InterpolatingRateMap InterpolatingRateMap
+class InterpolatingRateMap Stores a mapping between tenors and interest rates.
+Interpolates missing values using the provided interpolation mechanism.
+Constructors
+
+Properties
+
+Functions
+
+
+
+
+getRate
+
+fun getRate ( tenor : Tenor ) : BigDecimal ? Returns the interest rate for a given Tenor ,
+or null if the rate is not found and cannot be interpolated
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-interest-rates/-interpolating-rate-map/input-rates.html b/docs/build/html/api/core.node.services/-node-interest-rates/-interpolating-rate-map/input-rates.html
new file mode 100644
index 0000000000..8baa420cc3
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-interest-rates/-interpolating-rate-map/input-rates.html
@@ -0,0 +1,15 @@
+
+
+NodeInterestRates.InterpolatingRateMap.inputRates -
+core.node.services / NodeInterestRates / InterpolatingRateMap / inputRates inputRates
+val inputRates : Map < Tenor , BigDecimal > NodeInterestRates.InterpolatingRateMap.size -
+core.node.services / NodeInterestRates / InterpolatingRateMap / size size
+val size : Int Number of rates excluding the interpolated ones
+NodeInterestRates.Oracle.<init> -
+core.node.services / NodeInterestRates / Oracle / <init> <init>
+Oracle ( identity : Party , signingKey : KeyPair ) An implementation of an interest rate fix oracle which is given data in a simple string format.
+The oracle will try to interpolate the missing value of a tenor for the given fix name and date.
+NodeInterestRates.Oracle.identity -
+core.node.services / NodeInterestRates / Oracle / identity identity
+val identity : Party NodeInterestRates.Oracle -
+core.node.services / NodeInterestRates / Oracle Oracle
+class Oracle An implementation of an interest rate fix oracle which is given data in a simple string format.
+The oracle will try to interpolate the missing value of a tenor for the given fix name and date.
+Constructors
+
+
+
+
+<init>
+
+Oracle ( identity : Party , signingKey : KeyPair ) An implementation of an interest rate fix oracle which is given data in a simple string format.
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-interest-rates/-oracle/known-fixes.html b/docs/build/html/api/core.node.services/-node-interest-rates/-oracle/known-fixes.html
new file mode 100644
index 0000000000..8b47da7570
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-interest-rates/-oracle/known-fixes.html
@@ -0,0 +1,15 @@
+
+
+NodeInterestRates.Oracle.knownFixes -
+core.node.services / NodeInterestRates / Oracle / knownFixes knownFixes
+var knownFixes : FixContainer NodeInterestRates.Oracle.query -
+core.node.services / NodeInterestRates / Oracle / query query
+fun query ( queries : List < FixOf > ) : List < Fix > NodeInterestRates.Oracle.sign -
+core.node.services / NodeInterestRates / Oracle / sign sign
+fun sign ( wtx : WireTransaction ) : LegallyIdentifiable NodeInterestRates.Service.<init> -
+core.node.services / NodeInterestRates / Service / <init> <init>
+Service ( node : AbstractNode ) The Service that wraps Oracle and handles messages/network interaction/request scrubbing.
+NodeInterestRates.Service.acceptableFileExtensions -
+core.node.services / NodeInterestRates / Service / acceptableFileExtensions acceptableFileExtensions
+val acceptableFileExtensions : <ERROR CLASS> AcceptsFileUpload.acceptableFileExtensions What file extensions are acceptable for the file to be handed to upload()
+NodeInterestRates.Service.dataTypePrefix -
+core.node.services / NodeInterestRates / Service / dataTypePrefix dataTypePrefix
+val dataTypePrefix : String AcceptsFileUpload.dataTypePrefix A string that prefixes the URLs, e.g. "attachments" or "interest-rates". Should be OK for URLs.
+NodeInterestRates.Service -
+core.node.services / NodeInterestRates / Service Service
+class Service : AcceptsFileUpload , AbstractNodeService The Service that wraps Oracle and handles messages/network interaction/request scrubbing.
+Constructors
+
+
+
+
+<init>
+
+Service ( node : AbstractNode ) The Service that wraps Oracle and handles messages/network interaction/request scrubbing.
+
+
+
+
+Properties
+
+
+
+
+acceptableFileExtensions
+
+val acceptableFileExtensions : <ERROR CLASS> What file extensions are acceptable for the file to be handed to upload()
+
+
+
+
+dataTypePrefix
+
+val dataTypePrefix : String A string that prefixes the URLs, e.g. "attachments" or "interest-rates". Should be OK for URLs.
+
+
+
+
+oracle
+
+val oracle : Oracle
+
+
+
+ss
+
+val ss : StorageService
+
+
+
+Inherited Properties
+
+Functions
+
+
+
+
+upload
+
+fun upload ( data : InputStream ) : String Accepts the data in the given input stream, and returns some sort of useful return message that will be sent
+back to the user in the response.
+
+
+
+
+Inherited Functions
+
+
+
+
+addMessageHandler
+
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R , exceptionConsumer : ( Message , Exception ) -> Unit ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are caught and passed to the provided consumer.
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are propagated to the messaging layer.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-interest-rates/-service/oracle.html b/docs/build/html/api/core.node.services/-node-interest-rates/-service/oracle.html
new file mode 100644
index 0000000000..28a4984ba4
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-interest-rates/-service/oracle.html
@@ -0,0 +1,15 @@
+
+
+NodeInterestRates.Service.oracle -
+core.node.services / NodeInterestRates / Service / oracle oracle
+val oracle : Oracle NodeInterestRates.Service.ss -
+core.node.services / NodeInterestRates / Service / ss ss
+val ss : StorageService NodeInterestRates.Service.upload -
+core.node.services / NodeInterestRates / Service / upload upload
+fun upload ( data : InputStream ) : String AcceptsFileUpload.upload Accepts the data in the given input stream, and returns some sort of useful return message that will be sent
+back to the user in the response.
+NodeInterestRates.Type -
+core.node.services / NodeInterestRates / Type Type
+object Type : ServiceType Inherited Properties
+
+
+
+
+id
+
+val id : String
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open operator fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-interest-rates/-unknown-fix/-init-.html b/docs/build/html/api/core.node.services/-node-interest-rates/-unknown-fix/-init-.html
new file mode 100644
index 0000000000..f1327796f5
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-interest-rates/-unknown-fix/-init-.html
@@ -0,0 +1,14 @@
+
+
+NodeInterestRates.UnknownFix.<init> -
+core.node.services / NodeInterestRates / UnknownFix / <init> <init>
+UnknownFix ( fix : FixOf ) NodeInterestRates.UnknownFix.fix -
+core.node.services / NodeInterestRates / UnknownFix / fix fix
+val fix : FixOf NodeInterestRates.UnknownFix -
+core.node.services / NodeInterestRates / UnknownFix UnknownFix
+class UnknownFix : Exception Constructors
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-interest-rates/-unknown-fix/to-string.html b/docs/build/html/api/core.node.services/-node-interest-rates/-unknown-fix/to-string.html
new file mode 100644
index 0000000000..1d8e06a529
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-interest-rates/-unknown-fix/to-string.html
@@ -0,0 +1,15 @@
+
+
+NodeInterestRates.UnknownFix.toString -
+core.node.services / NodeInterestRates / UnknownFix / toString toString
+fun toString ( ) : String NodeInterestRates -
+core.node.services / NodeInterestRates NodeInterestRates
+object NodeInterestRates An interest rates service is an oracle that signs transactions which contain embedded assertions about an interest
+rate fix (e.g. LIBOR, EURIBOR ...).
+The oracle has two functions. It can be queried for a fix for the given day. And it can sign a transaction that
+includes a fix that it finds acceptable. So to use it you would query the oracle, incorporate its answer into the
+transaction you are building, and then (after possibly extra steps) hand the final transaction back to the oracle
+for signing.
+Types
+
+
+
+
+FixContainer
+
+class FixContainer Fix container, for every fix name & date pair stores a tenor to interest rate map - InterpolatingRateMap
+
+
+
+
+InterpolatingRateMap
+
+class InterpolatingRateMap Stores a mapping between tenors and interest rates.
+Interpolates missing values using the provided interpolation mechanism.
+
+
+
+
+Oracle
+
+class Oracle An implementation of an interest rate fix oracle which is given data in a simple string format.
+
+
+
+
+Service
+
+class Service : AcceptsFileUpload , AbstractNodeService The Service that wraps Oracle and handles messages/network interaction/request scrubbing.
+
+
+
+
+Type
+
+object Type : ServiceType
+
+
+
+Exceptions
+
+Functions
+
+
+
+
+parseFile
+
+fun parseFile ( s : String ) : FixContainer Parses lines containing fixes
+
+
+
+
+parseFix
+
+fun parseFix ( s : String ) : Fix Parses a string of the form "LIBOR 16-March-2016 1M = 0.678" into a Fix
+
+
+
+
+parseFixOf
+
+fun parseFixOf ( key : String ) : FixOf Parses a string of the form "LIBOR 16-March-2016 1M" into a FixOf
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-interest-rates/parse-file.html b/docs/build/html/api/core.node.services/-node-interest-rates/parse-file.html
new file mode 100644
index 0000000000..16e2ba9040
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-interest-rates/parse-file.html
@@ -0,0 +1,16 @@
+
+
+NodeInterestRates.parseFile -
+core.node.services / NodeInterestRates / parseFile parseFile
+fun parseFile ( s : String ) : FixContainer Parses lines containing fixes
+NodeInterestRates.parseFixOf -
+core.node.services / NodeInterestRates / parseFixOf parseFixOf
+fun parseFixOf ( key : String ) : FixOf Parses a string of the form "LIBOR 16-March-2016 1M" into a FixOf
+NodeInterestRates.parseFix -
+core.node.services / NodeInterestRates / parseFix parseFix
+fun parseFix ( s : String ) : Fix Parses a string of the form "LIBOR 16-March-2016 1M = 0.678" into a Fix
+NodeMapError.InvalidSignature.<init> -
+core.node.services / NodeMapError / InvalidSignature / <init> <init>
+InvalidSignature ( ) Thrown if the signature on the node info does not match the public key for the identity
+NodeMapError.InvalidSignature -
+core.node.services / NodeMapError / InvalidSignature InvalidSignature
+class InvalidSignature : NodeMapError Thrown if the signature on the node info does not match the public key for the identity
+Constructors
+
+
+
+
+<init>
+
+InvalidSignature ( ) Thrown if the signature on the node info does not match the public key for the identity
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-map-error/-invalid-subscriber/-init-.html b/docs/build/html/api/core.node.services/-node-map-error/-invalid-subscriber/-init-.html
new file mode 100644
index 0000000000..ffc7351983
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-map-error/-invalid-subscriber/-init-.html
@@ -0,0 +1,15 @@
+
+
+NodeMapError.InvalidSubscriber.<init> -
+core.node.services / NodeMapError / InvalidSubscriber / <init> <init>
+InvalidSubscriber ( ) Thrown if the replyTo of a subscription change message is not a single message recipient
+NodeMapError.InvalidSubscriber -
+core.node.services / NodeMapError / InvalidSubscriber InvalidSubscriber
+class InvalidSubscriber : NodeMapError Thrown if the replyTo of a subscription change message is not a single message recipient
+Constructors
+
+
+
+
+<init>
+
+InvalidSubscriber ( ) Thrown if the replyTo of a subscription change message is not a single message recipient
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-map-error/-unknown-change-type/-init-.html b/docs/build/html/api/core.node.services/-node-map-error/-unknown-change-type/-init-.html
new file mode 100644
index 0000000000..928a9415ac
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-map-error/-unknown-change-type/-init-.html
@@ -0,0 +1,15 @@
+
+
+NodeMapError.UnknownChangeType.<init> -
+core.node.services / NodeMapError / UnknownChangeType / <init> <init>
+UnknownChangeType ( ) Thrown if a change arrives which is of an unknown type
+NodeMapError.UnknownChangeType -
+core.node.services / NodeMapError / UnknownChangeType UnknownChangeType
+class UnknownChangeType : NodeMapError Thrown if a change arrives which is of an unknown type
+Constructors
+
+
+
+
+<init>
+
+UnknownChangeType ( ) Thrown if a change arrives which is of an unknown type
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-map-error/index.html b/docs/build/html/api/core.node.services/-node-map-error/index.html
new file mode 100644
index 0000000000..b5f26491d9
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-map-error/index.html
@@ -0,0 +1,66 @@
+
+
+NodeMapError -
+core.node.services / NodeMapError NodeMapError
+sealed class NodeMapError : Exception Exceptions
+
+
+
+
+InvalidSignature
+
+class InvalidSignature : NodeMapError Thrown if the signature on the node info does not match the public key for the identity
+
+
+
+
+InvalidSubscriber
+
+class InvalidSubscriber : NodeMapError Thrown if the replyTo of a subscription change message is not a single message recipient
+
+
+
+
+UnknownChangeType
+
+class UnknownChangeType : NodeMapError Thrown if a change arrives which is of an unknown type
+
+
+
+
+Inheritors
+
+
+
+
+InvalidSignature
+
+class InvalidSignature : NodeMapError Thrown if the signature on the node info does not match the public key for the identity
+
+
+
+
+InvalidSubscriber
+
+class InvalidSubscriber : NodeMapError Thrown if the replyTo of a subscription change message is not a single message recipient
+
+
+
+
+UnknownChangeType
+
+class UnknownChangeType : NodeMapError Thrown if a change arrives which is of an unknown type
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-registration/-init-.html b/docs/build/html/api/core.node.services/-node-registration/-init-.html
new file mode 100644
index 0000000000..5b5fde8852
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-registration/-init-.html
@@ -0,0 +1,30 @@
+
+
+NodeRegistration.<init> -
+core.node.services / NodeRegistration / <init> <init>
+NodeRegistration ( node : NodeInfo , serial : Long , type : AddOrRemove , expires : Instant ) A node registration state in the network map.
+Parameters
+node - the node being added/removed.serial - an increasing value which represents the version of this registration. Not expected to be sequential,
+but later versions of the registration must have higher values (or they will be ignored by the map service).
+Similar to the serial number on DNS records.type - add if the node is being added to the map, or remove if a previous node is being removed (indicated as
+going offline).expires - when the registration expires. Only used when adding a node to a map.NodeRegistration.expires -
+core.node.services / NodeRegistration / expires expires
+var expires : Instant NodeRegistration -
+core.node.services / NodeRegistration NodeRegistration
+class NodeRegistration A node registration state in the network map.
+Parameters
+node - the node being added/removed.serial - an increasing value which represents the version of this registration. Not expected to be sequential,
+but later versions of the registration must have higher values (or they will be ignored by the map service).
+Similar to the serial number on DNS records.type - add if the node is being added to the map, or remove if a previous node is being removed (indicated as
+going offline).expires - when the registration expires. Only used when adding a node to a map.Constructors
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-registration/node.html b/docs/build/html/api/core.node.services/-node-registration/node.html
new file mode 100644
index 0000000000..492077f462
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-registration/node.html
@@ -0,0 +1,15 @@
+
+
+NodeRegistration.node -
+core.node.services / NodeRegistration / node node
+val node : NodeInfo NodeRegistration.serial -
+core.node.services / NodeRegistration / serial serial
+val serial : Long NodeRegistration.toString -
+core.node.services / NodeRegistration / toString toString
+fun toString ( ) : String NodeRegistration.toWire -
+core.node.services / NodeRegistration / toWire toWire
+fun toWire ( privateKey : PrivateKey ) : WireNodeRegistration Build a node registration in wire format.
+NodeRegistration.type -
+core.node.services / NodeRegistration / type type
+val type : AddOrRemove NodeTimestamperService.<init> -
+core.node.services / NodeTimestamperService / <init> <init>
+NodeTimestamperService ( net : MessagingService , identity : Party , signingKey : KeyPair , clock : Clock = Clock.systemDefaultZone(), tolerance : Duration = 30.seconds) This class implements the server side of the timestamping protocol, using the local clock. A future version might
+add features like checking against other NTP servers to make sure the clock hasnt drifted by too much.
+See the doc site to learn more about timestamping authorities (nodes) and the role they play in the data model.
+NodeTimestamperService.TIMESTAMPING_PROTOCOL_TOPIC -
+core.node.services / NodeTimestamperService / TIMESTAMPING_PROTOCOL_TOPIC TIMESTAMPING_PROTOCOL_TOPIC
+val TIMESTAMPING_PROTOCOL_TOPIC : String NodeTimestamperService.clock -
+core.node.services / NodeTimestamperService / clock clock
+val clock : Clock NodeTimestamperService.identity -
+core.node.services / NodeTimestamperService / identity identity
+val identity : Party NodeTimestamperService -
+core.node.services / NodeTimestamperService NodeTimestamperService
+class NodeTimestamperService : AbstractNodeService This class implements the server side of the timestamping protocol, using the local clock. A future version might
+add features like checking against other NTP servers to make sure the clock hasnt drifted by too much.
+See the doc site to learn more about timestamping authorities (nodes) and the role they play in the data model.
+Constructors
+
+
+
+
+<init>
+
+NodeTimestamperService ( net : MessagingService , identity : Party , signingKey : KeyPair , clock : Clock = Clock.systemDefaultZone(), tolerance : Duration = 30.seconds) This class implements the server side of the timestamping protocol, using the local clock. A future version might
+add features like checking against other NTP servers to make sure the clock hasnt drifted by too much.
+
+
+
+
+Properties
+
+Inherited Properties
+
+Functions
+
+Inherited Functions
+
+
+
+
+addMessageHandler
+
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R , exceptionConsumer : ( Message , Exception ) -> Unit ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are caught and passed to the provided consumer.
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are propagated to the messaging layer.
+
+
+
+
+Companion Object Properties
+
+
+
diff --git a/docs/build/html/api/core.node.services/-node-timestamper-service/process-request.html b/docs/build/html/api/core.node.services/-node-timestamper-service/process-request.html
new file mode 100644
index 0000000000..e88ea19d2c
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-node-timestamper-service/process-request.html
@@ -0,0 +1,15 @@
+
+
+NodeTimestamperService.processRequest -
+core.node.services / NodeTimestamperService / processRequest processRequest
+fun processRequest ( req : Request ) : LegallyIdentifiable NodeTimestamperService.signingKey -
+core.node.services / NodeTimestamperService / signingKey signingKey
+val signingKey : KeyPair NodeTimestamperService.tolerance -
+core.node.services / NodeTimestamperService / tolerance tolerance
+val tolerance : Duration RegulatorService.Type -
+core.node.services / RegulatorService / Type Type
+object Type : ServiceType Inherited Properties
+
+
+
+
+id
+
+val id : String
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open operator fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-regulator-service/index.html b/docs/build/html/api/core.node.services/-regulator-service/index.html
new file mode 100644
index 0000000000..477a89d9df
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-regulator-service/index.html
@@ -0,0 +1,26 @@
+
+
+RegulatorService -
+core.node.services / RegulatorService RegulatorService
+interface RegulatorService Placeholder interface for regulator services.
+Types
+
+
+
diff --git a/docs/build/html/api/core.node.services/-service-type/-init-.html b/docs/build/html/api/core.node.services/-service-type/-init-.html
new file mode 100644
index 0000000000..c6d4c90769
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-service-type/-init-.html
@@ -0,0 +1,17 @@
+
+
+ServiceType.<init> -
+core.node.services / ServiceType / <init> <init>
+ServiceType ( id : String ) Identifier for service types a node can expose over the network to other peers. These types are placed into network
+map advertisements. Services that are purely local and are not providing functionality to other parts of the network
+dont need a declared service type.
+ServiceType.equals -
+core.node.services / ServiceType / equals equals
+open operator fun equals ( other : Any ? ) : Boolean ServiceType.hashCode -
+core.node.services / ServiceType / hashCode hashCode
+open fun hashCode ( ) : Int ServiceType.id -
+core.node.services / ServiceType / id id
+val id : String ServiceType -
+core.node.services / ServiceType ServiceType
+abstract class ServiceType Identifier for service types a node can expose over the network to other peers. These types are placed into network
+map advertisements. Services that are purely local and are not providing functionality to other parts of the network
+dont need a declared service type.
+Constructors
+
+
+
+
+<init>
+
+ServiceType ( id : String ) Identifier for service types a node can expose over the network to other peers. These types are placed into network
+map advertisements. Services that are purely local and are not providing functionality to other parts of the network
+dont need a declared service type.
+
+
+
+
+Properties
+
+
+
+
+id
+
+val id : String
+
+
+
+Functions
+
+
+
+
+equals
+
+open operator fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+Inheritors
+
+
+
+
+Type
+
+object Type : ServiceType
+
+
+
+Type
+
+object Type : ServiceType
+
+
+
+Type
+
+object Type : ServiceType
+
+
+
+Type
+
+object Type : ServiceType
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-service-type/to-string.html b/docs/build/html/api/core.node.services/-service-type/to-string.html
new file mode 100644
index 0000000000..7e9d431750
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-service-type/to-string.html
@@ -0,0 +1,15 @@
+
+
+ServiceType.toString -
+core.node.services / ServiceType / toString toString
+open fun toString ( ) : String TimestamperService.Type -
+core.node.services / TimestamperService / Type Type
+object Type : ServiceType Inherited Properties
+
+
+
+
+id
+
+val id : String
+
+
+
+Inherited Functions
+
+
+
+
+equals
+
+open operator fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-timestamper-service/identity.html b/docs/build/html/api/core.node.services/-timestamper-service/identity.html
new file mode 100644
index 0000000000..3c861673b6
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-timestamper-service/identity.html
@@ -0,0 +1,16 @@
+
+
+TimestamperService.identity -
+core.node.services / TimestamperService / identity identity
+abstract val identity : Party The name+pubkey that this timestamper will sign with.
+TimestamperService -
+core.node.services / TimestamperService TimestamperService
+interface TimestamperService Simple interface (for testing) to an abstract timestamping service. Note that this is not "timestamping" in the
+blockchain sense of a total ordering of transactions, but rather, a signature from a well known/trusted timestamping
+service over a transaction that indicates the timestamp in it is accurate. Such a signature may not always be
+necessary: if there are multiple parties involved in a transaction then they can cross-check the timestamp
+themselves.
+Types
+
+Properties
+
+
+
+
+identity
+
+abstract val identity : Party The name+pubkey that this timestamper will sign with.
+
+
+
+
+Functions
+
+Inheritors
+
+
+
+
+Client
+
+class Client : TimestamperService
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-timestamper-service/timestamp.html b/docs/build/html/api/core.node.services/-timestamper-service/timestamp.html
new file mode 100644
index 0000000000..5a861dd890
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-timestamper-service/timestamp.html
@@ -0,0 +1,15 @@
+
+
+TimestamperService.timestamp -
+core.node.services / TimestamperService / timestamp timestamp
+abstract fun timestamp ( wtxBytes : SerializedBytes < WireTransaction > ) : LegallyIdentifiable TimestampingError.NotForMe.<init> -
+core.node.services / TimestampingError / NotForMe / <init> <init>
+NotForMe ( ) Thrown if the command in the transaction doesnt list this timestamping authorities public key as a signer
+TimestampingError.NotForMe -
+core.node.services / TimestampingError / NotForMe NotForMe
+class NotForMe : TimestampingError Thrown if the command in the transaction doesnt list this timestamping authorities public key as a signer
+Constructors
+
+
+
+
+<init>
+
+NotForMe ( ) Thrown if the command in the transaction doesnt list this timestamping authorities public key as a signer
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-timestamping-error/-not-on-time-exception/-init-.html b/docs/build/html/api/core.node.services/-timestamping-error/-not-on-time-exception/-init-.html
new file mode 100644
index 0000000000..283afe7aa9
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-timestamping-error/-not-on-time-exception/-init-.html
@@ -0,0 +1,17 @@
+
+
+TimestampingError.NotOnTimeException.<init> -
+core.node.services / TimestampingError / NotOnTimeException / <init> <init>
+NotOnTimeException ( ) Thrown if an attempt is made to timestamp a transaction using a trusted timestamper, but the time on the
+transaction is too far in the past or future relative to the local clock and thus the timestamper would reject
+it.
+TimestampingError.NotOnTimeException -
+core.node.services / TimestampingError / NotOnTimeException NotOnTimeException
+class NotOnTimeException : TimestampingError Thrown if an attempt is made to timestamp a transaction using a trusted timestamper, but the time on the
+transaction is too far in the past or future relative to the local clock and thus the timestamper would reject
+it.
+Constructors
+
+
+
+
+<init>
+
+NotOnTimeException ( ) Thrown if an attempt is made to timestamp a transaction using a trusted timestamper, but the time on the
+transaction is too far in the past or future relative to the local clock and thus the timestamper would reject
+it.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-timestamping-error/-requires-exactly-one-command/-init-.html b/docs/build/html/api/core.node.services/-timestamping-error/-requires-exactly-one-command/-init-.html
new file mode 100644
index 0000000000..485b64f464
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-timestamping-error/-requires-exactly-one-command/-init-.html
@@ -0,0 +1,14 @@
+
+
+TimestampingError.RequiresExactlyOneCommand.<init> -
+core.node.services / TimestampingError / RequiresExactlyOneCommand / <init> <init>
+RequiresExactlyOneCommand ( ) TimestampingError.RequiresExactlyOneCommand -
+core.node.services / TimestampingError / RequiresExactlyOneCommand RequiresExactlyOneCommand
+class RequiresExactlyOneCommand : TimestampingError Constructors
+
+
+
+
+<init>
+
+RequiresExactlyOneCommand ( )
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-timestamping-error/index.html b/docs/build/html/api/core.node.services/-timestamping-error/index.html
new file mode 100644
index 0000000000..53b2b37e68
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-timestamping-error/index.html
@@ -0,0 +1,68 @@
+
+
+TimestampingError -
+core.node.services / TimestampingError TimestampingError
+sealed class TimestampingError : Exception Exceptions
+
+
+
+
+NotForMe
+
+class NotForMe : TimestampingError Thrown if the command in the transaction doesnt list this timestamping authorities public key as a signer
+
+
+
+
+NotOnTimeException
+
+class NotOnTimeException : TimestampingError Thrown if an attempt is made to timestamp a transaction using a trusted timestamper, but the time on the
+transaction is too far in the past or future relative to the local clock and thus the timestamper would reject
+it.
+
+
+
+
+RequiresExactlyOneCommand
+
+class RequiresExactlyOneCommand : TimestampingError
+
+
+
+Inheritors
+
+
+
+
+NotForMe
+
+class NotForMe : TimestampingError Thrown if the command in the transaction doesnt list this timestamping authorities public key as a signer
+
+
+
+
+NotOnTimeException
+
+class NotOnTimeException : TimestampingError Thrown if an attempt is made to timestamp a transaction using a trusted timestamper, but the time on the
+transaction is too far in the past or future relative to the local clock and thus the timestamper would reject
+it.
+
+
+
+
+RequiresExactlyOneCommand
+
+class RequiresExactlyOneCommand : TimestampingError
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-wire-node-registration/-init-.html b/docs/build/html/api/core.node.services/-wire-node-registration/-init-.html
new file mode 100644
index 0000000000..6c5e446136
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-wire-node-registration/-init-.html
@@ -0,0 +1,15 @@
+
+
+WireNodeRegistration.<init> -
+core.node.services / WireNodeRegistration / <init> <init>
+WireNodeRegistration ( raw : SerializedBytes < NodeRegistration > , sig : WithKey ) A node registration and its signature as a pair.
+WireNodeRegistration -
+core.node.services / WireNodeRegistration WireNodeRegistration
+class WireNodeRegistration : SignedData < NodeRegistration > A node registration and its signature as a pair.
+Constructors
+
+Inherited Properties
+
+Functions
+
+
+
+
+verifyData
+
+fun verifyData ( reg : NodeRegistration ) : Unit Verify the wrapped data after the signature has been verified and the data deserialised. Provided as an extension
+point for subclasses.
+
+
+
+
+Inherited Functions
+
+
+
+
+verified
+
+fun verified ( ) : T Return the deserialized data if the signature can be verified.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.services/-wire-node-registration/verify-data.html b/docs/build/html/api/core.node.services/-wire-node-registration/verify-data.html
new file mode 100644
index 0000000000..9aed2f3d05
--- /dev/null
+++ b/docs/build/html/api/core.node.services/-wire-node-registration/verify-data.html
@@ -0,0 +1,20 @@
+
+
+WireNodeRegistration.verifyData -
+core.node.services / WireNodeRegistration / verifyData verifyData
+protected fun verifyData ( reg : NodeRegistration ) : Unit Verify the wrapped data after the signature has been verified and the data deserialised. Provided as an extension
+point for subclasses.
+Exceptions
+IllegalArgumentException - if the data is invalid.core.node.services -
+core.node.services Package core.node.services
+Types
+
+
+
+
+AbstractNodeService
+
+abstract class AbstractNodeService Abstract superclass for services that a node can host, which provides helper functions.
+
+
+
+
+AttachmentStorage
+
+interface AttachmentStorage An attachment store records potentially large binary objects, identified by their hash. Note that attachments are
+immutable and can never be erased once inserted
+
+
+
+
+DummyTimestampingAuthority
+
+object DummyTimestampingAuthority
+
+
+
+IdentityService
+
+interface IdentityService An identity service maintains an bidirectional map of Party s to their associated public keys and thus supports
+lookup of a party given its key. This is obviously very incomplete and does not reflect everything a real identity
+service would provide.
+
+
+
+
+InMemoryNetworkMapService
+
+class InMemoryNetworkMapService : NetworkMapService , AbstractNodeService
+
+
+
+NetworkMapService
+
+interface NetworkMapService A network map contains lists of nodes on the network along with information about their identity keys, services
+they provide and host names or IP addresses where they can be connected to. This information is cached locally within
+nodes, by the NetworkMapCache . Currently very basic consensus controls are applied, using signed changes which
+replace each other based on a serial number present in the change.
+
+
+
+
+NodeAttachmentService
+
+class NodeAttachmentService : AttachmentStorage , AcceptsFileUpload Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.
+
+
+
+
+NodeInterestRates
+
+object NodeInterestRates An interest rates service is an oracle that signs transactions which contain embedded assertions about an interest
+rate fix (e.g. LIBOR, EURIBOR ...).
+
+
+
+
+NodeRegistration
+
+class NodeRegistration A node registration state in the network map.
+
+
+
+
+NodeTimestamperService
+
+class NodeTimestamperService : AbstractNodeService This class implements the server side of the timestamping protocol, using the local clock. A future version might
+add features like checking against other NTP servers to make sure the clock hasnt drifted by too much.
+
+
+
+
+RegulatorService
+
+interface RegulatorService Placeholder interface for regulator services.
+
+
+
+
+ServiceType
+
+abstract class ServiceType Identifier for service types a node can expose over the network to other peers. These types are placed into network
+map advertisements. Services that are purely local and are not providing functionality to other parts of the network
+dont need a declared service type.
+
+
+
+
+TimestamperService
+
+interface TimestamperService Simple interface (for testing) to an abstract timestamping service. Note that this is not "timestamping" in the
+blockchain sense of a total ordering of transactions, but rather, a signature from a well known/trusted timestamping
+service over a transaction that indicates the timestamp in it is accurate. Such a signature may not always be
+necessary: if there are multiple parties involved in a transaction then they can cross-check the timestamp
+themselves.
+
+
+
+
+WireNodeRegistration
+
+class WireNodeRegistration : SignedData < NodeRegistration > A node registration and its signature as a pair.
+
+
+
+
+Exceptions
+
+
+
diff --git a/docs/build/html/api/core.node.servlets/-attachment-download-servlet/-init-.html b/docs/build/html/api/core.node.servlets/-attachment-download-servlet/-init-.html
new file mode 100644
index 0000000000..0b82f0af72
--- /dev/null
+++ b/docs/build/html/api/core.node.servlets/-attachment-download-servlet/-init-.html
@@ -0,0 +1,22 @@
+
+
+AttachmentDownloadServlet.<init> -
+core.node.servlets / AttachmentDownloadServlet / <init> <init>
+AttachmentDownloadServlet ( ) Allows the node administrator to either download full attachment zips, or individual files within those zips.
+GET /attachments/123abcdef12121 -> download the zip identified by this hash
+GET /attachments/123abcdef12121/foo.txt -> download that file specifically
+Files are always forced to be downloads, they may not be embedded into web pages for security reasons.
+TODO: See if theres a way to prevent access by JavaScript.
+TODO: Provide an endpoint that exposes attachment file listings, to make attachments browseable.
+AttachmentDownloadServlet.doGet -
+core.node.servlets / AttachmentDownloadServlet / doGet doGet
+fun doGet ( req : <ERROR CLASS> , resp : <ERROR CLASS> ) : Unit AttachmentDownloadServlet -
+core.node.servlets / AttachmentDownloadServlet AttachmentDownloadServlet
+class AttachmentDownloadServlet Allows the node administrator to either download full attachment zips, or individual files within those zips.
+GET /attachments/123abcdef12121 -> download the zip identified by this hash
+GET /attachments/123abcdef12121/foo.txt -> download that file specifically
+Files are always forced to be downloads, they may not be embedded into web pages for security reasons.
+TODO: See if theres a way to prevent access by JavaScript.
+TODO: Provide an endpoint that exposes attachment file listings, to make attachments browseable.
+Constructors
+
+
+
+
+<init>
+
+AttachmentDownloadServlet ( ) Allows the node administrator to either download full attachment zips, or individual files within those zips.
+
+
+
+
+Functions
+
+
+
+
+doGet
+
+fun doGet ( req : <ERROR CLASS> , resp : <ERROR CLASS> ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.servlets/-data-upload-servlet/-init-.html b/docs/build/html/api/core.node.servlets/-data-upload-servlet/-init-.html
new file mode 100644
index 0000000000..36a1c1f0d5
--- /dev/null
+++ b/docs/build/html/api/core.node.servlets/-data-upload-servlet/-init-.html
@@ -0,0 +1,15 @@
+
+
+DataUploadServlet.<init> -
+core.node.servlets / DataUploadServlet / <init> <init>
+DataUploadServlet ( ) Accepts binary streams, finds the right AcceptsFileUpload implementor and hands the stream off to it.
+DataUploadServlet.doPost -
+core.node.servlets / DataUploadServlet / doPost doPost
+fun doPost ( req : <ERROR CLASS> , resp : <ERROR CLASS> ) : Unit DataUploadServlet -
+core.node.servlets / DataUploadServlet DataUploadServlet
+class DataUploadServlet Accepts binary streams, finds the right AcceptsFileUpload implementor and hands the stream off to it.
+Constructors
+
+
+
+
+<init>
+
+DataUploadServlet ( ) Accepts binary streams, finds the right AcceptsFileUpload implementor and hands the stream off to it.
+
+
+
+
+Functions
+
+
+
+
+doPost
+
+fun doPost ( req : <ERROR CLASS> , resp : <ERROR CLASS> ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.servlets/index.html b/docs/build/html/api/core.node.servlets/index.html
new file mode 100644
index 0000000000..d97ca6ab62
--- /dev/null
+++ b/docs/build/html/api/core.node.servlets/index.html
@@ -0,0 +1,30 @@
+
+
+core.node.servlets -
+core.node.servlets Package core.node.servlets
+Types
+
+
+
+
+AttachmentDownloadServlet
+
+class AttachmentDownloadServlet Allows the node administrator to either download full attachment zips, or individual files within those zips.
+
+
+
+
+DataUploadServlet
+
+class DataUploadServlet Accepts binary streams, finds the right AcceptsFileUpload implementor and hands the stream off to it.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-artemis-messaging-service/-handler/-init-.html b/docs/build/html/api/core.node.subsystems/-artemis-messaging-service/-handler/-init-.html
new file mode 100644
index 0000000000..3b9fb03c66
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-artemis-messaging-service/-handler/-init-.html
@@ -0,0 +1,15 @@
+
+
+ArtemisMessagingService.Handler.<init> -
+core.node.subsystems / ArtemisMessagingService / Handler / <init> <init>
+Handler ( executor : Executor ? , topic : String , callback : ( Message , MessageHandlerRegistration ) -> Unit ) A registration to handle messages of different types
+ArtemisMessagingService.Handler.callback -
+core.node.subsystems / ArtemisMessagingService / Handler / callback callback
+val callback : ( Message , MessageHandlerRegistration ) -> Unit ArtemisMessagingService.Handler.executor -
+core.node.subsystems / ArtemisMessagingService / Handler / executor executor
+val executor : Executor ? ArtemisMessagingService.Handler -
+core.node.subsystems / ArtemisMessagingService / Handler Handler
+inner class Handler : MessageHandlerRegistration A registration to handle messages of different types
+Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-artemis-messaging-service/-handler/topic.html b/docs/build/html/api/core.node.subsystems/-artemis-messaging-service/-handler/topic.html
new file mode 100644
index 0000000000..db1ab7bd2b
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-artemis-messaging-service/-handler/topic.html
@@ -0,0 +1,15 @@
+
+
+ArtemisMessagingService.Handler.topic -
+core.node.subsystems / ArtemisMessagingService / Handler / topic topic
+val topic : String ArtemisMessagingService.<init> -
+core.node.subsystems / ArtemisMessagingService / <init> <init>
+ArtemisMessagingService ( directory : Path , myHostPort : <ERROR CLASS> , defaultExecutor : Executor = RunOnCallerThread) This class implements the MessagingService API using Apache Artemis, the successor to their ActiveMQ product.
+Artemis is a message queue broker and here, we embed the entire server inside our own process. Nodes communicate
+with each other using (by default) an Artemis specific protocol, but it supports other protocols like AQMP/1.0
+as well.
+The current implementation is skeletal and lacks features like security or firewall tunnelling (that is, you must
+be able to receive TCP connections in order to receive messages). It is good enough for local communication within
+a fully connected network, trusted network or on localhost.
+Parameters
+directory - A place where Artemis can stash its message journal and other files.myHostPort - What host and port to bind to for receiving inbound connections.defaultExecutor - This will be used as the default executor to run message handlers on, if no other is specified.ArtemisMessagingService.TOPIC_PROPERTY -
+core.node.subsystems / ArtemisMessagingService / TOPIC_PROPERTY TOPIC_PROPERTY
+val TOPIC_PROPERTY : String ArtemisMessagingService.addMessageHandler -
+core.node.subsystems / ArtemisMessagingService / addMessageHandler addMessageHandler
+fun addMessageHandler ( topic : String , executor : Executor ? , callback : ( Message , MessageHandlerRegistration ) -> Unit ) : MessageHandlerRegistration MessagingService.addMessageHandler The provided function will be invoked for each received message whose topic matches the given string, on the given
+executor. The topic can be the empty string to match all messages.
+If no executor is received then the callback will run on threads provided by the messaging service, and the
+callback is expected to be thread safe as a result.
+The returned object is an opaque handle that may be used to un-register handlers later with removeMessageHandler .
+The handle is passed to the callback as well, to avoid race conditions whereby the callback wants to unregister
+itself and yet addMessageHandler hasnt returned the handle yet.
+ArtemisMessagingService.createMessage -
+core.node.subsystems / ArtemisMessagingService / createMessage createMessage
+fun createMessage ( topic : String , data : ByteArray ) : Message MessagingService.createMessage Returns an initialised Message with the current time, etc, already filled in.
+ArtemisMessagingService.defaultExecutor -
+core.node.subsystems / ArtemisMessagingService / defaultExecutor defaultExecutor
+val defaultExecutor : Executor ArtemisMessagingService.directory -
+core.node.subsystems / ArtemisMessagingService / directory directory
+val directory : Path ArtemisMessagingService -
+core.node.subsystems / ArtemisMessagingService ArtemisMessagingService
+class ArtemisMessagingService : MessagingService This class implements the MessagingService API using Apache Artemis, the successor to their ActiveMQ product.
+Artemis is a message queue broker and here, we embed the entire server inside our own process. Nodes communicate
+with each other using (by default) an Artemis specific protocol, but it supports other protocols like AQMP/1.0
+as well.
+The current implementation is skeletal and lacks features like security or firewall tunnelling (that is, you must
+be able to receive TCP connections in order to receive messages). It is good enough for local communication within
+a fully connected network, trusted network or on localhost.
+Parameters
+directory - A place where Artemis can stash its message journal and other files.myHostPort - What host and port to bind to for receiving inbound connections.defaultExecutor - This will be used as the default executor to run message handlers on, if no other is specified.Types
+
+Constructors
+
+
+
+
+<init>
+
+ArtemisMessagingService ( directory : Path , myHostPort : <ERROR CLASS> , defaultExecutor : Executor = RunOnCallerThread) This class implements the MessagingService API using Apache Artemis, the successor to their ActiveMQ product.
+Artemis is a message queue broker and here, we embed the entire server inside our own process. Nodes communicate
+with each other using (by default) an Artemis specific protocol, but it supports other protocols like AQMP/1.0
+as well.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+addMessageHandler
+
+fun addMessageHandler ( topic : String , executor : Executor ? , callback : ( Message , MessageHandlerRegistration ) -> Unit ) : MessageHandlerRegistration The provided function will be invoked for each received message whose topic matches the given string, on the given
+executor. The topic can be the empty string to match all messages.
+
+
+
+
+createMessage
+
+fun createMessage ( topic : String , data : ByteArray ) : Message Returns an initialised Message with the current time, etc, already filled in.
+
+
+
+
+removeMessageHandler
+
+fun removeMessageHandler ( registration : MessageHandlerRegistration ) : Unit Removes a handler given the object returned from addMessageHandler . The callback will no longer be invoked once
+this method has returned, although executions that are currently in flight will not be interrupted.
+
+
+
+
+send
+
+fun send ( message : Message , target : MessageRecipients ) : Unit Sends a message to the given receiver. The details of how receivers are identified is up to the messaging
+implementation: the type system provides an opaque high level view, with more fine grained control being
+available via type casting. Once this function returns the message is queued for delivery but not necessarily
+delivered: if the recipients are offline then the message could be queued hours or days later.
+
+
+
+
+start
+
+fun start ( ) : Unit
+
+
+
+stop
+
+fun stop ( ) : Unit
+
+
+
+Companion Object Properties
+
+
+
+
+TOPIC_PROPERTY
+
+val TOPIC_PROPERTY : String
+
+
+
+log
+
+val log : <ERROR CLASS>
+
+
+
+Companion Object Functions
+
+
+
+
+makeRecipient
+
+fun makeRecipient ( hostAndPort : <ERROR CLASS> ) : SingleMessageRecipient Temp helper until network map is established.
+fun makeRecipient ( hostname : String ) : <ERROR CLASS>
+
+
+
+toHostAndPort
+
+fun toHostAndPort ( hostname : String ) : <ERROR CLASS>
+
+
+
+Extension Functions
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-artemis-messaging-service/log.html b/docs/build/html/api/core.node.subsystems/-artemis-messaging-service/log.html
new file mode 100644
index 0000000000..445b93a3ed
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-artemis-messaging-service/log.html
@@ -0,0 +1,15 @@
+
+
+ArtemisMessagingService.log -
+core.node.subsystems / ArtemisMessagingService / log log
+val log : <ERROR CLASS> ArtemisMessagingService.makeRecipient -
+core.node.subsystems / ArtemisMessagingService / makeRecipient makeRecipient
+fun makeRecipient ( hostAndPort : <ERROR CLASS> ) : SingleMessageRecipient Temp helper until network map is established.
+fun makeRecipient ( hostname : String ) : <ERROR CLASS> ArtemisMessagingService.myAddress -
+core.node.subsystems / ArtemisMessagingService / myAddress myAddress
+val myAddress : SingleMessageRecipient MessagingService.myAddress Returns an address that refers to this node.
+ArtemisMessagingService.myHostPort -
+core.node.subsystems / ArtemisMessagingService / myHostPort myHostPort
+val myHostPort : <ERROR CLASS> ArtemisMessagingService.removeMessageHandler -
+core.node.subsystems / ArtemisMessagingService / removeMessageHandler removeMessageHandler
+fun removeMessageHandler ( registration : MessageHandlerRegistration ) : Unit MessagingService.removeMessageHandler Removes a handler given the object returned from addMessageHandler . The callback will no longer be invoked once
+this method has returned, although executions that are currently in flight will not be interrupted.
+Exceptions
+IllegalArgumentException - if the given registration isnt valid for this messaging service.IllegalStateException - if the given registration was already de-registered.ArtemisMessagingService.send -
+core.node.subsystems / ArtemisMessagingService / send send
+fun send ( message : Message , target : MessageRecipients ) : Unit MessagingService.send Sends a message to the given receiver. The details of how receivers are identified is up to the messaging
+implementation: the type system provides an opaque high level view, with more fine grained control being
+available via type casting. Once this function returns the message is queued for delivery but not necessarily
+delivered: if the recipients are offline then the message could be queued hours or days later.
+There is no way to know if a message has been received. If your protocol requires this, you need the recipient
+to send an ACK message back.
+ArtemisMessagingService.start -
+core.node.subsystems / ArtemisMessagingService / start start
+fun start ( ) : Unit ArtemisMessagingService.stop -
+core.node.subsystems / ArtemisMessagingService / stop stop
+fun stop ( ) : Unit MessagingService.stop ArtemisMessagingService.toHostAndPort -
+core.node.subsystems / ArtemisMessagingService / toHostAndPort toHostAndPort
+fun toHostAndPort ( hostname : String ) : <ERROR CLASS> DataVendingService.<init> -
+core.node.subsystems / DataVendingService / <init> <init>
+DataVendingService ( net : MessagingService , storage : StorageService ) This class sets up network message handlers for requests from peers for data keyed by hash. It is a piece of simple
+glue that sits between the network layer and the database layer.
+Note that in our data model, to be able to name a thing by hash automatically gives the power to request it. There
+are no access control lists. If you want to keep some data private, then you must be careful who you give its name
+to, and trust that they will not pass the name onwards. If someone suspects some data might exist but does not have
+its name, then the 256-bit search space theyd have to cover makes it physically impossible to enumerate, and as
+such the hash of a piece of data can be seen as a type of password allowing access to it.
+Additionally, because nodes do not store invalid transactions, requesting such a transaction will always yield null.
+DataVendingService.Request.<init> -
+core.node.subsystems / DataVendingService / Request / <init> <init>
+Request ( hashes : List < SecureHash > , replyTo : SingleMessageRecipient , sessionID : Long ) DataVendingService.Request.hashes -
+core.node.subsystems / DataVendingService / Request / hashes hashes
+val hashes : List < SecureHash > DataVendingService.Request -
+core.node.subsystems / DataVendingService / Request Request
+class Request : AbstractRequestMessage Constructors
+
+Properties
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-data-vending-service/index.html b/docs/build/html/api/core.node.subsystems/-data-vending-service/index.html
new file mode 100644
index 0000000000..d8b74cb46d
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-data-vending-service/index.html
@@ -0,0 +1,85 @@
+
+
+DataVendingService -
+core.node.subsystems / DataVendingService DataVendingService
+class DataVendingService : AbstractNodeService This class sets up network message handlers for requests from peers for data keyed by hash. It is a piece of simple
+glue that sits between the network layer and the database layer.
+Note that in our data model, to be able to name a thing by hash automatically gives the power to request it. There
+are no access control lists. If you want to keep some data private, then you must be careful who you give its name
+to, and trust that they will not pass the name onwards. If someone suspects some data might exist but does not have
+its name, then the 256-bit search space theyd have to cover makes it physically impossible to enumerate, and as
+such the hash of a piece of data can be seen as a type of password allowing access to it.
+Additionally, because nodes do not store invalid transactions, requesting such a transaction will always yield null.
+Types
+
+Constructors
+
+
+
+
+<init>
+
+DataVendingService ( net : MessagingService , storage : StorageService ) This class sets up network message handlers for requests from peers for data keyed by hash. It is a piece of simple
+glue that sits between the network layer and the database layer.
+
+
+
+
+Inherited Properties
+
+Inherited Functions
+
+
+
+
+addMessageHandler
+
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R , exceptionConsumer : ( Message , Exception ) -> Unit ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are caught and passed to the provided consumer.
+fun < Q : AbstractRequestMessage , R : Any > addMessageHandler ( topic : String , handler : ( Q ) -> R ) : Unit Register a handler for a message topic. In comparison to using net.addMessageHandler() this manages a lot of
+common boilerplate code. Exceptions are propagated to the messaging layer.
+
+
+
+
+Companion Object Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-data-vending-service/logger.html b/docs/build/html/api/core.node.subsystems/-data-vending-service/logger.html
new file mode 100644
index 0000000000..7220b16436
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-data-vending-service/logger.html
@@ -0,0 +1,15 @@
+
+
+DataVendingService.logger -
+core.node.subsystems / DataVendingService / logger logger
+val logger : <ERROR CLASS> E2ETestKeyManagementService.<init> -
+core.node.subsystems / E2ETestKeyManagementService / <init> <init>
+E2ETestKeyManagementService ( ) A simple in-memory KMS that doesnt bother saving keys to disk. A real implementation would:
+Probably be accessed via the network layer as an internal node service i.e. via a message queue, so it can run
+on a separate/firewalled service.
+Use the protocol framework so requests to fetch keys can be suspended whilst a human signs off on the request.
+Use deterministic key derivation.
+Possibly have some sort of TREZOR-like two-factor authentication ability
+etc
+E2ETestKeyManagementService.freshKey -
+core.node.subsystems / E2ETestKeyManagementService / freshKey freshKey
+fun freshKey ( ) : KeyPair KeyManagementService.freshKey Generates a new random key and adds it to the exposed map.
+E2ETestKeyManagementService -
+core.node.subsystems / E2ETestKeyManagementService E2ETestKeyManagementService
+class E2ETestKeyManagementService : KeyManagementService A simple in-memory KMS that doesnt bother saving keys to disk. A real implementation would:
+Probably be accessed via the network layer as an internal node service i.e. via a message queue, so it can run
+on a separate/firewalled service.
+Use the protocol framework so requests to fetch keys can be suspended whilst a human signs off on the request.
+Use deterministic key derivation.
+Possibly have some sort of TREZOR-like two-factor authentication ability
+etc
+Constructors
+
+
+
+
+<init>
+
+E2ETestKeyManagementService ( ) A simple in-memory KMS that doesnt bother saving keys to disk. A real implementation would:
+
+
+
+
+Properties
+
+
+
+
+keys
+
+val keys : Map < PublicKey , PrivateKey > Returns a snapshot of the current pubkey->privkey mapping.
+
+
+
+
+Functions
+
+
+
+
+freshKey
+
+fun freshKey ( ) : KeyPair Generates a new random key and adds it to the exposed map.
+
+
+
+
+Inherited Functions
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-e2-e-test-key-management-service/keys.html b/docs/build/html/api/core.node.subsystems/-e2-e-test-key-management-service/keys.html
new file mode 100644
index 0000000000..ffb996c1ce
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-e2-e-test-key-management-service/keys.html
@@ -0,0 +1,20 @@
+
+
+E2ETestKeyManagementService.keys -
+core.node.subsystems / E2ETestKeyManagementService / keys keys
+val keys : Map < PublicKey , PrivateKey > KeyManagementService.keys Returns a snapshot of the current pubkey->privkey mapping.
+Getter Returns a snapshot of the current pubkey->privkey mapping.
+InMemoryIdentityService.<init> -
+core.node.subsystems / InMemoryIdentityService / <init> <init>
+InMemoryIdentityService ( ) Simple identity service which caches parties and provides functionality for efficient lookup.
+InMemoryIdentityService -
+core.node.subsystems / InMemoryIdentityService InMemoryIdentityService
+class InMemoryIdentityService : IdentityService Simple identity service which caches parties and provides functionality for efficient lookup.
+Constructors
+
+
+
+
+<init>
+
+InMemoryIdentityService ( ) Simple identity service which caches parties and provides functionality for efficient lookup.
+
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-in-memory-identity-service/party-from-key.html b/docs/build/html/api/core.node.subsystems/-in-memory-identity-service/party-from-key.html
new file mode 100644
index 0000000000..640f965623
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-in-memory-identity-service/party-from-key.html
@@ -0,0 +1,16 @@
+
+
+InMemoryIdentityService.partyFromKey -
+core.node.subsystems / InMemoryIdentityService / partyFromKey partyFromKey
+fun partyFromKey ( key : PublicKey ) : Party ? IdentityService.partyFromKey InMemoryIdentityService.partyFromName -
+core.node.subsystems / InMemoryIdentityService / partyFromName partyFromName
+fun partyFromName ( name : String ) : Party ? IdentityService.partyFromName InMemoryIdentityService.registerIdentity -
+core.node.subsystems / InMemoryIdentityService / registerIdentity registerIdentity
+fun registerIdentity ( party : Party ) : Unit IdentityService.registerIdentity InMemoryNetworkMapCache.<init> -
+core.node.subsystems / InMemoryNetworkMapCache / <init> <init>
+InMemoryNetworkMapCache ( ) Extremely simple in-memory cache of the network map.
+InMemoryNetworkMapCache.addMapService -
+core.node.subsystems / InMemoryNetworkMapCache / addMapService addMapService
+open fun addMapService ( smm : StateMachineManager , net : MessagingService , service : NodeInfo , subscribe : Boolean , ifChangedSinceVer : Int ? ) : <ERROR CLASS> < Unit > NetworkMapCache.addMapService Add a network map service; fetches a copy of the latest map from the service and subscribes to any further
+updates.
+Parameters
+smm - state machine manager to use when requestingnet - the network messaging serviceservice - the network map service to fetch current state from.subscribe - if the cache should subscribe to updatesifChangedSinceVer - an optional version number to limit updating the map based on. If the latest map
+version is less than or equal to the given version, no update is fetched.InMemoryNetworkMapCache.addNode -
+core.node.subsystems / InMemoryNetworkMapCache / addNode addNode
+open fun addNode ( node : NodeInfo ) : Unit NetworkMapCache.addNode Adds a node to the local cache (generally only used for adding ourselves)
+InMemoryNetworkMapCache.deregisterForUpdates -
+core.node.subsystems / InMemoryNetworkMapCache / deregisterForUpdates deregisterForUpdates
+open fun deregisterForUpdates ( smm : StateMachineManager , net : MessagingService , service : NodeInfo ) : <ERROR CLASS> < Unit > NetworkMapCache.deregisterForUpdates Unsubscribes from updates from the given map service.
+Parameters
+service - the network map service to listen to updates from.InMemoryNetworkMapCache.getRecommended -
+core.node.subsystems / InMemoryNetworkMapCache / getRecommended getRecommended
+open fun getRecommended ( type : ServiceType , contract : Contract , vararg party : Party ) : NodeInfo ? NetworkMapCache.getRecommended Get a recommended node that advertises a service, and is suitable for the specified contract and parties.
+Implementations might understand, for example, the correct regulator to use for specific contracts/parties,
+or the appropriate oracle for a contract.
+InMemoryNetworkMapCache.get -
+core.node.subsystems / InMemoryNetworkMapCache / get get
+open fun get ( ) : <ERROR CLASS> NetworkMapCache.get Get a copy of all nodes in the map.
+open fun get ( serviceType : ServiceType ) : <ERROR CLASS> NetworkMapCache.get Get the collection of nodes which advertise a specific service.
+InMemoryNetworkMapCache -
+core.node.subsystems / InMemoryNetworkMapCache InMemoryNetworkMapCache
+open class InMemoryNetworkMapCache : NetworkMapCache Extremely simple in-memory cache of the network map.
+Constructors
+
+
+
+
+<init>
+
+InMemoryNetworkMapCache ( ) Extremely simple in-memory cache of the network map.
+
+
+
+
+Properties
+
+
+
+
+networkMapNodes
+
+open val networkMapNodes : List < NodeInfo > A list of nodes that advertise a network map service
+
+
+
+
+partyNodes
+
+open val partyNodes : List < NodeInfo > A list of all nodes the cache is aware of
+
+
+
+
+ratesOracleNodes
+
+open val ratesOracleNodes : List < NodeInfo > A list of nodes that advertise a rates oracle service
+
+
+
+
+registeredNodes
+
+var registeredNodes : MutableMap < Party , NodeInfo >
+
+
+
+regulators
+
+open val regulators : List < NodeInfo > A list of nodes that advertise a regulatory service. Identifying the correct regulator for a trade is outwith
+the scope of the network map service, and this is intended solely as a sanity check on configuration stored
+elsewhere.
+
+
+
+
+timestampingNodes
+
+open val timestampingNodes : List < NodeInfo > A list of nodes that advertise a timestamping service
+
+
+
+
+Functions
+
+
+
+
+addMapService
+
+open fun addMapService ( smm : StateMachineManager , net : MessagingService , service : NodeInfo , subscribe : Boolean , ifChangedSinceVer : Int ? ) : <ERROR CLASS> < Unit > Add a network map service; fetches a copy of the latest map from the service and subscribes to any further
+updates.
+
+
+
+
+addNode
+
+open fun addNode ( node : NodeInfo ) : Unit Adds a node to the local cache (generally only used for adding ourselves)
+
+
+
+
+deregisterForUpdates
+
+open fun deregisterForUpdates ( smm : StateMachineManager , net : MessagingService , service : NodeInfo ) : <ERROR CLASS> < Unit > Unsubscribes from updates from the given map service.
+
+
+
+
+get
+
+open fun get ( ) : <ERROR CLASS> Get a copy of all nodes in the map.
+open fun get ( serviceType : ServiceType ) : <ERROR CLASS> Get the collection of nodes which advertise a specific service.
+
+
+
+
+getRecommended
+
+open fun getRecommended ( type : ServiceType , contract : Contract , vararg party : Party ) : NodeInfo ? Get a recommended node that advertises a service, and is suitable for the specified contract and parties.
+Implementations might understand, for example, the correct regulator to use for specific contracts/parties,
+or the appropriate oracle for a contract.
+
+
+
+
+processUpdatePush
+
+fun processUpdatePush ( req : Update ) : Unit
+
+
+
+removeNode
+
+open fun removeNode ( node : NodeInfo ) : Unit Removes a node from the local cache
+
+
+
+
+Inherited Functions
+
+Inheritors
+
+
+
+
+MockNetworkMapCache
+
+class MockNetworkMapCache : InMemoryNetworkMapCache Network map cache with no backing map service.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-in-memory-network-map-cache/network-map-nodes.html b/docs/build/html/api/core.node.subsystems/-in-memory-network-map-cache/network-map-nodes.html
new file mode 100644
index 0000000000..7f5da8f63e
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-in-memory-network-map-cache/network-map-nodes.html
@@ -0,0 +1,20 @@
+
+
+InMemoryNetworkMapCache.networkMapNodes -
+core.node.subsystems / InMemoryNetworkMapCache / networkMapNodes networkMapNodes
+open val networkMapNodes : List < NodeInfo > NetworkMapCache.networkMapNodes A list of nodes that advertise a network map service
+Getter A list of nodes that advertise a network map service
+InMemoryNetworkMapCache.partyNodes -
+core.node.subsystems / InMemoryNetworkMapCache / partyNodes partyNodes
+open val partyNodes : List < NodeInfo > NetworkMapCache.partyNodes A list of all nodes the cache is aware of
+Getter A list of all nodes the cache is aware of
+InMemoryNetworkMapCache.processUpdatePush -
+core.node.subsystems / InMemoryNetworkMapCache / processUpdatePush processUpdatePush
+fun processUpdatePush ( req : Update ) : Unit InMemoryNetworkMapCache.ratesOracleNodes -
+core.node.subsystems / InMemoryNetworkMapCache / ratesOracleNodes ratesOracleNodes
+open val ratesOracleNodes : List < NodeInfo > NetworkMapCache.ratesOracleNodes A list of nodes that advertise a rates oracle service
+Getter A list of nodes that advertise a rates oracle service
+InMemoryNetworkMapCache.registeredNodes -
+core.node.subsystems / InMemoryNetworkMapCache / registeredNodes registeredNodes
+protected var registeredNodes : MutableMap < Party , NodeInfo > InMemoryNetworkMapCache.regulators -
+core.node.subsystems / InMemoryNetworkMapCache / regulators regulators
+open val regulators : List < NodeInfo > NetworkMapCache.regulators A list of nodes that advertise a regulatory service. Identifying the correct regulator for a trade is outwith
+the scope of the network map service, and this is intended solely as a sanity check on configuration stored
+elsewhere.
+Getter A list of nodes that advertise a regulatory service. Identifying the correct regulator for a trade is outwith
+the scope of the network map service, and this is intended solely as a sanity check on configuration stored
+elsewhere.
+InMemoryNetworkMapCache.removeNode -
+core.node.subsystems / InMemoryNetworkMapCache / removeNode removeNode
+open fun removeNode ( node : NodeInfo ) : Unit NetworkMapCache.removeNode Removes a node from the local cache
+InMemoryNetworkMapCache.timestampingNodes -
+core.node.subsystems / InMemoryNetworkMapCache / timestampingNodes timestampingNodes
+open val timestampingNodes : List < NodeInfo > NetworkMapCache.timestampingNodes A list of nodes that advertise a timestamping service
+Getter A list of nodes that advertise a timestamping service
+KeyManagementService.freshKey -
+core.node.subsystems / KeyManagementService / freshKey freshKey
+abstract fun freshKey ( ) : KeyPair Generates a new random key and adds it to the exposed map.
+KeyManagementService -
+core.node.subsystems / KeyManagementService KeyManagementService
+interface KeyManagementService The KMS is responsible for storing and using private keys to sign things. An implementation of this may, for example,
+call out to a hardware security module that enforces various auditing and frequency-of-use requirements.
+The current interface is obviously not usable for those use cases: this is just where wed put a real signing
+interface if/when one is developed.
+Properties
+
+
+
+
+keys
+
+abstract val keys : Map < PublicKey , PrivateKey > Returns a snapshot of the current pubkey->privkey mapping.
+
+
+
+
+Functions
+
+Inheritors
+
+
+
+
+E2ETestKeyManagementService
+
+class E2ETestKeyManagementService : KeyManagementService A simple in-memory KMS that doesnt bother saving keys to disk. A real implementation would:
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-key-management-service/keys.html b/docs/build/html/api/core.node.subsystems/-key-management-service/keys.html
new file mode 100644
index 0000000000..31fbdf88ab
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-key-management-service/keys.html
@@ -0,0 +1,16 @@
+
+
+KeyManagementService.keys -
+core.node.subsystems / KeyManagementService / keys keys
+abstract val keys : Map < PublicKey , PrivateKey > Returns a snapshot of the current pubkey->privkey mapping.
+KeyManagementService.toPrivate -
+core.node.subsystems / KeyManagementService / toPrivate toPrivate
+open fun toPrivate ( publicKey : PublicKey ) : PrivateKey MonitoringService.<init> -
+core.node.subsystems / MonitoringService / <init> <init>
+MonitoringService ( metrics : <ERROR CLASS> ) Provides access to various metrics and ways to notify monitoring services of things, for sysadmin purposes.
+This is not an interface because it is too lightweight to bother mocking out.
+MonitoringService -
+core.node.subsystems / MonitoringService MonitoringService
+class MonitoringService Provides access to various metrics and ways to notify monitoring services of things, for sysadmin purposes.
+This is not an interface because it is too lightweight to bother mocking out.
+Constructors
+
+
+
+
+<init>
+
+MonitoringService ( metrics : <ERROR CLASS> ) Provides access to various metrics and ways to notify monitoring services of things, for sysadmin purposes.
+This is not an interface because it is too lightweight to bother mocking out.
+
+
+
+
+Properties
+
+
+
+
+metrics
+
+val metrics : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-monitoring-service/metrics.html b/docs/build/html/api/core.node.subsystems/-monitoring-service/metrics.html
new file mode 100644
index 0000000000..46d6d168bb
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-monitoring-service/metrics.html
@@ -0,0 +1,15 @@
+
+
+MonitoringService.metrics -
+core.node.subsystems / MonitoringService / metrics metrics
+val metrics : <ERROR CLASS> NetworkCacheError.DeregistrationFailed.<init> -
+core.node.subsystems / NetworkCacheError / DeregistrationFailed / <init> <init>
+DeregistrationFailed ( ) Indicates a failure to deregister, because of a rejected request from the remote node
+NetworkCacheError.DeregistrationFailed -
+core.node.subsystems / NetworkCacheError / DeregistrationFailed DeregistrationFailed
+class DeregistrationFailed : NetworkCacheError Indicates a failure to deregister, because of a rejected request from the remote node
+Constructors
+
+
+
+
+<init>
+
+DeregistrationFailed ( ) Indicates a failure to deregister, because of a rejected request from the remote node
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-network-cache-error/index.html b/docs/build/html/api/core.node.subsystems/-network-cache-error/index.html
new file mode 100644
index 0000000000..f35c010a6d
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-network-cache-error/index.html
@@ -0,0 +1,38 @@
+
+
+NetworkCacheError -
+core.node.subsystems / NetworkCacheError NetworkCacheError
+sealed class NetworkCacheError : Exception Exceptions
+
+
+
+
+DeregistrationFailed
+
+class DeregistrationFailed : NetworkCacheError Indicates a failure to deregister, because of a rejected request from the remote node
+
+
+
+
+Inheritors
+
+
+
+
+DeregistrationFailed
+
+class DeregistrationFailed : NetworkCacheError Indicates a failure to deregister, because of a rejected request from the remote node
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-network-map-cache/add-map-service.html b/docs/build/html/api/core.node.subsystems/-network-map-cache/add-map-service.html
new file mode 100644
index 0000000000..12b1a7a084
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-network-map-cache/add-map-service.html
@@ -0,0 +1,33 @@
+
+
+NetworkMapCache.addMapService -
+core.node.subsystems / NetworkMapCache / addMapService addMapService
+abstract fun addMapService ( smm : StateMachineManager , net : MessagingService , service : NodeInfo , subscribe : Boolean , ifChangedSinceVer : Int ? = null) : <ERROR CLASS> < Unit > Add a network map service; fetches a copy of the latest map from the service and subscribes to any further
+updates.
+Parameters
+smm - state machine manager to use when requestingnet - the network messaging serviceservice - the network map service to fetch current state from.subscribe - if the cache should subscribe to updatesifChangedSinceVer - an optional version number to limit updating the map based on. If the latest map
+version is less than or equal to the given version, no update is fetched.NetworkMapCache.addNode -
+core.node.subsystems / NetworkMapCache / addNode addNode
+abstract fun addNode ( node : NodeInfo ) : Unit Adds a node to the local cache (generally only used for adding ourselves)
+NetworkMapCache.deregisterForUpdates -
+core.node.subsystems / NetworkMapCache / deregisterForUpdates deregisterForUpdates
+abstract fun deregisterForUpdates ( smm : StateMachineManager , net : MessagingService , service : NodeInfo ) : <ERROR CLASS> < Unit > Deregister from updates from the given map service.
+Parameters
+smm - state machine manager to use when requestingnet - the network messaging serviceservice - the network map service to fetch current state from.NetworkMapCache.getRecommended -
+core.node.subsystems / NetworkMapCache / getRecommended getRecommended
+abstract fun getRecommended ( type : ServiceType , contract : Contract , vararg party : Party ) : NodeInfo ? Get a recommended node that advertises a service, and is suitable for the specified contract and parties.
+Implementations might understand, for example, the correct regulator to use for specific contracts/parties,
+or the appropriate oracle for a contract.
+NetworkMapCache.get -
+core.node.subsystems / NetworkMapCache / get get
+abstract fun get ( ) : Collection < NodeInfo > Get a copy of all nodes in the map.
+abstract fun get ( serviceType : ServiceType ) : Collection < NodeInfo > Get the collection of nodes which advertise a specific service.
+NetworkMapCache -
+core.node.subsystems / NetworkMapCache NetworkMapCache
+interface NetworkMapCache A network map contains lists of nodes on the network along with information about their identity keys, services
+they provide and host names or IP addresses where they can be connected to. The cache wraps around a map fetched
+from an authoritative service, and adds easy lookup of the data stored within it. Generally it would be initialised
+with a specified network map service, which it fetches data from and then subscribes to updates of.
+Properties
+
+
+
+
+networkMapNodes
+
+abstract val networkMapNodes : List < NodeInfo > A list of nodes that advertise a network map service
+
+
+
+
+partyNodes
+
+abstract val partyNodes : List < NodeInfo > A list of all nodes the cache is aware of
+
+
+
+
+ratesOracleNodes
+
+abstract val ratesOracleNodes : List < NodeInfo > A list of nodes that advertise a rates oracle service
+
+
+
+
+regulators
+
+abstract val regulators : List < NodeInfo > A list of nodes that advertise a regulatory service. Identifying the correct regulator for a trade is outwith
+the scope of the network map service, and this is intended solely as a sanity check on configuration stored
+elsewhere.
+
+
+
+
+timestampingNodes
+
+abstract val timestampingNodes : List < NodeInfo > A list of nodes that advertise a timestamping service
+
+
+
+
+Functions
+
+
+
+
+addMapService
+
+abstract fun addMapService ( smm : StateMachineManager , net : MessagingService , service : NodeInfo , subscribe : Boolean , ifChangedSinceVer : Int ? = null) : <ERROR CLASS> < Unit > Add a network map service; fetches a copy of the latest map from the service and subscribes to any further
+updates.
+
+
+
+
+addNode
+
+abstract fun addNode ( node : NodeInfo ) : Unit Adds a node to the local cache (generally only used for adding ourselves)
+
+
+
+
+deregisterForUpdates
+
+abstract fun deregisterForUpdates ( smm : StateMachineManager , net : MessagingService , service : NodeInfo ) : <ERROR CLASS> < Unit > Deregister from updates from the given map service.
+
+
+
+
+get
+
+abstract fun get ( ) : Collection < NodeInfo > Get a copy of all nodes in the map.
+abstract fun get ( serviceType : ServiceType ) : Collection < NodeInfo > Get the collection of nodes which advertise a specific service.
+
+
+
+
+getRecommended
+
+abstract fun getRecommended ( type : ServiceType , contract : Contract , vararg party : Party ) : NodeInfo ? Get a recommended node that advertises a service, and is suitable for the specified contract and parties.
+Implementations might understand, for example, the correct regulator to use for specific contracts/parties,
+or the appropriate oracle for a contract.
+
+
+
+
+nodeForPartyName
+
+open fun nodeForPartyName ( name : String ) : NodeInfo ? Look up the node info for a party.
+
+
+
+
+removeNode
+
+abstract fun removeNode ( node : NodeInfo ) : Unit Removes a node from the local cache
+
+
+
+
+Companion Object Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS>
+
+
+
+Inheritors
+
+
+
+
+InMemoryNetworkMapCache
+
+open class InMemoryNetworkMapCache : NetworkMapCache Extremely simple in-memory cache of the network map.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-network-map-cache/logger.html b/docs/build/html/api/core.node.subsystems/-network-map-cache/logger.html
new file mode 100644
index 0000000000..bc750de9c4
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-network-map-cache/logger.html
@@ -0,0 +1,15 @@
+
+
+NetworkMapCache.logger -
+core.node.subsystems / NetworkMapCache / logger logger
+val logger : <ERROR CLASS> NetworkMapCache.networkMapNodes -
+core.node.subsystems / NetworkMapCache / networkMapNodes networkMapNodes
+abstract val networkMapNodes : List < NodeInfo > A list of nodes that advertise a network map service
+NetworkMapCache.nodeForPartyName -
+core.node.subsystems / NetworkMapCache / nodeForPartyName nodeForPartyName
+open fun nodeForPartyName ( name : String ) : NodeInfo ? Look up the node info for a party.
+NetworkMapCache.partyNodes -
+core.node.subsystems / NetworkMapCache / partyNodes partyNodes
+abstract val partyNodes : List < NodeInfo > A list of all nodes the cache is aware of
+NetworkMapCache.ratesOracleNodes -
+core.node.subsystems / NetworkMapCache / ratesOracleNodes ratesOracleNodes
+abstract val ratesOracleNodes : List < NodeInfo > A list of nodes that advertise a rates oracle service
+NetworkMapCache.regulators -
+core.node.subsystems / NetworkMapCache / regulators regulators
+abstract val regulators : List < NodeInfo > A list of nodes that advertise a regulatory service. Identifying the correct regulator for a trade is outwith
+the scope of the network map service, and this is intended solely as a sanity check on configuration stored
+elsewhere.
+NetworkMapCache.removeNode -
+core.node.subsystems / NetworkMapCache / removeNode removeNode
+abstract fun removeNode ( node : NodeInfo ) : Unit Removes a node from the local cache
+NetworkMapCache.timestampingNodes -
+core.node.subsystems / NetworkMapCache / timestampingNodes timestampingNodes
+abstract val timestampingNodes : List < NodeInfo > A list of nodes that advertise a timestamping service
+NodeWalletService.<init> -
+core.node.subsystems / NodeWalletService / <init> <init>
+NodeWalletService ( services : ServiceHub ) This class implements a simple, in memory wallet that tracks states that are owned by us, and also has a convenience
+method to auto-generate some self-issued cash states that can be used for test trading. A real wallet would persist
+states relevant to us into a database and once such a wallet is implemented, this scaffolding can be removed.
+NodeWalletService.cashBalances -
+core.node.subsystems / NodeWalletService / cashBalances cashBalances
+val cashBalances : Map < Currency , Amount > WalletService.cashBalances Returns a snapshot of how much cash we have in each currency, ignoring details like issuer. Note: currencies for
+which we have no cash evaluate to null, not 0.
+Getter Returns a snapshot of how much cash we have in each currency, ignoring details like issuer. Note: currencies for
+which we have no cash evaluate to null, not 0.
+NodeWalletService.currentWallet -
+core.node.subsystems / NodeWalletService / currentWallet currentWallet
+val currentWallet : Wallet WalletService.currentWallet Returns a read-only snapshot of the wallet at the time the call is made. Note that if you consume states or
+keys in this wallet, you must inform the wallet service so it can update its internal state.
+Getter Returns a read-only snapshot of the wallet at the time the call is made. Note that if you consume states or
+keys in this wallet, you must inform the wallet service so it can update its internal state.
+NodeWalletService.fillWithSomeTestCash -
+core.node.subsystems / NodeWalletService / fillWithSomeTestCash fillWithSomeTestCash
+fun fillWithSomeTestCash ( howMuch : Amount , atLeastThisManyStates : Int = 3, atMostThisManyStates : Int = 10, rng : Random = Random()) : Unit Creates a random set of between (by default) 3 and 10 cash states that add up to the given amount and adds them
+to the wallet.
+The cash is self issued with the current nodes identity, as fetched from the storage service. Thus it
+would not be trusted by any sensible market participant and is effectively an IOU. If it had been issued by
+the central bank, well ... thatd be a different story altogether.
+TODO: Move this out of NodeWalletService
+NodeWalletService -
+core.node.subsystems / NodeWalletService NodeWalletService
+class NodeWalletService : WalletService This class implements a simple, in memory wallet that tracks states that are owned by us, and also has a convenience
+method to auto-generate some self-issued cash states that can be used for test trading. A real wallet would persist
+states relevant to us into a database and once such a wallet is implemented, this scaffolding can be removed.
+Constructors
+
+
+
+
+<init>
+
+NodeWalletService ( services : ServiceHub ) This class implements a simple, in memory wallet that tracks states that are owned by us, and also has a convenience
+method to auto-generate some self-issued cash states that can be used for test trading. A real wallet would persist
+states relevant to us into a database and once such a wallet is implemented, this scaffolding can be removed.
+
+
+
+
+Properties
+
+
+
+
+cashBalances
+
+val cashBalances : Map < Currency , Amount > Returns a snapshot of how much cash we have in each currency, ignoring details like issuer. Note: currencies for
+which we have no cash evaluate to null, not 0.
+
+
+
+
+currentWallet
+
+val currentWallet : Wallet Returns a read-only snapshot of the wallet at the time the call is made. Note that if you consume states or
+keys in this wallet, you must inform the wallet service so it can update its internal state.
+
+
+
+
+linearHeads
+
+val linearHeads : Map < SecureHash , StateAndRef < LinearState > > Returns a snapshot of the heads of LinearStates
+
+
+
+
+Functions
+
+
+
+
+fillWithSomeTestCash
+
+fun fillWithSomeTestCash ( howMuch : Amount , atLeastThisManyStates : Int = 3, atMostThisManyStates : Int = 10, rng : Random = Random()) : Unit Creates a random set of between (by default) 3 and 10 cash states that add up to the given amount and adds them
+to the wallet.
+
+
+
+
+notifyAll
+
+fun notifyAll ( txns : Iterable < WireTransaction > ) : Wallet Possibly update the wallet by marking as spent states that these transactions consume, and adding any relevant
+new states that they create. You should only insert transactions that have been successfully verified here
+
+
+
+
+Inherited Functions
+
+Extension Functions
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-node-wallet-service/linear-heads.html b/docs/build/html/api/core.node.subsystems/-node-wallet-service/linear-heads.html
new file mode 100644
index 0000000000..6c1edfea99
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-node-wallet-service/linear-heads.html
@@ -0,0 +1,20 @@
+
+
+NodeWalletService.linearHeads -
+core.node.subsystems / NodeWalletService / linearHeads linearHeads
+val linearHeads : Map < SecureHash , StateAndRef < LinearState > > WalletService.linearHeads Returns a snapshot of the heads of LinearStates
+Getter Returns a snapshot of the heads of LinearStates
+NodeWalletService.notifyAll -
+core.node.subsystems / NodeWalletService / notifyAll notifyAll
+fun notifyAll ( txns : Iterable < WireTransaction > ) : Wallet WalletService.notifyAll Possibly update the wallet by marking as spent states that these transactions consume, and adding any relevant
+new states that they create. You should only insert transactions that have been successfully verified here
+Returns the new wallet that resulted from applying the transactions (note: it may quickly become out of date).
+TODO: Consider if theres a good way to enforce the must-be-verified requirement in the type system.
+StorageServiceImpl.<init> -
+core.node.subsystems / StorageServiceImpl / <init> <init>
+StorageServiceImpl ( attachments : AttachmentStorage , keypair : KeyPair , identity : Party = Party("Unit test party", keypair.public), recordingAs : ( String ) -> String = { tableName -> "" }) StorageServiceImpl.attachments -
+core.node.subsystems / StorageServiceImpl / attachments attachments
+open val attachments : AttachmentStorage StorageService.attachments Provides access to storage of arbitrary JAR files (which may contain only data, no code).
+StorageServiceImpl -
+core.node.subsystems / StorageServiceImpl StorageServiceImpl
+open class StorageServiceImpl : StorageService Constructors
+
+
+
+
+<init>
+
+StorageServiceImpl ( attachments : AttachmentStorage , keypair : KeyPair , identity : Party = Party("Unit test party", keypair.public), recordingAs : ( String ) -> String = { tableName -> "" })
+
+
+
+Properties
+
+
+
+
+attachments
+
+open val attachments : AttachmentStorage Provides access to storage of arbitrary JAR files (which may contain only data, no code).
+
+
+
+
+myLegalIdentity
+
+open val myLegalIdentity : Party Returns the legal identity that this node is configured with. Assumed to be initialised when the node is
+first installed.
+
+
+
+
+myLegalIdentityKey
+
+open val myLegalIdentityKey : KeyPair
+
+
+
+recordingAs
+
+val recordingAs : ( String ) -> String
+
+
+
+stateMachines
+
+open val stateMachines : MutableMap < SecureHash , ByteArray >
+
+
+
+tables
+
+val tables : HashMap < String , MutableMap < * , * > >
+
+
+
+validatedTransactions
+
+open val validatedTransactions : MutableMap < SecureHash , SignedTransaction > A map of hash->tx where tx has been signature/contract validated and the states are known to be correct.
+The signatures arent technically needed after that point, but we keep them around so that we can relay
+the transaction data to other nodes that need it.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-storage-service-impl/my-legal-identity-key.html b/docs/build/html/api/core.node.subsystems/-storage-service-impl/my-legal-identity-key.html
new file mode 100644
index 0000000000..fb90b5de51
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-storage-service-impl/my-legal-identity-key.html
@@ -0,0 +1,16 @@
+
+
+StorageServiceImpl.myLegalIdentityKey -
+core.node.subsystems / StorageServiceImpl / myLegalIdentityKey myLegalIdentityKey
+open val myLegalIdentityKey : KeyPair StorageService.myLegalIdentityKey StorageServiceImpl.myLegalIdentity -
+core.node.subsystems / StorageServiceImpl / myLegalIdentity myLegalIdentity
+open val myLegalIdentity : Party StorageService.myLegalIdentity Returns the legal identity that this node is configured with. Assumed to be initialised when the node is
+first installed.
+StorageServiceImpl.recordingAs -
+core.node.subsystems / StorageServiceImpl / recordingAs recordingAs
+val recordingAs : ( String ) -> String StorageServiceImpl.stateMachines -
+core.node.subsystems / StorageServiceImpl / stateMachines stateMachines
+open val stateMachines : MutableMap < SecureHash , ByteArray > StorageService.stateMachines StorageServiceImpl.tables -
+core.node.subsystems / StorageServiceImpl / tables tables
+protected val tables : HashMap < String , MutableMap < * , * > > StorageServiceImpl.validatedTransactions -
+core.node.subsystems / StorageServiceImpl / validatedTransactions validatedTransactions
+open val validatedTransactions : MutableMap < SecureHash , SignedTransaction > StorageService.validatedTransactions A map of hash->tx where tx has been signature/contract validated and the states are known to be correct.
+The signatures arent technically needed after that point, but we keep them around so that we can relay
+the transaction data to other nodes that need it.
+Getter A map of hash->tx where tx has been signature/contract validated and the states are known to be correct.
+The signatures arent technically needed after that point, but we keep them around so that we can relay
+the transaction data to other nodes that need it.
+StorageService.attachments -
+core.node.subsystems / StorageService / attachments attachments
+abstract val attachments : AttachmentStorage Provides access to storage of arbitrary JAR files (which may contain only data, no code).
+StorageService -
+core.node.subsystems / StorageService StorageService
+interface StorageService A sketch of an interface to a simple key/value storage system. Intended for persistence of simple blobs like
+transactions, serialised protocol state machines and so on. Again, this isnt intended to imply lack of SQL or
+anything like that, this interface is only big enough to support the prototyping work.
+Properties
+
+
+
+
+attachments
+
+abstract val attachments : AttachmentStorage Provides access to storage of arbitrary JAR files (which may contain only data, no code).
+
+
+
+
+myLegalIdentity
+
+abstract val myLegalIdentity : Party Returns the legal identity that this node is configured with. Assumed to be initialised when the node is
+first installed.
+
+
+
+
+myLegalIdentityKey
+
+abstract val myLegalIdentityKey : KeyPair
+
+
+
+stateMachines
+
+abstract val stateMachines : MutableMap < SecureHash , ByteArray >
+
+
+
+validatedTransactions
+
+abstract val validatedTransactions : MutableMap < SecureHash , SignedTransaction > A map of hash->tx where tx has been signature/contract validated and the states are known to be correct.
+The signatures arent technically needed after that point, but we keep them around so that we can relay
+the transaction data to other nodes that need it.
+
+
+
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-storage-service/my-legal-identity-key.html b/docs/build/html/api/core.node.subsystems/-storage-service/my-legal-identity-key.html
new file mode 100644
index 0000000000..644fdd050d
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-storage-service/my-legal-identity-key.html
@@ -0,0 +1,15 @@
+
+
+StorageService.myLegalIdentityKey -
+core.node.subsystems / StorageService / myLegalIdentityKey myLegalIdentityKey
+abstract val myLegalIdentityKey : KeyPair StorageService.myLegalIdentity -
+core.node.subsystems / StorageService / myLegalIdentity myLegalIdentity
+abstract val myLegalIdentity : Party Returns the legal identity that this node is configured with. Assumed to be initialised when the node is
+first installed.
+StorageService.stateMachines -
+core.node.subsystems / StorageService / stateMachines stateMachines
+abstract val stateMachines : MutableMap < SecureHash , ByteArray > StorageService.validatedTransactions -
+core.node.subsystems / StorageService / validatedTransactions validatedTransactions
+abstract val validatedTransactions : MutableMap < SecureHash , SignedTransaction > A map of hash->tx where tx has been signature/contract validated and the states are known to be correct.
+The signatures arent technically needed after that point, but we keep them around so that we can relay
+the transaction data to other nodes that need it.
+TOPIC_DEFAULT_POSTFIX -
+core.node.subsystems / TOPIC_DEFAULT_POSTFIX TOPIC_DEFAULT_POSTFIX
+val TOPIC_DEFAULT_POSTFIX : String Postfix for base topics when sending a request to a service.
+WalletService.cashBalances -
+core.node.subsystems / WalletService / cashBalances cashBalances
+abstract val cashBalances : Map < Currency , Amount > Returns a snapshot of how much cash we have in each currency, ignoring details like issuer. Note: currencies for
+which we have no cash evaluate to null, not 0.
+WalletService.currentWallet -
+core.node.subsystems / WalletService / currentWallet currentWallet
+abstract val currentWallet : Wallet Returns a read-only snapshot of the wallet at the time the call is made. Note that if you consume states or
+keys in this wallet, you must inform the wallet service so it can update its internal state.
+WalletService -
+core.node.subsystems / WalletService WalletService
+interface WalletService A WalletService is responsible for securely and safely persisting the current state of a wallet to storage. The
+wallet service vends immutable snapshots of the current wallet for working with: if you build a transaction based
+on a wallet that isnt current, be aware that it may end up being invalid if the states that were used have been
+consumed by someone else first
+Properties
+
+
+
+
+cashBalances
+
+abstract val cashBalances : Map < Currency , Amount > Returns a snapshot of how much cash we have in each currency, ignoring details like issuer. Note: currencies for
+which we have no cash evaluate to null, not 0.
+
+
+
+
+currentWallet
+
+abstract val currentWallet : Wallet Returns a read-only snapshot of the wallet at the time the call is made. Note that if you consume states or
+keys in this wallet, you must inform the wallet service so it can update its internal state.
+
+
+
+
+linearHeads
+
+abstract val linearHeads : Map < SecureHash , StateAndRef < LinearState > > Returns a snapshot of the heads of LinearStates
+
+
+
+
+Functions
+
+Extension Functions
+
+Inheritors
+
+
+
+
+NodeWalletService
+
+class NodeWalletService : WalletService This class implements a simple, in memory wallet that tracks states that are owned by us, and also has a convenience
+method to auto-generate some self-issued cash states that can be used for test trading. A real wallet would persist
+states relevant to us into a database and once such a wallet is implemented, this scaffolding can be removed.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-wallet-service/linear-heads-of-type_.html b/docs/build/html/api/core.node.subsystems/-wallet-service/linear-heads-of-type_.html
new file mode 100644
index 0000000000..1af12bbe1b
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-wallet-service/linear-heads-of-type_.html
@@ -0,0 +1,16 @@
+
+
+WalletService.linearHeadsOfType_ -
+core.node.subsystems / WalletService / linearHeadsOfType_ linearHeadsOfType_
+open fun < T : LinearState > linearHeadsOfType_ ( stateType : Class < T > ) : Map < SecureHash , StateAndRef < T > > Returns the linearHeads only when the type of the state would be considered an instanceof the given type.
+WalletService.linearHeads -
+core.node.subsystems / WalletService / linearHeads linearHeads
+abstract val linearHeads : Map < SecureHash , StateAndRef < LinearState > > Returns a snapshot of the heads of LinearStates
+WalletService.notifyAll -
+core.node.subsystems / WalletService / notifyAll notifyAll
+abstract fun notifyAll ( txns : Iterable < WireTransaction > ) : Wallet Possibly update the wallet by marking as spent states that these transactions consume, and adding any relevant
+new states that they create. You should only insert transactions that have been successfully verified here
+Returns the new wallet that resulted from applying the transactions (note: it may quickly become out of date).
+TODO: Consider if theres a good way to enforce the must-be-verified requirement in the type system.
+WalletService.notify -
+core.node.subsystems / WalletService / notify notify
+open fun notify ( tx : WireTransaction ) : Wallet Same as notifyAll but with a single transaction.
+WalletService.statesForRefs -
+core.node.subsystems / WalletService / statesForRefs statesForRefs
+open fun statesForRefs ( refs : List < StateRef > ) : Map < StateRef , ContractState ? > Wallet.<init> -
+core.node.subsystems / Wallet / <init> <init>
+Wallet ( states : List < StateAndRef < ContractState > > ) A wallet (name may be temporary) wraps a set of states that are useful for us to keep track of, for instance,
+because we own them. This class represents an immutable, stable state of a wallet: it is guaranteed not to
+change out from underneath you, even though the canonical currently-best-known wallet may change as we learn
+about new transactions from our peers and generate new transactions that consume states ourselves.
+Wallet.cashBalances -
+core.node.subsystems / Wallet / cashBalances cashBalances
+val cashBalances : Map < Currency , Amount > Returns a map of how much cash we have in each currency, ignoring details like issuer. Note: currencies for
+which we have no cash evaluate to null (not present in map), not 0.
+Wallet -
+core.node.subsystems / Wallet Wallet
+data class Wallet A wallet (name may be temporary) wraps a set of states that are useful for us to keep track of, for instance,
+because we own them. This class represents an immutable, stable state of a wallet: it is guaranteed not to
+change out from underneath you, even though the canonical currently-best-known wallet may change as we learn
+about new transactions from our peers and generate new transactions that consume states ourselves.
+Constructors
+
+
+
+
+<init>
+
+Wallet ( states : List < StateAndRef < ContractState > > ) A wallet (name may be temporary) wraps a set of states that are useful for us to keep track of, for instance,
+because we own them. This class represents an immutable, stable state of a wallet: it is guaranteed not to
+change out from underneath you, even though the canonical currently-best-known wallet may change as we learn
+about new transactions from our peers and generate new transactions that consume states ourselves.
+
+
+
+
+Properties
+
+
+
+
+cashBalances
+
+val cashBalances : Map < Currency , Amount > Returns a map of how much cash we have in each currency, ignoring details like issuer. Note: currencies for
+which we have no cash evaluate to null (not present in map), not 0.
+
+
+
+
+states
+
+val states : List < StateAndRef < ContractState > >
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/-wallet/states-of-type.html b/docs/build/html/api/core.node.subsystems/-wallet/states-of-type.html
new file mode 100644
index 0000000000..d699ba4b37
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/-wallet/states-of-type.html
@@ -0,0 +1,15 @@
+
+
+Wallet.statesOfType -
+core.node.subsystems / Wallet / statesOfType statesOfType
+inline fun < reified T : OwnableState > statesOfType ( ) : List < StateAndRef < T > > Wallet.states -
+core.node.subsystems / Wallet / states states
+val states : List < StateAndRef < ContractState > > core.node.subsystems -
+core.node.subsystems Package core.node.subsystems
+Types
+
+
+
+
+ArtemisMessagingService
+
+class ArtemisMessagingService : MessagingService This class implements the MessagingService API using Apache Artemis, the successor to their ActiveMQ product.
+Artemis is a message queue broker and here, we embed the entire server inside our own process. Nodes communicate
+with each other using (by default) an Artemis specific protocol, but it supports other protocols like AQMP/1.0
+as well.
+
+
+
+
+DataVendingService
+
+class DataVendingService : AbstractNodeService This class sets up network message handlers for requests from peers for data keyed by hash. It is a piece of simple
+glue that sits between the network layer and the database layer.
+
+
+
+
+E2ETestKeyManagementService
+
+class E2ETestKeyManagementService : KeyManagementService A simple in-memory KMS that doesnt bother saving keys to disk. A real implementation would:
+
+
+
+
+InMemoryIdentityService
+
+class InMemoryIdentityService : IdentityService Simple identity service which caches parties and provides functionality for efficient lookup.
+
+
+
+
+InMemoryNetworkMapCache
+
+open class InMemoryNetworkMapCache : NetworkMapCache Extremely simple in-memory cache of the network map.
+
+
+
+
+KeyManagementService
+
+interface KeyManagementService The KMS is responsible for storing and using private keys to sign things. An implementation of this may, for example,
+call out to a hardware security module that enforces various auditing and frequency-of-use requirements.
+
+
+
+
+MonitoringService
+
+class MonitoringService Provides access to various metrics and ways to notify monitoring services of things, for sysadmin purposes.
+This is not an interface because it is too lightweight to bother mocking out.
+
+
+
+
+NetworkMapCache
+
+interface NetworkMapCache A network map contains lists of nodes on the network along with information about their identity keys, services
+they provide and host names or IP addresses where they can be connected to. The cache wraps around a map fetched
+from an authoritative service, and adds easy lookup of the data stored within it. Generally it would be initialised
+with a specified network map service, which it fetches data from and then subscribes to updates of.
+
+
+
+
+NodeWalletService
+
+class NodeWalletService : WalletService This class implements a simple, in memory wallet that tracks states that are owned by us, and also has a convenience
+method to auto-generate some self-issued cash states that can be used for test trading. A real wallet would persist
+states relevant to us into a database and once such a wallet is implemented, this scaffolding can be removed.
+
+
+
+
+StorageService
+
+interface StorageService A sketch of an interface to a simple key/value storage system. Intended for persistence of simple blobs like
+transactions, serialised protocol state machines and so on. Again, this isnt intended to imply lack of SQL or
+anything like that, this interface is only big enough to support the prototyping work.
+
+
+
+
+StorageServiceImpl
+
+open class StorageServiceImpl : StorageService
+
+
+
+Wallet
+
+data class Wallet A wallet (name may be temporary) wraps a set of states that are useful for us to keep track of, for instance,
+because we own them. This class represents an immutable, stable state of a wallet: it is guaranteed not to
+change out from underneath you, even though the canonical currently-best-known wallet may change as we learn
+about new transactions from our peers and generate new transactions that consume states ourselves.
+
+
+
+
+WalletService
+
+interface WalletService A WalletService is responsible for securely and safely persisting the current state of a wallet to storage. The
+wallet service vends immutable snapshots of the current wallet for working with: if you build a transaction based
+on a wallet that isnt current, be aware that it may end up being invalid if the states that were used have been
+consumed by someone else first
+
+
+
+
+Exceptions
+
+Properties
+
+
+
+
+TOPIC_DEFAULT_POSTFIX
+
+val TOPIC_DEFAULT_POSTFIX : String Postfix for base topics when sending a request to a service.
+
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.node.subsystems/linear-heads-of-type.html b/docs/build/html/api/core.node.subsystems/linear-heads-of-type.html
new file mode 100644
index 0000000000..ea2d8e467b
--- /dev/null
+++ b/docs/build/html/api/core.node.subsystems/linear-heads-of-type.html
@@ -0,0 +1,15 @@
+
+
+linearHeadsOfType -
+core.node.subsystems / linearHeadsOfType linearHeadsOfType
+inline fun < reified T : LinearState > WalletService . linearHeadsOfType ( ) : <ERROR CLASS> AbstractNode.<init> -
+core.node / AbstractNode / <init> <init>
+AbstractNode ( dir : Path , configuration : NodeConfiguration , initialNetworkMapAddress : NodeInfo ? , advertisedServices : Set < ServiceType > , platformClock : Clock ) A base node implementation that can be customised either for production (with real implementations that do real
+I/O), or a mock implementation suitable for unit test environments.
+AbstractNode.PRIVATE_KEY_FILE_NAME -
+core.node / AbstractNode / PRIVATE_KEY_FILE_NAME PRIVATE_KEY_FILE_NAME
+val PRIVATE_KEY_FILE_NAME : String AbstractNode.PUBLIC_IDENTITY_FILE_NAME -
+core.node / AbstractNode / PUBLIC_IDENTITY_FILE_NAME PUBLIC_IDENTITY_FILE_NAME
+val PUBLIC_IDENTITY_FILE_NAME : String AbstractNode._servicesThatAcceptUploads -
+core.node / AbstractNode / _servicesThatAcceptUploads _servicesThatAcceptUploads
+protected val _servicesThatAcceptUploads : ArrayList < AcceptsFileUpload > AbstractNode.advertisedServices -
+core.node / AbstractNode / advertisedServices advertisedServices
+val advertisedServices : Set < ServiceType > AbstractNode.api -
+core.node / AbstractNode / api api
+lateinit var api : APIServer AbstractNode.configuration -
+core.node / AbstractNode / configuration configuration
+val configuration : NodeConfiguration AbstractNode.constructStorageService -
+core.node / AbstractNode / constructStorageService constructStorageService
+protected open fun constructStorageService ( attachments : NodeAttachmentService , keypair : KeyPair , identity : Party ) : StorageServiceImpl AbstractNode.dir -
+core.node / AbstractNode / dir dir
+val dir : Path AbstractNode.findMyLocation -
+core.node / AbstractNode / findMyLocation findMyLocation
+protected open fun findMyLocation ( ) : PhysicalLocation ? AbstractNode.identity -
+core.node / AbstractNode / identity identity
+lateinit var identity : IdentityService AbstractNode.inNodeNetworkMapService -
+core.node / AbstractNode / inNodeNetworkMapService inNodeNetworkMapService
+var inNodeNetworkMapService : NetworkMapService ? AbstractNode.inNodeTimestampingService -
+core.node / AbstractNode / inNodeTimestampingService inNodeTimestampingService
+var inNodeTimestampingService : NodeTimestamperService ? AbstractNode -
+core.node / AbstractNode AbstractNode
+abstract class AbstractNode A base node implementation that can be customised either for production (with real implementations that do real
+I/O), or a mock implementation suitable for unit test environments.
+Constructors
+
+
+
+
+<init>
+
+AbstractNode ( dir : Path , configuration : NodeConfiguration , initialNetworkMapAddress : NodeInfo ? , advertisedServices : Set < ServiceType > , platformClock : Clock ) A base node implementation that can be customised either for production (with real implementations that do real
+I/O), or a mock implementation suitable for unit test environments.
+
+
+
+
+Properties
+
+Functions
+
+Companion Object Properties
+
+Inheritors
+
+
+
+
+MockNode
+
+class MockNode : AbstractNode
+
+
+
+Node
+
+class Node : AbstractNode A Node manages a standalone server that takes part in the P2P network. It creates the services found in ServiceHub ,
+loads important data off disk and starts listening for connections.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node/-abstract-node/info.html b/docs/build/html/api/core.node/-abstract-node/info.html
new file mode 100644
index 0000000000..f05c53b167
--- /dev/null
+++ b/docs/build/html/api/core.node/-abstract-node/info.html
@@ -0,0 +1,15 @@
+
+
+AbstractNode.info -
+core.node / AbstractNode / info info
+val info : NodeInfo AbstractNode.initialNetworkMapAddress -
+core.node / AbstractNode / initialNetworkMapAddress initialNetworkMapAddress
+val initialNetworkMapAddress : NodeInfo ? AbstractNode.initialiseStorageService -
+core.node / AbstractNode / initialiseStorageService initialiseStorageService
+protected open fun initialiseStorageService ( dir : Path ) : StorageService AbstractNode.interestRatesService -
+core.node / AbstractNode / interestRatesService interestRatesService
+lateinit var interestRatesService : Service AbstractNode.keyManagement -
+core.node / AbstractNode / keyManagement keyManagement
+lateinit var keyManagement : E2ETestKeyManagementService AbstractNode.log -
+core.node / AbstractNode / log log
+protected abstract val log : <ERROR CLASS> AbstractNode.makeIdentityService -
+core.node / AbstractNode / makeIdentityService makeIdentityService
+protected open fun makeIdentityService ( ) : IdentityService AbstractNode.makeInterestRatesOracleService -
+core.node / AbstractNode / makeInterestRatesOracleService makeInterestRatesOracleService
+protected open fun makeInterestRatesOracleService ( ) : Unit AbstractNode.makeMessagingService -
+core.node / AbstractNode / makeMessagingService makeMessagingService
+protected abstract fun makeMessagingService ( ) : MessagingService AbstractNode.makeNetworkMapService -
+core.node / AbstractNode / makeNetworkMapService makeNetworkMapService
+protected open fun makeNetworkMapService ( ) : Unit AbstractNode.makeTimestampingService -
+core.node / AbstractNode / makeTimestampingService makeTimestampingService
+protected open fun makeTimestampingService ( ) : Unit AbstractNode.net -
+core.node / AbstractNode / net net
+lateinit var net : MessagingService AbstractNode.networkMapSeq -
+core.node / AbstractNode / networkMapSeq networkMapSeq
+var networkMapSeq : Long Sequence number of changes sent to the network map service, when registering/de-registering this node
+AbstractNode.networkMapServiceCallTimeout -
+core.node / AbstractNode / networkMapServiceCallTimeout networkMapServiceCallTimeout
+val networkMapServiceCallTimeout : Duration AbstractNode.platformClock -
+core.node / AbstractNode / platformClock platformClock
+val platformClock : Clock AbstractNode.serverThread -
+core.node / AbstractNode / serverThread serverThread
+protected abstract val serverThread : AffinityExecutor AbstractNode.servicesThatAcceptUploads -
+core.node / AbstractNode / servicesThatAcceptUploads servicesThatAcceptUploads
+val servicesThatAcceptUploads : List < AcceptsFileUpload > AbstractNode.services -
+core.node / AbstractNode / services services
+val services : ServiceHub AbstractNode.smm -
+core.node / AbstractNode / smm smm
+lateinit var smm : StateMachineManager AbstractNode.startMessagingService -
+core.node / AbstractNode / startMessagingService startMessagingService
+protected abstract fun startMessagingService ( ) : Unit AbstractNode.start -
+core.node / AbstractNode / start start
+open fun start ( ) : AbstractNode AbstractNode.stop -
+core.node / AbstractNode / stop stop
+open fun stop ( ) : Unit AbstractNode.storage -
+core.node / AbstractNode / storage storage
+lateinit var storage : StorageService AbstractNode.wallet -
+core.node / AbstractNode / wallet wallet
+lateinit var wallet : WalletService AcceptsFileUpload.acceptableFileExtensions -
+core.node / AcceptsFileUpload / acceptableFileExtensions acceptableFileExtensions
+abstract val acceptableFileExtensions : List < String > What file extensions are acceptable for the file to be handed to upload()
+AcceptsFileUpload.dataTypePrefix -
+core.node / AcceptsFileUpload / dataTypePrefix dataTypePrefix
+abstract val dataTypePrefix : String A string that prefixes the URLs, e.g. "attachments" or "interest-rates". Should be OK for URLs.
+AcceptsFileUpload -
+core.node / AcceptsFileUpload AcceptsFileUpload
+interface AcceptsFileUpload A service that implements AcceptsFileUpload can have new binary data provided to it via an HTTP upload.
+TODO: In future, also accept uploads over the MQ interface too.
+Properties
+
+
+
+
+acceptableFileExtensions
+
+abstract val acceptableFileExtensions : List < String > What file extensions are acceptable for the file to be handed to upload()
+
+
+
+
+dataTypePrefix
+
+abstract val dataTypePrefix : String A string that prefixes the URLs, e.g. "attachments" or "interest-rates". Should be OK for URLs.
+
+
+
+
+Functions
+
+
+
+
+upload
+
+abstract fun upload ( data : InputStream ) : String Accepts the data in the given input stream, and returns some sort of useful return message that will be sent
+back to the user in the response.
+
+
+
+
+Inheritors
+
+
+
+
+NodeAttachmentService
+
+class NodeAttachmentService : AttachmentStorage , AcceptsFileUpload Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.
+
+
+
+
+Service
+
+class Service : AcceptsFileUpload , AbstractNodeService The Service that wraps Oracle and handles messages/network interaction/request scrubbing.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node/-accepts-file-upload/upload.html b/docs/build/html/api/core.node/-accepts-file-upload/upload.html
new file mode 100644
index 0000000000..f776240a65
--- /dev/null
+++ b/docs/build/html/api/core.node/-accepts-file-upload/upload.html
@@ -0,0 +1,17 @@
+
+
+AcceptsFileUpload.upload -
+core.node / AcceptsFileUpload / upload upload
+abstract fun upload ( data : InputStream ) : String Accepts the data in the given input stream, and returns some sort of useful return message that will be sent
+back to the user in the response.
+AttachmentsClassLoader.<init> -
+core.node / AttachmentsClassLoader / <init> <init>
+AttachmentsClassLoader ( attachments : List < Attachment > , parent : ClassLoader = ClassLoader.getSystemClassLoader()) A custom ClassLoader that knows how to load classes from a set of attachments. The attachments themselves only
+need to provide JAR streams, and so could be fetched from a database, local disk, etc. Constructing an
+AttachmentsClassLoader is somewhat expensive, as every attachment is scanned to ensure that there are no overlapping
+file paths.
+AttachmentsClassLoader.OverlappingAttachments.<init> -
+core.node / AttachmentsClassLoader / OverlappingAttachments / <init> <init>
+OverlappingAttachments ( path : String ) AttachmentsClassLoader.OverlappingAttachments -
+core.node / AttachmentsClassLoader / OverlappingAttachments OverlappingAttachments
+class OverlappingAttachments : Exception Constructors
+
+
+
+
+<init>
+
+OverlappingAttachments ( path : String )
+
+
+
+Properties
+
+
+
+
+path
+
+val path : String
+
+
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.node/-attachments-class-loader/-overlapping-attachments/path.html b/docs/build/html/api/core.node/-attachments-class-loader/-overlapping-attachments/path.html
new file mode 100644
index 0000000000..7836b11263
--- /dev/null
+++ b/docs/build/html/api/core.node/-attachments-class-loader/-overlapping-attachments/path.html
@@ -0,0 +1,15 @@
+
+
+AttachmentsClassLoader.OverlappingAttachments.path -
+core.node / AttachmentsClassLoader / OverlappingAttachments / path path
+val path : String AttachmentsClassLoader.OverlappingAttachments.toString -
+core.node / AttachmentsClassLoader / OverlappingAttachments / toString toString
+fun toString ( ) : String AttachmentsClassLoader.findClass -
+core.node / AttachmentsClassLoader / findClass findClass
+protected fun findClass ( name : String ) : Class < * > AttachmentsClassLoader.findResource -
+core.node / AttachmentsClassLoader / findResource findResource
+protected fun findResource ( name : String ) : URL ? AttachmentsClassLoader.getResourceAsStream -
+core.node / AttachmentsClassLoader / getResourceAsStream getResourceAsStream
+fun getResourceAsStream ( name : String ) : InputStream ? AttachmentsClassLoader -
+core.node / AttachmentsClassLoader AttachmentsClassLoader
+class AttachmentsClassLoader : SecureClassLoader A custom ClassLoader that knows how to load classes from a set of attachments. The attachments themselves only
+need to provide JAR streams, and so could be fetched from a database, local disk, etc. Constructing an
+AttachmentsClassLoader is somewhat expensive, as every attachment is scanned to ensure that there are no overlapping
+file paths.
+Exceptions
+
+Constructors
+
+
+
+
+<init>
+
+AttachmentsClassLoader ( attachments : List < Attachment > , parent : ClassLoader = ClassLoader.getSystemClassLoader()) A custom ClassLoader that knows how to load classes from a set of attachments. The attachments themselves only
+need to provide JAR streams, and so could be fetched from a database, local disk, etc. Constructing an
+AttachmentsClassLoader is somewhat expensive, as every attachment is scanned to ensure that there are no overlapping
+file paths.
+
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.node/-city-database/get.html b/docs/build/html/api/core.node/-city-database/get.html
new file mode 100644
index 0000000000..4769d7592d
--- /dev/null
+++ b/docs/build/html/api/core.node/-city-database/get.html
@@ -0,0 +1,15 @@
+
+
+CityDatabase.get -
+core.node / CityDatabase / get get
+operator fun get ( name : String ) : PhysicalLocation ? CityDatabase -
+core.node / CityDatabase CityDatabase
+object CityDatabase A simple lookup table of city names to their coordinates. Lookups are case insensitive.
+Functions
+
+
+
diff --git a/docs/build/html/api/core.node/-configuration-exception/-init-.html b/docs/build/html/api/core.node/-configuration-exception/-init-.html
new file mode 100644
index 0000000000..2462adf97e
--- /dev/null
+++ b/docs/build/html/api/core.node/-configuration-exception/-init-.html
@@ -0,0 +1,14 @@
+
+
+ConfigurationException.<init> -
+core.node / ConfigurationException / <init> <init>
+ConfigurationException ( message : String ) ConfigurationException -
+core.node / ConfigurationException ConfigurationException
+class ConfigurationException : Exception Constructors
+
+
+
+
+<init>
+
+ConfigurationException ( message : String )
+
+
+
+
+
diff --git a/docs/build/html/api/core.node/-node-configuration-from-config/-init-.html b/docs/build/html/api/core.node/-node-configuration-from-config/-init-.html
new file mode 100644
index 0000000000..0ce0342869
--- /dev/null
+++ b/docs/build/html/api/core.node/-node-configuration-from-config/-init-.html
@@ -0,0 +1,14 @@
+
+
+NodeConfigurationFromConfig.<init> -
+core.node / NodeConfigurationFromConfig / <init> <init>
+NodeConfigurationFromConfig ( config : <ERROR CLASS> = ConfigFactory.load()) NodeConfigurationFromConfig.config -
+core.node / NodeConfigurationFromConfig / config config
+val config : <ERROR CLASS> NodeConfigurationFromConfig.exportJMXto -
+core.node / NodeConfigurationFromConfig / exportJMXto exportJMXto
+val exportJMXto : String NodeConfiguration.exportJMXto NodeConfigurationFromConfig -
+core.node / NodeConfigurationFromConfig NodeConfigurationFromConfig
+class NodeConfigurationFromConfig : NodeConfiguration Constructors
+
+
+
+
+<init>
+
+NodeConfigurationFromConfig ( config : <ERROR CLASS> = ConfigFactory.load())
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.node/-node-configuration-from-config/my-legal-name.html b/docs/build/html/api/core.node/-node-configuration-from-config/my-legal-name.html
new file mode 100644
index 0000000000..7fb8dba49b
--- /dev/null
+++ b/docs/build/html/api/core.node/-node-configuration-from-config/my-legal-name.html
@@ -0,0 +1,16 @@
+
+
+NodeConfigurationFromConfig.myLegalName -
+core.node / NodeConfigurationFromConfig / myLegalName myLegalName
+val myLegalName : String NodeConfiguration.myLegalName NodeConfigurationFromConfig.nearestCity -
+core.node / NodeConfigurationFromConfig / nearestCity nearestCity
+val nearestCity : String NodeConfiguration.nearestCity NodeConfiguration.exportJMXto -
+core.node / NodeConfiguration / exportJMXto exportJMXto
+abstract val exportJMXto : String NodeConfiguration -
+core.node / NodeConfiguration NodeConfiguration
+interface NodeConfiguration Properties
+
+
+
+
+exportJMXto
+
+abstract val exportJMXto : String
+
+
+
+myLegalName
+
+abstract val myLegalName : String
+
+
+
+nearestCity
+
+abstract val nearestCity : String
+
+
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/core.node/-node-configuration/my-legal-name.html b/docs/build/html/api/core.node/-node-configuration/my-legal-name.html
new file mode 100644
index 0000000000..3c22314914
--- /dev/null
+++ b/docs/build/html/api/core.node/-node-configuration/my-legal-name.html
@@ -0,0 +1,15 @@
+
+
+NodeConfiguration.myLegalName -
+core.node / NodeConfiguration / myLegalName myLegalName
+abstract val myLegalName : String NodeConfiguration.nearestCity -
+core.node / NodeConfiguration / nearestCity nearestCity
+abstract val nearestCity : String NodeInfo.<init> -
+core.node / NodeInfo / <init> <init>
+NodeInfo ( address : SingleMessageRecipient , identity : Party , advertisedServices : Set < ServiceType > = emptySet(), physicalLocation : PhysicalLocation ? = null) Info about a network node that acts on behalf of some form of contract party.
+NodeInfo.address -
+core.node / NodeInfo / address address
+val address : SingleMessageRecipient NodeInfo.advertisedServices -
+core.node / NodeInfo / advertisedServices advertisedServices
+var advertisedServices : Set < ServiceType > NodeInfo.identity -
+core.node / NodeInfo / identity identity
+val identity : Party NodeInfo -
+core.node / NodeInfo NodeInfo
+data class NodeInfo Info about a network node that acts on behalf of some form of contract party.
+Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.node/-node-info/physical-location.html b/docs/build/html/api/core.node/-node-info/physical-location.html
new file mode 100644
index 0000000000..59ced916a9
--- /dev/null
+++ b/docs/build/html/api/core.node/-node-info/physical-location.html
@@ -0,0 +1,15 @@
+
+
+NodeInfo.physicalLocation -
+core.node / NodeInfo / physicalLocation physicalLocation
+val physicalLocation : PhysicalLocation ? Node.DEFAULT_PORT -
+core.node / Node / DEFAULT_PORT DEFAULT_PORT
+val DEFAULT_PORT : Int The port that is used by default if none is specified. As you know, 31337 is the most elite number.
+Node.<init> -
+core.node / Node / <init> <init>
+Node ( dir : Path , p2pAddr : <ERROR CLASS> , configuration : NodeConfiguration , networkMapAddress : NodeInfo ? , advertisedServices : Set < ServiceType > , clock : Clock = Clock.systemUTC()) A Node manages a standalone server that takes part in the P2P network. It creates the services found in ServiceHub ,
+loads important data off disk and starts listening for connections.
+Parameters
+dir - A Path to a location on disk where working files can be found or stored.p2pAddr - The host and port that this server will use. It cant find out its own external hostname, so you
+have to specify that yourself.configuration - This is typically loaded from a .properties filenetworkMapAddress - An external network map service to use. Should only ever be null when creating the first
+network map service, while bootstrapping a network.advertisedServices - The services this node advertises. This must be a subset of the services it runs,
+but nodes are not required to advertise services they run (hence subset).clock - The clock used within the node and by all protocols etcNode -
+core.node / Node Node
+class Node : AbstractNode A Node manages a standalone server that takes part in the P2P network. It creates the services found in ServiceHub ,
+loads important data off disk and starts listening for connections.
+Parameters
+dir - A Path to a location on disk where working files can be found or stored.p2pAddr - The host and port that this server will use. It cant find out its own external hostname, so you
+have to specify that yourself.configuration - This is typically loaded from a .properties filenetworkMapAddress - An external network map service to use. Should only ever be null when creating the first
+network map service, while bootstrapping a network.advertisedServices - The services this node advertises. This must be a subset of the services it runs,
+but nodes are not required to advertise services they run (hence subset).clock - The clock used within the node and by all protocols etcConstructors
+
+
+
+
+<init>
+
+Node ( dir : Path , p2pAddr : <ERROR CLASS> , configuration : NodeConfiguration , networkMapAddress : NodeInfo ? , advertisedServices : Set < ServiceType > , clock : Clock = Clock.systemUTC()) A Node manages a standalone server that takes part in the P2P network. It creates the services found in ServiceHub ,
+loads important data off disk and starts listening for connections.
+
+
+
+
+Properties
+
+Inherited Properties
+
+Functions
+
+Inherited Functions
+
+Companion Object Properties
+
+
+
+
+DEFAULT_PORT
+
+val DEFAULT_PORT : Int The port that is used by default if none is specified. As you know, 31337 is the most elite number.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node/-node/log.html b/docs/build/html/api/core.node/-node/log.html
new file mode 100644
index 0000000000..f1c28c0a26
--- /dev/null
+++ b/docs/build/html/api/core.node/-node/log.html
@@ -0,0 +1,16 @@
+
+
+Node.log -
+core.node / Node / log log
+protected val log : <ERROR CLASS> AbstractNode.log Node.makeMessagingService -
+core.node / Node / makeMessagingService makeMessagingService
+protected fun makeMessagingService ( ) : MessagingService AbstractNode.makeMessagingService Node.p2pAddr -
+core.node / Node / p2pAddr p2pAddr
+val p2pAddr : <ERROR CLASS> Node.serverThread -
+core.node / Node / serverThread serverThread
+protected val serverThread : ServiceAffinityExecutor AbstractNode.serverThread Node.startMessagingService -
+core.node / Node / startMessagingService startMessagingService
+protected fun startMessagingService ( ) : Unit AbstractNode.startMessagingService Node.start -
+core.node / Node / start start
+fun start ( ) : Node AbstractNode.start Node.stop -
+core.node / Node / stop stop
+fun stop ( ) : Unit AbstractNode.stop Node.webServer -
+core.node / Node / webServer webServer
+lateinit var webServer : <ERROR CLASS> PhysicalLocation.<init> -
+core.node / PhysicalLocation / <init> <init>
+PhysicalLocation ( coordinate : WorldCoordinate , description : String ) A labelled WorldCoordinate , where the label is human meaningful. For example, the name of the nearest city.
+Labels should not refer to non-landmarks, for example, they should not contain the names of organisations.
+PhysicalLocation.coordinate -
+core.node / PhysicalLocation / coordinate coordinate
+val coordinate : WorldCoordinate PhysicalLocation.description -
+core.node / PhysicalLocation / description description
+val description : String PhysicalLocation -
+core.node / PhysicalLocation PhysicalLocation
+data class PhysicalLocation A labelled WorldCoordinate , where the label is human meaningful. For example, the name of the nearest city.
+Labels should not refer to non-landmarks, for example, they should not contain the names of organisations.
+Constructors
+
+
+
+
+<init>
+
+PhysicalLocation ( coordinate : WorldCoordinate , description : String ) A labelled WorldCoordinate , where the label is human meaningful. For example, the name of the nearest city.
+Labels should not refer to non-landmarks, for example, they should not contain the names of organisations.
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.node/-service-hub/clock.html b/docs/build/html/api/core.node/-service-hub/clock.html
new file mode 100644
index 0000000000..b3d0ed1bcc
--- /dev/null
+++ b/docs/build/html/api/core.node/-service-hub/clock.html
@@ -0,0 +1,15 @@
+
+
+ServiceHub.clock -
+core.node / ServiceHub / clock clock
+abstract val clock : Clock ServiceHub.identityService -
+core.node / ServiceHub / identityService identityService
+abstract val identityService : IdentityService ServiceHub -
+core.node / ServiceHub ServiceHub
+interface ServiceHub A service hub simply vends references to the other services a node has. Some of those services may be missing or
+mocked out. This class is useful to pass to chunks of pluggable code that might have need of many different kinds of
+functionality and you dont want to hard-code which types in the interface.
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.node/-service-hub/key-management-service.html b/docs/build/html/api/core.node/-service-hub/key-management-service.html
new file mode 100644
index 0000000000..32eb8364e8
--- /dev/null
+++ b/docs/build/html/api/core.node/-service-hub/key-management-service.html
@@ -0,0 +1,15 @@
+
+
+ServiceHub.keyManagementService -
+core.node / ServiceHub / keyManagementService keyManagementService
+abstract val keyManagementService : KeyManagementService ServiceHub.monitoringService -
+core.node / ServiceHub / monitoringService monitoringService
+abstract val monitoringService : MonitoringService ServiceHub.networkMapCache -
+core.node / ServiceHub / networkMapCache networkMapCache
+abstract val networkMapCache : NetworkMapCache ServiceHub.networkService -
+core.node / ServiceHub / networkService networkService
+abstract val networkService : MessagingService ServiceHub.recordTransactions -
+core.node / ServiceHub / recordTransactions recordTransactions
+open fun recordTransactions ( txs : List < SignedTransaction > , skipRecordingMap : Boolean = false) : Unit Given a list of SignedTransaction s, writes them to the local storage for validated transactions and then
+sends them to the wallet for further processing.
+TODO: Need to come up with a way for preventing transactions being written other than by this method.
+TODO: RecordingMap is test infrastructure. Refactor it away or find a way to ensure its only used in tests.
+Parameters
+txs - The transactions to recordskipRecordingMap - This is used in unit testing and can be ignored most of the time.ServiceHub.storageService -
+core.node / ServiceHub / storageService storageService
+abstract val storageService : StorageService ServiceHub.verifyTransaction -
+core.node / ServiceHub / verifyTransaction verifyTransaction
+open fun verifyTransaction ( ltx : LedgerTransaction ) : Unit Given a LedgerTransaction , looks up all its dependencies in the local database, uses the identity service to map
+the SignedTransaction s the DB gives back into LedgerTransaction s, and then runs the smart contracts for the
+transaction. If no exception is thrown, the transaction is valid.
+ServiceHub.walletService -
+core.node / ServiceHub / walletService walletService
+abstract val walletService : WalletService WorldCoordinate.<init> -
+core.node / WorldCoordinate / <init> <init>
+WorldCoordinate ( latitude : Double , longitude : Double ) A latitude/longitude pair.
+WorldCoordinate -
+core.node / WorldCoordinate WorldCoordinate
+data class WorldCoordinate A latitude/longitude pair.
+Constructors
+
+
+
+
+<init>
+
+WorldCoordinate ( latitude : Double , longitude : Double ) A latitude/longitude pair.
+
+
+
+
+Properties
+
+
+
+
+latitude
+
+val latitude : Double
+
+
+
+longitude
+
+val longitude : Double
+
+
+
+Functions
+
+
+
+
+project
+
+fun project ( screenWidth : Double , screenHeight : Double , topLatitude : Double , bottomLatitude : Double , leftLongitude : Double , rightLongitude : Double ) : <ERROR CLASS> < Double , Double > Convert to screen coordinates using the Mercator projection. You should have a world map image that
+you know the precise extents of for this function to work.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.node/-world-coordinate/latitude.html b/docs/build/html/api/core.node/-world-coordinate/latitude.html
new file mode 100644
index 0000000000..701da8bb09
--- /dev/null
+++ b/docs/build/html/api/core.node/-world-coordinate/latitude.html
@@ -0,0 +1,15 @@
+
+
+WorldCoordinate.latitude -
+core.node / WorldCoordinate / latitude latitude
+val latitude : Double WorldCoordinate.longitude -
+core.node / WorldCoordinate / longitude longitude
+val longitude : Double WorldCoordinate.project -
+core.node / WorldCoordinate / project project
+fun project ( screenWidth : Double , screenHeight : Double , topLatitude : Double , bottomLatitude : Double , leftLongitude : Double , rightLongitude : Double ) : <ERROR CLASS> < Double , Double > Convert to screen coordinates using the Mercator projection. You should have a world map image that
+you know the precise extents of for this function to work.
+Note that no world map ever has latitude extents of -90 to 90 because at these extremes the mapping tends
+to infinity. Google Maps, for example, uses a square map image, and square maps yield latitude extents
+of 85.0511 to -85.0511 = arctan(sinh(Ï€)).
+getValue -
+core.node / getValue getValue
+operator fun <ERROR CLASS> . getValue ( receiver : NodeConfigurationFromConfig , metadata : KProperty < * > ) : <ERROR CLASS> core.node -
+core.node Package core.node
+Types
+
+
+
+
+AbstractNode
+
+abstract class AbstractNode A base node implementation that can be customised either for production (with real implementations that do real
+I/O), or a mock implementation suitable for unit test environments.
+
+
+
+
+AcceptsFileUpload
+
+interface AcceptsFileUpload A service that implements AcceptsFileUpload can have new binary data provided to it via an HTTP upload.
+
+
+
+
+AttachmentsClassLoader
+
+class AttachmentsClassLoader : SecureClassLoader A custom ClassLoader that knows how to load classes from a set of attachments. The attachments themselves only
+need to provide JAR streams, and so could be fetched from a database, local disk, etc. Constructing an
+AttachmentsClassLoader is somewhat expensive, as every attachment is scanned to ensure that there are no overlapping
+file paths.
+
+
+
+
+CityDatabase
+
+object CityDatabase A simple lookup table of city names to their coordinates. Lookups are case insensitive.
+
+
+
+
+Node
+
+class Node : AbstractNode A Node manages a standalone server that takes part in the P2P network. It creates the services found in ServiceHub ,
+loads important data off disk and starts listening for connections.
+
+
+
+
+NodeConfiguration
+
+interface NodeConfiguration
+
+
+
+NodeConfigurationFromConfig
+
+class NodeConfigurationFromConfig : NodeConfiguration
+
+
+
+NodeInfo
+
+data class NodeInfo Info about a network node that acts on behalf of some form of contract party.
+
+
+
+
+PhysicalLocation
+
+data class PhysicalLocation A labelled WorldCoordinate , where the label is human meaningful. For example, the name of the nearest city.
+Labels should not refer to non-landmarks, for example, they should not contain the names of organisations.
+
+
+
+
+ServiceHub
+
+interface ServiceHub A service hub simply vends references to the other services a node has. Some of those services may be missing or
+mocked out. This class is useful to pass to chunks of pluggable code that might have need of many different kinds of
+functionality and you dont want to hard-code which types in the interface.
+
+
+
+
+WorldCoordinate
+
+data class WorldCoordinate A latitude/longitude pair.
+
+
+
+
+Exceptions
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.protocols/-protocol-logic/-init-.html b/docs/build/html/api/core.protocols/-protocol-logic/-init-.html
new file mode 100644
index 0000000000..608006173b
--- /dev/null
+++ b/docs/build/html/api/core.protocols/-protocol-logic/-init-.html
@@ -0,0 +1,28 @@
+
+
+ProtocolLogic.<init> -
+core.protocols / ProtocolLogic / <init> <init>
+ProtocolLogic ( ) A sub-class of ProtocolLogic implements a protocol flow using direct, straight line blocking code. Thus you
+can write complex protocol logic in an ordinary fashion, without having to think about callbacks, restarting after
+a node crash, how many instances of your protocol there are running and so on.
+Invoking the network will cause the call stack to be suspended onto the heap and then serialized to a database using
+the Quasar fibers framework. Because of this, if you need access to data that might change over time, you should
+request it just-in-time via the serviceHub property which is provided. Dont try and keep data you got from a
+service across calls to send/receive/sendAndReceive because the world might change in arbitrary ways out from
+underneath you, for instance, if the node is restarted or reconfigured
+Additionally, be aware of what data you pin either via the stack or in your ProtocolLogic implementation. Very large
+objects or datasets will hurt performance by increasing the amount of data stored in each checkpoint.
+If youd like to use another ProtocolLogic class as a component of your own, construct it on the fly and then pass
+it to the subProtocol method. It will return the result of that protocol when it completes.
+ProtocolLogic.call -
+core.protocols / ProtocolLogic / call call
+abstract fun call ( ) : T This is where you fill out your business logic.
+ProtocolLogic -
+core.protocols / ProtocolLogic ProtocolLogic
+abstract class ProtocolLogic < T > A sub-class of ProtocolLogic implements a protocol flow using direct, straight line blocking code. Thus you
+can write complex protocol logic in an ordinary fashion, without having to think about callbacks, restarting after
+a node crash, how many instances of your protocol there are running and so on.
+Invoking the network will cause the call stack to be suspended onto the heap and then serialized to a database using
+the Quasar fibers framework. Because of this, if you need access to data that might change over time, you should
+request it just-in-time via the serviceHub property which is provided. Dont try and keep data you got from a
+service across calls to send/receive/sendAndReceive because the world might change in arbitrary ways out from
+underneath you, for instance, if the node is restarted or reconfigured
+Additionally, be aware of what data you pin either via the stack or in your ProtocolLogic implementation. Very large
+objects or datasets will hurt performance by increasing the amount of data stored in each checkpoint.
+If youd like to use another ProtocolLogic class as a component of your own, construct it on the fly and then pass
+it to the subProtocol method. It will return the result of that protocol when it completes.
+Constructors
+
+
+
+
+<init>
+
+ProtocolLogic ( ) A sub-class of ProtocolLogic implements a protocol flow using direct, straight line blocking code. Thus you
+can write complex protocol logic in an ordinary fashion, without having to think about callbacks, restarting after
+a node crash, how many instances of your protocol there are running and so on.
+
+
+
+
+Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker ? Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+
+
+
+call
+
+abstract fun call ( ) : T This is where you fill out your business logic.
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogics reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Inheritors
+
+
+
+
+Broadcast
+
+class Broadcast : ProtocolLogic < Boolean > This takes a Java Integer rather than Kotlin Int as that is what we end up with in the calling map and currently
+we do not support coercing numeric types in the reflective search for matching constructors
+
+
+
+
+Broadcast
+
+class Broadcast : ProtocolLogic < Boolean >
+
+
+
+Buyer
+
+class Buyer : ProtocolLogic < SignedTransaction >
+
+
+
+FetchDataProtocol
+
+abstract class FetchDataProtocol < T : NamedByHash , W : Any > : ProtocolLogic < Result < T > > An abstract protocol for fetching typed data from a remote peer.
+
+
+
+
+Primary
+
+abstract class Primary < U > : ProtocolLogic < SignedTransaction > Abstracted bilateral deal protocol participant that initiates communication/handshake.
+
+
+
+
+RatesFixProtocol
+
+open class RatesFixProtocol : ProtocolLogic < Unit > This protocol queries the given oracle for an interest rate fix, and if it is within the given tolerance embeds the
+fix in the transaction and then proceeds to get the oracle to sign it. Although the call method combines the query
+and signing step, you can run the steps individually by constructing this object and then using the public methods
+for each step.
+
+
+
+
+Requester
+
+class Requester < T > : ProtocolLogic < SignedTransaction >
+
+
+
+ResolveTransactionsProtocol
+
+class ResolveTransactionsProtocol : ProtocolLogic < Unit > This protocol fetches each transaction identified by the given hashes from either disk or network, along with all
+their dependencies, and verifies them together using a single TransactionGroup . If no exception is thrown, then
+all the transactions have been successfully verified and inserted into the local database.
+
+
+
+
+Secondary
+
+abstract class Secondary < U > : ProtocolLogic < SignedTransaction > Abstracted bilateral deal protocol participant that is recipient of initial communication.
+
+
+
+
+Seller
+
+class Seller : ProtocolLogic < SignedTransaction >
+
+
+
+TimestampingProtocol
+
+class TimestampingProtocol : ProtocolLogic < LegallyIdentifiable > The TimestampingProtocol class is the client code that talks to a NodeTimestamperService on some remote node. It is a
+ProtocolLogic, meaning it can either be a sub-protocol of some other protocol, or be driven independently.
+
+
+
+
+TraderDemoProtocolBuyer
+
+class TraderDemoProtocolBuyer : ProtocolLogic < Unit >
+
+
+
+TraderDemoProtocolSeller
+
+class TraderDemoProtocolSeller : ProtocolLogic < Unit >
+
+
+
+Updater
+
+class Updater : ProtocolLogic < Boolean >
+
+
+
+
+
diff --git a/docs/build/html/api/core.protocols/-protocol-logic/logger.html b/docs/build/html/api/core.protocols/-protocol-logic/logger.html
new file mode 100644
index 0000000000..1edfb304dd
--- /dev/null
+++ b/docs/build/html/api/core.protocols/-protocol-logic/logger.html
@@ -0,0 +1,16 @@
+
+
+ProtocolLogic.logger -
+core.protocols / ProtocolLogic / logger logger
+val logger : <ERROR CLASS> This is where you should log things to.
+ProtocolLogic.progressTracker -
+core.protocols / ProtocolLogic / progressTracker progressTracker
+open val progressTracker : ProgressTracker ? Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+ProtocolLogic.psm -
+core.protocols / ProtocolLogic / psm psm
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+ProtocolLogic.receive -
+core.protocols / ProtocolLogic / receive receive
+inline fun < reified T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > ProtocolLogic.sendAndReceive -
+core.protocols / ProtocolLogic / sendAndReceive sendAndReceive
+inline fun < reified T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T > ProtocolLogic.send -
+core.protocols / ProtocolLogic / send send
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit ProtocolLogic.serviceHub -
+core.protocols / ProtocolLogic / serviceHub serviceHub
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+ProtocolLogic.subProtocol -
+core.protocols / ProtocolLogic / subProtocol subProtocol
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+ProtocolStateMachine.<init> -
+core.protocols / ProtocolStateMachine / <init> <init>
+ProtocolStateMachine ( logic : ProtocolLogic < R > , scheduler : <ERROR CLASS> ) A ProtocolStateMachine instance is a suspendable fiber that delegates all actual logic to a ProtocolLogic instance.
+For any given flow there is only one PSM, even if that protocol invokes subprotocols.
+These classes are created by the StateMachineManager when a new protocol is started at the topmost level. If
+a protocol invokes a sub-protocol, then it will pass along the PSM to the child. The call method of the topmost
+logic element gets to return the value that the entire state machine resolves to.
+ProtocolStateMachine -
+core.protocols / ProtocolStateMachine ProtocolStateMachine
+class ProtocolStateMachine < R > A ProtocolStateMachine instance is a suspendable fiber that delegates all actual logic to a ProtocolLogic instance.
+For any given flow there is only one PSM, even if that protocol invokes subprotocols.
+These classes are created by the StateMachineManager when a new protocol is started at the topmost level. If
+a protocol invokes a sub-protocol, then it will pass along the PSM to the child. The call method of the topmost
+logic element gets to return the value that the entire state machine resolves to.
+Constructors
+
+
+
+
+<init>
+
+ProtocolStateMachine ( logic : ProtocolLogic < R > , scheduler : <ERROR CLASS> ) A ProtocolStateMachine instance is a suspendable fiber that delegates all actual logic to a ProtocolLogic instance.
+For any given flow there is only one PSM, even if that protocol invokes subprotocols.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+prepareForResumeWith
+
+fun prepareForResumeWith ( serviceHub : ServiceHub , withObject : Any ? , logger : <ERROR CLASS> , suspendFunc : ( FiberRequest , ByteArray ) -> Unit ) : Unit
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , recvType : Class < T > ) : UntrustworthyData < T >
+
+
+
+run
+
+fun run ( ) : R
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any , recvType : Class < T > ) : UntrustworthyData < T >
+
+
+
+
+
diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/logger.html b/docs/build/html/api/core.protocols/-protocol-state-machine/logger.html
new file mode 100644
index 0000000000..ee52ad408f
--- /dev/null
+++ b/docs/build/html/api/core.protocols/-protocol-state-machine/logger.html
@@ -0,0 +1,15 @@
+
+
+ProtocolStateMachine.logger -
+core.protocols / ProtocolStateMachine / logger logger
+lateinit var logger : <ERROR CLASS> ProtocolStateMachine.logic -
+core.protocols / ProtocolStateMachine / logic logic
+val logic : ProtocolLogic < R > ProtocolStateMachine.prepareForResumeWith -
+core.protocols / ProtocolStateMachine / prepareForResumeWith prepareForResumeWith
+fun prepareForResumeWith ( serviceHub : ServiceHub , withObject : Any ? , logger : <ERROR CLASS> , suspendFunc : ( FiberRequest , ByteArray ) -> Unit ) : Unit ProtocolStateMachine.receive -
+core.protocols / ProtocolStateMachine / receive receive
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , recvType : Class < T > ) : UntrustworthyData < T > ProtocolStateMachine.resultFuture -
+core.protocols / ProtocolStateMachine / resultFuture resultFuture
+val resultFuture : <ERROR CLASS> < R > This future will complete when the call method returns.
+ProtocolStateMachine.run -
+core.protocols / ProtocolStateMachine / run run
+fun run ( ) : R ProtocolStateMachine.sendAndReceive -
+core.protocols / ProtocolStateMachine / sendAndReceive sendAndReceive
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any , recvType : Class < T > ) : UntrustworthyData < T > ProtocolStateMachine.send -
+core.protocols / ProtocolStateMachine / send send
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit ProtocolStateMachine.serviceHub -
+core.protocols / ProtocolStateMachine / serviceHub serviceHub
+lateinit var serviceHub : ServiceHub core.protocols -
+core.protocols Package core.protocols
+Types
+
+
+
+
+ProtocolLogic
+
+abstract class ProtocolLogic < T > A sub-class of ProtocolLogic implements a protocol flow using direct, straight line blocking code. Thus you
+can write complex protocol logic in an ordinary fashion, without having to think about callbacks, restarting after
+a node crash, how many instances of your protocol there are running and so on.
+
+
+
+
+ProtocolStateMachine
+
+class ProtocolStateMachine < R > A ProtocolStateMachine instance is a suspendable fiber that delegates all actual logic to a ProtocolLogic instance.
+For any given flow there is only one PSM, even if that protocol invokes subprotocols.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.serialization/-a-t-t-a-c-h-m-e-n-t_-s-t-o-r-a-g-e.html b/docs/build/html/api/core.serialization/-a-t-t-a-c-h-m-e-n-t_-s-t-o-r-a-g-e.html
new file mode 100644
index 0000000000..2d928f20b3
--- /dev/null
+++ b/docs/build/html/api/core.serialization/-a-t-t-a-c-h-m-e-n-t_-s-t-o-r-a-g-e.html
@@ -0,0 +1,15 @@
+
+
+ATTACHMENT_STORAGE -
+core.serialization / ATTACHMENT_STORAGE ATTACHMENT_STORAGE
+val ATTACHMENT_STORAGE : String ImmutableClassSerializer.<init> -
+core.serialization / ImmutableClassSerializer / <init> <init>
+ImmutableClassSerializer ( klass : KClass < T > ) Serializes properties and deserializes by using the constructor. This assumes that all backed properties are
+set via the constructor and the class is immutable.
+ImmutableClassSerializer.constructor -
+core.serialization / ImmutableClassSerializer / constructor constructor
+val constructor : <ERROR CLASS> ImmutableClassSerializer -
+core.serialization / ImmutableClassSerializer ImmutableClassSerializer
+class ImmutableClassSerializer < T : Any > Serializes properties and deserializes by using the constructor. This assumes that all backed properties are
+set via the constructor and the class is immutable.
+Constructors
+
+
+
+
+<init>
+
+ImmutableClassSerializer ( klass : KClass < T > ) Serializes properties and deserializes by using the constructor. This assumes that all backed properties are
+set via the constructor and the class is immutable.
+
+
+
+
+Properties
+
+
+
+
+constructor
+
+val constructor : <ERROR CLASS>
+
+
+
+klass
+
+val klass : KClass < T >
+
+
+
+props
+
+val props : <ERROR CLASS>
+
+
+
+propsByName
+
+val propsByName : <ERROR CLASS>
+
+
+
+Functions
+
+
+
+
+read
+
+fun read ( kryo : <ERROR CLASS> , input : <ERROR CLASS> , type : Class < T > ) : T
+
+
+
+write
+
+fun write ( kryo : <ERROR CLASS> , output : <ERROR CLASS> , obj : T ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.serialization/-immutable-class-serializer/klass.html b/docs/build/html/api/core.serialization/-immutable-class-serializer/klass.html
new file mode 100644
index 0000000000..2364ab2637
--- /dev/null
+++ b/docs/build/html/api/core.serialization/-immutable-class-serializer/klass.html
@@ -0,0 +1,15 @@
+
+
+ImmutableClassSerializer.klass -
+core.serialization / ImmutableClassSerializer / klass klass
+val klass : KClass < T > ImmutableClassSerializer.propsByName -
+core.serialization / ImmutableClassSerializer / propsByName propsByName
+val propsByName : <ERROR CLASS> ImmutableClassSerializer.props -
+core.serialization / ImmutableClassSerializer / props props
+val props : <ERROR CLASS> ImmutableClassSerializer.read -
+core.serialization / ImmutableClassSerializer / read read
+fun read ( kryo : <ERROR CLASS> , input : <ERROR CLASS> , type : Class < T > ) : T ImmutableClassSerializer.write -
+core.serialization / ImmutableClassSerializer / write write
+fun write ( kryo : <ERROR CLASS> , output : <ERROR CLASS> , obj : T ) : Unit MissingAttachmentsException.<init> -
+core.serialization / MissingAttachmentsException / <init> <init>
+MissingAttachmentsException ( ids : List < SecureHash > ) Thrown during deserialisation to indicate that an attachment needed to construct the WireTransaction is not found
+MissingAttachmentsException.ids -
+core.serialization / MissingAttachmentsException / ids ids
+val ids : List < SecureHash > MissingAttachmentsException -
+core.serialization / MissingAttachmentsException MissingAttachmentsException
+class MissingAttachmentsException : Exception Thrown during deserialisation to indicate that an attachment needed to construct the WireTransaction is not found
+Constructors
+
+
+
+
+<init>
+
+MissingAttachmentsException ( ids : List < SecureHash > ) Thrown during deserialisation to indicate that an attachment needed to construct the WireTransaction is not found
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.serialization/-opaque-bytes/-init-.html b/docs/build/html/api/core.serialization/-opaque-bytes/-init-.html
new file mode 100644
index 0000000000..dc6a32ac31
--- /dev/null
+++ b/docs/build/html/api/core.serialization/-opaque-bytes/-init-.html
@@ -0,0 +1,17 @@
+
+
+OpaqueBytes.<init> -
+core.serialization / OpaqueBytes / <init> <init>
+OpaqueBytes ( bits : ByteArray ) A simple class that wraps a byte array and makes the equals/hashCode/toString methods work as you actually expect.
+In an ideal JVM this would be a value type and be completely overhead free. Project Valhalla is adding such
+functionality to Java, but it wont arrive for a few years yet
+OpaqueBytes.bits -
+core.serialization / OpaqueBytes / bits bits
+val bits : ByteArray OpaqueBytes.equals -
+core.serialization / OpaqueBytes / equals equals
+open fun equals ( other : Any ? ) : Boolean OpaqueBytes.hashCode -
+core.serialization / OpaqueBytes / hashCode hashCode
+open fun hashCode ( ) : Int OpaqueBytes -
+core.serialization / OpaqueBytes OpaqueBytes
+open class OpaqueBytes A simple class that wraps a byte array and makes the equals/hashCode/toString methods work as you actually expect.
+In an ideal JVM this would be a value type and be completely overhead free. Project Valhalla is adding such
+functionality to Java, but it wont arrive for a few years yet
+Constructors
+
+
+
+
+<init>
+
+OpaqueBytes ( bits : ByteArray ) A simple class that wraps a byte array and makes the equals/hashCode/toString methods work as you actually expect.
+In an ideal JVM this would be a value type and be completely overhead free. Project Valhalla is adding such
+functionality to Java, but it wont arrive for a few years yet
+
+
+
+
+Properties
+
+
+
+
+bits
+
+val bits : ByteArray
+
+
+
+size
+
+val size : Int
+
+
+
+Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+Companion Object Functions
+
+
+
+
+of
+
+fun of ( vararg b : Byte ) : OpaqueBytes
+
+
+
+Extension Functions
+
+
+
+
+deserialize
+
+fun < T : Any > OpaqueBytes . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : T
+
+
+
+sha256
+
+fun OpaqueBytes . sha256 ( ) : SHA256
+
+
+
+Inheritors
+
+
+
+
+DigitalSignature
+
+open class DigitalSignature : OpaqueBytes A wrapper around a digital signature. The covering field is a generic tag usable by whatever is interpreting the
+signature. It isnt used currently, but experience from Bitcoin suggests such a feature is useful, especially when
+building partially signed transactions.
+
+
+
+
+SecureHash
+
+sealed class SecureHash : OpaqueBytes
+
+
+
+SerializedBytes
+
+class SerializedBytes < T : Any > : OpaqueBytes A type safe wrapper around a byte array that contains a serialised object. You can call SerializedBytes.deserialize
+to get the original object back.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.serialization/-opaque-bytes/of.html b/docs/build/html/api/core.serialization/-opaque-bytes/of.html
new file mode 100644
index 0000000000..d741a14bcd
--- /dev/null
+++ b/docs/build/html/api/core.serialization/-opaque-bytes/of.html
@@ -0,0 +1,15 @@
+
+
+OpaqueBytes.of -
+core.serialization / OpaqueBytes / of of
+fun of ( vararg b : Byte ) : OpaqueBytes OpaqueBytes.size -
+core.serialization / OpaqueBytes / size size
+val size : Int OpaqueBytes.toString -
+core.serialization / OpaqueBytes / toString toString
+open fun toString ( ) : String SerializedBytesSerializer -
+core.serialization / SerializedBytesSerializer SerializedBytesSerializer
+object SerializedBytesSerializer A serialiser that avoids writing the wrapper class to the byte stream, thus ensuring SerializedBytes is a pure
+type safety hack.
+Functions
+
+
+
diff --git a/docs/build/html/api/core.serialization/-serialized-bytes-serializer/read.html b/docs/build/html/api/core.serialization/-serialized-bytes-serializer/read.html
new file mode 100644
index 0000000000..e610bb4ea6
--- /dev/null
+++ b/docs/build/html/api/core.serialization/-serialized-bytes-serializer/read.html
@@ -0,0 +1,15 @@
+
+
+SerializedBytesSerializer.read -
+core.serialization / SerializedBytesSerializer / read read
+fun read ( kryo : <ERROR CLASS> , input : <ERROR CLASS> , type : Class < SerializedBytes < Any > > ) : SerializedBytes < Any > SerializedBytesSerializer.write -
+core.serialization / SerializedBytesSerializer / write write
+fun write ( kryo : <ERROR CLASS> , output : <ERROR CLASS> , obj : SerializedBytes < Any > ) : Unit SerializedBytes.<init> -
+core.serialization / SerializedBytes / <init> <init>
+SerializedBytes ( bits : ByteArray ) A type safe wrapper around a byte array that contains a serialised object. You can call SerializedBytes.deserialize
+to get the original object back.
+SerializedBytes.hash -
+core.serialization / SerializedBytes / hash hash
+val hash : SecureHash SerializedBytes -
+core.serialization / SerializedBytes SerializedBytes
+class SerializedBytes < T : Any > : OpaqueBytes A type safe wrapper around a byte array that contains a serialised object. You can call SerializedBytes.deserialize
+to get the original object back.
+Constructors
+
+
+
+
+<init>
+
+SerializedBytes ( bits : ByteArray ) A type safe wrapper around a byte array that contains a serialised object. You can call SerializedBytes.deserialize
+to get the original object back.
+
+
+
+
+Properties
+
+Inherited Properties
+
+
+
+
+bits
+
+val bits : ByteArray
+
+
+
+size
+
+val size : Int
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : Int
+
+
+
+toString
+
+open fun toString ( ) : String
+
+
+
+Extension Functions
+
+
+
+
+deserialize
+
+fun SerializedBytes < WireTransaction > . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : WireTransaction fun < T : Any > SerializedBytes < T > . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : T fun < T : Any > OpaqueBytes . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : T
+
+
+
+sha256
+
+fun OpaqueBytes . sha256 ( ) : SHA256
+
+
+
+
+
diff --git a/docs/build/html/api/core.serialization/-serialized-bytes/write-to-file.html b/docs/build/html/api/core.serialization/-serialized-bytes/write-to-file.html
new file mode 100644
index 0000000000..5c4232fe2e
--- /dev/null
+++ b/docs/build/html/api/core.serialization/-serialized-bytes/write-to-file.html
@@ -0,0 +1,15 @@
+
+
+SerializedBytes.writeToFile -
+core.serialization / SerializedBytes / writeToFile writeToFile
+fun writeToFile ( path : Path ) : Path THREAD_LOCAL_KRYO -
+core.serialization / THREAD_LOCAL_KRYO THREAD_LOCAL_KRYO
+val THREAD_LOCAL_KRYO : <ERROR CLASS> Serialization utilities, using the Kryo framework with a custom serialiser for immutable data classes and a dead
+simple, totally non-extensible binary (sub)format.
+This is NOT what should be used in any final platform product, rather, the final state should be a precisely
+specified and standardised binary format with attention paid to anti-malleability, versioning and performance.
+FIX SBE is a potential candidate: it prioritises performance over convenience and was designed for HFT. Google
+Protocol Buffers with a minor tightening to make field reordering illegal is another possibility.
+FIX SBE:
+https://real-logic.github.io/simple-binary-encoding/
+http://mechanical-sympathy.blogspot.co.at/2014/05/simple-binary-encoding.html
+Protocol buffers:
+https://developers.google.com/protocol-buffers/
+But for now we use Kryo to maximise prototyping speed.
+Note that this code ignores ALL concerns beyond convenience, in particular it ignores:
+This code will happily deserialise literally anything, including malicious streams that would reconstruct classes
+in invalid states, thus violating system invariants. It isnt designed to handle malicious streams and therefore,
+isnt usable beyond the prototyping stage. But thats fine: we can revisit serialisation technologies later after
+a formal evaluation process.
+WireTransactionSerializer -
+core.serialization / WireTransactionSerializer WireTransactionSerializer
+object WireTransactionSerializer A serialisation engine that knows how to deserialise code inside a sandbox
+Functions
+
+
+
diff --git a/docs/build/html/api/core.serialization/-wire-transaction-serializer/read.html b/docs/build/html/api/core.serialization/-wire-transaction-serializer/read.html
new file mode 100644
index 0000000000..391e852af3
--- /dev/null
+++ b/docs/build/html/api/core.serialization/-wire-transaction-serializer/read.html
@@ -0,0 +1,15 @@
+
+
+WireTransactionSerializer.read -
+core.serialization / WireTransactionSerializer / read read
+fun read ( kryo : <ERROR CLASS> , input : <ERROR CLASS> , type : Class < WireTransaction > ) : WireTransaction WireTransactionSerializer.write -
+core.serialization / WireTransactionSerializer / write write
+fun write ( kryo : <ERROR CLASS> , output : <ERROR CLASS> , obj : WireTransaction ) : Unit attachmentStorage -
+core.serialization / attachmentStorage attachmentStorage
+var <ERROR CLASS> . attachmentStorage : AttachmentStorage ? createKryo -
+core.serialization / createKryo createKryo
+fun createKryo ( k : <ERROR CLASS> = Kryo()) : <ERROR CLASS> deserialize -
+core.serialization / deserialize deserialize
+fun < T : Any > OpaqueBytes . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : T fun SerializedBytes < WireTransaction > . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : WireTransaction fun < T : Any > SerializedBytes < T > . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : T core.serialization -
+core.serialization Package core.serialization
+Types
+
+
+
+
+ImmutableClassSerializer
+
+class ImmutableClassSerializer < T : Any > Serializes properties and deserializes by using the constructor. This assumes that all backed properties are
+set via the constructor and the class is immutable.
+
+
+
+
+OpaqueBytes
+
+open class OpaqueBytes A simple class that wraps a byte array and makes the equals/hashCode/toString methods work as you actually expect.
+In an ideal JVM this would be a value type and be completely overhead free. Project Valhalla is adding such
+functionality to Java, but it wont arrive for a few years yet
+
+
+
+
+SerializedBytes
+
+class SerializedBytes < T : Any > : OpaqueBytes A type safe wrapper around a byte array that contains a serialised object. You can call SerializedBytes.deserialize
+to get the original object back.
+
+
+
+
+SerializedBytesSerializer
+
+object SerializedBytesSerializer A serialiser that avoids writing the wrapper class to the byte stream, thus ensuring SerializedBytes is a pure
+type safety hack.
+
+
+
+
+WireTransactionSerializer
+
+object WireTransactionSerializer A serialisation engine that knows how to deserialise code inside a sandbox
+
+
+
+
+Exceptions
+
+Extensions for External Classes
+
+Properties
+
+
+
+
+ATTACHMENT_STORAGE
+
+val ATTACHMENT_STORAGE : String
+
+
+
+THREAD_LOCAL_KRYO
+
+val THREAD_LOCAL_KRYO : <ERROR CLASS> Serialization utilities, using the Kryo framework with a custom serialiser for immutable data classes and a dead
+simple, totally non-extensible binary (sub)format.
+
+
+
+
+attachmentStorage
+
+var <ERROR CLASS> . attachmentStorage : AttachmentStorage ?
+
+
+
+Functions
+
+
+
+
+createKryo
+
+fun createKryo ( k : <ERROR CLASS> = Kryo()) : <ERROR CLASS>
+
+
+
+deserialize
+
+fun < T : Any > OpaqueBytes . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : T fun SerializedBytes < WireTransaction > . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : WireTransaction fun < T : Any > SerializedBytes < T > . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : T
+
+
+
+serialize
+
+fun < T : Any > T . serialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : SerializedBytes < T > Can be called on any object to convert it to a byte array (wrapped by SerializedBytes ), regardless of whether
+the type is marked as serializable or was designed for it (so be careful)
+
+
+
+
+useClassLoader
+
+fun < T > <ERROR CLASS> . useClassLoader ( cl : ClassLoader , body : ( ) -> T ) : T
+
+
+
+
+
diff --git a/docs/build/html/api/core.serialization/kotlin.-byte-array/deserialize.html b/docs/build/html/api/core.serialization/kotlin.-byte-array/deserialize.html
new file mode 100644
index 0000000000..566a9bc90e
--- /dev/null
+++ b/docs/build/html/api/core.serialization/kotlin.-byte-array/deserialize.html
@@ -0,0 +1,15 @@
+
+
+deserialize -
+core.serialization / kotlin.ByteArray / deserialize deserialize
+fun < T : Any > ByteArray . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : T core.serialization.kotlin.ByteArray -
+core.serialization / kotlin.ByteArray Extensions for kotlin.ByteArray
+
+
+
+
+deserialize
+
+fun < T : Any > ByteArray . deserialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : T
+
+
+
+opaque
+
+fun ByteArray . opaque ( ) : OpaqueBytes
+
+
+
+
+
diff --git a/docs/build/html/api/core.serialization/kotlin.-byte-array/opaque.html b/docs/build/html/api/core.serialization/kotlin.-byte-array/opaque.html
new file mode 100644
index 0000000000..5baa528246
--- /dev/null
+++ b/docs/build/html/api/core.serialization/kotlin.-byte-array/opaque.html
@@ -0,0 +1,15 @@
+
+
+opaque -
+core.serialization / kotlin.ByteArray / opaque opaque
+fun ByteArray . opaque ( ) : OpaqueBytes serialize -
+core.serialization / serialize serialize
+fun < T : Any > T . serialize ( kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : SerializedBytes < T > Can be called on any object to convert it to a byte array (wrapped by SerializedBytes ), regardless of whether
+the type is marked as serializable or was designed for it (so be careful)
+useClassLoader -
+core.serialization / useClassLoader useClassLoader
+inline fun < T > <ERROR CLASS> . useClassLoader ( cl : ClassLoader , body : ( ) -> T ) : T IRSSimulation.<init> -
+core.testing / IRSSimulation / <init> <init>
+IRSSimulation ( : Boolean , : LatencyCalculator ? ) A simulation in which banks execute interest rate swaps with each other, including the fixing events.
+IRSSimulation -
+core.testing / IRSSimulation IRSSimulation
+class IRSSimulation : Simulation A simulation in which banks execute interest rate swaps with each other, including the fixing events.
+Constructors
+
+
+
+
+<init>
+
+IRSSimulation ( : Boolean , : LatencyCalculator ? ) A simulation in which banks execute interest rate swaps with each other, including the fixing events.
+
+
+
+
+Properties
+
+
+
+
+om
+
+val om : <ERROR CLASS>
+
+
+
+Inherited Properties
+
+Functions
+
+
+
+
+iterate
+
+fun iterate ( ) : Unit Iterates the simulation by one step.
+
+
+
+
+start
+
+fun start ( ) : Unit
+
+
+
+Inherited Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-i-r-s-simulation/iterate.html b/docs/build/html/api/core.testing/-i-r-s-simulation/iterate.html
new file mode 100644
index 0000000000..8ae7e7d1ce
--- /dev/null
+++ b/docs/build/html/api/core.testing/-i-r-s-simulation/iterate.html
@@ -0,0 +1,23 @@
+
+
+IRSSimulation.iterate -
+core.testing / IRSSimulation / iterate iterate
+fun iterate ( ) : Unit Simulation.iterate Iterates the simulation by one step.
+The default implementation circles around the nodes, pumping until one of them handles a message. The next call
+will carry on from where this one stopped. In an environment where you want to take actions between anything
+interesting happening, or control the precise speed at which things operate (beyond the latency injector), this
+is a useful way to do things.
+IRSSimulation.om -
+core.testing / IRSSimulation / om om
+val om : <ERROR CLASS> IRSSimulation.start -
+core.testing / IRSSimulation / start start
+fun start ( ) : Unit Simulation.start InMemoryMessagingNetwork.Builder.<init> -
+core.testing / InMemoryMessagingNetwork / Builder / <init> <init>
+Builder ( manuallyPumped : Boolean , id : Handle ) InMemoryMessagingNetwork.Builder.id -
+core.testing / InMemoryMessagingNetwork / Builder / id id
+val id : Handle InMemoryMessagingNetwork.Builder -
+core.testing / InMemoryMessagingNetwork / Builder Builder
+inner class Builder : MessagingServiceBuilder < InMemoryMessaging > Constructors
+
+
+
+
+<init>
+
+Builder ( manuallyPumped : Boolean , id : Handle )
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-in-memory-messaging-network/-builder/manually-pumped.html b/docs/build/html/api/core.testing/-in-memory-messaging-network/-builder/manually-pumped.html
new file mode 100644
index 0000000000..e241852871
--- /dev/null
+++ b/docs/build/html/api/core.testing/-in-memory-messaging-network/-builder/manually-pumped.html
@@ -0,0 +1,15 @@
+
+
+InMemoryMessagingNetwork.Builder.manuallyPumped -
+core.testing / InMemoryMessagingNetwork / Builder / manuallyPumped manuallyPumped
+val manuallyPumped : Boolean InMemoryMessagingNetwork.Builder.start -
+core.testing / InMemoryMessagingNetwork / Builder / start start
+fun start ( ) : <ERROR CLASS> < InMemoryMessaging > MessagingServiceBuilder.start InMemoryMessagingNetwork.Handle.<init> -
+core.testing / InMemoryMessagingNetwork / Handle / <init> <init>
+Handle ( id : Int ) InMemoryMessagingNetwork.Handle.equals -
+core.testing / InMemoryMessagingNetwork / Handle / equals equals
+fun equals ( other : Any ? ) : Boolean InMemoryMessagingNetwork.Handle.hashCode -
+core.testing / InMemoryMessagingNetwork / Handle / hashCode hashCode
+fun hashCode ( ) : Int InMemoryMessagingNetwork.Handle.id -
+core.testing / InMemoryMessagingNetwork / Handle / id id
+val id : Int InMemoryMessagingNetwork.Handle -
+core.testing / InMemoryMessagingNetwork / Handle Handle
+class Handle : SingleMessageRecipient Constructors
+
+
+
+
+<init>
+
+Handle ( id : Int )
+
+
+
+Properties
+
+
+
+
+id
+
+val id : Int
+
+
+
+Functions
+
+
+
+
+equals
+
+fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+fun hashCode ( ) : Int
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.testing/-in-memory-messaging-network/-handle/to-string.html b/docs/build/html/api/core.testing/-in-memory-messaging-network/-handle/to-string.html
new file mode 100644
index 0000000000..4dce75ca1d
--- /dev/null
+++ b/docs/build/html/api/core.testing/-in-memory-messaging-network/-handle/to-string.html
@@ -0,0 +1,15 @@
+
+
+InMemoryMessagingNetwork.Handle.toString -
+core.testing / InMemoryMessagingNetwork / Handle / toString toString
+fun toString ( ) : String InMemoryMessagingNetwork.InMemoryMessaging.Handler.<init> -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / Handler / <init> <init>
+Handler ( executor : Executor ? , topic : String , callback : ( Message , MessageHandlerRegistration ) -> Unit ) InMemoryMessagingNetwork.InMemoryMessaging.Handler.callback -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / Handler / callback callback
+val callback : ( Message , MessageHandlerRegistration ) -> Unit InMemoryMessagingNetwork.InMemoryMessaging.Handler.executor -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / Handler / executor executor
+val executor : Executor ? InMemoryMessagingNetwork.InMemoryMessaging.Handler -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / Handler Handler
+inner class Handler : MessageHandlerRegistration Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.testing/-in-memory-messaging-network/-in-memory-messaging/-handler/topic.html b/docs/build/html/api/core.testing/-in-memory-messaging-network/-in-memory-messaging/-handler/topic.html
new file mode 100644
index 0000000000..c1100cdb08
--- /dev/null
+++ b/docs/build/html/api/core.testing/-in-memory-messaging-network/-in-memory-messaging/-handler/topic.html
@@ -0,0 +1,15 @@
+
+
+InMemoryMessagingNetwork.InMemoryMessaging.Handler.topic -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / Handler / topic topic
+val topic : String InMemoryMessagingNetwork.InMemoryMessaging.<init> -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / <init> <init>
+InMemoryMessaging ( manuallyPumped : Boolean , handle : Handle ) An InMemoryMessaging provides a MessagingService that isnt backed by any kind of network or disk storage
+system, but just uses regular queues on the heap instead. It is intended for unit testing and developer convenience
+when all entities on the network are being simulated in-process.
+An instance can be obtained by creating a builder and then using the start method.
+InMemoryMessagingNetwork.InMemoryMessaging.InnerState.<init> -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / InnerState / <init> <init>
+InnerState ( ) InMemoryMessagingNetwork.InMemoryMessaging.InnerState.handlers -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / InnerState / handlers handlers
+val handlers : MutableList < Handler > InMemoryMessagingNetwork.InMemoryMessaging.InnerState -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / InnerState InnerState
+protected inner class InnerState Constructors
+
+
+
+
+<init>
+
+InnerState ( )
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.testing/-in-memory-messaging-network/-in-memory-messaging/-inner-state/pending-redelivery.html b/docs/build/html/api/core.testing/-in-memory-messaging-network/-in-memory-messaging/-inner-state/pending-redelivery.html
new file mode 100644
index 0000000000..f85443ddc7
--- /dev/null
+++ b/docs/build/html/api/core.testing/-in-memory-messaging-network/-in-memory-messaging/-inner-state/pending-redelivery.html
@@ -0,0 +1,15 @@
+
+
+InMemoryMessagingNetwork.InMemoryMessaging.InnerState.pendingRedelivery -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / InnerState / pendingRedelivery pendingRedelivery
+val pendingRedelivery : LinkedList < Message > InMemoryMessagingNetwork.InMemoryMessaging.addMessageHandler -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / addMessageHandler addMessageHandler
+fun addMessageHandler ( topic : String , executor : Executor ? , callback : ( Message , MessageHandlerRegistration ) -> Unit ) : MessageHandlerRegistration MessagingService.addMessageHandler The provided function will be invoked for each received message whose topic matches the given string, on the given
+executor. The topic can be the empty string to match all messages.
+If no executor is received then the callback will run on threads provided by the messaging service, and the
+callback is expected to be thread safe as a result.
+The returned object is an opaque handle that may be used to un-register handlers later with removeMessageHandler .
+The handle is passed to the callback as well, to avoid race conditions whereby the callback wants to unregister
+itself and yet addMessageHandler hasnt returned the handle yet.
+InMemoryMessagingNetwork.InMemoryMessaging.backgroundThread -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / backgroundThread backgroundThread
+protected val backgroundThread : Nothing ? InMemoryMessagingNetwork.InMemoryMessaging.createMessage -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / createMessage createMessage
+fun createMessage ( topic : String , data : ByteArray ) : Message MessagingService.createMessage Returns the given (topic, data) pair as a newly created message object.
+InMemoryMessagingNetwork.InMemoryMessaging -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging InMemoryMessaging
+inner class InMemoryMessaging : MessagingService An InMemoryMessaging provides a MessagingService that isnt backed by any kind of network or disk storage
+system, but just uses regular queues on the heap instead. It is intended for unit testing and developer convenience
+when all entities on the network are being simulated in-process.
+An instance can be obtained by creating a builder and then using the start method.
+Types
+
+Constructors
+
+
+
+
+<init>
+
+InMemoryMessaging ( manuallyPumped : Boolean , handle : Handle ) An InMemoryMessaging provides a MessagingService that isnt backed by any kind of network or disk storage
+system, but just uses regular queues on the heap instead. It is intended for unit testing and developer convenience
+when all entities on the network are being simulated in-process.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+addMessageHandler
+
+fun addMessageHandler ( topic : String , executor : Executor ? , callback : ( Message , MessageHandlerRegistration ) -> Unit ) : MessageHandlerRegistration The provided function will be invoked for each received message whose topic matches the given string, on the given
+executor. The topic can be the empty string to match all messages.
+
+
+
+
+createMessage
+
+fun createMessage ( topic : String , data : ByteArray ) : Message Returns the given (topic, data) pair as a newly created message object.
+
+
+
+
+pump
+
+fun pump ( block : Boolean ) : Boolean Delivers a single message from the internal queue. If there are no messages waiting to be delivered and block
+is true, waits until one has been provided on a different thread via send. If block is false, the return
+result indicates whether a message was delivered or not.
+
+
+
+
+removeMessageHandler
+
+fun removeMessageHandler ( registration : MessageHandlerRegistration ) : Unit Removes a handler given the object returned from addMessageHandler . The callback will no longer be invoked once
+this method has returned, although executions that are currently in flight will not be interrupted.
+
+
+
+
+send
+
+fun send ( message : Message , target : MessageRecipients ) : Unit Sends a message to the given receiver. The details of how receivers are identified is up to the messaging
+implementation: the type system provides an opaque high level view, with more fine grained control being
+available via type casting. Once this function returns the message is queued for delivery but not necessarily
+delivered: if the recipients are offline then the message could be queued hours or days later.
+
+
+
+
+stop
+
+fun stop ( ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.testing/-in-memory-messaging-network/-in-memory-messaging/my-address.html b/docs/build/html/api/core.testing/-in-memory-messaging-network/-in-memory-messaging/my-address.html
new file mode 100644
index 0000000000..b571e55acc
--- /dev/null
+++ b/docs/build/html/api/core.testing/-in-memory-messaging-network/-in-memory-messaging/my-address.html
@@ -0,0 +1,17 @@
+
+
+InMemoryMessagingNetwork.InMemoryMessaging.myAddress -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / myAddress myAddress
+val myAddress : SingleMessageRecipient MessagingService.myAddress Returns an address that refers to this node.
+InMemoryMessagingNetwork.InMemoryMessaging.pump -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / pump pump
+fun pump ( block : Boolean ) : Boolean Delivers a single message from the internal queue. If there are no messages waiting to be delivered and block
+is true, waits until one has been provided on a different thread via send. If block is false, the return
+result indicates whether a message was delivered or not.
+InMemoryMessagingNetwork.InMemoryMessaging.removeMessageHandler -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / removeMessageHandler removeMessageHandler
+fun removeMessageHandler ( registration : MessageHandlerRegistration ) : Unit MessagingService.removeMessageHandler Removes a handler given the object returned from addMessageHandler . The callback will no longer be invoked once
+this method has returned, although executions that are currently in flight will not be interrupted.
+Exceptions
+IllegalArgumentException - if the given registration isnt valid for this messaging service.IllegalStateException - if the given registration was already de-registered.InMemoryMessagingNetwork.InMemoryMessaging.running -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / running running
+protected var running : Boolean InMemoryMessagingNetwork.InMemoryMessaging.send -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / send send
+fun send ( message : Message , target : MessageRecipients ) : Unit MessagingService.send Sends a message to the given receiver. The details of how receivers are identified is up to the messaging
+implementation: the type system provides an opaque high level view, with more fine grained control being
+available via type casting. Once this function returns the message is queued for delivery but not necessarily
+delivered: if the recipients are offline then the message could be queued hours or days later.
+There is no way to know if a message has been received. If your protocol requires this, you need the recipient
+to send an ACK message back.
+InMemoryMessagingNetwork.InMemoryMessaging.state -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / state state
+protected val state : ThreadBox < InnerState > InMemoryMessagingNetwork.InMemoryMessaging.stop -
+core.testing / InMemoryMessagingNetwork / InMemoryMessaging / stop stop
+fun stop ( ) : Unit MessagingService.stop InMemoryMessagingNetwork.<init> -
+core.testing / InMemoryMessagingNetwork / <init> <init>
+InMemoryMessagingNetwork ( ) An in-memory network allows you to manufacture InMemoryMessaging s for a set of participants. Each
+InMemoryMessaging maintains a queue of messages it has received, and a background thread that dispatches
+messages one by one to registered handlers. Alternatively, a messaging system may be manually pumped, in which
+case no thread is created and a caller is expected to force delivery one at a time (this is useful for unit
+testing).
+InMemoryMessagingNetwork.LatencyCalculator.between -
+core.testing / InMemoryMessagingNetwork / LatencyCalculator / between between
+abstract fun between ( sender : SingleMessageRecipient , receiver : SingleMessageRecipient ) : Duration InMemoryMessagingNetwork.LatencyCalculator -
+core.testing / InMemoryMessagingNetwork / LatencyCalculator LatencyCalculator
+interface LatencyCalculator Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-in-memory-messaging-network/all-messages.html b/docs/build/html/api/core.testing/-in-memory-messaging-network/all-messages.html
new file mode 100644
index 0000000000..940beba695
--- /dev/null
+++ b/docs/build/html/api/core.testing/-in-memory-messaging-network/all-messages.html
@@ -0,0 +1,16 @@
+
+
+InMemoryMessagingNetwork.allMessages -
+core.testing / InMemoryMessagingNetwork / allMessages allMessages
+val allMessages : <ERROR CLASS> < <ERROR CLASS> < SingleMessageRecipient , Message , MessageRecipients > > A stream of (sender, message, recipients) triples
+InMemoryMessagingNetwork.createNodeWithID -
+core.testing / InMemoryMessagingNetwork / createNodeWithID createNodeWithID
+fun createNodeWithID ( manuallyPumped : Boolean , id : Int ) : MessagingServiceBuilder < InMemoryMessaging > Creates a node at the given address: useful if you want to recreate a node to simulate a restart
+InMemoryMessagingNetwork.createNode -
+core.testing / InMemoryMessagingNetwork / createNode createNode
+fun createNode ( manuallyPumped : Boolean ) : <ERROR CLASS> < Handle , MessagingServiceBuilder < InMemoryMessaging > > Creates a node and returns the new object that identifies its location on the network to senders, and the
+InMemoryMessaging that the recipient/in-memory node uses to receive messages and send messages itself.
+If manuallyPumped is set to true, then you are expected to call the InMemoryMessaging.pump method on the InMemoryMessaging
+in order to cause the delivery of a single message, which will occur on the thread of the caller. If set to false
+then this class will set up a background thread to deliver messages asynchronously, if the handler specifies no
+executor.
+InMemoryMessagingNetwork.endpoints -
+core.testing / InMemoryMessagingNetwork / endpoints endpoints
+val endpoints : List < InMemoryMessaging > InMemoryMessagingNetwork.everyoneOnline -
+core.testing / InMemoryMessagingNetwork / everyoneOnline everyoneOnline
+val everyoneOnline : AllPossibleRecipients InMemoryMessagingNetwork -
+core.testing / InMemoryMessagingNetwork InMemoryMessagingNetwork
+class InMemoryMessagingNetwork An in-memory network allows you to manufacture InMemoryMessaging s for a set of participants. Each
+InMemoryMessaging maintains a queue of messages it has received, and a background thread that dispatches
+messages one by one to registered handlers. Alternatively, a messaging system may be manually pumped, in which
+case no thread is created and a caller is expected to force delivery one at a time (this is useful for unit
+testing).
+Types
+
+Constructors
+
+
+
+
+<init>
+
+InMemoryMessagingNetwork ( ) An in-memory network allows you to manufacture InMemoryMessaging s for a set of participants. Each
+InMemoryMessaging maintains a queue of messages it has received, and a background thread that dispatches
+messages one by one to registered handlers. Alternatively, a messaging system may be manually pumped, in which
+case no thread is created and a caller is expected to force delivery one at a time (this is useful for unit
+testing).
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-in-memory-messaging-network/latency-calculator.html b/docs/build/html/api/core.testing/-in-memory-messaging-network/latency-calculator.html
new file mode 100644
index 0000000000..77f5335464
--- /dev/null
+++ b/docs/build/html/api/core.testing/-in-memory-messaging-network/latency-calculator.html
@@ -0,0 +1,16 @@
+
+
+InMemoryMessagingNetwork.latencyCalculator -
+core.testing / InMemoryMessagingNetwork / latencyCalculator latencyCalculator
+var latencyCalculator : LatencyCalculator ? This can be set to an object which can inject artificial latency between sender/recipient pairs.
+InMemoryMessagingNetwork.setupTimestampingNode -
+core.testing / InMemoryMessagingNetwork / setupTimestampingNode setupTimestampingNode
+fun setupTimestampingNode ( manuallyPumped : Boolean ) : <ERROR CLASS> < NodeInfo , InMemoryMessaging > InMemoryMessagingNetwork.stop -
+core.testing / InMemoryMessagingNetwork / stop stop
+fun stop ( ) : Unit MockIdentityService.<init> -
+core.testing / MockIdentityService / <init> <init>
+MockIdentityService ( identities : List < Party > ) Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.
+This class allows the provided list of identities to be mutated after construction, so it takes the list lock
+when doing lookups and recalculates the mapping each time. The ability to change the list is used by the
+MockNetwork code.
+MockIdentityService.identities -
+core.testing / MockIdentityService / identities identities
+val identities : List < Party > MockIdentityService -
+core.testing / MockIdentityService MockIdentityService
+class MockIdentityService : IdentityService Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.
+This class allows the provided list of identities to be mutated after construction, so it takes the list lock
+when doing lookups and recalculates the mapping each time. The ability to change the list is used by the
+MockNetwork code.
+Constructors
+
+
+
+
+<init>
+
+MockIdentityService ( identities : List < Party > ) Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.
+This class allows the provided list of identities to be mutated after construction, so it takes the list lock
+when doing lookups and recalculates the mapping each time. The ability to change the list is used by the
+MockNetwork code.
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-mock-identity-service/party-from-key.html b/docs/build/html/api/core.testing/-mock-identity-service/party-from-key.html
new file mode 100644
index 0000000000..20b8dc25e3
--- /dev/null
+++ b/docs/build/html/api/core.testing/-mock-identity-service/party-from-key.html
@@ -0,0 +1,16 @@
+
+
+MockIdentityService.partyFromKey -
+core.testing / MockIdentityService / partyFromKey partyFromKey
+fun partyFromKey ( key : PublicKey ) : Party ? IdentityService.partyFromKey MockIdentityService.partyFromName -
+core.testing / MockIdentityService / partyFromName partyFromName
+fun partyFromName ( name : String ) : Party ? IdentityService.partyFromName MockIdentityService.registerIdentity -
+core.testing / MockIdentityService / registerIdentity registerIdentity
+fun registerIdentity ( party : Party ) : Unit IdentityService.registerIdentity MockNetworkMapCache.<init> -
+core.testing / MockNetworkMapCache / <init> <init>
+MockNetworkMapCache ( ) Network map cache with no backing map service.
+MockNetworkMapCache.MockAddress.<init> -
+core.testing / MockNetworkMapCache / MockAddress / <init> <init>
+MockAddress ( id : String ) MockNetworkMapCache.MockAddress.id -
+core.testing / MockNetworkMapCache / MockAddress / id id
+val id : String MockNetworkMapCache.MockAddress -
+core.testing / MockNetworkMapCache / MockAddress MockAddress
+data class MockAddress : SingleMessageRecipient Constructors
+
+
+
+
+<init>
+
+MockAddress ( id : String )
+
+
+
+Properties
+
+
+
+
+id
+
+val id : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.testing/-mock-network-map-cache/add-registration.html b/docs/build/html/api/core.testing/-mock-network-map-cache/add-registration.html
new file mode 100644
index 0000000000..dce318c165
--- /dev/null
+++ b/docs/build/html/api/core.testing/-mock-network-map-cache/add-registration.html
@@ -0,0 +1,17 @@
+
+
+MockNetworkMapCache.addRegistration -
+core.testing / MockNetworkMapCache / addRegistration addRegistration
+fun addRegistration ( node : NodeInfo ) : Unit Directly add a registration to the internal cache. DOES NOT fire the change listeners, as its
+not a change being received.
+MockNetworkMapCache.deleteRegistration -
+core.testing / MockNetworkMapCache / deleteRegistration deleteRegistration
+fun deleteRegistration ( identity : Party ) : Boolean Directly remove a registration from the internal cache. DOES NOT fire the change listeners, as its
+not a change being received.
+MockNetworkMapCache -
+core.testing / MockNetworkMapCache MockNetworkMapCache
+class MockNetworkMapCache : InMemoryNetworkMapCache Network map cache with no backing map service.
+Types
+
+Constructors
+
+
+
+
+<init>
+
+MockNetworkMapCache ( ) Network map cache with no backing map service.
+
+
+
+
+Inherited Properties
+
+
+
+
+networkMapNodes
+
+open val networkMapNodes : List < NodeInfo > A list of nodes that advertise a network map service
+
+
+
+
+partyNodes
+
+open val partyNodes : List < NodeInfo > A list of all nodes the cache is aware of
+
+
+
+
+ratesOracleNodes
+
+open val ratesOracleNodes : List < NodeInfo > A list of nodes that advertise a rates oracle service
+
+
+
+
+registeredNodes
+
+var registeredNodes : MutableMap < Party , NodeInfo >
+
+
+
+regulators
+
+open val regulators : List < NodeInfo > A list of nodes that advertise a regulatory service. Identifying the correct regulator for a trade is outwith
+the scope of the network map service, and this is intended solely as a sanity check on configuration stored
+elsewhere.
+
+
+
+
+timestampingNodes
+
+open val timestampingNodes : List < NodeInfo > A list of nodes that advertise a timestamping service
+
+
+
+
+Functions
+
+
+
+
+addRegistration
+
+fun addRegistration ( node : NodeInfo ) : Unit Directly add a registration to the internal cache. DOES NOT fire the change listeners, as its
+not a change being received.
+
+
+
+
+deleteRegistration
+
+fun deleteRegistration ( identity : Party ) : Boolean Directly remove a registration from the internal cache. DOES NOT fire the change listeners, as its
+not a change being received.
+
+
+
+
+Inherited Functions
+
+
+
+
+addMapService
+
+open fun addMapService ( smm : StateMachineManager , net : MessagingService , service : NodeInfo , subscribe : Boolean , ifChangedSinceVer : Int ? ) : <ERROR CLASS> < Unit > Add a network map service; fetches a copy of the latest map from the service and subscribes to any further
+updates.
+
+
+
+
+addNode
+
+open fun addNode ( node : NodeInfo ) : Unit Adds a node to the local cache (generally only used for adding ourselves)
+
+
+
+
+deregisterForUpdates
+
+open fun deregisterForUpdates ( smm : StateMachineManager , net : MessagingService , service : NodeInfo ) : <ERROR CLASS> < Unit > Unsubscribes from updates from the given map service.
+
+
+
+
+get
+
+open fun get ( ) : <ERROR CLASS> Get a copy of all nodes in the map.
+open fun get ( serviceType : ServiceType ) : <ERROR CLASS> Get the collection of nodes which advertise a specific service.
+
+
+
+
+getRecommended
+
+open fun getRecommended ( type : ServiceType , contract : Contract , vararg party : Party ) : NodeInfo ? Get a recommended node that advertises a service, and is suitable for the specified contract and parties.
+Implementations might understand, for example, the correct regulator to use for specific contracts/parties,
+or the appropriate oracle for a contract.
+
+
+
+
+processUpdatePush
+
+fun processUpdatePush ( req : Update ) : Unit
+
+
+
+removeNode
+
+open fun removeNode ( node : NodeInfo ) : Unit Removes a node from the local cache
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.testing/-mock-network/-default-factory/create.html b/docs/build/html/api/core.testing/-mock-network/-default-factory/create.html
new file mode 100644
index 0000000000..8b553395d6
--- /dev/null
+++ b/docs/build/html/api/core.testing/-mock-network/-default-factory/create.html
@@ -0,0 +1,16 @@
+
+
+MockNetwork.DefaultFactory.create -
+core.testing / MockNetwork / DefaultFactory / create create
+fun create ( dir : Path , config : NodeConfiguration , network : MockNetwork , networkMapAddr : NodeInfo ? , advertisedServices : Set < ServiceType > , id : Int ) : MockNode Factory.create MockNetwork.DefaultFactory -
+core.testing / MockNetwork / DefaultFactory DefaultFactory
+object DefaultFactory : Factory Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-mock-network/-factory/create.html b/docs/build/html/api/core.testing/-mock-network/-factory/create.html
new file mode 100644
index 0000000000..582bf40ebd
--- /dev/null
+++ b/docs/build/html/api/core.testing/-mock-network/-factory/create.html
@@ -0,0 +1,15 @@
+
+
+MockNetwork.Factory.create -
+core.testing / MockNetwork / Factory / create create
+abstract fun create ( dir : Path , config : NodeConfiguration , network : MockNetwork , networkMapAddr : NodeInfo ? , advertisedServices : Set < ServiceType > , id : Int ) : MockNode MockNetwork.Factory -
+core.testing / MockNetwork / Factory Factory
+interface Factory Allows customisation of how nodes are created.
+Functions
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/core.testing/-mock-network/-init-.html b/docs/build/html/api/core.testing/-mock-network/-init-.html
new file mode 100644
index 0000000000..a640c171f5
--- /dev/null
+++ b/docs/build/html/api/core.testing/-mock-network/-init-.html
@@ -0,0 +1,21 @@
+
+
+MockNetwork.<init> -
+core.testing / MockNetwork / <init> <init>
+MockNetwork ( threadPerNode : Boolean = false, defaultFactory : Factory = MockNetwork.DefaultFactory) A mock node brings up a suite of in-memory services in a fast manner suitable for unit testing.
+Components that do IO are either swapped out for mocks, or pointed to a Jimfs in memory filesystem.
+Mock network nodes require manual pumping by default: they will not run asynchronous. This means that
+for message exchanges to take place (and associated handlers to run), you must call the runNetwork
+method.
+MockNetwork.MockNode.<init> -
+core.testing / MockNetwork / MockNode / <init> <init>
+MockNode ( dir : Path , config : NodeConfiguration , mockNet : MockNetwork , networkMapAddr : NodeInfo ? , advertisedServices : Set < ServiceType > , id : Int ) MockNetwork.MockNode.findMyLocation -
+core.testing / MockNetwork / MockNode / findMyLocation findMyLocation
+protected open fun findMyLocation ( ) : PhysicalLocation ? AbstractNode.findMyLocation MockNetwork.MockNode.id -
+core.testing / MockNetwork / MockNode / id id
+val id : Int MockNetwork.MockNode -
+core.testing / MockNetwork / MockNode MockNode
+class MockNode : AbstractNode Constructors
+
+Properties
+
+Inherited Properties
+
+Functions
+
+Inherited Functions
+
+Inheritors
+
+
+
+
+SimulatedNode
+
+open class SimulatedNode : MockNode
+
+
+
+
+
diff --git a/docs/build/html/api/core.testing/-mock-network/-mock-node/log.html b/docs/build/html/api/core.testing/-mock-network/-mock-node/log.html
new file mode 100644
index 0000000000..d667bd5887
--- /dev/null
+++ b/docs/build/html/api/core.testing/-mock-network/-mock-node/log.html
@@ -0,0 +1,16 @@
+
+
+MockNetwork.MockNode.log -
+core.testing / MockNetwork / MockNode / log log
+protected open val log : <ERROR CLASS> AbstractNode.log MockNetwork.MockNode.makeIdentityService -
+core.testing / MockNetwork / MockNode / makeIdentityService makeIdentityService
+protected open fun makeIdentityService ( ) : MockIdentityService AbstractNode.makeIdentityService MockNetwork.MockNode.makeMessagingService -
+core.testing / MockNetwork / MockNode / makeMessagingService makeMessagingService
+protected open fun makeMessagingService ( ) : MessagingService AbstractNode.makeMessagingService MockNetwork.MockNode.mockNet -
+core.testing / MockNetwork / MockNode / mockNet mockNet
+val mockNet : MockNetwork MockNetwork.MockNode.place -
+core.testing / MockNetwork / MockNode / place place
+val place : PhysicalLocation MockNetwork.MockNode.serverThread -
+core.testing / MockNetwork / MockNode / serverThread serverThread
+protected open val serverThread : AffinityExecutor AbstractNode.serverThread MockNetwork.MockNode.startMessagingService -
+core.testing / MockNetwork / MockNode / startMessagingService startMessagingService
+protected open fun startMessagingService ( ) : Unit AbstractNode.startMessagingService MockNetwork.MockNode.start -
+core.testing / MockNetwork / MockNode / start start
+open fun start ( ) : MockNode AbstractNode.start MockNetwork.addressToNode -
+core.testing / MockNetwork / addressToNode addressToNode
+fun addressToNode ( address : SingleMessageRecipient ) : MockNode MockNetwork.createNode -
+core.testing / MockNetwork / createNode createNode
+fun createNode ( networkMapAddress : NodeInfo ? = null, forcedID : Int = -1, nodeFactory : Factory = defaultFactory, vararg advertisedServices : ServiceType ) : MockNode Returns a started node, optionally created by the passed factory method
+MockNetwork.createTwoNodes -
+core.testing / MockNetwork / createTwoNodes createTwoNodes
+fun createTwoNodes ( nodeFactory : Factory = defaultFactory) : <ERROR CLASS> < MockNode , MockNode > Sets up a two node network, in which the first node runs network map and timestamping services and the other
+doesnt.
+MockNetwork.filesystem -
+core.testing / MockNetwork / filesystem filesystem
+val filesystem : <ERROR CLASS> MockNetwork.identities -
+core.testing / MockNetwork / identities identities
+val identities : ArrayList < Party > MockNetwork -
+core.testing / MockNetwork MockNetwork
+class MockNetwork A mock node brings up a suite of in-memory services in a fast manner suitable for unit testing.
+Components that do IO are either swapped out for mocks, or pointed to a Jimfs in memory filesystem.
+Mock network nodes require manual pumping by default: they will not run asynchronous. This means that
+for message exchanges to take place (and associated handlers to run), you must call the runNetwork
+method.
+Types
+
+Constructors
+
+
+
+
+<init>
+
+MockNetwork ( threadPerNode : Boolean = false, defaultFactory : Factory = MockNetwork.DefaultFactory) A mock node brings up a suite of in-memory services in a fast manner suitable for unit testing.
+Components that do IO are either swapped out for mocks, or pointed to a Jimfs in memory filesystem.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+addressToNode
+
+fun addressToNode ( address : SingleMessageRecipient ) : MockNode
+
+
+
+createNode
+
+fun createNode ( networkMapAddress : NodeInfo ? = null, forcedID : Int = -1, nodeFactory : Factory = defaultFactory, vararg advertisedServices : ServiceType ) : MockNode Returns a started node, optionally created by the passed factory method
+
+
+
+
+createTwoNodes
+
+fun createTwoNodes ( nodeFactory : Factory = defaultFactory) : <ERROR CLASS> < MockNode , MockNode > Sets up a two node network, in which the first node runs network map and timestamping services and the other
+doesnt.
+
+
+
+
+runNetwork
+
+fun runNetwork ( rounds : Int = -1) : Unit Asks every node in order to process any queued up inbound messages. This may in turn result in nodes
+sending more messages to each other, thus, a typical usage is to call runNetwork with the rounds
+parameter set to -1 (the default) which simply runs as many rounds as necessary to result in network
+stability (no nodes sent any messages in the last round).
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.testing/-mock-network/messaging-network.html b/docs/build/html/api/core.testing/-mock-network/messaging-network.html
new file mode 100644
index 0000000000..0ef8581db8
--- /dev/null
+++ b/docs/build/html/api/core.testing/-mock-network/messaging-network.html
@@ -0,0 +1,15 @@
+
+
+MockNetwork.messagingNetwork -
+core.testing / MockNetwork / messagingNetwork messagingNetwork
+val messagingNetwork : InMemoryMessagingNetwork MockNetwork.nodes -
+core.testing / MockNetwork / nodes nodes
+val nodes : List < MockNode > A read only view of the current set of executing nodes.
+MockNetwork.runNetwork -
+core.testing / MockNetwork / runNetwork runNetwork
+fun runNetwork ( rounds : Int = -1) : Unit Asks every node in order to process any queued up inbound messages. This may in turn result in nodes
+sending more messages to each other, thus, a typical usage is to call runNetwork with the rounds
+parameter set to -1 (the default) which simply runs as many rounds as necessary to result in network
+stability (no nodes sent any messages in the last round).
+Simulation.BankFactory.<init> -
+core.testing / Simulation / BankFactory / <init> <init>
+BankFactory ( ) Simulation.BankFactory.counter -
+core.testing / Simulation / BankFactory / counter counter
+var counter : Int Simulation.BankFactory.createAll -
+core.testing / Simulation / BankFactory / createAll createAll
+fun createAll ( ) : List < SimulatedNode > Simulation.BankFactory.create -
+core.testing / Simulation / BankFactory / create create
+fun create ( dir : Path , config : NodeConfiguration , network : MockNetwork , networkMapAddr : NodeInfo ? , advertisedServices : Set < ServiceType > , id : Int ) : MockNode Factory.create Simulation.BankFactory -
+core.testing / Simulation / BankFactory BankFactory
+inner class BankFactory : Factory Constructors
+
+
+
+
+<init>
+
+BankFactory ( )
+
+
+
+Properties
+
+
+
+
+counter
+
+var counter : Int
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-simulation/-init-.html b/docs/build/html/api/core.testing/-simulation/-init-.html
new file mode 100644
index 0000000000..70eda4e879
--- /dev/null
+++ b/docs/build/html/api/core.testing/-simulation/-init-.html
@@ -0,0 +1,19 @@
+
+
+Simulation.<init> -
+core.testing / Simulation / <init> <init>
+Simulation ( runAsync : Boolean , latencyInjector : LatencyCalculator ? ) Base class for network simulations that are based on the unit test / mock environment.
+Sets up some nodes that can run protocols between each other, and exposes their progress trackers. Provides banks
+in a few cities around the world.
+Simulation.NetworkMapNodeFactory.create -
+core.testing / Simulation / NetworkMapNodeFactory / create create
+fun create ( dir : Path , config : NodeConfiguration , network : MockNetwork , networkMapAddr : NodeInfo ? , advertisedServices : Set < ServiceType > , id : Int ) : MockNode Factory.create Simulation.NetworkMapNodeFactory -
+core.testing / Simulation / NetworkMapNodeFactory NetworkMapNodeFactory
+object NetworkMapNodeFactory : Factory Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-simulation/-rates-oracle-factory/create.html b/docs/build/html/api/core.testing/-simulation/-rates-oracle-factory/create.html
new file mode 100644
index 0000000000..3cb9a85be4
--- /dev/null
+++ b/docs/build/html/api/core.testing/-simulation/-rates-oracle-factory/create.html
@@ -0,0 +1,16 @@
+
+
+Simulation.RatesOracleFactory.create -
+core.testing / Simulation / RatesOracleFactory / create create
+fun create ( dir : Path , config : NodeConfiguration , network : MockNetwork , networkMapAddr : NodeInfo ? , advertisedServices : Set < ServiceType > , id : Int ) : MockNode Factory.create Simulation.RatesOracleFactory -
+core.testing / Simulation / RatesOracleFactory RatesOracleFactory
+object RatesOracleFactory : Factory Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-simulation/-regulator-factory/create.html b/docs/build/html/api/core.testing/-simulation/-regulator-factory/create.html
new file mode 100644
index 0000000000..420828e891
--- /dev/null
+++ b/docs/build/html/api/core.testing/-simulation/-regulator-factory/create.html
@@ -0,0 +1,16 @@
+
+
+Simulation.RegulatorFactory.create -
+core.testing / Simulation / RegulatorFactory / create create
+fun create ( dir : Path , config : NodeConfiguration , network : MockNetwork , networkMapAddr : NodeInfo ? , advertisedServices : Set < ServiceType > , id : Int ) : MockNode Factory.create Simulation.RegulatorFactory -
+core.testing / Simulation / RegulatorFactory RegulatorFactory
+object RegulatorFactory : Factory Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-simulation/-simulated-node/-init-.html b/docs/build/html/api/core.testing/-simulation/-simulated-node/-init-.html
new file mode 100644
index 0000000000..269717799b
--- /dev/null
+++ b/docs/build/html/api/core.testing/-simulation/-simulated-node/-init-.html
@@ -0,0 +1,14 @@
+
+
+Simulation.SimulatedNode.<init> -
+core.testing / Simulation / SimulatedNode / <init> <init>
+SimulatedNode ( dir : Path , config : NodeConfiguration , mockNet : MockNetwork , networkMapAddress : NodeInfo ? , advertisedServices : Set < ServiceType > , id : Int ) Simulation.SimulatedNode.findMyLocation -
+core.testing / Simulation / SimulatedNode / findMyLocation findMyLocation
+protected open fun findMyLocation ( ) : PhysicalLocation ? MockNode.findMyLocation Simulation.SimulatedNode -
+core.testing / Simulation / SimulatedNode SimulatedNode
+open class SimulatedNode : MockNode Constructors
+
+Inherited Properties
+
+Functions
+
+Inherited Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-simulation/-timestamping-node-factory/create.html b/docs/build/html/api/core.testing/-simulation/-timestamping-node-factory/create.html
new file mode 100644
index 0000000000..ea6005515c
--- /dev/null
+++ b/docs/build/html/api/core.testing/-simulation/-timestamping-node-factory/create.html
@@ -0,0 +1,16 @@
+
+
+Simulation.TimestampingNodeFactory.create -
+core.testing / Simulation / TimestampingNodeFactory / create create
+fun create ( dir : Path , config : NodeConfiguration , network : MockNetwork , networkMapAddr : NodeInfo ? , advertisedServices : Set < ServiceType > , id : Int ) : MockNode Factory.create Simulation.TimestampingNodeFactory -
+core.testing / Simulation / TimestampingNodeFactory TimestampingNodeFactory
+object TimestampingNodeFactory : Factory Functions
+
+
+
diff --git a/docs/build/html/api/core.testing/-simulation/all-protocol-steps.html b/docs/build/html/api/core.testing/-simulation/all-protocol-steps.html
new file mode 100644
index 0000000000..6f1811c960
--- /dev/null
+++ b/docs/build/html/api/core.testing/-simulation/all-protocol-steps.html
@@ -0,0 +1,15 @@
+
+
+Simulation.allProtocolSteps -
+core.testing / Simulation / allProtocolSteps allProtocolSteps
+val allProtocolSteps : <ERROR CLASS> < <ERROR CLASS> < SimulatedNode , Change > > Simulation.bankFactory -
+core.testing / Simulation / bankFactory bankFactory
+val bankFactory : BankFactory Simulation.bankLocations -
+core.testing / Simulation / bankLocations bankLocations
+val bankLocations : <ERROR CLASS> Simulation.banks -
+core.testing / Simulation / banks banks
+val banks : List < SimulatedNode > Simulation.currentDay -
+core.testing / Simulation / currentDay currentDay
+var currentDay : LocalDate The current simulated date. By default this never changes. If you want it to change, you should do so from
+within your overridden iterate call. Changes in the current day surface in the dateChanges observable.
+Simulation.dateChanges -
+core.testing / Simulation / dateChanges dateChanges
+val dateChanges : <ERROR CLASS> < LocalDate > Simulation.doneSteps -
+core.testing / Simulation / doneSteps doneSteps
+val doneSteps : <ERROR CLASS> < Collection < SimulatedNode > > Simulation.extraNodeLabels -
+core.testing / Simulation / extraNodeLabels extraNodeLabels
+val extraNodeLabels : MutableMap < SimulatedNode , String > A place for simulations to stash human meaningful text about what the node is "thinking", which might appear
+in the UI somewhere.
+Simulation -
+core.testing / Simulation Simulation
+abstract class Simulation Base class for network simulations that are based on the unit test / mock environment.
+Sets up some nodes that can run protocols between each other, and exposes their progress trackers. Provides banks
+in a few cities around the world.
+Types
+
+Constructors
+
+
+
+
+<init>
+
+Simulation ( runAsync : Boolean , latencyInjector : LatencyCalculator ? ) Base class for network simulations that are based on the unit test / mock environment.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+iterate
+
+open fun iterate ( ) : Unit Iterates the simulation by one step.
+
+
+
+
+linkConsensus
+
+fun linkConsensus ( nodes : Collection < SimulatedNode > , protocol : ProtocolLogic < * > ) : Unit
+
+
+
+linkProtocolProgress
+
+fun linkProtocolProgress ( node : SimulatedNode , protocol : ProtocolLogic < * > ) : Unit
+
+
+
+start
+
+open fun start ( ) : Unit
+
+
+
+startTradingCircle
+
+fun startTradingCircle ( tradeBetween : ( Int , Int ) -> <ERROR CLASS> < out <ERROR CLASS> > ) : Unit Given a function that returns a future, iterates that function with arguments like (0, 1), (1, 2), (2, 3) etc
+each time the returned future completes.
+
+
+
+
+stop
+
+fun stop ( ) : Unit
+
+
+
+Inheritors
+
+
+
+
+IRSSimulation
+
+class IRSSimulation : Simulation A simulation in which banks execute interest rate swaps with each other, including the fixing events.
+
+
+
+
+TradeSimulation
+
+class TradeSimulation : Simulation Simulates a never ending series of trades that go pair-wise through the banks (e.g. A and B trade with each other,
+then B and C trade with each other, then C and A etc).
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.testing/-simulation/iterate.html b/docs/build/html/api/core.testing/-simulation/iterate.html
new file mode 100644
index 0000000000..e8971cfd88
--- /dev/null
+++ b/docs/build/html/api/core.testing/-simulation/iterate.html
@@ -0,0 +1,22 @@
+
+
+Simulation.iterate -
+core.testing / Simulation / iterate iterate
+open fun iterate ( ) : Unit Iterates the simulation by one step.
+The default implementation circles around the nodes, pumping until one of them handles a message. The next call
+will carry on from where this one stopped. In an environment where you want to take actions between anything
+interesting happening, or control the precise speed at which things operate (beyond the latency injector), this
+is a useful way to do things.
+Simulation.latencyInjector -
+core.testing / Simulation / latencyInjector latencyInjector
+val latencyInjector : LatencyCalculator ? Simulation.linkConsensus -
+core.testing / Simulation / linkConsensus linkConsensus
+protected fun linkConsensus ( nodes : Collection < SimulatedNode > , protocol : ProtocolLogic < * > ) : Unit Simulation.linkProtocolProgress -
+core.testing / Simulation / linkProtocolProgress linkProtocolProgress
+protected fun linkProtocolProgress ( node : SimulatedNode , protocol : ProtocolLogic < * > ) : Unit Simulation.networkMap -
+core.testing / Simulation / networkMap networkMap
+val networkMap : SimulatedNode Simulation.network -
+core.testing / Simulation / network network
+val network : MockNetwork Simulation.ratesOracle -
+core.testing / Simulation / ratesOracle ratesOracle
+val ratesOracle : SimulatedNode Simulation.regulators -
+core.testing / Simulation / regulators regulators
+val regulators : List < SimulatedNode > Simulation.runAsync -
+core.testing / Simulation / runAsync runAsync
+val runAsync : Boolean Simulation.serviceProviders -
+core.testing / Simulation / serviceProviders serviceProviders
+val serviceProviders : List < SimulatedNode > Simulation.startTradingCircle -
+core.testing / Simulation / startTradingCircle startTradingCircle
+fun startTradingCircle ( tradeBetween : ( Int , Int ) -> <ERROR CLASS> < out <ERROR CLASS> > ) : Unit Given a function that returns a future, iterates that function with arguments like (0, 1), (1, 2), (2, 3) etc
+each time the returned future completes.
+Simulation.start -
+core.testing / Simulation / start start
+open fun start ( ) : Unit Simulation.stop -
+core.testing / Simulation / stop stop
+fun stop ( ) : Unit Simulation.timestamper -
+core.testing / Simulation / timestamper timestamper
+val timestamper : SimulatedNode TradeSimulation.<init> -
+core.testing / TradeSimulation / <init> <init>
+TradeSimulation ( runAsync : Boolean , latencyInjector : LatencyCalculator ? ) Simulates a never ending series of trades that go pair-wise through the banks (e.g. A and B trade with each other,
+then B and C trade with each other, then C and A etc).
+TradeSimulation -
+core.testing / TradeSimulation TradeSimulation
+class TradeSimulation : Simulation Simulates a never ending series of trades that go pair-wise through the banks (e.g. A and B trade with each other,
+then B and C trade with each other, then C and A etc).
+Constructors
+
+
+
+
+<init>
+
+TradeSimulation ( runAsync : Boolean , latencyInjector : LatencyCalculator ? ) Simulates a never ending series of trades that go pair-wise through the banks (e.g. A and B trade with each other,
+then B and C trade with each other, then C and A etc).
+
+
+
+
+Inherited Properties
+
+Functions
+
+
+
+
+start
+
+fun start ( ) : Unit
+
+
+
+Inherited Functions
+
+
+
+
+iterate
+
+open fun iterate ( ) : Unit Iterates the simulation by one step.
+
+
+
+
+linkConsensus
+
+fun linkConsensus ( nodes : Collection < SimulatedNode > , protocol : ProtocolLogic < * > ) : Unit
+
+
+
+linkProtocolProgress
+
+fun linkProtocolProgress ( node : SimulatedNode , protocol : ProtocolLogic < * > ) : Unit
+
+
+
+startTradingCircle
+
+fun startTradingCircle ( tradeBetween : ( Int , Int ) -> <ERROR CLASS> < out <ERROR CLASS> > ) : Unit Given a function that returns a future, iterates that function with arguments like (0, 1), (1, 2), (2, 3) etc
+each time the returned future completes.
+
+
+
+
+stop
+
+fun stop ( ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.testing/-trade-simulation/start.html b/docs/build/html/api/core.testing/-trade-simulation/start.html
new file mode 100644
index 0000000000..52c44ce7ab
--- /dev/null
+++ b/docs/build/html/api/core.testing/-trade-simulation/start.html
@@ -0,0 +1,16 @@
+
+
+TradeSimulation.start -
+core.testing / TradeSimulation / start start
+fun start ( ) : Unit Simulation.start core.testing -
+core.testing Package core.testing
+Types
+
+
+
+
+IRSSimulation
+
+class IRSSimulation : Simulation A simulation in which banks execute interest rate swaps with each other, including the fixing events.
+
+
+
+
+InMemoryMessagingNetwork
+
+class InMemoryMessagingNetwork An in-memory network allows you to manufacture InMemoryMessaging s for a set of participants. Each
+InMemoryMessaging maintains a queue of messages it has received, and a background thread that dispatches
+messages one by one to registered handlers. Alternatively, a messaging system may be manually pumped, in which
+case no thread is created and a caller is expected to force delivery one at a time (this is useful for unit
+testing).
+
+
+
+
+MockIdentityService
+
+class MockIdentityService : IdentityService Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.
+This class allows the provided list of identities to be mutated after construction, so it takes the list lock
+when doing lookups and recalculates the mapping each time. The ability to change the list is used by the
+MockNetwork code.
+
+
+
+
+MockNetwork
+
+class MockNetwork A mock node brings up a suite of in-memory services in a fast manner suitable for unit testing.
+Components that do IO are either swapped out for mocks, or pointed to a Jimfs in memory filesystem.
+
+
+
+
+MockNetworkMapCache
+
+class MockNetworkMapCache : InMemoryNetworkMapCache Network map cache with no backing map service.
+
+
+
+
+Simulation
+
+abstract class Simulation Base class for network simulations that are based on the unit test / mock environment.
+
+
+
+
+TradeSimulation
+
+class TradeSimulation : Simulation Simulates a never ending series of trades that go pair-wise through the banks (e.g. A and B trade with each other,
+then B and C trade with each other, then C and A etc).
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-a-n-s-i-progress-renderer/index.html b/docs/build/html/api/core.utilities/-a-n-s-i-progress-renderer/index.html
new file mode 100644
index 0000000000..7da9900c13
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-a-n-s-i-progress-renderer/index.html
@@ -0,0 +1,31 @@
+
+
+ANSIProgressRenderer -
+core.utilities / ANSIProgressRenderer ANSIProgressRenderer
+object ANSIProgressRenderer Knows how to render a ProgressTracker to the terminal using coloured, emoji-fied output. Useful when writing small
+command line tools, demos, tests etc. Just set the progressTracker field and it will go ahead and start drawing
+if the terminal supports it. Otherwise it just prints out the name of the step whenever it changes.
+TODO: Thread safety
+Properties
+
+
+
diff --git a/docs/build/html/api/core.utilities/-a-n-s-i-progress-renderer/progress-tracker.html b/docs/build/html/api/core.utilities/-a-n-s-i-progress-renderer/progress-tracker.html
new file mode 100644
index 0000000000..7e37f12890
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-a-n-s-i-progress-renderer/progress-tracker.html
@@ -0,0 +1,15 @@
+
+
+ANSIProgressRenderer.progressTracker -
+core.utilities / ANSIProgressRenderer / progressTracker progressTracker
+var progressTracker : ProgressTracker ? AddOrRemove.ADD -
+core.utilities / AddOrRemove / ADD ADD
+ADD AddOrRemove.REMOVE -
+core.utilities / AddOrRemove / REMOVE REMOVE
+REMOVE AddOrRemove -
+core.utilities / AddOrRemove AddOrRemove
+enum class AddOrRemove Enum for when adding/removing something, for example adding or removing an entry in a directory.
+Enum Values
+
+
+
diff --git a/docs/build/html/api/core.utilities/-affinity-executor/-gate/-init-.html b/docs/build/html/api/core.utilities/-affinity-executor/-gate/-init-.html
new file mode 100644
index 0000000000..80062a2c6f
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-affinity-executor/-gate/-init-.html
@@ -0,0 +1,19 @@
+
+
+AffinityExecutor.Gate.<init> -
+core.utilities / AffinityExecutor / Gate / <init> <init>
+Gate ( alwaysQueue : Boolean = false) An executor useful for unit tests: allows the current thread to block until a command arrives from another
+thread, which is then executed. Inbound closures/commands stack up until they are cleared by looping.
+Parameters
+alwaysQueue - If true, executeASAP will never short-circuit and will always queue up.AffinityExecutor.Gate.execute -
+core.utilities / AffinityExecutor / Gate / execute execute
+fun execute ( command : Runnable ) : Unit AffinityExecutor.Gate -
+core.utilities / AffinityExecutor / Gate Gate
+class Gate : AffinityExecutor An executor useful for unit tests: allows the current thread to block until a command arrives from another
+thread, which is then executed. Inbound closures/commands stack up until they are cleared by looping.
+Parameters
+alwaysQueue - If true, executeASAP will never short-circuit and will always queue up.Constructors
+
+
+
+
+<init>
+
+Gate ( alwaysQueue : Boolean = false) An executor useful for unit tests: allows the current thread to block until a command arrives from another
+thread, which is then executed. Inbound closures/commands stack up until they are cleared by looping.
+
+
+
+
+Properties
+
+
+
+
+isOnThread
+
+val isOnThread : Boolean Returns true if the current thread is equal to the thread this executor is backed by.
+
+
+
+
+taskQueueSize
+
+val taskQueueSize : Int
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+checkOnThread
+
+open fun checkOnThread ( ) : Unit Throws an IllegalStateException if the current thread is not one of the threads this executor is backed by.
+
+
+
+
+executeASAP
+
+open fun executeASAP ( runnable : ( ) -> Unit ) : Unit If isOnThread() then runnable is invoked immediately, otherwise the closure is queued onto the backing thread.
+
+
+
+
+fetchFrom
+
+open fun < T > fetchFrom ( fetcher : ( ) -> T ) : T Runs the given function on the executor, blocking until the result is available. Be careful not to deadlock this
+way Make sure the executor cant possibly be waiting for the calling thread.
+
+
+
+
+flush
+
+open fun flush ( ) : Unit Posts a no-op task to the executor and blocks this thread waiting for it to complete. This can be useful in
+tests when you want to be sure that a previous task submitted via execute has completed.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-affinity-executor/-gate/is-on-thread.html b/docs/build/html/api/core.utilities/-affinity-executor/-gate/is-on-thread.html
new file mode 100644
index 0000000000..287a88307b
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-affinity-executor/-gate/is-on-thread.html
@@ -0,0 +1,20 @@
+
+
+AffinityExecutor.Gate.isOnThread -
+core.utilities / AffinityExecutor / Gate / isOnThread isOnThread
+val isOnThread : Boolean AffinityExecutor.isOnThread Returns true if the current thread is equal to the thread this executor is backed by.
+Getter Returns true if the current thread is equal to the thread this executor is backed by.
+AffinityExecutor.Gate.taskQueueSize -
+core.utilities / AffinityExecutor / Gate / taskQueueSize taskQueueSize
+val taskQueueSize : Int AffinityExecutor.Gate.waitAndRun -
+core.utilities / AffinityExecutor / Gate / waitAndRun waitAndRun
+fun waitAndRun ( ) : Unit AffinityExecutor.SAME_THREAD -
+core.utilities / AffinityExecutor / SAME_THREAD SAME_THREAD
+val SAME_THREAD : AffinityExecutor AffinityExecutor.ServiceAffinityExecutor.<init> -
+core.utilities / AffinityExecutor / ServiceAffinityExecutor / <init> <init>
+ServiceAffinityExecutor ( threadName : String , numThreads : Int ) An executor backed by thread pool (which may often have a single thread) which makes it easy to schedule
+tasks in the future and verify code is running on the executor.
+AffinityExecutor.ServiceAffinityExecutor.afterExecute -
+core.utilities / AffinityExecutor / ServiceAffinityExecutor / afterExecute afterExecute
+protected fun afterExecute ( r : Runnable , t : Throwable ? ) : Unit AffinityExecutor.ServiceAffinityExecutor -
+core.utilities / AffinityExecutor / ServiceAffinityExecutor ServiceAffinityExecutor
+class ServiceAffinityExecutor : AffinityExecutor , ThreadPoolExecutor An executor backed by thread pool (which may often have a single thread) which makes it easy to schedule
+tasks in the future and verify code is running on the executor.
+Constructors
+
+
+
+
+<init>
+
+ServiceAffinityExecutor ( threadName : String , numThreads : Int ) An executor backed by thread pool (which may often have a single thread) which makes it easy to schedule
+tasks in the future and verify code is running on the executor.
+
+
+
+
+Properties
+
+
+
+
+isOnThread
+
+val isOnThread : Boolean Returns true if the current thread is equal to the thread this executor is backed by.
+
+
+
+
+threads
+
+val threads : MutableSet < Thread >
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+checkOnThread
+
+open fun checkOnThread ( ) : Unit Throws an IllegalStateException if the current thread is not one of the threads this executor is backed by.
+
+
+
+
+executeASAP
+
+open fun executeASAP ( runnable : ( ) -> Unit ) : Unit If isOnThread() then runnable is invoked immediately, otherwise the closure is queued onto the backing thread.
+
+
+
+
+fetchFrom
+
+open fun < T > fetchFrom ( fetcher : ( ) -> T ) : T Runs the given function on the executor, blocking until the result is available. Be careful not to deadlock this
+way Make sure the executor cant possibly be waiting for the calling thread.
+
+
+
+
+flush
+
+open fun flush ( ) : Unit Posts a no-op task to the executor and blocks this thread waiting for it to complete. This can be useful in
+tests when you want to be sure that a previous task submitted via execute has completed.
+
+
+
+
+Companion Object Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-affinity-executor/-service-affinity-executor/is-on-thread.html b/docs/build/html/api/core.utilities/-affinity-executor/-service-affinity-executor/is-on-thread.html
new file mode 100644
index 0000000000..0513d3b4af
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-affinity-executor/-service-affinity-executor/is-on-thread.html
@@ -0,0 +1,20 @@
+
+
+AffinityExecutor.ServiceAffinityExecutor.isOnThread -
+core.utilities / AffinityExecutor / ServiceAffinityExecutor / isOnThread isOnThread
+val isOnThread : Boolean AffinityExecutor.isOnThread Returns true if the current thread is equal to the thread this executor is backed by.
+Getter Returns true if the current thread is equal to the thread this executor is backed by.
+AffinityExecutor.ServiceAffinityExecutor.logger -
+core.utilities / AffinityExecutor / ServiceAffinityExecutor / logger logger
+val logger : <ERROR CLASS> AffinityExecutor.ServiceAffinityExecutor.threads -
+core.utilities / AffinityExecutor / ServiceAffinityExecutor / threads threads
+protected val threads : MutableSet < Thread > AffinityExecutor.checkOnThread -
+core.utilities / AffinityExecutor / checkOnThread checkOnThread
+open fun checkOnThread ( ) : Unit Throws an IllegalStateException if the current thread is not one of the threads this executor is backed by.
+AffinityExecutor.executeASAP -
+core.utilities / AffinityExecutor / executeASAP executeASAP
+open fun executeASAP ( runnable : ( ) -> Unit ) : Unit If isOnThread() then runnable is invoked immediately, otherwise the closure is queued onto the backing thread.
+AffinityExecutor.fetchFrom -
+core.utilities / AffinityExecutor / fetchFrom fetchFrom
+open fun < T > fetchFrom ( fetcher : ( ) -> T ) : T Runs the given function on the executor, blocking until the result is available. Be careful not to deadlock this
+way Make sure the executor cant possibly be waiting for the calling thread.
+AffinityExecutor.flush -
+core.utilities / AffinityExecutor / flush flush
+open fun flush ( ) : Unit Posts a no-op task to the executor and blocks this thread waiting for it to complete. This can be useful in
+tests when you want to be sure that a previous task submitted via execute has completed.
+AffinityExecutor -
+core.utilities / AffinityExecutor AffinityExecutor
+interface AffinityExecutor : Executor An extended executor interface that supports thread affinity assertions and short circuiting. This can be useful
+for ensuring code runs on the right thread, and also for unit testing.
+Types
+
+
+
+
+Gate
+
+class Gate : AffinityExecutor An executor useful for unit tests: allows the current thread to block until a command arrives from another
+thread, which is then executed. Inbound closures/commands stack up until they are cleared by looping.
+
+
+
+
+ServiceAffinityExecutor
+
+class ServiceAffinityExecutor : AffinityExecutor , ThreadPoolExecutor An executor backed by thread pool (which may often have a single thread) which makes it easy to schedule
+tasks in the future and verify code is running on the executor.
+
+
+
+
+Properties
+
+
+
+
+isOnThread
+
+abstract val isOnThread : Boolean Returns true if the current thread is equal to the thread this executor is backed by.
+
+
+
+
+Functions
+
+
+
+
+checkOnThread
+
+open fun checkOnThread ( ) : Unit Throws an IllegalStateException if the current thread is not one of the threads this executor is backed by.
+
+
+
+
+executeASAP
+
+open fun executeASAP ( runnable : ( ) -> Unit ) : Unit If isOnThread() then runnable is invoked immediately, otherwise the closure is queued onto the backing thread.
+
+
+
+
+fetchFrom
+
+open fun < T > fetchFrom ( fetcher : ( ) -> T ) : T Runs the given function on the executor, blocking until the result is available. Be careful not to deadlock this
+way Make sure the executor cant possibly be waiting for the calling thread.
+
+
+
+
+flush
+
+open fun flush ( ) : Unit Posts a no-op task to the executor and blocks this thread waiting for it to complete. This can be useful in
+tests when you want to be sure that a previous task submitted via execute has completed.
+
+
+
+
+Companion Object Properties
+
+
+
+
+SAME_THREAD
+
+val SAME_THREAD : AffinityExecutor
+
+
+
+Inheritors
+
+
+
+
+Gate
+
+class Gate : AffinityExecutor An executor useful for unit tests: allows the current thread to block until a command arrives from another
+thread, which is then executed. Inbound closures/commands stack up until they are cleared by looping.
+
+
+
+
+ServiceAffinityExecutor
+
+class ServiceAffinityExecutor : AffinityExecutor , ThreadPoolExecutor An executor backed by thread pool (which may often have a single thread) which makes it easy to schedule
+tasks in the future and verify code is running on the executor.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-affinity-executor/is-on-thread.html b/docs/build/html/api/core.utilities/-affinity-executor/is-on-thread.html
new file mode 100644
index 0000000000..d8d7a70a7b
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-affinity-executor/is-on-thread.html
@@ -0,0 +1,16 @@
+
+
+AffinityExecutor.isOnThread -
+core.utilities / AffinityExecutor / isOnThread isOnThread
+abstract val isOnThread : Boolean Returns true if the current thread is equal to the thread this executor is backed by.
+BriefLogFormatter.<init> -
+core.utilities / BriefLogFormatter / <init> <init>
+BriefLogFormatter ( ) A Java logging formatter that writes more compact output than the default.
+BriefLogFormatter.format -
+core.utilities / BriefLogFormatter / format format
+fun format ( logRecord : LogRecord ) : String BriefLogFormatter -
+core.utilities / BriefLogFormatter BriefLogFormatter
+class BriefLogFormatter : Formatter A Java logging formatter that writes more compact output than the default.
+Constructors
+
+
+
+
+<init>
+
+BriefLogFormatter ( ) A Java logging formatter that writes more compact output than the default.
+
+
+
+
+Functions
+
+Companion Object Functions
+
+
+
+
+init
+
+fun init ( ) : Unit Configures JDK logging to use this class for everything.
+
+
+
+
+initVerbose
+
+fun initVerbose ( vararg loggerNames : String ) : Unit Takes a set of strings identifying logger names for which the logging level should be configured.
+If the logger name starts with a + or an ordinary character, the level is set to Level.ALL . If it starts
+with a - then logging is switched off.
+
+
+
+
+loggingOff
+
+fun loggingOff ( vararg names : String ) : Unit fun loggingOff ( vararg classes : KClass < * > ) : Unit
+
+
+
+loggingOn
+
+fun loggingOn ( vararg names : String ) : Unit fun loggingOn ( vararg classes : KClass < * > ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-brief-log-formatter/init-verbose.html b/docs/build/html/api/core.utilities/-brief-log-formatter/init-verbose.html
new file mode 100644
index 0000000000..920c2e131d
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-brief-log-formatter/init-verbose.html
@@ -0,0 +1,18 @@
+
+
+BriefLogFormatter.initVerbose -
+core.utilities / BriefLogFormatter / initVerbose initVerbose
+fun initVerbose ( vararg loggerNames : String ) : Unit Takes a set of strings identifying logger names for which the logging level should be configured.
+If the logger name starts with a + or an ordinary character, the level is set to Level.ALL . If it starts
+with a - then logging is switched off.
+BriefLogFormatter.init -
+core.utilities / BriefLogFormatter / init init
+fun init ( ) : Unit Configures JDK logging to use this class for everything.
+BriefLogFormatter.loggingOff -
+core.utilities / BriefLogFormatter / loggingOff loggingOff
+fun loggingOff ( vararg names : String ) : Unit fun loggingOff ( vararg classes : KClass < * > ) : Unit BriefLogFormatter.loggingOn -
+core.utilities / BriefLogFormatter / loggingOn loggingOn
+fun loggingOn ( vararg names : String ) : Unit fun loggingOn ( vararg classes : KClass < * > ) : Unit Emoji.CODE_BAG_OF_CASH -
+core.utilities / Emoji / CODE_BAG_OF_CASH CODE_BAG_OF_CASH
+const val CODE_BAG_OF_CASH : String Emoji.CODE_DIAMOND -
+core.utilities / Emoji / CODE_DIAMOND CODE_DIAMOND
+const val CODE_DIAMOND : String Emoji.CODE_GREEN_TICK -
+core.utilities / Emoji / CODE_GREEN_TICK CODE_GREEN_TICK
+const val CODE_GREEN_TICK : String Emoji.CODE_LEFT_ARROW -
+core.utilities / Emoji / CODE_LEFT_ARROW CODE_LEFT_ARROW
+const val CODE_LEFT_ARROW : String Emoji.CODE_NEWSPAPER -
+core.utilities / Emoji / CODE_NEWSPAPER CODE_NEWSPAPER
+const val CODE_NEWSPAPER : String Emoji.CODE_PAPERCLIP -
+core.utilities / Emoji / CODE_PAPERCLIP CODE_PAPERCLIP
+const val CODE_PAPERCLIP : String Emoji.CODE_RIGHT_ARROW -
+core.utilities / Emoji / CODE_RIGHT_ARROW CODE_RIGHT_ARROW
+const val CODE_RIGHT_ARROW : String Emoji.bagOfCash -
+core.utilities / Emoji / bagOfCash bagOfCash
+val bagOfCash : String Emoji.diamond -
+core.utilities / Emoji / diamond diamond
+val diamond : String Emoji.hasEmojiTerminal -
+core.utilities / Emoji / hasEmojiTerminal hasEmojiTerminal
+val hasEmojiTerminal : <ERROR CLASS> Emoji -
+core.utilities / Emoji Emoji
+object Emoji A simple wrapper class that contains icons and support for printing them only when were connected to a terminal.
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.utilities/-emoji/left-arrow.html b/docs/build/html/api/core.utilities/-emoji/left-arrow.html
new file mode 100644
index 0000000000..3cb0ac00af
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-emoji/left-arrow.html
@@ -0,0 +1,15 @@
+
+
+Emoji.leftArrow -
+core.utilities / Emoji / leftArrow leftArrow
+val leftArrow : String Emoji.newspaper -
+core.utilities / Emoji / newspaper newspaper
+val newspaper : String Emoji.paperclip -
+core.utilities / Emoji / paperclip paperclip
+val paperclip : String Emoji.renderIfSupported -
+core.utilities / Emoji / renderIfSupported renderIfSupported
+fun renderIfSupported ( obj : Any ) : String Emoji.rightArrow -
+core.utilities / Emoji / rightArrow rightArrow
+val rightArrow : String JsonSupport.CalendarDeserializer.deserialize -
+core.utilities / JsonSupport / CalendarDeserializer / deserialize deserialize
+fun deserialize ( parser : <ERROR CLASS> , context : <ERROR CLASS> ) : BusinessCalendar JsonSupport.CalendarDeserializer -
+core.utilities / JsonSupport / CalendarDeserializer CalendarDeserializer
+object CalendarDeserializer Functions
+
+
+
diff --git a/docs/build/html/api/core.utilities/-json-support/-local-date-deserializer/deserialize.html b/docs/build/html/api/core.utilities/-json-support/-local-date-deserializer/deserialize.html
new file mode 100644
index 0000000000..d37c9d3fb2
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-json-support/-local-date-deserializer/deserialize.html
@@ -0,0 +1,15 @@
+
+
+JsonSupport.LocalDateDeserializer.deserialize -
+core.utilities / JsonSupport / LocalDateDeserializer / deserialize deserialize
+fun deserialize ( parser : <ERROR CLASS> , context : <ERROR CLASS> ) : LocalDate JsonSupport.LocalDateDeserializer -
+core.utilities / JsonSupport / LocalDateDeserializer LocalDateDeserializer
+object LocalDateDeserializer Functions
+
+
+
+
+deserialize
+
+fun deserialize ( parser : <ERROR CLASS> , context : <ERROR CLASS> ) : LocalDate
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-json-support/-local-date-key-deserializer/deserialize-key.html b/docs/build/html/api/core.utilities/-json-support/-local-date-key-deserializer/deserialize-key.html
new file mode 100644
index 0000000000..e50468d71c
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-json-support/-local-date-key-deserializer/deserialize-key.html
@@ -0,0 +1,15 @@
+
+
+JsonSupport.LocalDateKeyDeserializer.deserializeKey -
+core.utilities / JsonSupport / LocalDateKeyDeserializer / deserializeKey deserializeKey
+fun deserializeKey ( text : String , p1 : <ERROR CLASS> ) : Any ? JsonSupport.LocalDateKeyDeserializer -
+core.utilities / JsonSupport / LocalDateKeyDeserializer LocalDateKeyDeserializer
+object LocalDateKeyDeserializer Functions
+
+
+
+
+deserializeKey
+
+fun deserializeKey ( text : String , p1 : <ERROR CLASS> ) : Any ?
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-json-support/-party-deserializer/deserialize.html b/docs/build/html/api/core.utilities/-json-support/-party-deserializer/deserialize.html
new file mode 100644
index 0000000000..c68cf8b545
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-json-support/-party-deserializer/deserialize.html
@@ -0,0 +1,15 @@
+
+
+JsonSupport.PartyDeserializer.deserialize -
+core.utilities / JsonSupport / PartyDeserializer / deserialize deserialize
+fun deserialize ( parser : <ERROR CLASS> , context : <ERROR CLASS> ) : Party JsonSupport.PartyDeserializer -
+core.utilities / JsonSupport / PartyDeserializer PartyDeserializer
+object PartyDeserializer Functions
+
+
+
+
+deserialize
+
+fun deserialize ( parser : <ERROR CLASS> , context : <ERROR CLASS> ) : Party
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-json-support/-party-serializer/index.html b/docs/build/html/api/core.utilities/-json-support/-party-serializer/index.html
new file mode 100644
index 0000000000..c61545a84b
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-json-support/-party-serializer/index.html
@@ -0,0 +1,25 @@
+
+
+JsonSupport.PartySerializer -
+core.utilities / JsonSupport / PartySerializer PartySerializer
+object PartySerializer Functions
+
+
+
+
+serialize
+
+fun serialize ( obj : Party , generator : <ERROR CLASS> , provider : <ERROR CLASS> ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-json-support/-party-serializer/serialize.html b/docs/build/html/api/core.utilities/-json-support/-party-serializer/serialize.html
new file mode 100644
index 0000000000..f90ee398bb
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-json-support/-party-serializer/serialize.html
@@ -0,0 +1,15 @@
+
+
+JsonSupport.PartySerializer.serialize -
+core.utilities / JsonSupport / PartySerializer / serialize serialize
+fun serialize ( obj : Party , generator : <ERROR CLASS> , provider : <ERROR CLASS> ) : Unit JsonSupport.SecureHashDeserializer.<init> -
+core.utilities / JsonSupport / SecureHashDeserializer / <init> <init>
+SecureHashDeserializer ( ) Implemented as a class so that we can instantiate for T
+JsonSupport.SecureHashDeserializer.deserialize -
+core.utilities / JsonSupport / SecureHashDeserializer / deserialize deserialize
+fun deserialize ( parser : <ERROR CLASS> , context : <ERROR CLASS> ) : T JsonSupport.SecureHashDeserializer -
+core.utilities / JsonSupport / SecureHashDeserializer SecureHashDeserializer
+class SecureHashDeserializer < T : SecureHash > Implemented as a class so that we can instantiate for T
+Constructors
+
+
+
+
+<init>
+
+SecureHashDeserializer ( ) Implemented as a class so that we can instantiate for T
+
+
+
+
+Functions
+
+
+
+
+deserialize
+
+fun deserialize ( parser : <ERROR CLASS> , context : <ERROR CLASS> ) : T
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-json-support/-secure-hash-serializer/index.html b/docs/build/html/api/core.utilities/-json-support/-secure-hash-serializer/index.html
new file mode 100644
index 0000000000..2b33a2ba62
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-json-support/-secure-hash-serializer/index.html
@@ -0,0 +1,25 @@
+
+
+JsonSupport.SecureHashSerializer -
+core.utilities / JsonSupport / SecureHashSerializer SecureHashSerializer
+object SecureHashSerializer Functions
+
+
+
+
+serialize
+
+fun serialize ( obj : SecureHash , generator : <ERROR CLASS> , provider : <ERROR CLASS> ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-json-support/-secure-hash-serializer/serialize.html b/docs/build/html/api/core.utilities/-json-support/-secure-hash-serializer/serialize.html
new file mode 100644
index 0000000000..1a05012083
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-json-support/-secure-hash-serializer/serialize.html
@@ -0,0 +1,15 @@
+
+
+JsonSupport.SecureHashSerializer.serialize -
+core.utilities / JsonSupport / SecureHashSerializer / serialize serialize
+fun serialize ( obj : SecureHash , generator : <ERROR CLASS> , provider : <ERROR CLASS> ) : Unit JsonSupport.ServiceHubObjectMapper.<init> -
+core.utilities / JsonSupport / ServiceHubObjectMapper / <init> <init>
+ServiceHubObjectMapper ( identities : IdentityService ) JsonSupport.ServiceHubObjectMapper.identities -
+core.utilities / JsonSupport / ServiceHubObjectMapper / identities identities
+val identities : IdentityService JsonSupport.ServiceHubObjectMapper -
+core.utilities / JsonSupport / ServiceHubObjectMapper ServiceHubObjectMapper
+class ServiceHubObjectMapper Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core.utilities/-json-support/-to-string-serializer/index.html b/docs/build/html/api/core.utilities/-json-support/-to-string-serializer/index.html
new file mode 100644
index 0000000000..de4d71944a
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-json-support/-to-string-serializer/index.html
@@ -0,0 +1,25 @@
+
+
+JsonSupport.ToStringSerializer -
+core.utilities / JsonSupport / ToStringSerializer ToStringSerializer
+object ToStringSerializer Functions
+
+
+
+
+serialize
+
+fun serialize ( obj : Any , generator : <ERROR CLASS> , provider : <ERROR CLASS> ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-json-support/-to-string-serializer/serialize.html b/docs/build/html/api/core.utilities/-json-support/-to-string-serializer/serialize.html
new file mode 100644
index 0000000000..f922a020db
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-json-support/-to-string-serializer/serialize.html
@@ -0,0 +1,15 @@
+
+
+JsonSupport.ToStringSerializer.serialize -
+core.utilities / JsonSupport / ToStringSerializer / serialize serialize
+fun serialize ( obj : Any , generator : <ERROR CLASS> , provider : <ERROR CLASS> ) : Unit JsonSupport.createDefaultMapper -
+core.utilities / JsonSupport / createDefaultMapper createDefaultMapper
+fun createDefaultMapper ( identities : IdentityService ) : <ERROR CLASS> JsonSupport -
+core.utilities / JsonSupport JsonSupport
+object JsonSupport Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for
+the java.time API, some core types, and Kotlin data classes.
+Types
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/-init-.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/-init-.html
new file mode 100644
index 0000000000..d27ac99cd8
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/-init-.html
@@ -0,0 +1,14 @@
+
+
+ProgressTracker.Change.Position.<init> -
+core.utilities / ProgressTracker / Change / Position / <init> <init>
+Position ( tracker : ProgressTracker , newStep : Step ) ProgressTracker.Change.Position -
+core.utilities / ProgressTracker / Change / Position Position
+class Position : Change Constructors
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/new-step.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/new-step.html
new file mode 100644
index 0000000000..7b00c5d886
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/new-step.html
@@ -0,0 +1,15 @@
+
+
+ProgressTracker.Change.Position.newStep -
+core.utilities / ProgressTracker / Change / Position / newStep newStep
+val newStep : Step ProgressTracker.Change.Position.toString -
+core.utilities / ProgressTracker / Change / Position / toString toString
+fun toString ( ) : String ProgressTracker.Change.Position.tracker -
+core.utilities / ProgressTracker / Change / Position / tracker tracker
+val tracker : ProgressTracker ProgressTracker.Change.Rendering.<init> -
+core.utilities / ProgressTracker / Change / Rendering / <init> <init>
+Rendering ( tracker : ProgressTracker , ofStep : Step ) ProgressTracker.Change.Rendering -
+core.utilities / ProgressTracker / Change / Rendering Rendering
+class Rendering : Change Constructors
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/of-step.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/of-step.html
new file mode 100644
index 0000000000..13ef31091d
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/of-step.html
@@ -0,0 +1,15 @@
+
+
+ProgressTracker.Change.Rendering.ofStep -
+core.utilities / ProgressTracker / Change / Rendering / ofStep ofStep
+val ofStep : Step ProgressTracker.Change.Rendering.toString -
+core.utilities / ProgressTracker / Change / Rendering / toString toString
+fun toString ( ) : String ProgressTracker.Change.Rendering.tracker -
+core.utilities / ProgressTracker / Change / Rendering / tracker tracker
+val tracker : ProgressTracker ProgressTracker.Change.Structural.<init> -
+core.utilities / ProgressTracker / Change / Structural / <init> <init>
+Structural ( tracker : ProgressTracker , parent : Step ) ProgressTracker.Change.Structural -
+core.utilities / ProgressTracker / Change / Structural Structural
+class Structural : Change Constructors
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/parent.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/parent.html
new file mode 100644
index 0000000000..f3cad7fa8e
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/parent.html
@@ -0,0 +1,15 @@
+
+
+ProgressTracker.Change.Structural.parent -
+core.utilities / ProgressTracker / Change / Structural / parent parent
+val parent : Step ProgressTracker.Change.Structural.toString -
+core.utilities / ProgressTracker / Change / Structural / toString toString
+fun toString ( ) : String ProgressTracker.Change.Structural.tracker -
+core.utilities / ProgressTracker / Change / Structural / tracker tracker
+val tracker : ProgressTracker ProgressTracker.Change -
+core.utilities / ProgressTracker / Change Change
+sealed class Change Types
+
+
+
+
+Position
+
+class Position : Change
+
+
+
+Rendering
+
+class Rendering : Change
+
+
+
+Structural
+
+class Structural : Change
+
+
+
+Inheritors
+
+
+
+
+Position
+
+class Position : Change
+
+
+
+Rendering
+
+class Rendering : Change
+
+
+
+Structural
+
+class Structural : Change
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-d-o-n-e/equals.html b/docs/build/html/api/core.utilities/-progress-tracker/-d-o-n-e/equals.html
new file mode 100644
index 0000000000..e7f798c1e2
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/-d-o-n-e/equals.html
@@ -0,0 +1,15 @@
+
+
+ProgressTracker.DONE.equals -
+core.utilities / ProgressTracker / DONE / equals equals
+fun equals ( other : Any ? ) : Boolean ProgressTracker.DONE -
+core.utilities / ProgressTracker / DONE DONE
+object DONE : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+Functions
+
+
+
+
+equals
+
+fun equals ( other : Any ? ) : Boolean
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-init-.html b/docs/build/html/api/core.utilities/-progress-tracker/-init-.html
new file mode 100644
index 0000000000..e369c39d71
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/-init-.html
@@ -0,0 +1,32 @@
+
+
+ProgressTracker.<init> -
+core.utilities / ProgressTracker / <init> <init>
+ProgressTracker ( vararg steps : Step ) A progress tracker helps surface information about the progress of an operation to a user interface or API of some
+kind. It lets you define a set of steps that represent an operation. A step is represented by an object (typically
+a singleton).
+Steps may logically be children of other steps, which models the case where a large top level operation involves
+sub-operations which may also have a notion of progress. If a step has children, then the tracker will report the
+steps children as the "next step" after the parent. In other words, a parent step is considered to involve actual
+reportable work and is a thing. If the parent step simply groups other steps, then youll have to step over it
+manually.
+Each step has a label. It is assumed by default that the label does not change. If you want a label to change, then
+you can emit a ProgressTracker.Change.Rendering object on the ProgressTracker.Step.changes observable stream
+after it changes. That object will propagate through to the top level trackers changes stream, which renderers can
+subscribe to in order to learn about progress.
+An operation can move both forwards and backwards through steps, thus, a ProgressTracker can represent operations
+that include loops.
+A progress tracker is not thread safe. You may move events from the thread making progress to another thread by
+using the Observable subscribeOn call.
+ProgressTracker.RelabelableStep.<init> -
+core.utilities / ProgressTracker / RelabelableStep / <init> <init>
+RelabelableStep ( currentLabel : String ) This class makes it easier to relabel a step on the fly, to provide transient information.
+ProgressTracker.RelabelableStep.changes -
+core.utilities / ProgressTracker / RelabelableStep / changes changes
+open val changes : <ERROR CLASS> Step.changes ProgressTracker.RelabelableStep.currentLabel -
+core.utilities / ProgressTracker / RelabelableStep / currentLabel currentLabel
+var currentLabel : String ProgressTracker.RelabelableStep -
+core.utilities / ProgressTracker / RelabelableStep RelabelableStep
+inner class RelabelableStep : Step This class makes it easier to relabel a step on the fly, to provide transient information.
+Constructors
+
+
+
+
+<init>
+
+RelabelableStep ( currentLabel : String ) This class makes it easier to relabel a step on the fly, to provide transient information.
+
+
+
+
+Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS>
+
+
+
+currentLabel
+
+var currentLabel : String
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/label.html b/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/label.html
new file mode 100644
index 0000000000..4d497ea609
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/label.html
@@ -0,0 +1,16 @@
+
+
+ProgressTracker.RelabelableStep.label -
+core.utilities / ProgressTracker / RelabelableStep / label label
+open val label : String Step.label ProgressTracker.Step.<init> -
+core.utilities / ProgressTracker / Step / <init> <init>
+Step ( label : String ) The superclass of all step objects.
+ProgressTracker.Step.changes -
+core.utilities / ProgressTracker / Step / changes changes
+open val changes : <ERROR CLASS> < Change > ProgressTracker.Step -
+core.utilities / ProgressTracker / Step Step
+class Step The superclass of all step objects.
+Constructors
+
+
+
+
+<init>
+
+Step ( label : String ) The superclass of all step objects.
+
+
+
+
+Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-step/label.html b/docs/build/html/api/core.utilities/-progress-tracker/-step/label.html
new file mode 100644
index 0000000000..5d74fe0889
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/-step/label.html
@@ -0,0 +1,15 @@
+
+
+ProgressTracker.Step.label -
+core.utilities / ProgressTracker / Step / label label
+open val label : String ProgressTracker.UNSTARTED.equals -
+core.utilities / ProgressTracker / UNSTARTED / equals equals
+fun equals ( other : Any ? ) : Boolean ProgressTracker.UNSTARTED -
+core.utilities / ProgressTracker / UNSTARTED UNSTARTED
+object UNSTARTED : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+Functions
+
+
+
+
+equals
+
+fun equals ( other : Any ? ) : Boolean
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/all-steps.html b/docs/build/html/api/core.utilities/-progress-tracker/all-steps.html
new file mode 100644
index 0000000000..20fa748bfb
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/all-steps.html
@@ -0,0 +1,17 @@
+
+
+ProgressTracker.allSteps -
+core.utilities / ProgressTracker / allSteps allSteps
+val allSteps : List < <ERROR CLASS> < Int , Step > > A list of all steps in this ProgressTracker and the children, with the indent level provided starting at zero.
+Note that UNSTARTED is never counted, and DONE is only counted at the calling level.
+ProgressTracker.changes -
+core.utilities / ProgressTracker / changes changes
+val changes : <ERROR CLASS> < Change > An observable stream of changes: includes child steps, resets and any changes emitted by individual steps (e.g.
+if a step changed its label or rendering).
+ProgressTracker.childrenFor -
+core.utilities / ProgressTracker / childrenFor childrenFor
+var childrenFor : HashMap < Step , ProgressTracker > Writable map that lets you insert child ProgressTracker s for particular steps. Its OK to edit this even
+after a progress tracker has been started.
+ProgressTracker.currentStepRecursive -
+core.utilities / ProgressTracker / currentStepRecursive currentStepRecursive
+val currentStepRecursive : Step Returns the current step, descending into children to find the deepest step we are up to.
+ProgressTracker.currentStep -
+core.utilities / ProgressTracker / currentStep currentStep
+var currentStep : Step Reading returns the value of stepsstepIndex , writing moves the position of the current tracker. Once moved to
+the DONE state, this tracker is finished and the current step cannot be moved again.
+ProgressTracker -
+core.utilities / ProgressTracker ProgressTracker
+class ProgressTracker A progress tracker helps surface information about the progress of an operation to a user interface or API of some
+kind. It lets you define a set of steps that represent an operation. A step is represented by an object (typically
+a singleton).
+Steps may logically be children of other steps, which models the case where a large top level operation involves
+sub-operations which may also have a notion of progress. If a step has children, then the tracker will report the
+steps children as the "next step" after the parent. In other words, a parent step is considered to involve actual
+reportable work and is a thing. If the parent step simply groups other steps, then youll have to step over it
+manually.
+Each step has a label. It is assumed by default that the label does not change. If you want a label to change, then
+you can emit a ProgressTracker.Change.Rendering object on the ProgressTracker.Step.changes observable stream
+after it changes. That object will propagate through to the top level trackers changes stream, which renderers can
+subscribe to in order to learn about progress.
+An operation can move both forwards and backwards through steps, thus, a ProgressTracker can represent operations
+that include loops.
+A progress tracker is not thread safe. You may move events from the thread making progress to another thread by
+using the Observable subscribeOn call.
+Types
+
+
+
+
+Change
+
+sealed class Change
+
+
+
+DONE
+
+object DONE : Step
+
+
+
+RelabelableStep
+
+inner class RelabelableStep : Step This class makes it easier to relabel a step on the fly, to provide transient information.
+
+
+
+
+Step
+
+class Step The superclass of all step objects.
+
+
+
+
+UNSTARTED
+
+object UNSTARTED : Step
+
+
+
+Constructors
+
+
+
+
+<init>
+
+ProgressTracker ( vararg steps : Step ) A progress tracker helps surface information about the progress of an operation to a user interface or API of some
+kind. It lets you define a set of steps that represent an operation. A step is represented by an object (typically
+a singleton).
+
+
+
+
+Properties
+
+
+
+
+allSteps
+
+val allSteps : List < <ERROR CLASS> < Int , Step > > A list of all steps in this ProgressTracker and the children, with the indent level provided starting at zero.
+Note that UNSTARTED is never counted, and DONE is only counted at the calling level.
+
+
+
+
+changes
+
+val changes : <ERROR CLASS> < Change > An observable stream of changes: includes child steps, resets and any changes emitted by individual steps (e.g.
+if a step changed its label or rendering).
+
+
+
+
+childrenFor
+
+var childrenFor : HashMap < Step , ProgressTracker > Writable map that lets you insert child ProgressTrackers for particular steps. Its OK to edit this even
+after a progress tracker has been started.
+
+
+
+
+currentStep
+
+var currentStep : Step Reading returns the value of stepsstepIndex , writing moves the position of the current tracker. Once moved to
+the DONE state, this tracker is finished and the current step cannot be moved again.
+
+
+
+
+currentStepRecursive
+
+val currentStepRecursive : Step Returns the current step, descending into children to find the deepest step we are up to.
+
+
+
+
+parent
+
+var parent : ProgressTracker ? The parent of this tracker: set automatically by the parent when a tracker is added as a child
+
+
+
+
+stepIndex
+
+var stepIndex : Int The zero-based index of the current step in the steps array (i.e. with UNSTARTED and DONE)
+
+
+
+
+steps
+
+val steps : Array < Step > The steps in this tracker, same as the steps passed to the constructor but with UNSTARTED and DONE inserted.
+
+
+
+
+topLevelTracker
+
+val topLevelTracker : ProgressTracker Walks up the tree to find the top level tracker. If this is the top level tracker, returns this
+
+
+
+
+Functions
+
+
+
+
+nextStep
+
+fun nextStep ( ) : Step Iterates the progress tracker. If the current step has a child, the child is iterated instead (recursively).
+Returns the latest step at the bottom of the step tree.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-progress-tracker/next-step.html b/docs/build/html/api/core.utilities/-progress-tracker/next-step.html
new file mode 100644
index 0000000000..986e9481c6
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-progress-tracker/next-step.html
@@ -0,0 +1,17 @@
+
+
+ProgressTracker.nextStep -
+core.utilities / ProgressTracker / nextStep nextStep
+fun nextStep ( ) : Step Iterates the progress tracker. If the current step has a child, the child is iterated instead (recursively).
+Returns the latest step at the bottom of the step tree.
+ProgressTracker.parent -
+core.utilities / ProgressTracker / parent parent
+var parent : ProgressTracker ? The parent of this tracker: set automatically by the parent when a tracker is added as a child
+ProgressTracker.stepIndex -
+core.utilities / ProgressTracker / stepIndex stepIndex
+var stepIndex : Int The zero-based index of the current step in the steps array (i.e. with UNSTARTED and DONE)
+ProgressTracker.steps -
+core.utilities / ProgressTracker / steps steps
+val steps : Array < Step > The steps in this tracker, same as the steps passed to the constructor but with UNSTARTED and DONE inserted.
+ProgressTracker.topLevelTracker -
+core.utilities / ProgressTracker / topLevelTracker topLevelTracker
+val topLevelTracker : ProgressTracker Walks up the tree to find the top level tracker. If this is the top level tracker, returns this
+RecordingMap.Get.<init> -
+core.utilities / RecordingMap / Get / <init> <init>
+Get ( key : K ) RecordingMap.Get -
+core.utilities / RecordingMap / Get Get
+data class Get < K > : Record Constructors
+
+
+
+
+<init>
+
+Get ( key : K )
+
+
+
+Properties
+
+
+
+
+key
+
+val key : K
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-recording-map/-get/key.html b/docs/build/html/api/core.utilities/-recording-map/-get/key.html
new file mode 100644
index 0000000000..2258527a9f
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-recording-map/-get/key.html
@@ -0,0 +1,15 @@
+
+
+RecordingMap.Get.key -
+core.utilities / RecordingMap / Get / key key
+val key : K RecordingMap.<init> -
+core.utilities / RecordingMap / <init> <init>
+RecordingMap ( wrappedMap : MutableMap < K , V > , logger : <ERROR CLASS> = loggerFor<RecordingMap<K, V>>()) A RecordingMap wraps a regular Map<K, V> and records the sequence of gets and puts to it. This is useful in
+white box unit tests to ensure that code is accessing a data store as much as you expect.
+Note: although this class itself thread safe, if the underlying map is not, then this class loses its thread safety.
+RecordingMap.Put.<init> -
+core.utilities / RecordingMap / Put / <init> <init>
+Put ( key : K , value : V ) RecordingMap.Put -
+core.utilities / RecordingMap / Put Put
+data class Put < K , V > : Record Constructors
+
+
+
+
+<init>
+
+Put ( key : K , value : V )
+
+
+
+Properties
+
+
+
+
+key
+
+val key : K
+
+
+
+value
+
+val value : V
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-recording-map/-put/key.html b/docs/build/html/api/core.utilities/-recording-map/-put/key.html
new file mode 100644
index 0000000000..7681d678d6
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-recording-map/-put/key.html
@@ -0,0 +1,15 @@
+
+
+RecordingMap.Put.key -
+core.utilities / RecordingMap / Put / key key
+val key : K RecordingMap.Put.value -
+core.utilities / RecordingMap / Put / value value
+val value : V RecordingMap.Record -
+core.utilities / RecordingMap / Record Record
+interface Record Inheritors
+
+
+
+
+Get
+
+data class Get < K > : Record
+
+
+
+Put
+
+data class Put < K , V > : Record
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-recording-map/clear-records.html b/docs/build/html/api/core.utilities/-recording-map/clear-records.html
new file mode 100644
index 0000000000..0df3fef3bb
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-recording-map/clear-records.html
@@ -0,0 +1,15 @@
+
+
+RecordingMap.clearRecords -
+core.utilities / RecordingMap / clearRecords clearRecords
+fun clearRecords ( ) : Unit RecordingMap.get -
+core.utilities / RecordingMap / get get
+fun get ( key : K ) : V ? RecordingMap -
+core.utilities / RecordingMap RecordingMap
+class RecordingMap < K , V > : MutableMap < K , V > A RecordingMap wraps a regular Map<K, V> and records the sequence of gets and puts to it. This is useful in
+white box unit tests to ensure that code is accessing a data store as much as you expect.
+Note: although this class itself thread safe, if the underlying map is not, then this class loses its thread safety.
+Types
+
+
+
+
+Get
+
+data class Get < K > : Record
+
+
+
+Put
+
+data class Put < K , V > : Record
+
+
+
+Record
+
+interface Record
+
+
+
+Constructors
+
+
+
+
+<init>
+
+RecordingMap ( wrappedMap : MutableMap < K , V > , logger : <ERROR CLASS> = loggerFor<RecordingMap<K, V>>()) A RecordingMap wraps a regular Map<K, V> and records the sequence of gets and puts to it. This is useful in
+white box unit tests to ensure that code is accessing a data store as much as you expect.
+
+
+
+
+Properties
+
+
+
+
+records
+
+val records : List < Record > Returns a snapshot of the set of records
+
+
+
+
+Functions
+
+
+
+
+clearRecords
+
+fun clearRecords ( ) : Unit
+
+
+
+get
+
+fun get ( key : K ) : V ?
+
+
+
+put
+
+fun put ( key : K , value : V ) : V ?
+
+
+
+putAll
+
+fun putAll ( from : Map < out K , V > ) : Unit
+
+
+
+putAllUnrecorded
+
+fun putAllUnrecorded ( from : Map < out K , V > ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-recording-map/put-all-unrecorded.html b/docs/build/html/api/core.utilities/-recording-map/put-all-unrecorded.html
new file mode 100644
index 0000000000..e173ae5e6e
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-recording-map/put-all-unrecorded.html
@@ -0,0 +1,15 @@
+
+
+RecordingMap.putAllUnrecorded -
+core.utilities / RecordingMap / putAllUnrecorded putAllUnrecorded
+fun putAllUnrecorded ( from : Map < out K , V > ) : Unit RecordingMap.putAll -
+core.utilities / RecordingMap / putAll putAll
+fun putAll ( from : Map < out K , V > ) : Unit RecordingMap.put -
+core.utilities / RecordingMap / put put
+fun put ( key : K , value : V ) : V ? RecordingMap.records -
+core.utilities / RecordingMap / records records
+val records : List < Record > Returns a snapshot of the set of records
+UntrustworthyData.<init> -
+core.utilities / UntrustworthyData / <init> <init>
+UntrustworthyData ( fromUntrustedWorld : T ) A small utility to approximate taint tracking: if a method gives you back one of these, it means the data came from
+a remote source that may be incentivised to pass us junk that violates basic assumptions and thus must be checked
+first. The wrapper helps you to avoid forgetting this vital step. Things you might want to check are:
+Is this object the one you actually expected? Did the other side hand you back something technically valid but
+not what you asked for?
+Is the object disobeying its own invariants?
+Are any objects reachable from this object mismatched or not what you expected?
+Is it suspiciously large or small?
+UntrustworthyData.data -
+core.utilities / UntrustworthyData / data data
+val data : T UntrustworthyData -
+core.utilities / UntrustworthyData UntrustworthyData
+class UntrustworthyData < T > A small utility to approximate taint tracking: if a method gives you back one of these, it means the data came from
+a remote source that may be incentivised to pass us junk that violates basic assumptions and thus must be checked
+first. The wrapper helps you to avoid forgetting this vital step. Things you might want to check are:
+Is this object the one you actually expected? Did the other side hand you back something technically valid but
+not what you asked for?
+Is the object disobeying its own invariants?
+Are any objects reachable from this object mismatched or not what you expected?
+Is it suspiciously large or small?
+Constructors
+
+
+
+
+<init>
+
+UntrustworthyData ( fromUntrustedWorld : T ) A small utility to approximate taint tracking: if a method gives you back one of these, it means the data came from
+a remote source that may be incentivised to pass us junk that violates basic assumptions and thus must be checked
+first. The wrapper helps you to avoid forgetting this vital step. Things you might want to check are:
+
+
+
+
+Properties
+
+
+
+
+data
+
+val data : T
+
+
+
+Functions
+
+
+
+
+validate
+
+fun < R > validate ( validator : ( T ) -> R ) : R
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/-untrustworthy-data/validate.html b/docs/build/html/api/core.utilities/-untrustworthy-data/validate.html
new file mode 100644
index 0000000000..4845c1bb56
--- /dev/null
+++ b/docs/build/html/api/core.utilities/-untrustworthy-data/validate.html
@@ -0,0 +1,15 @@
+
+
+UntrustworthyData.validate -
+core.utilities / UntrustworthyData / validate validate
+inline fun < R > validate ( validator : ( T ) -> R ) : R core.utilities -
+core.utilities Package core.utilities
+Types
+
+
+
+
+ANSIProgressRenderer
+
+object ANSIProgressRenderer Knows how to render a ProgressTracker to the terminal using coloured, emoji-fied output. Useful when writing small
+command line tools, demos, tests etc. Just set the progressTracker field and it will go ahead and start drawing
+if the terminal supports it. Otherwise it just prints out the name of the step whenever it changes.
+
+
+
+
+AddOrRemove
+
+enum class AddOrRemove Enum for when adding/removing something, for example adding or removing an entry in a directory.
+
+
+
+
+AffinityExecutor
+
+interface AffinityExecutor : Executor An extended executor interface that supports thread affinity assertions and short circuiting. This can be useful
+for ensuring code runs on the right thread, and also for unit testing.
+
+
+
+
+BriefLogFormatter
+
+class BriefLogFormatter : Formatter A Java logging formatter that writes more compact output than the default.
+
+
+
+
+Emoji
+
+object Emoji A simple wrapper class that contains icons and support for printing them only when were connected to a terminal.
+
+
+
+
+JsonSupport
+
+object JsonSupport Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for
+the java.time API, some core types, and Kotlin data classes.
+
+
+
+
+ProgressTracker
+
+class ProgressTracker A progress tracker helps surface information about the progress of an operation to a user interface or API of some
+kind. It lets you define a set of steps that represent an operation. A step is represented by an object (typically
+a singleton).
+
+
+
+
+RecordingMap
+
+class RecordingMap < K , V > : MutableMap < K , V > A RecordingMap wraps a regular Map<K, V> and records the sequence of gets and puts to it. This is useful in
+white box unit tests to ensure that code is accessing a data store as much as you expect.
+
+
+
+
+UntrustworthyData
+
+class UntrustworthyData < T > A small utility to approximate taint tracking: if a method gives you back one of these, it means the data came from
+a remote source that may be incentivised to pass us junk that violates basic assumptions and thus must be checked
+first. The wrapper helps you to avoid forgetting this vital step. Things you might want to check are:
+
+
+
+
+Functions
+
+
+
+
+loggerFor
+
+fun < T : Any > loggerFor ( ) : <ERROR CLASS>
+
+
+
+trace
+
+fun <ERROR CLASS> . trace ( msg : ( ) -> String ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core.utilities/logger-for.html b/docs/build/html/api/core.utilities/logger-for.html
new file mode 100644
index 0000000000..bac5e99b46
--- /dev/null
+++ b/docs/build/html/api/core.utilities/logger-for.html
@@ -0,0 +1,15 @@
+
+
+loggerFor -
+core.utilities / loggerFor loggerFor
+inline fun < reified T : Any > loggerFor ( ) : <ERROR CLASS> trace -
+core.utilities / trace trace
+inline fun <ERROR CLASS> . trace ( msg : ( ) -> String ) : Unit AccrualAdjustment.Adjusted -
+core / AccrualAdjustment / Adjusted Adjusted
+Adjusted AccrualAdjustment.Unadjusted -
+core / AccrualAdjustment / Unadjusted Unadjusted
+Unadjusted AccrualAdjustment -
+core / AccrualAdjustment AccrualAdjustment
+enum class AccrualAdjustment Simple enum for returning accurals adjusted or unadjusted.
+We dont actually do anything with this yet though, so its ignored for now.
+Enum Values
+
+
+
diff --git a/docs/build/html/api/core/-amount/-init-.html b/docs/build/html/api/core/-amount/-init-.html
new file mode 100644
index 0000000000..52662cb8d0
--- /dev/null
+++ b/docs/build/html/api/core/-amount/-init-.html
@@ -0,0 +1,30 @@
+
+
+Amount.<init> -
+core / Amount / <init> <init>
+Amount ( amount : BigDecimal , currency : Currency ) Amount ( pennies : Long , currency : Currency ) Amount represents a positive quantity of currency, measured in pennies, which are the smallest representable units.
+Note that "pennies" are not necessarily 1/100ths of a currency unit, but are the actual smallest amount used in
+whatever currency the amount represents.
+Amounts of different currencies do not mix and attempting to add or subtract two amounts of different currencies
+will throw IllegalArgumentException . Amounts may not be negative. Amounts are represented internally using a signed
+64 bit value, therefore, the maximum expressable amount is 2^63 - 1 == Long.MAX_VALUE. Addition, subtraction and
+multiplication are overflow checked and will throw ArithmeticException if the operation would have caused integer
+overflow.
+TODO: It may make sense to replace this with convenience extensions over the JSR 354 MonetaryAmount interface
+TODO: Should amount be abstracted to cover things like quantities of a stock, bond, commercial paper etc? Probably.
+TODO: Think about how positive-only vs positive-or-negative amounts can be represented in the type system.
+Amount.compareTo -
+core / Amount / compareTo compareTo
+fun compareTo ( other : Amount ) : Int Amount.currency -
+core / Amount / currency currency
+val currency : Currency Amount.div -
+core / Amount / div div
+operator fun div ( other : Long ) : Amount operator fun div ( other : Int ) : Amount Amount -
+core / Amount Amount
+data class Amount : Comparable < Amount > Amount represents a positive quantity of currency, measured in pennies, which are the smallest representable units.
+Note that "pennies" are not necessarily 1/100ths of a currency unit, but are the actual smallest amount used in
+whatever currency the amount represents.
+Amounts of different currencies do not mix and attempting to add or subtract two amounts of different currencies
+will throw IllegalArgumentException . Amounts may not be negative. Amounts are represented internally using a signed
+64 bit value, therefore, the maximum expressable amount is 2^63 - 1 == Long.MAX_VALUE. Addition, subtraction and
+multiplication are overflow checked and will throw ArithmeticException if the operation would have caused integer
+overflow.
+TODO: It may make sense to replace this with convenience extensions over the JSR 354 MonetaryAmount interface
+TODO: Should amount be abstracted to cover things like quantities of a stock, bond, commercial paper etc? Probably.
+TODO: Think about how positive-only vs positive-or-negative amounts can be represented in the type system.
+Constructors
+
+
+
+
+<init>
+
+Amount ( amount : BigDecimal , currency : Currency ) Amount ( pennies : Long , currency : Currency ) Amount represents a positive quantity of currency, measured in pennies, which are the smallest representable units.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+compareTo
+
+fun compareTo ( other : Amount ) : Int
+
+
+
+div
+
+operator fun div ( other : Long ) : Amount operator fun div ( other : Int ) : Amount
+
+
+
+minus
+
+operator fun minus ( other : Amount ) : Amount
+
+
+
+plus
+
+operator fun plus ( other : Amount ) : Amount
+
+
+
+times
+
+operator fun times ( other : Long ) : Amount operator fun times ( other : Int ) : Amount
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+Extension Functions
+
+
+
+
+times
+
+operator fun Amount . times ( other : RatioUnit ) : Amount
+
+
+
+
+
diff --git a/docs/build/html/api/core/-amount/minus.html b/docs/build/html/api/core/-amount/minus.html
new file mode 100644
index 0000000000..7b46b0b7b8
--- /dev/null
+++ b/docs/build/html/api/core/-amount/minus.html
@@ -0,0 +1,15 @@
+
+
+Amount.minus -
+core / Amount / minus minus
+operator fun minus ( other : Amount ) : Amount Amount.pennies -
+core / Amount / pennies pennies
+val pennies : Long Amount.plus -
+core / Amount / plus plus
+operator fun plus ( other : Amount ) : Amount Amount.times -
+core / Amount / times times
+operator fun times ( other : Long ) : Amount operator fun times ( other : Int ) : Amount Amount.toString -
+core / Amount / toString toString
+fun toString ( ) : String Attachment.extractFile -
+core / Attachment / extractFile extractFile
+open fun extractFile ( : String , : OutputStream ) : Unit Finds the named file case insensitively and copies it to the output stream.
+Exceptions
+FileNotFoundException - if the given path doesnt exist in the attachment.Attachment -
+core / Attachment Attachment
+interface Attachment : NamedByHash An attachment is a ZIP (or an optionally signed JAR) that contains one or more files. Attachments are meant to
+contain public static data which can be referenced from transactions and utilised from contracts. Good examples
+of how attachments are meant to be used include:
+Inherited Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-attachment/open-as-j-a-r.html b/docs/build/html/api/core/-attachment/open-as-j-a-r.html
new file mode 100644
index 0000000000..d4861d6f58
--- /dev/null
+++ b/docs/build/html/api/core/-attachment/open-as-j-a-r.html
@@ -0,0 +1,15 @@
+
+
+Attachment.openAsJAR -
+core / Attachment / openAsJAR openAsJAR
+open fun openAsJAR ( ) : JarInputStream Attachment.open -
+core / Attachment / open open
+abstract fun open ( ) : InputStream AuthenticatedObject.<init> -
+core / AuthenticatedObject / <init> <init>
+AuthenticatedObject ( signers : List < PublicKey > , signingParties : List < Party > , value : T ) Wraps an object that was signed by a public key, which may be a well known/recognised institutional key.
+AuthenticatedObject -
+core / AuthenticatedObject AuthenticatedObject
+data class AuthenticatedObject < out T : Any > Wraps an object that was signed by a public key, which may be a well known/recognised institutional key.
+Constructors
+
+
+
+
+<init>
+
+AuthenticatedObject ( signers : List < PublicKey > , signingParties : List < Party > , value : T ) Wraps an object that was signed by a public key, which may be a well known/recognised institutional key.
+
+
+
+
+Properties
+
+
+
+
+signers
+
+val signers : List < PublicKey >
+
+
+
+signingParties
+
+val signingParties : List < Party > If any public keys were recognised, the looked up institutions are available here
+
+
+
+
+value
+
+val value : T
+
+
+
+
+
diff --git a/docs/build/html/api/core/-authenticated-object/signers.html b/docs/build/html/api/core/-authenticated-object/signers.html
new file mode 100644
index 0000000000..acc0700c35
--- /dev/null
+++ b/docs/build/html/api/core/-authenticated-object/signers.html
@@ -0,0 +1,15 @@
+
+
+AuthenticatedObject.signers -
+core / AuthenticatedObject / signers signers
+val signers : List < PublicKey > AuthenticatedObject.signingParties -
+core / AuthenticatedObject / signingParties signingParties
+val signingParties : List < Party > If any public keys were recognised, the looked up institutions are available here
+AuthenticatedObject.value -
+core / AuthenticatedObject / value value
+val value : T BusinessCalendar.TEST_CALENDAR_DATA -
+core / BusinessCalendar / TEST_CALENDAR_DATA TEST_CALENDAR_DATA
+val TEST_CALENDAR_DATA : <ERROR CLASS> BusinessCalendar.UnknownCalendar.<init> -
+core / BusinessCalendar / UnknownCalendar / <init> <init>
+UnknownCalendar ( name : String ) BusinessCalendar.UnknownCalendar -
+core / BusinessCalendar / UnknownCalendar UnknownCalendar
+class UnknownCalendar : Exception Constructors
+
+
+
+
+<init>
+
+UnknownCalendar ( name : String )
+
+
+
+
+
diff --git a/docs/build/html/api/core/-business-calendar/apply-roll-convention.html b/docs/build/html/api/core/-business-calendar/apply-roll-convention.html
new file mode 100644
index 0000000000..8b4fd2658b
--- /dev/null
+++ b/docs/build/html/api/core/-business-calendar/apply-roll-convention.html
@@ -0,0 +1,15 @@
+
+
+BusinessCalendar.applyRollConvention -
+core / BusinessCalendar / applyRollConvention applyRollConvention
+open fun applyRollConvention ( testDate : LocalDate , dateRollConvention : DateRollConvention ) : LocalDate BusinessCalendar.calendars -
+core / BusinessCalendar / calendars calendars
+val calendars : Array < out String > val calendars : <ERROR CLASS> BusinessCalendar.createGenericSchedule -
+core / BusinessCalendar / createGenericSchedule createGenericSchedule
+fun createGenericSchedule ( startDate : LocalDate , period : Frequency , calendar : BusinessCalendar = BusinessCalendar.getInstance(), dateRollConvention : DateRollConvention = DateRollConvention.Following, noOfAdditionalPeriods : Int = Integer.MAX_VALUE, endDate : LocalDate ? = null, periodOffset : Int ? = null) : List < LocalDate > Calculates an event schedule that moves events around to ensure they fall on working days.
+BusinessCalendar.equals -
+core / BusinessCalendar / equals equals
+open fun equals ( other : Any ? ) : Boolean BusinessCalendar.getInstance -
+core / BusinessCalendar / getInstance getInstance
+fun getInstance ( vararg calname : String ) : BusinessCalendar Returns a business calendar that combines all the named holiday calendars into one list of holiday dates.
+BusinessCalendar.hashCode -
+core / BusinessCalendar / hashCode hashCode
+open fun hashCode ( ) : Int BusinessCalendar.holidayDates -
+core / BusinessCalendar / holidayDates holidayDates
+val holidayDates : List < LocalDate > BusinessCalendar -
+core / BusinessCalendar BusinessCalendar
+open class BusinessCalendar A business calendar performs date calculations that take into account national holidays and weekends. This is a
+typical feature of financial contracts, in which a business may not want a payment event to fall on a day when
+no staff are around to handle problems.
+Exceptions
+
+Properties
+
+Functions
+
+Companion Object Properties
+
+Companion Object Functions
+
+
+
+
+createGenericSchedule
+
+fun createGenericSchedule ( startDate : LocalDate , period : Frequency , calendar : BusinessCalendar = BusinessCalendar.getInstance(), dateRollConvention : DateRollConvention = DateRollConvention.Following, noOfAdditionalPeriods : Int = Integer.MAX_VALUE, endDate : LocalDate ? = null, periodOffset : Int ? = null) : List < LocalDate > Calculates an event schedule that moves events around to ensure they fall on working days.
+
+
+
+
+getInstance
+
+fun getInstance ( vararg calname : String ) : BusinessCalendar Returns a business calendar that combines all the named holiday calendars into one list of holiday dates.
+
+
+
+
+parseDateFromString
+
+fun parseDateFromString ( it : String ) : LocalDate Parses a date of the form YYYY-MM-DD, like 2016-01-10 for 10th Jan.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core/-business-calendar/is-working-day.html b/docs/build/html/api/core/-business-calendar/is-working-day.html
new file mode 100644
index 0000000000..a01367a055
--- /dev/null
+++ b/docs/build/html/api/core/-business-calendar/is-working-day.html
@@ -0,0 +1,15 @@
+
+
+BusinessCalendar.isWorkingDay -
+core / BusinessCalendar / isWorkingDay isWorkingDay
+open fun isWorkingDay ( date : LocalDate ) : Boolean BusinessCalendar.moveBusinessDays -
+core / BusinessCalendar / moveBusinessDays moveBusinessDays
+fun moveBusinessDays ( date : LocalDate , direction : DateRollDirection , i : Int ) : LocalDate Returns a date which is the inbound date plus/minus a given number of business days.
+TODO: Make more efficient if necessary
+BusinessCalendar.parseDateFromString -
+core / BusinessCalendar / parseDateFromString parseDateFromString
+fun parseDateFromString ( it : String ) : LocalDate Parses a date of the form YYYY-MM-DD, like 2016-01-10 for 10th Jan.
+CHF -
+core / CHF CHF
+val CHF : Currency CommandData -
+core / CommandData CommandData
+interface CommandData Marker interface for classes that represent commands
+Inheritors
+
+
+
+
+Commands
+
+interface Commands : CommandData
+
+
+
+Commands
+
+interface Commands : CommandData
+
+
+
+Commands
+
+interface Commands : CommandData
+
+
+
+Commands
+
+interface Commands : CommandData
+
+
+
+Commands
+
+interface Commands : CommandData
+
+
+
+Fix
+
+data class Fix : CommandData A Fix represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx.
+
+
+
+
+TimestampCommand
+
+data class TimestampCommand : CommandData If present in a transaction, contains a time that was verified by the timestamping authority/authorities whose
+public keys are identified in the containing Command object. The true time must be between (after, before)
+
+
+
+
+TypeOnlyCommandData
+
+abstract class TypeOnlyCommandData : CommandData Commands that inherit from this are intended to have no data items: its only their presence that matters.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core/-command/-init-.html b/docs/build/html/api/core/-command/-init-.html
new file mode 100644
index 0000000000..2c77018cca
--- /dev/null
+++ b/docs/build/html/api/core/-command/-init-.html
@@ -0,0 +1,18 @@
+
+
+Command.<init> -
+core / Command / <init> <init>
+Command ( data : CommandData , key : PublicKey ) Command ( value : CommandData , signers : List < PublicKey > ) Command data/content plus pubkey pair: the signature is stored at the end of the serialized bytes
+Command -
+core / Command Command
+data class Command Command data/content plus pubkey pair: the signature is stored at the end of the serialized bytes
+Constructors
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-command/signers.html b/docs/build/html/api/core/-command/signers.html
new file mode 100644
index 0000000000..d6f5899fd2
--- /dev/null
+++ b/docs/build/html/api/core/-command/signers.html
@@ -0,0 +1,15 @@
+
+
+Command.signers -
+core / Command / signers signers
+val signers : List < PublicKey > Command.toString -
+core / Command / toString toString
+fun toString ( ) : String Command.value -
+core / Command / value value
+val value : CommandData ContractState.contract -
+core / ContractState / contract contract
+abstract val contract : Contract Contract by which the state belongs
+ContractState -
+core / ContractState ContractState
+interface ContractState A contract state (or just "state") contains opaque data used by a contract program. It can be thought of as a disk
+file that the program can use to persist data across transactions. States are immutable: once created they are never
+updated, instead, any changes must generate a new successor state.
+Properties
+
+
+
+
+contract
+
+abstract val contract : Contract Contract by which the state belongs
+
+
+
+
+Extension Functions
+
+
+
+
+hash
+
+fun ContractState . hash ( ) : SecureHash Returns the SHA-256 hash of the serialised contents of this state (not cached)
+
+
+
+
+Inheritors
+
+
+
+
+LinearState
+
+interface LinearState : ContractState A state that evolves by superseding itself, all of which share the common "thread"
+
+
+
+
+OwnableState
+
+interface OwnableState : ContractState
+
+
+
+State
+
+data class State : ContractState
+
+
+
+State
+
+class State : ContractState
+
+
+
+
+
diff --git a/docs/build/html/api/core/-contract/index.html b/docs/build/html/api/core/-contract/index.html
new file mode 100644
index 0000000000..ebc00a0876
--- /dev/null
+++ b/docs/build/html/api/core/-contract/index.html
@@ -0,0 +1,93 @@
+
+
+Contract -
+core / Contract Contract
+interface Contract Implemented by a program that implements business logic on the shared ledger. All participants run this code for
+every LedgerTransaction they see on the network, for every input and output state. All contracts must accept the
+transaction for it to be accepted: failure of any aborts the entire thing. The time is taken from a trusted
+timestamp attached to the transaction itself i.e. it is NOT necessarily the current time.
+Properties
+
+
+
+
+legalContractReference
+
+abstract val legalContractReference : SecureHash Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+
+
+
+
+Functions
+
+
+
+
+verify
+
+abstract fun verify ( tx : TransactionForVerification ) : Unit Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
+Must throw an exception if theres a problem that should prevent state transition. Takes a single object
+rather than an argument so that additional data can be added without breaking binary compatibility with
+existing contract code.
+
+
+
+
+Inheritors
+
+
+
+
+Cash
+
+class Cash : Contract 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.
+
+
+
+
+CommercialPaper
+
+class CommercialPaper : Contract
+
+
+
+CrowdFund
+
+class CrowdFund : Contract 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).
+
+
+
+
+DummyContract
+
+class DummyContract : Contract
+
+
+
+InterestRateSwap
+
+class InterestRateSwap : Contract The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement)
+This contract has 4 significant data classes within it, the "Common", "Calculation", "FixedLeg" and "FloatingLeg"
+It also has 4 commands, "Agree", "Fix", "Pay" and "Mature".
+Currently, we are not interested (excuse pun) in valuing the swap, calculating the PVs, DFs and all that good stuff (soon though).
+This is just a representation of a vanilla Fixed vs Floating (same currency) IRS in the R3 prototype model.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core/-contract/legal-contract-reference.html b/docs/build/html/api/core/-contract/legal-contract-reference.html
new file mode 100644
index 0000000000..ad62fa457e
--- /dev/null
+++ b/docs/build/html/api/core/-contract/legal-contract-reference.html
@@ -0,0 +1,17 @@
+
+
+Contract.legalContractReference -
+core / Contract / legalContractReference legalContractReference
+abstract val legalContractReference : SecureHash Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
+the contracts contents).
+Contract.verify -
+core / Contract / verify verify
+abstract fun verify ( tx : TransactionForVerification ) : Unit Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
+Must throw an exception if theres a problem that should prevent state transition. Takes a single object
+rather than an argument so that additional data can be added without breaking binary compatibility with
+existing contract code.
+DateOffset.TWODAYS -
+core / DateOffset / TWODAYS TWODAYS
+TWODAYS DateOffset.ZERO -
+core / DateOffset / ZERO ZERO
+ZERO DateOffset -
+core / DateOffset DateOffset
+enum class DateOffset Date offset that the fixing is done prior to the accrual start date.
+Currently not used in the calculation.
+Enum Values
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-convention/-actual/direction.html b/docs/build/html/api/core/-date-roll-convention/-actual/direction.html
new file mode 100644
index 0000000000..02df8f991f
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-convention/-actual/direction.html
@@ -0,0 +1,16 @@
+
+
+DateRollConvention.Actual.direction -
+core / DateRollConvention / Actual / direction direction
+fun direction ( ) : DateRollDirection DateRollConvention.direction DateRollConvention.Actual -
+core / DateRollConvention / Actual Actual
+Actual Dont roll the date, use the one supplied.
+Properties
+
+
+
+
+isModified
+
+val isModified : Boolean
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-convention/-actual/is-modified.html b/docs/build/html/api/core/-date-roll-convention/-actual/is-modified.html
new file mode 100644
index 0000000000..7ad66902b5
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-convention/-actual/is-modified.html
@@ -0,0 +1,16 @@
+
+
+DateRollConvention.Actual.isModified -
+core / DateRollConvention / Actual / isModified isModified
+val isModified : Boolean DateRollConvention.isModified DateRollConvention.Following.direction -
+core / DateRollConvention / Following / direction direction
+fun direction ( ) : DateRollDirection DateRollConvention.direction DateRollConvention.Following -
+core / DateRollConvention / Following Following
+Following Following is the next business date from this one.
+Properties
+
+
+
+
+isModified
+
+val isModified : Boolean
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-convention/-following/is-modified.html b/docs/build/html/api/core/-date-roll-convention/-following/is-modified.html
new file mode 100644
index 0000000000..cfdacdd0c8
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-convention/-following/is-modified.html
@@ -0,0 +1,16 @@
+
+
+DateRollConvention.Following.isModified -
+core / DateRollConvention / Following / isModified isModified
+val isModified : Boolean DateRollConvention.isModified DateRollConvention.ModifiedFollowing.direction -
+core / DateRollConvention / ModifiedFollowing / direction direction
+fun direction ( ) : DateRollDirection DateRollConvention.direction DateRollConvention.ModifiedFollowing -
+core / DateRollConvention / ModifiedFollowing ModifiedFollowing
+ModifiedFollowing "Modified following" is the next business date, unless its in the next month, in which case use the preceeding
+business date.
+Properties
+
+
+
+
+isModified
+
+val isModified : Boolean
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-convention/-modified-following/is-modified.html b/docs/build/html/api/core/-date-roll-convention/-modified-following/is-modified.html
new file mode 100644
index 0000000000..93af7ce260
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-convention/-modified-following/is-modified.html
@@ -0,0 +1,16 @@
+
+
+DateRollConvention.ModifiedFollowing.isModified -
+core / DateRollConvention / ModifiedFollowing / isModified isModified
+val isModified : Boolean DateRollConvention.isModified DateRollConvention.ModifiedPrevious.direction -
+core / DateRollConvention / ModifiedPrevious / direction direction
+fun direction ( ) : DateRollDirection DateRollConvention.direction DateRollConvention.ModifiedPrevious -
+core / DateRollConvention / ModifiedPrevious ModifiedPrevious
+ModifiedPrevious Modified previous is the previous business date, unless its in the previous month, in which case use the next
+business date.
+Properties
+
+
+
+
+isModified
+
+val isModified : Boolean
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-convention/-modified-previous/is-modified.html b/docs/build/html/api/core/-date-roll-convention/-modified-previous/is-modified.html
new file mode 100644
index 0000000000..d42ee9a53d
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-convention/-modified-previous/is-modified.html
@@ -0,0 +1,16 @@
+
+
+DateRollConvention.ModifiedPrevious.isModified -
+core / DateRollConvention / ModifiedPrevious / isModified isModified
+val isModified : Boolean DateRollConvention.isModified DateRollConvention.Previous.direction -
+core / DateRollConvention / Previous / direction direction
+fun direction ( ) : DateRollDirection DateRollConvention.direction DateRollConvention.Previous -
+core / DateRollConvention / Previous Previous
+Previous Previous is the previous business date from this one.
+Properties
+
+
+
+
+isModified
+
+val isModified : Boolean
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-convention/-previous/is-modified.html b/docs/build/html/api/core/-date-roll-convention/-previous/is-modified.html
new file mode 100644
index 0000000000..fef5521936
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-convention/-previous/is-modified.html
@@ -0,0 +1,16 @@
+
+
+DateRollConvention.Previous.isModified -
+core / DateRollConvention / Previous / isModified isModified
+val isModified : Boolean DateRollConvention.isModified DateRollConvention.direction -
+core / DateRollConvention / direction direction
+abstract fun direction ( ) : DateRollDirection DateRollConvention -
+core / DateRollConvention DateRollConvention
+enum class DateRollConvention This reflects what happens if a date on which a business event is supposed to happen actually falls upon a non-working day
+Depending on the accounting requirement, we can move forward until we get to a business day, or backwards
+There are some additional rules which are explained in the individual cases below
+Enum Values
+
+
+
+
+Actual
+
+Dont roll the date, use the one supplied.
+
+
+
+
+Following
+
+Following is the next business date from this one.
+
+
+
+
+ModifiedFollowing
+
+"Modified following" is the next business date, unless its in the next month, in which case use the preceeding
+business date.
+
+
+
+
+Previous
+
+Previous is the previous business date from this one.
+
+
+
+
+ModifiedPrevious
+
+Modified previous is the previous business date, unless its in the previous month, in which case use the next
+business date.
+
+
+
+
+Properties
+
+
+
+
+isModified
+
+abstract val isModified : Boolean
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-convention/is-modified.html b/docs/build/html/api/core/-date-roll-convention/is-modified.html
new file mode 100644
index 0000000000..f999b8fd22
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-convention/is-modified.html
@@ -0,0 +1,15 @@
+
+
+DateRollConvention.isModified -
+core / DateRollConvention / isModified isModified
+abstract val isModified : Boolean DateRollDirection.BACKWARD -
+core / DateRollDirection / BACKWARD BACKWARD
+BACKWARD Inherited Properties
+
+
+
+
+value
+
+val value : Long
+
+
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-direction/-f-o-r-w-a-r-d.html b/docs/build/html/api/core/-date-roll-direction/-f-o-r-w-a-r-d.html
new file mode 100644
index 0000000000..2b35f935c9
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-direction/-f-o-r-w-a-r-d.html
@@ -0,0 +1,25 @@
+
+
+DateRollDirection.FORWARD -
+core / DateRollDirection / FORWARD FORWARD
+FORWARD Inherited Properties
+
+
+
+
+value
+
+val value : Long
+
+
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-direction/index.html b/docs/build/html/api/core/-date-roll-direction/index.html
new file mode 100644
index 0000000000..fcb8dcdb18
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-direction/index.html
@@ -0,0 +1,44 @@
+
+
+DateRollDirection -
+core / DateRollDirection DateRollDirection
+enum class DateRollDirection This is utilised in the DateRollConvention class to determine which way we should initially step when
+finding a business day
+Enum Values
+
+Properties
+
+
+
+
+value
+
+val value : Long
+
+
+
+
+
diff --git a/docs/build/html/api/core/-date-roll-direction/value.html b/docs/build/html/api/core/-date-roll-direction/value.html
new file mode 100644
index 0000000000..33697c2a5f
--- /dev/null
+++ b/docs/build/html/api/core/-date-roll-direction/value.html
@@ -0,0 +1,15 @@
+
+
+DateRollDirection.value -
+core / DateRollDirection / value value
+val value : Long DayCountBasisDay.DActualJ -
+core / DayCountBasisDay / DActualJ DActualJ
+DActualJ Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/-d-actual.html b/docs/build/html/api/core/-day-count-basis-day/-d-actual.html
new file mode 100644
index 0000000000..75e06ccd5f
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/-d-actual.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisDay.DActual -
+core / DayCountBasisDay / DActual DActual
+DActual Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/-d-bus_-sao-paulo.html b/docs/build/html/api/core/-day-count-basis-day/-d-bus_-sao-paulo.html
new file mode 100644
index 0000000000..805901c757
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/-d-bus_-sao-paulo.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisDay.DBus_SaoPaulo -
+core / DayCountBasisDay / DBus_SaoPaulo DBus_SaoPaulo
+DBus_SaoPaulo Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/-d30-e.html b/docs/build/html/api/core/-day-count-basis-day/-d30-e.html
new file mode 100644
index 0000000000..6cef728542
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/-d30-e.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisDay.D30E -
+core / DayCountBasisDay / D30E D30E
+D30E Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/-d30-f.html b/docs/build/html/api/core/-day-count-basis-day/-d30-f.html
new file mode 100644
index 0000000000..0b35df25a9
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/-d30-f.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisDay.D30F -
+core / DayCountBasisDay / D30F D30F
+D30F Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/-d30-g.html b/docs/build/html/api/core/-day-count-basis-day/-d30-g.html
new file mode 100644
index 0000000000..62576d36cf
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/-d30-g.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisDay.D30G -
+core / DayCountBasisDay / D30G D30G
+D30G Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/-d30-n.html b/docs/build/html/api/core/-day-count-basis-day/-d30-n.html
new file mode 100644
index 0000000000..f3dc371fc8
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/-d30-n.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisDay.D30N -
+core / DayCountBasisDay / D30N D30N
+D30N Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/-d30-p.html b/docs/build/html/api/core/-day-count-basis-day/-d30-p.html
new file mode 100644
index 0000000000..c5c8a5ae80
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/-d30-p.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisDay.D30P -
+core / DayCountBasisDay / D30P D30P
+D30P Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/-d30-z.html b/docs/build/html/api/core/-day-count-basis-day/-d30-z.html
new file mode 100644
index 0000000000..e8613a4e18
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/-d30-z.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisDay.D30Z -
+core / DayCountBasisDay / D30Z D30Z
+D30Z Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/-d30.html b/docs/build/html/api/core/-day-count-basis-day/-d30.html
new file mode 100644
index 0000000000..d9485d292f
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/-d30.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisDay.D30 -
+core / DayCountBasisDay / D30 D30
+D30 Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/index.html b/docs/build/html/api/core/-day-count-basis-day/index.html
new file mode 100644
index 0000000000..614f51e6cc
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/index.html
@@ -0,0 +1,93 @@
+
+
+DayCountBasisDay -
+core / DayCountBasisDay DayCountBasisDay
+enum class DayCountBasisDay This forms the day part of the "Day Count Basis" used for interest calculation.
+Note that the first character cannot be a number (enum naming constraints), so we drop that
+in the toString lest some people get confused.
+Enum Values
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-day/to-string.html b/docs/build/html/api/core/-day-count-basis-day/to-string.html
new file mode 100644
index 0000000000..59b61a3dfa
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-day/to-string.html
@@ -0,0 +1,15 @@
+
+
+DayCountBasisDay.toString -
+core / DayCountBasisDay / toString toString
+fun toString ( ) : String DayCountBasisYear.YActualA -
+core / DayCountBasisYear / YActualA YActualA
+YActualA Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y-actual.html b/docs/build/html/api/core/-day-count-basis-year/-y-actual.html
new file mode 100644
index 0000000000..421217cee4
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y-actual.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.YActual -
+core / DayCountBasisYear / YActual YActual
+YActual Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y-i-c-m-a.html b/docs/build/html/api/core/-day-count-basis-year/-y-i-c-m-a.html
new file mode 100644
index 0000000000..82eaa89c01
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y-i-c-m-a.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.YICMA -
+core / DayCountBasisYear / YICMA YICMA
+YICMA Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y-i-s-m-a.html b/docs/build/html/api/core/-day-count-basis-year/-y-i-s-m-a.html
new file mode 100644
index 0000000000..9d3a806a45
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y-i-s-m-a.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.YISMA -
+core / DayCountBasisYear / YISMA YISMA
+YISMA Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y252.html b/docs/build/html/api/core/-day-count-basis-year/-y252.html
new file mode 100644
index 0000000000..0a2440be40
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y252.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.Y252 -
+core / DayCountBasisYear / Y252 Y252
+Y252 Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y360.html b/docs/build/html/api/core/-day-count-basis-year/-y360.html
new file mode 100644
index 0000000000..2b0da7feac
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y360.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.Y360 -
+core / DayCountBasisYear / Y360 Y360
+Y360 Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y365-b.html b/docs/build/html/api/core/-day-count-basis-year/-y365-b.html
new file mode 100644
index 0000000000..171bae742b
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y365-b.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.Y365B -
+core / DayCountBasisYear / Y365B Y365B
+Y365B Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y365-f.html b/docs/build/html/api/core/-day-count-basis-year/-y365-f.html
new file mode 100644
index 0000000000..136183a5e2
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y365-f.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.Y365F -
+core / DayCountBasisYear / Y365F Y365F
+Y365F Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y365-l.html b/docs/build/html/api/core/-day-count-basis-year/-y365-l.html
new file mode 100644
index 0000000000..e565f3cd7f
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y365-l.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.Y365L -
+core / DayCountBasisYear / Y365L Y365L
+Y365L Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y365-q.html b/docs/build/html/api/core/-day-count-basis-year/-y365-q.html
new file mode 100644
index 0000000000..c353a9c5bb
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y365-q.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.Y365Q -
+core / DayCountBasisYear / Y365Q Y365Q
+Y365Q Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y365.html b/docs/build/html/api/core/-day-count-basis-year/-y365.html
new file mode 100644
index 0000000000..a27ae3a393
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y365.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.Y365 -
+core / DayCountBasisYear / Y365 Y365
+Y365 Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/-y366.html b/docs/build/html/api/core/-day-count-basis-year/-y366.html
new file mode 100644
index 0000000000..f411c7ac86
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/-y366.html
@@ -0,0 +1,25 @@
+
+
+DayCountBasisYear.Y366 -
+core / DayCountBasisYear / Y366 Y366
+Y366 Inherited Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/index.html b/docs/build/html/api/core/-day-count-basis-year/index.html
new file mode 100644
index 0000000000..5c92d0759c
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/index.html
@@ -0,0 +1,103 @@
+
+
+DayCountBasisYear -
+core / DayCountBasisYear DayCountBasisYear
+enum class DayCountBasisYear This forms the year part of the "Day Count Basis" used for interest calculation.
+Enum Values
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-day-count-basis-year/to-string.html b/docs/build/html/api/core/-day-count-basis-year/to-string.html
new file mode 100644
index 0000000000..0dc4229919
--- /dev/null
+++ b/docs/build/html/api/core/-day-count-basis-year/to-string.html
@@ -0,0 +1,15 @@
+
+
+DayCountBasisYear.toString -
+core / DayCountBasisYear / toString toString
+fun toString ( ) : String ExpressionDeserializer.deserialize -
+core / ExpressionDeserializer / deserialize deserialize
+fun deserialize ( parser : <ERROR CLASS> , context : <ERROR CLASS> ) : Expression ExpressionDeserializer -
+core / ExpressionDeserializer ExpressionDeserializer
+object ExpressionDeserializer Functions
+
+
+
diff --git a/docs/build/html/api/core/-expression-serializer/index.html b/docs/build/html/api/core/-expression-serializer/index.html
new file mode 100644
index 0000000000..dfdbb0f9c5
--- /dev/null
+++ b/docs/build/html/api/core/-expression-serializer/index.html
@@ -0,0 +1,25 @@
+
+
+ExpressionSerializer -
+core / ExpressionSerializer ExpressionSerializer
+object ExpressionSerializer Functions
+
+
+
+
+serialize
+
+fun serialize ( expr : Expression , generator : <ERROR CLASS> , provider : <ERROR CLASS> ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core/-expression-serializer/serialize.html b/docs/build/html/api/core/-expression-serializer/serialize.html
new file mode 100644
index 0000000000..a538100508
--- /dev/null
+++ b/docs/build/html/api/core/-expression-serializer/serialize.html
@@ -0,0 +1,15 @@
+
+
+ExpressionSerializer.serialize -
+core / ExpressionSerializer / serialize serialize
+fun serialize ( expr : Expression , generator : <ERROR CLASS> , provider : <ERROR CLASS> ) : Unit Expression.<init> -
+core / Expression / <init> <init>
+Expression ( expr : String ) Represents a textual expression of e.g. a formula
+Expression.expr -
+core / Expression / expr expr
+val expr : String Expression -
+core / Expression Expression
+data class Expression Represents a textual expression of e.g. a formula
+Constructors
+
+
+
+
+<init>
+
+Expression ( expr : String ) Represents a textual expression of e.g. a formula
+
+
+
+
+Properties
+
+
+
+
+expr
+
+val expr : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-fix-of/-init-.html b/docs/build/html/api/core/-fix-of/-init-.html
new file mode 100644
index 0000000000..e7d0c6d687
--- /dev/null
+++ b/docs/build/html/api/core/-fix-of/-init-.html
@@ -0,0 +1,15 @@
+
+
+FixOf.<init> -
+core / FixOf / <init> <init>
+FixOf ( name : String , forDay : LocalDate , ofTenor : Tenor ) A FixOf identifies the question side of a fix: what day, tenor and type of fix ("LIBOR", "EURIBOR" etc)
+FixOf.forDay -
+core / FixOf / forDay forDay
+val forDay : LocalDate FixOf -
+core / FixOf FixOf
+data class FixOf A FixOf identifies the question side of a fix: what day, tenor and type of fix ("LIBOR", "EURIBOR" etc)
+Constructors
+
+
+
+
+<init>
+
+FixOf ( name : String , forDay : LocalDate , ofTenor : Tenor ) A FixOf identifies the question side of a fix: what day, tenor and type of fix ("LIBOR", "EURIBOR" etc)
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core/-fix-of/name.html b/docs/build/html/api/core/-fix-of/name.html
new file mode 100644
index 0000000000..2c59fe85d0
--- /dev/null
+++ b/docs/build/html/api/core/-fix-of/name.html
@@ -0,0 +1,15 @@
+
+
+FixOf.name -
+core / FixOf / name name
+val name : String FixOf.ofTenor -
+core / FixOf / ofTenor ofTenor
+val ofTenor : Tenor Fix.<init> -
+core / Fix / <init> <init>
+Fix ( of : FixOf , value : BigDecimal ) A Fix represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx.
+Fix -
+core / Fix Fix
+data class Fix : CommandData A Fix represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx.
+Constructors
+
+
+
+
+<init>
+
+Fix ( of : FixOf , value : BigDecimal ) A Fix represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx.
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core/-fix/of.html b/docs/build/html/api/core/-fix/of.html
new file mode 100644
index 0000000000..c7d73fa7da
--- /dev/null
+++ b/docs/build/html/api/core/-fix/of.html
@@ -0,0 +1,15 @@
+
+
+Fix.of -
+core / Fix / of of
+val of : FixOf Fix.value -
+core / Fix / value value
+val value : BigDecimal Frequency.Annual -
+core / Frequency / Annual Annual
+Annual Inherited Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-frequency/-annual/offset.html b/docs/build/html/api/core/-frequency/-annual/offset.html
new file mode 100644
index 0000000000..aba88b1062
--- /dev/null
+++ b/docs/build/html/api/core/-frequency/-annual/offset.html
@@ -0,0 +1,16 @@
+
+
+Frequency.Annual.offset -
+core / Frequency / Annual / offset offset
+fun offset ( d : LocalDate ) : LocalDate Frequency.offset Frequency.BiWeekly -
+core / Frequency / BiWeekly BiWeekly
+BiWeekly Inherited Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-frequency/-bi-weekly/offset.html b/docs/build/html/api/core/-frequency/-bi-weekly/offset.html
new file mode 100644
index 0000000000..11b1855633
--- /dev/null
+++ b/docs/build/html/api/core/-frequency/-bi-weekly/offset.html
@@ -0,0 +1,16 @@
+
+
+Frequency.BiWeekly.offset -
+core / Frequency / BiWeekly / offset offset
+fun offset ( d : LocalDate ) : LocalDate Frequency.offset Frequency.Monthly -
+core / Frequency / Monthly Monthly
+Monthly Inherited Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-frequency/-monthly/offset.html b/docs/build/html/api/core/-frequency/-monthly/offset.html
new file mode 100644
index 0000000000..6f60806089
--- /dev/null
+++ b/docs/build/html/api/core/-frequency/-monthly/offset.html
@@ -0,0 +1,16 @@
+
+
+Frequency.Monthly.offset -
+core / Frequency / Monthly / offset offset
+fun offset ( d : LocalDate ) : LocalDate Frequency.offset Frequency.Quarterly -
+core / Frequency / Quarterly Quarterly
+Quarterly Inherited Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-frequency/-quarterly/offset.html b/docs/build/html/api/core/-frequency/-quarterly/offset.html
new file mode 100644
index 0000000000..14c9a349c3
--- /dev/null
+++ b/docs/build/html/api/core/-frequency/-quarterly/offset.html
@@ -0,0 +1,16 @@
+
+
+Frequency.Quarterly.offset -
+core / Frequency / Quarterly / offset offset
+fun offset ( d : LocalDate ) : LocalDate Frequency.offset Frequency.SemiAnnual -
+core / Frequency / SemiAnnual SemiAnnual
+SemiAnnual Inherited Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-frequency/-semi-annual/offset.html b/docs/build/html/api/core/-frequency/-semi-annual/offset.html
new file mode 100644
index 0000000000..7a9c359397
--- /dev/null
+++ b/docs/build/html/api/core/-frequency/-semi-annual/offset.html
@@ -0,0 +1,16 @@
+
+
+Frequency.SemiAnnual.offset -
+core / Frequency / SemiAnnual / offset offset
+fun offset ( d : LocalDate ) : LocalDate Frequency.offset Frequency.Weekly -
+core / Frequency / Weekly Weekly
+Weekly Inherited Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-frequency/-weekly/offset.html b/docs/build/html/api/core/-frequency/-weekly/offset.html
new file mode 100644
index 0000000000..a7f7467fd9
--- /dev/null
+++ b/docs/build/html/api/core/-frequency/-weekly/offset.html
@@ -0,0 +1,16 @@
+
+
+Frequency.Weekly.offset -
+core / Frequency / Weekly / offset offset
+fun offset ( d : LocalDate ) : LocalDate Frequency.offset Frequency.annualCompoundCount -
+core / Frequency / annualCompoundCount annualCompoundCount
+val annualCompoundCount : Int Frequency -
+core / Frequency Frequency
+enum class Frequency Frequency at which an event occurs - the enumerator also casts to an integer specifying the number of times per year
+that would divide into (eg annually = 1, semiannual = 2, monthly = 12 etc).
+Enum Values
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-frequency/offset.html b/docs/build/html/api/core/-frequency/offset.html
new file mode 100644
index 0000000000..053108cea9
--- /dev/null
+++ b/docs/build/html/api/core/-frequency/offset.html
@@ -0,0 +1,15 @@
+
+
+Frequency.offset -
+core / Frequency / offset offset
+abstract fun offset ( d : LocalDate ) : LocalDate GBP -
+core / GBP GBP
+val GBP : Currency LedgerTransaction.<init> -
+core / LedgerTransaction / <init> <init>
+LedgerTransaction ( inputs : List < StateRef > , attachments : List < Attachment > , outputs : List < ContractState > , commands : List < AuthenticatedObject < CommandData > > , id : SecureHash ) A LedgerTransaction wraps the data needed to calculate one or more successor states from a set of input states.
+It is the first step after extraction from a WireTransaction. The signatures at this point have been lined up
+with the commands from the wire, and verified/looked up.
+TODO: This class needs a bit more thought. Should inputs be fully resolved by this point too?
+LedgerTransaction.attachments -
+core / LedgerTransaction / attachments attachments
+val attachments : List < Attachment > A list of Attachment objects identified by the transaction that are needed for this transaction to verify.
+LedgerTransaction.commands -
+core / LedgerTransaction / commands commands
+val commands : List < AuthenticatedObject < CommandData > > Arbitrary data passed to the program of each input state.
+LedgerTransaction.id -
+core / LedgerTransaction / id id
+val id : SecureHash NamedByHash.id The hash of the original serialised WireTransaction
+LedgerTransaction -
+core / LedgerTransaction LedgerTransaction
+data class LedgerTransaction : NamedByHash A LedgerTransaction wraps the data needed to calculate one or more successor states from a set of input states.
+It is the first step after extraction from a WireTransaction. The signatures at this point have been lined up
+with the commands from the wire, and verified/looked up.
+TODO: This class needs a bit more thought. Should inputs be fully resolved by this point too?
+Constructors
+
+
+
+
+<init>
+
+LedgerTransaction ( inputs : List < StateRef > , attachments : List < Attachment > , outputs : List < ContractState > , commands : List < AuthenticatedObject < CommandData > > , id : SecureHash ) A LedgerTransaction wraps the data needed to calculate one or more successor states from a set of input states.
+It is the first step after extraction from a WireTransaction. The signatures at this point have been lined up
+with the commands from the wire, and verified/looked up.
+
+
+
+
+Properties
+
+
+
+
+attachments
+
+val attachments : List < Attachment > A list of Attachment objects identified by the transaction that are needed for this transaction to verify.
+
+
+
+
+commands
+
+val commands : List < AuthenticatedObject < CommandData > > Arbitrary data passed to the program of each input state.
+
+
+
+
+id
+
+val id : SecureHash The hash of the original serialised WireTransaction
+
+
+
+
+inputs
+
+val inputs : List < StateRef > The input states which will be consumed/invalidated by the execution of this transaction.
+
+
+
+
+outputs
+
+val outputs : List < ContractState > The states that will be generated by the execution of this transaction.
+
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-ledger-transaction/inputs.html b/docs/build/html/api/core/-ledger-transaction/inputs.html
new file mode 100644
index 0000000000..1cb40b5a5d
--- /dev/null
+++ b/docs/build/html/api/core/-ledger-transaction/inputs.html
@@ -0,0 +1,16 @@
+
+
+LedgerTransaction.inputs -
+core / LedgerTransaction / inputs inputs
+val inputs : List < StateRef > The input states which will be consumed/invalidated by the execution of this transaction.
+LedgerTransaction.outRef -
+core / LedgerTransaction / outRef outRef
+fun < T : ContractState > outRef ( index : Int ) : StateAndRef < T > LedgerTransaction.outputs -
+core / LedgerTransaction / outputs outputs
+val outputs : List < ContractState > The states that will be generated by the execution of this transaction.
+LinearState -
+core / LinearState LinearState
+interface LinearState : ContractState A state that evolves by superseding itself, all of which share the common "thread"
+This simplifies the job of tracking the current version of certain types of state in e.g. a wallet
+Properties
+
+
+
+
+thread
+
+abstract val thread : SecureHash Unique thread id within the wallets of all parties
+
+
+
+
+Inherited Properties
+
+
+
+
+contract
+
+abstract val contract : Contract Contract by which the state belongs
+
+
+
+
+Functions
+
+
+
+
+isRelevant
+
+abstract fun isRelevant ( ourKeys : Set < PublicKey > ) : Boolean true if this should be tracked by our wallet(s)
+
+
+
+
+Extension Functions
+
+
+
+
+hash
+
+fun ContractState . hash ( ) : SecureHash Returns the SHA-256 hash of the serialised contents of this state (not cached)
+
+
+
+
+Inheritors
+
+
+
+
+DealState
+
+interface DealState : LinearState Interface representing an agreement that exposes various attributes that are common. Implementing it simplifies
+implementation of general protocols that manipulate many agreement types.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core/-linear-state/is-relevant.html b/docs/build/html/api/core/-linear-state/is-relevant.html
new file mode 100644
index 0000000000..e476cfef08
--- /dev/null
+++ b/docs/build/html/api/core/-linear-state/is-relevant.html
@@ -0,0 +1,16 @@
+
+
+LinearState.isRelevant -
+core / LinearState / isRelevant isRelevant
+abstract fun isRelevant ( ourKeys : Set < PublicKey > ) : Boolean true if this should be tracked by our wallet(s)
+LinearState.thread -
+core / LinearState / thread thread
+abstract val thread : SecureHash Unique thread id within the wallets of all parties
+NamedByHash.id -
+core / NamedByHash / id id
+abstract val id : SecureHash NamedByHash -
+core / NamedByHash NamedByHash
+interface NamedByHash Implemented by anything that can be named by a secure hash value (e.g. transactions, attachments).
+Properties
+
+Inheritors
+
+
+
+
+Attachment
+
+interface Attachment : NamedByHash An attachment is a ZIP (or an optionally signed JAR) that contains one or more files. Attachments are meant to
+contain public static data which can be referenced from transactions and utilised from contracts. Good examples
+of how attachments are meant to be used include:
+
+
+
+
+LedgerTransaction
+
+data class LedgerTransaction : NamedByHash A LedgerTransaction wraps the data needed to calculate one or more successor states from a set of input states.
+It is the first step after extraction from a WireTransaction. The signatures at this point have been lined up
+with the commands from the wire, and verified/looked up.
+
+
+
+
+SignedTransaction
+
+data class SignedTransaction : NamedByHash Container for a WireTransaction and attached signatures.
+
+
+
+
+WireTransaction
+
+data class WireTransaction : NamedByHash Transaction ready for serialisation, without any signatures attached.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core/-ownable-state/index.html b/docs/build/html/api/core/-ownable-state/index.html
new file mode 100644
index 0000000000..ddc4efee0e
--- /dev/null
+++ b/docs/build/html/api/core/-ownable-state/index.html
@@ -0,0 +1,80 @@
+
+
+OwnableState -
+core / OwnableState OwnableState
+interface OwnableState : ContractState Properties
+
+
+
+
+owner
+
+abstract val owner : PublicKey There must be a MoveCommand signed by this key to claim the amount
+
+
+
+
+Inherited Properties
+
+
+
+
+contract
+
+abstract val contract : Contract Contract by which the state belongs
+
+
+
+
+Functions
+
+
+
+
+withNewOwner
+
+abstract fun withNewOwner ( newOwner : PublicKey ) : <ERROR CLASS> < CommandData , OwnableState > Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone
+
+
+
+
+Extension Functions
+
+
+
+
+hash
+
+fun ContractState . hash ( ) : SecureHash Returns the SHA-256 hash of the serialised contents of this state (not cached)
+
+
+
+
+Inheritors
+
+
+
+
+State
+
+data class State : OwnableState A state representing a cash claim against some party
+
+
+
+
+State
+
+data class State : OwnableState
+
+
+
+
+
diff --git a/docs/build/html/api/core/-ownable-state/owner.html b/docs/build/html/api/core/-ownable-state/owner.html
new file mode 100644
index 0000000000..05d702d1bb
--- /dev/null
+++ b/docs/build/html/api/core/-ownable-state/owner.html
@@ -0,0 +1,16 @@
+
+
+OwnableState.owner -
+core / OwnableState / owner owner
+abstract val owner : PublicKey There must be a MoveCommand signed by this key to claim the amount
+OwnableState.withNewOwner -
+core / OwnableState / withNewOwner withNewOwner
+abstract fun withNewOwner ( newOwner : PublicKey ) : <ERROR CLASS> < CommandData , OwnableState > Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone
+PartyReference.<init> -
+core / PartyReference / <init> <init>
+PartyReference ( party : Party , reference : OpaqueBytes ) Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal
+ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.
+PartyReference -
+core / PartyReference PartyReference
+data class PartyReference Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal
+ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.
+Constructors
+
+
+
+
+<init>
+
+PartyReference ( party : Party , reference : OpaqueBytes ) Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal
+ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-party-reference/party.html b/docs/build/html/api/core/-party-reference/party.html
new file mode 100644
index 0000000000..d7bdeec32a
--- /dev/null
+++ b/docs/build/html/api/core/-party-reference/party.html
@@ -0,0 +1,15 @@
+
+
+PartyReference.party -
+core / PartyReference / party party
+val party : Party PartyReference.reference -
+core / PartyReference / reference reference
+val reference : OpaqueBytes PartyReference.toString -
+core / PartyReference / toString toString
+fun toString ( ) : String Party.<init> -
+core / Party / <init> <init>
+Party ( name : String , owningKey : PublicKey ) A Party is well known (name, pubkey) pair. In a real system this would probably be an X.509 certificate.
+Party -
+core / Party Party
+data class Party A Party is well known (name, pubkey) pair. In a real system this would probably be an X.509 certificate.
+Constructors
+
+
+
+
+<init>
+
+Party ( name : String , owningKey : PublicKey ) A Party is well known (name, pubkey) pair. In a real system this would probably be an X.509 certificate.
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-party/name.html b/docs/build/html/api/core/-party/name.html
new file mode 100644
index 0000000000..1153a4a85e
--- /dev/null
+++ b/docs/build/html/api/core/-party/name.html
@@ -0,0 +1,15 @@
+
+
+Party.name -
+core / Party / name name
+val name : String Party.owningKey -
+core / Party / owningKey owningKey
+val owningKey : PublicKey Party.ref -
+core / Party / ref ref
+fun ref ( bytes : OpaqueBytes ) : PartyReference fun ref ( vararg bytes : Byte ) : PartyReference Party.toString -
+core / Party / toString toString
+fun toString ( ) : String PaymentRule.InAdvance -
+core / PaymentRule / InAdvance InAdvance
+InAdvance PaymentRule.InArrears -
+core / PaymentRule / InArrears InArrears
+InArrears PaymentRule -
+core / PaymentRule PaymentRule
+enum class PaymentRule Whether the payment should be made before the due date, or after it.
+Enum Values
+
+
+
diff --git a/docs/build/html/api/core/-r.html b/docs/build/html/api/core/-r.html
new file mode 100644
index 0000000000..46acd4906d
--- /dev/null
+++ b/docs/build/html/api/core/-r.html
@@ -0,0 +1,15 @@
+
+
+R -
+core / R R
+val R : Requirements Requirements.<init> -
+core / Requirements / <init> <init>
+Requirements ( ) Requirements.by -
+core / Requirements / by by
+infix fun String . by ( expr : Boolean ) : Unit Requirements -
+core / Requirements Requirements
+class Requirements Constructors
+
+
+
+
+<init>
+
+Requirements ( )
+
+
+
+Functions
+
+
+
+
+by
+
+infix fun String . by ( expr : Boolean ) : Unit
+
+
+
+
+
diff --git a/docs/build/html/api/core/-run-on-caller-thread.html b/docs/build/html/api/core/-run-on-caller-thread.html
new file mode 100644
index 0000000000..2d10a41e9d
--- /dev/null
+++ b/docs/build/html/api/core/-run-on-caller-thread.html
@@ -0,0 +1,15 @@
+
+
+RunOnCallerThread -
+core / RunOnCallerThread RunOnCallerThread
+val RunOnCallerThread : <ERROR CLASS> SignedTransaction.<init> -
+core / SignedTransaction / <init> <init>
+SignedTransaction ( txBits : SerializedBytes < WireTransaction > , sigs : List < WithKey > ) Container for a WireTransaction and attached signatures.
+SignedTransaction.id -
+core / SignedTransaction / id id
+val id : SecureHash NamedByHash.id A transaction ID is the hash of the WireTransaction . Thus adding or removing a signature does not change it.
+SignedTransaction -
+core / SignedTransaction SignedTransaction
+data class SignedTransaction : NamedByHash Container for a WireTransaction and attached signatures.
+Constructors
+
+Properties
+
+Functions
+
+
+
+
+plus
+
+operator fun plus ( sig : WithKey ) : SignedTransaction Alias for withAdditionalSignature to let you use Kotlin operator overloading.
+
+
+
+
+verify
+
+fun verify ( throwIfSignaturesAreMissing : Boolean = true) : Set < PublicKey > Verify the signatures, deserialise the wire transaction and then check that the set of signatures found matches
+the set of pubkeys in the commands. If any signatures are missing, either throws an exception (by default) or
+returns the list of keys that have missing signatures, depending on the parameter.
+
+
+
+
+verifySignatures
+
+fun verifySignatures ( ) : Unit Verifies the given signatures against the serialized transaction data. Does NOT deserialise or check the contents
+to ensure there are no missing signatures: use verify() to do that. This weaker version can be useful for
+checking a partially signed transaction being prepared by multiple co-operating parties.
+
+
+
+
+withAdditionalSignature
+
+fun withAdditionalSignature ( sig : WithKey ) : SignedTransaction Returns the same transaction but with an additional (unchecked) signature
+
+
+
+
+Extension Functions
+
+
+
diff --git a/docs/build/html/api/core/-signed-transaction/plus.html b/docs/build/html/api/core/-signed-transaction/plus.html
new file mode 100644
index 0000000000..378a35e540
--- /dev/null
+++ b/docs/build/html/api/core/-signed-transaction/plus.html
@@ -0,0 +1,16 @@
+
+
+SignedTransaction.plus -
+core / SignedTransaction / plus plus
+operator fun plus ( sig : WithKey ) : SignedTransaction Alias for withAdditionalSignature to let you use Kotlin operator overloading.
+SignedTransaction.sigs -
+core / SignedTransaction / sigs sigs
+val sigs : List < WithKey > SignedTransaction.txBits -
+core / SignedTransaction / txBits txBits
+val txBits : SerializedBytes < WireTransaction > SignedTransaction.tx -
+core / SignedTransaction / tx tx
+val tx : WireTransaction Lazily calculated access to the deserialised/hashed transaction data.
+Getter Lazily calculated access to the deserialised/hashed transaction data.
+SignedTransaction.verifySignatures -
+core / SignedTransaction / verifySignatures verifySignatures
+fun verifySignatures ( ) : Unit Verifies the given signatures against the serialized transaction data. Does NOT deserialise or check the contents
+to ensure there are no missing signatures: use verify() to do that. This weaker version can be useful for
+checking a partially signed transaction being prepared by multiple co-operating parties.
+Exceptions
+SignatureException - if the signature is invalid or does not match.SignedTransaction.verify -
+core / SignedTransaction / verify verify
+fun verify ( throwIfSignaturesAreMissing : Boolean = true) : Set < PublicKey > Verify the signatures, deserialise the wire transaction and then check that the set of signatures found matches
+the set of pubkeys in the commands. If any signatures are missing, either throws an exception (by default) or
+returns the list of keys that have missing signatures, depending on the parameter.
+Exceptions
+SignatureException - if a signature is invalid, does not match or if any signature is missing.SignedTransaction.withAdditionalSignature -
+core / SignedTransaction / withAdditionalSignature withAdditionalSignature
+fun withAdditionalSignature ( sig : WithKey ) : SignedTransaction Returns the same transaction but with an additional (unchecked) signature
+StateAndRef.<init> -
+core / StateAndRef / <init> <init>
+StateAndRef ( state : T , ref : StateRef ) A StateAndRef is simply a (state, ref) pair. For instance, a wallet (which holds available assets) contains these.
+StateAndRef -
+core / StateAndRef StateAndRef
+data class StateAndRef < out T : ContractState > A StateAndRef is simply a (state, ref) pair. For instance, a wallet (which holds available assets) contains these.
+Constructors
+
+
+
+
+<init>
+
+StateAndRef ( state : T , ref : StateRef ) A StateAndRef is simply a (state, ref) pair. For instance, a wallet (which holds available assets) contains these.
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core/-state-and-ref/ref.html b/docs/build/html/api/core/-state-and-ref/ref.html
new file mode 100644
index 0000000000..dca8979b3d
--- /dev/null
+++ b/docs/build/html/api/core/-state-and-ref/ref.html
@@ -0,0 +1,15 @@
+
+
+StateAndRef.ref -
+core / StateAndRef / ref ref
+val ref : StateRef StateAndRef.state -
+core / StateAndRef / state state
+val state : T StateRef.index -
+core / StateRef / index index
+val index : Int StateRef.<init> -
+core / StateRef / <init> <init>
+StateRef ( txhash : SecureHash , index : Int ) A stateref is a pointer (reference) to a state, this is an equivalent of an "outpoint" in Bitcoin. It records which
+transaction defined the state and where in that transaction it was.
+StateRef -
+core / StateRef StateRef
+data class StateRef A stateref is a pointer (reference) to a state, this is an equivalent of an "outpoint" in Bitcoin. It records which
+transaction defined the state and where in that transaction it was.
+Constructors
+
+
+
+
+<init>
+
+StateRef ( txhash : SecureHash , index : Int ) A stateref is a pointer (reference) to a state, this is an equivalent of an "outpoint" in Bitcoin. It records which
+transaction defined the state and where in that transaction it was.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-state-ref/to-string.html b/docs/build/html/api/core/-state-ref/to-string.html
new file mode 100644
index 0000000000..be423b2e16
--- /dev/null
+++ b/docs/build/html/api/core/-state-ref/to-string.html
@@ -0,0 +1,15 @@
+
+
+StateRef.toString -
+core / StateRef / toString toString
+fun toString ( ) : String StateRef.txhash -
+core / StateRef / txhash txhash
+val txhash : SecureHash Tenor.<init> -
+core / Tenor / <init> <init>
+Tenor ( name : String ) Placeholder class for the Tenor datatype - which is a standardised duration of time until maturity
+Tenor.TimeUnit.Day -
+core / Tenor / TimeUnit / Day Day
+Day Inherited Properties
+
+
+
+
+code
+
+val code : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-tenor/-time-unit/-month.html b/docs/build/html/api/core/-tenor/-time-unit/-month.html
new file mode 100644
index 0000000000..97b260b38d
--- /dev/null
+++ b/docs/build/html/api/core/-tenor/-time-unit/-month.html
@@ -0,0 +1,25 @@
+
+
+Tenor.TimeUnit.Month -
+core / Tenor / TimeUnit / Month Month
+Month Inherited Properties
+
+
+
+
+code
+
+val code : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-tenor/-time-unit/-week.html b/docs/build/html/api/core/-tenor/-time-unit/-week.html
new file mode 100644
index 0000000000..98e8c25875
--- /dev/null
+++ b/docs/build/html/api/core/-tenor/-time-unit/-week.html
@@ -0,0 +1,25 @@
+
+
+Tenor.TimeUnit.Week -
+core / Tenor / TimeUnit / Week Week
+Week Inherited Properties
+
+
+
+
+code
+
+val code : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-tenor/-time-unit/-year.html b/docs/build/html/api/core/-tenor/-time-unit/-year.html
new file mode 100644
index 0000000000..1b7ea252f3
--- /dev/null
+++ b/docs/build/html/api/core/-tenor/-time-unit/-year.html
@@ -0,0 +1,25 @@
+
+
+Tenor.TimeUnit.Year -
+core / Tenor / TimeUnit / Year Year
+Year Inherited Properties
+
+
+
+
+code
+
+val code : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-tenor/-time-unit/code.html b/docs/build/html/api/core/-tenor/-time-unit/code.html
new file mode 100644
index 0000000000..deec081661
--- /dev/null
+++ b/docs/build/html/api/core/-tenor/-time-unit/code.html
@@ -0,0 +1,15 @@
+
+
+Tenor.TimeUnit.code -
+core / Tenor / TimeUnit / code code
+val code : String Tenor.TimeUnit -
+core / Tenor / TimeUnit TimeUnit
+enum class TimeUnit Enum Values
+
+Properties
+
+
+
+
+code
+
+val code : String
+
+
+
+
+
diff --git a/docs/build/html/api/core/-tenor/days-to-maturity.html b/docs/build/html/api/core/-tenor/days-to-maturity.html
new file mode 100644
index 0000000000..8e25970bc4
--- /dev/null
+++ b/docs/build/html/api/core/-tenor/days-to-maturity.html
@@ -0,0 +1,15 @@
+
+
+Tenor.daysToMaturity -
+core / Tenor / daysToMaturity daysToMaturity
+fun daysToMaturity ( startDate : LocalDate , calendar : BusinessCalendar ) : Int Tenor -
+core / Tenor Tenor
+data class Tenor Placeholder class for the Tenor datatype - which is a standardised duration of time until maturity
+Types
+
+
+
+
+TimeUnit
+
+enum class TimeUnit
+
+
+
+Constructors
+
+
+
+
+<init>
+
+Tenor ( name : String ) Placeholder class for the Tenor datatype - which is a standardised duration of time until maturity
+
+
+
+
+Properties
+
+
+
+
+name
+
+val name : String
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-tenor/name.html b/docs/build/html/api/core/-tenor/name.html
new file mode 100644
index 0000000000..40d0d2dac4
--- /dev/null
+++ b/docs/build/html/api/core/-tenor/name.html
@@ -0,0 +1,15 @@
+
+
+Tenor.name -
+core / Tenor / name name
+val name : String Tenor.toString -
+core / Tenor / toString toString
+fun toString ( ) : String ThreadBox.<init> -
+core / ThreadBox / <init> <init>
+ThreadBox ( content : T , lock : Lock = ReentrantLock()) A threadbox is a simple utility that makes it harder to forget to take a lock before accessing some shared state.
+Simply define a private class to hold the data that must be grouped under the same lock, and then pass the only
+instance to the ThreadBox constructor. You can now use the locked method with a lambda to take the lock in a
+way that ensures itll be released if theres an exception.
+Note that this technique is not infallible: if you capture a reference to the fields in another lambda which then
+gets stored and invoked later, there may still be unsafe multi-threaded access going on, so watch out for that.
+This is just a simple guard rail that makes it harder to slip up.
+Example:
+private class MutableState { var i = 5 }
+private val state = ThreadBox(MutableState())
+val ii = state.locked { i }
+ThreadBox.content -
+core / ThreadBox / content content
+val content : T ThreadBox -
+core / ThreadBox ThreadBox
+class ThreadBox < T > A threadbox is a simple utility that makes it harder to forget to take a lock before accessing some shared state.
+Simply define a private class to hold the data that must be grouped under the same lock, and then pass the only
+instance to the ThreadBox constructor. You can now use the locked method with a lambda to take the lock in a
+way that ensures itll be released if theres an exception.
+Note that this technique is not infallible: if you capture a reference to the fields in another lambda which then
+gets stored and invoked later, there may still be unsafe multi-threaded access going on, so watch out for that.
+This is just a simple guard rail that makes it harder to slip up.
+Example:
+private class MutableState { var i = 5 }
+private val state = ThreadBox(MutableState())
+val ii = state.locked { i }
+Constructors
+
+
+
+
+<init>
+
+ThreadBox ( content : T , lock : Lock = ReentrantLock()) A threadbox is a simple utility that makes it harder to forget to take a lock before accessing some shared state.
+Simply define a private class to hold the data that must be grouped under the same lock, and then pass the only
+instance to the ThreadBox constructor. You can now use the locked method with a lambda to take the lock in a
+way that ensures itll be released if theres an exception.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+locked
+
+fun < R > locked ( body : T . ( ) -> R ) : R
+
+
+
+
+
diff --git a/docs/build/html/api/core/-thread-box/lock.html b/docs/build/html/api/core/-thread-box/lock.html
new file mode 100644
index 0000000000..d504ba21f6
--- /dev/null
+++ b/docs/build/html/api/core/-thread-box/lock.html
@@ -0,0 +1,15 @@
+
+
+ThreadBox.lock -
+core / ThreadBox / lock lock
+val lock : Lock ThreadBox.locked -
+core / ThreadBox / locked locked
+inline fun < R > locked ( body : T . ( ) -> R ) : R TimestampCommand.<init> -
+core / TimestampCommand / <init> <init>
+TimestampCommand ( time : Instant , tolerance : Duration ) TimestampCommand ( after : Instant ? , before : Instant ? ) If present in a transaction, contains a time that was verified by the timestamping authority/authorities whose
+public keys are identified in the containing Command object. The true time must be between (after, before)
+TimestampCommand.after -
+core / TimestampCommand / after after
+val after : Instant ? TimestampCommand.before -
+core / TimestampCommand / before before
+val before : Instant ? TimestampCommand -
+core / TimestampCommand TimestampCommand
+data class TimestampCommand : CommandData If present in a transaction, contains a time that was verified by the timestamping authority/authorities whose
+public keys are identified in the containing Command object. The true time must be between (after, before)
+Constructors
+
+
+
+
+<init>
+
+TimestampCommand ( time : Instant , tolerance : Duration ) TimestampCommand ( after : Instant ? , before : Instant ? ) If present in a transaction, contains a time that was verified by the timestamping authority/authorities whose
+public keys are identified in the containing Command object. The true time must be between (after, before)
+
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core/-timestamp-command/midpoint.html b/docs/build/html/api/core/-timestamp-command/midpoint.html
new file mode 100644
index 0000000000..80dc20b682
--- /dev/null
+++ b/docs/build/html/api/core/-timestamp-command/midpoint.html
@@ -0,0 +1,15 @@
+
+
+TimestampCommand.midpoint -
+core / TimestampCommand / midpoint midpoint
+val midpoint : Instant TransactionBuilder.<init> -
+core / TransactionBuilder / <init> <init>
+TransactionBuilder ( inputs : MutableList < StateRef > = arrayListOf(), attachments : MutableList < SecureHash > = arrayListOf(), outputs : MutableList < ContractState > = arrayListOf(), commands : MutableList < Command > = arrayListOf()) A TransactionBuilder is a transaction class thats mutable (unlike the others which are all immutable). It is
+intended to be passed around contracts that may edit it by adding new states/commands or modifying the existing set.
+Then once the states and commands are right, this class can be used as a holding bucket to gather signatures from
+multiple parties.
+TransactionBuilder.addAttachment -
+core / TransactionBuilder / addAttachment addAttachment
+fun addAttachment ( attachment : Attachment ) : Unit TransactionBuilder.addCommand -
+core / TransactionBuilder / addCommand addCommand
+fun addCommand ( arg : Command ) : Unit fun addCommand ( data : CommandData , vararg keys : PublicKey ) : <ERROR CLASS> fun addCommand ( data : CommandData , keys : List < PublicKey > ) : Unit TransactionBuilder.addInputState -
+core / TransactionBuilder / addInputState addInputState
+fun addInputState ( ref : StateRef ) : Unit TransactionBuilder.addOutputState -
+core / TransactionBuilder / addOutputState addOutputState
+fun addOutputState ( state : ContractState ) : Unit TransactionBuilder.addSignatureUnchecked -
+core / TransactionBuilder / addSignatureUnchecked addSignatureUnchecked
+fun addSignatureUnchecked ( sig : WithKey ) : Unit Adds the signature directly to the transaction, without checking it for validity.
+TransactionBuilder.attachments -
+core / TransactionBuilder / attachments attachments
+fun attachments ( ) : List < SecureHash > TransactionBuilder.checkAndAddSignature -
+core / TransactionBuilder / checkAndAddSignature checkAndAddSignature
+fun checkAndAddSignature ( sig : WithKey ) : Unit Checks that the given signature matches one of the commands and that it is a correct signature over the tx, then
+adds it.
+Exceptions
+SignatureException - if the signature didnt match the transaction contentsIllegalArgumentException - if the signature key doesnt appear in any command.TransactionBuilder.checkSignature -
+core / TransactionBuilder / checkSignature checkSignature
+fun checkSignature ( sig : WithKey ) : Unit Checks that the given signature matches one of the commands and that it is a correct signature over the tx.
+Exceptions
+SignatureException - if the signature didnt match the transaction contentsIllegalArgumentException - if the signature key doesnt appear in any command.TransactionBuilder.commands -
+core / TransactionBuilder / commands commands
+fun commands ( ) : List < Command > TransactionBuilder -
+core / TransactionBuilder TransactionBuilder
+class TransactionBuilder A TransactionBuilder is a transaction class thats mutable (unlike the others which are all immutable). It is
+intended to be passed around contracts that may edit it by adding new states/commands or modifying the existing set.
+Then once the states and commands are right, this class can be used as a holding bucket to gather signatures from
+multiple parties.
+Constructors
+
+
+
+
+<init>
+
+TransactionBuilder ( inputs : MutableList < StateRef > = arrayListOf(), attachments : MutableList < SecureHash > = arrayListOf(), outputs : MutableList < ContractState > = arrayListOf(), commands : MutableList < Command > = arrayListOf()) A TransactionBuilder is a transaction class thats mutable (unlike the others which are all immutable). It is
+intended to be passed around contracts that may edit it by adding new states/commands or modifying the existing set.
+Then once the states and commands are right, this class can be used as a holding bucket to gather signatures from
+multiple parties.
+
+
+
+
+Properties
+
+Functions
+
+
+
+
+addAttachment
+
+fun addAttachment ( attachment : Attachment ) : Unit
+
+
+
+addCommand
+
+fun addCommand ( arg : Command ) : Unit fun addCommand ( data : CommandData , vararg keys : PublicKey ) : <ERROR CLASS> fun addCommand ( data : CommandData , keys : List < PublicKey > ) : Unit
+
+
+
+addInputState
+
+fun addInputState ( ref : StateRef ) : Unit
+
+
+
+addOutputState
+
+fun addOutputState ( state : ContractState ) : Unit
+
+
+
+addSignatureUnchecked
+
+fun addSignatureUnchecked ( sig : WithKey ) : Unit Adds the signature directly to the transaction, without checking it for validity.
+
+
+
+
+attachments
+
+fun attachments ( ) : List < SecureHash >
+
+
+
+checkAndAddSignature
+
+fun checkAndAddSignature ( sig : WithKey ) : Unit Checks that the given signature matches one of the commands and that it is a correct signature over the tx, then
+adds it.
+
+
+
+
+checkSignature
+
+fun checkSignature ( sig : WithKey ) : Unit Checks that the given signature matches one of the commands and that it is a correct signature over the tx.
+
+
+
+
+commands
+
+fun commands ( ) : List < Command >
+
+
+
+inputStates
+
+fun inputStates ( ) : List < StateRef >
+
+
+
+outputStates
+
+fun outputStates ( ) : List < ContractState >
+
+
+
+setTime
+
+fun setTime ( time : Instant , authenticatedBy : Party , timeTolerance : Duration ) : Unit Places a TimestampCommand in this transaction, removing any existing command if there is one.
+To get the right signature from the timestamping service, use the timestamp method after building is
+finished, or run use the TimestampingProtocol yourself.
+
+
+
+
+signWith
+
+fun signWith ( key : KeyPair ) : Unit
+
+
+
+timestamp
+
+fun timestamp ( timestamper : TimestamperService , clock : Clock = Clock.systemUTC()) : Unit Uses the given timestamper service to request a signature over the WireTransaction be added. There must always be
+at least one such signature, but others may be added as well. You may want to have multiple redundant timestamps
+in the following cases:
+
+
+
+
+toSignedTransaction
+
+fun toSignedTransaction ( checkSufficientSignatures : Boolean = true) : SignedTransaction
+
+
+
+toWireTransaction
+
+fun toWireTransaction ( ) : WireTransaction
+
+
+
+withItems
+
+fun withItems ( vararg items : Any ) : TransactionBuilder A more convenient way to add items to this transaction that calls the add* methods for you based on type
+
+
+
+
+
+
diff --git a/docs/build/html/api/core/-transaction-builder/input-states.html b/docs/build/html/api/core/-transaction-builder/input-states.html
new file mode 100644
index 0000000000..895cde09ac
--- /dev/null
+++ b/docs/build/html/api/core/-transaction-builder/input-states.html
@@ -0,0 +1,15 @@
+
+
+TransactionBuilder.inputStates -
+core / TransactionBuilder / inputStates inputStates
+fun inputStates ( ) : List < StateRef > TransactionBuilder.outputStates -
+core / TransactionBuilder / outputStates outputStates
+fun outputStates ( ) : List < ContractState > TransactionBuilder.setTime -
+core / TransactionBuilder / setTime setTime
+fun setTime ( time : Instant , authenticatedBy : Party , timeTolerance : Duration ) : Unit Places a TimestampCommand in this transaction, removing any existing command if there is one.
+To get the right signature from the timestamping service, use the timestamp method after building is
+finished, or run use the TimestampingProtocol yourself.
+The window of time in which the final timestamp may lie is defined as time +/- timeTolerance .
+If you want a non-symmetrical time window you must add the command via addCommand yourself. The tolerance
+should be chosen such that your code can finish building the transaction and sending it to the TSA within that
+window of time, taking into account factors such as network latency. Transactions being built by a group of
+collaborating parties may therefore require a higher time tolerance than a transaction being built by a single
+node.
+TransactionBuilder.signWith -
+core / TransactionBuilder / signWith signWith
+fun signWith ( key : KeyPair ) : Unit TransactionBuilder.time -
+core / TransactionBuilder / time time
+val time : TimestampCommand ? TransactionBuilder.timestamp -
+core / TransactionBuilder / timestamp timestamp
+fun timestamp ( timestamper : TimestamperService , clock : Clock = Clock.systemUTC()) : Unit Uses the given timestamper service to request a signature over the WireTransaction be added. There must always be
+at least one such signature, but others may be added as well. You may want to have multiple redundant timestamps
+in the following cases:
+The signature of the trusted timestamper merely asserts that the time field of this transaction is valid.
+TransactionBuilder.toSignedTransaction -
+core / TransactionBuilder / toSignedTransaction toSignedTransaction
+fun toSignedTransaction ( checkSufficientSignatures : Boolean = true) : SignedTransaction TransactionBuilder.toWireTransaction -
+core / TransactionBuilder / toWireTransaction toWireTransaction
+fun toWireTransaction ( ) : WireTransaction TransactionBuilder.withItems -
+core / TransactionBuilder / withItems withItems
+fun withItems ( vararg items : Any ) : TransactionBuilder A more convenient way to add items to this transaction that calls the add* methods for you based on type
+TransactionConflictException.<init> -
+core / TransactionConflictException / <init> <init>
+TransactionConflictException ( conflictRef : StateRef , tx1 : LedgerTransaction , tx2 : LedgerTransaction ) TransactionConflictException.conflictRef -
+core / TransactionConflictException / conflictRef conflictRef
+val conflictRef : StateRef TransactionConflictException -
+core / TransactionConflictException TransactionConflictException
+class TransactionConflictException : Exception Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core/-transaction-conflict-exception/tx1.html b/docs/build/html/api/core/-transaction-conflict-exception/tx1.html
new file mode 100644
index 0000000000..acbf905a20
--- /dev/null
+++ b/docs/build/html/api/core/-transaction-conflict-exception/tx1.html
@@ -0,0 +1,15 @@
+
+
+TransactionConflictException.tx1 -
+core / TransactionConflictException / tx1 tx1
+val tx1 : LedgerTransaction TransactionConflictException.tx2 -
+core / TransactionConflictException / tx2 tx2
+val tx2 : LedgerTransaction TransactionForVerification.InOutGroup.<init> -
+core / TransactionForVerification / InOutGroup / <init> <init>
+InOutGroup ( inputs : List < T > , outputs : List < T > , groupingKey : K ) A set of related inputs and outputs that are connected by some common attributes. An InOutGroup is calculated
+using groupStates and is useful for handling cases where a transaction may contain similar but unrelated
+state evolutions, for example, a transaction that moves cash in two different currencies. The numbers must add
+up on both sides of the transaction, but the values must be summed independently per currency. Grouping can
+be used to simplify this logic.
+TransactionForVerification.InOutGroup.groupingKey -
+core / TransactionForVerification / InOutGroup / groupingKey groupingKey
+val groupingKey : K TransactionForVerification.InOutGroup -
+core / TransactionForVerification / InOutGroup InOutGroup
+data class InOutGroup < T : ContractState , K : Any > A set of related inputs and outputs that are connected by some common attributes. An InOutGroup is calculated
+using groupStates and is useful for handling cases where a transaction may contain similar but unrelated
+state evolutions, for example, a transaction that moves cash in two different currencies. The numbers must add
+up on both sides of the transaction, but the values must be summed independently per currency. Grouping can
+be used to simplify this logic.
+Constructors
+
+
+
+
+<init>
+
+InOutGroup ( inputs : List < T > , outputs : List < T > , groupingKey : K ) A set of related inputs and outputs that are connected by some common attributes. An InOutGroup is calculated
+using groupStates and is useful for handling cases where a transaction may contain similar but unrelated
+state evolutions, for example, a transaction that moves cash in two different currencies. The numbers must add
+up on both sides of the transaction, but the values must be summed independently per currency. Grouping can
+be used to simplify this logic.
+
+
+
+
+Properties
+
+
+
+
+groupingKey
+
+val groupingKey : K
+
+
+
+inputs
+
+val inputs : List < T >
+
+
+
+outputs
+
+val outputs : List < T >
+
+
+
+
+
diff --git a/docs/build/html/api/core/-transaction-for-verification/-in-out-group/inputs.html b/docs/build/html/api/core/-transaction-for-verification/-in-out-group/inputs.html
new file mode 100644
index 0000000000..9eee402d4a
--- /dev/null
+++ b/docs/build/html/api/core/-transaction-for-verification/-in-out-group/inputs.html
@@ -0,0 +1,15 @@
+
+
+TransactionForVerification.InOutGroup.inputs -
+core / TransactionForVerification / InOutGroup / inputs inputs
+val inputs : List < T > TransactionForVerification.InOutGroup.outputs -
+core / TransactionForVerification / InOutGroup / outputs outputs
+val outputs : List < T > TransactionForVerification.<init> -
+core / TransactionForVerification / <init> <init>
+TransactionForVerification ( inStates : List < ContractState > , outStates : List < ContractState > , attachments : List < Attachment > , commands : List < AuthenticatedObject < CommandData > > , origHash : SecureHash ) A transaction in fully resolved and sig-checked form, ready for passing as input to a verification function.
+TransactionForVerification.attachments -
+core / TransactionForVerification / attachments attachments
+val attachments : List < Attachment > TransactionForVerification.commands -
+core / TransactionForVerification / commands commands
+val commands : List < AuthenticatedObject < CommandData > > TransactionForVerification.equals -
+core / TransactionForVerification / equals equals
+fun equals ( other : Any ? ) : Boolean TransactionForVerification.getTimestampBy -
+core / TransactionForVerification / getTimestampBy getTimestampBy
+fun getTimestampBy ( timestampingAuthority : Party ) : TimestampCommand ? Simply calls commands.getTimestampBy as a shortcut to make code completion more intuitive.
+TransactionForVerification.groupStatesInternal -
+core / TransactionForVerification / groupStatesInternal groupStatesInternal
+fun < T : ContractState , K : Any > groupStatesInternal ( inGroups : Map < K , List < T > > , outGroups : Map < K , List < T > > ) : List < InOutGroup < T , K > > Deprecated: Do not use this directly: exposed as public only due to function inliningTransactionForVerification.groupStates -
+core / TransactionForVerification / groupStates groupStates
+fun < T : ContractState , K : Any > groupStates ( ofType : Class < T > , selector : ( T ) -> K ) : List < InOutGroup < T , K > > Given a type and a function that returns a grouping key, associates inputs and outputs together so that they
+can be processed as one. The grouping key is any arbitrary object that can act as a map key (so must implement
+equals and hashCode).
+The purpose of this function is to simplify the writing of verification logic for transactions that may contain
+similar but unrelated state evolutions which need to be checked independently. Consider a transaction that
+simultaneously moves both dollars and euros (e.g. is an atomic FX trade). There may be multiple dollar inputs and
+multiple dollar outputs, depending on things like how fragmented the owners wallet is and whether various privacy
+techniques are in use. The quantity of dollars on the output side must sum to the same as on the input side, to
+ensure no money is being lost track of. This summation and checking must be repeated independently for each
+currency. To solve this, you would use groupStates with a type of Cash.State and a selector that returns the
+currency field: the resulting list can then be iterated over to perform the per-currency calculation.
+inline fun < reified T : ContractState , K : Any > groupStates ( selector : ( T ) -> K ) : List < InOutGroup < T , K > > See the documentation for the reflection-based version of groupStates
+TransactionForVerification.hashCode -
+core / TransactionForVerification / hashCode hashCode
+fun hashCode ( ) : Int TransactionForVerification.inStates -
+core / TransactionForVerification / inStates inStates
+val inStates : List < ContractState > TransactionForVerification -
+core / TransactionForVerification TransactionForVerification
+data class TransactionForVerification A transaction in fully resolved and sig-checked form, ready for passing as input to a verification function.
+Types
+
+
+
+
+InOutGroup
+
+data class InOutGroup < T : ContractState , K : Any > A set of related inputs and outputs that are connected by some common attributes. An InOutGroup is calculated
+using groupStates and is useful for handling cases where a transaction may contain similar but unrelated
+state evolutions, for example, a transaction that moves cash in two different currencies. The numbers must add
+up on both sides of the transaction, but the values must be summed independently per currency. Grouping can
+be used to simplify this logic.
+
+
+
+
+Constructors
+
+Properties
+
+Functions
+
+
+
+
+equals
+
+fun equals ( other : Any ? ) : Boolean
+
+
+
+getTimestampBy
+
+fun getTimestampBy ( timestampingAuthority : Party ) : TimestampCommand ? Simply calls commands.getTimestampBy as a shortcut to make code completion more intuitive.
+
+
+
+
+groupStates
+
+fun < T : ContractState , K : Any > groupStates ( ofType : Class < T > , selector : ( T ) -> K ) : List < InOutGroup < T , K > > Given a type and a function that returns a grouping key, associates inputs and outputs together so that they
+can be processed as one. The grouping key is any arbitrary object that can act as a map key (so must implement
+equals and hashCode).
+fun < T : ContractState , K : Any > groupStates ( selector : ( T ) -> K ) : List < InOutGroup < T , K > > See the documentation for the reflection-based version of groupStates
+
+
+
+
+groupStatesInternal
+
+fun < T : ContractState , K : Any > groupStatesInternal ( inGroups : Map < K , List < T > > , outGroups : Map < K , List < T > > ) : List < InOutGroup < T , K > >
+
+
+
+hashCode
+
+fun hashCode ( ) : Int
+
+
+
+verify
+
+fun verify ( ) : Unit Runs the contracts for this transaction.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core/-transaction-for-verification/orig-hash.html b/docs/build/html/api/core/-transaction-for-verification/orig-hash.html
new file mode 100644
index 0000000000..d1d8e09a3d
--- /dev/null
+++ b/docs/build/html/api/core/-transaction-for-verification/orig-hash.html
@@ -0,0 +1,15 @@
+
+
+TransactionForVerification.origHash -
+core / TransactionForVerification / origHash origHash
+val origHash : SecureHash TransactionForVerification.outStates -
+core / TransactionForVerification / outStates outStates
+val outStates : List < ContractState > TransactionForVerification.verify -
+core / TransactionForVerification / verify verify
+fun verify ( ) : Unit Runs the contracts for this transaction.
+TODO: Move this out of the core data structure definitions, once unit tests are more cleanly separated.
+Exceptions
+TransactionVerificationException - if a contract throws an exception, the original is in the cause fieldIllegalStateException - if a state refers to an unknown contract.TransactionGraphSearch.<init> -
+core / TransactionGraphSearch / <init> <init>
+TransactionGraphSearch ( transactions : Map < SecureHash , SignedTransaction > , startPoints : List < WireTransaction > ) Given a map of transaction id to SignedTransaction , performs a breadth first search of the dependency graph from
+the starting point down in order to find transactions that match the given query criteria.
+Currently, only one kind of query is supported: find any transaction that contains a command of the given type.
+In future, this should support restricting the search by time, and other types of useful query.
+TODO: Write unit tests for this.
+TransactionGraphSearch.Query.<init> -
+core / TransactionGraphSearch / Query / <init> <init>
+Query ( withCommandOfType : Class < out CommandData > ? = null) TransactionGraphSearch.Query -
+core / TransactionGraphSearch / Query Query
+class Query Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core/-transaction-graph-search/-query/with-command-of-type.html b/docs/build/html/api/core/-transaction-graph-search/-query/with-command-of-type.html
new file mode 100644
index 0000000000..9424443322
--- /dev/null
+++ b/docs/build/html/api/core/-transaction-graph-search/-query/with-command-of-type.html
@@ -0,0 +1,15 @@
+
+
+TransactionGraphSearch.Query.withCommandOfType -
+core / TransactionGraphSearch / Query / withCommandOfType withCommandOfType
+val withCommandOfType : Class < out CommandData > ? TransactionGraphSearch.call -
+core / TransactionGraphSearch / call call
+fun call ( ) : List < WireTransaction > TransactionGraphSearch -
+core / TransactionGraphSearch TransactionGraphSearch
+class TransactionGraphSearch : Callable < List < WireTransaction > > Given a map of transaction id to SignedTransaction , performs a breadth first search of the dependency graph from
+the starting point down in order to find transactions that match the given query criteria.
+Currently, only one kind of query is supported: find any transaction that contains a command of the given type.
+In future, this should support restricting the search by time, and other types of useful query.
+TODO: Write unit tests for this.
+Types
+
+
+
+
+Query
+
+class Query
+
+
+
+Constructors
+
+
+
+
+<init>
+
+TransactionGraphSearch ( transactions : Map < SecureHash , SignedTransaction > , startPoints : List < WireTransaction > ) Given a map of transaction id to SignedTransaction , performs a breadth first search of the dependency graph from
+the starting point down in order to find transactions that match the given query criteria.
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-transaction-graph-search/query.html b/docs/build/html/api/core/-transaction-graph-search/query.html
new file mode 100644
index 0000000000..bd7adebefc
--- /dev/null
+++ b/docs/build/html/api/core/-transaction-graph-search/query.html
@@ -0,0 +1,15 @@
+
+
+TransactionGraphSearch.query -
+core / TransactionGraphSearch / query query
+var query : Query TransactionGraphSearch.startPoints -
+core / TransactionGraphSearch / startPoints startPoints
+val startPoints : List < WireTransaction > TransactionGraphSearch.transactions -
+core / TransactionGraphSearch / transactions transactions
+val transactions : Map < SecureHash , SignedTransaction > TransactionGroup.<init> -
+core / TransactionGroup / <init> <init>
+TransactionGroup ( transactions : Set < LedgerTransaction > , nonVerifiedRoots : Set < LedgerTransaction > ) A TransactionGroup defines a directed acyclic graph of transactions that can be resolved with each other and then
+verified. Successful verification does not imply the non-existence of other conflicting transactions: simply that
+this subgraph does not contain conflicts and is accepted by the involved contracts.
+The inputs of the provided transactions must be resolvable either within the transactions set, or from the
+nonVerifiedRoots set. Transactions in the non-verified set are ignored other than for looking up input states.
+TransactionGroup -
+core / TransactionGroup TransactionGroup
+class TransactionGroup A TransactionGroup defines a directed acyclic graph of transactions that can be resolved with each other and then
+verified. Successful verification does not imply the non-existence of other conflicting transactions: simply that
+this subgraph does not contain conflicts and is accepted by the involved contracts.
+The inputs of the provided transactions must be resolvable either within the transactions set, or from the
+nonVerifiedRoots set. Transactions in the non-verified set are ignored other than for looking up input states.
+Constructors
+
+
+
+
+<init>
+
+TransactionGroup ( transactions : Set < LedgerTransaction > , nonVerifiedRoots : Set < LedgerTransaction > ) A TransactionGroup defines a directed acyclic graph of transactions that can be resolved with each other and then
+verified. Successful verification does not imply the non-existence of other conflicting transactions: simply that
+this subgraph does not contain conflicts and is accepted by the involved contracts.
+
+
+
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/core/-transaction-group/non-verified-roots.html b/docs/build/html/api/core/-transaction-group/non-verified-roots.html
new file mode 100644
index 0000000000..fb6464118f
--- /dev/null
+++ b/docs/build/html/api/core/-transaction-group/non-verified-roots.html
@@ -0,0 +1,15 @@
+
+
+TransactionGroup.nonVerifiedRoots -
+core / TransactionGroup / nonVerifiedRoots nonVerifiedRoots
+val nonVerifiedRoots : Set < LedgerTransaction > TransactionGroup.transactions -
+core / TransactionGroup / transactions transactions
+val transactions : Set < LedgerTransaction > TransactionGroup.verify -
+core / TransactionGroup / verify verify
+fun verify ( ) : Set < TransactionForVerification > Verifies the group and returns the set of resolved transactions.
+TransactionResolutionException.<init> -
+core / TransactionResolutionException / <init> <init>
+TransactionResolutionException ( hash : SecureHash ) TransactionResolutionException.hash -
+core / TransactionResolutionException / hash hash
+val hash : SecureHash TransactionResolutionException -
+core / TransactionResolutionException TransactionResolutionException
+class TransactionResolutionException : Exception Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core/-transaction-verification-exception/-init-.html b/docs/build/html/api/core/-transaction-verification-exception/-init-.html
new file mode 100644
index 0000000000..38662d55cc
--- /dev/null
+++ b/docs/build/html/api/core/-transaction-verification-exception/-init-.html
@@ -0,0 +1,15 @@
+
+
+TransactionVerificationException.<init> -
+core / TransactionVerificationException / <init> <init>
+TransactionVerificationException ( tx : TransactionForVerification , contract : Contract , cause : Throwable ? ) Thrown if a verification fails due to a contract rejection.
+TransactionVerificationException.contract -
+core / TransactionVerificationException / contract contract
+val contract : Contract TransactionVerificationException -
+core / TransactionVerificationException TransactionVerificationException
+class TransactionVerificationException : Exception Thrown if a verification fails due to a contract rejection.
+Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/core/-transaction-verification-exception/tx.html b/docs/build/html/api/core/-transaction-verification-exception/tx.html
new file mode 100644
index 0000000000..2a59509917
--- /dev/null
+++ b/docs/build/html/api/core/-transaction-verification-exception/tx.html
@@ -0,0 +1,15 @@
+
+
+TransactionVerificationException.tx -
+core / TransactionVerificationException / tx tx
+val tx : TransactionForVerification TransientProperty.<init> -
+core / TransientProperty / <init> <init>
+TransientProperty ( initializer : ( ) -> T ) A simple wrapper that enables the use of Kotlins "val x by TransientProperty { ... }" syntax. Such a property
+will not be serialized to disk, and if its missing (or the first time its accessed), the initializer will be
+used to set it up. Note that the initializer will be called with the TransientProperty object locked.
+TransientProperty.getValue -
+core / TransientProperty / getValue getValue
+operator fun getValue ( thisRef : Any ? , property : KProperty < * > ) : T TransientProperty -
+core / TransientProperty TransientProperty
+class TransientProperty < T > A simple wrapper that enables the use of Kotlins "val x by TransientProperty { ... }" syntax. Such a property
+will not be serialized to disk, and if its missing (or the first time its accessed), the initializer will be
+used to set it up. Note that the initializer will be called with the TransientProperty object locked.
+Constructors
+
+
+
+
+<init>
+
+TransientProperty ( initializer : ( ) -> T ) A simple wrapper that enables the use of Kotlins "val x by TransientProperty { ... }" syntax. Such a property
+will not be serialized to disk, and if its missing (or the first time its accessed), the initializer will be
+used to set it up. Note that the initializer will be called with the TransientProperty object locked.
+
+
+
+
+Functions
+
+
+
+
+getValue
+
+operator fun getValue ( thisRef : Any ? , property : KProperty < * > ) : T
+
+
+
+
+
diff --git a/docs/build/html/api/core/-type-only-command-data/-init-.html b/docs/build/html/api/core/-type-only-command-data/-init-.html
new file mode 100644
index 0000000000..a9567477e0
--- /dev/null
+++ b/docs/build/html/api/core/-type-only-command-data/-init-.html
@@ -0,0 +1,15 @@
+
+
+TypeOnlyCommandData.<init> -
+core / TypeOnlyCommandData / <init> <init>
+TypeOnlyCommandData ( ) Commands that inherit from this are intended to have no data items: its only their presence that matters.
+TypeOnlyCommandData.equals -
+core / TypeOnlyCommandData / equals equals
+open fun equals ( other : Any ? ) : Boolean TypeOnlyCommandData.hashCode -
+core / TypeOnlyCommandData / hashCode hashCode
+open fun hashCode ( ) : <ERROR CLASS> TypeOnlyCommandData -
+core / TypeOnlyCommandData TypeOnlyCommandData
+abstract class TypeOnlyCommandData : CommandData Commands that inherit from this are intended to have no data items: its only their presence that matters.
+Constructors
+
+
+
+
+<init>
+
+TypeOnlyCommandData ( ) Commands that inherit from this are intended to have no data items: its only their presence that matters.
+
+
+
+
+Functions
+
+
+
+
+equals
+
+open fun equals ( other : Any ? ) : Boolean
+
+
+
+hashCode
+
+open fun hashCode ( ) : <ERROR CLASS>
+
+
+
+Inheritors
+
+
+
+
+Agree
+
+class Agree : TypeOnlyCommandData , Commands
+
+
+
+Close
+
+class Close : TypeOnlyCommandData , Commands
+
+
+
+Create
+
+class Create : TypeOnlyCommandData , Commands
+
+
+
+Fix
+
+class Fix : TypeOnlyCommandData , Commands
+
+
+
+Issue
+
+class Issue : TypeOnlyCommandData , Commands
+
+
+
+Mature
+
+class Mature : TypeOnlyCommandData , Commands
+
+
+
+Move
+
+class Move : TypeOnlyCommandData , Commands
+
+
+
+Move
+
+class Move : TypeOnlyCommandData , Commands
+
+
+
+Pay
+
+class Pay : TypeOnlyCommandData , Commands
+
+
+
+Pledge
+
+class Pledge : TypeOnlyCommandData , Commands
+
+
+
+Redeem
+
+class Redeem : TypeOnlyCommandData , Commands
+
+
+
+Register
+
+class Register : TypeOnlyCommandData , Commands
+
+
+
+
+
diff --git a/docs/build/html/api/core/-u-s-d.html b/docs/build/html/api/core/-u-s-d.html
new file mode 100644
index 0000000000..181dc00b36
--- /dev/null
+++ b/docs/build/html/api/core/-u-s-d.html
@@ -0,0 +1,15 @@
+
+
+USD -
+core / USD USD
+val USD : Currency WireTransaction.<init> -
+core / WireTransaction / <init> <init>
+WireTransaction ( inputs : List < StateRef > , attachments : List < SecureHash > , outputs : List < ContractState > , commands : List < Command > ) Transaction ready for serialisation, without any signatures attached.
+WireTransaction.attachments -
+core / WireTransaction / attachments attachments
+val attachments : List < SecureHash > WireTransaction.commands -
+core / WireTransaction / commands commands
+val commands : List < Command > WireTransaction.deserialize -
+core / WireTransaction / deserialize deserialize
+fun deserialize ( bits : SerializedBytes < WireTransaction > , kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : WireTransaction WireTransaction.id -
+core / WireTransaction / id id
+val id : SecureHash NamedByHash.id WireTransaction -
+core / WireTransaction WireTransaction
+data class WireTransaction : NamedByHash Transaction ready for serialisation, without any signatures attached.
+Constructors
+
+Properties
+
+Functions
+
+Companion Object Functions
+
+
+
+
+deserialize
+
+fun deserialize ( bits : SerializedBytes < WireTransaction > , kryo : <ERROR CLASS> = THREAD_LOCAL_KRYO.get()) : WireTransaction
+
+
+
+Extension Functions
+
+
+
diff --git a/docs/build/html/api/core/-wire-transaction/inputs.html b/docs/build/html/api/core/-wire-transaction/inputs.html
new file mode 100644
index 0000000000..442019e737
--- /dev/null
+++ b/docs/build/html/api/core/-wire-transaction/inputs.html
@@ -0,0 +1,15 @@
+
+
+WireTransaction.inputs -
+core / WireTransaction / inputs inputs
+val inputs : List < StateRef > WireTransaction.outRef -
+core / WireTransaction / outRef outRef
+fun < T : ContractState > outRef ( index : Int ) : StateAndRef < T > Returns a StateAndRef for the given output index.
+fun < T : ContractState > outRef ( state : ContractState ) : StateAndRef < T > Returns a StateAndRef for the requested output state, or throws IllegalArgumentException if not found.
+WireTransaction.outputs -
+core / WireTransaction / outputs outputs
+val outputs : List < ContractState > WireTransaction.serialized -
+core / WireTransaction / serialized serialized
+val serialized : SerializedBytes < WireTransaction > WireTransaction.toString -
+core / WireTransaction / toString toString
+fun toString ( ) : String calculateDaysBetween -
+core / calculateDaysBetween calculateDaysBetween
+fun calculateDaysBetween ( startDate : LocalDate , endDate : LocalDate , dcbYear : DayCountBasisYear , dcbDay : DayCountBasisDay ) : Int currency -
+core / currency currency
+fun currency ( code : String ) : Currency Defines a simple domain specific language for the specificiation of financial contracts. Currently covers:
+Some utilities for working with commands.
+Code for working with currencies.
+An Amount type that represents a positive quantity of a specific currency.
+A simple language extension for specifying requirements in English, along with logic to enforce them.
+TODO: Look into replacing Currency and Amount with CurrencyUnit and MonetaryAmount from the javax.money API (JSR 354)
+extractZipFile -
+core / extractZipFile extractZipFile
+fun extractZipFile ( : Path , : Path ) : Unit Given a path to a zip file, extracts it to the given directory.
+failure -
+core / failure failure
+fun < T > <ERROR CLASS> < T > . failure ( executor : Executor , body : ( Throwable ) -> Unit ) : <ERROR CLASS> infix fun < T > <ERROR CLASS> < T > . failure ( body : ( Throwable ) -> Unit ) : <ERROR CLASS> < T > hash -
+core / hash hash
+fun ContractState . hash ( ) : SecureHash Returns the SHA-256 hash of the serialised contents of this state (not cached)
+core -
+core Package core
+Types
+
+
+
+
+AccrualAdjustment
+
+enum class AccrualAdjustment Simple enum for returning accurals adjusted or unadjusted.
+We dont actually do anything with this yet though, so its ignored for now.
+
+
+
+
+Amount
+
+data class Amount : Comparable < Amount > Amount represents a positive quantity of currency, measured in pennies, which are the smallest representable units.
+
+
+
+
+Attachment
+
+interface Attachment : NamedByHash An attachment is a ZIP (or an optionally signed JAR) that contains one or more files. Attachments are meant to
+contain public static data which can be referenced from transactions and utilised from contracts. Good examples
+of how attachments are meant to be used include:
+
+
+
+
+AuthenticatedObject
+
+data class AuthenticatedObject < out T : Any > Wraps an object that was signed by a public key, which may be a well known/recognised institutional key.
+
+
+
+
+BusinessCalendar
+
+open class BusinessCalendar A business calendar performs date calculations that take into account national holidays and weekends. This is a
+typical feature of financial contracts, in which a business may not want a payment event to fall on a day when
+no staff are around to handle problems.
+
+
+
+
+Command
+
+data class Command Command data/content plus pubkey pair: the signature is stored at the end of the serialized bytes
+
+
+
+
+CommandData
+
+interface CommandData Marker interface for classes that represent commands
+
+
+
+
+Contract
+
+interface Contract Implemented by a program that implements business logic on the shared ledger. All participants run this code for
+every LedgerTransaction they see on the network, for every input and output state. All contracts must accept the
+transaction for it to be accepted: failure of any aborts the entire thing. The time is taken from a trusted
+timestamp attached to the transaction itself i.e. it is NOT necessarily the current time.
+
+
+
+
+ContractState
+
+interface ContractState A contract state (or just "state") contains opaque data used by a contract program. It can be thought of as a disk
+file that the program can use to persist data across transactions. States are immutable: once created they are never
+updated, instead, any changes must generate a new successor state.
+
+
+
+
+DateOffset
+
+enum class DateOffset Date offset that the fixing is done prior to the accrual start date.
+Currently not used in the calculation.
+
+
+
+
+DateRollConvention
+
+enum class DateRollConvention This reflects what happens if a date on which a business event is supposed to happen actually falls upon a non-working day
+Depending on the accounting requirement, we can move forward until we get to a business day, or backwards
+There are some additional rules which are explained in the individual cases below
+
+
+
+
+DateRollDirection
+
+enum class DateRollDirection This is utilised in the DateRollConvention class to determine which way we should initially step when
+finding a business day
+
+
+
+
+DayCountBasisDay
+
+enum class DayCountBasisDay This forms the day part of the "Day Count Basis" used for interest calculation.
+Note that the first character cannot be a number (enum naming constraints), so we drop that
+in the toString lest some people get confused.
+
+
+
+
+DayCountBasisYear
+
+enum class DayCountBasisYear This forms the year part of the "Day Count Basis" used for interest calculation.
+
+
+
+
+Expression
+
+data class Expression Represents a textual expression of e.g. a formula
+
+
+
+
+ExpressionDeserializer
+
+object ExpressionDeserializer
+
+
+
+ExpressionSerializer
+
+object ExpressionSerializer
+
+
+
+Fix
+
+data class Fix : CommandData A Fix represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx.
+
+
+
+
+FixOf
+
+data class FixOf A FixOf identifies the question side of a fix: what day, tenor and type of fix ("LIBOR", "EURIBOR" etc)
+
+
+
+
+Frequency
+
+enum class Frequency Frequency at which an event occurs - the enumerator also casts to an integer specifying the number of times per year
+that would divide into (eg annually = 1, semiannual = 2, monthly = 12 etc).
+
+
+
+
+LedgerTransaction
+
+data class LedgerTransaction : NamedByHash A LedgerTransaction wraps the data needed to calculate one or more successor states from a set of input states.
+It is the first step after extraction from a WireTransaction. The signatures at this point have been lined up
+with the commands from the wire, and verified/looked up.
+
+
+
+
+LinearState
+
+interface LinearState : ContractState A state that evolves by superseding itself, all of which share the common "thread"
+
+
+
+
+NamedByHash
+
+interface NamedByHash Implemented by anything that can be named by a secure hash value (e.g. transactions, attachments).
+
+
+
+
+OwnableState
+
+interface OwnableState : ContractState
+
+
+
+Party
+
+data class Party A Party is well known (name, pubkey) pair. In a real system this would probably be an X.509 certificate.
+
+
+
+
+PartyReference
+
+data class PartyReference Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal
+ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.
+
+
+
+
+PaymentRule
+
+enum class PaymentRule Whether the payment should be made before the due date, or after it.
+
+
+
+
+Requirements
+
+class Requirements
+
+
+
+SignedTransaction
+
+data class SignedTransaction : NamedByHash Container for a WireTransaction and attached signatures.
+
+
+
+
+StateAndRef
+
+data class StateAndRef < out T : ContractState > A StateAndRef is simply a (state, ref) pair. For instance, a wallet (which holds available assets) contains these.
+
+
+
+
+StateRef
+
+data class StateRef A stateref is a pointer (reference) to a state, this is an equivalent of an "outpoint" in Bitcoin. It records which
+transaction defined the state and where in that transaction it was.
+
+
+
+
+Tenor
+
+data class Tenor Placeholder class for the Tenor datatype - which is a standardised duration of time until maturity
+
+
+
+
+ThreadBox
+
+class ThreadBox < T > A threadbox is a simple utility that makes it harder to forget to take a lock before accessing some shared state.
+Simply define a private class to hold the data that must be grouped under the same lock, and then pass the only
+instance to the ThreadBox constructor. You can now use the locked method with a lambda to take the lock in a
+way that ensures itll be released if theres an exception.
+
+
+
+
+TimestampCommand
+
+data class TimestampCommand : CommandData If present in a transaction, contains a time that was verified by the timestamping authority/authorities whose
+public keys are identified in the containing Command object. The true time must be between (after, before)
+
+
+
+
+TransactionBuilder
+
+class TransactionBuilder A TransactionBuilder is a transaction class thats mutable (unlike the others which are all immutable). It is
+intended to be passed around contracts that may edit it by adding new states/commands or modifying the existing set.
+Then once the states and commands are right, this class can be used as a holding bucket to gather signatures from
+multiple parties.
+
+
+
+
+TransactionForVerification
+
+data class TransactionForVerification A transaction in fully resolved and sig-checked form, ready for passing as input to a verification function.
+
+
+
+
+TransactionGraphSearch
+
+class TransactionGraphSearch : Callable < List < WireTransaction > > Given a map of transaction id to SignedTransaction , performs a breadth first search of the dependency graph from
+the starting point down in order to find transactions that match the given query criteria.
+
+
+
+
+TransactionGroup
+
+class TransactionGroup A TransactionGroup defines a directed acyclic graph of transactions that can be resolved with each other and then
+verified. Successful verification does not imply the non-existence of other conflicting transactions: simply that
+this subgraph does not contain conflicts and is accepted by the involved contracts.
+
+
+
+
+TransientProperty
+
+class TransientProperty < T > A simple wrapper that enables the use of Kotlins "val x by TransientProperty { ... }" syntax. Such a property
+will not be serialized to disk, and if its missing (or the first time its accessed), the initializer will be
+used to set it up. Note that the initializer will be called with the TransientProperty object locked.
+
+
+
+
+TypeOnlyCommandData
+
+abstract class TypeOnlyCommandData : CommandData Commands that inherit from this are intended to have no data items: its only their presence that matters.
+
+
+
+
+WireTransaction
+
+data class WireTransaction : NamedByHash Transaction ready for serialisation, without any signatures attached.
+
+
+
+
+Exceptions
+
+Extensions for External Classes
+
+Properties
+
+Functions
+
+
+
+
+calculateDaysBetween
+
+fun calculateDaysBetween ( startDate : LocalDate , endDate : LocalDate , dcbYear : DayCountBasisYear , dcbDay : DayCountBasisDay ) : Int
+
+
+
+currency
+
+fun currency ( code : String ) : Currency Defines a simple domain specific language for the specificiation of financial contracts. Currently covers:
+
+
+
+
+extractZipFile
+
+fun extractZipFile ( : Path , : Path ) : Unit Given a path to a zip file, extracts it to the given directory.
+
+
+
+
+failure
+
+fun < T > <ERROR CLASS> < T > . failure ( executor : Executor , body : ( Throwable ) -> Unit ) : <ERROR CLASS> infix fun < T > <ERROR CLASS> < T > . failure ( body : ( Throwable ) -> Unit ) : <ERROR CLASS> < T >
+
+
+
+hash
+
+fun ContractState . hash ( ) : SecureHash Returns the SHA-256 hash of the serialised contents of this state (not cached)
+
+
+
+
+logElapsedTime
+
+fun < T > logElapsedTime ( label : String , logger : <ERROR CLASS> ? = null, body : ( ) -> T ) : T
+
+
+
+random63BitValue
+
+fun random63BitValue ( ) : Long Returns a random positive long generated using a secure RNG. This function sacrifies a bit of entropy in order to
+avoid potential bugs where the value is used in a context where negative numbers are not expected.
+
+
+
+
+requireThat
+
+fun < R > requireThat ( body : Requirements . ( ) -> R ) : R
+
+
+
+setFrom
+
+fun < T > <ERROR CLASS> < T > . setFrom ( logger : <ERROR CLASS> ? = null, block : ( ) -> T ) : <ERROR CLASS> < T > Executes the given block and sets the future to either the result, or any exception that was thrown.
+
+
+
+
+success
+
+fun < T > <ERROR CLASS> < T > . success ( executor : Executor , body : ( T ) -> Unit ) : <ERROR CLASS> infix fun < T > <ERROR CLASS> < T > . success ( body : ( T ) -> Unit ) : <ERROR CLASS> < T >
+
+
+
+then
+
+fun < T > <ERROR CLASS> < T > . then ( executor : Executor , body : ( ) -> Unit ) : <ERROR CLASS> infix fun < T > <ERROR CLASS> < T > . then ( body : ( ) -> Unit ) : <ERROR CLASS> < T >
+
+
+
+toLedgerTransaction
+
+fun WireTransaction . toLedgerTransaction ( identityService : IdentityService , attachmentStorage : AttachmentStorage ) : LedgerTransaction Looks up identities and attachments from storage to generate a LedgerTransaction .
+
+
+
+
+verifyToLedgerTransaction
+
+fun SignedTransaction . verifyToLedgerTransaction ( identityService : IdentityService , attachmentStorage : AttachmentStorage ) : LedgerTransaction Calls verify to check all required signatures are present, and then uses the passed IdentityService to call
+WireTransaction.toLedgerTransaction to look up well known identities from pubkeys.
+
+
+
+
+
+
diff --git a/docs/build/html/api/core/java.nio.file.-path/index.html b/docs/build/html/api/core/java.nio.file.-path/index.html
new file mode 100644
index 0000000000..3fa5eace28
--- /dev/null
+++ b/docs/build/html/api/core/java.nio.file.-path/index.html
@@ -0,0 +1,21 @@
+
+
+core.java.nio.file.Path -
+core / java.nio.file.Path Extensions for java.nio.file.Path
+
+
+
diff --git a/docs/build/html/api/core/java.nio.file.-path/use.html b/docs/build/html/api/core/java.nio.file.-path/use.html
new file mode 100644
index 0000000000..78aaa6daf9
--- /dev/null
+++ b/docs/build/html/api/core/java.nio.file.-path/use.html
@@ -0,0 +1,15 @@
+
+
+use -
+core / java.nio.file.Path / use use
+fun < R > Path . use ( block : ( InputStream ) -> R ) : R core.java.time.LocalDate -
+core / java.time.LocalDate Extensions for java.time.LocalDate
+
+
+
diff --git a/docs/build/html/api/core/java.time.-local-date/is-working-day.html b/docs/build/html/api/core/java.time.-local-date/is-working-day.html
new file mode 100644
index 0000000000..6ebe176ff5
--- /dev/null
+++ b/docs/build/html/api/core/java.time.-local-date/is-working-day.html
@@ -0,0 +1,15 @@
+
+
+isWorkingDay -
+core / java.time.LocalDate / isWorkingDay isWorkingDay
+fun LocalDate . isWorkingDay ( accordingToCalendar : BusinessCalendar ) : Boolean core.java.time.temporal.Temporal -
+core / java.time.temporal.Temporal Extensions for java.time.temporal.Temporal
+
+
+
diff --git a/docs/build/html/api/core/java.time.temporal.-temporal/until.html b/docs/build/html/api/core/java.time.temporal.-temporal/until.html
new file mode 100644
index 0000000000..4d85b2b2b6
--- /dev/null
+++ b/docs/build/html/api/core/java.time.temporal.-temporal/until.html
@@ -0,0 +1,15 @@
+
+
+until -
+core / java.time.temporal.Temporal / until until
+infix fun Temporal . until ( endExclusive : Temporal ) : Duration DOLLARS -
+core / kotlin.Double / DOLLARS DOLLARS
+val Double . DOLLARS : Amount bd -
+core / kotlin.Double / bd bd
+val Double . bd : BigDecimal core.kotlin.Double -
+core / kotlin.Double Extensions for kotlin.Double
+
+
+
diff --git a/docs/build/html/api/core/kotlin.-int/-d-o-l-l-a-r-s.html b/docs/build/html/api/core/kotlin.-int/-d-o-l-l-a-r-s.html
new file mode 100644
index 0000000000..74f8f32024
--- /dev/null
+++ b/docs/build/html/api/core/kotlin.-int/-d-o-l-l-a-r-s.html
@@ -0,0 +1,15 @@
+
+
+DOLLARS -
+core / kotlin.Int / DOLLARS DOLLARS
+val Int . DOLLARS : Amount POUNDS -
+core / kotlin.Int / POUNDS POUNDS
+val Int . POUNDS : Amount SWISS_FRANCS -
+core / kotlin.Int / SWISS_FRANCS SWISS_FRANCS
+val Int . SWISS_FRANCS : Amount bd -
+core / kotlin.Int / bd bd
+val Int . bd : BigDecimal days -
+core / kotlin.Int / days days
+val Int . days : Duration hours -
+core / kotlin.Int / hours hours
+val Int . hours : Duration core.kotlin.Int -
+core / kotlin.Int Extensions for kotlin.Int
+
+
+
diff --git a/docs/build/html/api/core/kotlin.-int/minutes.html b/docs/build/html/api/core/kotlin.-int/minutes.html
new file mode 100644
index 0000000000..ec227c5768
--- /dev/null
+++ b/docs/build/html/api/core/kotlin.-int/minutes.html
@@ -0,0 +1,15 @@
+
+
+minutes -
+core / kotlin.Int / minutes minutes
+val Int . minutes : Duration seconds -
+core / kotlin.Int / seconds seconds
+val Int . seconds : Duration bd -
+core / kotlin.Long / bd bd
+val Long . bd : BigDecimal core.kotlin.Long -
+core / kotlin.Long Extensions for kotlin.Long
+
+
+
diff --git a/docs/build/html/api/core/kotlin.-string/bd.html b/docs/build/html/api/core/kotlin.-string/bd.html
new file mode 100644
index 0000000000..fc47143355
--- /dev/null
+++ b/docs/build/html/api/core/kotlin.-string/bd.html
@@ -0,0 +1,15 @@
+
+
+bd -
+core / kotlin.String / bd bd
+val String . bd : BigDecimal core.kotlin.String -
+core / kotlin.String Extensions for kotlin.String
+
+
+
diff --git a/docs/build/html/api/core/kotlin.collections.-iterable/index.html b/docs/build/html/api/core/kotlin.collections.-iterable/index.html
new file mode 100644
index 0000000000..e5861733cd
--- /dev/null
+++ b/docs/build/html/api/core/kotlin.collections.-iterable/index.html
@@ -0,0 +1,33 @@
+
+
+core.kotlin.collections.Iterable -
+core / kotlin.collections.Iterable Extensions for kotlin.collections.Iterable
+
+
+
diff --git a/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-null.html b/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-null.html
new file mode 100644
index 0000000000..94840397a3
--- /dev/null
+++ b/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-null.html
@@ -0,0 +1,15 @@
+
+
+sumOrNull -
+core / kotlin.collections.Iterable / sumOrNull sumOrNull
+fun Iterable < Amount > . sumOrNull ( ) : Nothing ? sumOrThrow -
+core / kotlin.collections.Iterable / sumOrThrow sumOrThrow
+fun Iterable < Amount > . sumOrThrow ( ) : <ERROR CLASS> sumOrZero -
+core / kotlin.collections.Iterable / sumOrZero sumOrZero
+fun Iterable < Amount > . sumOrZero ( currency : Currency ) : Amount filterStatesOfType -
+core / kotlin.collections.List / filterStatesOfType filterStatesOfType
+inline fun < reified T : ContractState > List < StateAndRef < ContractState > > . filterStatesOfType ( ) : List < StateAndRef < T > > Filters a list of StateAndRef objects according to the type of the states
+getTimestampByName -
+core / kotlin.collections.List / getTimestampByName getTimestampByName
+fun List < AuthenticatedObject < CommandData > > . getTimestampByName ( vararg names : String ) : TimestampCommand ? Returns a timestamp that was signed by any of the the named authorities, or returns null if missing.
+Note that matching here is done by (verified, legal) name, not by public key. Any signature by any
+party with a name that matches (case insensitively) any of the given names will yield a match.
+getTimestampBy -
+core / kotlin.collections.List / getTimestampBy getTimestampBy
+fun List < AuthenticatedObject < CommandData > > . getTimestampBy ( timestampingAuthority : Party ) : TimestampCommand ? Returns a timestamp that was signed by the given authority, or returns null if missing.
+indexOfOrThrow -
+core / kotlin.collections.List / indexOfOrThrow indexOfOrThrow
+fun < T > List < T > . indexOfOrThrow ( item : T ) : Int Returns the index of the given item or throws IllegalArgumentException if not found.
+core.kotlin.collections.List -
+core / kotlin.collections.List Extensions for kotlin.collections.List
+
+
+
diff --git a/docs/build/html/api/core/kotlin.collections.-list/require-single-command.html b/docs/build/html/api/core/kotlin.collections.-list/require-single-command.html
new file mode 100644
index 0000000000..7c108de011
--- /dev/null
+++ b/docs/build/html/api/core/kotlin.collections.-list/require-single-command.html
@@ -0,0 +1,17 @@
+
+
+requireSingleCommand -
+core / kotlin.collections.List / requireSingleCommand requireSingleCommand
+inline fun < reified T : CommandData > List < AuthenticatedObject < CommandData > > . requireSingleCommand ( ) : <ERROR CLASS> fun List < AuthenticatedObject < CommandData > > . requireSingleCommand ( klass : Class < out CommandData > ) : <ERROR CLASS> select -
+core / kotlin.collections.List / select select
+inline fun < reified T : CommandData > List < AuthenticatedObject < CommandData > > . select ( signer : PublicKey ? = null, party : Party ? = null) : <ERROR CLASS> Filters the command list by type, party and public key all at once.
+logElapsedTime -
+core / logElapsedTime logElapsedTime
+inline fun < T > logElapsedTime ( label : String , logger : <ERROR CLASS> ? = null, body : ( ) -> T ) : T random63BitValue -
+core / random63BitValue random63BitValue
+fun random63BitValue ( ) : Long Returns a random positive long generated using a secure RNG. This function sacrifies a bit of entropy in order to
+avoid potential bugs where the value is used in a context where negative numbers are not expected.
+requireThat -
+core / requireThat requireThat
+inline fun < R > requireThat ( body : Requirements . ( ) -> R ) : R setFrom -
+core / setFrom setFrom
+fun < T > <ERROR CLASS> < T > . setFrom ( logger : <ERROR CLASS> ? = null, block : ( ) -> T ) : <ERROR CLASS> < T > Executes the given block and sets the future to either the result, or any exception that was thrown.
+success -
+core / success success
+fun < T > <ERROR CLASS> < T > . success ( executor : Executor , body : ( T ) -> Unit ) : <ERROR CLASS> infix fun < T > <ERROR CLASS> < T > . success ( body : ( T ) -> Unit ) : <ERROR CLASS> < T > then -
+core / then then
+fun < T > <ERROR CLASS> < T > . then ( executor : Executor , body : ( ) -> Unit ) : <ERROR CLASS> infix fun < T > <ERROR CLASS> < T > . then ( body : ( ) -> Unit ) : <ERROR CLASS> < T > toLedgerTransaction -
+core / toLedgerTransaction toLedgerTransaction
+fun WireTransaction . toLedgerTransaction ( identityService : IdentityService , attachmentStorage : AttachmentStorage ) : LedgerTransaction Looks up identities and attachments from storage to generate a LedgerTransaction .
+Exceptions
+FileNotFoundException - if a required attachment was not found in storage.verifyToLedgerTransaction -
+core / verifyToLedgerTransaction verifyToLedgerTransaction
+fun SignedTransaction . verifyToLedgerTransaction ( identityService : IdentityService , attachmentStorage : AttachmentStorage ) : LedgerTransaction Calls verify to check all required signatures are present, and then uses the passed IdentityService to call
+WireTransaction.toLedgerTransaction to look up well known identities from pubkeys.
+AutoOfferProtocol.AutoOfferMessage.<init> -
+demos.protocols / AutoOfferProtocol / AutoOfferMessage / <init> <init>
+AutoOfferMessage ( otherSide : SingleMessageRecipient , otherSessionID : Long , dealBeingOffered : DealState ) AutoOfferProtocol.AutoOfferMessage.dealBeingOffered -
+demos.protocols / AutoOfferProtocol / AutoOfferMessage / dealBeingOffered dealBeingOffered
+val dealBeingOffered : DealState AutoOfferProtocol.AutoOfferMessage -
+demos.protocols / AutoOfferProtocol / AutoOfferMessage AutoOfferMessage
+data class AutoOfferMessage Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-auto-offer-protocol/-auto-offer-message/other-session-i-d.html b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-auto-offer-message/other-session-i-d.html
new file mode 100644
index 0000000000..911bd73fd9
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-auto-offer-message/other-session-i-d.html
@@ -0,0 +1,15 @@
+
+
+AutoOfferProtocol.AutoOfferMessage.otherSessionID -
+demos.protocols / AutoOfferProtocol / AutoOfferMessage / otherSessionID otherSessionID
+val otherSessionID : Long AutoOfferProtocol.AutoOfferMessage.otherSide -
+demos.protocols / AutoOfferProtocol / AutoOfferMessage / otherSide otherSide
+val otherSide : SingleMessageRecipient AutoOfferProtocol.Handler.Callback.<init> -
+demos.protocols / AutoOfferProtocol / Handler / Callback / <init> <init>
+Callback ( success : ( SignedTransaction ) -> Unit ) AutoOfferProtocol.Handler.Callback -
+demos.protocols / AutoOfferProtocol / Handler / Callback Callback
+class Callback Constructors
+
+Properties
+
+Functions
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/-callback/on-failure.html b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/-callback/on-failure.html
new file mode 100644
index 0000000000..ef40453276
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/-callback/on-failure.html
@@ -0,0 +1,15 @@
+
+
+AutoOfferProtocol.Handler.Callback.onFailure -
+demos.protocols / AutoOfferProtocol / Handler / Callback / onFailure onFailure
+fun onFailure ( t : Throwable ? ) : Unit AutoOfferProtocol.Handler.Callback.onSuccess -
+demos.protocols / AutoOfferProtocol / Handler / Callback / onSuccess onSuccess
+fun onSuccess ( st : SignedTransaction ? ) : Unit AutoOfferProtocol.Handler.Callback.success -
+demos.protocols / AutoOfferProtocol / Handler / Callback / success success
+val success : ( SignedTransaction ) -> Unit AutoOfferProtocol.Handler.DEALING -
+demos.protocols / AutoOfferProtocol / Handler / DEALING DEALING
+object DEALING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/-r-e-c-e-i-v-e-d.html b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/-r-e-c-e-i-v-e-d.html
new file mode 100644
index 0000000000..3a0442e149
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/-r-e-c-e-i-v-e-d.html
@@ -0,0 +1,31 @@
+
+
+AutoOfferProtocol.Handler.RECEIVED -
+demos.protocols / AutoOfferProtocol / Handler / RECEIVED RECEIVED
+object RECEIVED : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/index.html b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/index.html
new file mode 100644
index 0000000000..f2e34a8c2d
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/index.html
@@ -0,0 +1,54 @@
+
+
+AutoOfferProtocol.Handler -
+demos.protocols / AutoOfferProtocol / Handler Handler
+object Handler Types
+
+Functions
+
+
+
+
+register
+
+fun register ( node : Node ) : Unit
+
+
+
+tracker
+
+fun tracker ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/register.html b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/register.html
new file mode 100644
index 0000000000..2b95b68533
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-handler/register.html
@@ -0,0 +1,15 @@
+
+
+AutoOfferProtocol.Handler.register -
+demos.protocols / AutoOfferProtocol / Handler / register register
+fun register ( node : Node ) : Unit AutoOfferProtocol.Handler.tracker -
+demos.protocols / AutoOfferProtocol / Handler / tracker tracker
+fun tracker ( ) : <ERROR CLASS> AutoOfferProtocol.Requester.ANNOUNCING -
+demos.protocols / AutoOfferProtocol / Requester / ANNOUNCING ANNOUNCING
+object ANNOUNCING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/-d-e-a-l-i-n-g.html b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/-d-e-a-l-i-n-g.html
new file mode 100644
index 0000000000..86fb3a151c
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/-d-e-a-l-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+AutoOfferProtocol.Requester.DEALING -
+demos.protocols / AutoOfferProtocol / Requester / DEALING DEALING
+object DEALING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/-init-.html b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/-init-.html
new file mode 100644
index 0000000000..0f0f4c5d5e
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/-init-.html
@@ -0,0 +1,14 @@
+
+
+AutoOfferProtocol.Requester.<init> -
+demos.protocols / AutoOfferProtocol / Requester / <init> <init>
+Requester ( dealToBeOffered : DealState ) AutoOfferProtocol.Requester.RECEIVED -
+demos.protocols / AutoOfferProtocol / Requester / RECEIVED RECEIVED
+object RECEIVED : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/call.html b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/call.html
new file mode 100644
index 0000000000..f8b253f7ef
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/call.html
@@ -0,0 +1,17 @@
+
+
+AutoOfferProtocol.Requester.call -
+demos.protocols / AutoOfferProtocol / Requester / call call
+fun call ( ) : SignedTransaction ProtocolLogic.call This is where you fill out your business logic.
+AutoOfferProtocol.Requester.dealToBeOffered -
+demos.protocols / AutoOfferProtocol / Requester / dealToBeOffered dealToBeOffered
+val dealToBeOffered : DealState AutoOfferProtocol.Requester -
+demos.protocols / AutoOfferProtocol / Requester Requester
+class Requester < T > : ProtocolLogic < SignedTransaction > Types
+
+Constructors
+
+Properties
+
+
+
+
+dealToBeOffered
+
+val dealToBeOffered : DealState
+
+
+
+progressTracker
+
+val progressTracker : <ERROR CLASS> Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Companion Object Functions
+
+
+
+
+tracker
+
+fun tracker ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/not-us.html b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/not-us.html
new file mode 100644
index 0000000000..8fa7e4ac6f
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-auto-offer-protocol/-requester/not-us.html
@@ -0,0 +1,15 @@
+
+
+AutoOfferProtocol.Requester.notUs -
+demos.protocols / AutoOfferProtocol / Requester / notUs notUs
+fun notUs ( vararg parties : Party ) : List < Party > AutoOfferProtocol.Requester.progressTracker -
+demos.protocols / AutoOfferProtocol / Requester / progressTracker progressTracker
+val progressTracker : <ERROR CLASS> ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+AutoOfferProtocol.Requester.tracker -
+demos.protocols / AutoOfferProtocol / Requester / tracker tracker
+fun tracker ( ) : <ERROR CLASS> AutoOfferProtocol.TOPIC -
+demos.protocols / AutoOfferProtocol / TOPIC TOPIC
+val TOPIC : String AutoOfferProtocol -
+demos.protocols / AutoOfferProtocol AutoOfferProtocol
+object AutoOfferProtocol This whole class is really part of a demo just to initiate the agreement of a deal with a simple
+API call from a single party without bi-directional access to the database of offers etc.
+In the "real world", wed probably have the offers sitting in the platform prior to the agreement step
+or the protocol would have to reach out to external systems (or users) to verify the deals
+Types
+
+Properties
+
+
+
+
+TOPIC
+
+val TOPIC : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-exit-server-protocol/-broadcast/-init-.html b/docs/build/html/api/demos.protocols/-exit-server-protocol/-broadcast/-init-.html
new file mode 100644
index 0000000000..0140718d4b
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-exit-server-protocol/-broadcast/-init-.html
@@ -0,0 +1,16 @@
+
+
+ExitServerProtocol.Broadcast.<init> -
+demos.protocols / ExitServerProtocol / Broadcast / <init> <init>
+Broadcast ( exitCode : Integer ) This takes a Java Integer rather than Kotlin Int as that is what we end up with in the calling map and currently
+we do not support coercing numeric types in the reflective search for matching constructors
+ExitServerProtocol.Broadcast.call -
+demos.protocols / ExitServerProtocol / Broadcast / call call
+fun call ( ) : Boolean ProtocolLogic.call This is where you fill out your business logic.
+ExitServerProtocol.Broadcast.exitCode -
+demos.protocols / ExitServerProtocol / Broadcast / exitCode exitCode
+val exitCode : Integer ExitServerProtocol.Broadcast -
+demos.protocols / ExitServerProtocol / Broadcast Broadcast
+class Broadcast : ProtocolLogic < Boolean > This takes a Java Integer rather than Kotlin Int as that is what we end up with in the calling map and currently
+we do not support coercing numeric types in the reflective search for matching constructors
+Constructors
+
+
+
+
+<init>
+
+Broadcast ( exitCode : Integer ) This takes a Java Integer rather than Kotlin Int as that is what we end up with in the calling map and currently
+we do not support coercing numeric types in the reflective search for matching constructors
+
+
+
+
+Properties
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker ? Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+
+
+
+call
+
+fun call ( ) : Boolean This is where you fill out your business logic.
+
+
+
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-exit-server-protocol/-exit-message/-init-.html b/docs/build/html/api/demos.protocols/-exit-server-protocol/-exit-message/-init-.html
new file mode 100644
index 0000000000..1bb42ed8f5
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-exit-server-protocol/-exit-message/-init-.html
@@ -0,0 +1,14 @@
+
+
+ExitServerProtocol.ExitMessage.<init> -
+demos.protocols / ExitServerProtocol / ExitMessage / <init> <init>
+ExitMessage ( exitCode : Int ) ExitServerProtocol.ExitMessage.exitCode -
+demos.protocols / ExitServerProtocol / ExitMessage / exitCode exitCode
+val exitCode : Int ExitServerProtocol.ExitMessage -
+demos.protocols / ExitServerProtocol / ExitMessage ExitMessage
+data class ExitMessage Constructors
+
+
+
+
+<init>
+
+ExitMessage ( exitCode : Int )
+
+
+
+Properties
+
+
+
+
+exitCode
+
+val exitCode : Int
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-exit-server-protocol/-handler/index.html b/docs/build/html/api/demos.protocols/-exit-server-protocol/-handler/index.html
new file mode 100644
index 0000000000..8404579dc5
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-exit-server-protocol/-handler/index.html
@@ -0,0 +1,25 @@
+
+
+ExitServerProtocol.Handler -
+demos.protocols / ExitServerProtocol / Handler Handler
+object Handler Functions
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-exit-server-protocol/-handler/register.html b/docs/build/html/api/demos.protocols/-exit-server-protocol/-handler/register.html
new file mode 100644
index 0000000000..bf6eea4a3a
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-exit-server-protocol/-handler/register.html
@@ -0,0 +1,15 @@
+
+
+ExitServerProtocol.Handler.register -
+demos.protocols / ExitServerProtocol / Handler / register register
+fun register ( node : Node ) : Unit ExitServerProtocol.TOPIC -
+demos.protocols / ExitServerProtocol / TOPIC TOPIC
+val TOPIC : String ExitServerProtocol -
+demos.protocols / ExitServerProtocol ExitServerProtocol
+object ExitServerProtocol Types
+
+
+
+
+Broadcast
+
+class Broadcast : ProtocolLogic < Boolean > This takes a Java Integer rather than Kotlin Int as that is what we end up with in the calling map and currently
+we do not support coercing numeric types in the reflective search for matching constructors
+
+
+
+
+ExitMessage
+
+data class ExitMessage
+
+
+
+Handler
+
+object Handler
+
+
+
+Properties
+
+
+
+
+TOPIC
+
+val TOPIC : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/-init-.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/-init-.html
new file mode 100644
index 0000000000..4d7f14f141
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/-init-.html
@@ -0,0 +1,14 @@
+
+
+UpdateBusinessDayProtocol.Broadcast.<init> -
+demos.protocols / UpdateBusinessDayProtocol / Broadcast / <init> <init>
+Broadcast ( date : LocalDate , progressTracker : ProgressTracker = Broadcast.tracker()) UpdateBusinessDayProtocol.Broadcast.LOCAL -
+demos.protocols / UpdateBusinessDayProtocol / Broadcast / LOCAL LOCAL
+object LOCAL : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/-n-o-t-i-f-y-i-n-g.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/-n-o-t-i-f-y-i-n-g.html
new file mode 100644
index 0000000000..f6239b374c
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/-n-o-t-i-f-y-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+UpdateBusinessDayProtocol.Broadcast.NOTIFYING -
+demos.protocols / UpdateBusinessDayProtocol / Broadcast / NOTIFYING NOTIFYING
+object NOTIFYING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/call.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/call.html
new file mode 100644
index 0000000000..6b0af9c8e3
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/call.html
@@ -0,0 +1,17 @@
+
+
+UpdateBusinessDayProtocol.Broadcast.call -
+demos.protocols / UpdateBusinessDayProtocol / Broadcast / call call
+fun call ( ) : Boolean ProtocolLogic.call This is where you fill out your business logic.
+UpdateBusinessDayProtocol.Broadcast.date -
+demos.protocols / UpdateBusinessDayProtocol / Broadcast / date date
+val date : LocalDate UpdateBusinessDayProtocol.Broadcast -
+demos.protocols / UpdateBusinessDayProtocol / Broadcast Broadcast
+class Broadcast : ProtocolLogic < Boolean > Types
+
+Constructors
+
+Properties
+
+
+
+
+date
+
+val date : LocalDate
+
+
+
+progressTracker
+
+val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+
+
+
+call
+
+fun call ( ) : Boolean This is where you fill out your business logic.
+
+
+
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Companion Object Functions
+
+
+
+
+tracker
+
+fun tracker ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/progress-tracker.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/progress-tracker.html
new file mode 100644
index 0000000000..86943f923d
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-broadcast/progress-tracker.html
@@ -0,0 +1,24 @@
+
+
+UpdateBusinessDayProtocol.Broadcast.progressTracker -
+demos.protocols / UpdateBusinessDayProtocol / Broadcast / progressTracker progressTracker
+val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+UpdateBusinessDayProtocol.Broadcast.tracker -
+demos.protocols / UpdateBusinessDayProtocol / Broadcast / tracker tracker
+fun tracker ( ) : <ERROR CLASS> UpdateBusinessDayProtocol.Handler -
+demos.protocols / UpdateBusinessDayProtocol / Handler Handler
+object Handler Functions
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-handler/register.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-handler/register.html
new file mode 100644
index 0000000000..bc1bf6e53f
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-handler/register.html
@@ -0,0 +1,15 @@
+
+
+UpdateBusinessDayProtocol.Handler.register -
+demos.protocols / UpdateBusinessDayProtocol / Handler / register register
+fun register ( node : Node ) : Unit UpdateBusinessDayProtocol.TOPIC -
+demos.protocols / UpdateBusinessDayProtocol / TOPIC TOPIC
+val TOPIC : String UpdateBusinessDayProtocol.UpdateBusinessDayMessage.<init> -
+demos.protocols / UpdateBusinessDayProtocol / UpdateBusinessDayMessage / <init> <init>
+UpdateBusinessDayMessage ( date : LocalDate , sessionID : Long ) UpdateBusinessDayProtocol.UpdateBusinessDayMessage.date -
+demos.protocols / UpdateBusinessDayProtocol / UpdateBusinessDayMessage / date date
+val date : LocalDate UpdateBusinessDayProtocol.UpdateBusinessDayMessage -
+demos.protocols / UpdateBusinessDayProtocol / UpdateBusinessDayMessage UpdateBusinessDayMessage
+data class UpdateBusinessDayMessage Constructors
+
+
+
+
+<init>
+
+UpdateBusinessDayMessage ( date : LocalDate , sessionID : Long )
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-update-business-day-message/session-i-d.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-update-business-day-message/session-i-d.html
new file mode 100644
index 0000000000..3d680db502
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-update-business-day-message/session-i-d.html
@@ -0,0 +1,15 @@
+
+
+UpdateBusinessDayProtocol.UpdateBusinessDayMessage.sessionID -
+demos.protocols / UpdateBusinessDayProtocol / UpdateBusinessDayMessage / sessionID sessionID
+val sessionID : Long UpdateBusinessDayProtocol.Updater.FETCHING -
+demos.protocols / UpdateBusinessDayProtocol / Updater / FETCHING FETCHING
+object FETCHING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-f-i-x-i-n-g.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-f-i-x-i-n-g.html
new file mode 100644
index 0000000000..948e9ded7c
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-f-i-x-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+UpdateBusinessDayProtocol.Updater.FIXING -
+demos.protocols / UpdateBusinessDayProtocol / Updater / FIXING FIXING
+object FIXING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-i-t-e-r-a-t-i-n-g_-d-e-a-l-s.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-i-t-e-r-a-t-i-n-g_-d-e-a-l-s.html
new file mode 100644
index 0000000000..7ac5eb568e
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-i-t-e-r-a-t-i-n-g_-d-e-a-l-s.html
@@ -0,0 +1,31 @@
+
+
+UpdateBusinessDayProtocol.Updater.ITERATING_DEALS -
+demos.protocols / UpdateBusinessDayProtocol / Updater / ITERATING_DEALS ITERATING_DEALS
+object ITERATING_DEALS : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-i-t-e-r-a-t-i-n-g_-f-i-x-i-n-g-s.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-i-t-e-r-a-t-i-n-g_-f-i-x-i-n-g-s.html
new file mode 100644
index 0000000000..1dda836056
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-i-t-e-r-a-t-i-n-g_-f-i-x-i-n-g-s.html
@@ -0,0 +1,31 @@
+
+
+UpdateBusinessDayProtocol.Updater.ITERATING_FIXINGS -
+demos.protocols / UpdateBusinessDayProtocol / Updater / ITERATING_FIXINGS ITERATING_FIXINGS
+object ITERATING_FIXINGS : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-init-.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-init-.html
new file mode 100644
index 0000000000..3b89e2d3c1
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/-init-.html
@@ -0,0 +1,14 @@
+
+
+UpdateBusinessDayProtocol.Updater.<init> -
+demos.protocols / UpdateBusinessDayProtocol / Updater / <init> <init>
+Updater ( date : LocalDate , sessionID : Long , progressTracker : ProgressTracker = Updater.tracker()) UpdateBusinessDayProtocol.Updater.call -
+demos.protocols / UpdateBusinessDayProtocol / Updater / call call
+fun call ( ) : Boolean ProtocolLogic.call This is where you fill out your business logic.
+UpdateBusinessDayProtocol.Updater.date -
+demos.protocols / UpdateBusinessDayProtocol / Updater / date date
+val date : LocalDate UpdateBusinessDayProtocol.Updater -
+demos.protocols / UpdateBusinessDayProtocol / Updater Updater
+class Updater : ProtocolLogic < Boolean > Types
+
+Constructors
+
+Properties
+
+
+
+
+date
+
+val date : LocalDate
+
+
+
+progressTracker
+
+val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+sessionID
+
+val sessionID : Long
+
+
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Companion Object Functions
+
+
+
diff --git a/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/other-party.html b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/other-party.html
new file mode 100644
index 0000000000..231562f891
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/-update-business-day-protocol/-updater/other-party.html
@@ -0,0 +1,15 @@
+
+
+UpdateBusinessDayProtocol.Updater.otherParty -
+demos.protocols / UpdateBusinessDayProtocol / Updater / otherParty otherParty
+fun otherParty ( deal : DealState ) : NodeInfo UpdateBusinessDayProtocol.Updater.processDeal -
+demos.protocols / UpdateBusinessDayProtocol / Updater / processDeal processDeal
+fun processDeal ( party : NodeInfo , deal : StateAndRef < DealState > , date : LocalDate , sessionID : Long ) : Unit UpdateBusinessDayProtocol.Updater.processInterestRateSwap -
+demos.protocols / UpdateBusinessDayProtocol / Updater / processInterestRateSwap processInterestRateSwap
+fun processInterestRateSwap ( party : NodeInfo , deal : StateAndRef < State > , date : LocalDate , sessionID : Long ) : Unit UpdateBusinessDayProtocol.Updater.progressTracker -
+demos.protocols / UpdateBusinessDayProtocol / Updater / progressTracker progressTracker
+val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+UpdateBusinessDayProtocol.Updater.sessionID -
+demos.protocols / UpdateBusinessDayProtocol / Updater / sessionID sessionID
+val sessionID : Long UpdateBusinessDayProtocol.Updater.tracker -
+demos.protocols / UpdateBusinessDayProtocol / Updater / tracker tracker
+fun tracker ( ) : ProgressTracker UpdateBusinessDayProtocol -
+demos.protocols / UpdateBusinessDayProtocol UpdateBusinessDayProtocol
+object UpdateBusinessDayProtocol This is a very temporary, demo-oriented way of initiating processing of temporal events and is not
+intended as the way things will necessarily be done longer term
+Types
+
+Properties
+
+
+
+
+TOPIC
+
+val TOPIC : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos.protocols/index.html b/docs/build/html/api/demos.protocols/index.html
new file mode 100644
index 0000000000..7284a8a096
--- /dev/null
+++ b/docs/build/html/api/demos.protocols/index.html
@@ -0,0 +1,38 @@
+
+
+demos.protocols -
+demos.protocols Package demos.protocols
+Types
+
+
+
+
+AutoOfferProtocol
+
+object AutoOfferProtocol This whole class is really part of a demo just to initiate the agreement of a deal with a simple
+API call from a single party without bi-directional access to the database of offers etc.
+
+
+
+
+ExitServerProtocol
+
+object ExitServerProtocol
+
+
+
+UpdateBusinessDayProtocol
+
+object UpdateBusinessDayProtocol This is a very temporary, demo-oriented way of initiating processing of temporal events and is not
+intended as the way things will necessarily be done longer term
+
+
+
+
+
+
diff --git a/docs/build/html/api/demos/-demo-clock/-init-.html b/docs/build/html/api/demos/-demo-clock/-init-.html
new file mode 100644
index 0000000000..afb0011606
--- /dev/null
+++ b/docs/build/html/api/demos/-demo-clock/-init-.html
@@ -0,0 +1,15 @@
+
+
+DemoClock.<init> -
+demos / DemoClock / <init> <init>
+DemoClock ( delegateClock : Clock = Clock.systemUTC()) A Clock that can have the date advanced for use in demos
+DemoClock.getZone -
+demos / DemoClock / getZone getZone
+fun getZone ( ) : ZoneId DemoClock -
+demos / DemoClock DemoClock
+class DemoClock : Clock A Clock that can have the date advanced for use in demos
+Constructors
+
+
+
+
+<init>
+
+DemoClock ( delegateClock : Clock = Clock.systemUTC()) A Clock that can have the date advanced for use in demos
+
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/demos/-demo-clock/instant.html b/docs/build/html/api/demos/-demo-clock/instant.html
new file mode 100644
index 0000000000..12066596a5
--- /dev/null
+++ b/docs/build/html/api/demos/-demo-clock/instant.html
@@ -0,0 +1,15 @@
+
+
+DemoClock.instant -
+demos / DemoClock / instant instant
+fun instant ( ) : Instant DemoClock.updateDate -
+demos / DemoClock / updateDate updateDate
+fun updateDate ( date : LocalDate ) : Boolean DemoClock.withZone -
+demos / DemoClock / withZone withZone
+fun withZone ( zone : ZoneId ) : Clock TraderDemoProtocolBuyer.<init> -
+demos / TraderDemoProtocolBuyer / <init> <init>
+TraderDemoProtocolBuyer ( attachmentsPath : Path ) TraderDemoProtocolBuyer.STARTING_BUY -
+demos / TraderDemoProtocolBuyer / STARTING_BUY STARTING_BUY
+object STARTING_BUY : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos/-trader-demo-protocol-buyer/-w-a-i-t-i-n-g_-f-o-r_-s-e-l-l-e-r_-t-o_-c-o-n-n-e-c-t.html b/docs/build/html/api/demos/-trader-demo-protocol-buyer/-w-a-i-t-i-n-g_-f-o-r_-s-e-l-l-e-r_-t-o_-c-o-n-n-e-c-t.html
new file mode 100644
index 0000000000..c33c6afc07
--- /dev/null
+++ b/docs/build/html/api/demos/-trader-demo-protocol-buyer/-w-a-i-t-i-n-g_-f-o-r_-s-e-l-l-e-r_-t-o_-c-o-n-n-e-c-t.html
@@ -0,0 +1,31 @@
+
+
+TraderDemoProtocolBuyer.WAITING_FOR_SELLER_TO_CONNECT -
+demos / TraderDemoProtocolBuyer / WAITING_FOR_SELLER_TO_CONNECT WAITING_FOR_SELLER_TO_CONNECT
+object WAITING_FOR_SELLER_TO_CONNECT : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos/-trader-demo-protocol-buyer/call.html b/docs/build/html/api/demos/-trader-demo-protocol-buyer/call.html
new file mode 100644
index 0000000000..cdd0416a2f
--- /dev/null
+++ b/docs/build/html/api/demos/-trader-demo-protocol-buyer/call.html
@@ -0,0 +1,17 @@
+
+
+TraderDemoProtocolBuyer.call -
+demos / TraderDemoProtocolBuyer / call call
+fun call ( ) : Unit ProtocolLogic.call This is where you fill out your business logic.
+TraderDemoProtocolBuyer -
+demos / TraderDemoProtocolBuyer TraderDemoProtocolBuyer
+class TraderDemoProtocolBuyer : ProtocolLogic < Unit > Types
+
+Constructors
+
+
+
+
+<init>
+
+TraderDemoProtocolBuyer ( attachmentsPath : Path )
+
+
+
+Properties
+
+
+
+
+progressTracker
+
+val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+
+
+
+call
+
+fun call ( ) : Unit This is where you fill out your business logic.
+
+
+
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+
+
diff --git a/docs/build/html/api/demos/-trader-demo-protocol-buyer/progress-tracker.html b/docs/build/html/api/demos/-trader-demo-protocol-buyer/progress-tracker.html
new file mode 100644
index 0000000000..95ee54060a
--- /dev/null
+++ b/docs/build/html/api/demos/-trader-demo-protocol-buyer/progress-tracker.html
@@ -0,0 +1,24 @@
+
+
+TraderDemoProtocolBuyer.progressTracker -
+demos / TraderDemoProtocolBuyer / progressTracker progressTracker
+val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TraderDemoProtocolSeller.ANNOUNCING -
+demos / TraderDemoProtocolSeller / ANNOUNCING ANNOUNCING
+object ANNOUNCING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/-init-.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/-init-.html
new file mode 100644
index 0000000000..b11cc44555
--- /dev/null
+++ b/docs/build/html/api/demos/-trader-demo-protocol-seller/-init-.html
@@ -0,0 +1,14 @@
+
+
+TraderDemoProtocolSeller.<init> -
+demos / TraderDemoProtocolSeller / <init> <init>
+TraderDemoProtocolSeller ( myAddress : <ERROR CLASS> , otherSide : SingleMessageRecipient , progressTracker : ProgressTracker = TraderDemoProtocolSeller.tracker()) TraderDemoProtocolSeller.PROSPECTUS_HASH -
+demos / TraderDemoProtocolSeller / PROSPECTUS_HASH PROSPECTUS_HASH
+val PROSPECTUS_HASH : <ERROR CLASS> TraderDemoProtocolSeller.SELF_ISSUING -
+demos / TraderDemoProtocolSeller / SELF_ISSUING SELF_ISSUING
+object SELF_ISSUING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/-t-r-a-d-i-n-g.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/-t-r-a-d-i-n-g.html
new file mode 100644
index 0000000000..13bfb6b840
--- /dev/null
+++ b/docs/build/html/api/demos/-trader-demo-protocol-seller/-t-r-a-d-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TraderDemoProtocolSeller.TRADING -
+demos / TraderDemoProtocolSeller / TRADING TRADING
+object TRADING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/call.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/call.html
new file mode 100644
index 0000000000..5aa81784f4
--- /dev/null
+++ b/docs/build/html/api/demos/-trader-demo-protocol-seller/call.html
@@ -0,0 +1,17 @@
+
+
+TraderDemoProtocolSeller.call -
+demos / TraderDemoProtocolSeller / call call
+fun call ( ) : Unit ProtocolLogic.call This is where you fill out your business logic.
+TraderDemoProtocolSeller -
+demos / TraderDemoProtocolSeller TraderDemoProtocolSeller
+class TraderDemoProtocolSeller : ProtocolLogic < Unit > Types
+
+Constructors
+
+Properties
+
+
+
+
+myAddress
+
+val myAddress : <ERROR CLASS>
+
+
+
+otherSide
+
+val otherSide : SingleMessageRecipient
+
+
+
+progressTracker
+
+val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Companion Object Properties
+
+Companion Object Functions
+
+
+
+
+tracker
+
+fun tracker ( ) : <ERROR CLASS>
+
+
+
+
+
diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/my-address.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/my-address.html
new file mode 100644
index 0000000000..132958967a
--- /dev/null
+++ b/docs/build/html/api/demos/-trader-demo-protocol-seller/my-address.html
@@ -0,0 +1,15 @@
+
+
+TraderDemoProtocolSeller.myAddress -
+demos / TraderDemoProtocolSeller / myAddress myAddress
+val myAddress : <ERROR CLASS> TraderDemoProtocolSeller.otherSide -
+demos / TraderDemoProtocolSeller / otherSide otherSide
+val otherSide : SingleMessageRecipient TraderDemoProtocolSeller.progressTracker -
+demos / TraderDemoProtocolSeller / progressTracker progressTracker
+val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TraderDemoProtocolSeller.selfIssueSomeCommercialPaper -
+demos / TraderDemoProtocolSeller / selfIssueSomeCommercialPaper selfIssueSomeCommercialPaper
+fun selfIssueSomeCommercialPaper ( ownedBy : PublicKey , tsa : NodeInfo ) : StateAndRef < State > TraderDemoProtocolSeller.tracker -
+demos / TraderDemoProtocolSeller / tracker tracker
+fun tracker ( ) : <ERROR CLASS> demos -
+demos Package demos
+Types
+
+Functions
+
+
+
+
+main
+
+fun main ( args : Array < String > ) : Unit fun main ( args : Array < String > ) : Unit fun main ( args : Array < String > ) : Unit Creates a dummy transaction that requires a rate fix within a certain range, and gets it signed by an oracle
+service.
+
+
+
+
+nodeInfo
+
+fun nodeInfo ( hostAndPortString : String , identityFile : String , advertisedServices : Set < ServiceType > = emptySet()) : NodeInfo
+
+
+
+
+
diff --git a/docs/build/html/api/demos/main.html b/docs/build/html/api/demos/main.html
new file mode 100644
index 0000000000..300a6c2cd3
--- /dev/null
+++ b/docs/build/html/api/demos/main.html
@@ -0,0 +1,23 @@
+
+
+main -
+demos / main main
+fun main ( args : Array < String > ) : Unit fun main ( args : Array < String > ) : Unit fun main ( args : Array < String > ) : Unit Creates a dummy transaction that requires a rate fix within a certain range, and gets it signed by an oracle
+service.
+nodeInfo -
+demos / nodeInfo nodeInfo
+fun nodeInfo ( hostAndPortString : String , identityFile : String , advertisedServices : Set < ServiceType > = emptySet()) : NodeInfo Module Contents
+
+
+
+Module Contents
+alltypes
+
+
+Module Contents
+object ANSIProgressRenderer interface APIServer
+
+
+Module Contents
+abstract fun buildTransaction ( type : ContractDefRef , steps : List < TransactionBuildStep > ) : SerializedBytes < WireTransaction > abstract fun commitTransaction ( tx : SerializedBytes < WireTransaction > , signatures : List < WithKey > ) : SecureHash abstract fun fetchProtocolsRequiringAttention ( query : StatesQuery ) : Map < StateRef , ProtocolRequiringAttention > abstract fun fetchStates ( states : List < StateRef > ) : Map < StateRef , ContractState ? > abstract fun fetchTransactions ( txs : List < SecureHash > ) : Map < SecureHash , SignedTransaction ? > abstract fun generateTransactionSignature ( tx : SerializedBytes < WireTransaction > ) : WithKey abstract fun invokeProtocolSync ( type : ProtocolRef , args : Map < String , Any ? > ) : Any ? abstract fun provideProtocolResponse ( protocol : ProtocolInstanceRef , choice : SecureHash , args : Map < String , Any ? > ) : Unit abstract fun queryStates ( query : StatesQuery ) : List < StateRef > abstract fun serverTime ( ) : LocalDateTime
+class APIServerImpl : APIServer
+
+
+Module Contents
+APIServerImpl ( node : AbstractNode ) fun buildTransaction ( type : ContractDefRef , steps : List < TransactionBuildStep > ) : SerializedBytes < WireTransaction > fun commitTransaction ( tx : SerializedBytes < WireTransaction > , signatures : List < WithKey > ) : SecureHash fun fetchProtocolsRequiringAttention ( query : StatesQuery ) : Map < StateRef , ProtocolRequiringAttention > fun fetchStates ( states : List < StateRef > ) : Map < StateRef , ContractState ? > fun fetchTransactions ( txs : List < SecureHash > ) : Map < SecureHash , SignedTransaction ? > fun generateTransactionSignature ( tx : SerializedBytes < WireTransaction > ) : WithKey fun invokeProtocolSync ( type : ProtocolRef , args : Map < String , Any ? > ) : Any ? val node : AbstractNode fun provideProtocolResponse ( protocol : ProtocolInstanceRef , choice : SecureHash , args : Map < String , Any ? > ) : Unit fun queryStates ( query : StatesQuery ) : List < StateRef > fun serverTime ( ) : LocalDateTime
+abstract class AbstractNode abstract class AbstractNodeService abstract class AbstractRequestMessage interface AcceptsFileUpload enum class AccrualAdjustment enum class AddOrRemove
+
+
+Module Contents
+ADD REMOVE
+interface AffinityExecutor : Executor interface AllPossibleRecipients : MessageRecipients data class Amount : Comparable < Amount > class ArtemisMessagingService : MessagingService interface Attachment : NamedByHash class AttachmentDownloadServlet interface AttachmentStorage class AttachmentsClassLoader : SecureClassLoader data class AuthenticatedObject < out T : Any > object AutoOfferProtocol class BriefLogFormatter : Formatter open class BusinessCalendar class Cash : Contract object CityDatabase data class Command interface CommandData class CommercialPaper : Contract class Config class ConfigurationException : Exception interface Contract data class ContractClassRef : ContractDefRef interface ContractDefRef data class ContractLedgerRef : ContractDefRef interface ContractState class CrowdFund : Contract class CubicSplineInterpolator : Interpolator class DataUploadServlet class DataVendingService : AbstractNodeService enum class DateOffset enum class DateRollConvention enum class DateRollDirection enum class DayCountBasisDay enum class DayCountBasisYear interface DealState : LinearState class DemoClock : Clock open class DigitalSignature : OpaqueBytes class DummyContract : Contract class DummyPublicKey : PublicKey , Comparable < PublicKey > object DummyTimestampingAuthority class E2ETestKeyManagementService : KeyManagementService object Emoji open class Event object ExitServerProtocol data class Expression object ExpressionDeserializer object ExpressionSerializer class FetchAttachmentsProtocol : FetchDataProtocol < Attachment , ByteArray > abstract class FetchDataProtocol < T : NamedByHash , W : Any > : ProtocolLogic < Result < T > > class FetchTransactionsProtocol : FetchDataProtocol < SignedTransaction , SignedTransaction > data class Fix : CommandData data class FixOf interface FixableDealState : DealState class FixedRate : Rate class FixedRatePaymentEvent : RatePaymentEvent open class FloatingRate : Rate class FloatingRatePaymentEvent : RatePaymentEvent enum class Frequency class IRSSimulation : Simulation interface IdentityService class ImmutableClassSerializer < T : Any > class InMemoryIdentityService : IdentityService class InMemoryMessagingNetwork open class InMemoryNetworkMapCache : NetworkMapCache class InMemoryNetworkMapService : NetworkMapService , AbstractNodeService class InsufficientBalanceException : Exception class InterestRateSwap : Contract
+
+
+Module Contents
+InterestRateSwap ( ) data class Calculation interface Commands : CommandData data class Common
+
+
+Module Contents
+Common ( baseCurrency : Currency , eligibleCurrency : Currency , eligibleCreditSupport : String , independentAmounts : Amount , threshold : Amount , minimumTransferAmount : Amount , rounding : Amount , valuationDate : String , notificationTime : String , resolutionTime : String , interestRate : ReferenceRate , addressForTransfers : String , exposure : UnknownType , localBusinessDay : BusinessCalendar , dailyInterestAmount : Expression , tradeID : String , hashLegalDocs : String ) val addressForTransfers : String val baseCurrency : Currency val dailyInterestAmount : Expression val eligibleCreditSupport : String val eligibleCurrency : Currency val exposure : UnknownType val hashLegalDocs : String val independentAmounts : Amount val interestRate : ReferenceRate val localBusinessDay : BusinessCalendar val minimumTransferAmount : Amount val notificationTime : String val resolutionTime : String val rounding : Amount val threshold : Amount val tradeID : String val valuationDate : String
+abstract class CommonLeg
+
+
+Module Contents
+CommonLeg ( notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment ) var dayCountBasisDay : DayCountBasisDay var dayCountBasisYear : DayCountBasisYear var dayInMonth : Int val effectiveDate : LocalDate val effectiveDateAdjustment : DateRollConvention ? open fun equals ( other : Any ? ) : Boolean open fun hashCode ( ) : Int var interestPeriodAdjustment : AccrualAdjustment val notional : Amount var paymentCalendar : BusinessCalendar var paymentDelay : Int val paymentFrequency : Frequency var paymentRule : PaymentRule val terminationDate : LocalDate val terminationDateAdjustment : DateRollConvention ? open fun toString ( ) : String
+class FixedLeg : CommonLeg
+
+
+Module Contents
+FixedLeg ( fixedRatePayer : Party , notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment , fixedRate : FixedRate , rollConvention : DateRollConvention ) open fun equals ( other : Any ? ) : Boolean var fixedRate : FixedRate var fixedRatePayer : Party open fun hashCode ( ) : Int var rollConvention : DateRollConvention open fun toString ( ) : String
+class FloatingLeg : CommonLeg
+
+
+Module Contents
+FloatingLeg ( floatingRatePayer : Party , notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment , rollConvention : DateRollConvention , fixingRollConvention : DateRollConvention , resetDayInMonth : Int , fixingPeriod : DateOffset , resetRule : PaymentRule , fixingsPerPayment : Frequency , fixingCalendar : BusinessCalendar , index : String , indexSource : String , indexTenor : Tenor ) open fun equals ( other : Any ? ) : Boolean var fixingCalendar : BusinessCalendar var fixingPeriod : DateOffset var fixingRollConvention : DateRollConvention var fixingsPerPayment : Frequency var floatingRatePayer : Party open fun hashCode ( ) : Int var index : String var indexSource : String var indexTenor : Tenor var resetDayInMonth : Int var resetRule : PaymentRule var rollConvention : DateRollConvention open fun toString ( ) : String
+data class State : FixableDealState fun generateAgreement ( floatingLeg : FloatingLeg , fixedLeg : FixedLeg , calculation : Calculation , common : Common ) : TransactionBuilder fun generateFix ( tx : TransactionBuilder , irs : StateAndRef < State > , fixing : <ERROR CLASS> < LocalDate , Rate > ) : Unit val legalContractReference : SecureHash fun verify ( tx : TransactionForVerification ) : Unit
+class InterestRateSwapAPI interface Interpolator interface InterpolatorFactory object JsonSupport interface KeyManagementService data class LedgerTransaction : NamedByHash class LinearInterpolator : Interpolator interface LinearState : ContractState interface Message interface MessageHandlerRegistration interface MessageRecipientGroup : MessageRecipients interface MessageRecipients interface MessagingService interface MessagingServiceBuilder < out T : MessagingService > class MissingAttachmentsException : Exception class MockIdentityService : IdentityService class MockNetwork class MockNetworkMapCache : InMemoryNetworkMapCache class MonitoringService interface NamedByHash sealed class NetworkCacheError : Exception interface NetworkMapCache interface NetworkMapService class Node : AbstractNode class NodeAttachmentService : AttachmentStorage , AcceptsFileUpload interface NodeConfiguration class NodeConfigurationFromConfig : NodeConfiguration data class NodeInfo object NodeInterestRates sealed class NodeMapError : Exception class NodeRegistration class NodeTimestamperService : AbstractNodeService class NodeWalletService : WalletService object NullPublicKey : PublicKey , Comparable < PublicKey > open class OpaqueBytes interface OwnableState : ContractState data class Party data class PartyReference abstract class PaymentEvent : Event enum class PaymentRule open class PercentageRatioUnit : RatioUnit data class PhysicalLocation class Polynomial class ProgressTracker data class ProtocolClassRef : ProtocolRef data class ProtocolInstanceRef abstract class ProtocolLogic < T >
+
+
+Module Contents
+ProtocolLogic ( ) abstract fun call ( ) : T val logger : <ERROR CLASS> open val progressTracker : ProgressTracker ? lateinit var psm : ProtocolStateMachine < * > inline fun < reified T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit inline fun < reified T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T > val serviceHub : ServiceHub fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R
+interface ProtocolRef data class ProtocolRequiringAttention class ProtocolStateMachine < R >
+
+
+Module Contents
+ProtocolStateMachine ( logic : ProtocolLogic < R > , scheduler : <ERROR CLASS> ) lateinit var logger : <ERROR CLASS> val logic : ProtocolLogic < R > fun prepareForResumeWith ( serviceHub : ServiceHub , withObject : Any ? , logger : <ERROR CLASS> , suspendFunc : ( FiberRequest , ByteArray ) -> Unit ) : Unit fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , recvType : Class < T > ) : UntrustworthyData < T > val resultFuture : <ERROR CLASS> < R > fun run ( ) : R fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any , recvType : Class < T > ) : UntrustworthyData < T > lateinit var serviceHub : ServiceHub
+open class Rate abstract class RatePaymentEvent : PaymentEvent open class RatesFixProtocol : ProtocolLogic < Unit > open class RatioUnit class RecordingMap < K , V > : MutableMap < K , V > class ReferenceRate : FloatingRate interface RegulatorService class Requirements class ResolveTransactionsProtocol : ProtocolLogic < Unit > class ResponseFilter sealed class SecureHash : OpaqueBytes class SerializedBytes < T : Any > : OpaqueBytes object SerializedBytesSerializer interface ServiceHub abstract class ServiceType open class SignedData < T : Any > data class SignedTransaction : NamedByHash abstract class Simulation interface SingleMessageRecipient : MessageRecipients class SplineFunction class StackSnapshot : Throwable data class StateAndRef < out T : ContractState > class StateMachineManager data class StateRef interface StatesQuery interface StorageService open class StorageServiceImpl : StorageService data class Tenor class ThreadBox < T > data class TimestampCommand : CommandData interface TimestamperService sealed class TimestampingError : Exception class TimestampingProtocol : ProtocolLogic < LegallyIdentifiable > object TopicStringValidator class TradeSimulation : Simulation class TraderDemoProtocolBuyer : ProtocolLogic < Unit > class TraderDemoProtocolSeller : ProtocolLogic < Unit > data class TransactionBuildStep class TransactionBuilder class TransactionConflictException : Exception data class TransactionForVerification
+
+
+Module Contents
+TransactionForVerification ( inStates : List < ContractState > , outStates : List < ContractState > , attachments : List < Attachment > , commands : List < AuthenticatedObject < CommandData > > , origHash : SecureHash ) data class InOutGroup < T : ContractState , K : Any > val attachments : List < Attachment > val commands : List < AuthenticatedObject < CommandData > > fun equals ( other : Any ? ) : Boolean fun getTimestampBy ( timestampingAuthority : Party ) : TimestampCommand ? fun < T : ContractState , K : Any > groupStates ( ofType : Class < T > , selector : ( T ) -> K ) : List < InOutGroup < T , K > > inline fun < reified T : ContractState , K : Any > groupStates ( selector : ( T ) -> K ) : List < InOutGroup < T , K > > fun < T : ContractState , K : Any > groupStatesInternal ( inGroups : Map < K , List < T > > , outGroups : Map < K , List < T > > ) : List < InOutGroup < T , K > > fun hashCode ( ) : Int val inStates : List < ContractState > val origHash : SecureHash val outStates : List < ContractState > fun verify ( ) : Unit
+class TransactionGraphSearch : Callable < List < WireTransaction > > class TransactionGroup class TransactionResolutionException : Exception class TransactionVerificationException : Exception class TransientProperty < T > object TwoPartyDealProtocol object TwoPartyTradeProtocol
+
+
+Module Contents
+class AssetMismatchException : Exception class Buyer : ProtocolLogic < SignedTransaction > class Seller : ProtocolLogic < SignedTransaction > class SellerTradeInfo class SignaturesFromSeller val TRADE_TOPIC : String class UnacceptablePriceException : Exception fun runBuyer ( smm : StateMachineManager , timestampingAuthority : NodeInfo , otherSide : SingleMessageRecipient , acceptablePrice : Amount , typeToBuy : Class < out OwnableState > , sessionID : Long ) : <ERROR CLASS> < SignedTransaction > fun runSeller ( smm : StateMachineManager , timestampingAuthority : NodeInfo , otherSide : SingleMessageRecipient , assetToSell : StateAndRef < OwnableState > , price : Amount , myKeyPair : KeyPair , buyerSessionID : Long ) : <ERROR CLASS> < SignedTransaction >
+abstract class TypeOnlyCommandData : CommandData open class UnknownType class UntrustworthyData < T > object UpdateBusinessDayProtocol data class Wallet interface WalletService class WireNodeRegistration : SignedData < NodeRegistration > data class WireTransaction : NamedByHash object WireTransactionSerializer data class WorldCoordinate java.nio.file.Path java.security.KeyPair java.security.PrivateKey java.security.PublicKey java.time.LocalDate java.time.temporal.Temporal kotlin.ByteArray kotlin.ByteArray kotlin.Double kotlin.Int kotlin.Int kotlin.Long kotlin.String kotlin.String kotlin.collections.Iterable kotlin.collections.Iterable kotlin.collections.List
+package api
+
+
+Module Contents
+interface APIServer
+
+
+Module Contents
+abstract fun buildTransaction ( type : ContractDefRef , steps : List < TransactionBuildStep > ) : SerializedBytes < WireTransaction > abstract fun commitTransaction ( tx : SerializedBytes < WireTransaction > , signatures : List < WithKey > ) : SecureHash abstract fun fetchProtocolsRequiringAttention ( query : StatesQuery ) : Map < StateRef , ProtocolRequiringAttention > abstract fun fetchStates ( states : List < StateRef > ) : Map < StateRef , ContractState ? > abstract fun fetchTransactions ( txs : List < SecureHash > ) : Map < SecureHash , SignedTransaction ? > abstract fun generateTransactionSignature ( tx : SerializedBytes < WireTransaction > ) : WithKey abstract fun invokeProtocolSync ( type : ProtocolRef , args : Map < String , Any ? > ) : Any ? abstract fun provideProtocolResponse ( protocol : ProtocolInstanceRef , choice : SecureHash , args : Map < String , Any ? > ) : Unit abstract fun queryStates ( query : StatesQuery ) : List < StateRef > abstract fun serverTime ( ) : LocalDateTime
+class APIServerImpl : APIServer
+
+
+Module Contents
+APIServerImpl ( node : AbstractNode ) fun buildTransaction ( type : ContractDefRef , steps : List < TransactionBuildStep > ) : SerializedBytes < WireTransaction > fun commitTransaction ( tx : SerializedBytes < WireTransaction > , signatures : List < WithKey > ) : SecureHash fun fetchProtocolsRequiringAttention ( query : StatesQuery ) : Map < StateRef , ProtocolRequiringAttention > fun fetchStates ( states : List < StateRef > ) : Map < StateRef , ContractState ? > fun fetchTransactions ( txs : List < SecureHash > ) : Map < SecureHash , SignedTransaction ? > fun generateTransactionSignature ( tx : SerializedBytes < WireTransaction > ) : WithKey fun invokeProtocolSync ( type : ProtocolRef , args : Map < String , Any ? > ) : Any ? val node : AbstractNode fun provideProtocolResponse ( protocol : ProtocolInstanceRef , choice : SecureHash , args : Map < String , Any ? > ) : Unit fun queryStates ( query : StatesQuery ) : List < StateRef > fun serverTime ( ) : LocalDateTime
+class Config data class ContractClassRef : ContractDefRef interface ContractDefRef data class ContractLedgerRef : ContractDefRef class InterestRateSwapAPI data class ProtocolClassRef : ProtocolRef data class ProtocolInstanceRef interface ProtocolRef data class ProtocolRequiringAttention class ResponseFilter interface StatesQuery data class TransactionBuildStep
+package contracts
+
+
+Module Contents
+val CASH_PROGRAM_ID : Cash val CP_PROGRAM_ID : CommercialPaper val CROWDFUND_PROGRAM_ID : CrowdFund class Cash : Contract class CommercialPaper : Contract class CrowdFund : Contract val DUMMY_PROGRAM_ID : DummyContract interface DealState : LinearState class DummyContract : Contract open class Event interface FixableDealState : DealState class FixedRate : Rate class FixedRatePaymentEvent : RatePaymentEvent open class FloatingRate : Rate class FloatingRatePaymentEvent : RatePaymentEvent val IRS_PROGRAM_ID : InterestRateSwap class InsufficientBalanceException : Exception class InterestRateSwap : Contract
+
+
+Module Contents
+InterestRateSwap ( ) data class Calculation interface Commands : CommandData data class Common
+
+
+Module Contents
+Common ( baseCurrency : Currency , eligibleCurrency : Currency , eligibleCreditSupport : String , independentAmounts : Amount , threshold : Amount , minimumTransferAmount : Amount , rounding : Amount , valuationDate : String , notificationTime : String , resolutionTime : String , interestRate : ReferenceRate , addressForTransfers : String , exposure : UnknownType , localBusinessDay : BusinessCalendar , dailyInterestAmount : Expression , tradeID : String , hashLegalDocs : String ) val addressForTransfers : String val baseCurrency : Currency val dailyInterestAmount : Expression val eligibleCreditSupport : String val eligibleCurrency : Currency val exposure : UnknownType val hashLegalDocs : String val independentAmounts : Amount val interestRate : ReferenceRate val localBusinessDay : BusinessCalendar val minimumTransferAmount : Amount val notificationTime : String val resolutionTime : String val rounding : Amount val threshold : Amount val tradeID : String val valuationDate : String
+abstract class CommonLeg
+
+
+Module Contents
+CommonLeg ( notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment ) var dayCountBasisDay : DayCountBasisDay var dayCountBasisYear : DayCountBasisYear var dayInMonth : Int val effectiveDate : LocalDate val effectiveDateAdjustment : DateRollConvention ? open fun equals ( other : Any ? ) : Boolean open fun hashCode ( ) : Int var interestPeriodAdjustment : AccrualAdjustment val notional : Amount var paymentCalendar : BusinessCalendar var paymentDelay : Int val paymentFrequency : Frequency var paymentRule : PaymentRule val terminationDate : LocalDate val terminationDateAdjustment : DateRollConvention ? open fun toString ( ) : String
+class FixedLeg : CommonLeg
+
+
+Module Contents
+FixedLeg ( fixedRatePayer : Party , notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment , fixedRate : FixedRate , rollConvention : DateRollConvention ) open fun equals ( other : Any ? ) : Boolean var fixedRate : FixedRate var fixedRatePayer : Party open fun hashCode ( ) : Int var rollConvention : DateRollConvention open fun toString ( ) : String
+class FloatingLeg : CommonLeg
+
+
+Module Contents
+FloatingLeg ( floatingRatePayer : Party , notional : Amount , paymentFrequency : Frequency , effectiveDate : LocalDate , effectiveDateAdjustment : DateRollConvention ? , terminationDate : LocalDate , terminationDateAdjustment : DateRollConvention ? , dayCountBasisDay : DayCountBasisDay , dayCountBasisYear : DayCountBasisYear , dayInMonth : Int , paymentRule : PaymentRule , paymentDelay : Int , paymentCalendar : BusinessCalendar , interestPeriodAdjustment : AccrualAdjustment , rollConvention : DateRollConvention , fixingRollConvention : DateRollConvention , resetDayInMonth : Int , fixingPeriod : DateOffset , resetRule : PaymentRule , fixingsPerPayment : Frequency , fixingCalendar : BusinessCalendar , index : String , indexSource : String , indexTenor : Tenor ) open fun equals ( other : Any ? ) : Boolean var fixingCalendar : BusinessCalendar var fixingPeriod : DateOffset var fixingRollConvention : DateRollConvention var fixingsPerPayment : Frequency var floatingRatePayer : Party open fun hashCode ( ) : Int var index : String var indexSource : String var indexTenor : Tenor var resetDayInMonth : Int var resetRule : PaymentRule var rollConvention : DateRollConvention open fun toString ( ) : String
+data class State : FixableDealState fun generateAgreement ( floatingLeg : FloatingLeg , fixedLeg : FixedLeg , calculation : Calculation , common : Common ) : TransactionBuilder fun generateFix ( tx : TransactionBuilder , irs : StateAndRef < State > , fixing : <ERROR CLASS> < LocalDate , Rate > ) : Unit val legalContractReference : SecureHash fun verify ( tx : TransactionForVerification ) : Unit
+abstract class PaymentEvent : Event open class PercentageRatioUnit : RatioUnit open class Rate abstract class RatePaymentEvent : PaymentEvent open class RatioUnit class ReferenceRate : FloatingRate open class UnknownType fun State . exportIRSToCSV ( ) : String kotlin.Int kotlin.String kotlin.collections.Iterable operator fun Amount . times ( other : RatioUnit ) : Amount
+package core
+
+
+Module Contents
+enum class AccrualAdjustment data class Amount : Comparable < Amount > interface Attachment : NamedByHash data class AuthenticatedObject < out T : Any > open class BusinessCalendar val CHF : Currency data class Command interface CommandData interface Contract interface ContractState enum class DateOffset enum class DateRollConvention enum class DateRollDirection enum class DayCountBasisDay enum class DayCountBasisYear data class Expression object ExpressionDeserializer object ExpressionSerializer data class Fix : CommandData data class FixOf enum class Frequency val GBP : Currency data class LedgerTransaction : NamedByHash interface LinearState : ContractState interface NamedByHash interface OwnableState : ContractState data class Party data class PartyReference enum class PaymentRule val R : Requirements class Requirements val RunOnCallerThread : <ERROR CLASS> data class SignedTransaction : NamedByHash data class StateAndRef < out T : ContractState > data class StateRef data class Tenor class ThreadBox < T > data class TimestampCommand : CommandData class TransactionBuilder class TransactionConflictException : Exception data class TransactionForVerification
+
+
+Module Contents
+TransactionForVerification ( inStates : List < ContractState > , outStates : List < ContractState > , attachments : List < Attachment > , commands : List < AuthenticatedObject < CommandData > > , origHash : SecureHash ) data class InOutGroup < T : ContractState , K : Any > val attachments : List < Attachment > val commands : List < AuthenticatedObject < CommandData > > fun equals ( other : Any ? ) : Boolean fun getTimestampBy ( timestampingAuthority : Party ) : TimestampCommand ? fun < T : ContractState , K : Any > groupStates ( ofType : Class < T > , selector : ( T ) -> K ) : List < InOutGroup < T , K > > inline fun < reified T : ContractState , K : Any > groupStates ( selector : ( T ) -> K ) : List < InOutGroup < T , K > > fun < T : ContractState , K : Any > groupStatesInternal ( inGroups : Map < K , List < T > > , outGroups : Map < K , List < T > > ) : List < InOutGroup < T , K > > fun hashCode ( ) : Int val inStates : List < ContractState > val origHash : SecureHash val outStates : List < ContractState > fun verify ( ) : Unit
+class TransactionGraphSearch : Callable < List < WireTransaction > > class TransactionGroup class TransactionResolutionException : Exception class TransactionVerificationException : Exception class TransientProperty < T > abstract class TypeOnlyCommandData : CommandData val USD : Currency data class WireTransaction : NamedByHash fun calculateDaysBetween ( startDate : LocalDate , endDate : LocalDate , dcbYear : DayCountBasisYear , dcbDay : DayCountBasisDay ) : Int fun currency ( code : String ) : Currency fun extractZipFile ( : Path , : Path ) : Unit fun < T > <ERROR CLASS> < T > . failure ( executor : Executor , body : ( Throwable ) -> Unit ) : <ERROR CLASS> infix fun < T > <ERROR CLASS> < T > . failure ( body : ( Throwable ) -> Unit ) : <ERROR CLASS> < T > fun ContractState . hash ( ) : SecureHash java.nio.file.Path java.time.LocalDate java.time.temporal.Temporal kotlin.Double kotlin.Int kotlin.Long kotlin.String kotlin.collections.Iterable kotlin.collections.List inline fun < T > logElapsedTime ( label : String , logger : <ERROR CLASS> ? = null, body : ( ) -> T ) : T fun random63BitValue ( ) : Long inline fun < R > requireThat ( body : Requirements . ( ) -> R ) : R fun < T > <ERROR CLASS> < T > . setFrom ( logger : <ERROR CLASS> ? = null, block : ( ) -> T ) : <ERROR CLASS> < T > fun < T > <ERROR CLASS> < T > . success ( executor : Executor , body : ( T ) -> Unit ) : <ERROR CLASS> infix fun < T > <ERROR CLASS> < T > . success ( body : ( T ) -> Unit ) : <ERROR CLASS> < T > fun < T > <ERROR CLASS> < T > . then ( executor : Executor , body : ( ) -> Unit ) : <ERROR CLASS> infix fun < T > <ERROR CLASS> < T > . then ( body : ( ) -> Unit ) : <ERROR CLASS> < T > fun WireTransaction . toLedgerTransaction ( identityService : IdentityService , attachmentStorage : AttachmentStorage ) : LedgerTransaction fun SignedTransaction . verifyToLedgerTransaction ( identityService : IdentityService , attachmentStorage : AttachmentStorage ) : LedgerTransaction
+package core.crypto package core.math package core.messaging package core.node package core.node.services package core.node.servlets package core.node.subsystems package core.protocols
+
+
+Module Contents
+abstract class ProtocolLogic < T >
+
+
+Module Contents
+ProtocolLogic ( ) abstract fun call ( ) : T val logger : <ERROR CLASS> open val progressTracker : ProgressTracker ? lateinit var psm : ProtocolStateMachine < * > inline fun < reified T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit inline fun < reified T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T > val serviceHub : ServiceHub fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R
+class ProtocolStateMachine < R >
+
+
+Module Contents
+ProtocolStateMachine ( logic : ProtocolLogic < R > , scheduler : <ERROR CLASS> ) lateinit var logger : <ERROR CLASS> val logic : ProtocolLogic < R > fun prepareForResumeWith ( serviceHub : ServiceHub , withObject : Any ? , logger : <ERROR CLASS> , suspendFunc : ( FiberRequest , ByteArray ) -> Unit ) : Unit fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , recvType : Class < T > ) : UntrustworthyData < T > val resultFuture : <ERROR CLASS> < R > fun run ( ) : R fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any , recvType : Class < T > ) : UntrustworthyData < T > lateinit var serviceHub : ServiceHub
+
+
+
+package core.serialization package core.testing package core.utilities package demos package demos.protocols package protocols
+
+
+Module Contents
+abstract class AbstractRequestMessage class FetchAttachmentsProtocol : FetchDataProtocol < Attachment , ByteArray > abstract class FetchDataProtocol < T : NamedByHash , W : Any > : ProtocolLogic < Result < T > > class FetchTransactionsProtocol : FetchDataProtocol < SignedTransaction , SignedTransaction > open class RatesFixProtocol : ProtocolLogic < Unit > class ResolveTransactionsProtocol : ProtocolLogic < Unit > class TimestampingProtocol : ProtocolLogic < LegallyIdentifiable > object TwoPartyDealProtocol object TwoPartyTradeProtocol
+
+
+Module Contents
+class AssetMismatchException : Exception class Buyer : ProtocolLogic < SignedTransaction > class Seller : ProtocolLogic < SignedTransaction > class SellerTradeInfo class SignaturesFromSeller val TRADE_TOPIC : String class UnacceptablePriceException : Exception fun runBuyer ( smm : StateMachineManager , timestampingAuthority : NodeInfo , otherSide : SingleMessageRecipient , acceptablePrice : Amount , typeToBuy : Class < out OwnableState > , sessionID : Long ) : <ERROR CLASS> < SignedTransaction > fun runSeller ( smm : StateMachineManager , timestampingAuthority : NodeInfo , otherSide : SingleMessageRecipient , assetToSell : StateAndRef < OwnableState > , price : Amount , myKeyPair : KeyPair , buyerSessionID : Long ) : <ERROR CLASS> < SignedTransaction >
+
+
+
+
+
+
+
+
diff --git a/docs/build/html/api/index.html b/docs/build/html/api/index.html
new file mode 100644
index 0000000000..a8472fdb06
--- /dev/null
+++ b/docs/build/html/api/index.html
@@ -0,0 +1,118 @@
+
+
+Packages
+
+Index
+All Types
+
diff --git a/docs/build/html/api/protocols/-abstract-request-message/-init-.html b/docs/build/html/api/protocols/-abstract-request-message/-init-.html
new file mode 100644
index 0000000000..d40df32592
--- /dev/null
+++ b/docs/build/html/api/protocols/-abstract-request-message/-init-.html
@@ -0,0 +1,16 @@
+
+
+AbstractRequestMessage.<init> -
+protocols / AbstractRequestMessage / <init> <init>
+AbstractRequestMessage ( replyTo : MessageRecipients , sessionID : Long ? ) Abstract superclass for request messages sent to services, which includes common
+fields such as replyTo and replyToTopic.
+AbstractRequestMessage -
+protocols / AbstractRequestMessage AbstractRequestMessage
+abstract class AbstractRequestMessage Abstract superclass for request messages sent to services, which includes common
+fields such as replyTo and replyToTopic.
+Constructors
+
+
+
+
+<init>
+
+AbstractRequestMessage ( replyTo : MessageRecipients , sessionID : Long ? ) Abstract superclass for request messages sent to services, which includes common
+fields such as replyTo and replyToTopic.
+
+
+
+
+Properties
+
+Inheritors
+
+
+
+
+FetchMapRequest
+
+class FetchMapRequest : AbstractRequestMessage
+
+
+
+QueryIdentityRequest
+
+class QueryIdentityRequest : AbstractRequestMessage
+
+
+
+QueryRequest
+
+class QueryRequest : AbstractRequestMessage
+
+
+
+RegistrationRequest
+
+class RegistrationRequest : AbstractRequestMessage
+
+
+
+Request
+
+class Request : AbstractRequestMessage
+
+
+
+Request
+
+class Request : AbstractRequestMessage
+
+
+
+SignRequest
+
+class SignRequest : AbstractRequestMessage
+
+
+
+SubscribeRequest
+
+class SubscribeRequest : AbstractRequestMessage
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-abstract-request-message/reply-to.html b/docs/build/html/api/protocols/-abstract-request-message/reply-to.html
new file mode 100644
index 0000000000..c7c5fdea23
--- /dev/null
+++ b/docs/build/html/api/protocols/-abstract-request-message/reply-to.html
@@ -0,0 +1,15 @@
+
+
+AbstractRequestMessage.replyTo -
+protocols / AbstractRequestMessage / replyTo replyTo
+val replyTo : MessageRecipients AbstractRequestMessage.sessionID -
+protocols / AbstractRequestMessage / sessionID sessionID
+val sessionID : Long ? FetchAttachmentsProtocol.<init> -
+protocols / FetchAttachmentsProtocol / <init> <init>
+FetchAttachmentsProtocol ( requests : Set < SecureHash > , otherSide : SingleMessageRecipient ) Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
+attachments are saved to local storage automatically.
+FetchAttachmentsProtocol.TOPIC -
+protocols / FetchAttachmentsProtocol / TOPIC TOPIC
+const val TOPIC : String FetchAttachmentsProtocol.convert -
+protocols / FetchAttachmentsProtocol / convert convert
+protected fun convert ( wire : ByteArray ) : Attachment FetchAttachmentsProtocol -
+protocols / FetchAttachmentsProtocol FetchAttachmentsProtocol
+class FetchAttachmentsProtocol : FetchDataProtocol < Attachment , ByteArray > Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
+attachments are saved to local storage automatically.
+Constructors
+
+
+
+
+<init>
+
+FetchAttachmentsProtocol ( requests : Set < SecureHash > , otherSide : SingleMessageRecipient ) Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
+attachments are saved to local storage automatically.
+
+
+
+
+Properties
+
+Inherited Properties
+
+Functions
+
+Inherited Functions
+
+
+
+
+call
+
+open fun call ( ) : Result < T > This is where you fill out your business logic.
+
+
+
+
+Companion Object Properties
+
+
+
+
+TOPIC
+
+const val TOPIC : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-fetch-attachments-protocol/load.html b/docs/build/html/api/protocols/-fetch-attachments-protocol/load.html
new file mode 100644
index 0000000000..d02afa90ab
--- /dev/null
+++ b/docs/build/html/api/protocols/-fetch-attachments-protocol/load.html
@@ -0,0 +1,16 @@
+
+
+FetchAttachmentsProtocol.load -
+protocols / FetchAttachmentsProtocol / load load
+protected fun load ( txid : SecureHash ) : Attachment ? FetchDataProtocol.load FetchAttachmentsProtocol.maybeWriteToDisk -
+protocols / FetchAttachmentsProtocol / maybeWriteToDisk maybeWriteToDisk
+protected fun maybeWriteToDisk ( downloaded : List < Attachment > ) : Unit FetchAttachmentsProtocol.queryTopic -
+protocols / FetchAttachmentsProtocol / queryTopic queryTopic
+protected val queryTopic : String FetchDataProtocol.queryTopic FetchDataProtocol.BadAnswer.<init> -
+protocols / FetchDataProtocol / BadAnswer / <init> <init>
+BadAnswer ( ) FetchDataProtocol.BadAnswer -
+protocols / FetchDataProtocol / BadAnswer BadAnswer
+open class BadAnswer : Exception Constructors
+
+
+
+
+<init>
+
+BadAnswer ( )
+
+
+
+Inheritors
+
+
+
diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/-init-.html b/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/-init-.html
new file mode 100644
index 0000000000..45a95f8d11
--- /dev/null
+++ b/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/-init-.html
@@ -0,0 +1,14 @@
+
+
+FetchDataProtocol.DownloadedVsRequestedDataMismatch.<init> -
+protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch / <init> <init>
+DownloadedVsRequestedDataMismatch ( requested : SecureHash , got : SecureHash ) FetchDataProtocol.DownloadedVsRequestedDataMismatch.got -
+protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch / got got
+val got : SecureHash FetchDataProtocol.DownloadedVsRequestedDataMismatch -
+protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch DownloadedVsRequestedDataMismatch
+class DownloadedVsRequestedDataMismatch : BadAnswer Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/requested.html b/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/requested.html
new file mode 100644
index 0000000000..9d4026cbea
--- /dev/null
+++ b/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/requested.html
@@ -0,0 +1,15 @@
+
+
+FetchDataProtocol.DownloadedVsRequestedDataMismatch.requested -
+protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch / requested requested
+val requested : SecureHash FetchDataProtocol.HashNotFound.<init> -
+protocols / FetchDataProtocol / HashNotFound / <init> <init>
+HashNotFound ( requested : SecureHash ) FetchDataProtocol.HashNotFound -
+protocols / FetchDataProtocol / HashNotFound HashNotFound
+class HashNotFound : BadAnswer Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/requested.html b/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/requested.html
new file mode 100644
index 0000000000..cd2326c28b
--- /dev/null
+++ b/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/requested.html
@@ -0,0 +1,15 @@
+
+
+FetchDataProtocol.HashNotFound.requested -
+protocols / FetchDataProtocol / HashNotFound / requested requested
+val requested : SecureHash FetchDataProtocol.<init> -
+protocols / FetchDataProtocol / <init> <init>
+FetchDataProtocol ( requests : Set < SecureHash > , otherSide : SingleMessageRecipient ) An abstract protocol for fetching typed data from a remote peer.
+Given a set of hashes (IDs), either loads them from local disk or asks the remote peer to provide them.
+A malicious response in which the data provided by the remote peer does not hash to the requested hash results in
+DownloadedVsRequestedDataMismatch being thrown. If the remote peer doesnt have an entry, it results in a
+HashNotFound exception being thrown.
+By default this class does not insert data into any local database, if you want to do that after missing items were
+fetched then override maybeWriteToDisk . You must override load and queryTopic . If the wire type is not the
+same as the ultimate type, you must also override convert .
+Parameters
+T - The ultimate type of the data being fetched.W - The wire type of the data being fetched, for when it isnt the same as the ultimate type.FetchDataProtocol.Result.<init> -
+protocols / FetchDataProtocol / Result / <init> <init>
+Result ( fromDisk : List < T > , downloaded : List < T > ) FetchDataProtocol.Result.downloaded -
+protocols / FetchDataProtocol / Result / downloaded downloaded
+val downloaded : List < T > FetchDataProtocol.Result.fromDisk -
+protocols / FetchDataProtocol / Result / fromDisk fromDisk
+val fromDisk : List < T > FetchDataProtocol.Result -
+protocols / FetchDataProtocol / Result Result
+data class Result < T : NamedByHash > Constructors
+
+
+
+
+<init>
+
+Result ( fromDisk : List < T > , downloaded : List < T > )
+
+
+
+Properties
+
+
+
+
+downloaded
+
+val downloaded : List < T >
+
+
+
+fromDisk
+
+val fromDisk : List < T >
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/call.html b/docs/build/html/api/protocols/-fetch-data-protocol/call.html
new file mode 100644
index 0000000000..528e5d4981
--- /dev/null
+++ b/docs/build/html/api/protocols/-fetch-data-protocol/call.html
@@ -0,0 +1,17 @@
+
+
+FetchDataProtocol.call -
+protocols / FetchDataProtocol / call call
+open fun call ( ) : Result < T > ProtocolLogic.call This is where you fill out your business logic.
+FetchDataProtocol.convert -
+protocols / FetchDataProtocol / convert convert
+protected open fun convert ( wire : W ) : T FetchDataProtocol -
+protocols / FetchDataProtocol FetchDataProtocol
+abstract class FetchDataProtocol < T : NamedByHash , W : Any > : ProtocolLogic < Result < T > > An abstract protocol for fetching typed data from a remote peer.
+Given a set of hashes (IDs), either loads them from local disk or asks the remote peer to provide them.
+A malicious response in which the data provided by the remote peer does not hash to the requested hash results in
+DownloadedVsRequestedDataMismatch being thrown. If the remote peer doesnt have an entry, it results in a
+HashNotFound exception being thrown.
+By default this class does not insert data into any local database, if you want to do that after missing items were
+fetched then override maybeWriteToDisk . You must override load and queryTopic . If the wire type is not the
+same as the ultimate type, you must also override convert .
+Parameters
+T - The ultimate type of the data being fetched.W - The wire type of the data being fetched, for when it isnt the same as the ultimate type.Types
+
+Exceptions
+
+Constructors
+
+Properties
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker ? Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+
+
+
+call
+
+open fun call ( ) : Result < T > This is where you fill out your business logic.
+
+
+
+
+convert
+
+open fun convert ( wire : W ) : T
+
+
+
+load
+
+abstract fun load ( txid : SecureHash ) : T ?
+
+
+
+maybeWriteToDisk
+
+open fun maybeWriteToDisk ( downloaded : List < T > ) : Unit
+
+
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Inheritors
+
+
+
+
+FetchAttachmentsProtocol
+
+class FetchAttachmentsProtocol : FetchDataProtocol < Attachment , ByteArray > Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
+attachments are saved to local storage automatically.
+
+
+
+
+FetchTransactionsProtocol
+
+class FetchTransactionsProtocol : FetchDataProtocol < SignedTransaction , SignedTransaction > Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.
+
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/load.html b/docs/build/html/api/protocols/-fetch-data-protocol/load.html
new file mode 100644
index 0000000000..b891e4b0bd
--- /dev/null
+++ b/docs/build/html/api/protocols/-fetch-data-protocol/load.html
@@ -0,0 +1,15 @@
+
+
+FetchDataProtocol.load -
+protocols / FetchDataProtocol / load load
+protected abstract fun load ( txid : SecureHash ) : T ? FetchDataProtocol.maybeWriteToDisk -
+protocols / FetchDataProtocol / maybeWriteToDisk maybeWriteToDisk
+protected open fun maybeWriteToDisk ( downloaded : List < T > ) : Unit FetchDataProtocol.otherSide -
+protocols / FetchDataProtocol / otherSide otherSide
+protected val otherSide : SingleMessageRecipient FetchDataProtocol.queryTopic -
+protocols / FetchDataProtocol / queryTopic queryTopic
+protected abstract val queryTopic : String FetchDataProtocol.requests -
+protocols / FetchDataProtocol / requests requests
+protected val requests : Set < SecureHash > FetchTransactionsProtocol.<init> -
+protocols / FetchTransactionsProtocol / <init> <init>
+FetchTransactionsProtocol ( requests : Set < SecureHash > , otherSide : SingleMessageRecipient ) Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.
+A malicious response in which the data provided by the remote peer does not hash to the requested hash results in
+FetchDataProtocol.DownloadedVsRequestedDataMismatch being thrown. If the remote peer doesnt have an entry, it
+results in a FetchDataProtocol.HashNotFound exception. Note that returned transactions are not inserted into
+the database, because its up to the caller to actually verify the transactions are valid.
+FetchTransactionsProtocol.TOPIC -
+protocols / FetchTransactionsProtocol / TOPIC TOPIC
+const val TOPIC : String FetchTransactionsProtocol -
+protocols / FetchTransactionsProtocol FetchTransactionsProtocol
+class FetchTransactionsProtocol : FetchDataProtocol < SignedTransaction , SignedTransaction > Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.
+A malicious response in which the data provided by the remote peer does not hash to the requested hash results in
+FetchDataProtocol.DownloadedVsRequestedDataMismatch being thrown. If the remote peer doesnt have an entry, it
+results in a FetchDataProtocol.HashNotFound exception. Note that returned transactions are not inserted into
+the database, because its up to the caller to actually verify the transactions are valid.
+Constructors
+
+
+
+
+<init>
+
+FetchTransactionsProtocol ( requests : Set < SecureHash > , otherSide : SingleMessageRecipient ) Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.
+
+
+
+
+Properties
+
+Inherited Properties
+
+Functions
+
+Inherited Functions
+
+
+
+
+call
+
+open fun call ( ) : Result < T > This is where you fill out your business logic.
+
+
+
+
+Companion Object Properties
+
+
+
+
+TOPIC
+
+const val TOPIC : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-fetch-transactions-protocol/load.html b/docs/build/html/api/protocols/-fetch-transactions-protocol/load.html
new file mode 100644
index 0000000000..7456f4fdac
--- /dev/null
+++ b/docs/build/html/api/protocols/-fetch-transactions-protocol/load.html
@@ -0,0 +1,16 @@
+
+
+FetchTransactionsProtocol.load -
+protocols / FetchTransactionsProtocol / load load
+protected fun load ( txid : SecureHash ) : SignedTransaction ? FetchDataProtocol.load FetchTransactionsProtocol.queryTopic -
+protocols / FetchTransactionsProtocol / queryTopic queryTopic
+protected val queryTopic : String FetchDataProtocol.queryTopic RatesFixProtocol.FixOutOfRange.<init> -
+protocols / RatesFixProtocol / FixOutOfRange / <init> <init>
+FixOutOfRange ( byAmount : BigDecimal ) RatesFixProtocol.FixOutOfRange.byAmount -
+protocols / RatesFixProtocol / FixOutOfRange / byAmount byAmount
+val byAmount : BigDecimal RatesFixProtocol.FixOutOfRange -
+protocols / RatesFixProtocol / FixOutOfRange FixOutOfRange
+class FixOutOfRange : Exception Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-rates-fix-protocol/-init-.html b/docs/build/html/api/protocols/-rates-fix-protocol/-init-.html
new file mode 100644
index 0000000000..ae67f70699
--- /dev/null
+++ b/docs/build/html/api/protocols/-rates-fix-protocol/-init-.html
@@ -0,0 +1,21 @@
+
+
+RatesFixProtocol.<init> -
+protocols / RatesFixProtocol / <init> <init>
+RatesFixProtocol ( tx : TransactionBuilder , oracle : NodeInfo , fixOf : FixOf , expectedRate : BigDecimal , rateTolerance : BigDecimal , progressTracker : ProgressTracker = RatesFixProtocol.tracker(fixOf.name)) This protocol queries the given oracle for an interest rate fix, and if it is within the given tolerance embeds the
+fix in the transaction and then proceeds to get the oracle to sign it. Although the call method combines the query
+and signing step, you can run the steps individually by constructing this object and then using the public methods
+for each step.
+Exceptions
+FixOutOfRange - if the returned fix was further away from the expected rate by the given amount.RatesFixProtocol.QUERYING.<init> -
+protocols / RatesFixProtocol / QUERYING / <init> <init>
+QUERYING ( name : String ) RatesFixProtocol.QUERYING -
+protocols / RatesFixProtocol / QUERYING QUERYING
+class QUERYING : Step Constructors
+
+
+
+
+<init>
+
+QUERYING ( name : String )
+
+
+
+Properties
+
+
+
+
+name
+
+val name : String
+
+
+
+Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-rates-fix-protocol/-q-u-e-r-y-i-n-g/name.html b/docs/build/html/api/protocols/-rates-fix-protocol/-q-u-e-r-y-i-n-g/name.html
new file mode 100644
index 0000000000..79e293ddc8
--- /dev/null
+++ b/docs/build/html/api/protocols/-rates-fix-protocol/-q-u-e-r-y-i-n-g/name.html
@@ -0,0 +1,15 @@
+
+
+RatesFixProtocol.QUERYING.name -
+protocols / RatesFixProtocol / QUERYING / name name
+val name : String RatesFixProtocol.QueryRequest.<init> -
+protocols / RatesFixProtocol / QueryRequest / <init> <init>
+QueryRequest ( queries : List < FixOf > , replyTo : SingleMessageRecipient , sessionID : Long ) RatesFixProtocol.QueryRequest -
+protocols / RatesFixProtocol / QueryRequest QueryRequest
+class QueryRequest : AbstractRequestMessage Constructors
+
+Properties
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-rates-fix-protocol/-query-request/queries.html b/docs/build/html/api/protocols/-rates-fix-protocol/-query-request/queries.html
new file mode 100644
index 0000000000..e39b1fafde
--- /dev/null
+++ b/docs/build/html/api/protocols/-rates-fix-protocol/-query-request/queries.html
@@ -0,0 +1,15 @@
+
+
+RatesFixProtocol.QueryRequest.queries -
+protocols / RatesFixProtocol / QueryRequest / queries queries
+val queries : List < FixOf > RatesFixProtocol.SIGNING -
+protocols / RatesFixProtocol / SIGNING SIGNING
+object SIGNING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/-init-.html b/docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/-init-.html
new file mode 100644
index 0000000000..bc874b13c5
--- /dev/null
+++ b/docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/-init-.html
@@ -0,0 +1,14 @@
+
+
+RatesFixProtocol.SignRequest.<init> -
+protocols / RatesFixProtocol / SignRequest / <init> <init>
+SignRequest ( tx : WireTransaction , replyTo : SingleMessageRecipient , sessionID : Long ) RatesFixProtocol.SignRequest -
+protocols / RatesFixProtocol / SignRequest SignRequest
+class SignRequest : AbstractRequestMessage Constructors
+
+Properties
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/tx.html b/docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/tx.html
new file mode 100644
index 0000000000..cc1b15d4b7
--- /dev/null
+++ b/docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/tx.html
@@ -0,0 +1,15 @@
+
+
+RatesFixProtocol.SignRequest.tx -
+protocols / RatesFixProtocol / SignRequest / tx tx
+val tx : WireTransaction RatesFixProtocol.TOPIC -
+protocols / RatesFixProtocol / TOPIC TOPIC
+val TOPIC : String RatesFixProtocol.TOPIC_QUERY -
+protocols / RatesFixProtocol / TOPIC_QUERY TOPIC_QUERY
+val TOPIC_QUERY : String RatesFixProtocol.TOPIC_SIGN -
+protocols / RatesFixProtocol / TOPIC_SIGN TOPIC_SIGN
+val TOPIC_SIGN : String RatesFixProtocol.WORKING -
+protocols / RatesFixProtocol / WORKING WORKING
+object WORKING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-rates-fix-protocol/before-signing.html b/docs/build/html/api/protocols/-rates-fix-protocol/before-signing.html
new file mode 100644
index 0000000000..3f4b9787fa
--- /dev/null
+++ b/docs/build/html/api/protocols/-rates-fix-protocol/before-signing.html
@@ -0,0 +1,17 @@
+
+
+RatesFixProtocol.beforeSigning -
+protocols / RatesFixProtocol / beforeSigning beforeSigning
+protected open fun beforeSigning ( fix : Fix ) : Unit You can override this to perform any additional work needed after the fix is added to the transaction but
+before its sent back to the oracle for signing (for example, adding output states that depend on the fix).
+RatesFixProtocol.call -
+protocols / RatesFixProtocol / call call
+open fun call ( ) : Unit ProtocolLogic.call This is where you fill out your business logic.
+RatesFixProtocol -
+protocols / RatesFixProtocol RatesFixProtocol
+open class RatesFixProtocol : ProtocolLogic < Unit > This protocol queries the given oracle for an interest rate fix, and if it is within the given tolerance embeds the
+fix in the transaction and then proceeds to get the oracle to sign it. Although the call method combines the query
+and signing step, you can run the steps individually by constructing this object and then using the public methods
+for each step.
+Exceptions
+FixOutOfRange - if the returned fix was further away from the expected rate by the given amount.Types
+
+Exceptions
+
+Constructors
+
+
+
+
+<init>
+
+RatesFixProtocol ( tx : TransactionBuilder , oracle : NodeInfo , fixOf : FixOf , expectedRate : BigDecimal , rateTolerance : BigDecimal , progressTracker : ProgressTracker = RatesFixProtocol.tracker(fixOf.name)) This protocol queries the given oracle for an interest rate fix, and if it is within the given tolerance embeds the
+fix in the transaction and then proceeds to get the oracle to sign it. Although the call method combines the query
+and signing step, you can run the steps individually by constructing this object and then using the public methods
+for each step.
+
+
+
+
+Properties
+
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+tx
+
+val tx : TransactionBuilder
+
+
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+
+
+
+beforeSigning
+
+open fun beforeSigning ( fix : Fix ) : Unit You can override this to perform any additional work needed after the fix is added to the transaction but
+before its sent back to the oracle for signing (for example, adding output states that depend on the fix).
+
+
+
+
+call
+
+open fun call ( ) : Unit This is where you fill out your business logic.
+
+
+
+
+query
+
+fun query ( ) : Fix
+
+
+
+sign
+
+fun sign ( ) : LegallyIdentifiable
+
+
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Companion Object Properties
+
+Companion Object Functions
+
+
+
diff --git a/docs/build/html/api/protocols/-rates-fix-protocol/progress-tracker.html b/docs/build/html/api/protocols/-rates-fix-protocol/progress-tracker.html
new file mode 100644
index 0000000000..2414f7db02
--- /dev/null
+++ b/docs/build/html/api/protocols/-rates-fix-protocol/progress-tracker.html
@@ -0,0 +1,24 @@
+
+
+RatesFixProtocol.progressTracker -
+protocols / RatesFixProtocol / progressTracker progressTracker
+open val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+RatesFixProtocol.query -
+protocols / RatesFixProtocol / query query
+fun query ( ) : Fix RatesFixProtocol.sign -
+protocols / RatesFixProtocol / sign sign
+fun sign ( ) : LegallyIdentifiable RatesFixProtocol.tracker -
+protocols / RatesFixProtocol / tracker tracker
+fun tracker ( fixName : String ) : ProgressTracker RatesFixProtocol.tx -
+protocols / RatesFixProtocol / tx tx
+protected val tx : TransactionBuilder ResolveTransactionsProtocol.ExcessivelyLargeTransactionGraph.<init> -
+protocols / ResolveTransactionsProtocol / ExcessivelyLargeTransactionGraph / <init> <init>
+ExcessivelyLargeTransactionGraph ( ) ResolveTransactionsProtocol.ExcessivelyLargeTransactionGraph -
+protocols / ResolveTransactionsProtocol / ExcessivelyLargeTransactionGraph ExcessivelyLargeTransactionGraph
+class ExcessivelyLargeTransactionGraph : Exception Constructors
+
+
+
+
+<init>
+
+ExcessivelyLargeTransactionGraph ( )
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-resolve-transactions-protocol/-init-.html b/docs/build/html/api/protocols/-resolve-transactions-protocol/-init-.html
new file mode 100644
index 0000000000..72a5c8ff35
--- /dev/null
+++ b/docs/build/html/api/protocols/-resolve-transactions-protocol/-init-.html
@@ -0,0 +1,28 @@
+
+
+ResolveTransactionsProtocol.<init> -
+protocols / ResolveTransactionsProtocol / <init> <init>
+ResolveTransactionsProtocol ( stx : SignedTransaction , otherSide : SingleMessageRecipient ) ResolveTransactionsProtocol ( wtx : WireTransaction , otherSide : SingleMessageRecipient ) ResolveTransactionsProtocol ( txHashes : Set < SecureHash > , otherSide : SingleMessageRecipient ) This protocol fetches each transaction identified by the given hashes from either disk or network, along with all
+their dependencies, and verifies them together using a single TransactionGroup . If no exception is thrown, then
+all the transactions have been successfully verified and inserted into the local database.
+A couple of constructors are provided that accept a single transaction. When these are used, the dependencies of that
+transaction are resolved and then the transaction itself is verified. Again, if successful, the results are inserted
+into the database as long as a SignedTransaction was provided. If only the WireTransaction form was provided
+then this isnt enough to put into the local database, so only the dependencies are inserted. This way to use the
+protocol is helpful when resolving and verifying a finished but partially signed transaction.
+ResolveTransactionsProtocol.call -
+protocols / ResolveTransactionsProtocol / call call
+fun call ( ) : Unit ProtocolLogic.call This is where you fill out your business logic.
+ResolveTransactionsProtocol -
+protocols / ResolveTransactionsProtocol ResolveTransactionsProtocol
+class ResolveTransactionsProtocol : ProtocolLogic < Unit > This protocol fetches each transaction identified by the given hashes from either disk or network, along with all
+their dependencies, and verifies them together using a single TransactionGroup . If no exception is thrown, then
+all the transactions have been successfully verified and inserted into the local database.
+A couple of constructors are provided that accept a single transaction. When these are used, the dependencies of that
+transaction are resolved and then the transaction itself is verified. Again, if successful, the results are inserted
+into the database as long as a SignedTransaction was provided. If only the WireTransaction form was provided
+then this isnt enough to put into the local database, so only the dependencies are inserted. This way to use the
+protocol is helpful when resolving and verifying a finished but partially signed transaction.
+Exceptions
+
+Constructors
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker ? Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+
+
+
+call
+
+fun call ( ) : Unit This is where you fill out your business logic.
+
+
+
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-client/-init-.html b/docs/build/html/api/protocols/-timestamping-protocol/-client/-init-.html
new file mode 100644
index 0000000000..541e2aa40f
--- /dev/null
+++ b/docs/build/html/api/protocols/-timestamping-protocol/-client/-init-.html
@@ -0,0 +1,14 @@
+
+
+TimestampingProtocol.Client.<init> -
+protocols / TimestampingProtocol / Client / <init> <init>
+Client ( stateMachineManager : StateMachineManager , node : NodeInfo ) TimestampingProtocol.Client.identity -
+protocols / TimestampingProtocol / Client / identity identity
+val identity : Party TimestamperService.identity The name+pubkey that this timestamper will sign with.
+TimestampingProtocol.Client -
+protocols / TimestampingProtocol / Client Client
+class Client : TimestamperService Constructors
+
+Properties
+
+
+
+
+identity
+
+val identity : Party The name+pubkey that this timestamper will sign with.
+
+
+
+
+Functions
+
+
+
diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-client/timestamp.html b/docs/build/html/api/protocols/-timestamping-protocol/-client/timestamp.html
new file mode 100644
index 0000000000..c5d2643ab3
--- /dev/null
+++ b/docs/build/html/api/protocols/-timestamping-protocol/-client/timestamp.html
@@ -0,0 +1,16 @@
+
+
+TimestampingProtocol.Client.timestamp -
+protocols / TimestampingProtocol / Client / timestamp timestamp
+fun timestamp ( wtxBytes : SerializedBytes < WireTransaction > ) : LegallyIdentifiable TimestamperService.timestamp TimestampingProtocol.<init> -
+protocols / TimestampingProtocol / <init> <init>
+TimestampingProtocol ( node : NodeInfo , wtxBytes : SerializedBytes < WireTransaction > , progressTracker : ProgressTracker = TimestampingProtocol.tracker()) The TimestampingProtocol class is the client code that talks to a NodeTimestamperService on some remote node. It is a
+ProtocolLogic , meaning it can either be a sub-protocol of some other protocol, or be driven independently.
+If you are not yourself authoring a protocol and want to timestamp something, the TimestampingProtocol.Client class
+implements the TimestamperService interface, meaning it can be passed to TransactionBuilder.timestamp to timestamp
+the built transaction. Please be aware that this will block, meaning it should not be used on a thread that is handling
+a network message: use it only from spare application threads that dont have to respond to anything.
+TimestampingProtocol.REQUESTING -
+protocols / TimestampingProtocol / REQUESTING REQUESTING
+object REQUESTING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-request/-init-.html b/docs/build/html/api/protocols/-timestamping-protocol/-request/-init-.html
new file mode 100644
index 0000000000..62580daeec
--- /dev/null
+++ b/docs/build/html/api/protocols/-timestamping-protocol/-request/-init-.html
@@ -0,0 +1,14 @@
+
+
+TimestampingProtocol.Request.<init> -
+protocols / TimestampingProtocol / Request / <init> <init>
+Request ( tx : SerializedBytes < WireTransaction > , replyTo : MessageRecipients , sessionID : Long ) TimestampingProtocol.Request -
+protocols / TimestampingProtocol / Request Request
+class Request : AbstractRequestMessage Constructors
+
+Properties
+
+Inherited Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-request/tx.html b/docs/build/html/api/protocols/-timestamping-protocol/-request/tx.html
new file mode 100644
index 0000000000..76d6d2334f
--- /dev/null
+++ b/docs/build/html/api/protocols/-timestamping-protocol/-request/tx.html
@@ -0,0 +1,15 @@
+
+
+TimestampingProtocol.Request.tx -
+protocols / TimestampingProtocol / Request / tx tx
+val tx : SerializedBytes < WireTransaction > TimestampingProtocol.VALIDATING -
+protocols / TimestampingProtocol / VALIDATING VALIDATING
+object VALIDATING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-timestamping-protocol/call.html b/docs/build/html/api/protocols/-timestamping-protocol/call.html
new file mode 100644
index 0000000000..1baa21f781
--- /dev/null
+++ b/docs/build/html/api/protocols/-timestamping-protocol/call.html
@@ -0,0 +1,17 @@
+
+
+TimestampingProtocol.call -
+protocols / TimestampingProtocol / call call
+fun call ( ) : LegallyIdentifiable ProtocolLogic.call This is where you fill out your business logic.
+TimestampingProtocol -
+protocols / TimestampingProtocol TimestampingProtocol
+class TimestampingProtocol : ProtocolLogic < LegallyIdentifiable > The TimestampingProtocol class is the client code that talks to a NodeTimestamperService on some remote node. It is a
+ProtocolLogic , meaning it can either be a sub-protocol of some other protocol, or be driven independently.
+If you are not yourself authoring a protocol and want to timestamp something, the TimestampingProtocol.Client class
+implements the TimestamperService interface, meaning it can be passed to TransactionBuilder.timestamp to timestamp
+the built transaction. Please be aware that this will block, meaning it should not be used on a thread that is handling
+a network message: use it only from spare application threads that dont have to respond to anything.
+Types
+
+Constructors
+
+Properties
+
+
+
+
+progressTracker
+
+val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Companion Object Functions
+
+
+
diff --git a/docs/build/html/api/protocols/-timestamping-protocol/progress-tracker.html b/docs/build/html/api/protocols/-timestamping-protocol/progress-tracker.html
new file mode 100644
index 0000000000..85080140d1
--- /dev/null
+++ b/docs/build/html/api/protocols/-timestamping-protocol/progress-tracker.html
@@ -0,0 +1,24 @@
+
+
+TimestampingProtocol.progressTracker -
+protocols / TimestampingProtocol / progressTracker progressTracker
+val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TimestampingProtocol.tracker -
+protocols / TimestampingProtocol / tracker tracker
+fun tracker ( ) : ProgressTracker TwoPartyDealProtocol.Acceptor.<init> -
+protocols / TwoPartyDealProtocol / Acceptor / <init> <init>
+Acceptor ( otherSide : SingleMessageRecipient , timestampingAuthority : Party , dealToBuy : T , sessionID : Long , progressTracker : ProgressTracker = Secondary.tracker()) One side of the protocol for inserting a pre-agreed deal.
+TwoPartyDealProtocol.Acceptor.assembleSharedTX -
+protocols / TwoPartyDealProtocol / Acceptor / assembleSharedTX assembleSharedTX
+protected open fun assembleSharedTX ( handshake : Handshake < T > ) : <ERROR CLASS> < TransactionBuilder , List < PublicKey > > TwoPartyDealProtocol.Acceptor.dealToBuy -
+protocols / TwoPartyDealProtocol / Acceptor / dealToBuy dealToBuy
+val dealToBuy : T TwoPartyDealProtocol.Acceptor -
+protocols / TwoPartyDealProtocol / Acceptor Acceptor
+class Acceptor < T : DealState > : Secondary < T > One side of the protocol for inserting a pre-agreed deal.
+Constructors
+
+
+
+
+<init>
+
+Acceptor ( otherSide : SingleMessageRecipient , timestampingAuthority : Party , dealToBuy : T , sessionID : Long , progressTracker : ProgressTracker = Secondary.tracker()) One side of the protocol for inserting a pre-agreed deal.
+
+
+
+
+Properties
+
+
+
+
+dealToBuy
+
+val dealToBuy : T
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+Inherited Properties
+
+Functions
+
+Inherited Functions
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-acceptor/progress-tracker.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-acceptor/progress-tracker.html
new file mode 100644
index 0000000000..453760cf1e
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-acceptor/progress-tracker.html
@@ -0,0 +1,24 @@
+
+
+TwoPartyDealProtocol.Acceptor.progressTracker -
+protocols / TwoPartyDealProtocol / Acceptor / progressTracker progressTracker
+open val progressTracker : ProgressTracker Secondary.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TwoPartyDealProtocol.Acceptor.validateHandshake -
+protocols / TwoPartyDealProtocol / Acceptor / validateHandshake validateHandshake
+protected open fun validateHandshake ( handshake : Handshake < T > ) : Handshake < T > TwoPartyDealProtocol.DEAL_TOPIC -
+protocols / TwoPartyDealProtocol / DEAL_TOPIC DEAL_TOPIC
+val DEAL_TOPIC : String TwoPartyDealProtocol.DealMismatchException.<init> -
+protocols / TwoPartyDealProtocol / DealMismatchException / <init> <init>
+DealMismatchException ( expectedDeal : ContractState , actualDeal : ContractState ) TwoPartyDealProtocol.DealMismatchException.actualDeal -
+protocols / TwoPartyDealProtocol / DealMismatchException / actualDeal actualDeal
+val actualDeal : ContractState TwoPartyDealProtocol.DealMismatchException.expectedDeal -
+protocols / TwoPartyDealProtocol / DealMismatchException / expectedDeal expectedDeal
+val expectedDeal : ContractState TwoPartyDealProtocol.DealMismatchException -
+protocols / TwoPartyDealProtocol / DealMismatchException DealMismatchException
+class DealMismatchException : Exception Constructors
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-deal-mismatch-exception/to-string.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-deal-mismatch-exception/to-string.html
new file mode 100644
index 0000000000..f18e02b43f
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-deal-mismatch-exception/to-string.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyDealProtocol.DealMismatchException.toString -
+protocols / TwoPartyDealProtocol / DealMismatchException / toString toString
+fun toString ( ) : String TwoPartyDealProtocol.DealRefMismatchException.<init> -
+protocols / TwoPartyDealProtocol / DealRefMismatchException / <init> <init>
+DealRefMismatchException ( expectedDeal : StateRef , actualDeal : StateRef ) TwoPartyDealProtocol.DealRefMismatchException.actualDeal -
+protocols / TwoPartyDealProtocol / DealRefMismatchException / actualDeal actualDeal
+val actualDeal : StateRef TwoPartyDealProtocol.DealRefMismatchException.expectedDeal -
+protocols / TwoPartyDealProtocol / DealRefMismatchException / expectedDeal expectedDeal
+val expectedDeal : StateRef TwoPartyDealProtocol.DealRefMismatchException -
+protocols / TwoPartyDealProtocol / DealRefMismatchException DealRefMismatchException
+class DealRefMismatchException : Exception Constructors
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-deal-ref-mismatch-exception/to-string.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-deal-ref-mismatch-exception/to-string.html
new file mode 100644
index 0000000000..d25a1694b6
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-deal-ref-mismatch-exception/to-string.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyDealProtocol.DealRefMismatchException.toString -
+protocols / TwoPartyDealProtocol / DealRefMismatchException / toString toString
+fun toString ( ) : String TwoPartyDealProtocol.Fixer.<init> -
+protocols / TwoPartyDealProtocol / Fixer / <init> <init>
+Fixer ( otherSide : SingleMessageRecipient , timestampingAuthority : Party , dealToFix : StateAndRef < T > , sessionID : Long , replacementProgressTracker : ProgressTracker ? = null) One side of the fixing protocol for an interest rate swap, but could easily be generalised further.
+Do not infer too much from the name of the class. This is just to indicate that it is the "side"
+of the protocol that is run by the party with the fixed leg of swap deal, which is the basis for decided
+who does what in the protocol.
+TwoPartyDealProtocol.Fixer.assembleSharedTX -
+protocols / TwoPartyDealProtocol / Fixer / assembleSharedTX assembleSharedTX
+protected open fun assembleSharedTX ( handshake : Handshake < StateRef > ) : <ERROR CLASS> < TransactionBuilder , List < PublicKey > > TwoPartyDealProtocol.Fixer.createTracker -
+protocols / TwoPartyDealProtocol / Fixer / createTracker createTracker
+fun createTracker ( ) : ProgressTracker TwoPartyDealProtocol.Fixer.dealToFix -
+protocols / TwoPartyDealProtocol / Fixer / dealToFix dealToFix
+val dealToFix : StateAndRef < T > TwoPartyDealProtocol.Fixer -
+protocols / TwoPartyDealProtocol / Fixer Fixer
+class Fixer < T : FixableDealState > : Secondary < StateRef > One side of the fixing protocol for an interest rate swap, but could easily be generalised further.
+Do not infer too much from the name of the class. This is just to indicate that it is the "side"
+of the protocol that is run by the party with the fixed leg of swap deal, which is the basis for decided
+who does what in the protocol.
+Constructors
+
+Properties
+
+
+
+
+dealToFix
+
+val dealToFix : StateAndRef < T >
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+replacementProgressTracker
+
+val replacementProgressTracker : ProgressTracker ?
+
+
+
+Inherited Properties
+
+Functions
+
+Inherited Functions
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-fixer/progress-tracker.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-fixer/progress-tracker.html
new file mode 100644
index 0000000000..a0581bab74
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-fixer/progress-tracker.html
@@ -0,0 +1,24 @@
+
+
+TwoPartyDealProtocol.Fixer.progressTracker -
+protocols / TwoPartyDealProtocol / Fixer / progressTracker progressTracker
+open val progressTracker : ProgressTracker Secondary.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TwoPartyDealProtocol.Fixer.replacementProgressTracker -
+protocols / TwoPartyDealProtocol / Fixer / replacementProgressTracker replacementProgressTracker
+val replacementProgressTracker : ProgressTracker ? TwoPartyDealProtocol.Fixer.validateHandshake -
+protocols / TwoPartyDealProtocol / Fixer / validateHandshake validateHandshake
+protected open fun validateHandshake ( handshake : Handshake < StateRef > ) : Handshake < StateRef > TwoPartyDealProtocol.Floater.<init> -
+protocols / TwoPartyDealProtocol / Floater / <init> <init>
+Floater ( otherSide : SingleMessageRecipient , otherSessionID : Long , timestampingAuthority : NodeInfo , dealToFix : StateAndRef < T > , myKeyPair : KeyPair , sessionID : Long , progressTracker : ProgressTracker = Primary.tracker()) One side of the fixing protocol for an interest rate swap, but could easily be generalised furher
+As per the Fixer , do not infer too much from this class name in terms of business roles. This
+is just the "side" of the protocol run by the party with the floating leg as a way of deciding who
+does what in the protocol.
+TwoPartyDealProtocol.Floater -
+protocols / TwoPartyDealProtocol / Floater Floater
+class Floater < T : FixableDealState > : Primary < StateRef > One side of the fixing protocol for an interest rate swap, but could easily be generalised furher
+As per the Fixer , do not infer too much from this class name in terms of business roles. This
+is just the "side" of the protocol run by the party with the floating leg as a way of deciding who
+does what in the protocol.
+Constructors
+
+Properties
+
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+sessionID
+
+val sessionID : Long
+
+
+
+Inherited Properties
+
+Inherited Functions
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-floater/progress-tracker.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-floater/progress-tracker.html
new file mode 100644
index 0000000000..09883bc325
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-floater/progress-tracker.html
@@ -0,0 +1,24 @@
+
+
+TwoPartyDealProtocol.Floater.progressTracker -
+protocols / TwoPartyDealProtocol / Floater / progressTracker progressTracker
+open val progressTracker : ProgressTracker Primary.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TwoPartyDealProtocol.Floater.sessionID -
+protocols / TwoPartyDealProtocol / Floater / sessionID sessionID
+val sessionID : Long TwoPartyDealProtocol.Handshake.<init> -
+protocols / TwoPartyDealProtocol / Handshake / <init> <init>
+Handshake ( payload : T , publicKey : PublicKey , sessionID : Long ) TwoPartyDealProtocol.Handshake -
+protocols / TwoPartyDealProtocol / Handshake Handshake
+data class Handshake < T > Constructors
+
+
+
+
+<init>
+
+Handshake ( payload : T , publicKey : PublicKey , sessionID : Long )
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-handshake/payload.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-handshake/payload.html
new file mode 100644
index 0000000000..2dc4eff62c
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-handshake/payload.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyDealProtocol.Handshake.payload -
+protocols / TwoPartyDealProtocol / Handshake / payload payload
+val payload : T TwoPartyDealProtocol.Handshake.publicKey -
+protocols / TwoPartyDealProtocol / Handshake / publicKey publicKey
+val publicKey : PublicKey TwoPartyDealProtocol.Handshake.sessionID -
+protocols / TwoPartyDealProtocol / Handshake / sessionID sessionID
+val sessionID : Long TwoPartyDealProtocol.Instigator.<init> -
+protocols / TwoPartyDealProtocol / Instigator / <init> <init>
+Instigator ( otherSide : SingleMessageRecipient , timestampingAuthority : NodeInfo , dealBeingOffered : T , myKeyPair : KeyPair , buyerSessionID : Long , progressTracker : ProgressTracker = Primary.tracker()) One side of the protocol for inserting a pre-agreed deal.
+TwoPartyDealProtocol.Instigator -
+protocols / TwoPartyDealProtocol / Instigator Instigator
+class Instigator < T : DealState > : Primary < T > One side of the protocol for inserting a pre-agreed deal.
+Constructors
+
+Properties
+
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+Inherited Properties
+
+Inherited Functions
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-instigator/progress-tracker.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-instigator/progress-tracker.html
new file mode 100644
index 0000000000..6cb73ffa1b
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-instigator/progress-tracker.html
@@ -0,0 +1,24 @@
+
+
+TwoPartyDealProtocol.Instigator.progressTracker -
+protocols / TwoPartyDealProtocol / Instigator / progressTracker progressTracker
+open val progressTracker : ProgressTracker Primary.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TwoPartyDealProtocol.Primary.AWAITING_PROPOSAL -
+protocols / TwoPartyDealProtocol / Primary / AWAITING_PROPOSAL AWAITING_PROPOSAL
+object AWAITING_PROPOSAL : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-c-o-p-y-i-n-g_-t-o_-r-e-g-u-l-a-t-o-r.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-c-o-p-y-i-n-g_-t-o_-r-e-g-u-l-a-t-o-r.html
new file mode 100644
index 0000000000..aa9071aa46
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-c-o-p-y-i-n-g_-t-o_-r-e-g-u-l-a-t-o-r.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyDealProtocol.Primary.COPYING_TO_REGULATOR -
+protocols / TwoPartyDealProtocol / Primary / COPYING_TO_REGULATOR COPYING_TO_REGULATOR
+object COPYING_TO_REGULATOR : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-init-.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-init-.html
new file mode 100644
index 0000000000..34a8d8eae0
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-init-.html
@@ -0,0 +1,19 @@
+
+
+TwoPartyDealProtocol.Primary.<init> -
+protocols / TwoPartyDealProtocol / Primary / <init> <init>
+Primary ( payload : U , otherSide : SingleMessageRecipient , otherSessionID : Long , myKeyPair : KeyPair , timestampingAuthority : NodeInfo , progressTracker : ProgressTracker = Primary.tracker()) Abstracted bilateral deal protocol participant that initiates communication/handshake.
+Theres a good chance we can push at least some of this logic down into core protocol logic
+and helper methods etc.
+TwoPartyDealProtocol.Primary.RECORDING -
+protocols / TwoPartyDealProtocol / Primary / RECORDING RECORDING
+object RECORDING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-s-e-n-d-i-n-g_-s-i-g-s.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-s-e-n-d-i-n-g_-s-i-g-s.html
new file mode 100644
index 0000000000..300844fa34
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-s-e-n-d-i-n-g_-s-i-g-s.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyDealProtocol.Primary.SENDING_SIGS -
+protocols / TwoPartyDealProtocol / Primary / SENDING_SIGS SENDING_SIGS
+object SENDING_SIGS : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-s-i-g-n-i-n-g.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-s-i-g-n-i-n-g.html
new file mode 100644
index 0000000000..2eeb9e5d24
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-s-i-g-n-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyDealProtocol.Primary.SIGNING -
+protocols / TwoPartyDealProtocol / Primary / SIGNING SIGNING
+object SIGNING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-t-i-m-e-s-t-a-m-p-i-n-g.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-t-i-m-e-s-t-a-m-p-i-n-g.html
new file mode 100644
index 0000000000..a9bf195fa8
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-t-i-m-e-s-t-a-m-p-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyDealProtocol.Primary.TIMESTAMPING -
+protocols / TwoPartyDealProtocol / Primary / TIMESTAMPING TIMESTAMPING
+object TIMESTAMPING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-v-e-r-i-f-y-i-n-g.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-v-e-r-i-f-y-i-n-g.html
new file mode 100644
index 0000000000..218159bb64
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/-v-e-r-i-f-y-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyDealProtocol.Primary.VERIFYING -
+protocols / TwoPartyDealProtocol / Primary / VERIFYING VERIFYING
+object VERIFYING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/call.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/call.html
new file mode 100644
index 0000000000..613080cd2d
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/call.html
@@ -0,0 +1,17 @@
+
+
+TwoPartyDealProtocol.Primary.call -
+protocols / TwoPartyDealProtocol / Primary / call call
+open fun call ( ) : SignedTransaction ProtocolLogic.call This is where you fill out your business logic.
+TwoPartyDealProtocol.Primary.getPartialTransaction -
+protocols / TwoPartyDealProtocol / Primary / getPartialTransaction getPartialTransaction
+fun getPartialTransaction ( ) : UntrustworthyData < SignedTransaction > TwoPartyDealProtocol.Primary -
+protocols / TwoPartyDealProtocol / Primary Primary
+abstract class Primary < U > : ProtocolLogic < SignedTransaction > Abstracted bilateral deal protocol participant that initiates communication/handshake.
+Theres a good chance we can push at least some of this logic down into core protocol logic
+and helper methods etc.
+Types
+
+Constructors
+
+
+
+
+<init>
+
+Primary ( payload : U , otherSide : SingleMessageRecipient , otherSessionID : Long , myKeyPair : KeyPair , timestampingAuthority : NodeInfo , progressTracker : ProgressTracker = Primary.tracker()) Abstracted bilateral deal protocol participant that initiates communication/handshake.
+
+
+
+
+Properties
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Companion Object Functions
+
+
+
+
+tracker
+
+fun tracker ( ) : <ERROR CLASS>
+
+
+
+Inheritors
+
+
+
+
+Floater
+
+class Floater < T : FixableDealState > : Primary < StateRef > One side of the fixing protocol for an interest rate swap, but could easily be generalised furher
+
+
+
+
+Instigator
+
+class Instigator < T : DealState > : Primary < T > One side of the protocol for inserting a pre-agreed deal.
+
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/my-key-pair.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/my-key-pair.html
new file mode 100644
index 0000000000..2798c955ee
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-primary/my-key-pair.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyDealProtocol.Primary.myKeyPair -
+protocols / TwoPartyDealProtocol / Primary / myKeyPair myKeyPair
+val myKeyPair : KeyPair TwoPartyDealProtocol.Primary.otherSessionID -
+protocols / TwoPartyDealProtocol / Primary / otherSessionID otherSessionID
+val otherSessionID : Long TwoPartyDealProtocol.Primary.otherSide -
+protocols / TwoPartyDealProtocol / Primary / otherSide otherSide
+val otherSide : SingleMessageRecipient TwoPartyDealProtocol.Primary.payload -
+protocols / TwoPartyDealProtocol / Primary / payload payload
+val payload : U TwoPartyDealProtocol.Primary.progressTracker -
+protocols / TwoPartyDealProtocol / Primary / progressTracker progressTracker
+open val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TwoPartyDealProtocol.Primary.signWithOurKey -
+protocols / TwoPartyDealProtocol / Primary / signWithOurKey signWithOurKey
+open fun signWithOurKey ( partialTX : SignedTransaction ) : WithKey TwoPartyDealProtocol.Primary.timestampingAuthority -
+protocols / TwoPartyDealProtocol / Primary / timestampingAuthority timestampingAuthority
+val timestampingAuthority : NodeInfo TwoPartyDealProtocol.Primary.tracker -
+protocols / TwoPartyDealProtocol / Primary / tracker tracker
+fun tracker ( ) : <ERROR CLASS> TwoPartyDealProtocol.Primary.verifyPartialTransaction -
+protocols / TwoPartyDealProtocol / Primary / verifyPartialTransaction verifyPartialTransaction
+fun verifyPartialTransaction ( untrustedPartialTX : UntrustworthyData < SignedTransaction > ) : SignedTransaction TwoPartyDealProtocol.Secondary.<init> -
+protocols / TwoPartyDealProtocol / Secondary / <init> <init>
+Secondary ( otherSide : SingleMessageRecipient , timestampingAuthority : Party , sessionID : Long , progressTracker : ProgressTracker = Secondary.tracker()) Abstracted bilateral deal protocol participant that is recipient of initial communication.
+Theres a good chance we can push at least some of this logic down into core protocol logic
+and helper methods etc.
+TwoPartyDealProtocol.Secondary.RECEIVING -
+protocols / TwoPartyDealProtocol / Secondary / RECEIVING RECEIVING
+object RECEIVING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-r-e-c-o-r-d-i-n-g.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-r-e-c-o-r-d-i-n-g.html
new file mode 100644
index 0000000000..c3b4960cb9
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-r-e-c-o-r-d-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyDealProtocol.Secondary.RECORDING -
+protocols / TwoPartyDealProtocol / Secondary / RECORDING RECORDING
+object RECORDING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-s-i-g-n-i-n-g.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-s-i-g-n-i-n-g.html
new file mode 100644
index 0000000000..bd5efaa0f8
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-s-i-g-n-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyDealProtocol.Secondary.SIGNING -
+protocols / TwoPartyDealProtocol / Secondary / SIGNING SIGNING
+object SIGNING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-s-w-a-p-p-i-n-g_-s-i-g-n-a-t-u-r-e-s.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-s-w-a-p-p-i-n-g_-s-i-g-n-a-t-u-r-e-s.html
new file mode 100644
index 0000000000..49d86f9edc
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-s-w-a-p-p-i-n-g_-s-i-g-n-a-t-u-r-e-s.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyDealProtocol.Secondary.SWAPPING_SIGNATURES -
+protocols / TwoPartyDealProtocol / Secondary / SWAPPING_SIGNATURES SWAPPING_SIGNATURES
+object SWAPPING_SIGNATURES : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-v-e-r-i-f-y-i-n-g.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-v-e-r-i-f-y-i-n-g.html
new file mode 100644
index 0000000000..95c565c89a
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/-v-e-r-i-f-y-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyDealProtocol.Secondary.VERIFYING -
+protocols / TwoPartyDealProtocol / Secondary / VERIFYING VERIFYING
+object VERIFYING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/assemble-shared-t-x.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/assemble-shared-t-x.html
new file mode 100644
index 0000000000..5a5c3c7525
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/assemble-shared-t-x.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyDealProtocol.Secondary.assembleSharedTX -
+protocols / TwoPartyDealProtocol / Secondary / assembleSharedTX assembleSharedTX
+protected abstract fun assembleSharedTX ( handshake : Handshake < U > ) : <ERROR CLASS> < TransactionBuilder , List < PublicKey > > TwoPartyDealProtocol.Secondary.call -
+protocols / TwoPartyDealProtocol / Secondary / call call
+open fun call ( ) : SignedTransaction ProtocolLogic.call This is where you fill out your business logic.
+TwoPartyDealProtocol.Secondary -
+protocols / TwoPartyDealProtocol / Secondary Secondary
+abstract class Secondary < U > : ProtocolLogic < SignedTransaction > Abstracted bilateral deal protocol participant that is recipient of initial communication.
+Theres a good chance we can push at least some of this logic down into core protocol logic
+and helper methods etc.
+Types
+
+Constructors
+
+
+
+
+<init>
+
+Secondary ( otherSide : SingleMessageRecipient , timestampingAuthority : Party , sessionID : Long , progressTracker : ProgressTracker = Secondary.tracker()) Abstracted bilateral deal protocol participant that is recipient of initial communication.
+
+
+
+
+Properties
+
+
+
+
+otherSide
+
+val otherSide : SingleMessageRecipient
+
+
+
+progressTracker
+
+open val progressTracker : ProgressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+
+
+
+
+sessionID
+
+val sessionID : Long
+
+
+
+timestampingAuthority
+
+val timestampingAuthority : Party
+
+
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Companion Object Functions
+
+Inheritors
+
+
+
+
+Acceptor
+
+class Acceptor < T : DealState > : Secondary < T > One side of the protocol for inserting a pre-agreed deal.
+
+
+
+
+Fixer
+
+class Fixer < T : FixableDealState > : Secondary < StateRef > One side of the fixing protocol for an interest rate swap, but could easily be generalised further.
+
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/other-side.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/other-side.html
new file mode 100644
index 0000000000..bff2ce3915
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-secondary/other-side.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyDealProtocol.Secondary.otherSide -
+protocols / TwoPartyDealProtocol / Secondary / otherSide otherSide
+val otherSide : SingleMessageRecipient TwoPartyDealProtocol.Secondary.progressTracker -
+protocols / TwoPartyDealProtocol / Secondary / progressTracker progressTracker
+open val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TwoPartyDealProtocol.Secondary.sessionID -
+protocols / TwoPartyDealProtocol / Secondary / sessionID sessionID
+val sessionID : Long TwoPartyDealProtocol.Secondary.timestampingAuthority -
+protocols / TwoPartyDealProtocol / Secondary / timestampingAuthority timestampingAuthority
+val timestampingAuthority : Party TwoPartyDealProtocol.Secondary.tracker -
+protocols / TwoPartyDealProtocol / Secondary / tracker tracker
+fun tracker ( ) : ProgressTracker TwoPartyDealProtocol.Secondary.validateHandshake -
+protocols / TwoPartyDealProtocol / Secondary / validateHandshake validateHandshake
+protected abstract fun validateHandshake ( handshake : Handshake < U > ) : Handshake < U > TwoPartyDealProtocol.SignaturesFromPrimary.<init> -
+protocols / TwoPartyDealProtocol / SignaturesFromPrimary / <init> <init>
+SignaturesFromPrimary ( timestampAuthoritySig : WithKey , sellerSig : WithKey ) TwoPartyDealProtocol.SignaturesFromPrimary -
+protocols / TwoPartyDealProtocol / SignaturesFromPrimary SignaturesFromPrimary
+class SignaturesFromPrimary Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-deal-protocol/-signatures-from-primary/seller-sig.html b/docs/build/html/api/protocols/-two-party-deal-protocol/-signatures-from-primary/seller-sig.html
new file mode 100644
index 0000000000..115758210b
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-deal-protocol/-signatures-from-primary/seller-sig.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyDealProtocol.SignaturesFromPrimary.sellerSig -
+protocols / TwoPartyDealProtocol / SignaturesFromPrimary / sellerSig sellerSig
+val sellerSig : WithKey TwoPartyDealProtocol.SignaturesFromPrimary.timestampAuthoritySig -
+protocols / TwoPartyDealProtocol / SignaturesFromPrimary / timestampAuthoritySig timestampAuthoritySig
+val timestampAuthoritySig : WithKey TwoPartyDealProtocol -
+protocols / TwoPartyDealProtocol TwoPartyDealProtocol
+object TwoPartyDealProtocol Classes for manipulating a two party deal or agreement.
+TODO: The subclasses should probably be broken out into individual protocols rather than making this an ever expanding collection of subclasses.
+TODO: Also, the term Deal is used here where we might prefer Agreement.
+Types
+
+Exceptions
+
+Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/-init-.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/-init-.html
new file mode 100644
index 0000000000..d5e857ca58
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/-init-.html
@@ -0,0 +1,14 @@
+
+
+TwoPartyTradeProtocol.AssetMismatchException.<init> -
+protocols / TwoPartyTradeProtocol / AssetMismatchException / <init> <init>
+AssetMismatchException ( expectedTypeName : String , typeName : String ) TwoPartyTradeProtocol.AssetMismatchException.expectedTypeName -
+protocols / TwoPartyTradeProtocol / AssetMismatchException / expectedTypeName expectedTypeName
+val expectedTypeName : String TwoPartyTradeProtocol.AssetMismatchException -
+protocols / TwoPartyTradeProtocol / AssetMismatchException AssetMismatchException
+class AssetMismatchException : Exception Constructors
+
+
+
+
+<init>
+
+AssetMismatchException ( expectedTypeName : String , typeName : String )
+
+
+
+Properties
+
+Functions
+
+
+
+
+toString
+
+fun toString ( ) : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/to-string.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/to-string.html
new file mode 100644
index 0000000000..471a3f9edc
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/to-string.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyTradeProtocol.AssetMismatchException.toString -
+protocols / TwoPartyTradeProtocol / AssetMismatchException / toString toString
+fun toString ( ) : String TwoPartyTradeProtocol.AssetMismatchException.typeName -
+protocols / TwoPartyTradeProtocol / AssetMismatchException / typeName typeName
+val typeName : String TwoPartyTradeProtocol.Buyer.<init> -
+protocols / TwoPartyTradeProtocol / Buyer / <init> <init>
+Buyer ( otherSide : SingleMessageRecipient , timestampingAuthority : Party , acceptablePrice : Amount , typeToBuy : Class < out OwnableState > , sessionID : Long ) TwoPartyTradeProtocol.Buyer.RECEIVING -
+protocols / TwoPartyTradeProtocol / Buyer / RECEIVING RECEIVING
+object RECEIVING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-s-i-g-n-i-n-g.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-s-i-g-n-i-n-g.html
new file mode 100644
index 0000000000..10ee9dcad7
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-s-i-g-n-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyTradeProtocol.Buyer.SIGNING -
+protocols / TwoPartyTradeProtocol / Buyer / SIGNING SIGNING
+object SIGNING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-s-w-a-p-p-i-n-g_-s-i-g-n-a-t-u-r-e-s.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-s-w-a-p-p-i-n-g_-s-i-g-n-a-t-u-r-e-s.html
new file mode 100644
index 0000000000..4f0ec517dc
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-s-w-a-p-p-i-n-g_-s-i-g-n-a-t-u-r-e-s.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyTradeProtocol.Buyer.SWAPPING_SIGNATURES -
+protocols / TwoPartyTradeProtocol / Buyer / SWAPPING_SIGNATURES SWAPPING_SIGNATURES
+object SWAPPING_SIGNATURES : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-v-e-r-i-f-y-i-n-g.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-v-e-r-i-f-y-i-n-g.html
new file mode 100644
index 0000000000..43e2cd9e0b
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-v-e-r-i-f-y-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyTradeProtocol.Buyer.VERIFYING -
+protocols / TwoPartyTradeProtocol / Buyer / VERIFYING VERIFYING
+object VERIFYING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/acceptable-price.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/acceptable-price.html
new file mode 100644
index 0000000000..bee486308d
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/acceptable-price.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyTradeProtocol.Buyer.acceptablePrice -
+protocols / TwoPartyTradeProtocol / Buyer / acceptablePrice acceptablePrice
+val acceptablePrice : Amount TwoPartyTradeProtocol.Buyer.call -
+protocols / TwoPartyTradeProtocol / Buyer / call call
+open fun call ( ) : SignedTransaction ProtocolLogic.call This is where you fill out your business logic.
+TwoPartyTradeProtocol.Buyer -
+protocols / TwoPartyTradeProtocol / Buyer Buyer
+class Buyer : ProtocolLogic < SignedTransaction > Types
+
+Constructors
+
+Properties
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/other-side.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/other-side.html
new file mode 100644
index 0000000000..2cb2d98143
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/other-side.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyTradeProtocol.Buyer.otherSide -
+protocols / TwoPartyTradeProtocol / Buyer / otherSide otherSide
+val otherSide : SingleMessageRecipient TwoPartyTradeProtocol.Buyer.progressTracker -
+protocols / TwoPartyTradeProtocol / Buyer / progressTracker progressTracker
+open val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TwoPartyTradeProtocol.Buyer.sessionID -
+protocols / TwoPartyTradeProtocol / Buyer / sessionID sessionID
+val sessionID : Long TwoPartyTradeProtocol.Buyer.timestampingAuthority -
+protocols / TwoPartyTradeProtocol / Buyer / timestampingAuthority timestampingAuthority
+val timestampingAuthority : Party TwoPartyTradeProtocol.Buyer.typeToBuy -
+protocols / TwoPartyTradeProtocol / Buyer / typeToBuy typeToBuy
+val typeToBuy : Class < out OwnableState > TwoPartyTradeProtocol.SellerTradeInfo.<init> -
+protocols / TwoPartyTradeProtocol / SellerTradeInfo / <init> <init>
+SellerTradeInfo ( assetForSale : StateAndRef < OwnableState > , price : Amount , sellerOwnerKey : PublicKey , sessionID : Long ) TwoPartyTradeProtocol.SellerTradeInfo.assetForSale -
+protocols / TwoPartyTradeProtocol / SellerTradeInfo / assetForSale assetForSale
+val assetForSale : StateAndRef < OwnableState > TwoPartyTradeProtocol.SellerTradeInfo -
+protocols / TwoPartyTradeProtocol / SellerTradeInfo SellerTradeInfo
+class SellerTradeInfo Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/price.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/price.html
new file mode 100644
index 0000000000..6b43819ef0
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/price.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyTradeProtocol.SellerTradeInfo.price -
+protocols / TwoPartyTradeProtocol / SellerTradeInfo / price price
+val price : Amount TwoPartyTradeProtocol.SellerTradeInfo.sellerOwnerKey -
+protocols / TwoPartyTradeProtocol / SellerTradeInfo / sellerOwnerKey sellerOwnerKey
+val sellerOwnerKey : PublicKey TwoPartyTradeProtocol.SellerTradeInfo.sessionID -
+protocols / TwoPartyTradeProtocol / SellerTradeInfo / sessionID sessionID
+val sessionID : Long TwoPartyTradeProtocol.Seller.AWAITING_PROPOSAL -
+protocols / TwoPartyTradeProtocol / Seller / AWAITING_PROPOSAL AWAITING_PROPOSAL
+object AWAITING_PROPOSAL : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-init-.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-init-.html
new file mode 100644
index 0000000000..67986b2940
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-init-.html
@@ -0,0 +1,14 @@
+
+
+TwoPartyTradeProtocol.Seller.<init> -
+protocols / TwoPartyTradeProtocol / Seller / <init> <init>
+Seller ( otherSide : SingleMessageRecipient , timestampingAuthority : NodeInfo , assetToSell : StateAndRef < OwnableState > , price : Amount , myKeyPair : KeyPair , buyerSessionID : Long , progressTracker : ProgressTracker = Seller.tracker()) TwoPartyTradeProtocol.Seller.SENDING_SIGS -
+protocols / TwoPartyTradeProtocol / Seller / SENDING_SIGS SENDING_SIGS
+object SENDING_SIGS : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-s-i-g-n-i-n-g.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-s-i-g-n-i-n-g.html
new file mode 100644
index 0000000000..62094afd9a
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-s-i-g-n-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyTradeProtocol.Seller.SIGNING -
+protocols / TwoPartyTradeProtocol / Seller / SIGNING SIGNING
+object SIGNING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-t-i-m-e-s-t-a-m-p-i-n-g.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-t-i-m-e-s-t-a-m-p-i-n-g.html
new file mode 100644
index 0000000000..ddade60013
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-t-i-m-e-s-t-a-m-p-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyTradeProtocol.Seller.TIMESTAMPING -
+protocols / TwoPartyTradeProtocol / Seller / TIMESTAMPING TIMESTAMPING
+object TIMESTAMPING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-v-e-r-i-f-y-i-n-g.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-v-e-r-i-f-y-i-n-g.html
new file mode 100644
index 0000000000..9722dde40f
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-v-e-r-i-f-y-i-n-g.html
@@ -0,0 +1,31 @@
+
+
+TwoPartyTradeProtocol.Seller.VERIFYING -
+protocols / TwoPartyTradeProtocol / Seller / VERIFYING VERIFYING
+object VERIFYING : Step Inherited Properties
+
+
+
+
+changes
+
+open val changes : <ERROR CLASS> < Change >
+
+
+
+label
+
+open val label : String
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/asset-to-sell.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/asset-to-sell.html
new file mode 100644
index 0000000000..5a321028dd
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/asset-to-sell.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyTradeProtocol.Seller.assetToSell -
+protocols / TwoPartyTradeProtocol / Seller / assetToSell assetToSell
+val assetToSell : StateAndRef < OwnableState > TwoPartyTradeProtocol.Seller.buyerSessionID -
+protocols / TwoPartyTradeProtocol / Seller / buyerSessionID buyerSessionID
+val buyerSessionID : Long TwoPartyTradeProtocol.Seller.call -
+protocols / TwoPartyTradeProtocol / Seller / call call
+open fun call ( ) : SignedTransaction ProtocolLogic.call This is where you fill out your business logic.
+TwoPartyTradeProtocol.Seller -
+protocols / TwoPartyTradeProtocol / Seller Seller
+class Seller : ProtocolLogic < SignedTransaction > Types
+
+Constructors
+
+Properties
+
+Inherited Properties
+
+
+
+
+logger
+
+val logger : <ERROR CLASS> This is where you should log things to.
+
+
+
+
+psm
+
+lateinit var psm : ProtocolStateMachine < * > Reference to the Fiber instance that is the top level controller for the entire flow.
+
+
+
+
+serviceHub
+
+val serviceHub : ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts
+
+
+
+
+Functions
+
+Inherited Functions
+
+
+
+
+receive
+
+fun < T : Any > receive ( topic : String , sessionIDForReceive : Long , clazz : Class < T > ) : UntrustworthyData < T > fun < T : Any > receive ( topic : String , sessionIDForReceive : Long ) : UntrustworthyData < T >
+
+
+
+send
+
+fun send ( topic : String , destination : MessageRecipients , sessionID : Long , obj : Any ) : Unit
+
+
+
+sendAndReceive
+
+fun < T : Any > sendAndReceive ( topic : String , destination : MessageRecipients , sessionIDForSend : Long , sessionIDForReceive : Long , obj : Any ) : UntrustworthyData < T >
+
+
+
+subProtocol
+
+fun < R > subProtocol ( subLogic : ProtocolLogic < R > ) : R Invokes the given subprotocol by simply passing through this ProtocolLogic s reference to the
+ProtocolStateMachine and then calling the call method.
+
+
+
+
+Companion Object Functions
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/my-key-pair.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/my-key-pair.html
new file mode 100644
index 0000000000..6c8395b3ea
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/my-key-pair.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyTradeProtocol.Seller.myKeyPair -
+protocols / TwoPartyTradeProtocol / Seller / myKeyPair myKeyPair
+val myKeyPair : KeyPair TwoPartyTradeProtocol.Seller.otherSide -
+protocols / TwoPartyTradeProtocol / Seller / otherSide otherSide
+val otherSide : SingleMessageRecipient TwoPartyTradeProtocol.Seller.price -
+protocols / TwoPartyTradeProtocol / Seller / price price
+val price : Amount TwoPartyTradeProtocol.Seller.progressTracker -
+protocols / TwoPartyTradeProtocol / Seller / progressTracker progressTracker
+open val progressTracker : ProgressTracker ProtocolLogic.progressTracker Override this to provide a ProgressTracker . If one is provided and stepped, the framework will do something
+helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
+tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
+progress.
+Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
+through.
+TwoPartyTradeProtocol.Seller.signWithOurKey -
+protocols / TwoPartyTradeProtocol / Seller / signWithOurKey signWithOurKey
+open fun signWithOurKey ( partialTX : SignedTransaction ) : WithKey TwoPartyTradeProtocol.Seller.timestampingAuthority -
+protocols / TwoPartyTradeProtocol / Seller / timestampingAuthority timestampingAuthority
+val timestampingAuthority : NodeInfo TwoPartyTradeProtocol.Seller.tracker -
+protocols / TwoPartyTradeProtocol / Seller / tracker tracker
+fun tracker ( ) : ProgressTracker TwoPartyTradeProtocol.SignaturesFromSeller.<init> -
+protocols / TwoPartyTradeProtocol / SignaturesFromSeller / <init> <init>
+SignaturesFromSeller ( timestampAuthoritySig : WithKey , sellerSig : WithKey ) TwoPartyTradeProtocol.SignaturesFromSeller -
+protocols / TwoPartyTradeProtocol / SignaturesFromSeller SignaturesFromSeller
+class SignaturesFromSeller Constructors
+
+Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/seller-sig.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/seller-sig.html
new file mode 100644
index 0000000000..89d46cd81f
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/seller-sig.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyTradeProtocol.SignaturesFromSeller.sellerSig -
+protocols / TwoPartyTradeProtocol / SignaturesFromSeller / sellerSig sellerSig
+val sellerSig : WithKey TwoPartyTradeProtocol.SignaturesFromSeller.timestampAuthoritySig -
+protocols / TwoPartyTradeProtocol / SignaturesFromSeller / timestampAuthoritySig timestampAuthoritySig
+val timestampAuthoritySig : WithKey TwoPartyTradeProtocol.TRADE_TOPIC -
+protocols / TwoPartyTradeProtocol / TRADE_TOPIC TRADE_TOPIC
+val TRADE_TOPIC : String TwoPartyTradeProtocol.UnacceptablePriceException.<init> -
+protocols / TwoPartyTradeProtocol / UnacceptablePriceException / <init> <init>
+UnacceptablePriceException ( givenPrice : Amount ) TwoPartyTradeProtocol.UnacceptablePriceException.givenPrice -
+protocols / TwoPartyTradeProtocol / UnacceptablePriceException / givenPrice givenPrice
+val givenPrice : Amount TwoPartyTradeProtocol.UnacceptablePriceException -
+protocols / TwoPartyTradeProtocol / UnacceptablePriceException UnacceptablePriceException
+class UnacceptablePriceException : Exception Constructors
+
+
+
+
+<init>
+
+UnacceptablePriceException ( givenPrice : Amount )
+
+
+
+Properties
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/index.html b/docs/build/html/api/protocols/-two-party-trade-protocol/index.html
new file mode 100644
index 0000000000..9509700778
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/index.html
@@ -0,0 +1,106 @@
+
+
+TwoPartyTradeProtocol -
+protocols / TwoPartyTradeProtocol TwoPartyTradeProtocol
+object TwoPartyTradeProtocol This asset trading protocol implements a "delivery vs payment" type swap. It has two parties (B and S for buyer
+and seller) and the following steps:
+S sends the StateAndRef pointing to what they want to sell to B, along with info about the price they require
+B to pay. For example this has probably been agreed on an exchange.
+B sends to S a SignedTransaction that includes the state as input, Bs cash as input, the state with the new
+owner key as output, and any change cash as output. It contains a single signature from B but isnt valid because
+it lacks a signature from S authorising movement of the asset.
+S signs it and hands the now finalised SignedWireTransaction back to B.
+Assuming no malicious termination, they both end the protocol being in posession of a valid, signed transaction
+that represents an atomic asset swap.
+Note that its the seller who initiates contact with the buyer, not vice-versa as you might imagine.
+To initiate the protocol, use either the runBuyer or runSeller methods, depending on which side of the trade
+your node is taking. These methods return a future which will complete once the trade is over and a fully signed
+transaction is available: you can either block your thread waiting for the protocol to complete by using
+ListenableFuture.get or more usefully, register a callback that will be invoked when the time comes.
+To see an example of how to use this class, look at the unit tests.
+Types
+
+Exceptions
+
+Properties
+
+Functions
+
+
+
+
+runBuyer
+
+fun runBuyer ( smm : StateMachineManager , timestampingAuthority : NodeInfo , otherSide : SingleMessageRecipient , acceptablePrice : Amount , typeToBuy : Class < out OwnableState > , sessionID : Long ) : <ERROR CLASS> < SignedTransaction >
+
+
+
+runSeller
+
+fun runSeller ( smm : StateMachineManager , timestampingAuthority : NodeInfo , otherSide : SingleMessageRecipient , assetToSell : StateAndRef < OwnableState > , price : Amount , myKeyPair : KeyPair , buyerSessionID : Long ) : <ERROR CLASS> < SignedTransaction >
+
+
+
+
+
diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/run-buyer.html b/docs/build/html/api/protocols/-two-party-trade-protocol/run-buyer.html
new file mode 100644
index 0000000000..214edd450e
--- /dev/null
+++ b/docs/build/html/api/protocols/-two-party-trade-protocol/run-buyer.html
@@ -0,0 +1,15 @@
+
+
+TwoPartyTradeProtocol.runBuyer -
+protocols / TwoPartyTradeProtocol / runBuyer runBuyer
+fun runBuyer ( smm : StateMachineManager , timestampingAuthority : NodeInfo , otherSide : SingleMessageRecipient , acceptablePrice : Amount , typeToBuy : Class < out OwnableState > , sessionID : Long ) : <ERROR CLASS> < SignedTransaction > TwoPartyTradeProtocol.runSeller -
+protocols / TwoPartyTradeProtocol / runSeller runSeller
+fun runSeller ( smm : StateMachineManager , timestampingAuthority : NodeInfo , otherSide : SingleMessageRecipient , assetToSell : StateAndRef < OwnableState > , price : Amount , myKeyPair : KeyPair , buyerSessionID : Long ) : <ERROR CLASS> < SignedTransaction > protocols -
+protocols Package protocols
+Types
+
+
+
+
+AbstractRequestMessage
+
+abstract class AbstractRequestMessage Abstract superclass for request messages sent to services, which includes common
+fields such as replyTo and replyToTopic.
+
+
+
+
+FetchAttachmentsProtocol
+
+class FetchAttachmentsProtocol : FetchDataProtocol < Attachment , ByteArray > Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
+attachments are saved to local storage automatically.
+
+
+
+
+FetchDataProtocol
+
+abstract class FetchDataProtocol < T : NamedByHash , W : Any > : ProtocolLogic < Result < T > > An abstract protocol for fetching typed data from a remote peer.
+
+
+
+
+FetchTransactionsProtocol
+
+class FetchTransactionsProtocol : FetchDataProtocol < SignedTransaction , SignedTransaction > Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.
+
+
+
+
+RatesFixProtocol
+
+open class RatesFixProtocol : ProtocolLogic < Unit > This protocol queries the given oracle for an interest rate fix, and if it is within the given tolerance embeds the
+fix in the transaction and then proceeds to get the oracle to sign it. Although the call method combines the query
+and signing step, you can run the steps individually by constructing this object and then using the public methods
+for each step.
+
+
+
+
+ResolveTransactionsProtocol
+
+class ResolveTransactionsProtocol : ProtocolLogic < Unit > This protocol fetches each transaction identified by the given hashes from either disk or network, along with all
+their dependencies, and verifies them together using a single TransactionGroup . If no exception is thrown, then
+all the transactions have been successfully verified and inserted into the local database.
+
+
+
+
+TimestampingProtocol
+
+class TimestampingProtocol : ProtocolLogic < LegallyIdentifiable > The TimestampingProtocol class is the client code that talks to a NodeTimestamperService on some remote node. It is a
+ProtocolLogic , meaning it can either be a sub-protocol of some other protocol, or be driven independently.
+
+
+
+
+TwoPartyDealProtocol
+
+object TwoPartyDealProtocol Classes for manipulating a two party deal or agreement.
+
+
+
+
+TwoPartyTradeProtocol
+
+object TwoPartyTradeProtocol This asset trading protocol implements a "delivery vs payment" type swap. It has two parties (B and S for buyer
+and seller) and the following steps:
+
+
+
+
+
+
diff --git a/docs/build/html/api/style.css b/docs/build/html/api/style.css
new file mode 100644
index 0000000000..0958623745
--- /dev/null
+++ b/docs/build/html/api/style.css
@@ -0,0 +1,280 @@
+@import url(https://fonts.googleapis.com/css?family=Lato:300italic,700italic,300,700);
+
+body, table {
+ padding:50px;
+ font:14px/1.5 Lato, "Helvetica Neue", Helvetica, Arial, sans-serif;
+ color:#555;
+ font-weight:300;
+}
+
+.keyword {
+ color:black;
+ font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal;
+ font-size:12px;
+}
+
+.symbol {
+ font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal;
+ font-size:12px;
+}
+
+.identifier {
+ color: darkblue;
+ font-size:12px;
+ font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color:#222;
+ margin:0 0 20px;
+}
+
+p, ul, ol, table, pre, dl {
+ margin:0 0 20px;
+}
+
+h1, h2, h3 {
+ line-height:1.1;
+}
+
+h1 {
+ font-size:28px;
+}
+
+h2 {
+ color:#393939;
+}
+
+h3, h4, h5, h6 {
+ color:#494949;
+}
+
+a {
+ color:#258aaf;
+ font-weight:400;
+ text-decoration:none;
+}
+
+a:hover {
+ color: inherit;
+ text-decoration:underline;
+}
+
+a small {
+ font-size:11px;
+ color:#555;
+ margin-top:-0.6em;
+ display:block;
+}
+
+.wrapper {
+ width:860px;
+ margin:0 auto;
+}
+
+blockquote {
+ border-left:1px solid #e5e5e5;
+ margin:0;
+ padding:0 0 0 20px;
+ font-style:italic;
+}
+
+code, pre {
+ font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal;
+ color:#333;
+ font-size:12px;
+}
+
+pre {
+ display: block;
+/*
+ padding:8px 8px;
+ background: #f8f8f8;
+ border-radius:5px;
+ border:1px solid #e5e5e5;
+*/
+ overflow-x: auto;
+}
+
+table {
+ width:100%;
+ border-collapse:collapse;
+}
+
+th, td {
+ text-align:left;
+ vertical-align: top;
+ padding:5px 10px;
+}
+
+dt {
+ color:#444;
+ font-weight:700;
+}
+
+th {
+ color:#444;
+}
+
+img {
+ max-width:100%;
+}
+
+header {
+ width:270px;
+ float:left;
+ position:fixed;
+}
+
+header ul {
+ list-style:none;
+ height:40px;
+
+ padding:0;
+
+ background: #eee;
+ background: -moz-linear-gradient(top, #f8f8f8 0%, #dddddd 100%);
+ background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#f8f8f8), color-stop(100%,#dddddd));
+ background: -webkit-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
+ background: -o-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
+ background: -ms-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
+ background: linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
+
+ border-radius:5px;
+ border:1px solid #d2d2d2;
+ box-shadow:inset #fff 0 1px 0, inset rgba(0,0,0,0.03) 0 -1px 0;
+ width:270px;
+}
+
+header li {
+ width:89px;
+ float:left;
+ border-right:1px solid #d2d2d2;
+ height:40px;
+}
+
+header ul a {
+ line-height:1;
+ font-size:11px;
+ color:#999;
+ display:block;
+ text-align:center;
+ padding-top:6px;
+ height:40px;
+}
+
+strong {
+ color:#222;
+ font-weight:700;
+}
+
+header ul li + li {
+ width:88px;
+ border-left:1px solid #fff;
+}
+
+header ul li + li + li {
+ border-right:none;
+ width:89px;
+}
+
+header ul a strong {
+ font-size:14px;
+ display:block;
+ color:#222;
+}
+
+section {
+ width:500px;
+ float:right;
+ padding-bottom:50px;
+}
+
+small {
+ font-size:11px;
+}
+
+hr {
+ border:0;
+ background:#e5e5e5;
+ height:1px;
+ margin:0 0 20px;
+}
+
+footer {
+ width:270px;
+ float:left;
+ position:fixed;
+ bottom:50px;
+}
+
+@media print, screen and (max-width: 960px) {
+
+ div.wrapper {
+ width:auto;
+ margin:0;
+ }
+
+ header, section, footer {
+ float:none;
+ position:static;
+ width:auto;
+ }
+
+ header {
+ padding-right:320px;
+ }
+
+ section {
+ border:1px solid #e5e5e5;
+ border-width:1px 0;
+ padding:20px 0;
+ margin:0 0 20px;
+ }
+
+ header a small {
+ display:inline;
+ }
+
+ header ul {
+ position:absolute;
+ right:50px;
+ top:52px;
+ }
+}
+
+@media print, screen and (max-width: 720px) {
+ body {
+ word-wrap:break-word;
+ }
+
+ header {
+ padding:0;
+ }
+
+ header ul, header p.view {
+ position:static;
+ }
+
+ pre, code {
+ word-wrap:normal;
+ }
+}
+
+@media print, screen and (max-width: 480px) {
+ body {
+ padding:15px;
+ }
+
+ header ul {
+ display:none;
+ }
+}
+
+@media print {
+ body {
+ padding:0.4in;
+ font-size:12pt;
+ color:#444;
+ }
+}