Skip to content

Commit b31be01

Browse files
authored
Update README.md
1 parent 91be4e8 commit b31be01

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

Advanced/auction-cordapp/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# auction cordapp [<img src="../../webIDE.png" height=25 />](https://ide.corda.net/?folder=/home/coder/samples-java/Advanced/auction-cordapp)
1+
# Auction Cordapp
22

33
This CorDapp serves as a demo of building an auction application on Corda. It leverages
44
different features of Corda like [SchedulableState](https://docs.corda.net/docs/corda-os/event-scheduling.html#how-to-implement-scheduled-events), [StatePointer](https://docs.corda.net/docs/corda-os/api-states.html#state-pointers) and [OwnableState](https://docs.corda.net/docs/corda-os/api-states.html#ownablestate). It also demonstrate
@@ -37,19 +37,19 @@ ownership. Left black for simplicity. Has two commands, `CreateAsset` and `Trans
3737

3838
### Flows:
3939

40-
- `CreateAssetFlow`: This flow is used create an asset. Implemented in [CreateAssetFlow.java](./workflows/src/main/java/net/corda/samples/flows/CreateAssetFlow.java#L44-L66)
40+
- `CreateAssetFlow`: This flow is used create an asset. Implemented in `CreateAssetFlow.java`
4141

42-
- `CreateAuctionFlow`: This flow is used to create an auction ([CreateAuctionFlow.java can be found here](./workflows/src/main/java/net/corda/samples/flows/CreateAuctionFlow.java#L58-L96)). Once an asset has been created using
42+
- `CreateAuctionFlow`: This flow is used to create an auction. Once an asset has been created using
4343
the`CreateAssetFlow`, this flow can be used to put the asset on auction. The `AuctionState`
4444
references to the `Asset` using a `StatePointer`.
4545

4646
Refer here to learn more about StatePointer: https://medium.com/corda/linking-corda-states-using-statepointer-16e24e5e602
4747

4848
- `BidFlow`: It is used to place a bid on an auction. Bids can be placed only till a predetermined
49-
deadline defined in the `AuctionState`. Implemented in [BidFlow.java](./workflows/src/main/java/net/corda/samples/flows/BidFlow.java#L42-L86).
49+
deadline defined in the `AuctionState`. Implemented in `BidFlow.java`.
5050

5151
- `EndAuctionFlow`: This is a scheduled flow, which run automatically on auction deadline to mark
52-
the corresponding auction as inactive, so that it stop receiving bids.The auction flow can be found [here](./workflows/src/main/java/net/corda/samples/flows/EndAuctionFlow.java#L39-L83)
52+
the corresponding auction as inactive, so that it stop receiving bids.
5353

5454
- `AuctionSettlementFlow`: It is used to settle an auction once the bidding deadline has passed. It internally triggers two flows:
5555

@@ -63,10 +63,9 @@ the corresponding auction as inactive, so that it stop receiving bids.The auctio
6363

6464

6565
## Usage
66+
## Pre-Requisites
67+
For development environment setup, please refer to: [Setup Guide](https://docs.corda.net/getting-set-up.html).
6668

67-
### Pre-requisites:
68-
69-
See https://docs.corda.net/getting-set-up.html.
7069

7170
### Running the nodes:
7271
Open a terminal and go to the project root directory and type: (to deploy the nodes using bootstrapper)

0 commit comments

Comments
 (0)