将最新版本的 web3j 加入到你的配置文件中。
Maven
java8:
<dependency>
<groupId>org.web3j</groupId>
<artifactId>core</artifactId>
<version>3.2.0</version>
</dependency>
Android:
<dependency>
<groupId>org.web3j</groupId>
<artifactId>core</artifactId>
<version>3.1.1-android</version>
</dependency>
Gradle
java8:
compile ('org.web3j:core:3.2.0')
Android:
compile ('org.web3j:core:3.1.1-android')
开启以太坊客户端
如果还没有开启以太坊客户端,需要先开启一个以太坊客户端。
比如 Geth:
$ geth --rpcapi personal,db,eth,net,web3 --rpc --rinkeby
或者 Parity:
$ parity --chain testnet
或者使用在云端运行的免费客户端 Infura:
Web3j web3 = Web3j.build(new InfuraHttpService("https://morden.infura.io/your-token"));
更多关于使用 web3j 连接 Infura 的信息。
在文档的 testnet 章节中有在网络中连接以太网的指令。
开始发送请求
发送同步请求:
Web3j web3 = Web3j.build(new HttpService()); // defaults to http://localhost:8545/
Web3ClientVersion web3ClientVersion = web3.web3ClientVersion().send();
String clientVersion = web3ClientVersion.getWeb3ClientVersion();
使用 CompletableFuture(Android特性) 发送异步请求:
Web3j web3 = Web3j.build(new HttpService()); // defaults to http://localhost:8545/
Web3ClientVersion web3ClientVersion = web3.web3ClientVersion().sendAsync().get();
String clientVersion = web3ClientVersion.getWeb3ClientVersion();
使用 RxJava Observable:
Web3j web3 = Web3j.build(new HttpService()); // defaults to http://localhost:8545/
web3.web3ClientVersion().observable().subscribe(x -> {
String clientVersion = x.getWeb3ClientVersion();
...
});
注意: Android 使用:
Web3j web3 = Web3jFactory.build(new HttpService()); // defaults to http://localhost:8545/
...
IPC
web3j 也支持快速的进程间通信(IPC),通过 file sockets 来运行与web3j相同主机上的客户端。在创建服务时,连接使用相关的IpcService实现而不是HttpService:
// OS X/Linux/Unix:
Web3j web3 = Web3j.build(new UnixIpcService("/path/to/socketfile"));
...
// Windows
Web3j web3 = Web3j.build(new WindowsIpcService("/path/to/namedpipefile"));
...
注意:IPC 在 web3j-android 中不可用。
用 Java 智能合约封装器使用智能合约
web3j 可以自动生成智能合约封装器代码,在不离开JVM的情况下部署和交互智能合约。
编译智能合约,以便生成封装器代码:
$ solc <contract>.sol --bin --abi --optimize -o <output-dir>/
然后使用 web3j 的 Command Line Tools 生成封装器代码:
web3j solidity generate /path/to/<smart-contract>.bin /path/to/<smart-contract>.abi -o /path/to/src/main/java -p com.your.organisation.name
现在,你就可以创建和部署你的智能合约了:
Web3j web3 = Web3j.build(new HttpService()); // defaults to http://localhost:8545/
Credentials credentials = WalletUtils.loadCredentials("password", "/path/to/walletfile");
YourSmartContract contract = YourSmartContract.deploy(
<web3j>, <credentials>,
GAS_PRICE, GAS_LIMIT,
<param1>, ..., <paramN>).send(); // constructor params
或者使用已经存在的合约:
YourSmartContract contract = YourSmartContract.load(
"0x<address>|<ensName>", <web3j>, <credentials>, GAS_PRICE, GAS_LIMIT);
使用智能合约交易:
TransactionReceipt transactionReceipt = contract.someMethod(
<param1>,
...).send();
调用智能合约:
Type result = contract.someMethod(<param1>, ...).send();
更多 Solidity 智能合约封装器相关信息。
过滤器(Filter)
web3j 功能-反应性的性质使得设置观察者能够通知在区块链上发生的事件的订阅者非常简单。
接收所有添加到区块链的新区块:
Subscription subscription = web3j.blockObservable(false).subscribe(block -> {
...
});
接收所有添加到区块链的新交易:
Subscription subscription = web3j.transactionObservable().subscribe(tx -> {
...
});
接收所有待处理的事务,因为它们是提交给网络的(也就是说,在它们被组合成一个块之前):
Subscription subscription = web3j.pendingTransactionObservable().subscribe(tx -> {
...
});
或者,如果您愿意将所有的块重放到当前的当前位置,并被告知新的后续块被创建:
Subscription subscription = catchUpToLatestAndSubscribeToNewBlocksObservable(
<startBlockNumber>, <fullTxObjects>)
.subscribe(block -> {
...
});
在过滤器和事件中,有许多其他事务和块重放 Observables 可见。
话题过滤也是支持的:
EthFilter filter = new EthFilter(DefaultBlockParameterName.EARLIEST,
DefaultBlockParameterName.LATEST, <contract-address>)
.addSingleTopic(...)|.addOptionalTopics(..., ...)|...;
web3j.ethLogObservable(filter).subscribe(log -> {
...
});
Subscriptions 在不会再用到的时候需要取消掉。
subscription.unsubscribe();
注意:过滤器不支持 Infura。
交易(Transactions)
web3j 提供用以太坊钱包文件(推荐)和用以太坊客户端管理命令用发送交易的使用支持。
使用以太坊钱包文件发送以太币:
Web3j web3 = Web3j.build(new HttpService()); // defaults to http://localhost:8545/
Credentials credentials = WalletUtils.loadCredentials("password", "/path/to/walletfile");
TransactionReceipt transactionReceipt = Transfer.sendFunds(
web3, credentials, "0x<address>|<ensName>",
BigDecimal.valueOf(1.0), Convert.Unit.ETHER)
.send();
或者创建你自己的客户交易:
Web3j web3 = Web3j.build(new HttpService()); // defaults to http://localhost:8545/
Credentials credentials = WalletUtils.loadCredentials("password", "/path/to/walletfile");
// get the next available nonce
EthGetTransactionCount ethGetTransactionCount = web3j.ethGetTransactionCount(
address, DefaultBlockParameterName.LATEST).send();
BigInteger nonce = ethGetTransactionCount.getTransactionCount();
// create our transaction
RawTransaction rawTransaction = RawTransaction.createEtherTransaction(
nonce, <gas price>, <gas limit>, <toAddress>, <value>);
// sign & send our transaction
byte[] signedMessage = TransactionEncoder.signMessage(rawTransaction, credentials);
String hexValue = Numeric.toHexString(signedMessage);
EthSendTransaction ethSendTransaction = web3j.ethSendRawTransaction(hexValue).send();
// ...
尽管使用web3j的传输与以太交换要简单得多。
使用以太坊客户端管理员命令(确定你的钱包在客服端的 keystore 中):
Admin web3j = Admin.build(new HttpService()); // defaults to http://localhost:8545/
PersonalUnlockAccount personalUnlockAccount = web3j.personalUnlockAccount("0x000...", "a password").sendAsync().get();
if (personalUnlockAccount.accountUnlocked()) {
// send a transaction
}
命令行工具(Command line tools)
一个 web3j fat jar 有每个版本对应的命令行工具。命令行工具允许您从命令行使用web3j的一些功能:
- 创建钱包
- 钱包密码管理
- 从一个钱包转移资产到另外一个钱包
- 生成 Solidity 智能合约功能封装器
更多详情详见文档。
更多详情
在 Java 8 构建中:
- web3j提供了对所有响应的类型安全访问。可选或空响应用Java 8的可选类型包装。
- 异步请求封装在Java 8 CompletableFutures中。web3j为所有异步请求提供了一个包装器,以确保在执行过程中捕获的任何异常都将被捕获,而不是被自动丢弃。这是由于对已检查异常的复杂期货缺乏支持,这些异常经常被重新抛出,作为未检查的异常,导致检测问题。参见Async.run()及其相关的详细测试。
在 Java 8 和 Android 构建中:
- 数字类型会返回为 BigIntegers 类型。简单结果可以将数字通过 Response.getResult() 作为 String 类型。
- 还可以通过 includeRawResponse 参数将原始 JSON 装载在 HttpService 或 IpcService 类中。