SpringBoot/HelloCorda
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #11 from corda/DOC-4345

Browse Source 
Doc 4345: Edited code comments for java CSDE templates
This commit is contained in:
Niamh25 2022-12-06 16:43:43 +00:00 committed by GitHub
commit 4a721f2144
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 59 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
build.gradle
View File

@ -31,7 +31,7 @@ def javaVersion = VERSION_11
cordapp {
// "targetPlatformVersion" and "minimumPlatformVersion" are intended to specify the preferred
// and earliest versions of the Corda platform that the CorDapp will run on respectively.
// Enforced versioning has not implemented yet so we need to pass in a dummy value for now.
// Enforced versioning has not been implemented yet, so enter a dummy value for now.
// The platform version will correspond to and be roughly equivalent to the Corda API version.
targetPlatformVersion platformVersion.toInteger()
minimumPlatformVersion platformVersion.toInteger()
@ -61,10 +61,10 @@ repositories {
// Declare dependencies for the modules we will use.
// A cordaProvided declaration is required for anything that we use that the Corda API provides.
// This is required to allow us to build CorDapp modules as OSGi bundles that CPI and CPB files are built on.
// This is required to allow us to build CorDapp modules as OSGi bundles that CPI and CPB files are then built upon.
dependencies {
// Declare a "platform" so that we use the correct set of dependency versions for the version of the
// Corda API specified.
// Declare a "platform" to use the correct set of dependency versions for the version that the
// Corda API specifies.
cordaProvided platform("net.corda:corda-api:$cordaApiVersion")
// If using transistive dependencies this will provide most of the Corda-API:
@ -94,7 +94,7 @@ dependencies {
testImplementation "org.junit.jupiter:junit-jupiter:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
// Optional but used by exmaple tests.
// Optional but used by example tests.
testImplementation "org.mockito:mockito-core:$mockitoVersion"
testImplementation "org.hamcrest:hamcrest-library:$hamcrestVersion"
}

10
buildSrc/src/main/groovy/csde.gradle
View File

@ -34,8 +34,8 @@ def cordaBinDir= System.getProperty('user.home') + "/.corda/corda5"
def cordaCliBinDir = System.getProperty('user.home') + "/.corda/cli"
def cordaJDBCDir = cordaBinDir + "/jdbcDrivers"
def signingCertAlias="gradle-plugin-default-key"
// Get error if this is not a autotyped object
// def signingCertFName = "$rootDir/config/gradle-plugin-default-key.pem"
// You will receive an error if this is not a autotyped object.
// def signingCertFName = "$rootDir/config/gradle-plugin-default-key.pem".
def signingCertFName = rootDir.toString() + "/config/gradle-plugin-default-key.pem"
def keystoreAlias = "my-signing-key"
def keystoreFName = devEnvWorkspace + "/signingkeys.pfx"
@ -136,7 +136,7 @@ tasks.register('createKeystore') {
"-storetype", "pkcs12",
"-validity", "4000"
}
// Need to add the default signing key to the keystore
// Add the default signing key to the keystore.
exec {
commandLine "${System.getProperty("java.home")}/bin/keytool", "-importcert",
"-keystore", keystoreFName,
@ -172,7 +172,7 @@ tasks.register('buildCPI') {
File srcDir
srcDir = file('build/libs')
// Create a file collection using a closure
// Create a file collection using a closure.
def collection = layout.files { srcDir.listFiles() }
def cpbs = collection.filter { it.getName().endsWith(".cpb") }
@ -225,7 +225,7 @@ tasks.register('listCPIs') {
}
}
// Empty task, just acts as the Task user entry point task.
// Empty task, this acts as the user entry point task.
tasks.register('deployCordapp') {
group = pluginGroupName
dependsOn("createAndRegVNodes")

16
buildSrc/src/main/java/com/r3/csde/CsdeRpcInterface.java
View File

@ -202,9 +202,9 @@ public class CsdeRpcInterface {
private boolean uploadStatusRetry(kong.unirest.HttpResponse<kong.unirest.JsonNode> response) {
int status = response.getStatus();
kong.unirest.JsonNode body = response.getBody();
// Do not retry on success
// Do not retry if successful.
if(status == 200) {
// Keep retrying until we get "OK" may move through "Validateing upload", "Persisting CPI"
// Retry until you get an "OK"; we may see several other responses before the "OK" response.
return !(body.getObject().get("status").equals("OK"));
}
else if (status == 400){
@ -269,7 +269,7 @@ public class CsdeRpcInterface {
out.println("Upload Status:" + status);
out.println("Pretty print the body\n" + body.toPrettyString());
// We expect the id field to be a string.
// Expect the ID field to be a string.
if (status == 200) {
String id = (String) body.getObject().get("id");
out.println("get id:\n" + id);
@ -299,7 +299,7 @@ public class CsdeRpcInterface {
LinkedList<String> x500Ids = getConfigX500Ids();
LinkedList<String> OKHoldingShortIds = new LinkedList<>();
// For each identity check that it already exists.
// Create a list of X500 IDs we will not need to create VNodes for.
Set<MemberX500Name> existingX500 = new HashSet<>();
kong.unirest.HttpResponse<kong.unirest.JsonNode> vnodeListResponse = getVNodeInfo();
@ -322,9 +322,9 @@ public class CsdeRpcInterface {
.asJson();
// Logging.
// need to check this and report errors.
// 200 - OK
// 409 - Vnode already exists
// Check this and report errors.
// 200 - OK.
// 409 - Vnode already exists.
if (jsonNode.getStatus() != 409) {
if (jsonNode.getStatus() != 200) {
reportError(jsonNode);
@ -340,7 +340,7 @@ public class CsdeRpcInterface {
}
}
// Register the VNodes
// Register the VNodes.
for(String shortHoldingIdHash: OKHoldingShortIds) {
kong.unirest.HttpResponse<kong.unirest.JsonNode> vnodeResponse = Unirest.post(baseURL + "/api/v1/membership/" + shortHoldingIdHash)
.body("{ \"memberRegistrationRequest\": { \"action\": \"requestJoin\", \"context\": { \"corda.key.scheme\" : \"CORDA.ECDSA.SECP256R1\" } } }")

4
src/main/java/com/r3/developers/csdetemplate/Message.java
View File

@ -3,8 +3,8 @@ package com.r3.developers.csdetemplate;
import net.corda.v5.base.annotations.CordaSerializable;
import net.corda.v5.base.types.MemberX500Name;
// A class which will contain a message, It must be marked with @CordaSerializable for Corda
// to be able to send from one virtual node to another.
// Where a class contains a message, mark it with @CordaSerializable to enable Corda to
// send it from one virtual node to another.
@CordaSerializable
public class Message {
public Message(MemberX500Name sender, String message) {

36
src/main/java/com/r3/developers/csdetemplate/MyFirstFlow.java
View File

@ -18,46 +18,46 @@ import org.slf4j.LoggerFactory;
// MyFirstFlow should inherit from RPCStartableFlow, which tells Corda it can be started via an RPC call
public class MyFirstFlow implements RPCStartableFlow {
// It is useful to be able to log messages from the flows for debugging.
// Log messages from the flows for debugging.
private final Logger log = LoggerFactory.getLogger(MyFirstFlow.class);
// Corda has a set of injectable services which are injected into the flow at runtime.
// Flows declare them with @CordaInjectable, then the flows have access to their services.
// JsonMarshallingService provides a Service for manipulating json
// JsonMarshallingService provides a service for manipulating JSON.
@CordaInject
public JsonMarshallingService jsonMarshallingService;
// FlowMessaging provides a service for establishing flow sessions between Virtual Nodes and
// sending and receiving payloads between them
// FlowMessaging provides a service that establishes flow sessions between virtual nodes
// that send and receive payloads between them.
@CordaInject
public FlowMessaging flowMessaging;
// MemberLookup provides a service for looking up information about members of the Virtual Network which
// this CorDapp is operating in.
// MemberLookup provides a service for looking up information about members of the virtual network which
// this CorDapp operates in.
@CordaInject
public MemberLookup memberLookup;
public MyFirstFlow() {}
// When a flow is invoked its call() method is called.
// call() methods must be marked as @Suspendable, this allows Corda to pause mid-execution to wait
// for a response from the other flows and services
// Call() methods must be marked as @Suspendable, this allows Corda to pause mid-execution to wait
// for a response from the other flows and services.
@NotNull
@Suspendable
@Override
public String call(RPCRequestData requestBody) {
// Useful logging to follow what's happening in the console or logs
// Follow what happens in the console or logs.
log.info("MFF: MyFirstFlow.call() called");
// Show the requestBody in the logs - this can be used to help establish the format for starting a flow on corda
// Show the requestBody in the logs - this can be used to help establish the format for starting a flow on Corda.
log.info("MFF: requestBody: " + requestBody.getRequestBody());
// Deserialize the Json requestBody into the MyfirstFlowStartArgs class using the JsonSerialisation Service
// Deserialize the Json requestBody into the MyfirstFlowStartArgs class using the JsonSerialisation service.
MyFirstFlowStartArgs flowArgs = requestBody.getRequestBodyAs(jsonMarshallingService, MyFirstFlowStartArgs.class);
// Obtain the MemberX500Name of counterparty
// Obtain the MemberX500Name of the counterparty.
MemberX500Name otherMember = flowArgs.otherMember;
// Get our identity from the MemberLookup service.
@ -69,19 +69,19 @@ public class MyFirstFlow implements RPCStartableFlow {
// Log the message to be sent.
log.info("MFF: message.message: " + message.message);
// Start a flow session with the otherMember using the FlowMessaging service
// The otherMember's Virtual Node will run the corresponding MyFirstFlowResponder responder flow
// Start a flow session with the otherMember using the FlowMessaging service.
// The otherMember's virtual node will run the corresponding MyFirstFlowResponder responder flow.
FlowSession session = flowMessaging.initiateFlow(otherMember);
// Send the Payload using the send method on the session to the MyFirstFlowResponder Responder flow
// Send the Payload using the send method on the session to the MyFirstFlowResponder responder flow.
session.send(message);
// Receive a response from the Responder flow
// Receive a response from the responder flow.
Message response = session.receive(Message.class);
// The return value of a RPCStartableFlow must always be a String, this string will be passed
// The return value of a RPCStartableFlow must always be a String. This will be passed
// back as the REST RPC response when the status of the flow is queried on Corda, or as the return
// value from the flow when testing using the Simulator
// value from the flow when testing using the simulator.
return response.message;
}
}

18
src/main/java/com/r3/developers/csdetemplate/MyFirstFlowResponder.java
View File

@ -17,19 +17,19 @@ import org.slf4j.LoggerFactory;
// Responder flows must inherit from ResponderFlow
public class MyFirstFlowResponder implements ResponderFlow {
// It is useful to be able to log messages from the flows for debugging.
// Log messages from the flows for debugging.
private final Logger log = LoggerFactory.getLogger(MyFirstFlowResponder.class);
// MemberLookup provides a service for looking up information about members of the Virtual Network which
// this CorDapp is operating in.
// MemberLookup looks for information about members of the virtual network which
// this CorDapp operates in.
@CordaInject
public MemberLookup memberLookup;
public MyFirstFlowResponder() {}
// Responder flows are invoked when an initiating flow makes a call via a session set up with the Virtual
// node hosting the Responder flow. When a responder flow is invoked its call() method is called.
// call() methods must be marked as @Suspendable, this allows Corda to pause mid-execution to wait
// Responder flows are invoked when an initiating flow makes a call via a session set up with the virtual
// node hosting the responder flow. When a responder flow is invoked its call() method is called.
// Call() methods must be marked as @Suspendable, this allows Corda to pause mid-execution to wait
// for a response from the other flows and services.
// The Call method has the flow session passed in as a parameter by Corda so the session is available to
// responder flow code, you don't need to inject the FlowMessaging service.
@ -37,10 +37,10 @@ public class MyFirstFlowResponder implements ResponderFlow {
@Override
public void call(FlowSession session) {
// Useful logging to follow what's happening in the console or logs
// Follow what happens in the console or logs.
log.info("MFF: MyFirstResponderFlow.call() called");
// Receive the payload and deserialize it into a Message class
// Receive the payload and deserialize it into a message class.
Message receivedMessage = session.receive(Message.class);
// Log the message as a proxy for performing some useful operation on it.
@ -49,7 +49,7 @@ public class MyFirstFlowResponder implements ResponderFlow {
// Get our identity from the MemberLookup service.
MemberX500Name ourIdentity = memberLookup.myInfo().getName();
// Create a response to greet the sender
// Create a message to greet the sender.
Message response = new Message(ourIdentity,
"Hello " + session.getCounterparty().getCommonName() + ", best wishes from " + ourIdentity.getCommonName());

22
src/test/java/com/r3/developers/csdetemplate/MyFirstFlowTest.java
View File

@ -17,32 +17,32 @@ class MyFirstFlowTest {
@Test
@SuppressWarnings("unchecked")
public void test_that_MyFirstFLow_returns_correct_message() {
// Instantiate an instance of the Simulator
// Instantiate an instance of the simulator.
Simulator simulator = new Simulator();
// Create Alice's and Bob HoldingIDs
// Create Alice's and Bob HoldingIDs.
HoldingIdentity aliceHoldingID = HoldingIdentity.Companion.create(aliceX500);
HoldingIdentity bobHoldingID = HoldingIdentity.Companion.create(bobX500);
// Create Alice and Bob's virtual nodes, including the Class's of the flows which will be registered on each node.
// We don't assign Bob's virtual node to a variable because we don't need it for this particular test.
// Create Alice's and Bob's virtual nodes, including the classes of the flows which will be registered on each node.
// Don't assign Bob's virtual node to a value. You don't need it for this particular test.
SimulatedVirtualNode aliceVN = simulator.createVirtualNode(aliceHoldingID, MyFirstFlow.class);
simulator.createVirtualNode(bobHoldingID, MyFirstFlowResponder.class);
// Create an instance of the MyFirstFlowStartArgs which contains the request arguments for starting the flow
// Create an instance of the MyFirstFlowStartArgs which contains the request arguments for starting the flow.
MyFirstFlowStartArgs myFirstFlowStartArgs = new MyFirstFlowStartArgs(bobX500);
// Create a requestData object
// Create a requestData object.
RequestData requestData = RequestData.Companion.create(
"request no 1", // A unique reference for the instance of the flow request
MyFirstFlow.class, // The name of the flow class which is to be started
myFirstFlowStartArgs // The object which contains the start arguments of the flow
"request no 1", // A unique reference for the instance of the flow request.
MyFirstFlow.class, // The name of the flow class which is to be started.
myFirstFlowStartArgs // The object which contains the start arguments of the flow.
);
// Call the Flow on Alice's virtual node and capture the response from the flow
// Call the flow on Alice's virtual node and capture the response.
String flowResponse = aliceVN.callFlow(requestData);
// Check that the flow has returned the expected string
// Check that the flow has returned the expected string.
assert(flowResponse.equals("Hello Alice, best wishes from Bob"));
}
}