org.polkadot.rpc.provider.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of polkadot-java Show documentation

Java Polkadot API, this is a clone of https://github.com/polkadot-java/api

The newest version!

/**
# @polkadot/rpc-provider

Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface.

## Provider Selection

There are two flavours of the providers provided, one allowing for using HTTP as a transport mechanism, the other using WebSockets. It is generally recommended to use the {@link org.polkadot.rpc.provider.ws.WsProvider} since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client.

## Usage

WebSocket Initialisation -

```java
import org.polkadot.rpc.provider.ws.WsProvider;

// this is the actual default endpoint
const provider = new WsProvider('ws://127.0.0.1:9944');
const version = provider.send('client_version', []);

System.out.print("client version ");
System.out.println(version);
```

HTTP Initialisation -

```java
import org.polkadot.rpc.provider.http.HttpProvider;

// this is the actual default endpoint
const provider = new HttpProvider('http://127.0.0.1:9933');
const version = provider.send('chain_getBlockHash', []);

System.out.print("latest block Hash ");
System.out.println(hash);
```
*/
package org.polkadot.rpc.provider;