stock pay dividend

Author: peterli-r3

Tokens/stockpaydividend/README.md

@@ -129,7 +129,7 @@ This can be executed anytime before step 6.
 
 ##### 1. IssueStock - Stock Issuer
 WayneCo creates a StockState and issues some stock tokens associated to the created StockState.
->On company WayneCo's node, execute <br>`start IssueStock symbol: TEST, name: "Stock, SP500", currency: USD, price: 7.4, issueVol: 500, notary: Notary`
+>On company WayneCo's node, execute <br>`start CreateAndIssueStock symbol: TEST, name: "Stock, SP500", currency: USD, price: 7.4, issueVol: 500, notary: Notary`
 
 ##### 2. MoveStock - Stock Issuer
 WayneCo transfers some stock tokens to the Shareholder.
@@ -142,19 +142,16 @@ Now at the Shareholder's terminal, we can see that it received 100 stock tokens:
 WayneCo announces the dividends that will be paid on the payday.
 >On WayneCo's node, execute <br>`start AnnounceDividend symbol: TEST, dividendPercentage: 0.05, executionDate: "2019-11-22T00:00:00Z", payDate: "2019-11-23T00:00:00Z"`
 
-##### 4. GetStockUpdate - Shareholder
-Shareholders retrieves the newest stock state from the company.
->On shareholder node, execute <br>`start GetStockUpdate symbol: TEST`
 
-##### 5. ClaimDividendReceivable - Shareholder
+##### 4. ClaimDividendReceivable - Shareholder
 Shareholders finds the dividend is announced and claims the dividends base on the owning stock.
 >On shareholder node, execute <br>`start ClaimDividendReceivable symbol: TEST`
 
-##### 6. PayDividend - Company
+##### 5. PayDividend - Company
 On the payday, the company pay off the stock with fiat currencies.
 >On WayneCo node, execute <br>`start PayDividend`
 
-##### 7. Get token balances - Any node
+##### 6. Get token balances - Any node
 Query the balances of different nodes. This can be executed at anytime.
 > Get stock token balances
 <br>`start GetStockBalance symbol: TEST`

Tokens/stockpaydividend/build.gradle

@@ -12,8 +12,10 @@ buildscript {
         slf4j_version = constants.getProperty("slf4jVersion")
         corda_platform_version = constants.getProperty("platformVersion")
         guava_version = constants.getProperty("guavaVersion")
+
+        //token dependency
         tokens_release_group = 'com.r3.corda.lib.tokens'
-        tokens_release_version = '1.0'
+        tokens_release_version = '1.2'
     }
 
     repositories {
@@ -98,7 +100,6 @@ dependencies {
     // Token SDK dependencies.
     cordapp "$tokens_release_group:tokens-contracts:$tokens_release_version"
     cordapp "$tokens_release_group:tokens-workflows:$tokens_release_version"
-    cordapp "$tokens_release_group:tokens-money:$tokens_release_version"
 }
 
 task deployNodes(type: net.corda.plugins.Cordform, dependsOn: ['jar']) {
@@ -108,7 +109,6 @@ task deployNodes(type: net.corda.plugins.Cordform, dependsOn: ['jar']) {
         }
         cordapp("$tokens_release_group:tokens-contracts:$tokens_release_version")
         cordapp("$tokens_release_group:tokens-workflows:$tokens_release_version")
-        cordapp("$tokens_release_group:tokens-money:$tokens_release_version")
         cordapp project(':contracts')
         cordapp project(':workflows')
     }

Tokens/stockpaydividend/contracts/build.gradle

@@ -23,7 +23,6 @@ dependencies {
 
     // Token SDK dependencies.
     cordaCompile "$tokens_release_group:tokens-contracts:$tokens_release_version"
-    cordaCompile "$tokens_release_group:tokens-money:$tokens_release_version"
 
     // Guave
     compile "com.google.guava:guava:$guava_version"

Tokens/stockpaydividend/contracts/src/main/java/net/corda/examples/stockpaydividend/states/StockState.java

@@ -2,6 +2,8 @@
 
 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.core.schemas.StatePersistable;
 import net.corda.core.serialization.CordaSerializable;
 import net.corda.examples.stockpaydividend.contracts.StockContract;
@@ -91,4 +93,9 @@ public List<Party> getMaintainers() {
         return ImmutableList.of(issuer);
     }
 
+    /* This method returns a TokenPointer by using the linear Id of the evolvable state */
+    public TokenPointer<StockState> toPointer(){
+        LinearPointer<StockState> linearPointer = new LinearPointer<>(linearId, StockState.class);
+        return new TokenPointer<>(linearPointer, fractionDigits);
+    }
 }

Tokens/stockpaydividend/workflows/build.gradle

@@ -51,7 +51,6 @@ dependencies {
     cordapp project(":contracts")
 
     // Token SDK dependencies.
-    cordaCompile "$tokens_release_group:tokens-money:$tokens_release_version"
     cordaCompile "$tokens_release_group:tokens-workflows:$tokens_release_version"
 }
 

Tokens/stockpaydividend/workflows/src/main/java/net/corda/examples/stockpaydividend/flows/AnnounceDividend.java

@@ -4,20 +4,16 @@
 import com.google.common.collect.ImmutableList;
 import com.r3.corda.lib.tokens.workflows.flows.evolvable.UpdateEvolvableTokenFlow;
 import com.r3.corda.lib.tokens.workflows.flows.evolvable.UpdateEvolvableTokenFlowHandler;
-import com.r3.corda.lib.tokens.workflows.flows.rpc.UpdateEvolvableToken;
 import net.corda.core.contracts.StateAndRef;
 import net.corda.core.flows.*;
 import net.corda.core.identity.Party;
 import net.corda.core.node.services.IdentityService;
 import net.corda.core.transactions.SignedTransaction;
-import net.corda.examples.stockpaydividend.flows.utilities.ObserversUtilities;
-import net.corda.examples.stockpaydividend.flows.utilities.QueryUtilities;
+import net.corda.examples.stockpaydividend.flows.utilities.CustomQuery;
 import net.corda.examples.stockpaydividend.states.StockState;
 
 import java.math.BigDecimal;
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.List;
+import java.util.*;
 
 /**
  * Designed initiating node : Company
@@ -48,7 +44,7 @@ public Initiator(String symbol, BigDecimal dividendPercentage, Date executionDat
         public String call() throws FlowException {
 
             // Retrieved the unconsumed StockState from the vault
-            StateAndRef<StockState> stockStateRef = QueryUtilities.queryStock(symbol, getServiceHub());
+            StateAndRef<StockState> stockStateRef = CustomQuery.queryStock(symbol, getServiceHub());
             StockState stock = stockStateRef.getState().getData();
 
             // Form the output state here with a dividend to be announced
@@ -65,7 +61,7 @@ public String call() throws FlowException {
 
             // Get predefined observers
             IdentityService identityService = getServiceHub().getIdentityService();
-            List<Party> observers = ObserversUtilities.getObserverLegalIdenties(identityService);
+            List<Party> observers = getObserverLegalIdenties(identityService);
             List<FlowSession> obSessions = new ArrayList<>();
             for(Party observer : observers){
                 obSessions.add(initiateFlow(observer));
@@ -78,7 +74,7 @@ public String call() throws FlowException {
     }
 
     @InitiatedBy(AnnounceDividend.Initiator.class)
-    public static class Responder extends FlowLogic<SignedTransaction> {
+    public static class Responder extends FlowLogic<Void> {
         private FlowSession counterSession;
 
         public Responder(FlowSession counterSession) {
@@ -87,9 +83,24 @@ public Responder(FlowSession counterSession) {
 
         @Suspendable
         @Override
-        public SignedTransaction call() throws FlowException {
+        public Void call() throws FlowException {
             // To implement the responder flow, simply call the subflow of UpdateEvolvableTokenFlowHandler
-            return subFlow(new UpdateEvolvableTokenFlowHandler(counterSession));
+            subFlow(new UpdateEvolvableTokenFlowHandler(counterSession));
+            return null;
         }
     }
+
+
+    public static List<Party> getObserverLegalIdenties(IdentityService identityService){
+        List<Party> observers = new ArrayList<>();
+        for(String observerName : Arrays.asList("Observer", "Shareholder")){
+            Set<Party> observerSet = identityService.partiesFromName(observerName, false);
+            if (observerSet.size() != 1) {
+                final String errMsg = String.format("Found %d identities for the observer.", observerSet.size());
+                throw new IllegalStateException(errMsg);
+            }
+            observers.add(observerSet.iterator().next());
+        }
+        return observers;
+    }
 }

Tokens/stockpaydividend/workflows/src/main/java/net/corda/examples/stockpaydividend/flows/ClaimDividendReceivable.java

@@ -6,7 +6,7 @@
 import com.r3.corda.lib.tokens.contracts.types.TokenPointer;
 import com.r3.corda.lib.tokens.contracts.types.TokenType;
 import com.r3.corda.lib.tokens.workflows.types.PartyAndAmount;
-import com.r3.corda.lib.tokens.workflows.utilities.QueryUtilitiesKt;
+import com.r3.corda.lib.tokens.workflows.utilities.QueryUtilities;
 import net.corda.core.contracts.*;
 import net.corda.core.crypto.SecureHash;
 import net.corda.core.flows.*;
@@ -16,7 +16,7 @@
 import net.corda.core.transactions.TransactionBuilder;
 import net.corda.core.utilities.ProgressTracker;
 import net.corda.examples.stockpaydividend.contracts.DividendContract;
-import net.corda.examples.stockpaydividend.flows.utilities.QueryUtilities;
+import net.corda.examples.stockpaydividend.flows.utilities.CustomQuery;
 import net.corda.examples.stockpaydividend.states.DividendState;
 import net.corda.examples.stockpaydividend.states.StockState;
 
@@ -51,12 +51,13 @@ public Initiator(String symbol) {
         public String call() throws FlowException {
 
             // Retrieve the stock and pointer
-            TokenPointer stockPointer = QueryUtilities.queryStockPointer(symbol, getServiceHub());
+            TokenPointer stockPointer = CustomQuery.queryStockPointer(symbol, getServiceHub());
+
             StateAndRef<StockState> stockStateRef = stockPointer.getPointer().resolve(getServiceHub());
             StockState stockState = stockStateRef.getState().getData();
 
             // Query the current Stock amount from shareholder
-            Amount<TokenType> stockAmount = QueryUtilitiesKt.tokenBalance(getServiceHub().getVaultService(), stockPointer);
+            Amount<TokenType> stockAmount = QueryUtilities.tokenBalance(getServiceHub().getVaultService(), stockPointer);
 
             // Prepare to send the stock amount to the company to request dividend issuance
             ClaimNotification stockToClaim = new ClaimNotification(stockAmount);
@@ -114,7 +115,7 @@ public SignedTransaction call() throws FlowException {
             StockState stockState = holderStockState.getState().getData();
 
             // Query the stored state of the company
-            TokenPointer stockPointer = QueryUtilities.queryStockPointer(stockState.getSymbol(), getServiceHub());
+            TokenPointer stockPointer = CustomQuery.queryStockPointer(stockState.getSymbol(), getServiceHub());
             StateAndRef<StockState> stockStateRef = stockPointer.getPointer().resolve(getServiceHub());
 
             // Receives the amount that the shareholder holds
@@ -124,8 +125,6 @@ public SignedTransaction call() throws FlowException {
                 return it;
             });
 
-            PartyAndAmount<TokenType> stockPartyAndAmount = new PartyAndAmount<TokenType>(getOurIdentity(), claimNoticication.getAmount());
-
             // Preparing the token type of the paying fiat currency
             Currency currency = Currency.getInstance(stockState.getCurrency());
             TokenType dividendTokenType = new TokenType(currency.getCurrencyCode(), currency.getDefaultFractionDigits());

…s/stockpaydividend/flows/IssueStock.java …ydividend/flows/CreateAndIssueStock.javaTokens/stockpaydividend/workflows/src/main/java/net/corda/examples/stockpaydividend/flows/IssueStock.java renamed to Tokens/stockpaydividend/workflows/src/main/java/net/corda/examples/stockpaydividend/flows/CreateAndIssueStock.java Tokens/stockpaydividend/workflows/src/main/java/net/corda/examples/stockpaydividend/flows/IssueStock.java renamed to Tokens/stockpaydividend/workflows/src/main/java/net/corda/examples/stockpaydividend/flows/CreateAndIssueStock.java

@@ -6,8 +6,8 @@
 import com.r3.corda.lib.tokens.contracts.types.IssuedTokenType;
 import com.r3.corda.lib.tokens.workflows.flows.rpc.CreateEvolvableTokens;
 import com.r3.corda.lib.tokens.workflows.flows.rpc.IssueTokens;
+import com.r3.corda.lib.tokens.workflows.utilities.FungibleTokenBuilder;
 import net.corda.core.node.services.IdentityService;
-import net.corda.examples.stockpaydividend.flows.utilities.ObserversUtilities;
 import net.corda.examples.stockpaydividend.states.StockState;
 import net.corda.core.contracts.Amount;
 import net.corda.core.contracts.TransactionState;
@@ -23,6 +23,8 @@
 import java.util.Date;
 import java.util.List;
 
+import static net.corda.examples.stockpaydividend.flows.AnnounceDividend.getObserverLegalIdenties;
+
 /**
  * Designed initiating node : Company
  * This flow issues a stock to the node itself just to keep things simple
@@ -32,7 +34,7 @@
  */
 @InitiatingFlow
 @StartableByRPC
-public class IssueStock extends FlowLogic<String> {
+public class CreateAndIssueStock extends FlowLogic<String> {
 
     private String symbol;
     private String name;
@@ -43,7 +45,7 @@ public class IssueStock extends FlowLogic<String> {
     // Using NetworkmapCache.getNotaryIdentities().get(0) is not encouraged due to multi notary is introduced
     private Party notary;
 
-    public IssueStock(String symbol, String name, String currency, BigDecimal price, int issueVol, Party notary) {
+    public CreateAndIssueStock(String symbol, String name, String currency, BigDecimal price, int issueVol, Party notary) {
         this.symbol = symbol;
         this.name = name;
         this.currency = currency;
@@ -58,7 +60,7 @@ public String call() throws FlowException {
 
         // Sample specific - retrieving the hard-coded observers
         IdentityService identityService = getServiceHub().getIdentityService();
-        List<Party> observers = ObserversUtilities.getObserverLegalIdenties(identityService);
+        List<Party> observers = getObserverLegalIdenties(identityService);
 
         Party company = getOurIdentity();
 
@@ -81,14 +83,14 @@ public String call() throws FlowException {
         // Using the build-in flow to create an evolvable token type -- Stock
         subFlow(new CreateEvolvableTokens(transactionState, observers));
 
-        // Similar in IssueMoney flow, class of IssuedTokenType represents the stock is issued by the company party
-        IssuedTokenType issuedStock = new IssuedTokenType(company, stockState.toPointer(stockState.getClass()));
-
-        // Create an specified amount of stock with a pointer that refers to the StockState
-        Amount<IssuedTokenType> issueAmount = new Amount(new Long(issueVol), issuedStock);
-
         // Indicate the recipient which is the issuing party itself here
-        FungibleToken stockToken = new FungibleToken(issueAmount, getOurIdentity(), null);
+        //new FungibleToken(issueAmount, getOurIdentity(), null);
+        FungibleToken stockToken = new FungibleTokenBuilder()
+                .ofTokenType(stockState.toPointer())
+                .withAmount(issueVol)
+                .issuedBy(getOurIdentity())
+                .heldBy(getOurIdentity())
+                .buildFungibleToken();
 
         // Finally, use the build-in flow to issue the stock tokens. Observer parties provided here will record a copy of the transactions
         SignedTransaction stx = subFlow(new IssueTokens(ImmutableList.of(stockToken), observers));