jNano | Java library for Nano
jNano is a Java library used to make integrations with the Nano cryptocurrency simple. This library allows you to interface with the node via RPC requests, and also provides many native tools and utilities so that a node isn't always necessary.
Nano is a crypto-currency which offers instantaneous and fee-less transactions. For more information, visit https://nano.org.
Technical details
- This library requires Java 8+ (module
uk.oczadly.karl.jnanofor versions 9+) - Fully compatible with clone cryptocurrencies (eg. Banano)
- Built and managed through Maven
- List of dependencies
Features
This library provides simple access to the following facilities:
- RPC queries
- WebSocket notifications
HTTP block callback server(deprecated, prefer websockets where possible)- Various built-in utilities:
- Block creation / signing / hashing
- Work generation (with support for CPU, GPU and the DPoW service)
- Account parsing / validation
- Unit conversions
- Constants for Nano (and Banano)
Usage
Download
This project is hosted on Maven Central. You can also download the compiled JAR directly from here.
Maven
<dependency>
<groupId>uk.oczadly.karl</groupId>
<artifactId>jnano</artifactId>
<version>2.20.1</version>
</dependency>Gradle
dependencies {
implementation 'uk.oczadly.karl:jnano:2.20.1'
}Documentation
Examples
RPC Queries [Wiki]
To make queries to an external Nano node through the RPC system, you will need to use the RpcQueryNode
class. You can customize these objects even further by constructing using the nested Builder class.
RpcQueryNode rpc = new RpcQueryNode(); // Using localhost:7076
RpcQueryNode rpc = RpcServiceProviders.nanex(); // Using nanex.cc public APIThis example will print an account's balance to the console using a synchronous (blocking) call.
// Construct and execute the request, and obtain the response
ResponseBalance balance = rpc.processRequest(new RequestAccountBalance(
"nano_34qjpc8t1u6wnb584pc4iwsukwa8jhrobpx4oea5gbaitnqafm6qsgoacpiz"));
// Handle the result object however you wish (eg. print the balance)
System.out.println("Account balance: " + balance.getTotal());WebSockets (listening for blocks) [Wiki]
The following will create a WebSocket listener which connects to port 7078 on localhost. For each new block
confirmed by the node, the hash and type will be printed to the console.
NanoWebSocketClient ws = new NanoWebSocketClient(); // Defaults to localhost:7078
ws.connect(); // Connect to the endpoint
// Register a listener (will be called for each new block)
ws.getTopics().topicConfirmedBlocks().registerListener((message, context) -> {
// Print the hash and type of all confirmed blocks
System.out.printf("Confirmed block: %s (%s)%n",
message.getHash(), message.getBlock().getType());
});
// Subscribe to the block confirmations topic
ws.getTopics().topicConfirmedBlocks().subscribeBlocking(new TopicConfirmation.SubArgs()
.includeBlockContents() // Include block info in messages
.filterAccounts( // Only receive blocks for these accounts
"nano_34qjpc8t1u6wnb584pc4iwsukwa8jhrobpx4oea5gbaitnqafm6qsgoacpiz",
"nano_1ipx847tk8o46pwxt5qjdbncjqcbwcc1rrmqnkztrfjy5k7z4imsrata9est"));Block Creation [Wiki]
The following sample will create a new state block. The block will be signed using the provided private key, and
work will be generated in the JVM using the CPU.
WorkGenerator workGenerator = new CPUWorkGenerator(); // Note: construct once and re-use
StateBlock block = StateBlock.builder()
.subtype(StateBlockSubType.OPEN)
.link("BF4A559FEF44D4A9C9CEF4972886A51FC83AD1A2BEE4CDD732F62F3C166D6D4F")
.balance("123000000000000000000000000")
.generateWork(workGenerator)
.buildAndSign("A3293644AC105DEE5A0202B7EF976A06E790908EE0E8CC43AEF845380BFF954E"); // Private key
String hash = block.getHash().toHexString(); // Hashes the block
String blockJson = block.toJsonString(); // Serializes the block to JSONDependencies
This project requires the following dependencies, which are included automatically through Maven:
If you found this library useful and would like to support my work, donations may be sent to
nano_34qjpc8t1u6wnb584pc4iwsukwa8jhrobpx4oea5gbaitnqafm6qsgoacpiz -
any amount would be greatly appreciated :D