Skip to content

Latest commit

 

History

History
145 lines (109 loc) · 6.26 KB

intellij-quickstart.md

File metadata and controls

145 lines (109 loc) · 6.26 KB
Raw

IntelliJ quickstart

JVM

OpenJDK17 is strongly recommended. You can download it from IntelliJ if you don't have it already.

Preliminaries

Clone this repository:

git clone https://github.com/hashgraph/hedera-services.git

From IntelliJ, choose File -> Open the hedera-services/ directory you just cloned.

Make sure you are using JDK17 as the project SDK:

Run the Gradle assemble task in the root project (for example, via the IntelliJ Gradle tool window).

This will both,

  1. Build the hedera-node/data/apps/HederaNode.jar; and,
  2. Populate your hedera-node/data/config directory with dev-appropriate versions of the application.properties, api-permission.properties, and node.properties files that are used to bootstrap a new Hedera Services network. (To read more about how properties are sourced in Services, please see [here](./services-configuration.md).)

Starting a local single-node network

Now browse to com.hedera.node.app.ServicesMain. Its main method starts a single node network of Hedera Service by calling com.swirlds.platform.Browser#main, which is the entrypoint to bootstrap the Platform app named by the config.txt in the working directory.

Run ServicesMain#main with an IntelliJ configuration whose working directory is the hedera-node/ directory of your clone of this repo:

You can also run from Gradle below:

You will see a single black pane appear, similar to:

This node's name is "Alice" because of Line 26 in the config.txt present in your working directory.

Looking closer at config.txt, you can see you are running Hedera Services (and not some other app) because Line 12 points to the JAR file you just built; and there are three nodes in your network because you specified "Bob" and "Carol" as well as "Alice".

If multiple nodes Alice, Bob, and Carol are set up to run locally by uncommenting lines 27 and 29, they will all be running on your local machine; and communicating via the loopback interface. But each still has a private instance of the Platform, and keeps its own state, just as it would in a true distributed network.

During the initial startup, the network creates system accounts 0.0.1 through 0.0.1000. It sets the key for each account to a KeyList of size one with a well-known Ed25519 keypair. The network reads the keypair in a legacy format from here, but the same keypair is available in PEM format using the PKCS8 encoding here (the passphrase is passphrase).

Even more explicitly, the 32-byte hex-encoded private and public keys of the Ed25519 keypair are:

Public: 0aa8e21064c61eab86e2a9c164565b4e7a9a4146106e0a6cd03a8c395a110e92
Private: 91132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137

Submitting transactions to your local network

The test-clients/ directory in this repo contains a large number of end-to-end tests that Hedera engineering uses to validate the behavior of Hedera Services. Many of these tests are written in the style of a BDD specification. For example, browse to com.hedera.services.bdd.suites.crypto.HelloWorldSpec, which makes some minimal assertions about the effects of a crypto transfer.

Run HelloWorldSpec#main with an IntelliJ configuration whose working directory is the test-clients/ directory of your clone of this repo:

Because node=localhost in the spec-default.properties controlling the HelloWorldSpec test, this will run against your local network, culminating in logs similar to:

2020-01-31 15:42:21.299 INFO   170  HapiApiSpec - 'BalancesChangeOnTransfer' finished initial execution of HapiCryptoTransfer{sigs=2, payer=GENESIS, transfers=[0.0.1002 <- +1, 0.0.1001 -> -1]}
2020-01-31 15:42:21.302 INFO   80   HapiGetAccountBalance - 'BalancesChangeOnTransfer' - balance for 'sponsor': 999999999
2020-01-31 15:42:21.304 INFO   170  HapiApiSpec - 'BalancesChangeOnTransfer' finished initial execution of HapiGetAccountBalance{sigs=0, account=sponsor}
2020-01-31 15:42:21.307 INFO   80   HapiGetAccountBalance - 'BalancesChangeOnTransfer' - balance for 'beneficiary': 1000000001
2020-01-31 15:42:21.308 INFO   170  HapiApiSpec - 'BalancesChangeOnTransfer' finished initial execution of HapiGetAccountBalance{sigs=0, account=beneficiary}
2020-01-31 15:42:21.310 INFO   190  HapiApiSpec - 'BalancesChangeOnTransfer' - final status: PASSED!
2020-01-31 15:42:21.311 INFO   128  HelloWorldSpec - -------------- RESULTS OF HelloWorldSpec SUITE --------------
2020-01-31 15:42:21.311 INFO   130  HelloWorldSpec - Spec{name=BalancesChangeOnTransfer, status=PASSED}

(This client uses account 0.0.2 as the default payer, and is aware of the above keypair via its configuration in spec-default.properties under the startupAccounts.path key).

Stopping/restarting the network

Stop the ServicesMain process in IntelliJ to shut down the network.

When you restart ServicesMain, the nodes will attempt to restore their state from the hedera-node/data/saved directory tree. In general, for this to work correctly, you should precede shutting down the network by submitting a Freeze transaction; e.g. via the FreezeIntellijNetwork client.

ℹ️  In case of an unclean shutdown, or unwanted accumulation of logs and audit data in the local workspace, use the Maven antrun:run@app-clean goal in the hedera-node project to get a clean state. (Or simply delete rm -rf hedera-node/data/saved for a quick reset.)