Updated account management and resolution functionality.

Author: MrMatthewLayton

build.gradle

@@ -14,7 +14,7 @@ buildscript {
         junit_version = '5.3.1'
 
         onixlabs_group = 'io.onixlabs'
-        onixlabs_corda_core_release_version = '3.2.0'
+        onixlabs_corda_core_release_version = '4.0.0-rc1'
 
         cordapp_platform_version = 10
         cordapp_contract_name = 'ONIXLabs Corda Identity Framework Contract'

gradle.properties

@@ -1,5 +1,5 @@
 name=onixlabs-corda-identity-framework
 group=io.onixlabs
-version=3.3.0
+version=4.0.0-rc1
 onixlabs.development.jarsign.keystore=../lib/onixlabs.development.pkcs12
 onixlabs.development.jarsign.password=5891f47942424d2acbe108691fdb5ba258712fca7e4762be4327241ebf3dbfa3

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/accounts/AccountContract.kt

@@ -64,6 +64,12 @@ open class AccountContract : Contract {
         internal const val CONTRACT_RULE_OUTPUTS =
             "On account issuing, at least one account state must be created."
 
+        internal const val CONTRACT_RULE_OWNER_DELIMITER =
+            "On account issuing, the account owner name must not contain an @ symbol."
+
+        internal const val CONTRACT_RULE_LINEAR_ID_DELIMITER =
+            "On account issuing, the account linear ID must not contain an @ symbol."
+
         internal const val CONTRACT_RULE_PARTICIPANTS =
             "On account issuing, the owner of each created account must be a participant."
 
@@ -81,6 +87,12 @@ open class AccountContract : Contract {
         internal const val CONTRACT_RULE_OUTPUTS =
             "On account amending, at least one account state must be created."
 
+        internal const val CONTRACT_RULE_OWNER_DELIMITER =
+            "On account amending, the account owner name must not contain an @ symbol."
+
+        internal const val CONTRACT_RULE_LINEAR_ID_DELIMITER =
+            "On account amending, the account linear ID must not contain an @ symbol."
+
         internal const val CONTRACT_RULE_PARTICIPANTS =
             "On account amending, the owner of each created account must be a participant."
 
@@ -138,6 +150,8 @@ open class AccountContract : Contract {
 
         Issue.CONTRACT_RULE_INPUTS using (accountInputs.isEmpty())
         Issue.CONTRACT_RULE_OUTPUTS using (accountOutputs.isNotEmpty())
+        Issue.CONTRACT_RULE_OWNER_DELIMITER using (accountOutputs.all { AccountParty.DELIMITER !in it.owner.toString() })
+        Issue.CONTRACT_RULE_LINEAR_ID_DELIMITER using (accountOutputs.all { AccountParty.DELIMITER !in it.linearId.toString() })
         Issue.CONTRACT_RULE_PARTICIPANTS using (accountOutputs.all { it.owner in it.participants })
         Issue.CONTRACT_RULE_SIGNERS using (accountOutputs.all { it.owner.owningKey in signers })
 
@@ -156,6 +170,8 @@ open class AccountContract : Contract {
 
         Amend.CONTRACT_RULE_INPUTS using (accountInputs.isNotEmpty())
         Amend.CONTRACT_RULE_OUTPUTS using (accountOutputs.isNotEmpty())
+        Amend.CONTRACT_RULE_OWNER_DELIMITER using (accountOutputs.all { AccountParty.DELIMITER !in it.owner.toString() })
+        Amend.CONTRACT_RULE_LINEAR_ID_DELIMITER using (accountOutputs.all { AccountParty.DELIMITER !in it.linearId.toString() })
         Amend.CONTRACT_RULE_PARTICIPANTS using (accountOutputs.all { it.owner in it.participants })
         Amend.CONTRACT_RULE_SIGNERS using (accountOutputs.all { it.owner.owningKey in signers })
 

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/accounts/AccountParty.kt

@@ -34,12 +34,16 @@ import java.util.*
  * @property accountLinearId The linear ID of the account associated with this party.
  * @property accountType The type of the account associated with this party.
  */
-class AccountParty internal constructor(
+class AccountParty(
     val owner: AbstractParty,
     val accountLinearId: UniqueIdentifier,
     val accountType: Class<out Account>
 ) : AbstractParty(owner.owningKey) {
 
+    companion object {
+        const val DELIMITER = '@'
+    }
+
     /**
      * Gets an account resolver to resolve this [AccountParty] back to the associated [Account].
      *
@@ -90,8 +94,10 @@ class AccountParty internal constructor(
      * @return Returns true if the specified object is equal to the current object; otherwise, false.
      */
     override fun equals(other: Any?): Boolean {
-        return if (other !is AccountParty) super.equals(other)
-        else other.owner == owner && other.accountLinearId == accountLinearId && other.accountType == accountType
+        return this === other || (other is AccountParty
+                && other.owner == owner
+                && other.accountLinearId == accountLinearId
+                && other.accountType == accountType)
     }
 
     /**
@@ -109,7 +115,7 @@ class AccountParty internal constructor(
      * @return Returns a string that represents the current object.
      */
     override fun toString(): String {
-        return "$accountLinearId@$owner"
+        return "$accountLinearId$DELIMITER$owner"
     }
 
     /**

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/attestations/Attestation.kt

@@ -18,7 +18,6 @@ package io.onixlabs.corda.identityframework.contract.attestations
 
 import io.onixlabs.corda.core.contract.ChainState
 import io.onixlabs.corda.core.contract.Hashable
-import io.onixlabs.corda.identityframework.contract.accountLinearId
 import io.onixlabs.corda.identityframework.contract.attestations.AttestationSchema.AttestationEntity
 import io.onixlabs.corda.identityframework.contract.attestations.AttestationSchema.AttestationSchemaV1
 import io.onixlabs.corda.identityframework.contract.toDataClassString
@@ -92,20 +91,7 @@ open class Attestation<T : ContractState>(
      * @return Returns a persistent state entity.
      */
     override fun generateMappedObject(schema: MappedSchema): PersistentState = when (schema) {
-        is AttestationSchemaV1 -> AttestationEntity(
-            linearId = linearId.id,
-            externalId = linearId.externalId,
-            attestor = attestor,
-            attestorAccountLinearId = attestor.accountLinearId?.id,
-            attestorAccountExternalId = attestor.accountLinearId?.externalId,
-            pointer = pointer.statePointer.toString(),
-            pointerStateType = pointer.stateType.canonicalName,
-            pointerHash = pointer.hash.toString(),
-            status = status,
-            previousStateRef = previousStateRef?.toString(),
-            hash = hash.toString(),
-            attestationType = javaClass.canonicalName
-        )
+        is AttestationSchemaV1 -> AttestationEntity(this)
         else -> throw IllegalArgumentException("Unrecognised schema: $schema.")
     }
 

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/attestations/AttestationSchema.kt

@@ -16,6 +16,7 @@
 
 package io.onixlabs.corda.identityframework.contract.attestations
 
+import io.onixlabs.corda.identityframework.contract.accountLinearId
 import net.corda.core.crypto.NullKeys.NULL_PARTY
 import net.corda.core.identity.AbstractParty
 import net.corda.core.schemas.MappedSchema
@@ -68,5 +69,20 @@ object AttestationSchema {
 
         @Column(name = "attestation_type", nullable = false)
         val attestationType: String = ""
-    ) : PersistentState()
+    ) : PersistentState() {
+        internal constructor(attestation: Attestation<*>) : this(
+            linearId = attestation.linearId.id,
+            externalId = attestation.linearId.externalId,
+            attestor = attestation.attestor,
+            attestorAccountLinearId = attestation.attestor.accountLinearId?.id,
+            attestorAccountExternalId = attestation.attestor.accountLinearId?.externalId,
+            pointer = attestation.pointer.statePointer.toString(),
+            pointerStateType = attestation.pointer.stateType.canonicalName,
+            pointerHash = attestation.pointer.hash.toString(),
+            status = attestation.status,
+            previousStateRef = attestation.previousStateRef?.toString(),
+            hash = attestation.hash.toString(),
+            attestationType = attestation.javaClass.canonicalName
+        )
+    }
 }

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/claims/CordaClaim.kt

@@ -18,7 +18,6 @@ package io.onixlabs.corda.identityframework.contract.claims
 
 import io.onixlabs.corda.core.contract.ChainState
 import io.onixlabs.corda.core.contract.Hashable
-import io.onixlabs.corda.identityframework.contract.accountLinearId
 import io.onixlabs.corda.identityframework.contract.claims.CordaClaimSchema.CordaClaimEntity
 import io.onixlabs.corda.identityframework.contract.claims.CordaClaimSchema.CordaClaimSchemaV1
 import net.corda.core.contracts.BelongsToContract
@@ -98,23 +97,7 @@ open class CordaClaim<T : Any>(
      * @return Returns a persistent state entity.
      */
     override fun generateMappedObject(schema: MappedSchema): PersistentState = when (schema) {
-        is CordaClaimSchemaV1 -> CordaClaimEntity(
-            linearId = linearId.id,
-            externalId = linearId.externalId,
-            issuer = issuer,
-            issuerAccountLinearId = issuer.accountLinearId?.id,
-            issuerAccountExternalId = issuer.accountLinearId?.externalId,
-            holder = holder,
-            holderAccountLinearId = holder.accountLinearId?.id,
-            holderAccountExternalId = holder.accountLinearId?.externalId,
-            property = property,
-            value = value.toString(),
-            valueType = value.javaClass.canonicalName,
-            previousStateRef = previousStateRef?.toString(),
-            isSelfIssued = isSelfIssued,
-            hash = hash.toString(),
-            claimType = javaClass.canonicalName
-        )
+        is CordaClaimSchemaV1 -> CordaClaimEntity(this)
         else -> throw IllegalArgumentException("Unrecognised schema: $schema.")
     }
 

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/claims/CordaClaimSchema.kt

@@ -16,6 +16,7 @@
 
 package io.onixlabs.corda.identityframework.contract.claims
 
+import io.onixlabs.corda.identityframework.contract.accountLinearId
 import net.corda.core.crypto.NullKeys.NULL_PARTY
 import net.corda.core.identity.AbstractParty
 import net.corda.core.schemas.MappedSchema
@@ -78,5 +79,23 @@ object CordaClaimSchema {
 
         @Column(name = "claim_type", nullable = false)
         val claimType: String = ""
-    ) : PersistentState()
+    ) : PersistentState() {
+        internal constructor(claim: CordaClaim<*>) : this(
+            linearId = claim.linearId.id,
+            externalId = claim.linearId.externalId,
+            issuer = claim.issuer,
+            issuerAccountLinearId = claim.issuer.accountLinearId?.id,
+            issuerAccountExternalId = claim.issuer.accountLinearId?.externalId,
+            holder = claim.holder,
+            holderAccountLinearId = claim.holder.accountLinearId?.id,
+            holderAccountExternalId = claim.holder.accountLinearId?.externalId,
+            property = claim.property,
+            value = claim.value.toString(),
+            valueType = claim.value.javaClass.canonicalName,
+            previousStateRef = claim.previousStateRef?.toString(),
+            isSelfIssued = claim.isSelfIssued,
+            hash = claim.hash.toString(),
+            claimType = claim.javaClass.canonicalName
+        )
+    }
 }

onixlabs-corda-identity-framework-workflow/src/main/kotlin/io/onixlabs/corda/identityframework/workflow/Extensions.CordaRPCOps.kt

@@ -0,0 +1,57 @@
+/*
+ * 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.identityframework.workflow
+
+import io.onixlabs.corda.identityframework.contract.accounts.Account
+import io.onixlabs.corda.identityframework.contract.accounts.AccountParty
+import net.corda.core.contracts.UniqueIdentifier
+import net.corda.core.identity.AbstractParty
+import net.corda.core.identity.AnonymousParty
+import net.corda.core.identity.CordaX500Name
+import net.corda.core.messaging.CordaRPCOps
+import net.corda.core.utilities.parsePublicKeyBase58
+
+fun CordaRPCOps.ownsLegalIdentity(party: AbstractParty): Boolean {
+    val partyToResolve = if (party is AccountParty) party.owner else party
+    val wellKnownParty = wellKnownPartyFromAnonymous(partyToResolve)
+
+    return wellKnownParty in nodeInfo().legalIdentities
+}
+
+fun CordaRPCOps.resolveParty(value: String, type: Class<out Account> = Account::class.java): AbstractParty {
+    return if (AccountParty.DELIMITER in value) resolveAccountParty(value, type) else resolveAbstractParty(value)
+}
+
+fun CordaRPCOps.resolveAbstractParty(value: String): AbstractParty {
+    return try {
+        val parsedCordaX500Name = CordaX500Name.parse(value)
+        wellKnownPartyFromX500Name(parsedCordaX500Name)
+    } catch (ex: Exception) {
+        val parsedPublicKey = parsePublicKeyBase58(value)
+        AnonymousParty(parsedPublicKey)
+    } ?: throw IllegalArgumentException("Failed to resolve '$value' to party.")
+}
+
+fun CordaRPCOps.resolveAccountParty(value: String, type: Class<out Account> = Account::class.java): AccountParty {
+    val identityComponent = value.substringAfter(AccountParty.DELIMITER)
+    val linearIdComponent = value.substringBefore(AccountParty.DELIMITER)
+
+    val identity = resolveAbstractParty(identityComponent)
+    val linearId = UniqueIdentifier.fromString(linearIdComponent)
+
+    return AccountParty(identity, linearId, type)
+}

onixlabs-corda-identity-framework-workflow/src/main/kotlin/io/onixlabs/corda/identityframework/workflow/Extensions.FlowLogic.Sessions.kt

@@ -0,0 +1,45 @@
+/*
+ * 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.identityframework.workflow
+
+import co.paralleluniverse.fibers.Suspendable
+import io.onixlabs.corda.core.workflow.checkSufficientSessions
+import io.onixlabs.corda.identityframework.contract.accounts.AccountParty
+import net.corda.core.contracts.ContractState
+import net.corda.core.flows.FlowLogic
+import net.corda.core.flows.FlowSession
+import net.corda.core.identity.AbstractParty
+import net.corda.core.transactions.TransactionBuilder
+
+@Suspendable
+fun FlowLogic<*>.checkSufficientSessionsWithAccounts(sessions: Iterable<FlowSession>, states: Iterable<ContractState>) {
+    checkSufficientSessions(sessions, states) { it.getAccountOwningPartyOrThis() }
+}
+
+@Suspendable
+fun FlowLogic<*>.checkSufficientSessionsWithAccounts(sessions: Iterable<FlowSession>, vararg states: ContractState) {
+    checkSufficientSessions(sessions, *states) { it.getAccountOwningPartyOrThis() }
+}
+
+@Suspendable
+fun FlowLogic<*>.checkSufficientSessions(sessions: Iterable<FlowSession>, transaction: TransactionBuilder) {
+    checkSufficientSessions(sessions, transaction) { it.getAccountOwningPartyOrThis() }
+}
+
+private fun AbstractParty.getAccountOwningPartyOrThis(): AbstractParty {
+    return if (this is AccountParty) owner else this
+}

onixlabs-corda-identity-framework-workflow/src/main/kotlin/io/onixlabs/corda/identityframework/workflow/Extensions.ServiceHub.kt

@@ -0,0 +1,57 @@
+/*
+ * 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.identityframework.workflow
+
+import io.onixlabs.corda.identityframework.contract.accounts.Account
+import io.onixlabs.corda.identityframework.contract.accounts.AccountParty
+import net.corda.core.contracts.UniqueIdentifier
+import net.corda.core.identity.AbstractParty
+import net.corda.core.identity.AnonymousParty
+import net.corda.core.identity.CordaX500Name
+import net.corda.core.node.ServiceHub
+import net.corda.core.utilities.parsePublicKeyBase58
+
+fun ServiceHub.ownsLegalIdentity(party: AbstractParty): Boolean {
+    val partyToResolve = if (party is AccountParty) party.owner else party
+    val wellKnownParty = identityService.wellKnownPartyFromAnonymous(partyToResolve)
+
+    return wellKnownParty in myInfo.legalIdentities
+}
+
+fun ServiceHub.resolveParty(value: String, type: Class<out Account> = Account::class.java): AbstractParty {
+    return if (AccountParty.DELIMITER in value) resolveAccountParty(value, type) else resolveAbstractParty(value)
+}
+
+fun ServiceHub.resolveAbstractParty(value: String): AbstractParty {
+    return try {
+        val parsedCordaX500Name = CordaX500Name.parse(value)
+        identityService.wellKnownPartyFromX500Name(parsedCordaX500Name)
+    } catch (ex: Exception) {
+        val parsedPublicKey = parsePublicKeyBase58(value)
+        AnonymousParty(parsedPublicKey)
+    } ?: throw IllegalArgumentException("Failed to resolve '$value' to party.")
+}
+
+fun ServiceHub.resolveAccountParty(value: String, type: Class<out Account> = Account::class.java): AccountParty {
+    val identityComponent = value.substringAfter(AccountParty.DELIMITER)
+    val linearIdComponent = value.substringBefore(AccountParty.DELIMITER)
+
+    val identity = resolveAbstractParty(identityComponent)
+    val linearId = UniqueIdentifier.fromString(linearIdComponent)
+
+    return AccountParty(identity, linearId, type)
+}