corda/docs/source/upgrade-notes.rst

Upgrading a CorDapp to a new platform version

These notes provide instructions for upgrading your CorDapps from previous versions of Corda to version .

Upgrading from Corda Open Source

A prerequisite to upgrade to is to ensure your CorDapp is upgraded to Open Source Corda 3.x. Please follow the instructions in Corda V3.1 upgrade notes and Corda V3.0 upgrade notes section to complete this initial step.

Note

There is no requirement to upgrade your CorDapp to Corda Enterprise in order to run it on Corda Enterprise. If you wish your CorDapp to be compatible with nodes running Open Source, then compiling against Open Source Corda V3.x will suffice.

Upgrading to from Open Source 3.x requires updating build file properties. For Gradle:

<<<<<<< HEAD

ext.corda_release_distribution = 'com.r3.corda' ext.corda_release_version = '3.1' ext.corda_gradle_plugins_version = '4.0.25'

=======

ext.kotlin_version = '1.1.4' ext.quasar_version = '0.7.9'

Please consult the relevant release notes of the release in question. If not specified, you may assume the versions you are currently using are still in force.

We also strongly recommend cross referencing with the changelog to confirm changes.

UNRELEASED

<<< Fill this in >>>

* Database upgrade - Change the type of the checkpoint_value. This will address the issue that the vacuum function is unable to clean up deleted checkpoints as they are still referenced from the pg_shdepend table.

For Postgres:

ALTER TABLE node_checkpoints ALTER COLUMN checkpoint_value set data type bytea;

For H2:

ALTER TABLE node_checkpoints ALTER COLUMN checkpoint_value set data type VARBINARY(33554432);

* API change: net.corda.core.schemas.PersistentStateRef fields (index and txId) incorrectly marked as nullable are now non-nullable,

changelog contains the explanation.

H2 database upgrade action:

For Cordapps persisting custom entities with PersistentStateRef used as non Primary Key column, the backing table needs to be updated, In SQL replace your_transaction_id/your_output_index column names with your custom names, if entity didn't used JPA @AttributeOverrides then default names are transaction_id and output_index.

SELECT count(*) FROM [YOUR_PersistentState_TABLE_NAME] WHERE your_transaction_id IS NULL OR your_output_index IS NULL;

In case your table already contains rows with NULL columns, and the logic doesn't distinguish between NULL and an empty string, all NULL column occurrences can be changed to an empty string:

UPDATE [YOUR_PersistentState_TABLE_NAME] SET your_transaction_id="" WHERE your_transaction_id IS NULL;
UPDATE [YOUR_PersistentState_TABLE_NAME] SET your_output_index="" WHERE your_output_index IS NULL;

If all rows have NON NULL transaction_ids and output_idx or you have assigned empty string values, then it's safe to update the table:

>>>>>>> 121dbec877

and specifying an additional repository entry to point to the location of the Corda Enterprise distribution. As an example:

repositories {
    maven {
        credentials {
            username "username"
            password "XXXXX"
        }
        url 'https://artifactory.mycompany.com/artifactory/corda-enterprise'
    }
}

Note

binaries are not available in a public repository. In order to make the dependencies available for development, either create a mirror repository and upload them there, or add them to the local Maven repository.

Note

While the Corda Gradle Plugins need no changes apart from the version, ensure that Corda Enterprise dependencies are referenced with the right distribution. As an example:

cordaCompile "net.corda:corda-core:$corda_release_version"

becomes:

cordaCompile "$corda_release_distribution:corda-core:$corda_release_version"

uses Kotlin API and language version 1.2. The specifics are

ext.kotlin_version = '1.2.50'

Note

Explicit overriding of properties ext.quasar_group and ext.quasar_version is not necessary anymore for CorDapps depending on the quasar-utils plugin. You can remove these two lines from which ever file.

Certificate Revocation List (CRL) support

The newly added feature of certificate revocation (see certificate-revocation) introduces a few changes to the node configuration. In the configuration file it is required to explicitly specify how strictly the node should apply the CRL check. For that purpose the crlCheckSoftFail parameter is now expected to be set explicitly in the node's SSL configuration. Setting the crlCheckSoftFail to true, relaxes the CRL checking policy. In this mode, the SSL communication will fail only when the certificate revocation status can be checked and the certificate is revoked. Otherwise it will succeed. If crlCheckSoftFail is false, then an SSL failure can occur if the certificate revocation status cannot be checked (e.g. due to a network failure), as well as when a certificate is revoked.

Older versions of Corda do not have CRL distribution points embedded in the SSL certificates. As such, in order to be able to reuse node and SSL certificates generated in those versions of Corda, the crlCheckSoftFail needs to be set to true.

Note

Mitigation of this issue and thus being able to use the strict mode (i.e. with crlCheckSoftFail = false) of the CRL checking with the certificates generated in previous versions of Corda is going to be added in the near future.

Upgrading from Corda Enterprise 3.0 Developer Preview 3.0

A limited distribution preview of was made available to a small number of users. If your app uses this version, here are some specific notes on how to upgrade to the Generally Available release:

• Update versions in your build files, for Gradle, as an example:

  ext.corda_release_version = '3.1'
  ext.corda_gradle_plugins_version = '4.0.25'
  ext.kotlin_version = '1.2.50'

  Note

  Explicit overriding of properties ext.quasar_group and ext.quasar_version is not necessary anymore for CorDapps depending on the quasar-utils plugin. You can remove these two lines from which ever file.

• For CorDapps depending on the cordapp-plugin, version 4.0.25 allows specifying distribution information. As an example:

  Note

  Properties name and version of a CorDapp's distribution information are derived automatically by the cordapp-plugin if not provided. The vendor property should be provided explicitly. A warning is raised by Corda Enterprise nodes for CorDapps that do not specify the vendor property.

Certificate Revocation List (CRL) support

The newly added feature of certificate revocation (see certificate-revocation) introduces a few changes to the node configuration. In the configuration file it is required to explicitly specify how strictly the node should apply the CRL check. For that purpose the crlCheckSoftFail parameter is now expected to be set explicitly in the node's SSL configuration. Setting the crlCheckSoftFail to true, relaxes the CRL checking policy. In this mode, the SSL communication will fail only when the certificate revocation status can be checked and the certificate is revoked. Otherwise it will succeed. If crlCheckSoftFail is false, then an SSL failure can occur if the certificate revocation status cannot be checked (e.g. due to a network failure), as well as when a certificate is revoked.

Older versions of Corda do not have CRL distribution points embedded in the SSL certificates. As such, in order to be able to reuse node and SSL certificates generated in those versions of Corda, the crlCheckSoftFail needs to be set to true.

Note

Mitigation of this issue and thus being able to use the strict mode (i.e. with crlCheckSoftFail = false) of the CRL checking with the certificates generated in previous versions of Corda is going to be added in the near future.