Merge branch 'main' into release

MrMatthewLayton · MrMatthewLayton · commit eb733276db96 · 2021-08-12T21:41:31.000+01:00
diff --git a/.idea/runConfigurations/Release__Local_.xml b/.idea/runConfigurations/Release__Local_.xml
diff --git a/.idea/runConfigurations/Release__Public_.xml b/.idea/runConfigurations/Release__Public_.xml
diff --git a/.idea/runConfigurations/Run_Contract_Tests.xml b/.idea/runConfigurations/Run_Contract_Tests.xml
diff --git a/.idea/runConfigurations/Run_Workflow_Tests.xml b/.idea/runConfigurations/Run_Workflow_Tests.xml
diff --git a/build.gradle b/build.gradle
@@ -40,8 +40,8 @@ buildscript {
     }
 }
 
-group 'io.onixlabs'
-version '2.1.2'
+group getProperty('group')
+version getProperty('version')
 
 subprojects {
     repositories {
@@ -73,6 +73,11 @@ subprojects {
         }
     }
 
+    task sourceJar(type: Jar) {
+        from sourceSets.main.allSource
+        archiveClassifier = "sources"
+    }
+
     jar {
         exclude '**/log4j2*.xml'
     }
diff --git a/docs/CHANGELOG-2.1.2.md b/docs/CHANGELOG-2.1.2.md
@@ -50,4 +50,3 @@ In this version the property is declared using the `open` modifier, allowing der
 
 ---
 
-### 
diff --git a/docs/CHANGELOG-3.0.0.md b/docs/CHANGELOG-3.0.0.md
@@ -0,0 +1,51 @@
+![ONIX Labs](https://raw.githubusercontent.com/onix-labs/onix-labs.github.io/master/content/logo/master_full_md.png)
+
+# Change Log - Version 3.0.0
+
+This document serves as the change log for the ONIXLabs Corda Core API.
+
+## Release Notes
+
+This release publishes source code along with the compiled dependencies, enabling developers debug into the ONIXLabs APIs and understand what's going on under the hood.
+
+---
+
+### sortAndReduce _Extension Function_
+
+**Module:** onixlabs-corda-core-contract
+
+**Package:** io.onixlabs.corda.core.contract
+
+Sorts and reduces an `Iterable` of `SecureHash` into a single hash.
+
+```kotlin
+fun Iterable<SecureHash>.sortAndReduce(): SecureHash
+```
+
+---
+
+### SignatureData *Class*
+
+**Module:** onixlabs-corda-core-contract
+
+**Package:** io.onixlabs.corda.core.contract
+
+#### Description
+
+Represents an array of unsigned bytes, and its signed equivalent.
+
+```kotlin
+@CordaSerializable
+data class SignatureData(
+    val content: ByteArray, 
+    val signature: DigitalSignature
+)
+```
+
+>   🔵  **INFORMATION**
+>
+>   This API exists in version 1.2.0 however in version 3.0.0 the `verify` function no longer returns `Boolean`. Instead, the `isValid` function replaces the `verify` function, and the `verify` function now returns `Unit`, or throws a `SignatureException` if the digital signature could not be verified by the specified public key.
+
+---
+
+### 
diff --git a/gradle.properties b/gradle.properties
@@ -1,9 +1,5 @@
 name=onixlabs-corda-core
 group=io.onixlabs
-version=2.1.2
-
-kotlin.incremental=false
-kotlin.code.style=official
-
+version=3.0.0
 onixlabs.development.jarsign.keystore=../lib/onixlabs.development.pkcs12
-onixlabs.development.jarsign.password=5891f47942424d2acbe108691fdb5ba258712fca7e4762be4327241ebf3dbfa3
+onixlabs.development.jarsign.password=5891f47942424d2acbe108691fdb5ba258712fca7e4762be4327241ebf3dbfa3
diff --git a/onixlabs-corda-core-contract/build.gradle b/onixlabs-corda-core-contract/build.gradle
@@ -49,6 +49,7 @@ publishing {
             groupId = project.parent.group
             version = project.parent.version
             artifactId = 'onixlabs-corda-core-contract'
+            artifact sourceJar
             from components.java
         }
     }
diff --git a/onixlabs-corda-core-contract/src/main/kotlin/io/onixlabs/corda/core/contract/Extensions.AbstractParty.kt b/onixlabs-corda-core-contract/src/main/kotlin/io/onixlabs/corda/core/contract/Extensions.AbstractParty.kt
@@ -34,4 +34,4 @@ val Iterable<AbstractParty>.owningKeys: Set<PublicKey>
  * @return Returns a [SecureHash] representing the participants of the initial [Iterable].
  */
 val Iterable<AbstractParty>.participantHash: SecureHash
-    get() = SecureHash.sha256(map { SecureHash.sha256(it.toString()) }.toSortedSet().joinToString())
+    get() = map { SecureHash.sha256(it.toString()) }.sortAndReduce()
diff --git a/onixlabs-corda-core-contract/src/main/kotlin/io/onixlabs/corda/core/contract/Extensions.SecureHash.kt b/onixlabs-corda-core-contract/src/main/kotlin/io/onixlabs/corda/core/contract/Extensions.SecureHash.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2020-2021 ONIXLabs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.onixlabs.corda.core.contract
+
+import net.corda.core.crypto.SecureHash
+
+/**
+ * Sorts and reduces an [Iterable] of [SecureHash] into a single hash.
+ *
+ * @return Returns a single hash representing the sorted and reduced input hashes.
+ */
+fun Iterable<SecureHash>.sortAndReduce(): SecureHash {
+    return sorted().reduce { lhs, rhs -> lhs.concatenate(rhs) }
+}
diff --git a/onixlabs-corda-core-contract/src/main/kotlin/io/onixlabs/corda/core/contract/SignatureData.kt b/onixlabs-corda-core-contract/src/main/kotlin/io/onixlabs/corda/core/contract/SignatureData.kt
@@ -22,6 +22,7 @@ import net.corda.core.crypto.sign
 import net.corda.core.node.ServiceHub
 import net.corda.core.node.services.KeyManagementService
 import net.corda.core.serialization.CordaSerializable
+import net.corda.core.utilities.toBase58String
 import net.corda.core.utilities.toBase64
 import java.security.PrivateKey
 import java.security.PublicKey
@@ -81,14 +82,26 @@ data class SignatureData(val content: ByteArray, val signature: DigitalSignature
         }
     }
 
+    /**
+     * Determines whether the signature data was signed by the specified key.
+     *
+     * @param publicKey The public key to verify against the signature.
+     * @return Returns true if the signature data was signed by the specified key; otherwise, false.
+     */
+    fun isValid(publicKey: PublicKey): Boolean {
+        return Crypto.isValid(publicKey, signature.bytes, content)
+    }
+
     /**
      * Verifies the signature data using the specified public key.
      *
      * @param publicKey The public key to verify against the signature.
      * @return Returns true if the public key was used to sign the data; otherwise, false.
      */
-    fun verify(publicKey: PublicKey): Boolean {
-        return Crypto.isValid(publicKey, signature.bytes, content)
+    fun verify(publicKey: PublicKey) {
+        if (!isValid(publicKey)) {
+            throw SignatureException("Signature was not signed by the specified key: ${publicKey.toBase58String()}")
+        }
     }
 
     /**
diff --git a/onixlabs-corda-core-integration/build.gradle b/onixlabs-corda-core-integration/build.gradle
@@ -32,6 +32,7 @@ publishing {
             groupId = project.parent.group
             version = project.parent.version
             artifactId = 'onixlabs-corda-core-integration'
+            artifact sourceJar
             from components.java
         }
     }
diff --git a/onixlabs-corda-core-workflow/build.gradle b/onixlabs-corda-core-workflow/build.gradle
@@ -52,6 +52,7 @@ publishing {
             groupId = project.parent.group
             version = project.parent.version
             artifactId = 'onixlabs-corda-core-workflow'
+            artifact sourceJar
             from components.java
         }
     }
diff --git a/onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/services/QueryDsl.kt b/onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/services/QueryDsl.kt
@@ -410,6 +410,16 @@ class QueryDsl<T : ContractState> internal constructor(
         criteria = criteria.and(criteriaToAdd.updateQueryCriteria())
     }
 
+    /**
+     * Applies a sub-query to the current query criteria using logical AND.
+     *
+     * @param queryCriteria The sub-query criteria which will be appended to the current query criteria.
+     */
+    @QueryDslContext
+    fun and(queryCriteria: QueryCriteria) {
+        criteria = criteria.and(queryCriteria)
+    }
+
     /**
      * Applies a sub-query to the current query criteria using logical AND.
      *
@@ -419,7 +429,17 @@ class QueryDsl<T : ContractState> internal constructor(
     fun and(action: QueryDsl<T>.() -> Unit) {
         val query = QueryDsl<T>(VaultQueryCriteria().updateQueryCriteria(), paging, sorting)
         action(query)
-        criteria = criteria.and(query.criteria)
+        and(query.criteria)
+    }
+
+    /**
+     * Applies a sub-query to the current query criteria using logical OR.
+     *
+     * @param queryCriteria The sub-query criteria which will be appended to the current query criteria.
+     */
+    @QueryDslContext
+    fun or(queryCriteria: QueryCriteria) {
+        criteria = criteria.or(queryCriteria)
     }
 
     /**
@@ -431,7 +451,7 @@ class QueryDsl<T : ContractState> internal constructor(
     fun or(action: QueryDsl<T>.() -> Unit) {
         val query = QueryDsl<T>(VaultQueryCriteria().updateQueryCriteria(), paging, sorting)
         action(query)
-        criteria = criteria.or(query.criteria)
+        or(query.criteria)
     }
 
     /**
diff --git a/onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/workflow/Extensions.FlowLogic.Notaries.kt b/onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/workflow/Extensions.FlowLogic.Notaries.kt
@@ -53,7 +53,7 @@ fun FlowLogic<*>.getPreferredNotary(
     defaultSelector: (ServiceHub) -> Party = { firstNotary }
 ): Party {
     val cordappContext: CordappContext = serviceHub.getAppContext()
-    logger.info("Using the specified cordapp for notary selection: ${cordappContext.cordapp.name}")
+    logger.info("Using the specified CorDapp for notary selection: ${cordappContext.cordapp.name}")
     return if (serviceHub.getAppContext().config.exists("notary")) {
         val name = CordaX500Name.parse(serviceHub.getAppContext().config.getString("notary"))
         serviceHub.networkMapCache.getNotary(name) ?: throw IllegalArgumentException(
diff --git a/onixlabs-corda-test-contract/src/main/kotlin/io/onixlabs/corda/test/contract/RewardContract.kt b/onixlabs-corda-test-contract/src/main/kotlin/io/onixlabs/corda/test/contract/RewardContract.kt
@@ -70,7 +70,7 @@ class RewardContract : Contract {
 
             CONTRACT_RULE_OWNER using (rewardOutput.owner == customerReference.owner)
             CONTRACT_RULE_SIGNATURE_DATA using (rewardOutput.hash().bytes.contentEquals(signature.content))
-            CONTRACT_RULE_SIGNATURE_SIGNER using (signature.verify(rewardOutput.issuer.owningKey))
+            CONTRACT_RULE_SIGNATURE_SIGNER using (signature.isValid(rewardOutput.issuer.owningKey))
             CONTRACT_RULE_SIGNERS using (rewardOutput.participants.owningKeys.all { it in signers })
         }
     }
@@ -114,7 +114,7 @@ class RewardContract : Contract {
 
             CONTRACT_RULE_OWNER using (rewardInput.owner == customerReference.owner)
             CONTRACT_RULE_SIGNATURE_DATA using (rewardInput.hash().bytes.contentEquals(signature.content))
-            CONTRACT_RULE_SIGNATURE_SIGNER using (signature.verify(rewardInput.owner.owningKey))
+            CONTRACT_RULE_SIGNATURE_SIGNER using (signature.isValid(rewardInput.owner.owningKey))
             CONTRACT_RULE_SIGNERS using (rewardInput.participants.owningKeys.all { it in signers })
         }
     }
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/ContractTest.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/ContractTest.kt
@@ -14,8 +14,11 @@
  * limitations under the License.
  */
 
-package io.onixlabs.corda.test.contract
+package io.onixlabs.corda.test
 
+import io.onixlabs.corda.test.contract.Customer
+import io.onixlabs.corda.test.contract.CustomerContract
+import io.onixlabs.corda.test.contract.RewardContract
 import net.corda.core.contracts.StateAndRef
 import net.corda.core.contracts.StateRef
 import net.corda.core.crypto.SecureHash
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/MockData.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/MockData.kt
@@ -14,8 +14,10 @@
  * limitations under the License.
  */
 
-package io.onixlabs.corda.test.contract
+package io.onixlabs.corda.test
 
+import io.onixlabs.corda.test.contract.Customer
+import io.onixlabs.corda.test.contract.Reward
 import net.corda.core.contracts.StateRef
 import net.corda.core.crypto.SecureHash
 import net.corda.core.identity.CordaX500Name
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/CustomerContractAmendCommandTests.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/CustomerContractAmendCommandTests.kt
@@ -16,6 +16,7 @@
 
 package io.onixlabs.corda.test.contract
 
+import io.onixlabs.corda.test.*
 import net.corda.testing.node.ledger
 import org.junit.jupiter.api.Test
 
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/CustomerContractIssueCommandTests.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/CustomerContractIssueCommandTests.kt
@@ -16,6 +16,7 @@
 
 package io.onixlabs.corda.test.contract
 
+import io.onixlabs.corda.test.*
 import net.corda.testing.node.ledger
 import org.junit.jupiter.api.Test
 
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/CustomerContractRevokeCommandTests.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/CustomerContractRevokeCommandTests.kt
@@ -16,6 +16,7 @@
 
 package io.onixlabs.corda.test.contract
 
+import io.onixlabs.corda.test.*
 import net.corda.testing.node.ledger
 import org.junit.jupiter.api.Test
 
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/RewardContractIssueCommandTests.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/RewardContractIssueCommandTests.kt
@@ -17,6 +17,7 @@
 package io.onixlabs.corda.test.contract
 
 import io.onixlabs.corda.core.contract.SignatureData
+import io.onixlabs.corda.test.*
 import net.corda.core.contracts.hash
 import net.corda.testing.node.ledger
 import org.junit.jupiter.api.Test
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/RewardContractSpendCommandTests.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/contract/RewardContractSpendCommandTests.kt
@@ -17,6 +17,7 @@
 package io.onixlabs.corda.test.contract
 
 import io.onixlabs.corda.core.contract.SignatureData
+import io.onixlabs.corda.test.*
 import net.corda.core.contracts.hash
 import net.corda.testing.node.ledger
 import org.junit.jupiter.api.Test
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/general/AbstractPartyExtensionTests.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/general/AbstractPartyExtensionTests.kt
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/general/ChainStateExtensionTests.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/general/ChainStateExtensionTests.kt
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/general/ContractIDTests.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/general/ContractIDTests.kt
diff --git a/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/general/SignatureDataTests.kt b/onixlabs-corda-test-contract/src/test/kotlin/io/onixlabs/corda/test/general/SignatureDataTests.kt

Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,8 @@ buildscript {`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`
`43`		`-group 'io.onixlabs'`
`44`		`-version '2.1.2'`
	`43`	`+group getProperty('group')`
	`44`	`+version getProperty('version')`
`45`	`45`
`46`	`46`	`subprojects {`
`47`	`47`	`repositories {`
`@@ -73,6 +73,11 @@ subprojects {`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ task sourceJar(type: Jar) {`
	`77`	`+ from sourceSets.main.allSource`
	`78`	`+ archiveClassifier = "sources"`
	`79`	`+ }`
	`80`	`+`
`76`	`81`	`jar {`
`77`	`82`	`exclude '*/log4j2.xml'`
`78`	`83`	`}`
Original file line number	Diff line number	Diff line change
@@ -50,4 +50,3 @@ In this version the property is declared using the `open` modifier, allowing der
`50`	`50`
`51`	`51`	`---`
`52`	`52`
`53`		`-###`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ publishing {`
`49`	`49`	`groupId = project.parent.group`
`50`	`50`	`version = project.parent.version`
`51`	`51`	`artifactId = 'onixlabs-corda-core-contract'`
	`52`	`+ artifact sourceJar`
`52`	`53`	`from components.java`
`53`	`54`	`}`
`54`	`55`	`}`