Java Web3J概述

1 Java Web3J概述

Web3j是一个轻量级，Reactive(响应式)，类型安全的Java库，用于与Ethereum网络上的客户端（节点）集成，这允许您使用Ethereum块链，而不需要为平台编写自己的集成代码的额外开销。

1.1 Web3J的提供的功能

通过HTTP和IPC 完成Ethereum的JSON-RPC客户端API的实现

1.Ethereum钱包支持

2.使用过滤器的函数式编程功能的API

3.自动生成Java智能合约包装器，以创建、部署、处理和调用来自本地Java代码的智能合约

4.支持Parity的 个人和Geth的 个人客户端API

5.支持Infura，所以您不必自己运行一个Ethereum客户端

6.综合整合测试展示了上述一些场景

7.命令行工具

1.2 Web3J的依赖的库（中间件）

1.RxJava函数式编程的的API中间件

2.Apache HTTP Client中间件

3.Jackson Core 用于快速JSON序列化/反序列化中间件

4.Bouncy Castle加密解密和 Java Scrypt加密中间件

5.生成智能合约java包装器类的java源代码（.java）的JavaPoet中间件

6.Java的UNIX域套接字的*nix系统进程间通信API中间件

1.3 启动Ethereum客户端

1	$ geth --fast --cache = 512 –networkid 2 - -rpcapi “personal，db，eth，net，web3” --rpc --dev

 

1.4 Web3J的进程间通信IPC

Web3j还支持通过文件套接字快速进行进程间通信（IPC）到在与web3j相同的主机上运行的客户端。在创建服务时，连接只需使用相关的IpcService实现而不是 HttpService：

​

1.5 Web3J的过滤器

Web3j的函数式编程的特性让我们设置观察者很容易，这样通知订阅者在区块链以便知道区块链上设置的事件。

1.5.1 区块过滤器

当所有新的块被添加到块链中的时候，接收到这些区块

如果您希望查看最近的当前的区块，以便于新的后续块的创建:

1.5.2 交易过滤器

当所有新的交易被添加到块链中的时候，接收到这些交易

1.5.3 待处理的交易过滤器

当所有待处理的交易被提交到网络时(也就是说，在它们被分组到一个块之前)，接收这些交易

1.5.4 使用Web3J交易

Web3j支持使用Ethereum钱包文件（推荐）和用于发送交易的Ethereum客户端管理命令。

使用您的Ethereum钱包文件将Ether发送到另一方：

如果想自定义交易

1.  获取可用的nonce
   

1.   创建交易
   

1.  签名并发送交易
   

1.  使用web3j的智能合约包装器要简单得多
   

 

1.6 使用Web3J智能合约

使用Java智能合约包装器处理智能合约

web3j可以自动生成智能合约包装器代码，以便在不离开Java的情况下部署和与智能合约进行交互，生成包装代码

1.6.1 编译智能合约

$ solc .sol —bin —abi —optimize -o <output-dir>

1.6.2 然后使用Web3J的命令行工具生成包装器代码

Web3j solidity生成/path/to/<smart-contract>.bin /path/to/<smart-contract>.abi -o / path / to / src / main / java -p com.your.organisation.name

1.6.3 创建并部署智能合约

1.6.4 使用已存在的智能合约

 

2 以太坊的Web3J交易

2.1 Web3J交易类型

从广义上讲，以太坊有三种类型的交易

1. 从以太坊的一方转移到另一方
   

2. 创建智能合约
   

3. 交易智能合约
   

 

2.2 在TestNet /私有块链上挖矿

在Ethereme测试网络（TestNet）中，采矿难度低于主网络（MainNet）。这意味着您可以使用常规CPU（如笔记本电脑）挖掘新的Ether，您需要做的就是运行一个Ethereum客户端

 

2.3 以太坊GAS

在使用Ethereum客户端时，这意味着有两个参数（GasPrice,GasLimit）用来决定你想花多少时间来完成一项任务:

2.3.1 Gas Price

这是你在每单位Gas中所准备的量。它的价格是9000 Wei (9 x 10 ^15 Ether)

这是你在交易执行过程中愿意花费的总金额。在以太坊中，一个交易的大小是有上限的，它限制了这个值，通常限制为1,500,000

2.3.2 Gas Limit

这些参数组合在一起，决定了您愿意花费在交易成本上的最大数量。也就是说，你不能再用Gas的价格限制了。GasPrice也会影响交易发生的速度，这取决于其他交易的价格，而这些交易对矿商来说更有利可图，您可能需要对这些参数进行调整，以确保交易能够及时地进行。

 

2.4 交易机制

当您使用某种Ether创建有效的帐户时，可以使用两种机制来与Ethereum进行交易，这两种机制都通过web3j来支持。

1. [通过Ethereum客户端进行交易签名](https://docs.web3j.io/transactions.html#signing-via-client)
   

2. [离线交易签名](https://docs.web3j.io/transactions.html#offline-signing)
   

2.4.1 通过Ethereum客户端进行交易签名

为了通过Ethereum客户端进行交易，您首先需要确保您所交易的客户知道您的钱包地址。为了做到这一点，你最好运行自己的Ethereum客户端，如Geth / Parity。一旦您有客户端运行，您可以通过以下方式创建一个钱包：

1. Geth Wiki包含了Geth支持的不同机制的良好运行，比如导入私钥文件，并通过它的控制台创建一个新帐户或者，您可以为客户端使用JSON-RPC管理命令，例如，用于[Parity](https://github.com/paritytech/parity/wiki/JSONRPC-personal-module#personal_newaccount) 或[Geth的personal_newAccount](https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_newaccount)
   

2. 在客户端使用json-rpc管理命令，对于 [Parity](https://github.com/paritytech/parity/wiki/JSONRPC-personal-module#personal_newaccount) or [Geth](https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_newaccount)使用personal_newAccount
   

创建您的钱包文件后，您可以通过web3j解锁帐户，首先创建一个支持Parity / Geth管理命令的web3j实例

2.4.2 脱机交易签名

如果您不想管理自己的Ethereum客户端，或者不想向Ethereum客户端提供电子钱包详细信息（如密码），那么离线交易签名就是要走的路。

离线交易签名允许您使用您在Web3j中的Ethereum Ethereum钱包签署交易，从而可以完全控制您的私人凭据。离线创建的交易可以发送到网络上的任何Ethereum客户端，这将会将交易传播到其他节点，前提是它是一个有效的交易。

2.4.3 创建和使用钱包文件

为了离线签署交易，您需要使用您的Ethereum钱包文件或与Ethereum钱包/帐户相关的公钥和私钥,web3j能够为您生成一个新的安全Ethereum钱包文件，或者使用现有的钱包文件。

要创建一个新的钱包文件：

String fileName = WalletUtils.generateNewWalletFile(“your password”,new File(“/path/to/destination”));

2.4.4 脱机签名交易

如果具有达到脱机签名能力目的交易应该使用 RawTransaction类型。RawTransaction类似于之前提到的交易类型，但是它不需要from地址，因为这可以从签名中推断出来。

为了创建和签名一个raw交易，顺序如下：

确定发件人帐户的下一个可用随机数

1.  创建RawTransaction对象
   

2.  编码RawTransaction对象
   

3.  签名RawTransaction对象
   

4.  将RawTransaction对象发送到节点进行处理
   

5. 获取下一个可用的[随机数后](https://docs.web3j.io/transactions.html#nonce)，该值就可以用于创建交易对象：
   

1. 然后可以对交易进行签名和编码:
   

这些凭证是在创建和处理钱包文件时加载的。

1. 然后使用ethsendrawtransaction发送该交易:
   

2.4.5 交易 Nonce

Nonce是一个递增的数值，它用于惟一地标识交易。一个nonce只能被使用一次，直到一个交易被挖矿确认，它可以用同一个nonce发送多个版本的交易，然而，一旦被挖矿确认，任何后续的提交都将被拒绝，可以通过

2.4.6 Nonce使用规则

为了防止交易重播，ETH（ETC）节点要求每笔交易必须有一个nonce数值。每一个账户从同一个节点发起交易时，这个nonce值从0开始计数，发送一笔nonce对应加1。当前面的nonce处理完成之后才会处理后面的nonce。

注意这里的前提条件是相同的地址在相同的节点发送交易。

1.  当nonce太小（小于之前已经有交易使用的nonce值），交易会被直接拒绝。
   

2.  当nonce太大,交易会一直处于队列之中,这也就是导致我们上面描述的问题的原因；
   

3.  当发送一个比较大的nonce值，然后补齐开始nonce到那个值之间的nonce，那么交易依旧可以被执行。
   

4.  当交易处于queue中时停止geth客户端，那么交易queue中的交易会被清除掉。
   

 

2.5 创建智能合约

2.5.1 使用Raw Transaction

2.5.2 获取合约地址

如果智能合约包含构造函数，则相关的构造函数字段值必须编码并附加到编译后的智能合约代码中.

2.5.3 执行智能合约

web3j负责为您提供功能编码，进一步的详细信息可以在Ethereum维基百科的电子合同ABI节中找到。

等待响应就使用EthGetTransactionReceipt…

不管消息签名的返回类型是什么，都不可能从事务性函数调用返回值。但是，可以使用过滤器捕获函数返回的值.

2.5.4 查询智能合约的状态

此功能由ethcall json-rpc调用实现, ethcall允许您在智能合约中调用一个方法来查询一个值。这个函数不存在交易成本，这是因为它不会改变任何智能合约方法的状态，它只是简单地返回它们的值:

注意:如果生成了一个无效的函数调用，或者获得了一个null结果，那么返回值将是一个集合。emptylist的实例.

原文链接：http://wangxiaoming.com/blog/2018/02/28/HPB-43-ETH-Web3j-function/