diff --git a/.gitignore b/.gitignore index 856b76416a..488e9bc902 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,13 @@ TODO +# Eclipse, ctags, Mac metadata, log files +.classpath +.project +.settings +tags +.DS_Store +*.log + # Created by .ignore support plugin (hsz.mobi) .gradle @@ -13,6 +21,7 @@ lib/dokka.jar buyer seller +rate-fix-demo-data ### JetBrains template # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio @@ -67,4 +76,4 @@ atlassian-ide-plugin.xml # Crashlytics plugin (for Android Studio and IntelliJ) com_crashlytics_export_strings.xml crashlytics.properties -crashlytics-build.properties \ No newline at end of file +crashlytics-build.properties diff --git a/build.gradle b/build.gradle index 7940e1ab66..8c943be0cc 100644 --- a/build.gradle +++ b/build.gradle @@ -12,7 +12,7 @@ allprojects { } buildscript { - ext.kotlin_version = '1.0.0' + ext.kotlin_version = '1.0.1' // TODO: Reset to 0.7.5 when released. We need the snapshot for a TLS serialization related fix. ext.quasar_version = '0.7.5-SNAPSHOT' ext.asm_version = '0.5.3' diff --git a/core/src/main/kotlin/core/FinanceTypes.kt b/core/src/main/kotlin/core/FinanceTypes.kt index 18aaf52ee8..b90687d596 100644 --- a/core/src/main/kotlin/core/FinanceTypes.kt +++ b/core/src/main/kotlin/core/FinanceTypes.kt @@ -9,8 +9,10 @@ package core import java.math.BigDecimal +import java.time.DayOfWeek import java.time.Duration import java.time.LocalDate +import java.time.format.DateTimeFormatter import java.util.* /** @@ -56,7 +58,7 @@ data class Amount(val pennies: Long, val currency: Currency) : Comparable.sumOrZero(currency: Currency) = if (iterator().hasNext()) s data class FixOf(val name: String, val forDay: LocalDate, val ofTenor: Duration) /** A [Fix] represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx. */ data class Fix(val of: FixOf, val value: BigDecimal) : CommandData + + + +/** + * Placeholder class for the Tenor datatype - which is a standardised duration of time until maturity */ +data class Tenor(var name:String) + +/** Simple enum for returning accurals adjusted or unadjusted. + * We don't actually do anything with this yet though, so it's ignored for now. + */ +enum class AccrualAdjustment { + Adjusted,Unadjusted +} + +/** This is utilised in the [DateRollConvention] class to determine which way we should initially step when + * finding a business day + */ +enum class DateRollDirection(val value: Long) { FORWARD(1), BACKWARD(-1) } + +/** 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 class DateRollConvention { + // direction() cannot be a val due to the throw in the Actual instance + + /** Don't roll the date, use the one supplied. */ + Actual { + override fun direction(): DateRollDirection = throw UnsupportedOperationException("Direction is not relevant for convention Actual") + override val isModified: Boolean = false + }, + /** Following is the next business date from this one. */ + Following { + override fun direction(): DateRollDirection = DateRollDirection.FORWARD + override val isModified: Boolean = false + }, + /** + * "Modified following" is the next business date, unless it's in the next month, in which case use the preceeding + * business date. + */ + ModifiedFollowing { + override fun direction(): DateRollDirection = DateRollDirection.FORWARD + override val isModified: Boolean = true + }, + /** Previous is the previous business date from this one. */ + Previous { + override fun direction(): DateRollDirection = DateRollDirection.BACKWARD + override val isModified: Boolean = false + }, + /** + * Modified previous is the previous business date, unless it's in the previous month, in which case use the next + * business date. + */ + ModifiedPrevious { + override fun direction(): DateRollDirection = DateRollDirection.BACKWARD + override val isModified: Boolean = true + }; + + abstract fun direction(): DateRollDirection + abstract val isModified: Boolean +} + + +/** This forms the day part of the "Day Count Basis" used for interest calculation. */ +enum class DayCountBasisDay { + // We have to prefix 30 etc with a letter due to enum naming constraints. + D30, D30N, D30P, D30E, D30G, Actual, ActualJ, D30Z, D30F, Bus_SaoPaulo +} + +/** This forms the year part of the "Day Count Basis" used for interest calculation. */ +enum class DayCountBasisYear { + // Ditto above comment for years. + Y360, Y365F, Y365L, Y365Q, Y366, Actual, ActualA, Y365B, Y365, ISMA, ICMA, Y252 +} + +/** Whether the payment should be made before the due date, or after it. */ +enum class PaymentRule { + InAdvance, InArrears, +} + +/** + * Date offset that the fixing is done prior to the accrual start date. + * Currently not used in the calculation. + */ +enum class DateOffset { + // TODO: Definitely shouldn't be an enum, but let's leave it for now at T-2 is a convention. + ZERO, TWODAYS, +} + + +/** + * 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 class Frequency(val annualCompoundCount: Int) { + Annual(1) { + override fun offset(d: LocalDate) = d.plusYears(1) + }, + SemiAnnual(2) { + override fun offset(d: LocalDate) = d.plusMonths(6) + }, + Quarterly(4) { + override fun offset(d: LocalDate) = d.plusMonths(3) + }, + Monthly(12) { + override fun offset(d: LocalDate) = d.plusMonths(1) + }, + Weekly(52) { + override fun offset(d: LocalDate) = d.plusWeeks(1) + }, + BiWeekly(26) { + override fun offset(d: LocalDate) = d.plusWeeks(2) + }; + abstract fun offset(d: LocalDate): LocalDate + // Daily() // Let's not worry about this for now. +} + + +fun LocalDate.isWorkingDay(accordingToCalendar: BusinessCalendar): Boolean = accordingToCalendar.isWorkingDay(this) + +// TODO: Make Calendar data come from an oracle + +/** + * 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. + */ +open class BusinessCalendar private constructor(val holidayDates: List) { + class UnknownCalendar(name: String): Exception("$name not found") + + companion object { + val calendars = listOf("London","NewYork") + + val TEST_CALENDAR_DATA = calendars.map { + it to BusinessCalendar::class.java.getResourceAsStream("${it}HolidayCalendar.txt").bufferedReader().readText() + }.toMap() + + /** Parses a date of the form YYYY-MM-DD, like 2016-01-10 for 10th Jan. */ + fun parseDateFromString(it: String) = LocalDate.parse(it, DateTimeFormatter.ISO_LOCAL_DATE) + + /** Returns a business calendar that combines all the named holiday calendars into one list of holiday dates. */ + fun getInstance(vararg calname: String) = BusinessCalendar( + calname.flatMap { (TEST_CALENDAR_DATA[it] ?: throw UnknownCalendar(it)).split(",") }. + toSet(). + map{ parseDateFromString(it) }. + toList() + ) + + /** Calculates an event schedule that moves events around to ensure they fall on working days. */ + 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 { + val ret = ArrayList() + var ctr = 0 + var currentDate = startDate + + while (true) { + currentDate = period.offset(currentDate) + val scheduleDate = calendar.applyRollConvention(currentDate, dateRollConvention) + + if (periodOffset == null || periodOffset <= ctr) + ret.add(scheduleDate) + ctr += 1 + // TODO: Fix addl period logic + if ((ctr > noOfAdditionalPeriods ) || (currentDate >= endDate ?: currentDate )) + break + } + return ret + } + } + + open fun isWorkingDay(date: LocalDate): Boolean = + when { + date.dayOfWeek == DayOfWeek.SATURDAY -> false + date.dayOfWeek == DayOfWeek.SUNDAY -> false + holidayDates.contains(date) -> false + else -> true + } + + open fun applyRollConvention(testDate: LocalDate, dateRollConvention: DateRollConvention): LocalDate { + if (dateRollConvention == DateRollConvention.Actual) return testDate + + var direction = dateRollConvention.direction().value + var trialDate = testDate + while (!isWorkingDay(trialDate)) { + trialDate = trialDate.plusDays(direction) + } + + // We've moved to the next working day in the right direction, but if we're using the "modified" date roll + // convention and we've crossed into another month, reverse the direction instead to stay within the month. + // Probably better explained here: http://www.investopedia.com/terms/m/modifiedfollowing.asp + + if (dateRollConvention.isModified && testDate.month != trialDate.month) { + direction = -direction + trialDate = testDate + while (!isWorkingDay(trialDate)) { + trialDate = trialDate.plusDays(direction) + } + } + return trialDate + } +} + +fun dayCountCalculator(startDate: LocalDate, endDate: LocalDate, + dcbYear: DayCountBasisYear, + dcbDay: DayCountBasisDay): BigDecimal { + // Right now we are only considering Actual/360 and 30/360 .. We'll do the rest later. + // TODO: The rest. + return when { + dcbDay == DayCountBasisDay.Actual && dcbYear == DayCountBasisYear.Y360 -> BigDecimal((endDate.toEpochDay() - startDate.toEpochDay())) + dcbDay == DayCountBasisDay.D30 && dcbYear == DayCountBasisYear.Y360 -> BigDecimal((endDate.year - startDate.year) * 360.0 + (endDate.monthValue - startDate.monthValue) * 30.0 + endDate.dayOfMonth - startDate.dayOfMonth) + else -> TODO("Can't calculate days using convention $dcbDay / $dcbYear") + } +} diff --git a/core/src/main/kotlin/core/Utils.kt b/core/src/main/kotlin/core/Utils.kt index 59243ac333..d4cff7c637 100644 --- a/core/src/main/kotlin/core/Utils.kt +++ b/core/src/main/kotlin/core/Utils.kt @@ -33,7 +33,10 @@ val Int.hours: Duration get() = Duration.ofHours(this.toLong()) val Int.minutes: Duration get() = Duration.ofMinutes(this.toLong()) val Int.seconds: Duration get() = Duration.ofSeconds(this.toLong()) -val String.d: BigDecimal get() = BigDecimal(this) +val Int.bd: BigDecimal get() = BigDecimal(this) +val Double.bd: BigDecimal get() = BigDecimal(this) +val String.bd: BigDecimal get() = BigDecimal(this) +val Long.bd: BigDecimal get() = BigDecimal(this) /** * Returns a random positive long generated using a secure RNG. This function sacrifies a bit of entropy in order to diff --git a/core/src/main/resources/core/LondonHolidayCalendar.txt b/core/src/main/resources/core/LondonHolidayCalendar.txt new file mode 100644 index 0000000000..a68eaa7b30 --- /dev/null +++ b/core/src/main/resources/core/LondonHolidayCalendar.txt @@ -0,0 +1 @@ +2015-01-01,2015-04-03,2015-04-06,2015-05-04,2015-05-25,2015-08-31,2015-12-25,2015-12-28,2016-01-01,2016-03-25,2016-03-28,2016-05-02,2016-05-30,2016-08-29,2016-12-26,2016-12-27,2017-01-02,2017-04-14,2017-04-17,2017-05-01,2017-05-29,2017-08-28,2017-12-25,2017-12-26,2018-01-01,2018-03-30,2018-04-02,2018-05-07,2018-05-28,2018-08-27,2018-12-25,2018-12-26,2019-01-01,2019-04-19,2019-04-22,2019-05-06,2019-05-27,2019-08-26,2019-12-25,2019-12-26,2020-01-01,2020-04-10,2020-04-13,2020-05-04,2020-05-25,2020-08-31,2020-12-25,2020-12-28,2021-01-01,2021-04-02,2021-04-05,2021-05-03,2021-05-31,2021-08-30,2021-12-27,2021-12-28,2022-01-03,2022-04-15,2022-04-18,2022-05-02,2022-05-30,2022-08-29,2022-12-26,2022-12-27,2023-01-02,2023-04-07,2023-04-10,2023-05-01,2023-05-29,2023-08-28,2023-12-25,2023-12-26,2024-01-01,2024-03-29,2024-04-01,2024-05-06,2024-05-27,2024-08-26,2024-12-25,2024-12-26 \ No newline at end of file diff --git a/core/src/main/resources/core/NewYorkHolidayCalendar.txt b/core/src/main/resources/core/NewYorkHolidayCalendar.txt new file mode 100644 index 0000000000..e2edfa6902 --- /dev/null +++ b/core/src/main/resources/core/NewYorkHolidayCalendar.txt @@ -0,0 +1 @@ +2015-01-01,2015-01-19,2015-02-16,2015-02-18,2015-05-25,2015-07-03,2015-09-07,2015-10-12,2015-11-11,2015-11-26,2015-12-25,2016-01-01,2016-01-18,2016-02-10,2016-02-15,2016-05-30,2016-07-04,2016-09-05,2016-10-10,2016-11-11,2016-11-24,2016-12-26,2017-01-02,2017-01-16,2017-02-20,2017-03-01,2017-05-29,2017-07-04,2017-09-04,2017-10-09,2017-11-10,2017-11-23,2017-12-25,2018-01-01,2018-01-15,2018-02-14,2018-02-19,2018-05-28,2018-07-04,2018-09-03,2018-10-08,2018-11-12,2018-11-22,2018-12-25,2019-01-01,2019-01-21,2019-02-18,2019-03-06,2019-05-27,2019-07-04,2019-09-02,2019-10-14,2019-11-11,2019-11-28,2019-12-25,2020-01-01,2020-01-20,2020-02-17,2020-02-26,2020-05-25,2020-07-03,2020-09-07,2020-10-12,2020-11-11,2020-11-26,2020-12-25,2021-01-01,2021-01-18,2021-02-15,2021-02-17,2021-05-31,2021-07-05,2021-09-06,2021-10-11,2021-11-11,2021-11-25,2021-12-24,2022-01-17,2022-02-21,2022-03-02,2022-05-30,2022-07-04,2022-09-05,2022-10-10,2022-11-11,2022-11-24,2022-12-26,2023-01-02,2023-01-16,2023-02-20,2023-02-22,2023-05-29,2023-07-04,2023-09-04,2023-10-09,2023-11-10,2023-11-23,2023-12-25,2024-01-01,2024-01-15,2024-02-14,2024-02-19,2024-05-27,2024-07-04,2024-09-02,2024-10-14,2024-11-11,2024-11-28,2024-12-25 \ No newline at end of file diff --git a/core/src/test/kotlin/core/FinanceTypesTest.kt b/core/src/test/kotlin/core/FinanceTypesTest.kt new file mode 100644 index 0000000000..b5b07b8f26 --- /dev/null +++ b/core/src/test/kotlin/core/FinanceTypesTest.kt @@ -0,0 +1,97 @@ +/* + * Copyright 2015 Distributed Ledger Group LLC. Distributed as Licensed Company IP to DLG Group Members + * pursuant to the August 7, 2015 Advisory Services Agreement and subject to the Company IP License terms + * set forth therein. + * + * All other rights reserved. + */ + +package core + +import org.junit.Test +import java.time.LocalDate +import java.util.* + +class FinanceTypesTest { + + @Test + fun `make sure Amount has decimal places`() { + var x = Amount(1, Currency.getInstance("USD")) + assert("0.01" in x.toString()) + } + + + @Test + fun `schedule generator 1`() { + var ret = BusinessCalendar.createGenericSchedule(startDate = LocalDate.of(2014, 11, 25), period = Frequency.Monthly, noOfAdditionalPeriods = 3) + // We know that Jan 25th 2015 is on the weekend -> It should not be in this list returned. + assert(! (LocalDate.of(2015,1,25) in ret)) + println(ret) + } + + @Test + fun `schedule generator 2`() { + var ret = BusinessCalendar.createGenericSchedule(startDate = LocalDate.of(2015, 11, 25), period = Frequency.Monthly, noOfAdditionalPeriods = 3, calendar = BusinessCalendar.getInstance("London"), dateRollConvention = DateRollConvention.Following) + // Xmas should not be in the list! + assert(! (LocalDate.of(2015,12,25) in ret)) + println(ret) + } + + + @Test + fun `create a UK calendar` () { + val cal = BusinessCalendar.getInstance("London") + val holdates = cal.holidayDates + println(holdates) + assert(LocalDate.of(2016,12,27) in holdates) // Christmas this year is at the weekend... + } + + @Test + fun `create a US UK calendar`() { + val cal = BusinessCalendar.getInstance("London","NewYork") + assert(LocalDate.of(2016,7,4) in cal.holidayDates) // The most American of holidays + assert(LocalDate.of(2016,8,29) in cal.holidayDates) // August Bank Holiday for brits only + println("Calendar contains both US and UK holidays") + } + + @Test + fun `calendar test of modified following` () { + val ldn = BusinessCalendar.getInstance("London") + val result = ldn.applyRollConvention(LocalDate.of(2016,12,25),DateRollConvention.ModifiedFollowing) + assert(result == LocalDate.of(2016,12,28)) + } + + @Test + fun `calendar test of modified following pt 2` () { + val ldn = BusinessCalendar.getInstance("London") + val result = ldn.applyRollConvention(LocalDate.of(2016,12,31),DateRollConvention.ModifiedFollowing) + assert(result == LocalDate.of(2016,12,30)) + } + + + @Test + fun `calendar test of modified previous` () { + val ldn = BusinessCalendar.getInstance("London") + val result = ldn.applyRollConvention(LocalDate.of(2016,1,1),DateRollConvention.ModifiedPrevious) + assert(result == LocalDate.of(2016,1,4)) + } + + @Test + fun `calendar test of previous` () { + val ldn = BusinessCalendar.getInstance("London") + val result = ldn.applyRollConvention(LocalDate.of(2016,12,25),DateRollConvention.Previous) + assert(result == LocalDate.of(2016,12,23)) + } + + @Test + fun `calendar test of following` () { + val ldn = BusinessCalendar.getInstance("London") + val result = ldn.applyRollConvention(LocalDate.of(2016,12,25),DateRollConvention.Following) + assert(result == LocalDate.of(2016,12,28)) + } + + + + + +} \ No newline at end of file diff --git a/docs/build/html/_sources/index.txt b/docs/build/html/_sources/index.txt index 473fa96175..e5a07d6b9b 100644 --- a/docs/build/html/_sources/index.txt +++ b/docs/build/html/_sources/index.txt @@ -38,12 +38,12 @@ Read on to learn: tutorial protocol-state-machines + oracles .. toctree:: :maxdepth: 2 :caption: Appendix visualiser - roadmap codestyle diff --git a/docs/build/html/_sources/inthebox.txt b/docs/build/html/_sources/inthebox.txt index 30be0a9db8..df7b4ad8c5 100644 --- a/docs/build/html/_sources/inthebox.txt +++ b/docs/build/html/_sources/inthebox.txt @@ -3,15 +3,16 @@ What's included? The current prototype consists of a small amount of code that defines: -* Key data structures +* Key data structures. * Algorithms that work with them, such as serialising, hashing, signing, and verification of the signatures. -* Three smart contracts that implement a notion of a cash claim, a basic commercial paper and a crowdfunding contract. - These are simplified versions of the real things. +* Two smart contracts that implement a notion of a cash claim and basic commercial paper (implemented twice, in two + different programming languages). These are simplified versions of the real things. * Unit tests that check the algorithms do what is expected, and which verify the behaviour of the smart contracts. * API documentation and tutorials (what you're reading) -* A simple standalone node that uses an embedded message queue broker as its P2P messaging layer +* A simple standalone node that uses an embedded message queue broker as its P2P messaging layer. * A trading demo that runs the node in either a listening/buying mode, or a connecting/selling mode, and swaps some - fake commercial paper assets for some self-issued IOU cash. + fake commercial paper assets for some self-issued IOU cash, using a generic *protocol framework*. +* It also includes two oracles: one for precise timestamping and another for interest rate swaps. Some things it does not currently include but should gain later are: @@ -27,8 +28,9 @@ You can browse `the JIRA bug tracker `_. The prototype's goal is rapid exploration of ideas. Therefore in places it takes shortcuts that a production system would not in order to boost productivity: -* It uses a serialization framework instead of a well specified, vendor neutral protocol. +* It uses an object graph serialization framework instead of a well specified, vendor neutral protocol. * It uses secp256r1, an obsolete elliptic curve. +* It uses the default, out of the box Apache Artemis MQ protocol instead of AMQP/1.0 (although switching should be easy) Contracts --------- diff --git a/docs/build/html/_sources/node-administration.txt b/docs/build/html/_sources/node-administration.txt index 7f6d13417e..e9ea9264d8 100644 --- a/docs/build/html/_sources/node-administration.txt +++ b/docs/build/html/_sources/node-administration.txt @@ -4,6 +4,34 @@ Node administration When a node is running, it exposes an embedded web server that lets you monitor it, upload and download attachments, access a REST API and so on. +Monitoring your node +-------------------- + +Like most Java servers, the node exports various useful metrics and management operations via the industry-standard +`JMX infrastructure `_. JMX is a standard _in-process_ API +for registering so-called _MBeans_ ... objects whose properties and methods are intended for server management. It does +not require any particular network protocol for export. So this data can be exported from the node in various ways: +some monitoring systems provide a "Java Agent", which is essentially a JVM plugin that finds all the MBeans and sends +them out to a statistics collector over the network. For those systems, follow the instructions provided by the vendor. + +Sometimes though, you just want raw access to the data and operations itself. So nodes export them over HTTP on the +`/monitoring/json` HTTP endpoint, using a program called `Jolokia `_. Jolokia defines the JSON +and REST formats for accessing MBeans, and provides client libraries to work with that protocol as well. + +Here are a few ways to build dashboards and extract monitoring data for a node: + +* `JMX2Graphite `_ is a tool that can be pointed to /monitoring/json and will + scrape the statistics found there, then insert them into the Graphite monitoring tool on a regular basis. It runs + in Docker and can be started with a single command. +* `JMXTrans `_ is another tool for Graphite, this time, it's got its own agent + (JVM plugin) which reads a custom config file and exports only the named data. It's more configurable than + JMX2Graphite and doesn't require a separate process, as the JVM will write directly to Graphite. +* *Java Mission Control* is a desktop app that can connect to a target JVM that has the right command line flags set + (or always, if running locally). You can explore what data is available, create graphs of those metrics, and invoke + management operations like forcing a garbage collection. +* Cloud metrics services like New Relic also understand JMX, typically, by providing their own agent that uploads the + data to their service on a regular schedule. + Uploading and downloading attachments ------------------------------------- @@ -15,7 +43,7 @@ you can upload it by running this command from a UNIX terminal: .. sourcecode:: shell - curl -F myfile=@path/to/my/file.zip http://localhost:31338/attachments/upload + curl -F myfile=@path/to/my/file.zip http://localhost:31338/upload/attachment The attachment will be identified by the SHA-256 hash of the contents, which you can get by doing: @@ -23,8 +51,8 @@ The attachment will be identified by the SHA-256 hash of the contents, which you shasum -a 256 file.zip -on a Mac or by using ``sha256sum`` on Linux. Alternatively, check the node logs. There is presently no way to manage -attachments from a GUI. +on a Mac or by using ``sha256sum`` on Linux. Alternatively, the hash will be returned to you when you upload the +attachment. An attachment may be downloaded by fetching: @@ -39,3 +67,24 @@ containers, you can also fetch a specific file within the attachment by appendin http://localhost:31338/attachments/DECD098666B9657314870E192CED0C3519C2C9D395507A238338F8D003929DE9/path/within/zip.txt +Uploading interest rate fixes +----------------------------- + +If you would like to operate an interest rate fixing service (oracle), you can upload fix data by uploading data in +a simple text format to the ``/upload/interest-rates`` path on the web server. + +The file looks like this:: + + # Some pretend noddy rate fixes, for the interest rate oracles. + + LIBOR 2016-03-16 30 = 0.678 + LIBOR 2016-03-16 60 = 0.655 + EURIBOR 2016-03-15 30 = 0.123 + EURIBOR 2016-03-15 60 = 0.111 + +The columns are: + +* Name of the fix +* Date of the fix +* The tenor / time to maturity in days +* The interest rate itself \ No newline at end of file diff --git a/docs/build/html/_sources/oracles.txt b/docs/build/html/_sources/oracles.txt new file mode 100644 index 0000000000..5457b49fc6 --- /dev/null +++ b/docs/build/html/_sources/oracles.txt @@ -0,0 +1,186 @@ +.. highlight:: kotlin +.. raw:: html + + + + +Writing oracle services +======================= + +This article covers *oracles*: network services that link the ledger to the outside world by providing facts that +affect the validity of transactions. + +The current prototype includes two oracles: + +1. A timestamping service +2. An interest rate fixing service + +We will examine the similarities and differences in their design, whilst covering how the oracle concept works. + +Introduction +------------ + +Oracles are a key concept in the block chain/decentralised ledger space. They can be essential for many kinds of +application, because we often wish to condition a transaction on some fact being true or false, but the ledger itself +has a design that is essentially functional: all transactions are *pure* and *immutable*. Phrased another way, a +smart contract cannot perform any input/output or depend on any state outside of the transaction itself. There is no +way to download a web page or interact with the user, in a smart contract. It must be this way because everyone must +be able to independently check a transaction and arrive at an identical conclusion for the ledger to maintan its +integrity: if a transaction could evaluate to "valid" on one computer and then "invalid" a few minutes later on a +different computer, the entire shared ledger concept wouldn't work. + +But it is often essential that transactions do depend on data from the outside world, for example, verifying that an +interest rate swap is paying out correctly may require data on interest rates, verifying that a loan has reached +maturity requires knowledge about the current time, knowing which side of a bet receives the payment may require +arbitrary facts about the real world (e.g. the bankruptcy or solvency of a company or country) ... and so on. + +We can solve this problem by introducing services that create digitally signed data structures which assert facts. +These structures can then be used as an input to a transaction and distributed with the transaction data itself. Because +the statements are themselves immutable and signed, it is impossible for an oracle to change its mind later and +invalidate transactions that were previously found to be valid. In contrast, consider what would happen if a contract +could do an HTTP request: it's possible that an answer would change after being downloaded, resulting in loss of +consensus (breaks). + +The two basic approaches +------------------------ + +The architecture provides two ways of implementing oracles with different tradeoffs: + +1. Using commands +2. Using attachments + +When a fact is encoded in a command, it is embedded in the transaction itself. The oracle then acts as a co-signer to +the entire transaction. The oracle's signature is valid only for that transaction, and thus even if a fact (like a +stock price) does not change, every transaction that incorporates that fact must go back to the oracle for signing. + +When a fact is encoded as an attachment, it is a separate object to the transaction which is referred to by hash. +Nodes download attachments from peers at the same time as they download transactions, unless of course the node has +already seen that attachment, in which case it won't fetch it again. Contracts have access to the contents of +attachments and attachments can be digitally signed (in future). + +As you can see, both approaches share a few things: they both allow arbitrary binary data to be provided to transactions +(and thus contracts). The primary difference is whether the data is a freely reusable, standalone object or whether it's +integrated with a transaction. + +Here's a quick way to decide which approach makes more sense for your data source: + +* Is your data *continuously changing*, like a stock price, the current time, etc? If yes, use a command. +* Is your data *commercially valuable*, like a feed which you are not allowed to resell unless it's incorporated into + a business deal? If yes, use a command, so you can charge money for signing the same fact in each unique business + context. +* Is your data *very small*, like a single number? If yes, use a command. +* Is your data *large*, *static* and *commercially worthless*, for instance, a holiday calendar? If yes, use an + attachment. +* Is your data *intended for human consumption*, like a PDF of legal prose, or an Excel spreadsheet? If yes, use an + attachment. + +Asserting continuously varying data that is publicly known +---------------------------------------------------------- + +Let's look at the timestamping oracle that can be found in the ``TimestamperService`` class. This is an example of +an oracle that uses a command because the current time is a constantly changing fact that everybody knows. + +The most obvious way to implement such a service would be: + +1. The creator of the transaction that depends on the time reads their local clock +2. They insert a command with that time into the transaction +3. They then send it to the oracle for signing. + +But this approach has a problem. There will never be exact clock synchronisation between the party creating the +transaction and the oracle. This is not only due to physics, network latencies etc but because between inserting the +command and getting the oracle to sign there may be many other steps, like sending the transaction to other parties +involved in the trade as well, or even requesting human signoff. Thus the time observed by the oracle may be quite +different to the time observed in step 1. This problem can occur any time an oracle attests to a constantly changing +value. + +.. note:: It is assumed that "true time" for a timestamping oracle means GPS/NaviStar time as defined by the atomic + clocks at the US Naval Observatory. This time feed is extremely accurate and available globally for free. + +We fix it by including explicit tolerances in the command, which is defined like this: + +.. sourcecode:: kotlin + + data class TimestampCommand(val after: Instant?, val before: Instant?) : CommandData + init { + if (after == null && before == null) + throw IllegalArgumentException("At least one of before/after must be specified") + if (after != null && before != null) + check(after <= before) + } + } + +This defines a class that has two optional fields: before and after, along with a constructor that imposes a couple +more constraints that cannot be expressed in the type system, namely, that "after" actually is temporally after +"before", and that at least one bound must be present. A timestamp command that doesn't contain anything is illegal. + +Thus we express that the *true value* of the fact "the current time" is actually unknowable. Even when both before and +after times are included, the transaction could have occurred at any point between those two timestamps. In this case +"occurrence" could mean the execution date, the value date, the trade date etc ... the oracle doesn't care what precise +meaning the timestamp has to the contract. + +By creating a range that can be either closed or open at one end, we allow all of the following facts to be modelled: + +* This transaction occurred at some point after the given time (e.g. after a maturity event) +* This transaction occurred at any time before the given time (e.g. before a bankruptcy event) +* This transaction occurred at some point roughly around the given time (e.g. on a specific day) + +This same technique can be adapted to other types of oracle. + +Asserting occasionally varying data that is not publicly known +-------------------------------------------------------------- + +Sometimes you may want a fact that changes, but is not entirely continuous. Additionally the exact value may not be +public, or may only be semi-public (e.g. easily available to some entities on the network but not all). An example of +this would be a LIBOR interest rate fix. + +In this case, the following design can be used. The oracle service provides a query API which returns the current value, +and a signing service that signs a transaction if the data in the command matches the answer being returned by the +query API. Probably the query response contains some sort of timestamp as well, so the service can recognise values +that were true in the past but no longer are (this is arguably a part of the fact being asserted). + +Because the signature covers the transaction, and transactions may end up being forwarded anywhere, the fact itself +is independently checkable. However, this approach can be useful when the data itself costs money, because the act +of issuing the signature in the first place can be charged for (e.g. by requiring the submission of a fresh +``Cash.State`` that has been re-assigned to a key owned by the oracle service). Because the signature covers the +*transaction* and not only the *fact*, this allows for a kind of weak pseudo-DRM over data feeds. Whilst a smart +contract could in theory include a transaction parsing and signature checking library, writing a contract in this way +would be conclusive evidence of intent to disobey the rules of the service (*res ipsa loquitur*). In an environment +where parties are legally identifiable, usage of such a contract would by itself be sufficient to trigger some sort of +punishment. + +Here is an extract from the ``NodeService.Oracle`` class and supporting types: + +.. sourcecode:: kotlin + + /** A [FixOf] identifies the question side of a fix: what day, tenor and type of fix ("LIBOR", "EURIBOR" etc) */ + data class FixOf(val name: String, val forDay: LocalDate, val ofTenor: Duration) + + /** A [Fix] represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx. */ + data class Fix(val of: FixOf, val value: BigDecimal) : CommandData + + class Oracle { + fun query(queries: List): List + + fun sign(wtx: WireTransaction): DigitalSignature.LegallyIdentifiable + } + +Because the fix contains a timestamp (the ``forDay`` field), there can be an arbitrary delay between a fix being +requested via ``query`` and the signature being requested via ``sign``. + +Implementing oracles in the framework +------------------------------------- + +Implementation involves the following steps: + +1. Defining a high level oracle class, that exposes the basic API operations. +2. Defining a lower level service class, that binds network messages to the API. +3. Defining a protocol using the :doc:`protocol-state-machines` framework to make it easy for a client to interact + with the oracle. + +An example of how to do this can be found in the ``NodeInterestRates.Oracle``, ``NodeInterestRates.Service`` and +``RateFixProtocol`` classes. The exact details of how this code works will change in future, so for now consulting +the protocols tutorial and the code for the server-side oracles implementation will have to suffice. There will be more +detail added once the platform APIs have settled down. + +Currently, there's no network map service, so the location and identity keys of an oracle must be distributed out of +band. \ No newline at end of file diff --git a/docs/build/html/_sources/roadmap.txt b/docs/build/html/_sources/roadmap.txt deleted file mode 100644 index 9a26720dcb..0000000000 --- a/docs/build/html/_sources/roadmap.txt +++ /dev/null @@ -1,37 +0,0 @@ -Roadmap -======= - -The canonical place to learn about pending tasks is the `R3 JIRA `_ site. This -page gives some examples of tasks that we wish to explore in future milestones as part of proving (or disproving) -our core thesis - -Data distribution and management: - -* Introduce a pluggable network messaging backend with a mock implementation for testing, and an Apache Kafka based - implementation for bringing up first networking capability. Using Kafka as a message routing/storage layer is not - necessarily the final approach or suitable for P2P WAN messaging, but it should be a good next step for prototyping - and may even be a useful for internal deployments. -* Flesh out the core code enough to have a server that downloads and verifies transactions as they are uploaded to the - cluster. At this stage all transactions are assumed to be public to the network (this will change later). Some basic - logging/JMX/monitoring dashboard should be present to see what the node is doing. -* Experimentation with block-free conflict/double spend resolution using a voting pool of *observers* with lazy consensus. - Logic for rolling back losing transaction subgraphs when a conflict is resolved, reporting these events to observer - APIs and so on. -* Support a pluggable storage layer for recording seen transactions and their validity states. - -Contracts API: - -* Upgrades to the composability of contracts: demonstrate how states can require the presence of other states as a way - to mix in things like multi-signature requirements. -* Demonstrate how states can be separated into two parts, the minimum necessary for conflict resolution (e.g. owner keys) - and a separated part that contains data useful for auditing and building confidence in the validity of a transaction - (e.g. amounts). -* Explorations of improved time handling, and how best to express temporal logic in the contract API/DSL. - -JVM adaptations: - -* Implement a sandbox and packaging system for contract logic. Contracts should be distributable through the network - layer. -* Experiment with modifications to HotSpot to allow for safely killing threads (i.e. fixing the issues that make - Thread.stop() unsafe to use), and to measure and enforce runtime limits to handle runaway code. - diff --git a/docs/build/html/_static/css/custom.css b/docs/build/html/_static/css/custom.css index d4c211d508..2fd187f700 100644 --- a/docs/build/html/_static/css/custom.css +++ b/docs/build/html/_static/css/custom.css @@ -28,4 +28,8 @@ .wy-nav-content { max-width: 1000px; +} + +p { + font-size: 100%; /* Get rid of RTD rule that assumes nobody changes their browser font size */ } \ No newline at end of file diff --git a/docs/build/html/api/alltypes/index.html b/docs/build/html/api/alltypes/index.html deleted file mode 100644 index 6081064eec..0000000000 --- a/docs/build/html/api/alltypes/index.html +++ /dev/null @@ -1,811 +0,0 @@ - - -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.

-
-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.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.services.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.servlets.AttachmentUploadServlet -
-core.AuthenticatedObject -

Wraps an object that was signed by a public key, which may be a well known/recognised institutional key.

-
-core.utilities.BriefLogFormatter -

A Java logging formatter that writes more compact output than the default.

-
-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.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 -
-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.

-
-core.ContractFactory -

A contract factory knows how to lazily load and instantiate contract objects.

-
-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.node.services.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.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.services.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.

-
-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.node.services.FixedIdentityService -

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-core.node.services.IdentityService -

An identity service maintains an bidirectional map of Partys 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.

-
-contracts.InsufficientBalanceException -
-kotlin.Int (extensions in package core) -
-kotlin.collections.Iterable (extensions in package core) -
-kotlin.collections.Iterable (extensions in package contracts) -
-core.node.services.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.messaging.LegallyIdentifiableNode -

Info about a network node that has is operated by some sort of verified identity.

-
-kotlin.collections.List (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.messaging.MockNetworkMap -
-core.NamedByHash -

Implemented by anything that can be named by a secure hash value (e.g. transactions, attachments).

-
-core.messaging.NetworkMap -

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. A reasonable architecture for the -network map service might be one like the Tor directory authorities, where several nodes linked by RAFT or Paxos -elect a leader and that leader distributes signed documents describing the network layout. Those documents can -then be cached by every node and thus a network map can be retrieved given only a single successful peer connection.

-
-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.NodeConfigurationFromProperties -

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-
-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.services.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) -
-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).

-
-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.

-
-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) -
-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.

-
-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.node.services.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.SignedTransaction -

Container for a WireTransaction and attached signatures.

-
-core.messaging.SingleMessageRecipient -

A base class for the case of point-to-point messages

-
-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.

-
-core.node.services.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.

-
-kotlin.String (extensions in package core) -
-java.time.temporal.Temporal (extensions in package core) -
-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

-
-demos.TraderDemoProtocolBuyer -
-demos.TraderDemoProtocolSeller -
-core.TransactionBuilder -

A mutable transaction thats in the process of being built, before all signatures are present.

-
-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.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.

-
-core.UnknownContractException -
-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:

-
-core.node.services.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.services.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.WireTransaction -

Transaction ready for serialisation, without any signatures attached.

-
- - 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 deleted file mode 100644 index c0738b4ec8..0000000000 --- a/docs/build/html/api/contracts/-c-a-s-h_-p-r-o-g-r-a-m_-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CASH_PROGRAM_ID - - - - -contracts / CASH_PROGRAM_ID
-
-

CASH_PROGRAM_ID

- -val CASH_PROGRAM_ID: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/contracts/-c-p_-p-r-o-g-r-a-m_-i-d.html b/docs/build/html/api/contracts/-c-p_-p-r-o-g-r-a-m_-i-d.html deleted file mode 100644 index bca4f8632e..0000000000 --- a/docs/build/html/api/contracts/-c-p_-p-r-o-g-r-a-m_-i-d.html +++ /dev/null @@ -1,34 +0,0 @@ - - -CP_PROGRAM_ID - - - - -contracts / CP_PROGRAM_ID
-
-

CP_PROGRAM_ID

- -val CP_PROGRAM_ID: <ERROR CLASS>
-

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).

    -

-
-
-
- - diff --git a/docs/build/html/api/contracts/-c-r-o-w-d-f-u-n-d_-p-r-o-g-r-a-m_-i-d.html b/docs/build/html/api/contracts/-c-r-o-w-d-f-u-n-d_-p-r-o-g-r-a-m_-i-d.html deleted file mode 100644 index 11de726d45..0000000000 --- a/docs/build/html/api/contracts/-c-r-o-w-d-f-u-n-d_-p-r-o-g-r-a-m_-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CROWDFUND_PROGRAM_ID - - - - -contracts / CROWDFUND_PROGRAM_ID
-
-

CROWDFUND_PROGRAM_ID

- -val CROWDFUND_PROGRAM_ID: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-commands/-exit/-init-.html b/docs/build/html/api/contracts/-cash/-commands/-exit/-init-.html deleted file mode 100644 index c24ad10c11..0000000000 --- a/docs/build/html/api/contracts/-cash/-commands/-exit/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-commands/-exit/amount.html b/docs/build/html/api/contracts/-cash/-commands/-exit/amount.html deleted file mode 100644 index e626f38732..0000000000 --- a/docs/build/html/api/contracts/-cash/-commands/-exit/amount.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Cash.Commands.Exit.amount - - - - -contracts / Cash / Commands / Exit / amount
-
-

amount

- -val amount: Amount
-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-commands/-exit/index.html b/docs/build/html/api/contracts/-cash/-commands/-exit/index.html deleted file mode 100644 index fdec1b649f..0000000000 --- a/docs/build/html/api/contracts/-cash/-commands/-exit/index.html +++ /dev/null @@ -1,40 +0,0 @@ - - -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

- - - - - - - -
-amount -val amount: Amount
- - diff --git a/docs/build/html/api/contracts/-cash/-commands/-issue/-init-.html b/docs/build/html/api/contracts/-cash/-commands/-issue/-init-.html deleted file mode 100644 index bf80ca6432..0000000000 --- a/docs/build/html/api/contracts/-cash/-commands/-issue/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-commands/-issue/index.html b/docs/build/html/api/contracts/-cash/-commands/-issue/index.html deleted file mode 100644 index a7516c9a01..0000000000 --- a/docs/build/html/api/contracts/-cash/-commands/-issue/index.html +++ /dev/null @@ -1,40 +0,0 @@ - - -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 deleted file mode 100644 index 2cadc5d058..0000000000 --- a/docs/build/html/api/contracts/-cash/-commands/-issue/nonce.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Cash.Commands.Issue.nonce - - - - -contracts / Cash / Commands / Issue / nonce
-
-

nonce

- -val nonce: Long
-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-commands/-move/-init-.html b/docs/build/html/api/contracts/-cash/-commands/-move/-init-.html deleted file mode 100644 index ef579196f9..0000000000 --- a/docs/build/html/api/contracts/-cash/-commands/-move/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -Cash.Commands.Move.<init> - - - - -contracts / Cash / Commands / Move / <init>
-
-

<init>

-Move()
-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-commands/-move/index.html b/docs/build/html/api/contracts/-cash/-commands/-move/index.html deleted file mode 100644 index 6e6fe443da..0000000000 --- a/docs/build/html/api/contracts/-cash/-commands/-move/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -Cash.Commands.Move - - - - -contracts / Cash / Commands / Move
-
-

Move

-class Move : TypeOnlyCommandData, Commands
-
-
-

Constructors

- - - - - - - -
-<init> -Move()
-

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 deleted file mode 100644 index bf5bb04ec8..0000000000 --- a/docs/build/html/api/contracts/-cash/-commands/index.html +++ /dev/null @@ -1,68 +0,0 @@ - - -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 deleted file mode 100644 index 0bb6d2b8a5..0000000000 --- a/docs/build/html/api/contracts/-cash/-init-.html +++ /dev/null @@ -1,25 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-state/-init-.html b/docs/build/html/api/contracts/-cash/-state/-init-.html deleted file mode 100644 index 2d4898ad5b..0000000000 --- a/docs/build/html/api/contracts/-cash/-state/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Cash.State.<init> - - - - -contracts / Cash / State / <init>
-
-

<init>

-State(deposit: PartyReference, amount: Amount, owner: PublicKey)
-

A state representing a cash claim against some party

-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-state/amount.html b/docs/build/html/api/contracts/-cash/-state/amount.html deleted file mode 100644 index 7592bde565..0000000000 --- a/docs/build/html/api/contracts/-cash/-state/amount.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Cash.State.amount - - - - -contracts / Cash / State / amount
-
-

amount

- -val amount: Amount
-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-state/deposit.html b/docs/build/html/api/contracts/-cash/-state/deposit.html deleted file mode 100644 index 5719392e4d..0000000000 --- a/docs/build/html/api/contracts/-cash/-state/deposit.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Cash.State.deposit - - - - -contracts / Cash / State / deposit
-
-

deposit

- -val deposit: PartyReference
-

Where the underlying currency backing this ledger entry can be found (propagated)

-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-state/index.html b/docs/build/html/api/contracts/-cash/-state/index.html deleted file mode 100644 index e17d21e39d..0000000000 --- a/docs/build/html/api/contracts/-cash/-state/index.html +++ /dev/null @@ -1,79 +0,0 @@ - - -Cash.State - - - - -contracts / Cash / State
-
-

State

-data class State : OwnableState
-

A state representing a cash claim against some party

-
-
-

Constructors

- - - - - - - -
-<init> -State(deposit: PartyReference, amount: Amount, owner: PublicKey)

A state representing a cash claim against some party

-
-

Properties

- - - - - - - - - - - - - - - - - - - -
-amount -val amount: Amount
-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

-
-programRef -val programRef: <ERROR CLASS>

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
-

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 deleted file mode 100644 index 40a8915dab..0000000000 --- a/docs/build/html/api/contracts/-cash/-state/owner.html +++ /dev/null @@ -1,17 +0,0 @@ - - -Cash.State.owner - - - - -contracts / Cash / State / owner
-
-

owner

- -val owner: PublicKey
-Overrides OwnableState.owner
-

There must be a MoveCommand signed by this key to claim the amount

-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-state/program-ref.html b/docs/build/html/api/contracts/-cash/-state/program-ref.html deleted file mode 100644 index 9704e1e24d..0000000000 --- a/docs/build/html/api/contracts/-cash/-state/program-ref.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Cash.State.programRef - - - - -contracts / Cash / State / programRef
-
-

programRef

- -val programRef: <ERROR CLASS>
-Overrides ContractState.programRef
-

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-state/to-string.html b/docs/build/html/api/contracts/-cash/-state/to-string.html deleted file mode 100644 index 6d83eea3dd..0000000000 --- a/docs/build/html/api/contracts/-cash/-state/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Cash.State.toString - - - - -contracts / Cash / State / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/contracts/-cash/-state/with-new-owner.html b/docs/build/html/api/contracts/-cash/-state/with-new-owner.html deleted file mode 100644 index faac36ac28..0000000000 --- a/docs/build/html/api/contracts/-cash/-state/with-new-owner.html +++ /dev/null @@ -1,17 +0,0 @@ - - -Cash.State.withNewOwner - - - - -contracts / Cash / State / withNewOwner
-
-

withNewOwner

- -fun withNewOwner(newOwner: PublicKey): <ERROR CLASS>
-Overrides OwnableState.withNewOwner
-

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/generate-issue.html b/docs/build/html/api/contracts/-cash/generate-issue.html deleted file mode 100644 index 38be4af60c..0000000000 --- a/docs/build/html/api/contracts/-cash/generate-issue.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/contracts/-cash/generate-spend.html b/docs/build/html/api/contracts/-cash/generate-spend.html deleted file mode 100644 index a19da53fbe..0000000000 --- a/docs/build/html/api/contracts/-cash/generate-spend.html +++ /dev/null @@ -1,22 +0,0 @@ - - -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.
-
-
- - diff --git a/docs/build/html/api/contracts/-cash/index.html b/docs/build/html/api/contracts/-cash/index.html deleted file mode 100644 index 4663b87d2d..0000000000 --- a/docs/build/html/api/contracts/-cash/index.html +++ /dev/null @@ -1,97 +0,0 @@ - - -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

- - - - - - - - - - - -
-Commands -interface Commands : CommandData
-State -data class State : OwnableState

A state representing a cash claim against some party

-
-

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

- - - - - - - -
-legalContractReference -val legalContractReference: SecureHash

TODO:

-
-

Functions

- - - - - - - - - - - - - - - -
-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.

-
-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.

-
-verify -fun verify(tx: TransactionForVerification): Unit

This is the function EVERYONE runs

-
- - diff --git a/docs/build/html/api/contracts/-cash/legal-contract-reference.html b/docs/build/html/api/contracts/-cash/legal-contract-reference.html deleted file mode 100644 index d151bdc904..0000000000 --- a/docs/build/html/api/contracts/-cash/legal-contract-reference.html +++ /dev/null @@ -1,25 +0,0 @@ - - -Cash.legalContractReference - - - - -contracts / Cash / legalContractReference
-
-

legalContractReference

- -val legalContractReference: SecureHash
-Overrides Contract.legalContractReference
-

TODO:

-

  1. hash should be of the contents, not the URI

    -

  2. 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

-
-
-
-
- - diff --git a/docs/build/html/api/contracts/-cash/verify.html b/docs/build/html/api/contracts/-cash/verify.html deleted file mode 100644 index ef5a95f9a6..0000000000 --- a/docs/build/html/api/contracts/-cash/verify.html +++ /dev/null @@ -1,17 +0,0 @@ - - -Cash.verify - - - - -contracts / Cash / verify
-
-

verify

- -fun verify(tx: TransactionForVerification): Unit
-Overrides Contract.verify
-

This is the function EVERYONE runs

-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-commands/-issue/-init-.html b/docs/build/html/api/contracts/-commercial-paper/-commands/-issue/-init-.html deleted file mode 100644 index 0599089f81..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-commands/-issue/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CommercialPaper.Commands.Issue.<init> - - - - -contracts / CommercialPaper / Commands / Issue / <init>
-
-

<init>

-Issue()
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-commands/-issue/index.html b/docs/build/html/api/contracts/-commercial-paper/-commands/-issue/index.html deleted file mode 100644 index aaf6dffe72..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-commands/-issue/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -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 deleted file mode 100644 index 11abf580a4..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-commands/-move/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CommercialPaper.Commands.Move.<init> - - - - -contracts / CommercialPaper / Commands / Move / <init>
-
-

<init>

-Move()
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-commands/-move/index.html b/docs/build/html/api/contracts/-commercial-paper/-commands/-move/index.html deleted file mode 100644 index fb104aae5a..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-commands/-move/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -CommercialPaper.Commands.Move - - - - -contracts / CommercialPaper / Commands / Move
-
-

Move

-class Move : TypeOnlyCommandData, Commands
-
-
-

Constructors

- - - - - - - -
-<init> -Move()
-

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 deleted file mode 100644 index eb9e49ac8f..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-commands/-redeem/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CommercialPaper.Commands.Redeem.<init> - - - - -contracts / CommercialPaper / Commands / Redeem / <init>
-
-

<init>

-Redeem()
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-commands/-redeem/index.html b/docs/build/html/api/contracts/-commercial-paper/-commands/-redeem/index.html deleted file mode 100644 index 12ccadeb7b..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-commands/-redeem/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -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 deleted file mode 100644 index 4eb4ec7d39..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-commands/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - -CommercialPaper.Commands - - - - -contracts / CommercialPaper / Commands
-
-

Commands

-interface Commands : CommandData
-
-
-

Types

- - - - - - - - - - - - - - - -
-Issue -class Issue : TypeOnlyCommandData, Commands
-Move -class Move : TypeOnlyCommandData, Commands
-Redeem -class Redeem : TypeOnlyCommandData, Commands
-

Inheritors

- - - - - - - - - - - - - - - -
-Issue -class Issue : TypeOnlyCommandData, Commands
-Move -class Move : TypeOnlyCommandData, Commands
-Redeem -class Redeem : TypeOnlyCommandData, Commands
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-init-.html b/docs/build/html/api/contracts/-commercial-paper/-init-.html deleted file mode 100644 index 768c3ca4dc..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CommercialPaper.<init> - - - - -contracts / CommercialPaper / <init>
-
-

<init>

-CommercialPaper()
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/-init-.html b/docs/build/html/api/contracts/-commercial-paper/-state/-init-.html deleted file mode 100644 index 6f950169b3..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CommercialPaper.State.<init> - - - - -contracts / CommercialPaper / State / <init>
-
-

<init>

-State(issuance: PartyReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/face-value.html b/docs/build/html/api/contracts/-commercial-paper/-state/face-value.html deleted file mode 100644 index 6a1328d7c7..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/face-value.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CommercialPaper.State.faceValue - - - - -contracts / CommercialPaper / State / faceValue
-
-

faceValue

- -val faceValue: Amount
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/index.html b/docs/build/html/api/contracts/-commercial-paper/-state/index.html deleted file mode 100644 index ac94a46907..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/index.html +++ /dev/null @@ -1,112 +0,0 @@ - - -CommercialPaper.State - - - - -contracts / CommercialPaper / State
-
-

State

-data class State : OwnableState
-
-
-

Constructors

- - - - - - - -
-<init> -State(issuance: PartyReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - -
-faceValue -val faceValue: Amount
-issuance -val issuance: PartyReference
-maturityDate -val maturityDate: Instant
-owner -val owner: PublicKey

There must be a MoveCommand signed by this key to claim the amount

-
-programRef -val programRef: <ERROR CLASS>

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-toString -fun toString(): String
-withFaceValue -fun withFaceValue(newFaceValue: Amount): <ERROR CLASS>
-withIssuance -fun withIssuance(newIssuance: PartyReference): <ERROR CLASS>
-withMaturityDate -fun withMaturityDate(newMaturityDate: Instant): <ERROR CLASS>
-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

-
-withOwner -fun withOwner(newOwner: PublicKey): <ERROR CLASS>
-withoutOwner -fun withoutOwner(): State
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html b/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html deleted file mode 100644 index f1f65450bd..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CommercialPaper.State.issuance - - - - -contracts / CommercialPaper / State / issuance
-
-

issuance

- -val issuance: PartyReference
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/maturity-date.html b/docs/build/html/api/contracts/-commercial-paper/-state/maturity-date.html deleted file mode 100644 index 58c6c8612a..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/maturity-date.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CommercialPaper.State.maturityDate - - - - -contracts / CommercialPaper / State / maturityDate
-
-

maturityDate

- -val maturityDate: Instant
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/owner.html b/docs/build/html/api/contracts/-commercial-paper/-state/owner.html deleted file mode 100644 index 15bfe04c5b..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/owner.html +++ /dev/null @@ -1,17 +0,0 @@ - - -CommercialPaper.State.owner - - - - -contracts / CommercialPaper / State / owner
-
-

owner

- -val owner: PublicKey
-Overrides OwnableState.owner
-

There must be a MoveCommand signed by this key to claim the amount

-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/program-ref.html b/docs/build/html/api/contracts/-commercial-paper/-state/program-ref.html deleted file mode 100644 index bac20a6a17..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/program-ref.html +++ /dev/null @@ -1,19 +0,0 @@ - - -CommercialPaper.State.programRef - - - - -contracts / CommercialPaper / State / programRef
-
-

programRef

- -val programRef: <ERROR CLASS>
-Overrides ContractState.programRef
-

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/to-string.html b/docs/build/html/api/contracts/-commercial-paper/-state/to-string.html deleted file mode 100644 index 7c24cfbc3e..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CommercialPaper.State.toString - - - - -contracts / CommercialPaper / State / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/with-face-value.html b/docs/build/html/api/contracts/-commercial-paper/-state/with-face-value.html deleted file mode 100644 index bfe75c8f1b..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/with-face-value.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CommercialPaper.State.withFaceValue - - - - -contracts / CommercialPaper / State / withFaceValue
-
-

withFaceValue

- -fun withFaceValue(newFaceValue: Amount): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/with-issuance.html b/docs/build/html/api/contracts/-commercial-paper/-state/with-issuance.html deleted file mode 100644 index a995e0d8a0..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/with-issuance.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CommercialPaper.State.withIssuance - - - - -contracts / CommercialPaper / State / withIssuance
-
-

withIssuance

- -fun withIssuance(newIssuance: PartyReference): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/with-maturity-date.html b/docs/build/html/api/contracts/-commercial-paper/-state/with-maturity-date.html deleted file mode 100644 index ec0eba6df3..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/with-maturity-date.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CommercialPaper.State.withMaturityDate - - - - -contracts / CommercialPaper / State / withMaturityDate
-
-

withMaturityDate

- -fun withMaturityDate(newMaturityDate: Instant): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/with-new-owner.html b/docs/build/html/api/contracts/-commercial-paper/-state/with-new-owner.html deleted file mode 100644 index 50cf564db4..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/with-new-owner.html +++ /dev/null @@ -1,17 +0,0 @@ - - -CommercialPaper.State.withNewOwner - - - - -contracts / CommercialPaper / State / withNewOwner
-
-

withNewOwner

- -fun withNewOwner(newOwner: PublicKey): <ERROR CLASS>
-Overrides OwnableState.withNewOwner
-

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/-commercial-paper/-state/with-owner.html b/docs/build/html/api/contracts/-commercial-paper/-state/with-owner.html deleted file mode 100644 index 736f3e004b..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/with-owner.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CommercialPaper.State.withOwner - - - - -contracts / CommercialPaper / State / withOwner
-
-

withOwner

- -fun withOwner(newOwner: PublicKey): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/without-owner.html b/docs/build/html/api/contracts/-commercial-paper/-state/without-owner.html deleted file mode 100644 index c37b1ec9fc..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/-state/without-owner.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CommercialPaper.State.withoutOwner - - - - -contracts / CommercialPaper / State / withoutOwner
-
-

withoutOwner

- -fun withoutOwner(): State
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/generate-issue.html b/docs/build/html/api/contracts/-commercial-paper/generate-issue.html deleted file mode 100644 index b5bf985fb6..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/generate-issue.html +++ /dev/null @@ -1,18 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/generate-move.html b/docs/build/html/api/contracts/-commercial-paper/generate-move.html deleted file mode 100644 index 834b461948..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/generate-move.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/generate-redeem.html b/docs/build/html/api/contracts/-commercial-paper/generate-redeem.html deleted file mode 100644 index d424ecf98f..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/generate-redeem.html +++ /dev/null @@ -1,21 +0,0 @@ - - -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 redeemer
-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/index.html b/docs/build/html/api/contracts/-commercial-paper/index.html deleted file mode 100644 index 401304d924..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/index.html +++ /dev/null @@ -1,95 +0,0 @@ - - -CommercialPaper - - - - -contracts / CommercialPaper
-
-

CommercialPaper

-class CommercialPaper : Contract
-
-
-

Types

- - - - - - - - - - - -
-Commands -interface Commands : CommandData
-State -data class State : OwnableState
-

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 deleted file mode 100644 index 6f648f3ba7..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/legal-contract-reference.html +++ /dev/null @@ -1,18 +0,0 @@ - - -CommercialPaper.legalContractReference - - - - -contracts / CommercialPaper / legalContractReference
-
-

legalContractReference

- -val legalContractReference: SecureHash
-Overrides Contract.legalContractReference
-

Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of -the contracts contents).

-
-
- - diff --git a/docs/build/html/api/contracts/-commercial-paper/verify.html b/docs/build/html/api/contracts/-commercial-paper/verify.html deleted file mode 100644 index 193eabd96b..0000000000 --- a/docs/build/html/api/contracts/-commercial-paper/verify.html +++ /dev/null @@ -1,20 +0,0 @@ - - -CommercialPaper.verify - - - - -contracts / CommercialPaper / verify
-
-

verify

- -fun verify(tx: TransactionForVerification): Unit
-Overrides 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.

-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-campaign/-init-.html b/docs/build/html/api/contracts/-crowd-fund/-campaign/-init-.html deleted file mode 100644 index 1d92af3e0e..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-campaign/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CrowdFund.Campaign.<init> - - - - -contracts / CrowdFund / Campaign / <init>
-
-

<init>

-Campaign(owner: PublicKey, name: String, target: Amount, closingTime: Instant)
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-campaign/closing-time.html b/docs/build/html/api/contracts/-crowd-fund/-campaign/closing-time.html deleted file mode 100644 index 8c0719923d..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-campaign/closing-time.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.Campaign.closingTime - - - - -contracts / CrowdFund / Campaign / closingTime
-
-

closingTime

- -val closingTime: Instant
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-campaign/index.html b/docs/build/html/api/contracts/-crowd-fund/-campaign/index.html deleted file mode 100644 index eb908975bb..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-campaign/index.html +++ /dev/null @@ -1,65 +0,0 @@ - - -CrowdFund.Campaign - - - - -contracts / CrowdFund / Campaign
-
-

Campaign

-data class Campaign
-
-
-

Constructors

- - - - - - - -
-<init> -Campaign(owner: PublicKey, name: String, target: Amount, closingTime: Instant)
-

Properties

- - - - - - - - - - - - - - - - - - - -
-closingTime -val closingTime: Instant
-name -val name: String
-owner -val owner: PublicKey
-target -val target: Amount
-

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 deleted file mode 100644 index ed02e5e6d5..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-campaign/name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.Campaign.name - - - - -contracts / CrowdFund / Campaign / name
-
-

name

- -val name: String
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-campaign/owner.html b/docs/build/html/api/contracts/-crowd-fund/-campaign/owner.html deleted file mode 100644 index a345873eed..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-campaign/owner.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.Campaign.owner - - - - -contracts / CrowdFund / Campaign / owner
-
-

owner

- -val owner: PublicKey
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-campaign/target.html b/docs/build/html/api/contracts/-crowd-fund/-campaign/target.html deleted file mode 100644 index 9b1a849b44..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-campaign/target.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.Campaign.target - - - - -contracts / CrowdFund / Campaign / target
-
-

target

- -val target: Amount
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-campaign/to-string.html b/docs/build/html/api/contracts/-crowd-fund/-campaign/to-string.html deleted file mode 100644 index a978a705d2..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-campaign/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.Campaign.toString - - - - -contracts / CrowdFund / Campaign / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-commands/-close/-init-.html b/docs/build/html/api/contracts/-crowd-fund/-commands/-close/-init-.html deleted file mode 100644 index f11ce6dfbf..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-commands/-close/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CrowdFund.Commands.Close.<init> - - - - -contracts / CrowdFund / Commands / Close / <init>
-
-

<init>

-Close()
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-commands/-close/index.html b/docs/build/html/api/contracts/-crowd-fund/-commands/-close/index.html deleted file mode 100644 index ea6b929738..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-commands/-close/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -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 deleted file mode 100644 index 47942123f9..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-commands/-pledge/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CrowdFund.Commands.Pledge.<init> - - - - -contracts / CrowdFund / Commands / Pledge / <init>
-
-

<init>

-Pledge()
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-commands/-pledge/index.html b/docs/build/html/api/contracts/-crowd-fund/-commands/-pledge/index.html deleted file mode 100644 index 06a44297b2..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-commands/-pledge/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -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 deleted file mode 100644 index 22df21abc1..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-commands/-register/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CrowdFund.Commands.Register.<init> - - - - -contracts / CrowdFund / Commands / Register / <init>
-
-

<init>

-Register()
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-commands/-register/index.html b/docs/build/html/api/contracts/-crowd-fund/-commands/-register/index.html deleted file mode 100644 index 0167d7b0c1..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-commands/-register/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -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 deleted file mode 100644 index f9e012fe78..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-commands/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - -CrowdFund.Commands - - - - -contracts / CrowdFund / Commands
-
-

Commands

-interface Commands : CommandData
-
-
-

Types

- - - - - - - - - - - - - - - -
-Close -class Close : TypeOnlyCommandData, Commands
-Pledge -class Pledge : TypeOnlyCommandData, Commands
-Register -class Register : TypeOnlyCommandData, Commands
-

Inheritors

- - - - - - - - - - - - - - - -
-Close -class Close : TypeOnlyCommandData, Commands
-Pledge -class Pledge : TypeOnlyCommandData, Commands
-Register -class Register : TypeOnlyCommandData, Commands
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-init-.html b/docs/build/html/api/contracts/-crowd-fund/-init-.html deleted file mode 100644 index b87f6b9808..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-init-.html +++ /dev/null @@ -1,32 +0,0 @@ - - -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).

-Discussion

This 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
-James Carlyle
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-pledge/-init-.html b/docs/build/html/api/contracts/-crowd-fund/-pledge/-init-.html deleted file mode 100644 index 3131431ae9..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-pledge/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CrowdFund.Pledge.<init> - - - - -contracts / CrowdFund / Pledge / <init>
-
-

<init>

-Pledge(owner: PublicKey, amount: Amount)
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-pledge/amount.html b/docs/build/html/api/contracts/-crowd-fund/-pledge/amount.html deleted file mode 100644 index 85d9aec14f..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-pledge/amount.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.Pledge.amount - - - - -contracts / CrowdFund / Pledge / amount
-
-

amount

- -val amount: Amount
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-pledge/index.html b/docs/build/html/api/contracts/-crowd-fund/-pledge/index.html deleted file mode 100644 index dd43ef2737..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-pledge/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -CrowdFund.Pledge - - - - -contracts / CrowdFund / Pledge
-
-

Pledge

-data class Pledge
-
-
-

Constructors

- - - - - - - -
-<init> -Pledge(owner: PublicKey, amount: Amount)
-

Properties

- - - - - - - - - - - -
-amount -val amount: Amount
-owner -val owner: PublicKey
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-pledge/owner.html b/docs/build/html/api/contracts/-crowd-fund/-pledge/owner.html deleted file mode 100644 index 037e585180..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-pledge/owner.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.Pledge.owner - - - - -contracts / CrowdFund / Pledge / owner
-
-

owner

- -val owner: PublicKey
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-state/-init-.html b/docs/build/html/api/contracts/-crowd-fund/-state/-init-.html deleted file mode 100644 index 8bfa9ace1a..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-state/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -CrowdFund.State.<init> - - - - -contracts / CrowdFund / State / <init>
-
-

<init>

-State(campaign: Campaign, closed: Boolean = false, pledges: List<Pledge> = ArrayList())
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-state/campaign.html b/docs/build/html/api/contracts/-crowd-fund/-state/campaign.html deleted file mode 100644 index 47d993e7ec..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-state/campaign.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.State.campaign - - - - -contracts / CrowdFund / State / campaign
-
-

campaign

- -val campaign: Campaign
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-state/closed.html b/docs/build/html/api/contracts/-crowd-fund/-state/closed.html deleted file mode 100644 index a7ff3f4eb4..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-state/closed.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.State.closed - - - - -contracts / CrowdFund / State / closed
-
-

closed

- -val closed: Boolean
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-state/index.html b/docs/build/html/api/contracts/-crowd-fund/-state/index.html deleted file mode 100644 index c79502ce11..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-state/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - -CrowdFund.State - - - - -contracts / CrowdFund / State
-
-

State

-data class State : ContractState
-
-
-

Constructors

- - - - - - - -
-<init> -State(campaign: Campaign, closed: Boolean = false, pledges: List<Pledge> = ArrayList())
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - -
-campaign -val campaign: Campaign
-closed -val closed: Boolean
-pledgedAmount -val pledgedAmount: Amount
-pledges -val pledges: List<Pledge>
-programRef -val programRef: <ERROR CLASS>

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
- - 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 deleted file mode 100644 index 6e9610ac7f..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-state/pledged-amount.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.State.pledgedAmount - - - - -contracts / CrowdFund / State / pledgedAmount
-
-

pledgedAmount

- -val pledgedAmount: Amount
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-state/pledges.html b/docs/build/html/api/contracts/-crowd-fund/-state/pledges.html deleted file mode 100644 index cc06a495fb..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-state/pledges.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.State.pledges - - - - -contracts / CrowdFund / State / pledges
-
-

pledges

- -val pledges: List<Pledge>
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/-state/program-ref.html b/docs/build/html/api/contracts/-crowd-fund/-state/program-ref.html deleted file mode 100644 index 6b6d7ee981..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/-state/program-ref.html +++ /dev/null @@ -1,19 +0,0 @@ - - -CrowdFund.State.programRef - - - - -contracts / CrowdFund / State / programRef
-
-

programRef

- -val programRef: <ERROR CLASS>
-Overrides ContractState.programRef
-

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/generate-close.html b/docs/build/html/api/contracts/-crowd-fund/generate-close.html deleted file mode 100644 index a79c87e28c..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/generate-close.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CrowdFund.generateClose - - - - -contracts / CrowdFund / generateClose
-
-

generateClose

- -fun generateClose(tx: TransactionBuilder, campaign: StateAndRef<State>, wallet: List<StateAndRef<State>>): Unit
-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/generate-pledge.html b/docs/build/html/api/contracts/-crowd-fund/generate-pledge.html deleted file mode 100644 index acbdad624b..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/generate-pledge.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/generate-register.html b/docs/build/html/api/contracts/-crowd-fund/generate-register.html deleted file mode 100644 index 1462ebbd49..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/generate-register.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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

-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/index.html b/docs/build/html/api/contracts/-crowd-fund/index.html deleted file mode 100644 index a5a5ae0583..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/index.html +++ /dev/null @@ -1,124 +0,0 @@ - - -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).

-Discussion

This 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
-James Carlyle
-
-
-

Types

- - - - - - - - - - - - - - - - - - - -
-Campaign -data class Campaign
-Commands -interface Commands : CommandData
-Pledge -data class Pledge
-State -data class State : ContractState
-

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 deleted file mode 100644 index 37f5459898..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/legal-contract-reference.html +++ /dev/null @@ -1,18 +0,0 @@ - - -CrowdFund.legalContractReference - - - - -contracts / CrowdFund / legalContractReference
-
-

legalContractReference

- -val legalContractReference: SecureHash
-Overrides Contract.legalContractReference
-

Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of -the contracts contents).

-
-
- - diff --git a/docs/build/html/api/contracts/-crowd-fund/verify.html b/docs/build/html/api/contracts/-crowd-fund/verify.html deleted file mode 100644 index 696d65a209..0000000000 --- a/docs/build/html/api/contracts/-crowd-fund/verify.html +++ /dev/null @@ -1,20 +0,0 @@ - - -CrowdFund.verify - - - - -contracts / CrowdFund / verify
-
-

verify

- -fun verify(tx: TransactionForVerification): Unit
-Overrides 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.

-
-
- - diff --git a/docs/build/html/api/contracts/-d-u-m-m-y_-p-r-o-g-r-a-m_-i-d.html b/docs/build/html/api/contracts/-d-u-m-m-y_-p-r-o-g-r-a-m_-i-d.html deleted file mode 100644 index 61df61407b..0000000000 --- a/docs/build/html/api/contracts/-d-u-m-m-y_-p-r-o-g-r-a-m_-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DUMMY_PROGRAM_ID - - - - -contracts / DUMMY_PROGRAM_ID
-
-

DUMMY_PROGRAM_ID

- -val DUMMY_PROGRAM_ID: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/contracts/-dummy-contract/-init-.html b/docs/build/html/api/contracts/-dummy-contract/-init-.html deleted file mode 100644 index 77db1224c8..0000000000 --- a/docs/build/html/api/contracts/-dummy-contract/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -DummyContract.<init> - - - - -contracts / DummyContract / <init>
-
-

<init>

-DummyContract()
-
-
- - diff --git a/docs/build/html/api/contracts/-dummy-contract/-state/-init-.html b/docs/build/html/api/contracts/-dummy-contract/-state/-init-.html deleted file mode 100644 index 60f999a273..0000000000 --- a/docs/build/html/api/contracts/-dummy-contract/-state/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -DummyContract.State.<init> - - - - -contracts / DummyContract / State / <init>
-
-

<init>

-State()
-
-
- - diff --git a/docs/build/html/api/contracts/-dummy-contract/-state/index.html b/docs/build/html/api/contracts/-dummy-contract/-state/index.html deleted file mode 100644 index afeaea2b70..0000000000 --- a/docs/build/html/api/contracts/-dummy-contract/-state/index.html +++ /dev/null @@ -1,39 +0,0 @@ - - -DummyContract.State - - - - -contracts / DummyContract / State
-
-

State

-class State : ContractState
-
-
-

Constructors

- - - - - - - -
-<init> -State()
-

Properties

- - - - - - - -
-programRef -val programRef: SecureHash

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
- - diff --git a/docs/build/html/api/contracts/-dummy-contract/-state/program-ref.html b/docs/build/html/api/contracts/-dummy-contract/-state/program-ref.html deleted file mode 100644 index 0397c97bb1..0000000000 --- a/docs/build/html/api/contracts/-dummy-contract/-state/program-ref.html +++ /dev/null @@ -1,19 +0,0 @@ - - -DummyContract.State.programRef - - - - -contracts / DummyContract / State / programRef
-
-

programRef

- -val programRef: SecureHash
-Overrides ContractState.programRef
-

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
-
- - diff --git a/docs/build/html/api/contracts/-dummy-contract/index.html b/docs/build/html/api/contracts/-dummy-contract/index.html deleted file mode 100644 index e8a0d9e284..0000000000 --- a/docs/build/html/api/contracts/-dummy-contract/index.html +++ /dev/null @@ -1,64 +0,0 @@ - - -DummyContract - - - - -contracts / DummyContract
-
-

DummyContract

-class DummyContract : Contract
-
-
-

Types

- - - - - - - -
-State -class State : ContractState
-

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

- - - - - - - -
-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 deleted file mode 100644 index 63bbb94b13..0000000000 --- a/docs/build/html/api/contracts/-dummy-contract/legal-contract-reference.html +++ /dev/null @@ -1,18 +0,0 @@ - - -DummyContract.legalContractReference - - - - -contracts / DummyContract / legalContractReference
-
-

legalContractReference

- -val legalContractReference: SecureHash
-Overrides Contract.legalContractReference
-

Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of -the contracts contents).

-
-
- - diff --git a/docs/build/html/api/contracts/-dummy-contract/verify.html b/docs/build/html/api/contracts/-dummy-contract/verify.html deleted file mode 100644 index f71aa682b9..0000000000 --- a/docs/build/html/api/contracts/-dummy-contract/verify.html +++ /dev/null @@ -1,20 +0,0 @@ - - -DummyContract.verify - - - - -contracts / DummyContract / verify
-
-

verify

- -fun verify(tx: TransactionForVerification): Unit
-Overrides 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.

-
-
- - diff --git a/docs/build/html/api/contracts/-insufficient-balance-exception/-init-.html b/docs/build/html/api/contracts/-insufficient-balance-exception/-init-.html deleted file mode 100644 index 8968497aa1..0000000000 --- a/docs/build/html/api/contracts/-insufficient-balance-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -InsufficientBalanceException.<init> - - - - -contracts / InsufficientBalanceException / <init>
-
-

<init>

-InsufficientBalanceException(amountMissing: Amount)
-
-
- - diff --git a/docs/build/html/api/contracts/-insufficient-balance-exception/amount-missing.html b/docs/build/html/api/contracts/-insufficient-balance-exception/amount-missing.html deleted file mode 100644 index 1859ebcc8b..0000000000 --- a/docs/build/html/api/contracts/-insufficient-balance-exception/amount-missing.html +++ /dev/null @@ -1,15 +0,0 @@ - - -InsufficientBalanceException.amountMissing - - - - -contracts / InsufficientBalanceException / amountMissing
-
-

amountMissing

- -val amountMissing: Amount
-
-
- - diff --git a/docs/build/html/api/contracts/-insufficient-balance-exception/index.html b/docs/build/html/api/contracts/-insufficient-balance-exception/index.html deleted file mode 100644 index eb79ffe2f4..0000000000 --- a/docs/build/html/api/contracts/-insufficient-balance-exception/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -InsufficientBalanceException - - - - -contracts / InsufficientBalanceException
-
-

InsufficientBalanceException

-class InsufficientBalanceException : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -InsufficientBalanceException(amountMissing: Amount)
-

Properties

- - - - - - - -
-amountMissing -val amountMissing: Amount
- - diff --git a/docs/build/html/api/contracts/index.html b/docs/build/html/api/contracts/index.html deleted file mode 100644 index 5e8a3869d6..0000000000 --- a/docs/build/html/api/contracts/index.html +++ /dev/null @@ -1,103 +0,0 @@ - - -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).

-
-DummyContract -class DummyContract : Contract
-

Exceptions

- - - - - - - -
-InsufficientBalanceException -class InsufficientBalanceException : Exception
-

Extensions for External Classes

- - - - - - - -
-kotlin.collections.Iterable -
-

Properties

- - - - - - - - - - - - - - - - - - - -
-CASH_PROGRAM_ID -val CASH_PROGRAM_ID: <ERROR CLASS>
-CP_PROGRAM_ID -val CP_PROGRAM_ID: <ERROR CLASS>

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: <ERROR CLASS>
-DUMMY_PROGRAM_ID -val DUMMY_PROGRAM_ID: <ERROR CLASS>
- - diff --git a/docs/build/html/api/contracts/kotlin.collections.-iterable/index.html b/docs/build/html/api/contracts/kotlin.collections.-iterable/index.html deleted file mode 100644 index 233dc75fb1..0000000000 --- a/docs/build/html/api/contracts/kotlin.collections.-iterable/index.html +++ /dev/null @@ -1,43 +0,0 @@ - - -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 deleted file mode 100644 index d8e3203abf..0000000000 --- a/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-by.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-or-null.html b/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-or-null.html deleted file mode 100644 index 04c256bd56..0000000000 --- a/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-or-null.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-or-zero.html b/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-or-zero.html deleted file mode 100644 index eb2e4faab0..0000000000 --- a/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash-or-zero.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash.html b/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash.html deleted file mode 100644 index 7e9b5ab3c7..0000000000 --- a/docs/build/html/api/contracts/kotlin.collections.-iterable/sum-cash.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.crypto/-digital-signature/-init-.html b/docs/build/html/api/core.crypto/-digital-signature/-init-.html deleted file mode 100644 index 5b4674412c..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/-init-.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/-init-.html b/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/-init-.html deleted file mode 100644 index 5ee39f099f..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -DigitalSignature.LegallyIdentifiable.<init> - - - - -core.crypto / DigitalSignature / LegallyIdentifiable / <init>
-
-

<init>

-LegallyIdentifiable(signer: Party, bits: ByteArray, covering: Int)
-
-
- - diff --git a/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/index.html b/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/index.html deleted file mode 100644 index 471c4af279..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/index.html +++ /dev/null @@ -1,59 +0,0 @@ - - -DigitalSignature.LegallyIdentifiable - - - - -core.crypto / DigitalSignature / LegallyIdentifiable
-
-

LegallyIdentifiable

-class LegallyIdentifiable : WithKey
-
-
-

Constructors

- - - - - - - -
-<init> -LegallyIdentifiable(signer: Party, bits: ByteArray, covering: Int)
-

Properties

- - - - - - - -
-signer -val signer: Party
-

Inherited Properties

- - - - - - - -
-by -val by: PublicKey
-

Inherited Functions

- - - - - - - -
-verifyWithECDSA -fun verifyWithECDSA(content: ByteArray): Unit
-fun verifyWithECDSA(content: OpaqueBytes): Unit
- - 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 deleted file mode 100644 index 3e970b86a0..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/-legally-identifiable/signer.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DigitalSignature.LegallyIdentifiable.signer - - - - -core.crypto / DigitalSignature / LegallyIdentifiable / signer
-
-

signer

- -val signer: Party
-
-
- - diff --git a/docs/build/html/api/core.crypto/-digital-signature/-with-key/-init-.html b/docs/build/html/api/core.crypto/-digital-signature/-with-key/-init-.html deleted file mode 100644 index cfc0499347..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/-with-key/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.crypto/-digital-signature/-with-key/by.html b/docs/build/html/api/core.crypto/-digital-signature/-with-key/by.html deleted file mode 100644 index cd076a628f..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/-with-key/by.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DigitalSignature.WithKey.by - - - - -core.crypto / DigitalSignature / WithKey / by
-
-

by

- -val by: PublicKey
-
-
- - diff --git a/docs/build/html/api/core.crypto/-digital-signature/-with-key/index.html b/docs/build/html/api/core.crypto/-digital-signature/-with-key/index.html deleted file mode 100644 index c1e83127f6..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/-with-key/index.html +++ /dev/null @@ -1,72 +0,0 @@ - - -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

- - - - - - - -
-by -val by: PublicKey
-

Inherited Properties

- - - - - - - -
-covering -val covering: Int
-

Functions

- - - - - - - -
-verifyWithECDSA -fun verifyWithECDSA(content: ByteArray): Unit
-fun verifyWithECDSA(content: OpaqueBytes): Unit
-

Inheritors

- - - - - - - -
-LegallyIdentifiable -class LegallyIdentifiable : WithKey
- - 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 deleted file mode 100644 index f13a695a97..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/-with-key/verify-with-e-c-d-s-a.html +++ /dev/null @@ -1,17 +0,0 @@ - - -DigitalSignature.WithKey.verifyWithECDSA - - - - -core.crypto / DigitalSignature / WithKey / verifyWithECDSA
-
-

verifyWithECDSA

- -fun verifyWithECDSA(content: ByteArray): Unit
- -fun verifyWithECDSA(content: OpaqueBytes): Unit
-
-
- - diff --git a/docs/build/html/api/core.crypto/-digital-signature/covering.html b/docs/build/html/api/core.crypto/-digital-signature/covering.html deleted file mode 100644 index b7c52dae10..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/covering.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DigitalSignature.covering - - - - -core.crypto / DigitalSignature / covering
-
-

covering

- -val covering: Int
-
-
- - diff --git a/docs/build/html/api/core.crypto/-digital-signature/index.html b/docs/build/html/api/core.crypto/-digital-signature/index.html deleted file mode 100644 index d787ddb0a5..0000000000 --- a/docs/build/html/api/core.crypto/-digital-signature/index.html +++ /dev/null @@ -1,129 +0,0 @@ - - -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

- - - - - - - - - - - -
-deserialize -fun <T : Any> OpaqueBytes.deserialize(kryo: <ERROR CLASS> = THREAD_LOCAL_KRYO.get(), includeClassName: Boolean = false): T
-sha256 -fun OpaqueBytes.sha256(): SHA256
-

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 deleted file mode 100644 index 7e497cf3f6..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -DummyPublicKey.<init> - - - - -core.crypto / DummyPublicKey / <init>
-
-

<init>

-DummyPublicKey(s: String)
-
-
- - diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/compare-to.html b/docs/build/html/api/core.crypto/-dummy-public-key/compare-to.html deleted file mode 100644 index 1ba1955412..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/compare-to.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyPublicKey.compareTo - - - - -core.crypto / DummyPublicKey / compareTo
-
-

compareTo

- -fun compareTo(other: PublicKey): Int
-
-
- - diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/equals.html b/docs/build/html/api/core.crypto/-dummy-public-key/equals.html deleted file mode 100644 index 69c03e11b9..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/equals.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyPublicKey.equals - - - - -core.crypto / DummyPublicKey / equals
-
-

equals

- -fun equals(other: Any?): Boolean
-
-
- - diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/get-algorithm.html b/docs/build/html/api/core.crypto/-dummy-public-key/get-algorithm.html deleted file mode 100644 index 3aeb5a406c..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/get-algorithm.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyPublicKey.getAlgorithm - - - - -core.crypto / DummyPublicKey / getAlgorithm
-
-

getAlgorithm

- -fun getAlgorithm(): String
-
-
- - diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/get-encoded.html b/docs/build/html/api/core.crypto/-dummy-public-key/get-encoded.html deleted file mode 100644 index a661becee0..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/get-encoded.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyPublicKey.getEncoded - - - - -core.crypto / DummyPublicKey / getEncoded
-
-

getEncoded

- -fun getEncoded(): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/get-format.html b/docs/build/html/api/core.crypto/-dummy-public-key/get-format.html deleted file mode 100644 index d02cd73265..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/get-format.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyPublicKey.getFormat - - - - -core.crypto / DummyPublicKey / getFormat
-
-

getFormat

- -fun getFormat(): String
-
-
- - diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/hash-code.html b/docs/build/html/api/core.crypto/-dummy-public-key/hash-code.html deleted file mode 100644 index 0f6ba11a88..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/hash-code.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyPublicKey.hashCode - - - - -core.crypto / DummyPublicKey / hashCode
-
-

hashCode

- -fun hashCode(): Int
-
-
- - diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/index.html b/docs/build/html/api/core.crypto/-dummy-public-key/index.html deleted file mode 100644 index a6a17ad207..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/index.html +++ /dev/null @@ -1,102 +0,0 @@ - - -DummyPublicKey - - - - -core.crypto / DummyPublicKey
-
-

DummyPublicKey

-class DummyPublicKey : PublicKey, Comparable<PublicKey>
-
-
-

Constructors

- - - - - - - -
-<init> -DummyPublicKey(s: String)
-

Properties

- - - - - - - -
-s -val s: String
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-compareTo -fun compareTo(other: PublicKey): Int
-equals -fun equals(other: Any?): Boolean
-getAlgorithm -fun getAlgorithm(): String
-getEncoded -fun getEncoded(): <ERROR CLASS>
-getFormat -fun getFormat(): String
-hashCode -fun hashCode(): Int
-toString -fun toString(): String
-

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 deleted file mode 100644 index bb917254a3..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/s.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyPublicKey.s - - - - -core.crypto / DummyPublicKey / s
-
-

s

- -val s: String
-
-
- - diff --git a/docs/build/html/api/core.crypto/-dummy-public-key/to-string.html b/docs/build/html/api/core.crypto/-dummy-public-key/to-string.html deleted file mode 100644 index d95d615f76..0000000000 --- a/docs/build/html/api/core.crypto/-dummy-public-key/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyPublicKey.toString - - - - -core.crypto / DummyPublicKey / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core.crypto/-null-public-key/compare-to.html b/docs/build/html/api/core.crypto/-null-public-key/compare-to.html deleted file mode 100644 index f238b63d0e..0000000000 --- a/docs/build/html/api/core.crypto/-null-public-key/compare-to.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NullPublicKey.compareTo - - - - -core.crypto / NullPublicKey / compareTo
-
-

compareTo

- -fun compareTo(other: PublicKey): Int
-
-
- - diff --git a/docs/build/html/api/core.crypto/-null-public-key/get-algorithm.html b/docs/build/html/api/core.crypto/-null-public-key/get-algorithm.html deleted file mode 100644 index 8d4d756c3c..0000000000 --- a/docs/build/html/api/core.crypto/-null-public-key/get-algorithm.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NullPublicKey.getAlgorithm - - - - -core.crypto / NullPublicKey / getAlgorithm
-
-

getAlgorithm

- -fun getAlgorithm(): String
-
-
- - diff --git a/docs/build/html/api/core.crypto/-null-public-key/get-encoded.html b/docs/build/html/api/core.crypto/-null-public-key/get-encoded.html deleted file mode 100644 index f8df818ca1..0000000000 --- a/docs/build/html/api/core.crypto/-null-public-key/get-encoded.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NullPublicKey.getEncoded - - - - -core.crypto / NullPublicKey / getEncoded
-
-

getEncoded

- -fun getEncoded(): ByteArray
-
-
- - diff --git a/docs/build/html/api/core.crypto/-null-public-key/get-format.html b/docs/build/html/api/core.crypto/-null-public-key/get-format.html deleted file mode 100644 index e81a606539..0000000000 --- a/docs/build/html/api/core.crypto/-null-public-key/get-format.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NullPublicKey.getFormat - - - - -core.crypto / NullPublicKey / getFormat
-
-

getFormat

- -fun getFormat(): String
-
-
- - diff --git a/docs/build/html/api/core.crypto/-null-public-key/index.html b/docs/build/html/api/core.crypto/-null-public-key/index.html deleted file mode 100644 index ac5862d186..0000000000 --- a/docs/build/html/api/core.crypto/-null-public-key/index.html +++ /dev/null @@ -1,68 +0,0 @@ - - -NullPublicKey - - - - -core.crypto / NullPublicKey
-
-

NullPublicKey

-object NullPublicKey : PublicKey, Comparable<PublicKey>
-
-
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - -
-compareTo -fun compareTo(other: PublicKey): Int
-getAlgorithm -fun getAlgorithm(): String
-getEncoded -fun getEncoded(): ByteArray
-getFormat -fun getFormat(): String
-toString -fun toString(): String
-

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 deleted file mode 100644 index db2e9a537c..0000000000 --- a/docs/build/html/api/core.crypto/-null-public-key/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NullPublicKey.toString - - - - -core.crypto / NullPublicKey / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/-init-.html b/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/-init-.html deleted file mode 100644 index e5637e9e88..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -SecureHash.SHA256.<init> - - - - -core.crypto / SecureHash / SHA256 / <init>
-
-

<init>

-SHA256(bits: ByteArray)
-
-
- - diff --git a/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/index.html b/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/index.html deleted file mode 100644 index d908544aac..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/index.html +++ /dev/null @@ -1,53 +0,0 @@ - - -SecureHash.SHA256 - - - - -core.crypto / SecureHash / SHA256
-
-

SHA256

-class SHA256 : SecureHash
-
-
-

Constructors

- - - - - - - -
-<init> -SHA256(bits: ByteArray)
-

Properties

- - - - - - - -
-signatureAlgorithmName -val signatureAlgorithmName: String
-

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 deleted file mode 100644 index f385a8d85b..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/-s-h-a256/signature-algorithm-name.html +++ /dev/null @@ -1,16 +0,0 @@ - - -SecureHash.SHA256.signatureAlgorithmName - - - - -core.crypto / SecureHash / SHA256 / signatureAlgorithmName
-
-

signatureAlgorithmName

- -val signatureAlgorithmName: String
-Overrides SecureHash.signatureAlgorithmName
-
-
- - diff --git a/docs/build/html/api/core.crypto/-secure-hash/index.html b/docs/build/html/api/core.crypto/-secure-hash/index.html deleted file mode 100644 index a283dc1645..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/index.html +++ /dev/null @@ -1,145 +0,0 @@ - - -SecureHash - - - - -core.crypto / SecureHash
-
-

SecureHash

-sealed class SecureHash : OpaqueBytes
-
-
-

Types

- - - - - - - -
-SHA256 -class SHA256 : SecureHash
-

Properties

- - - - - - - -
-signatureAlgorithmName -abstract val signatureAlgorithmName: String
-

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

- - - - - - - - - - - -
-deserialize -fun <T : Any> OpaqueBytes.deserialize(kryo: <ERROR CLASS> = THREAD_LOCAL_KRYO.get(), includeClassName: Boolean = false): T
-sha256 -fun OpaqueBytes.sha256(): SHA256
-

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 deleted file mode 100644 index 80b4fd3c1f..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/parse.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SecureHash.parse - - - - -core.crypto / SecureHash / parse
-
-

parse

- -fun parse(str: String): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.crypto/-secure-hash/prefix-chars.html b/docs/build/html/api/core.crypto/-secure-hash/prefix-chars.html deleted file mode 100644 index ed8d084dfd..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/prefix-chars.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SecureHash.prefixChars - - - - -core.crypto / SecureHash / prefixChars
-
-

prefixChars

- -fun prefixChars(prefixLen: Int = 6): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.crypto/-secure-hash/random-s-h-a256.html b/docs/build/html/api/core.crypto/-secure-hash/random-s-h-a256.html deleted file mode 100644 index 95f1a6b457..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/random-s-h-a256.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SecureHash.randomSHA256 - - - - -core.crypto / SecureHash / randomSHA256
-
-

randomSHA256

- -fun randomSHA256(): SHA256
-
-
- - diff --git a/docs/build/html/api/core.crypto/-secure-hash/sha256-twice.html b/docs/build/html/api/core.crypto/-secure-hash/sha256-twice.html deleted file mode 100644 index 4e642f2e95..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/sha256-twice.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SecureHash.sha256Twice - - - - -core.crypto / SecureHash / sha256Twice
-
-

sha256Twice

- -fun sha256Twice(bits: ByteArray): SHA256
-
-
- - diff --git a/docs/build/html/api/core.crypto/-secure-hash/sha256.html b/docs/build/html/api/core.crypto/-secure-hash/sha256.html deleted file mode 100644 index 7f35dfae02..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/sha256.html +++ /dev/null @@ -1,17 +0,0 @@ - - -SecureHash.sha256 - - - - -core.crypto / SecureHash / sha256
-
-

sha256

- -fun sha256(bits: ByteArray): SHA256
- -fun sha256(str: String): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.crypto/-secure-hash/signature-algorithm-name.html b/docs/build/html/api/core.crypto/-secure-hash/signature-algorithm-name.html deleted file mode 100644 index 0c7d92d3ea..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/signature-algorithm-name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SecureHash.signatureAlgorithmName - - - - -core.crypto / SecureHash / signatureAlgorithmName
-
-

signatureAlgorithmName

- -abstract val signatureAlgorithmName: String
-
-
- - diff --git a/docs/build/html/api/core.crypto/-secure-hash/to-string.html b/docs/build/html/api/core.crypto/-secure-hash/to-string.html deleted file mode 100644 index 2ca3e55287..0000000000 --- a/docs/build/html/api/core.crypto/-secure-hash/to-string.html +++ /dev/null @@ -1,16 +0,0 @@ - - -SecureHash.toString - - - - -core.crypto / SecureHash / toString
-
-

toString

- -open fun toString(): <ERROR CLASS>
-Overrides OpaqueBytes.toString
-
-
- - diff --git a/docs/build/html/api/core.crypto/generate-key-pair.html b/docs/build/html/api/core.crypto/generate-key-pair.html deleted file mode 100644 index 9ebb5092bd..0000000000 --- a/docs/build/html/api/core.crypto/generate-key-pair.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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

-
-
- - diff --git a/docs/build/html/api/core.crypto/index.html b/docs/build/html/api/core.crypto/index.html deleted file mode 100644 index 294206c9df..0000000000 --- a/docs/build/html/api/core.crypto/index.html +++ /dev/null @@ -1,90 +0,0 @@ - - -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
-

Extensions for External Classes

- - - - - - - - - - - - - - - - - - - -
-java.security.KeyPair -
-java.security.PrivateKey -
-java.security.PublicKey -
-kotlin.ByteArray -
-

Functions

- - - - - - - - - - - -
-generateKeyPair -fun generateKeyPair(): KeyPair

A simple wrapper that will make it easier to swap out the EC algorithm we use in future

-
-sha256 -fun OpaqueBytes.sha256(): SHA256
- - 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 deleted file mode 100644 index e3cd60f572..0000000000 --- a/docs/build/html/api/core.crypto/java.security.-key-pair/component1.html +++ /dev/null @@ -1,15 +0,0 @@ - - -component1 - - - - -core.crypto / java.security.KeyPair / component1
-
-

component1

- -operator fun KeyPair.component1(): PrivateKey
-
-
- - diff --git a/docs/build/html/api/core.crypto/java.security.-key-pair/component2.html b/docs/build/html/api/core.crypto/java.security.-key-pair/component2.html deleted file mode 100644 index e3aacd1733..0000000000 --- a/docs/build/html/api/core.crypto/java.security.-key-pair/component2.html +++ /dev/null @@ -1,15 +0,0 @@ - - -component2 - - - - -core.crypto / java.security.KeyPair / component2
-
-

component2

- -operator fun KeyPair.component2(): PublicKey
-
-
- - diff --git a/docs/build/html/api/core.crypto/java.security.-key-pair/index.html b/docs/build/html/api/core.crypto/java.security.-key-pair/index.html deleted file mode 100644 index 64d437b063..0000000000 --- a/docs/build/html/api/core.crypto/java.security.-key-pair/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -core.crypto.java.security.KeyPair - - - - -core.crypto / java.security.KeyPair
-
-

Extensions for java.security.KeyPair

- - - - - - - - - - - - - - - -
-component1 -operator fun KeyPair.component1(): PrivateKey
-component2 -operator fun KeyPair.component2(): PublicKey
-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
- - 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 deleted file mode 100644 index ea70ec4e1c..0000000000 --- a/docs/build/html/api/core.crypto/java.security.-key-pair/sign-with-e-c-d-s-a.html +++ /dev/null @@ -1,21 +0,0 @@ - - -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
-
-
- - diff --git a/docs/build/html/api/core.crypto/java.security.-private-key/index.html b/docs/build/html/api/core.crypto/java.security.-private-key/index.html deleted file mode 100644 index e91f3ca423..0000000000 --- a/docs/build/html/api/core.crypto/java.security.-private-key/index.html +++ /dev/null @@ -1,22 +0,0 @@ - - -core.crypto.java.security.PrivateKey - - - - -core.crypto / java.security.PrivateKey
-
-

Extensions for java.security.PrivateKey

- - - - - - - -
-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
- - 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 deleted file mode 100644 index bab411e816..0000000000 --- a/docs/build/html/api/core.crypto/java.security.-private-key/sign-with-e-c-d-s-a.html +++ /dev/null @@ -1,20 +0,0 @@ - - -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
-
-
- - diff --git a/docs/build/html/api/core.crypto/java.security.-public-key/index.html b/docs/build/html/api/core.crypto/java.security.-public-key/index.html deleted file mode 100644 index 9b29cd6b17..0000000000 --- a/docs/build/html/api/core.crypto/java.security.-public-key/index.html +++ /dev/null @@ -1,29 +0,0 @@ - - -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 deleted file mode 100644 index ce69028b41..0000000000 --- a/docs/build/html/api/core.crypto/java.security.-public-key/to-string-short.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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

-
-
- - diff --git a/docs/build/html/api/core.crypto/java.security.-public-key/verify-with-e-c-d-s-a.html b/docs/build/html/api/core.crypto/java.security.-public-key/verify-with-e-c-d-s-a.html deleted file mode 100644 index b4d58465a7..0000000000 --- a/docs/build/html/api/core.crypto/java.security.-public-key/verify-with-e-c-d-s-a.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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

-
-
- - diff --git a/docs/build/html/api/core.crypto/kotlin.-byte-array/index.html b/docs/build/html/api/core.crypto/kotlin.-byte-array/index.html deleted file mode 100644 index 052f13c99a..0000000000 --- a/docs/build/html/api/core.crypto/kotlin.-byte-array/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - -core.crypto.kotlin.ByteArray - - - - -core.crypto / kotlin.ByteArray
-
-

Extensions for kotlin.ByteArray

- - - - - - - -
-sha256 -fun ByteArray.sha256(): SHA256
- - 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 deleted file mode 100644 index 1d3b8e305a..0000000000 --- a/docs/build/html/api/core.crypto/kotlin.-byte-array/sha256.html +++ /dev/null @@ -1,15 +0,0 @@ - - -sha256 - - - - -core.crypto / kotlin.ByteArray / sha256
-
-

sha256

- -fun ByteArray.sha256(): SHA256
-
-
- - diff --git a/docs/build/html/api/core.crypto/sha256.html b/docs/build/html/api/core.crypto/sha256.html deleted file mode 100644 index 89f290a8d5..0000000000 --- a/docs/build/html/api/core.crypto/sha256.html +++ /dev/null @@ -1,15 +0,0 @@ - - -sha256 - - - - -core.crypto / sha256
-
-

sha256

- -fun OpaqueBytes.sha256(): SHA256
-
-
- - diff --git a/docs/build/html/api/core.messaging/-all-possible-recipients.html b/docs/build/html/api/core.messaging/-all-possible-recipients.html deleted file mode 100644 index e7c15d9999..0000000000 --- a/docs/build/html/api/core.messaging/-all-possible-recipients.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.messaging/-legally-identifiable-node/-init-.html b/docs/build/html/api/core.messaging/-legally-identifiable-node/-init-.html deleted file mode 100644 index bdf73b9431..0000000000 --- a/docs/build/html/api/core.messaging/-legally-identifiable-node/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -LegallyIdentifiableNode.<init> - - - - -core.messaging / LegallyIdentifiableNode / <init>
-
-

<init>

-LegallyIdentifiableNode(address: SingleMessageRecipient, identity: Party)
-

Info about a network node that has is operated by some sort of verified identity.

-
-
- - diff --git a/docs/build/html/api/core.messaging/-legally-identifiable-node/address.html b/docs/build/html/api/core.messaging/-legally-identifiable-node/address.html deleted file mode 100644 index a90cbf6e70..0000000000 --- a/docs/build/html/api/core.messaging/-legally-identifiable-node/address.html +++ /dev/null @@ -1,15 +0,0 @@ - - -LegallyIdentifiableNode.address - - - - -core.messaging / LegallyIdentifiableNode / address
-
-

address

- -val address: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/core.messaging/-legally-identifiable-node/identity.html b/docs/build/html/api/core.messaging/-legally-identifiable-node/identity.html deleted file mode 100644 index 4dbadac8f2..0000000000 --- a/docs/build/html/api/core.messaging/-legally-identifiable-node/identity.html +++ /dev/null @@ -1,15 +0,0 @@ - - -LegallyIdentifiableNode.identity - - - - -core.messaging / LegallyIdentifiableNode / identity
-
-

identity

- -val identity: Party
-
-
- - diff --git a/docs/build/html/api/core.messaging/-legally-identifiable-node/index.html b/docs/build/html/api/core.messaging/-legally-identifiable-node/index.html deleted file mode 100644 index fcee0d9ca0..0000000000 --- a/docs/build/html/api/core.messaging/-legally-identifiable-node/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - -LegallyIdentifiableNode - - - - -core.messaging / LegallyIdentifiableNode
-
-

LegallyIdentifiableNode

-data class LegallyIdentifiableNode
-

Info about a network node that has is operated by some sort of verified identity.

-
-
-

Constructors

- - - - - - - -
-<init> -LegallyIdentifiableNode(address: SingleMessageRecipient, identity: Party)

Info about a network node that has is operated by some sort of verified identity.

-
-

Properties

- - - - - - - - - - - -
-address -val address: SingleMessageRecipient
-identity -val identity: Party
- - diff --git a/docs/build/html/api/core.messaging/-message-handler-registration.html b/docs/build/html/api/core.messaging/-message-handler-registration.html deleted file mode 100644 index d757a1362e..0000000000 --- a/docs/build/html/api/core.messaging/-message-handler-registration.html +++ /dev/null @@ -1,26 +0,0 @@ - - -MessageHandlerRegistration - - - - -core.messaging / MessageHandlerRegistration
-
-

MessageHandlerRegistration

-interface MessageHandlerRegistration
-
-
-

Inheritors

- - - - - - - -
-Handler -inner class Handler : MessageHandlerRegistration

A registration to handle messages of different types

-
- - diff --git a/docs/build/html/api/core.messaging/-message-recipient-group.html b/docs/build/html/api/core.messaging/-message-recipient-group.html deleted file mode 100644 index 2c0e30e09c..0000000000 --- a/docs/build/html/api/core.messaging/-message-recipient-group.html +++ /dev/null @@ -1,15 +0,0 @@ - - -MessageRecipientGroup - - - - -core.messaging / MessageRecipientGroup
-
-

MessageRecipientGroup

-interface MessageRecipientGroup : MessageRecipients
-

A base class for a set of recipients specifically identified by the sender.

-
-
- - diff --git a/docs/build/html/api/core.messaging/-message-recipients.html b/docs/build/html/api/core.messaging/-message-recipients.html deleted file mode 100644 index c65fba1cc4..0000000000 --- a/docs/build/html/api/core.messaging/-message-recipients.html +++ /dev/null @@ -1,41 +0,0 @@ - - -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 deleted file mode 100644 index 6265b6f3cb..0000000000 --- a/docs/build/html/api/core.messaging/-message/data.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.data - - - - -core.messaging / Message / data
-
-

data

- -abstract val data: ByteArray
-
-
- - diff --git a/docs/build/html/api/core.messaging/-message/debug-message-i-d.html b/docs/build/html/api/core.messaging/-message/debug-message-i-d.html deleted file mode 100644 index 207af85bcc..0000000000 --- a/docs/build/html/api/core.messaging/-message/debug-message-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.debugMessageID - - - - -core.messaging / Message / debugMessageID
-
-

debugMessageID

- -abstract val debugMessageID: String
-
-
- - diff --git a/docs/build/html/api/core.messaging/-message/debug-timestamp.html b/docs/build/html/api/core.messaging/-message/debug-timestamp.html deleted file mode 100644 index eaa930929a..0000000000 --- a/docs/build/html/api/core.messaging/-message/debug-timestamp.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.debugTimestamp - - - - -core.messaging / Message / debugTimestamp
-
-

debugTimestamp

- -abstract val debugTimestamp: Instant
-
-
- - diff --git a/docs/build/html/api/core.messaging/-message/index.html b/docs/build/html/api/core.messaging/-message/index.html deleted file mode 100644 index 9f4cf5220b..0000000000 --- a/docs/build/html/api/core.messaging/-message/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - -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

- - - - - - - - - - - - - - - - - - - -
-data -abstract val data: ByteArray
-debugMessageID -abstract val debugMessageID: String
-debugTimestamp -abstract val debugTimestamp: Instant
-topic -abstract val topic: String
-

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 deleted file mode 100644 index fbd1892aac..0000000000 --- a/docs/build/html/api/core.messaging/-message/serialise.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.serialise - - - - -core.messaging / Message / serialise
-
-

serialise

- -abstract fun serialise(): ByteArray
-
-
- - diff --git a/docs/build/html/api/core.messaging/-message/topic.html b/docs/build/html/api/core.messaging/-message/topic.html deleted file mode 100644 index 52d3745896..0000000000 --- a/docs/build/html/api/core.messaging/-message/topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.topic - - - - -core.messaging / Message / topic
-
-

topic

- -abstract val topic: String
-
-
- - diff --git a/docs/build/html/api/core.messaging/-messaging-service-builder/index.html b/docs/build/html/api/core.messaging/-messaging-service-builder/index.html deleted file mode 100644 index f7d1323dc6..0000000000 --- a/docs/build/html/api/core.messaging/-messaging-service-builder/index.html +++ /dev/null @@ -1,33 +0,0 @@ - - -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>
- - 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 deleted file mode 100644 index 1f0675d399..0000000000 --- a/docs/build/html/api/core.messaging/-messaging-service-builder/start.html +++ /dev/null @@ -1,15 +0,0 @@ - - -MessagingServiceBuilder.start - - - - -core.messaging / MessagingServiceBuilder / start
-
-

start

- -abstract fun start(): <ERROR CLASS><out T>
-
-
- - diff --git a/docs/build/html/api/core.messaging/-messaging-service/add-message-handler.html b/docs/build/html/api/core.messaging/-messaging-service/add-message-handler.html deleted file mode 100644 index 2e4f54cbc2..0000000000 --- a/docs/build/html/api/core.messaging/-messaging-service/add-message-handler.html +++ /dev/null @@ -1,24 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.messaging/-messaging-service/create-message.html b/docs/build/html/api/core.messaging/-messaging-service/create-message.html deleted file mode 100644 index c9cfd40309..0000000000 --- a/docs/build/html/api/core.messaging/-messaging-service/create-message.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.messaging/-messaging-service/index.html b/docs/build/html/api/core.messaging/-messaging-service/index.html deleted file mode 100644 index 904aa552de..0000000000 --- a/docs/build/html/api/core.messaging/-messaging-service/index.html +++ /dev/null @@ -1,113 +0,0 @@ - - -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

- - - - - - - -
-myAddress -abstract val myAddress: SingleMessageRecipient

Returns an address that refers to this node.

-
-

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, includeClassName: Boolean = false): 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.

-
- - 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 deleted file mode 100644 index 5f0286063d..0000000000 --- a/docs/build/html/api/core.messaging/-messaging-service/my-address.html +++ /dev/null @@ -1,16 +0,0 @@ - - -MessagingService.myAddress - - - - -core.messaging / MessagingService / myAddress
-
-

myAddress

- -abstract val myAddress: SingleMessageRecipient
-

Returns an address that refers to this node.

-
-
- - diff --git a/docs/build/html/api/core.messaging/-messaging-service/remove-message-handler.html b/docs/build/html/api/core.messaging/-messaging-service/remove-message-handler.html deleted file mode 100644 index 7ac4c91a54..0000000000 --- a/docs/build/html/api/core.messaging/-messaging-service/remove-message-handler.html +++ /dev/null @@ -1,23 +0,0 @@ - - -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.
-
-
- - diff --git a/docs/build/html/api/core.messaging/-messaging-service/send.html b/docs/build/html/api/core.messaging/-messaging-service/send.html deleted file mode 100644 index 2ffad23f5c..0000000000 --- a/docs/build/html/api/core.messaging/-messaging-service/send.html +++ /dev/null @@ -1,23 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.messaging/-messaging-service/stop.html b/docs/build/html/api/core.messaging/-messaging-service/stop.html deleted file mode 100644 index 9a242c0228..0000000000 --- a/docs/build/html/api/core.messaging/-messaging-service/stop.html +++ /dev/null @@ -1,15 +0,0 @@ - - -MessagingService.stop - - - - -core.messaging / MessagingService / stop
-
-

stop

- -abstract fun stop(): Unit
-
-
- - diff --git a/docs/build/html/api/core.messaging/-mock-network-map/-init-.html b/docs/build/html/api/core.messaging/-mock-network-map/-init-.html deleted file mode 100644 index 101885438c..0000000000 --- a/docs/build/html/api/core.messaging/-mock-network-map/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -MockNetworkMap.<init> - - - - -core.messaging / MockNetworkMap / <init>
-
-

<init>

-MockNetworkMap()
-
-
- - diff --git a/docs/build/html/api/core.messaging/-mock-network-map/index.html b/docs/build/html/api/core.messaging/-mock-network-map/index.html deleted file mode 100644 index 25fc6b9056..0000000000 --- a/docs/build/html/api/core.messaging/-mock-network-map/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -MockNetworkMap - - - - -core.messaging / MockNetworkMap
-
-

MockNetworkMap

-class MockNetworkMap : NetworkMap
-
-
-

Constructors

- - - - - - - -
-<init> -MockNetworkMap()
-

Properties

- - - - - - - -
-timestampingNodes -val timestampingNodes: MutableList<LegallyIdentifiableNode>
- - diff --git a/docs/build/html/api/core.messaging/-mock-network-map/timestamping-nodes.html b/docs/build/html/api/core.messaging/-mock-network-map/timestamping-nodes.html deleted file mode 100644 index 6cdfeb5c16..0000000000 --- a/docs/build/html/api/core.messaging/-mock-network-map/timestamping-nodes.html +++ /dev/null @@ -1,16 +0,0 @@ - - -MockNetworkMap.timestampingNodes - - - - -core.messaging / MockNetworkMap / timestampingNodes
-
-

timestampingNodes

- -val timestampingNodes: MutableList<LegallyIdentifiableNode>
-Overrides NetworkMap.timestampingNodes
-
-
- - diff --git a/docs/build/html/api/core.messaging/-network-map/index.html b/docs/build/html/api/core.messaging/-network-map/index.html deleted file mode 100644 index e652aacd39..0000000000 --- a/docs/build/html/api/core.messaging/-network-map/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - -NetworkMap - - - - -core.messaging / NetworkMap
-
-

NetworkMap

-interface NetworkMap
-

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. A reasonable architecture for the -network map service might be one like the Tor directory authorities, where several nodes linked by RAFT or Paxos -elect a leader and that leader distributes signed documents describing the network layout. Those documents can -then be cached by every node and thus a network map can be retrieved given only a single successful peer connection.

-

This interface assumes fast, synchronous access to an in-memory map.

-
-
-
-
-

Properties

- - - - - - - -
-timestampingNodes -abstract val timestampingNodes: List<LegallyIdentifiableNode>
-

Inheritors

- - - - - - - -
-MockNetworkMap -class MockNetworkMap : NetworkMap
- - diff --git a/docs/build/html/api/core.messaging/-network-map/timestamping-nodes.html b/docs/build/html/api/core.messaging/-network-map/timestamping-nodes.html deleted file mode 100644 index 95e7155ba6..0000000000 --- a/docs/build/html/api/core.messaging/-network-map/timestamping-nodes.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NetworkMap.timestampingNodes - - - - -core.messaging / NetworkMap / timestampingNodes
-
-

timestampingNodes

- -abstract val timestampingNodes: List<LegallyIdentifiableNode>
-
-
- - diff --git a/docs/build/html/api/core.messaging/-single-message-recipient.html b/docs/build/html/api/core.messaging/-single-message-recipient.html deleted file mode 100644 index 6c494432cc..0000000000 --- a/docs/build/html/api/core.messaging/-single-message-recipient.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SingleMessageRecipient - - - - -core.messaging / SingleMessageRecipient
-
-

SingleMessageRecipient

-interface SingleMessageRecipient : MessageRecipients
-

A base class for the case of point-to-point messages

-
-
- - 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 deleted file mode 100644 index bc39c91e16..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -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>)
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/index.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/index.html deleted file mode 100644 index cf2bdb309c..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/index.html +++ /dev/null @@ -1,71 +0,0 @@ - - -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

- - - - - - - -
-responseType -val responseType: Class<R>
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - -
-destination -val destination: MessageRecipients?
-obj -val obj: Any?
-sessionIDForReceive -val sessionIDForReceive: Long
-sessionIDForSend -val sessionIDForSend: Long
-topic -val topic: String
- - 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 deleted file mode 100644 index 06808768a7..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/response-type.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.ExpectingResponse.responseType - - - - -core.messaging / StateMachineManager / FiberRequest / ExpectingResponse / responseType
-
-

responseType

- -val responseType: Class<R>
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-init-.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-init-.html deleted file mode 100644 index 8cd98d402b..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -StateMachineManager.FiberRequest.<init> - - - - -core.messaging / StateMachineManager / FiberRequest / <init>
-
-

<init>

-FiberRequest(topic: String, destination: MessageRecipients?, sessionIDForSend: Long, sessionIDForReceive: Long, obj: Any?)
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/-init-.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/-init-.html deleted file mode 100644 index ec9db5833d..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -StateMachineManager.FiberRequest.NotExpectingResponse.<init> - - - - -core.messaging / StateMachineManager / FiberRequest / NotExpectingResponse / <init>
-
-

<init>

-NotExpectingResponse(topic: String, destination: MessageRecipients, sessionIDForSend: Long, obj: Any?)
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/index.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/index.html deleted file mode 100644 index 53fe387d3f..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - -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

- - - - - - - - - - - - - - - - - - - - - - - -
-destination -val destination: MessageRecipients?
-obj -val obj: Any?
-sessionIDForReceive -val sessionIDForReceive: Long
-sessionIDForSend -val sessionIDForSend: Long
-topic -val topic: String
- - 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 deleted file mode 100644 index c67bf7ad20..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/destination.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.destination - - - - -core.messaging / StateMachineManager / FiberRequest / destination
-
-

destination

- -val destination: MessageRecipients?
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/index.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/index.html deleted file mode 100644 index cbeac0b7d3..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/index.html +++ /dev/null @@ -1,94 +0,0 @@ - - -StateMachineManager.FiberRequest - - - - -core.messaging / StateMachineManager / FiberRequest
-
-

FiberRequest

-class FiberRequest
-
-
-

Types

- - - - - - - - - - - -
-ExpectingResponse -class ExpectingResponse<R : Any> : FiberRequest
-NotExpectingResponse -class NotExpectingResponse : FiberRequest
-

Constructors

- - - - - - - -
-<init> -FiberRequest(topic: String, destination: MessageRecipients?, sessionIDForSend: Long, sessionIDForReceive: Long, obj: Any?)
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - -
-destination -val destination: MessageRecipients?
-obj -val obj: Any?
-sessionIDForReceive -val sessionIDForReceive: Long
-sessionIDForSend -val sessionIDForSend: Long
-topic -val topic: String
-

Inheritors

- - - - - - - - - - - -
-ExpectingResponse -class ExpectingResponse<R : Any> : FiberRequest
-NotExpectingResponse -class NotExpectingResponse : FiberRequest
- - 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 deleted file mode 100644 index 59a930234b..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/obj.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.obj - - - - -core.messaging / StateMachineManager / FiberRequest / obj
-
-

obj

- -val obj: Any?
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-receive.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-receive.html deleted file mode 100644 index 71edcfa82c..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.sessionIDForReceive - - - - -core.messaging / StateMachineManager / FiberRequest / sessionIDForReceive
-
-

sessionIDForReceive

- -val sessionIDForReceive: Long
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-send.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-send.html deleted file mode 100644 index 31900075b9..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-send.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.sessionIDForSend - - - - -core.messaging / StateMachineManager / FiberRequest / sessionIDForSend
-
-

sessionIDForSend

- -val sessionIDForSend: Long
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/topic.html b/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/topic.html deleted file mode 100644 index 6a805c7ceb..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-fiber-request/topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.topic - - - - -core.messaging / StateMachineManager / FiberRequest / topic
-
-

topic

- -val topic: String
-
-
- - 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 deleted file mode 100644 index db7a2b9880..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-init-.html +++ /dev/null @@ -1,33 +0,0 @@ - - -StateMachineManager.<init> - - - - -core.messaging / StateMachineManager / <init>
-
-

<init>

-StateMachineManager(serviceHub: ServiceHub, runInThread: Executor)
-

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.

-

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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/-same-thread-fiber-scheduler.html b/docs/build/html/api/core.messaging/-state-machine-manager/-same-thread-fiber-scheduler.html deleted file mode 100644 index 644d61d045..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/-same-thread-fiber-scheduler.html +++ /dev/null @@ -1,14 +0,0 @@ - - -StateMachineManager.SameThreadFiberScheduler - - - - -core.messaging / StateMachineManager / SameThreadFiberScheduler
-
-

SameThreadFiberScheduler

-object SameThreadFiberScheduler
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/add.html b/docs/build/html/api/core.messaging/-state-machine-manager/add.html deleted file mode 100644 index fa28ee12f5..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/add.html +++ /dev/null @@ -1,18 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/checkpointing.html b/docs/build/html/api/core.messaging/-state-machine-manager/checkpointing.html deleted file mode 100644 index 3ee395b257..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/checkpointing.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.checkpointing - - - - -core.messaging / StateMachineManager / checkpointing
-
-

checkpointing

- -val checkpointing: Boolean
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/find-state-machines.html b/docs/build/html/api/core.messaging/-state-machine-manager/find-state-machines.html deleted file mode 100644 index 88a2990dc7..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/find-state-machines.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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)

-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/index.html b/docs/build/html/api/core.messaging/-state-machine-manager/index.html deleted file mode 100644 index b5a961c90c..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/index.html +++ /dev/null @@ -1,107 +0,0 @@ - - -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.

-

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

- - - - - - - - - - - -
-FiberRequest -class FiberRequest
-SameThreadFiberScheduler -object SameThreadFiberScheduler
-

Constructors

- - - - - - - -
-<init> -StateMachineManager(serviceHub: ServiceHub, runInThread: Executor)

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

- - - - - - - - - - - - - - - -
-checkpointing -val checkpointing: Boolean
-runInThread -val runInThread: Executor
-serviceHub -val serviceHub: ServiceHub
-

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/run-in-thread.html b/docs/build/html/api/core.messaging/-state-machine-manager/run-in-thread.html deleted file mode 100644 index 1a4eb9f242..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/run-in-thread.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.runInThread - - - - -core.messaging / StateMachineManager / runInThread
-
-

runInThread

- -val runInThread: Executor
-
-
- - diff --git a/docs/build/html/api/core.messaging/-state-machine-manager/service-hub.html b/docs/build/html/api/core.messaging/-state-machine-manager/service-hub.html deleted file mode 100644 index f9a38c5d0a..0000000000 --- a/docs/build/html/api/core.messaging/-state-machine-manager/service-hub.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.serviceHub - - - - -core.messaging / StateMachineManager / serviceHub
-
-

serviceHub

- -val serviceHub: ServiceHub
-
-
- - diff --git a/docs/build/html/api/core.messaging/-topic-string-validator/check.html b/docs/build/html/api/core.messaging/-topic-string-validator/check.html deleted file mode 100644 index 1f0e354172..0000000000 --- a/docs/build/html/api/core.messaging/-topic-string-validator/check.html +++ /dev/null @@ -1,18 +0,0 @@ - - -TopicStringValidator.check - - - - -core.messaging / TopicStringValidator / check
-
-

check

- -fun check(tag: String): <ERROR CLASS>
-

Exceptions

- -IllegalArgumentException - if the given topic contains invalid characters
-
-
- - diff --git a/docs/build/html/api/core.messaging/-topic-string-validator/index.html b/docs/build/html/api/core.messaging/-topic-string-validator/index.html deleted file mode 100644 index a7591963dd..0000000000 --- a/docs/build/html/api/core.messaging/-topic-string-validator/index.html +++ /dev/null @@ -1,26 +0,0 @@ - - -TopicStringValidator - - - - -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 deleted file mode 100644 index 4133d052eb..0000000000 --- a/docs/build/html/api/core.messaging/index.html +++ /dev/null @@ -1,135 +0,0 @@ - - -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.

-
-LegallyIdentifiableNode -data class LegallyIdentifiableNode

Info about a network node that has is operated by some sort of verified identity.

-
-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.

-
-MockNetworkMap -class MockNetworkMap : NetworkMap
-NetworkMap -interface NetworkMap

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. A reasonable architecture for the -network map service might be one like the Tor directory authorities, where several nodes linked by RAFT or Paxos -elect a leader and that leader distributes signed documents describing the network layout. Those documents can -then be cached by every node and thus a network map can be retrieved given only a single successful peer connection.

-
-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

-
-

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, includeClassName: Boolean = false): Unit
- - 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 deleted file mode 100644 index 5f29bdc4a7..0000000000 --- a/docs/build/html/api/core.messaging/run-on-next-message.html +++ /dev/null @@ -1,18 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.messaging/send.html b/docs/build/html/api/core.messaging/send.html deleted file mode 100644 index 66a8b22d85..0000000000 --- a/docs/build/html/api/core.messaging/send.html +++ /dev/null @@ -1,15 +0,0 @@ - - -send - - - - -core.messaging / send
-
-

send

- -fun MessagingService.send(topic: String, to: MessageRecipients, obj: Any, includeClassName: Boolean = false): Unit
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/-init-.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/-init-.html deleted file mode 100644 index 55e1fc2a7b..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.Handler.<init> - - - - -core.node.services / ArtemisMessagingService / Handler / <init>
-
-

<init>

-Handler(executor: Executor?, topic: String, callback: (Message, MessageHandlerRegistration) -> Unit)
-

A registration to handle messages of different types

-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/callback.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/callback.html deleted file mode 100644 index 4fb31624d5..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/callback.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.Handler.callback - - - - -core.node.services / ArtemisMessagingService / Handler / callback
-
-

callback

- -val callback: (Message, MessageHandlerRegistration) -> Unit
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/executor.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/executor.html deleted file mode 100644 index 2b3824f4c9..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/executor.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.Handler.executor - - - - -core.node.services / ArtemisMessagingService / Handler / executor
-
-

executor

- -val executor: Executor?
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/index.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/index.html deleted file mode 100644 index 2534761b0d..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/index.html +++ /dev/null @@ -1,50 +0,0 @@ - - -ArtemisMessagingService.Handler - - - - -core.node.services / ArtemisMessagingService / Handler
-
-

Handler

-inner class Handler : MessageHandlerRegistration
-

A registration to handle messages of different types

-
-
-

Constructors

- - - - - - - -
-<init> -Handler(executor: Executor?, topic: String, callback: (Message, MessageHandlerRegistration) -> Unit)

A registration to handle messages of different types

-
-

Properties

- - - - - - - - - - - - - - - -
-callback -val callback: (Message, MessageHandlerRegistration) -> Unit
-executor -val executor: Executor?
-topic -val topic: String
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/topic.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/topic.html deleted file mode 100644 index c71a0c48ef..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/-handler/topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.Handler.topic - - - - -core.node.services / ArtemisMessagingService / Handler / topic
-
-

topic

- -val topic: String
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/-init-.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/-init-.html deleted file mode 100644 index b932ef4ee6..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/-init-.html +++ /dev/null @@ -1,23 +0,0 @@ - - -ArtemisMessagingService.<init> - - - - -core.node.services / ArtemisMessagingService / <init>
-
-

<init>

-ArtemisMessagingService(directory: Path, myHostPort: <ERROR CLASS>)
-

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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/-t-o-p-i-c_-p-r-o-p-e-r-t-y.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/-t-o-p-i-c_-p-r-o-p-e-r-t-y.html deleted file mode 100644 index aac3f13bcf..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/-t-o-p-i-c_-p-r-o-p-e-r-t-y.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.TOPIC_PROPERTY - - - - -core.node.services / ArtemisMessagingService / TOPIC_PROPERTY
-
-

TOPIC_PROPERTY

- -val TOPIC_PROPERTY: String
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/add-message-handler.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/add-message-handler.html deleted file mode 100644 index 37f62f03e4..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/add-message-handler.html +++ /dev/null @@ -1,25 +0,0 @@ - - -ArtemisMessagingService.addMessageHandler - - - - -core.node.services / ArtemisMessagingService / addMessageHandler
-
-

addMessageHandler

- -fun addMessageHandler(topic: String, executor: Executor?, callback: (Message, MessageHandlerRegistration) -> Unit): MessageHandlerRegistration
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/create-message.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/create-message.html deleted file mode 100644 index e526eff46b..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/create-message.html +++ /dev/null @@ -1,17 +0,0 @@ - - -ArtemisMessagingService.createMessage - - - - -core.node.services / ArtemisMessagingService / createMessage
-
-

createMessage

- -fun createMessage(topic: String, data: ByteArray): Message
-Overrides MessagingService.createMessage
-

Returns an initialised Message with the current time, etc, already filled in.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/directory.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/directory.html deleted file mode 100644 index 8bc769156d..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/directory.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.directory - - - - -core.node.services / ArtemisMessagingService / directory
-
-

directory

- -val directory: Path
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/index.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/index.html deleted file mode 100644 index c02458204a..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/index.html +++ /dev/null @@ -1,179 +0,0 @@ - - -ArtemisMessagingService - - - - -core.node.services / 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.

-
-
-
-
-

Types

- - - - - - - -
-Handler -inner class Handler : MessageHandlerRegistration

A registration to handle messages of different types

-
-

Constructors

- - - - - - - -
-<init> -ArtemisMessagingService(directory: Path, myHostPort: <ERROR CLASS>)

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

- - - - - - - - - - - - - - - -
-directory -val directory: Path
-myAddress -val myAddress: SingleMessageRecipient

Returns an address that refers to this node.

-
-myHostPort -val myHostPort: <ERROR CLASS>
-

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

- - - - - - - - - - - -
-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, includeClassName: Boolean = false): Unit
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/log.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/log.html deleted file mode 100644 index b07de39dd3..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/log.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.log - - - - -core.node.services / ArtemisMessagingService / log
-
-

log

- -val log: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/make-recipient.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/make-recipient.html deleted file mode 100644 index 5422674040..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/make-recipient.html +++ /dev/null @@ -1,20 +0,0 @@ - - -ArtemisMessagingService.makeRecipient - - - - -core.node.services / ArtemisMessagingService / makeRecipient
-
-

makeRecipient

- -fun makeRecipient(hostAndPort: <ERROR CLASS>): SingleMessageRecipient
-

Temp helper until network map is established.

-
-
- -fun makeRecipient(hostname: String): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/my-address.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/my-address.html deleted file mode 100644 index 65902a0061..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/my-address.html +++ /dev/null @@ -1,17 +0,0 @@ - - -ArtemisMessagingService.myAddress - - - - -core.node.services / ArtemisMessagingService / myAddress
-
-

myAddress

- -val myAddress: SingleMessageRecipient
-Overrides MessagingService.myAddress
-

Returns an address that refers to this node.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/my-host-port.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/my-host-port.html deleted file mode 100644 index e2383d959f..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/my-host-port.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.myHostPort - - - - -core.node.services / ArtemisMessagingService / myHostPort
-
-

myHostPort

- -val myHostPort: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/remove-message-handler.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/remove-message-handler.html deleted file mode 100644 index 5acf7ef83a..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/remove-message-handler.html +++ /dev/null @@ -1,24 +0,0 @@ - - -ArtemisMessagingService.removeMessageHandler - - - - -core.node.services / ArtemisMessagingService / removeMessageHandler
-
-

removeMessageHandler

- -fun removeMessageHandler(registration: MessageHandlerRegistration): Unit
-Overrides 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.
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/send.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/send.html deleted file mode 100644 index da0ec6df22..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/send.html +++ /dev/null @@ -1,24 +0,0 @@ - - -ArtemisMessagingService.send - - - - -core.node.services / ArtemisMessagingService / send
-
-

send

- -fun send(message: Message, target: MessageRecipients): Unit
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/start.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/start.html deleted file mode 100644 index 9d2fe232e0..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/start.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.start - - - - -core.node.services / ArtemisMessagingService / start
-
-

start

- -fun start(): Unit
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/stop.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/stop.html deleted file mode 100644 index dc10cf99b8..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/stop.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ArtemisMessagingService.stop - - - - -core.node.services / ArtemisMessagingService / stop
-
-

stop

- -fun stop(): Unit
-Overrides MessagingService.stop
-
-
- - diff --git a/docs/build/html/api/core.node.services/-artemis-messaging-service/to-host-and-port.html b/docs/build/html/api/core.node.services/-artemis-messaging-service/to-host-and-port.html deleted file mode 100644 index e8010b561b..0000000000 --- a/docs/build/html/api/core.node.services/-artemis-messaging-service/to-host-and-port.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.toHostAndPort - - - - -core.node.services / ArtemisMessagingService / toHostAndPort
-
-

toHostAndPort

- -fun toHostAndPort(hostname: String): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.node.services/-attachment-storage/import-attachment.html b/docs/build/html/api/core.node.services/-attachment-storage/import-attachment.html deleted file mode 100644 index 05eef512a3..0000000000 --- a/docs/build/html/api/core.node.services/-attachment-storage/import-attachment.html +++ /dev/null @@ -1,30 +0,0 @@ - - -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.
-
-
- - diff --git a/docs/build/html/api/core.node.services/-attachment-storage/index.html b/docs/build/html/api/core.node.services/-attachment-storage/index.html deleted file mode 100644 index 026b293d73..0000000000 --- a/docs/build/html/api/core.node.services/-attachment-storage/index.html +++ /dev/null @@ -1,51 +0,0 @@ - - -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

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 deleted file mode 100644 index c8994d97e9..0000000000 --- a/docs/build/html/api/core.node.services/-attachment-storage/open-attachment.html +++ /dev/null @@ -1,19 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-data-vending-service/-init-.html b/docs/build/html/api/core.node.services/-data-vending-service/-init-.html deleted file mode 100644 index a42a0bac1b..0000000000 --- a/docs/build/html/api/core.node.services/-data-vending-service/-init-.html +++ /dev/null @@ -1,24 +0,0 @@ - - -DataVendingService.<init> - - - - -core.node.services / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-data-vending-service/-request/-init-.html b/docs/build/html/api/core.node.services/-data-vending-service/-request/-init-.html deleted file mode 100644 index 9005c7fbb5..0000000000 --- a/docs/build/html/api/core.node.services/-data-vending-service/-request/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -DataVendingService.Request.<init> - - - - -core.node.services / DataVendingService / Request / <init>
-
-

<init>

-Request(hashes: List<SecureHash>, responseTo: SingleMessageRecipient, sessionID: Long)
-
-
- - diff --git a/docs/build/html/api/core.node.services/-data-vending-service/-request/hashes.html b/docs/build/html/api/core.node.services/-data-vending-service/-request/hashes.html deleted file mode 100644 index 62c99618e9..0000000000 --- a/docs/build/html/api/core.node.services/-data-vending-service/-request/hashes.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DataVendingService.Request.hashes - - - - -core.node.services / DataVendingService / Request / hashes
-
-

hashes

- -val hashes: List<SecureHash>
-
-
- - diff --git a/docs/build/html/api/core.node.services/-data-vending-service/-request/index.html b/docs/build/html/api/core.node.services/-data-vending-service/-request/index.html deleted file mode 100644 index 620f5d8042..0000000000 --- a/docs/build/html/api/core.node.services/-data-vending-service/-request/index.html +++ /dev/null @@ -1,48 +0,0 @@ - - -DataVendingService.Request - - - - -core.node.services / DataVendingService / Request
-
-

Request

-data class Request
-
-
-

Constructors

- - - - - - - -
-<init> -Request(hashes: List<SecureHash>, responseTo: SingleMessageRecipient, sessionID: Long)
-

Properties

- - - - - - - - - - - - - - - -
-hashes -val hashes: List<SecureHash>
-responseTo -val responseTo: SingleMessageRecipient
-sessionID -val sessionID: Long
- - diff --git a/docs/build/html/api/core.node.services/-data-vending-service/-request/response-to.html b/docs/build/html/api/core.node.services/-data-vending-service/-request/response-to.html deleted file mode 100644 index 24e1231327..0000000000 --- a/docs/build/html/api/core.node.services/-data-vending-service/-request/response-to.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DataVendingService.Request.responseTo - - - - -core.node.services / DataVendingService / Request / responseTo
-
-

responseTo

- -val responseTo: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/core.node.services/-data-vending-service/-request/session-i-d.html b/docs/build/html/api/core.node.services/-data-vending-service/-request/session-i-d.html deleted file mode 100644 index 581c62b4bc..0000000000 --- a/docs/build/html/api/core.node.services/-data-vending-service/-request/session-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DataVendingService.Request.sessionID - - - - -core.node.services / DataVendingService / Request / sessionID
-
-

sessionID

- -val sessionID: Long
-
-
- - diff --git a/docs/build/html/api/core.node.services/-data-vending-service/index.html b/docs/build/html/api/core.node.services/-data-vending-service/index.html deleted file mode 100644 index e3bc7029ab..0000000000 --- a/docs/build/html/api/core.node.services/-data-vending-service/index.html +++ /dev/null @@ -1,59 +0,0 @@ - - -DataVendingService - - - - -core.node.services / DataVendingService
-
-

DataVendingService

-class 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.

-

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

- - - - - - - -
-Request -data class Request
-

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.

-
-

Companion Object Properties

- - - - - - - -
-logger -val logger: <ERROR CLASS>
- - diff --git a/docs/build/html/api/core.node.services/-data-vending-service/logger.html b/docs/build/html/api/core.node.services/-data-vending-service/logger.html deleted file mode 100644 index 6e341e7752..0000000000 --- a/docs/build/html/api/core.node.services/-data-vending-service/logger.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DataVendingService.logger - - - - -core.node.services / DataVendingService / logger
-
-

logger

- -val logger: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.node.services/-dummy-timestamping-authority/identity.html b/docs/build/html/api/core.node.services/-dummy-timestamping-authority/identity.html deleted file mode 100644 index add30e7a97..0000000000 --- a/docs/build/html/api/core.node.services/-dummy-timestamping-authority/identity.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyTimestampingAuthority.identity - - - - -core.node.services / DummyTimestampingAuthority / identity
-
-

identity

- -val identity: Party
-
-
- - diff --git a/docs/build/html/api/core.node.services/-dummy-timestamping-authority/index.html b/docs/build/html/api/core.node.services/-dummy-timestamping-authority/index.html deleted file mode 100644 index fec26a679f..0000000000 --- a/docs/build/html/api/core.node.services/-dummy-timestamping-authority/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - -DummyTimestampingAuthority - - - - -core.node.services / DummyTimestampingAuthority
-
-

DummyTimestampingAuthority

-object DummyTimestampingAuthority
-
-
-

Properties

- - - - - - - - - - - -
-identity -val identity: Party
-key -val key: KeyPair
- - 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 deleted file mode 100644 index bc68a6b5b6..0000000000 --- a/docs/build/html/api/core.node.services/-dummy-timestamping-authority/key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DummyTimestampingAuthority.key - - - - -core.node.services / DummyTimestampingAuthority / key
-
-

key

- -val key: KeyPair
-
-
- - diff --git a/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/-init-.html b/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/-init-.html deleted file mode 100644 index f93e0074d5..0000000000 --- a/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/-init-.html +++ /dev/null @@ -1,23 +0,0 @@ - - -E2ETestKeyManagementService.<init> - - - - -core.node.services / 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

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/fresh-key.html b/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/fresh-key.html deleted file mode 100644 index 5ba0eab1c0..0000000000 --- a/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/fresh-key.html +++ /dev/null @@ -1,17 +0,0 @@ - - -E2ETestKeyManagementService.freshKey - - - - -core.node.services / E2ETestKeyManagementService / freshKey
-
-

freshKey

- -fun freshKey(): KeyPair
-Overrides KeyManagementService.freshKey
-

Generates a new random key and adds it to the exposed map.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/index.html b/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/index.html deleted file mode 100644 index 442055e023..0000000000 --- a/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/index.html +++ /dev/null @@ -1,70 +0,0 @@ - - -E2ETestKeyManagementService - - - - -core.node.services / 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

- - - - - - - -
-toPrivate -open fun toPrivate(publicKey: PublicKey): PrivateKey
- - diff --git a/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/keys.html b/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/keys.html deleted file mode 100644 index 6114c11085..0000000000 --- a/docs/build/html/api/core.node.services/-e2-e-test-key-management-service/keys.html +++ /dev/null @@ -1,20 +0,0 @@ - - -E2ETestKeyManagementService.keys - - - - -core.node.services / E2ETestKeyManagementService / keys
-
-

keys

- -val keys: Map<PublicKey, PrivateKey>
-Overrides KeyManagementService.keys
-

Returns a snapshot of the current pubkey->privkey mapping.

-Getter
-

Returns a snapshot of the current pubkey->privkey mapping.

-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-fixed-identity-service/-init-.html b/docs/build/html/api/core.node.services/-fixed-identity-service/-init-.html deleted file mode 100644 index 9401ccd4a4..0000000000 --- a/docs/build/html/api/core.node.services/-fixed-identity-service/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FixedIdentityService.<init> - - - - -core.node.services / FixedIdentityService / <init>
-
-

<init>

-FixedIdentityService(identities: List<Party>)
-

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-fixed-identity-service/index.html b/docs/build/html/api/core.node.services/-fixed-identity-service/index.html deleted file mode 100644 index c6c736b290..0000000000 --- a/docs/build/html/api/core.node.services/-fixed-identity-service/index.html +++ /dev/null @@ -1,38 +0,0 @@ - - -FixedIdentityService - - - - -core.node.services / FixedIdentityService
-
-

FixedIdentityService

-class FixedIdentityService : IdentityService
-

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-
-

Constructors

- - - - - - - -
-<init> -FixedIdentityService(identities: List<Party>)

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-

Functions

- - - - - - - -
-partyFromKey -fun partyFromKey(key: PublicKey): Party?
- - diff --git a/docs/build/html/api/core.node.services/-fixed-identity-service/party-from-key.html b/docs/build/html/api/core.node.services/-fixed-identity-service/party-from-key.html deleted file mode 100644 index 107c5c063d..0000000000 --- a/docs/build/html/api/core.node.services/-fixed-identity-service/party-from-key.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FixedIdentityService.partyFromKey - - - - -core.node.services / FixedIdentityService / partyFromKey
-
-

partyFromKey

- -fun partyFromKey(key: PublicKey): Party?
-Overrides IdentityService.partyFromKey
-
-
- - diff --git a/docs/build/html/api/core.node.services/-identity-service/index.html b/docs/build/html/api/core.node.services/-identity-service/index.html deleted file mode 100644 index 083d90d1a0..0000000000 --- a/docs/build/html/api/core.node.services/-identity-service/index.html +++ /dev/null @@ -1,40 +0,0 @@ - - -IdentityService - - - - -core.node.services / IdentityService
-
-

IdentityService

-interface IdentityService
-

An identity service maintains an bidirectional map of Partys 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

- - - - - - - -
-partyFromKey -abstract fun partyFromKey(key: PublicKey): Party?
-

Inheritors

- - - - - - - -
-FixedIdentityService -class FixedIdentityService : IdentityService

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
- - 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 deleted file mode 100644 index 8e1681c060..0000000000 --- a/docs/build/html/api/core.node.services/-identity-service/party-from-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -IdentityService.partyFromKey - - - - -core.node.services / IdentityService / partyFromKey
-
-

partyFromKey

- -abstract fun partyFromKey(key: PublicKey): Party?
-
-
- - diff --git a/docs/build/html/api/core.node.services/-key-management-service/fresh-key.html b/docs/build/html/api/core.node.services/-key-management-service/fresh-key.html deleted file mode 100644 index 9ab39166fe..0000000000 --- a/docs/build/html/api/core.node.services/-key-management-service/fresh-key.html +++ /dev/null @@ -1,16 +0,0 @@ - - -KeyManagementService.freshKey - - - - -core.node.services / KeyManagementService / freshKey
-
-

freshKey

- -abstract fun freshKey(): KeyPair
-

Generates a new random key and adds it to the exposed map.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-key-management-service/index.html b/docs/build/html/api/core.node.services/-key-management-service/index.html deleted file mode 100644 index ee299b9d74..0000000000 --- a/docs/build/html/api/core.node.services/-key-management-service/index.html +++ /dev/null @@ -1,62 +0,0 @@ - - -KeyManagementService - - - - -core.node.services / 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

- - - - - - - - - - - -
-freshKey -abstract fun freshKey(): KeyPair

Generates a new random key and adds it to the exposed map.

-
-toPrivate -open fun toPrivate(publicKey: PublicKey): PrivateKey
-

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.services/-key-management-service/keys.html b/docs/build/html/api/core.node.services/-key-management-service/keys.html deleted file mode 100644 index 6944eb52ee..0000000000 --- a/docs/build/html/api/core.node.services/-key-management-service/keys.html +++ /dev/null @@ -1,16 +0,0 @@ - - -KeyManagementService.keys - - - - -core.node.services / KeyManagementService / keys
-
-

keys

- -abstract val keys: Map<PublicKey, PrivateKey>
-

Returns a snapshot of the current pubkey->privkey mapping.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-key-management-service/to-private.html b/docs/build/html/api/core.node.services/-key-management-service/to-private.html deleted file mode 100644 index f79b61a396..0000000000 --- a/docs/build/html/api/core.node.services/-key-management-service/to-private.html +++ /dev/null @@ -1,15 +0,0 @@ - - -KeyManagementService.toPrivate - - - - -core.node.services / KeyManagementService / toPrivate
-
-

toPrivate

- -open fun toPrivate(publicKey: PublicKey): PrivateKey
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/-init-.html b/docs/build/html/api/core.node.services/-node-attachment-service/-init-.html deleted file mode 100644 index 970d3caa6a..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.<init> - - - - -core.node.services / NodeAttachmentService / <init>
-
-

<init>

-NodeAttachmentService(storePath: Path)
-

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/-node-attachment-service/-on-disk-hash-mismatch/-init-.html b/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/-init-.html deleted file mode 100644 index ac35735919..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch.<init> - - - - -core.node.services / NodeAttachmentService / OnDiskHashMismatch / <init>
-
-

<init>

-OnDiskHashMismatch(file: Path, actual: SecureHash)
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/actual.html b/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/actual.html deleted file mode 100644 index cdf98db116..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/actual.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch.actual - - - - -core.node.services / NodeAttachmentService / OnDiskHashMismatch / actual
-
-

actual

- -val actual: SecureHash
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/file.html b/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/file.html deleted file mode 100644 index 91ef8e9d8f..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/file.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch.file - - - - -core.node.services / NodeAttachmentService / OnDiskHashMismatch / file
-
-

file

- -val file: Path
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/index.html b/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/index.html deleted file mode 100644 index d4f8830675..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/index.html +++ /dev/null @@ -1,53 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch - - - - -core.node.services / NodeAttachmentService / OnDiskHashMismatch
-
-

OnDiskHashMismatch

-class OnDiskHashMismatch : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -OnDiskHashMismatch(file: Path, actual: SecureHash)
-

Properties

- - - - - - - - - - - -
-actual -val actual: SecureHash
-file -val file: Path
-

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 deleted file mode 100644 index 1216e5b38a..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch.toString - - - - -core.node.services / NodeAttachmentService / OnDiskHashMismatch / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/automatically-extract-attachments.html b/docs/build/html/api/core.node.services/-node-attachment-service/automatically-extract-attachments.html deleted file mode 100644 index e54d99170d..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/automatically-extract-attachments.html +++ /dev/null @@ -1,18 +0,0 @@ - - -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).

-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/check-attachments-on-load.html b/docs/build/html/api/core.node.services/-node-attachment-service/check-attachments-on-load.html deleted file mode 100644 index 0b2e54365a..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/check-attachments-on-load.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.checkAttachmentsOnLoad - - - - -core.node.services / NodeAttachmentService / checkAttachmentsOnLoad
-
-

checkAttachmentsOnLoad

- -var checkAttachmentsOnLoad: Boolean
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/import-attachment.html b/docs/build/html/api/core.node.services/-node-attachment-service/import-attachment.html deleted file mode 100644 index 68c1d0b6e4..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/import-attachment.html +++ /dev/null @@ -1,31 +0,0 @@ - - -NodeAttachmentService.importAttachment - - - - -core.node.services / NodeAttachmentService / importAttachment
-
-

importAttachment

- -fun importAttachment(jar: InputStream): SecureHash
-Overrides 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.
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/index.html b/docs/build/html/api/core.node.services/-node-attachment-service/index.html deleted file mode 100644 index 78d565b98c..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/index.html +++ /dev/null @@ -1,87 +0,0 @@ - - -NodeAttachmentService - - - - -core.node.services / NodeAttachmentService
-
-

NodeAttachmentService

-class NodeAttachmentService : AttachmentStorage
-

Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.

-
-
-

Exceptions

- - - - - - - -
-OnDiskHashMismatch -class OnDiskHashMismatch : Exception
-

Constructors

- - - - - - - -
-<init> -NodeAttachmentService(storePath: Path)

Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.

-
-

Properties

- - - - - - - - - - - - - - - -
-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
-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.

-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/open-attachment.html b/docs/build/html/api/core.node.services/-node-attachment-service/open-attachment.html deleted file mode 100644 index 49c09d80e1..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/open-attachment.html +++ /dev/null @@ -1,20 +0,0 @@ - - -NodeAttachmentService.openAttachment - - - - -core.node.services / NodeAttachmentService / openAttachment
-
-

openAttachment

- -fun openAttachment(id: SecureHash): Attachment?
-Overrides 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.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-attachment-service/store-path.html b/docs/build/html/api/core.node.services/-node-attachment-service/store-path.html deleted file mode 100644 index 65acbfe05d..0000000000 --- a/docs/build/html/api/core.node.services/-node-attachment-service/store-path.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.storePath - - - - -core.node.services / NodeAttachmentService / storePath
-
-

storePath

- -val storePath: Path
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-timestamper-service/-init-.html b/docs/build/html/api/core.node.services/-node-timestamper-service/-init-.html deleted file mode 100644 index 070a1e8ce8..0000000000 --- a/docs/build/html/api/core.node.services/-node-timestamper-service/-init-.html +++ /dev/null @@ -1,19 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-timestamper-service/-t-i-m-e-s-t-a-m-p-i-n-g_-p-r-o-t-o-c-o-l_-t-o-p-i-c.html b/docs/build/html/api/core.node.services/-node-timestamper-service/-t-i-m-e-s-t-a-m-p-i-n-g_-p-r-o-t-o-c-o-l_-t-o-p-i-c.html deleted file mode 100644 index ab2ea04343..0000000000 --- a/docs/build/html/api/core.node.services/-node-timestamper-service/-t-i-m-e-s-t-a-m-p-i-n-g_-p-r-o-t-o-c-o-l_-t-o-p-i-c.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.TIMESTAMPING_PROTOCOL_TOPIC - - - - -core.node.services / NodeTimestamperService / TIMESTAMPING_PROTOCOL_TOPIC
-
-

TIMESTAMPING_PROTOCOL_TOPIC

- -val TIMESTAMPING_PROTOCOL_TOPIC: String
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-timestamper-service/clock.html b/docs/build/html/api/core.node.services/-node-timestamper-service/clock.html deleted file mode 100644 index 90caf5fdef..0000000000 --- a/docs/build/html/api/core.node.services/-node-timestamper-service/clock.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.clock - - - - -core.node.services / NodeTimestamperService / clock
-
-

clock

- -val clock: Clock
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-timestamper-service/identity.html b/docs/build/html/api/core.node.services/-node-timestamper-service/identity.html deleted file mode 100644 index 13403b5f2a..0000000000 --- a/docs/build/html/api/core.node.services/-node-timestamper-service/identity.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.identity - - - - -core.node.services / NodeTimestamperService / identity
-
-

identity

- -val identity: Party
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-timestamper-service/index.html b/docs/build/html/api/core.node.services/-node-timestamper-service/index.html deleted file mode 100644 index 483594ea4f..0000000000 --- a/docs/build/html/api/core.node.services/-node-timestamper-service/index.html +++ /dev/null @@ -1,83 +0,0 @@ - - -NodeTimestamperService - - - - -core.node.services / NodeTimestamperService
-
-

NodeTimestamperService

-class 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.

-

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

- - - - - - - - - - - - - - - - - - - -
-clock -val clock: Clock
-identity -val identity: Party
-signingKey -val signingKey: KeyPair
-tolerance -val tolerance: Duration
-

Functions

- - - - - - - -
-processRequest -fun processRequest(req: Request): LegallyIdentifiable
-

Companion Object Properties

- - - - - - - -
-TIMESTAMPING_PROTOCOL_TOPIC -val TIMESTAMPING_PROTOCOL_TOPIC: String
- - 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 deleted file mode 100644 index e88ea19d2c..0000000000 --- a/docs/build/html/api/core.node.services/-node-timestamper-service/process-request.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.processRequest - - - - -core.node.services / NodeTimestamperService / processRequest
-
-

processRequest

- -fun processRequest(req: Request): LegallyIdentifiable
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-timestamper-service/signing-key.html b/docs/build/html/api/core.node.services/-node-timestamper-service/signing-key.html deleted file mode 100644 index 4dca551458..0000000000 --- a/docs/build/html/api/core.node.services/-node-timestamper-service/signing-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.signingKey - - - - -core.node.services / NodeTimestamperService / signingKey
-
-

signingKey

- -val signingKey: KeyPair
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-timestamper-service/tolerance.html b/docs/build/html/api/core.node.services/-node-timestamper-service/tolerance.html deleted file mode 100644 index 11ba2cde5e..0000000000 --- a/docs/build/html/api/core.node.services/-node-timestamper-service/tolerance.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.tolerance - - - - -core.node.services / NodeTimestamperService / tolerance
-
-

tolerance

- -val tolerance: Duration
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-wallet-service/-init-.html b/docs/build/html/api/core.node.services/-node-wallet-service/-init-.html deleted file mode 100644 index 69463cb011..0000000000 --- a/docs/build/html/api/core.node.services/-node-wallet-service/-init-.html +++ /dev/null @@ -1,17 +0,0 @@ - - -NodeWalletService.<init> - - - - -core.node.services / 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.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-wallet-service/cash-balances.html b/docs/build/html/api/core.node.services/-node-wallet-service/cash-balances.html deleted file mode 100644 index 64d116c4f3..0000000000 --- a/docs/build/html/api/core.node.services/-node-wallet-service/cash-balances.html +++ /dev/null @@ -1,22 +0,0 @@ - - -NodeWalletService.cashBalances - - - - -core.node.services / NodeWalletService / cashBalances
-
-

cashBalances

- -val cashBalances: Map<Currency, Amount>
-Overrides 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.

-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-wallet-service/current-wallet.html b/docs/build/html/api/core.node.services/-node-wallet-service/current-wallet.html deleted file mode 100644 index 759362f86d..0000000000 --- a/docs/build/html/api/core.node.services/-node-wallet-service/current-wallet.html +++ /dev/null @@ -1,22 +0,0 @@ - - -NodeWalletService.currentWallet - - - - -core.node.services / NodeWalletService / currentWallet
-
-

currentWallet

- -val currentWallet: Wallet
-Overrides 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.

-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-wallet-service/fill-with-some-test-cash.html b/docs/build/html/api/core.node.services/-node-wallet-service/fill-with-some-test-cash.html deleted file mode 100644 index 7712b27d95..0000000000 --- a/docs/build/html/api/core.node.services/-node-wallet-service/fill-with-some-test-cash.html +++ /dev/null @@ -1,23 +0,0 @@ - - -NodeWalletService.fillWithSomeTestCash - - - - -core.node.services / NodeWalletService / fillWithSomeTestCash
-
-

fillWithSomeTestCash

- -fun fillWithSomeTestCash(howMuch: Amount, atLeastThisManyStates: Int = 3, atMostThisManyStates: Int = 10, rng: Random = Random()): Wallet
-

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

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-node-wallet-service/index.html b/docs/build/html/api/core.node.services/-node-wallet-service/index.html deleted file mode 100644 index 2b7ef8ebf2..0000000000 --- a/docs/build/html/api/core.node.services/-node-wallet-service/index.html +++ /dev/null @@ -1,85 +0,0 @@ - - -NodeWalletService - - - - -core.node.services / 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.

-
-

Functions

- - - - - - - - - - - -
-fillWithSomeTestCash -fun fillWithSomeTestCash(howMuch: Amount, atLeastThisManyStates: Int = 3, atMostThisManyStates: Int = 10, rng: Random = Random()): Wallet

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

- - - - - - - -
-notify -open fun notify(tx: WireTransaction): Wallet

Same as notifyAll but with a single transaction.

-
- - diff --git a/docs/build/html/api/core.node.services/-node-wallet-service/notify-all.html b/docs/build/html/api/core.node.services/-node-wallet-service/notify-all.html deleted file mode 100644 index 54edc6af68..0000000000 --- a/docs/build/html/api/core.node.services/-node-wallet-service/notify-all.html +++ /dev/null @@ -1,22 +0,0 @@ - - -NodeWalletService.notifyAll - - - - -core.node.services / NodeWalletService / notifyAll
-
-

notifyAll

- -fun notifyAll(txns: Iterable<WireTransaction>): Wallet
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-service-hub/identity-service.html b/docs/build/html/api/core.node.services/-service-hub/identity-service.html deleted file mode 100644 index e6a28b8c98..0000000000 --- a/docs/build/html/api/core.node.services/-service-hub/identity-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.identityService - - - - -core.node.services / ServiceHub / identityService
-
-

identityService

- -abstract val identityService: IdentityService
-
-
- - diff --git a/docs/build/html/api/core.node.services/-service-hub/index.html b/docs/build/html/api/core.node.services/-service-hub/index.html deleted file mode 100644 index 3b90159d45..0000000000 --- a/docs/build/html/api/core.node.services/-service-hub/index.html +++ /dev/null @@ -1,72 +0,0 @@ - - -ServiceHub - - - - -core.node.services / 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

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-identityService -abstract val identityService: IdentityService
-keyManagementService -abstract val keyManagementService: KeyManagementService
-networkMapService -abstract val networkMapService: NetworkMap
-networkService -abstract val networkService: MessagingService
-storageService -abstract val storageService: StorageService
-walletService -abstract val walletService: WalletService
-

Functions

- - - - - - - -
-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 SignedTransactions the DB gives back into LedgerTransactions, and then runs the smart contracts for the -transaction. If no exception is thrown, the transaction is valid.

-
- - diff --git a/docs/build/html/api/core.node.services/-service-hub/key-management-service.html b/docs/build/html/api/core.node.services/-service-hub/key-management-service.html deleted file mode 100644 index 3c3b348885..0000000000 --- a/docs/build/html/api/core.node.services/-service-hub/key-management-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.keyManagementService - - - - -core.node.services / ServiceHub / keyManagementService
-
-

keyManagementService

- -abstract val keyManagementService: KeyManagementService
-
-
- - diff --git a/docs/build/html/api/core.node.services/-service-hub/network-map-service.html b/docs/build/html/api/core.node.services/-service-hub/network-map-service.html deleted file mode 100644 index ff42efb28d..0000000000 --- a/docs/build/html/api/core.node.services/-service-hub/network-map-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.networkMapService - - - - -core.node.services / ServiceHub / networkMapService
-
-

networkMapService

- -abstract val networkMapService: NetworkMap
-
-
- - diff --git a/docs/build/html/api/core.node.services/-service-hub/network-service.html b/docs/build/html/api/core.node.services/-service-hub/network-service.html deleted file mode 100644 index c16904f759..0000000000 --- a/docs/build/html/api/core.node.services/-service-hub/network-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.networkService - - - - -core.node.services / ServiceHub / networkService
-
-

networkService

- -abstract val networkService: MessagingService
-
-
- - diff --git a/docs/build/html/api/core.node.services/-service-hub/storage-service.html b/docs/build/html/api/core.node.services/-service-hub/storage-service.html deleted file mode 100644 index 9a388ede2a..0000000000 --- a/docs/build/html/api/core.node.services/-service-hub/storage-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.storageService - - - - -core.node.services / ServiceHub / storageService
-
-

storageService

- -abstract val storageService: StorageService
-
-
- - diff --git a/docs/build/html/api/core.node.services/-service-hub/verify-transaction.html b/docs/build/html/api/core.node.services/-service-hub/verify-transaction.html deleted file mode 100644 index 29057a0f02..0000000000 --- a/docs/build/html/api/core.node.services/-service-hub/verify-transaction.html +++ /dev/null @@ -1,18 +0,0 @@ - - -ServiceHub.verifyTransaction - - - - -core.node.services / 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 SignedTransactions the DB gives back into LedgerTransactions, and then runs the smart contracts for the -transaction. If no exception is thrown, the transaction is valid.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-service-hub/wallet-service.html b/docs/build/html/api/core.node.services/-service-hub/wallet-service.html deleted file mode 100644 index 28b8c3d578..0000000000 --- a/docs/build/html/api/core.node.services/-service-hub/wallet-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.walletService - - - - -core.node.services / ServiceHub / walletService
-
-

walletService

- -abstract val walletService: WalletService
-
-
- - diff --git a/docs/build/html/api/core.node.services/-storage-service/attachments.html b/docs/build/html/api/core.node.services/-storage-service/attachments.html deleted file mode 100644 index 8623958b01..0000000000 --- a/docs/build/html/api/core.node.services/-storage-service/attachments.html +++ /dev/null @@ -1,16 +0,0 @@ - - -StorageService.attachments - - - - -core.node.services / StorageService / attachments
-
-

attachments

- -abstract val attachments: AttachmentStorage
-

Provides access to storage of arbitrary JAR files (which may contain only data, no code).

-
-
- - diff --git a/docs/build/html/api/core.node.services/-storage-service/contract-programs.html b/docs/build/html/api/core.node.services/-storage-service/contract-programs.html deleted file mode 100644 index c15e0e667f..0000000000 --- a/docs/build/html/api/core.node.services/-storage-service/contract-programs.html +++ /dev/null @@ -1,16 +0,0 @@ - - -StorageService.contractPrograms - - - - -core.node.services / StorageService / contractPrograms
-
-

contractPrograms

- -abstract val contractPrograms: ContractFactory
-

A map of program hash->contract class type, used for verification.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-storage-service/get-map.html b/docs/build/html/api/core.node.services/-storage-service/get-map.html deleted file mode 100644 index 529d3f099a..0000000000 --- a/docs/build/html/api/core.node.services/-storage-service/get-map.html +++ /dev/null @@ -1,16 +0,0 @@ - - -StorageService.getMap - - - - -core.node.services / StorageService / getMap
-
-

getMap

- -abstract fun <K, V> getMap(tableName: String): MutableMap<K, V>
-

TODO: Temp scaffolding that will go away eventually.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-storage-service/index.html b/docs/build/html/api/core.node.services/-storage-service/index.html deleted file mode 100644 index abeeb6a838..0000000000 --- a/docs/build/html/api/core.node.services/-storage-service/index.html +++ /dev/null @@ -1,82 +0,0 @@ - - -StorageService - - - - -core.node.services / 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).

-
-contractPrograms -abstract val contractPrograms: ContractFactory

A map of program hash->contract class type, used for verification.

-
-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
-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.

-
-

Functions

- - - - - - - -
-getMap -abstract fun <K, V> getMap(tableName: String): MutableMap<K, V>

TODO: Temp scaffolding that will go away eventually.

-
-

Inheritors

- - - - - - - -
-StorageServiceImpl -open inner class StorageServiceImpl : StorageService
- - diff --git a/docs/build/html/api/core.node.services/-storage-service/my-legal-identity-key.html b/docs/build/html/api/core.node.services/-storage-service/my-legal-identity-key.html deleted file mode 100644 index b43c442672..0000000000 --- a/docs/build/html/api/core.node.services/-storage-service/my-legal-identity-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StorageService.myLegalIdentityKey - - - - -core.node.services / StorageService / myLegalIdentityKey
-
-

myLegalIdentityKey

- -abstract val myLegalIdentityKey: KeyPair
-
-
- - diff --git a/docs/build/html/api/core.node.services/-storage-service/my-legal-identity.html b/docs/build/html/api/core.node.services/-storage-service/my-legal-identity.html deleted file mode 100644 index ea5d10e020..0000000000 --- a/docs/build/html/api/core.node.services/-storage-service/my-legal-identity.html +++ /dev/null @@ -1,17 +0,0 @@ - - -StorageService.myLegalIdentity - - - - -core.node.services / 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.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-storage-service/validated-transactions.html b/docs/build/html/api/core.node.services/-storage-service/validated-transactions.html deleted file mode 100644 index 2c13c6e566..0000000000 --- a/docs/build/html/api/core.node.services/-storage-service/validated-transactions.html +++ /dev/null @@ -1,18 +0,0 @@ - - -StorageService.validatedTransactions - - - - -core.node.services / 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.

-
-
- - 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 deleted file mode 100644 index 3c861673b6..0000000000 --- a/docs/build/html/api/core.node.services/-timestamper-service/identity.html +++ /dev/null @@ -1,16 +0,0 @@ - - -TimestamperService.identity - - - - -core.node.services / TimestamperService / identity
-
-

identity

- -abstract val identity: Party
-

The name+pubkey that this timestamper will sign with.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-timestamper-service/index.html b/docs/build/html/api/core.node.services/-timestamper-service/index.html deleted file mode 100644 index 5c86115195..0000000000 --- a/docs/build/html/api/core.node.services/-timestamper-service/index.html +++ /dev/null @@ -1,53 +0,0 @@ - - -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.

-
-
-

Properties

- - - - - - - -
-identity -abstract val identity: Party

The name+pubkey that this timestamper will sign with.

-
-

Functions

- - - - - - - -
-timestamp -abstract fun timestamp(wtxBytes: SerializedBytes<WireTransaction>): LegallyIdentifiable
-

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 deleted file mode 100644 index 5a861dd890..0000000000 --- a/docs/build/html/api/core.node.services/-timestamper-service/timestamp.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestamperService.timestamp - - - - -core.node.services / TimestamperService / timestamp
-
-

timestamp

- -abstract fun timestamp(wtxBytes: SerializedBytes<WireTransaction>): LegallyIdentifiable
-
-
- - diff --git a/docs/build/html/api/core.node.services/-timestamping-error/-not-for-me/-init-.html b/docs/build/html/api/core.node.services/-timestamping-error/-not-for-me/-init-.html deleted file mode 100644 index de3ee1ef7a..0000000000 --- a/docs/build/html/api/core.node.services/-timestamping-error/-not-for-me/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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

-
-
- - diff --git a/docs/build/html/api/core.node.services/-timestamping-error/-not-for-me/index.html b/docs/build/html/api/core.node.services/-timestamping-error/-not-for-me/index.html deleted file mode 100644 index 45cb733153..0000000000 --- a/docs/build/html/api/core.node.services/-timestamping-error/-not-for-me/index.html +++ /dev/null @@ -1,27 +0,0 @@ - - -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 deleted file mode 100644 index 283afe7aa9..0000000000 --- a/docs/build/html/api/core.node.services/-timestamping-error/-not-on-time-exception/-init-.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-timestamping-error/-not-on-time-exception/index.html b/docs/build/html/api/core.node.services/-timestamping-error/-not-on-time-exception/index.html deleted file mode 100644 index 7808752072..0000000000 --- a/docs/build/html/api/core.node.services/-timestamping-error/-not-on-time-exception/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index 485b64f464..0000000000 --- a/docs/build/html/api/core.node.services/-timestamping-error/-requires-exactly-one-command/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TimestampingError.RequiresExactlyOneCommand.<init> - - - - -core.node.services / TimestampingError / RequiresExactlyOneCommand / <init>
-
-

<init>

-RequiresExactlyOneCommand()
-
-
- - diff --git a/docs/build/html/api/core.node.services/-timestamping-error/-requires-exactly-one-command/index.html b/docs/build/html/api/core.node.services/-timestamping-error/-requires-exactly-one-command/index.html deleted file mode 100644 index 71c7fed21f..0000000000 --- a/docs/build/html/api/core.node.services/-timestamping-error/-requires-exactly-one-command/index.html +++ /dev/null @@ -1,25 +0,0 @@ - - -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 deleted file mode 100644 index 53b2b37e68..0000000000 --- a/docs/build/html/api/core.node.services/-timestamping-error/index.html +++ /dev/null @@ -1,68 +0,0 @@ - - -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/-wallet-service/cash-balances.html b/docs/build/html/api/core.node.services/-wallet-service/cash-balances.html deleted file mode 100644 index 16ecf8f998..0000000000 --- a/docs/build/html/api/core.node.services/-wallet-service/cash-balances.html +++ /dev/null @@ -1,17 +0,0 @@ - - -WalletService.cashBalances - - - - -core.node.services / 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.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-wallet-service/current-wallet.html b/docs/build/html/api/core.node.services/-wallet-service/current-wallet.html deleted file mode 100644 index 618b7d1cfc..0000000000 --- a/docs/build/html/api/core.node.services/-wallet-service/current-wallet.html +++ /dev/null @@ -1,17 +0,0 @@ - - -WalletService.currentWallet - - - - -core.node.services / 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.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-wallet-service/index.html b/docs/build/html/api/core.node.services/-wallet-service/index.html deleted file mode 100644 index 0313a9bd29..0000000000 --- a/docs/build/html/api/core.node.services/-wallet-service/index.html +++ /dev/null @@ -1,73 +0,0 @@ - - -WalletService - - - - -core.node.services / 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.

-
-

Functions

- - - - - - - - - - - -
-notify -open fun notify(tx: WireTransaction): Wallet

Same as notifyAll but with a single transaction.

-
-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

-
-

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.services/-wallet-service/notify-all.html b/docs/build/html/api/core.node.services/-wallet-service/notify-all.html deleted file mode 100644 index f2987ff121..0000000000 --- a/docs/build/html/api/core.node.services/-wallet-service/notify-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - -WalletService.notifyAll - - - - -core.node.services / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.services/-wallet-service/notify.html b/docs/build/html/api/core.node.services/-wallet-service/notify.html deleted file mode 100644 index b032db5b38..0000000000 --- a/docs/build/html/api/core.node.services/-wallet-service/notify.html +++ /dev/null @@ -1,16 +0,0 @@ - - -WalletService.notify - - - - -core.node.services / WalletService / notify
-
-

notify

- -open fun notify(tx: WireTransaction): Wallet
-

Same as notifyAll but with a single transaction.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-wallet/-init-.html b/docs/build/html/api/core.node.services/-wallet/-init-.html deleted file mode 100644 index bd47945617..0000000000 --- a/docs/build/html/api/core.node.services/-wallet/-init-.html +++ /dev/null @@ -1,18 +0,0 @@ - - -Wallet.<init> - - - - -core.node.services / Wallet / <init>
-
-

<init>

-Wallet(states: List<StateAndRef<OwnableState>>)
-

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.

-
-
- - diff --git a/docs/build/html/api/core.node.services/-wallet/index.html b/docs/build/html/api/core.node.services/-wallet/index.html deleted file mode 100644 index 4a96039a8b..0000000000 --- a/docs/build/html/api/core.node.services/-wallet/index.html +++ /dev/null @@ -1,55 +0,0 @@ - - -Wallet - - - - -core.node.services / 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<OwnableState>>)

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

- - - - - - - -
-states -val states: List<StateAndRef<OwnableState>>
-

Functions

- - - - - - - -
-statesOfType -fun <T : OwnableState> statesOfType(): List<StateAndRef<T>>
- - diff --git a/docs/build/html/api/core.node.services/-wallet/states-of-type.html b/docs/build/html/api/core.node.services/-wallet/states-of-type.html deleted file mode 100644 index 985e2436a7..0000000000 --- a/docs/build/html/api/core.node.services/-wallet/states-of-type.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Wallet.statesOfType - - - - -core.node.services / Wallet / statesOfType
-
-

statesOfType

- -inline fun <reified T : OwnableState> statesOfType(): List<StateAndRef<T>>
-
-
- - diff --git a/docs/build/html/api/core.node.services/-wallet/states.html b/docs/build/html/api/core.node.services/-wallet/states.html deleted file mode 100644 index 82bea35049..0000000000 --- a/docs/build/html/api/core.node.services/-wallet/states.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Wallet.states - - - - -core.node.services / Wallet / states
-
-

states

- -val states: List<StateAndRef<OwnableState>>
-
-
- - diff --git a/docs/build/html/api/core.node.services/index.html b/docs/build/html/api/core.node.services/index.html deleted file mode 100644 index 4c74f978bc..0000000000 --- a/docs/build/html/api/core.node.services/index.html +++ /dev/null @@ -1,163 +0,0 @@ - - -core.node.services - - - - -core.node.services
-
-

Package core.node.services

-

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.

-
-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

-
-DataVendingService -class 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.

-
-DummyTimestampingAuthority -object DummyTimestampingAuthority
-E2ETestKeyManagementService -class E2ETestKeyManagementService : KeyManagementService

A simple in-memory KMS that doesnt bother saving keys to disk. A real implementation would:

-
-FixedIdentityService -class FixedIdentityService : IdentityService

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-IdentityService -interface IdentityService

An identity service maintains an bidirectional map of Partys 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.

-
-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.

-
-NodeAttachmentService -class NodeAttachmentService : AttachmentStorage

Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.

-
-NodeTimestamperService -class 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.

-
-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.

-
-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.

-
-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.

-
-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.

-
-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

- - - - - - - -
-TimestampingError -sealed class TimestampingError : Exception
- - 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 deleted file mode 100644 index 0b82f0af72..0000000000 --- a/docs/build/html/api/core.node.servlets/-attachment-download-servlet/-init-.html +++ /dev/null @@ -1,22 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.node.servlets/-attachment-download-servlet/do-get.html b/docs/build/html/api/core.node.servlets/-attachment-download-servlet/do-get.html deleted file mode 100644 index 04e6cc252f..0000000000 --- a/docs/build/html/api/core.node.servlets/-attachment-download-servlet/do-get.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AttachmentDownloadServlet.doGet - - - - -core.node.servlets / AttachmentDownloadServlet / doGet
-
-

doGet

- -fun doGet(req: <ERROR CLASS>, resp: <ERROR CLASS>): Unit
-
-
- - diff --git a/docs/build/html/api/core.node.servlets/-attachment-download-servlet/index.html b/docs/build/html/api/core.node.servlets/-attachment-download-servlet/index.html deleted file mode 100644 index 4e8050ed7c..0000000000 --- a/docs/build/html/api/core.node.servlets/-attachment-download-servlet/index.html +++ /dev/null @@ -1,45 +0,0 @@ - - -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/-attachment-upload-servlet/-init-.html b/docs/build/html/api/core.node.servlets/-attachment-upload-servlet/-init-.html deleted file mode 100644 index 1c0f931540..0000000000 --- a/docs/build/html/api/core.node.servlets/-attachment-upload-servlet/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -AttachmentUploadServlet.<init> - - - - -core.node.servlets / AttachmentUploadServlet / <init>
-
-

<init>

-AttachmentUploadServlet()
-
-
- - diff --git a/docs/build/html/api/core.node.servlets/-attachment-upload-servlet/do-post.html b/docs/build/html/api/core.node.servlets/-attachment-upload-servlet/do-post.html deleted file mode 100644 index a85087d9eb..0000000000 --- a/docs/build/html/api/core.node.servlets/-attachment-upload-servlet/do-post.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AttachmentUploadServlet.doPost - - - - -core.node.servlets / AttachmentUploadServlet / doPost
-
-

doPost

- -fun doPost(req: <ERROR CLASS>, resp: <ERROR CLASS>): Unit
-
-
- - diff --git a/docs/build/html/api/core.node.servlets/-attachment-upload-servlet/index.html b/docs/build/html/api/core.node.servlets/-attachment-upload-servlet/index.html deleted file mode 100644 index c852e4d0b9..0000000000 --- a/docs/build/html/api/core.node.servlets/-attachment-upload-servlet/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -AttachmentUploadServlet - - - - -core.node.servlets / AttachmentUploadServlet
-
-

AttachmentUploadServlet

-class AttachmentUploadServlet
-
-
-

Constructors

- - - - - - - -
-<init> -AttachmentUploadServlet()
-

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 deleted file mode 100644 index f7ffe875ea..0000000000 --- a/docs/build/html/api/core.node.servlets/index.html +++ /dev/null @@ -1,29 +0,0 @@ - - -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.

-
-AttachmentUploadServlet -class AttachmentUploadServlet
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-init-.html b/docs/build/html/api/core.node/-abstract-node/-init-.html deleted file mode 100644 index 375ad810d6..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -AbstractNode.<init> - - - - -core.node / AbstractNode / <init>
-
-

<init>

-AbstractNode(dir: Path, configuration: NodeConfiguration, timestamperAddress: LegallyIdentifiableNode?)
-

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.

-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-p-r-i-v-a-t-e_-k-e-y_-f-i-l-e_-n-a-m-e.html b/docs/build/html/api/core.node/-abstract-node/-p-r-i-v-a-t-e_-k-e-y_-f-i-l-e_-n-a-m-e.html deleted file mode 100644 index bd8f3475a8..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-p-r-i-v-a-t-e_-k-e-y_-f-i-l-e_-n-a-m-e.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.PRIVATE_KEY_FILE_NAME - - - - -core.node / AbstractNode / PRIVATE_KEY_FILE_NAME
-
-

PRIVATE_KEY_FILE_NAME

- -val PRIVATE_KEY_FILE_NAME: String
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-p-u-b-l-i-c_-i-d-e-n-t-i-t-y_-f-i-l-e_-n-a-m-e.html b/docs/build/html/api/core.node/-abstract-node/-p-u-b-l-i-c_-i-d-e-n-t-i-t-y_-f-i-l-e_-n-a-m-e.html deleted file mode 100644 index 10f31803f8..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-p-u-b-l-i-c_-i-d-e-n-t-i-t-y_-f-i-l-e_-n-a-m-e.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.PUBLIC_IDENTITY_FILE_NAME - - - - -core.node / AbstractNode / PUBLIC_IDENTITY_FILE_NAME
-
-

PUBLIC_IDENTITY_FILE_NAME

- -val PUBLIC_IDENTITY_FILE_NAME: String
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/-init-.html b/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/-init-.html deleted file mode 100644 index 752acaa5df..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -AbstractNode.StorageServiceImpl.<init> - - - - -core.node / AbstractNode / StorageServiceImpl / <init>
-
-

<init>

-StorageServiceImpl(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair)
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/attachments.html b/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/attachments.html deleted file mode 100644 index aa5bc7ae15..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/attachments.html +++ /dev/null @@ -1,17 +0,0 @@ - - -AbstractNode.StorageServiceImpl.attachments - - - - -core.node / AbstractNode / StorageServiceImpl / attachments
-
-

attachments

- -open val attachments: AttachmentStorage
-Overrides StorageService.attachments
-

Provides access to storage of arbitrary JAR files (which may contain only data, no code).

-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/contract-programs.html b/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/contract-programs.html deleted file mode 100644 index 4c11f02b93..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/contract-programs.html +++ /dev/null @@ -1,17 +0,0 @@ - - -AbstractNode.StorageServiceImpl.contractPrograms - - - - -core.node / AbstractNode / StorageServiceImpl / contractPrograms
-
-

contractPrograms

- -open val contractPrograms: ContractFactory
-Overrides StorageService.contractPrograms
-

A map of program hash->contract class type, used for verification.

-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/get-map.html b/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/get-map.html deleted file mode 100644 index d69002e9e6..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/get-map.html +++ /dev/null @@ -1,17 +0,0 @@ - - -AbstractNode.StorageServiceImpl.getMap - - - - -core.node / AbstractNode / StorageServiceImpl / getMap
-
-

getMap

- -open fun <K, V> getMap(tableName: String): MutableMap<K, V>
-Overrides StorageService.getMap
-

TODO: Temp scaffolding that will go away eventually.

-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/index.html b/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/index.html deleted file mode 100644 index c7b346a3c3..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/index.html +++ /dev/null @@ -1,85 +0,0 @@ - - -AbstractNode.StorageServiceImpl - - - - -core.node / AbstractNode / StorageServiceImpl
-
-

StorageServiceImpl

-open inner class StorageServiceImpl : StorageService
-
-
-

Constructors

- - - - - - - -
-<init> -StorageServiceImpl(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair)
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-attachments -open val attachments: AttachmentStorage

Provides access to storage of arbitrary JAR files (which may contain only data, no code).

-
-contractPrograms -open val contractPrograms: ContractFactory

A map of program hash->contract class type, used for verification.

-
-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
-tables -val tables: HashMap<String, MutableMap<Any, Any>>
-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.

-
-

Functions

- - - - - - - -
-getMap -open fun <K, V> getMap(tableName: String): MutableMap<K, V>

TODO: Temp scaffolding that will go away eventually.

-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/my-legal-identity-key.html b/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/my-legal-identity-key.html deleted file mode 100644 index d2e5cf9a24..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/my-legal-identity-key.html +++ /dev/null @@ -1,16 +0,0 @@ - - -AbstractNode.StorageServiceImpl.myLegalIdentityKey - - - - -core.node / AbstractNode / StorageServiceImpl / myLegalIdentityKey
-
-

myLegalIdentityKey

- -open val myLegalIdentityKey: KeyPair
-Overrides StorageService.myLegalIdentityKey
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/my-legal-identity.html b/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/my-legal-identity.html deleted file mode 100644 index ef3a848403..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/my-legal-identity.html +++ /dev/null @@ -1,18 +0,0 @@ - - -AbstractNode.StorageServiceImpl.myLegalIdentity - - - - -core.node / AbstractNode / StorageServiceImpl / myLegalIdentity
-
-

myLegalIdentity

- -open val myLegalIdentity: Party
-Overrides StorageService.myLegalIdentity
-

Returns the legal identity that this node is configured with. Assumed to be initialised when the node is -first installed.

-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/tables.html b/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/tables.html deleted file mode 100644 index 4bb9bfa14b..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/tables.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.StorageServiceImpl.tables - - - - -core.node / AbstractNode / StorageServiceImpl / tables
-
-

tables

- -protected val tables: HashMap<String, MutableMap<Any, Any>>
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/validated-transactions.html b/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/validated-transactions.html deleted file mode 100644 index 387c7f4b11..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/-storage-service-impl/validated-transactions.html +++ /dev/null @@ -1,24 +0,0 @@ - - -AbstractNode.StorageServiceImpl.validatedTransactions - - - - -core.node / AbstractNode / StorageServiceImpl / validatedTransactions
-
-

validatedTransactions

- -open val validatedTransactions: MutableMap<SecureHash, SignedTransaction>
-Overrides 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.

-
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/configuration.html b/docs/build/html/api/core.node/-abstract-node/configuration.html deleted file mode 100644 index 769502f9b9..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/configuration.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.configuration - - - - -core.node / AbstractNode / configuration
-
-

configuration

- -val configuration: NodeConfiguration
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/construct-storage-service.html b/docs/build/html/api/core.node/-abstract-node/construct-storage-service.html deleted file mode 100644 index ed307e3ffa..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/construct-storage-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.constructStorageService - - - - -core.node / AbstractNode / constructStorageService
-
-

constructStorageService

- -protected open fun constructStorageService(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair): StorageServiceImpl
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/contract-factory.html b/docs/build/html/api/core.node/-abstract-node/contract-factory.html deleted file mode 100644 index a7e28233de..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/contract-factory.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.contractFactory - - - - -core.node / AbstractNode / contractFactory
-
-

contractFactory

- -protected val contractFactory: ContractFactory
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/dir.html b/docs/build/html/api/core.node/-abstract-node/dir.html deleted file mode 100644 index 418f2aaf09..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/dir.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.dir - - - - -core.node / AbstractNode / dir
-
-

dir

- -val dir: Path
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/identity.html b/docs/build/html/api/core.node/-abstract-node/identity.html deleted file mode 100644 index 686c3fa385..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/identity.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.identity - - - - -core.node / AbstractNode / identity
-
-

identity

- -lateinit var identity: IdentityService
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/in-node-timestamping-service.html b/docs/build/html/api/core.node/-abstract-node/in-node-timestamping-service.html deleted file mode 100644 index 717307dd29..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/in-node-timestamping-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.inNodeTimestampingService - - - - -core.node / AbstractNode / inNodeTimestampingService
-
-

inNodeTimestampingService

- -var inNodeTimestampingService: NodeTimestamperService?
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/index.html b/docs/build/html/api/core.node/-abstract-node/index.html deleted file mode 100644 index 31cafeb1b2..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/index.html +++ /dev/null @@ -1,206 +0,0 @@ - - -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.

-
-
-

Types

- - - - - - - -
-StorageServiceImpl -open inner class StorageServiceImpl : StorageService
-

Constructors

- - - - - - - -
-<init> -AbstractNode(dir: Path, configuration: NodeConfiguration, timestamperAddress: LegallyIdentifiableNode?)

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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-configuration -val configuration: NodeConfiguration
-contractFactory -val contractFactory: ContractFactory
-dir -val dir: Path
-identity -lateinit var identity: IdentityService
-inNodeTimestampingService -var inNodeTimestampingService: NodeTimestamperService?
-keyManagement -lateinit var keyManagement: E2ETestKeyManagementService
-legallyIdentifableAddress -val legallyIdentifableAddress: LegallyIdentifiableNode
-log -abstract val log: <ERROR CLASS>
-net -lateinit var net: MessagingService
-serverThread -open val serverThread: ExecutorService
-services -val services: ServiceHub
-smm -lateinit var smm: StateMachineManager
-storage -lateinit var storage: StorageService
-timestamperAddress -val timestamperAddress: LegallyIdentifiableNode?
-wallet -lateinit var wallet: WalletService
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-constructStorageService -open fun constructStorageService(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair): StorageServiceImpl
-initialiseStorageService -open fun initialiseStorageService(dir: Path): StorageService
-makeIdentityService -open fun makeIdentityService(): IdentityService
-makeMessagingService -abstract fun makeMessagingService(): MessagingService
-start -open fun start(): AbstractNode
-stop -open fun stop(): Unit
-

Companion Object Properties

- - - - - - - - - - - -
-PRIVATE_KEY_FILE_NAME -val PRIVATE_KEY_FILE_NAME: String
-PUBLIC_IDENTITY_FILE_NAME -val PUBLIC_IDENTITY_FILE_NAME: String
-

Inheritors

- - - - - - - -
-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/initialise-storage-service.html b/docs/build/html/api/core.node/-abstract-node/initialise-storage-service.html deleted file mode 100644 index 9a2d02d3d5..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/initialise-storage-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.initialiseStorageService - - - - -core.node / AbstractNode / initialiseStorageService
-
-

initialiseStorageService

- -protected open fun initialiseStorageService(dir: Path): StorageService
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/key-management.html b/docs/build/html/api/core.node/-abstract-node/key-management.html deleted file mode 100644 index 4524526eab..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/key-management.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.keyManagement - - - - -core.node / AbstractNode / keyManagement
-
-

keyManagement

- -lateinit var keyManagement: E2ETestKeyManagementService
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/legally-identifable-address.html b/docs/build/html/api/core.node/-abstract-node/legally-identifable-address.html deleted file mode 100644 index be782a0e51..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/legally-identifable-address.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.legallyIdentifableAddress - - - - -core.node / AbstractNode / legallyIdentifableAddress
-
-

legallyIdentifableAddress

- -val legallyIdentifableAddress: LegallyIdentifiableNode
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/log.html b/docs/build/html/api/core.node/-abstract-node/log.html deleted file mode 100644 index dfda462656..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/log.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.log - - - - -core.node / AbstractNode / log
-
-

log

- -protected abstract val log: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/make-identity-service.html b/docs/build/html/api/core.node/-abstract-node/make-identity-service.html deleted file mode 100644 index dc6436503c..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/make-identity-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.makeIdentityService - - - - -core.node / AbstractNode / makeIdentityService
-
-

makeIdentityService

- -protected open fun makeIdentityService(): IdentityService
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/make-messaging-service.html b/docs/build/html/api/core.node/-abstract-node/make-messaging-service.html deleted file mode 100644 index 462ad95146..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/make-messaging-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.makeMessagingService - - - - -core.node / AbstractNode / makeMessagingService
-
-

makeMessagingService

- -protected abstract fun makeMessagingService(): MessagingService
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/net.html b/docs/build/html/api/core.node/-abstract-node/net.html deleted file mode 100644 index 1a16b40ba0..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/net.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.net - - - - -core.node / AbstractNode / net
-
-

net

- -lateinit var net: MessagingService
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/server-thread.html b/docs/build/html/api/core.node/-abstract-node/server-thread.html deleted file mode 100644 index bd134f45e0..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/server-thread.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.serverThread - - - - -core.node / AbstractNode / serverThread
-
-

serverThread

- -protected open val serverThread: ExecutorService
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/services.html b/docs/build/html/api/core.node/-abstract-node/services.html deleted file mode 100644 index f158bd9ced..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/services.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.services - - - - -core.node / AbstractNode / services
-
-

services

- -val services: ServiceHub
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/smm.html b/docs/build/html/api/core.node/-abstract-node/smm.html deleted file mode 100644 index e0b11eeb35..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/smm.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.smm - - - - -core.node / AbstractNode / smm
-
-

smm

- -lateinit var smm: StateMachineManager
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/start.html b/docs/build/html/api/core.node/-abstract-node/start.html deleted file mode 100644 index 55ab8d4bf2..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/start.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.start - - - - -core.node / AbstractNode / start
-
-

start

- -open fun start(): AbstractNode
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/stop.html b/docs/build/html/api/core.node/-abstract-node/stop.html deleted file mode 100644 index 56c931528c..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/stop.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.stop - - - - -core.node / AbstractNode / stop
-
-

stop

- -open fun stop(): Unit
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/storage.html b/docs/build/html/api/core.node/-abstract-node/storage.html deleted file mode 100644 index 95b21b1d4b..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/storage.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.storage - - - - -core.node / AbstractNode / storage
-
-

storage

- -lateinit var storage: StorageService
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/timestamper-address.html b/docs/build/html/api/core.node/-abstract-node/timestamper-address.html deleted file mode 100644 index 1f4ed8adbd..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/timestamper-address.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.timestamperAddress - - - - -core.node / AbstractNode / timestamperAddress
-
-

timestamperAddress

- -val timestamperAddress: LegallyIdentifiableNode?
-
-
- - diff --git a/docs/build/html/api/core.node/-abstract-node/wallet.html b/docs/build/html/api/core.node/-abstract-node/wallet.html deleted file mode 100644 index 2e5a4340b0..0000000000 --- a/docs/build/html/api/core.node/-abstract-node/wallet.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.wallet - - - - -core.node / AbstractNode / wallet
-
-

wallet

- -lateinit var wallet: WalletService
-
-
- - diff --git a/docs/build/html/api/core.node/-configuration-exception/-init-.html b/docs/build/html/api/core.node/-configuration-exception/-init-.html deleted file mode 100644 index 2462adf97e..0000000000 --- a/docs/build/html/api/core.node/-configuration-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -ConfigurationException.<init> - - - - -core.node / ConfigurationException / <init>
-
-

<init>

-ConfigurationException(message: String)
-
-
- - diff --git a/docs/build/html/api/core.node/-configuration-exception/index.html b/docs/build/html/api/core.node/-configuration-exception/index.html deleted file mode 100644 index da5f0659d3..0000000000 --- a/docs/build/html/api/core.node/-configuration-exception/index.html +++ /dev/null @@ -1,25 +0,0 @@ - - -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-properties/-init-.html b/docs/build/html/api/core.node/-node-configuration-from-properties/-init-.html deleted file mode 100644 index 91dd9080a2..0000000000 --- a/docs/build/html/api/core.node/-node-configuration-from-properties/-init-.html +++ /dev/null @@ -1,20 +0,0 @@ - - -NodeConfigurationFromProperties.<init> - - - - -core.node / NodeConfigurationFromProperties / <init>
-
-

<init>

-NodeConfigurationFromProperties(properties: Properties)
-

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-

TODO: Replace Java properties file with a better config file format (maybe yaml). -We want to be able to configure via a GUI too, so an ability to round-trip whitespace, comments etc when machine -editing the file is a must-have.

-
-
-
-
- - diff --git a/docs/build/html/api/core.node/-node-configuration-from-properties/index.html b/docs/build/html/api/core.node/-node-configuration-from-properties/index.html deleted file mode 100644 index e55ca73eff..0000000000 --- a/docs/build/html/api/core.node/-node-configuration-from-properties/index.html +++ /dev/null @@ -1,43 +0,0 @@ - - -NodeConfigurationFromProperties - - - - -core.node / NodeConfigurationFromProperties
-
-

NodeConfigurationFromProperties

-class NodeConfigurationFromProperties : NodeConfiguration
-

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-

TODO: Replace Java properties file with a better config file format (maybe yaml). -We want to be able to configure via a GUI too, so an ability to round-trip whitespace, comments etc when machine -editing the file is a must-have.

-
-
-
-
-

Constructors

- - - - - - - -
-<init> -NodeConfigurationFromProperties(properties: Properties)

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-
-

Properties

- - - - - - - -
-myLegalName -val myLegalName: String
- - diff --git a/docs/build/html/api/core.node/-node-configuration-from-properties/my-legal-name.html b/docs/build/html/api/core.node/-node-configuration-from-properties/my-legal-name.html deleted file mode 100644 index 9f5d4102e0..0000000000 --- a/docs/build/html/api/core.node/-node-configuration-from-properties/my-legal-name.html +++ /dev/null @@ -1,16 +0,0 @@ - - -NodeConfigurationFromProperties.myLegalName - - - - -core.node / NodeConfigurationFromProperties / myLegalName
-
-

myLegalName

- -val myLegalName: String
-Overrides NodeConfiguration.myLegalName
-
-
- - diff --git a/docs/build/html/api/core.node/-node-configuration/index.html b/docs/build/html/api/core.node/-node-configuration/index.html deleted file mode 100644 index 8cf1823442..0000000000 --- a/docs/build/html/api/core.node/-node-configuration/index.html +++ /dev/null @@ -1,37 +0,0 @@ - - -NodeConfiguration - - - - -core.node / NodeConfiguration
-
-

NodeConfiguration

-interface NodeConfiguration
-
-
-

Properties

- - - - - - - -
-myLegalName -abstract val myLegalName: String
-

Inheritors

- - - - - - - -
-NodeConfigurationFromProperties -class NodeConfigurationFromProperties : NodeConfiguration

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-
- - 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 deleted file mode 100644 index 3c22314914..0000000000 --- a/docs/build/html/api/core.node/-node-configuration/my-legal-name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeConfiguration.myLegalName - - - - -core.node / NodeConfiguration / myLegalName
-
-

myLegalName

- -abstract val myLegalName: String
-
-
- - diff --git a/docs/build/html/api/core.node/-node/-d-e-f-a-u-l-t_-p-o-r-t.html b/docs/build/html/api/core.node/-node/-d-e-f-a-u-l-t_-p-o-r-t.html deleted file mode 100644 index 7c366d0e50..0000000000 --- a/docs/build/html/api/core.node/-node/-d-e-f-a-u-l-t_-p-o-r-t.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.node/-node/-init-.html b/docs/build/html/api/core.node/-node/-init-.html deleted file mode 100644 index 77a88b8f2e..0000000000 --- a/docs/build/html/api/core.node/-node/-init-.html +++ /dev/null @@ -1,29 +0,0 @@ - - -Node.<init> - - - - -core.node / Node / <init>
-
-

<init>

-Node(dir: Path, p2pAddr: <ERROR CLASS>, configuration: NodeConfiguration, timestamperAddress: LegallyIdentifiableNode?)
-

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 file
-
- -timestamperAddress - If null, this node will become a timestamping node, otherwise, it will use that one.
-
-
- - diff --git a/docs/build/html/api/core.node/-node/index.html b/docs/build/html/api/core.node/-node/index.html deleted file mode 100644 index 2dc92d6c7f..0000000000 --- a/docs/build/html/api/core.node/-node/index.html +++ /dev/null @@ -1,212 +0,0 @@ - - -Node - - - - -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 file
-
- -timestamperAddress - If null, this node will become a timestamping node, otherwise, it will use that one.
-
-
-

Constructors

- - - - - - - -
-<init> -Node(dir: Path, p2pAddr: <ERROR CLASS>, configuration: NodeConfiguration, timestamperAddress: LegallyIdentifiableNode?)

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

- - - - - - - - - - - - - - - -
-log -val log: <ERROR CLASS>
-p2pAddr -val p2pAddr: <ERROR CLASS>
-webServer -lateinit var webServer: <ERROR CLASS>
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-configuration -val configuration: NodeConfiguration
-contractFactory -val contractFactory: ContractFactory
-dir -val dir: Path
-identity -lateinit var identity: IdentityService
-inNodeTimestampingService -var inNodeTimestampingService: NodeTimestamperService?
-keyManagement -lateinit var keyManagement: E2ETestKeyManagementService
-legallyIdentifableAddress -val legallyIdentifableAddress: LegallyIdentifiableNode
-net -lateinit var net: MessagingService
-serverThread -open val serverThread: ExecutorService
-services -val services: ServiceHub
-smm -lateinit var smm: StateMachineManager
-storage -lateinit var storage: StorageService
-timestamperAddress -val timestamperAddress: LegallyIdentifiableNode?
-wallet -lateinit var wallet: WalletService
-

Functions

- - - - - - - - - - - - - - - -
-makeMessagingService -fun makeMessagingService(): MessagingService
-start -fun start(): Node
-stop -fun stop(): Unit
-

Inherited Functions

- - - - - - - - - - - - - - - -
-constructStorageService -open fun constructStorageService(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair): StorageServiceImpl
-initialiseStorageService -open fun initialiseStorageService(dir: Path): StorageService
-makeIdentityService -open fun makeIdentityService(): IdentityService
-

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 deleted file mode 100644 index f1c28c0a26..0000000000 --- a/docs/build/html/api/core.node/-node/log.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Node.log - - - - -core.node / Node / log
-
-

log

- -protected val log: <ERROR CLASS>
-Overrides AbstractNode.log
-
-
- - diff --git a/docs/build/html/api/core.node/-node/make-messaging-service.html b/docs/build/html/api/core.node/-node/make-messaging-service.html deleted file mode 100644 index a63c87715f..0000000000 --- a/docs/build/html/api/core.node/-node/make-messaging-service.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Node.makeMessagingService - - - - -core.node / Node / makeMessagingService
-
-

makeMessagingService

- -protected fun makeMessagingService(): MessagingService
-Overrides AbstractNode.makeMessagingService
-
-
- - diff --git a/docs/build/html/api/core.node/-node/p2p-addr.html b/docs/build/html/api/core.node/-node/p2p-addr.html deleted file mode 100644 index 5eb2fd3213..0000000000 --- a/docs/build/html/api/core.node/-node/p2p-addr.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Node.p2pAddr - - - - -core.node / Node / p2pAddr
-
-

p2pAddr

- -val p2pAddr: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.node/-node/start.html b/docs/build/html/api/core.node/-node/start.html deleted file mode 100644 index f059695ccc..0000000000 --- a/docs/build/html/api/core.node/-node/start.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Node.start - - - - -core.node / Node / start
-
-

start

- -fun start(): Node
-Overrides AbstractNode.start
-
-
- - diff --git a/docs/build/html/api/core.node/-node/stop.html b/docs/build/html/api/core.node/-node/stop.html deleted file mode 100644 index 82a2e47b51..0000000000 --- a/docs/build/html/api/core.node/-node/stop.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Node.stop - - - - -core.node / Node / stop
-
-

stop

- -fun stop(): Unit
-Overrides AbstractNode.stop
-
-
- - diff --git a/docs/build/html/api/core.node/-node/web-server.html b/docs/build/html/api/core.node/-node/web-server.html deleted file mode 100644 index e108a48ebe..0000000000 --- a/docs/build/html/api/core.node/-node/web-server.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Node.webServer - - - - -core.node / Node / webServer
-
-

webServer

- -lateinit var webServer: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.node/index.html b/docs/build/html/api/core.node/index.html deleted file mode 100644 index fa8c00920d..0000000000 --- a/docs/build/html/api/core.node/index.html +++ /dev/null @@ -1,56 +0,0 @@ - - -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.

-
-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
-NodeConfigurationFromProperties -class NodeConfigurationFromProperties : NodeConfiguration

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-
-

Exceptions

- - - - - - - -
-ConfigurationException -class ConfigurationException : Exception
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/-init-.html b/docs/build/html/api/core.protocols/-protocol-logic/-init-.html deleted file mode 100644 index 608006173b..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/-init-.html +++ /dev/null @@ -1,28 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/call.html b/docs/build/html/api/core.protocols/-protocol-logic/call.html deleted file mode 100644 index d57ececdc0..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/call.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProtocolLogic.call - - - - -core.protocols / ProtocolLogic / call
-
-

call

- -abstract fun call(): T
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/index.html b/docs/build/html/api/core.protocols/-protocol-logic/index.html deleted file mode 100644 index c7216c561b..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/index.html +++ /dev/null @@ -1,169 +0,0 @@ - - -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>
-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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-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.

-
-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.

-
-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>
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/logger.html b/docs/build/html/api/core.protocols/-protocol-logic/logger.html deleted file mode 100644 index 1edfb304dd..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/logger.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProtocolLogic.logger - - - - -core.protocols / ProtocolLogic / logger
-
-

logger

- -val logger: <ERROR CLASS>
-

This is where you should log things to.

-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/progress-tracker.html b/docs/build/html/api/core.protocols/-protocol-logic/progress-tracker.html deleted file mode 100644 index 61c1033178..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/progress-tracker.html +++ /dev/null @@ -1,23 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/psm.html b/docs/build/html/api/core.protocols/-protocol-logic/psm.html deleted file mode 100644 index 93cebeb618..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/psm.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/receive.html b/docs/build/html/api/core.protocols/-protocol-logic/receive.html deleted file mode 100644 index 0a98aaaec1..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolLogic.receive - - - - -core.protocols / ProtocolLogic / receive
-
-

receive

- -inline fun <reified T : Any> receive(topic: String, sessionIDForReceive: Long): UntrustworthyData<T>
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/send-and-receive.html b/docs/build/html/api/core.protocols/-protocol-logic/send-and-receive.html deleted file mode 100644 index 6f6f8a309e..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/send-and-receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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>
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/send.html b/docs/build/html/api/core.protocols/-protocol-logic/send.html deleted file mode 100644 index 79003b4e87..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/send.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolLogic.send - - - - -core.protocols / ProtocolLogic / send
-
-

send

- -fun send(topic: String, destination: MessageRecipients, sessionID: Long, obj: Any): Unit
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/service-hub.html b/docs/build/html/api/core.protocols/-protocol-logic/service-hub.html deleted file mode 100644 index b9435cf894..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/service-hub.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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

-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-logic/sub-protocol.html b/docs/build/html/api/core.protocols/-protocol-logic/sub-protocol.html deleted file mode 100644 index 19d404435f..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-logic/sub-protocol.html +++ /dev/null @@ -1,17 +0,0 @@ - - -ProtocolLogic.subProtocol - - - - -core.protocols / ProtocolLogic / subProtocol
-
-

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.

-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/-init-.html b/docs/build/html/api/core.protocols/-protocol-state-machine/-init-.html deleted file mode 100644 index b302e0eb09..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/-init-.html +++ /dev/null @@ -1,21 +0,0 @@ - - -ProtocolStateMachine.<init> - - - - -core.protocols / ProtocolStateMachine / <init>
-
-

<init>

-ProtocolStateMachine(logic: ProtocolLogic<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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/index.html b/docs/build/html/api/core.protocols/-protocol-state-machine/index.html deleted file mode 100644 index 19dbcb3ead..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/index.html +++ /dev/null @@ -1,99 +0,0 @@ - - -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>)

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

- - - - - - - - - - - - - - - - - - - -
-logger -lateinit var logger: <ERROR CLASS>
-logic -val logic: ProtocolLogic<R>
-resultFuture -val resultFuture: <ERROR CLASS><R>

This future will complete when the call method returns.

-
-serviceHub -lateinit var serviceHub: ServiceHub
-

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 deleted file mode 100644 index ee52ad408f..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/logger.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.logger - - - - -core.protocols / ProtocolStateMachine / logger
-
-

logger

- -lateinit var logger: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/logic.html b/docs/build/html/api/core.protocols/-protocol-state-machine/logic.html deleted file mode 100644 index 48dc16d757..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/logic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.logic - - - - -core.protocols / ProtocolStateMachine / logic
-
-

logic

- -val logic: ProtocolLogic<R>
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/prepare-for-resume-with.html b/docs/build/html/api/core.protocols/-protocol-state-machine/prepare-for-resume-with.html deleted file mode 100644 index 7c4c945a44..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/prepare-for-resume-with.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.prepareForResumeWith - - - - -core.protocols / ProtocolStateMachine / prepareForResumeWith
-
-

prepareForResumeWith

- -fun prepareForResumeWith(serviceHub: ServiceHub, withObject: Any?, logger: <ERROR CLASS>, suspendFunc: (FiberRequest, ByteArray) -> Unit): Unit
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/receive.html b/docs/build/html/api/core.protocols/-protocol-state-machine/receive.html deleted file mode 100644 index bcc203a290..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.receive - - - - -core.protocols / ProtocolStateMachine / receive
-
-

receive

- -fun <T : Any> receive(topic: String, sessionIDForReceive: Long, recvType: Class<T>): UntrustworthyData<T>
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/result-future.html b/docs/build/html/api/core.protocols/-protocol-state-machine/result-future.html deleted file mode 100644 index 6868b0c36f..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/result-future.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProtocolStateMachine.resultFuture - - - - -core.protocols / ProtocolStateMachine / resultFuture
-
-

resultFuture

- -val resultFuture: <ERROR CLASS><R>
-

This future will complete when the call method returns.

-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/run.html b/docs/build/html/api/core.protocols/-protocol-state-machine/run.html deleted file mode 100644 index d348d2ab72..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/run.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.run - - - - -core.protocols / ProtocolStateMachine / run
-
-

run

- -fun run(): R
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/send-and-receive.html b/docs/build/html/api/core.protocols/-protocol-state-machine/send-and-receive.html deleted file mode 100644 index a78e7f2d18..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/send-and-receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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>
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/send.html b/docs/build/html/api/core.protocols/-protocol-state-machine/send.html deleted file mode 100644 index 537477163c..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/send.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.send - - - - -core.protocols / ProtocolStateMachine / send
-
-

send

- -fun send(topic: String, destination: MessageRecipients, sessionID: Long, obj: Any): Unit
-
-
- - diff --git a/docs/build/html/api/core.protocols/-protocol-state-machine/service-hub.html b/docs/build/html/api/core.protocols/-protocol-state-machine/service-hub.html deleted file mode 100644 index f0514b7a66..0000000000 --- a/docs/build/html/api/core.protocols/-protocol-state-machine/service-hub.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.serviceHub - - - - -core.protocols / ProtocolStateMachine / serviceHub
-
-

serviceHub

- -lateinit var serviceHub: ServiceHub
-
-
- - diff --git a/docs/build/html/api/core.protocols/index.html b/docs/build/html/api/core.protocols/index.html deleted file mode 100644 index b1e35c12be..0000000000 --- a/docs/build/html/api/core.protocols/index.html +++ /dev/null @@ -1,33 +0,0 @@ - - -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/-immutable-class-serializer/-init-.html b/docs/build/html/api/core.serialization/-immutable-class-serializer/-init-.html deleted file mode 100644 index 2e64a45bb0..0000000000 --- a/docs/build/html/api/core.serialization/-immutable-class-serializer/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.serialization/-immutable-class-serializer/constructor.html b/docs/build/html/api/core.serialization/-immutable-class-serializer/constructor.html deleted file mode 100644 index 6aef5d8540..0000000000 --- a/docs/build/html/api/core.serialization/-immutable-class-serializer/constructor.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ImmutableClassSerializer.constructor - - - - -core.serialization / ImmutableClassSerializer / constructor
-
-

constructor

- -val constructor: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.serialization/-immutable-class-serializer/index.html b/docs/build/html/api/core.serialization/-immutable-class-serializer/index.html deleted file mode 100644 index 692a4402af..0000000000 --- a/docs/build/html/api/core.serialization/-immutable-class-serializer/index.html +++ /dev/null @@ -1,75 +0,0 @@ - - -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 deleted file mode 100644 index 2364ab2637..0000000000 --- a/docs/build/html/api/core.serialization/-immutable-class-serializer/klass.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ImmutableClassSerializer.klass - - - - -core.serialization / ImmutableClassSerializer / klass
-
-

klass

- -val klass: KClass<T>
-
-
- - diff --git a/docs/build/html/api/core.serialization/-immutable-class-serializer/props-by-name.html b/docs/build/html/api/core.serialization/-immutable-class-serializer/props-by-name.html deleted file mode 100644 index fa117e05b6..0000000000 --- a/docs/build/html/api/core.serialization/-immutable-class-serializer/props-by-name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ImmutableClassSerializer.propsByName - - - - -core.serialization / ImmutableClassSerializer / propsByName
-
-

propsByName

- -val propsByName: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.serialization/-immutable-class-serializer/props.html b/docs/build/html/api/core.serialization/-immutable-class-serializer/props.html deleted file mode 100644 index b0b6bf2a28..0000000000 --- a/docs/build/html/api/core.serialization/-immutable-class-serializer/props.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ImmutableClassSerializer.props - - - - -core.serialization / ImmutableClassSerializer / props
-
-

props

- -val props: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.serialization/-immutable-class-serializer/read.html b/docs/build/html/api/core.serialization/-immutable-class-serializer/read.html deleted file mode 100644 index 3938d44d99..0000000000 --- a/docs/build/html/api/core.serialization/-immutable-class-serializer/read.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ImmutableClassSerializer.read - - - - -core.serialization / ImmutableClassSerializer / read
-
-

read

- -fun read(kryo: <ERROR CLASS>, input: <ERROR CLASS>, type: Class<T>): T
-
-
- - diff --git a/docs/build/html/api/core.serialization/-immutable-class-serializer/write.html b/docs/build/html/api/core.serialization/-immutable-class-serializer/write.html deleted file mode 100644 index c5d295685a..0000000000 --- a/docs/build/html/api/core.serialization/-immutable-class-serializer/write.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ImmutableClassSerializer.write - - - - -core.serialization / ImmutableClassSerializer / write
-
-

write

- -fun write(kryo: <ERROR CLASS>, output: <ERROR CLASS>, obj: T): Unit
-
-
- - diff --git a/docs/build/html/api/core.serialization/-opaque-bytes/-init-.html b/docs/build/html/api/core.serialization/-opaque-bytes/-init-.html deleted file mode 100644 index dc6a32ac31..0000000000 --- a/docs/build/html/api/core.serialization/-opaque-bytes/-init-.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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

-
-
- - diff --git a/docs/build/html/api/core.serialization/-opaque-bytes/bits.html b/docs/build/html/api/core.serialization/-opaque-bytes/bits.html deleted file mode 100644 index ac93754a3c..0000000000 --- a/docs/build/html/api/core.serialization/-opaque-bytes/bits.html +++ /dev/null @@ -1,15 +0,0 @@ - - -OpaqueBytes.bits - - - - -core.serialization / OpaqueBytes / bits
-
-

bits

- -val bits: ByteArray
-
-
- - diff --git a/docs/build/html/api/core.serialization/-opaque-bytes/equals.html b/docs/build/html/api/core.serialization/-opaque-bytes/equals.html deleted file mode 100644 index 32d92ad64e..0000000000 --- a/docs/build/html/api/core.serialization/-opaque-bytes/equals.html +++ /dev/null @@ -1,15 +0,0 @@ - - -OpaqueBytes.equals - - - - -core.serialization / OpaqueBytes / equals
-
-

equals

- -open fun equals(other: Any?): Boolean
-
-
- - diff --git a/docs/build/html/api/core.serialization/-opaque-bytes/hash-code.html b/docs/build/html/api/core.serialization/-opaque-bytes/hash-code.html deleted file mode 100644 index 7b12a43e91..0000000000 --- a/docs/build/html/api/core.serialization/-opaque-bytes/hash-code.html +++ /dev/null @@ -1,15 +0,0 @@ - - -OpaqueBytes.hashCode - - - - -core.serialization / OpaqueBytes / hashCode
-
-

hashCode

- -open fun hashCode(): Int
-
-
- - diff --git a/docs/build/html/api/core.serialization/-opaque-bytes/index.html b/docs/build/html/api/core.serialization/-opaque-bytes/index.html deleted file mode 100644 index ce9411df10..0000000000 --- a/docs/build/html/api/core.serialization/-opaque-bytes/index.html +++ /dev/null @@ -1,127 +0,0 @@ - - -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(), includeClassName: Boolean = false): 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 deleted file mode 100644 index d741a14bcd..0000000000 --- a/docs/build/html/api/core.serialization/-opaque-bytes/of.html +++ /dev/null @@ -1,15 +0,0 @@ - - -OpaqueBytes.of - - - - -core.serialization / OpaqueBytes / of
-
-

of

- -fun of(vararg b: Byte): OpaqueBytes
-
-
- - diff --git a/docs/build/html/api/core.serialization/-opaque-bytes/size.html b/docs/build/html/api/core.serialization/-opaque-bytes/size.html deleted file mode 100644 index 6481021502..0000000000 --- a/docs/build/html/api/core.serialization/-opaque-bytes/size.html +++ /dev/null @@ -1,15 +0,0 @@ - - -OpaqueBytes.size - - - - -core.serialization / OpaqueBytes / size
-
-

size

- -val size: Int
-
-
- - diff --git a/docs/build/html/api/core.serialization/-opaque-bytes/to-string.html b/docs/build/html/api/core.serialization/-opaque-bytes/to-string.html deleted file mode 100644 index c5eadf1572..0000000000 --- a/docs/build/html/api/core.serialization/-opaque-bytes/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -OpaqueBytes.toString - - - - -core.serialization / OpaqueBytes / toString
-
-

toString

- -open fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core.serialization/-serialized-bytes/-init-.html b/docs/build/html/api/core.serialization/-serialized-bytes/-init-.html deleted file mode 100644 index d3d39468ba..0000000000 --- a/docs/build/html/api/core.serialization/-serialized-bytes/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.serialization/-serialized-bytes/hash.html b/docs/build/html/api/core.serialization/-serialized-bytes/hash.html deleted file mode 100644 index 1e2408062a..0000000000 --- a/docs/build/html/api/core.serialization/-serialized-bytes/hash.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SerializedBytes.hash - - - - -core.serialization / SerializedBytes / hash
-
-

hash

- -val hash: SecureHash
-
-
- - diff --git a/docs/build/html/api/core.serialization/-serialized-bytes/index.html b/docs/build/html/api/core.serialization/-serialized-bytes/index.html deleted file mode 100644 index 18f54b2d55..0000000000 --- a/docs/build/html/api/core.serialization/-serialized-bytes/index.html +++ /dev/null @@ -1,110 +0,0 @@ - - -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

- - - - - - - -
-hash -val hash: SecureHash
-

Inherited Properties

- - - - - - - - - - - -
-bits -val bits: ByteArray
-size -val size: Int
-

Functions

- - - - - - - -
-writeToFile -fun writeToFile(path: Path): Path
-

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(): WireTransaction
-fun <T : Any> SerializedBytes<T>.deserialize(): T
-fun <T : Any> OpaqueBytes.deserialize(kryo: <ERROR CLASS> = THREAD_LOCAL_KRYO.get(), includeClassName: Boolean = false): 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 deleted file mode 100644 index 5c4232fe2e..0000000000 --- a/docs/build/html/api/core.serialization/-serialized-bytes/write-to-file.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SerializedBytes.writeToFile - - - - -core.serialization / SerializedBytes / writeToFile
-
-

writeToFile

- -fun writeToFile(path: Path): Path
-
-
- - diff --git a/docs/build/html/api/core.serialization/-t-h-r-e-a-d_-l-o-c-a-l_-k-r-y-o.html b/docs/build/html/api/core.serialization/-t-h-r-e-a-d_-l-o-c-a-l_-k-r-y-o.html deleted file mode 100644 index b30b67df9e..0000000000 --- a/docs/build/html/api/core.serialization/-t-h-r-e-a-d_-l-o-c-a-l_-k-r-y-o.html +++ /dev/null @@ -1,36 +0,0 @@ - - -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:

-

  • Performance

    -

  • Security

    -

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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.serialization/create-kryo.html b/docs/build/html/api/core.serialization/create-kryo.html deleted file mode 100644 index e3646c7c59..0000000000 --- a/docs/build/html/api/core.serialization/create-kryo.html +++ /dev/null @@ -1,15 +0,0 @@ - - -createKryo - - - - -core.serialization / createKryo
-
-

createKryo

- -fun createKryo(k: <ERROR CLASS> = Kryo()): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.serialization/deserialize.html b/docs/build/html/api/core.serialization/deserialize.html deleted file mode 100644 index 9bfbd6b968..0000000000 --- a/docs/build/html/api/core.serialization/deserialize.html +++ /dev/null @@ -1,19 +0,0 @@ - - -deserialize - - - - -core.serialization / deserialize
-
-

deserialize

- -inline fun <reified T : Any> OpaqueBytes.deserialize(kryo: <ERROR CLASS> = THREAD_LOCAL_KRYO.get(), includeClassName: Boolean = false): T
- -fun SerializedBytes<WireTransaction>.deserialize(): WireTransaction
- -inline fun <reified T : Any> SerializedBytes<T>.deserialize(): T
-
-
- - diff --git a/docs/build/html/api/core.serialization/index.html b/docs/build/html/api/core.serialization/index.html deleted file mode 100644 index cc78d025b6..0000000000 --- a/docs/build/html/api/core.serialization/index.html +++ /dev/null @@ -1,92 +0,0 @@ - - -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.

-
-

Extensions for External Classes

- - - - - - - -
-kotlin.ByteArray -
-

Properties

- - - - - - - -
-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.

-
-

Functions

- - - - - - - - - - - - - - - -
-createKryo -fun createKryo(k: <ERROR CLASS> = Kryo()): <ERROR CLASS>
-deserialize -fun <T : Any> OpaqueBytes.deserialize(kryo: <ERROR CLASS> = THREAD_LOCAL_KRYO.get(), includeClassName: Boolean = false): T
-fun SerializedBytes<WireTransaction>.deserialize(): WireTransaction
-fun <T : Any> SerializedBytes<T>.deserialize(): T
-serialize -fun <T : Any> T.serialize(kryo: <ERROR CLASS> = THREAD_LOCAL_KRYO.get(), includeClassName: Boolean = false): 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)

-
- - 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 deleted file mode 100644 index 607a235b5c..0000000000 --- a/docs/build/html/api/core.serialization/kotlin.-byte-array/deserialize.html +++ /dev/null @@ -1,15 +0,0 @@ - - -deserialize - - - - -core.serialization / kotlin.ByteArray / deserialize
-
-

deserialize

- -inline fun <reified T : Any> ByteArray.deserialize(kryo: <ERROR CLASS> = THREAD_LOCAL_KRYO.get(), includeClassName: Boolean = false): T
-
-
- - diff --git a/docs/build/html/api/core.serialization/kotlin.-byte-array/index.html b/docs/build/html/api/core.serialization/kotlin.-byte-array/index.html deleted file mode 100644 index d4bfbde49f..0000000000 --- a/docs/build/html/api/core.serialization/kotlin.-byte-array/index.html +++ /dev/null @@ -1,27 +0,0 @@ - - -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(), includeClassName: Boolean = false): 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 deleted file mode 100644 index 5baa528246..0000000000 --- a/docs/build/html/api/core.serialization/kotlin.-byte-array/opaque.html +++ /dev/null @@ -1,15 +0,0 @@ - - -opaque - - - - -core.serialization / kotlin.ByteArray / opaque
-
-

opaque

- -fun ByteArray.opaque(): OpaqueBytes
-
-
- - diff --git a/docs/build/html/api/core.serialization/serialize.html b/docs/build/html/api/core.serialization/serialize.html deleted file mode 100644 index 7113737c20..0000000000 --- a/docs/build/html/api/core.serialization/serialize.html +++ /dev/null @@ -1,17 +0,0 @@ - - -serialize - - - - -core.serialization / serialize
-
-

serialize

- -fun <T : Any> T.serialize(kryo: <ERROR CLASS> = THREAD_LOCAL_KRYO.get(), includeClassName: Boolean = false): 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)

-
-
- - 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 deleted file mode 100644 index 7da9900c13..0000000000 --- a/docs/build/html/api/core.utilities/-a-n-s-i-progress-renderer/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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

- - - - - - - -
-progressTracker -var progressTracker: ProgressTracker?
- - 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 deleted file mode 100644 index 7e37f12890..0000000000 --- a/docs/build/html/api/core.utilities/-a-n-s-i-progress-renderer/progress-tracker.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ANSIProgressRenderer.progressTracker - - - - -core.utilities / ANSIProgressRenderer / progressTracker
-
-

progressTracker

- -var progressTracker: ProgressTracker?
-
-
- - diff --git a/docs/build/html/api/core.utilities/-brief-log-formatter/-init-.html b/docs/build/html/api/core.utilities/-brief-log-formatter/-init-.html deleted file mode 100644 index 7c2e4e6af1..0000000000 --- a/docs/build/html/api/core.utilities/-brief-log-formatter/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -BriefLogFormatter.<init> - - - - -core.utilities / BriefLogFormatter / <init>
-
-

<init>

-BriefLogFormatter()
-

A Java logging formatter that writes more compact output than the default.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-brief-log-formatter/format.html b/docs/build/html/api/core.utilities/-brief-log-formatter/format.html deleted file mode 100644 index 70d22f5c28..0000000000 --- a/docs/build/html/api/core.utilities/-brief-log-formatter/format.html +++ /dev/null @@ -1,15 +0,0 @@ - - -BriefLogFormatter.format - - - - -core.utilities / BriefLogFormatter / format
-
-

format

- -fun format(logRecord: LogRecord): String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-brief-log-formatter/index.html b/docs/build/html/api/core.utilities/-brief-log-formatter/index.html deleted file mode 100644 index 5965fbf2dd..0000000000 --- a/docs/build/html/api/core.utilities/-brief-log-formatter/index.html +++ /dev/null @@ -1,73 +0,0 @@ - - -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

- - - - - - - -
-format -fun format(logRecord: LogRecord): String
-

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 deleted file mode 100644 index 920c2e131d..0000000000 --- a/docs/build/html/api/core.utilities/-brief-log-formatter/init-verbose.html +++ /dev/null @@ -1,18 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-brief-log-formatter/init.html b/docs/build/html/api/core.utilities/-brief-log-formatter/init.html deleted file mode 100644 index 53cb05f503..0000000000 --- a/docs/build/html/api/core.utilities/-brief-log-formatter/init.html +++ /dev/null @@ -1,16 +0,0 @@ - - -BriefLogFormatter.init - - - - -core.utilities / BriefLogFormatter / init
-
-

init

- -fun init(): Unit
-

Configures JDK logging to use this class for everything.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-brief-log-formatter/logging-off.html b/docs/build/html/api/core.utilities/-brief-log-formatter/logging-off.html deleted file mode 100644 index 7ad456b3d2..0000000000 --- a/docs/build/html/api/core.utilities/-brief-log-formatter/logging-off.html +++ /dev/null @@ -1,17 +0,0 @@ - - -BriefLogFormatter.loggingOff - - - - -core.utilities / BriefLogFormatter / loggingOff
-
-

loggingOff

- -fun loggingOff(vararg names: String): Unit
- -fun loggingOff(vararg classes: KClass<*>): Unit
-
-
- - diff --git a/docs/build/html/api/core.utilities/-brief-log-formatter/logging-on.html b/docs/build/html/api/core.utilities/-brief-log-formatter/logging-on.html deleted file mode 100644 index 3cbfedd011..0000000000 --- a/docs/build/html/api/core.utilities/-brief-log-formatter/logging-on.html +++ /dev/null @@ -1,17 +0,0 @@ - - -BriefLogFormatter.loggingOn - - - - -core.utilities / BriefLogFormatter / loggingOn
-
-

loggingOn

- -fun loggingOn(vararg names: String): Unit
- -fun loggingOn(vararg classes: KClass<*>): Unit
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-b-a-g_-o-f_-c-a-s-h.html b/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-b-a-g_-o-f_-c-a-s-h.html deleted file mode 100644 index f56bc76eb5..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-b-a-g_-o-f_-c-a-s-h.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.CODE_BAG_OF_CASH - - - - -core.utilities / Emoji / CODE_BAG_OF_CASH
-
-

CODE_BAG_OF_CASH

- -const val CODE_BAG_OF_CASH: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-d-i-a-m-o-n-d.html b/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-d-i-a-m-o-n-d.html deleted file mode 100644 index a6e6697383..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-d-i-a-m-o-n-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.CODE_DIAMOND - - - - -core.utilities / Emoji / CODE_DIAMOND
-
-

CODE_DIAMOND

- -const val CODE_DIAMOND: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-g-r-e-e-n_-t-i-c-k.html b/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-g-r-e-e-n_-t-i-c-k.html deleted file mode 100644 index 72624c3f88..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-g-r-e-e-n_-t-i-c-k.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.CODE_GREEN_TICK - - - - -core.utilities / Emoji / CODE_GREEN_TICK
-
-

CODE_GREEN_TICK

- -const val CODE_GREEN_TICK: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-l-e-f-t_-a-r-r-o-w.html b/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-l-e-f-t_-a-r-r-o-w.html deleted file mode 100644 index 04abb44704..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-l-e-f-t_-a-r-r-o-w.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.CODE_LEFT_ARROW - - - - -core.utilities / Emoji / CODE_LEFT_ARROW
-
-

CODE_LEFT_ARROW

- -const val CODE_LEFT_ARROW: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-n-e-w-s-p-a-p-e-r.html b/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-n-e-w-s-p-a-p-e-r.html deleted file mode 100644 index d856145fbe..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-n-e-w-s-p-a-p-e-r.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.CODE_NEWSPAPER - - - - -core.utilities / Emoji / CODE_NEWSPAPER
-
-

CODE_NEWSPAPER

- -const val CODE_NEWSPAPER: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-p-a-p-e-r-c-l-i-p.html b/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-p-a-p-e-r-c-l-i-p.html deleted file mode 100644 index 210a7adc32..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-p-a-p-e-r-c-l-i-p.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.CODE_PAPERCLIP - - - - -core.utilities / Emoji / CODE_PAPERCLIP
-
-

CODE_PAPERCLIP

- -const val CODE_PAPERCLIP: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-r-i-g-h-t_-a-r-r-o-w.html b/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-r-i-g-h-t_-a-r-r-o-w.html deleted file mode 100644 index 91fbe93d93..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/-c-o-d-e_-r-i-g-h-t_-a-r-r-o-w.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.CODE_RIGHT_ARROW - - - - -core.utilities / Emoji / CODE_RIGHT_ARROW
-
-

CODE_RIGHT_ARROW

- -const val CODE_RIGHT_ARROW: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/bag-of-cash.html b/docs/build/html/api/core.utilities/-emoji/bag-of-cash.html deleted file mode 100644 index 23e6ae865b..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/bag-of-cash.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.bagOfCash - - - - -core.utilities / Emoji / bagOfCash
-
-

bagOfCash

- -val bagOfCash: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/diamond.html b/docs/build/html/api/core.utilities/-emoji/diamond.html deleted file mode 100644 index 62caebb134..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/diamond.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.diamond - - - - -core.utilities / Emoji / diamond
-
-

diamond

- -val diamond: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/has-emoji-terminal.html b/docs/build/html/api/core.utilities/-emoji/has-emoji-terminal.html deleted file mode 100644 index 1ca86c4faf..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/has-emoji-terminal.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.hasEmojiTerminal - - - - -core.utilities / Emoji / hasEmojiTerminal
-
-

hasEmojiTerminal

- -val hasEmojiTerminal: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/index.html b/docs/build/html/api/core.utilities/-emoji/index.html deleted file mode 100644 index d5d41921a7..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/index.html +++ /dev/null @@ -1,115 +0,0 @@ - - -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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-CODE_BAG_OF_CASH -const val CODE_BAG_OF_CASH: String
-CODE_DIAMOND -const val CODE_DIAMOND: String
-CODE_GREEN_TICK -const val CODE_GREEN_TICK: String
-CODE_LEFT_ARROW -const val CODE_LEFT_ARROW: String
-CODE_NEWSPAPER -const val CODE_NEWSPAPER: String
-CODE_PAPERCLIP -const val CODE_PAPERCLIP: String
-CODE_RIGHT_ARROW -const val CODE_RIGHT_ARROW: String
-bagOfCash -val bagOfCash: String
-diamond -val diamond: String
-hasEmojiTerminal -val hasEmojiTerminal: <ERROR CLASS>
-leftArrow -val leftArrow: String
-newspaper -val newspaper: String
-paperclip -val paperclip: String
-rightArrow -val rightArrow: String
-

Functions

- - - - - - - -
-renderIfSupported -fun renderIfSupported(obj: Any): String
- - diff --git a/docs/build/html/api/core.utilities/-emoji/left-arrow.html b/docs/build/html/api/core.utilities/-emoji/left-arrow.html deleted file mode 100644 index 3cb0ac00af..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/left-arrow.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.leftArrow - - - - -core.utilities / Emoji / leftArrow
-
-

leftArrow

- -val leftArrow: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/newspaper.html b/docs/build/html/api/core.utilities/-emoji/newspaper.html deleted file mode 100644 index a5e1246f35..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/newspaper.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.newspaper - - - - -core.utilities / Emoji / newspaper
-
-

newspaper

- -val newspaper: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/paperclip.html b/docs/build/html/api/core.utilities/-emoji/paperclip.html deleted file mode 100644 index 045814bffd..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/paperclip.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.paperclip - - - - -core.utilities / Emoji / paperclip
-
-

paperclip

- -val paperclip: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/render-if-supported.html b/docs/build/html/api/core.utilities/-emoji/render-if-supported.html deleted file mode 100644 index 9243d5126c..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/render-if-supported.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.renderIfSupported - - - - -core.utilities / Emoji / renderIfSupported
-
-

renderIfSupported

- -fun renderIfSupported(obj: Any): String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-emoji/right-arrow.html b/docs/build/html/api/core.utilities/-emoji/right-arrow.html deleted file mode 100644 index bced5b19b5..0000000000 --- a/docs/build/html/api/core.utilities/-emoji/right-arrow.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Emoji.rightArrow - - - - -core.utilities / Emoji / rightArrow
-
-

rightArrow

- -val rightArrow: String
-
-
- - 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 deleted file mode 100644 index 453fc8616a..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -ProgressTracker.Change.Position.<init> - - - - -core.utilities / ProgressTracker / Change / Position / <init>
-
-

<init>

-Position(newStep: Step)
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/index.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/index.html deleted file mode 100644 index 15bafb432a..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -ProgressTracker.Change.Position - - - - -core.utilities / ProgressTracker / Change / Position
-
-

Position

-class Position : Change
-
-
-

Constructors

- - - - - - - -
-<init> -Position(newStep: Step)
-

Properties

- - - - - - - -
-newStep -val newStep: Step
- - 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 deleted file mode 100644 index 7b00c5d886..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/-position/new-step.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProgressTracker.Change.Position.newStep - - - - -core.utilities / ProgressTracker / Change / Position / newStep
-
-

newStep

- -val newStep: Step
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/-init-.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/-init-.html deleted file mode 100644 index 41c5725b36..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -ProgressTracker.Change.Rendering.<init> - - - - -core.utilities / ProgressTracker / Change / Rendering / <init>
-
-

<init>

-Rendering(ofStep: Step)
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/index.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/index.html deleted file mode 100644 index 10447fe1ca..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -ProgressTracker.Change.Rendering - - - - -core.utilities / ProgressTracker / Change / Rendering
-
-

Rendering

-class Rendering : Change
-
-
-

Constructors

- - - - - - - -
-<init> -Rendering(ofStep: Step)
-

Properties

- - - - - - - -
-ofStep -val ofStep: Step
- - 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 deleted file mode 100644 index 13ef31091d..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/-rendering/of-step.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProgressTracker.Change.Rendering.ofStep - - - - -core.utilities / ProgressTracker / Change / Rendering / ofStep
-
-

ofStep

- -val ofStep: Step
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/-init-.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/-init-.html deleted file mode 100644 index 91f56996b0..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -ProgressTracker.Change.Structural.<init> - - - - -core.utilities / ProgressTracker / Change / Structural / <init>
-
-

<init>

-Structural(parent: Step)
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/index.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/index.html deleted file mode 100644 index 7345629968..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -ProgressTracker.Change.Structural - - - - -core.utilities / ProgressTracker / Change / Structural
-
-

Structural

-class Structural : Change
-
-
-

Constructors

- - - - - - - -
-<init> -Structural(parent: Step)
-

Properties

- - - - - - - -
-parent -val parent: Step
- - 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 deleted file mode 100644 index f3cad7fa8e..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/-structural/parent.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProgressTracker.Change.Structural.parent - - - - -core.utilities / ProgressTracker / Change / Structural / parent
-
-

parent

- -val parent: Step
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-change/index.html b/docs/build/html/api/core.utilities/-progress-tracker/-change/index.html deleted file mode 100644 index 5367e4e52d..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-change/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - -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 deleted file mode 100644 index e7f798c1e2..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-d-o-n-e/equals.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProgressTracker.DONE.equals - - - - -core.utilities / ProgressTracker / DONE / equals
-
-

equals

- -fun equals(other: Any?): Boolean
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-d-o-n-e/index.html b/docs/build/html/api/core.utilities/-progress-tracker/-d-o-n-e/index.html deleted file mode 100644 index d5c2f0f7b0..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-d-o-n-e/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -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 deleted file mode 100644 index e369c39d71..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-init-.html +++ /dev/null @@ -1,32 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/-init-.html b/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/-init-.html deleted file mode 100644 index 1e4056bc53..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/changes.html b/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/changes.html deleted file mode 100644 index 39cbec6403..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/changes.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProgressTracker.RelabelableStep.changes - - - - -core.utilities / ProgressTracker / RelabelableStep / changes
-
-

changes

- -open val changes: <ERROR CLASS>
-Overrides Step.changes
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/current-label.html b/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/current-label.html deleted file mode 100644 index 9eb9b4b51d..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/current-label.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProgressTracker.RelabelableStep.currentLabel - - - - -core.utilities / ProgressTracker / RelabelableStep / currentLabel
-
-

currentLabel

- -var currentLabel: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/index.html b/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/index.html deleted file mode 100644 index 1dd4ddce27..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/index.html +++ /dev/null @@ -1,50 +0,0 @@ - - -ProgressTracker.RelabelableStep - - - - -core.utilities / ProgressTracker / RelabelableStep
-
-

RelabelableStep

-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 deleted file mode 100644 index 4d497ea609..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-relabelable-step/label.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProgressTracker.RelabelableStep.label - - - - -core.utilities / ProgressTracker / RelabelableStep / label
-
-

label

- -open val label: String
-Overrides Step.label
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-step/-init-.html b/docs/build/html/api/core.utilities/-progress-tracker/-step/-init-.html deleted file mode 100644 index dc7052ff8c..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-step/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProgressTracker.Step.<init> - - - - -core.utilities / ProgressTracker / Step / <init>
-
-

<init>

-Step(label: String)
-

The superclass of all step objects.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-step/changes.html b/docs/build/html/api/core.utilities/-progress-tracker/-step/changes.html deleted file mode 100644 index b0041ee03d..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-step/changes.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProgressTracker.Step.changes - - - - -core.utilities / ProgressTracker / Step / changes
-
-

changes

- -open val changes: <ERROR CLASS><Change>
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-step/index.html b/docs/build/html/api/core.utilities/-progress-tracker/-step/index.html deleted file mode 100644 index edc2a49ddf..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-step/index.html +++ /dev/null @@ -1,152 +0,0 @@ - - -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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-ANNOUNCING -object ANNOUNCING : Step
-AWAITING_PROPOSAL -object AWAITING_PROPOSAL : Step
-DONE -object DONE : Step
-RECEIVING -object RECEIVING : Step
-RelabelableStep -class RelabelableStep : Step

This class makes it easier to relabel a step on the fly, to provide transient information.

-
-SELF_ISSUING -object SELF_ISSUING : Step
-SENDING_SIGS -object SENDING_SIGS : Step
-SIGNING -object SIGNING : Step
-SIGNING -object SIGNING : Step
-STARTING_BUY -object STARTING_BUY : Step
-SWAPPING_SIGNATURES -object SWAPPING_SIGNATURES : Step
-TIMESTAMPING -object TIMESTAMPING : Step
-TRADING -object TRADING : Step
-UNSTARTED -object UNSTARTED : Step
-VERIFYING -object VERIFYING : Step
-VERIFYING -object VERIFYING : Step
-WAITING_FOR_SELLER_TO_CONNECT -object WAITING_FOR_SELLER_TO_CONNECT : Step
- - 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 deleted file mode 100644 index 5d74fe0889..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-step/label.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProgressTracker.Step.label - - - - -core.utilities / ProgressTracker / Step / label
-
-

label

- -open val label: String
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-u-n-s-t-a-r-t-e-d/equals.html b/docs/build/html/api/core.utilities/-progress-tracker/-u-n-s-t-a-r-t-e-d/equals.html deleted file mode 100644 index a9d6deb366..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-u-n-s-t-a-r-t-e-d/equals.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProgressTracker.UNSTARTED.equals - - - - -core.utilities / ProgressTracker / UNSTARTED / equals
-
-

equals

- -fun equals(other: Any?): Boolean
-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/-u-n-s-t-a-r-t-e-d/index.html b/docs/build/html/api/core.utilities/-progress-tracker/-u-n-s-t-a-r-t-e-d/index.html deleted file mode 100644 index 0f585a7cb8..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/-u-n-s-t-a-r-t-e-d/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -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 deleted file mode 100644 index 20fa748bfb..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/all-steps.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/changes.html b/docs/build/html/api/core.utilities/-progress-tracker/changes.html deleted file mode 100644 index 659242afd8..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/changes.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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).

-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/children-for.html b/docs/build/html/api/core.utilities/-progress-tracker/children-for.html deleted file mode 100644 index 6f924d9a9f..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/children-for.html +++ /dev/null @@ -1,17 +0,0 @@ - - -ProgressTracker.childrenFor - - - - -core.utilities / ProgressTracker / childrenFor
-
-

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.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/current-step-recursive.html b/docs/build/html/api/core.utilities/-progress-tracker/current-step-recursive.html deleted file mode 100644 index 1dd821beca..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/current-step-recursive.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/current-step.html b/docs/build/html/api/core.utilities/-progress-tracker/current-step.html deleted file mode 100644 index 0676229240..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/current-step.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/index.html b/docs/build/html/api/core.utilities/-progress-tracker/index.html deleted file mode 100644 index 6dd3ca8a6f..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/index.html +++ /dev/null @@ -1,154 +0,0 @@ - - -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 -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.

-
-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.

-
-

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 deleted file mode 100644 index 986e9481c6..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/next-step.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/step-index.html b/docs/build/html/api/core.utilities/-progress-tracker/step-index.html deleted file mode 100644 index 70277cc814..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/step-index.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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)

-
-
- - diff --git a/docs/build/html/api/core.utilities/-progress-tracker/steps.html b/docs/build/html/api/core.utilities/-progress-tracker/steps.html deleted file mode 100644 index 8658aadb7f..0000000000 --- a/docs/build/html/api/core.utilities/-progress-tracker/steps.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core.utilities/-untrustworthy-data/-init-.html b/docs/build/html/api/core.utilities/-untrustworthy-data/-init-.html deleted file mode 100644 index 041561576d..0000000000 --- a/docs/build/html/api/core.utilities/-untrustworthy-data/-init-.html +++ /dev/null @@ -1,24 +0,0 @@ - - -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?

    -

-
-
-
- - diff --git a/docs/build/html/api/core.utilities/-untrustworthy-data/data.html b/docs/build/html/api/core.utilities/-untrustworthy-data/data.html deleted file mode 100644 index 0e103bf4cd..0000000000 --- a/docs/build/html/api/core.utilities/-untrustworthy-data/data.html +++ /dev/null @@ -1,15 +0,0 @@ - - -UntrustworthyData.data - - - - -core.utilities / UntrustworthyData / data
-
-

data

- -val data: T
-
-
- - diff --git a/docs/build/html/api/core.utilities/-untrustworthy-data/index.html b/docs/build/html/api/core.utilities/-untrustworthy-data/index.html deleted file mode 100644 index 05b11dabf7..0000000000 --- a/docs/build/html/api/core.utilities/-untrustworthy-data/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - -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 deleted file mode 100644 index 4845c1bb56..0000000000 --- a/docs/build/html/api/core.utilities/-untrustworthy-data/validate.html +++ /dev/null @@ -1,15 +0,0 @@ - - -UntrustworthyData.validate - - - - -core.utilities / UntrustworthyData / validate
-
-

validate

- -inline fun <R> validate(validator: (T) -> R): R
-
-
- - diff --git a/docs/build/html/api/core.utilities/index.html b/docs/build/html/api/core.utilities/index.html deleted file mode 100644 index 8a6ef2fe9a..0000000000 --- a/docs/build/html/api/core.utilities/index.html +++ /dev/null @@ -1,74 +0,0 @@ - - -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.

-
-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.

-
-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).

-
-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 deleted file mode 100644 index bac5e99b46..0000000000 --- a/docs/build/html/api/core.utilities/logger-for.html +++ /dev/null @@ -1,15 +0,0 @@ - - -loggerFor - - - - -core.utilities / loggerFor
-
-

loggerFor

- -inline fun <reified T : Any> loggerFor(): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core.utilities/trace.html b/docs/build/html/api/core.utilities/trace.html deleted file mode 100644 index 5f74e1f669..0000000000 --- a/docs/build/html/api/core.utilities/trace.html +++ /dev/null @@ -1,15 +0,0 @@ - - -trace - - - - -core.utilities / trace
-
-

trace

- -inline fun <ERROR CLASS>.trace(msg: () -> String): Unit
-
-
- - diff --git a/docs/build/html/api/core/-amount/-init-.html b/docs/build/html/api/core/-amount/-init-.html deleted file mode 100644 index aeb233c3f2..0000000000 --- a/docs/build/html/api/core/-amount/-init-.html +++ /dev/null @@ -1,27 +0,0 @@ - - -Amount.<init> - - - - -core / Amount / <init>
-
-

<init>

-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.

-
-
-
-
- - diff --git a/docs/build/html/api/core/-amount/compare-to.html b/docs/build/html/api/core/-amount/compare-to.html deleted file mode 100644 index c24817ff64..0000000000 --- a/docs/build/html/api/core/-amount/compare-to.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Amount.compareTo - - - - -core / Amount / compareTo
-
-

compareTo

- -fun compareTo(other: Amount): Int
-
-
- - diff --git a/docs/build/html/api/core/-amount/currency.html b/docs/build/html/api/core/-amount/currency.html deleted file mode 100644 index c7ca2d0e17..0000000000 --- a/docs/build/html/api/core/-amount/currency.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Amount.currency - - - - -core / Amount / currency
-
-

currency

- -val currency: Currency
-
-
- - diff --git a/docs/build/html/api/core/-amount/div.html b/docs/build/html/api/core/-amount/div.html deleted file mode 100644 index 4a3f5654ea..0000000000 --- a/docs/build/html/api/core/-amount/div.html +++ /dev/null @@ -1,17 +0,0 @@ - - -Amount.div - - - - -core / Amount / div
-
-

div

- -operator fun div(other: Long): Amount
- -operator fun div(other: Int): Amount
-
-
- - diff --git a/docs/build/html/api/core/-amount/index.html b/docs/build/html/api/core/-amount/index.html deleted file mode 100644 index 5815de0dc8..0000000000 --- a/docs/build/html/api/core/-amount/index.html +++ /dev/null @@ -1,99 +0,0 @@ - - -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(pennies: Long, currency: Currency)

Amount represents a positive quantity of currency, measured in pennies, which are the smallest representable units.

-
-

Properties

- - - - - - - - - - - -
-currency -val currency: Currency
-pennies -val pennies: Long
-

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
- - diff --git a/docs/build/html/api/core/-amount/minus.html b/docs/build/html/api/core/-amount/minus.html deleted file mode 100644 index 7b46b0b7b8..0000000000 --- a/docs/build/html/api/core/-amount/minus.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Amount.minus - - - - -core / Amount / minus
-
-

minus

- -operator fun minus(other: Amount): Amount
-
-
- - diff --git a/docs/build/html/api/core/-amount/pennies.html b/docs/build/html/api/core/-amount/pennies.html deleted file mode 100644 index 89373ffc17..0000000000 --- a/docs/build/html/api/core/-amount/pennies.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Amount.pennies - - - - -core / Amount / pennies
-
-

pennies

- -val pennies: Long
-
-
- - diff --git a/docs/build/html/api/core/-amount/plus.html b/docs/build/html/api/core/-amount/plus.html deleted file mode 100644 index e9f60611b6..0000000000 --- a/docs/build/html/api/core/-amount/plus.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Amount.plus - - - - -core / Amount / plus
-
-

plus

- -operator fun plus(other: Amount): Amount
-
-
- - diff --git a/docs/build/html/api/core/-amount/times.html b/docs/build/html/api/core/-amount/times.html deleted file mode 100644 index 9e1b616af5..0000000000 --- a/docs/build/html/api/core/-amount/times.html +++ /dev/null @@ -1,17 +0,0 @@ - - -Amount.times - - - - -core / Amount / times
-
-

times

- -operator fun times(other: Long): Amount
- -operator fun times(other: Int): Amount
-
-
- - diff --git a/docs/build/html/api/core/-amount/to-string.html b/docs/build/html/api/core/-amount/to-string.html deleted file mode 100644 index e2bf66cca5..0000000000 --- a/docs/build/html/api/core/-amount/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Amount.toString - - - - -core / Amount / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core/-attachment/extract-file.html b/docs/build/html/api/core/-attachment/extract-file.html deleted file mode 100644 index 57235e160a..0000000000 --- a/docs/build/html/api/core/-attachment/extract-file.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Attachment.extractFile - - - - -core / Attachment / extractFile
-
-

extractFile

- -open fun extractFile(path: String, outputTo: 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.
-
-
- - diff --git a/docs/build/html/api/core/-attachment/index.html b/docs/build/html/api/core/-attachment/index.html deleted file mode 100644 index 0f80af0e32..0000000000 --- a/docs/build/html/api/core/-attachment/index.html +++ /dev/null @@ -1,59 +0,0 @@ - - -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:

-

  • Calendar data

    -

  • Fixes (e.g. LIBOR)

    -

  • Smart contract code

    -

  • Legal documents

    -

  • Facts generated by oracles which might be reused a lot

    -

-
-
-
-

Inherited Properties

- - - - - - - -
-id -abstract val id: SecureHash
-

Functions

- - - - - - - - - - - - - - - -
-extractFile -open fun extractFile(path: String, outputTo: OutputStream): Unit

Finds the named file case insensitively and copies it to the output stream.

-
-open -abstract fun open(): InputStream
-openAsJAR -open fun openAsJAR(): JarInputStream
- - 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 deleted file mode 100644 index d4861d6f58..0000000000 --- a/docs/build/html/api/core/-attachment/open-as-j-a-r.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Attachment.openAsJAR - - - - -core / Attachment / openAsJAR
-
-

openAsJAR

- -open fun openAsJAR(): JarInputStream
-
-
- - diff --git a/docs/build/html/api/core/-attachment/open.html b/docs/build/html/api/core/-attachment/open.html deleted file mode 100644 index f3d25f4b3b..0000000000 --- a/docs/build/html/api/core/-attachment/open.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Attachment.open - - - - -core / Attachment / open
-
-

open

- -abstract fun open(): InputStream
-
-
- - diff --git a/docs/build/html/api/core/-authenticated-object/-init-.html b/docs/build/html/api/core/-authenticated-object/-init-.html deleted file mode 100644 index 110cafc4ed..0000000000 --- a/docs/build/html/api/core/-authenticated-object/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-authenticated-object/index.html b/docs/build/html/api/core/-authenticated-object/index.html deleted file mode 100644 index 7ef638481a..0000000000 --- a/docs/build/html/api/core/-authenticated-object/index.html +++ /dev/null @@ -1,51 +0,0 @@ - - -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 deleted file mode 100644 index acc0700c35..0000000000 --- a/docs/build/html/api/core/-authenticated-object/signers.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AuthenticatedObject.signers - - - - -core / AuthenticatedObject / signers
-
-

signers

- -val signers: List<PublicKey>
-
-
- - diff --git a/docs/build/html/api/core/-authenticated-object/signing-parties.html b/docs/build/html/api/core/-authenticated-object/signing-parties.html deleted file mode 100644 index c18c83829d..0000000000 --- a/docs/build/html/api/core/-authenticated-object/signing-parties.html +++ /dev/null @@ -1,16 +0,0 @@ - - -AuthenticatedObject.signingParties - - - - -core / AuthenticatedObject / signingParties
-
-

signingParties

- -val signingParties: List<Party>
-

If any public keys were recognised, the looked up institutions are available here

-
-
- - diff --git a/docs/build/html/api/core/-authenticated-object/value.html b/docs/build/html/api/core/-authenticated-object/value.html deleted file mode 100644 index 95fd39959a..0000000000 --- a/docs/build/html/api/core/-authenticated-object/value.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AuthenticatedObject.value - - - - -core / AuthenticatedObject / value
-
-

value

- -val value: T
-
-
- - diff --git a/docs/build/html/api/core/-c-h-f.html b/docs/build/html/api/core/-c-h-f.html deleted file mode 100644 index 4fd93288c1..0000000000 --- a/docs/build/html/api/core/-c-h-f.html +++ /dev/null @@ -1,15 +0,0 @@ - - -CHF - - - - -core / CHF
-
-

CHF

- -val CHF: Currency
-
-
- - diff --git a/docs/build/html/api/core/-command-data.html b/docs/build/html/api/core/-command-data.html deleted file mode 100644 index 3163482f90..0000000000 --- a/docs/build/html/api/core/-command-data.html +++ /dev/null @@ -1,53 +0,0 @@ - - -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
-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 deleted file mode 100644 index b6814c2c38..0000000000 --- a/docs/build/html/api/core/-command/-init-.html +++ /dev/null @@ -1,18 +0,0 @@ - - -Command.<init> - - - - -core / Command / <init>
-
-

<init>

-Command(data: CommandData, key: PublicKey)
-
-
-Command(data: CommandData, pubkeys: List<PublicKey>)
-

Command data/content plus pubkey pair: the signature is stored at the end of the serialized bytes

-
-
- - diff --git a/docs/build/html/api/core/-command/data.html b/docs/build/html/api/core/-command/data.html deleted file mode 100644 index 298235cd90..0000000000 --- a/docs/build/html/api/core/-command/data.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Command.data - - - - -core / Command / data
-
-

data

- -val data: CommandData
-
-
- - diff --git a/docs/build/html/api/core/-command/index.html b/docs/build/html/api/core/-command/index.html deleted file mode 100644 index f5f61be84d..0000000000 --- a/docs/build/html/api/core/-command/index.html +++ /dev/null @@ -1,55 +0,0 @@ - - -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

- - - - - - - -
-<init> -Command(data: CommandData, key: PublicKey)Command(data: CommandData, pubkeys: List<PublicKey>)

Command data/content plus pubkey pair: the signature is stored at the end of the serialized bytes

-
-

Properties

- - - - - - - - - - - -
-data -val data: CommandData
-pubkeys -val pubkeys: List<PublicKey>
-

Functions

- - - - - - - -
-toString -fun toString(): String
- - diff --git a/docs/build/html/api/core/-command/pubkeys.html b/docs/build/html/api/core/-command/pubkeys.html deleted file mode 100644 index c5d30b7ba0..0000000000 --- a/docs/build/html/api/core/-command/pubkeys.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Command.pubkeys - - - - -core / Command / pubkeys
-
-

pubkeys

- -val pubkeys: List<PublicKey>
-
-
- - diff --git a/docs/build/html/api/core/-command/to-string.html b/docs/build/html/api/core/-command/to-string.html deleted file mode 100644 index 3d72244f93..0000000000 --- a/docs/build/html/api/core/-command/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Command.toString - - - - -core / Command / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core/-contract-factory/get.html b/docs/build/html/api/core/-contract-factory/get.html deleted file mode 100644 index 400450b227..0000000000 --- a/docs/build/html/api/core/-contract-factory/get.html +++ /dev/null @@ -1,22 +0,0 @@ - - -ContractFactory.get - - - - -core / ContractFactory / get
-
-

get

- -abstract operator fun <T : Contract> get(hash: SecureHash): T
-

Loads, instantiates and returns a contract object from its class bytecodes, given the hash of that bytecode.

-

Exceptions

- -UnknownContractException - if the hash doesnt map to any known contract.
-
- -ClassCastException - if the hash mapped to a contract, but it was not of type T
-
-
- - diff --git a/docs/build/html/api/core/-contract-factory/index.html b/docs/build/html/api/core/-contract-factory/index.html deleted file mode 100644 index c3e24c8b91..0000000000 --- a/docs/build/html/api/core/-contract-factory/index.html +++ /dev/null @@ -1,27 +0,0 @@ - - -ContractFactory - - - - -core / ContractFactory
-
-

ContractFactory

-interface ContractFactory
-

A contract factory knows how to lazily load and instantiate contract objects.

-
-
-

Functions

- - - - - - - -
-get -abstract operator fun <T : Contract> get(hash: SecureHash): T

Loads, instantiates and returns a contract object from its class bytecodes, given the hash of that bytecode.

-
- - diff --git a/docs/build/html/api/core/-contract-state/index.html b/docs/build/html/api/core/-contract-state/index.html deleted file mode 100644 index 12ae8874cd..0000000000 --- a/docs/build/html/api/core/-contract-state/index.html +++ /dev/null @@ -1,66 +0,0 @@ - - -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

- - - - - - - -
-programRef -abstract val programRef: SecureHash

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
-

Extension Functions

- - - - - - - -
-hash -fun ContractState.hash(): SecureHash

Returns the SHA-256 hash of the serialised contents of this state (not cached)

-
-

Inheritors

- - - - - - - - - - - - - - - -
-OwnableState -interface OwnableState : ContractState
-State -data class State : ContractState
-State -class State : ContractState
- - diff --git a/docs/build/html/api/core/-contract-state/program-ref.html b/docs/build/html/api/core/-contract-state/program-ref.html deleted file mode 100644 index 01cce5bd88..0000000000 --- a/docs/build/html/api/core/-contract-state/program-ref.html +++ /dev/null @@ -1,18 +0,0 @@ - - -ContractState.programRef - - - - -core / ContractState / programRef
-
-

programRef

- -abstract val programRef: SecureHash
-

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
-
- - diff --git a/docs/build/html/api/core/-contract/index.html b/docs/build/html/api/core/-contract/index.html deleted file mode 100644 index 73df0a1fda..0000000000 --- a/docs/build/html/api/core/-contract/index.html +++ /dev/null @@ -1,82 +0,0 @@ - - -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
- - diff --git a/docs/build/html/api/core/-contract/legal-contract-reference.html b/docs/build/html/api/core/-contract/legal-contract-reference.html deleted file mode 100644 index ad62fa457e..0000000000 --- a/docs/build/html/api/core/-contract/legal-contract-reference.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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).

-
-
- - diff --git a/docs/build/html/api/core/-contract/verify.html b/docs/build/html/api/core/-contract/verify.html deleted file mode 100644 index b2b6b174b9..0000000000 --- a/docs/build/html/api/core/-contract/verify.html +++ /dev/null @@ -1,19 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-g-b-p.html b/docs/build/html/api/core/-g-b-p.html deleted file mode 100644 index 6118a89695..0000000000 --- a/docs/build/html/api/core/-g-b-p.html +++ /dev/null @@ -1,15 +0,0 @@ - - -GBP - - - - -core / GBP
-
-

GBP

- -val GBP: Currency
-
-
- - diff --git a/docs/build/html/api/core/-ledger-transaction/-init-.html b/docs/build/html/api/core/-ledger-transaction/-init-.html deleted file mode 100644 index ef9a827d44..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/-init-.html +++ /dev/null @@ -1,20 +0,0 @@ - - -LedgerTransaction.<init> - - - - -core / LedgerTransaction / <init>
-
-

<init>

-LedgerTransaction(inputs: List<StateRef>, attachments: List<Attachment>, outputs: List<ContractState>, commands: List<AuthenticatedObject<CommandData>>, hash: 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?

-
-
-
-
- - diff --git a/docs/build/html/api/core/-ledger-transaction/attachments.html b/docs/build/html/api/core/-ledger-transaction/attachments.html deleted file mode 100644 index 3d8e61e964..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/attachments.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-ledger-transaction/commands.html b/docs/build/html/api/core/-ledger-transaction/commands.html deleted file mode 100644 index e182fc5ceb..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/commands.html +++ /dev/null @@ -1,16 +0,0 @@ - - -LedgerTransaction.commands - - - - -core / LedgerTransaction / commands
-
-

commands

- -val commands: List<AuthenticatedObject<CommandData>>
-

Arbitrary data passed to the program of each input state.

-
-
- - diff --git a/docs/build/html/api/core/-ledger-transaction/hash.html b/docs/build/html/api/core/-ledger-transaction/hash.html deleted file mode 100644 index 0e1bf68a88..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/hash.html +++ /dev/null @@ -1,16 +0,0 @@ - - -LedgerTransaction.hash - - - - -core / LedgerTransaction / hash
-
-

hash

- -val hash: SecureHash
-

The hash of the original serialised WireTransaction

-
-
- - diff --git a/docs/build/html/api/core/-ledger-transaction/index.html b/docs/build/html/api/core/-ledger-transaction/index.html deleted file mode 100644 index b134aad957..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/index.html +++ /dev/null @@ -1,99 +0,0 @@ - - -LedgerTransaction - - - - -core / LedgerTransaction
-
-

LedgerTransaction

-data class 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.

-

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>>, hash: 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.

-
-hash -val hash: 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

- - - - - - - - - - - - - - - -
-outRef -fun <T : ContractState> outRef(index: Int): StateAndRef<T>
-toSignedTransaction -fun toSignedTransaction(andSignWithKeys: List<KeyPair> = emptyList(), allowUnusedKeys: Boolean = false): SignedTransaction

Converts this transaction to SignedTransaction form, optionally using the provided keys to sign. There is -no requirement that andSignWithKeys include all required keys.

-
-toWireTransaction -fun toWireTransaction(): WireTransaction
- - diff --git a/docs/build/html/api/core/-ledger-transaction/inputs.html b/docs/build/html/api/core/-ledger-transaction/inputs.html deleted file mode 100644 index 1cb40b5a5d..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/inputs.html +++ /dev/null @@ -1,16 +0,0 @@ - - -LedgerTransaction.inputs - - - - -core / LedgerTransaction / inputs
-
-

inputs

- -val inputs: List<StateRef>
-

The input states which will be consumed/invalidated by the execution of this transaction.

-
-
- - diff --git a/docs/build/html/api/core/-ledger-transaction/out-ref.html b/docs/build/html/api/core/-ledger-transaction/out-ref.html deleted file mode 100644 index 89848282ca..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/out-ref.html +++ /dev/null @@ -1,15 +0,0 @@ - - -LedgerTransaction.outRef - - - - -core / LedgerTransaction / outRef
-
-

outRef

- -fun <T : ContractState> outRef(index: Int): StateAndRef<T>
-
-
- - diff --git a/docs/build/html/api/core/-ledger-transaction/outputs.html b/docs/build/html/api/core/-ledger-transaction/outputs.html deleted file mode 100644 index fbdb16b89d..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/outputs.html +++ /dev/null @@ -1,16 +0,0 @@ - - -LedgerTransaction.outputs - - - - -core / LedgerTransaction / outputs
-
-

outputs

- -val outputs: List<ContractState>
-

The states that will be generated by the execution of this transaction.

-
-
- - diff --git a/docs/build/html/api/core/-ledger-transaction/to-signed-transaction.html b/docs/build/html/api/core/-ledger-transaction/to-signed-transaction.html deleted file mode 100644 index a3aa101c9d..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/to-signed-transaction.html +++ /dev/null @@ -1,21 +0,0 @@ - - -LedgerTransaction.toSignedTransaction - - - - -core / LedgerTransaction / toSignedTransaction
-
-

toSignedTransaction

- -fun toSignedTransaction(andSignWithKeys: List<KeyPair> = emptyList(), allowUnusedKeys: Boolean = false): SignedTransaction
-

Converts this transaction to SignedTransaction form, optionally using the provided keys to sign. There is -no requirement that andSignWithKeys include all required keys.

-

Exceptions

- -IllegalArgumentException - if a key is provided that isnt listed in any command and allowUnusedKeys -is false.
-
-
- - diff --git a/docs/build/html/api/core/-ledger-transaction/to-wire-transaction.html b/docs/build/html/api/core/-ledger-transaction/to-wire-transaction.html deleted file mode 100644 index a565cf409c..0000000000 --- a/docs/build/html/api/core/-ledger-transaction/to-wire-transaction.html +++ /dev/null @@ -1,15 +0,0 @@ - - -LedgerTransaction.toWireTransaction - - - - -core / LedgerTransaction / toWireTransaction
-
-

toWireTransaction

- -fun toWireTransaction(): WireTransaction
-
-
- - diff --git a/docs/build/html/api/core/-named-by-hash/id.html b/docs/build/html/api/core/-named-by-hash/id.html deleted file mode 100644 index 8e28e971aa..0000000000 --- a/docs/build/html/api/core/-named-by-hash/id.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NamedByHash.id - - - - -core / NamedByHash / id
-
-

id

- -abstract val id: SecureHash
-
-
- - diff --git a/docs/build/html/api/core/-named-by-hash/index.html b/docs/build/html/api/core/-named-by-hash/index.html deleted file mode 100644 index 4bc8f0cf5b..0000000000 --- a/docs/build/html/api/core/-named-by-hash/index.html +++ /dev/null @@ -1,54 +0,0 @@ - - -NamedByHash - - - - -core / NamedByHash
-
-

NamedByHash

-interface NamedByHash
-

Implemented by anything that can be named by a secure hash value (e.g. transactions, attachments).

-
-
-

Properties

- - - - - - - -
-id -abstract val id: SecureHash
-

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:

-
-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 deleted file mode 100644 index 8ebeea0bef..0000000000 --- a/docs/build/html/api/core/-ownable-state/index.html +++ /dev/null @@ -1,82 +0,0 @@ - - -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

- - - - - - - -
-programRef -abstract val programRef: SecureHash

Refers to a bytecode program that has previously been published to the network. This contract program -will be executed any time this state is used in an input. It must accept in order for the -transaction to proceed.

-
-

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 deleted file mode 100644 index 05d702d1bb..0000000000 --- a/docs/build/html/api/core/-ownable-state/owner.html +++ /dev/null @@ -1,16 +0,0 @@ - - -OwnableState.owner - - - - -core / OwnableState / owner
-
-

owner

- -abstract val owner: PublicKey
-

There must be a MoveCommand signed by this key to claim the amount

-
-
- - diff --git a/docs/build/html/api/core/-ownable-state/with-new-owner.html b/docs/build/html/api/core/-ownable-state/with-new-owner.html deleted file mode 100644 index 1b9b41d8e0..0000000000 --- a/docs/build/html/api/core/-ownable-state/with-new-owner.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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

-
-
- - diff --git a/docs/build/html/api/core/-party-reference/-init-.html b/docs/build/html/api/core/-party-reference/-init-.html deleted file mode 100644 index 391c96996e..0000000000 --- a/docs/build/html/api/core/-party-reference/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-party-reference/index.html b/docs/build/html/api/core/-party-reference/index.html deleted file mode 100644 index 8558a27a13..0000000000 --- a/docs/build/html/api/core/-party-reference/index.html +++ /dev/null @@ -1,57 +0,0 @@ - - -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

- - - - - - - - - - - -
-party -val party: Party
-reference -val reference: OpaqueBytes
-

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 deleted file mode 100644 index d7bdeec32a..0000000000 --- a/docs/build/html/api/core/-party-reference/party.html +++ /dev/null @@ -1,15 +0,0 @@ - - -PartyReference.party - - - - -core / PartyReference / party
-
-

party

- -val party: Party
-
-
- - diff --git a/docs/build/html/api/core/-party-reference/reference.html b/docs/build/html/api/core/-party-reference/reference.html deleted file mode 100644 index bf0508c7fc..0000000000 --- a/docs/build/html/api/core/-party-reference/reference.html +++ /dev/null @@ -1,15 +0,0 @@ - - -PartyReference.reference - - - - -core / PartyReference / reference
-
-

reference

- -val reference: OpaqueBytes
-
-
- - diff --git a/docs/build/html/api/core/-party-reference/to-string.html b/docs/build/html/api/core/-party-reference/to-string.html deleted file mode 100644 index 57795715c5..0000000000 --- a/docs/build/html/api/core/-party-reference/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -PartyReference.toString - - - - -core / PartyReference / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core/-party/-init-.html b/docs/build/html/api/core/-party/-init-.html deleted file mode 100644 index fa5b451522..0000000000 --- a/docs/build/html/api/core/-party/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-party/index.html b/docs/build/html/api/core/-party/index.html deleted file mode 100644 index 41d06a0151..0000000000 --- a/docs/build/html/api/core/-party/index.html +++ /dev/null @@ -1,62 +0,0 @@ - - -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

- - - - - - - - - - - -
-name -val name: String
-owningKey -val owningKey: PublicKey
-

Functions

- - - - - - - - - - - -
-ref -fun ref(bytes: OpaqueBytes): PartyReference
-fun ref(vararg bytes: Byte): PartyReference
-toString -fun toString(): String
- - diff --git a/docs/build/html/api/core/-party/name.html b/docs/build/html/api/core/-party/name.html deleted file mode 100644 index 1153a4a85e..0000000000 --- a/docs/build/html/api/core/-party/name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Party.name - - - - -core / Party / name
-
-

name

- -val name: String
-
-
- - diff --git a/docs/build/html/api/core/-party/owning-key.html b/docs/build/html/api/core/-party/owning-key.html deleted file mode 100644 index efbbdff22f..0000000000 --- a/docs/build/html/api/core/-party/owning-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Party.owningKey - - - - -core / Party / owningKey
-
-

owningKey

- -val owningKey: PublicKey
-
-
- - diff --git a/docs/build/html/api/core/-party/ref.html b/docs/build/html/api/core/-party/ref.html deleted file mode 100644 index 94db4e8377..0000000000 --- a/docs/build/html/api/core/-party/ref.html +++ /dev/null @@ -1,17 +0,0 @@ - - -Party.ref - - - - -core / Party / ref
-
-

ref

- -fun ref(bytes: OpaqueBytes): PartyReference
- -fun ref(vararg bytes: Byte): PartyReference
-
-
- - diff --git a/docs/build/html/api/core/-party/to-string.html b/docs/build/html/api/core/-party/to-string.html deleted file mode 100644 index 37c022f67c..0000000000 --- a/docs/build/html/api/core/-party/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Party.toString - - - - -core / Party / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core/-r.html b/docs/build/html/api/core/-r.html deleted file mode 100644 index 46acd4906d..0000000000 --- a/docs/build/html/api/core/-r.html +++ /dev/null @@ -1,15 +0,0 @@ - - -R - - - - -core / R
-
-

R

- -val R: Requirements
-
-
- - diff --git a/docs/build/html/api/core/-requirements/-init-.html b/docs/build/html/api/core/-requirements/-init-.html deleted file mode 100644 index 4a56980dff..0000000000 --- a/docs/build/html/api/core/-requirements/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -Requirements.<init> - - - - -core / Requirements / <init>
-
-

<init>

-Requirements()
-
-
- - diff --git a/docs/build/html/api/core/-requirements/by.html b/docs/build/html/api/core/-requirements/by.html deleted file mode 100644 index 63dc9d818a..0000000000 --- a/docs/build/html/api/core/-requirements/by.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Requirements.by - - - - -core / Requirements / by
-
-

by

- -infix fun String.by(expr: Boolean): Unit
-
-
- - diff --git a/docs/build/html/api/core/-requirements/index.html b/docs/build/html/api/core/-requirements/index.html deleted file mode 100644 index bd3ab917b5..0000000000 --- a/docs/build/html/api/core/-requirements/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -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 deleted file mode 100644 index 2d10a41e9d..0000000000 --- a/docs/build/html/api/core/-run-on-caller-thread.html +++ /dev/null @@ -1,15 +0,0 @@ - - -RunOnCallerThread - - - - -core / RunOnCallerThread
-
-

RunOnCallerThread

- -val RunOnCallerThread: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core/-signed-transaction/-init-.html b/docs/build/html/api/core/-signed-transaction/-init-.html deleted file mode 100644 index 15149417df..0000000000 --- a/docs/build/html/api/core/-signed-transaction/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SignedTransaction.<init> - - - - -core / SignedTransaction / <init>
-
-

<init>

-SignedTransaction(txBits: SerializedBytes<WireTransaction>, sigs: List<WithKey>)
-

Container for a WireTransaction and attached signatures.

-
-
- - diff --git a/docs/build/html/api/core/-signed-transaction/id.html b/docs/build/html/api/core/-signed-transaction/id.html deleted file mode 100644 index 7e14131fd3..0000000000 --- a/docs/build/html/api/core/-signed-transaction/id.html +++ /dev/null @@ -1,17 +0,0 @@ - - -SignedTransaction.id - - - - -core / SignedTransaction / id
-
-

id

- -val id: SecureHash
-Overrides NamedByHash.id
-

A transaction ID is the hash of the WireTransaction. Thus adding or removing a signature does not change it.

-
-
- - diff --git a/docs/build/html/api/core/-signed-transaction/index.html b/docs/build/html/api/core/-signed-transaction/index.html deleted file mode 100644 index c67d44ecb5..0000000000 --- a/docs/build/html/api/core/-signed-transaction/index.html +++ /dev/null @@ -1,108 +0,0 @@ - - -SignedTransaction - - - - -core / SignedTransaction
-
-

SignedTransaction

-data class SignedTransaction : NamedByHash
-

Container for a WireTransaction and attached signatures.

-
-
-

Constructors

- - - - - - - -
-<init> -SignedTransaction(txBits: SerializedBytes<WireTransaction>, sigs: List<WithKey>)

Container for a WireTransaction and attached signatures.

-
-

Properties

- - - - - - - - - - - - - - - - - - - -
-id -val id: SecureHash

A transaction ID is the hash of the WireTransaction. Thus adding or removing a signature does not change it.

-
-sigs -val sigs: List<WithKey>
-tx -val tx: WireTransaction

Lazily calculated access to the deserialised/hashed transaction data.

-
-txBits -val txBits: SerializedBytes<WireTransaction>
-

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

- - - - - - - -
-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/-signed-transaction/plus.html b/docs/build/html/api/core/-signed-transaction/plus.html deleted file mode 100644 index 378a35e540..0000000000 --- a/docs/build/html/api/core/-signed-transaction/plus.html +++ /dev/null @@ -1,16 +0,0 @@ - - -SignedTransaction.plus - - - - -core / SignedTransaction / plus
-
-

plus

- -operator fun plus(sig: WithKey): SignedTransaction
-

Alias for withAdditionalSignature to let you use Kotlin operator overloading.

-
-
- - diff --git a/docs/build/html/api/core/-signed-transaction/sigs.html b/docs/build/html/api/core/-signed-transaction/sigs.html deleted file mode 100644 index f8b0561c3d..0000000000 --- a/docs/build/html/api/core/-signed-transaction/sigs.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SignedTransaction.sigs - - - - -core / SignedTransaction / sigs
-
-

sigs

- -val sigs: List<WithKey>
-
-
- - diff --git a/docs/build/html/api/core/-signed-transaction/tx-bits.html b/docs/build/html/api/core/-signed-transaction/tx-bits.html deleted file mode 100644 index 0662e6cad7..0000000000 --- a/docs/build/html/api/core/-signed-transaction/tx-bits.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SignedTransaction.txBits - - - - -core / SignedTransaction / txBits
-
-

txBits

- -val txBits: SerializedBytes<WireTransaction>
-
-
- - diff --git a/docs/build/html/api/core/-signed-transaction/tx.html b/docs/build/html/api/core/-signed-transaction/tx.html deleted file mode 100644 index a42c1611c4..0000000000 --- a/docs/build/html/api/core/-signed-transaction/tx.html +++ /dev/null @@ -1,19 +0,0 @@ - - -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.

-
-
-
- - diff --git a/docs/build/html/api/core/-signed-transaction/verify-signatures.html b/docs/build/html/api/core/-signed-transaction/verify-signatures.html deleted file mode 100644 index 73eebd118d..0000000000 --- a/docs/build/html/api/core/-signed-transaction/verify-signatures.html +++ /dev/null @@ -1,21 +0,0 @@ - - -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.
-
-
- - diff --git a/docs/build/html/api/core/-signed-transaction/verify.html b/docs/build/html/api/core/-signed-transaction/verify.html deleted file mode 100644 index a2370789fc..0000000000 --- a/docs/build/html/api/core/-signed-transaction/verify.html +++ /dev/null @@ -1,21 +0,0 @@ - - -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.
-
-
- - diff --git a/docs/build/html/api/core/-signed-transaction/with-additional-signature.html b/docs/build/html/api/core/-signed-transaction/with-additional-signature.html deleted file mode 100644 index 4c5d153c6a..0000000000 --- a/docs/build/html/api/core/-signed-transaction/with-additional-signature.html +++ /dev/null @@ -1,16 +0,0 @@ - - -SignedTransaction.withAdditionalSignature - - - - -core / SignedTransaction / withAdditionalSignature
-
-

withAdditionalSignature

- -fun withAdditionalSignature(sig: WithKey): SignedTransaction
-

Returns the same transaction but with an additional (unchecked) signature

-
-
- - diff --git a/docs/build/html/api/core/-state-and-ref/-init-.html b/docs/build/html/api/core/-state-and-ref/-init-.html deleted file mode 100644 index 785f77d98a..0000000000 --- a/docs/build/html/api/core/-state-and-ref/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-state-and-ref/index.html b/docs/build/html/api/core/-state-and-ref/index.html deleted file mode 100644 index f702ce9c39..0000000000 --- a/docs/build/html/api/core/-state-and-ref/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - -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

- - - - - - - - - - - -
-ref -val ref: StateRef
-state -val state: T
- - diff --git a/docs/build/html/api/core/-state-and-ref/ref.html b/docs/build/html/api/core/-state-and-ref/ref.html deleted file mode 100644 index dca8979b3d..0000000000 --- a/docs/build/html/api/core/-state-and-ref/ref.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateAndRef.ref - - - - -core / StateAndRef / ref
-
-

ref

- -val ref: StateRef
-
-
- - diff --git a/docs/build/html/api/core/-state-and-ref/state.html b/docs/build/html/api/core/-state-and-ref/state.html deleted file mode 100644 index 99ea8ed1b2..0000000000 --- a/docs/build/html/api/core/-state-and-ref/state.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateAndRef.state - - - - -core / StateAndRef / state
-
-

state

- -val state: T
-
-
- - diff --git a/docs/build/html/api/core/-state-ref/--index--.html b/docs/build/html/api/core/-state-ref/--index--.html deleted file mode 100644 index 7c49cd8dfd..0000000000 --- a/docs/build/html/api/core/-state-ref/--index--.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateRef.index - - - - -core / StateRef / index
-
-

index

- -val index: Int
-
-
- - diff --git a/docs/build/html/api/core/-state-ref/-init-.html b/docs/build/html/api/core/-state-ref/-init-.html deleted file mode 100644 index 0e1deb3305..0000000000 --- a/docs/build/html/api/core/-state-ref/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-state-ref/index.html b/docs/build/html/api/core/-state-ref/index.html deleted file mode 100644 index 294ae34657..0000000000 --- a/docs/build/html/api/core/-state-ref/index.html +++ /dev/null @@ -1,57 +0,0 @@ - - -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

- - - - - - - - - - - -
-index -val index: Int
-txhash -val txhash: SecureHash
-

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 deleted file mode 100644 index be423b2e16..0000000000 --- a/docs/build/html/api/core/-state-ref/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateRef.toString - - - - -core / StateRef / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core/-state-ref/txhash.html b/docs/build/html/api/core/-state-ref/txhash.html deleted file mode 100644 index 7b6af23e3e..0000000000 --- a/docs/build/html/api/core/-state-ref/txhash.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateRef.txhash - - - - -core / StateRef / txhash
-
-

txhash

- -val txhash: SecureHash
-
-
- - diff --git a/docs/build/html/api/core/-thread-box/-init-.html b/docs/build/html/api/core/-thread-box/-init-.html deleted file mode 100644 index b2663f3dab..0000000000 --- a/docs/build/html/api/core/-thread-box/-init-.html +++ /dev/null @@ -1,27 +0,0 @@ - - -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 }

-
-
-
-
- - diff --git a/docs/build/html/api/core/-thread-box/content.html b/docs/build/html/api/core/-thread-box/content.html deleted file mode 100644 index 3af41ad0f2..0000000000 --- a/docs/build/html/api/core/-thread-box/content.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ThreadBox.content - - - - -core / ThreadBox / content
-
-

content

- -val content: T
-
-
- - diff --git a/docs/build/html/api/core/-thread-box/index.html b/docs/build/html/api/core/-thread-box/index.html deleted file mode 100644 index 5ef3d01d64..0000000000 --- a/docs/build/html/api/core/-thread-box/index.html +++ /dev/null @@ -1,70 +0,0 @@ - - -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

- - - - - - - - - - - -
-content -val content: T
-lock -val lock: Lock
-

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 deleted file mode 100644 index d504ba21f6..0000000000 --- a/docs/build/html/api/core/-thread-box/lock.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ThreadBox.lock - - - - -core / ThreadBox / lock
-
-

lock

- -val lock: Lock
-
-
- - diff --git a/docs/build/html/api/core/-thread-box/locked.html b/docs/build/html/api/core/-thread-box/locked.html deleted file mode 100644 index e139683f82..0000000000 --- a/docs/build/html/api/core/-thread-box/locked.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ThreadBox.locked - - - - -core / ThreadBox / locked
-
-

locked

- -inline fun <R> locked(body: T.() -> R): R
-
-
- - diff --git a/docs/build/html/api/core/-timestamp-command/-init-.html b/docs/build/html/api/core/-timestamp-command/-init-.html deleted file mode 100644 index 17d53a13ec..0000000000 --- a/docs/build/html/api/core/-timestamp-command/-init-.html +++ /dev/null @@ -1,19 +0,0 @@ - - -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)

-
-
- - diff --git a/docs/build/html/api/core/-timestamp-command/after.html b/docs/build/html/api/core/-timestamp-command/after.html deleted file mode 100644 index 4729a1a421..0000000000 --- a/docs/build/html/api/core/-timestamp-command/after.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampCommand.after - - - - -core / TimestampCommand / after
-
-

after

- -val after: Instant?
-
-
- - diff --git a/docs/build/html/api/core/-timestamp-command/before.html b/docs/build/html/api/core/-timestamp-command/before.html deleted file mode 100644 index 3c4739ac9c..0000000000 --- a/docs/build/html/api/core/-timestamp-command/before.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampCommand.before - - - - -core / TimestampCommand / before
-
-

before

- -val before: Instant?
-
-
- - diff --git a/docs/build/html/api/core/-timestamp-command/index.html b/docs/build/html/api/core/-timestamp-command/index.html deleted file mode 100644 index ada95f943b..0000000000 --- a/docs/build/html/api/core/-timestamp-command/index.html +++ /dev/null @@ -1,52 +0,0 @@ - - -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

- - - - - - - - - - - - - - - -
-after -val after: Instant?
-before -val before: Instant?
-midpoint -val midpoint: Instant
- - diff --git a/docs/build/html/api/core/-timestamp-command/midpoint.html b/docs/build/html/api/core/-timestamp-command/midpoint.html deleted file mode 100644 index 80dc20b682..0000000000 --- a/docs/build/html/api/core/-timestamp-command/midpoint.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampCommand.midpoint - - - - -core / TimestampCommand / midpoint
-
-

midpoint

- -val midpoint: Instant
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/-init-.html b/docs/build/html/api/core/-transaction-builder/-init-.html deleted file mode 100644 index 70f8977139..0000000000 --- a/docs/build/html/api/core/-transaction-builder/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.<init> - - - - -core / TransactionBuilder / <init>
-
-

<init>

-TransactionBuilder(inputs: MutableList<StateRef> = arrayListOf(), attachments: MutableList<SecureHash> = arrayListOf(), outputs: MutableList<ContractState> = arrayListOf(), commands: MutableList<Command> = arrayListOf())
-

A mutable transaction thats in the process of being built, before all signatures are present.

-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/add-attachment.html b/docs/build/html/api/core/-transaction-builder/add-attachment.html deleted file mode 100644 index 77e037bd6e..0000000000 --- a/docs/build/html/api/core/-transaction-builder/add-attachment.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.addAttachment - - - - -core / TransactionBuilder / addAttachment
-
-

addAttachment

- -fun addAttachment(attachment: Attachment): Unit
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/add-command.html b/docs/build/html/api/core/-transaction-builder/add-command.html deleted file mode 100644 index 1860833e0f..0000000000 --- a/docs/build/html/api/core/-transaction-builder/add-command.html +++ /dev/null @@ -1,19 +0,0 @@ - - -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
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/add-input-state.html b/docs/build/html/api/core/-transaction-builder/add-input-state.html deleted file mode 100644 index 6de3d63ea9..0000000000 --- a/docs/build/html/api/core/-transaction-builder/add-input-state.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.addInputState - - - - -core / TransactionBuilder / addInputState
-
-

addInputState

- -fun addInputState(ref: StateRef): Unit
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/add-output-state.html b/docs/build/html/api/core/-transaction-builder/add-output-state.html deleted file mode 100644 index 38345bd685..0000000000 --- a/docs/build/html/api/core/-transaction-builder/add-output-state.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.addOutputState - - - - -core / TransactionBuilder / addOutputState
-
-

addOutputState

- -fun addOutputState(state: ContractState): Unit
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/add-signature-unchecked.html b/docs/build/html/api/core/-transaction-builder/add-signature-unchecked.html deleted file mode 100644 index ac3d4214a9..0000000000 --- a/docs/build/html/api/core/-transaction-builder/add-signature-unchecked.html +++ /dev/null @@ -1,16 +0,0 @@ - - -TransactionBuilder.addSignatureUnchecked - - - - -core / TransactionBuilder / addSignatureUnchecked
-
-

addSignatureUnchecked

- -fun addSignatureUnchecked(sig: WithKey): Unit
-

Adds the signature directly to the transaction, without checking it for validity.

-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/attachments.html b/docs/build/html/api/core/-transaction-builder/attachments.html deleted file mode 100644 index bd2236fba7..0000000000 --- a/docs/build/html/api/core/-transaction-builder/attachments.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.attachments - - - - -core / TransactionBuilder / attachments
-
-

attachments

- -fun attachments(): List<SecureHash>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/check-and-add-signature.html b/docs/build/html/api/core/-transaction-builder/check-and-add-signature.html deleted file mode 100644 index 4b2d72310f..0000000000 --- a/docs/build/html/api/core/-transaction-builder/check-and-add-signature.html +++ /dev/null @@ -1,23 +0,0 @@ - - -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 contents
-
- -IllegalArgumentException - if the signature key doesnt appear in any command.
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/check-signature.html b/docs/build/html/api/core/-transaction-builder/check-signature.html deleted file mode 100644 index 00cae79b38..0000000000 --- a/docs/build/html/api/core/-transaction-builder/check-signature.html +++ /dev/null @@ -1,22 +0,0 @@ - - -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 contents
-
- -IllegalArgumentException - if the signature key doesnt appear in any command.
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/commands.html b/docs/build/html/api/core/-transaction-builder/commands.html deleted file mode 100644 index 5e27c7fd88..0000000000 --- a/docs/build/html/api/core/-transaction-builder/commands.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.commands - - - - -core / TransactionBuilder / commands
-
-

commands

- -fun commands(): List<Command>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/index.html b/docs/build/html/api/core/-transaction-builder/index.html deleted file mode 100644 index 1dc146f168..0000000000 --- a/docs/build/html/api/core/-transaction-builder/index.html +++ /dev/null @@ -1,158 +0,0 @@ - - -TransactionBuilder - - - - -core / TransactionBuilder
-
-

TransactionBuilder

-class TransactionBuilder
-

A mutable transaction thats in the process of being built, before all signatures are present.

-
-
-

Constructors

- - - - - - - -
-<init> -TransactionBuilder(inputs: MutableList<StateRef> = arrayListOf(), attachments: MutableList<SecureHash> = arrayListOf(), outputs: MutableList<ContractState> = arrayListOf(), commands: MutableList<Command> = arrayListOf())

A mutable transaction thats in the process of being built, before all signatures are present.

-
-

Properties

- - - - - - - -
-time -val time: TimestampCommand?
-

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 deleted file mode 100644 index 895cde09ac..0000000000 --- a/docs/build/html/api/core/-transaction-builder/input-states.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.inputStates - - - - -core / TransactionBuilder / inputStates
-
-

inputStates

- -fun inputStates(): List<StateRef>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/output-states.html b/docs/build/html/api/core/-transaction-builder/output-states.html deleted file mode 100644 index 772d46ba12..0000000000 --- a/docs/build/html/api/core/-transaction-builder/output-states.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.outputStates - - - - -core / TransactionBuilder / outputStates
-
-

outputStates

- -fun outputStates(): List<ContractState>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/set-time.html b/docs/build/html/api/core/-transaction-builder/set-time.html deleted file mode 100644 index 1f9c8bc8f5..0000000000 --- a/docs/build/html/api/core/-transaction-builder/set-time.html +++ /dev/null @@ -1,26 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/sign-with.html b/docs/build/html/api/core/-transaction-builder/sign-with.html deleted file mode 100644 index 232bbf126c..0000000000 --- a/docs/build/html/api/core/-transaction-builder/sign-with.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.signWith - - - - -core / TransactionBuilder / signWith
-
-

signWith

- -fun signWith(key: KeyPair): Unit
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/time.html b/docs/build/html/api/core/-transaction-builder/time.html deleted file mode 100644 index 32ee561872..0000000000 --- a/docs/build/html/api/core/-transaction-builder/time.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.time - - - - -core / TransactionBuilder / time
-
-

time

- -val time: TimestampCommand?
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/timestamp.html b/docs/build/html/api/core/-transaction-builder/timestamp.html deleted file mode 100644 index 1cf5ed01da..0000000000 --- a/docs/build/html/api/core/-transaction-builder/timestamp.html +++ /dev/null @@ -1,23 +0,0 @@ - - -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:

-

  • Cross border contracts where local law says that only local timestamping authorities are acceptable.

    -

  • Backup in case a TSAs signing key is compromised.

    -

The signature of the trusted timestamper merely asserts that the time field of this transaction is valid.

-
-
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/to-signed-transaction.html b/docs/build/html/api/core/-transaction-builder/to-signed-transaction.html deleted file mode 100644 index c9f4b2881e..0000000000 --- a/docs/build/html/api/core/-transaction-builder/to-signed-transaction.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.toSignedTransaction - - - - -core / TransactionBuilder / toSignedTransaction
-
-

toSignedTransaction

- -fun toSignedTransaction(checkSufficientSignatures: Boolean = true): SignedTransaction
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/to-wire-transaction.html b/docs/build/html/api/core/-transaction-builder/to-wire-transaction.html deleted file mode 100644 index e4a335085b..0000000000 --- a/docs/build/html/api/core/-transaction-builder/to-wire-transaction.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionBuilder.toWireTransaction - - - - -core / TransactionBuilder / toWireTransaction
-
-

toWireTransaction

- -fun toWireTransaction(): WireTransaction
-
-
- - diff --git a/docs/build/html/api/core/-transaction-builder/with-items.html b/docs/build/html/api/core/-transaction-builder/with-items.html deleted file mode 100644 index ceb0d0fc8f..0000000000 --- a/docs/build/html/api/core/-transaction-builder/with-items.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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

-
-
- - diff --git a/docs/build/html/api/core/-transaction-conflict-exception/-init-.html b/docs/build/html/api/core/-transaction-conflict-exception/-init-.html deleted file mode 100644 index 9b42e736cd..0000000000 --- a/docs/build/html/api/core/-transaction-conflict-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TransactionConflictException.<init> - - - - -core / TransactionConflictException / <init>
-
-

<init>

-TransactionConflictException(conflictRef: StateRef, tx1: LedgerTransaction, tx2: LedgerTransaction)
-
-
- - diff --git a/docs/build/html/api/core/-transaction-conflict-exception/conflict-ref.html b/docs/build/html/api/core/-transaction-conflict-exception/conflict-ref.html deleted file mode 100644 index 5761ba0597..0000000000 --- a/docs/build/html/api/core/-transaction-conflict-exception/conflict-ref.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionConflictException.conflictRef - - - - -core / TransactionConflictException / conflictRef
-
-

conflictRef

- -val conflictRef: StateRef
-
-
- - diff --git a/docs/build/html/api/core/-transaction-conflict-exception/index.html b/docs/build/html/api/core/-transaction-conflict-exception/index.html deleted file mode 100644 index 61082d4fad..0000000000 --- a/docs/build/html/api/core/-transaction-conflict-exception/index.html +++ /dev/null @@ -1,48 +0,0 @@ - - -TransactionConflictException - - - - -core / TransactionConflictException
-
-

TransactionConflictException

-class TransactionConflictException : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -TransactionConflictException(conflictRef: StateRef, tx1: LedgerTransaction, tx2: LedgerTransaction)
-

Properties

- - - - - - - - - - - - - - - -
-conflictRef -val conflictRef: StateRef
-tx1 -val tx1: LedgerTransaction
-tx2 -val tx2: LedgerTransaction
- - diff --git a/docs/build/html/api/core/-transaction-conflict-exception/tx1.html b/docs/build/html/api/core/-transaction-conflict-exception/tx1.html deleted file mode 100644 index acbf905a20..0000000000 --- a/docs/build/html/api/core/-transaction-conflict-exception/tx1.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionConflictException.tx1 - - - - -core / TransactionConflictException / tx1
-
-

tx1

- -val tx1: LedgerTransaction
-
-
- - diff --git a/docs/build/html/api/core/-transaction-conflict-exception/tx2.html b/docs/build/html/api/core/-transaction-conflict-exception/tx2.html deleted file mode 100644 index ab6e84e697..0000000000 --- a/docs/build/html/api/core/-transaction-conflict-exception/tx2.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionConflictException.tx2 - - - - -core / TransactionConflictException / tx2
-
-

tx2

- -val tx2: LedgerTransaction
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/-in-out-group/-init-.html b/docs/build/html/api/core/-transaction-for-verification/-in-out-group/-init-.html deleted file mode 100644 index e1f4ac61e4..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/-in-out-group/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.InOutGroup.<init> - - - - -core / TransactionForVerification / InOutGroup / <init>
-
-

<init>

-InOutGroup(inputs: List<T>, outputs: List<T>)
-

Utilities for contract writers to incorporate into their logic.

-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/-in-out-group/index.html b/docs/build/html/api/core/-transaction-for-verification/-in-out-group/index.html deleted file mode 100644 index 25512177be..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/-in-out-group/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - -TransactionForVerification.InOutGroup - - - - -core / TransactionForVerification / InOutGroup
-
-

InOutGroup

-data class InOutGroup<T : ContractState>
-

Utilities for contract writers to incorporate into their logic.

-
-
-

Constructors

- - - - - - - -
-<init> -InOutGroup(inputs: List<T>, outputs: List<T>)

Utilities for contract writers to incorporate into their logic.

-
-

Properties

- - - - - - - - - - - -
-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 deleted file mode 100644 index 9eee402d4a..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/-in-out-group/inputs.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.InOutGroup.inputs - - - - -core / TransactionForVerification / InOutGroup / inputs
-
-

inputs

- -val inputs: List<T>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/-in-out-group/outputs.html b/docs/build/html/api/core/-transaction-for-verification/-in-out-group/outputs.html deleted file mode 100644 index ae538b9e0a..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/-in-out-group/outputs.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.InOutGroup.outputs - - - - -core / TransactionForVerification / InOutGroup / outputs
-
-

outputs

- -val outputs: List<T>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/-init-.html b/docs/build/html/api/core/-transaction-for-verification/-init-.html deleted file mode 100644 index 3cdf068208..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/attachments.html b/docs/build/html/api/core/-transaction-for-verification/attachments.html deleted file mode 100644 index a44c3bbfa3..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/attachments.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.attachments - - - - -core / TransactionForVerification / attachments
-
-

attachments

- -val attachments: List<Attachment>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/commands.html b/docs/build/html/api/core/-transaction-for-verification/commands.html deleted file mode 100644 index e18bf53442..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/commands.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.commands - - - - -core / TransactionForVerification / commands
-
-

commands

- -val commands: List<AuthenticatedObject<CommandData>>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/equals.html b/docs/build/html/api/core/-transaction-for-verification/equals.html deleted file mode 100644 index 3a9cc9825e..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/equals.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.equals - - - - -core / TransactionForVerification / equals
-
-

equals

- -fun equals(other: Any?): Boolean
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/get-timestamp-by.html b/docs/build/html/api/core/-transaction-for-verification/get-timestamp-by.html deleted file mode 100644 index 30b8a1469f..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/get-timestamp-by.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.getTimestampBy - - - - -core / TransactionForVerification / getTimestampBy
-
-

getTimestampBy

- -fun getTimestampBy(timestampingAuthority: Party): TimestampCommand?
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/group-states-internal.html b/docs/build/html/api/core/-transaction-for-verification/group-states-internal.html deleted file mode 100644 index df3c2370f3..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/group-states-internal.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TransactionForVerification.groupStatesInternal - - - - -core / TransactionForVerification / groupStatesInternal
-
-

groupStatesInternal

- -fun <T : ContractState> groupStatesInternal(inGroups: Map<Any, List<T>>, outGroups: Map<Any, List<T>>): List<InOutGroup<T>>
-Deprecated: Do not use this directly: exposed as public only due to function inlining
-
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/group-states.html b/docs/build/html/api/core/-transaction-for-verification/group-states.html deleted file mode 100644 index 46a0ee13a8..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/group-states.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TransactionForVerification.groupStates - - - - -core / TransactionForVerification / groupStates
-
-

groupStates

- -fun <T : ContractState> groupStates(ofType: Class<T>, selector: (T) -> Any): List<InOutGroup<T>>
- -inline fun <reified T : ContractState> groupStates(selector: (T) -> Any): List<InOutGroup<T>>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/hash-code.html b/docs/build/html/api/core/-transaction-for-verification/hash-code.html deleted file mode 100644 index 7ee2562213..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/hash-code.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.hashCode - - - - -core / TransactionForVerification / hashCode
-
-

hashCode

- -fun hashCode(): Int
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/in-states.html b/docs/build/html/api/core/-transaction-for-verification/in-states.html deleted file mode 100644 index ab5387bfd3..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/in-states.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.inStates - - - - -core / TransactionForVerification / inStates
-
-

inStates

- -val inStates: List<ContractState>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/index.html b/docs/build/html/api/core/-transaction-for-verification/index.html deleted file mode 100644 index 116d801c2e..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/index.html +++ /dev/null @@ -1,117 +0,0 @@ - - -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>

Utilities for contract writers to incorporate into their logic.

-
-

Constructors

- - - - - - - -
-<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.

-
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - -
-attachments -val attachments: List<Attachment>
-commands -val commands: List<AuthenticatedObject<CommandData>>
-inStates -val inStates: List<ContractState>
-origHash -val origHash: SecureHash
-outStates -val outStates: List<ContractState>
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-equals -fun equals(other: Any?): Boolean
-getTimestampBy -fun getTimestampBy(timestampingAuthority: Party): TimestampCommand?
-groupStates -fun <T : ContractState> groupStates(ofType: Class<T>, selector: (T) -> Any): List<InOutGroup<T>>
-fun <T : ContractState> groupStates(selector: (T) -> Any): List<InOutGroup<T>>
-groupStatesInternal -fun <T : ContractState> groupStatesInternal(inGroups: Map<Any, List<T>>, outGroups: Map<Any, List<T>>): List<InOutGroup<T>>
-hashCode -fun hashCode(): Int
-verify -fun verify(programMap: ContractFactory): 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 deleted file mode 100644 index d1d8e09a3d..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/orig-hash.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.origHash - - - - -core / TransactionForVerification / origHash
-
-

origHash

- -val origHash: SecureHash
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/out-states.html b/docs/build/html/api/core/-transaction-for-verification/out-states.html deleted file mode 100644 index 38364cca9d..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/out-states.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionForVerification.outStates - - - - -core / TransactionForVerification / outStates
-
-

outStates

- -val outStates: List<ContractState>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-for-verification/verify.html b/docs/build/html/api/core/-transaction-for-verification/verify.html deleted file mode 100644 index 543ec03d03..0000000000 --- a/docs/build/html/api/core/-transaction-for-verification/verify.html +++ /dev/null @@ -1,25 +0,0 @@ - - -TransactionForVerification.verify - - - - -core / TransactionForVerification / verify
-
-

verify

- -fun verify(programMap: ContractFactory): 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 field
-
- -IllegalStateException - if a state refers to an unknown contract.
-
-
- - diff --git a/docs/build/html/api/core/-transaction-graph-search/-init-.html b/docs/build/html/api/core/-transaction-graph-search/-init-.html deleted file mode 100644 index 55fc6a8a61..0000000000 --- a/docs/build/html/api/core/-transaction-graph-search/-init-.html +++ /dev/null @@ -1,21 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core/-transaction-graph-search/-query/-init-.html b/docs/build/html/api/core/-transaction-graph-search/-query/-init-.html deleted file mode 100644 index ee4cd2c866..0000000000 --- a/docs/build/html/api/core/-transaction-graph-search/-query/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TransactionGraphSearch.Query.<init> - - - - -core / TransactionGraphSearch / Query / <init>
-
-

<init>

-Query(withCommandOfType: Class<out CommandData>? = null)
-
-
- - diff --git a/docs/build/html/api/core/-transaction-graph-search/-query/index.html b/docs/build/html/api/core/-transaction-graph-search/-query/index.html deleted file mode 100644 index a428f35278..0000000000 --- a/docs/build/html/api/core/-transaction-graph-search/-query/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -TransactionGraphSearch.Query - - - - -core / TransactionGraphSearch / Query
-
-

Query

-class Query
-
-
-

Constructors

- - - - - - - -
-<init> -Query(withCommandOfType: Class<out CommandData>? = null)
-

Properties

- - - - - - - -
-withCommandOfType -val withCommandOfType: Class<out CommandData>?
- - 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 deleted file mode 100644 index 9424443322..0000000000 --- a/docs/build/html/api/core/-transaction-graph-search/-query/with-command-of-type.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionGraphSearch.Query.withCommandOfType - - - - -core / TransactionGraphSearch / Query / withCommandOfType
-
-

withCommandOfType

- -val withCommandOfType: Class<out CommandData>?
-
-
- - diff --git a/docs/build/html/api/core/-transaction-graph-search/call.html b/docs/build/html/api/core/-transaction-graph-search/call.html deleted file mode 100644 index f46cd2c157..0000000000 --- a/docs/build/html/api/core/-transaction-graph-search/call.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionGraphSearch.call - - - - -core / TransactionGraphSearch / call
-
-

call

- -fun call(): List<WireTransaction>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-graph-search/index.html b/docs/build/html/api/core/-transaction-graph-search/index.html deleted file mode 100644 index 31ade0165c..0000000000 --- a/docs/build/html/api/core/-transaction-graph-search/index.html +++ /dev/null @@ -1,79 +0,0 @@ - - -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

- - - - - - - - - - - - - - - -
-query -var query: Query
-startPoints -val startPoints: List<WireTransaction>
-transactions -val transactions: Map<SecureHash, SignedTransaction>
-

Functions

- - - - - - - -
-call -fun call(): List<WireTransaction>
- - diff --git a/docs/build/html/api/core/-transaction-graph-search/query.html b/docs/build/html/api/core/-transaction-graph-search/query.html deleted file mode 100644 index bd7adebefc..0000000000 --- a/docs/build/html/api/core/-transaction-graph-search/query.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionGraphSearch.query - - - - -core / TransactionGraphSearch / query
-
-

query

- -var query: Query
-
-
- - diff --git a/docs/build/html/api/core/-transaction-graph-search/start-points.html b/docs/build/html/api/core/-transaction-graph-search/start-points.html deleted file mode 100644 index 7b3f6a07c6..0000000000 --- a/docs/build/html/api/core/-transaction-graph-search/start-points.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionGraphSearch.startPoints - - - - -core / TransactionGraphSearch / startPoints
-
-

startPoints

- -val startPoints: List<WireTransaction>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-graph-search/transactions.html b/docs/build/html/api/core/-transaction-graph-search/transactions.html deleted file mode 100644 index 7c7b0904e3..0000000000 --- a/docs/build/html/api/core/-transaction-graph-search/transactions.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionGraphSearch.transactions - - - - -core / TransactionGraphSearch / transactions
-
-

transactions

- -val transactions: Map<SecureHash, SignedTransaction>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-group/-init-.html b/docs/build/html/api/core/-transaction-group/-init-.html deleted file mode 100644 index 6d6ef51258..0000000000 --- a/docs/build/html/api/core/-transaction-group/-init-.html +++ /dev/null @@ -1,21 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/core/-transaction-group/index.html b/docs/build/html/api/core/-transaction-group/index.html deleted file mode 100644 index f391f6010d..0000000000 --- a/docs/build/html/api/core/-transaction-group/index.html +++ /dev/null @@ -1,64 +0,0 @@ - - -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

- - - - - - - - - - - -
-nonVerifiedRoots -val nonVerifiedRoots: Set<LedgerTransaction>
-transactions -val transactions: Set<LedgerTransaction>
-

Functions

- - - - - - - -
-verify -fun verify(programMap: ContractFactory): Set<TransactionForVerification>

Verifies the group and returns the set of resolved transactions.

-
- - 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 deleted file mode 100644 index fb6464118f..0000000000 --- a/docs/build/html/api/core/-transaction-group/non-verified-roots.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionGroup.nonVerifiedRoots - - - - -core / TransactionGroup / nonVerifiedRoots
-
-

nonVerifiedRoots

- -val nonVerifiedRoots: Set<LedgerTransaction>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-group/transactions.html b/docs/build/html/api/core/-transaction-group/transactions.html deleted file mode 100644 index 7a3ceceadb..0000000000 --- a/docs/build/html/api/core/-transaction-group/transactions.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionGroup.transactions - - - - -core / TransactionGroup / transactions
-
-

transactions

- -val transactions: Set<LedgerTransaction>
-
-
- - diff --git a/docs/build/html/api/core/-transaction-group/verify.html b/docs/build/html/api/core/-transaction-group/verify.html deleted file mode 100644 index e9ec11002f..0000000000 --- a/docs/build/html/api/core/-transaction-group/verify.html +++ /dev/null @@ -1,16 +0,0 @@ - - -TransactionGroup.verify - - - - -core / TransactionGroup / verify
-
-

verify

- -fun verify(programMap: ContractFactory): Set<TransactionForVerification>
-

Verifies the group and returns the set of resolved transactions.

-
-
- - diff --git a/docs/build/html/api/core/-transaction-resolution-exception/-init-.html b/docs/build/html/api/core/-transaction-resolution-exception/-init-.html deleted file mode 100644 index 0ca83eb33c..0000000000 --- a/docs/build/html/api/core/-transaction-resolution-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TransactionResolutionException.<init> - - - - -core / TransactionResolutionException / <init>
-
-

<init>

-TransactionResolutionException(hash: SecureHash)
-
-
- - diff --git a/docs/build/html/api/core/-transaction-resolution-exception/hash.html b/docs/build/html/api/core/-transaction-resolution-exception/hash.html deleted file mode 100644 index 410616da55..0000000000 --- a/docs/build/html/api/core/-transaction-resolution-exception/hash.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionResolutionException.hash - - - - -core / TransactionResolutionException / hash
-
-

hash

- -val hash: SecureHash
-
-
- - diff --git a/docs/build/html/api/core/-transaction-resolution-exception/index.html b/docs/build/html/api/core/-transaction-resolution-exception/index.html deleted file mode 100644 index 930c9fa667..0000000000 --- a/docs/build/html/api/core/-transaction-resolution-exception/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -TransactionResolutionException - - - - -core / TransactionResolutionException
-
-

TransactionResolutionException

-class TransactionResolutionException : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -TransactionResolutionException(hash: SecureHash)
-

Properties

- - - - - - - -
-hash -val hash: SecureHash
- - diff --git a/docs/build/html/api/core/-transaction-verification-exception/-init-.html b/docs/build/html/api/core/-transaction-verification-exception/-init-.html deleted file mode 100644 index 38662d55cc..0000000000 --- a/docs/build/html/api/core/-transaction-verification-exception/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionVerificationException.<init> - - - - -core / TransactionVerificationException / <init>
-
-

<init>

-TransactionVerificationException(tx: TransactionForVerification, contract: Contract, cause: Throwable?)
-

Thrown if a verification fails due to a contract rejection.

-
-
- - diff --git a/docs/build/html/api/core/-transaction-verification-exception/contract.html b/docs/build/html/api/core/-transaction-verification-exception/contract.html deleted file mode 100644 index 2965cd83c0..0000000000 --- a/docs/build/html/api/core/-transaction-verification-exception/contract.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionVerificationException.contract - - - - -core / TransactionVerificationException / contract
-
-

contract

- -val contract: Contract
-
-
- - diff --git a/docs/build/html/api/core/-transaction-verification-exception/index.html b/docs/build/html/api/core/-transaction-verification-exception/index.html deleted file mode 100644 index 2b5bbe6ce0..0000000000 --- a/docs/build/html/api/core/-transaction-verification-exception/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - -TransactionVerificationException - - - - -core / TransactionVerificationException
-
-

TransactionVerificationException

-class TransactionVerificationException : Exception
-

Thrown if a verification fails due to a contract rejection.

-
-
-

Constructors

- - - - - - - -
-<init> -TransactionVerificationException(tx: TransactionForVerification, contract: Contract, cause: Throwable?)

Thrown if a verification fails due to a contract rejection.

-
-

Properties

- - - - - - - - - - - -
-contract -val contract: Contract
-tx -val tx: TransactionForVerification
- - diff --git a/docs/build/html/api/core/-transaction-verification-exception/tx.html b/docs/build/html/api/core/-transaction-verification-exception/tx.html deleted file mode 100644 index 2a59509917..0000000000 --- a/docs/build/html/api/core/-transaction-verification-exception/tx.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransactionVerificationException.tx - - - - -core / TransactionVerificationException / tx
-
-

tx

- -val tx: TransactionForVerification
-
-
- - diff --git a/docs/build/html/api/core/-transient-property/-init-.html b/docs/build/html/api/core/-transient-property/-init-.html deleted file mode 100644 index 4539886a70..0000000000 --- a/docs/build/html/api/core/-transient-property/-init-.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-transient-property/get-value.html b/docs/build/html/api/core/-transient-property/get-value.html deleted file mode 100644 index ea173eece3..0000000000 --- a/docs/build/html/api/core/-transient-property/get-value.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TransientProperty.getValue - - - - -core / TransientProperty / getValue
-
-

getValue

- -operator fun getValue(thisRef: Any?, property: KProperty<*>): T
-
-
- - diff --git a/docs/build/html/api/core/-transient-property/index.html b/docs/build/html/api/core/-transient-property/index.html deleted file mode 100644 index eddf584bad..0000000000 --- a/docs/build/html/api/core/-transient-property/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -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 deleted file mode 100644 index a9567477e0..0000000000 --- a/docs/build/html/api/core/-type-only-command-data/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-type-only-command-data/equals.html b/docs/build/html/api/core/-type-only-command-data/equals.html deleted file mode 100644 index 3858a46095..0000000000 --- a/docs/build/html/api/core/-type-only-command-data/equals.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TypeOnlyCommandData.equals - - - - -core / TypeOnlyCommandData / equals
-
-

equals

- -open fun equals(other: Any?): Boolean
-
-
- - diff --git a/docs/build/html/api/core/-type-only-command-data/hash-code.html b/docs/build/html/api/core/-type-only-command-data/hash-code.html deleted file mode 100644 index 07a0bce78a..0000000000 --- a/docs/build/html/api/core/-type-only-command-data/hash-code.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TypeOnlyCommandData.hashCode - - - - -core / TypeOnlyCommandData / hashCode
-
-

hashCode

- -open fun hashCode(): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core/-type-only-command-data/index.html b/docs/build/html/api/core/-type-only-command-data/index.html deleted file mode 100644 index 12444a0b2f..0000000000 --- a/docs/build/html/api/core/-type-only-command-data/index.html +++ /dev/null @@ -1,91 +0,0 @@ - - -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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Close -class Close : TypeOnlyCommandData, Commands
-Issue -class Issue : TypeOnlyCommandData, Commands
-Move -class Move : TypeOnlyCommandData, Commands
-Move -class Move : 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 deleted file mode 100644 index 181dc00b36..0000000000 --- a/docs/build/html/api/core/-u-s-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -USD - - - - -core / USD
-
-

USD

- -val USD: Currency
-
-
- - diff --git a/docs/build/html/api/core/-unknown-contract-exception/-init-.html b/docs/build/html/api/core/-unknown-contract-exception/-init-.html deleted file mode 100644 index 943eca3461..0000000000 --- a/docs/build/html/api/core/-unknown-contract-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -UnknownContractException.<init> - - - - -core / UnknownContractException / <init>
-
-

<init>

-UnknownContractException()
-
-
- - diff --git a/docs/build/html/api/core/-unknown-contract-exception/index.html b/docs/build/html/api/core/-unknown-contract-exception/index.html deleted file mode 100644 index 54615fddfa..0000000000 --- a/docs/build/html/api/core/-unknown-contract-exception/index.html +++ /dev/null @@ -1,25 +0,0 @@ - - -UnknownContractException - - - - -core / UnknownContractException
-
-

UnknownContractException

-class UnknownContractException : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -UnknownContractException()
- - diff --git a/docs/build/html/api/core/-wire-transaction/-init-.html b/docs/build/html/api/core/-wire-transaction/-init-.html deleted file mode 100644 index 97143a80f6..0000000000 --- a/docs/build/html/api/core/-wire-transaction/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/attachments.html b/docs/build/html/api/core/-wire-transaction/attachments.html deleted file mode 100644 index ad948a2821..0000000000 --- a/docs/build/html/api/core/-wire-transaction/attachments.html +++ /dev/null @@ -1,15 +0,0 @@ - - -WireTransaction.attachments - - - - -core / WireTransaction / attachments
-
-

attachments

- -val attachments: List<SecureHash>
-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/commands.html b/docs/build/html/api/core/-wire-transaction/commands.html deleted file mode 100644 index cd74dcc4dd..0000000000 --- a/docs/build/html/api/core/-wire-transaction/commands.html +++ /dev/null @@ -1,15 +0,0 @@ - - -WireTransaction.commands - - - - -core / WireTransaction / commands
-
-

commands

- -val commands: List<Command>
-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/deserialize.html b/docs/build/html/api/core/-wire-transaction/deserialize.html deleted file mode 100644 index 52082fdbe2..0000000000 --- a/docs/build/html/api/core/-wire-transaction/deserialize.html +++ /dev/null @@ -1,15 +0,0 @@ - - -WireTransaction.deserialize - - - - -core / WireTransaction / deserialize
-
-

deserialize

- -fun deserialize(bits: SerializedBytes<WireTransaction>): WireTransaction
-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/id.html b/docs/build/html/api/core/-wire-transaction/id.html deleted file mode 100644 index e036e71543..0000000000 --- a/docs/build/html/api/core/-wire-transaction/id.html +++ /dev/null @@ -1,16 +0,0 @@ - - -WireTransaction.id - - - - -core / WireTransaction / id
-
-

id

- -val id: SecureHash
-Overrides NamedByHash.id
-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/index.html b/docs/build/html/api/core/-wire-transaction/index.html deleted file mode 100644 index 8996ace13d..0000000000 --- a/docs/build/html/api/core/-wire-transaction/index.html +++ /dev/null @@ -1,117 +0,0 @@ - - -WireTransaction - - - - -core / WireTransaction
-
-

WireTransaction

-data class WireTransaction : NamedByHash
-

Transaction ready for serialisation, without any signatures attached.

-
-
-

Constructors

- - - - - - - -
-<init> -WireTransaction(inputs: List<StateRef>, attachments: List<SecureHash>, outputs: List<ContractState>, commands: List<Command>)

Transaction ready for serialisation, without any signatures attached.

-
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-attachments -val attachments: List<SecureHash>
-commands -val commands: List<Command>
-id -val id: SecureHash
-inputs -val inputs: List<StateRef>
-outputs -val outputs: List<ContractState>
-serialized -val serialized: SerializedBytes<WireTransaction>
-

Functions

- - - - - - - - - - - - - - - -
-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.

-
-toSignedTransaction -fun toSignedTransaction(withSigs: List<WithKey>): SignedTransaction

Serialises and returns this transaction as a SignedTransaction with no signatures attached.

-
-toString -fun toString(): String
-

Companion Object Functions

- - - - - - - -
-deserialize -fun deserialize(bits: SerializedBytes<WireTransaction>): WireTransaction
-

Extension Functions

- - - - - - - -
-toLedgerTransaction -fun WireTransaction.toLedgerTransaction(identityService: IdentityService, attachmentStorage: AttachmentStorage): LedgerTransaction

Looks up identities and attachments from storage to generate a LedgerTransaction.

-
- - diff --git a/docs/build/html/api/core/-wire-transaction/inputs.html b/docs/build/html/api/core/-wire-transaction/inputs.html deleted file mode 100644 index 442019e737..0000000000 --- a/docs/build/html/api/core/-wire-transaction/inputs.html +++ /dev/null @@ -1,15 +0,0 @@ - - -WireTransaction.inputs - - - - -core / WireTransaction / inputs
-
-

inputs

- -val inputs: List<StateRef>
-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/out-ref.html b/docs/build/html/api/core/-wire-transaction/out-ref.html deleted file mode 100644 index 32fc839f50..0000000000 --- a/docs/build/html/api/core/-wire-transaction/out-ref.html +++ /dev/null @@ -1,21 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/outputs.html b/docs/build/html/api/core/-wire-transaction/outputs.html deleted file mode 100644 index b8e54034dd..0000000000 --- a/docs/build/html/api/core/-wire-transaction/outputs.html +++ /dev/null @@ -1,15 +0,0 @@ - - -WireTransaction.outputs - - - - -core / WireTransaction / outputs
-
-

outputs

- -val outputs: List<ContractState>
-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/serialized.html b/docs/build/html/api/core/-wire-transaction/serialized.html deleted file mode 100644 index 1c274ef785..0000000000 --- a/docs/build/html/api/core/-wire-transaction/serialized.html +++ /dev/null @@ -1,15 +0,0 @@ - - -WireTransaction.serialized - - - - -core / WireTransaction / serialized
-
-

serialized

- -val serialized: SerializedBytes<WireTransaction>
-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/to-signed-transaction.html b/docs/build/html/api/core/-wire-transaction/to-signed-transaction.html deleted file mode 100644 index 5356441da8..0000000000 --- a/docs/build/html/api/core/-wire-transaction/to-signed-transaction.html +++ /dev/null @@ -1,16 +0,0 @@ - - -WireTransaction.toSignedTransaction - - - - -core / WireTransaction / toSignedTransaction
-
-

toSignedTransaction

- -fun toSignedTransaction(withSigs: List<WithKey>): SignedTransaction
-

Serialises and returns this transaction as a SignedTransaction with no signatures attached.

-
-
- - diff --git a/docs/build/html/api/core/-wire-transaction/to-string.html b/docs/build/html/api/core/-wire-transaction/to-string.html deleted file mode 100644 index c411f72d79..0000000000 --- a/docs/build/html/api/core/-wire-transaction/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -WireTransaction.toString - - - - -core / WireTransaction / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/core/currency.html b/docs/build/html/api/core/currency.html deleted file mode 100644 index 9bfbff6c84..0000000000 --- a/docs/build/html/api/core/currency.html +++ /dev/null @@ -1,23 +0,0 @@ - - -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)

-
-
-
-
- - diff --git a/docs/build/html/api/core/extract-zip-file.html b/docs/build/html/api/core/extract-zip-file.html deleted file mode 100644 index c8febca963..0000000000 --- a/docs/build/html/api/core/extract-zip-file.html +++ /dev/null @@ -1,16 +0,0 @@ - - -extractZipFile - - - - -core / extractZipFile
-
-

extractZipFile

- -fun extractZipFile(zipPath: Path, toPath: Path): Unit
-

Given a path to a zip file, extracts it to the given directory.

-
-
- - diff --git a/docs/build/html/api/core/failure.html b/docs/build/html/api/core/failure.html deleted file mode 100644 index 05733425c0..0000000000 --- a/docs/build/html/api/core/failure.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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>
-
-
- - diff --git a/docs/build/html/api/core/hash.html b/docs/build/html/api/core/hash.html deleted file mode 100644 index 0402b5b79e..0000000000 --- a/docs/build/html/api/core/hash.html +++ /dev/null @@ -1,16 +0,0 @@ - - -hash - - - - -core / hash
-
-

hash

- -fun ContractState.hash(): SecureHash
-

Returns the SHA-256 hash of the serialised contents of this state (not cached)

-
-
- - diff --git a/docs/build/html/api/core/index.html b/docs/build/html/api/core/index.html deleted file mode 100644 index edcd88e2bb..0000000000 --- a/docs/build/html/api/core/index.html +++ /dev/null @@ -1,417 +0,0 @@ - - -core - - - - -core
-
-

Package core

-

Types

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-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.

-
-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.

-
-ContractFactory -interface ContractFactory

A contract factory knows how to lazily load and instantiate contract objects.

-
-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.

-
-LedgerTransaction -data class 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.

-
-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.

-
-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.

-
-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 mutable transaction thats in the process of being built, before all signatures are present.

-
-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

- - - - - - - - - - - - - - - - - - - -
-TransactionConflictException -class TransactionConflictException : Exception
-TransactionResolutionException -class TransactionResolutionException : Exception
-TransactionVerificationException -class TransactionVerificationException : Exception

Thrown if a verification fails due to a contract rejection.

-
-UnknownContractException -class UnknownContractException : Exception
-

Extensions for External Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-java.nio.file.Path -
-java.time.temporal.Temporal -
-kotlin.Double -
-kotlin.Int -
-kotlin.String -
-kotlin.collections.Iterable -
-kotlin.collections.List -
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - -
-CHF -val CHF: Currency
-GBP -val GBP: Currency
-R -val R: Requirements
-RunOnCallerThread -val RunOnCallerThread: <ERROR CLASS>
-USD -val USD: Currency
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-currency -fun currency(code: String): Currency

Defines a simple domain specific language for the specificiation of financial contracts. Currently covers:

-
-extractZipFile -fun extractZipFile(zipPath: Path, toPath: 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 deleted file mode 100644 index 3fa5eace28..0000000000 --- a/docs/build/html/api/core/java.nio.file.-path/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - -core.java.nio.file.Path - - - - -core / java.nio.file.Path
-
-

Extensions for java.nio.file.Path

- - - - - - - -
-use -fun <R> Path.use(block: (InputStream) -> R): R
- - 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 deleted file mode 100644 index 78aaa6daf9..0000000000 --- a/docs/build/html/api/core/java.nio.file.-path/use.html +++ /dev/null @@ -1,15 +0,0 @@ - - -use - - - - -core / java.nio.file.Path / use
-
-

use

- -fun <R> Path.use(block: (InputStream) -> R): R
-
-
- - diff --git a/docs/build/html/api/core/java.time.temporal.-temporal/index.html b/docs/build/html/api/core/java.time.temporal.-temporal/index.html deleted file mode 100644 index 6ca04996d7..0000000000 --- a/docs/build/html/api/core/java.time.temporal.-temporal/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - -core.java.time.temporal.Temporal - - - - -core / java.time.temporal.Temporal
-
-

Extensions for java.time.temporal.Temporal

- - - - - - - -
-until -infix fun Temporal.until(endExclusive: Temporal): Duration
- - 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 deleted file mode 100644 index 4d85b2b2b6..0000000000 --- a/docs/build/html/api/core/java.time.temporal.-temporal/until.html +++ /dev/null @@ -1,15 +0,0 @@ - - -until - - - - -core / java.time.temporal.Temporal / until
-
-

until

- -infix fun Temporal.until(endExclusive: Temporal): Duration
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-double/-d-o-l-l-a-r-s.html b/docs/build/html/api/core/kotlin.-double/-d-o-l-l-a-r-s.html deleted file mode 100644 index 16bfbc55c7..0000000000 --- a/docs/build/html/api/core/kotlin.-double/-d-o-l-l-a-r-s.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DOLLARS - - - - -core / kotlin.Double / DOLLARS
-
-

DOLLARS

- -val Double.DOLLARS: Amount
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-double/index.html b/docs/build/html/api/core/kotlin.-double/index.html deleted file mode 100644 index bd797c78ec..0000000000 --- a/docs/build/html/api/core/kotlin.-double/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - -core.kotlin.Double - - - - -core / kotlin.Double
-
-

Extensions for kotlin.Double

- - - - - - - -
-DOLLARS -val Double.DOLLARS: Amount
- - 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 deleted file mode 100644 index 74f8f32024..0000000000 --- a/docs/build/html/api/core/kotlin.-int/-d-o-l-l-a-r-s.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DOLLARS - - - - -core / kotlin.Int / DOLLARS
-
-

DOLLARS

- -val Int.DOLLARS: Amount
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-int/-p-o-u-n-d-s.html b/docs/build/html/api/core/kotlin.-int/-p-o-u-n-d-s.html deleted file mode 100644 index a5444c984a..0000000000 --- a/docs/build/html/api/core/kotlin.-int/-p-o-u-n-d-s.html +++ /dev/null @@ -1,15 +0,0 @@ - - -POUNDS - - - - -core / kotlin.Int / POUNDS
-
-

POUNDS

- -val Int.POUNDS: Amount
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-int/-s-w-i-s-s_-f-r-a-n-c-s.html b/docs/build/html/api/core/kotlin.-int/-s-w-i-s-s_-f-r-a-n-c-s.html deleted file mode 100644 index 2025866635..0000000000 --- a/docs/build/html/api/core/kotlin.-int/-s-w-i-s-s_-f-r-a-n-c-s.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SWISS_FRANCS - - - - -core / kotlin.Int / SWISS_FRANCS
-
-

SWISS_FRANCS

- -val Int.SWISS_FRANCS: Amount
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-int/days.html b/docs/build/html/api/core/kotlin.-int/days.html deleted file mode 100644 index 6f9d0a1476..0000000000 --- a/docs/build/html/api/core/kotlin.-int/days.html +++ /dev/null @@ -1,15 +0,0 @@ - - -days - - - - -core / kotlin.Int / days
-
-

days

- -val Int.days: Duration
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-int/hours.html b/docs/build/html/api/core/kotlin.-int/hours.html deleted file mode 100644 index 42d025c923..0000000000 --- a/docs/build/html/api/core/kotlin.-int/hours.html +++ /dev/null @@ -1,15 +0,0 @@ - - -hours - - - - -core / kotlin.Int / hours
-
-

hours

- -val Int.hours: Duration
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-int/index.html b/docs/build/html/api/core/kotlin.-int/index.html deleted file mode 100644 index ccd0080e46..0000000000 --- a/docs/build/html/api/core/kotlin.-int/index.html +++ /dev/null @@ -1,57 +0,0 @@ - - -core.kotlin.Int - - - - -core / kotlin.Int
-
-

Extensions for kotlin.Int

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-DOLLARS -val Int.DOLLARS: Amount
-POUNDS -val Int.POUNDS: Amount
-SWISS_FRANCS -val Int.SWISS_FRANCS: Amount
-days -val Int.days: Duration
-hours -val Int.hours: Duration
-minutes -val Int.minutes: Duration
-seconds -val Int.seconds: Duration
- - diff --git a/docs/build/html/api/core/kotlin.-int/minutes.html b/docs/build/html/api/core/kotlin.-int/minutes.html deleted file mode 100644 index ec227c5768..0000000000 --- a/docs/build/html/api/core/kotlin.-int/minutes.html +++ /dev/null @@ -1,15 +0,0 @@ - - -minutes - - - - -core / kotlin.Int / minutes
-
-

minutes

- -val Int.minutes: Duration
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-int/seconds.html b/docs/build/html/api/core/kotlin.-int/seconds.html deleted file mode 100644 index 9d4532be30..0000000000 --- a/docs/build/html/api/core/kotlin.-int/seconds.html +++ /dev/null @@ -1,15 +0,0 @@ - - -seconds - - - - -core / kotlin.Int / seconds
-
-

seconds

- -val Int.seconds: Duration
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-string/d.html b/docs/build/html/api/core/kotlin.-string/d.html deleted file mode 100644 index 0e584b69d0..0000000000 --- a/docs/build/html/api/core/kotlin.-string/d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -d - - - - -core / kotlin.String / d
-
-

d

- -val String.d: BigDecimal
-
-
- - diff --git a/docs/build/html/api/core/kotlin.-string/index.html b/docs/build/html/api/core/kotlin.-string/index.html deleted file mode 100644 index a83ab588ff..0000000000 --- a/docs/build/html/api/core/kotlin.-string/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - -core.kotlin.String - - - - -core / kotlin.String
-
-

Extensions for kotlin.String

- - - - - - - -
-d -val String.d: BigDecimal
- - diff --git a/docs/build/html/api/core/kotlin.collections.-iterable/index.html b/docs/build/html/api/core/kotlin.collections.-iterable/index.html deleted file mode 100644 index e5861733cd..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-iterable/index.html +++ /dev/null @@ -1,33 +0,0 @@ - - -core.kotlin.collections.Iterable - - - - -core / kotlin.collections.Iterable
-
-

Extensions for kotlin.collections.Iterable

- - - - - - - - - - - - - - - -
-sumOrNull -fun Iterable<Amount>.sumOrNull(): Nothing?
-sumOrThrow -fun Iterable<Amount>.sumOrThrow(): <ERROR CLASS>
-sumOrZero -fun Iterable<Amount>.sumOrZero(currency: Currency): Amount
- - 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 deleted file mode 100644 index 94840397a3..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-null.html +++ /dev/null @@ -1,15 +0,0 @@ - - -sumOrNull - - - - -core / kotlin.collections.Iterable / sumOrNull
-
-

sumOrNull

- -fun Iterable<Amount>.sumOrNull(): Nothing?
-
-
- - diff --git a/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-throw.html b/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-throw.html deleted file mode 100644 index 30e4673c4f..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-throw.html +++ /dev/null @@ -1,15 +0,0 @@ - - -sumOrThrow - - - - -core / kotlin.collections.Iterable / sumOrThrow
-
-

sumOrThrow

- -fun Iterable<Amount>.sumOrThrow(): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-zero.html b/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-zero.html deleted file mode 100644 index 62958295fa..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-iterable/sum-or-zero.html +++ /dev/null @@ -1,15 +0,0 @@ - - -sumOrZero - - - - -core / kotlin.collections.Iterable / sumOrZero
-
-

sumOrZero

- -fun Iterable<Amount>.sumOrZero(currency: Currency): Amount
-
-
- - diff --git a/docs/build/html/api/core/kotlin.collections.-list/get-timestamp-by-name.html b/docs/build/html/api/core/kotlin.collections.-list/get-timestamp-by-name.html deleted file mode 100644 index 101fc4849d..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-list/get-timestamp-by-name.html +++ /dev/null @@ -1,18 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/kotlin.collections.-list/get-timestamp-by.html b/docs/build/html/api/core/kotlin.collections.-list/get-timestamp-by.html deleted file mode 100644 index 02c709bfd3..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-list/get-timestamp-by.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/kotlin.collections.-list/index-of-or-throw.html b/docs/build/html/api/core/kotlin.collections.-list/index-of-or-throw.html deleted file mode 100644 index af22989e3e..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-list/index-of-or-throw.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/kotlin.collections.-list/index.html b/docs/build/html/api/core/kotlin.collections.-list/index.html deleted file mode 100644 index 018fae1e75..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-list/index.html +++ /dev/null @@ -1,52 +0,0 @@ - - -core.kotlin.collections.List - - - - -core / kotlin.collections.List
-
-

Extensions for kotlin.collections.List

- - - - - - - - - - - - - - - - - - - - - - - -
-getTimestampBy -fun List<AuthenticatedObject<CommandData>>.getTimestampBy(timestampingAuthority: Party): TimestampCommand?

Returns a timestamp that was signed by the given authority, or returns null if missing.

-
-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.

-
-indexOfOrThrow -fun <T> List<T>.indexOfOrThrow(item: T): Int

Returns the index of the given item or throws IllegalArgumentException if not found.

-
-requireSingleCommand -fun <T : CommandData> List<AuthenticatedObject<CommandData>>.requireSingleCommand(): <ERROR CLASS>
-fun List<AuthenticatedObject<CommandData>>.requireSingleCommand(klass: Class<out CommandData>): <ERROR CLASS>
-select -fun <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.

-
- - 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 deleted file mode 100644 index 7c108de011..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-list/require-single-command.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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>
-
-
- - diff --git a/docs/build/html/api/core/kotlin.collections.-list/select.html b/docs/build/html/api/core/kotlin.collections.-list/select.html deleted file mode 100644 index 187d6c2bb8..0000000000 --- a/docs/build/html/api/core/kotlin.collections.-list/select.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/log-elapsed-time.html b/docs/build/html/api/core/log-elapsed-time.html deleted file mode 100644 index 48d7af36af..0000000000 --- a/docs/build/html/api/core/log-elapsed-time.html +++ /dev/null @@ -1,15 +0,0 @@ - - -logElapsedTime - - - - -core / logElapsedTime
-
-

logElapsedTime

- -inline fun <T> logElapsedTime(label: String, logger: <ERROR CLASS>? = null, body: () -> T): T
-
-
- - diff --git a/docs/build/html/api/core/random63-bit-value.html b/docs/build/html/api/core/random63-bit-value.html deleted file mode 100644 index 64e0bde485..0000000000 --- a/docs/build/html/api/core/random63-bit-value.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/require-that.html b/docs/build/html/api/core/require-that.html deleted file mode 100644 index dac23f1a48..0000000000 --- a/docs/build/html/api/core/require-that.html +++ /dev/null @@ -1,15 +0,0 @@ - - -requireThat - - - - -core / requireThat
-
-

requireThat

- -inline fun <R> requireThat(body: Requirements.() -> R): R
-
-
- - diff --git a/docs/build/html/api/core/set-from.html b/docs/build/html/api/core/set-from.html deleted file mode 100644 index 8ed5b9c8f9..0000000000 --- a/docs/build/html/api/core/set-from.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/core/success.html b/docs/build/html/api/core/success.html deleted file mode 100644 index d950611aa5..0000000000 --- a/docs/build/html/api/core/success.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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>
-
-
- - diff --git a/docs/build/html/api/core/then.html b/docs/build/html/api/core/then.html deleted file mode 100644 index 2e32f1359e..0000000000 --- a/docs/build/html/api/core/then.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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>
-
-
- - diff --git a/docs/build/html/api/core/to-ledger-transaction.html b/docs/build/html/api/core/to-ledger-transaction.html deleted file mode 100644 index b24dbbc612..0000000000 --- a/docs/build/html/api/core/to-ledger-transaction.html +++ /dev/null @@ -1,19 +0,0 @@ - - -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 transaction was not found in storage.
-
-
- - diff --git a/docs/build/html/api/core/verify-to-ledger-transaction.html b/docs/build/html/api/core/verify-to-ledger-transaction.html deleted file mode 100644 index 92d7ac9642..0000000000 --- a/docs/build/html/api/core/verify-to-ledger-transaction.html +++ /dev/null @@ -1,17 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-buyer/-init-.html b/docs/build/html/api/demos/-trader-demo-protocol-buyer/-init-.html deleted file mode 100644 index 772d3ecd8c..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-buyer/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TraderDemoProtocolBuyer.<init> - - - - -demos / TraderDemoProtocolBuyer / <init>
-
-

<init>

-TraderDemoProtocolBuyer(attachmentsPath: Path)
-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-buyer/-s-t-a-r-t-i-n-g_-b-u-y.html b/docs/build/html/api/demos/-trader-demo-protocol-buyer/-s-t-a-r-t-i-n-g_-b-u-y.html deleted file mode 100644 index 158df5d18f..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-buyer/-s-t-a-r-t-i-n-g_-b-u-y.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index c33c6afc07..0000000000 --- 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 +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index cdd0416a2f..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-buyer/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TraderDemoProtocolBuyer.call - - - - -demos / TraderDemoProtocolBuyer / call
-
-

call

- -fun call(): Unit
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-buyer/index.html b/docs/build/html/api/demos/-trader-demo-protocol-buyer/index.html deleted file mode 100644 index a0048b3265..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-buyer/index.html +++ /dev/null @@ -1,126 +0,0 @@ - - -TraderDemoProtocolBuyer - - - - -demos / TraderDemoProtocolBuyer
-
-

TraderDemoProtocolBuyer

-class TraderDemoProtocolBuyer : ProtocolLogic<Unit>
-
-
-

Types

- - - - - - - - - - - -
-STARTING_BUY -object STARTING_BUY : Step
-WAITING_FOR_SELLER_TO_CONNECT -object WAITING_FOR_SELLER_TO_CONNECT : Step
-

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>
-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.

-
- - 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 deleted file mode 100644 index 95ee54060a..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-buyer/progress-tracker.html +++ /dev/null @@ -1,24 +0,0 @@ - - -TraderDemoProtocolBuyer.progressTracker - - - - -demos / TraderDemoProtocolBuyer / progressTracker
-
-

progressTracker

- -val progressTracker: ProgressTracker
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/-a-n-n-o-u-n-c-i-n-g.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/-a-n-n-o-u-n-c-i-n-g.html deleted file mode 100644 index 779711d99c..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/-a-n-n-o-u-n-c-i-n-g.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index b11cc44555..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TraderDemoProtocolSeller.<init> - - - - -demos / TraderDemoProtocolSeller / <init>
-
-

<init>

-TraderDemoProtocolSeller(myAddress: <ERROR CLASS>, otherSide: SingleMessageRecipient, progressTracker: ProgressTracker = TraderDemoProtocolSeller.tracker())
-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/-p-r-o-s-p-e-c-t-u-s_-h-a-s-h.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/-p-r-o-s-p-e-c-t-u-s_-h-a-s-h.html deleted file mode 100644 index f2c175286b..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/-p-r-o-s-p-e-c-t-u-s_-h-a-s-h.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.PROSPECTUS_HASH - - - - -demos / TraderDemoProtocolSeller / PROSPECTUS_HASH
-
-

PROSPECTUS_HASH

- -val PROSPECTUS_HASH: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/-s-e-l-f_-i-s-s-u-i-n-g.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/-s-e-l-f_-i-s-s-u-i-n-g.html deleted file mode 100644 index 359291b181..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/-s-e-l-f_-i-s-s-u-i-n-g.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index 13bfb6b840..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/-t-r-a-d-i-n-g.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index 5aa81784f4..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TraderDemoProtocolSeller.call - - - - -demos / TraderDemoProtocolSeller / call
-
-

call

- -fun call(): Unit
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/index.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/index.html deleted file mode 100644 index ee146eebbc..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/index.html +++ /dev/null @@ -1,172 +0,0 @@ - - -TraderDemoProtocolSeller - - - - -demos / TraderDemoProtocolSeller
-
-

TraderDemoProtocolSeller

-class TraderDemoProtocolSeller : ProtocolLogic<Unit>
-
-
-

Types

- - - - - - - - - - - - - - - -
-ANNOUNCING -object ANNOUNCING : Step
-SELF_ISSUING -object SELF_ISSUING : Step
-TRADING -object TRADING : Step
-

Constructors

- - - - - - - -
-<init> -TraderDemoProtocolSeller(myAddress: <ERROR CLASS>, otherSide: SingleMessageRecipient, progressTracker: ProgressTracker = TraderDemoProtocolSeller.tracker())
-

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

- - - - - - - - - - - -
-call -fun call(): Unit

This is where you fill out your business logic.

-
-selfIssueSomeCommercialPaper -fun selfIssueSomeCommercialPaper(ownedBy: PublicKey, tsa: LegallyIdentifiableNode): StateAndRef<State>
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - -
-receive -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 ProtocolLogics reference to the -ProtocolStateMachine and then calling the call method.

-
-

Companion Object Properties

- - - - - - - -
-PROSPECTUS_HASH -val PROSPECTUS_HASH: <ERROR CLASS>
-

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 deleted file mode 100644 index 132958967a..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/my-address.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.myAddress - - - - -demos / TraderDemoProtocolSeller / myAddress
-
-

myAddress

- -val myAddress: <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/other-side.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/other-side.html deleted file mode 100644 index e2a4c3137f..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/other-side.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.otherSide - - - - -demos / TraderDemoProtocolSeller / otherSide
-
-

otherSide

- -val otherSide: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/progress-tracker.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/progress-tracker.html deleted file mode 100644 index 33219e23f5..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/progress-tracker.html +++ /dev/null @@ -1,24 +0,0 @@ - - -TraderDemoProtocolSeller.progressTracker - - - - -demos / TraderDemoProtocolSeller / progressTracker
-
-

progressTracker

- -val progressTracker: ProgressTracker
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/self-issue-some-commercial-paper.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/self-issue-some-commercial-paper.html deleted file mode 100644 index 2894a6be70..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/self-issue-some-commercial-paper.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.selfIssueSomeCommercialPaper - - - - -demos / TraderDemoProtocolSeller / selfIssueSomeCommercialPaper
-
-

selfIssueSomeCommercialPaper

- -fun selfIssueSomeCommercialPaper(ownedBy: PublicKey, tsa: LegallyIdentifiableNode): StateAndRef<State>
-
-
- - diff --git a/docs/build/html/api/demos/-trader-demo-protocol-seller/tracker.html b/docs/build/html/api/demos/-trader-demo-protocol-seller/tracker.html deleted file mode 100644 index 7d33ea8dc5..0000000000 --- a/docs/build/html/api/demos/-trader-demo-protocol-seller/tracker.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.tracker - - - - -demos / TraderDemoProtocolSeller / tracker
-
-

tracker

- -fun tracker(): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/demos/index.html b/docs/build/html/api/demos/index.html deleted file mode 100644 index fbab2a3e03..0000000000 --- a/docs/build/html/api/demos/index.html +++ /dev/null @@ -1,39 +0,0 @@ - - -demos - - - - -demos
-
-

Package demos

-

Types

- - - - - - - - - - - -
-TraderDemoProtocolBuyer -class TraderDemoProtocolBuyer : ProtocolLogic<Unit>
-TraderDemoProtocolSeller -class TraderDemoProtocolSeller : ProtocolLogic<Unit>
-

Functions

- - - - - - - -
-main -fun main(args: Array<String>): Unit
- - diff --git a/docs/build/html/api/demos/main.html b/docs/build/html/api/demos/main.html deleted file mode 100644 index a3d974b35e..0000000000 --- a/docs/build/html/api/demos/main.html +++ /dev/null @@ -1,15 +0,0 @@ - - -main - - - - -demos / main
-
-

main

- -fun main(args: Array<String>): Unit
-
-
- - diff --git a/docs/build/html/api/index-outline.html b/docs/build/html/api/index-outline.html deleted file mode 100644 index cb863cd6f9..0000000000 --- a/docs/build/html/api/index-outline.html +++ /dev/null @@ -1,4917 +0,0 @@ - - -Module Contents - - - -
- - - diff --git a/docs/build/html/api/index.html b/docs/build/html/api/index.html deleted file mode 100644 index a274efd0c8..0000000000 --- a/docs/build/html/api/index.html +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - -
-
-

Packages

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-contracts -
-core -
-core.crypto -
-core.messaging -
-core.node -
-core.node.services -
-core.node.servlets -
-core.protocols -
-core.serialization -
-core.utilities -
-demos -
-protocols -
-

Index

-All Types - diff --git a/docs/build/html/api/protocols/-fetch-attachments-protocol/-init-.html b/docs/build/html/api/protocols/-fetch-attachments-protocol/-init-.html deleted file mode 100644 index d0f65e1d5c..0000000000 --- a/docs/build/html/api/protocols/-fetch-attachments-protocol/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -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.

-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-attachments-protocol/-t-o-p-i-c.html b/docs/build/html/api/protocols/-fetch-attachments-protocol/-t-o-p-i-c.html deleted file mode 100644 index 2430594127..0000000000 --- a/docs/build/html/api/protocols/-fetch-attachments-protocol/-t-o-p-i-c.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchAttachmentsProtocol.TOPIC - - - - -protocols / FetchAttachmentsProtocol / TOPIC
-
-

TOPIC

- -const val TOPIC: String
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-attachments-protocol/convert.html b/docs/build/html/api/protocols/-fetch-attachments-protocol/convert.html deleted file mode 100644 index 200385ea9f..0000000000 --- a/docs/build/html/api/protocols/-fetch-attachments-protocol/convert.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchAttachmentsProtocol.convert - - - - -protocols / FetchAttachmentsProtocol / convert
-
-

convert

- -protected fun convert(wire: ByteArray): Attachment
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-attachments-protocol/index.html b/docs/build/html/api/protocols/-fetch-attachments-protocol/index.html deleted file mode 100644 index 2d1ab582e0..0000000000 --- a/docs/build/html/api/protocols/-fetch-attachments-protocol/index.html +++ /dev/null @@ -1,103 +0,0 @@ - - -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

- - - - - - - -
-queryTopic -val queryTopic: String
-

Inherited Properties

- - - - - - - - - - - -
-otherSide -val otherSide: SingleMessageRecipient
-requests -val requests: Set<SecureHash>
-

Functions

- - - - - - - - - - - - - - - -
-convert -fun convert(wire: ByteArray): Attachment
-load -fun load(txid: SecureHash): Attachment?
-maybeWriteToDisk -fun maybeWriteToDisk(downloaded: List<Attachment>): Unit
-

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 deleted file mode 100644 index d02afa90ab..0000000000 --- a/docs/build/html/api/protocols/-fetch-attachments-protocol/load.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FetchAttachmentsProtocol.load - - - - -protocols / FetchAttachmentsProtocol / load
-
-

load

- -protected fun load(txid: SecureHash): Attachment?
-Overrides FetchDataProtocol.load
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-attachments-protocol/maybe-write-to-disk.html b/docs/build/html/api/protocols/-fetch-attachments-protocol/maybe-write-to-disk.html deleted file mode 100644 index 487894c398..0000000000 --- a/docs/build/html/api/protocols/-fetch-attachments-protocol/maybe-write-to-disk.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchAttachmentsProtocol.maybeWriteToDisk - - - - -protocols / FetchAttachmentsProtocol / maybeWriteToDisk
-
-

maybeWriteToDisk

- -protected fun maybeWriteToDisk(downloaded: List<Attachment>): Unit
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-attachments-protocol/query-topic.html b/docs/build/html/api/protocols/-fetch-attachments-protocol/query-topic.html deleted file mode 100644 index 77e84f36be..0000000000 --- a/docs/build/html/api/protocols/-fetch-attachments-protocol/query-topic.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FetchAttachmentsProtocol.queryTopic - - - - -protocols / FetchAttachmentsProtocol / queryTopic
-
-

queryTopic

- -protected val queryTopic: String
-Overrides FetchDataProtocol.queryTopic
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/-init-.html b/docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/-init-.html deleted file mode 100644 index eeaa4e4222..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -FetchDataProtocol.BadAnswer.<init> - - - - -protocols / FetchDataProtocol / BadAnswer / <init>
-
-

<init>

-BadAnswer()
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/index.html b/docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/index.html deleted file mode 100644 index f646e1e406..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -FetchDataProtocol.BadAnswer - - - - -protocols / FetchDataProtocol / BadAnswer
-
-

BadAnswer

-open class BadAnswer : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -BadAnswer()
-

Inheritors

- - - - - - - - - - - -
-DownloadedVsRequestedDataMismatch -class DownloadedVsRequestedDataMismatch : BadAnswer
-HashNotFound -class HashNotFound : BadAnswer
- - 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 deleted file mode 100644 index 45a95f8d11..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -FetchDataProtocol.DownloadedVsRequestedDataMismatch.<init> - - - - -protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch / <init>
-
-

<init>

-DownloadedVsRequestedDataMismatch(requested: SecureHash, got: SecureHash)
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/got.html b/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/got.html deleted file mode 100644 index 3953e6af24..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/got.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.DownloadedVsRequestedDataMismatch.got - - - - -protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch / got
-
-

got

- -val got: SecureHash
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/index.html b/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/index.html deleted file mode 100644 index 49ee804e6d..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -FetchDataProtocol.DownloadedVsRequestedDataMismatch - - - - -protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch
-
-

DownloadedVsRequestedDataMismatch

-class DownloadedVsRequestedDataMismatch : BadAnswer
-
-
-

Constructors

- - - - - - - -
-<init> -DownloadedVsRequestedDataMismatch(requested: SecureHash, got: SecureHash)
-

Properties

- - - - - - - - - - - -
-got -val got: SecureHash
-requested -val requested: SecureHash
- - 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 deleted file mode 100644 index 9d4026cbea..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/requested.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.DownloadedVsRequestedDataMismatch.requested - - - - -protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch / requested
-
-

requested

- -val requested: SecureHash
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/-init-.html b/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/-init-.html deleted file mode 100644 index ffa5d6b549..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -FetchDataProtocol.HashNotFound.<init> - - - - -protocols / FetchDataProtocol / HashNotFound / <init>
-
-

<init>

-HashNotFound(requested: SecureHash)
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/index.html b/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/index.html deleted file mode 100644 index 324aed6d5c..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -FetchDataProtocol.HashNotFound - - - - -protocols / FetchDataProtocol / HashNotFound
-
-

HashNotFound

-class HashNotFound : BadAnswer
-
-
-

Constructors

- - - - - - - -
-<init> -HashNotFound(requested: SecureHash)
-

Properties

- - - - - - - -
-requested -val requested: SecureHash
- - 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 deleted file mode 100644 index cd2326c28b..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/requested.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.HashNotFound.requested - - - - -protocols / FetchDataProtocol / HashNotFound / requested
-
-

requested

- -val requested: SecureHash
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-init-.html b/docs/build/html/api/protocols/-fetch-data-protocol/-init-.html deleted file mode 100644 index 0578602535..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-init-.html +++ /dev/null @@ -1,30 +0,0 @@ - - -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.
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-result/-init-.html b/docs/build/html/api/protocols/-fetch-data-protocol/-result/-init-.html deleted file mode 100644 index 9e0db69a57..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-result/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -FetchDataProtocol.Result.<init> - - - - -protocols / FetchDataProtocol / Result / <init>
-
-

<init>

-Result(fromDisk: List<T>, downloaded: List<T>)
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-result/downloaded.html b/docs/build/html/api/protocols/-fetch-data-protocol/-result/downloaded.html deleted file mode 100644 index e7e6bd35bf..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-result/downloaded.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.Result.downloaded - - - - -protocols / FetchDataProtocol / Result / downloaded
-
-

downloaded

- -val downloaded: List<T>
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-result/from-disk.html b/docs/build/html/api/protocols/-fetch-data-protocol/-result/from-disk.html deleted file mode 100644 index cca7df0e2e..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-result/from-disk.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.Result.fromDisk - - - - -protocols / FetchDataProtocol / Result / fromDisk
-
-

fromDisk

- -val fromDisk: List<T>
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/-result/index.html b/docs/build/html/api/protocols/-fetch-data-protocol/-result/index.html deleted file mode 100644 index 7e4193f217..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/-result/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -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 deleted file mode 100644 index 528e5d4981..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -FetchDataProtocol.call - - - - -protocols / FetchDataProtocol / call
-
-

call

- -open fun call(): Result<T>
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/convert.html b/docs/build/html/api/protocols/-fetch-data-protocol/convert.html deleted file mode 100644 index 2189863bd3..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/convert.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.convert - - - - -protocols / FetchDataProtocol / convert
-
-

convert

- -protected open fun convert(wire: W): T
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/index.html b/docs/build/html/api/protocols/-fetch-data-protocol/index.html deleted file mode 100644 index 162826aa5a..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/index.html +++ /dev/null @@ -1,216 +0,0 @@ - - -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

- - - - - - - -
-Result -data class Result<T : NamedByHash>
-

Exceptions

- - - - - - - - - - - - - - - -
-BadAnswer -open class BadAnswer : Exception
-DownloadedVsRequestedDataMismatch -class DownloadedVsRequestedDataMismatch : BadAnswer
-HashNotFound -class HashNotFound : BadAnswer
-

Constructors

- - - - - - - -
-<init> -FetchDataProtocol(requests: Set<SecureHash>, otherSide: SingleMessageRecipient)

An abstract protocol for fetching typed data from a remote peer.

-
-

Properties

- - - - - - - - - - - - - - - -
-otherSide -val otherSide: SingleMessageRecipient
-queryTopic -abstract val queryTopic: String
-requests -val requests: Set<SecureHash>
-

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>
-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

- - - - - - - - - - - -
-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 deleted file mode 100644 index b891e4b0bd..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/load.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.load - - - - -protocols / FetchDataProtocol / load
-
-

load

- -protected abstract fun load(txid: SecureHash): T?
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/maybe-write-to-disk.html b/docs/build/html/api/protocols/-fetch-data-protocol/maybe-write-to-disk.html deleted file mode 100644 index 7ec619b522..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/maybe-write-to-disk.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.maybeWriteToDisk - - - - -protocols / FetchDataProtocol / maybeWriteToDisk
-
-

maybeWriteToDisk

- -protected open fun maybeWriteToDisk(downloaded: List<T>): Unit
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/other-side.html b/docs/build/html/api/protocols/-fetch-data-protocol/other-side.html deleted file mode 100644 index 98986700c8..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/other-side.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.otherSide - - - - -protocols / FetchDataProtocol / otherSide
-
-

otherSide

- -protected val otherSide: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/query-topic.html b/docs/build/html/api/protocols/-fetch-data-protocol/query-topic.html deleted file mode 100644 index 919bb4d389..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/query-topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.queryTopic - - - - -protocols / FetchDataProtocol / queryTopic
-
-

queryTopic

- -protected abstract val queryTopic: String
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-data-protocol/requests.html b/docs/build/html/api/protocols/-fetch-data-protocol/requests.html deleted file mode 100644 index ce24cdd3aa..0000000000 --- a/docs/build/html/api/protocols/-fetch-data-protocol/requests.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.requests - - - - -protocols / FetchDataProtocol / requests
-
-

requests

- -protected val requests: Set<SecureHash>
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-transactions-protocol/-init-.html b/docs/build/html/api/protocols/-fetch-transactions-protocol/-init-.html deleted file mode 100644 index 8cf43e951b..0000000000 --- a/docs/build/html/api/protocols/-fetch-transactions-protocol/-init-.html +++ /dev/null @@ -1,21 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-transactions-protocol/-t-o-p-i-c.html b/docs/build/html/api/protocols/-fetch-transactions-protocol/-t-o-p-i-c.html deleted file mode 100644 index a60773b4cb..0000000000 --- a/docs/build/html/api/protocols/-fetch-transactions-protocol/-t-o-p-i-c.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchTransactionsProtocol.TOPIC - - - - -protocols / FetchTransactionsProtocol / TOPIC
-
-

TOPIC

- -const val TOPIC: String
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-transactions-protocol/index.html b/docs/build/html/api/protocols/-fetch-transactions-protocol/index.html deleted file mode 100644 index 8496dfecd6..0000000000 --- a/docs/build/html/api/protocols/-fetch-transactions-protocol/index.html +++ /dev/null @@ -1,95 +0,0 @@ - - -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

- - - - - - - -
-queryTopic -val queryTopic: String
-

Inherited Properties

- - - - - - - - - - - -
-otherSide -val otherSide: SingleMessageRecipient
-requests -val requests: Set<SecureHash>
-

Functions

- - - - - - - -
-load -fun load(txid: SecureHash): SignedTransaction?
-

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 deleted file mode 100644 index 7456f4fdac..0000000000 --- a/docs/build/html/api/protocols/-fetch-transactions-protocol/load.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FetchTransactionsProtocol.load - - - - -protocols / FetchTransactionsProtocol / load
-
-

load

- -protected fun load(txid: SecureHash): SignedTransaction?
-Overrides FetchDataProtocol.load
-
-
- - diff --git a/docs/build/html/api/protocols/-fetch-transactions-protocol/query-topic.html b/docs/build/html/api/protocols/-fetch-transactions-protocol/query-topic.html deleted file mode 100644 index 875a45e066..0000000000 --- a/docs/build/html/api/protocols/-fetch-transactions-protocol/query-topic.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FetchTransactionsProtocol.queryTopic - - - - -protocols / FetchTransactionsProtocol / queryTopic
-
-

queryTopic

- -protected val queryTopic: String
-Overrides FetchDataProtocol.queryTopic
-
-
- - diff --git a/docs/build/html/api/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/-init-.html b/docs/build/html/api/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/-init-.html deleted file mode 100644 index 7c05f72a5b..0000000000 --- a/docs/build/html/api/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -ResolveTransactionsProtocol.ExcessivelyLargeTransactionGraph.<init> - - - - -protocols / ResolveTransactionsProtocol / ExcessivelyLargeTransactionGraph / <init>
-
-

<init>

-ExcessivelyLargeTransactionGraph()
-
-
- - diff --git a/docs/build/html/api/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/index.html b/docs/build/html/api/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/index.html deleted file mode 100644 index f85500a1f9..0000000000 --- a/docs/build/html/api/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/index.html +++ /dev/null @@ -1,25 +0,0 @@ - - -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 deleted file mode 100644 index 72a5c8ff35..0000000000 --- a/docs/build/html/api/protocols/-resolve-transactions-protocol/-init-.html +++ /dev/null @@ -1,28 +0,0 @@ - - -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.

-
-
-
-
- - diff --git a/docs/build/html/api/protocols/-resolve-transactions-protocol/call.html b/docs/build/html/api/protocols/-resolve-transactions-protocol/call.html deleted file mode 100644 index 7ebf5026df..0000000000 --- a/docs/build/html/api/protocols/-resolve-transactions-protocol/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -ResolveTransactionsProtocol.call - - - - -protocols / ResolveTransactionsProtocol / call
-
-

call

- -fun call(): Unit
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/protocols/-resolve-transactions-protocol/index.html b/docs/build/html/api/protocols/-resolve-transactions-protocol/index.html deleted file mode 100644 index 99ab62d17e..0000000000 --- a/docs/build/html/api/protocols/-resolve-transactions-protocol/index.html +++ /dev/null @@ -1,129 +0,0 @@ - - -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

- - - - - - - -
-ExcessivelyLargeTransactionGraph -class ExcessivelyLargeTransactionGraph : Exception
-

Constructors

- - - - - - - -
-<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.

-
-

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>
-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.

-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-client/-init-.html b/docs/build/html/api/protocols/-timestamping-protocol/-client/-init-.html deleted file mode 100644 index aa03f1f31f..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-client/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TimestampingProtocol.Client.<init> - - - - -protocols / TimestampingProtocol / Client / <init>
-
-

<init>

-Client(stateMachineManager: StateMachineManager, node: LegallyIdentifiableNode)
-
-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-client/identity.html b/docs/build/html/api/protocols/-timestamping-protocol/-client/identity.html deleted file mode 100644 index cb3d433e7b..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-client/identity.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TimestampingProtocol.Client.identity - - - - -protocols / TimestampingProtocol / Client / identity
-
-

identity

- -val identity: Party
-Overrides TimestamperService.identity
-

The name+pubkey that this timestamper will sign with.

-
-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-client/index.html b/docs/build/html/api/protocols/-timestamping-protocol/-client/index.html deleted file mode 100644 index ef394647c7..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-client/index.html +++ /dev/null @@ -1,48 +0,0 @@ - - -TimestampingProtocol.Client - - - - -protocols / TimestampingProtocol / Client
-
-

Client

-class Client : TimestamperService
-
-
-

Constructors

- - - - - - - -
-<init> -Client(stateMachineManager: StateMachineManager, node: LegallyIdentifiableNode)
-

Properties

- - - - - - - -
-identity -val identity: Party

The name+pubkey that this timestamper will sign with.

-
-

Functions

- - - - - - - -
-timestamp -fun timestamp(wtxBytes: SerializedBytes<WireTransaction>): LegallyIdentifiable
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-client/timestamp.html b/docs/build/html/api/protocols/-timestamping-protocol/-client/timestamp.html deleted file mode 100644 index c5d2643ab3..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-client/timestamp.html +++ /dev/null @@ -1,16 +0,0 @@ - - -TimestampingProtocol.Client.timestamp - - - - -protocols / TimestampingProtocol / Client / timestamp
-
-

timestamp

- -fun timestamp(wtxBytes: SerializedBytes<WireTransaction>): LegallyIdentifiable
-Overrides TimestamperService.timestamp
-
-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-init-.html b/docs/build/html/api/protocols/-timestamping-protocol/-init-.html deleted file mode 100644 index 2ad1191eff..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-init-.html +++ /dev/null @@ -1,22 +0,0 @@ - - -TimestampingProtocol.<init> - - - - -protocols / TimestampingProtocol / <init>
-
-

<init>

-TimestampingProtocol(node: LegallyIdentifiableNode, wtxBytes: SerializedBytes<WireTransaction>)
-

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.

-
-
-
-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-request/-init-.html b/docs/build/html/api/protocols/-timestamping-protocol/-request/-init-.html deleted file mode 100644 index 4ecaf48a24..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-request/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TimestampingProtocol.Request.<init> - - - - -protocols / TimestampingProtocol / Request / <init>
-
-

<init>

-Request(tx: SerializedBytes<WireTransaction>, replyTo: MessageRecipients, replyToTopic: String)
-
-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-request/index.html b/docs/build/html/api/protocols/-timestamping-protocol/-request/index.html deleted file mode 100644 index 28441bf1b8..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-request/index.html +++ /dev/null @@ -1,48 +0,0 @@ - - -TimestampingProtocol.Request - - - - -protocols / TimestampingProtocol / Request
-
-

Request

-data class Request
-
-
-

Constructors

- - - - - - - -
-<init> -Request(tx: SerializedBytes<WireTransaction>, replyTo: MessageRecipients, replyToTopic: String)
-

Properties

- - - - - - - - - - - - - - - -
-replyTo -val replyTo: MessageRecipients
-replyToTopic -val replyToTopic: String
-tx -val tx: SerializedBytes<WireTransaction>
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to-topic.html b/docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to-topic.html deleted file mode 100644 index 8ab22b42c9..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to-topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampingProtocol.Request.replyToTopic - - - - -protocols / TimestampingProtocol / Request / replyToTopic
-
-

replyToTopic

- -val replyToTopic: String
-
-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to.html b/docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to.html deleted file mode 100644 index e3be245c56..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampingProtocol.Request.replyTo - - - - -protocols / TimestampingProtocol / Request / replyTo
-
-

replyTo

- -val replyTo: MessageRecipients
-
-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/-request/tx.html b/docs/build/html/api/protocols/-timestamping-protocol/-request/tx.html deleted file mode 100644 index 76d6d2334f..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/-request/tx.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampingProtocol.Request.tx - - - - -protocols / TimestampingProtocol / Request / tx
-
-

tx

- -val tx: SerializedBytes<WireTransaction>
-
-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/call.html b/docs/build/html/api/protocols/-timestamping-protocol/call.html deleted file mode 100644 index 1baa21f781..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TimestampingProtocol.call - - - - -protocols / TimestampingProtocol / call
-
-

call

- -fun call(): LegallyIdentifiable
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/protocols/-timestamping-protocol/index.html b/docs/build/html/api/protocols/-timestamping-protocol/index.html deleted file mode 100644 index 2d668712e1..0000000000 --- a/docs/build/html/api/protocols/-timestamping-protocol/index.html +++ /dev/null @@ -1,131 +0,0 @@ - - -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

- - - - - - - - - - - -
-Client -class Client : TimestamperService
-Request -data class Request
-

Constructors

- - - - - - - -
-<init> -TimestampingProtocol(node: LegallyIdentifiableNode, wtxBytes: SerializedBytes<WireTransaction>)

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.

-
-

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(): LegallyIdentifiable

This is where you fill out your business logic.

-
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - -
-receive -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 ProtocolLogics reference to the -ProtocolStateMachine and then calling the call method.

-
- - 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 deleted file mode 100644 index d5e857ca58..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException.<init> - - - - -protocols / TwoPartyTradeProtocol / AssetMismatchException / <init>
-
-

<init>

-AssetMismatchException(expectedTypeName: String, typeName: String)
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/expected-type-name.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/expected-type-name.html deleted file mode 100644 index f5ba76c752..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/expected-type-name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException.expectedTypeName - - - - -protocols / TwoPartyTradeProtocol / AssetMismatchException / expectedTypeName
-
-

expectedTypeName

- -val expectedTypeName: String
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/index.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/index.html deleted file mode 100644 index 6ec1803de2..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/index.html +++ /dev/null @@ -1,53 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException - - - - -protocols / TwoPartyTradeProtocol / AssetMismatchException
-
-

AssetMismatchException

-class AssetMismatchException : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -AssetMismatchException(expectedTypeName: String, typeName: String)
-

Properties

- - - - - - - - - - - -
-expectedTypeName -val expectedTypeName: String
-typeName -val typeName: String
-

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 deleted file mode 100644 index 471a3f9edc..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException.toString - - - - -protocols / TwoPartyTradeProtocol / AssetMismatchException / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/type-name.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/type-name.html deleted file mode 100644 index 97bc26fece..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/type-name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException.typeName - - - - -protocols / TwoPartyTradeProtocol / AssetMismatchException / typeName
-
-

typeName

- -val typeName: String
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-init-.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-init-.html deleted file mode 100644 index 84763d3562..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.<init> - - - - -protocols / TwoPartyTradeProtocol / Buyer / <init>
-
-

<init>

-Buyer(otherSide: SingleMessageRecipient, timestampingAuthority: Party, acceptablePrice: Amount, typeToBuy: Class<out OwnableState>, sessionID: Long)
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-r-e-c-e-i-v-i-n-g.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-r-e-c-e-i-v-i-n-g.html deleted file mode 100644 index f65fef3854..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-r-e-c-e-i-v-i-n-g.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index 10ee9dcad7..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-s-i-g-n-i-n-g.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index 4f0ec517dc..0000000000 --- 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 +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index 43e2cd9e0b..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-v-e-r-i-f-y-i-n-g.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index bee486308d..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/acceptable-price.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.acceptablePrice - - - - -protocols / TwoPartyTradeProtocol / Buyer / acceptablePrice
-
-

acceptablePrice

- -val acceptablePrice: Amount
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/call.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/call.html deleted file mode 100644 index 1e1d3eae3f..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.call - - - - -protocols / TwoPartyTradeProtocol / Buyer / call
-
-

call

- -open fun call(): SignedTransaction
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/index.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/index.html deleted file mode 100644 index aa2003213a..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/index.html +++ /dev/null @@ -1,168 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer - - - - -protocols / TwoPartyTradeProtocol / Buyer
-
-

Buyer

-class Buyer : ProtocolLogic<SignedTransaction>
-
-
-

Types

- - - - - - - - - - - - - - - - - - - -
-RECEIVING -object RECEIVING : Step
-SIGNING -object SIGNING : Step
-SWAPPING_SIGNATURES -object SWAPPING_SIGNATURES : Step
-VERIFYING -object VERIFYING : Step
-

Constructors

- - - - - - - -
-<init> -Buyer(otherSide: SingleMessageRecipient, timestampingAuthority: Party, acceptablePrice: Amount, typeToBuy: Class<out OwnableState>, sessionID: Long)
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-acceptablePrice -val acceptablePrice: Amount
-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
-typeToBuy -val typeToBuy: Class<out OwnableState>
-

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 -open fun call(): SignedTransaction

This is where you fill out your business logic.

-
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - -
-receive -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 ProtocolLogics 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 deleted file mode 100644 index 2cb2d98143..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/other-side.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.otherSide - - - - -protocols / TwoPartyTradeProtocol / Buyer / otherSide
-
-

otherSide

- -val otherSide: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/progress-tracker.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/progress-tracker.html deleted file mode 100644 index 4c10e094d0..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/progress-tracker.html +++ /dev/null @@ -1,24 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.progressTracker - - - - -protocols / TwoPartyTradeProtocol / Buyer / progressTracker
-
-

progressTracker

- -open val progressTracker: ProgressTracker
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/session-i-d.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/session-i-d.html deleted file mode 100644 index 489473da52..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/session-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.sessionID - - - - -protocols / TwoPartyTradeProtocol / Buyer / sessionID
-
-

sessionID

- -val sessionID: Long
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/timestamping-authority.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/timestamping-authority.html deleted file mode 100644 index 9f4183a4c9..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/timestamping-authority.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.timestampingAuthority - - - - -protocols / TwoPartyTradeProtocol / Buyer / timestampingAuthority
-
-

timestampingAuthority

- -val timestampingAuthority: Party
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/type-to-buy.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/type-to-buy.html deleted file mode 100644 index 7a270d8060..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/type-to-buy.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.typeToBuy - - - - -protocols / TwoPartyTradeProtocol / Buyer / typeToBuy
-
-

typeToBuy

- -val typeToBuy: Class<out OwnableState>
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/-init-.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/-init-.html deleted file mode 100644 index 942c52ba0f..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.<init> - - - - -protocols / TwoPartyTradeProtocol / SellerTradeInfo / <init>
-
-

<init>

-SellerTradeInfo(assetForSale: StateAndRef<OwnableState>, price: Amount, sellerOwnerKey: PublicKey, sessionID: Long)
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/asset-for-sale.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/asset-for-sale.html deleted file mode 100644 index 46d33703ac..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/asset-for-sale.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.assetForSale - - - - -protocols / TwoPartyTradeProtocol / SellerTradeInfo / assetForSale
-
-

assetForSale

- -val assetForSale: StateAndRef<OwnableState>
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/index.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/index.html deleted file mode 100644 index 3dfbcb8df3..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/index.html +++ /dev/null @@ -1,54 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo - - - - -protocols / TwoPartyTradeProtocol / SellerTradeInfo
-
-

SellerTradeInfo

-class SellerTradeInfo
-
-
-

Constructors

- - - - - - - -
-<init> -SellerTradeInfo(assetForSale: StateAndRef<OwnableState>, price: Amount, sellerOwnerKey: PublicKey, sessionID: Long)
-

Properties

- - - - - - - - - - - - - - - - - - - -
-assetForSale -val assetForSale: StateAndRef<OwnableState>
-price -val price: Amount
-sellerOwnerKey -val sellerOwnerKey: PublicKey
-sessionID -val sessionID: Long
- - 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 deleted file mode 100644 index 6b43819ef0..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/price.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.price - - - - -protocols / TwoPartyTradeProtocol / SellerTradeInfo / price
-
-

price

- -val price: Amount
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/seller-owner-key.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/seller-owner-key.html deleted file mode 100644 index 4033db523f..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/seller-owner-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.sellerOwnerKey - - - - -protocols / TwoPartyTradeProtocol / SellerTradeInfo / sellerOwnerKey
-
-

sellerOwnerKey

- -val sellerOwnerKey: PublicKey
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/session-i-d.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/session-i-d.html deleted file mode 100644 index 30a1cced34..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/session-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.sessionID - - - - -protocols / TwoPartyTradeProtocol / SellerTradeInfo / sessionID
-
-

sessionID

- -val sessionID: Long
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-a-w-a-i-t-i-n-g_-p-r-o-p-o-s-a-l.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-a-w-a-i-t-i-n-g_-p-r-o-p-o-s-a-l.html deleted file mode 100644 index a1c5448855..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-a-w-a-i-t-i-n-g_-p-r-o-p-o-s-a-l.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index e59ac66518..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.<init> - - - - -protocols / TwoPartyTradeProtocol / Seller / <init>
-
-

<init>

-Seller(otherSide: SingleMessageRecipient, timestampingAuthority: LegallyIdentifiableNode, assetToSell: StateAndRef<OwnableState>, price: Amount, myKeyPair: KeyPair, buyerSessionID: Long, progressTracker: ProgressTracker = Seller.tracker())
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-s-e-n-d-i-n-g_-s-i-g-s.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-s-e-n-d-i-n-g_-s-i-g-s.html deleted file mode 100644 index 6e35ae3729..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-s-e-n-d-i-n-g_-s-i-g-s.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index 62094afd9a..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-s-i-g-n-i-n-g.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index ddade60013..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-t-i-m-e-s-t-a-m-p-i-n-g.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index 9722dde40f..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/-v-e-r-i-f-y-i-n-g.html +++ /dev/null @@ -1,31 +0,0 @@ - - -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 deleted file mode 100644 index 5a321028dd..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/asset-to-sell.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.assetToSell - - - - -protocols / TwoPartyTradeProtocol / Seller / assetToSell
-
-

assetToSell

- -val assetToSell: StateAndRef<OwnableState>
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/buyer-session-i-d.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/buyer-session-i-d.html deleted file mode 100644 index b29e63a2ba..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/buyer-session-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.buyerSessionID - - - - -protocols / TwoPartyTradeProtocol / Seller / buyerSessionID
-
-

buyerSessionID

- -val buyerSessionID: Long
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/call.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/call.html deleted file mode 100644 index 2f9c8a4a6e..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.call - - - - -protocols / TwoPartyTradeProtocol / Seller / call
-
-

call

- -open fun call(): SignedTransaction
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/index.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/index.html deleted file mode 100644 index 28b948775c..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/index.html +++ /dev/null @@ -1,197 +0,0 @@ - - -TwoPartyTradeProtocol.Seller - - - - -protocols / TwoPartyTradeProtocol / Seller
-
-

Seller

-class Seller : ProtocolLogic<SignedTransaction>
-
-
-

Types

- - - - - - - - - - - - - - - - - - - - - - - -
-AWAITING_PROPOSAL -object AWAITING_PROPOSAL : Step
-SENDING_SIGS -object SENDING_SIGS : Step
-SIGNING -object SIGNING : Step
-TIMESTAMPING -object TIMESTAMPING : Step
-VERIFYING -object VERIFYING : Step
-

Constructors

- - - - - - - -
-<init> -Seller(otherSide: SingleMessageRecipient, timestampingAuthority: LegallyIdentifiableNode, assetToSell: StateAndRef<OwnableState>, price: Amount, myKeyPair: KeyPair, buyerSessionID: Long, progressTracker: ProgressTracker = Seller.tracker())
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-assetToSell -val assetToSell: StateAndRef<OwnableState>
-buyerSessionID -val buyerSessionID: Long
-myKeyPair -val myKeyPair: KeyPair
-otherSide -val otherSide: SingleMessageRecipient
-price -val price: Amount
-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.

-
-timestampingAuthority -val timestampingAuthority: LegallyIdentifiableNode
-

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 -open fun call(): SignedTransaction

This is where you fill out your business logic.

-
-signWithOurKey -open fun signWithOurKey(partialTX: SignedTransaction): WithKey
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - -
-receive -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 ProtocolLogics reference to the -ProtocolStateMachine and then calling the call method.

-
-

Companion Object Functions

- - - - - - - -
-tracker -fun tracker(): ProgressTracker
- - 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 deleted file mode 100644 index 6c8395b3ea..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/my-key-pair.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.myKeyPair - - - - -protocols / TwoPartyTradeProtocol / Seller / myKeyPair
-
-

myKeyPair

- -val myKeyPair: KeyPair
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/other-side.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/other-side.html deleted file mode 100644 index c22a714a12..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/other-side.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.otherSide - - - - -protocols / TwoPartyTradeProtocol / Seller / otherSide
-
-

otherSide

- -val otherSide: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/price.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/price.html deleted file mode 100644 index d2bf09587b..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/price.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.price - - - - -protocols / TwoPartyTradeProtocol / Seller / price
-
-

price

- -val price: Amount
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/progress-tracker.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/progress-tracker.html deleted file mode 100644 index 55310ba155..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/progress-tracker.html +++ /dev/null @@ -1,24 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.progressTracker - - - - -protocols / TwoPartyTradeProtocol / Seller / progressTracker
-
-

progressTracker

- -open val progressTracker: ProgressTracker
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/sign-with-our-key.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/sign-with-our-key.html deleted file mode 100644 index df269740ac..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/sign-with-our-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.signWithOurKey - - - - -protocols / TwoPartyTradeProtocol / Seller / signWithOurKey
-
-

signWithOurKey

- -open fun signWithOurKey(partialTX: SignedTransaction): WithKey
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/timestamping-authority.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/timestamping-authority.html deleted file mode 100644 index b6f9186377..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/timestamping-authority.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.timestampingAuthority - - - - -protocols / TwoPartyTradeProtocol / Seller / timestampingAuthority
-
-

timestampingAuthority

- -val timestampingAuthority: LegallyIdentifiableNode
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/tracker.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/tracker.html deleted file mode 100644 index 54c648d08b..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-seller/tracker.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.tracker - - - - -protocols / TwoPartyTradeProtocol / Seller / tracker
-
-

tracker

- -fun tracker(): ProgressTracker
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/-init-.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/-init-.html deleted file mode 100644 index 767d05b5b4..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.SignaturesFromSeller.<init> - - - - -protocols / TwoPartyTradeProtocol / SignaturesFromSeller / <init>
-
-

<init>

-SignaturesFromSeller(timestampAuthoritySig: WithKey, sellerSig: WithKey)
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/index.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/index.html deleted file mode 100644 index c2307dd12b..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -TwoPartyTradeProtocol.SignaturesFromSeller - - - - -protocols / TwoPartyTradeProtocol / SignaturesFromSeller
-
-

SignaturesFromSeller

-class SignaturesFromSeller
-
-
-

Constructors

- - - - - - - -
-<init> -SignaturesFromSeller(timestampAuthoritySig: WithKey, sellerSig: WithKey)
-

Properties

- - - - - - - - - - - -
-sellerSig -val sellerSig: WithKey
-timestampAuthoritySig -val timestampAuthoritySig: WithKey
- - 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 deleted file mode 100644 index 89d46cd81f..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/seller-sig.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SignaturesFromSeller.sellerSig - - - - -protocols / TwoPartyTradeProtocol / SignaturesFromSeller / sellerSig
-
-

sellerSig

- -val sellerSig: WithKey
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/timestamp-authority-sig.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/timestamp-authority-sig.html deleted file mode 100644 index 99ac9611e4..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-signatures-from-seller/timestamp-authority-sig.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SignaturesFromSeller.timestampAuthoritySig - - - - -protocols / TwoPartyTradeProtocol / SignaturesFromSeller / timestampAuthoritySig
-
-

timestampAuthoritySig

- -val timestampAuthoritySig: WithKey
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-t-r-a-d-e_-t-o-p-i-c.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-t-r-a-d-e_-t-o-p-i-c.html deleted file mode 100644 index 104a71ac8b..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-t-r-a-d-e_-t-o-p-i-c.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.TRADE_TOPIC - - - - -protocols / TwoPartyTradeProtocol / TRADE_TOPIC
-
-

TRADE_TOPIC

- -val TRADE_TOPIC: String
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-unacceptable-price-exception/-init-.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-unacceptable-price-exception/-init-.html deleted file mode 100644 index 8039ffdf70..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-unacceptable-price-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.UnacceptablePriceException.<init> - - - - -protocols / TwoPartyTradeProtocol / UnacceptablePriceException / <init>
-
-

<init>

-UnacceptablePriceException(givenPrice: Amount)
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-unacceptable-price-exception/given-price.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-unacceptable-price-exception/given-price.html deleted file mode 100644 index 53203a44fe..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-unacceptable-price-exception/given-price.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.UnacceptablePriceException.givenPrice - - - - -protocols / TwoPartyTradeProtocol / UnacceptablePriceException / givenPrice
-
-

givenPrice

- -val givenPrice: Amount
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/-unacceptable-price-exception/index.html b/docs/build/html/api/protocols/-two-party-trade-protocol/-unacceptable-price-exception/index.html deleted file mode 100644 index 90585749f0..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/-unacceptable-price-exception/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -TwoPartyTradeProtocol.UnacceptablePriceException - - - - -protocols / TwoPartyTradeProtocol / UnacceptablePriceException
-
-

UnacceptablePriceException

-class UnacceptablePriceException : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -UnacceptablePriceException(givenPrice: Amount)
-

Properties

- - - - - - - -
-givenPrice -val givenPrice: Amount
- - 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 deleted file mode 100644 index d8fa49c676..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/index.html +++ /dev/null @@ -1,106 +0,0 @@ - - -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:

-

  1. 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.

    -

  2. 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.

    -

  3. 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

- - - - - - - - - - - - - - - - - - - -
-Buyer -class Buyer : ProtocolLogic<SignedTransaction>
-Seller -class Seller : ProtocolLogic<SignedTransaction>
-SellerTradeInfo -class SellerTradeInfo
-SignaturesFromSeller -class SignaturesFromSeller
-

Exceptions

- - - - - - - - - - - -
-AssetMismatchException -class AssetMismatchException : Exception
-UnacceptablePriceException -class UnacceptablePriceException : Exception
-

Properties

- - - - - - - -
-TRADE_TOPIC -val TRADE_TOPIC: String
-

Functions

- - - - - - - - - - - -
-runBuyer -fun runBuyer(smm: StateMachineManager, timestampingAuthority: LegallyIdentifiableNode, otherSide: SingleMessageRecipient, acceptablePrice: Amount, typeToBuy: Class<out OwnableState>, sessionID: Long): <ERROR CLASS><SignedTransaction>
-runSeller -fun runSeller(smm: StateMachineManager, timestampingAuthority: LegallyIdentifiableNode, 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 deleted file mode 100644 index c759297ac0..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/run-buyer.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.runBuyer - - - - -protocols / TwoPartyTradeProtocol / runBuyer
-
-

runBuyer

- -fun runBuyer(smm: StateMachineManager, timestampingAuthority: LegallyIdentifiableNode, otherSide: SingleMessageRecipient, acceptablePrice: Amount, typeToBuy: Class<out OwnableState>, sessionID: Long): <ERROR CLASS><SignedTransaction>
-
-
- - diff --git a/docs/build/html/api/protocols/-two-party-trade-protocol/run-seller.html b/docs/build/html/api/protocols/-two-party-trade-protocol/run-seller.html deleted file mode 100644 index 51a5ed045f..0000000000 --- a/docs/build/html/api/protocols/-two-party-trade-protocol/run-seller.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.runSeller - - - - -protocols / TwoPartyTradeProtocol / runSeller
-
-

runSeller

- -fun runSeller(smm: StateMachineManager, timestampingAuthority: LegallyIdentifiableNode, otherSide: SingleMessageRecipient, assetToSell: StateAndRef<OwnableState>, price: Amount, myKeyPair: KeyPair, buyerSessionID: Long): <ERROR CLASS><SignedTransaction>
-
-
- - diff --git a/docs/build/html/api/protocols/index.html b/docs/build/html/api/protocols/index.html deleted file mode 100644 index 09a55bdb48..0000000000 --- a/docs/build/html/api/protocols/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - -protocols - - - - -protocols
-
-

Package protocols

-

Types

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-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.

-
-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.

-
-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/r3prototyping/alltypes/index.html b/docs/build/html/api/r3prototyping/alltypes/index.html deleted file mode 100644 index 86eb57333f..0000000000 --- a/docs/build/html/api/r3prototyping/alltypes/index.html +++ /dev/null @@ -1,377 +0,0 @@ - - -alltypes - r3prototyping - - - -

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.

-
-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.messaging.AllPossibleRecipients -

A special base class for the set of all possible recipients, without having to identify who they all are.

-
-core.node.services.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.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.servlets.AttachmentUploadServlet -
-core.utilities.BriefLogFormatter -

A Java logging formatter that writes more compact output than the default.

-
-core.node.ConfigurationException -
-core.node.services.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.node.services.E2ETestKeyManagementService -

A simple in-memory KMS that doesnt bother saving keys to disk. A real implementation would:

-
-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.node.services.FixedIdentityService -

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-core.node.services.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.

-
-core.messaging.LegallyIdentifiableNode -

Info about a network node that has is operated by some sort of verified identity.

-
-org.slf4j.Logger (extensions in package core.utilities) -
-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.messaging.MockNetworkMap -
-core.messaging.NetworkMap -

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. A reasonable architecture for the -network map service might be one like the Tor directory authorities, where several nodes linked by RAFT or Paxos -elect a leader and that leader distributes signed documents describing the network layout. Those documents can -then be cached by every node and thus a network map can be retrieved given only a single successful peer connection.

-
-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.NodeConfigurationFromProperties -

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-
-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.services.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.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.

-
-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.

-
-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.

-
-core.node.services.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.messaging.SingleMessageRecipient -

A base class for the case of point-to-point messages

-
-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.node.services.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.

-
-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

-
-demos.TraderDemoProtocolBuyer -
-demos.TraderDemoProtocolSeller -
-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.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:

-
-core.node.services.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.services.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

-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-all-possible-recipients.html b/docs/build/html/api/r3prototyping/core.messaging/-all-possible-recipients.html deleted file mode 100644 index 7c3a239552..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-all-possible-recipients.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AllPossibleRecipients - r3prototyping - - - -r3prototyping / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/-init-.html b/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/-init-.html deleted file mode 100644 index 83581e010b..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -LegallyIdentifiableNode.<init> - r3prototyping - - - -r3prototyping / core.messaging / LegallyIdentifiableNode / <init>
-
-

<init>

-LegallyIdentifiableNode(address: SingleMessageRecipient, identity: Party)
-

Info about a network node that has is operated by some sort of verified identity.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/address.html b/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/address.html deleted file mode 100644 index 6353f099fc..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/address.html +++ /dev/null @@ -1,15 +0,0 @@ - - -LegallyIdentifiableNode.address - r3prototyping - - - -r3prototyping / core.messaging / LegallyIdentifiableNode / address
-
-

address

- -val address: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/identity.html b/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/identity.html deleted file mode 100644 index 0396bb856c..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/identity.html +++ /dev/null @@ -1,15 +0,0 @@ - - -LegallyIdentifiableNode.identity - r3prototyping - - - -r3prototyping / core.messaging / LegallyIdentifiableNode / identity
-
-

identity

- -val identity: Party
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/index.html b/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/index.html deleted file mode 100644 index 3c96da4125..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-legally-identifiable-node/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - -LegallyIdentifiableNode - r3prototyping - - - -r3prototyping / core.messaging / LegallyIdentifiableNode
-
-

LegallyIdentifiableNode

-data class LegallyIdentifiableNode
-

Info about a network node that has is operated by some sort of verified identity.

-
-
-

Constructors

- - - - - - - -
-<init> -LegallyIdentifiableNode(address: SingleMessageRecipient, identity: Party)

Info about a network node that has is operated by some sort of verified identity.

-
-

Properties

- - - - - - - - - - - -
-address -val address: SingleMessageRecipient
-identity -val identity: Party
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-message-handler-registration.html b/docs/build/html/api/r3prototyping/core.messaging/-message-handler-registration.html deleted file mode 100644 index dd787c12fd..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-message-handler-registration.html +++ /dev/null @@ -1,26 +0,0 @@ - - -MessageHandlerRegistration - r3prototyping - - - -r3prototyping / core.messaging / MessageHandlerRegistration
-
-

MessageHandlerRegistration

-interface MessageHandlerRegistration
-
-
-

Inheritors

- - - - - - - -
-Handler -inner class Handler : MessageHandlerRegistration

A registration to handle messages of different types

-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-message-recipient-group.html b/docs/build/html/api/r3prototyping/core.messaging/-message-recipient-group.html deleted file mode 100644 index 847f403b1f..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-message-recipient-group.html +++ /dev/null @@ -1,15 +0,0 @@ - - -MessageRecipientGroup - r3prototyping - - - -r3prototyping / core.messaging / MessageRecipientGroup
-
-

MessageRecipientGroup

-interface MessageRecipientGroup : MessageRecipients
-

A base class for a set of recipients specifically identified by the sender.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-message-recipients.html b/docs/build/html/api/r3prototyping/core.messaging/-message-recipients.html deleted file mode 100644 index ca85192e90..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-message-recipients.html +++ /dev/null @@ -1,41 +0,0 @@ - - -MessageRecipients - r3prototyping - - - -r3prototyping / 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/r3prototyping/core.messaging/-message/data.html b/docs/build/html/api/r3prototyping/core.messaging/-message/data.html deleted file mode 100644 index 7a25e4d2c1..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-message/data.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.data - r3prototyping - - - -r3prototyping / core.messaging / Message / data
-
-

data

- -abstract val data: ByteArray
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-message/debug-message-i-d.html b/docs/build/html/api/r3prototyping/core.messaging/-message/debug-message-i-d.html deleted file mode 100644 index 0480125336..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-message/debug-message-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.debugMessageID - r3prototyping - - - -r3prototyping / core.messaging / Message / debugMessageID
-
-

debugMessageID

- -abstract val debugMessageID: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-message/debug-timestamp.html b/docs/build/html/api/r3prototyping/core.messaging/-message/debug-timestamp.html deleted file mode 100644 index e474213b5c..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-message/debug-timestamp.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.debugTimestamp - r3prototyping - - - -r3prototyping / core.messaging / Message / debugTimestamp
-
-

debugTimestamp

- -abstract val debugTimestamp: Instant
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-message/index.html b/docs/build/html/api/r3prototyping/core.messaging/-message/index.html deleted file mode 100644 index 15d1ad6a52..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-message/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - -Message - r3prototyping - - - -r3prototyping / 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

- - - - - - - - - - - - - - - - - - - -
-data -abstract val data: ByteArray
-debugMessageID -abstract val debugMessageID: String
-debugTimestamp -abstract val debugTimestamp: Instant
-topic -abstract val topic: String
-

Functions

- - - - - - - -
-serialise -abstract fun serialise(): ByteArray
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-message/serialise.html b/docs/build/html/api/r3prototyping/core.messaging/-message/serialise.html deleted file mode 100644 index 93adcff5cc..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-message/serialise.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.serialise - r3prototyping - - - -r3prototyping / core.messaging / Message / serialise
-
-

serialise

- -abstract fun serialise(): ByteArray
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-message/topic.html b/docs/build/html/api/r3prototyping/core.messaging/-message/topic.html deleted file mode 100644 index 62c69929ca..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-message/topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Message.topic - r3prototyping - - - -r3prototyping / core.messaging / Message / topic
-
-

topic

- -abstract val topic: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service-builder/index.html b/docs/build/html/api/r3prototyping/core.messaging/-messaging-service-builder/index.html deleted file mode 100644 index 43cea9dc86..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service-builder/index.html +++ /dev/null @@ -1,33 +0,0 @@ - - -MessagingServiceBuilder - r3prototyping - - - -r3prototyping / 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(): ListenableFuture<out T>
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service-builder/start.html b/docs/build/html/api/r3prototyping/core.messaging/-messaging-service-builder/start.html deleted file mode 100644 index 2ede37b378..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service-builder/start.html +++ /dev/null @@ -1,15 +0,0 @@ - - -MessagingServiceBuilder.start - r3prototyping - - - -r3prototyping / core.messaging / MessagingServiceBuilder / start
-
-

start

- -abstract fun start(): ListenableFuture<out T>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/add-message-handler.html b/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/add-message-handler.html deleted file mode 100644 index 69b7710122..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/add-message-handler.html +++ /dev/null @@ -1,24 +0,0 @@ - - -MessagingService.addMessageHandler - r3prototyping - - - -r3prototyping / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/create-message.html b/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/create-message.html deleted file mode 100644 index 284ce819ae..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/create-message.html +++ /dev/null @@ -1,16 +0,0 @@ - - -MessagingService.createMessage - r3prototyping - - - -r3prototyping / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/index.html b/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/index.html deleted file mode 100644 index f5e7c087fc..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/index.html +++ /dev/null @@ -1,113 +0,0 @@ - - -MessagingService - r3prototyping - - - -r3prototyping / core.messaging / MessagingService
-
-

MessagingService

-@ThreadSafe 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

- - - - - - - -
-myAddress -abstract val myAddress: SingleMessageRecipient

Returns an address that refers to this node.

-
-

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, includeClassName: Boolean = false): 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.

-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/my-address.html b/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/my-address.html deleted file mode 100644 index 2a58245a77..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/my-address.html +++ /dev/null @@ -1,16 +0,0 @@ - - -MessagingService.myAddress - r3prototyping - - - -r3prototyping / core.messaging / MessagingService / myAddress
-
-

myAddress

- -abstract val myAddress: SingleMessageRecipient
-

Returns an address that refers to this node.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/remove-message-handler.html b/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/remove-message-handler.html deleted file mode 100644 index b9bb90498a..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/remove-message-handler.html +++ /dev/null @@ -1,23 +0,0 @@ - - -MessagingService.removeMessageHandler - r3prototyping - - - -r3prototyping / 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.
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/send.html b/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/send.html deleted file mode 100644 index 9999e3a65d..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/send.html +++ /dev/null @@ -1,23 +0,0 @@ - - -MessagingService.send - r3prototyping - - - -r3prototyping / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/stop.html b/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/stop.html deleted file mode 100644 index 087f777057..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-messaging-service/stop.html +++ /dev/null @@ -1,15 +0,0 @@ - - -MessagingService.stop - r3prototyping - - - -r3prototyping / core.messaging / MessagingService / stop
-
-

stop

- -abstract fun stop(): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-mock-network-map/-init-.html b/docs/build/html/api/r3prototyping/core.messaging/-mock-network-map/-init-.html deleted file mode 100644 index 167a1038b1..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-mock-network-map/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -MockNetworkMap.<init> - r3prototyping - - - -r3prototyping / core.messaging / MockNetworkMap / <init>
-
-

<init>

-MockNetworkMap()
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-mock-network-map/index.html b/docs/build/html/api/r3prototyping/core.messaging/-mock-network-map/index.html deleted file mode 100644 index 6ed3641315..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-mock-network-map/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -MockNetworkMap - r3prototyping - - - -r3prototyping / core.messaging / MockNetworkMap
-
-

MockNetworkMap

-class MockNetworkMap : NetworkMap
-
-
-

Constructors

- - - - - - - -
-<init> -MockNetworkMap()
-

Properties

- - - - - - - -
-timestampingNodes -val timestampingNodes: MutableList<LegallyIdentifiableNode>
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-mock-network-map/timestamping-nodes.html b/docs/build/html/api/r3prototyping/core.messaging/-mock-network-map/timestamping-nodes.html deleted file mode 100644 index e14dcae540..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-mock-network-map/timestamping-nodes.html +++ /dev/null @@ -1,16 +0,0 @@ - - -MockNetworkMap.timestampingNodes - r3prototyping - - - -r3prototyping / core.messaging / MockNetworkMap / timestampingNodes
-
-

timestampingNodes

- -val timestampingNodes: MutableList<LegallyIdentifiableNode>
-Overrides NetworkMap.timestampingNodes
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-network-map/index.html b/docs/build/html/api/r3prototyping/core.messaging/-network-map/index.html deleted file mode 100644 index 937e6cabdd..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-network-map/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - -NetworkMap - r3prototyping - - - -r3prototyping / core.messaging / NetworkMap
-
-

NetworkMap

-interface NetworkMap
-

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. A reasonable architecture for the -network map service might be one like the Tor directory authorities, where several nodes linked by RAFT or Paxos -elect a leader and that leader distributes signed documents describing the network layout. Those documents can -then be cached by every node and thus a network map can be retrieved given only a single successful peer connection.

-

This interface assumes fast, synchronous access to an in-memory map.

-
-
-
-
-

Properties

- - - - - - - -
-timestampingNodes -abstract val timestampingNodes: List<LegallyIdentifiableNode>
-

Inheritors

- - - - - - - -
-MockNetworkMap -class MockNetworkMap : NetworkMap
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-network-map/timestamping-nodes.html b/docs/build/html/api/r3prototyping/core.messaging/-network-map/timestamping-nodes.html deleted file mode 100644 index 29d19cb42c..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-network-map/timestamping-nodes.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NetworkMap.timestampingNodes - r3prototyping - - - -r3prototyping / core.messaging / NetworkMap / timestampingNodes
-
-

timestampingNodes

- -abstract val timestampingNodes: List<LegallyIdentifiableNode>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-single-message-recipient.html b/docs/build/html/api/r3prototyping/core.messaging/-single-message-recipient.html deleted file mode 100644 index a1a259283d..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-single-message-recipient.html +++ /dev/null @@ -1,15 +0,0 @@ - - -SingleMessageRecipient - r3prototyping - - - -r3prototyping / core.messaging / SingleMessageRecipient
-
-

SingleMessageRecipient

-interface SingleMessageRecipient : MessageRecipients
-

A base class for the case of point-to-point messages

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/-init-.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/-init-.html deleted file mode 100644 index ee4444e975..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -StateMachineManager.FiberRequest.ExpectingResponse.<init> - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / ExpectingResponse / <init>
-
-

<init>

-ExpectingResponse(topic: String, destination: MessageRecipients?, sessionIDForSend: Long, sessionIDForReceive: Long, obj: Any?, responseType: Class<R>)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/index.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/index.html deleted file mode 100644 index dc01f1b677..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/index.html +++ /dev/null @@ -1,71 +0,0 @@ - - -StateMachineManager.FiberRequest.ExpectingResponse - r3prototyping - - - -r3prototyping / 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

- - - - - - - -
-responseType -val responseType: Class<R>
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - -
-destination -val destination: MessageRecipients?
-obj -val obj: Any?
-sessionIDForReceive -val sessionIDForReceive: Long
-sessionIDForSend -val sessionIDForSend: Long
-topic -val topic: String
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/response-type.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/response-type.html deleted file mode 100644 index 8e7aaff506..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-expecting-response/response-type.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.ExpectingResponse.responseType - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / ExpectingResponse / responseType
-
-

responseType

- -val responseType: Class<R>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-init-.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-init-.html deleted file mode 100644 index 72e83461ff..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -StateMachineManager.FiberRequest.<init> - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / <init>
-
-

<init>

-FiberRequest(topic: String, destination: MessageRecipients?, sessionIDForSend: Long, sessionIDForReceive: Long, obj: Any?)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/-init-.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/-init-.html deleted file mode 100644 index 59514c2453..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -StateMachineManager.FiberRequest.NotExpectingResponse.<init> - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / NotExpectingResponse / <init>
-
-

<init>

-NotExpectingResponse(topic: String, destination: MessageRecipients, sessionIDForSend: Long, obj: Any?)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/index.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/index.html deleted file mode 100644 index c952eef612..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/-not-expecting-response/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - -StateMachineManager.FiberRequest.NotExpectingResponse - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / NotExpectingResponse
-
-

NotExpectingResponse

-class NotExpectingResponse : FiberRequest
-
-
-

Constructors

- - - - - - - -
-<init> -NotExpectingResponse(topic: String, destination: MessageRecipients, sessionIDForSend: Long, obj: Any?)
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - -
-destination -val destination: MessageRecipients?
-obj -val obj: Any?
-sessionIDForReceive -val sessionIDForReceive: Long
-sessionIDForSend -val sessionIDForSend: Long
-topic -val topic: String
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/destination.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/destination.html deleted file mode 100644 index 78825d0cf9..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/destination.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.destination - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / destination
-
-

destination

- -val destination: MessageRecipients?
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/index.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/index.html deleted file mode 100644 index 1dc3033a7b..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/index.html +++ /dev/null @@ -1,94 +0,0 @@ - - -StateMachineManager.FiberRequest - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest
-
-

FiberRequest

-class FiberRequest
-
-
-

Types

- - - - - - - - - - - -
-ExpectingResponse -class ExpectingResponse<R : Any> : FiberRequest
-NotExpectingResponse -class NotExpectingResponse : FiberRequest
-

Constructors

- - - - - - - -
-<init> -FiberRequest(topic: String, destination: MessageRecipients?, sessionIDForSend: Long, sessionIDForReceive: Long, obj: Any?)
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - -
-destination -val destination: MessageRecipients?
-obj -val obj: Any?
-sessionIDForReceive -val sessionIDForReceive: Long
-sessionIDForSend -val sessionIDForSend: Long
-topic -val topic: String
-

Inheritors

- - - - - - - - - - - -
-ExpectingResponse -class ExpectingResponse<R : Any> : FiberRequest
-NotExpectingResponse -class NotExpectingResponse : FiberRequest
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/obj.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/obj.html deleted file mode 100644 index d5fadcb355..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/obj.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.obj - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / obj
-
-

obj

- -val obj: Any?
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-receive.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-receive.html deleted file mode 100644 index 708b382191..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.sessionIDForReceive - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / sessionIDForReceive
-
-

sessionIDForReceive

- -val sessionIDForReceive: Long
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-send.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-send.html deleted file mode 100644 index 36c5965a63..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/session-i-d-for-send.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.sessionIDForSend - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / sessionIDForSend
-
-

sessionIDForSend

- -val sessionIDForSend: Long
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/topic.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/topic.html deleted file mode 100644 index 7206168c77..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-fiber-request/topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.FiberRequest.topic - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / FiberRequest / topic
-
-

topic

- -val topic: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-init-.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-init-.html deleted file mode 100644 index 264f542e41..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-init-.html +++ /dev/null @@ -1,33 +0,0 @@ - - -StateMachineManager.<init> - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / <init>
-
-

<init>

-StateMachineManager(serviceHub: ServiceHub, runInThread: Executor)
-

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.

-

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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-same-thread-fiber-scheduler.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-same-thread-fiber-scheduler.html deleted file mode 100644 index c7bc76d89c..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/-same-thread-fiber-scheduler.html +++ /dev/null @@ -1,14 +0,0 @@ - - -StateMachineManager.SameThreadFiberScheduler - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / SameThreadFiberScheduler
-
-

SameThreadFiberScheduler

-object SameThreadFiberScheduler : FiberExecutorScheduler
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/add.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/add.html deleted file mode 100644 index ccdfc63167..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/add.html +++ /dev/null @@ -1,18 +0,0 @@ - - -StateMachineManager.add - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / add
-
-

add

- -fun <T> add(loggerName: String, logic: ProtocolLogic<T>): ListenableFuture<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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/checkpointing.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/checkpointing.html deleted file mode 100644 index 9ddf446bdd..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/checkpointing.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.checkpointing - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / checkpointing
-
-

checkpointing

- -val checkpointing: Boolean
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/find-state-machines.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/find-state-machines.html deleted file mode 100644 index 752b8b060d..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/find-state-machines.html +++ /dev/null @@ -1,16 +0,0 @@ - - -StateMachineManager.findStateMachines - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / findStateMachines
-
-

findStateMachines

- -fun <T> findStateMachines(klass: Class<out ProtocolLogic<T>>): List<Pair<ProtocolLogic<T>, ListenableFuture<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/r3prototyping/core.messaging/-state-machine-manager/index.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/index.html deleted file mode 100644 index 8f8f532be0..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/index.html +++ /dev/null @@ -1,107 +0,0 @@ - - -StateMachineManager - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager
-
-

StateMachineManager

-@ThreadSafe 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.

-

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

- - - - - - - - - - - -
-FiberRequest -class FiberRequest
-SameThreadFiberScheduler -object SameThreadFiberScheduler : FiberExecutorScheduler
-

Constructors

- - - - - - - -
-<init> -StateMachineManager(serviceHub: ServiceHub, runInThread: Executor)

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

- - - - - - - - - - - - - - - -
-checkpointing -val checkpointing: Boolean
-runInThread -val runInThread: Executor
-serviceHub -val serviceHub: ServiceHub
-

Functions

- - - - - - - - - - - -
-add -fun <T> add(loggerName: String, logic: ProtocolLogic<T>): ListenableFuture<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<Pair<ProtocolLogic<T>, ListenableFuture<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/r3prototyping/core.messaging/-state-machine-manager/run-in-thread.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/run-in-thread.html deleted file mode 100644 index 6a82b9d2cd..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/run-in-thread.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.runInThread - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / runInThread
-
-

runInThread

- -val runInThread: Executor
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/service-hub.html b/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/service-hub.html deleted file mode 100644 index 17f9f38cf8..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-state-machine-manager/service-hub.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StateMachineManager.serviceHub - r3prototyping - - - -r3prototyping / core.messaging / StateMachineManager / serviceHub
-
-

serviceHub

- -val serviceHub: ServiceHub
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-topic-string-validator/check.html b/docs/build/html/api/r3prototyping/core.messaging/-topic-string-validator/check.html deleted file mode 100644 index 7a2e6a37bf..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-topic-string-validator/check.html +++ /dev/null @@ -1,18 +0,0 @@ - - -TopicStringValidator.check - r3prototyping - - - -r3prototyping / core.messaging / TopicStringValidator / check
-
-

check

- -fun check(tag: String): <ERROR CLASS>
-

Exceptions

- -IllegalArgumentException - if the given topic contains invalid characters
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/-topic-string-validator/index.html b/docs/build/html/api/r3prototyping/core.messaging/-topic-string-validator/index.html deleted file mode 100644 index afd5877657..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/-topic-string-validator/index.html +++ /dev/null @@ -1,26 +0,0 @@ - - -TopicStringValidator - r3prototyping - - - -r3prototyping / 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/r3prototyping/core.messaging/index.html b/docs/build/html/api/r3prototyping/core.messaging/index.html deleted file mode 100644 index 6bd5c90786..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/index.html +++ /dev/null @@ -1,135 +0,0 @@ - - -core.messaging - r3prototyping - - - -r3prototyping / 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.

-
-LegallyIdentifiableNode -data class LegallyIdentifiableNode

Info about a network node that has is operated by some sort of verified identity.

-
-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.

-
-MockNetworkMap -class MockNetworkMap : NetworkMap
-NetworkMap -interface NetworkMap

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. A reasonable architecture for the -network map service might be one like the Tor directory authorities, where several nodes linked by RAFT or Paxos -elect a leader and that leader distributes signed documents describing the network layout. Those documents can -then be cached by every node and thus a network map can be retrieved given only a single successful peer connection.

-
-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

-
-

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, includeClassName: Boolean = false): Unit
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/run-on-next-message.html b/docs/build/html/api/r3prototyping/core.messaging/run-on-next-message.html deleted file mode 100644 index 69b5885728..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/run-on-next-message.html +++ /dev/null @@ -1,18 +0,0 @@ - - -runOnNextMessage - r3prototyping - - - -r3prototyping / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.messaging/send.html b/docs/build/html/api/r3prototyping/core.messaging/send.html deleted file mode 100644 index 0adb75de37..0000000000 --- a/docs/build/html/api/r3prototyping/core.messaging/send.html +++ /dev/null @@ -1,15 +0,0 @@ - - -send - r3prototyping - - - -r3prototyping / core.messaging / send
-
-

send

- -fun MessagingService.send(topic: String, to: MessageRecipients, obj: Any, includeClassName: Boolean = false): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/-init-.html deleted file mode 100644 index 63b0b4d9cf..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.Handler.<init> - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / Handler / <init>
-
-

<init>

-Handler(executor: Executor?, topic: String, callback: (Message, MessageHandlerRegistration) -> Unit)
-

A registration to handle messages of different types

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/callback.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/callback.html deleted file mode 100644 index 3ab5b0254a..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/callback.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.Handler.callback - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / Handler / callback
-
-

callback

- -val callback: (Message, MessageHandlerRegistration) -> Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/executor.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/executor.html deleted file mode 100644 index 595996decf..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/executor.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.Handler.executor - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / Handler / executor
-
-

executor

- -val executor: Executor?
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/index.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/index.html deleted file mode 100644 index 004eaaf98d..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/index.html +++ /dev/null @@ -1,50 +0,0 @@ - - -ArtemisMessagingService.Handler - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / Handler
-
-

Handler

-inner class Handler : MessageHandlerRegistration
-

A registration to handle messages of different types

-
-
-

Constructors

- - - - - - - -
-<init> -Handler(executor: Executor?, topic: String, callback: (Message, MessageHandlerRegistration) -> Unit)

A registration to handle messages of different types

-
-

Properties

- - - - - - - - - - - - - - - -
-callback -val callback: (Message, MessageHandlerRegistration) -> Unit
-executor -val executor: Executor?
-topic -val topic: String
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/topic.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/topic.html deleted file mode 100644 index c8055a1527..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-handler/topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.Handler.topic - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / Handler / topic
-
-

topic

- -val topic: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-init-.html deleted file mode 100644 index a29e4a7d38..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-init-.html +++ /dev/null @@ -1,23 +0,0 @@ - - -ArtemisMessagingService.<init> - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / <init>
-
-

<init>

-ArtemisMessagingService(directory: Path, myHostPort: HostAndPort)
-

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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-t-o-p-i-c_-p-r-o-p-e-r-t-y.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-t-o-p-i-c_-p-r-o-p-e-r-t-y.html deleted file mode 100644 index 1c52307a0b..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/-t-o-p-i-c_-p-r-o-p-e-r-t-y.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.TOPIC_PROPERTY - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / TOPIC_PROPERTY
-
-

TOPIC_PROPERTY

- -val TOPIC_PROPERTY: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/add-message-handler.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/add-message-handler.html deleted file mode 100644 index 5f96bda235..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/add-message-handler.html +++ /dev/null @@ -1,25 +0,0 @@ - - -ArtemisMessagingService.addMessageHandler - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / addMessageHandler
-
-

addMessageHandler

- -fun addMessageHandler(topic: String, executor: Executor?, callback: (Message, MessageHandlerRegistration) -> Unit): MessageHandlerRegistration
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/create-message.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/create-message.html deleted file mode 100644 index 2c65dfaf9e..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/create-message.html +++ /dev/null @@ -1,17 +0,0 @@ - - -ArtemisMessagingService.createMessage - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / createMessage
-
-

createMessage

- -fun createMessage(topic: String, data: ByteArray): Message
-Overrides MessagingService.createMessage
-

Returns an initialised Message with the current time, etc, already filled in.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/directory.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/directory.html deleted file mode 100644 index 3a3ab425f6..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/directory.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.directory - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / directory
-
-

directory

- -val directory: Path
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/index.html deleted file mode 100644 index 2c9a155a51..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/index.html +++ /dev/null @@ -1,179 +0,0 @@ - - -ArtemisMessagingService - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService
-
-

ArtemisMessagingService

-@ThreadSafe 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.

-
-
-
-
-

Types

- - - - - - - -
-Handler -inner class Handler : MessageHandlerRegistration

A registration to handle messages of different types

-
-

Constructors

- - - - - - - -
-<init> -ArtemisMessagingService(directory: Path, myHostPort: HostAndPort)

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

- - - - - - - - - - - - - - - -
-directory -val directory: Path
-myAddress -val myAddress: SingleMessageRecipient

Returns an address that refers to this node.

-
-myHostPort -val myHostPort: HostAndPort
-

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: Logger
-

Companion Object Functions

- - - - - - - - - - - -
-makeRecipient -fun makeRecipient(hostAndPort: HostAndPort): SingleMessageRecipient

Temp helper until network map is established.

-fun makeRecipient(hostname: String): SingleMessageRecipient
-toHostAndPort -fun toHostAndPort(hostname: String): HostAndPort
-

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, includeClassName: Boolean = false): Unit
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/log.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/log.html deleted file mode 100644 index b05d03a08c..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/log.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.log - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / log
-
-

log

- -val log: Logger
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/make-recipient.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/make-recipient.html deleted file mode 100644 index ff81b22135..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/make-recipient.html +++ /dev/null @@ -1,20 +0,0 @@ - - -ArtemisMessagingService.makeRecipient - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / makeRecipient
-
-

makeRecipient

- -fun makeRecipient(hostAndPort: HostAndPort): SingleMessageRecipient
-

Temp helper until network map is established.

-
-
- -fun makeRecipient(hostname: String): SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/my-address.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/my-address.html deleted file mode 100644 index f981827894..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/my-address.html +++ /dev/null @@ -1,17 +0,0 @@ - - -ArtemisMessagingService.myAddress - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / myAddress
-
-

myAddress

- -val myAddress: SingleMessageRecipient
-Overrides MessagingService.myAddress
-

Returns an address that refers to this node.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/my-host-port.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/my-host-port.html deleted file mode 100644 index 02e769a04f..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/my-host-port.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.myHostPort - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / myHostPort
-
-

myHostPort

- -val myHostPort: HostAndPort
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/remove-message-handler.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/remove-message-handler.html deleted file mode 100644 index 2289ce8493..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/remove-message-handler.html +++ /dev/null @@ -1,24 +0,0 @@ - - -ArtemisMessagingService.removeMessageHandler - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / removeMessageHandler
-
-

removeMessageHandler

- -fun removeMessageHandler(registration: MessageHandlerRegistration): Unit
-Overrides 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.
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/send.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/send.html deleted file mode 100644 index 9982962b97..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/send.html +++ /dev/null @@ -1,24 +0,0 @@ - - -ArtemisMessagingService.send - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / send
-
-

send

- -fun send(message: Message, target: MessageRecipients): Unit
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/start.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/start.html deleted file mode 100644 index ca0d5dbdf8..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/start.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.start - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / start
-
-

start

- -fun start(): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/stop.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/stop.html deleted file mode 100644 index 9c1001c053..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/stop.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ArtemisMessagingService.stop - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / stop
-
-

stop

- -fun stop(): Unit
-Overrides MessagingService.stop
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/to-host-and-port.html b/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/to-host-and-port.html deleted file mode 100644 index aef0785b7a..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-artemis-messaging-service/to-host-and-port.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ArtemisMessagingService.toHostAndPort - r3prototyping - - - -r3prototyping / core.node.services / ArtemisMessagingService / toHostAndPort
-
-

toHostAndPort

- -fun toHostAndPort(hostname: String): HostAndPort
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-attachment-storage/import-attachment.html b/docs/build/html/api/r3prototyping/core.node.services/-attachment-storage/import-attachment.html deleted file mode 100644 index fb68cdf829..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-attachment-storage/import-attachment.html +++ /dev/null @@ -1,30 +0,0 @@ - - -AttachmentStorage.importAttachment - r3prototyping - - - -r3prototyping / 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.
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-attachment-storage/index.html b/docs/build/html/api/r3prototyping/core.node.services/-attachment-storage/index.html deleted file mode 100644 index 539480d775..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-attachment-storage/index.html +++ /dev/null @@ -1,51 +0,0 @@ - - -AttachmentStorage - r3prototyping - - - -r3prototyping / 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

Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.

-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-attachment-storage/open-attachment.html b/docs/build/html/api/r3prototyping/core.node.services/-attachment-storage/open-attachment.html deleted file mode 100644 index 9ba6280b5b..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-attachment-storage/open-attachment.html +++ /dev/null @@ -1,19 +0,0 @@ - - -AttachmentStorage.openAttachment - r3prototyping - - - -r3prototyping / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-init-.html deleted file mode 100644 index 435863c85f..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-init-.html +++ /dev/null @@ -1,24 +0,0 @@ - - -DataVendingService.<init> - r3prototyping - - - -r3prototyping / core.node.services / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/-init-.html deleted file mode 100644 index d9b988d5dc..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -DataVendingService.Request.<init> - r3prototyping - - - -r3prototyping / core.node.services / DataVendingService / Request / <init>
-
-

<init>

-Request(hashes: List<SecureHash>, responseTo: SingleMessageRecipient, sessionID: Long)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/hashes.html b/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/hashes.html deleted file mode 100644 index eba3a0c7b5..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/hashes.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DataVendingService.Request.hashes - r3prototyping - - - -r3prototyping / core.node.services / DataVendingService / Request / hashes
-
-

hashes

- -val hashes: List<SecureHash>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/index.html b/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/index.html deleted file mode 100644 index aab989a676..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/index.html +++ /dev/null @@ -1,48 +0,0 @@ - - -DataVendingService.Request - r3prototyping - - - -r3prototyping / core.node.services / DataVendingService / Request
-
-

Request

-data class Request
-
-
-

Constructors

- - - - - - - -
-<init> -Request(hashes: List<SecureHash>, responseTo: SingleMessageRecipient, sessionID: Long)
-

Properties

- - - - - - - - - - - - - - - -
-hashes -val hashes: List<SecureHash>
-responseTo -val responseTo: SingleMessageRecipient
-sessionID -val sessionID: Long
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/response-to.html b/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/response-to.html deleted file mode 100644 index ed5605ea3f..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/response-to.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DataVendingService.Request.responseTo - r3prototyping - - - -r3prototyping / core.node.services / DataVendingService / Request / responseTo
-
-

responseTo

- -val responseTo: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/session-i-d.html b/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/session-i-d.html deleted file mode 100644 index 0efd1af9a3..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/-request/session-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DataVendingService.Request.sessionID - r3prototyping - - - -r3prototyping / core.node.services / DataVendingService / Request / sessionID
-
-

sessionID

- -val sessionID: Long
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/index.html deleted file mode 100644 index 0bc83be776..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/index.html +++ /dev/null @@ -1,59 +0,0 @@ - - -DataVendingService - r3prototyping - - - -r3prototyping / core.node.services / DataVendingService
-
-

DataVendingService

-@ThreadSafe class 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.

-

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

- - - - - - - -
-Request -data class Request
-

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.

-
-

Companion Object Properties

- - - - - - - -
-logger -val logger: Logger
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/logger.html b/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/logger.html deleted file mode 100644 index b730bb11a0..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-data-vending-service/logger.html +++ /dev/null @@ -1,15 +0,0 @@ - - -DataVendingService.logger - r3prototyping - - - -r3prototyping / core.node.services / DataVendingService / logger
-
-

logger

- -val logger: Logger
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/-init-.html deleted file mode 100644 index b5ed036147..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/-init-.html +++ /dev/null @@ -1,23 +0,0 @@ - - -E2ETestKeyManagementService.<init> - r3prototyping - - - -r3prototyping / core.node.services / 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

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/fresh-key.html b/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/fresh-key.html deleted file mode 100644 index 9478d22aba..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/fresh-key.html +++ /dev/null @@ -1,17 +0,0 @@ - - -E2ETestKeyManagementService.freshKey - r3prototyping - - - -r3prototyping / core.node.services / E2ETestKeyManagementService / freshKey
-
-

freshKey

- -fun freshKey(): KeyPair
-Overrides KeyManagementService.freshKey
-

Generates a new random key and adds it to the exposed map.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/index.html deleted file mode 100644 index f329796adc..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/index.html +++ /dev/null @@ -1,70 +0,0 @@ - - -E2ETestKeyManagementService - r3prototyping - - - -r3prototyping / core.node.services / E2ETestKeyManagementService
-
-

E2ETestKeyManagementService

-@ThreadSafe 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

- - - - - - - -
-toPrivate -open fun toPrivate(publicKey: PublicKey): PrivateKey
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/keys.html b/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/keys.html deleted file mode 100644 index 03ee4e0487..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-e2-e-test-key-management-service/keys.html +++ /dev/null @@ -1,20 +0,0 @@ - - -E2ETestKeyManagementService.keys - r3prototyping - - - -r3prototyping / core.node.services / E2ETestKeyManagementService / keys
-
-

keys

- -val keys: Map<PublicKey, PrivateKey>
-Overrides KeyManagementService.keys
-

Returns a snapshot of the current pubkey->privkey mapping.

-Getter
-

Returns a snapshot of the current pubkey->privkey mapping.

-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-fixed-identity-service/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-fixed-identity-service/-init-.html deleted file mode 100644 index 94781908ee..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-fixed-identity-service/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FixedIdentityService.<init> - r3prototyping - - - -r3prototyping / core.node.services / FixedIdentityService / <init>
-
-

<init>

-FixedIdentityService(identities: List<Party>)
-

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-fixed-identity-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-fixed-identity-service/index.html deleted file mode 100644 index 63374776a1..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-fixed-identity-service/index.html +++ /dev/null @@ -1,38 +0,0 @@ - - -FixedIdentityService - r3prototyping - - - -r3prototyping / core.node.services / FixedIdentityService
-
-

FixedIdentityService

-class FixedIdentityService : IdentityService
-

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-
-

Constructors

- - - - - - - -
-<init> -FixedIdentityService(identities: List<Party>)

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-

Functions

- - - - - - - -
-partyFromKey -fun partyFromKey(key: PublicKey): Party?
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-fixed-identity-service/party-from-key.html b/docs/build/html/api/r3prototyping/core.node.services/-fixed-identity-service/party-from-key.html deleted file mode 100644 index 92dc01b733..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-fixed-identity-service/party-from-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FixedIdentityService.partyFromKey - r3prototyping - - - -r3prototyping / core.node.services / FixedIdentityService / partyFromKey
-
-

partyFromKey

- -fun partyFromKey(key: PublicKey): Party?
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/fresh-key.html b/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/fresh-key.html deleted file mode 100644 index 652636c4a6..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/fresh-key.html +++ /dev/null @@ -1,16 +0,0 @@ - - -KeyManagementService.freshKey - r3prototyping - - - -r3prototyping / core.node.services / KeyManagementService / freshKey
-
-

freshKey

- -abstract fun freshKey(): KeyPair
-

Generates a new random key and adds it to the exposed map.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/index.html deleted file mode 100644 index 6e87398a9a..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/index.html +++ /dev/null @@ -1,62 +0,0 @@ - - -KeyManagementService - r3prototyping - - - -r3prototyping / core.node.services / 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

- - - - - - - - - - - -
-freshKey -abstract fun freshKey(): KeyPair

Generates a new random key and adds it to the exposed map.

-
-toPrivate -open fun toPrivate(publicKey: PublicKey): PrivateKey
-

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/r3prototyping/core.node.services/-key-management-service/keys.html b/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/keys.html deleted file mode 100644 index f8409a1440..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/keys.html +++ /dev/null @@ -1,16 +0,0 @@ - - -KeyManagementService.keys - r3prototyping - - - -r3prototyping / core.node.services / KeyManagementService / keys
-
-

keys

- -abstract val keys: Map<PublicKey, PrivateKey>
-

Returns a snapshot of the current pubkey->privkey mapping.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/to-private.html b/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/to-private.html deleted file mode 100644 index 2d5fe06869..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-key-management-service/to-private.html +++ /dev/null @@ -1,15 +0,0 @@ - - -KeyManagementService.toPrivate - r3prototyping - - - -r3prototyping / core.node.services / KeyManagementService / toPrivate
-
-

toPrivate

- -open fun toPrivate(publicKey: PublicKey): PrivateKey
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-init-.html deleted file mode 100644 index b2d55485a4..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.<init> - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / <init>
-
-

<init>

-NodeAttachmentService(storePath: Path)
-

Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/-init-.html deleted file mode 100644 index 1b0b17e584..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch.<init> - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / OnDiskHashMismatch / <init>
-
-

<init>

-OnDiskHashMismatch(file: Path, actual: SecureHash)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/actual.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/actual.html deleted file mode 100644 index 68ef593cf4..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/actual.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch.actual - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / OnDiskHashMismatch / actual
-
-

actual

- -val actual: SecureHash
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/file.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/file.html deleted file mode 100644 index d0bd0c6f06..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/file.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch.file - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / OnDiskHashMismatch / file
-
-

file

- -val file: Path
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/index.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/index.html deleted file mode 100644 index ee808eb3e2..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/index.html +++ /dev/null @@ -1,53 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / OnDiskHashMismatch
-
-

OnDiskHashMismatch

-class OnDiskHashMismatch : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -OnDiskHashMismatch(file: Path, actual: SecureHash)
-

Properties

- - - - - - - - - - - -
-actual -val actual: SecureHash
-file -val file: Path
-

Functions

- - - - - - - -
-toString -fun toString(): String
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/to-string.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/to-string.html deleted file mode 100644 index 04ededa7b7..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/-on-disk-hash-mismatch/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.OnDiskHashMismatch.toString - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / OnDiskHashMismatch / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/automatically-extract-attachments.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/automatically-extract-attachments.html deleted file mode 100644 index 804efea6e5..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/automatically-extract-attachments.html +++ /dev/null @@ -1,18 +0,0 @@ - - -NodeAttachmentService.automaticallyExtractAttachments - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / automaticallyExtractAttachments
-
-

automaticallyExtractAttachments

- -@Volatile 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).

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/check-attachments-on-load.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/check-attachments-on-load.html deleted file mode 100644 index 1a71fc6735..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/check-attachments-on-load.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.checkAttachmentsOnLoad - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / checkAttachmentsOnLoad
-
-

checkAttachmentsOnLoad

- -var checkAttachmentsOnLoad: Boolean
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/import-attachment.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/import-attachment.html deleted file mode 100644 index 1bd1c68570..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/import-attachment.html +++ /dev/null @@ -1,31 +0,0 @@ - - -NodeAttachmentService.importAttachment - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / importAttachment
-
-

importAttachment

- -fun importAttachment(jar: InputStream): SecureHash
-Overrides 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.
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/index.html deleted file mode 100644 index b8f1011257..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/index.html +++ /dev/null @@ -1,87 +0,0 @@ - - -NodeAttachmentService - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService
-
-

NodeAttachmentService

-@ThreadSafe class NodeAttachmentService : AttachmentStorage
-

Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.

-
-
-

Exceptions

- - - - - - - -
-OnDiskHashMismatch -class OnDiskHashMismatch : Exception
-

Constructors

- - - - - - - -
-<init> -NodeAttachmentService(storePath: Path)

Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.

-
-

Properties

- - - - - - - - - - - - - - - -
-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
-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.

-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/open-attachment.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/open-attachment.html deleted file mode 100644 index ca8003e684..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/open-attachment.html +++ /dev/null @@ -1,20 +0,0 @@ - - -NodeAttachmentService.openAttachment - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / openAttachment
-
-

openAttachment

- -fun openAttachment(id: SecureHash): Attachment?
-Overrides 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/store-path.html b/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/store-path.html deleted file mode 100644 index 4a4160611f..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-attachment-service/store-path.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeAttachmentService.storePath - r3prototyping - - - -r3prototyping / core.node.services / NodeAttachmentService / storePath
-
-

storePath

- -val storePath: Path
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/-init-.html deleted file mode 100644 index 5daaeafcd0..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/-init-.html +++ /dev/null @@ -1,19 +0,0 @@ - - -NodeTimestamperService.<init> - r3prototyping - - - -r3prototyping / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/-t-i-m-e-s-t-a-m-p-i-n-g_-p-r-o-t-o-c-o-l_-t-o-p-i-c.html b/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/-t-i-m-e-s-t-a-m-p-i-n-g_-p-r-o-t-o-c-o-l_-t-o-p-i-c.html deleted file mode 100644 index 53b2a50988..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/-t-i-m-e-s-t-a-m-p-i-n-g_-p-r-o-t-o-c-o-l_-t-o-p-i-c.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.TIMESTAMPING_PROTOCOL_TOPIC - r3prototyping - - - -r3prototyping / core.node.services / NodeTimestamperService / TIMESTAMPING_PROTOCOL_TOPIC
-
-

TIMESTAMPING_PROTOCOL_TOPIC

- -val TIMESTAMPING_PROTOCOL_TOPIC: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/clock.html b/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/clock.html deleted file mode 100644 index 3e80270869..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/clock.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.clock - r3prototyping - - - -r3prototyping / core.node.services / NodeTimestamperService / clock
-
-

clock

- -val clock: Clock
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/identity.html b/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/identity.html deleted file mode 100644 index 7a1e1ccf74..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/identity.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.identity - r3prototyping - - - -r3prototyping / core.node.services / NodeTimestamperService / identity
-
-

identity

- -val identity: Party
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/index.html deleted file mode 100644 index 298fe0f58a..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/index.html +++ /dev/null @@ -1,83 +0,0 @@ - - -NodeTimestamperService - r3prototyping - - - -r3prototyping / core.node.services / NodeTimestamperService
-
-

NodeTimestamperService

-@ThreadSafe class 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.

-

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

- - - - - - - - - - - - - - - - - - - -
-clock -val clock: Clock
-identity -val identity: Party
-signingKey -val signingKey: KeyPair
-tolerance -val tolerance: Duration
-

Functions

- - - - - - - -
-processRequest -fun processRequest(req: Request): LegallyIdentifiable
-

Companion Object Properties

- - - - - - - -
-TIMESTAMPING_PROTOCOL_TOPIC -val TIMESTAMPING_PROTOCOL_TOPIC: String
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/process-request.html b/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/process-request.html deleted file mode 100644 index cf0d752886..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/process-request.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.processRequest - r3prototyping - - - -r3prototyping / core.node.services / NodeTimestamperService / processRequest
-
-

processRequest

- -@VisibleForTesting fun processRequest(req: Request): LegallyIdentifiable
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/signing-key.html b/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/signing-key.html deleted file mode 100644 index eccff1ed18..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/signing-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.signingKey - r3prototyping - - - -r3prototyping / core.node.services / NodeTimestamperService / signingKey
-
-

signingKey

- -val signingKey: KeyPair
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/tolerance.html b/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/tolerance.html deleted file mode 100644 index 4d5374f3f4..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-timestamper-service/tolerance.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeTimestamperService.tolerance - r3prototyping - - - -r3prototyping / core.node.services / NodeTimestamperService / tolerance
-
-

tolerance

- -val tolerance: Duration
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/-init-.html deleted file mode 100644 index 287b9ad7d8..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/-init-.html +++ /dev/null @@ -1,17 +0,0 @@ - - -NodeWalletService.<init> - r3prototyping - - - -r3prototyping / core.node.services / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/cash-balances.html b/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/cash-balances.html deleted file mode 100644 index f4266c47b1..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/cash-balances.html +++ /dev/null @@ -1,22 +0,0 @@ - - -NodeWalletService.cashBalances - r3prototyping - - - -r3prototyping / core.node.services / NodeWalletService / cashBalances
-
-

cashBalances

- -val cashBalances: Map<Currency, Amount>
-Overrides 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.

-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/current-wallet.html b/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/current-wallet.html deleted file mode 100644 index 29690d4e44..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/current-wallet.html +++ /dev/null @@ -1,22 +0,0 @@ - - -NodeWalletService.currentWallet - r3prototyping - - - -r3prototyping / core.node.services / NodeWalletService / currentWallet
-
-

currentWallet

- -val currentWallet: Wallet
-Overrides 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.

-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/fill-with-some-test-cash.html b/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/fill-with-some-test-cash.html deleted file mode 100644 index bb0b9ab459..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/fill-with-some-test-cash.html +++ /dev/null @@ -1,23 +0,0 @@ - - -NodeWalletService.fillWithSomeTestCash - r3prototyping - - - -r3prototyping / core.node.services / NodeWalletService / fillWithSomeTestCash
-
-

fillWithSomeTestCash

- -fun fillWithSomeTestCash(howMuch: Amount, atLeastThisManyStates: Int = 3, atMostThisManyStates: Int = 10, rng: Random = Random()): Wallet
-

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

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/index.html deleted file mode 100644 index d097089b83..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/index.html +++ /dev/null @@ -1,85 +0,0 @@ - - -NodeWalletService - r3prototyping - - - -r3prototyping / core.node.services / NodeWalletService
-
-

NodeWalletService

-@ThreadSafe 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.

-
-

Functions

- - - - - - - - - - - -
-fillWithSomeTestCash -fun fillWithSomeTestCash(howMuch: Amount, atLeastThisManyStates: Int = 3, atMostThisManyStates: Int = 10, rng: Random = Random()): Wallet

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

- - - - - - - -
-notify -open fun notify(tx: WireTransaction): Wallet

Same as notifyAll but with a single transaction.

-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/notify-all.html b/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/notify-all.html deleted file mode 100644 index 7bf762c288..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-node-wallet-service/notify-all.html +++ /dev/null @@ -1,22 +0,0 @@ - - -NodeWalletService.notifyAll - r3prototyping - - - -r3prototyping / core.node.services / NodeWalletService / notifyAll
-
-

notifyAll

- -fun notifyAll(txns: Iterable<WireTransaction>): Wallet
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/identity-service.html b/docs/build/html/api/r3prototyping/core.node.services/-service-hub/identity-service.html deleted file mode 100644 index 9ac48dbc2c..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/identity-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.identityService - r3prototyping - - - -r3prototyping / core.node.services / ServiceHub / identityService
-
-

identityService

- -abstract val identityService: IdentityService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/index.html b/docs/build/html/api/r3prototyping/core.node.services/-service-hub/index.html deleted file mode 100644 index 1e0faeba33..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/index.html +++ /dev/null @@ -1,72 +0,0 @@ - - -ServiceHub - r3prototyping - - - -r3prototyping / core.node.services / 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

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-identityService -abstract val identityService: IdentityService
-keyManagementService -abstract val keyManagementService: KeyManagementService
-networkMapService -abstract val networkMapService: NetworkMap
-networkService -abstract val networkService: MessagingService
-storageService -abstract val storageService: StorageService
-walletService -abstract val walletService: WalletService
-

Functions

- - - - - - - -
-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 SignedTransactions the DB gives back into LedgerTransactions, and then runs the smart contracts for the -transaction. If no exception is thrown, the transaction is valid.

-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/key-management-service.html b/docs/build/html/api/r3prototyping/core.node.services/-service-hub/key-management-service.html deleted file mode 100644 index 90b60d2493..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/key-management-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.keyManagementService - r3prototyping - - - -r3prototyping / core.node.services / ServiceHub / keyManagementService
-
-

keyManagementService

- -abstract val keyManagementService: KeyManagementService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/network-map-service.html b/docs/build/html/api/r3prototyping/core.node.services/-service-hub/network-map-service.html deleted file mode 100644 index 870512c90e..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/network-map-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.networkMapService - r3prototyping - - - -r3prototyping / core.node.services / ServiceHub / networkMapService
-
-

networkMapService

- -abstract val networkMapService: NetworkMap
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/network-service.html b/docs/build/html/api/r3prototyping/core.node.services/-service-hub/network-service.html deleted file mode 100644 index b897009ea3..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/network-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.networkService - r3prototyping - - - -r3prototyping / core.node.services / ServiceHub / networkService
-
-

networkService

- -abstract val networkService: MessagingService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/storage-service.html b/docs/build/html/api/r3prototyping/core.node.services/-service-hub/storage-service.html deleted file mode 100644 index fa0be2b132..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/storage-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.storageService - r3prototyping - - - -r3prototyping / core.node.services / ServiceHub / storageService
-
-

storageService

- -abstract val storageService: StorageService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/verify-transaction.html b/docs/build/html/api/r3prototyping/core.node.services/-service-hub/verify-transaction.html deleted file mode 100644 index 5df7956325..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/verify-transaction.html +++ /dev/null @@ -1,18 +0,0 @@ - - -ServiceHub.verifyTransaction - r3prototyping - - - -r3prototyping / core.node.services / 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 SignedTransactions the DB gives back into LedgerTransactions, and then runs the smart contracts for the -transaction. If no exception is thrown, the transaction is valid.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/wallet-service.html b/docs/build/html/api/r3prototyping/core.node.services/-service-hub/wallet-service.html deleted file mode 100644 index 8231e5b33f..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-service-hub/wallet-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ServiceHub.walletService - r3prototyping - - - -r3prototyping / core.node.services / ServiceHub / walletService
-
-

walletService

- -abstract val walletService: WalletService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/attachments.html b/docs/build/html/api/r3prototyping/core.node.services/-storage-service/attachments.html deleted file mode 100644 index 1865e0fee9..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/attachments.html +++ /dev/null @@ -1,16 +0,0 @@ - - -StorageService.attachments - r3prototyping - - - -r3prototyping / core.node.services / StorageService / attachments
-
-

attachments

- -abstract val attachments: AttachmentStorage
-

Provides access to storage of arbitrary JAR files (which may contain only data, no code).

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/contract-programs.html b/docs/build/html/api/r3prototyping/core.node.services/-storage-service/contract-programs.html deleted file mode 100644 index 49ac3170c6..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/contract-programs.html +++ /dev/null @@ -1,16 +0,0 @@ - - -StorageService.contractPrograms - r3prototyping - - - -r3prototyping / core.node.services / StorageService / contractPrograms
-
-

contractPrograms

- -abstract val contractPrograms: ContractFactory
-

A map of program hash->contract class type, used for verification.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/get-map.html b/docs/build/html/api/r3prototyping/core.node.services/-storage-service/get-map.html deleted file mode 100644 index 456ff61735..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/get-map.html +++ /dev/null @@ -1,16 +0,0 @@ - - -StorageService.getMap - r3prototyping - - - -r3prototyping / core.node.services / StorageService / getMap
-
-

getMap

- -abstract fun <K, V> getMap(tableName: String): MutableMap<K, V>
-

TODO: Temp scaffolding that will go away eventually.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-storage-service/index.html deleted file mode 100644 index dacbfb6035..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/index.html +++ /dev/null @@ -1,82 +0,0 @@ - - -StorageService - r3prototyping - - - -r3prototyping / core.node.services / 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).

-
-contractPrograms -abstract val contractPrograms: ContractFactory

A map of program hash->contract class type, used for verification.

-
-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
-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.

-
-

Functions

- - - - - - - -
-getMap -abstract fun <K, V> getMap(tableName: String): MutableMap<K, V>

TODO: Temp scaffolding that will go away eventually.

-
-

Inheritors

- - - - - - - -
-StorageServiceImpl -open inner class StorageServiceImpl : StorageService
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/my-legal-identity-key.html b/docs/build/html/api/r3prototyping/core.node.services/-storage-service/my-legal-identity-key.html deleted file mode 100644 index 966be78655..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/my-legal-identity-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -StorageService.myLegalIdentityKey - r3prototyping - - - -r3prototyping / core.node.services / StorageService / myLegalIdentityKey
-
-

myLegalIdentityKey

- -abstract val myLegalIdentityKey: KeyPair
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/my-legal-identity.html b/docs/build/html/api/r3prototyping/core.node.services/-storage-service/my-legal-identity.html deleted file mode 100644 index 4990a49975..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/my-legal-identity.html +++ /dev/null @@ -1,17 +0,0 @@ - - -StorageService.myLegalIdentity - r3prototyping - - - -r3prototyping / core.node.services / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/validated-transactions.html b/docs/build/html/api/r3prototyping/core.node.services/-storage-service/validated-transactions.html deleted file mode 100644 index abae125bf7..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-storage-service/validated-transactions.html +++ /dev/null @@ -1,18 +0,0 @@ - - -StorageService.validatedTransactions - r3prototyping - - - -r3prototyping / core.node.services / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/cash-balances.html b/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/cash-balances.html deleted file mode 100644 index ae7f1680d4..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/cash-balances.html +++ /dev/null @@ -1,17 +0,0 @@ - - -WalletService.cashBalances - r3prototyping - - - -r3prototyping / core.node.services / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/current-wallet.html b/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/current-wallet.html deleted file mode 100644 index 7aa470bb9c..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/current-wallet.html +++ /dev/null @@ -1,17 +0,0 @@ - - -WalletService.currentWallet - r3prototyping - - - -r3prototyping / core.node.services / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/index.html b/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/index.html deleted file mode 100644 index 334b773488..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/index.html +++ /dev/null @@ -1,73 +0,0 @@ - - -WalletService - r3prototyping - - - -r3prototyping / core.node.services / 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.

-
-

Functions

- - - - - - - - - - - -
-notify -open fun notify(tx: WireTransaction): Wallet

Same as notifyAll but with a single transaction.

-
-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

-
-

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/r3prototyping/core.node.services/-wallet-service/notify-all.html b/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/notify-all.html deleted file mode 100644 index d5288ede1d..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/notify-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - -WalletService.notifyAll - r3prototyping - - - -r3prototyping / core.node.services / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/notify.html b/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/notify.html deleted file mode 100644 index e5146be674..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-wallet-service/notify.html +++ /dev/null @@ -1,16 +0,0 @@ - - -WalletService.notify - r3prototyping - - - -r3prototyping / core.node.services / WalletService / notify
-
-

notify

- -open fun notify(tx: WireTransaction): Wallet
-

Same as notifyAll but with a single transaction.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-wallet/-init-.html b/docs/build/html/api/r3prototyping/core.node.services/-wallet/-init-.html deleted file mode 100644 index f598ba14e6..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-wallet/-init-.html +++ /dev/null @@ -1,18 +0,0 @@ - - -Wallet.<init> - r3prototyping - - - -r3prototyping / core.node.services / Wallet / <init>
-
-

<init>

-Wallet(states: List<StateAndRef<OwnableState>>)
-

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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-wallet/index.html b/docs/build/html/api/r3prototyping/core.node.services/-wallet/index.html deleted file mode 100644 index bcfb5bae71..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-wallet/index.html +++ /dev/null @@ -1,55 +0,0 @@ - - -Wallet - r3prototyping - - - -r3prototyping / core.node.services / 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<OwnableState>>)

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

- - - - - - - -
-states -val states: List<StateAndRef<OwnableState>>
-

Functions

- - - - - - - -
-statesOfType -fun <T : OwnableState> statesOfType(): List<StateAndRef<T>>
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-wallet/states-of-type.html b/docs/build/html/api/r3prototyping/core.node.services/-wallet/states-of-type.html deleted file mode 100644 index a4de9e3a79..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-wallet/states-of-type.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Wallet.statesOfType - r3prototyping - - - -r3prototyping / core.node.services / Wallet / statesOfType
-
-

statesOfType

- -inline fun <reified T : OwnableState> statesOfType(): List<StateAndRef<T>>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/-wallet/states.html b/docs/build/html/api/r3prototyping/core.node.services/-wallet/states.html deleted file mode 100644 index a8d8f44928..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/-wallet/states.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Wallet.states - r3prototyping - - - -r3prototyping / core.node.services / Wallet / states
-
-

states

- -val states: List<StateAndRef<OwnableState>>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.services/index.html b/docs/build/html/api/r3prototyping/core.node.services/index.html deleted file mode 100644 index 01dfd6c676..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.services/index.html +++ /dev/null @@ -1,126 +0,0 @@ - - -core.node.services - r3prototyping - - - -r3prototyping / core.node.services
-
-

Package core.node.services

-

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.

-
-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

-
-DataVendingService -class 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.

-
-E2ETestKeyManagementService -class E2ETestKeyManagementService : KeyManagementService

A simple in-memory KMS that doesnt bother saving keys to disk. A real implementation would:

-
-FixedIdentityService -class FixedIdentityService : IdentityService

Scaffolding: a dummy identity service that just expects to have identities loaded off disk or found elsewhere.

-
-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.

-
-NodeAttachmentService -class NodeAttachmentService : AttachmentStorage

Stores attachments in the specified local directory, which must exist. Doesnt allow new attachments to be uploaded.

-
-NodeTimestamperService -class 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.

-
-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.

-
-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.

-
-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.

-
-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

-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-download-servlet/-init-.html b/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-download-servlet/-init-.html deleted file mode 100644 index 082491932d..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-download-servlet/-init-.html +++ /dev/null @@ -1,22 +0,0 @@ - - -AttachmentDownloadServlet.<init> - r3prototyping - - - -r3prototyping / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-download-servlet/do-get.html b/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-download-servlet/do-get.html deleted file mode 100644 index 60c0d9f2c5..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-download-servlet/do-get.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AttachmentDownloadServlet.doGet - r3prototyping - - - -r3prototyping / core.node.servlets / AttachmentDownloadServlet / doGet
-
-

doGet

- -protected fun doGet(req: HttpServletRequest, resp: HttpServletResponse): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-download-servlet/index.html b/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-download-servlet/index.html deleted file mode 100644 index de61db2385..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-download-servlet/index.html +++ /dev/null @@ -1,45 +0,0 @@ - - -AttachmentDownloadServlet - r3prototyping - - - -r3prototyping / core.node.servlets / AttachmentDownloadServlet
-
-

AttachmentDownloadServlet

-class AttachmentDownloadServlet : HttpServlet
-

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: HttpServletRequest, resp: HttpServletResponse): Unit
- - diff --git a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-upload-servlet/-init-.html b/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-upload-servlet/-init-.html deleted file mode 100644 index 9e77398bb4..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-upload-servlet/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -AttachmentUploadServlet.<init> - r3prototyping - - - -r3prototyping / core.node.servlets / AttachmentUploadServlet / <init>
-
-

<init>

-AttachmentUploadServlet()
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-upload-servlet/do-post.html b/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-upload-servlet/do-post.html deleted file mode 100644 index 0db9cb9af6..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-upload-servlet/do-post.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AttachmentUploadServlet.doPost - r3prototyping - - - -r3prototyping / core.node.servlets / AttachmentUploadServlet / doPost
-
-

doPost

- -protected fun doPost(req: HttpServletRequest, resp: HttpServletResponse): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-upload-servlet/index.html b/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-upload-servlet/index.html deleted file mode 100644 index 14530896a0..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.servlets/-attachment-upload-servlet/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -AttachmentUploadServlet - r3prototyping - - - -r3prototyping / core.node.servlets / AttachmentUploadServlet
-
-

AttachmentUploadServlet

-class AttachmentUploadServlet : HttpServlet
-
-
-

Constructors

- - - - - - - -
-<init> -AttachmentUploadServlet()
-

Functions

- - - - - - - -
-doPost -fun doPost(req: HttpServletRequest, resp: HttpServletResponse): Unit
- - diff --git a/docs/build/html/api/r3prototyping/core.node.servlets/index.html b/docs/build/html/api/r3prototyping/core.node.servlets/index.html deleted file mode 100644 index 6ee96c78ce..0000000000 --- a/docs/build/html/api/r3prototyping/core.node.servlets/index.html +++ /dev/null @@ -1,29 +0,0 @@ - - -core.node.servlets - r3prototyping - - - -r3prototyping / core.node.servlets
-
-

Package core.node.servlets

-

Types

- - - - - - - - - - - -
-AttachmentDownloadServlet -class AttachmentDownloadServlet : HttpServlet

Allows the node administrator to either download full attachment zips, or individual files within those zips.

-
-AttachmentUploadServlet -class AttachmentUploadServlet : HttpServlet
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-init-.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-init-.html deleted file mode 100644 index c19a6f77e8..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -AbstractNode.<init> - r3prototyping - - - -r3prototyping / core.node / AbstractNode / <init>
-
-

<init>

-AbstractNode(dir: Path, configuration: NodeConfiguration, timestamperAddress: LegallyIdentifiableNode?)
-

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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-p-r-i-v-a-t-e_-k-e-y_-f-i-l-e_-n-a-m-e.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-p-r-i-v-a-t-e_-k-e-y_-f-i-l-e_-n-a-m-e.html deleted file mode 100644 index 212b12ccb8..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-p-r-i-v-a-t-e_-k-e-y_-f-i-l-e_-n-a-m-e.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.PRIVATE_KEY_FILE_NAME - r3prototyping - - - -r3prototyping / core.node / AbstractNode / PRIVATE_KEY_FILE_NAME
-
-

PRIVATE_KEY_FILE_NAME

- -val PRIVATE_KEY_FILE_NAME: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-p-u-b-l-i-c_-i-d-e-n-t-i-t-y_-f-i-l-e_-n-a-m-e.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-p-u-b-l-i-c_-i-d-e-n-t-i-t-y_-f-i-l-e_-n-a-m-e.html deleted file mode 100644 index 62acd3ab5e..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-p-u-b-l-i-c_-i-d-e-n-t-i-t-y_-f-i-l-e_-n-a-m-e.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.PUBLIC_IDENTITY_FILE_NAME - r3prototyping - - - -r3prototyping / core.node / AbstractNode / PUBLIC_IDENTITY_FILE_NAME
-
-

PUBLIC_IDENTITY_FILE_NAME

- -val PUBLIC_IDENTITY_FILE_NAME: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/-init-.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/-init-.html deleted file mode 100644 index 6bcdd09d5c..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -AbstractNode.StorageServiceImpl.<init> - r3prototyping - - - -r3prototyping / core.node / AbstractNode / StorageServiceImpl / <init>
-
-

<init>

-StorageServiceImpl(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/attachments.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/attachments.html deleted file mode 100644 index a87a0e4fe4..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/attachments.html +++ /dev/null @@ -1,17 +0,0 @@ - - -AbstractNode.StorageServiceImpl.attachments - r3prototyping - - - -r3prototyping / core.node / AbstractNode / StorageServiceImpl / attachments
-
-

attachments

- -open val attachments: AttachmentStorage
-Overrides StorageService.attachments
-

Provides access to storage of arbitrary JAR files (which may contain only data, no code).

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/contract-programs.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/contract-programs.html deleted file mode 100644 index ba54bc6e51..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/contract-programs.html +++ /dev/null @@ -1,17 +0,0 @@ - - -AbstractNode.StorageServiceImpl.contractPrograms - r3prototyping - - - -r3prototyping / core.node / AbstractNode / StorageServiceImpl / contractPrograms
-
-

contractPrograms

- -open val contractPrograms: ContractFactory
-Overrides StorageService.contractPrograms
-

A map of program hash->contract class type, used for verification.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/get-map.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/get-map.html deleted file mode 100644 index ff54b7606b..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/get-map.html +++ /dev/null @@ -1,17 +0,0 @@ - - -AbstractNode.StorageServiceImpl.getMap - r3prototyping - - - -r3prototyping / core.node / AbstractNode / StorageServiceImpl / getMap
-
-

getMap

- -open fun <K, V> getMap(tableName: String): MutableMap<K, V>
-Overrides StorageService.getMap
-

TODO: Temp scaffolding that will go away eventually.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/index.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/index.html deleted file mode 100644 index a56ba8bb3b..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/index.html +++ /dev/null @@ -1,85 +0,0 @@ - - -AbstractNode.StorageServiceImpl - r3prototyping - - - -r3prototyping / core.node / AbstractNode / StorageServiceImpl
-
-

StorageServiceImpl

-open inner class StorageServiceImpl : StorageService
-
-
-

Constructors

- - - - - - - -
-<init> -StorageServiceImpl(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair)
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-attachments -open val attachments: AttachmentStorage

Provides access to storage of arbitrary JAR files (which may contain only data, no code).

-
-contractPrograms -open val contractPrograms: ContractFactory

A map of program hash->contract class type, used for verification.

-
-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
-tables -val tables: HashMap<String, MutableMap<Any, Any>>
-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.

-
-

Functions

- - - - - - - -
-getMap -open fun <K, V> getMap(tableName: String): MutableMap<K, V>

TODO: Temp scaffolding that will go away eventually.

-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/my-legal-identity-key.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/my-legal-identity-key.html deleted file mode 100644 index b44f3dd8f2..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/my-legal-identity-key.html +++ /dev/null @@ -1,16 +0,0 @@ - - -AbstractNode.StorageServiceImpl.myLegalIdentityKey - r3prototyping - - - -r3prototyping / core.node / AbstractNode / StorageServiceImpl / myLegalIdentityKey
-
-

myLegalIdentityKey

- -open val myLegalIdentityKey: KeyPair
-Overrides StorageService.myLegalIdentityKey
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/my-legal-identity.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/my-legal-identity.html deleted file mode 100644 index 08964b1d18..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/my-legal-identity.html +++ /dev/null @@ -1,18 +0,0 @@ - - -AbstractNode.StorageServiceImpl.myLegalIdentity - r3prototyping - - - -r3prototyping / core.node / AbstractNode / StorageServiceImpl / myLegalIdentity
-
-

myLegalIdentity

- -open val myLegalIdentity: Party
-Overrides StorageService.myLegalIdentity
-

Returns the legal identity that this node is configured with. Assumed to be initialised when the node is -first installed.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/tables.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/tables.html deleted file mode 100644 index 717d833593..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/tables.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.StorageServiceImpl.tables - r3prototyping - - - -r3prototyping / core.node / AbstractNode / StorageServiceImpl / tables
-
-

tables

- -protected val tables: HashMap<String, MutableMap<Any, Any>>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/validated-transactions.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/validated-transactions.html deleted file mode 100644 index 39f3bb3505..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/-storage-service-impl/validated-transactions.html +++ /dev/null @@ -1,24 +0,0 @@ - - -AbstractNode.StorageServiceImpl.validatedTransactions - r3prototyping - - - -r3prototyping / core.node / AbstractNode / StorageServiceImpl / validatedTransactions
-
-

validatedTransactions

- -open val validatedTransactions: MutableMap<SecureHash, SignedTransaction>
-Overrides 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.

-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/configuration.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/configuration.html deleted file mode 100644 index 82e28dbcfd..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/configuration.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.configuration - r3prototyping - - - -r3prototyping / core.node / AbstractNode / configuration
-
-

configuration

- -val configuration: NodeConfiguration
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/construct-storage-service.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/construct-storage-service.html deleted file mode 100644 index d58f571620..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/construct-storage-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.constructStorageService - r3prototyping - - - -r3prototyping / core.node / AbstractNode / constructStorageService
-
-

constructStorageService

- -protected open fun constructStorageService(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair): StorageServiceImpl
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/contract-factory.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/contract-factory.html deleted file mode 100644 index 3b1ffc0874..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/contract-factory.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.contractFactory - r3prototyping - - - -r3prototyping / core.node / AbstractNode / contractFactory
-
-

contractFactory

- -protected val contractFactory: ContractFactory
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/dir.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/dir.html deleted file mode 100644 index 481f13cf5b..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/dir.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.dir - r3prototyping - - - -r3prototyping / core.node / AbstractNode / dir
-
-

dir

- -val dir: Path
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/identity.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/identity.html deleted file mode 100644 index 436def08fd..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/identity.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.identity - r3prototyping - - - -r3prototyping / core.node / AbstractNode / identity
-
-

identity

- -lateinit var identity: IdentityService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/in-node-timestamping-service.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/in-node-timestamping-service.html deleted file mode 100644 index 9b7eccf1ac..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/in-node-timestamping-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.inNodeTimestampingService - r3prototyping - - - -r3prototyping / core.node / AbstractNode / inNodeTimestampingService
-
-

inNodeTimestampingService

- -var inNodeTimestampingService: NodeTimestamperService?
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/index.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/index.html deleted file mode 100644 index 4134a154d4..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/index.html +++ /dev/null @@ -1,206 +0,0 @@ - - -AbstractNode - r3prototyping - - - -r3prototyping / 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.

-
-
-

Types

- - - - - - - -
-StorageServiceImpl -open inner class StorageServiceImpl : StorageService
-

Constructors

- - - - - - - -
-<init> -AbstractNode(dir: Path, configuration: NodeConfiguration, timestamperAddress: LegallyIdentifiableNode?)

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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-configuration -val configuration: NodeConfiguration
-contractFactory -val contractFactory: ContractFactory
-dir -val dir: Path
-identity -lateinit var identity: IdentityService
-inNodeTimestampingService -var inNodeTimestampingService: NodeTimestamperService?
-keyManagement -lateinit var keyManagement: E2ETestKeyManagementService
-legallyIdentifableAddress -val legallyIdentifableAddress: LegallyIdentifiableNode
-log -abstract val log: Logger
-net -lateinit var net: MessagingService
-serverThread -open val serverThread: ExecutorService
-services -val services: ServiceHub
-smm -lateinit var smm: StateMachineManager
-storage -lateinit var storage: StorageService
-timestamperAddress -val timestamperAddress: LegallyIdentifiableNode?
-wallet -lateinit var wallet: WalletService
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-constructStorageService -open fun constructStorageService(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair): StorageServiceImpl
-initialiseStorageService -open fun initialiseStorageService(dir: Path): StorageService
-makeIdentityService -open fun makeIdentityService(): IdentityService
-makeMessagingService -abstract fun makeMessagingService(): MessagingService
-start -open fun start(): AbstractNode
-stop -open fun stop(): Unit
-

Companion Object Properties

- - - - - - - - - - - -
-PRIVATE_KEY_FILE_NAME -val PRIVATE_KEY_FILE_NAME: String
-PUBLIC_IDENTITY_FILE_NAME -val PUBLIC_IDENTITY_FILE_NAME: String
-

Inheritors

- - - - - - - -
-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/r3prototyping/core.node/-abstract-node/initialise-storage-service.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/initialise-storage-service.html deleted file mode 100644 index b3dc5d875f..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/initialise-storage-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.initialiseStorageService - r3prototyping - - - -r3prototyping / core.node / AbstractNode / initialiseStorageService
-
-

initialiseStorageService

- -protected open fun initialiseStorageService(dir: Path): StorageService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/key-management.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/key-management.html deleted file mode 100644 index d8cc264f45..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/key-management.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.keyManagement - r3prototyping - - - -r3prototyping / core.node / AbstractNode / keyManagement
-
-

keyManagement

- -lateinit var keyManagement: E2ETestKeyManagementService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/legally-identifable-address.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/legally-identifable-address.html deleted file mode 100644 index aab27c0aeb..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/legally-identifable-address.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.legallyIdentifableAddress - r3prototyping - - - -r3prototyping / core.node / AbstractNode / legallyIdentifableAddress
-
-

legallyIdentifableAddress

- -val legallyIdentifableAddress: LegallyIdentifiableNode
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/log.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/log.html deleted file mode 100644 index ce37c39f36..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/log.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.log - r3prototyping - - - -r3prototyping / core.node / AbstractNode / log
-
-

log

- -protected abstract val log: Logger
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/make-identity-service.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/make-identity-service.html deleted file mode 100644 index 22ccad33e0..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/make-identity-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.makeIdentityService - r3prototyping - - - -r3prototyping / core.node / AbstractNode / makeIdentityService
-
-

makeIdentityService

- -protected open fun makeIdentityService(): IdentityService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/make-messaging-service.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/make-messaging-service.html deleted file mode 100644 index 4c5fa06398..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/make-messaging-service.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.makeMessagingService - r3prototyping - - - -r3prototyping / core.node / AbstractNode / makeMessagingService
-
-

makeMessagingService

- -protected abstract fun makeMessagingService(): MessagingService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/net.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/net.html deleted file mode 100644 index 73172e2932..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/net.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.net - r3prototyping - - - -r3prototyping / core.node / AbstractNode / net
-
-

net

- -lateinit var net: MessagingService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/server-thread.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/server-thread.html deleted file mode 100644 index 82c23fa67f..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/server-thread.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.serverThread - r3prototyping - - - -r3prototyping / core.node / AbstractNode / serverThread
-
-

serverThread

- -protected open val serverThread: ExecutorService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/services.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/services.html deleted file mode 100644 index ffefa49077..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/services.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.services - r3prototyping - - - -r3prototyping / core.node / AbstractNode / services
-
-

services

- -val services: ServiceHub
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/smm.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/smm.html deleted file mode 100644 index 274365d32e..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/smm.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.smm - r3prototyping - - - -r3prototyping / core.node / AbstractNode / smm
-
-

smm

- -lateinit var smm: StateMachineManager
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/start.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/start.html deleted file mode 100644 index 5e5d40c6d1..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/start.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.start - r3prototyping - - - -r3prototyping / core.node / AbstractNode / start
-
-

start

- -open fun start(): AbstractNode
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/stop.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/stop.html deleted file mode 100644 index 6e617ef0ee..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/stop.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.stop - r3prototyping - - - -r3prototyping / core.node / AbstractNode / stop
-
-

stop

- -open fun stop(): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/storage.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/storage.html deleted file mode 100644 index 99ce3997b0..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/storage.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.storage - r3prototyping - - - -r3prototyping / core.node / AbstractNode / storage
-
-

storage

- -lateinit var storage: StorageService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/timestamper-address.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/timestamper-address.html deleted file mode 100644 index e2114fd4f1..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/timestamper-address.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.timestamperAddress - r3prototyping - - - -r3prototyping / core.node / AbstractNode / timestamperAddress
-
-

timestamperAddress

- -val timestamperAddress: LegallyIdentifiableNode?
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-abstract-node/wallet.html b/docs/build/html/api/r3prototyping/core.node/-abstract-node/wallet.html deleted file mode 100644 index 632631500e..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-abstract-node/wallet.html +++ /dev/null @@ -1,15 +0,0 @@ - - -AbstractNode.wallet - r3prototyping - - - -r3prototyping / core.node / AbstractNode / wallet
-
-

wallet

- -lateinit var wallet: WalletService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-configuration-exception/-init-.html b/docs/build/html/api/r3prototyping/core.node/-configuration-exception/-init-.html deleted file mode 100644 index 642ef40f84..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-configuration-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -ConfigurationException.<init> - r3prototyping - - - -r3prototyping / core.node / ConfigurationException / <init>
-
-

<init>

-ConfigurationException(message: String)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-configuration-exception/index.html b/docs/build/html/api/r3prototyping/core.node/-configuration-exception/index.html deleted file mode 100644 index 337bc2a19c..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-configuration-exception/index.html +++ /dev/null @@ -1,25 +0,0 @@ - - -ConfigurationException - r3prototyping - - - -r3prototyping / core.node / ConfigurationException
-
-

ConfigurationException

-class ConfigurationException : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -ConfigurationException(message: String)
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node-configuration-from-properties/-init-.html b/docs/build/html/api/r3prototyping/core.node/-node-configuration-from-properties/-init-.html deleted file mode 100644 index 664f4e4b69..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node-configuration-from-properties/-init-.html +++ /dev/null @@ -1,20 +0,0 @@ - - -NodeConfigurationFromProperties.<init> - r3prototyping - - - -r3prototyping / core.node / NodeConfigurationFromProperties / <init>
-
-

<init>

-NodeConfigurationFromProperties(properties: Properties)
-

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-

TODO: Replace Java properties file with a better config file format (maybe yaml). -We want to be able to configure via a GUI too, so an ability to round-trip whitespace, comments etc when machine -editing the file is a must-have.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node-configuration-from-properties/index.html b/docs/build/html/api/r3prototyping/core.node/-node-configuration-from-properties/index.html deleted file mode 100644 index d2b02f44d5..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node-configuration-from-properties/index.html +++ /dev/null @@ -1,43 +0,0 @@ - - -NodeConfigurationFromProperties - r3prototyping - - - -r3prototyping / core.node / NodeConfigurationFromProperties
-
-

NodeConfigurationFromProperties

-class NodeConfigurationFromProperties : NodeConfiguration
-

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-

TODO: Replace Java properties file with a better config file format (maybe yaml). -We want to be able to configure via a GUI too, so an ability to round-trip whitespace, comments etc when machine -editing the file is a must-have.

-
-
-
-
-

Constructors

- - - - - - - -
-<init> -NodeConfigurationFromProperties(properties: Properties)

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-
-

Properties

- - - - - - - -
-myLegalName -val myLegalName: String
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node-configuration-from-properties/my-legal-name.html b/docs/build/html/api/r3prototyping/core.node/-node-configuration-from-properties/my-legal-name.html deleted file mode 100644 index 26ee792501..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node-configuration-from-properties/my-legal-name.html +++ /dev/null @@ -1,16 +0,0 @@ - - -NodeConfigurationFromProperties.myLegalName - r3prototyping - - - -r3prototyping / core.node / NodeConfigurationFromProperties / myLegalName
-
-

myLegalName

- -val myLegalName: String
-Overrides NodeConfiguration.myLegalName
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node-configuration/index.html b/docs/build/html/api/r3prototyping/core.node/-node-configuration/index.html deleted file mode 100644 index e0d1181678..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node-configuration/index.html +++ /dev/null @@ -1,37 +0,0 @@ - - -NodeConfiguration - r3prototyping - - - -r3prototyping / core.node / NodeConfiguration
-
-

NodeConfiguration

-interface NodeConfiguration
-
-
-

Properties

- - - - - - - -
-myLegalName -abstract val myLegalName: String
-

Inheritors

- - - - - - - -
-NodeConfigurationFromProperties -class NodeConfigurationFromProperties : NodeConfiguration

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node-configuration/my-legal-name.html b/docs/build/html/api/r3prototyping/core.node/-node-configuration/my-legal-name.html deleted file mode 100644 index 7f60731a88..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node-configuration/my-legal-name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -NodeConfiguration.myLegalName - r3prototyping - - - -r3prototyping / core.node / NodeConfiguration / myLegalName
-
-

myLegalName

- -abstract val myLegalName: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node/-d-e-f-a-u-l-t_-p-o-r-t.html b/docs/build/html/api/r3prototyping/core.node/-node/-d-e-f-a-u-l-t_-p-o-r-t.html deleted file mode 100644 index 14bb5edb36..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node/-d-e-f-a-u-l-t_-p-o-r-t.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Node.DEFAULT_PORT - r3prototyping - - - -r3prototyping / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node/-init-.html b/docs/build/html/api/r3prototyping/core.node/-node/-init-.html deleted file mode 100644 index 921962aeff..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node/-init-.html +++ /dev/null @@ -1,29 +0,0 @@ - - -Node.<init> - r3prototyping - - - -r3prototyping / core.node / Node / <init>
-
-

<init>

-Node(dir: Path, p2pAddr: HostAndPort, configuration: NodeConfiguration, timestamperAddress: LegallyIdentifiableNode?)
-

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 file
-
- -timestamperAddress - If null, this node will become a timestamping node, otherwise, it will use that one.
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node/index.html b/docs/build/html/api/r3prototyping/core.node/-node/index.html deleted file mode 100644 index 124799e1e8..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node/index.html +++ /dev/null @@ -1,212 +0,0 @@ - - -Node - r3prototyping - - - -r3prototyping / 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 file
-
- -timestamperAddress - If null, this node will become a timestamping node, otherwise, it will use that one.
-
-
-

Constructors

- - - - - - - -
-<init> -Node(dir: Path, p2pAddr: HostAndPort, configuration: NodeConfiguration, timestamperAddress: LegallyIdentifiableNode?)

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

- - - - - - - - - - - - - - - -
-log -val log: Logger
-p2pAddr -val p2pAddr: HostAndPort
-webServer -lateinit var webServer: Server
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-configuration -val configuration: NodeConfiguration
-contractFactory -val contractFactory: ContractFactory
-dir -val dir: Path
-identity -lateinit var identity: IdentityService
-inNodeTimestampingService -var inNodeTimestampingService: NodeTimestamperService?
-keyManagement -lateinit var keyManagement: E2ETestKeyManagementService
-legallyIdentifableAddress -val legallyIdentifableAddress: LegallyIdentifiableNode
-net -lateinit var net: MessagingService
-serverThread -open val serverThread: ExecutorService
-services -val services: ServiceHub
-smm -lateinit var smm: StateMachineManager
-storage -lateinit var storage: StorageService
-timestamperAddress -val timestamperAddress: LegallyIdentifiableNode?
-wallet -lateinit var wallet: WalletService
-

Functions

- - - - - - - - - - - - - - - -
-makeMessagingService -fun makeMessagingService(): MessagingService
-start -fun start(): Node
-stop -fun stop(): Unit
-

Inherited Functions

- - - - - - - - - - - - - - - -
-constructStorageService -open fun constructStorageService(attachments: NodeAttachmentService, identity: Party, keypair: KeyPair): StorageServiceImpl
-initialiseStorageService -open fun initialiseStorageService(dir: Path): StorageService
-makeIdentityService -open fun makeIdentityService(): IdentityService
-

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/r3prototyping/core.node/-node/log.html b/docs/build/html/api/r3prototyping/core.node/-node/log.html deleted file mode 100644 index 73a34b47b2..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node/log.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Node.log - r3prototyping - - - -r3prototyping / core.node / Node / log
-
-

log

- -protected val log: Logger
-Overrides AbstractNode.log
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node/make-messaging-service.html b/docs/build/html/api/r3prototyping/core.node/-node/make-messaging-service.html deleted file mode 100644 index 483bf883c6..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node/make-messaging-service.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Node.makeMessagingService - r3prototyping - - - -r3prototyping / core.node / Node / makeMessagingService
-
-

makeMessagingService

- -protected fun makeMessagingService(): MessagingService
-Overrides AbstractNode.makeMessagingService
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node/p2p-addr.html b/docs/build/html/api/r3prototyping/core.node/-node/p2p-addr.html deleted file mode 100644 index 0b1862a355..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node/p2p-addr.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Node.p2pAddr - r3prototyping - - - -r3prototyping / core.node / Node / p2pAddr
-
-

p2pAddr

- -val p2pAddr: HostAndPort
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node/start.html b/docs/build/html/api/r3prototyping/core.node/-node/start.html deleted file mode 100644 index 59430ff4cb..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node/start.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Node.start - r3prototyping - - - -r3prototyping / core.node / Node / start
-
-

start

- -fun start(): Node
-Overrides AbstractNode.start
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node/stop.html b/docs/build/html/api/r3prototyping/core.node/-node/stop.html deleted file mode 100644 index b7395ca660..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node/stop.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Node.stop - r3prototyping - - - -r3prototyping / core.node / Node / stop
-
-

stop

- -fun stop(): Unit
-Overrides AbstractNode.stop
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/-node/web-server.html b/docs/build/html/api/r3prototyping/core.node/-node/web-server.html deleted file mode 100644 index 949e70953a..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/-node/web-server.html +++ /dev/null @@ -1,15 +0,0 @@ - - -Node.webServer - r3prototyping - - - -r3prototyping / core.node / Node / webServer
-
-

webServer

- -lateinit var webServer: Server
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.node/index.html b/docs/build/html/api/r3prototyping/core.node/index.html deleted file mode 100644 index 5f6f11ab3e..0000000000 --- a/docs/build/html/api/r3prototyping/core.node/index.html +++ /dev/null @@ -1,56 +0,0 @@ - - -core.node - r3prototyping - - - -r3prototyping / 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.

-
-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
-NodeConfigurationFromProperties -class NodeConfigurationFromProperties : NodeConfiguration

A simple wrapper around a plain old Java .properties file. The keys have the same name as in the source code.

-
-

Exceptions

- - - - - - - -
-ConfigurationException -class ConfigurationException : Exception
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/-init-.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/-init-.html deleted file mode 100644 index 4bfe9badc9..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/-init-.html +++ /dev/null @@ -1,28 +0,0 @@ - - -ProtocolLogic.<init> - r3prototyping - - - -r3prototyping / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/call.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/call.html deleted file mode 100644 index 89e3e999fa..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/call.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProtocolLogic.call - r3prototyping - - - -r3prototyping / core.protocols / ProtocolLogic / call
-
-

call

- -@Suspendable abstract fun call(): T
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/index.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/index.html deleted file mode 100644 index 41c26ffba4..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/index.html +++ /dev/null @@ -1,169 +0,0 @@ - - -ProtocolLogic - r3prototyping - - - -r3prototyping / 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: Logger

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>
-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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-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.

-
-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.

-
-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>
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/logger.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/logger.html deleted file mode 100644 index 0545a81280..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/logger.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProtocolLogic.logger - r3prototyping - - - -r3prototyping / core.protocols / ProtocolLogic / logger
-
-

logger

- -val logger: Logger
-

This is where you should log things to.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/progress-tracker.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/progress-tracker.html deleted file mode 100644 index bb0745917a..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/progress-tracker.html +++ /dev/null @@ -1,23 +0,0 @@ - - -ProtocolLogic.progressTracker - r3prototyping - - - -r3prototyping / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/psm.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/psm.html deleted file mode 100644 index f57a349a26..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/psm.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProtocolLogic.psm - r3prototyping - - - -r3prototyping / core.protocols / ProtocolLogic / psm
-
-

psm

- -lateinit var psm: ProtocolStateMachine<*>
-

Reference to the Fiber instance that is the top level controller for the entire flow.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/receive.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/receive.html deleted file mode 100644 index f63b28acba..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolLogic.receive - r3prototyping - - - -r3prototyping / core.protocols / ProtocolLogic / receive
-
-

receive

- -inline fun <reified T : Any> receive(topic: String, sessionIDForReceive: Long): UntrustworthyData<T>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/send-and-receive.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/send-and-receive.html deleted file mode 100644 index b71e6fa1bd..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/send-and-receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolLogic.sendAndReceive - r3prototyping - - - -r3prototyping / core.protocols / ProtocolLogic / sendAndReceive
-
-

sendAndReceive

- -inline fun <reified T : Any> sendAndReceive(topic: String, destination: MessageRecipients, sessionIDForSend: Long, sessionIDForReceive: Long, obj: Any): UntrustworthyData<T>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/send.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/send.html deleted file mode 100644 index 3bad7c87da..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/send.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolLogic.send - r3prototyping - - - -r3prototyping / core.protocols / ProtocolLogic / send
-
-

send

- -@Suspendable fun send(topic: String, destination: MessageRecipients, sessionID: Long, obj: Any): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/service-hub.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/service-hub.html deleted file mode 100644 index ae1c00dbe7..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/service-hub.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProtocolLogic.serviceHub - r3prototyping - - - -r3prototyping / 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

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/sub-protocol.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/sub-protocol.html deleted file mode 100644 index 5cadd0eb0f..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-logic/sub-protocol.html +++ /dev/null @@ -1,17 +0,0 @@ - - -ProtocolLogic.subProtocol - r3prototyping - - - -r3prototyping / core.protocols / ProtocolLogic / subProtocol
-
-

subProtocol

- -@Suspendable 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/-init-.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/-init-.html deleted file mode 100644 index a9dc252460..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/-init-.html +++ /dev/null @@ -1,21 +0,0 @@ - - -ProtocolStateMachine.<init> - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / <init>
-
-

<init>

-ProtocolStateMachine(logic: ProtocolLogic<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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/index.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/index.html deleted file mode 100644 index fab2f3a160..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/index.html +++ /dev/null @@ -1,99 +0,0 @@ - - -ProtocolStateMachine - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine
-
-

ProtocolStateMachine

-class ProtocolStateMachine<R> : Fiber<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>)

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

- - - - - - - - - - - - - - - - - - - -
-logger -lateinit var logger: Logger
-logic -val logic: ProtocolLogic<R>
-resultFuture -val resultFuture: ListenableFuture<R>

This future will complete when the call method returns.

-
-serviceHub -lateinit var serviceHub: ServiceHub
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - -
-prepareForResumeWith -fun prepareForResumeWith(serviceHub: ServiceHub, withObject: Any?, logger: Logger, 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/r3prototyping/core.protocols/-protocol-state-machine/logger.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/logger.html deleted file mode 100644 index 88ab1e2fa0..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/logger.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.logger - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / logger
-
-

logger

- -@Transient lateinit var logger: Logger
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/logic.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/logic.html deleted file mode 100644 index a3e587d381..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/logic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.logic - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / logic
-
-

logic

- -val logic: ProtocolLogic<R>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/prepare-for-resume-with.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/prepare-for-resume-with.html deleted file mode 100644 index 3a10f39525..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/prepare-for-resume-with.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.prepareForResumeWith - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / prepareForResumeWith
-
-

prepareForResumeWith

- -fun prepareForResumeWith(serviceHub: ServiceHub, withObject: Any?, logger: Logger, suspendFunc: (FiberRequest, ByteArray) -> Unit): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/receive.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/receive.html deleted file mode 100644 index b0342711ab..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.receive - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / receive
-
-

receive

- -@Suspendable fun <T : Any> receive(topic: String, sessionIDForReceive: Long, recvType: Class<T>): UntrustworthyData<T>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/result-future.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/result-future.html deleted file mode 100644 index 1d4944b573..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/result-future.html +++ /dev/null @@ -1,16 +0,0 @@ - - -ProtocolStateMachine.resultFuture - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / resultFuture
-
-

resultFuture

- -val resultFuture: ListenableFuture<R>
-

This future will complete when the call method returns.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/run.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/run.html deleted file mode 100644 index ea28f2fd40..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/run.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.run - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / run
-
-

run

- -@Suspendable protected fun run(): R
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/send-and-receive.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/send-and-receive.html deleted file mode 100644 index 419220159d..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/send-and-receive.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.sendAndReceive - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / sendAndReceive
-
-

sendAndReceive

- -@Suspendable 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/r3prototyping/core.protocols/-protocol-state-machine/send.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/send.html deleted file mode 100644 index 7e83f2843e..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/send.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.send - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / send
-
-

send

- -@Suspendable fun send(topic: String, destination: MessageRecipients, sessionID: Long, obj: Any): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/service-hub.html b/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/service-hub.html deleted file mode 100644 index e55ba27b11..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/-protocol-state-machine/service-hub.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ProtocolStateMachine.serviceHub - r3prototyping - - - -r3prototyping / core.protocols / ProtocolStateMachine / serviceHub
-
-

serviceHub

- -@Transient lateinit var serviceHub: ServiceHub
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.protocols/index.html b/docs/build/html/api/r3prototyping/core.protocols/index.html deleted file mode 100644 index 7f5a5af3e0..0000000000 --- a/docs/build/html/api/r3prototyping/core.protocols/index.html +++ /dev/null @@ -1,33 +0,0 @@ - - -core.protocols - r3prototyping - - - -r3prototyping / 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> : Fiber<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/r3prototyping/core.utilities/-a-n-s-i-progress-renderer/index.html b/docs/build/html/api/r3prototyping/core.utilities/-a-n-s-i-progress-renderer/index.html deleted file mode 100644 index 4058f226b5..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-a-n-s-i-progress-renderer/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - -ANSIProgressRenderer - r3prototyping - - - -r3prototyping / 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

- - - - - - - -
-progressTracker -var progressTracker: ProgressTracker?
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-a-n-s-i-progress-renderer/progress-tracker.html b/docs/build/html/api/r3prototyping/core.utilities/-a-n-s-i-progress-renderer/progress-tracker.html deleted file mode 100644 index a0c4f5aa62..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-a-n-s-i-progress-renderer/progress-tracker.html +++ /dev/null @@ -1,15 +0,0 @@ - - -ANSIProgressRenderer.progressTracker - r3prototyping - - - -r3prototyping / core.utilities / ANSIProgressRenderer / progressTracker
-
-

progressTracker

- -var progressTracker: ProgressTracker?
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/-init-.html b/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/-init-.html deleted file mode 100644 index 9dc954001c..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - -BriefLogFormatter.<init> - r3prototyping - - - -r3prototyping / core.utilities / BriefLogFormatter / <init>
-
-

<init>

-BriefLogFormatter()
-

A Java logging formatter that writes more compact output than the default.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/format.html b/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/format.html deleted file mode 100644 index 901a541f02..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/format.html +++ /dev/null @@ -1,15 +0,0 @@ - - -BriefLogFormatter.format - r3prototyping - - - -r3prototyping / core.utilities / BriefLogFormatter / format
-
-

format

- -fun format(logRecord: LogRecord): String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/index.html b/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/index.html deleted file mode 100644 index f527303bb7..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/index.html +++ /dev/null @@ -1,73 +0,0 @@ - - -BriefLogFormatter - r3prototyping - - - -r3prototyping / 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

- - - - - - - -
-format -fun format(logRecord: LogRecord): String
-

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/r3prototyping/core.utilities/-brief-log-formatter/init-verbose.html b/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/init-verbose.html deleted file mode 100644 index 4fc9c2e51c..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/init-verbose.html +++ /dev/null @@ -1,18 +0,0 @@ - - -BriefLogFormatter.initVerbose - r3prototyping - - - -r3prototyping / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/init.html b/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/init.html deleted file mode 100644 index b06677b4b9..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/init.html +++ /dev/null @@ -1,16 +0,0 @@ - - -BriefLogFormatter.init - r3prototyping - - - -r3prototyping / core.utilities / BriefLogFormatter / init
-
-

init

- -fun init(): Unit
-

Configures JDK logging to use this class for everything.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/logging-off.html b/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/logging-off.html deleted file mode 100644 index acf2ed95d4..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/logging-off.html +++ /dev/null @@ -1,17 +0,0 @@ - - -BriefLogFormatter.loggingOff - r3prototyping - - - -r3prototyping / core.utilities / BriefLogFormatter / loggingOff
-
-

loggingOff

- -fun loggingOff(vararg names: String): Unit
- -fun loggingOff(vararg classes: KClass<*>): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/logging-on.html b/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/logging-on.html deleted file mode 100644 index 67f9e70b2c..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-brief-log-formatter/logging-on.html +++ /dev/null @@ -1,17 +0,0 @@ - - -BriefLogFormatter.loggingOn - r3prototyping - - - -r3prototyping / core.utilities / BriefLogFormatter / loggingOn
-
-

loggingOn

- -fun loggingOn(vararg names: String): Unit
- -fun loggingOn(vararg classes: KClass<*>): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/-init-.html b/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/-init-.html deleted file mode 100644 index 5ea084e3b1..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/-init-.html +++ /dev/null @@ -1,24 +0,0 @@ - - -UntrustworthyData.<init> - r3prototyping - - - -r3prototyping / 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?

    -

-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/data.html b/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/data.html deleted file mode 100644 index c044d855b7..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/data.html +++ /dev/null @@ -1,15 +0,0 @@ - - -UntrustworthyData.data - r3prototyping - - - -r3prototyping / core.utilities / UntrustworthyData / data
-
-

data

- -val data: T
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/index.html b/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/index.html deleted file mode 100644 index 835b1b8f07..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - -UntrustworthyData - r3prototyping - - - -r3prototyping / 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/r3prototyping/core.utilities/-untrustworthy-data/validate.html b/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/validate.html deleted file mode 100644 index 0cc4bb44bb..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/-untrustworthy-data/validate.html +++ /dev/null @@ -1,15 +0,0 @@ - - -UntrustworthyData.validate - r3prototyping - - - -r3prototyping / core.utilities / UntrustworthyData / validate
-
-

validate

- -inline fun <R> validate(validator: (T) -> R): R
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/index.html b/docs/build/html/api/r3prototyping/core.utilities/index.html deleted file mode 100644 index 1d6625f93d..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - -core.utilities - r3prototyping - - - -r3prototyping / 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.

-
-BriefLogFormatter -class BriefLogFormatter : Formatter

A Java logging formatter that writes more compact output than the default.

-
-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:

-
-

Extensions for External Classes

- - - - - - - -
-org.slf4j.Logger -
-

Functions

- - - - - - - -
-loggerFor -fun <T : Any> loggerFor(): Logger
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/logger-for.html b/docs/build/html/api/r3prototyping/core.utilities/logger-for.html deleted file mode 100644 index cadc653c21..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/logger-for.html +++ /dev/null @@ -1,15 +0,0 @@ - - -loggerFor - r3prototyping - - - -r3prototyping / core.utilities / loggerFor
-
-

loggerFor

- -inline fun <reified T : Any> loggerFor(): Logger
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/org.slf4j.-logger/index.html b/docs/build/html/api/r3prototyping/core.utilities/org.slf4j.-logger/index.html deleted file mode 100644 index b19da18091..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/org.slf4j.-logger/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - -core.utilities.org.slf4j.Logger - r3prototyping - - - -r3prototyping / core.utilities / org.slf4j.Logger
-
-

Extensions for org.slf4j.Logger

- - - - - - - -
-trace -fun Logger.trace(msg: () -> String): Unit
- - diff --git a/docs/build/html/api/r3prototyping/core.utilities/org.slf4j.-logger/trace.html b/docs/build/html/api/r3prototyping/core.utilities/org.slf4j.-logger/trace.html deleted file mode 100644 index d6c24d531d..0000000000 --- a/docs/build/html/api/r3prototyping/core.utilities/org.slf4j.-logger/trace.html +++ /dev/null @@ -1,15 +0,0 @@ - - -trace - r3prototyping - - - -r3prototyping / core.utilities / org.slf4j.Logger / trace
-
-

trace

- -inline fun Logger.trace(msg: () -> String): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core/index.html b/docs/build/html/api/r3prototyping/core/index.html deleted file mode 100644 index 3394f9e553..0000000000 --- a/docs/build/html/api/r3prototyping/core/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - -core - r3prototyping - - - -r3prototyping / core
-
-

Package core

-

Functions

- - - - - - - - - - - -
-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/r3prototyping/core/to-ledger-transaction.html b/docs/build/html/api/r3prototyping/core/to-ledger-transaction.html deleted file mode 100644 index 7643151e9c..0000000000 --- a/docs/build/html/api/r3prototyping/core/to-ledger-transaction.html +++ /dev/null @@ -1,19 +0,0 @@ - - -toLedgerTransaction - r3prototyping - - - -r3prototyping / 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 transaction was not found in storage.
-
-
- - diff --git a/docs/build/html/api/r3prototyping/core/verify-to-ledger-transaction.html b/docs/build/html/api/r3prototyping/core/verify-to-ledger-transaction.html deleted file mode 100644 index cede73f82d..0000000000 --- a/docs/build/html/api/r3prototyping/core/verify-to-ledger-transaction.html +++ /dev/null @@ -1,17 +0,0 @@ - - -verifyToLedgerTransaction - r3prototyping - - - -r3prototyping / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/-init-.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/-init-.html deleted file mode 100644 index 7573da6f16..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TraderDemoProtocolBuyer.<init> - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolBuyer / <init>
-
-

<init>

-TraderDemoProtocolBuyer(attachmentsPath: Path)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/-s-t-a-r-t-i-n-g_-b-u-y.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/-s-t-a-r-t-i-n-g_-b-u-y.html deleted file mode 100644 index c597fa26b0..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/-s-t-a-r-t-i-n-g_-b-u-y.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TraderDemoProtocolBuyer.STARTING_BUY - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolBuyer / STARTING_BUY
-
-

STARTING_BUY

-object STARTING_BUY : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/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/r3prototyping/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 deleted file mode 100644 index 1c81eede98..0000000000 --- a/docs/build/html/api/r3prototyping/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 +++ /dev/null @@ -1,14 +0,0 @@ - - -TraderDemoProtocolBuyer.WAITING_FOR_SELLER_TO_CONNECT - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolBuyer / WAITING_FOR_SELLER_TO_CONNECT
-
-

WAITING_FOR_SELLER_TO_CONNECT

-object WAITING_FOR_SELLER_TO_CONNECT : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/call.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/call.html deleted file mode 100644 index 2ef6459f61..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TraderDemoProtocolBuyer.call - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolBuyer / call
-
-

call

- -@Suspendable fun call(): Unit
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/index.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/index.html deleted file mode 100644 index de11c44739..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/index.html +++ /dev/null @@ -1,126 +0,0 @@ - - -TraderDemoProtocolBuyer - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolBuyer
-
-

TraderDemoProtocolBuyer

-class TraderDemoProtocolBuyer : ProtocolLogic<Unit>
-
-
-

Types

- - - - - - - - - - - -
-STARTING_BUY -object STARTING_BUY : Step
-WAITING_FOR_SELLER_TO_CONNECT -object WAITING_FOR_SELLER_TO_CONNECT : Step
-

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: Logger

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>
-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.

-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/progress-tracker.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/progress-tracker.html deleted file mode 100644 index a8f84781d0..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-buyer/progress-tracker.html +++ /dev/null @@ -1,24 +0,0 @@ - - -TraderDemoProtocolBuyer.progressTracker - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolBuyer / progressTracker
-
-

progressTracker

- -val progressTracker: ProgressTracker
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-a-n-n-o-u-n-c-i-n-g.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-a-n-n-o-u-n-c-i-n-g.html deleted file mode 100644 index c5542dfa2f..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-a-n-n-o-u-n-c-i-n-g.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TraderDemoProtocolSeller.ANNOUNCING - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / ANNOUNCING
-
-

ANNOUNCING

-object ANNOUNCING : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-init-.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-init-.html deleted file mode 100644 index 42f325de46..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TraderDemoProtocolSeller.<init> - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / <init>
-
-

<init>

-TraderDemoProtocolSeller(myAddress: HostAndPort, otherSide: SingleMessageRecipient, progressTracker: ProgressTracker = TraderDemoProtocolSeller.tracker())
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-p-r-o-s-p-e-c-t-u-s_-h-a-s-h.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-p-r-o-s-p-e-c-t-u-s_-h-a-s-h.html deleted file mode 100644 index 8bc22eb8d3..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-p-r-o-s-p-e-c-t-u-s_-h-a-s-h.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.PROSPECTUS_HASH - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / PROSPECTUS_HASH
-
-

PROSPECTUS_HASH

- -val PROSPECTUS_HASH: SHA256
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-s-e-l-f_-i-s-s-u-i-n-g.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-s-e-l-f_-i-s-s-u-i-n-g.html deleted file mode 100644 index 69470faab8..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-s-e-l-f_-i-s-s-u-i-n-g.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TraderDemoProtocolSeller.SELF_ISSUING - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / SELF_ISSUING
-
-

SELF_ISSUING

-object SELF_ISSUING : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-t-r-a-d-i-n-g.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-t-r-a-d-i-n-g.html deleted file mode 100644 index 0a4c150dd3..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/-t-r-a-d-i-n-g.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TraderDemoProtocolSeller.TRADING - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / TRADING
-
-

TRADING

-object TRADING : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/call.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/call.html deleted file mode 100644 index 704123fdf8..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TraderDemoProtocolSeller.call - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / call
-
-

call

- -@Suspendable fun call(): Unit
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/index.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/index.html deleted file mode 100644 index b4ed25ea1c..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/index.html +++ /dev/null @@ -1,172 +0,0 @@ - - -TraderDemoProtocolSeller - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller
-
-

TraderDemoProtocolSeller

-class TraderDemoProtocolSeller : ProtocolLogic<Unit>
-
-
-

Types

- - - - - - - - - - - - - - - -
-ANNOUNCING -object ANNOUNCING : Step
-SELF_ISSUING -object SELF_ISSUING : Step
-TRADING -object TRADING : Step
-

Constructors

- - - - - - - -
-<init> -TraderDemoProtocolSeller(myAddress: HostAndPort, otherSide: SingleMessageRecipient, progressTracker: ProgressTracker = TraderDemoProtocolSeller.tracker())
-

Properties

- - - - - - - - - - - - - - - -
-myAddress -val myAddress: HostAndPort
-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: Logger

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.

-
-selfIssueSomeCommercialPaper -fun selfIssueSomeCommercialPaper(ownedBy: PublicKey, tsa: LegallyIdentifiableNode): StateAndRef<State>
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - -
-receive -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 ProtocolLogics reference to the -ProtocolStateMachine and then calling the call method.

-
-

Companion Object Properties

- - - - - - - -
-PROSPECTUS_HASH -val PROSPECTUS_HASH: SHA256
-

Companion Object Functions

- - - - - - - -
-tracker -fun tracker(): <ERROR CLASS>
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/my-address.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/my-address.html deleted file mode 100644 index 0f4e275928..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/my-address.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.myAddress - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / myAddress
-
-

myAddress

- -val myAddress: HostAndPort
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/other-side.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/other-side.html deleted file mode 100644 index d05fca83ee..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/other-side.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.otherSide - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / otherSide
-
-

otherSide

- -val otherSide: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/progress-tracker.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/progress-tracker.html deleted file mode 100644 index 651b536a96..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/progress-tracker.html +++ /dev/null @@ -1,24 +0,0 @@ - - -TraderDemoProtocolSeller.progressTracker - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / progressTracker
-
-

progressTracker

- -val progressTracker: ProgressTracker
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/self-issue-some-commercial-paper.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/self-issue-some-commercial-paper.html deleted file mode 100644 index f01293835d..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/self-issue-some-commercial-paper.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.selfIssueSomeCommercialPaper - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / selfIssueSomeCommercialPaper
-
-

selfIssueSomeCommercialPaper

- -@Suspendable fun selfIssueSomeCommercialPaper(ownedBy: PublicKey, tsa: LegallyIdentifiableNode): StateAndRef<State>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/tracker.html b/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/tracker.html deleted file mode 100644 index d56b5c7086..0000000000 --- a/docs/build/html/api/r3prototyping/demos/-trader-demo-protocol-seller/tracker.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TraderDemoProtocolSeller.tracker - r3prototyping - - - -r3prototyping / demos / TraderDemoProtocolSeller / tracker
-
-

tracker

- -fun tracker(): <ERROR CLASS>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/demos/index.html b/docs/build/html/api/r3prototyping/demos/index.html deleted file mode 100644 index dcc23cdb9d..0000000000 --- a/docs/build/html/api/r3prototyping/demos/index.html +++ /dev/null @@ -1,39 +0,0 @@ - - -demos - r3prototyping - - - -r3prototyping / demos
-
-

Package demos

-

Types

- - - - - - - - - - - -
-TraderDemoProtocolBuyer -class TraderDemoProtocolBuyer : ProtocolLogic<Unit>
-TraderDemoProtocolSeller -class TraderDemoProtocolSeller : ProtocolLogic<Unit>
-

Functions

- - - - - - - -
-main -fun main(args: Array<String>): Unit
- - diff --git a/docs/build/html/api/r3prototyping/demos/main.html b/docs/build/html/api/r3prototyping/demos/main.html deleted file mode 100644 index 58fd337591..0000000000 --- a/docs/build/html/api/r3prototyping/demos/main.html +++ /dev/null @@ -1,15 +0,0 @@ - - -main - r3prototyping - - - -r3prototyping / demos / main
-
-

main

- -fun main(args: Array<String>): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/index-outline.html b/docs/build/html/api/r3prototyping/index-outline.html deleted file mode 100644 index 6e880e3d13..0000000000 --- a/docs/build/html/api/r3prototyping/index-outline.html +++ /dev/null @@ -1,2099 +0,0 @@ - - -Module Contents - - - -r3prototyping
- - - diff --git a/docs/build/html/api/r3prototyping/index.html b/docs/build/html/api/r3prototyping/index.html deleted file mode 100644 index d26e43ce7a..0000000000 --- a/docs/build/html/api/r3prototyping/index.html +++ /dev/null @@ -1,70 +0,0 @@ - - -r3prototyping - - - -r3prototyping
-
-

Packages

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-core -
-core.messaging -
-core.node -
-core.node.services -
-core.node.servlets -
-core.protocols -
-core.utilities -
-demos -
-protocols -
-

Index

-All Types - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/-init-.html b/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/-init-.html deleted file mode 100644 index 2f979d771a..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FetchAttachmentsProtocol.<init> - r3prototyping - - - -r3prototyping / 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.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/-t-o-p-i-c.html b/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/-t-o-p-i-c.html deleted file mode 100644 index 9635673e78..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/-t-o-p-i-c.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchAttachmentsProtocol.TOPIC - r3prototyping - - - -r3prototyping / protocols / FetchAttachmentsProtocol / TOPIC
-
-

TOPIC

- -const val TOPIC: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/convert.html b/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/convert.html deleted file mode 100644 index 4707809c6c..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/convert.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchAttachmentsProtocol.convert - r3prototyping - - - -r3prototyping / protocols / FetchAttachmentsProtocol / convert
-
-

convert

- -protected fun convert(wire: ByteArray): Attachment
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/index.html b/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/index.html deleted file mode 100644 index 8a9c5343a2..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/index.html +++ /dev/null @@ -1,103 +0,0 @@ - - -FetchAttachmentsProtocol - r3prototyping - - - -r3prototyping / 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

- - - - - - - -
-queryTopic -val queryTopic: String
-

Inherited Properties

- - - - - - - - - - - -
-otherSide -val otherSide: SingleMessageRecipient
-requests -val requests: Set<SecureHash>
-

Functions

- - - - - - - - - - - - - - - -
-convert -fun convert(wire: ByteArray): Attachment
-load -fun load(txid: SecureHash): Attachment?
-maybeWriteToDisk -fun maybeWriteToDisk(downloaded: List<Attachment>): Unit
-

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/r3prototyping/protocols/-fetch-attachments-protocol/load.html b/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/load.html deleted file mode 100644 index 8b8f7b7555..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/load.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FetchAttachmentsProtocol.load - r3prototyping - - - -r3prototyping / protocols / FetchAttachmentsProtocol / load
-
-

load

- -protected fun load(txid: SecureHash): Attachment?
-Overrides FetchDataProtocol.load
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/maybe-write-to-disk.html b/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/maybe-write-to-disk.html deleted file mode 100644 index 2414227a54..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/maybe-write-to-disk.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchAttachmentsProtocol.maybeWriteToDisk - r3prototyping - - - -r3prototyping / protocols / FetchAttachmentsProtocol / maybeWriteToDisk
-
-

maybeWriteToDisk

- -protected fun maybeWriteToDisk(downloaded: List<Attachment>): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/query-topic.html b/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/query-topic.html deleted file mode 100644 index 22241b935a..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-attachments-protocol/query-topic.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FetchAttachmentsProtocol.queryTopic - r3prototyping - - - -r3prototyping / protocols / FetchAttachmentsProtocol / queryTopic
-
-

queryTopic

- -protected val queryTopic: String
-Overrides FetchDataProtocol.queryTopic
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-bad-answer/-init-.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-bad-answer/-init-.html deleted file mode 100644 index 736580322f..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-bad-answer/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -FetchDataProtocol.BadAnswer.<init> - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / BadAnswer / <init>
-
-

<init>

-BadAnswer()
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-bad-answer/index.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-bad-answer/index.html deleted file mode 100644 index 49c64a548c..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-bad-answer/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -FetchDataProtocol.BadAnswer - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / BadAnswer
-
-

BadAnswer

-open class BadAnswer : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -BadAnswer()
-

Inheritors

- - - - - - - - - - - -
-DownloadedVsRequestedDataMismatch -class DownloadedVsRequestedDataMismatch : BadAnswer
-HashNotFound -class HashNotFound : BadAnswer
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/-init-.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/-init-.html deleted file mode 100644 index fdd5775410..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -FetchDataProtocol.DownloadedVsRequestedDataMismatch.<init> - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch / <init>
-
-

<init>

-DownloadedVsRequestedDataMismatch(requested: SecureHash, got: SecureHash)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/got.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/got.html deleted file mode 100644 index e8c0e31f25..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/got.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.DownloadedVsRequestedDataMismatch.got - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch / got
-
-

got

- -val got: SecureHash
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/index.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/index.html deleted file mode 100644 index 5059b09204..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -FetchDataProtocol.DownloadedVsRequestedDataMismatch - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch
-
-

DownloadedVsRequestedDataMismatch

-class DownloadedVsRequestedDataMismatch : BadAnswer
-
-
-

Constructors

- - - - - - - -
-<init> -DownloadedVsRequestedDataMismatch(requested: SecureHash, got: SecureHash)
-

Properties

- - - - - - - - - - - -
-got -val got: SecureHash
-requested -val requested: SecureHash
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/requested.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/requested.html deleted file mode 100644 index bb45afd8fb..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/requested.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.DownloadedVsRequestedDataMismatch.requested - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / DownloadedVsRequestedDataMismatch / requested
-
-

requested

- -val requested: SecureHash
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-hash-not-found/-init-.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-hash-not-found/-init-.html deleted file mode 100644 index bc82445f5a..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-hash-not-found/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -FetchDataProtocol.HashNotFound.<init> - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / HashNotFound / <init>
-
-

<init>

-HashNotFound(requested: SecureHash)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-hash-not-found/index.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-hash-not-found/index.html deleted file mode 100644 index 084b0ea838..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-hash-not-found/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -FetchDataProtocol.HashNotFound - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / HashNotFound
-
-

HashNotFound

-class HashNotFound : BadAnswer
-
-
-

Constructors

- - - - - - - -
-<init> -HashNotFound(requested: SecureHash)
-

Properties

- - - - - - - -
-requested -val requested: SecureHash
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-hash-not-found/requested.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-hash-not-found/requested.html deleted file mode 100644 index 8620c61488..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-hash-not-found/requested.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.HashNotFound.requested - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / HashNotFound / requested
-
-

requested

- -val requested: SecureHash
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-init-.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-init-.html deleted file mode 100644 index dfa3b9c169..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-init-.html +++ /dev/null @@ -1,30 +0,0 @@ - - -FetchDataProtocol.<init> - r3prototyping - - - -r3prototyping / 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.
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/-init-.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/-init-.html deleted file mode 100644 index 72775f8a24..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -FetchDataProtocol.Result.<init> - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / Result / <init>
-
-

<init>

-Result(fromDisk: List<T>, downloaded: List<T>)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/downloaded.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/downloaded.html deleted file mode 100644 index 9fa8eaca96..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/downloaded.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.Result.downloaded - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / Result / downloaded
-
-

downloaded

- -val downloaded: List<T>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/from-disk.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/from-disk.html deleted file mode 100644 index b65d86b440..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/from-disk.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.Result.fromDisk - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / Result / fromDisk
-
-

fromDisk

- -val fromDisk: List<T>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/index.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/index.html deleted file mode 100644 index 3ebbb6dd7d..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/-result/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -FetchDataProtocol.Result - r3prototyping - - - -r3prototyping / 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/r3prototyping/protocols/-fetch-data-protocol/call.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/call.html deleted file mode 100644 index 60e59250e2..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -FetchDataProtocol.call - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / call
-
-

call

- -@Suspendable open fun call(): Result<T>
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/convert.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/convert.html deleted file mode 100644 index fe4d39a3fb..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/convert.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.convert - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / convert
-
-

convert

- -protected open fun convert(wire: W): T
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/index.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/index.html deleted file mode 100644 index 6a776226f5..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/index.html +++ /dev/null @@ -1,216 +0,0 @@ - - -FetchDataProtocol - r3prototyping - - - -r3prototyping / 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

- - - - - - - -
-Result -data class Result<T : NamedByHash>
-

Exceptions

- - - - - - - - - - - - - - - -
-BadAnswer -open class BadAnswer : Exception
-DownloadedVsRequestedDataMismatch -class DownloadedVsRequestedDataMismatch : BadAnswer
-HashNotFound -class HashNotFound : BadAnswer
-

Constructors

- - - - - - - -
-<init> -FetchDataProtocol(requests: Set<SecureHash>, otherSide: SingleMessageRecipient)

An abstract protocol for fetching typed data from a remote peer.

-
-

Properties

- - - - - - - - - - - - - - - -
-otherSide -val otherSide: SingleMessageRecipient
-queryTopic -abstract val queryTopic: String
-requests -val requests: Set<SecureHash>
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - -
-logger -val logger: Logger

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>
-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

- - - - - - - - - - - -
-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/r3prototyping/protocols/-fetch-data-protocol/load.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/load.html deleted file mode 100644 index b2122bd37f..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/load.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.load - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / load
-
-

load

- -protected abstract fun load(txid: SecureHash): T?
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/maybe-write-to-disk.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/maybe-write-to-disk.html deleted file mode 100644 index 230717c73d..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/maybe-write-to-disk.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.maybeWriteToDisk - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / maybeWriteToDisk
-
-

maybeWriteToDisk

- -protected open fun maybeWriteToDisk(downloaded: List<T>): Unit
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/other-side.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/other-side.html deleted file mode 100644 index 9e56bf3c1e..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/other-side.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.otherSide - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / otherSide
-
-

otherSide

- -protected val otherSide: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/query-topic.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/query-topic.html deleted file mode 100644 index 1143bd2cde..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/query-topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.queryTopic - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / queryTopic
-
-

queryTopic

- -protected abstract val queryTopic: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/requests.html b/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/requests.html deleted file mode 100644 index 2fe29965b5..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-data-protocol/requests.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchDataProtocol.requests - r3prototyping - - - -r3prototyping / protocols / FetchDataProtocol / requests
-
-

requests

- -protected val requests: Set<SecureHash>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/-init-.html b/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/-init-.html deleted file mode 100644 index ee37dd7e8e..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/-init-.html +++ /dev/null @@ -1,21 +0,0 @@ - - -FetchTransactionsProtocol.<init> - r3prototyping - - - -r3prototyping / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/-t-o-p-i-c.html b/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/-t-o-p-i-c.html deleted file mode 100644 index f1a1bed32d..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/-t-o-p-i-c.html +++ /dev/null @@ -1,15 +0,0 @@ - - -FetchTransactionsProtocol.TOPIC - r3prototyping - - - -r3prototyping / protocols / FetchTransactionsProtocol / TOPIC
-
-

TOPIC

- -const val TOPIC: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/index.html b/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/index.html deleted file mode 100644 index 2ca3e6b8c9..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/index.html +++ /dev/null @@ -1,95 +0,0 @@ - - -FetchTransactionsProtocol - r3prototyping - - - -r3prototyping / 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

- - - - - - - -
-queryTopic -val queryTopic: String
-

Inherited Properties

- - - - - - - - - - - -
-otherSide -val otherSide: SingleMessageRecipient
-requests -val requests: Set<SecureHash>
-

Functions

- - - - - - - -
-load -fun load(txid: SecureHash): SignedTransaction?
-

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/r3prototyping/protocols/-fetch-transactions-protocol/load.html b/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/load.html deleted file mode 100644 index 741844877c..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/load.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FetchTransactionsProtocol.load - r3prototyping - - - -r3prototyping / protocols / FetchTransactionsProtocol / load
-
-

load

- -protected fun load(txid: SecureHash): SignedTransaction?
-Overrides FetchDataProtocol.load
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/query-topic.html b/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/query-topic.html deleted file mode 100644 index 8a72f044b3..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-fetch-transactions-protocol/query-topic.html +++ /dev/null @@ -1,16 +0,0 @@ - - -FetchTransactionsProtocol.queryTopic - r3prototyping - - - -r3prototyping / protocols / FetchTransactionsProtocol / queryTopic
-
-

queryTopic

- -protected val queryTopic: String
-Overrides FetchDataProtocol.queryTopic
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/-init-.html b/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/-init-.html deleted file mode 100644 index 1b6d1e5c3d..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -ResolveTransactionsProtocol.ExcessivelyLargeTransactionGraph.<init> - r3prototyping - - - -r3prototyping / protocols / ResolveTransactionsProtocol / ExcessivelyLargeTransactionGraph / <init>
-
-

<init>

-ExcessivelyLargeTransactionGraph()
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/index.html b/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/index.html deleted file mode 100644 index 992d3f4124..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/-excessively-large-transaction-graph/index.html +++ /dev/null @@ -1,25 +0,0 @@ - - -ResolveTransactionsProtocol.ExcessivelyLargeTransactionGraph - r3prototyping - - - -r3prototyping / protocols / ResolveTransactionsProtocol / ExcessivelyLargeTransactionGraph
-
-

ExcessivelyLargeTransactionGraph

-class ExcessivelyLargeTransactionGraph : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -ExcessivelyLargeTransactionGraph()
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/-init-.html b/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/-init-.html deleted file mode 100644 index 258f9b2594..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/-init-.html +++ /dev/null @@ -1,28 +0,0 @@ - - -ResolveTransactionsProtocol.<init> - r3prototyping - - - -r3prototyping / 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/call.html b/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/call.html deleted file mode 100644 index ce49299626..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -ResolveTransactionsProtocol.call - r3prototyping - - - -r3prototyping / protocols / ResolveTransactionsProtocol / call
-
-

call

- -@Suspendable fun call(): Unit
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/index.html b/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/index.html deleted file mode 100644 index 86a04d5c60..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-resolve-transactions-protocol/index.html +++ /dev/null @@ -1,129 +0,0 @@ - - -ResolveTransactionsProtocol - r3prototyping - - - -r3prototyping / 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

- - - - - - - -
-ExcessivelyLargeTransactionGraph -class ExcessivelyLargeTransactionGraph : Exception
-

Constructors

- - - - - - - -
-<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.

-
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - -
-logger -val logger: Logger

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>
-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.

-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/-init-.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/-init-.html deleted file mode 100644 index 6d578cd1b8..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TimestampingProtocol.Client.<init> - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / Client / <init>
-
-

<init>

-Client(stateMachineManager: StateMachineManager, node: LegallyIdentifiableNode)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/identity.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/identity.html deleted file mode 100644 index 726cf4271f..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/identity.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampingProtocol.Client.identity - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / Client / identity
-
-

identity

- -val identity: Party
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/index.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/index.html deleted file mode 100644 index 48933ef9ae..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/index.html +++ /dev/null @@ -1,47 +0,0 @@ - - -TimestampingProtocol.Client - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / Client
-
-

Client

-class Client : TimestamperService
-
-
-

Constructors

- - - - - - - -
-<init> -Client(stateMachineManager: StateMachineManager, node: LegallyIdentifiableNode)
-

Properties

- - - - - - - -
-identity -val identity: Party
-

Functions

- - - - - - - -
-timestamp -fun timestamp(wtxBytes: SerializedBytes<WireTransaction>): LegallyIdentifiable
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/timestamp.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/timestamp.html deleted file mode 100644 index 74f690ca7c..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-client/timestamp.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampingProtocol.Client.timestamp - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / Client / timestamp
-
-

timestamp

- -fun timestamp(wtxBytes: SerializedBytes<WireTransaction>): LegallyIdentifiable
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-init-.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-init-.html deleted file mode 100644 index 6dff62eee8..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-init-.html +++ /dev/null @@ -1,22 +0,0 @@ - - -TimestampingProtocol.<init> - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / <init>
-
-

<init>

-TimestampingProtocol(node: LegallyIdentifiableNode, wtxBytes: SerializedBytes<WireTransaction>)
-

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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/-init-.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/-init-.html deleted file mode 100644 index b01a683dc8..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TimestampingProtocol.Request.<init> - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / Request / <init>
-
-

<init>

-Request(tx: SerializedBytes<WireTransaction>, replyTo: MessageRecipients, replyToTopic: String)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/index.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/index.html deleted file mode 100644 index 229a361d21..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/index.html +++ /dev/null @@ -1,48 +0,0 @@ - - -TimestampingProtocol.Request - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / Request
-
-

Request

-data class Request
-
-
-

Constructors

- - - - - - - -
-<init> -Request(tx: SerializedBytes<WireTransaction>, replyTo: MessageRecipients, replyToTopic: String)
-

Properties

- - - - - - - - - - - - - - - -
-replyTo -val replyTo: MessageRecipients
-replyToTopic -val replyToTopic: String
-tx -val tx: SerializedBytes<WireTransaction>
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/reply-to-topic.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/reply-to-topic.html deleted file mode 100644 index 1ba88d1ab1..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/reply-to-topic.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampingProtocol.Request.replyToTopic - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / Request / replyToTopic
-
-

replyToTopic

- -val replyToTopic: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/reply-to.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/reply-to.html deleted file mode 100644 index cfe01ac553..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/reply-to.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampingProtocol.Request.replyTo - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / Request / replyTo
-
-

replyTo

- -val replyTo: MessageRecipients
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/tx.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/tx.html deleted file mode 100644 index 22da2344f1..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/-request/tx.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TimestampingProtocol.Request.tx - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / Request / tx
-
-

tx

- -val tx: SerializedBytes<WireTransaction>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/call.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/call.html deleted file mode 100644 index cfc61caad5..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TimestampingProtocol.call - r3prototyping - - - -r3prototyping / protocols / TimestampingProtocol / call
-
-

call

- -@Suspendable fun call(): LegallyIdentifiable
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/index.html b/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/index.html deleted file mode 100644 index af1884d2ed..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-timestamping-protocol/index.html +++ /dev/null @@ -1,131 +0,0 @@ - - -TimestampingProtocol - r3prototyping - - - -r3prototyping / 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

- - - - - - - - - - - -
-Client -class Client : TimestamperService
-Request -data class Request
-

Constructors

- - - - - - - -
-<init> -TimestampingProtocol(node: LegallyIdentifiableNode, wtxBytes: SerializedBytes<WireTransaction>)

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.

-
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - -
-logger -val logger: Logger

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(): LegallyIdentifiable

This is where you fill out your business logic.

-
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - -
-receive -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 ProtocolLogics reference to the -ProtocolStateMachine and then calling the call method.

-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/-init-.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/-init-.html deleted file mode 100644 index 515371f160..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException.<init> - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / AssetMismatchException / <init>
-
-

<init>

-AssetMismatchException(expectedTypeName: String, typeName: String)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/expected-type-name.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/expected-type-name.html deleted file mode 100644 index 21665b7a64..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/expected-type-name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException.expectedTypeName - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / AssetMismatchException / expectedTypeName
-
-

expectedTypeName

- -val expectedTypeName: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/index.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/index.html deleted file mode 100644 index 2abefa82e5..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/index.html +++ /dev/null @@ -1,53 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / AssetMismatchException
-
-

AssetMismatchException

-class AssetMismatchException : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -AssetMismatchException(expectedTypeName: String, typeName: String)
-

Properties

- - - - - - - - - - - -
-expectedTypeName -val expectedTypeName: String
-typeName -val typeName: String
-

Functions

- - - - - - - -
-toString -fun toString(): String
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/to-string.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/to-string.html deleted file mode 100644 index 247835d56e..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/to-string.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException.toString - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / AssetMismatchException / toString
-
-

toString

- -fun toString(): String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/type-name.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/type-name.html deleted file mode 100644 index 15c56898fb..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-asset-mismatch-exception/type-name.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.AssetMismatchException.typeName - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / AssetMismatchException / typeName
-
-

typeName

- -val typeName: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-init-.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-init-.html deleted file mode 100644 index f871cb8d18..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.<init> - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / <init>
-
-

<init>

-Buyer(otherSide: SingleMessageRecipient, timestampingAuthority: Party, acceptablePrice: Amount, typeToBuy: Class<out OwnableState>, sessionID: Long)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-r-e-c-e-i-v-i-n-g.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-r-e-c-e-i-v-i-n-g.html deleted file mode 100644 index 0a377e6789..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-r-e-c-e-i-v-i-n-g.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.RECEIVING - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / RECEIVING
-
-

RECEIVING

-object RECEIVING : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-s-i-g-n-i-n-g.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-s-i-g-n-i-n-g.html deleted file mode 100644 index 27464a3d85..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-s-i-g-n-i-n-g.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.SIGNING - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / SIGNING
-
-

SIGNING

-object SIGNING : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/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/r3prototyping/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 deleted file mode 100644 index 5e9f4dbb98..0000000000 --- a/docs/build/html/api/r3prototyping/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 +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.SWAPPING_SIGNATURES - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / SWAPPING_SIGNATURES
-
-

SWAPPING_SIGNATURES

-object SWAPPING_SIGNATURES : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-v-e-r-i-f-y-i-n-g.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-v-e-r-i-f-y-i-n-g.html deleted file mode 100644 index e8ca8ba9e3..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/-v-e-r-i-f-y-i-n-g.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.VERIFYING - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / VERIFYING
-
-

VERIFYING

-object VERIFYING : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/acceptable-price.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/acceptable-price.html deleted file mode 100644 index ade747c815..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/acceptable-price.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.acceptablePrice - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / acceptablePrice
-
-

acceptablePrice

- -val acceptablePrice: Amount
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/call.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/call.html deleted file mode 100644 index 8564ad89e3..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.call - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / call
-
-

call

- -@Suspendable open fun call(): SignedTransaction
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/index.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/index.html deleted file mode 100644 index 4e204f2172..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/index.html +++ /dev/null @@ -1,168 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer
-
-

Buyer

-class Buyer : ProtocolLogic<SignedTransaction>
-
-
-

Types

- - - - - - - - - - - - - - - - - - - -
-RECEIVING -object RECEIVING : Step
-SIGNING -object SIGNING : Step
-SWAPPING_SIGNATURES -object SWAPPING_SIGNATURES : Step
-VERIFYING -object VERIFYING : Step
-

Constructors

- - - - - - - -
-<init> -Buyer(otherSide: SingleMessageRecipient, timestampingAuthority: Party, acceptablePrice: Amount, typeToBuy: Class<out OwnableState>, sessionID: Long)
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-acceptablePrice -val acceptablePrice: Amount
-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
-typeToBuy -val typeToBuy: Class<out OwnableState>
-

Inherited Properties

- - - - - - - - - - - - - - - -
-logger -val logger: Logger

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 -open fun call(): SignedTransaction

This is where you fill out your business logic.

-
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - -
-receive -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 ProtocolLogics reference to the -ProtocolStateMachine and then calling the call method.

-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/other-side.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/other-side.html deleted file mode 100644 index 043d60fdac..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/other-side.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.otherSide - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / otherSide
-
-

otherSide

- -val otherSide: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/progress-tracker.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/progress-tracker.html deleted file mode 100644 index 1bb8dabe8d..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/progress-tracker.html +++ /dev/null @@ -1,24 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.progressTracker - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / progressTracker
-
-

progressTracker

- -open val progressTracker: ProgressTracker
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/session-i-d.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/session-i-d.html deleted file mode 100644 index cd45f58b35..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/session-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.sessionID - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / sessionID
-
-

sessionID

- -val sessionID: Long
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/timestamping-authority.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/timestamping-authority.html deleted file mode 100644 index bab6a1782c..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/timestamping-authority.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.timestampingAuthority - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / timestampingAuthority
-
-

timestampingAuthority

- -val timestampingAuthority: Party
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/type-to-buy.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/type-to-buy.html deleted file mode 100644 index 4599192761..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-buyer/type-to-buy.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Buyer.typeToBuy - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Buyer / typeToBuy
-
-

typeToBuy

- -val typeToBuy: Class<out OwnableState>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/-init-.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/-init-.html deleted file mode 100644 index eeae0ef4cb..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.<init> - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SellerTradeInfo / <init>
-
-

<init>

-SellerTradeInfo(assetForSale: StateAndRef<OwnableState>, price: Amount, sellerOwnerKey: PublicKey, sessionID: Long)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/asset-for-sale.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/asset-for-sale.html deleted file mode 100644 index e65daa10bc..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/asset-for-sale.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.assetForSale - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SellerTradeInfo / assetForSale
-
-

assetForSale

- -val assetForSale: StateAndRef<OwnableState>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/index.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/index.html deleted file mode 100644 index 6ac4cc5640..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/index.html +++ /dev/null @@ -1,54 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SellerTradeInfo
-
-

SellerTradeInfo

-class SellerTradeInfo
-
-
-

Constructors

- - - - - - - -
-<init> -SellerTradeInfo(assetForSale: StateAndRef<OwnableState>, price: Amount, sellerOwnerKey: PublicKey, sessionID: Long)
-

Properties

- - - - - - - - - - - - - - - - - - - -
-assetForSale -val assetForSale: StateAndRef<OwnableState>
-price -val price: Amount
-sellerOwnerKey -val sellerOwnerKey: PublicKey
-sessionID -val sessionID: Long
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/price.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/price.html deleted file mode 100644 index 70fe0f0465..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/price.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.price - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SellerTradeInfo / price
-
-

price

- -val price: Amount
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/seller-owner-key.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/seller-owner-key.html deleted file mode 100644 index b29b315100..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/seller-owner-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.sellerOwnerKey - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SellerTradeInfo / sellerOwnerKey
-
-

sellerOwnerKey

- -val sellerOwnerKey: PublicKey
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/session-i-d.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/session-i-d.html deleted file mode 100644 index ffd0b241ce..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller-trade-info/session-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SellerTradeInfo.sessionID - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SellerTradeInfo / sessionID
-
-

sessionID

- -val sessionID: Long
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-a-w-a-i-t-i-n-g_-p-r-o-p-o-s-a-l.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-a-w-a-i-t-i-n-g_-p-r-o-p-o-s-a-l.html deleted file mode 100644 index aad4a88abc..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-a-w-a-i-t-i-n-g_-p-r-o-p-o-s-a-l.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.AWAITING_PROPOSAL - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / AWAITING_PROPOSAL
-
-

AWAITING_PROPOSAL

-object AWAITING_PROPOSAL : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-init-.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-init-.html deleted file mode 100644 index 8771e32ff8..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.<init> - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / <init>
-
-

<init>

-Seller(otherSide: SingleMessageRecipient, timestampingAuthority: LegallyIdentifiableNode, assetToSell: StateAndRef<OwnableState>, price: Amount, myKeyPair: KeyPair, buyerSessionID: Long, progressTracker: ProgressTracker = Seller.tracker())
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-s-e-n-d-i-n-g_-s-i-g-s.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-s-e-n-d-i-n-g_-s-i-g-s.html deleted file mode 100644 index 87857463c6..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-s-e-n-d-i-n-g_-s-i-g-s.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.SENDING_SIGS - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / SENDING_SIGS
-
-

SENDING_SIGS

-object SENDING_SIGS : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-s-i-g-n-i-n-g.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-s-i-g-n-i-n-g.html deleted file mode 100644 index 0e8540483e..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-s-i-g-n-i-n-g.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.SIGNING - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / SIGNING
-
-

SIGNING

-object SIGNING : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-t-i-m-e-s-t-a-m-p-i-n-g.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-t-i-m-e-s-t-a-m-p-i-n-g.html deleted file mode 100644 index 62b68d689e..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-t-i-m-e-s-t-a-m-p-i-n-g.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.TIMESTAMPING - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / TIMESTAMPING
-
-

TIMESTAMPING

-object TIMESTAMPING : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-v-e-r-i-f-y-i-n-g.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-v-e-r-i-f-y-i-n-g.html deleted file mode 100644 index a0392fde72..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/-v-e-r-i-f-y-i-n-g.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.VERIFYING - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / VERIFYING
-
-

VERIFYING

-object VERIFYING : Step
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/asset-to-sell.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/asset-to-sell.html deleted file mode 100644 index 966788a73f..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/asset-to-sell.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.assetToSell - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / assetToSell
-
-

assetToSell

- -val assetToSell: StateAndRef<OwnableState>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/buyer-session-i-d.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/buyer-session-i-d.html deleted file mode 100644 index 7d7475a20d..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/buyer-session-i-d.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.buyerSessionID - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / buyerSessionID
-
-

buyerSessionID

- -val buyerSessionID: Long
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/call.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/call.html deleted file mode 100644 index 69ce68a6a8..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/call.html +++ /dev/null @@ -1,17 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.call - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / call
-
-

call

- -@Suspendable open fun call(): SignedTransaction
-Overrides ProtocolLogic.call
-

This is where you fill out your business logic.

-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/index.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/index.html deleted file mode 100644 index c6bfc43ce4..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/index.html +++ /dev/null @@ -1,197 +0,0 @@ - - -TwoPartyTradeProtocol.Seller - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller
-
-

Seller

-class Seller : ProtocolLogic<SignedTransaction>
-
-
-

Types

- - - - - - - - - - - - - - - - - - - - - - - -
-AWAITING_PROPOSAL -object AWAITING_PROPOSAL : Step
-SENDING_SIGS -object SENDING_SIGS : Step
-SIGNING -object SIGNING : Step
-TIMESTAMPING -object TIMESTAMPING : Step
-VERIFYING -object VERIFYING : Step
-

Constructors

- - - - - - - -
-<init> -Seller(otherSide: SingleMessageRecipient, timestampingAuthority: LegallyIdentifiableNode, assetToSell: StateAndRef<OwnableState>, price: Amount, myKeyPair: KeyPair, buyerSessionID: Long, progressTracker: ProgressTracker = Seller.tracker())
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-assetToSell -val assetToSell: StateAndRef<OwnableState>
-buyerSessionID -val buyerSessionID: Long
-myKeyPair -val myKeyPair: KeyPair
-otherSide -val otherSide: SingleMessageRecipient
-price -val price: Amount
-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.

-
-timestampingAuthority -val timestampingAuthority: LegallyIdentifiableNode
-

Inherited Properties

- - - - - - - - - - - - - - - -
-logger -val logger: Logger

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 -open fun call(): SignedTransaction

This is where you fill out your business logic.

-
-signWithOurKey -open fun signWithOurKey(partialTX: SignedTransaction): WithKey
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - -
-receive -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 ProtocolLogics reference to the -ProtocolStateMachine and then calling the call method.

-
-

Companion Object Functions

- - - - - - - -
-tracker -fun tracker(): ProgressTracker
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/my-key-pair.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/my-key-pair.html deleted file mode 100644 index 17aa805c61..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/my-key-pair.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.myKeyPair - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / myKeyPair
-
-

myKeyPair

- -val myKeyPair: KeyPair
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/other-side.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/other-side.html deleted file mode 100644 index f885a78e17..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/other-side.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.otherSide - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / otherSide
-
-

otherSide

- -val otherSide: SingleMessageRecipient
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/price.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/price.html deleted file mode 100644 index e8856e9df5..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/price.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.price - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / price
-
-

price

- -val price: Amount
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/progress-tracker.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/progress-tracker.html deleted file mode 100644 index c35721fe10..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/progress-tracker.html +++ /dev/null @@ -1,24 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.progressTracker - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / progressTracker
-
-

progressTracker

- -open val progressTracker: ProgressTracker
-Overrides 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.

-
-
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/sign-with-our-key.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/sign-with-our-key.html deleted file mode 100644 index d4b4987fa5..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/sign-with-our-key.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.signWithOurKey - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / signWithOurKey
-
-

signWithOurKey

- -@Suspendable open fun signWithOurKey(partialTX: SignedTransaction): WithKey
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/timestamping-authority.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/timestamping-authority.html deleted file mode 100644 index 5e1d451ee9..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/timestamping-authority.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.timestampingAuthority - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / timestampingAuthority
-
-

timestampingAuthority

- -val timestampingAuthority: LegallyIdentifiableNode
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/tracker.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/tracker.html deleted file mode 100644 index 2c7672713f..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-seller/tracker.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.Seller.tracker - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / Seller / tracker
-
-

tracker

- -fun tracker(): ProgressTracker
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/-init-.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/-init-.html deleted file mode 100644 index 6c54c350f4..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.SignaturesFromSeller.<init> - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SignaturesFromSeller / <init>
-
-

<init>

-SignaturesFromSeller(timestampAuthoritySig: WithKey, sellerSig: WithKey)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/index.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/index.html deleted file mode 100644 index e8e75f64b3..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - -TwoPartyTradeProtocol.SignaturesFromSeller - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SignaturesFromSeller
-
-

SignaturesFromSeller

-class SignaturesFromSeller
-
-
-

Constructors

- - - - - - - -
-<init> -SignaturesFromSeller(timestampAuthoritySig: WithKey, sellerSig: WithKey)
-

Properties

- - - - - - - - - - - -
-sellerSig -val sellerSig: WithKey
-timestampAuthoritySig -val timestampAuthoritySig: WithKey
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/seller-sig.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/seller-sig.html deleted file mode 100644 index 4539df3083..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/seller-sig.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SignaturesFromSeller.sellerSig - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SignaturesFromSeller / sellerSig
-
-

sellerSig

- -val sellerSig: WithKey
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/timestamp-authority-sig.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/timestamp-authority-sig.html deleted file mode 100644 index 7b31156f9b..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-signatures-from-seller/timestamp-authority-sig.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.SignaturesFromSeller.timestampAuthoritySig - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / SignaturesFromSeller / timestampAuthoritySig
-
-

timestampAuthoritySig

- -val timestampAuthoritySig: WithKey
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-t-r-a-d-e_-t-o-p-i-c.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-t-r-a-d-e_-t-o-p-i-c.html deleted file mode 100644 index 4c37c0f188..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-t-r-a-d-e_-t-o-p-i-c.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.TRADE_TOPIC - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / TRADE_TOPIC
-
-

TRADE_TOPIC

- -val TRADE_TOPIC: String
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-unacceptable-price-exception/-init-.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-unacceptable-price-exception/-init-.html deleted file mode 100644 index 28d408777c..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-unacceptable-price-exception/-init-.html +++ /dev/null @@ -1,14 +0,0 @@ - - -TwoPartyTradeProtocol.UnacceptablePriceException.<init> - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / UnacceptablePriceException / <init>
-
-

<init>

-UnacceptablePriceException(givenPrice: Amount)
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-unacceptable-price-exception/given-price.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-unacceptable-price-exception/given-price.html deleted file mode 100644 index 28a644b9b9..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-unacceptable-price-exception/given-price.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.UnacceptablePriceException.givenPrice - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / UnacceptablePriceException / givenPrice
-
-

givenPrice

- -val givenPrice: Amount
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-unacceptable-price-exception/index.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-unacceptable-price-exception/index.html deleted file mode 100644 index 6b8b387618..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/-unacceptable-price-exception/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - -TwoPartyTradeProtocol.UnacceptablePriceException - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / UnacceptablePriceException
-
-

UnacceptablePriceException

-class UnacceptablePriceException : Exception
-
-
-

Constructors

- - - - - - - -
-<init> -UnacceptablePriceException(givenPrice: Amount)
-

Properties

- - - - - - - -
-givenPrice -val givenPrice: Amount
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/index.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/index.html deleted file mode 100644 index dc87a1986b..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/index.html +++ /dev/null @@ -1,106 +0,0 @@ - - -TwoPartyTradeProtocol - r3prototyping - - - -r3prototyping / 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:

-

  1. 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.

    -

  2. 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.

    -

  3. 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

- - - - - - - - - - - - - - - - - - - -
-Buyer -class Buyer : ProtocolLogic<SignedTransaction>
-Seller -class Seller : ProtocolLogic<SignedTransaction>
-SellerTradeInfo -class SellerTradeInfo
-SignaturesFromSeller -class SignaturesFromSeller
-

Exceptions

- - - - - - - - - - - -
-AssetMismatchException -class AssetMismatchException : Exception
-UnacceptablePriceException -class UnacceptablePriceException : Exception
-

Properties

- - - - - - - -
-TRADE_TOPIC -val TRADE_TOPIC: String
-

Functions

- - - - - - - - - - - -
-runBuyer -fun runBuyer(smm: StateMachineManager, timestampingAuthority: LegallyIdentifiableNode, otherSide: SingleMessageRecipient, acceptablePrice: Amount, typeToBuy: Class<out OwnableState>, sessionID: Long): ListenableFuture<SignedTransaction>
-runSeller -fun runSeller(smm: StateMachineManager, timestampingAuthority: LegallyIdentifiableNode, otherSide: SingleMessageRecipient, assetToSell: StateAndRef<OwnableState>, price: Amount, myKeyPair: KeyPair, buyerSessionID: Long): ListenableFuture<SignedTransaction>
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/run-buyer.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/run-buyer.html deleted file mode 100644 index 3480b8c3c0..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/run-buyer.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.runBuyer - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / runBuyer
-
-

runBuyer

- -fun runBuyer(smm: StateMachineManager, timestampingAuthority: LegallyIdentifiableNode, otherSide: SingleMessageRecipient, acceptablePrice: Amount, typeToBuy: Class<out OwnableState>, sessionID: Long): ListenableFuture<SignedTransaction>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/run-seller.html b/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/run-seller.html deleted file mode 100644 index f9016e8128..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/-two-party-trade-protocol/run-seller.html +++ /dev/null @@ -1,15 +0,0 @@ - - -TwoPartyTradeProtocol.runSeller - r3prototyping - - - -r3prototyping / protocols / TwoPartyTradeProtocol / runSeller
-
-

runSeller

- -fun runSeller(smm: StateMachineManager, timestampingAuthority: LegallyIdentifiableNode, otherSide: SingleMessageRecipient, assetToSell: StateAndRef<OwnableState>, price: Amount, myKeyPair: KeyPair, buyerSessionID: Long): ListenableFuture<SignedTransaction>
-
-
- - diff --git a/docs/build/html/api/r3prototyping/protocols/index.html b/docs/build/html/api/r3prototyping/protocols/index.html deleted file mode 100644 index 2aa2451c7d..0000000000 --- a/docs/build/html/api/r3prototyping/protocols/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - -protocols - r3prototyping - - - -r3prototyping / protocols
-
-

Package protocols

-

Types

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-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.

-
-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.

-
-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 deleted file mode 100644 index 0958623745..0000000000 --- a/docs/build/html/api/style.css +++ /dev/null @@ -1,280 +0,0 @@ -@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; - } -} diff --git a/docs/build/html/codestyle.html b/docs/build/html/codestyle.html index 576e189678..922fb8359f 100644 --- a/docs/build/html/codestyle.html +++ b/docs/build/html/codestyle.html @@ -31,7 +31,7 @@ - + @@ -97,11 +97,11 @@

Appendix

+
  • Writing oracle services +

    • Appendix

    • Using the visualiser
      • -
    • Roadmap
    • Code style guide
      • 1. General style
      • 2. Comments
        • diff --git a/docs/build/html/inthebox.html b/docs/build/html/inthebox.html index 7c206100dc..c939e830e6 100644 --- a/docs/build/html/inthebox.html +++ b/docs/build/html/inthebox.html @@ -102,11 +102,11 @@

        Appendix

        @@ -156,15 +156,16 @@

        What’s included?

        The current prototype consists of a small amount of code that defines:

          -
        • Key data structures
          • +
        • Key data structures.
        • Algorithms that work with them, such as serialising, hashing, signing, and verification of the signatures.
          • -
        • Three smart contracts that implement a notion of a cash claim, a basic commercial paper and a crowdfunding contract. -These are simplified versions of the real things.
          • +
        • Two smart contracts that implement a notion of a cash claim and basic commercial paper (implemented twice, in two +different programming languages). These are simplified versions of the real things.
        • Unit tests that check the algorithms do what is expected, and which verify the behaviour of the smart contracts.
        • API documentation and tutorials (what you’re reading)
          • -
        • A simple standalone node that uses an embedded message queue broker as its P2P messaging layer
          • +
        • A simple standalone node that uses an embedded message queue broker as its P2P messaging layer.
        • A trading demo that runs the node in either a listening/buying mode, or a connecting/selling mode, and swaps some -fake commercial paper assets for some self-issued IOU cash.
          • +fake commercial paper assets for some self-issued IOU cash, using a generic protocol framework. +
        • It also includes two oracles: one for precise timestamping and another for interest rate swaps.

        Some things it does not currently include but should gain later are:

          @@ -179,8 +180,9 @@ fake commercial paper assets for some self-issued IOU cash.

          The prototype’s goal is rapid exploration of ideas. Therefore in places it takes shortcuts that a production system would not in order to boost productivity:

            -
          • It uses a serialization framework instead of a well specified, vendor neutral protocol.
            • +
          • It uses an object graph serialization framework instead of a well specified, vendor neutral protocol.
          • It uses secp256r1, an obsolete elliptic curve.
            • +
          • It uses the default, out of the box Apache Artemis MQ protocol instead of AMQP/1.0 (although switching should be easy)

          Contracts

          diff --git a/docs/build/html/messaging.html b/docs/build/html/messaging.html index e9c2e27924..ba81329c90 100644 --- a/docs/build/html/messaging.html +++ b/docs/build/html/messaging.html @@ -103,11 +103,11 @@

          Appendix

          diff --git a/docs/build/html/node-administration.html b/docs/build/html/node-administration.html index 382edc6a82..3868ce0b98 100644 --- a/docs/build/html/node-administration.html +++ b/docs/build/html/node-administration.html @@ -93,7 +93,9 @@
        • Networking and messaging
        • Running the trading demo
        • Node administration
        @@ -101,11 +103,11 @@

        Appendix

        @@ -155,21 +157,47 @@

        Node administration

        When a node is running, it exposes an embedded web server that lets you monitor it, upload and download attachments, access a REST API and so on.

        +
        +

        Monitoring your node

        +

        Like most Java servers, the node exports various useful metrics and management operations via the industry-standard +JMX infrastructure. JMX is a standard _in-process_ API +for registering so-called _MBeans_ ... objects whose properties and methods are intended for server management. It does +not require any particular network protocol for export. So this data can be exported from the node in various ways: +some monitoring systems provide a “Java Agent”, which is essentially a JVM plugin that finds all the MBeans and sends +them out to a statistics collector over the network. For those systems, follow the instructions provided by the vendor.

        +

        Sometimes though, you just want raw access to the data and operations itself. So nodes export them over HTTP on the +/monitoring/json HTTP endpoint, using a program called Jolokia. Jolokia defines the JSON +and REST formats for accessing MBeans, and provides client libraries to work with that protocol as well.

        +

        Here are a few ways to build dashboards and extract monitoring data for a node:

        +
          +
        • JMX2Graphite is a tool that can be pointed to /monitoring/json and will +scrape the statistics found there, then insert them into the Graphite monitoring tool on a regular basis. It runs +in Docker and can be started with a single command.
          • +
        • JMXTrans is another tool for Graphite, this time, it’s got its own agent +(JVM plugin) which reads a custom config file and exports only the named data. It’s more configurable than +JMX2Graphite and doesn’t require a separate process, as the JVM will write directly to Graphite.
          • +
        • Java Mission Control is a desktop app that can connect to a target JVM that has the right command line flags set +(or always, if running locally). You can explore what data is available, create graphs of those metrics, and invoke +management operations like forcing a garbage collection.
          • +
        • Cloud metrics services like New Relic also understand JMX, typically, by providing their own agent that uploads the +data to their service on a regular schedule.
          • +
        +

        Uploading and downloading attachments

        Attachments are files that add context to and influence the behaviour of transactions. They are always identified by hash and they are public, in that they propagate through the network to wherever they are needed.

        All attachments are zip files. Thus to upload a file to the ledger you must first wrap it into a zip (or jar) file. Then you can upload it by running this command from a UNIX terminal:

        -
        curl -F myfile=@path/to/my/file.zip http://localhost:31338/attachments/upload
+
        curl -F myfile=@path/to/my/file.zip http://localhost:31338/upload/attachment
 
        
 
        
 
        The attachment will be identified by the SHA-256 hash of the contents, which you can get by doing:
        
 
        shasum -a 256 file.zip
 
        
 
        
-
        on a Mac or by using sha256sum on Linux. Alternatively, check the node logs. There is presently no way to manage
-attachments from a GUI.
        
+
        on a Mac or by using sha256sum on Linux. Alternatively, the hash will be returned to you when you upload the
+attachment.
        
 
        An attachment may be downloaded by fetching:
        
 
        http://localhost:31338/attachments/DECD098666B9657314870E192CED0C3519C2C9D395507A238338F8D003929DE9
 
        
@@ -180,6 +208,27 @@ containers, you can also fetch a specific file within the attachment by appendin
        +
        +

        Uploading interest rate fixes

        +

        If you would like to operate an interest rate fixing service (oracle), you can upload fix data by uploading data in +a simple text format to the /upload/interest-rates path on the web server.

        +

        The file looks like this:

        +
        # Some pretend noddy rate fixes, for the interest rate oracles.
+
+LIBOR 2016-03-16 30 = 0.678
+LIBOR 2016-03-16 60 = 0.655
+EURIBOR 2016-03-15 30 = 0.123
+EURIBOR 2016-03-15 60 = 0.111
+
        +
        +

        The columns are:

        +
          +
        • Name of the fix
          • +
        • Date of the fix
          • +
        • The tenor / time to maturity in days
          • +
        • The interest rate itself
          • +
        +
    diff --git a/docs/build/html/oracles.html b/docs/build/html/oracles.html new file mode 100644 index 0000000000..1ba22c9779 --- /dev/null +++ b/docs/build/html/oracles.html @@ -0,0 +1,388 @@ + + + + + + + + + + + Writing oracle services — R3 Prototyping latest documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + +
    + + + + + + +
    +
    + + + + + + +
    + +
    +
    +
    +
    + + +
    +

    Writing oracle services

    +

    This article covers oracles: network services that link the ledger to the outside world by providing facts that +affect the validity of transactions.

    +

    The current prototype includes two oracles:

    +
      +
    1. A timestamping service
      2. +
    2. An interest rate fixing service
      3. +
    +

    We will examine the similarities and differences in their design, whilst covering how the oracle concept works.

    +
    +

    Introduction

    +

    Oracles are a key concept in the block chain/decentralised ledger space. They can be essential for many kinds of +application, because we often wish to condition a transaction on some fact being true or false, but the ledger itself +has a design that is essentially functional: all transactions are pure and immutable. Phrased another way, a +smart contract cannot perform any input/output or depend on any state outside of the transaction itself. There is no +way to download a web page or interact with the user, in a smart contract. It must be this way because everyone must +be able to independently check a transaction and arrive at an identical conclusion for the ledger to maintan its +integrity: if a transaction could evaluate to “valid” on one computer and then “invalid” a few minutes later on a +different computer, the entire shared ledger concept wouldn’t work.

    +

    But it is often essential that transactions do depend on data from the outside world, for example, verifying that an +interest rate swap is paying out correctly may require data on interest rates, verifying that a loan has reached +maturity requires knowledge about the current time, knowing which side of a bet receives the payment may require +arbitrary facts about the real world (e.g. the bankruptcy or solvency of a company or country) ... and so on.

    +

    We can solve this problem by introducing services that create digitally signed data structures which assert facts. +These structures can then be used as an input to a transaction and distributed with the transaction data itself. Because +the statements are themselves immutable and signed, it is impossible for an oracle to change its mind later and +invalidate transactions that were previously found to be valid. In contrast, consider what would happen if a contract +could do an HTTP request: it’s possible that an answer would change after being downloaded, resulting in loss of +consensus (breaks).

    +
    +
    +

    The two basic approaches

    +

    The architecture provides two ways of implementing oracles with different tradeoffs:

    +
      +
    1. Using commands
      2. +
    2. Using attachments
      3. +
    +

    When a fact is encoded in a command, it is embedded in the transaction itself. The oracle then acts as a co-signer to +the entire transaction. The oracle’s signature is valid only for that transaction, and thus even if a fact (like a +stock price) does not change, every transaction that incorporates that fact must go back to the oracle for signing.

    +

    When a fact is encoded as an attachment, it is a separate object to the transaction which is referred to by hash. +Nodes download attachments from peers at the same time as they download transactions, unless of course the node has +already seen that attachment, in which case it won’t fetch it again. Contracts have access to the contents of +attachments and attachments can be digitally signed (in future).

    +

    As you can see, both approaches share a few things: they both allow arbitrary binary data to be provided to transactions +(and thus contracts). The primary difference is whether the data is a freely reusable, standalone object or whether it’s +integrated with a transaction.

    +

    Here’s a quick way to decide which approach makes more sense for your data source:

    +
      +
    • Is your data continuously changing, like a stock price, the current time, etc? If yes, use a command.
      • +
    • Is your data commercially valuable, like a feed which you are not allowed to resell unless it’s incorporated into +a business deal? If yes, use a command, so you can charge money for signing the same fact in each unique business +context.
      • +
    • Is your data very small, like a single number? If yes, use a command.
      • +
    • Is your data large, static and commercially worthless, for instance, a holiday calendar? If yes, use an +attachment.
      • +
    • Is your data intended for human consumption, like a PDF of legal prose, or an Excel spreadsheet? If yes, use an +attachment.
      • +
    +
    +
    +

    Asserting continuously varying data that is publicly known

    +

    Let’s look at the timestamping oracle that can be found in the TimestamperService class. This is an example of +an oracle that uses a command because the current time is a constantly changing fact that everybody knows.

    +

    The most obvious way to implement such a service would be:

    +
      +
    1. The creator of the transaction that depends on the time reads their local clock
      2. +
    2. They insert a command with that time into the transaction
      3. +
    3. They then send it to the oracle for signing.
      4. +
    +

    But this approach has a problem. There will never be exact clock synchronisation between the party creating the +transaction and the oracle. This is not only due to physics, network latencies etc but because between inserting the +command and getting the oracle to sign there may be many other steps, like sending the transaction to other parties +involved in the trade as well, or even requesting human signoff. Thus the time observed by the oracle may be quite +different to the time observed in step 1. This problem can occur any time an oracle attests to a constantly changing +value.

    +
    +

    Note

    +

    It is assumed that “true time” for a timestamping oracle means GPS/NaviStar time as defined by the atomic +clocks at the US Naval Observatory. This time feed is extremely accurate and available globally for free.

    +
    +

    We fix it by including explicit tolerances in the command, which is defined like this:

    +
    data class TimestampCommand(val after: Instant?, val before: Instant?) : CommandData
+    init {
+        if (after == null && before == null)
+            throw IllegalArgumentException("At least one of before/after must be specified")
+        if (after != null && before != null)
+            check(after <= before)
+    }
+}
+
    +
    +

    This defines a class that has two optional fields: before and after, along with a constructor that imposes a couple +more constraints that cannot be expressed in the type system, namely, that “after” actually is temporally after +“before”, and that at least one bound must be present. A timestamp command that doesn’t contain anything is illegal.

    +

    Thus we express that the true value of the fact “the current time” is actually unknowable. Even when both before and +after times are included, the transaction could have occurred at any point between those two timestamps. In this case +“occurrence” could mean the execution date, the value date, the trade date etc ... the oracle doesn’t care what precise +meaning the timestamp has to the contract.

    +

    By creating a range that can be either closed or open at one end, we allow all of the following facts to be modelled:

    +
      +
    • This transaction occurred at some point after the given time (e.g. after a maturity event)
      • +
    • This transaction occurred at any time before the given time (e.g. before a bankruptcy event)
      • +
    • This transaction occurred at some point roughly around the given time (e.g. on a specific day)
      • +
    +

    This same technique can be adapted to other types of oracle.

    +
    +
    +

    Asserting occasionally varying data that is not publicly known

    +

    Sometimes you may want a fact that changes, but is not entirely continuous. Additionally the exact value may not be +public, or may only be semi-public (e.g. easily available to some entities on the network but not all). An example of +this would be a LIBOR interest rate fix.

    +

    In this case, the following design can be used. The oracle service provides a query API which returns the current value, +and a signing service that signs a transaction if the data in the command matches the answer being returned by the +query API. Probably the query response contains some sort of timestamp as well, so the service can recognise values +that were true in the past but no longer are (this is arguably a part of the fact being asserted).

    +

    Because the signature covers the transaction, and transactions may end up being forwarded anywhere, the fact itself +is independently checkable. However, this approach can be useful when the data itself costs money, because the act +of issuing the signature in the first place can be charged for (e.g. by requiring the submission of a fresh +Cash.State that has been re-assigned to a key owned by the oracle service). Because the signature covers the +transaction and not only the fact, this allows for a kind of weak pseudo-DRM over data feeds. Whilst a smart +contract could in theory include a transaction parsing and signature checking library, writing a contract in this way +would be conclusive evidence of intent to disobey the rules of the service (res ipsa loquitur). In an environment +where parties are legally identifiable, usage of such a contract would by itself be sufficient to trigger some sort of +punishment.

    +

    Here is an extract from the NodeService.Oracle class and supporting types:

    +
    /** A [FixOf] identifies the question side of a fix: what day, tenor and type of fix ("LIBOR", "EURIBOR" etc) */
+data class FixOf(val name: String, val forDay: LocalDate, val ofTenor: Duration)
+
+/** A [Fix] represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx. */
+data class Fix(val of: FixOf, val value: BigDecimal) : CommandData
+
+class Oracle {
+    fun query(queries: List<FixOf>): List<Fix>
+
+    fun sign(wtx: WireTransaction): DigitalSignature.LegallyIdentifiable
+}
+
    +
    +

    Because the fix contains a timestamp (the forDay field), there can be an arbitrary delay between a fix being +requested via query and the signature being requested via sign.

    +
    +
    +

    Implementing oracles in the framework

    +

    Implementation involves the following steps:

    +
      +
    1. Defining a high level oracle class, that exposes the basic API operations.
      2. +
    2. Defining a lower level service class, that binds network messages to the API.
      3. +
    3. Defining a protocol using the Protocol state machines framework to make it easy for a client to interact +with the oracle.
      4. +
    +

    An example of how to do this can be found in the NodeInterestRates.Oracle, NodeInterestRates.Service and +RateFixProtocol classes. The exact details of how this code works will change in future, so for now consulting +the protocols tutorial and the code for the server-side oracles implementation will have to suffice. There will be more +detail added once the platform APIs have settled down.

    +

    Currently, there’s no network map service, so the location and identity keys of an oracle must be distributed out of +band.

    +
    +
    + + +
    +
    + + +
    +
    + +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/protocol-state-machines.html b/docs/build/html/protocol-state-machines.html index 156cb2f435..d7cbc5c7b4 100644 --- a/docs/build/html/protocol-state-machines.html +++ b/docs/build/html/protocol-state-machines.html @@ -31,7 +31,7 @@ - + @@ -108,11 +108,11 @@
  • Progress tracking
    • +
  • Writing oracle services

    • Appendix

    @@ -690,7 +690,7 @@ surfaced to human operators for investigation and resolution.