Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
M10 change log
  • Loading branch information
Patrick Kuo committed Apr 5, 2017
commit e7f040ffff17cf5e3993ee0d82e59ea52c891c96
67 changes: 57 additions & 10 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,65 @@ Here are brief summaries of what's changed between each snapshot release.
Milestone 10.0
--------------

API changes:

* The new Jackson module provides JSON/YAML serialisers for common Corda datatypes. If you have previously been
using the JSON support in the standalone web server, please be aware that amounts are now serialised as strings
instead of { quantity, token } pairs as before. The old format is still accepted, but new JSON will be produced
using strings like "1000.00 USD" when writing. You can use any format supported by ``Amount.parseCurrency``
as input.
.. warning:: Due to incompatibility between older version of IntelliJ and gradle 3.4, you will need to upgrade Intellij to 2017.1 and kotlin-plugin to 1.1.1 in order to run Corda demos in IntelliJ.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we quickly talk about how this is done - specifically link to IntelliJ downloads, and unless I'm mistaken the plugin version is the default for the latest download, so there's hopefully no manual work required to update the plugin?

Also, the Kapt generated model are no longer included in our codebase, please run ``kaptKotlin`` gradle task if you experience problem with ``Model`` class when building in IntelliJ.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specify the command to run:
"please run ./gradlew kaptKotlin if you ..."


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to provide some really clear instructions here (with a visual link to what to click in IntelliJ) as people will undoubtedly trip up.

Kapt is used to generate schema model and entity code (from annotations in the codebase) using the Kotlin Annotation processor. If the gradle KaptKotlin task is not run, then IntelliJ will report loads of unresolved references to Entities (and their attributes) and Models in any Kotlin source file that reference these.
The solution is to explicitly run the gradle kaptKotlin task, either on the command line or via the gradle run configuration in IntelliJ (see screen shot attached). Alternatively, perform a full gradle build or install.

screen shot 2017-04-05 at 15 44 11

* Dependencies changes:
* Upgraded Kotlin to v1.1.1.
* Upgraded Gradle to v3.4.1.
* Upgraded Requery to v1.2.1.
* Upgraded H2 to v1.4.194.
* Replaced kotlinx-support-jdk8 with kotlin-stdlib-jre8.

* API changes:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These points are v technical. Please remember to add the "so what?" info, i.e. why are these changes worthwhile, ideally with a business spin. Move technical changes beneath Vault and DemoBench

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think its ok to be a bit technical in change log? The less technical more businessy stuff is in the release-notes.rst

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that's why we split them - changelog is for developers who are upgrading their apps, release notes is for everyone else who is interested but not working with the platform every day.

* The new Jackson module provides JSON/YAML serialisers for common Corda datatypes.
If you have previously been using the JSON support in the standalone web server,
please be aware that amounts are now serialised as strings instead of { quantity, token } pairs as before.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amounts

The old format is still accepted, but new JSON will be produced using strings like "1000.00 USD" when writing.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but the new

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The last bit of the sentence doesn't make sense to me. What does writing mean here?

You can use any format supported by ``Amount.parseCurrency`` as input.

* We have restructured client package in this milestone.
* ``CordaClientRPC`` is now in the new ``:client:rpc`` module.
* The old ``:client`` module has been broken into ``:client:jfx`` and ``:client:mock``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

has been split up

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or "split into"

* We also have a new ``:node-api`` module (package ``net.corda.nodeapi``) which contains the common RPC classes such as ``RPCException`` and ``User``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit misleading, the node-api module basically contains shared code between node and node clients


* Configuration:
* Replace ``artemisPort`` with ``p2pPort`` in Gradle configuration
* Replace ``artemisAddress`` with ``p2pAddress`` in node configuration
* Added ``rpcAddress`` in node configuration
* Replace ``artemisPort`` with ``p2pPort`` in Gradle configuration.
* Replace ``artemisAddress`` with ``p2pAddress`` in node configuration.
* Added ``rpcAddress`` in node configuration for non-ssl RPC connection.

* Object Serialization:
* Pool Kryo instances for efficiency.

* RPC client changes:
* Added a non-ssl connector to artemis broker for non-ssl RPC connection.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps say something a like:
RPC clients can now connect to the node without the need for SSL. This requires a separate port on the Artemis broker. CordaRPCClient now needs to connect to rpcAddress rather than p2pAddress.

CordaRPCClient can only connect to ``rpcAddress``, please make sure ``rpcAddress`` is configured in the node.

* Vault:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move to 2nd in release notes, after DemoBench

* Soft Locking is a new feature implemented in the vault which prevents a node constructing transactions that attempt to use the same input(s) simultaneously.
* Such transactions would result in naturally wasted work when the notary rejects them as double spend attempts.
* Soft locks are automatically applied to coin selection (eg. cash spending) to ensure that no two transactions attempt to spend the same fungible states.

* Corda Demobench:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please move to top of the release notes

* DemoBench is a new tool to make configure and launch local Corda nodes easier. A very useful tool to demonstrate to your colleagues the fundamentals of Corda in real-time. It has the following features:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrase: "DemoBench is a new tool to make it easy to configure and launch local Corda nodes."

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"to make configuring and launching local Corda nodes easier"

* New nodes can be added at the click of a button. Clicking "Add node" creates a new tab that lets you edit the most important configuration properties of the node before launch, such as its legal name and which Cordapps will be loaded.
* Each tab contains a terminal emulator, attached to the pty of the node. This lets you see console output.
* You can launch an Explorer instance for each node at the click of a button. Credentials are handed to the Explorer so it starts out logged in already.
Copy link

@GavT GavT Apr 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"at the click of a button" is repetitive. "Credentials..." is too wordy. Remove it

* Some basic statistics are shown about each node, informed via the RPC connection.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which statistics? Informed via the RPC connection - what does this mean in basic terms and why is it noteworthy?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chrisr3 can you help address this? As you are the original author.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The statistics I had in mind were the node's cash balance and the number of transactions. Maybe drop the part about the RPC connection.

* Another button launches a database viewer in the system browser.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that... what? Why is that useful?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chrisr3 same here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you can run SQL against the node's database?

* The configurations of all running nodes can be saved into a single ``.profile`` file that can be reloaded later.
* You can download Corda demobench from `here <https://www.corda.net/downloads/>`_

* Improvements:
* Added ``--version`` command line flag to print the version of the node.
* Flows written in Java can now execute a sub-flow inside ``UntrustworthyData.unwrap``.
* Added additional JUnit tests for coin selection by issuer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in the release notes?


* Bug fixes:
* ``--logging-level`` command line flag was previously broken, now correctly sets the logging level.
* Fixed bug whereby Cash Exit was not taking into account the issuer reference.



Milestone 9.1
-------------
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ Welcome to the Corda documentation!
===================================

.. warning:: This build of the docs is from the "|version|" branch, not a milestone release. It may not reflect the
current state of the code. `Read the docs for milestone release M9.2 <https://docs.corda.net/releases/release-M9.2/>`_.
current state of the code. `Read the docs for milestone release M10.0 <https://docs.corda.net/releases/release-M10.0/>`_.

`Corda <https://www.corda.net/>`_ is an open-source distributed ledger platform. The latest *milestone* (i.e. stable)
release is M9.2. The codebase is on `GitHub <https://github.com/corda>`_, and our community can be found on
release is M10.0. The codebase is on `GitHub <https://github.com/corda>`_, and our community can be found on
`Slack <https://slack.corda.net/>`_ and in our `forum <https://discourse.corda.net/>`_.

If you're new to Corda, you should start by learning about its motivating vision and architecture. A good introduction
Expand Down
7 changes: 6 additions & 1 deletion docs/source/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,25 @@ the previous milestone release.
Milestone 10
------------

Copy link

@josecoll josecoll Apr 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No mention of Soft Locking?
Refer to the soft-locking.rst for a good description (including usage and sample use case scenarios).

We have delivered the long waited Kotlin 1.1 upgrade in M10! The new features in Kotlin allow us to write even more clean and easy to manage code, which greatly increase our productivity.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

increases (I had to think about this but I'm pretty sure the "which greatly increase our productivity" is bound to the "to write even more..." phrase... )

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also: is this the most important thing? not demo bench? not shell? not soft-locking?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not the most important thing, but definitely one of the most painful thing in last sprint :(, will move it down the line.

We have also introduced a new demobench and Corda shell to make running and demoing Corda easier for the corda community.

A new interactive **Corda Shell** has been added to the node. The shell lets developers and node administrators
easily command the node by running flows, RPCs and SQL queries. It also provides a variety of commands to monitor
the node. The Corda Shell is based on the popular `CRaSH project <http://www.crashub.org/>`_ and new commands can
be easily added to the node by simply dropping Groovy or Java files into the node's ``shell-commands`` directory.
We have many enhancements planned over time including SSH access, more commands and better tab completion.

There is a new tool "DemoBench", which makes it easy to configure and launch local Corda nodes. It is a standalone desktop app that can be bundled with its own JRE and packaged as either EXE (Windows), DMG (MacOS) or RPM (Linux-based). It has the following features:
The new "DemoBench" makes it easy to configure and launch local Corda nodes. It is a standalone desktop app that can be bundled with its own JRE and packaged as either EXE (Windows), DMG (MacOS) or RPM (Linux-based). It has the following features:
#. New nodes can be added at the click of a button. Clicking "Add node" creates a new tab that lets you edit the most important configuration properties of the node before launch, such as its legal name and which Cordapps will be loaded.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CorDapps

#. Each tab contains a terminal emulator, attached to the pty of the node. This lets you see console output.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pty? Think of the poor reader...!!

#. You can launch an Explorer instance for each node at the click of a button. Credentials are handed to the Explorer so it starts out logged in already.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a Corda Explorer (avoid ambiguity with the Windows Explorer?)

#. Some basic statistics are shown about each node, informed via the RPC connection.
#. Another button launches a database viewer in the system browser.
#. The configurations of all running nodes can be saved into a single ``.profile`` file that can be reloaded later.

This release contains tons of improvements, new features, library upgrades and bug fixes. For a full list of changes please see :doc:`change-log`.

Milestone 9
-----------

Expand Down