Merge pull request #33 from corda/tokenrevamp

Tokenrevamp

Author: peterli-r3

.gitignore

@@ -8,5 +8,6 @@
 **/.vscode/*
 **/out/
 **/logs/
+**/node_modules/
 corda-nodeinfo/corda-nodeinfo.iml
 *~*

Tokens/README.md

@@ -1,18 +1,27 @@
-## samples-java/token-cordapps
+## Tokens CorDapp Samples
 
 This folder features [TokenSDK](https://training.corda.net/libraries/tokens-sdk/) sample projects.
 
-### [bike market](./bikemarket):
-This sample Cordapp demonstrate some simple flows related to the token SDK.  
+### [Fungible House Token](./fungiblehousetoken):
+This Cordapp serves as a basic example to demostrate how to tokenize an asset into [Fungible](https://training.corda.net/libraries/tokens-sdk/#fungibletoken) tokens in Corda utilizing the TokenSDK. 
 
-### [dollar to Token DvP](./dollartohousetoken):
-This CorDapp serves as a basic example to create, issue and perform a DvP (Delivery vs Payment) of an [Evolvable](https://training.corda.net/libraries/tokens-sdk/#evolvabletokentype), [NonFungible](https://training.corda.net/libraries/tokens-sdk/#nonfungibletoken) token in Corda utilizing the TokenSDK.  
+### [Bike Market](./bikemarket):
+This sample Cordapp demonstrate all four out-of-box TokenSDK flows (Create, Issue, Move, and Redeem flows). The cordapp demonstrate how to tokenize an asset as non-fungible tokens and excute a few transacting procedures. 
+<p align="center">
+  <img src="./bikemarket/diagram/pic1.png" alt="Corda" width="500">
+</p>
 
-### [fungible house token](./fungiblehousetoken):
-This Cordapp serves as a basic example to create, issue, move [Fungible](https://training.corda.net/libraries/tokens-sdk/#fungibletoken) tokens in Corda utilizing the TokenSDK.  
+### [Dollar To House Token](./dollartohousetoken):
+This CorDapp demonstrate a DvP (Delivery vs Payment) of an [Evolvable](https://training.corda.net/libraries/tokens-sdk/#evolvabletokentype), [NonFungible](https://training.corda.net/libraries/tokens-sdk/#nonfungibletoken) house token in Corda utilizing the TokenSDK. 
 
-### [stock pay dividend](./stockpaydividend):
+### [Stock Pay Dividend](./stockpaydividend):
 This CorDapp aims to demonstrate the usage of TokenSDK, especially the concept of [EvolvableToken](https://training.corda.net/libraries/tokens-sdk/#evolvabletokentype) which represents stock. You will find the StockState extends from EvolvableToken which allows the stock details(eg. announcing dividends) to be updated without affecting the parties who own the stock.  
 
-### [spaceships-javaAPIs](./spaceships-javaAPIs):
-This CorDapp contains examples using new [Java APIs](https://medium.com/corda/corda-tokens-made-easy-with-new-java-apis-83095693d72) introduced in Token SDK 1.2 - It makes of use of utility functions and the new Java Token Builders.  
+### [Spaceships-javaAPIs](./spaceships-javaAPIs):
+This CorDapp contains examples using new [Java APIs](https://medium.com/corda/corda-tokens-made-easy-with-new-java-apis-83095693d72) introduced in Token SDK 1.2 - It makes of use of utility functions and the new Java Token Builders. The lastes Java APIs were indeed later implmented for all of the samples above as well. 
+
+### [Token To Friend](./tokentofriend):
+This CorDapp showcase a simple token issuance use case. You can attach a secret message with the token and your friend can retrive it with the credential that you inputed when creating the token. This cordapp come with a nice looking front end using Reactjs. Feel free to give a try on the app!
+<p align="center">
+  <img src="./tokentofriend/diagram.png" alt="Corda" width="600">
+</p>

Tokens/bikemarket/README.md

@@ -33,24 +33,11 @@ Throughout the sample, we will see how to create, transact, and redeem a Token.
 
 
 ### Flows
-
-
-We'll create bike parts using the flows for CreateFrameToken and CreateWheelToken.
-
-
-We can create the Tokens with [CreateFrameToken](./workflows/src/main/java/net/corda/examples/bikemarket/flows/CreateFrameToken.java) and [CreateWheelToken](./workflows/src/main/java/net/corda/examples/bikemarket/flows/CreateWheelToken.java).
-
-
-We'll create a bike with the [IssueNewBike](./workflows/src/main/java/net/corda/examples/bikemarket/flows/IssueNewBike.java) flow.
-
-
-We can transfer bike Tokens using the [TransferBikeToken](./workflows/src/main/java/net/corda/examples/bikemarket/flows/TransferBikeTokens.java) flow.
-
-
-We can total bike Tokens using the [TotalPart](./workflows/src/main/java/net/corda/examples/bikemarket/flows/TotalParts.java) flow.
-
-
-We can transfer part Tokens using the [TransferPartToken](./workflows/src/main/java/net/corda/examples/bikemarket/flows/TransferPartTokens.java) flow.
+1. We'll create bike parts using the flows for `CreateFrameToken` and `CreateWheelToken`.
+2. We'll create a bike with the `IssueNewBike` flow.
+3. We can transfer bike Tokens using the `TransferBikeToken` flow.
+4. We can total bike Tokens using the `TotalPart` flow.
+5. We can transfer part Tokens using the `TransferPartToken` flow.
 
 
 ## Usage
@@ -67,12 +54,12 @@ if you have any questions during setup, please go to https://docs.corda.net/gett
 Once all four nodes are started up, in BikeCo's node shell, run:
 ```
 flow start CreateFrameToken frameSerial: F4561
-flow start CreateWheelToken wheelSerial: W7894
+flow start CreateWheelToken wheelsSerial: W7894
 ```
 After this step, we have created 2 Tokens representing the physical bike part with unique serial number (which will be unique in the manufacturing).
 Then run:
 ```
-flow start IssueNewBike frameSerial: F4561, wheelSerial: W7894, holder: LicensedDealership
+flow start IssueNewBike frameSerial: F4561, wheelsSerial: W7894, holder: LicensedDealership
 ```
 This line of command will transfer the Tokens (2 Tokens together represents a single bike) to the licensed dealership.
 
@@ -82,7 +69,7 @@ run vaultQuery contractStateType: com.r3.corda.lib.tokens.contracts.states.NonFu
 ```
 Continue to the business flow, the licensed dealership will sell the bike to the Buyer. Run:
 ```
-flow start TransferBikeToken frameSerial: F4561, wheelSerial: W7894, holder: Buyer
+flow start TransferBikeToken frameSerial: F4561, wheelsSerial: W7894, holder: Buyer
 ```
 
 Now we can check at the Buyer's node shell to see if the buyer received the Token by running the same `vaultQuery` we just ran at the dealership's shell.
@@ -95,7 +82,7 @@ flow start TotalPart part: frame, serialNumber: F4561
 At the buyer's shell, if we do the [vaultQuery](https://docs.corda.net/docs/corda-os/api-vault-query.html#api-vault-query) again, we will see we now only have a wheel Token (the frame Token is gone). With the wheel Token, we can sell 
 this pair of wheels to the used parts agency. We will achieve it by running:
 ```
-flow start TransferPartToken part: wheel, serialNumber: W7894, holder: UsedPartsAgency
+flow start TransferPartToken part: wheels, serialNumber: W7894, holder: UsedPartsAgency
 ```
 At the end of the flow logic, we will find the frame Token is destroyed and the used parts agency holds the wheel Token.
 

Tokens/bikemarket/build.gradle

@@ -3,7 +3,6 @@ buildscript {
     file("$projectDir/../constants.properties").withInputStream { constants.load(it) }
 
     ext {
-
         corda_release_group = constants.getProperty("cordaReleaseGroup")
         corda_release_version = constants.getProperty("cordaVersion")
         corda_gradle_plugins_version = constants.getProperty("gradlePluginsVersion")
@@ -13,12 +12,10 @@ buildscript {
         slf4j_version = constants.getProperty("slf4jVersion")
         corda_platform_version = constants.getProperty("platformVersion").toInteger()
         guava_version = constants.getProperty("guavaVersion")
+
         //Tokens
         tokens_release_group = 'com.r3.corda.lib.tokens'
         tokens_release_version = '1.2'
-        //CI
-        confidential_id_release_group = "com.r3.corda.lib.ci"
-        confidential_id_release_version = "1.0"
     }
 
     repositories {
@@ -45,9 +42,10 @@ allprojects {
         mavenCentral()
         maven { url 'https://software.r3.com/artifactory/corda' }
         maven { url 'https://jitpack.io' }
-        // Can be removed post-release - used to get nightly snapshot build.
+        //SDK lib
         maven { url 'https://software.r3.com/artifactory/corda-lib' }
-        maven { url 'https://software.r3.com/artifactory/corda-tokens-dev' }
+        //Gradle Plugins
+        maven { url 'https://repo.gradle.org/gradle/libs-releases' }
     }
 
     tasks.withType(JavaCompile) {
@@ -73,15 +71,6 @@ apply plugin: 'net.corda.plugins.cordapp'
 apply plugin: 'net.corda.plugins.cordformation'
 apply plugin: 'net.corda.plugins.quasar-utils'
 
-cordapp {
-    info {
-        name "CorDapp bikemarket"
-        vendor "Corda Open Source"
-        targetPlatformVersion corda_platform_version.toInteger()
-        minimumPlatformVersion corda_platform_version.toInteger()
-    }
-}
-
 sourceSets {
     main {
         resources {
@@ -110,27 +99,15 @@ dependencies {
     // Token SDK dependencies.
     cordapp "$tokens_release_group:tokens-contracts:$tokens_release_version"
     cordapp "$tokens_release_group:tokens-workflows:$tokens_release_version"
-
-    // CI dependencies
-    cordapp "$confidential_id_release_group:ci-workflows:$confidential_id_release_version"
-
-}
-cordapp {
-    info {
-        name "CorDapp Template"
-        vendor "Corda Open Source"
-        targetPlatformVersion corda_platform_version
-        minimumPlatformVersion corda_platform_version
-    }
 }
+
 task deployNodes(type: net.corda.plugins.Cordform, dependsOn: ['jar']) {
     nodeDefaults {
         projectCordapp {
             deploy = false
         }
         cordapp("$tokens_release_group:tokens-contracts:$tokens_release_version")
         cordapp("$tokens_release_group:tokens-workflows:$tokens_release_version")
-        cordapp("$confidential_id_release_group:ci-workflows:$confidential_id_release_version")
         cordapp project(':contracts')
         cordapp project(':workflows')
 	runSchemaMigration = true

Tokens/bikemarket/contracts/src/main/java/net/corda/examples/bikemarket/contracts/FrameContract.java

@@ -0,0 +1,29 @@
+package net.corda.samples.bikemarket.contracts;
+
+import com.r3.corda.lib.tokens.contracts.EvolvableTokenContract;
+import net.corda.core.contracts.Contract;
+import net.corda.core.transactions.LedgerTransaction;
+import net.corda.samples.bikemarket.states.FrameTokenState;
+import org.jetbrains.annotations.NotNull;
+
+import static net.corda.core.contracts.ContractsDSL.requireThat;
+
+public class FrameContract extends EvolvableTokenContract implements Contract {
+
+    public static final String CONTRACT_ID = "net.corda.samples.bikemarket.contracts.FrameContract";
+
+    @Override
+    public void additionalCreateChecks(@NotNull LedgerTransaction tx) {
+        FrameTokenState newToken = (FrameTokenState) tx.getOutputStates().get(0);
+        requireThat( require -> {
+            require.using("Serial Number cannot be empty",(!newToken.getserialNum().equals("")));
+            return null;
+        });
+    }
+
+    @Override
+    public void additionalUpdateChecks(@NotNull LedgerTransaction tx) {
+        /*This additional check does not apply to this use case.
+         *This sample does not allow token update */
+    }
+}

Tokens/bikemarket/contracts/src/main/java/net/corda/examples/bikemarket/contracts/WheelsContract.java

@@ -0,0 +1,29 @@
+package net.corda.samples.bikemarket.contracts;
+
+import com.r3.corda.lib.tokens.contracts.EvolvableTokenContract;
+import net.corda.core.contracts.Contract;
+import net.corda.core.transactions.LedgerTransaction;
+import net.corda.samples.bikemarket.states.WheelsTokenState;
+import org.jetbrains.annotations.NotNull;
+
+import static net.corda.core.contracts.ContractsDSL.requireThat;
+
+public class WheelsContract extends EvolvableTokenContract implements Contract {
+
+    public static final String CONTRACT_ID = "net.corda.samples.bikemarket.contracts.WheelsContract";
+
+    @Override
+    public void additionalCreateChecks(@NotNull LedgerTransaction tx) {
+        WheelsTokenState newToken = (WheelsTokenState) tx.getOutputStates().get(0);
+        requireThat( require -> {
+            require.using("Serial Number cannot be empty",(!newToken.getserialNum().equals("")));
+            return null;
+        });
+    }
+
+    @Override
+    public void additionalUpdateChecks(@NotNull LedgerTransaction tx) {
+        /*This additional check does not apply to this use case.
+         *This sample does not allow token update */
+    }
+}

Tokens/bikemarket/contracts/src/main/java/net/corda/samples/bikemarket/contracts/FrameContract.java

@@ -1,10 +1,10 @@
-package net.corda.examples.bikemarket.states;
+package net.corda.samples.bikemarket.states;
 
 import com.google.common.collect.ImmutableList;
 import com.r3.corda.lib.tokens.contracts.states.EvolvableTokenType;
 import com.r3.corda.lib.tokens.contracts.types.TokenPointer;
 import net.corda.core.contracts.LinearPointer;
-import net.corda.examples.bikemarket.contracts.FrameContract;
+import net.corda.samples.bikemarket.contracts.FrameContract;
 import net.corda.core.contracts.BelongsToContract;
 import net.corda.core.contracts.UniqueIdentifier;
 import net.corda.core.identity.Party;
@@ -18,17 +18,17 @@ public class FrameTokenState extends EvolvableTokenType {
     private final Party maintainer;
     private final UniqueIdentifier uniqueIdentifier;
     private final int fractionDigits;
-    private final String ModelNum;
+    private final String serialNum;
 
-    public FrameTokenState(Party maintainer, UniqueIdentifier uniqueIdentifier, int fractionDigits, String ModelNum) {
+    public FrameTokenState(Party maintainer, UniqueIdentifier uniqueIdentifier, int fractionDigits, String serialNum) {
         this.maintainer = maintainer;
         this.uniqueIdentifier = uniqueIdentifier;
         this.fractionDigits = fractionDigits;
-        this.ModelNum = ModelNum;
+        this.serialNum = serialNum;
     }
 
-    public String getModelNum() {
-        return ModelNum;
+    public String getserialNum() {
+        return serialNum;
     }
 
 

Tokens/bikemarket/contracts/src/main/java/net/corda/samples/bikemarket/contracts/WheelsContract.java

@@ -1,10 +1,10 @@
-package net.corda.examples.bikemarket.states;
+package net.corda.samples.bikemarket.states;
 
 import com.google.common.collect.ImmutableList;
 import com.r3.corda.lib.tokens.contracts.states.EvolvableTokenType;
 import com.r3.corda.lib.tokens.contracts.types.TokenPointer;
 import net.corda.core.contracts.LinearPointer;
-import net.corda.examples.bikemarket.contracts.WheelsContract;
+import net.corda.samples.bikemarket.contracts.WheelsContract;
 import net.corda.core.contracts.BelongsToContract;
 import net.corda.core.contracts.UniqueIdentifier;
 import net.corda.core.identity.Party;
@@ -18,21 +18,22 @@ public class WheelsTokenState extends EvolvableTokenType {
     private final Party maintainer;
     private final UniqueIdentifier uniqueIdentifier;
     private final int fractionDigits;
-    private final String modelNum;
+    private final String serialNum;
 
-    public WheelsTokenState(Party maintainer, UniqueIdentifier uniqueIdentifier, int fractionDigits, String modelNum) {
+    public WheelsTokenState(Party maintainer, UniqueIdentifier uniqueIdentifier, int fractionDigits, String serialNum) {
         this.maintainer = maintainer;
         this.uniqueIdentifier = uniqueIdentifier;
         this.fractionDigits = fractionDigits;
-        this.modelNum = modelNum;
+        this.serialNum = serialNum;
     }
 
-    public String getModelNum() {
-        return modelNum;
+    public String getserialNum() {
+        return serialNum;
     }
     public Party getIssuer() {
         return maintainer;
     }
+
     @Override
     public int getFractionDigits() {
         return this.fractionDigits;