Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rafaelazeredo/creditbank


https://github.com/rafaelazeredo/creditbank

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
![Corda](https://www.corda.net/wp-content/uploads/2016/11/fg005_corda_b.png)



# CorDapp Template



Welcome to the CorDapp template. The CorDapp template is a stubbed-out CorDapp 

which you can use to bootstrap your own CorDapp projects.



**This is the KOTLIN version of the CorDapp template. For the JAVA version click 

[here](https://github.com/corda/cordapp-template-java/).**



## Pre-Requisites



You will need the following installed on your machine before you can start:



* [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) 

  installed and available on your path (Minimum version: 1.8_131).

* [IntelliJ IDEA](https://www.jetbrains.com/idea/download/) (Minimum version 2017.1)

* git

* Optional: [h2 web console](http://www.h2database.com/html/download.html)

  (download the "platform-independent zip")



For more detailed information, see the

[getting set up](https://docs.corda.net/getting-set-up.html) page on the

Corda docsite.



For IDE, compilation and JVM version issues, see the

[Troubleshooting](https://docs.corda.net/troubleshooting.html) page on the Corda docsite.



## Getting Set Up



To get started, clone this repository with:



     git clone https://github.com/corda/cordapp-template-kotlin.git



And change directories to the newly cloned repo:



     cd cordapp-template-kotlin



## Building the CorDapp template:



**Unix:** 



     ./gradlew deployNodes



**Windows:**



     gradlew.bat deployNodes



Note: You'll need to re-run this build step after making any changes to

the template for these to take effect on the node.



## Running the Nodes



Once the build finishes, change directories to the folder where the newly

built nodes are located:



     cd build/nodes



The Gradle build script will have created a folder for each node. You'll

see three folders, one for each node and a `runnodes` script. You can

run the nodes with:



**Unix:**



     ./runnodes --log-to-console --logging-level=DEBUG



**Windows:**



    runnodes.bat --log-to-console --logging-level=DEBUG



You should now have three Corda nodes running on your machine serving 

the template.



When the nodes have booted up, you should see a message like the following 

in the console: 



     Node started up and registered in 5.007 sec



## Interacting with the CorDapp via HTTP



The CorDapp defines a couple of HTTP API end-points and also serves some

static web content. Initially, these return generic template responses.



The nodes can be found using the following port numbers, defined in 

`build.gradle`, as well as the `node.conf` file for each node found

under `build/nodes/partyX`:



     PartyA: localhost:10007

     PartyB: localhost:10010



As the nodes start up, they should tell you which host and port their

embedded web server is running on. The API endpoints served are:



     /api/template/templateGetEndpoint



And the static web content is served from:



     /web/template



## Using the Example RPC Client



The `ExampleClient.kt` file is a simple utility which uses the client

RPC library to connect to a node and log its transaction activity.

It will log any existing states and listen for any future states. To build 

the client use the following Gradle task:



     ./gradlew runTemplateClient



To run the client:



**Via IntelliJ:**



Select the 'Run Template RPC Client'

run configuration which, by default, connect to PartyA (RPC port 10006). Click the

Green Arrow to run the client.



**Via the command line:**



Run the following Gradle task:



     ./gradlew runTemplateClient

     

Note that the template rPC client won't output anything to the console as no state 

objects are contained in either PartyA's or PartyB's vault.



## Running the Nodes Across Multiple Machines



See https://docs.corda.net/tutorial-cordapp.html#running-nodes-across-machines.



## Further reading



Tutorials and developer docs for CorDapps and Corda are

[here](https://docs.corda.net/).