Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Pana committed Sep 19, 2023
1 parent 923dd3c commit 1d594c1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ gradle-app.setting
bin
.idea
docs/tmp.md
docs/how-to-publish.md
docs/how-to-publish.md
.vscode
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,15 @@ Or you can download jar package from github release page, or clone the source co

## Docs

* [Conflux developer documentation portal](https://developer.confluxnetwork.org/)
* [Conflux developer documentation portal](https://doc.confluxnetwork.org/)
* [JAVA SDK API](https://javadoc.io/doc/io.github.conflux-chain/conflux.web3j)
* [Conflux fullnode RPC API](https://developer.confluxnetwork.org/conflux-doc/docs/json_rpc)
* [Conflux fullnode pub/sub API](https://developer.confluxnetwork.org/conflux-doc/docs/pubsub)
* [Conflux fullnode RPC API](https://doc.confluxnetwork.org/docs/core/build/json-rpc/)
* [Conflux fullnode pub/sub API](https://doc.confluxnetwork.org/docs/core/build/json-rpc/pubsub)
* [SDK updates for CIP37](./docs/cfx-address.md)
* [Testnet Faucet](https://faucet.confluxnetwork.org/)
* [changelog](./CHANGELOG.md)
* [Community Examples](https://github.com/conflux-fans/java-sdk-examples)
* [Contract method interaction ABI encode](https://github.com/conflux-fans/crypto-knowledge/blob/main/blogs/java-sdk-abi-encode.md)

## Quick Start

Expand Down Expand Up @@ -198,7 +199,7 @@ String result = account.transfer(opt, new Address("0x13d2bA4eD43542e7c54fbB6c5fC
```

## Websocket and PubSub
The `conflux-rust` fullnode [support PubSub](https://developer.confluxnetwork.org/conflux-doc/docs/pubsub) through websocket, the default port is 12535, you need open it manually.
The `conflux-rust` fullnode [support PubSub](https://doc.confluxnetwork.org/docs/core/build/json-rpc/pubsub) through websocket, the default port is 12535, you need open it manually.
Now the SDK provide three methods `subscribeNewHeads`, `subscribeLogs`, `subscribeEpochs` you can use to sub respect events.

```java
Expand Down

0 comments on commit 1d594c1

Please sign in to comment.