Skip to content

Commit 8c6846b

Browse files
authored
Update README.md
1 parent 067ab13 commit 8c6846b

File tree

1 file changed

+5
-56
lines changed

1 file changed

+5
-56
lines changed

Tokens/stockpaydividend/README.md

Lines changed: 5 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -36,63 +36,12 @@ This Stock Exchange CorDapp includes:
3636

3737
*Note that some date constraint(eg. payday) is being commented out to make sure the sample can be ran smoothly
3838

39-
### States
40-
* `StockState` - which holds the underlying information of a stock like stock name, symbol, dividend, etc.
41-
* `DividendState` - represents the dividend to be paid off by the company to the shareholder.
42-
43-
44-
### Flows
45-
46-
We'll list the flows here in the order that they execute in our example.
47-
48-
49-
##### Pre-requisite. IssueMoney - Bank
50-
51-
First, the bank issues money to WayneCo using `IssueMoney.java`
52-
53-
##### 1. IssueStock - Stock Issuer
54-
WayneCo creates a StockState and issues some stock tokens associated to the created StockState.
55-
56-
That stock is issused in `IssueStock.java`
57-
58-
##### 2. MoveStock - Stock Issuer
59-
60-
WayneCo transfers some stock tokens to the Shareholder.
61-
62-
63-
This flow is in `MoveStock.java`
64-
65-
##### 3. AnnounceDividend - Stock Issuer
66-
WayneCo announces the dividends that will be paid on the payday.
67-
68-
This happens through `AnnounceDividend.java`
69-
70-
71-
72-
##### 4. GetStockUpdate - Shareholder
73-
Shareholders retrieves the newest stock state from the company.
74-
75-
76-
We see this happen in `GetStockUpdate.java`
77-
78-
79-
##### 5. ClaimDividendReceivable - Shareholder
80-
81-
Shareholders finds the dividend is announced and claims the dividends base on the owning stock.
82-
83-
Implemented in `ClaimDividendReceivable.java`
84-
85-
86-
##### 6. PayDividend - Company
87-
On the payday, the company pay off the stock with fiat currencies.
88-
89-
90-
This is implemented in `PayDividend.java`
91-
##### 7. Get token balances - Any node
92-
Query the balances of different nodes. This can be executed at anytime.
93-
94-
This is found in two different flows, where we make requests using `GetStockBalances` or `GetFiatBalances` for stock or fiat with `QueryStock.java`
9539

40+
### States
41+
* **[StockState](./contracts/src/main/java/net/corda/samples/stockpaydividend/states/StockState.java)** -
42+
which holds the underlying information of a stock like stock name, symbol, dividend, etc.
43+
* **[DividendState](./contracts/src/main/java/net/corda/samples/stockpaydividend/states/DividendState.java)** -
44+
represents the dividend to be paid off by the company to the shareholder.
9645

9746
## Usage
9847

0 commit comments

Comments
 (0)