Merge pull request #74 from knarayan/main

code to query simple CorDapp using linearId

Author: sandeepnRES

docs/docs/external/getting-started.md

@@ -216,7 +216,7 @@ The code for this lies in the `core/drivers/fabric-driver` folder.
 
 #### Configuring
 
-In the `core/drivers/fabric-driver` folder, copy `.env.template` to `.env` and update `CONNECTION_PROFILE` to point to the connection profile of the fabric network (e.g. `<PATH_TO_NETWORK_SETUPS_REPO>/fabric/shared/network1/peerOrganizations/org1.network1.com/connection-org1.json`)
+In the `core/drivers/fabric-driver` folder, copy `.env.template` to `.env` and update `CONNECTION_PROFILE` to point to the connection profile of the fabric network (e.g. `<PATH-TO-NETWORK-SETUPS>/fabric/shared/network1/peerOrganizations/org1.network1.com/connection-org1.json`)
 
 Configure `fabric-driver` for `network1` as follows:
 - Navigate to the `core/drivers/fabric-driver` folder.
@@ -373,11 +373,15 @@ Once you have the networks, the relays, and the drivers, running, and the ledger
 
 ## Corda to Fabric
 
-To test the scenario where `Corda_Network` requests the value of the state (key) `Arcturus` from `network1`, do the following:
+To test the scenario where `Corda_Network` requests the value of the state (key) `a` from `network1`, do the following:
 - Navigate to the `samples/corda-simple-application` folder.
 - Run the following:
   ```bash
-  ./clients/build/install/clients/bin/clients request-state localhost:9081 localhost:9080/network1/mychannel:simplestate:Read:Arcturus
+  ./clients/build/install/clients/bin/clients request-state localhost:9081 localhost:9080/network1/mychannel:simplestate:Read:a
+  ```
+- Query the value of the requested state (key) `a` in `Corda_Network` using the following (replace LinearId with the CorDapp simplestate linearId value obtained in the previous command):
+  ```bash
+  ./clients/build/install/clients/bin/clients get-state-using-linear-id LinearId
   ```
 
 To test the scenario where `Corda_Network` requests the value of the state (key) `Arcturus` from `network2`, do the following:
@@ -396,6 +400,10 @@ To test the scenario where `network1` requests the value of the state (key) `H`
   ```bash
   fabric-cli interop --local-network=network1 --sign=true --requesting-org=Org1MSP localhost:9081/Corda_Network/localhost:10006#com.cordaSimpleApplication.flow.GetStateByKey:H --debug=true
   ```
+- Query the value of the requested state (key) `H` in `network1` using the following (replace the Args with the Args value obtained in the previous command):
+  ```bash
+  fabric-cli interop --local-network=network1 chaincode invoke mychannel simplestate read '["Args"]'
+  ```
 
 To test the scenario where `network2` requests the value of the state (key) `H` from `Corda_Network`, do the following:
 - Navigate to the `tests/network-setups/fabric/dev/scripts/fabric-cli` folder.
@@ -414,6 +422,10 @@ To test the scenario where `network1` requests the value of the state (key) `Arc
   ```bash
   fabric-cli interop --local-network=network1 --requesting-org=Org1MSP localhost:9083/network2/mychannel:simplestate:Read:Arcturus
   ```
+- Query the value of the requested state (key) `Arcturus` in `network1` using the following (replace the Args with the Args value obtained in the previous command):
+  ```bash
+  fabric-cli interop --local-network=network1 chaincode invoke mychannel simplestate read '["Args"]'
+  ```
 
 To test the scenario where `network2` requests the value of the state (key) `a` from `network1`, do the following:
 - Navigate to the `tests/network-setups/fabric/dev/scripts/fabric-cli` folder.
@@ -431,7 +443,7 @@ Bring down the various components as follows:
   * Navigate to the `tests/network-setups/shared/corda` folder.
   * Run the following:
   ```bash
-  make clean-local
+  make clean
   ```
 - To bring down one or both of the Fabric networks:
   * Navigate to the `tests/network-setups/fabric/dev` folder.

samples/corda-simple-application/README.md

@@ -54,12 +54,18 @@ Use the command line client to manage state in the network:
 ./clients/build/install/clients/bin/clients create-state H 1
 ```
 
-- Query a `SimpleStates` by key
+- Query a `SimpleState` by key
 
 ```
 ./clients/build/install/clients/bin/clients get-state H
 ```
 
+- Query a `SimpleState` by linearId
+
+```
+./clients/build/install/clients/bin/clients get-state-using-linear-id LinearId
+```
+
 - Query all `SimpleStates`
 
 ```

samples/corda-simple-application/clients/src/main/kotlin/com/cordaSimpleApplication/client/CordaClient.kt

@@ -50,6 +50,7 @@ fun main(args: Array<String>) = App()
                 UpdateStateCommand(),
                 DeleteStateCommand(),
                 GetStateCommand(),
+                GetStateUsingLinearIdCommand(),
                 GetStatesCommand(),
                 RequestStateCommand(),
                 CreateVerificationPolicyCommand(),

samples/corda-simple-application/clients/src/main/kotlin/com/cordaSimpleApplication/client/InteropRequests.kt

@@ -9,6 +9,8 @@ package com.cordaSimpleApplication.client
 import arrow.core.Either
 import arrow.core.Left
 import arrow.core.Right
+import com.cordaSimpleApplication.flow.CreateState
+import com.cordaSimpleApplication.state.SimpleState
 import com.cordaInteropApp.flows.CreateExternalRequest
 import com.cordaInteropApp.flows.WriteExternalStateInitiator
 import com.cordaInteropApp.flows.GetExternalStateByLinearId
@@ -174,7 +176,16 @@ fun writeExternalStateToVault(
                     .returnValue.get()
         }.fold({
             it.map { linearId ->
-                println("Verification was successful and state was stored with linearId $linearId.\n")
+                println("Verification was successful and external-state was stored with linearId $linearId.\n")
+
+		val (valueByteArray, externalStateProof) = proxy.startFlow(::GetExternalStateByLinearId, linearId.toString()).returnValue.get()
+		val value = valueByteArray.toString(Charsets.UTF_8)
+		val key = address.split(":").last()
+		val createdState = proxy.startFlow(::CreateState, key, value)
+                    .returnValue.get().tx.outputStates.first() as SimpleState
+		println("Created simplestate: ${createdState}")
+		println("LinearId ${createdState.linearId} can be used to fetch the requested state from the CorDapp simplestate vault")
+
                 linearId.toString()
             }
         }, {

samples/corda-simple-application/clients/src/main/kotlin/com/cordaSimpleApplication/client/SimpleStateManager.kt

@@ -121,7 +121,35 @@ class GetStateCommand : CliktCommand(help = "Gets state by key. Requires a key")
             val proxy = rpc.proxy
             val states = proxy.startFlow(::GetStateByKey, key)
                     .returnValue.get()
-            println(states)
+            println(states.toString(Charsets.UTF_8))
+        } catch (e: Exception) {
+            println(e.toString())
+        } finally {
+            rpc.close()
+        }
+    }
+}
+
+/**
+ * The CLI command used to trigger a GetStateByLinearId flow.
+ *
+ * @property linearId The linearId for the [SimpleState] to be retrieved.
+ */
+class GetStateUsingLinearIdCommand : CliktCommand(help = "Gets state by linearId. Requires a linearId") {
+    val linearId: String by argument()
+    val config by requireObject<Map<String, String>>()
+    override fun run() {
+        println("Get state with linearId $linearId")
+        val rpc = NodeRPCConnection(
+                host = config["CORDA_HOST"]!!,
+                username = "clientUser1",
+                password = "test",
+                rpcPort = config["CORDA_PORT"]!!.toInt())
+        try {
+            val proxy = rpc.proxy
+            val state = proxy.startFlow(::GetStateByLinearId, linearId)
+                    .returnValue.get()
+            println(state)
         } catch (e: Exception) {
             println(e.toString())
         } finally {

samples/corda-simple-application/workflows-kotlin/src/main/kotlin/com/example/flow/SimpleFlow.kt

@@ -11,6 +11,7 @@ import com.cordaSimpleApplication.contract.SimpleContract
 import com.cordaSimpleApplication.state.SimpleState
 import javassist.NotFoundException
 import net.corda.core.contracts.Command
+import net.corda.core.contracts.UniqueIdentifier
 import net.corda.core.flows.*
 import net.corda.core.node.services.queryBy
 import net.corda.core.transactions.SignedTransaction
@@ -254,6 +255,30 @@ class GetStateByKey(val key: String) : FlowLogic<ByteArray>() {
     }
 }
 
+/**
+ * The GetStateByLinearId flow is used to retrieve a [SimpleState] from the vault based on its linearId.
+ *
+ * @property linearId the linearId for the [SimpleState] to be retrieved.
+ */
+@StartableByRPC
+class GetStateByLinearId(val linearId: String) : FlowLogic<String>() {
+    @Suspendable
+
+    /**
+     * The call() method captures the logic to find a [SimpleState] in the vault based on its linearId.
+     *
+     * @return returns the [SimpleState].
+     */
+    override fun call(): String {
+        val states = serviceHub.vaultService.queryBy<SimpleState>().states
+                .filter { it.state.data.linearId == UniqueIdentifier.Companion.fromString(linearId) }
+                .map { it.state.data }
+        val state = states.first()
+        println("Retrieved state with linearId $linearId: $state\n")
+        return state.toString()
+    }
+}
+
 /**
  * The GetStates flow is used to retrieve all [SimpleState]s from the vault.
  */