Added overloads to claim and attestation command services to allow issuance, amendment and revocation of custom claim and attestation types.

Author: MrMatthewLayton

onixlabs-corda-identity-framework-integration/src/main/kotlin/io/onixlabs/corda/identityframework/integration/AttestationCommandService.kt

@@ -39,6 +39,23 @@ import net.corda.core.transactions.SignedTransaction
  */
 class AttestationCommandService(rpc: CordaRPCOps) : RPCService(rpc) {
 
+    /**
+     * Issues an attestation.
+     *
+     * @param T The [Attestation] type.
+     * @param attestation The attestation to issue.
+     * @param notary The notary to use for the transaction.
+     * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
+     */
+    fun <T : Attestation<*>> issueAttestation(
+        attestation: T,
+        notary: Party? = null,
+        observers: Set<Party> = emptySet()
+    ): FlowProgressHandle<SignedTransaction> {
+        return rpc.startTrackedFlow(IssueAttestationFlow::Initiator, attestation, notary, observers)
+    }
+
     /**
      * Issues an attestation.
      *
@@ -50,6 +67,7 @@ class AttestationCommandService(rpc: CordaRPCOps) : RPCService(rpc) {
      * @param linearId The unique identifier of the attestation.
      * @param notary The notary to use for the transaction.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
     fun <T : ContractState> issueAttestation(
         state: StateAndRef<T>,
@@ -60,98 +78,97 @@ class AttestationCommandService(rpc: CordaRPCOps) : RPCService(rpc) {
         notary: Party? = null,
         observers: Set<Party> = emptySet()
     ): FlowProgressHandle<SignedTransaction> {
-        return rpc.startTrackedFlow(
-            IssueAttestationFlow::Initiator,
-            state.attest(attestor, status, metadata, linearId),
-            notary,
-            observers
-        )
+        val attestation = state.attest(attestor, status, metadata, linearId)
+        return issueAttestation(attestation, notary, observers)
+    }
+
+    /**
+     * Amends an attestation.
+     *
+     * @param T The [Attestation] type.
+     * @param oldAttestation The old attestation to be consumed.
+     * @param newAttestation The new attestation to be created.
+     * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
+     */
+    fun <T : Attestation<*>> amendAttestation(
+        oldAttestation: StateAndRef<T>,
+        newAttestation: T,
+        observers: Set<Party> = emptySet()
+    ): FlowProgressHandle<SignedTransaction> {
+        return rpc.startTrackedFlow(AmendAttestationFlow::Initiator, oldAttestation, newAttestation, observers)
     }
 
     /**
      * Amends an attestation.
      *
      * @param T The underlying [ContractState] type.
-     * @param attestation The attestation to be consumed.
+     * @param oldAttestation The old attestation to be consumed.
      * @param status The status of the attestation.
      * @param metadata Additional information about the attestation.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
     fun <T : ContractState> amendAttestation(
-        attestation: StateAndRef<Attestation<T>>,
+        oldAttestation: StateAndRef<Attestation<T>>,
         status: AttestationStatus = AttestationStatus.REJECTED,
         metadata: Map<String, String> = emptyMap(),
         observers: Set<Party> = emptySet()
     ): FlowProgressHandle<SignedTransaction> {
-        val amendedAttestation = attestation.amend(status, metadata = metadata)
-        return rpc.startTrackedFlow(
-            AmendAttestationFlow::Initiator,
-            attestation,
-            amendedAttestation,
-            observers
-        )
+        val newAttestation = oldAttestation.amend(status, metadata = metadata)
+        return amendAttestation(oldAttestation, newAttestation, observers)
     }
 
     /**
      * Amends an attestation.
      *
      * @param T The underlying [ContractState] type.
-     * @param attestation The attestation to be consumed.
+     * @param oldAttestation The old attestation to be consumed.
      * @param state The state being attested.
      * @param status The status of the attestation.
      * @param metadata Additional information about the attestation.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
     fun <T : ContractState> amendAttestation(
-        attestation: StateAndRef<Attestation<T>>,
+        oldAttestation: StateAndRef<Attestation<T>>,
         state: StateAndRef<T>,
         status: AttestationStatus = AttestationStatus.REJECTED,
         metadata: Map<String, String> = emptyMap(),
         observers: Set<Party> = emptySet()
     ): FlowProgressHandle<SignedTransaction> {
         val pointer = state.toAttestationPointer()
-        val amendedAttestation = attestation.amend(status, pointer, metadata)
-        return rpc.startTrackedFlow(
-            AmendAttestationFlow::Initiator,
-            attestation,
-            amendedAttestation,
-            observers
-        )
+        val newAttestation = oldAttestation.amend(status, pointer, metadata)
+        return amendAttestation(oldAttestation, newAttestation, observers)
     }
 
     /**
      * Revokes an attestation.
      *
-     * @param T The underlying [ContractState] type.
+     * @param T The [Attestation] type.
      * @param attestation The attestation to be consumed.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
-    fun <T : ContractState> revokeAttestation(
-        attestation: StateAndRef<Attestation<T>>,
+    fun <T : Attestation<*>> revokeAttestation(
+        attestation: StateAndRef<T>,
         observers: Set<Party> = emptySet()
     ): FlowProgressHandle<SignedTransaction> {
-        return rpc.startTrackedFlow(
-            RevokeAttestationFlow::Initiator,
-            attestation,
-            observers
-        )
+        return rpc.startTrackedFlow(RevokeAttestationFlow::Initiator, attestation, observers)
     }
 
     /**
      * Publishes an attestation.
      *
-     * @param T The underlying [ContractState] type.
+     * @param T The [Attestation] type.
      * @param attestation The attestation to be published.
      * @param observers Observers of the attestation.
+     * @return Returns a flow process handle.
      */
-    fun <T : ContractState> publishAttestation(
-        attestation: StateAndRef<Attestation<T>>,
+    fun <T : Attestation<*>> publishAttestation(
+        attestation: StateAndRef<T>,
         observers: Set<Party>
     ): FlowProgressHandle<SignedTransaction> {
-        return rpc.startTrackedFlow(
-            PublishAttestationFlow::Initiator,
-            attestation,
-            observers
-        )
+        return rpc.startTrackedFlow(PublishAttestationFlow::Initiator, attestation, observers)
     }
 }

onixlabs-corda-identity-framework-integration/src/main/kotlin/io/onixlabs/corda/identityframework/integration/ClaimCommandService.kt

@@ -42,9 +42,11 @@ class ClaimCommandService(rpc: CordaRPCOps) : RPCService(rpc) {
     /**
      * Issues a claim.
      *
+     * @param T The underlying claim value type.
      * @param claim The claim to issue.
      * @param notary The notary to use for the transaction.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
     fun <T : Any> issueClaim(
         claim: CordaClaim<T>,
@@ -65,6 +67,7 @@ class ClaimCommandService(rpc: CordaRPCOps) : RPCService(rpc) {
      * @param linearId The unique identifier of the claim.
      * @param notary The notary to use for the transaction.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
     fun <T : Any> issueClaim(
         property: String,
@@ -86,6 +89,7 @@ class ClaimCommandService(rpc: CordaRPCOps) : RPCService(rpc) {
      * @param oldClaim The claim to be consumed.
      * @param newClaim The claim to be created.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
     fun <T : Any> amendClaim(
         oldClaim: StateAndRef<CordaClaim<T>>,
@@ -102,6 +106,7 @@ class ClaimCommandService(rpc: CordaRPCOps) : RPCService(rpc) {
      * @param claim The claim to be consumed.
      * @param value The amended value of the claim.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
     fun <T : Any> amendClaim(
         claim: StateAndRef<CordaClaim<T>>,
@@ -117,16 +122,13 @@ class ClaimCommandService(rpc: CordaRPCOps) : RPCService(rpc) {
      * @param T The underlying claim value type.
      * @param claim The claim to be consumed.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
     fun <T : Any> revokeClaim(
         claim: StateAndRef<CordaClaim<T>>,
         observers: Set<Party> = emptySet()
     ): FlowProgressHandle<SignedTransaction> {
-        return rpc.startTrackedFlow(
-            RevokeClaimFlow::Initiator,
-            claim,
-            observers
-        )
+        return rpc.startTrackedFlow(RevokeClaimFlow::Initiator, claim, observers)
     }
 
     /**
@@ -135,15 +137,12 @@ class ClaimCommandService(rpc: CordaRPCOps) : RPCService(rpc) {
      * @param T The underlying claim value type.
      * @param claim The claim to be published.
      * @param observers Additional observers of the transaction.
+     * @return Returns a flow process handle.
      */
     fun <T : Any> publishClaim(
         claim: StateAndRef<CordaClaim<T>>,
         observers: Set<Party>
     ): FlowProgressHandle<SignedTransaction> {
-        return rpc.startTrackedFlow(
-            PublishClaimFlow::Initiator,
-            claim,
-            observers
-        )
+        return rpc.startTrackedFlow(PublishClaimFlow::Initiator, claim, observers)
     }
 }

onixlabs-corda-identity-framework-integration/src/test/kotlin/io/onixlabs/corda/identityframework/integration/AttestationIntegrationTests.kt

@@ -16,7 +16,6 @@
 
 package io.onixlabs.corda.identityframework.integration
 
-import io.onixlabs.corda.core.contract.cast
 import io.onixlabs.corda.identityframework.contract.Attestation
 import io.onixlabs.corda.identityframework.contract.AttestationStatus
 import io.onixlabs.corda.identityframework.contract.CordaClaim
@@ -57,7 +56,7 @@ class AttestationIntegrationTests : IntegrationTest() {
 
         // Amend the issued attestation
         nodeC.attestations.commandService.amendAttestation(
-            attestation = issuedAttestation,
+            oldAttestation = issuedAttestation,
             state = issuedClaim,
             status = AttestationStatus.ACCEPTED
         ).returnValue.getOrThrow()